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