git.maemo.org Git - modest/blob - src/widgets/modest-serversecurity-combo-box.c

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