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