Merge lp:~igors/do-plugins/Thunderbird-fix into lp:do-plugins

[Igor Slepchin]

[Igor Slepchin (igors)]

This fixes Thunderbird plugin. The original problem was described in https://bugs.launchpad.net/do-plugins/+bug/305778 and was fixed by the first commit on the branch.

The rest of the changes add the following:

 * Support for multiple Thunderbird emails on a single ContactItem (ContactDetailItems are introduced)
 * Importing emails from Thunderbird history in addition to Thunderbird address book
 * Using the most used email for main ContactItem (as determined by Thunderbird's PopularityIndex)

I know the plugin is marked as "Community" but people still seem to distribute it (e.g., Fedora does).

[Chris Halse Rogers (raof)]

Bah. Sometimes, I hate bzr.

This branch looks like it's got some valuable improvements, but I can't actually pull it because of a repository version mismatch! If you could hit the “upgrade” button on your branch, it should convert it to a 2a repository, which I'll be able to pull.

It looks good, with the exception of the EmailList class. I'm not sure why you don't just pass a Dictionary<string, uint> around directly? The only value of EmailList appears to be .Add, which is only called once, and looks like it could replace with TryGetValue?

review: Needs Information

[Igor Slepchin (igors)]

Hey Chris - I clicked "upgrade" half a dozen times now but I'm not sure it's changed anything (upgrade button is still available and the repo is still marked as RepositoryFormatKnitPack6RichRoot (bzr 1.9)). Please let me know if this still does not work for you and I'll try to do the merge to the trunk locally or just re-publish it as a new branch (I still have the branch sources that I seem to be able to work with).

As for EmailList class, the primary motivation for it was overwriting Add method so that I didn't have to check if the key was already present in the Dictionary whenever I needed to update "popularity" value.

[Chris Halse Rogers (raof)]

Bah. No, it hasn't upgraded, so I'm still unable to pull from it.

Running “bzr upgrade --2a lp:~igors/do-plugins/Thunderbird-fix” might upgrade it properly, or you could (hopefully) push a new branch.

Ah. Somehow I didn't notice all the .Adds when doing my cursory review. I still find the class a bit of a heavyweight solution, so I might play around with some other options. I don't expect you to need to do any work there, though.

[Igor Slepchin (igors)]

bzr upgrade apparently worked, thanks!

I also merged this to the current trunk and re-pushed to https://code.launchpad.net/~igors/do-plugins/Thunderbird-fix-redux just in case so please let me know if either of these works for you.

[Chris Halse Rogers (raof)]

Excellent. That works.

I'll perform a more thorough review and merge.

[lp:~igors/do-plugins/Thunderbird-fix]

687. By Igor on 2011-02-08

Strip leading/trailing spaces and quotes from display names so that
multiple Thunderbird contacts get merged better.

[Igor Slepchin (igors)]

While I have your attention: do you think you could commit the fix for bug 698078 while at it? Thunderbird plugin is fairly useless if the email action itself does not work :p

=== modified file 'Thunderbird/Makefile.am'
--- Thunderbird/Makefile.am	2009-01-15 06:27:03 +0000
+++ Thunderbird/Makefile.am	2011-02-08 03:44:13 +0000
@@ -11,4 +11,5 @@
 
 REFERENCES = \
 	System \
-	$(DO_UNIVERSE_LIBS)
+	$(DO_UNIVERSE_LIBS) \
+	$(DO_PLATFORM_LIBS)

=== modified file 'Thunderbird/Thunderbird.mdp'
--- Thunderbird/Thunderbird.mdp	2009-06-23 00:52:54 +0000
+++ Thunderbird/Thunderbird.mdp	2011-02-08 03:44:13 +0000
@@ -22,5 +22,6 @@
   <References>
     <ProjectReference type="Gac" localcopy="True" refto="System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
     <ProjectReference type="Gac" localcopy="True" refto="Do.Universe, Version=0.9.0.0, Culture=neutral" />
+    <ProjectReference type="Gac" localcopy="True" refto="Do.Platform, Version=0.9.0.0, Culture=neutral" />
   </References>
 </Project>
\ No newline at end of file

=== modified file 'Thunderbird/src/ThunderbirdContactItemSource.cs'
--- Thunderbird/src/ThunderbirdContactItemSource.cs	2009-05-29 09:39:41 +0000
+++ Thunderbird/src/ThunderbirdContactItemSource.cs	2011-02-08 03:44:13 +0000
@@ -17,14 +17,13 @@
 //  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.IO;
 using System.Collections;
 using System.Collections.Generic;
 
 using Do.Universe;
+using Do.Platform;
 
 using Beagle.Util;
 
@@ -33,16 +32,107 @@
 
 	public class ThunderbirdContactItemSource : ItemSource
 	{
-		
-		const string BeginProfileName = "Path=";
+
+		class EmailContactDetail: Item, IContactDetailItem
+		{
+			readonly string		 detail, description;
+			readonly ContactItem owner;
+
+			public	EmailContactDetail (ContactItem owner, string detail)
+			{
+				this.owner	= owner;
+				this.detail = detail;
+				description = string.IsNullOrEmpty (owner["name"]) 
+							  ? owner[detail]
+							  : owner["name"];
+			}
+
+			public override string Name 
+			{
+				get	{ return owner[detail]; }
+			}
+
+			public override string Description
+			{
+				get { return description; }
+			}
+
+			public override string Icon
+			{
+				get { return "thunderbird"; }
+			}
+
+			public string Key 
+			{
+				get { return detail; }
+			}
+
+			public string Value
+			{
+				get { return owner[detail]; }
+			}
+		}
+
+		class EmailList
+		{
+			private Dictionary<string, uint> set;
+
+			public EmailList () { set = new Dictionary<string, uint> (); }
+
+			public void Add (string email, uint popularity)
+			{
+				if (!set.ContainsKey (email))
+				{
+					set.Add (email, popularity);
+				}
+				else
+				{
+					set[email] += popularity;
+				}
+			}
+
+			public bool Contains (string email)
+			{
+				return set.ContainsKey (email);
+			}
+
+			public uint this [string email]
+			{
+				get { return set[email]; }
+			}
+
+			public int Count {
+				get { return set.Count; }
+			}
+
+			public ICollection<string> Keys {
+				get { return set.Keys; }
+			}
+		}
+
+		class ThunderbirdEmail
+		{
+			public readonly string email;
+			public readonly uint   popularity;
+
+			public ThunderbirdEmail (string email, uint popularity)
+			{
+				this.email		= email;
+				this.popularity = popularity;
+			}
+		}
+
+
+		const string BeginProfileName	 = "Path=";
 		const string BeginDefaultProfile = "Name=default";
-		
-		List<Item> contacts;
+		const string THUNDERBIRD_EMAIL	 = "email.thunderbird";
+		static readonly char[] nameDelimiters      = { ' ', '\'', '"' };
+
+		Dictionary<string, Item> contacts; // name => ContactItem
 		
 		public ThunderbirdContactItemSource ()
 		{
-			contacts = new List<Item> ();
-			UpdateItems ();
+			contacts = new Dictionary<string, Item> ();
 		}
 		
 		public override IEnumerable<Type> SupportedItemTypes {
@@ -50,7 +140,7 @@
 				return new Type[] {
 					typeof (ContactItem),
 				};
-			}
+            }
 		}
 		
 		public override string Name { get { return "Thunderbird Contacts"; } }
@@ -62,73 +152,135 @@
 			try {
 				_UpdateItems ();
 			} catch (Exception e) {
-				Console.Error.WriteLine ("Cannot index Thunderbird contacts because a {0} was thrown: {1}", e.GetType (), e.Message);
+				Log<ThunderbirdContactItemSource>.Error ("Cannot index Thunderbird contacts because a {0} was thrown: {1}", e.GetType (), e.Message);
 				return;
 			}
 		}
 		
 		public override IEnumerable<Item> Items {
-			get { return contacts; }
+			get { return contacts.Values; }
 		}
 		
 		public override IEnumerable<Item> ChildrenOfItem (Item item)
 		{
+			ContactItem contact = item as ContactItem;
+
+			foreach (string detail in contact.Details)
+			{
+				if (detail.StartsWith (THUNDERBIRD_EMAIL))
+				{
+					yield return new EmailContactDetail (contact, detail);
+				}
+			}
 			yield break;
 		}
 		
 		void _UpdateItems ()
 		{
-			MorkDatabase database;
-		
+			MorkDatabase abook, history;
+			Dictionary<string, EmailList> emails = new Dictionary<string, EmailList> ();
+
+			abook = new MorkDatabase (GetThunderbirdAddressBookFilePath ());
+			abook.Read ();
+			abook.EnumNamespace = "ns:addrbk:db:row:scope:card:all";
+
+			history = new MorkDatabase (GetThunderbirdHistoryFilePath ());
+			history.Read ();
+			history.EnumNamespace = "ns:addrbk:db:row:scope:card:all";
+
+			addEmails (emails, history);
+			addEmails (emails, abook);
+
 			contacts.Clear ();
-			database = new MorkDatabase (GetThunderbirdAddressBookFilePath ());
-			database.Read ();
-			database.EnumNamespace = "ns:addrbk:db:row:scope:card:all";
+			foreach (string name in emails.Keys)
+			{
+				CreateThunderbirdContactItem (name, emails[name]);
+			}
+		}
 
-			foreach (string id in database) {
-				Hashtable contact_row;
-				ContactItem contact;
-				
-				contact_row = database.Compile (id, database.EnumNamespace);
-				contact = CreateThunderbirdContactItem (contact_row);
-				if (contact != null)
-					contacts.Add (contact);
+		void addEmails (Dictionary<string, EmailList> emails, MorkDatabase database)
+		{
+			foreach (string id in database)
+			{
+				Hashtable contact_row = database.Compile (id, database.EnumNamespace);
+				AddThunderbirdEmail (emails, contact_row);
 			}
 		}
 	
-		ContactItem CreateThunderbirdContactItem (Hashtable row) {
-			ContactItem contact;
+		void AddThunderbirdEmail (Dictionary<string, EmailList> emails, Hashtable row)
+		{
 			string name, email;
-			
-//			foreach (object o in row.Keys)
-//				Console.WriteLine ("\t{0} --> {1}", o, row[o]);
+			uint popularity;
 			
 			// I think this will detect deleted contacts... Hmm...
 			if (row["table"] == null || row["table"] as string == "C6")
-				return null;
+				return;
 			
 			// Name
 			name = row["DisplayName"] as string;
+			if (name != null) {
+				name = name.Trim (nameDelimiters);
+			}
 			if (name == null || name == string.Empty)
 				name = string.Format ("{0} {1}", row["FirstName"], row["LastName"]);
-			contact = ContactItem.Create (name);
 			
 			// Email
-			email = row["PrimaryEmail"] as string;
-			if (email != null && email != string.Empty)
-				contact["email"] = email;
+			email	 = row["PrimaryEmail"] as string;
+			string p = row["PopularityIndex"] as string;
+			try {
+				popularity =  UInt32.Parse (p, System.Globalization.NumberStyles.HexNumber);
+			}
+			catch (Exception) {
+				popularity = 0;
+			}
 			
-			return contact;
-		}
-		
-		string GetThunderbirdAddressBookFilePath ()
+			if (name == null || name.Trim () == string.Empty)
+				name = email;
+
+			if (string.IsNullOrEmpty (email))
+				return;
+
+			if (!emails.ContainsKey (name))
+			{
+				emails[name] = new EmailList ();
+			}
+			emails[name].Add (email, popularity);
+		}
+
+		void CreateThunderbirdContactItem (string name, EmailList emails)
+		{
+			int emailCount = emails.Count;
+			ThunderbirdEmail[] sortedEmails = new ThunderbirdEmail[emailCount];
+
+			int i = 0;
+			foreach (string key in emails.Keys)
+			{
+				sortedEmails[i] = new ThunderbirdEmail (key, emails[key]);
+				i++;
+			}
+			Array.Sort (sortedEmails, (x, y) => (int) (y.popularity - x.popularity));
+
+			ContactItem contact = ContactItem.Create (name);
+			for (i = 0; i < emailCount; i++)
+			{
+				string detail	= THUNDERBIRD_EMAIL + "." + i;
+				contact[detail] = sortedEmails[i].email;
+			}
+
+			if (!contacts.ContainsKey (name.ToLower ()))
+			{
+				contacts.Add (name.ToLower (), contact);
+			}
+		}
+
+		string GetThunderbirdDefaultProfilePath ()
 		{
 			string home, path, profile;
 			StreamReader reader;
 
 			profile = null;
 			home = System.Environment.GetFolderPath (System.Environment.SpecialFolder.Personal);
-			path = System.IO.Path.Combine (home, ".mozilla-thunderbird/profiles.ini");
+			path = System.IO.Path.Combine (home, ".thunderbird/profiles.ini");
 			try {
 				reader = System.IO.File.OpenText (path);
 			} catch {
@@ -148,16 +300,31 @@
 				}
 			}
 			reader.Close ();
-			
+			return profile;
+		}
+
+		string GetThunderbirdFilePath (string filename)
+		{
+			string path, home, profile;
+			home = System.Environment.GetFolderPath (System.Environment.SpecialFolder.Personal);
+			profile = GetThunderbirdDefaultProfilePath ();
 			if (profile == null) {
 				return null;
 			}
-			path = System.IO.Path.Combine (home, ".mozilla-thunderbird");
+			path = System.IO.Path.Combine (home, ".thunderbird");
 			path = System.IO.Path.Combine (path, profile);
-			path = System.IO.Path.Combine (path, "abook.mab");
+			path = System.IO.Path.Combine (path, filename);
 			return path;
-			
 		}
 		
+		string GetThunderbirdHistoryFilePath ()
+		{
+			return GetThunderbirdFilePath ("history.mab");
+		}
+
+		string GetThunderbirdAddressBookFilePath ()
+		{
+			return GetThunderbirdFilePath ("abook.mab");
+		}
 	}
 }