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.
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>
40 #include <string.h> /* For memcpy() */
42 /* Include config.h so that _() works: */
47 G_DEFINE_TYPE (ModestServersecurityPicker, modest_serversecurity_picker, HILDON_TYPE_PICKER_BUTTON);
49 #define MODEST_SERVERSECURITY_PICKER_GET_PRIVATE(o) \
50 (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_SERVERSECURITY_PICKER, ModestServersecurityPickerPrivate))
52 typedef struct _ModestServersecurityPickerPrivate ModestServersecurityPickerPrivate;
54 struct _ModestServersecurityPickerPrivate
57 ModestProtocolType protocol;
61 modest_serversecurity_picker_finalize (GObject *object)
63 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (object);
65 g_object_unref (G_OBJECT (priv->model));
67 G_OBJECT_CLASS (modest_serversecurity_picker_parent_class)->finalize (object);
71 modest_serversecurity_picker_class_init (ModestServersecurityPickerClass *klass)
73 GObjectClass *object_class = G_OBJECT_CLASS (klass);
75 g_type_class_add_private (klass, sizeof (ModestServersecurityPickerPrivate));
77 object_class->finalize = modest_serversecurity_picker_finalize;
81 MODEL_COL_NAME = 0, /* a string */
82 MODEL_COL_ID = 1 /* an int. */
86 modest_serversecurity_picker_init (ModestServersecurityPicker *self)
88 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (self);
95 touch_selector_print_func (HildonTouchSelector *selector)
98 if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
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);
109 ModestServersecurityPicker*
110 modest_serversecurity_picker_new (void)
112 ModestServersecurityPicker *self;
113 ModestServersecurityPickerPrivate *priv;
114 GtkCellRenderer *renderer;
117 self = g_object_new (MODEST_TYPE_SERVERSECURITY_PICKER,
118 "arrangement", HILDON_BUTTON_ARRANGEMENT_VERTICAL,
119 "size", HILDON_SIZE_AUTO,
121 priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (self);
123 /* Create a tree model,
124 * with a string for the name, and an ID for the servertype.
125 * This must match our MODEL_COLS enum constants.
127 priv->model = GTK_TREE_MODEL (gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT));
128 renderer = gtk_cell_renderer_text_new ();
129 g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
131 selector = hildon_touch_selector_new ();
132 hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
133 renderer, "text", MODEL_COL_NAME, NULL);
135 hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
136 hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector), touch_selector_print_func);
138 hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
143 /* Fill the picker box with appropriate choices.
144 * #picker: The picker box.
145 * @protocol: IMAP or POP.
147 void modest_serversecurity_picker_fill (ModestServersecurityPicker *picker, ModestProtocolType protocol_type)
149 ModestServersecurityPickerPrivate *priv;
150 ModestProtocol *protocol;
152 priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
153 priv->protocol = protocol_type; /* Remembered for later. */
154 protocol = modest_protocol_registry_get_protocol_by_type (modest_runtime_get_protocol_registry (),
157 /* Remove any existing rows: */
158 GtkListStore *liststore = GTK_LIST_STORE (priv->model);
159 gtk_list_store_clear (liststore);
162 gtk_list_store_append (liststore, &iter);
163 /* TODO: This logical ID is not in the .po file: */
164 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 gtk_list_store_append (liststore, &iter);
167 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 /* Add security choices with protocol-specific names, as in the UI spec:
170 * (Note: Changing the title seems pointless. murrayc) */
171 gchar *protocol_name = modest_protocol_get_translation (protocol, MODEST_PROTOCOL_TRANSLATION_SSL_PROTO_NAME);
173 gtk_list_store_append (liststore, &iter);
174 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOLS_CONNECTION_SSL, MODEL_COL_NAME, protocol_name, -1);
175 g_free (protocol_name);
177 /* generic fallback */
178 gtk_list_store_append (liststore, &iter);
179 gtk_list_store_set (liststore, &iter, MODEL_COL_ID, (gint)MODEST_PROTOCOLS_CONNECTION_SSL, MODEL_COL_NAME, _("mcen_fi_advsetup_other_security_ssl"), -1);
183 static gint get_port_for_security (ModestProtocolType protocol_type, ModestProtocolType security_type)
185 /* See the UI spec, section Email Wizards, Incoming Details [MSG-WIZ001]: */
187 ModestProtocol *protocol, *security;
188 ModestProtocolRegistry *protocol_registry;
189 gboolean use_alternate_port;
191 protocol_registry = modest_runtime_get_protocol_registry ();
192 protocol = modest_protocol_registry_get_protocol_by_type (protocol_registry, protocol_type);
193 security = modest_protocol_registry_get_protocol_by_type (protocol_registry, security_type);
195 g_return_val_if_fail ((security != NULL && protocol != NULL), 0);
197 use_alternate_port = modest_protocol_registry_protocol_type_has_tag (protocol_registry, security_type,
198 MODEST_PROTOCOL_REGISTRY_USE_ALTERNATE_PORT);
200 /* Get the default port number for this protocol with this security: */
201 if (use_alternate_port) {
202 result = modest_account_protocol_get_alternate_port (MODEST_ACCOUNT_PROTOCOL (protocol));
204 result = modest_account_protocol_get_port (MODEST_ACCOUNT_PROTOCOL (protocol));
211 * Returns the selected serversecurity,
212 * or MODEST_PROTOCOLS_CONNECTION_NONE if no serversecurity was selected.
215 modest_serversecurity_picker_get_active_serversecurity (ModestServersecurityPicker *picker)
221 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker)));
223 found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
225 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
227 ModestProtocolType serversecurity = MODEST_PROTOCOLS_CONNECTION_NONE;
228 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &serversecurity, -1);
229 return serversecurity;
232 return MODEST_PROTOCOLS_CONNECTION_NONE; /* Failed. */
236 * Returns the default port to be used for the selected serversecurity,
237 * or 0 if no serversecurity was selected.
240 modest_serversecurity_picker_get_active_serversecurity_port (ModestServersecurityPicker *picker)
242 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
244 ModestProtocolType security = modest_serversecurity_picker_get_active_serversecurity
246 return get_port_for_security (priv->protocol, security);
249 /* This allows us to pass more than one piece of data to the signal handler,
250 * and get a result: */
253 ModestServersecurityPicker* self;
254 ModestProtocolType id;
259 on_model_foreach_select_id(GtkTreeModel *model,
260 GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
262 ForEachData *state = (ForEachData*)(user_data);
264 /* Select the item if it has the matching ID: */
265 ModestProtocolType id = MODEST_PROTOCOL_REGISTRY_TYPE_INVALID;
266 gtk_tree_model_get (model, iter, MODEL_COL_ID, &id, -1);
267 if(id == state->id) {
269 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (state->self)));
270 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, iter, TRUE);
271 hildon_button_set_value (HILDON_BUTTON (state->self),
272 hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
275 return TRUE; /* Stop walking the tree. */
278 return FALSE; /* Keep walking the tree. */
282 * Selects the specified serversecurity,
283 * or MODEST_PROTOCOLS_CONNECTION_NONE if no serversecurity was selected.
286 modest_serversecurity_picker_set_active_serversecurity (ModestServersecurityPicker *picker,
287 ModestProtocolType serversecurity)
289 ModestServersecurityPickerPrivate *priv = MODEST_SERVERSECURITY_PICKER_GET_PRIVATE (picker);
291 /* Create a state instance so we can send two items of data to the signal handler: */
292 ForEachData *state = g_new0 (ForEachData, 1);
293 state->self = picker;
294 state->id = serversecurity;
295 state->found = FALSE;
297 /* Look at each item, and select the one with the correct ID: */
298 gtk_tree_model_foreach (priv->model, &on_model_foreach_select_id, state);
300 const gboolean result = state->found;
302 /* Free the state instance: */