Switched to module level loggers
[gc-dialer] / src / gtk_toolbox.py
1 #!/usr/bin/python
2
3 from __future__ import with_statement
4
5 import os
6 import errno
7 import sys
8 import time
9 import itertools
10 import functools
11 import contextlib
12 import logging
13 import threading
14 import Queue
15
16 import gobject
17 import gtk
18
19
20 _moduleLogger = logging.getLogger("gtk_toolbox")
21
22
23 def get_screen_orientation():
24         width, height = gtk.gdk.get_default_root_window().get_size()
25         if width < height:
26                 return gtk.ORIENTATION_VERTICAL
27         else:
28                 return gtk.ORIENTATION_HORIZONTAL
29
30
31 def orientation_change_connect(handler, *args):
32         """
33         @param handler(orientation, *args) -> None(?)
34         """
35         initialScreenOrientation = get_screen_orientation()
36         orientationAndArgs = list(itertools.chain((initialScreenOrientation, ), args))
37
38         def _on_screen_size_changed(screen):
39                 newScreenOrientation = get_screen_orientation()
40                 if newScreenOrientation != orientationAndArgs[0]:
41                         orientationAndArgs[0] = newScreenOrientation
42                         handler(*orientationAndArgs)
43
44         rootScreen = gtk.gdk.get_default_root_window()
45         return gtk.connect(rootScreen, "size-changed", _on_screen_size_changed)
46
47
48 @contextlib.contextmanager
49 def flock(path, timeout=-1):
50         WAIT_FOREVER = -1
51         DELAY = 0.1
52         timeSpent = 0
53
54         acquired = False
55
56         while timeSpent <= timeout or timeout == WAIT_FOREVER:
57                 try:
58                         fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR)
59                         acquired = True
60                         break
61                 except OSError, e:
62                         if e.errno != errno.EEXIST:
63                                 raise
64                 time.sleep(DELAY)
65                 timeSpent += DELAY
66
67         assert acquired, "Failed to grab file-lock %s within timeout %d" % (path, timeout)
68
69         try:
70                 yield fd
71         finally:
72                 os.unlink(path)
73
74
75 @contextlib.contextmanager
76 def gtk_lock():
77         gtk.gdk.threads_enter()
78         try:
79                 yield
80         finally:
81                 gtk.gdk.threads_leave()
82
83
84 def find_parent_window(widget):
85         while True:
86                 parent = widget.get_parent()
87                 if isinstance(parent, gtk.Window):
88                         return parent
89                 widget = parent
90
91
92 def make_idler(func):
93         """
94         Decorator that makes a generator-function into a function that will continue execution on next call
95         """
96         a = []
97
98         @functools.wraps(func)
99         def decorated_func(*args, **kwds):
100                 if not a:
101                         a.append(func(*args, **kwds))
102                 try:
103                         a[0].next()
104                         return True
105                 except StopIteration:
106                         del a[:]
107                         return False
108
109         return decorated_func
110
111
112 def asynchronous_gtk_message(original_func):
113         """
114         @note Idea came from http://www.aclevername.com/articles/python-webgui/
115         """
116
117         def execute(allArgs):
118                 args, kwargs = allArgs
119                 with gtk_lock():
120                         original_func(*args, **kwargs)
121                 return False
122
123         @functools.wraps(original_func)
124         def delayed_func(*args, **kwargs):
125                 gobject.idle_add(execute, (args, kwargs))
126
127         return delayed_func
128
129
130 def synchronous_gtk_message(original_func):
131         """
132         @note Idea came from http://www.aclevername.com/articles/python-webgui/
133         """
134
135         @functools.wraps(original_func)
136         def immediate_func(*args, **kwargs):
137                 with gtk_lock():
138                         return original_func(*args, **kwargs)
139
140         return immediate_func
141
142
143 def autostart(func):
144         """
145         >>> @autostart
146         ... def grep_sink(pattern):
147         ...     print "Looking for %s" % pattern
148         ...     while True:
149         ...             line = yield
150         ...             if pattern in line:
151         ...                     print line,
152         >>> g = grep_sink("python")
153         Looking for python
154         >>> g.send("Yeah but no but yeah but no")
155         >>> g.send("A series of tubes")
156         >>> g.send("python generators rock!")
157         python generators rock!
158         >>> g.close()
159         """
160
161         @functools.wraps(func)
162         def start(*args, **kwargs):
163                 cr = func(*args, **kwargs)
164                 cr.next()
165                 return cr
166
167         return start
168
169
170 @autostart
171 def printer_sink(format = "%s"):
172         """
173         >>> pr = printer_sink("%r")
174         >>> pr.send("Hello")
175         'Hello'
176         >>> pr.send("5")
177         '5'
178         >>> pr.send(5)
179         5
180         >>> p = printer_sink()
181         >>> p.send("Hello")
182         Hello
183         >>> p.send("World")
184         World
185         >>> # p.throw(RuntimeError, "Goodbye")
186         >>> # p.send("Meh")
187         >>> # p.close()
188         """
189         while True:
190                 item = yield
191                 print format % (item, )
192
193
194 @autostart
195 def null_sink():
196         """
197         Good for uses like with cochain to pick up any slack
198         """
199         while True:
200                 item = yield
201
202
203 @autostart
204 def comap(function, target):
205         """
206         >>> p = printer_sink()
207         >>> cm = comap(lambda x: x+1, p)
208         >>> cm.send((0, ))
209         1
210         >>> cm.send((1.0, ))
211         2.0
212         >>> cm.send((-2, ))
213         -1
214         """
215         while True:
216                 try:
217                         item = yield
218                         mappedItem = function(*item)
219                         target.send(mappedItem)
220                 except Exception, e:
221                         _moduleLogger.exception("Forwarding exception!")
222                         target.throw(e.__class__, str(e))
223
224
225 def _flush_queue(queue):
226         while not queue.empty():
227                 yield queue.get()
228
229
230 @autostart
231 def queue_sink(queue):
232         """
233         >>> q = Queue.Queue()
234         >>> qs = queue_sink(q)
235         >>> qs.send("Hello")
236         >>> qs.send("World")
237         >>> qs.throw(RuntimeError, "Goodbye")
238         >>> qs.send("Meh")
239         >>> qs.close()
240         >>> print [i for i in _flush_queue(q)]
241         [(None, 'Hello'), (None, 'World'), (<type 'exceptions.RuntimeError'>, 'Goodbye'), (None, 'Meh'), (<type 'exceptions.GeneratorExit'>, None)]
242         """
243         while True:
244                 try:
245                         item = yield
246                         queue.put((None, item))
247                 except Exception, e:
248                         queue.put((e.__class__, str(e)))
249                 except GeneratorExit:
250                         queue.put((GeneratorExit, None))
251                         raise
252
253
254 def decode_item(item, target):
255         if item[0] is None:
256                 target.send(item[1])
257                 return False
258         elif item[0] is GeneratorExit:
259                 target.close()
260                 return True
261         else:
262                 target.throw(item[0], item[1])
263                 return False
264
265
266 def nonqueue_source(queue, target):
267         isDone = False
268         while not isDone:
269                 item = queue.get()
270                 isDone = decode_item(item, target)
271                 while not queue.empty():
272                         queue.get_nowait()
273
274
275 def threaded_stage(target, thread_factory = threading.Thread):
276         messages = Queue.Queue()
277
278         run_source = functools.partial(nonqueue_source, messages, target)
279         thread = thread_factory(target=run_source)
280         thread.setDaemon(True)
281         thread.start()
282
283         # Sink running in current thread
284         return queue_sink(messages)
285
286
287 class LoginWindow(object):
288
289         def __init__(self, widgetTree):
290                 """
291                 @note Thread agnostic
292                 """
293                 self._dialog = widgetTree.get_widget("loginDialog")
294                 self._parentWindow = widgetTree.get_widget("mainWindow")
295                 self._serviceCombo = widgetTree.get_widget("serviceCombo")
296                 self._usernameEntry = widgetTree.get_widget("usernameentry")
297                 self._passwordEntry = widgetTree.get_widget("passwordentry")
298
299                 self._serviceList = gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING)
300                 self._serviceCombo.set_model(self._serviceList)
301                 cell = gtk.CellRendererText()
302                 self._serviceCombo.pack_start(cell, True)
303                 self._serviceCombo.add_attribute(cell, 'text', 1)
304                 self._serviceCombo.set_active(0)
305
306                 widgetTree.get_widget("loginbutton").connect("clicked", self._on_loginbutton_clicked)
307                 widgetTree.get_widget("logins_close_button").connect("clicked", self._on_loginclose_clicked)
308
309         def request_credentials(self,
310                 parentWindow = None,
311                 defaultCredentials = ("", "")
312         ):
313                 """
314                 @note UI Thread
315                 """
316                 if parentWindow is None:
317                         parentWindow = self._parentWindow
318
319                 self._serviceCombo.hide()
320                 self._serviceList.clear()
321
322                 self._usernameEntry.set_text(defaultCredentials[0])
323                 self._passwordEntry.set_text(defaultCredentials[1])
324
325                 try:
326                         self._dialog.set_transient_for(parentWindow)
327                         self._dialog.set_default_response(gtk.RESPONSE_OK)
328                         response = self._dialog.run()
329                         if response != gtk.RESPONSE_OK:
330                                 raise RuntimeError("Login Cancelled")
331
332                         username = self._usernameEntry.get_text()
333                         password = self._passwordEntry.get_text()
334                         self._passwordEntry.set_text("")
335                 finally:
336                         self._dialog.hide()
337
338                 return username, password
339
340         def request_credentials_from(self,
341                 services,
342                 parentWindow = None,
343                 defaultCredentials = ("", "")
344         ):
345                 """
346                 @note UI Thread
347                 """
348                 if parentWindow is None:
349                         parentWindow = self._parentWindow
350
351                 self._serviceList.clear()
352                 for serviceIdserviceName in services:
353                         self._serviceList.append(serviceIdserviceName)
354                 self._serviceCombo.set_active(0)
355                 self._serviceCombo.show()
356
357                 self._usernameEntry.set_text(defaultCredentials[0])
358                 self._passwordEntry.set_text(defaultCredentials[1])
359
360                 try:
361                         self._dialog.set_transient_for(parentWindow)
362                         self._dialog.set_default_response(gtk.RESPONSE_OK)
363                         response = self._dialog.run()
364                         if response != gtk.RESPONSE_OK:
365                                 raise RuntimeError("Login Cancelled")
366
367                         username = self._usernameEntry.get_text()
368                         password = self._passwordEntry.get_text()
369                 finally:
370                         self._dialog.hide()
371
372                 itr = self._serviceCombo.get_active_iter()
373                 serviceId = int(self._serviceList.get_value(itr, 0))
374                 self._serviceList.clear()
375                 return serviceId, username, password
376
377         def _on_loginbutton_clicked(self, *args):
378                 self._dialog.response(gtk.RESPONSE_OK)
379
380         def _on_loginclose_clicked(self, *args):
381                 self._dialog.response(gtk.RESPONSE_CANCEL)
382
383
384 def safecall(f, errorDisplay=None, default=None, exception=Exception):
385         '''
386         Returns modified f. When the modified f is called and throws an
387         exception, the default value is returned
388         '''
389         def _safecall(*args, **argv):
390                 try:
391                         return f(*args,**argv)
392                 except exception, e:
393                         if errorDisplay is not None:
394                                 errorDisplay.push_exception(e)
395                         return default
396         return _safecall
397
398
399 class ErrorDisplay(object):
400
401         def __init__(self, widgetTree):
402                 super(ErrorDisplay, self).__init__()
403                 self.__errorBox = widgetTree.get_widget("errorEventBox")
404                 self.__errorDescription = widgetTree.get_widget("errorDescription")
405                 self.__errorClose = widgetTree.get_widget("errorClose")
406                 self.__parentBox = self.__errorBox.get_parent()
407
408                 self.__errorBox.connect("button_release_event", self._on_close)
409
410                 self.__messages = []
411                 self.__parentBox.remove(self.__errorBox)
412
413         def push_message_with_lock(self, message):
414                 with gtk_lock():
415                         self.push_message(message)
416
417         def push_message(self, message):
418                 self.__messages.append(message)
419                 if 1 == len(self.__messages):
420                         self.__show_message(message)
421
422         def push_exception_with_lock(self):
423                 with gtk_lock():
424                         self.push_exception()
425
426         def push_exception(self):
427                 userMessage = str(sys.exc_info()[1])
428                 self.push_message(userMessage)
429                 _moduleLogger.exception(userMessage)
430
431         def pop_message(self):
432                 del self.__messages[0]
433                 if 0 == len(self.__messages):
434                         self.__hide_message()
435                 else:
436                         self.__errorDescription.set_text(self.__messages[0])
437
438         def _on_close(self, *args):
439                 self.pop_message()
440
441         def __show_message(self, message):
442                 self.__errorDescription.set_text(message)
443                 self.__parentBox.pack_start(self.__errorBox, False, False)
444                 self.__parentBox.reorder_child(self.__errorBox, 1)
445
446         def __hide_message(self):
447                 self.__errorDescription.set_text("")
448                 self.__parentBox.remove(self.__errorBox)
449
450
451 class DummyErrorDisplay(object):
452
453         def __init__(self):
454                 super(DummyErrorDisplay, self).__init__()
455
456                 self.__messages = []
457
458         def push_message_with_lock(self, message):
459                 self.push_message(message)
460
461         def push_message(self, message):
462                 if 0 < len(self.__messages):
463                         self.__messages.append(message)
464                 else:
465                         self.__show_message(message)
466
467         def push_exception(self, exception = None):
468                 userMessage = str(sys.exc_value)
469                 _moduleLogger.exception(userMessage)
470
471         def pop_message(self):
472                 if 0 < len(self.__messages):
473                         self.__show_message(self.__messages[0])
474                         del self.__messages[0]
475
476         def __show_message(self, message):
477                 _moduleLogger.debug(message)
478
479
480 class MessageBox(gtk.MessageDialog):
481
482         def __init__(self, message):
483                 parent = None
484                 gtk.MessageDialog.__init__(
485                         self,
486                         parent,
487                         gtk.DIALOG_MODAL|gtk.DIALOG_DESTROY_WITH_PARENT,
488                         gtk.MESSAGE_ERROR,
489                         gtk.BUTTONS_OK,
490                         message,
491                 )
492                 self.set_default_response(gtk.RESPONSE_OK)
493                 self.connect('response', self._handle_clicked)
494
495         def _handle_clicked(self, *args):
496                 self.destroy()
497
498
499 class MessageBox2(gtk.MessageDialog):
500
501         def __init__(self, message):
502                 parent = None
503                 gtk.MessageDialog.__init__(
504                         self,
505                         parent,
506                         gtk.DIALOG_DESTROY_WITH_PARENT,
507                         gtk.MESSAGE_ERROR,
508                         gtk.BUTTONS_OK,
509                         message,
510                 )
511                 self.set_default_response(gtk.RESPONSE_OK)
512                 self.connect('response', self._handle_clicked)
513
514         def _handle_clicked(self, *args):
515                 self.destroy()
516
517
518 class PopupCalendar(object):
519
520         def __init__(self, parent, displayDate, title = ""):
521                 self._displayDate = displayDate
522
523                 self._calendar = gtk.Calendar()
524                 self._calendar.select_month(self._displayDate.month, self._displayDate.year)
525                 self._calendar.select_day(self._displayDate.day)
526                 self._calendar.set_display_options(
527                         gtk.CALENDAR_SHOW_HEADING |
528                         gtk.CALENDAR_SHOW_DAY_NAMES |
529                         gtk.CALENDAR_NO_MONTH_CHANGE |
530                         0
531                 )
532                 self._calendar.connect("day-selected", self._on_day_selected)
533
534                 self._popupWindow = gtk.Window()
535                 self._popupWindow.set_title(title)
536                 self._popupWindow.add(self._calendar)
537                 self._popupWindow.set_transient_for(parent)
538                 self._popupWindow.set_modal(True)
539                 self._popupWindow.set_type_hint(gtk.gdk.WINDOW_TYPE_HINT_DIALOG)
540                 self._popupWindow.set_skip_pager_hint(True)
541                 self._popupWindow.set_skip_taskbar_hint(True)
542
543         def run(self):
544                 self._popupWindow.show_all()
545
546         def _on_day_selected(self, *args):
547                 try:
548                         self._calendar.select_month(self._displayDate.month, self._displayDate.year)
549                         self._calendar.select_day(self._displayDate.day)
550                 except Exception, e:
551                         _moduleLogger.exception(e)
552
553
554 class QuickAddView(object):
555
556         def __init__(self, widgetTree, errorDisplay, signalSink, prefix):
557                 self._errorDisplay = errorDisplay
558                 self._manager = None
559                 self._signalSink = signalSink
560
561                 self._clipboard = gtk.clipboard_get()
562
563                 self._taskNameEntry = widgetTree.get_widget(prefix+"-nameEntry")
564                 self._addTaskButton = widgetTree.get_widget(prefix+"-addButton")
565                 self._pasteTaskNameButton = widgetTree.get_widget(prefix+"-pasteNameButton")
566                 self._clearTaskNameButton = widgetTree.get_widget(prefix+"-clearNameButton")
567                 self._onAddId = None
568                 self._onAddClickedId = None
569                 self._onAddReleasedId = None
570                 self._addToEditTimerId = None
571                 self._onClearId = None
572                 self._onPasteId = None
573
574         def enable(self, manager):
575                 self._manager = manager
576
577                 self._onAddId = self._addTaskButton.connect("clicked", self._on_add)
578                 self._onAddClickedId = self._addTaskButton.connect("pressed", self._on_add_pressed)
579                 self._onAddReleasedId = self._addTaskButton.connect("released", self._on_add_released)
580                 self._onPasteId = self._pasteTaskNameButton.connect("clicked", self._on_paste)
581                 self._onClearId = self._clearTaskNameButton.connect("clicked", self._on_clear)
582
583         def disable(self):
584                 self._manager = None
585
586                 self._addTaskButton.disconnect(self._onAddId)
587                 self._addTaskButton.disconnect(self._onAddClickedId)
588                 self._addTaskButton.disconnect(self._onAddReleasedId)
589                 self._pasteTaskNameButton.disconnect(self._onPasteId)
590                 self._clearTaskNameButton.disconnect(self._onClearId)
591
592         def set_addability(self, addability):
593                 self._addTaskButton.set_sensitive(addability)
594
595         def _on_add(self, *args):
596                 try:
597                         name = self._taskNameEntry.get_text()
598                         self._taskNameEntry.set_text("")
599
600                         self._signalSink.stage.send(("add", name))
601                 except Exception, e:
602                         self._errorDisplay.push_exception()
603
604         def _on_add_edit(self, *args):
605                 try:
606                         name = self._taskNameEntry.get_text()
607                         self._taskNameEntry.set_text("")
608
609                         self._signalSink.stage.send(("add-edit", name))
610                 except Exception, e:
611                         self._errorDisplay.push_exception()
612
613         def _on_add_pressed(self, widget):
614                 try:
615                         self._addToEditTimerId = gobject.timeout_add(1000, self._on_add_edit)
616                 except Exception, e:
617                         self._errorDisplay.push_exception()
618
619         def _on_add_released(self, widget):
620                 try:
621                         if self._addToEditTimerId is not None:
622                                 gobject.source_remove(self._addToEditTimerId)
623                         self._addToEditTimerId = None
624                 except Exception, e:
625                         self._errorDisplay.push_exception()
626
627         def _on_paste(self, *args):
628                 try:
629                         entry = self._taskNameEntry.get_text()
630                         addedText = self._clipboard.wait_for_text()
631                         if addedText:
632                                 entry += addedText
633                         self._taskNameEntry.set_text(entry)
634                 except Exception, e:
635                         self._errorDisplay.push_exception()
636
637         def _on_clear(self, *args):
638                 try:
639                         self._taskNameEntry.set_text("")
640                 except Exception, e:
641                         self._errorDisplay.push_exception()
642
643
644 class TapOrHold(object):
645
646         def __init__(self, widget):
647                 self._widget = widget
648                 self._isTap = True
649                 self._isPointerInside = True
650                 self._holdTimeoutId = None
651                 self._tapTimeoutId = None
652                 self._taps = 0
653
654                 self._bpeId = None
655                 self._breId = None
656                 self._eneId = None
657                 self._lneId = None
658
659         def enable(self):
660                 self._bpeId = self._widget.connect("button-press-event", self._on_button_press)
661                 self._breId = self._widget.connect("button-release-event", self._on_button_release)
662                 self._eneId = self._widget.connect("enter-notify-event", self._on_enter)
663                 self._lneId = self._widget.connect("leave-notify-event", self._on_leave)
664
665         def disable(self):
666                 self._widget.disconnect(self._bpeId)
667                 self._widget.disconnect(self._breId)
668                 self._widget.disconnect(self._eneId)
669                 self._widget.disconnect(self._lneId)
670
671         def on_tap(self, taps):
672                 print "TAP", taps
673
674         def on_hold(self, taps):
675                 print "HOLD", taps
676
677         def on_holding(self):
678                 print "HOLDING"
679
680         def on_cancel(self):
681                 print "CANCEL"
682
683         def _on_button_press(self, *args):
684                 # Hack to handle weird notebook behavior
685                 self._isPointerInside = True
686                 self._isTap = True
687
688                 if self._tapTimeoutId is not None:
689                         gobject.source_remove(self._tapTimeoutId)
690                         self._tapTimeoutId = None
691
692                 # Handle double taps
693                 if self._holdTimeoutId is None:
694                         self._tapTimeoutId = None
695
696                         self._taps = 1
697                         self._holdTimeoutId = gobject.timeout_add(1000, self._on_hold_timeout)
698                 else:
699                         self._taps = 2
700
701         def _on_button_release(self, *args):
702                 assert self._tapTimeoutId is None
703                 # Handle release after timeout if user hasn't double-clicked
704                 self._tapTimeoutId = gobject.timeout_add(100, self._on_tap_timeout)
705
706         def _on_actual_press(self, *args):
707                 if self._holdTimeoutId is not None:
708                         gobject.source_remove(self._holdTimeoutId)
709                 self._holdTimeoutId = None
710
711                 if self._isPointerInside:
712                         if self._isTap:
713                                 self.on_tap(self._taps)
714                         else:
715                                 self.on_hold(self._taps)
716                 else:
717                         self.on_cancel()
718
719         def _on_tap_timeout(self, *args):
720                 self._tapTimeoutId = None
721                 self._on_actual_press()
722                 return False
723
724         def _on_hold_timeout(self, *args):
725                 self._holdTimeoutId = None
726                 self._isTap = False
727                 self.on_holding()
728                 return False
729
730         def _on_enter(self, *args):
731                 self._isPointerInside = True
732
733         def _on_leave(self, *args):
734                 self._isPointerInside = False
735
736
737 if __name__ == "__main__":
738         if False:
739                 import datetime
740                 cal = PopupCalendar(None, datetime.datetime.now())
741                 cal._popupWindow.connect("destroy", lambda w: gtk.main_quit())
742                 cal.run()
743
744         gtk.main()