* fix precondition, which could cause a crash
[modest] / src / modest-utils.c
1 /* Copyright (c) 2007, 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 <glib.h>
31 #include <glib/gstdio.h>
32 #include <errno.h>
33 #include <string.h> /* for strlen */
34 #include <modest-runtime.h>
35 #include <libgnomevfs/gnome-vfs.h>
36 #include <tny-fs-stream.h>
37 #include <tny-camel-account.h>
38 #include <tny-status.h>
39 #include <tny-camel-transport-account.h>
40 #include <tny-camel-imap-store-account.h>
41 #include <tny-camel-pop-store-account.h>
42
43 #include <modest-defs.h>
44 #include "modest-utils.h"
45 #include "modest-platform.h"
46
47 GQuark
48 modest_utils_get_supported_secure_authentication_error_quark (void)
49 {
50         return g_quark_from_static_string("modest-utils-get-supported-secure-authentication-error-quark");
51 }
52
53 gboolean 
54 modest_utils_folder_writable (const gchar *filename)
55 {
56         g_return_val_if_fail (filename, FALSE);
57
58         if (!filename)
59                 return FALSE;
60         
61         if (g_strncasecmp (filename, "obex", 4) != 0) {
62                 GnomeVFSFileInfo folder_info;
63                 gchar *folder;
64                 folder = g_path_get_dirname (filename);
65                 gnome_vfs_get_file_info (folder, &folder_info,
66                                          GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS);
67                 g_free (folder);
68                 if (!((folder_info.permissions & GNOME_VFS_PERM_ACCESS_WRITABLE) ||
69                       (folder_info.permissions & GNOME_VFS_PERM_USER_WRITE))) {
70                         return FALSE;
71                 }
72         }
73         return TRUE;
74 }
75
76 gboolean 
77 modest_utils_file_exists (const gchar *filename)
78 {
79         GnomeVFSURI *uri = NULL;
80         gboolean result = FALSE;
81
82         uri = gnome_vfs_uri_new (filename);
83         if (uri) {
84                 result = gnome_vfs_uri_exists (uri);
85                 gnome_vfs_uri_unref (uri);
86         }
87         return result;
88 }
89
90 TnyFsStream *
91 modest_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path)
92 {
93         gint fd;
94         gchar *filepath = NULL;
95         gchar *tmpdir;
96         guint hash_number;
97
98         /* hmmm... maybe we need a modest_text_utils_validate_file_name? */
99         g_return_val_if_fail (orig_name && strlen(orig_name) != 0, NULL);
100
101         if (strlen(orig_name) > 200) {
102                 g_warning ("%s: filename too long ('%s')",
103                            __FUNCTION__, orig_name);
104                 return NULL;
105         }
106         
107         if (g_strstr_len (orig_name, strlen(orig_name), "/") != NULL) {
108                 g_warning ("%s: filename contains '/' character(s) (%s)",
109                            __FUNCTION__, orig_name);
110                 return NULL;
111         }
112                 
113         /* make a random subdir under /tmp or /var/tmp */
114         if (hash_base != NULL) {
115                 hash_number = g_str_hash (hash_base);
116         } else {
117                 hash_number = (guint) random ();
118         }
119         tmpdir = g_strdup_printf ("%s/%u", g_get_tmp_dir (), hash_number);
120         if ((g_access (tmpdir, R_OK) == -1) && (g_mkdir (tmpdir, 0755) == -1)) {
121                 g_warning ("%s: failed to create dir '%s': %s",
122                            __FUNCTION__, tmpdir, g_strerror(errno));
123                 g_free (tmpdir);
124                 return NULL;
125         }
126
127         filepath = g_strconcat (tmpdir, "/", orig_name, NULL);
128         /* don't overwrite if it already exists, even if it is writable */
129         if (modest_utils_file_exists (filepath)) {
130                 if (path!=NULL) {
131                         *path = filepath;
132                 } else {
133                         g_free (filepath);
134                 }
135                 g_free (tmpdir);
136                 return NULL;
137         } else {
138                 /* try to write the file there */
139                 fd = g_open (filepath, O_CREAT|O_WRONLY|O_TRUNC, 0644);
140                 if (fd == -1) {
141                         g_warning ("%s: failed to create '%s': %s",
142                                         __FUNCTION__, filepath, g_strerror(errno));                     
143                         g_free (filepath);
144                         g_free (tmpdir);
145                         return NULL;
146                 }
147         }
148
149         g_free (tmpdir);
150
151         if (path)
152                 *path = filepath;
153
154         return TNY_FS_STREAM (tny_fs_stream_new (fd));
155 }
156
157 typedef struct 
158 {
159         gboolean cancel;
160         GList *result;
161         GtkWidget* dialog;
162         GtkWidget* progress;
163         GError* error;
164 } ModestGetSupportedAuthInfo;
165
166 static void on_camel_account_get_supported_secure_authentication_status (
167         GObject *self, TnyStatus *status, gpointer user_data)
168 {
169         /*ModestGetSupportedAuthInfo* info = (ModestGetSupportedAuthInfo*) user_data;*/
170 }
171
172 static gboolean
173 on_idle_secure_auth_finished (gpointer user_data)
174 {
175         ModestGetSupportedAuthInfo *info = (ModestGetSupportedAuthInfo*)user_data;
176         /* Operation has finished, close the dialog. Control continues after
177          * gtk_dialog_run in modest_utils_get_supported_secure_authentication_methods() */
178
179         /* This is a GDK lock because we are an idle callback and
180          * the code below is or does Gtk+ code */
181
182         gdk_threads_enter(); /* CHECKED */
183         gtk_dialog_response (GTK_DIALOG (info->dialog), GTK_RESPONSE_ACCEPT);
184         gdk_threads_leave(); /* CHECKED */
185
186         return FALSE;
187 }
188
189 static void
190 on_camel_account_get_supported_secure_authentication (
191   TnyCamelAccount *self, gboolean cancelled,
192   TnyList *auth_types, GError *err, 
193   gpointer user_data)
194 {
195         ModestGetSupportedAuthInfo *info = (ModestGetSupportedAuthInfo*)user_data;
196         g_return_if_fail (info);
197         
198
199         /* Free everything if the actual action was canceled */
200         if (info->cancel)
201         {
202                 /* The operation was canceled and the ownership of the info given to us
203                  * so that we could still check the cancel flag. */
204                 g_slice_free (ModestGetSupportedAuthInfo, info);
205                 info = NULL;
206         }
207         else
208         {
209                 if (err)
210                 {
211                         if (info->error) {
212                                 g_error_free (info->error);
213                                 info->error = NULL;
214                         }
215                         
216                         info->error = g_error_copy (err);
217                 }
218
219                 if (!auth_types) {
220                         g_warning ("DEBUG: %s: auth_types is NULL.\n", __FUNCTION__);
221                 }
222                 else if (tny_list_get_length(auth_types) == 0) {
223                         g_warning ("DEBUG: %s: auth_types is an empty TnyList.\n", __FUNCTION__);
224                 } else
225                 {
226                         ModestPairList* pairs = modest_protocol_info_get_auth_protocol_pair_list ();
227   
228                         /* Get the enum value for the strings: */
229                         GList *result = NULL;
230                         TnyIterator* iter = tny_list_create_iterator(auth_types);
231                         while (!tny_iterator_is_done(iter)) {
232                                 TnyPair *pair = TNY_PAIR(tny_iterator_get_current(iter));
233                                 const gchar *auth_name = NULL;
234                                 if (pair) {
235                                         auth_name = tny_pair_get_name(pair);
236                                         g_object_unref (pair);
237                                         pair = NULL;
238                                 }
239
240                                 printf("DEBUG: %s: auth_name=%s\n", __FUNCTION__, auth_name);
241
242                                 ModestAuthProtocol proto = modest_protocol_info_get_auth_protocol (auth_name);
243                                 if(proto != MODEST_PROTOCOL_AUTH_NONE)
244                                                 result = g_list_prepend(result, GINT_TO_POINTER(proto));
245
246                                 tny_iterator_next(iter);
247                         }
248                         g_object_unref (iter);
249
250                         modest_pair_list_free (pairs);
251         
252                         info->result = result;
253                 }
254
255                 printf("DEBUG: finished\n");
256                                 
257                 /* Close the dialog in a main thread */
258                 g_idle_add(on_idle_secure_auth_finished, info);
259         }
260 }
261
262 static void
263 on_secure_auth_cancel(GtkWidget* dialog, int response, gpointer user_data)
264 {
265         if(response == GTK_RESPONSE_REJECT || response == GTK_RESPONSE_DELETE_EVENT)
266         {
267                 ModestGetSupportedAuthInfo *info = (ModestGetSupportedAuthInfo*)user_data;
268                 g_return_if_fail(info);
269                 /* This gives the ownership of the info to the worker thread. */
270                 info->result = NULL;
271                 info->cancel = TRUE;
272         }
273 }
274
275 GList*
276 modest_utils_get_supported_secure_authentication_methods (ModestTransportStoreProtocol proto, 
277         const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error)
278 {
279         g_return_val_if_fail (proto != MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN, NULL);
280         
281         /* We need a connection to get the capabilities; */
282         if (!modest_platform_connect_and_wait (GTK_WINDOW (parent_window), NULL))
283                 return NULL;
284          
285         /*
286         result = g_list_append (result, GINT_TO_POINTER (MODEST_PROTOCOL_AUTH_CRAMMD5));
287         */
288         
289         /* Create a TnyCamelAccount so we can use 
290          * tny_camel_account_get_supported_secure_authentication(): */
291         TnyAccount * tny_account = NULL;
292         switch (proto) {
293         case MODEST_PROTOCOL_TRANSPORT_SENDMAIL:
294         case MODEST_PROTOCOL_TRANSPORT_SMTP:
295                 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ()); break;
296         case MODEST_PROTOCOL_STORE_POP:
297                 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ()); break;
298         case MODEST_PROTOCOL_STORE_IMAP:
299                 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ()); break;
300         case MODEST_PROTOCOL_STORE_MAILDIR:
301         case MODEST_PROTOCOL_STORE_MBOX:
302                 tny_account = TNY_ACCOUNT(tny_camel_store_account_new()); break;
303         default:
304                 tny_account = NULL;
305         }
306
307         
308         if (!tny_account) {
309                 g_printerr ("%s could not create tny account.", __FUNCTION__);
310                 return NULL;
311         }
312         
313         /* Set proto, so that the prepare_func() vfunc will work when we call 
314          * set_session(): */
315          /* TODO: Why isn't this done in account_new()? */
316         tny_account_set_proto (tny_account,
317                                modest_protocol_info_get_transport_store_protocol_name(proto));
318
319         tny_account_set_hostname (tny_account, hostname);
320         /* Required for POP, at least */
321         tny_account_set_user (tny_account, username);
322                                
323         if(port > 0)
324                 tny_account_set_port (tny_account, port);
325                 
326         /* Set the session for the account, so we can use it: */
327         ModestTnyAccountStore *account_store = modest_runtime_get_account_store ();
328         TnySessionCamel *session = 
329                 modest_tny_account_store_get_session (TNY_ACCOUNT_STORE (account_store));
330         g_return_val_if_fail (session, NULL);
331         tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), session);
332         
333         
334         /* Ask camel to ask the server, asynchronously: */
335         ModestGetSupportedAuthInfo *info = g_slice_new (ModestGetSupportedAuthInfo);
336         info->result = NULL;
337         info->cancel = FALSE;
338         info->error = NULL;
339         info->progress = gtk_progress_bar_new();
340         /* TODO: Need logical_ID for the title: */
341         info->dialog = gtk_dialog_new_with_buttons(_("Authentication"),
342                                                    parent_window, GTK_DIALOG_MODAL,
343                                                    _("mcen_bd_dialog_cancel"),
344                                                    GTK_RESPONSE_REJECT,
345                                                    NULL);
346         //gtk_window_set_default_size(GTK_WINDOW(info->dialog), 300, 100);
347         
348         g_signal_connect(G_OBJECT(info->dialog), "response", G_CALLBACK(on_secure_auth_cancel), info);
349         
350         gtk_container_add(GTK_CONTAINER(GTK_DIALOG(info->dialog)->vbox),
351                           gtk_label_new("Checking for supported authentication types..."));
352         gtk_container_add(GTK_CONTAINER(GTK_DIALOG(info->dialog)->vbox), info->progress);
353         gtk_widget_show_all(info->dialog);
354         gtk_progress_bar_pulse(GTK_PROGRESS_BAR(info->progress));
355         
356         printf ("DEBUG: %s: STARTING.\n", __FUNCTION__);
357         tny_camel_account_get_supported_secure_authentication (
358                 TNY_CAMEL_ACCOUNT (tny_account),
359                 on_camel_account_get_supported_secure_authentication,
360                 on_camel_account_get_supported_secure_authentication_status,
361                 info);
362
363         gtk_dialog_run (GTK_DIALOG (info->dialog));
364         
365         gtk_widget_destroy(info->dialog);
366                         
367         GList *result = info->result;
368         if (!info->cancel)
369         {
370                 if (info->error) {
371                         gchar * debug_url_string = tny_account_get_url_string  (tny_account);
372                         g_warning ("DEBUG: %s:\n  error: %s\n  account url: %s", __FUNCTION__, info->error->message, 
373                                 debug_url_string);
374                         g_free (debug_url_string);
375                         
376                         g_propagate_error(error, info->error);
377                         info->error = NULL;
378                 }
379
380                 g_slice_free (ModestGetSupportedAuthInfo, info);
381                 info = NULL;
382         }
383         else
384         {
385                 // Tell the caller that the operation was canceled so it can
386                 // make a difference
387                 g_set_error(error,
388                             modest_utils_get_supported_secure_authentication_error_quark(),
389                             MODEST_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED,
390                             "User has canceled query");
391         }
392
393         return result;
394 }
395
396 void 
397 modest_utils_show_dialog_and_forget (GtkWindow *parent_window, 
398                                      GtkDialog *dialog)
399 {
400         gtk_window_set_transient_for (GTK_WINDOW (dialog), parent_window);
401         
402         /* Destroy the dialog when it is closed: */
403         g_signal_connect_swapped (dialog, 
404                                   "response", 
405                                   G_CALLBACK (gtk_widget_destroy), 
406                                   dialog);
407
408         gtk_widget_show (GTK_WIDGET (dialog));
409 }
410
411 void
412 modest_utils_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value)
413 {
414         GSList *proxies = NULL;
415
416         g_return_if_fail (GTK_IS_TOGGLE_ACTION (action));
417
418         for (proxies = gtk_action_get_proxies (GTK_ACTION (action));
419              proxies != NULL; proxies = g_slist_next (proxies)) {
420                 GtkWidget *widget = (GtkWidget *) proxies->data;
421                 gtk_action_block_activate_from (GTK_ACTION (action), widget);
422         }
423
424         gtk_toggle_action_set_active (action, value);
425
426         for (proxies = gtk_action_get_proxies (GTK_ACTION (action));
427              proxies != NULL; proxies = g_slist_next (proxies)) {
428                 GtkWidget *widget = (GtkWidget *) proxies->data;
429                 gtk_action_unblock_activate_from (GTK_ACTION (action), widget);
430         }
431
432 }
433