1 /* Copyright (c) 2006, 2008 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
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>
42 #include <string.h> /* For memcpy() */
44 /* Include config.h so that _() works: */
49 G_DEFINE_TYPE (ModestProviderPicker, modest_provider_picker, HILDON_TYPE_PICKER_BUTTON);
51 #define MODEST_PROVIDER_PICKER_GET_PRIVATE(o) \
52 (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_PROVIDER_PICKER, ModestProviderPickerPrivate))
54 typedef struct _ModestProviderPickerPrivate ModestProviderPickerPrivate;
56 struct _ModestProviderPickerPrivate
59 GHashTable *enabled_plugin_ids;
62 modest_provider_picker_finalize (GObject *object)
64 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (object);
66 g_hash_table_destroy (priv->enabled_plugin_ids);
68 g_object_unref (G_OBJECT (priv->model));
70 G_OBJECT_CLASS (modest_provider_picker_parent_class)->finalize (object);
74 modest_provider_picker_class_init (ModestProviderPickerClass *klass)
76 GObjectClass *object_class = G_OBJECT_CLASS (klass);
78 g_type_class_add_private (klass, sizeof (ModestProviderPickerPrivate));
80 object_class->finalize = modest_provider_picker_finalize;
84 MODEL_COL_ID, /* a string, not an int. */
90 id_type_index (ModestProviderPickerIdType id_type)
93 case MODEST_PROVIDER_PICKER_ID_OTHER:
96 case MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL:
99 case MODEST_PROVIDER_PICKER_ID_PROVIDER:
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.
110 provider_sort_func (GtkTreeModel *model, GtkTreeIter *iter1, GtkTreeIter *iter2, gpointer user_data)
112 gchar *prov1, *prov2;
113 ModestProviderPickerIdType id_type1, id_type2;
116 gtk_tree_model_get (model, iter1,
117 MODEL_COL_NAME, &prov1,
118 MODEL_COL_ID_TYPE, &id_type1,
120 gtk_tree_model_get (model, iter2,
121 MODEL_COL_NAME, &prov2,
122 MODEL_COL_ID_TYPE, &id_type2,
125 retval = id_type_index (id_type2) - id_type_index (id_type1);
129 if (strcmp (prov1, prov2) == 0)
131 else if (strcmp (_("mcen_va_serviceprovider_other"), prov1) == 0)
133 else if (strcmp (_("mcen_va_serviceprovider_other"), prov2) == 0)
136 retval = modest_text_utils_utf8_strcmp (prov1, prov2, TRUE);
145 touch_selector_print_func (HildonTouchSelector *selector, gpointer userdata)
148 if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
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);
161 modest_provider_picker_init (ModestProviderPicker *self)
163 ModestProviderPickerPrivate *priv;
165 priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
167 priv->enabled_plugin_ids = g_hash_table_new_full (g_str_hash, g_str_equal,
171 ModestProviderPicker*
172 modest_provider_picker_new (HildonSizeType size,
173 HildonButtonArrangement arrangement)
175 ModestProviderPickerPrivate *priv;
176 ModestProviderPicker *self;
177 GtkCellRenderer *renderer;
179 HildonTouchSelectorColumn *column;
181 self = g_object_new (MODEST_TYPE_PROVIDER_PICKER,
182 "arrangement", arrangement,
185 priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
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.
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),
196 (GtkTreeIterCompareFunc)provider_sort_func,
199 renderer = gtk_cell_renderer_text_new ();
200 g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
202 selector = hildon_touch_selector_entry_new ();
203 hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector),
204 (HildonTouchSelectorPrintFunc) touch_selector_print_func);
205 column = hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
206 renderer, "text", MODEL_COL_NAME, NULL);
207 hildon_touch_selector_entry_set_text_column (HILDON_TOUCH_SELECTOR_ENTRY (selector),
210 /* Set this _after_ loading from file, it makes loading faster */
211 hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
212 hildon_touch_selector_entry_set_input_mode (HILDON_TOUCH_SELECTOR_ENTRY (selector),
213 HILDON_GTK_INPUT_MODE_ALPHA |
214 HILDON_GTK_INPUT_MODE_SPECIAL |
215 HILDON_GTK_INPUT_MODE_NUMERIC |
216 HILDON_GTK_INPUT_MODE_AUTOCAP);
219 hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
220 modest_provider_picker_set_others_provider (MODEST_PROVIDER_PICKER (self));
222 /* For theming purpouses. Widget name must end in Button-finger */
223 gtk_widget_set_name ((GtkWidget *) self, "ModestProviderPickerButton-finger");
229 modest_provider_picker_fill (ModestProviderPicker *self,
230 ModestPresets *presets,
233 GtkTreeIter other_iter;
234 ModestProviderPickerPrivate *priv;
235 GtkListStore *liststore;
236 GSList *provider_ids_used_already = NULL, *provider_protos, *tmp;
237 gchar ** provider_ids = NULL;
238 gchar ** provider_names;
239 gchar ** iter_provider_names;
240 gchar ** iter_provider_ids;
241 ModestProtocolRegistry *registry;
244 g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
246 priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
247 liststore = GTK_LIST_STORE (priv->model);
248 gtk_list_store_clear (liststore);
249 provider_names = modest_presets_get_providers (presets, mcc, TRUE, &provider_ids);
251 iter_provider_names = provider_names;
252 iter_provider_ids = provider_ids;
254 g_hash_table_remove_all (priv->enabled_plugin_ids);
256 while(iter_provider_names && *iter_provider_names && iter_provider_ids && *iter_provider_ids) {
257 const gchar* provider_name = *iter_provider_names;
258 const gchar* provider_id = *iter_provider_ids;
260 /* Prevent duplicate providers: */
261 if (g_slist_find_custom (provider_ids_used_already,
262 provider_id, (GCompareFunc)strcmp) == NULL) {
263 /* printf("debug: provider_name=%s\n", provider_name); */
267 gtk_list_store_append (liststore, &iter);
269 gtk_list_store_set(liststore, &iter,
270 MODEL_COL_ID, provider_id,
271 MODEL_COL_NAME, provider_name,
272 MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PROVIDER,
275 provider_ids_used_already = g_slist_prepend (
276 provider_ids_used_already, (gpointer)g_strdup (provider_id));
279 ++iter_provider_names;
283 /* Free the result of modest_presets_get_providers()
284 * as specified by its documentation: */
285 g_strfreev (provider_names);
286 g_strfreev (provider_ids);
288 /* Add the provider protocols */
289 registry = modest_runtime_get_protocol_registry ();
290 provider_protos = modest_protocol_registry_get_by_tag (registry,
291 MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS);
292 for (tmp = provider_protos; tmp != NULL; tmp = g_slist_next (tmp)) {
295 ModestProtocol *proto = MODEST_PROTOCOL (tmp->data);
296 const gchar *name = modest_protocol_get_display_name (proto);
298 /* only add store protocols, no need to duplicate them */
299 if (!modest_protocol_registry_protocol_type_has_tag (registry,
300 modest_protocol_get_type_id (proto),
301 MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS))
304 if (modest_protocol_registry_protocol_type_has_tag
306 modest_protocol_get_type_id (proto),
307 MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)) {
308 /* Check if there's already an account configured with this account type */
309 if (modest_account_mgr_singleton_protocol_exists (modest_runtime_get_account_mgr (),
310 modest_protocol_get_type_id (proto)))
314 if (MODEST_ACCOUNT_PROTOCOL (proto) &&
315 !modest_account_protocol_is_supported (MODEST_ACCOUNT_PROTOCOL (proto))) {
319 gtk_list_store_append (liststore, &iter);
320 gtk_list_store_set (liststore, &iter,
321 MODEL_COL_ID, modest_protocol_get_name (proto),
322 MODEL_COL_NAME, name,
323 MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL,
325 g_hash_table_insert (priv->enabled_plugin_ids, g_strdup (modest_protocol_get_name (proto)), NULL);
327 g_slist_free (provider_protos);
329 g_slist_foreach (provider_ids_used_already, (GFunc)g_free, NULL);
330 g_slist_free (provider_ids_used_already);
332 /* Add the "Other" item: */
333 /* Note that ID 0 means "Other" for us: */
334 gtk_list_store_prepend (liststore, &other_iter);
335 gtk_list_store_set (liststore, &other_iter,
337 MODEL_COL_NAME, _("mcen_va_serviceprovider_other"),
338 MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_OTHER,
341 /* Select the "Other" item: */
342 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
343 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &other_iter, TRUE);
344 hildon_button_set_value (HILDON_BUTTON (self),
345 hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
350 modest_provider_picker_refresh (ModestProviderPicker *self)
352 ModestProviderPickerPrivate *priv;
353 GtkListStore *liststore;
354 GSList *provider_ids_used_already = NULL, *provider_protos, *tmp;
355 ModestProtocolRegistry *registry;
357 g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
359 priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
360 liststore = GTK_LIST_STORE (priv->model);
361 /* Add the provider protocols */
362 registry = modest_runtime_get_protocol_registry ();
363 provider_protos = modest_protocol_registry_get_by_tag (registry,
364 MODEST_PROTOCOL_REGISTRY_PROVIDER_PROTOCOLS);
365 for (tmp = provider_protos; tmp != NULL; tmp = g_slist_next (tmp)) {
368 ModestProtocol *proto = MODEST_PROTOCOL (tmp->data);
369 const gchar *name = modest_protocol_get_display_name (proto);
370 gboolean provider_exists;
372 /* only add store protocols, no need to duplicate them */
373 if (!modest_protocol_registry_protocol_type_has_tag (registry,
374 modest_protocol_get_type_id (proto),
375 MODEST_PROTOCOL_REGISTRY_STORE_PROTOCOLS))
378 if (modest_protocol_registry_protocol_type_has_tag
380 modest_protocol_get_type_id (proto),
381 MODEST_PROTOCOL_REGISTRY_SINGLETON_PROVIDER_PROTOCOLS)) {
382 /* Check if there's already an account configured with this account type */
383 if (modest_account_mgr_singleton_protocol_exists (modest_runtime_get_account_mgr (),
384 modest_protocol_get_type_id (proto)))
388 provider_exists = g_hash_table_lookup_extended (priv->enabled_plugin_ids, modest_protocol_get_name (proto),
391 if (MODEST_ACCOUNT_PROTOCOL (proto) &&
392 !modest_account_protocol_is_supported (MODEST_ACCOUNT_PROTOCOL (proto))) {
394 if (provider_exists) {
397 if (!gtk_tree_model_get_iter_first (priv->model, &iter))
402 gtk_tree_model_get (priv->model, &iter,
406 if (g_strcmp0 (id, modest_protocol_get_name (proto)) == 0) {
407 gtk_list_store_remove (GTK_LIST_STORE (priv->model), &iter);
411 } while (gtk_tree_model_iter_next (priv->model, &iter));
417 if (!provider_exists) {
418 gtk_list_store_append (liststore, &iter);
419 gtk_list_store_set (liststore, &iter,
420 MODEL_COL_ID, modest_protocol_get_name (proto),
421 MODEL_COL_NAME, name,
422 MODEL_COL_ID_TYPE, MODEST_PROVIDER_PICKER_ID_PLUGIN_PROTOCOL,
426 g_slist_free (provider_protos);
428 g_slist_foreach (provider_ids_used_already, (GFunc)g_free, NULL);
429 g_slist_free (provider_ids_used_already);
434 * Returns the MCC number of the selected provider,
435 * or NULL if no provider was selected, or "Other" was selected.
438 modest_provider_picker_get_active_provider_id (ModestProviderPicker *self)
444 g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER(self), NULL);
446 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
447 found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
449 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
452 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &id, -1);
456 return NULL; /* Failed. */
460 modest_provider_picker_set_others_provider (ModestProviderPicker *self)
463 GtkTreeIter others_iter;
466 g_return_if_fail (MODEST_IS_PROVIDER_PICKER(self));
468 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (self)));
469 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
471 if (gtk_tree_model_get_iter_first (model, &others_iter)) {
472 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &others_iter, TRUE);
473 hildon_button_set_value (HILDON_BUTTON (self),
474 hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
478 ModestProviderPickerIdType
479 modest_provider_picker_get_active_id_type (ModestProviderPicker *self)
484 g_return_val_if_fail (MODEST_IS_PROVIDER_PICKER (self),
485 MODEST_PROVIDER_PICKER_ID_OTHER);
487 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON(self)));
489 if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active)) {
490 ModestProviderPickerPrivate *priv = MODEST_PROVIDER_PICKER_GET_PRIVATE (self);
491 ModestProviderPickerIdType id_type;
493 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID_TYPE, &id_type, -1);
496 /* Fallback to other */
497 return MODEST_PROVIDER_PICKER_ID_OTHER;