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