git.maemo.org Git - modest/blob - src/hildon2/modest-serversecurity-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
  31 #include "modest-serversecurity-picker.h"
  32 #include <modest-runtime.h>
  33 #include <modest-account-protocol.h>
  34 #include <gtk/gtkliststore.h>
  35 #include <gtk/gtkcelllayout.h>
  36 #include <gtk/gtkcellrenderertext.h>
  37 #include <glib/gi18n.h>
  38
  39 #include <stdlib.h>
  40 #include <string.h> /* For memcpy() */
  41
  42 /* Include config.h so that _() works: */
  43 #ifdef HAVE_CONFIG_H
  44 #include <config.h>
  45 #endif
  46
  47 G_DEFINE_TYPE (ModestServersecurityPicker, modest_serversecurity_picker, HILDON_TYPE_PICKER_BUTTON);
  48
  49 #define MODEST_SERVERSECURITY_PICKER_GET_PRIVATE(o) \
  50         (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_SERVERSECURITY_PICKER, ModestServersecurityPickerPrivate))
  51
  52 typedef struct _ModestServersecurityPickerPrivate ModestServersecurityPickerPrivate;
  53
  54 struct _ModestServersecurityPickerPrivate
  55 {
  56         GtkTreeModel *model;
  57         ModestProtocolType protocol;
  58 };
  59
  60 static void
  61 modest_serversecurity_picker_finalize (GObject *object)
  62 {
  63         ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (object);
  64
  65         g_object_unref (G_OBJECT (priv->model));
  66
  67         G_OBJECT_CLASS (modest_serversecurity_picker_parent_class)->finalize (object);
  68 }
  69
  70 static void
  71 modest_serversecurity_picker_class_init (ModestServersecurityPickerClass *klass)
  72 {
  73         GObjectClass *object_class = G_OBJECT_CLASS (klass);
  74
  75         g_type_class_add_private (klass, sizeof (ModestServersecurityPickerPrivate));
  76
  77         object_class->finalize = modest_serversecurity_picker_finalize;
  78 }
  79
  80 enum MODEL_COLS {
  81         MODEL_COL_NAME = 0, /* a string */
  82         MODEL_COL_ID = 1 /* an int. */
  83 };
  84
  85 static void
  86 modest_serversecurity_picker_init (ModestServersecurityPicker *self)
  87 {
  88         ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (self);
  89
  90         priv->model = NULL;
  91
  92 }
  93
  94 static gchar *
  95 touch_selector_print_func (HildonTouchSelector *selector)
  96 {
  97         GtkTreeIter iter;
  98         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
  99                 GtkTreeModel *model;
 100                 GValue value = {0,};
 101
 102                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
 103                 gtk_tree_model_get_value (model, &iter, MODEL_COL_NAME, &value);
 104                 return g_value_dup_string (&value);
 105         }
 106         return NULL;
 107 }
 108
 109 ModestServersecurityPicker*
 110 modest_serversecurity_picker_new (HildonSizeType size,
 111                                   HildonButtonArrangement arrangement)
 112 {
 113         ModestServersecurityPicker *self;
 114         ModestServersecurityPickerPrivate *priv;
 115         GtkCellRenderer *renderer;
 116         GtkWidget *selector;
 117
 118         self = g_object_new (MODEST_TYPE_SERVERSECURITY_PICKER,
 119                              "arrangement", arrangement,
 120                              "size", size,
 121                              NULL);
 122         priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (self);
 123
 124         /* Create a tree model,
 125          * with a string for the name, and an ID for the servertype.
 126          * This must match our MODEL_COLS enum constants.
 127          */
 128         priv->model = GTK_TREE_MODEL (gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT));
 129         renderer = gtk_cell_renderer_text_new ();
 130         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 131
 132         selector = hildon_touch_selector_new ();
 133         hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
 134                                              renderer, "text", MODEL_COL_NAME, NULL);
 135
 136         hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
 137         hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector), touch_selector_print_func);
 138
 139         hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
 140
 141         return self;
 142 }
 143
 144 /* Fill the picker box with appropriate choices.
 145  * #picker: The picker box.
 146  * @protocol: IMAP or POP.
 147  */
 148 void modest_serversecurity_picker_fill (ModestServersecurityPicker *picker, ModestProtocolType protocol_type)
 149 {
 150         ModestServersecurityPickerPrivate *priv;
 151         ModestProtocol *protocol;
 152
 153         priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
 154         priv->protocol = protocol_type; /* Remembered for later. */
 155         protocol = modest_protocol_registry_get_protocol_by_type (modest_runtime_get_protocol_registry (),
 156                                                                   protocol_type);
 157
 158         /* Remove any existing rows: */
 159         GtkListStore *liststore = GTK_LIST_STORE (priv->model);
 160         gtk_list_store_clear (liststore);
 161
 162         GtkTreeIter iter;
 163         gtk_list_store_append (liststore, &iter);
 164         /* TODO: This logical ID is not in the .po file: */
 165         gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint) MODEST_PROTOCOLS_CONNECTION_NONE, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_none"), -1);
 166
 167         gtk_list_store_append (liststore, &iter);
 168         gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOLS_CONNECTION_TLS, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_normal"), -1);
 169
 170         /* Add security choices with protocol-specific names, as in the UI spec:
 171          * (Note: Changing the title seems pointless. murrayc) */
 172         gchar *protocol_name = modest_protocol_get_translation (protocol, MODEST_PROTOCOL_TRANSLATION_SSL_PROTO_NAME);
 173         if (protocol_name) {
 174                 gtk_list_store_append (liststore, &iter);
 175                 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOLS_CONNECTION_SSL, MODEL_COL_NAME, protocol_name, -1);
 176                 g_free (protocol_name);
 177         } else {
 178                 /* generic fallback */
 179                 gtk_list_store_append (liststore, &iter);
 180                 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOLS_CONNECTION_SSL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_ssl"), -1);
 181         }
 182 }
 183
 184 static gint get_port_for_security (ModestProtocolType protocol_type, ModestProtocolType security_type)
 185 {
 186         /* See the UI spec, section Email Wizards, Incoming Details [MSG-WIZ001]: */
 187         gint result = 0;
 188         ModestProtocol *protocol, *security;
 189         ModestProtocolRegistry *protocol_registry;
 190         gboolean use_alternate_port;
 191
 192         protocol_registry = modest_runtime_get_protocol_registry ();
 193         protocol = modest_protocol_registry_get_protocol_by_type (protocol_registry, protocol_type);
 194         security = modest_protocol_registry_get_protocol_by_type (protocol_registry, security_type);
 195
 196         g_return_val_if_fail ((security != NULL && protocol != NULL), 0);
 197
 198         use_alternate_port = modest_protocol_registry_protocol_type_has_tag (protocol_registry, security_type,
 199                                                                              MODEST_PROTOCOL_REGISTRY_USE_ALTERNATE_PORT);
 200
 201         /* Get the default port number for this protocol with this security: */
 202         if (use_alternate_port) {
 203                 result = modest_account_protocol_get_alternate_port (MODEST_ACCOUNT_PROTOCOL (protocol));
 204         } else {
 205                 result = modest_account_protocol_get_port (MODEST_ACCOUNT_PROTOCOL (protocol));
 206         }
 207
 208         return result;
 209 }
 210
 211 /**
 212  * Returns the selected serversecurity,
 213  * or MODEST_PROTOCOLS_CONNECTION_NONE if no serversecurity was selected.
 214  */
 215 ModestProtocolType
 216 modest_serversecurity_picker_get_active_serversecurity (ModestServersecurityPicker *picker)
 217 {
 218         GtkTreeIter active;
 219         gboolean found;
 220         GtkWidget *selector;
 221
 222         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker)));
 223
 224         found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
 225         if (found) {
 226                 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
 227
 228                 ModestProtocolType serversecurity = MODEST_PROTOCOLS_CONNECTION_NONE;
 229                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &serversecurity, -1);
 230                 return serversecurity;
 231         }
 232
 233         return MODEST_PROTOCOLS_CONNECTION_NONE; /* Failed. */
 234 }
 235
 236 /**
 237  * Returns the default port to be used for the selected serversecurity,
 238  * or 0 if no serversecurity was selected.
 239  */
 240 gint
 241 modest_serversecurity_picker_get_active_serversecurity_port (ModestServersecurityPicker *picker)
 242 {
 243         ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
 244
 245         ModestProtocolType security = modest_serversecurity_picker_get_active_serversecurity
 246                 (picker);
 247         return get_port_for_security (priv->protocol, security);
 248 }
 249
 250 /* This allows us to pass more than one piece of data to the signal handler,
 251  * and get a result: */
 252 typedef struct
 253 {
 254                 ModestServersecurityPicker* self;
 255                 ModestProtocolType id;
 256                 gboolean found;
 257 } ForEachData;
 258
 259 static gboolean
 260 on_model_foreach_select_id(GtkTreeModel *model,
 261         GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
 262 {
 263         ForEachData *state = (ForEachData*)(user_data);
 264
 265         /* Select the item if it has the matching ID: */
 266         ModestProtocolType id = MODEST_PROTOCOL_REGISTRY_TYPE_INVALID;
 267         gtk_tree_model_get (model, iter, MODEL_COL_ID, &id, -1);
 268         if(id == state->id) {
 269                 GtkWidget *selector;
 270                 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (state->self)));
 271                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, iter, TRUE);
 272                 hildon_button_set_value (HILDON_BUTTON (state->self),
 273                                          hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
 274
 275                 state->found = TRUE;
 276                 return TRUE; /* Stop walking the tree. */
 277         }
 278
 279         return FALSE; /* Keep walking the tree. */
 280 }
 281
 282 /**
 283  * Selects the specified serversecurity,
 284  * or MODEST_PROTOCOLS_CONNECTION_NONE if no serversecurity was selected.
 285  */
 286 gboolean
 287 modest_serversecurity_picker_set_active_serversecurity (ModestServersecurityPicker *picker,
 288                                                         ModestProtocolType serversecurity)
 289 {
 290         ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
 291
 292         /* Create a state instance so we can send two items of data to the signal handler: */
 293         ForEachData *state = g_new0 (ForEachData, 1);
 294         state->self = picker;
 295         state->id = serversecurity;
 296         state->found = FALSE;
 297
 298         /* Look at each item, and select the one with the correct ID: */
 299         gtk_tree_model_foreach (priv->model, &on_model_foreach_select_id, state);
 300
 301         const gboolean result = state->found;
 302
 303         /* Free the state instance: */
 304         g_free(state);
 305
 306         return result;
 307 }
 308