Modified webpage: now tinymail repository is in gitorious.
[modest] / src / hildon2 / modest-secureauth-picker.c
1 /* Copyright (c) 2007, 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 #include "modest-secureauth-picker.h"
31 #include <modest-runtime.h>
32 #include <gtk/gtkliststore.h>
33 #include <gtk/gtkcelllayout.h>
34 #include <gtk/gtkcellrenderertext.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 (ModestSecureauthPicker, modest_secureauth_picker, HILDON_TYPE_PICKER_BUTTON);
46
47 #define MODEST_SECUREAUTH_PICKER_GET_PRIVATE(o) \
48         (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_SECUREAUTH_PICKER, ModestSecureauthPickerPrivate))
49
50 typedef struct _ModestSecureauthPickerPrivate ModestSecureauthPickerPrivate;
51
52 struct _ModestSecureauthPickerPrivate
53 {
54         GtkTreeModel *model;
55 };
56
57 static void
58 modest_secureauth_picker_finalize (GObject *object)
59 {
60         ModestSecureauthPickerPrivate *priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (object);
61
62         g_object_unref (G_OBJECT (priv->model));
63
64         G_OBJECT_CLASS (modest_secureauth_picker_parent_class)->finalize (object);
65 }
66
67 static void
68 modest_secureauth_picker_class_init (ModestSecureauthPickerClass *klass)
69 {
70         GObjectClass *object_class = G_OBJECT_CLASS (klass);
71
72         g_type_class_add_private (klass, sizeof (ModestSecureauthPickerPrivate));
73
74         object_class->finalize = modest_secureauth_picker_finalize;
75 }
76
77 enum MODEL_COLS {
78         MODEL_COL_NAME = 0, /* a string */
79         MODEL_COL_ID = 1 /* an int. */
80 };
81
82 static void modest_secureauth_picker_fill (ModestSecureauthPicker *picker);
83
84 static gchar *
85 touch_selector_print_func (HildonTouchSelector *selector, gpointer userdata)
86 {
87         GtkTreeIter iter;
88         if (hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &iter)) {
89                 GtkTreeModel *model;
90                 GValue value = {0,};
91                 
92                 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
93                 gtk_tree_model_get_value (model, &iter, MODEL_COL_NAME, &value);
94                 return g_value_dup_string (&value);
95         }
96         return NULL;
97 }
98
99 static void
100 modest_secureauth_picker_init (ModestSecureauthPicker *self)
101 {
102         ModestSecureauthPickerPrivate *priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (self);
103
104         priv->model = NULL;
105 }
106
107 ModestSecureauthPicker*
108 modest_secureauth_picker_new (HildonSizeType size,
109                               HildonButtonArrangement arrangement)
110 {
111         ModestSecureauthPicker *self;
112         ModestSecureauthPickerPrivate *priv;
113         GtkCellRenderer *renderer;
114         GtkWidget *selector;
115
116         self = g_object_new (MODEST_TYPE_SECUREAUTH_PICKER, 
117                              "arrangement", arrangement,
118                              "size", size,
119                              NULL);
120         priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (self);
121
122         /* Create a tree model,
123          * with a string for the name, and an ID for the servertype.
124          * This must match our MODEL_COLS enum constants.
125          */
126         priv->model = GTK_TREE_MODEL (gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT));
127         renderer = gtk_cell_renderer_text_new ();
128         g_object_set (G_OBJECT (renderer), "ellipsize", PANGO_ELLIPSIZE_END, NULL);
129
130         selector = hildon_touch_selector_new ();
131         hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector), GTK_TREE_MODEL (priv->model),
132                                              renderer, "text", MODEL_COL_NAME, NULL);
133
134         hildon_touch_selector_set_model (HILDON_TOUCH_SELECTOR (selector), 0, GTK_TREE_MODEL (priv->model));
135         hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector), (HildonTouchSelectorPrintFunc) touch_selector_print_func);
136
137         hildon_picker_button_set_selector (HILDON_PICKER_BUTTON (self), HILDON_TOUCH_SELECTOR (selector));
138
139         modest_secureauth_picker_fill (self);
140
141         /* For theming purpouses. Widget name must end in Button-finger */
142         gtk_widget_set_name ((GtkWidget *) self, "ModestSecureauthPickerButton-finger");
143
144         return self;
145 }
146
147 /* Fill the combo box with appropriate choices.
148  * #picker: The combo box.
149  * @protocol: IMAP or POP.
150  */
151 static void 
152 modest_secureauth_picker_fill (ModestSecureauthPicker *picker)
153 {       
154         ModestSecureauthPickerPrivate *priv;
155         GtkListStore *liststore;
156         ModestProtocolRegistry *protocol_registry;
157         GSList *protocols, *node;
158         GtkTreeIter iter;
159
160         priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
161         
162         /* Remove any existing rows: */
163         liststore = GTK_LIST_STORE (priv->model);
164         gtk_list_store_clear (liststore);
165
166         protocol_registry = modest_runtime_get_protocol_registry ();
167         protocols = modest_protocol_registry_get_by_tag (protocol_registry, MODEST_PROTOCOL_REGISTRY_AUTH_PROTOCOLS);
168
169         for (node = protocols; node != NULL; node = g_slist_next (node)) {
170                 ModestProtocol *protocol;
171                 protocol = (ModestProtocol *) node->data;
172
173                 gtk_list_store_append (liststore, &iter);
174                 gtk_list_store_set (liststore, &iter, 
175                                     MODEL_COL_ID, (gint)modest_protocol_get_type_id (protocol),
176                                     MODEL_COL_NAME, modest_protocol_get_display_name (protocol),
177                                     -1);
178                 if (modest_protocol_get_type_id (protocol) == MODEST_PROTOCOLS_AUTH_NONE) {
179                         HildonTouchSelector *selector;
180                         selector = hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker));
181                         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &iter, TRUE);
182                         hildon_button_set_value (HILDON_BUTTON (picker), 
183                                                  hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
184                         
185                 }
186         }       
187 }
188
189 /**
190  * Returns the selected secureauth, 
191  * or MODEST_PROTOCOL_REGISTRY_TYPE_INVALID if no secureauth was selected.
192  */
193 ModestProtocolType
194 modest_secureauth_picker_get_active_secureauth (ModestSecureauthPicker *picker)
195 {
196         GtkTreeIter active;
197         gboolean found;
198         GtkWidget *selector;
199
200         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker)));
201
202         found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
203         if (found) {
204                 ModestSecureauthPickerPrivate *priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
205
206                 ModestProtocolType secure_auth = MODEST_PROTOCOLS_AUTH_NONE;
207                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &secure_auth, -1);
208                 return secure_auth;     
209         }
210
211         return MODEST_PROTOCOL_REGISTRY_TYPE_INVALID; /* Failed. */
212 }
213
214 /* This allows us to pass more than one piece of data to the signal handler,
215  * and get a result: */
216 typedef struct 
217 {
218         ModestSecureauthPicker* self;
219         ModestProtocolType id;
220         gboolean found;
221 } ForEachData;
222
223 static gboolean
224 on_model_foreach_select_id(GtkTreeModel *model, 
225         GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
226 {
227         ForEachData *state;
228         ModestProtocolType id = MODEST_PROTOCOL_REGISTRY_TYPE_INVALID;
229
230         state = (ForEachData*)(user_data);
231         
232         /* Select the item if it has the matching ID: */
233         gtk_tree_model_get (model, iter, MODEL_COL_ID, &id, -1); 
234         if(id == state->id) {
235                 GtkWidget *selector;
236                 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (state->self)));
237                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, iter, TRUE);
238                 hildon_button_set_value (HILDON_BUTTON (state->self),
239                                          hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
240                 
241                 state->found = TRUE;
242                 return TRUE; /* Stop walking the tree. */
243         }
244         
245         return FALSE; /* Keep walking the tree. */
246 }
247
248 /**
249  * Selects the specified secureauth, 
250  * or MODEST_PROTOCOL_REGISTRY_TYPE_INVALID if no secureauth was selected.
251  */
252 gboolean
253 modest_secureauth_picker_set_active_secureauth (ModestSecureauthPicker *picker, ModestProtocolType secureauth)
254 {
255         ModestSecureauthPickerPrivate *priv;
256         ForEachData *state;
257         gboolean result;
258
259         priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
260         
261         /* Create a state instance so we can send two items of data to the signal handler: */
262         state = g_new0 (ForEachData, 1);
263         state->self = picker;
264         state->id = secureauth;
265         state->found = FALSE;
266         
267         /* Look at each item, and select the one with the correct ID: */
268         gtk_tree_model_foreach (priv->model, &on_model_foreach_select_id, state);
269
270         result = state->found;
271         
272         /* Free the state instance: */
273         g_free(state);
274         
275         return result;
276 }
277