Merge lp:~cmulk/cardapio/firefox-bookmarks into lp:cardapio

[cmulk]

[lp:~cmulk/cardapio/firefox-bookmarks]

422. By me <me@me-laptop> on 2010-09-17

Fixed handling of file paths using os.path.join()

423. By me <me@me-laptop> on 2010-09-17

Added updating of bookmark list in plugin whenever Firefox is closed

424. By Clifton Mulkey on 2010-10-01

Fixed bug that occurs when firefox default profile folder is not explicitly set.

=== added file 'src/plugins/firefox_bookmarks.py'
--- src/plugins/firefox_bookmarks.py	1970-01-01 00:00:00 +0000
+++ src/plugins/firefox_bookmarks.py	2010-10-01 19:51:02 +0000
@@ -0,0 +1,134 @@
+import_error = None
+try:
+	import os
+	import sqlite3
+	import shutil
+	import gio
+	
+except Exception, exception:
+	import_error = exception
+	
+
+class CardapioPlugin (CardapioPluginInterface):
+	author = 'Cardapio Team'
+	name = _('Firefox Bookmarks')
+	description = _('Search for Firefox Bookmarks')
+
+	url = ''
+	help_text = ''
+	version = '1.0'
+
+	plugin_api_version = 1.39 
+
+	search_delay_type = None
+	category_name = _('Firefox Bookmarks')
+	category_icon = 'firefox'
+	category_tooltip   = _('Web bookmarks in Firefox')
+	
+	fallback_icon	  = 'html'
+
+	hide_from_sidebar = True 		
+
+
+	def __init__(self, cardapio_proxy):
+		'''	
+		This method is called when the plugin is enabled.
+		Nothing much to be done here except initialize variables and set loaded to True
+		'''
+		self.c = cardapio_proxy
+		
+		if import_error:
+			self.c.write_to_log(self, 'Could not import certain modules', is_error = True)
+			self.c.write_to_log(self, import_error, is_error = True)
+			self.loaded = False
+			return
+		
+		
+		self.build_bookmark_list()
+		lock_path = os.path.join(self.prof_path,'lock')
+		
+		#The lock file may not exist at first, but the monitor will
+		#detect when it is created and deleted
+		self.package_monitor = gio.File(lock_path).monitor_file()
+		self.package_monitor.connect('changed', self.on_lock_changed)
+		
+	   	self.loaded = True # set to true if everything goes well
+	   	
+	def search(self, text, result_limit):
+		results = []
+		self.current_query = text
+		text = text.lower()
+		
+		for item in self.item_list:
+			if len(results) >= result_limit: break
+			
+			if item['name'].lower().find(text) != -1:
+				results.append(item)
+		
+		self.c.handle_search_result(self, results, self.current_query)
+	
+	def build_bookmark_list(self):
+		
+		firefox_path = os.path.join(os.environ['HOME'],".mozilla/firefox")
+		ini_file = open(os.path.join(firefox_path,'profiles.ini'))
+		prof_list = ini_file.read().split()
+		ini_file.close()
+		
+		try:
+			prof_folder = prof_list[prof_list.index('Default=1') - 1].split('=')[1]
+			
+		except ValueError:
+			
+			try:
+				prof_folder = prof_list[prof_list.index('Name=default') + 2].split('=')[1]
+			
+			except ValueError:
+				self.c.write_to_log(self, 'Could not determine firefox profile folder',
+									is_error = True)
+				return
+			
+		self.prof_path = os.path.join(firefox_path,prof_folder)
+		
+		db_path = os.path.join(self.prof_path, 'places.sqlite')
+		
+		if not os.path.exists(db_path):
+			self.c.write_to_log(self, 'Could not find the bookmarks database', is_error = True)
+			return
+		
+		#places.sqlite is locked when firefox is running, so we must make
+		#a temporary copy to read the bookmarks from
+		db_copy_path = '%s.copy' % db_path
+		shutil.copy(db_path, db_copy_path)
+		
+		sql_conn = sqlite3.connect(db_copy_path)
+
+		sql_query = "SELECT moz_bookmarks.title, moz_places.url \
+					 FROM moz_bookmarks, moz_places  \
+					 WHERE moz_bookmarks.fk = moz_places.id AND moz_places.url NOT LIKE 'place:%'"
+					 
+		c = sql_conn.execute(sql_query)
+		
+		self.item_list = []
+		for row in c:
+			item = {
+					'name'		 : _('%s') % row[0],
+					'tooltip'	  : _('Go To \"%s\"') % row[0] ,
+					'icon name'	: 'html', 
+					'type'		 : 'xdg',
+					'command'	  : '%s' % row[1],
+					'context menu' : None,
+					}
+			self.item_list.append(item)
+		
+		sql_conn.close()
+		os.remove(db_copy_path)
+		
+	#TODO: Find a way to update plugin when bookmarks change in Firefox
+	
+	def on_lock_changed(self, monitor, file, other_file, event):
+		#Happens whenever Firefox is closed
+		if event == gio.FILE_MONITOR_EVENT_DELETED:
+			self.c.ask_for_reload_permission(self)	
+			
+	def on_reload_permission_granted(self):
+		self.build_bookmark_list()