Merge lp:~mterry/timezonemap/alternate-names into lp:timezonemap

[Michael Terry]

Exposes the "alternate_names" and "en_name_utf8" fields from the cities database.

This branch exposes the "alternate_names" and "en_name_utf8" fields from the cities database.

My rationale here is enabling the unity8 out-of-box wizard to search on native-language city names.

Ideally, we could use the alternateNames.txt database, but that is 400MB uncompressed, and we probably don't want to add that to the images. (If we did use that, we could add an API like get_localized_name(gchar *locale) or some such, which clients could use to populate their databases with just the current language's search names. That would be swell.)

But failing that, cities15000.txt has a short list of alternate names (without noting which language each name is in). I've exposed that here, so that clients can search across all possible language strings.

While doing that, I noticed that our en_name field was using the ascii name. I considered just upgrading it to the utf8 version, but guessed that you folks wouldn't like that change in behavior. So I exposed the utf8 version too (makes for a better display value).

[lp:~mterry/timezonemap/alternate-names]

59. By Michael Terry on 2015-12-10

Bump version

[Mathieu Trudel-Lapierre (cyphermox)]

LGTM

review: Approve

Unmerged revisions

59. By Michael Terry on 2015-12-10

Bump version

58. By Michael Terry on 2015-12-10

Add new field en_name_utf8 rather than upgrading en_name in place

57. By Michael Terry on 2015-12-10

Expose alternate_names from cities database

=== modified file 'configure.ac'
--- configure.ac	2015-05-07 23:16:25 +0000
+++ configure.ac	2015-12-14 21:59:55 +0000
@@ -1,5 +1,5 @@
 AC_INIT([libtimezonemap],
-        [0.4.4],
+        [0.4.5],
         [http://bugs.launchpad.net/libtimezonemap],
         [libtimezonemap],
         [http://launchpad.net/libtimezonemap])
 
=== modified file 'debian/changelog'
--- debian/changelog	2015-05-07 23:18:41 +0000
+++ debian/changelog	2015-12-14 21:59:55 +0000
@@ -1,3 +1,9 @@
+libtimezonemap (0.4.5) UNRELEASED; urgency=medium
+
+  * Add alternate_names and en_name_utf8 fields to locations.
+
+ -- Michael Terry <[e-mail]>  Thu, 10 Dec 2015 15:40:49 -0500
+
 libtimezonemap (0.4.4) wily; urgency=medium
 
   [ David Shea ]
 
=== modified file 'src/cc-timezone-location.c'
--- src/cc-timezone-location.c	2013-11-29 12:23:12 +0000
+++ src/cc-timezone-location.c	2015-12-14 21:59:55 +0000
@@ -34,6 +34,8 @@
     gchar *country;
     gchar *full_country;
     gchar *en_name;
+    gchar *en_name_utf8;
+    gchar **alternate_names;
     gchar *state;
     gdouble latitude;
     gdouble longitude;
@@ -48,6 +50,8 @@
   PROP_COUNTRY,
   PROP_FULL_COUNTRY,
   PROP_EN_NAME,
+  PROP_EN_NAME_UTF8,
+  PROP_ALTERNATE_NAMES,
   PROP_STATE,
   PROP_LATITUDE,
   PROP_LONGITUDE,
@@ -73,6 +77,12 @@
     case PROP_EN_NAME:
       g_value_set_string (value, priv->en_name);
       break;
+    case PROP_EN_NAME_UTF8:
+      g_value_set_string (value, priv->en_name_utf8);
+      break;
+    case PROP_ALTERNATE_NAMES:
+      g_value_set_boxed (value, priv->alternate_names);
+      break;
     case PROP_STATE:
       g_value_set_string (value, priv->state);
       break;
@@ -113,6 +123,12 @@
     case PROP_EN_NAME:
       cc_timezone_location_set_en_name(loc, g_value_get_string(value));
       break;
+    case PROP_EN_NAME_UTF8:
+      cc_timezone_location_set_en_name_utf8(loc, g_value_get_string(value));
+      break;
+    case PROP_ALTERNATE_NAMES:
+      cc_timezone_location_set_alternate_names(loc, (const gchar **)g_value_get_boxed(value));
+      break;
     case PROP_STATE:
       cc_timezone_location_set_state(loc, g_value_get_string(value));
       break;
@@ -159,6 +175,18 @@
       priv->en_name = NULL;
     }
 
+  if (priv->en_name_utf8)
+    {
+      g_free (priv->en_name_utf8);
+      priv->en_name_utf8 = NULL;
+    }
+
+  if (priv->alternate_names)
+    {
+      g_strfreev (priv->alternate_names);
+      priv->alternate_names = NULL;
+    }
+
   if (priv->state) 
     {
       g_free (priv->state);
@@ -220,6 +248,20 @@
                                           "",
                                           G_PARAM_READWRITE));
   g_object_class_install_property(object_class,
+                                  PROP_EN_NAME_UTF8,
+                                  g_param_spec_string ("en_name_utf8",
+                                          "English Name in UTF-8",
+                                          "The name of the location, encoded in UTF-8",
+                                          "",
+                                          G_PARAM_READWRITE));
+  g_object_class_install_property(object_class,
+                                  PROP_ALTERNATE_NAMES,
+                                  g_param_spec_boxed ("alternate_names",
+                                          "Alternate Names",
+                                          "Non-English names of the location",
+                                          G_TYPE_STRV,
+                                          G_PARAM_READWRITE));
+  g_object_class_install_property(object_class,
                                   PROP_STATE,
                                   g_param_spec_string ("state",
                                           "State",
@@ -320,6 +362,32 @@
     g_object_notify(G_OBJECT(loc), "en_name");
 }
 
+const gchar *cc_timezone_location_get_en_name_utf8(CcTimezoneLocation *loc)
+{
+    return loc->priv->en_name_utf8;
+}
+
+void cc_timezone_location_set_en_name_utf8(CcTimezoneLocation *loc, const gchar *en_name_utf8)
+{
+    g_free(loc->priv->en_name_utf8);
+    loc->priv->en_name_utf8 = g_strdup(en_name_utf8);
+
+    g_object_notify(G_OBJECT(loc), "en_name_utf8");
+}
+
+const gchar * const *cc_timezone_location_get_alternate_names(CcTimezoneLocation *loc)
+{
+    return (const gchar * const *)loc->priv->alternate_names;
+}
+
+void cc_timezone_location_set_alternate_names(CcTimezoneLocation *loc, const gchar **alternate_names)
+{
+    g_strfreev(loc->priv->alternate_names);
+    loc->priv->alternate_names = g_strdupv((gchar **)alternate_names);
+
+    g_object_notify(G_OBJECT(loc), "alternate_names");
+}
+
 const gchar *cc_timezone_location_get_state(CcTimezoneLocation *loc)
 {
     return loc->priv->state;
 
=== modified file 'src/cc-timezone-location.h'
--- src/cc-timezone-location.h	2013-11-14 15:50:49 +0000
+++ src/cc-timezone-location.h	2015-12-14 21:59:55 +0000
@@ -77,6 +77,10 @@
 void cc_timezone_location_set_full_country(CcTimezoneLocation *loc, const gchar *full_country);
 const gchar *cc_timezone_location_get_en_name(CcTimezoneLocation *loc);
 void cc_timezone_location_set_en_name(CcTimezoneLocation *loc, const gchar *en_name);
+const gchar *cc_timezone_location_get_en_name_utf8(CcTimezoneLocation *loc);
+void cc_timezone_location_set_en_name_utf8(CcTimezoneLocation *loc, const gchar *en_name_utf8);
+const gchar* const *cc_timezone_location_get_alternate_names(CcTimezoneLocation *loc);
+void cc_timezone_location_set_alternate_names(CcTimezoneLocation *loc, const gchar **alternate_names);
 const gchar *cc_timezone_location_get_state(CcTimezoneLocation *loc);
 void cc_timezone_location_set_state(CcTimezoneLocation *loc, const gchar *state);
 gdouble cc_timezone_location_get_latitude(CcTimezoneLocation *loc);
 
=== modified file 'src/test-timezone.c'
--- src/test-timezone.c	2013-11-29 12:26:52 +0000
+++ src/test-timezone.c	2015-12-14 21:59:55 +0000
@@ -3,33 +3,15 @@
 
 #include "tz.h"
 
-int main (int argc, char **argv)
+gboolean test_pixmaps(TzDB *db, const gchar *pixmap_dir)
 {
-    TzDB *db;
     GPtrArray *locs;
     guint i;
-    char *pixmap_dir;
-    int retval = 0;
-
-        setlocale (LC_ALL, "");
-
-    if (argc == 2) 
-      {
-        pixmap_dir = g_strdup (argv[1]);
-      } else if (argc == 1) {
-        pixmap_dir = g_strdup ("data/");
-      } else {
-        g_message ("Usage: %s [PIXMAP DIRECTORY]", argv[0]);
-        return 1;
-      }
-
-#if !GLIB_CHECK_VERSION(2, 35, 0)
-    g_type_init();
-#endif
+    gboolean retval = TRUE;
+
     GValue zone = {0};
     g_value_init(&zone, G_TYPE_STRING);
 
-    db = tz_load_db ();
     locs = tz_get_locations (db);
     for (i = 0; i < locs->len ; i++)
       {
@@ -53,15 +35,110 @@
         if (g_file_test (path, G_FILE_TEST_IS_REGULAR) == FALSE)
           {
             g_message ("File '%s' missing for zone '%s'", filename, g_value_get_string(&zone));
-            retval = 1;
+            retval = FALSE;
           }
 
         g_free (filename);
         g_free (path);
         tz_info_free (info);
       }
+
+    return retval;
+}
+
+gboolean test_names(TzDB *db)
+{
+    GPtrArray *locs = tz_get_locations (db);
+    for (guint i = 0; i < locs->len; i++)
+      {
+        CcTimezoneLocation *loc = locs->pdata[i];
+
+        gchar *en_name;
+        g_object_get (G_OBJECT (loc), "en_name", &en_name, NULL);
+
+        if (g_strcmp0 (en_name, "Aibak") == 0)
+          {
+            g_free (en_name);
+
+            gchar *en_name_utf8;
+            g_object_get (G_OBJECT (loc), "en_name_utf8", &en_name_utf8, NULL);
+            if (g_strcmp0 (en_name_utf8, "Aībak") != 0)
+              {
+                g_message ("Aībak utf8 name is wrong: %s", en_name_utf8);
+                g_free (en_name_utf8);
+                return FALSE;
+              }
+            g_free (en_name_utf8);
+
+            gchar **alternate_names;
+            g_object_get (G_OBJECT (loc), "alternate_names", &alternate_names, NULL);
+
+            gchar *expected_names[] = {"Aibak", "Aybak", "Aībak", "Eybak",
+                                       "Haibak", "Samagan", "Samangan",
+                                       "Samangān", "aybk", "smngan", "Āybak",
+                                       "Саманган", "آیبک" ,"ایبک" ,"سمنگان", NULL};
+
+            guint names_len = g_strv_length (alternate_names);
+            if (names_len != g_strv_length (expected_names))
+              {
+                g_message ("Aībak alternate name list is wrong length (%d vs %d):\n%s",
+                           names_len, g_strv_length (expected_names),
+                           g_strjoinv (",", alternate_names));
+                g_strfreev (alternate_names);
+                return FALSE;
+              }
+
+            for (guint j = 0; j < names_len; j++)
+              {
+                if (g_strcmp0 (alternate_names[j], expected_names[j]) != 0)
+                  {
+                    g_message ("Aībak alternate name list has wrong contents (%s vs %s):\n%s",
+                               alternate_names[j], expected_names[j],
+                               g_strjoinv (",", alternate_names));
+                    g_strfreev (alternate_names);
+                    return FALSE;
+                  }
+              }
+
+            return TRUE;
+          }
+
+        g_free (en_name);
+      }
+
+    g_message ("Did not find Aībak");
+    return FALSE;
+}
+
+int main (int argc, char **argv)
+{
+    TzDB *db;
+    gchar *pixmap_dir;
+    gboolean retval = TRUE;
+
+        setlocale (LC_ALL, "");
+
+    if (argc == 2) 
+      {
+        pixmap_dir = g_strdup (argv[1]);
+      } else if (argc == 1) {
+        pixmap_dir = g_strdup ("data/");
+      } else {
+        g_message ("Usage: %s [PIXMAP DIRECTORY]", argv[0]);
+        return 1;
+      }
+
+#if !GLIB_CHECK_VERSION(2, 35, 0)
+    g_type_init();
+#endif
+
+    db = tz_load_db ();
+
+    retval = test_pixmaps(db, pixmap_dir) && retval;
+    retval = test_names(db) && retval;
+
     tz_db_free (db);
     g_free (pixmap_dir);
 
-    return retval;
+    return retval ? 0 : 1;
 }
 
=== modified file 'src/tz.c'
--- src/tz.c	2013-12-16 17:01:37 +0000
+++ src/tz.c	2015-12-14 21:59:55 +0000
@@ -114,6 +114,11 @@
 
     cc_timezone_location_set_country(loc, parsed_data_v[8]);
     cc_timezone_location_set_en_name(loc, parsed_data_v[2]);
+    cc_timezone_location_set_en_name_utf8(loc, parsed_data_v[1]);
+
+    gchar **altnames = g_strsplit(parsed_data_v[3], ",", -1);
+    cc_timezone_location_set_alternate_names(loc, (const gchar **)altnames);
+    g_strfreev(altnames);
 
     gchar * tmpState = g_strdup_printf ("%s.%s",
             cc_timezone_location_get_country(loc),