Merge lp:~cszikszoy/do/newdo-service-loading into lp:do/rewrite

[Chris S.]

[Alex Launi (alexlauni)]

1.) Please comment all classes to say overall what the class is for. Give a little design intro as to the reason for the class. If you think it's abundantly obvious make it short, but have a little something
1a.) What's the point of the Addins class? What is in there that should not just be in ServiceManager? If you think that the Actual Mono.Addins stuff should be its own class (which I think I agree with) then try and take the AddinManager calls out of Services and fully abstract it out.
2.)
+ try {
+ AddinManager.Initialize (pluginsPath);
+ } catch (Exception e) {
+ AddinManager.Registry.Rebuild (monitor);
+ AddinManager.Shutdown ();
+ AddinManager.Initialize (pluginsPath);
+ }
+
+ AddinManager.Registry.Update (monitor);

Why wouldn't the 2nd call to AddinManager throw the same exception the first one did? Why do you Rebuild, shutdown, and then initialize? Is it necessary to Update after the Rebuild, Shutdown, Init cycle? The Update seems needless. If there's a good reason for this please put it into a comment so that this is clearer.
3.) Why does the DBus csproj need a Mono.Addins reference?
4.) Use Hyena.Log class for logging.

review: Needs Fixing

Unmerged revisions

15. By Chris S. on 2010-08-24

lay the groundwork for loading of services via mono.addins

=== modified file 'src/Backends/DBus/DBus.csproj'
--- src/Backends/DBus/DBus.csproj	2010-08-23 00:27:07 +0000
+++ src/Backends/DBus/DBus.csproj	2010-08-24 06:58:42 +0000
@@ -47,6 +47,9 @@
     <Reference Include="nunit.framework, Version=2.4.7.0, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77">
       <Package>nunit</Package>
     </Reference>
+    <Reference Include="Mono.Addins, Version=0.4.0.0, Culture=neutral, PublicKeyToken=0738eb9f132ed756">
+      <Package>mono-addins</Package>
+    </Reference>
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\Core\Services\Services.csproj">

=== modified file 'src/Core/Base/Base.csproj'
--- src/Core/Base/Base.csproj	2010-08-22 23:25:06 +0000
+++ src/Core/Base/Base.csproj	2010-08-24 06:58:42 +0000
@@ -40,6 +40,7 @@
     <Reference Include="Hyena, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\..\..\..\..\..\..\..\usr\local\lib\hyena\Hyena.dll</HintPath>
+      <Package>banshee-1-hyena</Package>
     </Reference>
   </ItemGroup>
   <ItemGroup>
@@ -58,6 +59,7 @@
   <ItemGroup>
     <Compile Include="src\ServiceManager.cs" />
     <Compile Include="src\UniverseManager.cs" />
+    <Compile Include="src\Addins.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
 </Project>
\ No newline at end of file

=== added file 'src/Core/Base/src/Addins.cs'
--- src/Core/Base/src/Addins.cs	1970-01-01 00:00:00 +0000
+++ src/Core/Base/src/Addins.cs	2010-08-24 06:58:42 +0000
@@ -0,0 +1,130 @@
+//  
+//  AddinManager.cs
+//  
+//  Author:
+//       Chris Szikszoy <[e-mail]>
+// 
+//  Copyright (c) 2010 Do developers
+// 
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+// 
+//  This program 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 General Public License for more details.
+// 
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+using System;
+using System.Linq;
+using System.Collections.Generic;
+
+using Mono.Addins;
+using Hyena;
+
+namespace Do
+{
+	public class AddinStateChangedEventArgs : EventArgs
+	{
+		public Addin Addin { get; private set; }
+		
+		public AddinStateChangedEventArgs (Addin addin)
+		{
+			Addin = addin;
+		}
+	}
+	
+	public class Addins
+	{
+		static Addins ()
+		{
+		}
+		
+		#region public api
+		
+		public static event EventHandler<AddinStateChangedEventArgs> AddinStateChanged;
+		
+		public static void Initialize ()
+		{
+			string pluginsPath = ApplicationContext.CommandLine.Contains ("uninstalled")
+				    ? "." : Paths.ApplicationData;
+			IProgressStatus monitor = ApplicationContext.CommandLine.Contains ("debug-addins")
+				? new ConsoleProgressStatus (true)
+				: null;
+			
+			try {
+				AddinManager.Initialize (pluginsPath);
+			} catch (Exception e) {
+				AddinManager.Registry.Rebuild (monitor);
+				AddinManager.Shutdown ();
+				AddinManager.Initialize (pluginsPath);
+			}
+
+			AddinManager.Registry.Update (monitor);
+			
+			// Add feedback when addin is loaded or unloaded
+			AddinManager.AddinLoaded += AddinManagerAddinLoaded;
+			AddinManager.AddinUnloaded += AddinManagerAddinUnloaded;
+		}
+		
+		/// <summary>
+		/// All addins in the Addins registry.
+		/// </summary>
+		public static IEnumerable<Addin> AllAddins {
+			get {
+				return AddinManager.Registry.GetAddins ();
+			}
+		}
+		
+		#endregion
+		
+		static void OnStateChanged (Addin addin)
+		{
+			if (AddinStateChanged != null)
+				AddinStateChanged (null, new AddinStateChangedEventArgs (addin));
+		}
+		
+		static void AddinManagerAddinLoaded (object sender, AddinEventArgs args)
+		{
+			Addin addin = AddinFromID (args.AddinId);
+			OnStateChanged (addin);
+			//Log<PluginManager>.Info ("Loaded \"{0}\".", addin.Name);
+		}
+
+		static void AddinManagerAddinUnloaded (object sender, AddinEventArgs args)
+		{
+			Addin addin = AddinFromID (args.AddinId);
+			OnStateChanged (addin);
+			//Log<PluginManager>.Info ("Unloaded \"{0}\".", addin.Name);
+		}
+		
+		/// <summary>
+		/// Look up an addin by supplying the Addin ID.
+		/// </summary>
+		/// <param name="id">
+		/// A <see cref="System.String"/>
+		/// </param>
+		/// <returns>
+		/// A <see cref="Addin"/>
+		/// </returns>
+		public static Addin AddinFromID (string id)
+		{
+			return AddinManager.Registry.GetAddin (id);
+		}
+		
+		static T ObjectFromAddin<T> (string extensionPath, string addinID) where T : class
+		{
+			IEnumerable<TypeExtensionNode> nodes = AddinManager.GetExtensionNodes (extensionPath)
+				.OfType<TypeExtensionNode> ()
+				.Where (a => Addin.GetIdName (a.Addin.Id) == Addin.GetIdName (addinID));
+			
+			if (nodes.Any ())
+				return nodes.First ().GetInstance () as T;
+			return null;
+		}
+	}
+}

=== modified file 'src/Core/Base/src/ServiceManager.cs'
--- src/Core/Base/src/ServiceManager.cs	2010-08-22 23:25:06 +0000
+++ src/Core/Base/src/ServiceManager.cs	2010-08-24 06:58:42 +0000
@@ -20,6 +20,7 @@
 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 using System;
+using System.Linq;
 using System.Collections.Generic;
 
 using Mono.Addins;
@@ -28,47 +29,88 @@
 using Do.Services;
 
 namespace Do
-{
+{	
 	/// <summary>
 	/// Loads, and unloads the services that make Do run.
 	/// Three cheers for the service manager, all man right here.
 	/// </summary>
 	public class ServiceManager
 	{
-		public ServiceManager ()
-		{
-			InitializeAddins ();
+		
+		public static UniverseManager universe;
+		
+		static ServiceManager ()
+		{
+		}
+		
+		#region public API
+		
+		/// <summary>
+		/// Initializes the service manager, builds (or rebuilds) the addin registry and registers the services
+		/// </summary>
+		public static void Initialize ()
+		{
+			Addins.Initialize ();
+			
+			AddinManager.AddExtensionNodeHandler ("/Do/Service", OnServiceChanged);
+			
 			RegisterDefaultServices ();
 			RegisterServiceAddins ();
 		}
-
-		void InitializeAddins ()
-		{
-			AddinManager.Initialize (ApplicationContext.CommandLine.Contains ("uninstalled")
-				? "." : Paths.ApplicationData);
-
-			IProgressStatus monitor = ApplicationContext.CommandLine.Contains ("debug-addins")
-				? new ConsoleProgressStatus (true)
-				: null;
-
-			if (ApplicationContext.Debugging) {
-				AddinManager.Registry.Rebuild (monitor);
-			} else {
-				AddinManager.Registry.Update (monitor);
-			}
-		}
-
-		void RegisterServiceAddins ()
-		{
-		}
-
-		void RegisterDefaultServices ()
-		{
-		}
-		
-		void RegisterService (IService service)
+		
+		#region public services
+		
+		public static UniverseManager Universe {
+			get {
+				if (universe == null) {
+					IIpcUniverseProxy proxy = LoadService<IIpcUniverseProxy> ();
+					universe = new UniverseManager (proxy);
+				}
+				return universe;
+			}
+		}
+		
+		#endregion
+		
+		#endregion
+		
+		static void OnServiceChanged (object sender, ExtensionNodeEventArgs e)
+		{			
+			IService service = e.ExtensionObject as IService;
+
+			switch (e.Change) {
+			case ExtensionChange.Add:
+				if (service is IInitializedService)
+					(service as IInitializedService).Initialize ();
+				break;
+			case ExtensionChange.Remove:
+				break;
+			}
+			
+			if (service is IIpcUniverseProxy)
+				universe = null;
+		}
+		
+		static TService LoadService<TService> () where TService : class, IService
+		{
+			TService [] extensionObjects = AddinManager.GetExtensionObjects ("/Do/Service", true).OfType<TService> ();
+			
+			//FIXME: with logging framework...
+			/*
+			if (!extensionObjects.Any ())
+				fatal... ("no services of type TService found...")
+			if (extensionObjects.Count () > 1)
+				warn... ("more than 1 service of type TService found... only using the first")
+			*/
+			return extensionObjects.First ();
+		}
+
+		static void RegisterServiceAddins ()
+		{
+		}
+
+		static void RegisterDefaultServices ()
 		{
 		}
 	}
 }
-

=== modified file 'src/Core/Base/src/UniverseManager.cs'
--- src/Core/Base/src/UniverseManager.cs	2010-08-23 00:27:07 +0000
+++ src/Core/Base/src/UniverseManager.cs	2010-08-24 06:58:42 +0000
@@ -40,7 +40,7 @@
 		/// A <see cref="IIpcUniverseManager"/> proxy to the IPC service
 		/// that sources actually talk to.
 		/// </param>
-		public UniverseManager (IIpcUniverseProxy proxy)
+		internal UniverseManager (IIpcUniverseProxy proxy)
 		{
 		}
 

=== added directory 'src/Core/Services/Resources'
=== added file 'src/Core/Services/Resources/Do.Services.addin.xml'
--- src/Core/Services/Resources/Do.Services.addin.xml	1970-01-01 00:00:00 +0000
+++ src/Core/Services/Resources/Do.Services.addin.xml	2010-08-24 06:58:42 +0000
@@ -0,0 +1,9 @@
+<Addin id="Services" namespace="Do" version="1.0" isroot="true">
+	<Runtime>
+		<Import assembly="Do.Services.dll"/>
+	</Runtime>
+
+	<ExtensionPoint path="/Do/Service">
+		<ExtensionNode name="Service" objectType="Do.Services.IService"/>
+	</ExtensionPoint>
+</Addin>

=== modified file 'src/Core/Services/Services.csproj'
--- src/Core/Services/Services.csproj	2010-08-23 00:27:07 +0000
+++ src/Core/Services/Services.csproj	2010-08-24 06:58:42 +0000
@@ -35,6 +35,9 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="Mono.Addins, Version=0.4.0.0, Culture=neutral, PublicKeyToken=0738eb9f132ed756">
+      <Package>mono-addins</Package>
+    </Reference>
   </ItemGroup>
   <ItemGroup>
     <Compile Include="src\IExportable.cs" />
@@ -44,5 +47,9 @@
   </ItemGroup>
   <ItemGroup>
     <Folder Include="src\" />
+    <Folder Include="Resources\" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="Resources\Do.Services.addin.xml" />
   </ItemGroup>
 </Project>
\ No newline at end of file