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.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         GHashTable *enabled_plugin_ids;
  60 };
  61 static void
  62 modest_provider_picker_finalize (GObject *object)
  63 {
  64         ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (object);
  65
  66         g_hash_table_destroy (priv->enabled_plugin_ids);
  67
  68         g_object_unref (G_OBJECT (priv->model));
  69
  70         G_OBJECT_CLASS (modest_provider_picker_parent_class)->finalize (object);
  71 }
  72
  73 static void
  74 modest_provider_picker_class_init (ModestProviderPickerClass *klass)
  75 {
  76         GObjectClass *object_class = G_OBJECT_CLASS (klass);
  77
  78         g_type_class_add_private (klass, sizeof (ModestProviderPickerPrivate));
  79
  80         object_class->finalize = modest_provider_picker_finalize;
  81 }
  82
  83 enum MODEL_COLS {
  84         MODEL_COL_ID, /* a string, not an int. */
  85         MODEL_COL_NAME,
  86         MODEL_COL_ID_TYPE
  87 };
  88
  89 static gint
  90 id_type_index (ModestProviderPickerIdType id_type)
  91 {
  92         switch (id_type) {
  93         case MODEST_PROVIDER_PICKER_ID_OTHER:
  94                 return 2;
  95                 break;
  96         case MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL:
  97                 return 1;
  98                 break;
  99         case MODEST_PROVIDER_PICKER_ID_PROVIDER:
 100         default:
 101                 return 0;
 102         }
 103 }
 104
 105 /*
 106  * strictly, we should sort providers with mcc=0 after the other ones.... but, we don't have
 107  * that info here, so ignoring for now.
 108  */
 109 static gint
 110 provider_sort_func (GtkTreeModel *model, GtkTreeIter *iter1, GtkTreeIter *iter2, gpointer user_data)
 111 {
 112         gchar *prov1, *prov2;
 113         ModestProviderPickerIdType id_type1, id_type2;
 114         gint retval;
 115
 116         gtk_tree_model_get (model, iter1,
 117                             MODEL_COL_NAME, &prov1,
 118                             MODEL_COL_ID_TYPE, &id_type1,
 119                             -1);
 120         gtk_tree_model_get (model, iter2,
 121                             MODEL_COL_NAME, &prov2,
 122                             MODEL_COL_ID_TYPE, &id_type2,
 123                             -1);
 124
 125         retval = id_type_index (id_type2) - id_type_index (id_type1);
 126         if (retval != 0)
 127                 goto end;
 128
 129         if (strcmp (prov1, prov2) == 0)
 130                 retval = 0;
 131         else if (strcmp (_("mcen_va_serviceprovider_other"), prov1) == 0)
 132                 retval = -1;
 133         else if (strcmp (_("mcen_va_serviceprovider_other"), prov2) == 0)
 134                 retval = 1;
 135         else
 136                 retval = modest_text_utils_utf8_strcmp (prov1, prov2, TRUE);
 137 end:
 138         g_free (prov1);
 139         g_free (prov2);
 140
 141         return retval;
 142 }
 143
 144 static gchar *
 145 touch_selector_print_func (HildonTouchSelector *selector, gpointer userdata)
 146 {
 147         GtkTreeIter iter;
 148         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
 149                 GtkTreeModel *model;
 150                 GValue value = {0,};
 151
 152                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
 153                 gtk_tree_model_get_value (model, &iter, MODEL_COL_NAME, &value);
 154                 return g_value_dup_string (&value);
 155         }
 156         return NULL;
 157 }
 158
 159
 160 static void
 161 modest_provider_picker_init (ModestProviderPicker *self)
 162 {
 163         ModestProviderPickerPrivate *priv;
 164
 165         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 166         priv->model = NULL;
 167         priv->enabled_plugin_ids = g_hash_table_new_full (g_str_hash, g_str_equal,
 168                                                           g_free, NULL);
 169 }
 170
 171 ModestProviderPicker*
 172 modest_provider_picker_new (HildonSizeType size,
 173                             HildonButtonArrangement arrangement)
 174 {
 175         ModestProviderPickerPrivate *priv;
 176         ModestProviderPicker *self;
 177         GtkCellRenderer *renderer;
 178         GtkWidget *selector;
 179         HildonTouchSelectorColumn *column;
 180
 181         self = g_object_new (MODEST_TYPE_PROVIDER_PICKER,
 182                              "arrangement", arrangement,
 183                              "size", size,
 184                              NULL);
 185         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 186
 187         /* Create the tree model for the selector,
 188          * with a string for the name, and a string for the ID (e.g. "vodafone.it"), and the mcc
 189          * This must match our MODEL_COLS enum constants.
 190          */
 191         priv->model = GTK_TREE_MODEL (gtk_list_store_new (3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_INT));
 192         gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(priv->model),
 193                                               MODEL_COL_NAME, GTK_SORT_ASCENDING);
 194         gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE(priv->model),
 195                                           MODEL_COL_NAME,
 196                                           (GtkTreeIterCompareFunc)provider_sort_func,
 197                                           NULL, NULL);
 198
 199         renderer = gtk_cell_renderer_text_new ();
 200         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 201
 202         selector = hildon_touch_selector_new ();
 203         hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector),
 204                                               (HildonTouchSelectorPrintFunc) touch_selector_print_func);
 205         hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
 206         column = hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
 207                                                       renderer, "text", MODEL_COL_NAME, NULL);
 208         hildon_touch_selector_column_set_text_column (column, MODEL_COL_NAME);
 209
 210
 211         hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
 212         modest_provider_picker_set_others_provider (MODEST_PROVIDER_PICKER (self));
 213
 214         /* For theming purpouses. Widget name must end in Button-finger */
 215         gtk_widget_set_name ((GtkWidget *) self, "ModestProviderPickerButton-finger");
 216
 217         return self;
 218 }
 219
 220 void
 221 modest_provider_picker_fill (ModestProviderPicker *self,
 222                              ModestPresets *presets,
 223                              gint mcc)
 224 {
 225         GtkTreeIter other_iter;
 226         ModestProviderPickerPrivate *priv;
 227         GtkListStore *liststore;
 228         GSList *provider_ids_used_already = NULL, *provider_protos, *tmp;
 229         gchar ** provider_ids = NULL;
 230         gchar ** provider_names;
 231         gchar ** iter_provider_names;
 232         gchar ** iter_provider_ids;
 233         ModestProtocolRegistry *registry;
 234         GtkWidget *selector;
 235
 236         g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
 237
 238         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 239         liststore = GTK_LIST_STORE (priv->model);
 240         gtk_list_store_clear (liststore);
 241         provider_names = modest_presets_get_providers (presets, mcc, TRUE, &provider_ids);
 242
 243         iter_provider_names = provider_names;
 244         iter_provider_ids = provider_ids;
 245
 246         g_hash_table_remove_all (priv->enabled_plugin_ids);
 247
 248         while(iter_provider_names && *iter_provider_names && iter_provider_ids && *iter_provider_ids) {
 249                 const gchar* provider_name = *iter_provider_names;
 250                 const gchar* provider_id = *iter_provider_ids;
 251
 252                 /* Prevent duplicate providers: */
 253                 if (g_slist_find_custom (provider_ids_used_already,
 254                                          provider_id, (GCompareFunc)strcmp) == NULL) {
 255                         /* printf("debug: provider_name=%s\n", provider_name); */
 256
 257                         /* Add the row: */
 258                         GtkTreeIter iter;
 259                         gtk_list_store_append (liststore, &iter);
 260
 261                         gtk_list_store_set(liststore, &iter,
 262                                            MODEL_COL_ID, provider_id,
 263                                            MODEL_COL_NAME, provider_name,
 264                                            MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PROVIDER,
 265                                            -1);
 266
 267                         provider_ids_used_already = g_slist_prepend (
 268                                 provider_ids_used_already, (gpointer)g_strdup (provider_id));
 269                 }
 270
 271                 ++iter_provider_names;
 272                 ++iter_provider_ids;
 273         }
 274
 275         /* Free the result of modest_presets_get_providers()
 276          * as specified by its documentation: */
 277         g_strfreev (provider_names);
 278         g_strfreev (provider_ids);
 279
 280         /* Add the provider protocols */
 281         registry = modest_runtime_get_protocol_registry ();
 282         provider_protos = modest_protocol_registry_get_by_tag (registry,
 283                                                                MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS);
 284         for (tmp = provider_protos; tmp != NULL; tmp = g_slist_next (tmp)) {
 285
 286                 GtkTreeIter iter;
 287                 ModestProtocol *proto = MODEST_PROTOCOL (tmp->data);
 288                 const gchar *name = modest_protocol_get_display_name (proto);
 289
 290                 /* only add store protocols, no need to duplicate them */
 291                 if (!modest_protocol_registry_protocol_type_has_tag (registry,
 292                                                                      modest_protocol_get_type_id (proto),
 293                                                                      MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS))
 294                         continue;
 295
 296                 if (modest_protocol_registry_protocol_type_has_tag
 297                     (registry,
 298                      modest_protocol_get_type_id (proto),
 299                      MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)) {
 300                         /* Check if there's already an account configured with this account type */
 301                         if (modest_account_mgr_singleton_protocol_exists (modest_runtime_get_account_mgr (),
 302                                                                           modest_protocol_get_type_id (proto)))
 303                                 continue;
 304                 }
 305
 306                 if (MODEST_ACCOUNT_PROTOCOL (proto) &&
 307                     !modest_account_protocol_is_supported (MODEST_ACCOUNT_PROTOCOL (proto))) {
 308                         continue;
 309                 }
 310
 311                 gtk_list_store_append (liststore, &iter);
 312                 gtk_list_store_set (liststore, &iter,
 313                                     MODEL_COL_ID, modest_protocol_get_name (proto),
 314                                     MODEL_COL_NAME, name,
 315                                     MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL,
 316                                     -1);
 317                 g_hash_table_insert (priv->enabled_plugin_ids, g_strdup (modest_protocol_get_name (proto)), NULL);
 318         }
 319         g_slist_free (provider_protos);
 320
 321         g_slist_foreach (provider_ids_used_already, (GFunc)g_free, NULL);
 322         g_slist_free (provider_ids_used_already);
 323
 324         /* Add the "Other" item: */
 325         /* Note that ID 0 means "Other" for us: */
 326         gtk_list_store_prepend (liststore, &other_iter);
 327         gtk_list_store_set (liststore, &other_iter,
 328                             MODEL_COL_ID, 0,
 329                             MODEL_COL_NAME, _("mcen_va_serviceprovider_other"),
 330                             MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_OTHER,
 331                             -1);
 332
 333         /* Select the "Other" item: */
 334         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 335         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &other_iter, TRUE);
 336         hildon_button_set_value (HILDON_BUTTON (self),
 337                                  hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
 338
 339 }
 340
 341 void
 342 modest_provider_picker_refresh (ModestProviderPicker *self)
 343 {
 344         ModestProviderPickerPrivate *priv;
 345         GtkListStore *liststore;
 346         GSList *provider_ids_used_already = NULL, *provider_protos, *tmp;
 347         ModestProtocolRegistry *registry;
 348
 349         g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
 350
 351         priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 352         liststore = GTK_LIST_STORE (priv->model);
 353         /* Add the provider protocols */
 354         registry = modest_runtime_get_protocol_registry ();
 355         provider_protos = modest_protocol_registry_get_by_tag (registry,
 356                                                                MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS);
 357         for (tmp = provider_protos; tmp != NULL; tmp = g_slist_next (tmp)) {
 358
 359                 GtkTreeIter iter;
 360                 ModestProtocol *proto = MODEST_PROTOCOL (tmp->data);
 361                 const gchar *name = modest_protocol_get_display_name (proto);
 362                 gboolean provider_exists;
 363
 364                 /* only add store protocols, no need to duplicate them */
 365                 if (!modest_protocol_registry_protocol_type_has_tag (registry,
 366                                                                      modest_protocol_get_type_id (proto),
 367                                                                      MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS))
 368                         continue;
 369
 370                 if (modest_protocol_registry_protocol_type_has_tag
 371                     (registry,
 372                      modest_protocol_get_type_id (proto),
 373                      MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)) {
 374                         /* Check if there's already an account configured with this account type */
 375                         if (modest_account_mgr_singleton_protocol_exists (modest_runtime_get_account_mgr (),
 376                                                                           modest_protocol_get_type_id (proto)))
 377                                 continue;
 378                 }
 379
 380                 provider_exists = g_hash_table_lookup_extended (priv->enabled_plugin_ids, modest_protocol_get_name (proto),
 381                                                                 NULL, NULL);
 382
 383                 if (MODEST_ACCOUNT_PROTOCOL (proto) &&
 384                     !modest_account_protocol_is_supported (MODEST_ACCOUNT_PROTOCOL (proto))) {
 385
 386                         if (provider_exists) {
 387                                 GtkTreeIter iter;
 388
 389                                 if (!gtk_tree_model_get_iter_first (priv->model, &iter))
 390                                         continue;
 391
 392                                 do {
 393                                         const gchar *id;
 394                                         gtk_tree_model_get (priv->model, &iter,
 395                                                             MODEL_COL_ID, id,
 396                                                             -1);
 397
 398                                         if (g_strcmp0 (id, modest_protocol_get_name (proto)) == 0) {
 399                                                 gtk_list_store_remove (GTK_LIST_STORE (priv->model), &iter);
 400                                                 break;
 401                                         }
 402
 403                                 } while (gtk_tree_model_iter_next (priv->model, &iter));
 404                         }
 405
 406                         continue;
 407                 }
 408
 409                 if (!provider_exists) {
 410                         gtk_list_store_append (liststore, &iter);
 411                         gtk_list_store_set (liststore, &iter,
 412                                             MODEL_COL_ID, modest_protocol_get_name (proto),
 413                                             MODEL_COL_NAME, name,
 414                                             MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL,
 415                                             -1);
 416                 }
 417         }
 418         g_slist_free (provider_protos);
 419
 420         g_slist_foreach (provider_ids_used_already, (GFunc)g_free, NULL);
 421         g_slist_free (provider_ids_used_already);
 422
 423 }
 424
 425 /**
 426  * Returns the MCC number of the selected provider,
 427  * or NULL if no provider was selected, or "Other" was selected.
 428  */
 429 gchar*
 430 modest_provider_picker_get_active_provider_id (ModestProviderPicker *self)
 431 {
 432         GtkTreeIter active;
 433         gboolean found;
 434         GtkWidget *selector;
 435
 436         g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER(self), NULL);
 437
 438         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 439         found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
 440         if (found) {
 441                 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 442
 443                 gchar *id = NULL;
 444                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &id, -1);
 445                 return g_strdup(id);
 446         }
 447
 448         return NULL; /* Failed. */
 449 }
 450
 451 void
 452 modest_provider_picker_set_others_provider (ModestProviderPicker *self)
 453 {
 454         GtkTreeModel *model;
 455         GtkTreeIter others_iter;
 456         GtkWidget *selector;
 457
 458         g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
 459
 460         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
 461         model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
 462
 463         if (gtk_tree_model_get_iter_first (model, &others_iter)) {
 464                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &others_iter, TRUE);
 465                 hildon_button_set_value (HILDON_BUTTON (self),
 466                                          hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
 467         }
 468 }
 469
 470 ModestProviderPickerIdType
 471 modest_provider_picker_get_active_id_type (ModestProviderPicker *self)
 472 {
 473         GtkTreeIter active;
 474         GtkWidget *selector;
 475
 476         g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER (self),
 477                               MODEST_PROVIDER_PICKER_ID_OTHER);
 478
 479         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON(self)));
 480
 481         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active)) {
 482                 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
 483                 ModestProviderPickerIdType id_type;
 484
 485                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID_TYPE, &id_type, -1);
 486                 return id_type;
 487         } else {
 488                 /* Fallback to other */
 489                 return MODEST_PROVIDER_PICKER_ID_OTHER;
 490         }
 491 }