* Fixes several memory leaks
[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)
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), 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         return self;
142 }
143
144 /* Fill the combo box with appropriate choices.
145  * #picker: The combo box.
146  * @protocol: IMAP or POP.
147  */
148 static void 
149 modest_secureauth_picker_fill (ModestSecureauthPicker *picker)
150 {       
151         ModestSecureauthPickerPrivate *priv;
152         GtkListStore *liststore;
153         ModestProtocolRegistry *protocol_registry;
154         GSList *protocols, *node;
155         GtkTreeIter iter;
156
157         priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
158         
159         /* Remove any existing rows: */
160         liststore = GTK_LIST_STORE (priv->model);
161         gtk_list_store_clear (liststore);
162
163         protocol_registry = modest_runtime_get_protocol_registry ();
164         protocols = modest_protocol_registry_get_by_tag (protocol_registry, MODEST_PROTOCOL_REGISTRY_AUTH_PROTOCOLS);
165
166         for (node = protocols; node != NULL; node = g_slist_next (node)) {
167                 ModestProtocol *protocol;
168                 protocol = (ModestProtocol *) node->data;
169
170                 gtk_list_store_append (liststore, &iter);
171                 gtk_list_store_set (liststore, &iter, 
172                                     MODEL_COL_ID, (gint)modest_protocol_get_type_id (protocol),
173                                     MODEL_COL_NAME, modest_protocol_get_display_name (protocol),
174                                     -1);
175                 if (modest_protocol_get_type_id (protocol) == MODEST_PROTOCOLS_AUTH_NONE) {
176                         HildonTouchSelector *selector;
177                         selector = hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker));
178                         hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, &iter, TRUE);
179                         hildon_button_set_value (HILDON_BUTTON (picker), 
180                                                  hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
181                         
182                 }
183         }       
184 }
185
186 /**
187  * Returns the selected secureauth, 
188  * or MODEST_PROTOCOL_REGISTRY_TYPE_INVALID if no secureauth was selected.
189  */
190 ModestProtocolType
191 modest_secureauth_picker_get_active_secureauth (ModestSecureauthPicker *picker)
192 {
193         GtkTreeIter active;
194         gboolean found;
195         GtkWidget *selector;
196
197         selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (picker)));
198
199         found = hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector), 0, &active);
200         if (found) {
201                 ModestSecureauthPickerPrivate *priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
202
203                 ModestProtocolType secure_auth = MODEST_PROTOCOLS_AUTH_NONE;
204                 gtk_tree_model_get (priv->model, &active, MODEL_COL_ID, &secure_auth, -1);
205                 return secure_auth;     
206         }
207
208         return MODEST_PROTOCOL_REGISTRY_TYPE_INVALID; /* Failed. */
209 }
210
211 /* This allows us to pass more than one piece of data to the signal handler,
212  * and get a result: */
213 typedef struct 
214 {
215         ModestSecureauthPicker* self;
216         ModestProtocolType id;
217         gboolean found;
218 } ForEachData;
219
220 static gboolean
221 on_model_foreach_select_id(GtkTreeModel *model, 
222         GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
223 {
224         ForEachData *state;
225         ModestProtocolType id = MODEST_PROTOCOL_REGISTRY_TYPE_INVALID;
226
227         state = (ForEachData*)(user_data);
228         
229         /* Select the item if it has the matching ID: */
230         gtk_tree_model_get (model, iter, MODEL_COL_ID, &id, -1); 
231         if(id == state->id) {
232                 GtkWidget *selector;
233                 selector = GTK_WIDGET (hildon_picker_button_get_selector (HILDON_PICKER_BUTTON (state->self)));
234                 hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector), 0, iter, TRUE);
235                 hildon_button_set_value (HILDON_BUTTON (state->self),
236                                          hildon_touch_selector_get_current_text (HILDON_TOUCH_SELECTOR (selector)));
237                 
238                 state->found = TRUE;
239                 return TRUE; /* Stop walking the tree. */
240         }
241         
242         return FALSE; /* Keep walking the tree. */
243 }
244
245 /**
246  * Selects the specified secureauth, 
247  * or MODEST_PROTOCOL_REGISTRY_TYPE_INVALID if no secureauth was selected.
248  */
249 gboolean
250 modest_secureauth_picker_set_active_secureauth (ModestSecureauthPicker *picker, ModestProtocolType secureauth)
251 {
252         ModestSecureauthPickerPrivate *priv;
253         ForEachData *state;
254         gboolean result;
255
256         priv = MODEST_SECUREAUTH_PICKER_GET_PRIVATE (picker);
257         
258         /* Create a state instance so we can send two items of data to the signal handler: */
259         state = g_new0 (ForEachData, 1);
260         state->self = picker;
261         state->id = secureauth;
262         state->found = FALSE;
263         
264         /* Look at each item, and select the one with the correct ID: */
265         gtk_tree_model_foreach (priv->model, &on_model_foreach_select_id, state);
266
267         result = state->found;
268         
269         /* Free the state instance: */
270         g_free(state);
271         
272         return result;
273 }
274