1 /* Copyright (c) 2006, 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.
31 #include "modest-serversecurity-combo-box.h"
32 #include <gtk/gtkliststore.h>
33 #include <gtk/gtkcelllayout.h>
34 #include <gtk/gtkcellrenderertext.h>
35 #include <glib/gi18n.h>
38 #include <string.h> /* For memcpy() */
40 /* Include config.h so that _() works: */
45 G_DEFINE_TYPE (ModestServersecurityComboBox, modest_serversecurity_combo_box, GTK_TYPE_COMBO_BOX);
47 #define SERVERSECURITY_COMBO_BOX_GET_PRIVATE(o) \
48 (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_SERVERSECURITY_COMBO_BOX, ModestServersecurityComboBoxPrivate))
50 typedef struct _ModestServersecurityComboBoxPrivate ModestServersecurityComboBoxPrivate;
52 struct _ModestServersecurityComboBoxPrivate
55 ModestConnectionProtocol protocol;
59 modest_serversecurity_combo_box_get_property (GObject *object, guint property_id,
60 GValue *value, GParamSpec *pspec)
62 switch (property_id) {
64 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
69 modest_serversecurity_combo_box_set_property (GObject *object, guint property_id,
70 const GValue *value, GParamSpec *pspec)
72 switch (property_id) {
74 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
79 modest_serversecurity_combo_box_dispose (GObject *object)
81 if (G_OBJECT_CLASS (modest_serversecurity_combo_box_parent_class)->dispose)
82 G_OBJECT_CLASS (modest_serversecurity_combo_box_parent_class)->dispose (object);
86 modest_serversecurity_combo_box_finalize (GObject *object)
88 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (object);
90 g_object_unref (G_OBJECT (priv->model));
92 G_OBJECT_CLASS (modest_serversecurity_combo_box_parent_class)->finalize (object);
96 modest_serversecurity_combo_box_class_init (ModestServersecurityComboBoxClass *klass)
98 GObjectClass *object_class = G_OBJECT_CLASS (klass);
100 g_type_class_add_private (klass, sizeof (ModestServersecurityComboBoxPrivate));
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;
109 MODEL_COL_NAME = 0, /* a string */
110 MODEL_COL_ID = 1 /* an int. */
114 modest_serversecurity_combo_box_init (ModestServersecurityComboBox *self)
116 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (self);
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.
122 priv->model = GTK_TREE_MODEL (gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT));
124 /* Setup the combo box: */
125 GtkComboBox *combobox = GTK_COMBO_BOX (self);
126 gtk_combo_box_set_model (combobox, priv->model);
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);
135 /* The application must call modest_serversecurity_combo_box_fill().
139 ModestServersecurityComboBox*
140 modest_serversecurity_combo_box_new (void)
142 return g_object_new (MODEST_TYPE_SERVERSECURITY_COMBO_BOX, NULL);
145 /* Fill the combo box with appropriate choices.
146 * #combobox: The combo box.
147 * @protocol: IMAP or POP.
149 void modest_serversecurity_combo_box_fill (ModestServersecurityComboBox *combobox, ModestTransportStoreProtocol protocol)
151 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (combobox);
152 priv->protocol = protocol; /* Remembered for later. */
154 /* Remove any existing rows: */
155 GtkListStore *liststore = GTK_LIST_STORE (priv->model);
156 gtk_list_store_clear (liststore);
159 gtk_list_store_append (liststore, &iter);
160 /* TODO: This logical ID is not in the .po file: */
161 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOL_CONNECTION_NORMAL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_none"), -1);
163 /* Select the None item: */
164 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (combobox), &iter);
166 gtk_list_store_append (liststore, &iter);
167 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOL_CONNECTION_TLS, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_normal"), -1);
169 /* Add security choices with protocol-specific names, as in the UI spec:
170 * (Note: Changing the title seems pointless. murrayc) */
171 if(protocol == MODEST_PROTOCOL_STORE_POP) {
172 gtk_list_store_append (liststore, &iter);
173 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOL_CONNECTION_SSL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_securepop3s"), -1);
174 } else if(protocol == MODEST_PROTOCOL_STORE_IMAP) {
175 gtk_list_store_append (liststore, &iter);
176 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOL_CONNECTION_SSL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_secureimap4s"), -1);
177 } else if(protocol == MODEST_PROTOCOL_TRANSPORT_SMTP) {
178 gtk_list_store_append (liststore, &iter);
179 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOL_CONNECTION_SSL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_ssl"), -1);
183 static gint get_port_for_security (ModestTransportStoreProtocol protocol, ModestConnectionProtocol security)
185 /* See the UI spec, section Email Wizards, Incoming Details [MSG-WIZ001]: */
188 /* Get the default port number for this protocol with this security: */
189 if(protocol == MODEST_PROTOCOL_STORE_POP) {
190 if ((security == MODEST_PROTOCOL_CONNECTION_NORMAL) || (security == MODEST_PROTOCOL_CONNECTION_TLS))
192 else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
194 } else if (protocol == MODEST_PROTOCOL_STORE_IMAP) {
195 if ((security == MODEST_PROTOCOL_CONNECTION_NORMAL) || (security == MODEST_PROTOCOL_CONNECTION_TLS))
197 else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
199 } else if (protocol == MODEST_PROTOCOL_TRANSPORT_SMTP) {
200 if ((security == MODEST_PROTOCOL_CONNECTION_NORMAL) || (security == MODEST_PROTOCOL_CONNECTION_TLS))
202 else if (security == MODEST_PROTOCOL_CONNECTION_SSL)
210 * Returns the selected serversecurity,
211 * or MODEST_PROTOCOL_CONNECTION_NORMAL if no serversecurity was selected.
213 ModestConnectionProtocol
214 modest_serversecurity_combo_box_get_active_serversecurity (ModestServersecurityComboBox *combobox)
217 const gboolean found = gtk_combo_box_get_active_iter (GTK_COMBO_BOX (combobox), &active);
219 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (combobox);
221 ModestConnectionProtocol serversecurity = MODEST_PROTOCOL_CONNECTION_NORMAL;
222 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &serversecurity, -1);
223 return serversecurity;
226 return MODEST_PROTOCOL_CONNECTION_NORMAL; /* Failed. */
230 * Returns the default port to be used for the selected serversecurity,
231 * or 0 if no serversecurity was selected.
234 modest_serversecurity_combo_box_get_active_serversecurity_port (ModestServersecurityComboBox *combobox)
236 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (combobox);
238 const ModestConnectionProtocol security = modest_serversecurity_combo_box_get_active_serversecurity
240 return get_port_for_security (priv->protocol, security);
243 /* This allows us to pass more than one piece of data to the signal handler,
244 * and get a result: */
247 ModestServersecurityComboBox* self;
253 on_model_foreach_select_id(GtkTreeModel *model,
254 GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
256 ForEachData *state = (ForEachData*)(user_data);
258 /* Select the item if it has the matching ID: */
260 gtk_tree_model_get (model, iter, MODEL_COL_ID, &id, -1);
261 if(id == state->id) {
262 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (state->self), iter);
265 return TRUE; /* Stop walking the tree. */
268 return FALSE; /* Keep walking the tree. */
272 * Selects the specified serversecurity,
273 * or MODEST_PROTOCOL_CONNECTION_NORMAL if no serversecurity was selected.
276 modest_serversecurity_combo_box_set_active_serversecurity (ModestServersecurityComboBox *combobox,
277 ModestConnectionProtocol serversecurity)
279 ModestServersecurityComboBoxPrivate *priv = SERVERSECURITY_COMBO_BOX_GET_PRIVATE (combobox);
281 /* Create a state instance so we can send two items of data to the signal handler: */
282 ForEachData *state = g_new0 (ForEachData, 1);
283 state->self = combobox;
284 state->id = serversecurity;
285 state->found = FALSE;
287 /* Look at each item, and select the one with the correct ID: */
288 gtk_tree_model_foreach (priv->model, &on_model_foreach_select_id, state);
290 const gboolean result = state->found;
292 /* Free the state instance: */