git.maemo.org Git - modest/blob - src/maemo/easysetup/modest-easysetup-country-combo-box.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef _GNU_SOURCE
  31 #define _GNU_SOURCE /* So we can use the getline() function, which is a convenient GNU extension. */
  32 #endif
  33
  34 #include <stdio.h>
  35
  36 #include "../modest-maemo-utils.h"
  37 #include "modest-easysetup-country-combo-box.h"
  38 #include <gtk/gtkliststore.h>
  39 #include <gtk/gtkcelllayout.h>
  40 #include <gtk/gtkcellrenderertext.h>
  41
  42 #include <stdlib.h>
  43 #include <string.h> /* For memcpy() */
  44
  45 #include <libintl.h> /* For dgettext(). */
  46
  47 /* Include config.h so that _() works: */
  48 #ifdef HAVE_CONFIG_H
  49 #include <config.h>
  50 #endif
  51
  52 #define MAX_LINE_LEN 128 /* max length of a line in MCC file */
  53
  54 G_DEFINE_TYPE (EasysetupCountryComboBox, easysetup_country_combo_box, GTK_TYPE_COMBO_BOX);
  55
  56 typedef struct
  57 {
  58         GtkTreeModel *model;
  59 } ModestEasysetupCountryComboBoxPrivate;
  60
  61 #define MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), \
  62                                                         MODEST_EASYSETUP_TYPE_COUNTRY_COMBO_BOX, \
  63                                                         ModestEasysetupCountryComboBoxPrivate))
  64
  65 static void
  66 easysetup_country_combo_box_get_property (GObject *object, guint property_id,
  67                                                                                                                         GValue *value, GParamSpec *pspec)
  68 {
  69         switch (property_id) {
  70         default:
  71                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  72         }
  73 }
  74
  75 static void
  76 easysetup_country_combo_box_set_property (GObject *object, guint property_id,
  77                                                                                                                         const GValue *value, GParamSpec *pspec)
  78 {
  79         switch (property_id) {
  80         default:
  81                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  82         }
  83 }
  84
  85 static void
  86 easysetup_country_combo_box_dispose (GObject *object)
  87 {
  88         if (G_OBJECT_CLASS (easysetup_country_combo_box_parent_class)->dispose)
  89                 G_OBJECT_CLASS (easysetup_country_combo_box_parent_class)->dispose (object);
  90 }
  91
  92 enum MODEL_COLS {
  93         MODEL_COL_NAME = 0, /* string */
  94         MODEL_COL_MCC  = 1 /* the 'effective mcc' for this country */
  95 };
  96
  97
  98 static void
  99 easysetup_country_combo_box_finalize (GObject *object)
 100 {
 101         ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (object);
 102
 103         g_object_unref (G_OBJECT (priv->model));
 104         G_OBJECT_CLASS (easysetup_country_combo_box_parent_class)->finalize (object);
 105 }
 106
 107 static void
 108 easysetup_country_combo_box_class_init (EasysetupCountryComboBoxClass *klass)
 109 {
 110         GObjectClass *object_class = G_OBJECT_CLASS (klass);
 111
 112         g_type_class_add_private (klass, sizeof (ModestEasysetupCountryComboBoxPrivate));
 113
 114         object_class->get_property = easysetup_country_combo_box_get_property;
 115         object_class->set_property = easysetup_country_combo_box_set_property;
 116         object_class->dispose = easysetup_country_combo_box_dispose;
 117         object_class->finalize = easysetup_country_combo_box_finalize;
 118 }
 119
 120
 121
 122
 123 /* cluster mcc's, based on the list
 124  * http://en.wikipedia.org/wiki/Mobile_country_code
 125  */
 126 static int
 127 effective_mcc (gint mcc)
 128 {
 129         switch (mcc) {
 130         case 405: return 404; /* india */
 131         case 441: return 440; /* japan */
 132         case 235: return 234; /* united kingdom */
 133         case 311:
 134         case 312:
 135         case 313:
 136         case 314:
 137         case 315:
 138         case 316: return 310; /* united states */
 139         default:  return mcc;
 140         }
 141 }
 142
 143
 144 /* each line is of the form:
 145    xxx    logical_id
 146
 147   NOTE: this function is NOT re-entrant, the out-param country
 148   are static strings that should NOT be freed. and will change when
 149   calling this function again
 150
 151   also note, this function will return the "effective mcc", which
 152   is the normalized mcc for a country - ie. even if the there
 153   are multiple entries for the United States with various mccs,
 154   this function will always return 310, even if the real mcc parsed
 155   would be 314. see the 'effective_mcc' function above.
 156 */
 157 static int
 158 parse_mcc_mapping_line (const char* line,  char** country)
 159 {
 160         int i, j;
 161         char mcc[4];  /* the mcc code, always 3 bytes*/
 162         static char my_country[128];
 163
 164         if (!line) {
 165                 *country = NULL;
 166                 return 0;
 167         }
 168
 169         for (i = 3, j = 0; i < 128; ++i) {
 170                 char kar = line[i];
 171                 if (kar == '\0')
 172                         break;
 173                 else if (kar < '_')
 174                         continue;
 175                 else
 176                         my_country [j++] = kar;
 177         }
 178         my_country[j] = '\0';
 179
 180         mcc[0] = line[0];
 181         mcc[1] = line[1];
 182         mcc[2] = line[2];
 183         mcc[3] = '\0';
 184
 185         *country = my_country;
 186
 187         return effective_mcc ((int) strtol ((const char*)mcc, NULL, 10));
 188 }
 189
 190 /** Note that the mcc_mapping file is installed
 191  * by the operator-wizard-settings package.
 192  */
 193 static void
 194 load_from_file (EasysetupCountryComboBox *self)
 195 {
 196         ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (self);
 197         GtkListStore *liststore = GTK_LIST_STORE (priv->model);
 198
 199         char line[MAX_LINE_LEN];
 200         guint previous_mcc = 0;
 201
 202         FILE *file = modest_maemo_open_mcc_mapping_file ();
 203         if (!file) {
 204                 g_warning("Could not open mcc_mapping file");
 205                 return;
 206         }
 207
 208         while (fgets (line, MAX_LINE_LEN, file) != NULL) {
 209
 210                 int mcc;
 211                 char *country = NULL;
 212                 mcc = parse_mcc_mapping_line (line, &country);
 213                 if (!country || mcc == 0) {
 214                         g_warning ("%s: error parsing line: '%s'", __FUNCTION__, line);
 215                         continue;
 216                 }
 217
 218                 if (mcc == previous_mcc) {
 219                         /* g_warning ("already seen: %s", line); */
 220                         continue;
 221                 }
 222                 previous_mcc = mcc;
 223
 224                 /* Get the translation for the country name:
 225                  * Note that the osso_countries_1.0 translation domain files are installed
 226                  * by the operator-wizard-settings package. */
 227                 /* For post-Bora, there is a separate (meta)package osso-countries-l10n-mr0 */
 228
 229                 /* Note: Even when the untranslated names are different, there may still be
 230                  * duplicate translated names. They would be translation bugs.
 231                  */
 232                 const gchar *name_translated = dgettext ("osso-countries", country);
 233
 234                 /* Add the row to the model: */
 235                 GtkTreeIter iter;
 236                 gtk_list_store_append (liststore, &iter);
 237                 gtk_list_store_set(liststore, &iter, MODEL_COL_MCC, mcc, MODEL_COL_NAME, name_translated, -1);
 238         }
 239         fclose (file);
 240
 241         /* Sort the items: */
 242         gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (liststore),
 243                                               MODEL_COL_NAME, GTK_SORT_ASCENDING);
 244 }
 245
 246 static void
 247 easysetup_country_combo_box_init (EasysetupCountryComboBox *self)
 248 {
 249         ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (self);
 250         priv->model = NULL;
 251 }
 252
 253 void
 254 easysetup_country_combo_box_load_data(EasysetupCountryComboBox *self)
 255 {
 256         ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (self);
 257
 258         /* Create a tree model for the combo box,
 259          * with a string for the name, and an int for the MCC ID.
 260          * This must match our MODEL_COLS enum constants.
 261          */
 262         priv->model = GTK_TREE_MODEL (gtk_list_store_new (2,  G_TYPE_STRING, G_TYPE_INT));
 263
 264         /* Setup the combo box: */
 265         GtkComboBox *combobox = GTK_COMBO_BOX (self);
 266
 267         /* Country column:
 268          * The ID model column in not shown in the view. */
 269         GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
 270         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 271         gtk_cell_layout_pack_start(GTK_CELL_LAYOUT (combobox), renderer, TRUE);
 272         gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combobox), renderer,
 273         "text", MODEL_COL_NAME, NULL);
 274
 275
 276         g_assert (GTK_IS_LIST_STORE(priv->model));
 277
 278
 279         /* Fill the model with rows: */
 280         load_from_file (self);
 281         /* Set this _after_ loading from file, it makes loading faster */
 282         gtk_combo_box_set_model (combobox, priv->model);
 283 }
 284
 285 EasysetupCountryComboBox*
 286 easysetup_country_combo_box_new (void)
 287 {
 288         return g_object_new (MODEST_EASYSETUP_TYPE_COUNTRY_COMBO_BOX, NULL);
 289 }
 290
 291 /**
 292  * Returns the MCC number of the selected country, or 0 if no country was selected.
 293  */
 294 gint
 295 easysetup_country_combo_box_get_active_country_mcc (EasysetupCountryComboBox *self)
 296 {
 297         GtkTreeIter active;
 298         const gboolean found = gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &active);
 299         if (found) {
 300                 ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (self);
 301                 gint mcc = 0;
 302                 gtk_tree_model_get (priv->model, &active, MODEL_COL_MCC, &mcc, -1);
 303                 return mcc;
 304         }
 305         return 0; /* Failed. */
 306 }
 307
 308
 309 /**
 310  * Selects the MCC number of the selected country.
 311  * Specify 0 to select no country.
 312  */
 313 gboolean
 314 easysetup_country_combo_box_set_active_country_mcc (EasysetupCountryComboBox *self, guint mcc)
 315 {
 316         ModestEasysetupCountryComboBoxPrivate *priv = MODEST_EASYSETUP_COUNTRY_COMBO_BOX_GET_PRIVATE (self);
 317         GtkTreeIter iter;
 318
 319         if (!gtk_tree_model_get_iter_first (priv->model, &iter))
 320                 return FALSE;
 321         do {
 322                 gint current_mcc = 0;
 323                 gtk_tree_model_get (priv->model, &iter, MODEL_COL_MCC, &current_mcc, -1);
 324                 if (current_mcc == mcc) {
 325                         gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
 326                         return TRUE;
 327                 }
 328         } while (gtk_tree_model_iter_next (priv->model, &iter));
 329
 330         return FALSE; /* not found */
 331 }
 332