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