git.maemo.org Git - modest/blob - src/modest-utils.h

   1 /* Copyright (c) 2006, 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
  31 #ifndef __MODEST_UTILS_H__
  32 #define __MODEST_UTILS_H__
  33
  34 #include <gtk/gtk.h>
  35 #include <stdio.h> /* for FILE* */
  36 #include <tny-fs-stream.h>
  37 #include <modest-protocol.h>
  38 #include "widgets/modest-validating-entry.h"
  39 #include <widgets/modest-window.h>
  40
  41 typedef enum {
  42         MODEST_UTILS_GET_SUPPORTED_SECURE_AUTHENTICATION_ERROR_CANCELED
  43 } ModestUtilsGetSupportedSecureAuthenticationError;
  44
  45 typedef enum _ModestSortDialogType {
  46         MODEST_SORT_HEADERS,
  47 } ModestSortDialogType;
  48
  49 typedef struct _ModestMsgNotificationData {
  50         gchar *subject;
  51         gchar *from;
  52         gchar *uri;
  53         time_t time;
  54 } ModestMsgNotificationData;
  55
  56 GQuark modest_utils_get_supported_secure_authentication_error_quark (void);
  57
  58
  59 /**
  60  * modest_utils_folder_writable:
  61  * @filename: a string
  62  *
  63  * Checks if @filename is in a writable folder
  64  *
  65  * Returns: %TRUE if @filename is writable, %FALSE otherwise
  66  */
  67 gboolean modest_utils_folder_writable (const gchar *filename);
  68
  69 /**
  70  * modest_utils_file_exists:
  71  * @filename: a string
  72  *
  73  * Checks if @filename exists. The filename must NOT use escaped
  74  * characters as this function uses g_access to check if the file
  75  * exists or not
  76  *
  77  * Returns: %TRUE if @filename currently exists, %FALSE otherwise
  78  */
  79 gboolean modest_utils_file_exists (const gchar *filename);
  80
  81 /**
  82  * modest_utils_create_temp_stream:
  83  * @orig_name: a string with the original name of the extension, or %NULL
  84  * @hash_base: if %NULL, subdir will be random. If not, it will be a hash
  85  * of this.
  86  * @path: a string with the created file path.
  87  *
  88  * Creates a temporary fs stream, in a random subdir of /tmp or /var/tmp.
  89  *
  90  * Returns: a #TnyFsStream, or %NULL if operation failed.  Note that it is
  91  * possible that the file already exists but it is not writable. In that case,
  92  * the function would return NULL and @path would contain its path.
  93  */
  94 TnyFsStream *modest_utils_create_temp_stream (const gchar *orig_name, const gchar *hash_base, gchar **path);
  95
  96 /**
  97  * modest_utils_get_supported_secure_authentication_methods:
  98  * @proto: the protocol
  99  * @hostname: hostname of the mail server to check
 100  * @port: mail server port
 101  * @username: username of the account to check for
 102  * @parent_window: a GtkWindow that can be used a parent for progress indication
 103  *
 104  * Get a list of supported authentication methods of the server
 105  *
 106  * Returns: GList* of the method names. This list needs to be freed using g_list_free.
 107  *
 108  */
 109
 110 GList* modest_utils_get_supported_secure_authentication_methods (ModestProtocolType proto,
 111         const gchar* hostname, gint port, const gchar* username, GtkWindow *parent_window, GError** error);
 112
 113 /** modest_show_information_note_in_main_context_and_forget:
 114  * @parent_window: The window for which the note should be transient.
 115  * @message: The text to show.
 116  *
 117  * This calls modest_maemo_show_information_note_and_forget() in an idle handler.
 118  * This should be used when you are not sure that you are in the main context,
 119  * because you should try to use GTK+ UI code only in the main context.
 120  */
 121 void modest_utils_show_information_note_in_main_context_and_forget (GtkWindow *parent_window, const gchar* message);
 122
 123 /** modest_show_dialog_and_forget:
 124  * @parent_window: The window for which the note should be transient.
 125  * @message: The dialog to show.
 126  *
 127  * Show the dialog and destroy it when it is closed, without
 128  * blocking. Use this when you don't want to use gtk_dialog_run(), which might lead
 129  * to hangs.
 130  */
 131 void modest_utils_show_dialog_and_forget (GtkWindow *parent_window, GtkDialog *dialog);
 132
 133 /**
 134  * modest_toggle_action_set_active_block_notify:
 135  * @action: a #GtkToggleAction
 136  * @value: a #gboolean
 137  *
 138  * updates the toggle action active status, but blocking the notification of the changes.
 139  */
 140 void modest_utils_toggle_action_set_active_block_notify (GtkToggleAction *action, gboolean value);
 141
 142 /**
 143  * modest_utils_run_sort_dialog:
 144  * @parent_window: the modest window the dialog has been requested from
 145  * @type: a #ModestSortDialogType
 146  *
 147  * raises a sort dialog for this window
 148  */
 149 void modest_utils_run_sort_dialog (ModestWindow *parent_window, ModestSortDialogType type);
 150
 151
 152 /**
 153  * modest_list_index:
 154  * @list: a #TnyList
 155  * @object: a #GObject
 156  *
 157  * finds the index of @object in @list
 158  *
 159  * Returns: the index of @object, or -1 if @object is not in @list
 160  */
 161 gint modest_list_index (TnyList *list, GObject *object);
 162
 163 /**
 164  * modest_utils_get_available_space:
 165  * @maildir_path: the path of the maildir folder, or %NULL to
 166  * get the space available in local folders
 167  *
 168  * Obtains the space available in the local folder.
 169  *
 170  * Returns: a #guint64
 171  */
 172 guint64 modest_utils_get_available_space (const gchar *maildir_path);
 173
 174 /**
 175  * modest_images_cache_get_id:
 176  * @account: a #TnyAccount
 177  * @uri: an uri string
 178  *
 179  * obtains the hash corresponding to an image external resource to be
 180  * stored in image cache.
 181  *
 182  * Returns: a newly allocated string containing the hash key
 183  */
 184 gchar *modest_images_cache_get_id (const gchar *account, const gchar *uri);
 185
 186
 187 /**
 188  * modest_utils_get_account_name_from_recipient:
 189  * @from: the result of a call to tny_header_dup_from
 190  *
 191  * returns the account name that corresponds to the given from address
 192  *
 193  * Returns: a newly allocated string containing the account name or
 194  * %NULL in case of error
 195  */
 196 gchar *modest_utils_get_account_name_from_recipient (const gchar *from, gchar **mailbox);
 197
 198 void modest_utils_on_entry_invalid_character (ModestValidatingEntry *self,
 199                                               const gchar* character,
 200                                               gpointer user_data);
 201
 202 /**
 203  * modest_utils_open_mcc_mapping_file:
 204  * @translated: a #gboolean pointer
 205  *
 206  * open the mcc mapping file, or %NULL if it fails
 207  *
 208  * Returns: file ptr or %NULL in case of error
 209  */
 210 FILE* modest_utils_open_mcc_mapping_file (void);
 211
 212 typedef enum {
 213         MODEST_UTILS_COUNTRY_MODEL_COLUMN_NAME = 0,
 214         MODEST_UTILS_COUNTRY_MODEL_COLUMN_MCC = 1,
 215         MODEST_UTILS_COUNTRY_MODEL_N_COLUMNS
 216 } ModestUtilsCountryModelColumns;
 217
 218 /**
 219  * modest_utils_create_country_model:
 220  * @locale_mcc: a #gboolean
 221  *
 222  * creates the countries tree model used in wizard from the mcc
 223  * files.
 224  *
 225  * Returns: an empty #GtkTreeModel with the columns enumerated in
 226  *  #ModestUtilsCountryModelColumns
 227  */
 228 GtkTreeModel *modest_utils_create_country_model (void);
 229
 230 /**
 231  * modest_utils_fill_country_model:
 232  * @model: a #GtkTreeModel (obtained with modest_utils_create_country_model
 233  * @locale_mcc: a #gboolean
 234  *
 235  * fills the countries tree model used in wizard from the mcc
 236  * files.
 237  *
 238  */
 239 void modest_utils_fill_country_model (GtkTreeModel *model, gint *locale_mcc);
 240
 241 /**
 242  * modest_utils_create_notification_list_from_header_list:
 243  * @header_list: a #TnyList of #TnyHeader instances
 244  *
 245  * This function transforms a list of #TnyHeader objects into a list
 246  * that will be used to issue new email notifications
 247  *
 248  * Returns: a #GList of #ModestMsgNotificationData
 249  **/
 250 GList *modest_utils_create_notification_list_from_header_list (TnyList *header_list);
 251
 252 /**
 253  * modest_utils_free_notification_list:
 254  * @notification_list: a #GList of #ModestMsgNotificationData
 255  *
 256  * Frees a list of #ModestMsgNotificationData structures
 257  **/
 258 void  modest_utils_free_notification_list (GList *notification_list);
 259
 260 /**
 261  * modest_utils_flush_send_queue:
 262  * @account_id: the ID of the modest account
 263  *
 264  * Flushes the send queue of the given account. That will try to send
 265  * all the remaining messages in the send queue
 266  **/
 267 void  modest_utils_flush_send_queue (const gchar *account_id);
 268
 269 #endif /*__MODEST_MAEMO_UTILS_H__*/