Merge lp:~joehillen/do-plugins/FirefoxKeywordSearch into lp:do-plugins

[JoE]

[JoE (joehillen)]

Integrated Smart Keyword Search action into Firefox plugin.

An outline of the feature is here:
http://do.davebsd.com/wiki/index.php?title=FirefoxKeywordSearch_Plugin
I will integrate this description into the "Firefox Plugin" page, once this is merged.

The mailing list discussion of this plugin is here:
http://groups.google.com/group/gnome-do/browse_thread/thread/effb0a87336aa8f?hl=en

[lp:~joehillen/do-plugins/FirefoxKeywordSearch]

676. By JoE on 2009-11-30

Minor fixes to Firefox plugin

Unmerged revisions

676. By JoE on 2009-11-30

Minor fixes to Firefox plugin

675. By JoE on 2009-11-28

Add Keyword Search feature to Firefox Plugin

=== modified file 'Firefox/Makefile.am'
--- Firefox/Makefile.am	2009-06-22 04:05:16 +0000
+++ Firefox/Makefile.am	2009-11-30 09:33:10 +0000
@@ -7,10 +7,16 @@
 	src/BrowseHistoryItem.cs \
 	src/FolderItem.cs \
 	src/PlaceItem.cs \
-	src/PlacesItemSource.cs
+	src/PlacesItemSource.cs \
+	src/FirefoxDB.cs \
+	src/KeywordSearch.cs \
+	src/IKeywordSearchItem.cs \
+	src/KeywordSearchItem.cs
 
 RESOURCES = \
-	Resources/Firefox.addin.xml
+	Resources/Firefox.addin.xml \
+	Resources/icons/firefox-search-icon.png \
+	Resources/icons/search-icon.png
 
 REFERENCES = \
 	System \
 
=== modified file 'Firefox/Resources/Firefox.addin.xml.in'
--- Firefox/Resources/Firefox.addin.xml.in	2009-06-26 15:47:18 +0000
+++ Firefox/Resources/Firefox.addin.xml.in	2009-11-30 09:33:10 +0000
@@ -1,10 +1,10 @@
 <Addin
 	id="Firefox"
 	namespace="Do"
-	version="3.0"
+	version="3.5"
 	name="Firefox"
-	description="Search Firefox 3 bookmarks, bookmark directories, and history."
-	author="David Siegel, Neal Stewart, Alex Launi"
+	description="Search Firefox 3 bookmarks, history, and use Smart Keyword searches."
+	author="David Siegel, Neal Stewart, Alex Launi, Joe Hillenbrand"
 	category="Official"
 	defaultEnabled="false"
     url="http://do.davebsd.com/wiki/Firefox_Plugin"
@@ -23,4 +23,8 @@
 	<Extension path="/Do/ItemSource">
 		<ItemSource type="Firefox.PlacesItemSource" />
 	</Extension>
+	
+	<Extension path="/Do/Action">
+		<Action type="Firefox.KeywordSearch"/>
+	</Extension>
 </Addin>
 
=== added directory 'Firefox/Resources/icons'
=== added file 'Firefox/Resources/icons/firefox-search-icon.png'
 Binary files Firefox/Resources/icons/firefox-search-icon.png	1970-01-01 00:00:00 +0000 and Firefox/Resources/icons/firefox-search-icon.png	2009-11-30 09:33:10 +0000 differ
=== added file 'Firefox/Resources/icons/search-icon.png'
 Binary files Firefox/Resources/icons/search-icon.png	1970-01-01 00:00:00 +0000 and Firefox/Resources/icons/search-icon.png	2009-11-30 09:33:10 +0000 differ
=== added file 'Firefox/src/FirefoxDB.cs'
--- Firefox/src/FirefoxDB.cs	1970-01-01 00:00:00 +0000
+++ Firefox/src/FirefoxDB.cs	2009-11-30 09:33:10 +0000
@@ -0,0 +1,89 @@
+// FirefoxDB.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.IO;
+using System.Data;
+using System.Linq;
+using System.Collections.Generic;
+
+using Do.Platform;
+using Do.Platform.Common;
+using Do.Universe;
+using Do.Universe.Common;
+
+using Mono.Addins;
+using Mono.Data.SqliteClient;
+	
+namespace Firefox
+{
+	/// <summary>
+	/// This is a class of helper functions moved from PlacesItemSource 
+	/// so that they can be shared with FirefoxKeywordSearch
+	/// </summary>
+	public static class FirefoxDB
+	{
+		const string BeginProfileName = "Path=";
+		const string BeginDefaultProfile = "Default=1";
+		
+		public static bool IsFirefox (Item item) 
+		{
+			return item.Equals (Do.Platform.Services.UniverseFactory.MaybeApplicationItemFromCommand ("firefox"));
+		}
+		
+		/// <summary>
+		/// Looks in the firefox profiles file (~/.mozilla/firefox/profiles.ini)
+		/// for the name of the default profile, and returns the path to the
+		/// default profile.
+		/// </summary>
+		/// <returns>
+		/// A <see cref="System.String"/> containing the absolute path to the
+		/// bookmarks.html file of the default firefox profile for the current
+		/// user.
+		/// </returns>
+		public static string FirefoxDBPath
+		{
+			get {
+				string line, profile, home;
+				string path = "";
+				if (path == "") {
+					profile = null;
+					home = Environment.GetFolderPath (Environment.SpecialFolder.Personal);
+			
+					path = Path.Combine (home, ".mozilla/firefox/profiles.ini");
+					using (StreamReader r = File.OpenText (path)) {
+						while ((line = r.ReadLine ()) != null) {
+							if (line.StartsWith (BeginDefaultProfile)) {
+								break;
+							} else if (line.StartsWith (BeginProfileName)) {
+								line = line.Trim ();
+								line = line.Substring (BeginProfileName.Length);
+								profile = line;
+							}
+						}
+					}
+					path = new [] {home, ".mozilla", "firefox", profile, "places.sqlite"}.Aggregate (Path.Combine); 
+				}
+				return path;
+			}
+		}
+		
+
+	}
+}
 
=== added file 'Firefox/src/IKeywordSearchItem.cs'
--- Firefox/src/IKeywordSearchItem.cs	1970-01-01 00:00:00 +0000
+++ Firefox/src/IKeywordSearchItem.cs	2009-11-30 09:33:10 +0000
@@ -0,0 +1,40 @@
+//  IKeywordSearchItem.cs
+//  by Joe Hillenbrand <[e-mail]>
+//
+//  GNOME Do is the legal property of its developers, whose names are too numerous
+//  to list here.  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 Do.Universe;
+
+namespace Firefox
+{	
+	public interface IKeywordSearchItem : IItem
+	{
+		string Url { get; }
+		
+		/// <summary>
+		/// Build a search URL for this OpenSearch item using the provided search terms.
+		/// </summary>
+		/// <param name="searchTerms">
+		/// The search terms to use in the URL template.
+		/// </param>
+		/// <returns>
+		/// A formatted search URL, using the provided search terms.
+		/// </returns>
+		string BuildSearchUrl (string searchTerms);
+	}
+}
 
=== added file 'Firefox/src/KeywordSearch.cs'
--- Firefox/src/KeywordSearch.cs	1970-01-01 00:00:00 +0000
+++ Firefox/src/KeywordSearch.cs	2009-11-30 09:33:10 +0000
@@ -0,0 +1,149 @@
+// KeywordSearch.cs
+// by Joe Hillenbrand <[e-mail]>
+//
+// This is the Action for the FirefoxKeywordSearch plugin
+//
+// 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.IO;
+using System.Data;
+using System.Linq;
+using System.Collections.Generic;
+
+using Do.Platform;
+using Do.Platform.Common;
+using Do.Universe;
+using Do.Universe.Common;
+
+using Mono.Addins;
+using Mono.Data.SqliteClient;
+
+namespace Firefox {
+
+	public class KeywordSearch : Act {
+
+		public override string Name {
+			get { return AddinManager.CurrentLocalizer.GetString ("Firefox Keyword Search"); }
+		}
+
+		public override string Description {
+			get { return AddinManager.CurrentLocalizer.GetString ("Search the Web using Firefox's Smart Keywords."); }
+		}
+
+		public override string Icon {
+			get { return "firefox-search-icon.png@" + GetType ().Assembly.FullName; }
+		}
+		
+		public override IEnumerable<Type> SupportedItemTypes {
+			get { yield return typeof (ITextItem);	}
+		}
+		
+		public override IEnumerable<Type> SupportedModifierItemTypes {
+			get { yield return typeof (IKeywordSearchItem);	}
+		}
+                
+        public override bool ModifierItemsOptional {
+            get { return false; }
+        }
+		
+		public override IEnumerable<Item> DynamicModifierItemsForItem (Item item)
+		{
+			Log<Firefox>.Debug("Indexing Keyword Search items...");
+			using (IDbConnection dbcon = (IDbConnection) new SqliteConnection (ConnectionString)) {
+				dbcon.Open ();
+				
+				using (IDbCommand dbcmd = dbcon.CreateCommand ()) {
+					dbcmd.CommandText =  "SELECT DISTINCT moz_keywords.keyword, moz_bookmarks.title, moz_places.url FROM moz_places "
+						+ "LEFT OUTER JOIN moz_bookmarks ON moz_places.id=moz_bookmarks.fk "
+						+ "JOIN moz_keywords ON moz_keywords.id=moz_bookmarks.keyword_id "
+						+ "WHERE moz_places.url LIKE '%\\%s%' ESCAPE '\\' ORDER BY moz_places.frecency DESC "
+						+ "LIMIT 500";
+						
+					using (IDataReader reader = dbcmd.ExecuteReader ()) {
+						while (reader.Read () ) {		
+							string keyword = (string)reader.GetValue (0);		
+							string title = (string)reader.GetValue (1);
+							string url = (string)reader.GetValue (2);
+							
+							// Firefox stores some interesting non-url places. Ignore them.
+							if (url [0] != 'p') {
+								if (string.IsNullOrEmpty (title)) {
+									yield return new KeywordSearchItem (keyword, url, url);
+								} else {
+									yield return new KeywordSearchItem (keyword, title + " [" + url + "] " , url);
+								}
+							}
+						}
+					}
+				}
+				// this shouldn't be necessary, but: https://bugzilla.novell.com/show_bug.cgi?id=499864
+				dbcon.Close ();
+			}
+		}
+		
+		public override IEnumerable<Item> Perform (IEnumerable<Item> items, IEnumerable<Item> modItems)
+		{
+			foreach (Item i in items) {
+				string query = (i as ITextItem).Text;
+				foreach (Item modi in modItems)
+					Services.Environment.OpenUrl ((modi as KeywordSearchItem).BuildSearchUrl (query));
+			}
+			yield break;
+		}
+		
+		/// <summary>
+		/// Looks at the file currently saved in the temp folder and sees if it
+		/// needs to be updated.
+		/// </summary>
+		/// <returns>
+		/// The path of the current database file in memory.
+		/// </returns>
+		string stored_temp_db_path;
+		
+		string TempDatabasePath {
+			get {				
+				// Check if the stored temp file exists and if it doesn't, make one.
+				if  (string.IsNullOrEmpty (stored_temp_db_path) || !File.Exists (stored_temp_db_path)) {
+					stored_temp_db_path = Path.GetTempFileName ();
+					System.IO.File.Copy (FirefoxDB.FirefoxDBPath, stored_temp_db_path, true);
+				} else if (File.Exists (stored_temp_db_path)) {
+					FileInfo firefoxDBFileInfo = new FileInfo (FirefoxDB.FirefoxDBPath);
+					FileInfo tempDBFileInfo = new FileInfo (stored_temp_db_path);
+					
+					if (firefoxDBFileInfo.LastWriteTimeUtc > tempDBFileInfo.LastWriteTimeUtc)
+						System.IO.File.Copy (FirefoxDB.FirefoxDBPath, stored_temp_db_path, true);
+				}
+				return stored_temp_db_path;
+			}
+		}
+		
+		/// <summary>
+		/// Creates the current SQL connection string to the temporary database in use. 
+		/// </summary>
+		/// <returns>
+		/// The current SQL connection string to the temporary database in use.
+		/// </returns>
+		string ConnectionString {
+			get { return String.Format ("URI=file:{0},version=3", TempDatabasePath); }
+		}
+		
+
+		
+	}
+}
 
=== added file 'Firefox/src/KeywordSearchItem.cs'
--- Firefox/src/KeywordSearchItem.cs	1970-01-01 00:00:00 +0000
+++ Firefox/src/KeywordSearchItem.cs	2009-11-30 09:33:10 +0000
@@ -0,0 +1,63 @@
+//  KeywordSearchItem.cs
+//  by Joe Hillenbrand <[e-mail]>
+//
+//  This is the Item for the FirefoxKeywordSearch plugin
+//
+//  GNOME Do is the legal property of its developers, whose names are too numerous
+//  to list here.  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 Do.Universe;
+
+namespace Firefox
+{
+	public class KeywordSearchItem : Item, IKeywordSearchItem
+	{
+		private string keyword, title, url;
+		
+		public KeywordSearchItem (string keyword, string title, string url)
+		{
+			this.keyword = keyword;
+			this.title = title;
+			this.url = url;
+		}
+		
+		public override string Name 
+		{ 
+			get { return keyword; } 
+		}
+		
+		public override string Description 
+		{ 
+			get { return "Search " + title; } 
+		}
+		
+		public override string Icon
+		{
+			get { return "search-icon.png@" + GetType ().Assembly.FullName; }
+		}
+		
+		public string Url
+		{
+			get { return url; }
+		}
+		
+		public string BuildSearchUrl (string query)
+		{
+			return Url.Replace ("%s",  query);
+		}
+	}
+}
 
=== modified file 'Firefox/src/PlaceItem.cs'
--- Firefox/src/PlaceItem.cs	2009-06-22 04:05:16 +0000
+++ Firefox/src/PlaceItem.cs	2009-11-30 09:33:10 +0000
@@ -27,7 +27,6 @@
 
 namespace Firefox
 {
-	
 	public class PlaceItem : Item, IBookmarkItem
 	{
 		string title, url;
 
=== modified file 'Firefox/src/PlacesItemSource.cs'
--- Firefox/src/PlacesItemSource.cs	2009-09-05 02:06:59 +0000
+++ Firefox/src/PlacesItemSource.cs	2009-11-30 09:33:10 +0000
@@ -43,15 +43,11 @@
 		IEnumerable<PlaceItem> places;
 		IEnumerable<FolderItem> folders;
 		
-		string stored_temp_db_path;
-		
 		public PlacesItemSource ()
 		{
 			items = new List<Item> ();
 			places = Enumerable.Empty<PlaceItem> ();			
 			folders = Enumerable.Empty<FolderItem> ();
-
-			ProfilePath = FindProfilePath ();
 		}
 
 		~PlacesItemSource ()
@@ -94,7 +90,7 @@
 
 		public override IEnumerable<Item> ChildrenOfItem (Item item) 
 		{
-			if (IsFirefox (item)) {
+			if (FirefoxDB.IsFirefox (item)) {
 				yield return new BrowseHistoryItem ();
 				yield return new BrowseBookmarkItem ();
 			} else if (item is BrowseBookmarkItem || item is BrowseHistoryItem) {
@@ -137,52 +133,6 @@
 			get { return places.Where (place => place.ParentId.HasValue); }
 		}
 		
-		bool IsFirefox (Item item) 
-		{
-			return item.Equals (Do.Platform.Services.UniverseFactory.MaybeApplicationItemFromCommand ("firefox"));
-		}
-		
-		/// <summary>
-		/// Looks in the firefox profiles file (~/.mozilla/firefox/profiles.ini)
-		/// for the name of the default profile, and returns the path to the
-		/// default profile.
-		/// </summary>
-		/// <returns>
-		/// A <see cref="System.String"/> containing the absolute path to the
-		/// bookmarks.html file of the default firefox profile for the current
-		/// user.
-		/// </returns>
-		string ProfilePath { get; set; }
-
-		string FindProfilePath ()
-		{
-			string line, profile, path, home;
-
-			profile = null;
-			home = Environment.GetFolderPath (Environment.SpecialFolder.Personal);
-			
-			path = Path.Combine (home, ".mozilla/firefox/profiles.ini");
-			using (StreamReader r = File.OpenText (path)) {
-				while ((line = r.ReadLine ()) != null) {
-					if (line.StartsWith (BeginDefaultProfile)) {
-						break;
-					} else if (line.StartsWith (BeginProfileName)) {
-						line = line.Trim ();
-						line = line.Substring (BeginProfileName.Length);
-						profile = line;
-					}
-				}
-			}
-			return new [] {home, ".mozilla", "firefox", profile}.Aggregate (Path.Combine); 
-		}
-
-
-		string FirefoxDBPath {
-			get {
-				return Path.Combine (ProfilePath, "places.sqlite");
-			}
-		}
-		
 		/// <summary>
 		/// Looks at the file currently saved in the temp folder and sees if it
 		/// needs to be updated.
@@ -190,18 +140,20 @@
 		/// <returns>
 		/// The path of the current database file in memory.
 		/// </returns>
+		string stored_temp_db_path;
+		
 		string TempDatabasePath {
 			get {				
 				// Check if the stored temp file exists and if it doesn't, make one.
 				if  (string.IsNullOrEmpty (stored_temp_db_path) || !File.Exists (stored_temp_db_path)) {
 					stored_temp_db_path = Path.GetTempFileName ();
-					System.IO.File.Copy (FirefoxDBPath, stored_temp_db_path, true);
+					System.IO.File.Copy (FirefoxDB.FirefoxDBPath, stored_temp_db_path, true);
 				} else if (File.Exists (stored_temp_db_path)) {
-					FileInfo firefoxDBFileInfo = new FileInfo (FirefoxDBPath);
+					FileInfo firefoxDBFileInfo = new FileInfo (FirefoxDB.FirefoxDBPath);
 					FileInfo tempDBFileInfo = new FileInfo (stored_temp_db_path);
 					
 					if (firefoxDBFileInfo.LastWriteTimeUtc > tempDBFileInfo.LastWriteTimeUtc)
-						System.IO.File.Copy (FirefoxDBPath, stored_temp_db_path, true);
+						System.IO.File.Copy (FirefoxDB.FirefoxDBPath, stored_temp_db_path, true);
 				}
 				return stored_temp_db_path;
 			}
@@ -309,4 +261,4 @@
 			}
 		}
 	}
-}
 \ No newline at end of file
+}