Merge lp:~mterry/ubuntu-system-settings/timezone-name into lp:ubuntu-system-settings

[Michael Terry]

Show user-friendly city name for the timezone.

Use existing timezone-name gsettings field to store a user-friendly version of the timezone. This is a strategy already used on the desktop. This branch just brings it to Touch too.

https://code.launchpad.net/~mterry/unity8/timezone-name/+merge/291042 should land at the same. I don't know of any other consumers.

[Jonas G. Drange (jonas-drange)]

Since we're currently not getting any debs from ci, Michael, could you create arm debs either manually, in a silo (silo preferred so we can test both changes together?).

[Michael Terry (mterry)]

OK, check silo 33. It also has the geonames translation support (so when searching for timezones, you can see localized city names). But that's unrelated to this MP. Just a silo bonus.

[Jonas G. Drange (jonas-drange)]

This is great. Currently, if I select the city “Bergen”, the tz is set to “Europe/Oslo”. Silo 33 presents the tz as “Bergen +2”.

Thanks!

review: Approve

[Lukáš Tinkl (lukas-kde)]

Worked well in my testing too (in silo 33)

review: Approve

[Lukáš Tinkl (lukas-kde)]

Minor nitpick:

QString TimeDate::timeZoneName()

should be const

[Michael Terry (mterry)]

But if it's const, it can't call initializeTimeZone. Maybe lazily-initializing the timezone info isn't worth the const-uncleanliness... But I figured I'd follow timeZone()'s lead here.

=== modified file 'debian/changelog'
--- debian/changelog	2016-03-25 20:53:47 +0000
+++ debian/changelog	2016-04-05 20:30:13 +0000
@@ -1,3 +1,9 @@
+ubuntu-system-settings (0.4+16.04.20160325-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Bump version number for change in TimeDate plugin API
+
+ -- Michael Terry <[e-mail]>  Tue, 05 Apr 2016 15:16:11 -0400
+
 ubuntu-system-settings (0.3+16.04.20160325-0ubuntu1) xenial; urgency=medium
 
   * Bump Ubuntu.Content import to 1.3 to prevent mixed version imports

=== modified file 'debian/control'
--- debian/control	2016-03-23 08:46:51 +0000
+++ debian/control	2016-04-05 20:30:13 +0000
@@ -72,6 +72,7 @@
          gsettings-desktop-schemas,
          gsettings-ubuntu-schemas (>= 0.0.4),
          indicator-bluetooth (>> 0.0.6+13.10.20131010),
+         indicator-datetime,
          indicator-network (>= 0.7.1),
          indicator-power (>= 12.10.6+15.04.20150130),
          powerd (>= 0.15) | gnome-settings-daemon,

=== modified file 'plugins/time-date/ChooseTimeZone.qml'
--- plugins/time-date/ChooseTimeZone.qml	2015-10-16 13:42:50 +0000
+++ plugins/time-date/ChooseTimeZone.qml	2016-04-05 20:30:13 +0000
@@ -22,7 +22,7 @@
 import SystemSettings 1.0
 import Ubuntu.Components 1.3
 import Ubuntu.Components.ListItems 1.3 as ListItem
-import Ubuntu.SystemSettings.TimeDate 1.0
+import Ubuntu.SystemSettings.TimeDate 1.1
 
 ItemPage {
     title: i18n.tr("Time zone")
@@ -54,7 +54,7 @@
 
     ListItem.Standard {
         anchors.top: setTimeZoneSelector.bottom
-        text: timeDatePanel.timeZone
+        text: timeDatePanel.timeZoneName
         enabled: false
         visible: showAllUI && setTimeZoneSelector.selectedIndex == 0 // Automatically
     }
@@ -103,7 +103,7 @@
             // are highlighted.
             onClicked: {
                 locationsListView.manuallySelected = displayName
-                timeDatePanel.timeZone = timeZone
+                timeDatePanel.setTimeZone(timeZone, city);
             }
             selected: locationsListView.manuallySelected === "" ?
                           timeDatePanel.timeZone == timeZone :

=== modified file 'plugins/time-date/PageComponent.qml'
--- plugins/time-date/PageComponent.qml	2015-10-16 13:42:50 +0000
+++ plugins/time-date/PageComponent.qml	2016-04-05 20:30:13 +0000
@@ -23,7 +23,7 @@
 import Ubuntu.Components 1.3
 import Ubuntu.Components.ListItems 1.3 as ListItem
 import Ubuntu.Components.Popups 1.3
-import Ubuntu.SystemSettings.TimeDate 1.0
+import Ubuntu.SystemSettings.TimeDate 1.1
 
 ItemPage {
     id: root
@@ -65,8 +65,7 @@
             ListItem.SingleValue {
                 objectName: "timeZone"
                 id: timeZone
-                //e.g. America/New_York -> America/New York
-                text: timeDatePanel.timeZone.replace("_", " ")
+                text: timeDatePanel.timeZoneName
                 value: getUTCOffset()
                 progression: true
                 onClicked: pageStack.push(Qt.resolvedUrl("ChooseTimeZone.qml"), {

=== modified file 'plugins/time-date/plugin.cpp'
--- plugins/time-date/plugin.cpp	2014-07-23 13:53:48 +0000
+++ plugins/time-date/plugin.cpp	2016-04-05 20:30:13 +0000
@@ -29,7 +29,7 @@
 {
     Q_ASSERT(uri == QLatin1String("Ubuntu.SystemSettings.TimeDate"));
 
-    qmlRegisterType<TimeDate>(uri, 1, 0, "UbuntuTimeDatePanel");
+    qmlRegisterType<TimeDate>(uri, 1, 1, "UbuntuTimeDatePanel");
 }
 
 void BackendPlugin::initializeEngine(QQmlEngine *engine, const char *uri)

=== modified file 'plugins/time-date/timedate.cpp'
--- plugins/time-date/timedate.cpp	2016-02-23 20:23:18 +0000
+++ plugins/time-date/timedate.cpp	2016-04-05 20:30:13 +0000
@@ -37,6 +37,7 @@
                          "/org/freedesktop/timedate1",
                          "org.freedesktop.timedate1",
                           m_systemBusConnection),
+    m_indicatorSettings(g_settings_new("com.canonical.indicator.datetime")),
     m_timeZoneModel()
 {
     connect (&m_serviceWatcher,
@@ -68,19 +69,35 @@
 QString TimeDate::timeZone()
 {
     if (m_currentTimeZone.isEmpty() || m_currentTimeZone.isNull())
-        m_currentTimeZone = getTimeZone();
+        initializeTimeZone();
 
      return m_currentTimeZone;
 }
 
-QString TimeDate::getTimeZone()
-{
-    QVariant tz(m_timeDateInterface.property("Timezone"));
-
-    if (tz.isValid())
-        return tz.toString();
-
-    return QString();
+QString TimeDate::timeZoneName()
+{
+    if (m_currentTimeZoneName.isEmpty() || m_currentTimeZoneName.isNull())
+        initializeTimeZone();
+
+     return m_currentTimeZoneName;
+}
+
+void TimeDate::initializeTimeZone()
+{
+    // Get timezone from authoritative source
+    m_currentTimeZone = m_timeDateInterface.property("Timezone").toString();
+    if (m_currentTimeZone.isEmpty())
+        return;
+
+    // And get saved user-visible name if we have one
+    g_autofree gchar *gtzname = g_settings_get_string(m_indicatorSettings, "timezone-name");
+    QString tzname(gtzname);
+    int space = tzname.indexOf(' ');
+    if (space > 0 && tzname.left(space) == m_currentTimeZone && tzname.size() > space + 1) {
+        m_currentTimeZoneName = tzname.mid(space + 1);
+    } else {
+        m_currentTimeZoneName = m_currentTimeZone.split('/').last().replace('_', ' ');
+    }
 }
 
 bool TimeDate::useNTP()
@@ -114,10 +131,7 @@
 
     if (changed_properties.contains("Timezone")) {
         QString tz(changed_properties["Timezone"].toString());
-        if (tz != m_currentTimeZone) {
-            m_currentTimeZone = tz;
-            Q_EMIT timeZoneChanged();
-        }
+        setTimeZone(tz);
     }
 
     if (changed_properties.contains("NTP")) {
@@ -143,9 +157,26 @@
         setUpInterface();
 }
 
-void TimeDate::setTimeZone(QString &time_zone)
+void TimeDate::setTimeZone(const QString &time_zone, const QString &time_zone_name)
 {
-    m_timeDateInterface.call("SetTimezone", time_zone, false);
+    if (m_currentTimeZone != time_zone ||
+        (!time_zone_name.isEmpty() && m_currentTimeZoneName != time_zone_name))
+    {
+        auto name = time_zone_name;
+        if (name.isEmpty())
+            name = time_zone.split('/').last().replace('_', ' ');
+
+        auto reply = m_timeDateInterface.call("SetTimezone", time_zone, false);
+        if (reply.errorName().isEmpty()) {
+            m_currentTimeZone = time_zone;
+            m_currentTimeZoneName = name;
+
+            auto combined = QString("%1 %2").arg(time_zone, name);
+            g_settings_set_string(m_indicatorSettings, "timezone-name", combined.toUtf8().data());
+
+            Q_EMIT timeZoneChanged();
+        }
+    }
 }
 
 QAbstractItemModel *TimeDate::getTimeZoneModel()
@@ -175,4 +206,5 @@
 }
 
 TimeDate::~TimeDate() {
+    g_clear_object (&m_indicatorSettings);
 }

=== modified file 'plugins/time-date/timedate.h'
--- plugins/time-date/timedate.h	2014-12-08 17:28:29 +0000
+++ plugins/time-date/timedate.h	2016-04-05 20:30:13 +0000
@@ -28,13 +28,16 @@
 #include <QDBusServiceWatcher>
 #include <QObject>
 #include <QProcess>
+#include <gio/gio.h>
 
 class TimeDate : public QObject
 {
     Q_OBJECT
     Q_PROPERTY (QString timeZone
                 READ timeZone
-                WRITE setTimeZone
+                NOTIFY timeZoneChanged)
+    Q_PROPERTY (QString timeZoneName
+                READ timeZoneName
                 NOTIFY timeZoneChanged)
     Q_PROPERTY (QAbstractItemModel *timeZoneModel
                 READ getTimeZoneModel
@@ -53,8 +56,9 @@
 public:
     explicit TimeDate(QObject *parent = 0);
     ~TimeDate();
-    void setTimeZone (QString &time_zone);
+    Q_INVOKABLE void setTimeZone (const QString &time_zone, const QString &time_zone_name = QString());
     QString timeZone();
+    QString timeZoneName();
     bool useNTP();
     QAbstractItemModel *getTimeZoneModel();
     QString getFilter();
@@ -76,13 +80,15 @@
 private:
     bool m_useNTP;
     QString m_currentTimeZone;
+    QString m_currentTimeZoneName;
     QDBusConnection m_systemBusConnection;
     QDBusServiceWatcher m_serviceWatcher;
     QDBusInterface m_timeDateInterface;
+    GSettings *m_indicatorSettings;
     QString m_objectPath;
     TimeZoneLocationModel m_timeZoneModel;
     QString m_filter;
-    QString getTimeZone();
+    void initializeTimeZone();
     bool getUseNTP();
     void setUpInterface();