b7afc39b1a865e52b1855764faeeccbd524e707a
[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.1"
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                 self._prefsDialog = gtk_toolbox.PreferencesDialog(self._widgetTree)
74
75                 self._app = None
76                 self._isFullScreen = False
77                 if hildon is not None:
78                         self._app = hildon.Program()
79                         self.__window = hildon.Window()
80                         self._widgetTree.get_widget("mainLayout").reparent(self.__window)
81                         self._app.add_window(self.__window)
82                         self._widgetTree.get_widget("usernameentry").set_property('hildon-input-mode', 7)
83                         self._widgetTree.get_widget("passwordentry").set_property('hildon-input-mode', 7|(1 << 29))
84
85                         gtkMenu = self._widgetTree.get_widget("mainMenubar")
86                         menu = gtk.Menu()
87                         for child in gtkMenu.get_children():
88                                 child.reparent(menu)
89                         self.__window.set_menu(menu)
90                         gtkMenu.destroy()
91
92                         self.__window.connect("key-press-event", self._on_key_press)
93                         self.__window.connect("window-state-event", self._on_window_state_change)
94                 else:
95                         pass # warnings.warn("No Hildon", UserWarning, 2)
96
97                 callbackMapping = {
98                         "on_doneit_quit": self._on_close,
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                 self._widgetTree.get_widget("connectMenuItem").connect("activate", lambda *args: self.switch_ui(self._defaultUIName))
161                 self._widgetTree.get_widget("preferencesMenuItem").connect("activate", self._on_prefs)
162
163         def display_error_message(self, msg):
164                 """
165                 @note UI Thread
166                 """
167                 error_dialog = gtk.MessageDialog(None, 0, gtk.MESSAGE_ERROR, gtk.BUTTONS_CLOSE, msg)
168
169                 def close(dialog, response, editor):
170                         editor.about_dialog = None
171                         dialog.destroy()
172                 error_dialog.connect("response", close, self)
173                 error_dialog.run()
174
175         def load_settings(self, config):
176                 """
177                 @note UI Thread
178                 """
179                 for todoUI in self._todoUIs.itervalues():
180                         try:
181                                 todoUI.load_settings(config)
182                         except ConfigParser.NoSectionError, e:
183                                 warnings.warn(
184                                         "Settings file %s is missing section %s" % (
185                                                 self._user_settings,
186                                                 e.section,
187                                         ),
188                                         stacklevel=2
189                                 )
190
191                 try:
192                         activeUIName = config.get(self.__pretty_app_name__, "active")
193                 except ConfigParser.NoSectionError, e:
194                         activeUIName = ""
195                         warnings.warn(
196                                 "Settings file %s is missing section %s" % (
197                                         self._user_settings,
198                                         e.section,
199                                 ),
200                                 stacklevel=2
201                         )
202
203                 try:
204                         self.switch_ui(activeUIName)
205                 except KeyError, e:
206                         self.switch_ui(self._defaultUIName)
207
208         def save_settings(self, config):
209                 """
210                 @note Thread Agnostic
211                 """
212                 config.add_section(self.__pretty_app_name__)
213                 config.set(self.__pretty_app_name__, "active", self._todoUI.name())
214
215                 for todoUI in self._todoUIs.itervalues():
216                         todoUI.save_settings(config)
217
218         def get_uis(self):
219                 return (ui for ui in self._todoUIs.iteritems())
220
221         def get_default_ui(self):
222                 return self._defaultUIName
223
224         def switch_ui(self, uiName):
225                 """
226                 @note UI Thread
227                 """
228                 newActiveUI = self._todoUIs[uiName]
229                 try:
230                         newActiveUI.login()
231                 except RuntimeError:
232                         return # User cancelled the operation
233
234                 self._todoUI.disable()
235                 self._todoUI = newActiveUI
236                 self._todoUI.enable()
237
238                 if uiName != self._fallbackUIName:
239                         self._defaultUIName = uiName
240
241         def _save_settings(self):
242                 """
243                 @note Thread Agnostic
244                 """
245                 config = ConfigParser.SafeConfigParser()
246                 self.save_settings(config)
247                 with open(self._user_settings, "wb") as configFile:
248                         config.write(configFile)
249
250         def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
251                 """
252                 For system_inactivity, we have no background tasks to pause
253
254                 @note Hildon specific
255                 """
256                 if memory_low:
257                         gc.collect()
258
259                 if save_unsaved_data or shutdown:
260                         self._save_settings()
261
262         def _on_connection_change(self, connection, event, magicIdentifier):
263                 """
264                 @note Hildon specific
265                 """
266                 import conic
267
268                 status = event.get_status()
269                 error = event.get_error()
270                 iap_id = event.get_iap_id()
271                 bearer = event.get_bearer_type()
272
273                 if status == conic.STATUS_CONNECTED:
274                         self._deviceIsOnline = True
275                         self.switch_ui(self._defaultUIName)
276                 elif status == conic.STATUS_DISCONNECTED:
277                         self._deviceIsOnline = False
278                         self.switch_ui(self._fallbackUIName)
279
280         def _on_window_state_change(self, widget, event, *args):
281                 """
282                 @note Hildon specific
283                 """
284                 if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
285                         self._isFullScreen = True
286                 else:
287                         self._isFullScreen = False
288
289         def _on_close(self, *args, **kwds):
290                 try:
291                         if self._osso is not None:
292                                 self._osso.close()
293
294                         self._save_settings()
295                 finally:
296                         gtk.main_quit()
297
298         def _on_paste(self, *args):
299                 pass
300
301         def _on_key_press(self, widget, event, *args):
302                 """
303                 @note Hildon specific
304                 """
305                 if event.keyval == gtk.keysyms.F6:
306                         if self._isFullScreen:
307                                 self.__window.unfullscreen()
308                         else:
309                                 self.__window.fullscreen()
310
311         def _on_logout(self, *args):
312                 self._todoUI.logout()
313                 self.switch_ui(self._fallbackUIName)
314
315         def _on_prefs(self, *args):
316                 self._prefsDialog.enable()
317                 try:
318                         self._prefsDialog.run(self)
319                 finally:
320                         self._prefsDialog.disable()
321
322         def _on_about_activate(self, *args):
323                 dlg = gtk.AboutDialog()
324                 dlg.set_name(self.__pretty_app_name__)
325                 dlg.set_version(self.__version__)
326                 dlg.set_copyright("Copyright 2008 - LGPL")
327                 dlg.set_comments("")
328                 dlg.set_website("http://doneit.garage.maemo.org")
329                 dlg.set_authors(["Ed Page"])
330                 dlg.run()
331                 dlg.destroy()
332
333
334 def run_doctest():
335         import doctest
336
337         failureCount, testCount = doctest.testmod()
338         if not failureCount:
339                 print "Tests Successful"
340                 sys.exit(0)
341         else:
342                 sys.exit(1)
343
344
345 def run_doneit():
346         gtk.gdk.threads_init()
347
348         if hildon is not None:
349                 gtk.set_application_name(DoneIt.__pretty_app_name__)
350         handle = DoneIt()
351         gtk.main()
352
353
354 class DummyOptions(object):
355
356         def __init__(self):
357                 self.test = False
358
359
360 if __name__ == "__main__":
361         if len(sys.argv) > 1:
362                 try:
363                         import optparse
364                 except ImportError:
365                         optparse = None
366
367                 if optparse is not None:
368                         parser = optparse.OptionParser()
369                         parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
370                         (commandOptions, commandArgs) = parser.parse_args()
371         else:
372                 commandOptions = DummyOptions()
373                 commandArgs = []
374
375         if commandOptions.test:
376                 run_doctest()
377         else:
378                 run_doneit()