Merge lp:~ijk/gtimelog/nutmeg into lp:~gtimelog-dev/gtimelog/trunk

[ijk]

[lp:~ijk/gtimelog/nutmeg]

246. By ijk on 2013-01-06

Use XDG Base Directory Spec

247. By ijk on 2013-01-09

Fix gtimelog.desktop validation. Use gtimelog icon instead of gnome-week.png.

[Marius Gedminas (mgedmin)]

This:

+ subject = 'Weekly report for {} (week {:0>2})'.format(who, week)

means a UnicodeEncodeError if who is a unicode string with non-ASCII characters.

Although testing reveals that currently `who` is a byte string, which causes bug 1117109, so this doesn't make anything worse.

(It also drops support for Python 2.6 or older, which is probably fine. We'll see if anyone complains about that.)

There are some minor PEP-8 transgressions that I'll fix up after merging.

(Ick, launchpad's review UI sucks. Why haven't I moved to github already?)

review: Approve

[Marius Gedminas (mgedmin)]

Actually, wait a second:

        xdg = os.environ.get('XDG_CONFIG_HOME')
        if xdg is not None:
            return os.path.expanduser(xdg)
        else:
            return os.path.expanduser("~/.config/gtimelog")

so if I set XDG_CONFIG_HOME=~/.config, then gtimelog will use ~/.config/gtimelogrc?

Shouldn't that be

        xdg = os.environ.get('XDG_CONFIG_HOME')
        if xdg is not None:
            return os.path.join(os.path.expanduser(xdg), 'gtimelog')
        else:
            return os.path.expanduser("~/.config/gtimelog")

and likewise for the data dir?

review: Needs Fixing

[Marius Gedminas (mgedmin)]

Also, should it really pass the value of the environment variable through os.path.expanduser()?

=== modified file 'NEWS.txt'
--- NEWS.txt	2012-08-24 13:53:30 +0000
+++ NEWS.txt	2013-01-09 18:20:25 +0000
@@ -1,7 +1,9 @@
 0.8.1 (unreleased)
 ==================
-* No changes yet.
-
+* Fix STRF formatting problem on windows (LP: #1096489).
+* Use XDG Base Directory Specification for config and data files.
+* Fix gtimelog.desktop validation. (LP: #1051226).
+  Use gtimelog icon instead of gnome-week.png.
 
 0.8.0 (2012-08-24)
 ==================

=== modified file 'README.txt'
--- README.txt	2012-08-21 15:04:04 +0000
+++ README.txt	2013-01-09 18:20:25 +0000
@@ -13,15 +13,16 @@
 the activity name upfront, and just delay pressing the Enter key until you're
 done.
 
-There's also a Tasks pane that lists tasks found in ~/.gtimelog/tasks.txt.
+There's also a Tasks pane that lists tasks found in ~/.local/share/gtimelog/tasks.txt.
 You can click on those to save typing.  Or you can specify a URL in
-~/.gtimelog/gtimelogrc and download the task list from a wiki or wherever.
+~/.config/gtimelog/gtimelogrc and download the task list from a wiki or wherever.
 
-There are two broad categories of activities: ones that count as work (coding,
-planning, writing proposals or reports, answering work-related email), and ones
-that don't (browsing the web for fun, reading personal email, chatting with
-a friend on the phone for two hours, going out for a lunch break).  To indicate
-which activities are not work related add two asterisks to the activity name:
+There are two broad categories of activities: ones that count as work
+(coding, planning, writing proposals or reports, answering
+work-related email), and ones that don't (browsing the web for fun,
+reading personal email, chatting with a friend on the phone for two
+hours, going out for a lunch break).  To indicate which activities are
+not work related add two asterisks to the activity name:
 
   lunch **
   browsing slashdot **
@@ -44,7 +45,7 @@
 for convenience. It also advises you how much time you still have to work today
 to get 8 hours of work done, and how much time is left just to have spent a
 workday at the office (the number of hours in a day is configurable in
-~/.gtimelog/gtimelogrc). There are three basic views: one shows all the
+~/.config/gtimelog/gtimelogrc). There are three basic views: one shows all the
 activities in chronological order, with starting and ending times; another
 groups all entries with the same title into one activity and just shows
 the total duration; and a third one groups all entries from the same categories
@@ -52,7 +53,7 @@
 
 At the end of the day you can send off a daily report by choosing File -> Daily
 Report.  A mail program (Mutt in a terminal, unless you have changed it in
-~/.gtimelog/gtimelogrc) will be started with all the activities listed in it.
+~/.config/gtimelog/gtimelogrc) will be started with all the activities listed in it.
 My Mutt configuration lets me edit the report before sending it.
 
 If you forget to enter an activity, you can start your activity with a 24h
@@ -63,7 +64,7 @@
 
 If you make a mistake and type in the wrong activity name, don't worry.
 GTimeLog stores the time log in a simple plain text file
-~/.gtimelog/timelog.txt.  Every line contains a timestamp and the name of the
+~/.config/gtimelog/timelog.txt.  Every line contains a timestamp and the name of the
 activity that was finished at the time.  All other lines are ignored, so you
 can add comments if you want to -- just make sure no comment begins with a
 timestamp.  You do not have to worry about GTimeLog overwriting your changes
@@ -79,7 +80,7 @@
 from midnight makes it easy to read the graph scale as the time of day.  Try
 a bargraph with stacked values and both first row and column as labels.
 
-You can change the configuration directory (by default, ~/.gtimelog) by
+You can change the configuration directory (by default, ~/.config/gtimelog) by
 setting the environment variable $GTIMELOG_HOME to a non-empty string naming
 the directory you want to use.
 

=== modified file 'gtimelog.desktop'
--- gtimelog.desktop	2010-09-02 21:11:41 +0000
+++ gtimelog.desktop	2013-01-09 18:20:25 +0000
@@ -5,5 +5,5 @@
 Terminal=false
 Type=Application
 StartupNotify=true
-Icon=gnome-week.png
-Categories=Application;Utility
+Icon=gtimelog
+Categories=Application;Utility;

=== modified file 'scripts/export-my-calendar.py'
--- scripts/export-my-calendar.py	2012-11-28 17:49:14 +0000
+++ scripts/export-my-calendar.py	2013-01-09 18:20:25 +0000
@@ -12,11 +12,12 @@
 outputfile = 'calendar.ics'
 
 settings = gtimelog.Settings()
-configdir = os.path.expanduser('~/.gtimelog')
-settings_file = os.path.join(configdir, 'gtimelogrc')
+configdir = settings.get_config_dir()
+datadir = settings.get_data_dir()
+settings_file = settings.get_config_file()
 if os.path.exists(settings_file):
     settings.load(settings_file)
-timelog = gtimelog.TimeLog(os.path.join(configdir, 'timelog.txt'),
+timelog = gtimelog.TimeLog(settings.get_timelog_file(),
                            settings.virtual_midnight)
 window = timelog.window_for(d1, d2)
 window.icalendar(open(outputfile, 'w'))

=== modified file 'src/gtimelog/main.py'
--- src/gtimelog/main.py	2012-11-28 17:49:14 +0000
+++ src/gtimelog/main.py	2013-01-09 18:20:25 +0000
@@ -113,7 +113,7 @@
 ui_file = os.path.join(resource_dir, "gtimelog.ui")
 icon_file_bright = os.path.join(resource_dir, "gtimelog-small-bright.png")
 icon_file_dark = os.path.join(resource_dir, "gtimelog-small.png")
-default_home = '~/.gtimelog'
+legacy_default_home = '~/.gtimelog'
 
 # This is for distribution packages
 if not os.path.exists(ui_file):
@@ -704,8 +704,8 @@
     def weekly_report_categorized(self, output, email, who,
                                   estimated_column=False):
         """Format a weekly report with entries displayed  under categories."""
-        week = self.window.min_timestamp.strftime('%V')
-        subject = 'Weekly report for %s (week %s)' % (who, week)
+        week = self.window.min_timestamp.isocalendar()[1]
+        subject = 'Weekly report for {} (week {:0>2})'.format(who, week)
         return self._categorizing_report(output, email, who, subject,
                                          period_name='week',
                                          estimated_column=estimated_column)
@@ -721,8 +721,8 @@
 
     def weekly_report_plain(self, output, email, who, estimated_column=False):
         """Format a weekly report ."""
-        week = self.window.min_timestamp.strftime('%V')
-        subject = 'Weekly report for %s (week %s)' % (who, week)
+        week = self.window.min_timestamp.isocalendar()[1]
+        subject = 'Weekly report for {} (week {:0>2})'.format(who, week)
         return self._plain_report(output, email, who, subject,
                                   period_name='week',
                                   estimated_column=estimated_column)
@@ -746,12 +746,12 @@
         # would give us translated names
         weekday_names = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
         weekday = weekday_names[window.min_timestamp.weekday()]
-        week = window.min_timestamp.strftime('%V')
-        print >> output, "To: %(email)s" % {'email': email}
-        print >> output, ("Subject: %(date)s report for %(who)s"
-                          " (%(weekday)s, week %(week)s)"
-                          % {'date': window.min_timestamp.strftime('%Y-%m-%d'),
-                             'weekday': weekday, 'week': week, 'who': who})
+        week = window.min_timestamp.isocalendar()[1]
+        print >> output, "To: {email}".format(email=email)
+        print >> output, ("Subject: {:%Y-%m-%d} report for {who}"
+                          " ({weekday}, week {week:0>2})".format(
+                          window.min_timestamp, who=who,
+                          weekday=weekday, week=week))
         print >> output
         items = list(window.all_entries())
         if not items:
@@ -1066,13 +1066,39 @@
 
     report_style = 'plain'
 
+    def check_legacy_config(self):
+        envar_home = os.environ.get('GTIMELOG_HOME')
+        if envar_home is not None:
+            return os.path.expanduser(envar_home)
+        if os.path.isdir(os.path.expanduser(legacy_default_home)):
+            return os.path.expanduser(legacy_default_home)
+
     def get_config_dir(self):
-        envar_home = os.environ.get('GTIMELOG_HOME')
-        return os.path.expanduser(envar_home if envar_home else default_home)
+         legacy = self.check_legacy_config()
+         if legacy is not None: return legacy
+         #http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+         xdg =  os.environ.get('XDG_CONFIG_HOME')
+         if xdg is not None:
+             return os.path.expanduser(xdg)
+         else:
+              return os.path.expanduser("~/.config/gtimelog")
+
+    def get_data_dir(self):
+         legacy = self.check_legacy_config()
+         if legacy is not None: return legacy
+
+         xdg =  os.environ.get('XDG_DATA_HOME')
+         if xdg is not None:
+              return os.path.expanduser(xdg)
+         else:
+              return os.path.expanduser("~/.local/share/gtimelog")
 
     def get_config_file(self):
         return os.path.join(self.get_config_dir(), 'gtimelogrc')
 
+    def get_timelog_file(self):
+        return os.path.join(self.get_data_dir(), 'timelog.txt')
+    
     def _config(self):
         config = ConfigParser.RawConfigParser()
         config.add_section('gtimelog')
@@ -1527,7 +1553,8 @@
         else:
             today = self.looking_at_date
             window = self.timelog.window_for_day(today)
-        today = today.strftime('%A, %Y-%m-%d (week %V)')
+        today = ("{:%A, %Y-%m-%d} (week {:0>2})"
+        .format(today, today.isocalendar()[1]))
         self.current_view_label.set_text(today)
         if self.chronological:
             for item in window.all_entries():
@@ -2286,13 +2313,21 @@
 
     settings = Settings()
     configdir = settings.get_config_dir()
+    datadir = settings.get_data_dir()
     try:
-        # Create it if it doesn't exist.
+        # Create configdir if it doesn't exist.
         os.makedirs(configdir)
     except OSError as error:
         if error.errno != errno.EEXIST:
             # XXX: not the most friendly way of error reporting for a GUI app
             raise
+    try:
+        # Create datadir if it doesn't exist.
+        os.makedirs(datadir)
+    except OSError as error:
+        if error.errno != errno.EEXIST:
+            raise
+
     settings_file = settings.get_config_file()
     if not os.path.exists(settings_file):
         if opts.debug:
@@ -2303,20 +2338,20 @@
             print 'Loading settings from %s' % settings_file
         settings.load(settings_file)
     if opts.debug:
-        print 'Loading time log from %s' % os.path.join(configdir, 'timelog.txt')
+        print 'Loading time log from %s' % settings.get_timelog_file()
         print 'Assuming date changes at %s' % settings.virtual_midnight
-    timelog = TimeLog(os.path.join(configdir, 'timelog.txt'),
+    timelog = TimeLog(settings.get_timelog_file(),
                       settings.virtual_midnight)
     if settings.task_list_url:
         if opts.debug:
             print 'Loading cached remote tasks from %s' % (
-                               os.path.join(configdir, 'remote-tasks.txt'))
+                               os.path.join(datadir, 'remote-tasks.txt'))
         tasks = RemoteTaskList(settings.task_list_url,
-                               os.path.join(configdir, 'remote-tasks.txt'))
+                               os.path.join(datadir, 'remote-tasks.txt'))
     else:
         if opts.debug:
-            print 'Loading tasks from %s' % os.path.join(configdir, 'tasks.txt')
-        tasks = TaskList(os.path.join(configdir, 'tasks.txt'))
+            print 'Loading tasks from %s' % os.path.join(datadir, 'tasks.txt')
+        tasks = TaskList(os.path.join(datadir, 'tasks.txt'))
     main_window = MainWindow(timelog, settings, tasks)
     start_in_tray = False
     if settings.show_tray_icon: