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