Changeset 1911

Timestamp:

05/08/07 11:41:03

Author:

murrayc

Message:

2007-05-08 Murray Cumming <murrayc@murrayc.com

• • • • libtinymail/tny-account-store.c:
        
      • libtinymail/tny-account-store.h: Change the alert_func vfunc to
        

provide a GError instead of a human-readable error string.
(tny_account_store_alert): The documentation for this vfunc invoker seems to
refer to the vfunc (as is also normal in GTK+), so document how the GError
should be used and point out that the application should translate the
message and show an appropriate dialog.
This does not seem to require the definition of a new GError domain -
the existing one seems suitable.

• • • • libtinymail-acap/tny-acap-account-store.c:
        

(tny_acap_account_store_alert):

• • • • libtinymail-camel/tny-camel-account.c:
        

(tny_camel_account_set_online_default):

• • • • libtinymail-camel/tny-session-camel.c:
        

(tny_session_camel_alert_user), (foreach_account_set_connectivity):

• • • • libtinymail-gnome-desktop/tny-gnome-account-store.c:
        

(tny_gnome_account_store_alert):

• • • • libtinymail-gpe/tny-gpe-account-store.c:
        

(tny_gpe_account_store_alert):

• • • • libtinymail-maemo/tny-maemo-account-store.c:
        

(tny_maemo_account_store_alert):

• • • • libtinymail-olpc/tny-olpc-account-store.c:
        

(tny_olpc_account_store_alert):

• • • • tests/shared/account-store.c: (tny_test_account_store_alert):
        

Use the GError instead of the message string.

Files:

• trunk/ChangeLog (modified) (1 diff)
• trunk/libtinymail-acap/tny-acap-account-store.c (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-account.c (modified) (1 diff)
• trunk/libtinymail-camel/tny-session-camel.c (modified) (3 diffs)
• trunk/libtinymail-gnome-desktop/tny-gnome-account-store.c (modified) (1 diff)
• trunk/libtinymail-gpe/tny-gpe-account-store.c (modified) (1 diff)
• trunk/libtinymail-maemo/tny-maemo-account-store.c (modified) (3 diffs)
• trunk/libtinymail-olpc/tny-olpc-account-store.c (modified) (1 diff)
• trunk/libtinymail/tny-account-store.c (modified) (4 diffs)
• trunk/libtinymail/tny-account-store.h (modified) (2 diffs)
• trunk/tests/shared/account-store.c (modified) (1 diff)

trunk/ChangeLog

@@ +1 @@
+2007-05-08  Murray Cumming  <murrayc@murrayc.com
+
+        * libtinymail/tny-account-store.c:
+        * libtinymail/tny-account-store.h: Change the alert_func vfunc to 
+        provide a GError instead of a human-readable error string.
+        (tny_account_store_alert): The documentation for this vfunc invoker seems to 
+        refer to the vfunc (as is also normal in GTK+), so document how the GError 
+        should be used and point out that the application should translate the 
+        message and show an appropriate dialog.
+        This does not seem to require the definition of a new GError domain - 
+        the existing one seems suitable.
+        
+        * libtinymail-acap/tny-acap-account-store.c:
+        (tny_acap_account_store_alert):
+        * libtinymail-camel/tny-camel-account.c:
+        (tny_camel_account_set_online_default):
+        * libtinymail-camel/tny-session-camel.c:
+        (tny_session_camel_alert_user), (foreach_account_set_connectivity):
+        * libtinymail-gnome-desktop/tny-gnome-account-store.c:
+        (tny_gnome_account_store_alert):
+        * libtinymail-gpe/tny-gpe-account-store.c:
+        (tny_gpe_account_store_alert):
+        * libtinymail-maemo/tny-maemo-account-store.c:
+        (tny_maemo_account_store_alert):
+        * libtinymail-olpc/tny-olpc-account-store.c:
+        (tny_olpc_account_store_alert):
+        * tests/shared/account-store.c: (tny_test_account_store_alert):
+        Use the GError instead of the message string.
+
-2007-05-08  Philip Van Hoof  <pvanhoof@gnome.org>
-

trunk/libtinymail-acap/tny-acap-account-store.c

@@ -48 +48 @@
-
-static gboolean
-gchar *prompt
-
-
-prompt
+GError *error
+
+
+error
-}
-

trunk/libtinymail-camel/tny-camel-account.c

@@ -840 +840 @@
-tny_camel_account_set_online_default (TnyCamelAccount *self, gboolean online, GError **err)
-{
+        /* Note that the human-readable GError:message strings here are only for debugging.
+         * They should never be shown to the user. The application should make its own 
+         * decisions about how to show these errors in the UI, and should make sure that 
+         * they are translated in the user's locale.
+         */
+
-        TnyCamelAccountPriv *priv = TNY_CAMEL_ACCOUNT_GET_PRIVATE (self);
-        CamelException ex = CAMEL_EXCEPTION_INITIALISER;

trunk/libtinymail-camel/tny-session-camel.c

@@ -170 +170 @@
-
-static gboolean
-char *prompt
+GError *error
-{
-        TnySessionCamel *self = (TnySessionCamel *)session;
@@ -199 +199 @@
-                retval = tny_account_store_alert (
-                        (TnyAccountStore*) self->priv->account_store, 
-(const gchar *) prompt
+error
-                tny_lockable_unlock (self->priv->ui_lock);
-        }
@@ -415 +415 @@
-                if (err != NULL) 
-                {
-->message
+
-                        g_error_free (err);
-                }

trunk/libtinymail-gnome-desktop/tny-gnome-account-store.c

@@ -100 +100 @@
-
-static gboolean
-gchar *prompt
+GError *error
-{
-        GtkMessageType gtktype;

trunk/libtinymail-gpe/tny-gpe-account-store.c

@@ -98 +98 @@
-
-static gboolean
-gchar *prompt
+GError *error
-{
-        GtkMessageType gtktype;

trunk/libtinymail-maemo/tny-maemo-account-store.c

@@ -34 +34 @@
-
-#include <tny-account-store.h>
+#include <tny-error.h>
-#include <tny-maemo-account-store.h>
-#include <tny-account.h>
@@ -98 +99 @@
-
-static gboolean
-gchar *prompt
+GError *error
-{
-        GtkMessageType gtktype;
-        gboolean retval = FALSE;
-        GtkWidget *dialog;
-
@@ -118 +118 @@
-        }
-
+        const gchar *prompt = NULL;
+        switch (error->code)
+        {
+                /* Currently, this seems to be the only possible error.
+                 * It originates from _tny_camel_account_try_connect(), 
+                 * and maybe from similar functions.
+                 * The error->message text originates from 
+                 * camel-imap-store.c:imap_auth_loop().
+                 */
+                case TNY_ACCOUNT_ERROR_TRY_CONNECT:
+                        /* Use a Logical ID: */
+                        prompt = _("Account not yet fully configured");
+                        break;
+                default:
+                        g_warning ("%s: Unhandled GError code.", __FUNCTION__);
+                        prompt = NULL;
+                break;
+        }
+        
+        if (!prompt)
+                return FALSE;
+                
+        /* TODO: Show more appropriate explicitly named buttons in the dialog,
+         * and just show one button if there is no choice to be made. */
+        gboolean retval = FALSE;
-        dialog = gtk_message_dialog_new (NULL, GTK_DIALOG_MODAL,
-                                  gtktype, GTK_BUTTONS_YES_NO, prompt);

trunk/libtinymail-olpc/tny-olpc-account-store.c

@@ -96 +96 @@
-
-static gboolean
-gchar *prompt
+GError *error
-{
-        GtkMessageType gtktype;

trunk/libtinymail/tny-account-store.c

@@ -81 +81 @@
- * @self: a #TnyAccountStore object
- * @type: the message type (severity)
-prompt: the prompt
-
-with @prompt
-s prompt a
+error: A GError, of domain TNY_ACCOUNT_ERROR, which should be used to determine what to show to the user.
+
+appropriate for the @error
+
- * affirmative or FALSE if not.
- *
- * Implementors: when implementing a platform-specific library, you must
-tk
- for example
+TK
+, for example,
- * certificates. The two possible answers that must be supported are 
-
-
-
+
+
+
+
+
+
- * <informalexample><programlisting>
- * static gboolean
-gchar *prompt
+GError *error
- * {
- *     GtkMessageType gtktype;
- *     gboolean retval = FALSE;
- *     GtkWidget *dialog;
- *     switch (type)
@@ -114 +116 @@
- *         break;
- *     }
+ *
+ *     const gchar *prompt = NULL;
+ *     switch (error->code)
+ *     {
+ *         case TNY_ACCOUNT_ERROR_TRY_CONNECT:
+ *             prompt = _("Account not yet fully configured");
+ *             break;
+ *         default:
+ *             g_warning ("%s: Unhandled GError code.", __FUNCTION__);
+ *             prompt = NULL;
+ *             break;
+ *      }
+ *      
+ *      if (!prompt)
+ *              return FALSE;
+ *
+ *     gboolean retval = FALSE;
- *     dialog = gtk_message_dialog_new (NULL, GTK_DIALOG_MODAL,
- *            gtktype, GTK_BUTTONS_YES_NO, prompt);
@@ -127 +146 @@
- **/
-gboolean 
-gchar *prompt
+GError *error
-{
-        gboolean retval;
@@ -138 +157 @@
-#endif
-
-prompt
+error
-
-#ifdef DBC /* ensure */

trunk/libtinymail/tny-account-store.h

@@ -79 +79 @@
-        const gchar* (*get_cache_dir_func) (TnyAccountStore *self);
-        TnyDevice* (*get_device_func) (TnyAccountStore *self);
-gchar *prompt
+GError *error
-        TnyAccount* (*find_account_func) (TnyAccountStore *self, const gchar *url_string);
-};
@@ -90 +90 @@
-const gchar*  tny_account_store_get_cache_dir (TnyAccountStore *self);
-TnyDevice* tny_account_store_get_device (TnyAccountStore *self);
-gchar *prompt
+GError *error
-TnyAccount* tny_account_store_find_account (TnyAccountStore *self, const gchar *url_string);
-

trunk/tests/shared/account-store.c

@@ -66 +66 @@
-
-static gboolean
-gchar *prompt
+GError *error
-{
-        return TRUE;