1557c2fad9cde94ae91eb9d64130a3fb6d6fd055
[doneit] / src / doneit_glade.py
1 #!/usr/bin/python
2
3 """
4 @todo Add logging support to make debugging random user issues a lot easier
5 """
6
7 from __future__ import with_statement
8
9
10 import sys
11 import gc
12 import os
13 import threading
14 import warnings
15 import ConfigParser
16 import socket
17
18 import gtk
19 import gtk.glade
20
21 try:
22         import hildon
23 except ImportError:
24         hildon = None
25
26 import gtk_toolbox
27
28
29 socket.setdefaulttimeout(10)
30
31
32 class DoneIt(object):
33
34         __pretty_app_name__ = "DoneIt"
35         __app_name__ = "doneit"
36         __version__ = "0.3.0"
37         __app_magic__ = 0xdeadbeef
38
39         _glade_files = [
40                 '/usr/lib/doneit/doneit.glade',
41                 os.path.join(os.path.dirname(__file__), "doneit.glade"),
42                 os.path.join(os.path.dirname(__file__), "../lib/doneit.glade"),
43         ]
44
45         _user_data = os.path.expanduser("~/.%s/" % __app_name__)
46         _user_settings = "%s/settings.ini" % _user_data
47
48         def __init__(self):
49                 self._todoUIs = {}
50                 self._todoUI = None
51                 self._osso = None
52                 self._deviceIsOnline = True
53                 self._connection = None
54                 self._fallbackUIName = ""
55                 self._defaultUIName = ""
56
57                 for path in self._glade_files:
58                         if os.path.isfile(path):
59                                 self._widgetTree = gtk.glade.XML(path)
60                                 break
61                 else:
62                         self.display_error_message("Cannot find doneit.glade")
63                         gtk.main_quit()
64                 try:
65                         os.makedirs(self._user_data)
66                 except OSError, e:
67                         if e.errno != 17:
68                                 raise
69
70                 self._clipboard = gtk.clipboard_get()
71                 self.__window = self._widgetTree.get_widget("mainWindow")
72                 self.__errorDisplay = gtk_toolbox.ErrorDisplay(self._widgetTree)
73
74                 self._app = None
75                 self._isFullScreen = False
76                 if hildon is not None:
77                         self._app = hildon.Program()
78                         self.__window = hildon.Window()
79                         self._widgetTree.get_widget("mainLayout").reparent(self.__window)
80                         self._app.add_window(self.__window)
81                         self._widgetTree.get_widget("usernameentry").set_property('hildon-input-mode', 7)
82                         self._widgetTree.get_widget("passwordentry").set_property('hildon-input-mode', 7|(1 << 29))
83
84                         gtkMenu = self._widgetTree.get_widget("mainMenubar")
85                         menu = gtk.Menu()
86                         for child in gtkMenu.get_children():
87                                 child.reparent(menu)
88                         self.__window.set_menu(menu)
89                         gtkMenu.destroy()
90
91                         self.__window.connect("key-press-event", self._on_key_press)
92                         self.__window.connect("window-state-event", self._on_window_state_change)
93                 else:
94                         pass # warnings.warn("No Hildon", UserWarning, 2)
95
96                 callbackMapping = {
97                         "on_doneit_quit": self._on_close,
98                         "on_paste": self._on_paste,
99                         "on_about": self._on_about_activate,
100                 }
101                 self._widgetTree.signal_autoconnect(callbackMapping)
102
103                 if self.__window:
104                         if hildon is None:
105                                 self.__window.set_title("%s" % self.__pretty_app_name__)
106                         self.__window.connect("destroy", self._on_close)
107                         self.__window.show_all()
108
109                 backgroundSetup = threading.Thread(target=self._idle_setup)
110                 backgroundSetup.setDaemon(True)
111                 backgroundSetup.start()
112
113         def _idle_setup(self):
114                 # Barebones UI handlers
115                 import null_view
116                 with gtk_toolbox.gtk_lock():
117                         nullView = null_view.GtkNull(self._widgetTree)
118                         self._todoUIs[nullView.name()] = nullView
119                         self._todoUI = nullView
120                         self._todoUI.enable()
121                         self._fallbackUIName = nullView.name()
122
123                 # Setup maemo specifics
124                 try:
125                         import osso
126                 except ImportError:
127                         osso = None
128                 self._osso = None
129                 if osso is not None:
130                         self._osso = osso.Context(DoneIt.__app_name__, DoneIt.__version__, False)
131                         device = osso.DeviceState(self._osso)
132                         device.set_device_state_callback(self._on_device_state_change, 0)
133                 else:
134                         pass # warnings.warn("No OSSO", UserWarning, 2)
135
136                 try:
137                         import conic
138                 except ImportError:
139                         conic = None
140                 self._connection = None
141                 if conic is not None:
142                         self._connection = conic.Connection()
143                         self._connection.connect("connection-event", self._on_connection_change, self.__app_magic__)
144                         self._connection.request_connection(conic.CONNECT_FLAG_NONE)
145                 else:
146                         pass # warnings.warn("No Internet Connectivity API ", UserWarning)
147
148                 # Setup costly backends
149                 import rtm_view
150                 with gtk_toolbox.gtk_lock():
151                         rtmView = rtm_view.GtkRtMilk(self._widgetTree, self.__errorDisplay)
152                 self._todoUIs[rtmView.name()] = rtmView
153                 self._defaultUIName = rtmView.name()
154
155                 config = ConfigParser.SafeConfigParser()
156                 config.read(self._user_settings)
157                 with gtk_toolbox.gtk_lock():
158                         self.load_settings(config)
159
160         def display_error_message(self, msg):
161                 """
162                 @note UI Thread
163                 """
164                 error_dialog = gtk.MessageDialog(None, 0, gtk.MESSAGE_ERROR, gtk.BUTTONS_CLOSE, msg)
165
166                 def close(dialog, response, editor):
167                         editor.about_dialog = None
168                         dialog.destroy()
169                 error_dialog.connect("response", close, self)
170                 error_dialog.run()
171
172         def load_settings(self, config):
173                 """
174                 @note UI Thread
175                 """
176                 for todoUI in self._todoUIs.itervalues():
177                         try:
178                                 todoUI.load_settings(config)
179                         except ConfigParser.NoSectionError, e:
180                                 warnings.warn(
181                                         "Settings file %s is missing section %s" % (
182                                                 self._user_settings,
183                                                 e.section,
184                                         ),
185                                         stacklevel=2
186                                 )
187
188                 try:
189                         activeUIName = config.get(self.__pretty_app_name__, "active")
190                 except ConfigParser.NoSectionError, e:
191                         activeUIName = ""
192                         warnings.warn(
193                                 "Settings file %s is missing section %s" % (
194                                         self._user_settings,
195                                         e.section,
196                                 ),
197                                 stacklevel=2
198                         )
199
200                 try:
201                         self._switch_ui(activeUIName)
202                 except KeyError, e:
203                         self._switch_ui(self._defaultUIName)
204
205         def save_settings(self, config):
206                 """
207                 @note Thread Agnostic
208                 """
209                 config.add_section(self.__pretty_app_name__)
210                 config.set(self.__pretty_app_name__, "active", self._todoUI.name())
211
212                 for todoUI in self._todoUIs.itervalues():
213                         todoUI.save_settings(config)
214
215         def _switch_ui(self, uiName):
216                 """
217                 @note UI Thread
218                 """
219                 newActiveUI = self._todoUIs[uiName]
220                 try:
221                         newActiveUI.login()
222                 except RuntimeError:
223                         return # User cancelled the operation
224
225                 self._todoUI.disable()
226                 self._todoUI = newActiveUI
227                 self._todoUI.enable()
228
229                 if uiName != self._fallbackUIName:
230                         self._defaultUIName = uiName
231
232         def _save_settings(self):
233                 """
234                 @note Thread Agnostic
235                 """
236                 config = ConfigParser.SafeConfigParser()
237                 self.save_settings(config)
238                 with open(self._user_settings, "wb") as configFile:
239                         config.write(configFile)
240
241         def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
242                 """
243                 For system_inactivity, we have no background tasks to pause
244
245                 @note Hildon specific
246                 """
247                 if memory_low:
248                         gc.collect()
249
250                 if save_unsaved_data or shutdown:
251                         self._save_settings()
252
253         def _on_connection_change(self, connection, event, magicIdentifier):
254                 """
255                 @note Hildon specific
256                 """
257                 import conic
258
259                 status = event.get_status()
260                 error = event.get_error()
261                 iap_id = event.get_iap_id()
262                 bearer = event.get_bearer_type()
263
264                 if status == conic.STATUS_CONNECTED:
265                         self._deviceIsOnline = True
266                         self._switch_ui(self._defaultUIName)
267                 elif status == conic.STATUS_DISCONNECTED:
268                         self._deviceIsOnline = False
269                         self._switch_ui(self._fallbackUIName)
270
271         def _on_window_state_change(self, widget, event, *args):
272                 """
273                 @note Hildon specific
274                 """
275                 if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
276                         self._isFullScreen = True
277                 else:
278                         self._isFullScreen = False
279
280         def _on_close(self, *args, **kwds):
281                 try:
282                         if self._osso is not None:
283                                 self._osso.close()
284
285                         self._save_settings()
286                 finally:
287                         gtk.main_quit()
288
289         def _on_paste(self, *args):
290                 pass
291
292         def _on_key_press(self, widget, event, *args):
293                 """
294                 @note Hildon specific
295                 """
296                 if event.keyval == gtk.keysyms.F6:
297                         if self._isFullScreen:
298                                 self.__window.unfullscreen()
299                         else:
300                                 self.__window.fullscreen()
301
302         def _on_logout(self, *args):
303                 self._todoUI.logout()
304                 self._switch_ui(self._fallbackUIName)
305
306         def _on_about_activate(self, *args):
307                 dlg = gtk.AboutDialog()
308                 dlg.set_name(self.__pretty_app_name__)
309                 dlg.set_version(self.__version__)
310                 dlg.set_copyright("Copyright 2008 - LGPL")
311                 dlg.set_comments("")
312                 dlg.set_website("")
313                 dlg.set_authors([""])
314                 dlg.run()
315                 dlg.destroy()
316
317
318 def run_doctest():
319         import doctest
320
321         failureCount, testCount = doctest.testmod()
322         if not failureCount:
323                 print "Tests Successful"
324                 sys.exit(0)
325         else:
326                 sys.exit(1)
327
328
329 def run_doneit():
330         gtk.gdk.threads_init()
331
332         if hildon is not None:
333                 gtk.set_application_name(DoneIt.__pretty_app_name__)
334         handle = DoneIt()
335         gtk.main()
336
337
338 class DummyOptions(object):
339
340         def __init__(self):
341                 self.test = False
342
343
344 if __name__ == "__main__":
345         if len(sys.argv) > 1:
346                 try:
347                         import optparse
348                 except ImportError:
349                         optparse = None
350
351                 if optparse is not None:
352                         parser = optparse.OptionParser()
353                         parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
354                         (commandOptions, commandArgs) = parser.parse_args()
355         else:
356                 commandOptions = DummyOptions()
357                 commandArgs = []
358
359         if commandOptions.test:
360                 run_doctest()
361         else:
362                 run_doneit()