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