Merge lp:~gotopad/do-plugins/TimerApplet into lp:do-plugins

[gotopad]

[gotopad (gotopad)]

TimerApplet-Plugin for the TimerApplet for the GNOME panel (http://timerapplet.sourceforge.net/)

[Alex Launi (alexlauni)]

alphabetize your makefile sections. the files, refs, and resources should be listed in alphabetical order.

You also need to update some stuff for trunk, we no longer have an addin.xml but an addin.xml.in. There's not much difference, you just need to define a GetText localizer, look at another plugin and basically copy and paste.

You've got formatting issues in basically every file, both indentation/spacing as well as no new lines where there should be new lines. If you finish a method, put a newline before you start a new one. Make your code a work of art, not a scribble on the back of a notebook. Make sure you review the mono guidelines. We follow them with the exception of indentation we use 1 tab, and have a loose 120 char rule instead of 80 -> http://www.mono-project.com/Coding_Guidelines

TimerApplet.cs:

first off all interfaces should start with the letter I, so that should be ITimer.

You've hardcoded the ObjectPath to timer_3, this is terrible. That's not the least bit guaranteed. You need to ask "/net/sourceforge/timerapplet/TimerApplet/TimerManager" for a list of applets available, and it will give you an array of applets (like "applet_3"). You then need to use each one.

For your block where you've implemented the methods of the Timer interface, instead of putting a comment above each method, before the first put #region ITimer implementation and at the end put #endregion. This is general .NET style.

in HasOwner, you do a really roundabout way of doing an if/else. Just do an if/else.

Also, you call HasOwner for every one of your ITimer methods, this is going to cause you to get a new timer object every time! Why? Just get it once and cache it. Look at how the other plugins that use dbus do it. Pidgin, and banshee are two examples that come to mind instantly.

in PauseContinueTimer.cs and StopTimer.cs

In SupportsItem, you do an if () and then outside of that you just return false. You can save a level of indentation by doing
if (!item is PresetItem) return false; and then in the same block as SupportsItem do your work. Makes the code much more readable.

in StartTimer.cs

If all SupportsItem does is return true, you don't even need it. This is the default behaviour.

review: Needs Fixing

Unmerged revisions

624. By gotopad on 2009-06-11

Indentation corrected

623. By gotopad on 2009-06-11

Added TimerApplet to DoPlugins.mds

622. By gotopad on 2009-06-11

Added TimerApplet directory. Changed Makefile.am and configure.ac

=== modified file 'DoPlugins.mds'
--- DoPlugins.mds	2009-06-11 07:36:57 +0000
+++ DoPlugins.mds	2009-06-11 22:04:04 +0000
@@ -73,6 +73,7 @@
       <Entry build="True" name="Emesene" configuration="Debug" />
       <Entry build="True" name="Dropbox" configuration="Debug" />
       <Entry build="True" name="RemindMe" configuration="Debug" />
+      <Entry build="True" name="TimerApplet" configuration="Debug" />
     </Configuration>
     <Configuration name="Release" ctype="CombineConfiguration">
       <Entry build="True" name="Rhythmbox" configuration="Release" />
@@ -147,6 +148,7 @@
       <Entry build="True" name="Emesene" configuration="Release" />
       <Entry build="True" name="Dropbox" configuration="Release" />
       <Entry build="True" name="RemindMe" configuration="Release" />
+      <Entry build="True" name="TimerApplet" configuration="Release" />
     </Configuration>
   </Configurations>
   <StartMode startupentry="Rhythmbox" single="True">
@@ -222,6 +224,7 @@
     <Execute type="None" entry="Emesene" />
     <Execute type="None" entry="Dropbox" />
     <Execute type="None" entry="RemindMe" />
+    <Execute type="None" entry="TimerApplet" />
   </StartMode>
   <MonoDevelop.ChangeLogAddIn.ChangeLogInfo policy="UpdateNearestChangeLog" />
   <Entries>
@@ -297,5 +300,6 @@
     <Entry filename="Emesene/Emesene.mdp" />
     <Entry filename="Dropbox/Dropbox.mdp" />
     <Entry filename="RemindMe/RemindMe.mdp" />
+    <Entry filename="TimerApplet/TimerApplet.mdp" />
   </Entries>
 </Combine>
 \ No newline at end of file
 
=== modified file 'Makefile.am'
--- Makefile.am	2009-05-22 18:34:39 +0000
+++ Makefile.am	2009-06-11 21:13:44 +0000
@@ -64,6 +64,7 @@
 	TerminalServerClient \
 	Text \
 	Thunderbird \
+	TimerApplet \
 	TinyUrl \
 	Tracker \
 	Translate \
 
=== added directory 'TimerApplet'
=== added file 'TimerApplet/Makefile.am'
--- TimerApplet/Makefile.am	1970-01-01 00:00:00 +0000
+++ TimerApplet/Makefile.am	2009-06-11 21:13:44 +0000
@@ -0,0 +1,22 @@
+include $(top_srcdir)/build.rules.mk
+
+ASSEMBLY=TimerApplet
+
+FILES =  \
+	src/PresetItem.cs \
+	src/TimerAppletItemSource.cs \
+	src/DBusTimerApplet.cs \
+	src/StartTimer.cs \
+	src/StopTimer.cs \
+	src/PauseContinueTimer.cs
+
+RESOURCES = \
+	Resources/TimerApplet.addin.xml
+
+REFERENCES =  \
+	Mono.Posix \
+	System \
+	System.Core \
+	$(NDESK_DBUS_10_LIBS) \
+	$(DO_PLATFORM_LIBS) \
+	$(DO_UNIVERSE_LIBS)
 
=== added directory 'TimerApplet/Resources'
=== added file 'TimerApplet/Resources/TimerApplet.addin.xml'
--- TimerApplet/Resources/TimerApplet.addin.xml	1970-01-01 00:00:00 +0000
+++ TimerApplet/Resources/TimerApplet.addin.xml	2009-06-11 21:13:44 +0000
@@ -0,0 +1,28 @@
+<Addin 
+	id="TimerApplet"
+	namespace="Do"
+	version="1.0"
+	name="TimerApplet"
+	description="Starting Timer-Applet Presets"
+	author="goto"
+	category="Community"
+        >
+ 
+	<Runtime>
+		<Import assembly="TimerApplet.dll"/>
+	</Runtime>
+	
+	<Dependencies>
+		<Addin id="Universe" version="1.0" />
+	</Dependencies>
+	
+	<!-- Extensions included in this assembly -->
+	<Extension path="/Do/ItemSource">
+		<ItemSource type="TimerApplet.TimerAppletItemSource"/>
+	</Extension>
+    <Extension path="/Do/Action">
+        <Action type="TimerApplet.StartTimer"/>
+     	<Action type="TimerApplet.StopTimer"/>
+    	<Action type="TimerApplet.PauseContinueTimer"/>
+    </Extension>
+</Addin>
 
=== added file 'TimerApplet/TimerApplet.mdp'
--- TimerApplet/TimerApplet.mdp	1970-01-01 00:00:00 +0000
+++ TimerApplet/TimerApplet.mdp	2009-06-11 21:13:44 +0000
@@ -0,0 +1,34 @@
+<Project name="TimerApplet" fileversion="2.0" language="C#" targetFramework="2.0" ctype="DotNetProject">
+  <Configurations active="Debug">
+    <Configuration name="Debug" ctype="DotNetProjectConfiguration">
+      <Output directory="bin/Debug" assembly="TimerApplet" />
+      <Build debugmode="True" target="Library" />
+      <Execution runwithwarnings="True" consolepause="False" runtime="MsNet" />
+      <CodeGeneration compiler="Mcs" warninglevel="4" optimize="False" unsafecodeallowed="False" generateoverflowchecks="False" definesymbols="DEBUG" generatexmldocumentation="False" ctype="CSharpCompilerParameters" />
+    </Configuration>
+    <Configuration name="Release" ctype="DotNetProjectConfiguration">
+      <Output directory="bin/Release" assembly="TimerApplet" />
+      <Build debugmode="False" target="Library" />
+      <Execution runwithwarnings="True" consolepause="False" runtime="MsNet" />
+      <CodeGeneration compiler="Mcs" warninglevel="4" optimize="False" unsafecodeallowed="False" generateoverflowchecks="False" generatexmldocumentation="False" ctype="CSharpCompilerParameters" />
+    </Configuration>
+  </Configurations>
+  <Contents>
+    <File name="Resources" subtype="Directory" buildaction="Compile" />
+    <File name="src" subtype="Directory" buildaction="Compile" />
+    <File name="Resources/TimerApplet.addin.xml" subtype="Code" buildaction="Nothing" />
+    <File name="src/PresetItem.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/StartTimer.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/TimerAppletItemSource.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/DBusTimerApplet.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/StopTimer.cs" subtype="Code" buildaction="Compile" />
+    <File name="src/PauseContinueTimer.cs" subtype="Code" buildaction="Compile" />
+  </Contents>
+  <References>
+    <ProjectReference type="Gac" localcopy="True" refto="System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
+    <ProjectReference type="Gac" localcopy="True" refto="Mono.Posix, Version=2.0.0.0, Culture=neutral, PublicKeyToken=0738eb9f132ed756" />
+    <ProjectReference type="Gac" localcopy="True" refto="Do.Platform, Version=0.9.0.0, Culture=neutral, PublicKeyToken=null" />
+    <ProjectReference type="Gac" localcopy="True" refto="Do.Universe, Version=0.9.0.0, Culture=neutral, PublicKeyToken=null" />
+    <ProjectReference type="Gac" localcopy="True" refto="NDesk.DBus, Version=1.0.0.0, Culture=neutral, PublicKeyToken=f6716e4f9b2ed099" />
+  </References>
+</Project>
 \ No newline at end of file
 
=== added directory 'TimerApplet/src'
=== added file 'TimerApplet/src/DBusTimerApplet.cs'
--- TimerApplet/src/DBusTimerApplet.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/DBusTimerApplet.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+using NDesk.DBus;
+using org.freedesktop.DBus;
+
+namespace TimerApplet
+{
+	[Interface("net.sourceforge.timerapplet.TimerApplet.Timer")]
+	public interface Timer 
+    	{
+		void Start (string name, int hours, int minutes, int seconds);
+	        void Stop ();
+        	void PauseContinue ();
+    	}	
+	
+	public static class DBusTimerApplet
+	{
+		static Bus bus;
+		static string busName;
+		static ObjectPath path;
+		static Timer timer;
+		public struct ActualItem
+		{
+			public static PresetItem preset;
+			public static DateTime startTime;
+			public static DateTime endTime;
+		}
+		
+		static DBusTimerApplet ()
+		{
+			bus = Bus.Session;
+			busName = "net.sourceforge.timerapplet.TimerApplet";
+                        path = new ObjectPath("/net/sourceforge/timerapplet/TimerApplet/Timers/applet_3");
+			timer = null;
+			ActualItem.preset = null;
+			
+		}
+		static bool HasOwner ()
+		{
+			if(!bus.NameHasOwner(busName)) {
+				bus.StartServiceByName(busName);
+		                System.Threading.Thread.Sleep(5000);
+            		}
+			if(bus.NameHasOwner(busName)) {
+				timer = bus.GetObject<Timer>(busName, path);
+				if(timer != null)
+					return true;
+			}
+			return false;
+		}
+		//Implementation of Timer.Start()
+		public static void Start (PresetItem preset)
+		{
+			if(HasOwner ()) {
+				if(preset != ActualItem.preset)	{
+					if(ActualItem.preset != null) {
+						ActualItem.preset.Status = PresetStatus.None;
+					}
+					preset.Status = PresetStatus.Started;
+					ActualItem.preset = preset;
+					ActualItem.startTime = DateTime.Now;
+					ActualItem.endTime = DateTime.Now.Add(new TimeSpan (preset.Hours, preset.Minutes, preset.Seconds));
+				}
+				timer.Start(preset.Name, preset.Hours, preset.Minutes, preset.Seconds);
+            		}			
+		}
+		//Implementation of Timer.Stop()
+		public static void Stop ()
+		{
+			if(HasOwner ()) {
+					timer.Stop ();
+					ActualItem.preset.Status = PresetStatus.None;
+					ActualItem.preset = null;
+            		}			
+		}
+		//Implementation of Timer.PauseContinue()
+		public static void  PauseContinue ()
+		{
+			if(HasOwner ())	{
+				timer.PauseContinue ();
+				if(ActualItem.preset.Status == PresetStatus.Started) {
+					ActualItem.preset.Status = PresetStatus.Paused;
+					
+					TimeSpan lostTime = DateTime.Now - ActualItem.startTime;
+					ActualItem.preset.Hours -= lostTime.Hours;
+					ActualItem.preset.Minutes -= lostTime.Minutes;
+					ActualItem.preset.Seconds -= lostTime.Seconds;
+				}
+				else {
+					ActualItem.preset.Status = PresetStatus.Started;
+					ActualItem.endTime = DateTime.Now.Add (new TimeSpan(ActualItem.preset.Hours, ActualItem.preset.Minutes, ActualItem.preset.Seconds));
+					ActualItem.startTime = DateTime.Now;
+				}
+			}
+		}
+		public static bool TimerFinished ()
+		{
+			if(DBusTimerApplet.ActualItem.endTime > DateTime.Now)
+				return true;
+			else {
+				ActualItem.preset.Status = PresetStatus.None;
+				 ActualItem.preset = null; // Timer finished => no actual item.
+				return false;
+			}
+		}
+		                         
+	}
+}
 
=== added file 'TimerApplet/src/PauseContinueTimer.cs'
--- TimerApplet/src/PauseContinueTimer.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/PauseContinueTimer.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,45 @@
+using System;
+using System.Linq;
+using System.Collections.Generic;
+
+using Mono.Unix;
+
+using Do.Universe;
+
+namespace TimerApplet
+{
+	class PauseContinueTimer : Act
+	{
+		public override string Name {
+			get { return Catalog.GetString("Pause or Continue an Timer"); }
+  		}
+        	public override string Description {
+        		get { return Catalog.GetString("Pauses or Continues the selected Timer"); }
+	         }
+	        public override string Icon {
+	         	get { return "timer-applet";}
+	        }
+	        public override IEnumerable<Type> SupportedItemTypes {
+	         	get { yield return typeof (PresetItem); }
+	        }
+			public override bool SupportsItem (Item item) // Only supports Started or Paused Presets
+			{
+				if(item is PresetItem) {
+					PresetItem preset = (item as PresetItem);
+					if(preset == DBusTimerApplet.ActualItem.preset)	{
+						if(preset.Status == PresetStatus.Started)
+							return DBusTimerApplet.TimerFinished();
+						if(preset.Status == PresetStatus.Paused)
+							return true;
+					}
+				}
+				return false;
+			}
+	        public override IEnumerable<Item> Perform (IEnumerable<Item> items, IEnumerable<Item> modifierItems)
+	        {
+			if(items.First () is PresetItem)
+				DBusTimerApplet.PauseContinue();
+	            yield break;
+	        }
+	}
+}
 
=== added file 'TimerApplet/src/PresetItem.cs'
--- TimerApplet/src/PresetItem.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/PresetItem.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,53 @@
+using Do.Universe;
+
+namespace TimerApplet
+{
+	public enum PresetStatus
+	{
+		None,
+		Started,
+		Paused
+	}
+        public class PresetItem : Item
+        {
+                string name;
+                int hours;
+                int minutes;
+                int seconds;
+		PresetStatus status;
+		
+                public PresetItem (string name, int hours, int minutes, int seconds)
+                {
+                        this.name = name;
+                        this.hours = hours;
+                        this.minutes = minutes;
+                        this.seconds = seconds;
+						this.status = PresetStatus.None;
+                }
+                public override string Name { 
+                        get { return string.Format ("{0} {1:D2}:{2:D2}:{3:D2}",name, hours, minutes, seconds); }
+                }
+                public int Hours {
+                        get { return hours; }
+						set { hours = value; }
+                }
+                public int Minutes {
+                        get { return minutes; }
+						set { minutes = value; }
+                }
+                public int Seconds {
+                        get { return seconds; }
+						set { seconds = value; }
+                }
+		public PresetStatus Status {
+			get { return status; }
+			set { this.status = value; }
+		}
+                public override string Description {
+                        get { return "Timer-Applet Preset: " + name; }
+                }
+                public override string Icon {
+                        get { return "timer-applet"; }
+                }
+        }
+}
 
=== added file 'TimerApplet/src/StartTimer.cs'
--- TimerApplet/src/StartTimer.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/StartTimer.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,36 @@
+using System;
+using System.Linq;
+using System.Collections.Generic;
+
+using Mono.Unix;
+
+using Do.Universe;
+
+namespace TimerApplet
+{
+        class StartTimer : Act
+        {
+                public override string Name {
+                        get { return Catalog.GetString ("Start an Timer"); }
+                }
+                public override string Description {
+                        get { return Catalog.GetString ("Starts the selected Timer"); }
+                }
+                public override string Icon {
+                        get { return "timer-applet";}
+                }
+                public override IEnumerable<Type> SupportedItemTypes {
+                        get { yield return typeof (PresetItem); }
+                }
+		public override bool SupportsItem (Item item) // Supports all Presets
+		{
+			return true;
+		}
+                public override IEnumerable<Item> Perform (IEnumerable<Item> items, IEnumerable<Item> modifierItems)
+                {
+			if(items.First () is PresetItem)
+				DBusTimerApplet.Start ((items.First () as PresetItem));
+        	        yield break;
+                }
+        }        
+}
 
=== added file 'TimerApplet/src/StopTimer.cs'
--- TimerApplet/src/StopTimer.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/StopTimer.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,46 @@
+using System;
+using System.Linq;
+using System.Collections.Generic;
+
+using Mono.Unix;
+
+using Do.Universe;
+
+namespace TimerApplet
+{
+	class StopTimer : Act
+	{
+		public override string Name {
+			get { return Catalog.GetString ("Stops an Timer"); }
+     		}
+	        public override string Description {
+	        	get { return Catalog.GetString ("Stops the selected Timer"); }
+	         }
+	        public override string Icon {
+	         	get { return "timer-applet"; }
+	        }
+	        public override IEnumerable<Type> SupportedItemTypes {
+	         	get { yield return typeof (PresetItem); }
+	        }
+			public override bool SupportsItem (Item item) // Only supports Started or Paused Presets
+			{
+				if(item is PresetItem)
+				{
+					PresetItem preset = (item as PresetItem);
+					if(preset == DBusTimerApplet.ActualItem.preset)	{
+						if(preset.Status == PresetStatus.Started)
+							return DBusTimerApplet.TimerFinished();
+						if(preset.Status == PresetStatus.Paused)
+							return true;
+					}
+				}
+				return false;
+			}
+	        public override IEnumerable<Item> Perform (IEnumerable<Item> items, IEnumerable<Item> modifierItems)
+	        {
+				if(items.First () is PresetItem)
+					DBusTimerApplet.Stop ();
+	            yield break;
+	        }
+	}
+}
 
=== added file 'TimerApplet/src/TimerAppletItemSource.cs'
--- TimerApplet/src/TimerAppletItemSource.cs	1970-01-01 00:00:00 +0000
+++ TimerApplet/src/TimerAppletItemSource.cs	2009-06-11 22:17:49 +0000
@@ -0,0 +1,65 @@
+using System;
+using System.IO;
+using System.Collections.Generic;
+using System.Text.RegularExpressions;
+
+using Mono.Unix;
+
+using Do.Platform;
+using Do.Universe;
+using Do.Universe.Common;
+
+namespace TimerApplet
+{
+        class TimerAppletItemSource : ItemSource
+        {
+                List<Item> items;
+
+                public TimerAppletItemSource ()
+                {
+                        items = new List<Item> ();
+                }
+
+                public override string Name {
+                        get { return Catalog.GetString ("Timer-Applet"); }
+                }
+                public override string Description {
+                        get { return Catalog.GetString ("Starting Timer-Applet Presets"); }
+                }
+                public override string Icon {
+                        get { return "timer-applet"; }
+                }
+                public override IEnumerable<Type> SupportedItemTypes {
+                        get { yield return typeof (Item); }
+                }
+                public override IEnumerable<Item> Items {
+                        get { return items; }
+                }
+
+                public override void UpdateItems ()
+                {
+                        string home = Environment.GetFolderPath (Environment.SpecialFolder.Personal);
+                        string path = "~/.gnome2/timer-applet/presets.xml".Replace ("~", home);
+
+                        items.Clear ();
+                        try {
+                                using(StreamReader streamReader = new StreamReader (path)) {
+                                        string file = streamReader.ReadToEnd ();
+                                        Regex regex = new Regex ("<preset duration=\"([0-9]*?)\" name=\"(.*?)\" />");
+                                        foreach(Match match in regex.Matches (file)) {
+                                                string name = match.Groups [2].ToString ();
+                                                int time = Convert.ToInt32(match.Groups [1].ToString ());
+                                                int seconds = time % 60;
+                                                int minutes = (time % 3600) / 60;
+                                                int hour = time / 3600;
+                                                items.Add(new PresetItem (name, hour, minutes, seconds));
+                                        }
+                                }
+                        }
+                        catch(Exception e) {
+                                Log.Error ("Could not read Presets file {0}: {1}", path, e.Message);
+                                Log.Debug (e.StackTrace);
+                        }
+                }
+        }
+}
 
=== modified file 'configure.ac'
--- configure.ac	2009-05-22 18:34:39 +0000
+++ configure.ac	2009-06-11 21:13:44 +0000
@@ -301,6 +301,7 @@
 TerminalServerClient/Makefile
 Text/Makefile
 Thunderbird/Makefile
+TimerApplet/Makefile
 TinyUrl/Makefile
 Tracker/Makefile
 Translate/Makefile