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