Hopeing this will fix a weird title thing I saw today
[quicknote] / src / libquicknote.py
index 371962e..624c4dd 100644 (file)
@@ -8,16 +8,18 @@ This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License version 2 as
 published by the Free Software Foundation.
 
-@todo Add an edit menu with select all, cut, copy, and paste
-@todo Add undo directly into the UI
 @todo Add Note Export (txt File) and Export All (json dump?)
-@todo Save word wrap and zoom setting 
+@todo Remove confirmation on deleting empty notes
+@todo Try to switch to more passive notifications (rather than message boxes)
 """
 
+from __future__ import with_statement
 
 import os
 import gc
 import logging
+import warnings
+import ConfigParser
 
 import gtk
 
@@ -33,6 +35,8 @@ try:
 except ImportError:
        osso = None
 
+import constants
+
 import libspeichern
 import libkopfzeile
 import libnotizen
@@ -45,17 +49,15 @@ except NameError:
        _ = lambda x: x
 
 
-class quicknoteclass(hildon.Program):
+class QuicknoteProgram(hildon.Program):
 
-       __pretty_app_name__ = "quicknote"
-       __app_name__ = "quicknote"
-       __version__ = "0.7.7"
+       _user_data = os.path.join(os.path.expanduser("~"), ".%s" % constants.__app_name__)
+       _user_settings = "%s/settings.ini" % _user_data
 
        def __init__(self):
-               super(quicknoteclass, self).__init__()
+               super(QuicknoteProgram, self).__init__()
 
-               home_dir = os.path.expanduser('~')
-               dblog = os.path.join(home_dir, "quicknote.log")
+               dblog = os.path.join(self._user_data, "quicknote.log")
 
                # define a Handler which writes INFO messages or higher to the sys.stderr
                console = logging.StreamHandler()
@@ -70,25 +72,30 @@ class quicknoteclass(hildon.Program):
                logging.info('Starting quicknote')
 
                if osso is not None:
-                       self._osso_c = osso.Context(self.__app_name__, self.__version__, False)
-                       self.device = osso.DeviceState(self._osso_c)
-                       self.device.set_device_state_callback(self._on_device_state_change, 0)
+                       self._osso_c = osso.Context(constants.__app_name__, constants.__version__, False)
+                       self._deviceState = osso.DeviceState(self._osso_c)
+                       self._deviceState.set_device_state_callback(self._on_device_state_change, 0)
                else:
                        self._osso_c = None
+                       self._deviceState = None
 
                #Get the Main Window, and connect the "destroy" event
-               self.window = hildon.Window()
-               self.add_window(self.window)
-
-               self.window.set_title(self.__pretty_app_name__)
-               self.window.connect("delete_event", self.delete_event)
-               self.window.connect("destroy", self.destroy)
-               self.window.connect("key-press-event", self.on_key_press)
-               self.window.connect("window-state-event", self.on_window_state_change)
-               self.window_in_fullscreen = False #The window isn't in full screen mode initially.
+               self._window = hildon.Window()
+               self.add_window(self._window)
 
-               self.db = libspeichern.Speichern()
-               self.prepare_sync_dialog()
+               if IS_HILDON:
+                       gtk.set_application_name(constants.__pretty_app_name__)
+               self._window.set_title(constants.__pretty_app_name__)
+               self._window.connect("delete_event", self._on_delete_event)
+               self._window.connect("destroy", self._on_destroy)
+               self._window.connect("key-press-event", self._on_key_press)
+               self._window.connect("window-state-event", self._on_window_state_change)
+               self._window_in_fullscreen = False #The window isn't in full screen mode initially.
+               self._isZoomEnabled = False
+
+               self._db = libspeichern.Speichern()
+               self._syncDialog = None
+               self._prepare_sync_dialog()
 
                #Create GUI main vbox
                vbox = gtk.VBox(homogeneous = False, spacing = 0)
@@ -102,15 +109,15 @@ class quicknoteclass(hildon.Program):
 
                menu_items = gtk.MenuItem(_("SQL History"))
                filemenu.append(menu_items)
-               menu_items.connect("activate", self.view_sql_history, None)
+               menu_items.connect("activate", self._on_view_sql_history, None)
 
                menu_items = gtk.MenuItem(_("Sync notes"))
                filemenu.append(menu_items)
-               menu_items.connect("activate", self.sync_notes, None)
+               menu_items.connect("activate", self._on_sync_notes, None)
 
                menu_items = gtk.MenuItem(_("Quit"))
                filemenu.append(menu_items)
-               menu_items.connect("activate", self.destroy, None)
+               menu_items.connect("activate", self._on_destroy, None)
 
                file_menu = gtk.MenuItem(_("File"))
                file_menu.show()
@@ -118,13 +125,13 @@ class quicknoteclass(hildon.Program):
 
                categorymenu = gtk.Menu()
 
-               menu_items = gtk.MenuItem(_("delete"))
+               menu_items = gtk.MenuItem(_("Delete"))
                categorymenu.append(menu_items)
-               menu_items.connect("activate", self.delete_Category, None)
+               menu_items.connect("activate", self._on_delete_category, None)
 
-               menu_items = gtk.MenuItem(_("move to category"))
+               menu_items = gtk.MenuItem(_("Move To Category"))
                categorymenu.append(menu_items)
-               menu_items.connect("activate", self.move_Category, None)
+               menu_items.connect("activate", self._on_move_category, None)
 
                category_menu = gtk.MenuItem(_("Category"))
                category_menu.show()
@@ -134,7 +141,7 @@ class quicknoteclass(hildon.Program):
 
                menu_items = gtk.MenuItem(_("Word Wrap"))
                viewmenu.append(menu_items)
-               menu_items.connect("activate", self.toggle_word_wrap, None)
+               menu_items.connect("activate", self._on_toggle_word_wrap, None)
                self._wordWrapEnabled = False
 
                view_menu = gtk.MenuItem(_("View"))
@@ -145,7 +152,7 @@ class quicknoteclass(hildon.Program):
 
                menu_items = gtk.MenuItem(_("About"))
                helpmenu.append(menu_items)
-               menu_items.connect("activate", self.show_about, None)
+               menu_items.connect("activate", self._on_show_about, None)
 
                help_menu = gtk.MenuItem(_("Help"))
                help_menu.show()
@@ -163,102 +170,166 @@ class quicknoteclass(hildon.Program):
                        menu = gtk.Menu()
                        for child in menu_bar.get_children():
                                child.reparent(menu)
-                       self.window.set_menu(menu)
+                       self._window.set_menu(menu)
                        menu_bar.destroy()
                else:
                        vbox.pack_start(menu_bar, False, False, 0)
 
                #Create GUI elements
-               self.topBox = libkopfzeile.Kopfzeile(self.db)
-               vbox.pack_start(self.topBox, False, False, 0)
+               self._topBox = libkopfzeile.Kopfzeile(self._db)
+               vbox.pack_start(self._topBox, False, False, 0)
+
+               self._notizen = libnotizen.Notizen(self._db, self._topBox)
+               vbox.pack_start(self._notizen, True, True, 0)
+               self._window.add(vbox)
 
-               self.notizen = libnotizen.Notizen(self.db, self.topBox)
-               vbox.pack_start(self.notizen, True, True, 0)
+               self._on_toggle_word_wrap()
 
-               self.window.add(vbox)
-               self.window.show_all()
-               self.toggle_word_wrap()
+               try:
+                       os.makedirs(self._user_data)
+               except OSError, e:
+                       if e.errno != 17:
+                               raise
+               self._window.show_all()
+               self._load_settings()
+
+       def main(self):
+               gtk.main()
+
+       def _save_settings(self):
+               config = ConfigParser.SafeConfigParser()
+               self.save_settings(config)
+               with open(self._user_settings, "wb") as configFile:
+                       config.write(configFile)
+
+       def save_settings(self, config):
+               config.add_section(constants.__pretty_app_name__)
+               config.set(constants.__pretty_app_name__, "wordwrap", str(self._wordWrapEnabled))
+               config.set(constants.__pretty_app_name__, "zoom", str(self._isZoomEnabled))
+               config.set(constants.__pretty_app_name__, "fullscreen", str(self._window_in_fullscreen))
+
+       def _load_settings(self):
+               config = ConfigParser.SafeConfigParser()
+               config.read(self._user_settings)
+               self.load_settings(config)
+
+       def load_settings(self, config):
+               try:
+                       self._wordWrapEnabled = config.getboolean(constants.__pretty_app_name__, "wordwrap")
+                       self._isZoomEnabled = config.getboolean(constants.__pretty_app_name__, "zoom")
+                       self._window_in_fullscreen = config.getboolean(constants.__pretty_app_name__, "fullscreen")
+               except ConfigParser.NoSectionError, e:
+                       warnings.warn(
+                               "Settings file %s is missing section %s" % (
+                                       self._user_settings,
+                                       e.section,
+                               ),
+                               stacklevel=2
+                       )
+
+               self._notizen.set_wordwrap(self._wordWrapEnabled)
+
+               self.enable_zoom(self._isZoomEnabled)
+
+               if self._window_in_fullscreen:
+                       self._window.fullscreen()
+               else:
+                       self._window.unfullscreen()
 
        def set_db_file(self, widget = None, data = None):
-               dlg = hildon.FileChooserDialog(parent=self.window, action=gtk.FILE_CHOOSER_ACTION_SAVE)
+               dlg = hildon.FileChooserDialog(parent=self._window, action=gtk.FILE_CHOOSER_ACTION_SAVE)
 
-               if self.db.ladeDirekt('datenbank'):
-                       dlg.set_filename(self.db.ladeDirekt('datenbank'))
+               if self._db.ladeDirekt('datenbank'):
+                       dlg.set_filename(self._db.ladeDirekt('datenbank'))
 
                dlg.set_title(_("Choose database file"))
                if dlg.run() == gtk.RESPONSE_OK:
                        fileName = dlg.get_filename()
-                       self.db.speichereDirekt('datenbank', fileName)
+                       self._db.speichereDirekt('datenbank', fileName)
+
+                       self._db.openDB()
+                       self._topBox.load_categories()
+                       self._notizen.load_notes()
+               dlg.destroy()
+
+       def _prepare_sync_dialog(self):
+               self._syncDialog = gtk.Dialog(_("Sync"), None, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, (gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
+
+               self._syncDialog.set_position(gtk.WIN_POS_CENTER)
+               sync = libsync.Sync(self._db, self._window, 50504)
+               self._syncDialog.vbox.pack_start(sync, True, True, 0)
+               self._syncDialog.set_size_request(500, 350)
+               self._syncDialog.vbox.show_all()
+               sync.connect("syncFinished", self._on_sync_finished)
+
+       def enable_zoom(self, zoomEnabled):
+               self._isZoomEnabled = zoomEnabled
+               if zoomEnabled:
+                       self._topBox.hide()
+                       self._notizen.show_history_area(False)
+               else:
+                       self._topBox.show()
+                       self._notizen.show_history_area(True)
 
-                       self.db.openDB()
-                       self.topBox.load_categories()
-                       self.notizen.load_notes()
-                       dlg.destroy()
+       def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
+               """
+               For system_inactivity, we have no background tasks to pause
 
-       def show_about(self, widget = None, data = None):
-               dialog = gtk.AboutDialog()
-               dialog.set_position(gtk.WIN_POS_CENTER)
-               dialog.set_name(self.__pretty_app_name__)
-               dialog.set_version(self.__version__)
-               dialog.set_copyright("")
-               dialog.set_website("http://axique.de/index.php?f=Quicknote")
-               comments = _("%s is a note taking program; it is optimised for quick save and search of notes") % self.__pretty_app_name__
-               dialog.set_comments(comments)
-               dialog.run()
-               dialog.destroy()
+               @note Hildon specific
+               """
+               if memory_low:
+                       gc.collect()
 
-       def view_sql_history(self, widget = None, data = None, data2 = None):
+               if save_unsaved_data or shutdown:
+                       self._save_settings()
+
+       def _on_window_state_change(self, widget, event, *args):
+               if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
+                       self._window_in_fullscreen = True
+               else:
+                       self._window_in_fullscreen = False
+
+       def _on_key_press(self, widget, event, *args):
+               if event.keyval == gtk.keysyms.F6:
+                       # The "Full screen" hardware key has been pressed 
+                       if self._window_in_fullscreen:
+                               self._window.unfullscreen ()
+                       else:
+                               self._window.fullscreen ()
+               elif event.keyval == gtk.keysyms.F7:
+                       # Zoom In
+                       self.enable_zoom(True)
+               elif event.keyval == gtk.keysyms.F8:
+                       # Zoom Out
+                       self.enable_zoom(False)
+
+       def _on_view_sql_history(self, widget = None, data = None, data2 = None):
                import libsqldialog
-               sqldiag = libsqldialog.sqlDialog(self.db)
+               sqldiag = libsqldialog.SqlDialog(self._db)
                res = sqldiag.run()
                sqldiag.hide()
-               if res == 444:
+               if res == sqldiag.EXPORT_RESPONSE:
                        logging.info("exporting sql")
 
-                       dlg = hildon.FileChooserDialog(parent=self.window, action=gtk.FILE_CHOOSER_ACTION_SAVE)
+                       dlg = hildon.FileChooserDialog(parent=self._window, action=gtk.FILE_CHOOSER_ACTION_SAVE)
 
                        dlg.set_title(_("Select SQL export file"))
                        if dlg.run() == gtk.RESPONSE_OK:
                                fileName = dlg.get_filename()
-                               dlg.destroy()
                                sqldiag.exportSQL(fileName)
-                       else:
-                               dlg.destroy()
+                       dlg.destroy()
 
                sqldiag.destroy()
 
-       def delete_Category(self, widget = None, data = None):
-               if self.topBox.get_category() == "%" or self.topBox.get_category() == "undefined":
-                       mbox = gtk.MessageDialog(None, gtk.DIALOG_MODAL, gtk.MESSAGE_ERROR, gtk.BUTTONS_OK, _("This category can not be deleted"))
-                       response = mbox.run()
-                       mbox.hide()
-                       mbox.destroy()
-                       return
-
-               mbox = gtk.MessageDialog(None, gtk.DIALOG_MODAL, gtk.MESSAGE_WARNING, gtk.BUTTONS_YES_NO, _("Are you sure to delete the current category?"))
-               response = mbox.run()
-               mbox.hide()
-               mbox.destroy()
-               if response == gtk.RESPONSE_YES:
-                       sql = "UPDATE notes SET category = ? WHERE category = ?"
-                       self.db.speichereSQL(sql, ("undefined", self.topBox.get_category()))
-                       sql = "DELETE FROM categories WHERE liste = ?"
-                       self.db.speichereSQL(sql, (self.topBox.get_category(), ))
-                       model = self.topBox.categoryCombo.get_model()
-                       pos = self.topBox.categoryCombo.get_active()
-                       if (pos>1):
-                               self.topBox.categoryCombo.remove_text(pos)
-                               self.topBox.categoryCombo.set_active(0)
-
-       def move_Category(self, widget = None, data = None):
-               dialog = gtk.Dialog(_("Choose category"), self.window, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, (gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT, gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
+       def _on_move_category(self, widget = None, data = None):
+               dialog = gtk.Dialog(_("Choose category"), self._window, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, (gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT, gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
 
                dialog.set_position(gtk.WIN_POS_CENTER)
                comboCategory = gtk.combo_box_new_text()
 
                comboCategory.append_text('undefined')
                sql = "SELECT id, liste FROM categories WHERE id = 0 ORDER BY liste"
-               rows = self.db.ladeSQL(sql)
+               rows = self._db.ladeSQL(sql)
                for row in rows:
                        comboCategory.append_text(row[1])
 
@@ -269,87 +340,81 @@ class quicknoteclass(hildon.Program):
 
                if dialog.run() == gtk.RESPONSE_ACCEPT:
                        n = comboCategory.get_active()
-                       if -1 < n and self.notizen.noteId != -1:
+                       if -1 < n and self._notizen.noteId != -1:
                                model = comboCategory.get_model()
                                active = comboCategory.get_active()
                                if active < 0:
                                        return None
                                cat_id = model[active][0]
 
-                               noteid, category, note = self.db.loadNote(self.notizen.noteId)
+                               noteid, category, note = self._db.loadNote(self._notizen.noteId)
                                #print noteid, category, cat_id
-                               self.db.saveNote(noteid, note, cat_id, pcdatum = None)
-                               self.topBox.category_combo_changed()
+                               self._db.saveNote(noteid, note, cat_id, pcdatum = None)
+                               self._topBox.category_combo_changed()
                        else:
-                               mbox = gtk.MessageDialog(self.window, gtk.DIALOG_MODAL, gtk.MESSAGE_ERROR, gtk.BUTTONS_OK, _("No note selected."))
+                               mbox = gtk.MessageDialog(self._window, gtk.DIALOG_MODAL, gtk.MESSAGE_ERROR, gtk.BUTTONS_OK, _("No note selected."))
                                response = mbox.run()
                                mbox.hide()
                                mbox.destroy()
 
                dialog.destroy()
 
-       def sync_finished(self, data = None, data2 = None):
-               self.topBox.load_categories()
-               self.notizen.load_notes()
+       def _on_delete_category(self, widget = None, data = None):
+               if self._topBox.get_category() == "%" or self._topBox.get_category() == "undefined":
+                       mbox = gtk.MessageDialog(None, gtk.DIALOG_MODAL, gtk.MESSAGE_ERROR, gtk.BUTTONS_OK, _("This category can not be deleted"))
+                       response = mbox.run()
+                       mbox.hide()
+                       mbox.destroy()
+                       return
 
-       def prepare_sync_dialog(self):
-               self.sync_dialog = gtk.Dialog(_("Sync"), None, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, (gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
+               mbox = gtk.MessageDialog(None, gtk.DIALOG_MODAL, gtk.MESSAGE_WARNING, gtk.BUTTONS_YES_NO, _("Are you sure to delete the current category?"))
+               response = mbox.run()
+               mbox.hide()
+               mbox.destroy()
+               if response == gtk.RESPONSE_YES:
+                       sql = "UPDATE notes SET category = ? WHERE category = ?"
+                       self._db.speichereSQL(sql, ("undefined", self._topBox.get_category()))
+                       sql = "DELETE FROM categories WHERE liste = ?"
+                       self._db.speichereSQL(sql, (self._topBox.get_category(), ))
+                       model = self._topBox.categoryCombo.get_model()
+                       pos = self._topBox.categoryCombo.get_active()
+                       if (pos>1):
+                               self._topBox.categoryCombo.remove_text(pos)
+                               self._topBox.categoryCombo.set_active(0)
 
-               self.sync_dialog.set_position(gtk.WIN_POS_CENTER)
-               sync = libsync.Sync(self.db, self.window, 50504)
-               self.sync_dialog.vbox.pack_start(sync, True, True, 0)
-               self.sync_dialog.set_size_request(500, 350)
-               self.sync_dialog.vbox.show_all()
-               sync.connect("syncFinished", self.sync_finished)
+       def _on_sync_finished(self, data = None, data2 = None):
+               self._topBox.load_categories()
+               self._notizen.load_notes()
 
-       def sync_notes(self, widget = None, data = None):
-               self.sync_dialog.run()
-               self.sync_dialog.hide()
+       def _on_sync_notes(self, widget = None, data = None):
+               self._syncDialog.run()
+               self._syncDialog.hide()
 
-       def toggle_word_wrap(self, *args):
+       def _on_toggle_word_wrap(self, *args):
                self._wordWrapEnabled = not self._wordWrapEnabled
-               self.notizen.set_wordwrap(self._wordWrapEnabled)
+               self._notizen.set_wordwrap(self._wordWrapEnabled)
 
-       def delete_event(self, widget, event, data = None):
+       def _on_delete_event(self, widget, event, data = None):
                return False
 
-       def destroy(self, widget = None, data = None):
-               self.db.close()
-               if self._osso_c:
-                       self._osso_c.close()
-               gtk.main_quit()
-
-       def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
-               """
-               For system_inactivity, we have no background tasks to pause
+       def _on_destroy(self, widget = None, data = None):
+               try:
+                       self._save_settings()
+                       self._db.close()
+                       if self._osso_c:
+                               self._osso_c.close()
+               finally:
+                       gtk.main_quit()
 
-               @note Hildon specific
-               """
-               if memory_low:
-                       gc.collect()
-
-               if save_unsaved_data or shutdown:
-                       pass
-
-       def on_window_state_change(self, widget, event, *args):
-               if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
-                       self.window_in_fullscreen = True
-               else:
-                       self.window_in_fullscreen = False
-
-       def on_key_press(self, widget, event, *args):
-               if event.keyval == gtk.keysyms.F6:
-                       # The "Full screen" hardware key has been pressed 
-                       if self.window_in_fullscreen:
-                               self.window.unfullscreen ()
-                       else:
-                               self.window.fullscreen ()
-               elif event.keyval == gtk.keysyms.F7:
-                       # Zoom In
-                       self.topBox.hide()
-               elif event.keyval == gtk.keysyms.F8:
-                       # Zoom Out
-                       self.topBox.show()
-
-       def main(self):
-               gtk.main()
+       def _on_show_about(self, widget = None, data = None):
+               dialog = gtk.AboutDialog()
+               dialog.set_position(gtk.WIN_POS_CENTER)
+               dialog.set_name(constants.__pretty_app_name__)
+               dialog.set_version(constants.__version__)
+               dialog.set_copyright("")
+               dialog.set_website("http://axique.de/index.php?f=Quicknote")
+               comments = _("%s is a note taking program; it is optimised for quick save and search of notes") % constants.__pretty_app_name__
+               dialog.set_comments(comments)
+               dialog.set_authors(["Christoph Wurstle <n800@axique.net>", "Ed Page <edpage@byu.net> (Blame him for the most recent bugs)"])
+               dialog.run()
+               dialog.destroy()