git.maemo.org Git - modest/blob - src/hildon2/modest-provider-picker.c

   1 /* Copyright (c) 2006, 2008 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 #include "modest-provider-picker.h"
  31 #include <hildon/hildon-touch-selector-entry.h>
  32 #include <gtk/gtkliststore.h>
  33 #include <gtk/gtkcelllayout.h>
  34 #include <gtk/gtkcellrenderertext.h>
  35 #include <glib/gi18n.h>
  36 #include <modest-text-utils.h>
  37 #include "modest-protocol-registry.h"
  38 #include "modest-runtime.h"
  39 #include <modest-account-protocol.h>
  40
  41 #include <stdlib.h>
  42 #include <string.h> /* For memcpy() */
  43
  44 /* Include config.h so that _() works: */
  45 #ifdef HAVE_CONFIG_H
  46 #include <config.h>
  47 #endif
  48
  49 G_DEFINE_TYPE (ModestProviderPicker, modest_provider_picker, HILDON_TYPE_PICKER_BUTTON);
  50
  51 #define MODEST_PROVIDER_PICKER_GET_PRIVATE(o) \
  52         (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_PROVIDER_PICKER, ModestProviderPickerPrivate))
  53
  54 typedef struct _ModestProviderPickerPrivate ModestProviderPickerPrivate;
  55
  56 struct _ModestProviderPickerPrivate
  57 {
  58         GtkTreeModel *model;
  59 };
  60 static void
  61 modest_provider_picker_finalize (GObject *object)
  62 {
  63         ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (object);
  64
  65         g_object_unref (G_OBJECT (priv->model));
  66
  67         G_OBJECT_CLASS (modest_provider_picker_parent_class)->finalize (object);
  68 }
  69
  70 static void
  71 modest_provider_picker_class_init (ModestProviderPickerClass *klass)
  72 {
  73         GObjectClass *object_class = G_OBJECT_CLASS (klass);
  74
  75         g_type_class_add_private (klass, sizeof (ModestProviderPickerPrivate));
  76
  77         object_class->finalize = modest_provider_picker_finalize;
  78 }
  79
  80 enum MODEL_COLS {
  81         MODEL_COL_ID, /* a string, not an int. */
  82         MODEL_COL_NAME,
  83         MODEL_COL_ID_TYPE
  84 };
  85
  86 static gint
  87 id_type_index (ModestProviderPickerIdType id_type)
  88 {
  89         switch (id_type) {
  90         case MODEST_PROVIDER_PICKER_ID_OTHER:
  91                 return 2;
  92                 break;
  93         case MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL:
  94                 return 1;
  95                 break;
  96         case MODEST_PROVIDER_PICKER_ID_PROVIDER:
  97         default:
  98                 return 0;
  99         }
 100 }
 101
 102 /*
 103  * strictly, we should sort providers with mcc=0 after the other ones.... but, we don't have
 104  * that info here, so ignoring for now.
 105  */
 106 static gint
 107 provider_sort_func (GtkTreeModel *model, GtkTreeIter *iter1, GtkTreeIter *iter2, gpointer user_data)
 108 {
 109         gchar *prov1, *prov2;
 110         ModestProviderPickerIdType id_type1, id_type2;
 111         gint retval;
 112
 113         gtk_tree_model_get (model, iter1,
 114                             MODEL_COL_NAME, &prov1,
 115                             MODEL_COL_ID_TYPE, &id_type1,
 116                             -1);
 117         gtk_tree_model_get (model, iter2,
 118                             MODEL_COL_NAME, &prov2,
 119                             MODEL_COL_ID_TYPE, &id_type2,
 120                             -1);
 121
 122         retval = id_type_index (id_type2) - id_type_index (id_type1);
 123         if (retval != 0)
 124                 goto end;
 125
 126         if (strcmp (prov1, prov2) == 0)
 127                 retval = 0;
 128         else if (strcmp (_("mcen_va_serviceprovider_other"), prov1) == 0)
 129                 retval = -1;
 130         else if (strcmp (_("mcen_va_serviceprovider_other"), prov2) == 0)
 131                 retval = 1;
 132         else
 133                 retval = modest_text_utils_utf8_strcmp (prov1, prov2, TRUE);
 134 end:
 135         g_free (prov1);
 136         g_free (prov2);
 137
 138         return retval;
 139 }
 140
 141 static gchar *
 142 touch_selector_print_func (HildonTouchSelector *selector, gpointer userdata)
 143 {
 144         GtkTreeIter iter;
 145         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
 146                 GtkTreeModel *model;
 147                 GValue value = {0,};
 148
 149                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
 150                 gtk_tree_model_get_value (model, &iter, MODEL_COL_NAME, &value);
 151                 return g_value_dup_string (&value);
 152         }
 153         return NULL;
 154 }
 155
 156
 157 static void
 158 modest_provider_picker_init (ModestProviderPicker *self)
 159 {
 160         ModestProviderPickerPrivate *priv;
 161
 162         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 163         priv->model = NULL;
 164 }
 165
 166 ModestProviderPicker*
 167 modest_provider_picker_new (HildonSizeType size,
 168                             HildonButtonArrangement arrangement)
 169 {
 170         ModestProviderPickerPrivate *priv;
 171         ModestProviderPicker *self;
 172         GtkCellRenderer *renderer;
 173         GtkWidget *selector;
 174         HildonTouchSelectorColumn *column;
 175
 176         self = g_object_new (MODEST_TYPE_PROVIDER_PICKER,
 177                              "arrangement", arrangement,
 178                              "size", size,
 179                              NULL);
 180         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 181
 182         /* Create the tree model for the selector,
 183          * with a string for the name, and a string for the ID (e.g. "vodafone.it"), and the mcc
 184          * This must match our MODEL_COLS enum constants.
 185          */
 186         priv->model = GTK_TREE_MODEL (gtk_list_store_new (3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_INT));
 187         gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(priv->model),
 188                                               MODEL_COL_NAME, GTK_SORT_ASCENDING);
 189         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE(priv->model),
 190                                           MODEL_COL_NAME,
 191                                           (GtkTreeIterCompareFunc)provider_sort_func,
 192                                           NULL, NULL);
 193
 194         renderer = gtk_cell_renderer_text_new ();
 195         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 196
 197         selector = hildon_touch_selector_entry_new ();
 198         hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector),
 199                                               (HildonTouchSelectorPrintFunc) touch_selector_print_func);
 200         column = hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
 201                                                       renderer, "text", MODEL_COL_NAME, NULL);
 202         hildon_touch_selector_entry_set_text_column (HILDON_TOUCH_SELECTOR_ENTRY (selector),
 203                                                      MODEL_COL_NAME);
 204
 205         /* Set this _after_ loading from file, it makes loading faster */
 206         hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
 207         hildon_touch_selector_entry_set_input_mode (HILDON_TOUCH_SELECTOR_ENTRY (selector),
 208                                                     HILDON_GTK_INPUT_MODE_ALPHA |
 209                                                     HILDON_GTK_INPUT_MODE_AUTOCAP);
 210
 211
 212         hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
 213         modest_provider_picker_set_others_provider (MODEST_PROVIDER_PICKER (self));
 214
 215         return self;
 216 }
 217
 218 void
 219 modest_provider_picker_fill (ModestProviderPicker *self,
 220                              ModestPresets *presets,
 221                              gint mcc)
 222 {
 223         GtkTreeIter other_iter;
 224         ModestProviderPickerPrivate *priv;
 225         GtkListStore *liststore;
 226         GSList *provider_ids_used_already = NULL, *provider_protos, *tmp;
 227         gchar ** provider_ids = NULL;
 228         gchar ** provider_names;
 229         gchar ** iter_provider_names;
 230         gchar ** iter_provider_ids;
 231         ModestProtocolRegistry *registry;
 232         GtkWidget *selector;
 233
 234         g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
 235
 236         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 237         liststore = GTK_LIST_STORE (priv->model);
 238         gtk_list_store_clear (liststore);
 239         provider_names = modest_presets_get_providers (presets, mcc, TRUE, &provider_ids);
 240
 241         iter_provider_names = provider_names;
 242         iter_provider_ids = provider_ids;
 243
 244         while(iter_provider_names && *iter_provider_names && iter_provider_ids && *iter_provider_ids) {
 245                 const gchar* provider_name = *iter_provider_names;
 246                 const gchar* provider_id = *iter_provider_ids;
 247
 248                 /* Prevent duplicate providers: */
 249                 if (g_slist_find_custom (provider_ids_used_already,
 250                                          provider_id, (GCompareFunc)strcmp) == NULL) {
 251                         /* printf("debug: provider_name=%s\n", provider_name); */
 252
 253                         /* Add the row: */
 254                         GtkTreeIter iter;
 255                         gtk_list_store_append (liststore, &iter);
 256
 257                         gtk_list_store_set(liststore, &iter,
 258                                            MODEL_COL_ID, provider_id,
 259                                            MODEL_COL_NAME, provider_name,
 260                                            MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PROVIDER,
 261                                            -1);
 262
 263                         provider_ids_used_already = g_slist_prepend (
 264                                 provider_ids_used_already, (gpointer)g_strdup (provider_id));
 265                 }
 266
 267                 ++iter_provider_names;
 268                 ++iter_provider_ids;
 269         }
 270
 271         /* Free the result of modest_presets_get_providers()
 272          * as specified by its documentation: */
 273         g_strfreev (provider_names);
 274         g_strfreev (provider_ids);
 275
 276         /* Add the provider protocols */
 277         registry = modest_runtime_get_protocol_registry ();
 278         provider_protos = modest_protocol_registry_get_by_tag (registry,
 279                                                                MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS);
 280         for (tmp = provider_protos; tmp != NULL; tmp = g_slist_next (tmp)) {
 281
 282                 GtkTreeIter iter;
 283                 ModestProtocol *proto = MODEST_PROTOCOL (tmp->data);
 284                 const gchar *name = modest_protocol_get_display_name (proto);
 285
 286                 /* only add store protocols, no need to duplicate them */
 287                 if (!modest_protocol_registry_protocol_type_has_tag (registry,
 288                                                                      modest_protocol_get_type_id (proto),
 289                                                                      MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS))
 290                         continue;
 291
 292                 if (modest_protocol_registry_protocol_type_has_tag
 293                     (registry,
 294                      modest_protocol_get_type_id (proto),
 295                      MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)) {
 296                         /* Check if there's already an account configured with this account type */
 297                         if (modest_account_mgr_singleton_protocol_exists (modest_runtime_get_account_mgr (),
 298                                                                           modest_protocol_get_type_id (proto)))
 299                                 continue;
 300                 }
 301
 302                 if (MODEST_ACCOUNT_PROTOCOL (proto) &&
 303                     !modest_account_protocol_is_supported (MODEST_ACCOUNT_PROTOCOL (proto))) {
 304                         continue;
 305                 }
 306
 307                 gtk_list_store_append (liststore, &iter);
 308                 gtk_list_store_set (liststore, &iter,
 309                                     MODEL_COL_ID, modest_protocol_get_name (proto),
 310                                     MODEL_COL_NAME, name,
 311                                     MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL,
 312                                     -1);
 313         }
 314         g_slist_free (provider_protos);
 315
 316         g_slist_foreach (provider_ids_used_already, (GFunc)g_free, NULL);
 317         g_slist_free (provider_ids_used_already);
 318
 319         /* Add the "Other" item: */
 320         /* Note that ID 0 means "Other" for us: */
 321         gtk_list_store_prepend (liststore, &other_iter);
 322         gtk_list_store_set (liststore, &other_iter,
 323                             MODEL_COL_ID, 0,
 324                             MODEL_COL_NAME, _("mcen_va_serviceprovider_other"),
 325                             MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_OTHER,
 326                             -1);
 327
 328         /* Select the "Other" item: */
 329         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 330         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &other_iter, TRUE);
 331         hildon_button_set_value (HILDON_BUTTON (self),
 332                                  hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
 333
 334 }
 335
 336 /**
 337  * Returns the MCC number of the selected provider,
 338  * or NULL if no provider was selected, or "Other" was selected.
 339  */
 340 gchar*
 341 modest_provider_picker_get_active_provider_id (ModestProviderPicker *self)
 342 {
 343         GtkTreeIter active;
 344         gboolean found;
 345         GtkWidget *selector;
 346
 347         g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER(self), NULL);
 348
 349         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 350         found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
 351         if (found) {
 352                 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 353
 354                 gchar *id = NULL;
 355                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &id, -1);
 356                 return g_strdup(id);
 357         }
 358
 359         return NULL; /* Failed. */
 360 }
 361
 362 void
 363 modest_provider_picker_set_others_provider (ModestProviderPicker *self)
 364 {
 365         GtkTreeModel *model;
 366         GtkTreeIter others_iter;
 367         GtkWidget *selector;
 368
 369         g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
 370
 371         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 372         model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
 373
 374         if (gtk_tree_model_get_iter_first (model, &others_iter)) {
 375                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &others_iter, TRUE);
 376                 hildon_button_set_value (HILDON_BUTTON (self),
 377                                          hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
 378         }
 379 }
 380
 381 ModestProviderPickerIdType
 382 modest_provider_picker_get_active_id_type (ModestProviderPicker *self)
 383 {
 384         GtkTreeIter active;
 385         GtkWidget *selector;
 386
 387         g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER (self),
 388                               MODEST_PROVIDER_PICKER_ID_OTHER);
 389
 390         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON(self)));
 391
 392         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active)) {
 393                 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 394                 ModestProviderPickerIdType id_type;
 395
 396                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID_TYPE, &id_type, -1);
 397                 return id_type;
 398         } else {
 399                 /* Fallback to other */
 400                 return MODEST_PROVIDER_PICKER_ID_OTHER;
 401         }
 402 }