/
main.py
2208 lines (1880 loc) · 88.1 KB
/
main.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""An application for keeping track of your time."""
from __future__ import print_function, absolute_import
import time
import sys
DEBUG = '--debug' in sys.argv
if DEBUG:
def mark_time(what=None, _prev=[0, 0]):
t = time.time()
if what:
print("{:.3f} ({:+.3f}) {}".format(t - _prev[1], t - _prev[0], what))
else:
print()
_prev[1] = t
_prev[0] = t
else:
def mark_time(what=None):
pass
mark_time()
mark_time("in script")
import collections
import datetime
import email
import email.header
import email.mime.text
import functools
import gettext
import io
import locale
import logging
import os
import re
import signal
import smtplib
from contextlib import closing
from email.utils import parseaddr, formataddr
from gettext import gettext as _
from io import StringIO
mark_time("Python imports done")
if DEBUG:
os.environ['G_ENABLE_DIAGNOSTIC'] = '1'
# The gtimelog.paths import has important side effects and must be done before
# importing 'gi'.
from .paths import (
UI_FILE, PREFERENCES_UI_FILE, ABOUT_DIALOG_UI_FILE, SHORTCUTS_UI_FILE,
MENUS_UI_FILE, CSS_FILE, LOCALE_DIR, CONTRIBUTORS_FILE,
)
import gi
def require_version(namespace, version):
try:
gi.require_version(namespace, version)
except ValueError:
deb_package = "gir1.2-{namespace}-{version}".format(
namespace=namespace.lower(), version=version)
sys.exit("""Typelib files for {namespace}-{version} are not available.
If you're on Ubuntu or another Debian-like distribution, please install
them with
sudo apt install {deb_package}
""".format(namespace=namespace, version=version, deb_package=deb_package))
require_version('Gtk', '3.0')
require_version('Soup', '2.4')
require_version('Secret', '1')
from gi.repository import Gtk, Gdk, GLib, Gio, GObject, Pango, Soup, Secret
mark_time("Gtk imports done")
from gtimelog import __version__
from gtimelog.settings import Settings
from gtimelog.timelog import (
as_minutes, virtual_day, different_days, prev_month, next_month, uniq, parse_time,
Reports, ReportRecord, TaskList, TimeLog)
if str is bytes:
# Python 2: GTK+ gives us back UTF-8 strings
def to_unicode(s):
return s.decode('UTF-8')
def to_bytes(s):
return s
else:
# Python 3: GTK+ gives us Unicode strings
def to_unicode(s):
return s
def to_bytes(s):
return s.encode('UTF-8')
mark_time("gtimelog imports done")
log = logging.getLogger('gtimelog')
MailProtocol = collections.namedtuple('MailProtocol', 'factory, startssl')
MAIL_PROTOCOLS = {
'SMTP': MailProtocol(smtplib.SMTP, False),
'SMTPS': MailProtocol(smtplib.SMTP_SSL, False),
'SMTP (StartTLS)': MailProtocol(smtplib.SMTP, True),
}
class EmailError(Exception):
pass
def start_smtp_password_lookup(server, username, callback):
schema = Secret.get_schema(Secret.SchemaType.COMPAT_NETWORK)
attrs = dict(user=username, server=server, protocol='smtp')
def password_callback(source, result):
password = Secret.password_lookup_finish(result)
if password:
log.debug("Found the SMTP password in the keyring.")
else:
log.debug("Did not find the SMTP password in the keyring.")
callback(password or '')
log.debug("Looking up the SMTP password for %s@%s in the keyring.",
username, server)
Secret.password_lookup(schema, attrs, cancellable=None,
callback=password_callback)
def set_smtp_password(server, username, password):
schema = Secret.get_schema(Secret.SchemaType.COMPAT_NETWORK)
attrs = dict(user=username, server=server, protocol='smtp')
label = '{user}@{server}'.format_map(attrs)
def callback(source, result):
if not Secret.password_store_finish(result):
log.error(_("Failed to store SMTP password in the keyring."))
else:
log.debug("SMTP password stored in the keyring.")
log.debug("Storing the SMTP password for %s in the keyring.", label)
Secret.password_store(schema, attrs, collection=Secret.COLLECTION_DEFAULT,
label=label, password=password, cancellable=None,
callback=callback)
def format_duration(duration):
"""Format a datetime.timedelta with minute precision.
The difference from gtimelog.timelog.format_duration() is that this
one is internationalized.
"""
h, m = divmod(as_minutes(duration), 60)
return _('{0} h {1} min').format(h, m)
def isascii(s):
return all(0 <= ord(c) <= 127 for c in s)
def address_header(name_and_address):
if isascii(name_and_address):
return name_and_address
name, addr = parseaddr(name_and_address)
name = str(email.header.Header(name, 'UTF-8'))
return formataddr((name, addr))
def subject_header(header):
if isascii(header):
return header
return email.header.Header(header, 'UTF-8')
def prepare_message(sender, recipient, subject, body):
if isascii(body):
msg = email.mime.text.MIMEText(body)
else:
msg = email.mime.text.MIMEText(body, _charset="UTF-8")
if sender:
msg["From"] = address_header(sender)
msg["To"] = address_header(recipient)
msg["Subject"] = subject_header(subject)
msg["User-Agent"] = "gtimelog/{}".format(__version__)
return msg
def make_option(long_name, short_name=None, flags=0, arg=GLib.OptionArg.NONE,
arg_data=None, description=None, arg_description=None):
# surely something like this should exist inside PyGObject itself?!
option = GLib.OptionEntry()
option.long_name = long_name.lstrip('-')
option.short_name = 0 if not short_name else short_name.lstrip('-')
option.flags = flags
option.arg = arg
option.arg_data = arg_data
option.description = description
option.arg_description = arg_description
return option
# Global HTTP stuff
class Authenticator(object):
def __init__(self):
self.pending = []
self.lookup_in_progress = False
self.username = None
self.password = None
def find_in_keyring(self, uri, callback):
"""
Attempt to load a username and password from the keyring.
If the keyring is not available, return the last username
and password entered, if any.
"""
# NB: we cannot use the simpler Secret.password_lookup_sync() because
# it won't give us access to the username!
Secret.Service.get(
Secret.ServiceFlags.OPEN_SESSION
| Secret.ServiceFlags.LOAD_COLLECTIONS,
cancellable=None,
callback=functools.partial(self._find_in_keyring, uri, callback),
)
def _find_in_keyring(self, uri, callback, source, result):
service = Secret.Service.get_finish(result)
schema = Secret.get_schema(Secret.SchemaType.COMPAT_NETWORK)
attrs = dict(server=uri.get_host(),
protocol=uri.get_scheme(),
port=str(uri.get_port()))
flags = (Secret.SearchFlags.UNLOCK
| Secret.SearchFlags.LOAD_SECRETS)
def search_callback(source, result):
items = service.search_finish(result)
if items:
# Note: the search will give us the most recently used password
# if several ones match (e.g. the user tried several different
# usernames). This is good because if the wrong username gets
# picked and is rejected by the server, we'll ask the user
# again and then rememebr the more recently provided answer.
# This is bad only if multiple sets of credentials are valid
# but cause different data to be returned -- the user will
# be forced to launch Seahorse and remove the saved credentials
# manually to log in into a different account.
log.debug("Found the HTTP password for %s in the keyring.",
items[0].get_label())
username = items[0].get_attributes()['user']
password = items[0].get_secret().get_text()
if len(items) > 1:
# This will never happen. If you want this to happen,
# add Secret.SearchFlags.ALL to the search flags.
log.debug("Ignoring the other %d found passwords.",
len(items) - 1)
else:
log.debug("Did not find any HTTP passwords for %s://%s:%s"
" in the keyring.",
uri.get_scheme(), uri.get_host(), uri.get_port())
username = self.username
password = self.password
callback(username, password)
service.search(schema, attrs, flags, cancellable=None,
callback=search_callback)
def save_to_keyring(self, uri, username, password):
schema = Secret.get_schema(Secret.SchemaType.COMPAT_NETWORK)
attrs = dict(server=uri.get_host(),
protocol=uri.get_scheme(),
port=str(uri.get_port()),
user=username)
label = '{user}@{server}:{port}'.format_map(attrs)
def password_stored_callback(source, result):
if not Secret.password_store_finish(result):
log.error(_("Failed to store HTTP password in the keyring."))
else:
log.debug("HTTP password stored in the keyring.")
log.debug("Storing the HTTP password for %s in the keyring.", label)
Secret.password_store(
schema, attrs, collection=Secret.COLLECTION_DEFAULT, label=label,
password=password, cancellable=None,
callback=password_stored_callback,
)
def ask_the_user(self, auth, uri, callback):
"""
Pop up a username/password dialog for uri
"""
mountoperation = Gtk.MountOperation.new()
def on_reply(m, r):
if r == Gio.MountOperationResult.HANDLED:
username = m.get_username()
password = m.get_password()
if username and password:
if m.get_password_save() == Gio.PasswordSave.PERMANENTLY:
# NB: we're saving the password before even testing if
# it actually works! This is not too big of a problem:
# if it fails to work, the user will get another prompt
# and we will store the other password.
self.save_to_keyring(uri, username, password)
elif m.get_password_save() == Gio.PasswordSave.FOR_SESSION:
self.username = username
self.password = password
else:
username = None
password = None
callback(username, password)
flags = (Gio.AskPasswordFlags.NEED_PASSWORD
| Gio.AskPasswordFlags.NEED_USERNAME
| Gio.AskPasswordFlags.SAVING_SUPPORTED)
mountoperation.connect('reply', on_reply)
mountoperation.set_password_save(Gio.PasswordSave.PERMANENTLY)
mountoperation.do_ask_password(mountoperation,
_('Authentication is required for "%s"\n'
'You need a username and a password to access %s') % (
auth.get_realm(), uri.get_host()),
'',
auth.get_realm(),
flags)
def find_password(self, auth, uri, retrying, callback):
def keyring_callback(username, password):
# If not found, ask the user for it
if username is None or retrying:
GObject.idle_add(lambda: self.ask_the_user(auth, uri, callback))
else:
callback(username, password)
self.find_in_keyring(uri, keyring_callback)
def http_auth_cb(self, session, message, auth, retrying, *args):
session.pause_message(message)
self.pending.insert(0, (session, message, auth, retrying))
self.maybe_pop_queue()
def maybe_pop_queue(self):
# I don't think we need any locking, because GIL.
if self.lookup_in_progress:
return
try:
(session, message, auth, retrying) = self.pending.pop()
except IndexError:
pass
else:
self.lookup_in_progress = True
uri = message.get_uri()
self.find_password(auth, uri, retrying,
callback=functools.partial(
self.http_auth_finish, session, message, auth))
def http_auth_finish(self, session, message, auth, username, password):
if username and password:
auth.authenticate(username, password)
session.unpause_message(message)
self.lookup_in_progress = False
self.maybe_pop_queue()
soup_session = Soup.SessionAsync()
authenticator = Authenticator()
soup_session.connect('authenticate', authenticator.http_auth_cb)
class Application(Gtk.Application):
class Actions(object):
actions = [
'preferences',
'shortcuts',
'about',
'quit',
'edit-log',
'edit-tasks',
'refresh-tasks',
]
def __init__(self, app):
for action_name in self.actions:
action = Gio.SimpleAction.new(action_name, None)
action.connect('activate', getattr(app, 'on_' + action_name.replace('-', '_')))
app.add_action(action)
setattr(self, action_name.replace('-', '_'), action)
self.shortcuts.set_enabled(hasattr(Gtk, 'ShortcutsWindow'))
def __init__(self):
super(Application, self).__init__(
application_id='org.gtimelog',
flags=Gio.ApplicationFlags.HANDLES_COMMAND_LINE,
)
GLib.set_application_name(_("Time Log"))
GLib.set_prgname('gtimelog')
self.add_main_option_entries([
make_option("--version", description=_("Show version number and exit")),
make_option("--debug", description=_("Show debug information on the console")),
make_option("--prefs", description=_("Open the preferences dialog")),
make_option("--email-prefs", description=_("Open the preferences dialog on the email page")),
])
def check_schema(self):
schema_source = Gio.SettingsSchemaSource.get_default()
if schema_source.lookup("org.gtimelog", False) is None:
sys.exit(_("\nWARNING: GSettings schema for org.gtimelog is missing! If you're running from a source checkout, be sure to run 'make'."))
def create_data_directory(self):
data_dir = Settings().get_data_dir()
if not os.path.exists(data_dir):
try:
os.makedirs(data_dir)
except OSError as e:
log.error(_("Could not create {directory}: {error}").format(directory=data_dir, error=e), file=sys.stderr)
else:
log.info(_("Created {directory}").format(directory=data_dir))
def do_handle_local_options(self, options):
if options.contains('version'):
print(_('GTimeLog version: {}').format(__version__))
print(_('Python version: {}').format(sys.version.replace('\n', '')))
print(_('GTK+ version: {}.{}.{}').format(Gtk.MAJOR_VERSION, Gtk.MINOR_VERSION, Gtk.MICRO_VERSION))
print(_('PyGI version: {}').format(gi.__version__))
print(_('Data directory: {}').format(Settings().get_data_dir()))
print(_('Legacy config directory: {}').format(Settings().get_config_dir()))
self.check_schema()
gsettings = Gio.Settings.new("org.gtimelog")
if not gsettings.get_boolean('settings-migrated'):
print(_('Settings will be migrated to GSettings (org.gtimelog) on first launch'))
else:
print(_('Settings already migrated to GSettings (org.gtimelog)'))
return 0
return -1 # send the args to the remote instance for processing
def do_command_line(self, command_line):
self.do_activate()
options = command_line.get_options_dict()
if options.contains('email-prefs'):
self.on_preferences(page="email")
elif options.contains('prefs'):
self.on_preferences()
return 0
def do_startup(self):
mark_time("in app startup")
self.check_schema()
self.create_data_directory()
Gtk.Application.do_startup(self)
mark_time("basic app startup done")
css = Gtk.CssProvider()
css.load_from_path(CSS_FILE)
screen = Gdk.Screen.get_default()
Gtk.StyleContext.add_provider_for_screen(
screen, css, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION)
mark_time("CSS loaded")
if Gtk.Settings.get_default().get_property('gtk-shell-shows-app-menu'):
builder = Gtk.Builder.new_from_file(MENUS_UI_FILE)
self.set_app_menu(builder.get_object('app_menu'))
mark_time("menus loaded")
self.actions = self.Actions(self)
self.set_accels_for_action("win.detail-level::chronological", ["<Alt>1"])
self.set_accels_for_action("win.detail-level::grouped", ["<Alt>2"])
self.set_accels_for_action("win.detail-level::summary", ["<Alt>3"])
self.set_accels_for_action("win.time-range::day", ["<Alt>4"])
self.set_accels_for_action("win.time-range::week", ["<Alt>5"])
self.set_accels_for_action("win.time-range::month", ["<Alt>6"])
self.set_accels_for_action("win.show-task-pane", ["F9"])
self.set_accels_for_action("win.show-menu", ["F10"])
self.set_accels_for_action("win.show-search-bar", ["<Primary>F"])
self.set_accels_for_action("win.go-back", ["<Alt>Left"])
self.set_accels_for_action("win.go-forward", ["<Alt>Right"])
self.set_accels_for_action("win.go-home", ["<Alt>Home"])
self.set_accels_for_action("app.edit-log", ["<Primary>E"])
self.set_accels_for_action("app.edit-tasks", ["<Primary>T"])
self.set_accels_for_action("app.shortcuts", ["<Primary>question"])
self.set_accels_for_action("app.preferences", ["<Primary>P"])
self.set_accels_for_action("app.quit", ["<Primary>Q"])
self.set_accels_for_action("win.report", ["<Primary>D"])
self.set_accels_for_action("win.cancel-report", ["Escape"])
self.set_accels_for_action("win.send-report", ["<Primary>Return"])
mark_time("app startup done")
def on_quit(self, action, parameter):
self.quit()
def open_in_editor(self, filename):
self.create_if_missing(filename)
if os.name == 'nt':
os.startfile(filename)
else:
uri = GLib.filename_to_uri(filename, None)
Gtk.show_uri(None, uri, Gdk.CURRENT_TIME)
def on_edit_log(self, action, parameter):
filename = Settings().get_timelog_file()
self.open_in_editor(filename)
def on_edit_tasks(self, action, parameter):
gsettings = Gio.Settings.new("org.gtimelog")
if gsettings.get_boolean('remote-task-list'):
uri = gsettings.get_string('task-list-edit-url')
if self.get_active_window() is not None:
self.get_active_window().editing_remote_tasks = True
Gtk.show_uri(None, uri, Gdk.CURRENT_TIME)
else:
filename = Settings().get_task_list_file()
self.open_in_editor(filename)
def on_refresh_tasks(self, action, parameter):
gsettings = Gio.Settings.new("org.gtimelog")
if gsettings.get_boolean('remote-task-list'):
if self.get_active_window() is not None:
self.get_active_window().download_tasks()
def create_if_missing(self, filename):
if not os.path.exists(filename):
open(filename, 'a').close()
def on_shortcuts(self, action, parameter):
builder = Gtk.Builder.new_from_file(SHORTCUTS_UI_FILE)
shortcuts_window = builder.get_object('shortcuts_window')
shortcuts_window.set_transient_for(self.get_active_window())
shortcuts_window.show_all()
def get_contributors(self):
contributors = []
with io.open(CONTRIBUTORS_FILE, encoding='UTF-8') as f:
for line in f:
if line.startswith('- '):
contributors.append(line[2:].strip())
return sorted(contributors)
def on_about(self, action, parameter):
# Note: must create a new dialog (which means a new Gtk.Builder)
# on every invocation.
builder = Gtk.Builder.new_from_file(ABOUT_DIALOG_UI_FILE)
about_dialog = builder.get_object('about_dialog')
about_dialog.set_version(__version__)
about_dialog.set_authors(self.get_contributors())
about_dialog.set_transient_for(self.get_active_window())
about_dialog.connect("response", lambda *args: about_dialog.destroy())
about_dialog.show()
def on_preferences(self, action=None, parameter=None, page=None):
if self.are_there_any_modals():
# Don't let a user invoke this recursively via gtimelog --prefs
return
preferences = PreferencesDialog(self.get_active_window(), page=page)
preferences.connect("response", lambda *args: preferences.destroy())
preferences.run()
def are_there_any_modals(self):
# Fix for https://github.com/gtimelog/gtimelog/issues/127
return any(window.get_modal()
for window in Gtk.Window.list_toplevels())
def do_activate(self):
mark_time("in app activate")
window = self.get_active_window()
if window is not None:
# window.present() doesn't work on wayland:
# https://gitlab.gnome.org/GNOME/gtk/issues/624#note_119092
window.present_with_time(GLib.get_monotonic_time() // 1000)
return
window = Window(self)
mark_time("have window")
self.add_window(window)
mark_time("added window")
window.show()
mark_time("showed window")
GLib.idle_add(mark_time, "in main loop")
mark_time("app activate done")
def copy_properties(src, dest):
blacklist = (
'events', 'child', 'parent', 'input-hints', 'buffer', 'tabs',
'completion', 'model', 'type',
'progress-', 'primary-icon-', 'secondary-icon-',
)
RW = GObject.ParamFlags.READWRITE
for prop in src.props:
if prop.flags & GObject.ParamFlags.DEPRECATED != 0:
continue
if prop.flags & RW != RW:
continue
if prop.name.startswith(blacklist):
continue
setattr(dest.props, prop.name, getattr(src.props, prop.name))
def swap_widget(builder, name, replacement):
original = builder.get_object(name)
copy_properties(original, replacement)
parent = original.get_parent()
if isinstance(parent, Gtk.Box):
expand, fill, padding, pack_type = parent.query_child_packing(original)
position = parent.get_children().index(original)
parent.remove(original)
parent.add(replacement)
if isinstance(parent, Gtk.Box):
parent.set_child_packing(replacement, expand, fill, padding, pack_type)
parent.reorder_child(replacement, position)
original.destroy()
REPORT_KINDS = {
# map time_range values to report_kind values
'day': ReportRecord.DAILY,
'week': ReportRecord.WEEKLY,
'month': ReportRecord.MONTHLY,
}
class Window(Gtk.ApplicationWindow):
timelog = GObject.Property(
type=object, default=None, nick='Time log',
blurb='Time log object')
tasks = GObject.Property(
type=object, default=None, nick='Tasks',
blurb='Task list object')
date = GObject.Property(
type=object, default=None, nick='Date',
blurb='Date to show (None tracks today)')
detail_level = GObject.Property(
type=str, default='chronological', nick='Detail level',
blurb='Detail level to show (chronological/grouped/summary)')
time_range = GObject.Property(
type=str, default='day', nick='Time range',
blurb='Time range to show (day/week/month)')
filter_text = GObject.Property(
type=str, default='', nick='Filter text',
blurb='Show only tasks matching this substring')
class Actions(object):
def __init__(self, win):
PropertyAction = Gio.PropertyAction
self.detail_level = PropertyAction.new("detail-level", win, "detail-level")
win.add_action(self.detail_level)
self.time_range = PropertyAction.new("time-range", win, "time-range")
win.add_action(self.time_range)
self.show_view_menu = PropertyAction.new("show-view-menu", win.view_button, "active")
win.add_action(self.show_view_menu)
self.show_task_pane = PropertyAction.new("show-task-pane", win.task_pane, "visible")
win.add_action(self.show_task_pane)
self.show_menu = PropertyAction.new("show-menu", win.menu_button, "active")
win.add_action(self.show_menu)
self.show_search_bar = PropertyAction.new("show-search-bar", win.search_bar, "search-mode-enabled")
win.add_action(self.show_search_bar)
for action_name in ['go-back', 'go-forward', 'go-home', 'add-entry', 'report', 'send-report', 'cancel-report']:
action = Gio.SimpleAction.new(action_name, None)
action.connect('activate', getattr(win, 'on_' + action_name.replace('-', '_')))
win.add_action(action)
setattr(self, action_name.replace('-', '_'), action)
def __init__(self, app):
Gtk.ApplicationWindow.__init__(self, application=app, icon_name='gtimelog')
self._watches = {}
self._download = None
self._date = None
self._showing_today = None
self._window_size_update_timeout = None
self.editing_remote_tasks = False
self.timelog = None
self.tasks = None
self.app = app
mark_time("loading ui")
builder = Gtk.Builder.new_from_file(UI_FILE)
mark_time("main ui loaded")
builder.add_from_file(MENUS_UI_FILE)
mark_time("menus loaded")
# I want to use a custom Gtk.ApplicationWindow subclass, but I
# also want to be able to edit the .ui file with Glade. So I use
# a regular ApplicationWindow in the .ui file, then steal its
# children and add them into my custom window instance.
main_window = builder.get_object('main_window')
main_stack = builder.get_object('main_stack')
headerbar = builder.get_object('headerbar')
copy_properties(main_window, self)
main_window.set_titlebar(None)
main_window.remove(main_stack)
self.add(main_stack)
self.set_titlebar(headerbar)
# Cannot store these in the same .ui file nor hook them up in the
# .ui because glade doesn't support that and strips both the
# <menu> and the menu-model property on save.
self.view_button = builder.get_object("view_button")
self.menu_button = builder.get_object("menu_button")
self.menu_button.set_menu_model(builder.get_object('window_menu'))
self.view_button.set_menu_model(builder.get_object('view_menu'))
self.main_stack = main_stack
self.paned = builder.get_object("paned")
self.task_pane_button = builder.get_object("task_pane_button")
self.back_button = builder.get_object("back_button")
self.forward_button = builder.get_object("forward_button")
self.today_button = builder.get_object("today_button")
self.send_report_button = builder.get_object("send_report_button")
self.cancel_report_button = builder.get_object("cancel_report_button")
self.sender_entry = builder.get_object("sender_entry")
self.recipient_entry = builder.get_object("recipient_entry")
self.subject_entry = builder.get_object("subject_entry")
self.tasks_infobar = builder.get_object("tasks_infobar")
self.tasks_infobar_label = builder.get_object("tasks_infobar_label")
self.infobar = builder.get_object("report_infobar")
self.infobar.connect('response', lambda *args: self.infobar.hide())
self.infobar_label = builder.get_object("infobar_label")
self.headerbar = builder.get_object('headerbar')
self.time_label = builder.get_object('time_label')
self.task_entry = TaskEntry()
swap_widget(builder, 'task_entry', self.task_entry)
self.task_entry.grab_focus() # I specified this in the .ui file but it gets ignored
self.add_button = builder.get_object('add_button')
self.add_button.grab_default() # I specified this in the .ui file but it gets ignored
self.log_view = LogView()
swap_widget(builder, 'log_view', self.log_view)
self.bind_property('timelog', self.task_entry, 'timelog', GObject.BindingFlags.DEFAULT)
self.bind_property('timelog', self.log_view, 'timelog', GObject.BindingFlags.DEFAULT)
self.bind_property('showing_today', self.log_view, 'showing_today', GObject.BindingFlags.DEFAULT)
self.bind_property('date', self.log_view, 'date', GObject.BindingFlags.DEFAULT)
self.bind_property('detail_level', self.log_view, 'detail_level', GObject.BindingFlags.SYNC_CREATE)
self.bind_property('time_range', self.log_view, 'time_range', GObject.BindingFlags.SYNC_CREATE)
self.task_entry.bind_property('text', self.log_view, 'current_task', GObject.BindingFlags.DEFAULT)
self.bind_property('subtitle', self.headerbar, 'subtitle', GObject.BindingFlags.DEFAULT)
self.bind_property('filter_text', self.log_view, 'filter_text', GObject.BindingFlags.DEFAULT)
self.search_bar = builder.get_object("search_bar")
self.search_entry = builder.get_object("search_entry")
self.search_entry.connect('search-changed', self.on_search_changed)
self.task_pane = builder.get_object("task_pane")
self.task_list = TaskListView()
swap_widget(builder, 'task_list', self.task_list)
self.task_list.connect('row-activated', self.task_list_row_activated)
self.bind_property('tasks', self.task_list, 'tasks', GObject.BindingFlags.DEFAULT)
self.actions = self.Actions(self)
self.actions.add_entry.set_enabled(False)
self.actions.send_report.set_enabled(False)
self.report_view = ReportView()
swap_widget(builder, 'report_view', self.report_view)
self.bind_property('timelog', self.report_view, 'timelog', GObject.BindingFlags.DEFAULT)
self.bind_property('date', self.report_view, 'date', GObject.BindingFlags.DEFAULT)
self.bind_property('time_range', self.report_view, 'time_range', GObject.BindingFlags.SYNC_CREATE)
self.sender_entry.bind_property('text', self.report_view, 'sender', GObject.BindingFlags.SYNC_CREATE)
self.recipient_entry.bind_property('text', self.report_view, 'recipient', GObject.BindingFlags.SYNC_CREATE)
self.report_view.bind_property('subject', self.subject_entry, 'text', GObject.BindingFlags.DEFAULT)
self.report_view.connect('notify::recipient', self.update_send_report_availability)
self.report_view.connect('notify::body', self.update_send_report_availability)
self.report_view.connect('notify::report-status', self.update_already_sent_indication)
self.update_send_report_availability()
mark_time('window created')
self.load_settings()
self.date = None # initialize today's date
self.task_entry.connect('changed', self.task_entry_changed)
self.connect('notify::detail-level', self.detail_level_changed)
self.connect('notify::time-range', self.time_range_changed)
self.connect('focus-in-event', self.gained_focus)
mark_time('window ready')
GLib.idle_add(self.load_log)
GLib.idle_add(self.load_tasks)
self.tick(True)
# In theory we could wake up once every 60 seconds. Shame that
# there's no timeout_add_minutes. I don't want to use
# timeout_add_seconds(60) because that wouldn't be aligned to a
# minute boundary, so we would delay updating the current time
# unnecessarily.
GLib.timeout_add_seconds(1, self.tick)
def load_settings(self):
self.gsettings = Gio.Settings.new("org.gtimelog")
self.gsettings.bind('detail-level', self, 'detail-level', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('show-task-pane', self.task_pane, 'visible', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('hours', self.log_view, 'hours', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('office-hours', self.log_view, 'office-hours', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('name', self.report_view, 'name', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('sender', self.sender_entry, 'text', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('list-email', self.recipient_entry, 'text', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('report-style', self.report_view, 'report-style', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('remote-task-list', self.app.actions.refresh_tasks, 'enabled', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.bind('gtk-completion', self.task_entry, 'gtk-completion-enabled', Gio.SettingsBindFlags.DEFAULT)
self.gsettings.connect('changed::remote-task-list', self.load_tasks)
self.gsettings.connect('changed::task-list-url', self.load_tasks)
self.gsettings.connect('changed::task-list-edit-url', self.update_edit_tasks_availability)
self.gsettings.connect('changed::virtual-midnight', self.virtual_midnight_changed)
self.update_edit_tasks_availability()
x, y = self.gsettings.get_value('window-position')
w, h = self.gsettings.get_value('window-size')
tpp = self.gsettings.get_int('task-pane-position')
self.resize(w, h)
if (x, y) != (-1, -1):
self.move(x, y)
self.paned.set_position(tpp)
self.paned.connect('notify::position', self.delay_store_window_size)
self.connect("configure-event", self.delay_store_window_size)
if not self.gsettings.get_boolean('settings-migrated'):
old_settings = Settings()
old_settings.load()
if old_settings.summary_view:
self.gsettings.set_string('detail-level', 'summary')
elif old_settings.chronological:
self.gsettings.set_string('detail-level', 'chronological')
else:
self.gsettings.set_string('detail-level', 'grouped')
self.gsettings.set_boolean('show-task-pane', old_settings.show_tasks)
self.gsettings.set_double('hours', old_settings.hours)
self.gsettings.set_double('office-hours', old_settings.office_hours)
self.gsettings.set_string('name', old_settings.name)
self.gsettings.set_string('sender', old_settings.sender)
self.gsettings.set_string('list-email', old_settings.email)
self.gsettings.set_string('report-style', old_settings.report_style)
self.gsettings.set_string('task-list-url', old_settings.task_list_url)
self.gsettings.set_boolean('remote-task-list', bool(old_settings.task_list_url))
for arg in old_settings.edit_task_list_cmd.split():
if arg.startswith(('http://', 'https://')):
self.gsettings.set_string('task-list-edit-url', arg)
vm = old_settings.virtual_midnight
self.gsettings.set_value('virtual-midnight', GLib.Variant('(ii)', (vm.hour, vm.minute)))
self.gsettings.set_boolean('gtk-completion', bool(old_settings.enable_gtk_completion))
self.gsettings.set_boolean('settings-migrated', True)
log.info(_('Settings from {filename} migrated to GSettings (org.gtimelog)').format(filename=old_settings.get_config_file()))
mark_time('settings loaded')
def load_log(self):
mark_time("loading timelog")
timelog = TimeLog(Settings().get_timelog_file(), self.get_virtual_midnight())
mark_time("timelog loaded")
self.timelog = timelog
self.tick(True)
self.enable_add_entry()
mark_time("timelog presented")
self.watch_file(self.timelog.filename, self.on_timelog_file_changed)
def load_tasks(self, *args):
mark_time("loading tasks")
if self.gsettings.get_boolean('remote-task-list'):
filename = Settings().get_task_list_cache_file()
tasks = TaskList(filename)
self.download_tasks()
else:
filename = Settings().get_task_list_file()
tasks = TaskList(filename)
self.tasks_infobar.hide()
mark_time("tasks loaded")
if self.tasks:
self.unwatch_file(self.tasks.filename)
self.tasks = tasks
mark_time("tasks presented")
self.watch_file(self.tasks.filename, self.on_tasks_file_changed)
self.update_edit_tasks_availability()
def update_edit_tasks_availability(self, *args):
if self.gsettings.get_boolean('remote-task-list'):
can_edit_tasks = bool(self.gsettings.get_string('task-list-edit-url'))
else:
can_edit_tasks = True
self.app.actions.edit_tasks.set_enabled(can_edit_tasks)
def update_send_report_availability(self, *args):
if self.main_stack.get_visible_child_name() == 'report':
can_send = bool(self.report_view.recipient and self.report_view.body)
else:
can_send = False
self.actions.send_report.set_enabled(can_send)
def update_already_sent_indication(self, *args):
if self.report_view.report_status == 'sent':
self.infobar_label.set_text(_("Report already sent"))
self.infobar.show()
# https://github.com/gtimelog/gtimelog/issues/89
self.infobar.queue_resize()
elif self.report_view.report_status == 'sent-elsewhere':
self.infobar_label.set_text(
_("Report already sent (to {})").format(
self.report_view.report_sent_to))
self.infobar.show()
# https://github.com/gtimelog/gtimelog/issues/89
self.infobar.queue_resize()
else:
self.infobar.hide()
def cancel_tasks_download(self, hide=True):
if self._download:
old_message, old_url = self._download
soup_session.cancel_message(old_message, Soup.Status.CANCELLED)
self._download = None
if hide:
self.tasks_infobar.hide()
def download_tasks(self):
# hide=False and queue_resize() are needed to work around
# this bug: https://github.com/gtimelog/gtimelog/issues/89
self.cancel_tasks_download(hide=False)
url = self.gsettings.get_string('task-list-url')
if not url:
log.debug("Not downloading tasks: URL not specified")
return
cache_filename = Settings().get_task_list_cache_file()
self.tasks_infobar.set_message_type(Gtk.MessageType.INFO)
self.tasks_infobar_label.set_text(_("Downloading tasks..."))
self.tasks_infobar.connect('response', lambda *args: self.cancel_tasks_download())
self.tasks_infobar.show()
self.tasks_infobar.queue_resize()
log.debug("Downloading tasks from %s", url)
message = Soup.Message.new('GET', url)
self._download = (message, url)
soup_session.queue_message(message, self.tasks_downloaded, cache_filename)
def tasks_downloaded(self, session, message, cache_filename):
content = message.response_body.data
if message.status_code != Soup.Status.OK:
url = message.get_uri().to_string(just_path_and_query=False)
log.error("Failed to download tasks from %s: %d %s", url, message.status_code, message.reason_phrase)
self.tasks_infobar.set_message_type(Gtk.MessageType.ERROR)
self.tasks_infobar_label.set_text(_("Download failed."))
self.tasks_infobar.connect('response', lambda *args: self.tasks_infobar.hide())
self.tasks_infobar.show()
else:
log.debug("Successfully downloaded tasks:\n %s",
content.replace('\n', '\n '))
with open(cache_filename, 'w') as f:
f.write(content)
self.check_reload_tasks()
self.tasks_infobar.hide()
self._download = None
def gained_focus(self, *args):
if self.editing_remote_tasks:
self.download_tasks()
self.editing_remote_tasks = False
# In case inotify magic fails, let's allow the user to refresh by
# switching focus.
self.check_reload()
self.check_reload_tasks()
def virtual_midnight_changed(self, *args):