Merge lp:~cszikszoy/do/NetworkService into lp:do

[Chris S.]

[Chris S. (cszikszoy)]

Fix for https://bugs.edge.launchpad.net/bugs/324484 - Add network connection info to Do.Platform

This patch adds a generic Network service to Do.Platform and a NetworkManager implementation to Do.Platform.Linux

The Network service contains one boolean property (IsConnected) and an event (StateChanged).

Do.Universe.Element was updated and given a boolean property NetAccessRequired. This property defaults to false. Elements (Actions or ItemSources) requiring network access should override this and set it to true.

Do.Core.UniverseManager was also updated to be connection state aware. If no network connection is active, Elements (Actions or ItemSources) requiring network access will be removed from universe. When a network connection is re-established, those items will be added back.

[David Siegel (djsiegel-deactivatedaccount)]

Removing elements from the Universe is not a good solution. Users will have no idea why they cannot find items and actions that are usually there.

Also, adding a boolean to Element is not appropriate.

review: Disapprove

[David Siegel (djsiegel-deactivatedaccount)]

However, the Network service seems like a reasonable way to let plugins know when they should stop trying (and failing) to talk to the network. Remove the universe stuff and we can take another look.

[lp:~cszikszoy/do/NetworkService]

1222. By Chris S. on 2009-06-17

remove code removing items from universe

1223. By Chris S. on 2009-06-17

remove more network checking

1224. By Chris S. on 2009-06-18

merge trunk

=== modified file 'Do.Platform.Linux/Do.Platform.Linux.mdp'
--- Do.Platform.Linux/Do.Platform.Linux.mdp	2009-06-05 19:45:45 +0000
+++ Do.Platform.Linux/Do.Platform.Linux.mdp	2009-06-10 05:30:30 +0000
@@ -49,6 +49,7 @@
     <File name="src/Do.Platform/Do.Platform.Linux/Do.Platform.Linux.DBus/Registrar.cs" subtype="Code" buildaction="Compile" />
     <File name="src/Do.Platform/Do.Platform.Linux/SystemService.cs" subtype="Code" buildaction="Compile" />
     <File name="src/Do.Universe/NullApplicationItem.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/Do.Platform/Do.Platform.Linux/NetworkService.cs" subtype="Code" buildaction="Compile" />
   </Contents>
   <References>
     <ProjectReference type="Gac" localcopy="True" refto="System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
 
=== modified file 'Do.Platform.Linux/Makefile.am'
--- Do.Platform.Linux/Makefile.am	2009-05-29 01:26:23 +0000
+++ Do.Platform.Linux/Makefile.am	2009-06-10 05:30:30 +0000
@@ -21,6 +21,7 @@
 	src/Do.Platform/Do.Platform.Linux/TrayIconPreferences.cs \
 	src/Do.Platform/Do.Platform.Linux/TrayIconService.cs \
 	src/Do.Platform/Do.Platform.Linux/UniverseFactoryService.cs \
+	src/Do.Platform/Do.Platform.Linux/NetworkService.cs \
 	src/Do.Universe/ApplicationItem.cs \
 	src/Do.Universe/CategoryItem.cs \
 	src/Do.Universe/NullApplicationItem.cs \
 
=== modified file 'Do.Platform.Linux/Resources/Do.Platform.Linux.addin.xml'
--- Do.Platform.Linux/Resources/Do.Platform.Linux.addin.xml	2009-02-17 22:48:40 +0000
+++ Do.Platform.Linux/Resources/Do.Platform.Linux.addin.xml	2009-06-10 05:30:30 +0000
@@ -23,6 +23,7 @@
 		<Service type="Do.Platform.Common.EventsOnlyNotificationsService" />
 
 		<Service type="Do.Platform.Linux.SystemService" />
+		<Service type="Do.Platform.Linux.NetworkService" />
 		<Service type="Do.Platform.Linux.TrayIconService" />
 		<Service type="Do.Platform.Linux.ConsoleLogService" />
 		<Service type="Do.Platform.Linux.EnvironmentService" />
 
=== added file 'Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/NetworkService.cs'
--- Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/NetworkService.cs	1970-01-01 00:00:00 +0000
+++ Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/NetworkService.cs	2009-06-10 16:44:20 +0000
@@ -0,0 +1,94 @@
+// NetworkService.cs
+//
+// GNOME Do is the legal property of its developers. Please refer to the
+// COPYRIGHT file distributed with this source distribution.
+//
+// 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.Reflection;
+
+using NDesk.DBus;
+using org.freedesktop.DBus;
+
+using Do.Platform.ServiceStack;
+using Do.Platform.Linux.DBus;
+
+namespace Do.Platform.Linux
+{
+	
+	public class NetworkService : INetworkService
+	{
+		const string NetworkManagerName = "org.freedesktop.NetworkManager";
+		const string NetworkManagerPath = "/org/freedesktop/NetworkManager";
+		
+		[Interface(NetworkManagerName)]
+		interface INetworkManager : org.freedesktop.DBus.Properties
+		{
+			event StateChangedHandler StateChanged;
+		}
+		
+		delegate void StateChangedHandler (uint state);
+		
+		INetworkManager network;
+		
+		public event EventHandler<NetworkStateChangedEventArgs> StateChanged;
+		
+		public NetworkService ()
+		{
+			try {
+				BusG.Init ();
+				if (Bus.System.NameHasOwner (NetworkManagerName)) {
+					network = Bus.System.GetObject<INetworkManager> (NetworkManagerName, new ObjectPath (NetworkManagerPath));
+					network.StateChanged += OnStateChanged;
+				}
+			} catch (Exception e) {
+				Log<NetworkService>.Error ("Could not initialize dbus: {0}", e.Message);
+				Log<NetworkService>.Debug (e.StackTrace);
+			}
+			
+			SetConnected ();
+		}
+
+		void OnStateChanged (uint state)
+		{
+			NetworkState newState = (NetworkState) Enum.ToObject (typeof (NetworkState), state);
+			SetConnected ();
+			if (StateChanged != null) {
+				StateChanged (this, new NetworkStateChangedEventArgs (newState));
+			}
+		}
+		
+		void SetConnected ()
+		{
+			if (this.State == NetworkState.Connected)
+				IsConnected = true;
+			else
+				IsConnected = false;
+		}
+		
+		NetworkState State {
+			get	{ 
+				return (NetworkState) Enum.ToObject (typeof (NetworkState), network.Get (NetworkManagerName, "State"));
+			}
+		}
+		
+		#region INetworkService
+
+		public bool IsConnected { get; private set; }
+
+		#endregion
+	}
+}
 \ No newline at end of file
 
=== modified file 'Do.Platform/Do.Platform.mdp'
--- Do.Platform/Do.Platform.mdp	2009-06-05 19:45:45 +0000
+++ Do.Platform/Do.Platform.mdp	2009-06-10 05:30:30 +0000
@@ -76,6 +76,9 @@
     <File name="src/System/Linq/EnumerableExtensions.cs" subtype="Code" buildaction="Compile" />
     <File name="src/Do.Platform/AbstractSystemService.cs" subtype="Code" buildaction="Compile" />
     <File name="src/Do.Platform/Do.Platform.Default/DefaultSystemService.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/Do.Platform/INetworkService.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/Do.Platform/NetworkStateChangedEventArgs.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/Do.Platform/Do.Platform.Default/NetworkService.cs" subtype="Code" buildaction="Compile" />
   </Contents>
   <References>
     <ProjectReference type="Gac" localcopy="True" refto="System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
 
=== modified file 'Do.Platform/Makefile.am'
--- Do.Platform/Makefile.am	2009-02-17 21:58:50 +0000
+++ Do.Platform/Makefile.am	2009-06-10 05:30:30 +0000
@@ -25,6 +25,7 @@
 	src/Do.Platform/Do.Platform.Default/SecurePreferencesService.cs \
 	src/Do.Platform/Do.Platform.Default/UniverseFactoryService.cs \
 	src/Do.Platform/Do.Platform.Default/WindowingService.cs \
+	src/Do.Platform/Do.Platform.Default/NetworkService.cs \
 	src/Do.Platform/Do.Platform.Preferences/PreferencesFactory.cs \
 	src/Do.Platform/Do.Platform.Preferences/PreferencesImplementation.cs \
 	src/Do.Platform/Do.Platform.ServiceStack/IInitializedService.cs \
@@ -49,6 +50,8 @@
 	src/Do.Platform/PreferencesChangedEventArgs.cs \
 	src/Do.Platform/SecurePreferencesWrapper.cs \
 	src/Do.Platform/Services.cs \
+	src/Do.Platform/INetworkService.cs \
+	src/Do.Platform/NetworkStateChangedEventArgs.cs \
 	src/Do.Universe/Do.Universe.Common/EmailAction.cs \
 	src/Do.Universe/Do.Universe.Common/OpenAction.cs \
 	src/Do.Universe/Do.Universe.Common/OpenUrlAction.cs \
 
=== added file 'Do.Platform/src/Do.Platform/Do.Platform.Default/NetworkService.cs'
--- Do.Platform/src/Do.Platform/Do.Platform.Default/NetworkService.cs	1970-01-01 00:00:00 +0000
+++ Do.Platform/src/Do.Platform/Do.Platform.Default/NetworkService.cs	2009-06-10 05:30:30 +0000
@@ -0,0 +1,48 @@
+/* NetworkService.cs 
+ *
+ * GNOME Do is the legal property of its developers. Please refer to the
+ * COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * 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 Do.Platform;
+
+namespace Do.Platform.Default
+{
+	
+	public class NetworkService : INetworkService
+	{		
+		public event EventHandler<NetworkStateChangedEventArgs> StateChanged;
+		
+		public NetworkService ()
+		{
+			connected = true;
+		}
+		
+		bool connected; 
+		
+		#region INetworkService		
+
+		public bool IsConnected
+		{
+			get { return connected; }
+		}
+		
+		#endregion
+	}
+}
 
=== added file 'Do.Platform/src/Do.Platform/INetworkService.cs'
--- Do.Platform/src/Do.Platform/INetworkService.cs	1970-01-01 00:00:00 +0000
+++ Do.Platform/src/Do.Platform/INetworkService.cs	2009-06-10 05:30:30 +0000
@@ -0,0 +1,42 @@
+/* INetworkService.cs
+ *
+ * GNOME Do is the legal property of its developers. Please refer to the
+ * COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * 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 Do.Platform.ServiceStack;
+
+namespace Do.Platform
+{
+	
+	public enum NetworkState {
+		Unknown = 0,
+		Asleep,
+		Connecting,
+		Connected,
+		Disconnected
+	}
+	
+	public interface INetworkService : IService
+	{
+		event EventHandler<NetworkStateChangedEventArgs> StateChanged;
+		
+		bool IsConnected { get; }
+	}
+}
 \ No newline at end of file
 
=== added file 'Do.Platform/src/Do.Platform/NetworkStateChangedEventArgs.cs'
--- Do.Platform/src/Do.Platform/NetworkStateChangedEventArgs.cs	1970-01-01 00:00:00 +0000
+++ Do.Platform/src/Do.Platform/NetworkStateChangedEventArgs.cs	2009-06-10 05:30:30 +0000
@@ -0,0 +1,35 @@
+/* NetworkStatusChangedEventArgs.cs
+ *
+ * GNOME Do is the legal property of its developers. Please refer to the
+ * COPYRIGHT file distributed with this
+ * source distribution.
+ *
+ * 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;
+
+namespace Do.Platform {
+
+	public class NetworkStateChangedEventArgs : EventArgs
+	{
+		public NetworkState NewState { get; private set; }
+		
+		public NetworkStateChangedEventArgs (NetworkState newState)
+		{
+			NewState = newState;
+		}
+	}
+	
+}
 \ No newline at end of file
 
=== modified file 'Do.Platform/src/Do.Platform/Services.cs'
--- Do.Platform/src/Do.Platform/Services.cs	2009-02-17 21:58:50 +0000
+++ Do.Platform/src/Do.Platform/Services.cs	2009-06-10 05:30:30 +0000
@@ -43,6 +43,7 @@
 		static IEnvironmentService environment;
 		static INotificationsService notifications;
 		static IUniverseFactoryService universe_factory;
+		static INetworkService network;
 
 		/// <summary>
 		/// Initializes the class. Must be called after Mono.Addins is initialized; if this is
@@ -99,6 +100,8 @@
 				application = null;
 			if (service is AbstractSystemService)
 				system = null;
+			if (service is INetworkService)
+				network = null;
 		}
 
 		/// <summary>
@@ -175,6 +178,14 @@
 				return universe_factory;
 			}
 		}
+		
+		public static INetworkService Network {
+			get {
+				if (network == null)
+					network = LocateService<INetworkService, Default.NetworkService> ();
+				return network;
+			}
+		}	
 			
 		public static PreferencesFactory Preferences {
 			get {
 
=== modified file 'Do.Universe/src/Do.Universe/Element.cs'
--- Do.Universe/src/Do.Universe/Element.cs	2009-01-17 22:13:37 +0000
+++ Do.Universe/src/Do.Universe/Element.cs	2009-06-10 07:29:46 +0000
@@ -116,6 +116,14 @@
 		
 		public abstract string Icon { get; }
 		
+		/// <value>
+		/// Provides an indication of whether or not this element requires an active
+		/// network connection.
+		/// </value>
+		public virtual bool NetworkRequired {
+			get { return false; }
+		}
+		
 		public override int GetHashCode ()
 		{
 			return UniqueId.GetHashCode ();
 
=== modified file 'Do/src/Do.Core/UniverseManager.cs'
--- Do/src/Do.Core/UniverseManager.cs	2009-01-25 20:32:52 +0000
+++ Do/src/Do.Core/UniverseManager.cs	2009-06-10 07:42:46 +0000
@@ -80,6 +80,13 @@
 			update_thread = new Thread (new ThreadStart (UniverseUpdateLoop));
 			update_thread.IsBackground = true;
 			update_thread.Priority = ThreadPriority.Lowest;
+			
+			Services.Network.StateChanged += OnNetworkStateChanged;
+		}
+
+		void OnNetworkStateChanged (object sender, NetworkStateChangedEventArgs e)
+		{
+			Reload ();
 		}
 			
 		public void Initialize ()
@@ -190,11 +197,11 @@
 			Log<UniverseManager>.Debug ("Reloading actions...");
 			lock (universe) {
 				foreach (Act action in PluginManager.Actions) {
-					universe.Remove (action.UniqueId);
-				}
-				foreach (Act action in PluginManager.Actions) {
-						universe [action.UniqueId] = action;			
-				}
+					if (universe.ContainsKey (action.UniqueId))
+						universe.Remove (action.UniqueId);
+				}
+				foreach (Act action in PluginManager.Actions.Where (a => ShouldUpdate (a)))
+					universe [action.UniqueId] = action;
 			}
 		}
 		
@@ -211,24 +218,37 @@
 			if (source == null) throw new ArgumentNullException ("source");
 			
 			safeSource = source.RetainSafe ();
-			Log<UniverseManager>.Debug ("Reloading item source \"{0}\"...", safeSource.Name);
 			oldItems = safeSource.Items;
 			// We call UpdateItems outside of the lock so as not to block other
 			// threads in contention for the lock if UpdateItems blocks.
-			safeSource.UpdateItems ();
-			newItems = safeSource.Items;
+			if (ShouldUpdate (source)) {
+				Log<UniverseManager>.Debug ("Reloading item source \"{0}\"...", safeSource.Name);
+				safeSource.UpdateItems ();
+				newItems = safeSource.Items;
+			} else {
+				newItems = Enumerable.Empty<Item> ();
+			}
 			
 			lock (universe) {
 				foreach (Item item in oldItems) {
 					if (universe.ContainsKey (item.UniqueId))
 						universe.Remove (item.UniqueId);
 				}
+				//only add the items if no net access is required, or if it is, if we have net access
 				foreach (Item item in newItems) {
 					universe  [item.UniqueId] = item;
 				}
 			}
 		}
 		
+		bool ShouldUpdate (Element element)
+		{
+			if (element.NetworkRequired && !Services.Network.IsConnected)
+				return false;
+			else
+				return true;
+		}
+		
 		void ReloadUniverse ()
 		{
 			Log<UniverseManager>.Info ("Reloading universe...");