Merge lp:~mandel/ubuntuone-windows-installer/implement_db_port_manager into lp:ubuntuone-windows-installer/beta

[Manuel de la Peña]

Provides an implementation of the port manager that stores the relation between a user and a port in a SQLite db. This allows to ensure that the same port is always used when assigned so that the system admin can allow exceptions in the Windows firewall (either the OS one or a 3 party one)

[Rick McBride (rmcbride)]

Looks good, tests pass. +1

review: Approve

[Vincenzo Di Somma (vds)]

Same for me!

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2010-08-10 12:42:54 +0000
+++ .bzrignore	2010-08-18 10:05:56 +0000
@@ -27,3 +27,4 @@
 src/UbuntuOneClient.Tests/bin
 src/UbuntuOneClient.Tests/obj
 *.ReSharper
+test-results
 
=== added directory 'lib/SQLite'
=== added file 'lib/SQLite/System.Data.SQLite.DLL'
 Binary files lib/SQLite/System.Data.SQLite.DLL	1970-01-01 00:00:00 +0000 and lib/SQLite/System.Data.SQLite.DLL	2010-08-18 10:05:56 +0000 differ
=== added file 'src/Canonical.UbuntuOne.ProcessDispatcher.Tests/App.config'
--- src/Canonical.UbuntuOne.ProcessDispatcher.Tests/App.config	1970-01-01 00:00:00 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher.Tests/App.config	2010-08-18 10:05:56 +0000
@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<configuration>
+  <configSections>
+    <sectionGroup name="spring">
+      <section name="parsers"
+               type="Spring.Context.Support.NamespaceParsersSectionHandler, Spring.Core" />
+      <section name="context"
+               type="Spring.Context.Support.ContextHandler, Spring.Core"/>
+      <section name="objects"
+               type="Spring.Context.Support.DefaultSectionHandler, Spring.Core" />
+    </sectionGroup>
+    <sectionGroup name="common">
+      <section name="logging"
+               type="Common.Logging.ConfigurationSectionHandler, Common.Logging" />
+    </sectionGroup>
+  </configSections>
+
+  <!-- logging configuration -->
+  <common>
+    <logging>
+      <factoryAdapter type="Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter, Common.Logging.Log4Net">
+        <!-- choices are INLINE, FILE, FILE-WATCH, EXTERNAL-->
+        <!-- otherwise BasicConfigurer.Configure is used   -->
+        <!-- log4net configuration file is specified with key configFile-->
+        <arg key="configType"
+             value="FILE" />
+        <arg key="configFile"
+             value="~/Config/log4net.config" />
+      </factoryAdapter>
+    </logging>
+  </common>
+
+  <!-- Spring configuration -->
+  <spring>
+    <parsers>
+      <parser type="Spring.Data.Config.DatabaseNamespaceParser, Spring.Data" />
+    </parsers>
+    <context>
+      <resource uri="config://spring/objects"/>
+    </context>
+    <objects xmlns="http://www.springframework.net"
+             xmlns:db="http://www.springframework.net/database">
+      <!-- most internal objects definition is in the embeded objects.xml file here you will just find the db configuration -->
+      <db:provider id="DbProvider"
+                   provider="SQLite-1.0.65"
+                   connectionString="Data Source=UbuntuOne.db;Version=3;FailIfMissing=False;Compress=True"/>
+    </objects>
+  </spring>
+  <startup/>
+</configuration>
 
=== modified file 'src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Canonical.UbuntuOne.ProcessDispatcher.Tests.csproj'
--- src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Canonical.UbuntuOne.ProcessDispatcher.Tests.csproj	2010-08-18 10:05:56 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Canonical.UbuntuOne.ProcessDispatcher.Tests.csproj	2010-08-18 10:05:56 +0000
@@ -65,6 +65,7 @@
     <Compile Include="Protobuf\SyncDaemonMessageFactoryFixture.cs" />
     <Compile Include="Protobuf\SyncFolderMessageFactoryFixture.cs" />
     <Compile Include="Protobuf\SyncShareMessageFactoryFixture.cs" />
+    <Compile Include="SetUpClass.cs" />
     <Compile Include="SyncConfigurationServiceFixture.cs" />
     <Compile Include="SyncDaemonServiceFixture.cs" />
     <Compile Include="SyncFoldersServiceFixture.cs" />
@@ -81,6 +82,10 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
+    <Reference Include="Common.Logging.Log4Net, Version=1.2.0.2, Culture=neutral, PublicKeyToken=af08829b84f0328e, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Spring.Net\Common.Logging.Log4Net.dll</HintPath>
+    </Reference>
     <Reference Include="log4net, Version=1.2.10.0, Culture=neutral, PublicKeyToken=1b44e1d426115821, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\lib\log4net\log4net.dll</HintPath>
@@ -97,11 +102,23 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\lib\RhinoMocks\Rhino.Mocks.dll</HintPath>
     </Reference>
+    <Reference Include="Spring.Core, Version=1.3.0.20349, Culture=neutral, PublicKeyToken=65e474d141e25e07, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Spring.Net\Spring.Core.dll</HintPath>
+    </Reference>
+    <Reference Include="Spring.Data, Version=1.3.0.20349, Culture=neutral, PublicKeyToken=65e474d141e25e07, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Spring.Net\Spring.Data.dll</HintPath>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core">
       <RequiredTargetFramework>3.5</RequiredTargetFramework>
     </Reference>
     <Reference Include="System.Data" />
+    <Reference Include="System.Data.SQLite, Version=1.0.65.0, Culture=neutral, PublicKeyToken=db937bc2d44ff139, processorArchitecture=x86">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\SQLite\System.Data.SQLite.DLL</HintPath>
+    </Reference>
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
@@ -121,6 +138,9 @@
       <Install>false</Install>
     </BootstrapperPackage>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="App.config" />
+  </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <ProjectExtensions>
     <MonoDevelop>
 
=== modified file 'src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Net/PortManagerFixture.cs'
--- src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Net/PortManagerFixture.cs	2010-08-12 07:59:15 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher.Tests/Net/PortManagerFixture.cs	2010-08-18 10:05:56 +0000
@@ -18,9 +18,12 @@
  * Authors: Manuel de la Peña <[e-mail]>
  */
 using Canonical.UbuntuOne.Common;
+using Canonical.UbuntuOne.Common.Container;
 using Canonical.UbuntuOne.ProcessDispatcher.Net;
 using NUnit.Framework;
 using Rhino.Mocks;
+using Spring.Data.Common;
+using Spring.Data.Core;
 
 namespace Canonical.UbuntuOne.ProcessDispatcher.Tests.Net
 {
@@ -33,6 +36,7 @@
         private IAuthentication _auth;
         private PortManager _portManager;
         private MockRepository _mocks;
+        private IDbProvider _dbProvider;
 
         #endregion
 
@@ -44,15 +48,26 @@
             _mocks = new MockRepository();
             _portFinder = _mocks.StrictMock<IPortFinder>();
             _auth = _mocks.StrictMock<IAuthentication>();
+            _dbProvider = ObjectsContainer.GetImplementationOf<IDbProvider>();
             _portManager = PortManager.Instance;
             _portManager.Authentication = _auth;
             _portManager.PortFinder = _portFinder;
+            _portManager.DbProvider = _dbProvider;
         }
 
         [TearDown]
         public void TearDown()
         {
             _portManager.Clear();
+            // Clear the db 
+            var template = new AdoTemplate(_dbProvider);
+            template.Execute(
+                command =>
+                    {
+                        command.CommandText = string.Format("DELETE FROM {0};", PortManager.UserPortsTableName);
+                        return command.ExecuteScalar();
+                    }
+                );
         }
 
         #endregion
 
=== added file 'src/Canonical.UbuntuOne.ProcessDispatcher.Tests/SetUpClass.cs'
--- src/Canonical.UbuntuOne.ProcessDispatcher.Tests/SetUpClass.cs	1970-01-01 00:00:00 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher.Tests/SetUpClass.cs	2010-08-18 10:05:56 +0000
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2010 Canonical Ltd.
+ * 
+ * This file is part of UbuntuOne on Windows.
+ * 
+ * UbuntuOne on Windows is free software: you can redistribute it and/or modify		
+ * it under the terms of the GNU Lesser General Public License version 		
+ * as published by the Free Software Foundation.		
+ *		
+ * Ubuntu One on Windows is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the	
+ * GNU Lesser General Public License for more details.	
+ *
+ * You should have received a copy of the GNU Lesser General Public License	
+ * along with UbuntuOne for Windows.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * Authors: Manuel de la Peña <[e-mail]>
+ */
+using Canonical.UbuntuOne.Common.Container;
+using NUnit.Framework;
+
+namespace Canonical.UbuntuOne.ProcessDispatcher.Tests
+{
+    /// <summary>
+    ///  Set up class ran before any test to be able to use the IoC from xml
+    /// </summary>
+    [SetUpFixture]
+    public class SetUpClass
+    {
+        [SetUp]
+        public void Setup()
+        {
+            ObjectsContainer.Initialize(new SpringContainer());
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            ObjectsContainer.Clear();
+        }
+    }
+}
 
=== modified file 'src/Canonical.UbuntuOne.ProcessDispatcher/App.config'
--- src/Canonical.UbuntuOne.ProcessDispatcher/App.config	2010-07-26 15:55:00 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher/App.config	2010-08-18 10:05:56 +0000
@@ -32,11 +32,18 @@
   
   <!-- Spring configuration -->
   <spring>
+    <parsers>
+      <parser type="Spring.Data.Config.DatabaseNamespaceParser, Spring.Data" />
+    </parsers>
     <context>
       <resource uri="assembly://Canonical.UbuntuOne.ProcessDispatcher/Canonical.UbuntuOne.ProcessDispatcher/objects.xml" />
     </context>
-    <objects xmlns="http://www.springframework.net">
-      <!-- most internal objects definition is in the embeded objects.xml file -->
+    <objects xmlns="http://www.springframework.net"
+             xmlns:db="http://www.springframework.net/database">
+      <!-- most internal objects definition is in the embeded objects.xml file here you will just find the db configuration -->
+      <db:provider id="DbProvider"
+                   provider="SQLite-1.0.65"
+                   connectionString="Data Source=UbuntuOne.db;Version=3;FailIfMissing=False;Compress=True"/>
     </objects>
   </spring>
 
 
=== modified file 'src/Canonical.UbuntuOne.ProcessDispatcher/Canonical.UbuntuOne.ProcessDispatcher.csproj'
--- src/Canonical.UbuntuOne.ProcessDispatcher/Canonical.UbuntuOne.ProcessDispatcher.csproj	2010-08-18 10:05:56 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher/Canonical.UbuntuOne.ProcessDispatcher.csproj	2010-08-18 10:05:56 +0000
@@ -127,6 +127,14 @@
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\lib\log4net\log4net.dll</HintPath>
     </Reference>
+    <Reference Include="Spring.Core, Version=1.3.0.20349, Culture=neutral, PublicKeyToken=65e474d141e25e07, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Spring.Net\Spring.Core.dll</HintPath>
+    </Reference>
+    <Reference Include="Spring.Data, Version=1.3.0.20349, Culture=neutral, PublicKeyToken=65e474d141e25e07, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\lib\Spring.Net\Spring.Data.dll</HintPath>
+    </Reference>
     <Reference Include="Spring.Services, Version=1.3.0.20214, Culture=neutral, PublicKeyToken=65e474d141e25e07, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\lib\Spring.Net\Spring.Services.dll</HintPath>
 
=== modified file 'src/Canonical.UbuntuOne.ProcessDispatcher/Net/PortManager.cs'
--- src/Canonical.UbuntuOne.ProcessDispatcher/Net/PortManager.cs	2010-08-12 07:59:15 +0000
+++ src/Canonical.UbuntuOne.ProcessDispatcher/Net/PortManager.cs	2010-08-18 10:05:56 +0000
@@ -17,14 +17,19 @@
  * 
  * Authors: Manuel de la Peña <[e-mail]>
  */
+using System;
 using System.Collections.Generic;
+using System.Data;
 using Canonical.UbuntuOne.Common;
+using Spring.Data.Common;
+using Spring.Data.Core;
 
 namespace Canonical.UbuntuOne.ProcessDispatcher.Net
 {
     /// <summary>
     /// Implementation of the IPortManager that keeps track of the ports assigned to the different users and ensures that
-    /// there are correctly managed.
+    /// there are correctly managed. The port manager create a sqlite db that will be used to ensure that a user 
+    /// allw
     /// </summary>
     internal class PortManager : IPortManager
     {
@@ -67,6 +72,8 @@
 
         private readonly object _dictionaryLock = new object();
         private readonly Dictionary<string, UserPorts> _ports;
+        internal const string UserPortsTableName = "UserPorts";
+        private bool _usetTableExists;
 
         #endregion
 
@@ -82,6 +89,12 @@
         /// </summary>
         internal IPortFinder PortFinder { get; set; }
 
+        /// <summary>
+        /// Gets and sets the provider that the port manager uses to store the relation between a user and the 
+        /// ports he use in the application.
+        /// </summary>
+        internal IDbProvider DbProvider { get; set; }
+
         #endregion
 
         #region Helpers
@@ -93,11 +106,153 @@
         {
             lock (_dictionaryLock)
             {
-                var userPorts = new UserPorts(PortFinder.GetFreePort(), PortFinder.GetFreePort());
+                // we check if the table exists, this can happe either the first time we start in the system
+                // and the table does not exists or when we reboot and we lost the info of the flag. Ofcourse the
+                // the table could have been drop at some point
+                if(!_usetTableExists)
+                {
+                    var reallyExists = UserPortsTableExists();
+                    if(!reallyExists)
+                    {
+                        CreateUserPortsTable();
+                    }
+                    _usetTableExists = true;
+                }
+                int dotNetPort;
+                int pythonPort;
+                // we try to get the data from the db
+                if(!TryGetUserPortFromDb(Authentication.Username, out pythonPort, out dotNetPort))
+                {
+                    // we cannot get the ports, therefore we generate them.
+                    pythonPort = PortFinder.GetFreePort();
+                    dotNetPort = PortFinder.GetFreePort();
+                    // store the user ports in the db for the next time
+                    InserUserPortsInDb(Authentication.Username, pythonPort, dotNetPort);
+                }
+                var userPorts = new UserPorts(pythonPort, dotNetPort);
                 _ports.Add(Authentication.Username, userPorts);
             }
         }
 
+
+        /// <summary>
+        /// Helper method that returns if the table that stores the user name and ports relation is 
+        /// present in the db.
+        /// </summary>
+        /// <returns>A boolean value stating if the UserPorts table is present in the db.</returns>
+        private bool UserPortsTableExists()
+        {
+            // query the sqlite schema using and ado template
+            var template = new AdoTemplate(DbProvider);
+            var result = template.Execute(
+                command =>
+                    {
+                        command.CommandText = "SELECT count(*) FROM sqlite_master WHERE type='table' AND name=:tableName;";
+                        var parameter = command.CreateParameter();
+                        parameter.ParameterName = ":tableName";
+                        parameter.Value = UserPortsTableName;
+                        command.Parameters.Add(parameter);
+                        var count = command.ExecuteScalar();
+                        return (long)count != 0;
+                    }
+                );
+
+            return (bool)result;
+        }
+
+        /// <summary>
+        /// Helper method that will create the user porst table in the db when needed.
+        /// </summary>
+        private void CreateUserPortsTable()
+        {
+            // create the table using an ado template.
+            var template = new AdoTemplate(DbProvider);
+            template.ExecuteNonQuery( CommandType.Text, 
+                String.Format("CREATE TABLE IF NOT EXISTS {0}('Username' TEXT PRIMARY KEY, 'PythonPort' INT, 'DotNetPort' INT);",
+                UserPortsTableName));
+        }
+
+        /// <summary>
+        /// Helper method that adds a new pair of ports for a user in the db.
+        /// </summary>
+        /// <param name="username">The name of the user whose ports we are going to insert.</param>
+        /// <param name="pythonPort">The port to be used to talk to python.</param>
+        /// <param name="dotNetPort">The port to be used to talk to dotNet.</param>
+        private void InserUserPortsInDb(string username, int pythonPort, int dotNetPort)
+        {
+            var template = new AdoTemplate(DbProvider);
+            template.Execute(
+                command =>
+                    {
+                        command.CommandText = String.Format(
+                            "INSERT INTO {0}(Username, PythonPort, DotNetPort) VALUES (:username, :pythonPort, :dotNetPort)",
+                            UserPortsTableName);
+                        var usernameParam = command.CreateParameter();
+                        usernameParam.ParameterName = ":username";
+                        usernameParam.Value = username;
+                        command.Parameters.Add(usernameParam);
+
+                        var pythonParam = command.CreateParameter();
+                        pythonParam.ParameterName = ":pythonPort";
+                        pythonParam.Value = pythonPort;
+                        command.Parameters.Add(pythonParam);
+
+                        var dotNetParam = command.CreateParameter();
+                        dotNetParam.ParameterName = ":dotNetPort";
+                        dotNetParam.Value = dotNetPort;
+                        command.Parameters.Add(dotNetParam);
+
+                        return command.ExecuteScalar();
+                    }
+                );
+        }
+
+        /// <summary>
+        /// Helper method that allows to retrieve the ports of a user from the db. If the data cannot be retrieved from 
+        /// the db.
+        /// </summary>
+        /// <param name="username">The username whose ports we want to retrieve.</param>
+        /// <param name="pythonPort">Out parameter used to return the port used to talk with python.</param>
+        /// <param name="dotNetPort">Out parameter used to return the port used to talk with dot net.</param>
+        /// <returns>A boolean flag that indicates if the data could have been retrieved from the db.</returns>
+        private bool TryGetUserPortFromDb(string username, out int pythonPort, out int dotNetPort)
+        {
+            // try to get the ports from the db, if it is not possible we return false
+            var template = new AdoTemplate(DbProvider);
+            try
+            {
+                var userPorts = (UserPorts)template.Execute(
+                    command =>
+                        {
+                            command.CommandText =
+                                String.Format("SELECT PythonPort, DotNetPort FROM {0} WHERE Username=:username;",
+                                              UserPortsTableName);
+                            var parameter = command.CreateParameter();
+                            parameter.ParameterName = ":username";
+                            parameter.Value = username;
+                            command.Parameters.Add(parameter);
+                            var reader = command.ExecuteReader();
+                            while (reader.Read())
+                            {
+                                return new UserPorts(System.Convert.ToInt32((long) reader["PythonPort"]), 
+                                    System.Convert.ToInt32((long) reader["DotNetPort"]));
+                            }
+                            return new UserPorts(-1, -1);
+                        }
+                    );
+                pythonPort = userPorts.PythonPort;
+                dotNetPort = userPorts.DotNetPort;
+                return false;
+            }
+            catch(Exception)
+            {
+                // an exception will be thrown if we cannot get the data from the db, therefore we return false
+                pythonPort = -1;
+                dotNetPort = -1;
+                return false;
+            }
+        }
+
         #endregion
 
         #region Constructors