Changeset 3634

Timestamp:

04/28/08 18:51:22

Author:

jdapena

Message:

* libtinymail/tny-folder.[ch]:

• New method find_msg_async. This makes find_msg synchronous
  version be deprecated now.
  

* libtinymail-camel/tny-camel-folder.[ch],

libtinymail/tny-merge-folder.[ch]:

• Added implementations of find_msg_async method.
  

Files:

• trunk/ChangeLog (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-folder.c (modified) (4 diffs)
• trunk/libtinymail-camel/tny-camel-folder.h (modified) (1 diff)
• trunk/libtinymail/tny-folder.c (modified) (3 diffs)
• trunk/libtinymail/tny-folder.h (modified) (3 diffs)
• trunk/libtinymail/tny-merge-folder.c (modified) (2 diffs)

trunk/ChangeLog

@@ +1 @@
+2008-04-28  Jose Dapena Paz  <jdapena@igalia.com>, Sergio Villar Senin <svillar@igalia.com>
+
+        * libtinymail/tny-folder.[ch]: new method find_msg_async. This makes find_msg synchronous
+        version be deprecated now.
+
+        * libtinymail-camel/tny-camel-folder.[ch],
+        libtinymail/tny-merge-folder.[ch]:
+        Added implementations of find_msg_async method.
+
-2008-04-25  Philip Van Hoof <pvanhoof@gnome.org>
-

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

@@ -1271 +1271 @@
-        TnyIterator *iter = NULL;
-        TnyHeader *header = NULL;
-        TnyMsgRemoveStrategy *strat;
-
-        g_assert (TNY_IS_LIST (headers));
@@ -2599 +2598 @@
-
-
+typedef struct 
+{
+        TnyCamelQueueable parent;
+
+        TnyFolder *self;
+        TnyMsg *msg;
+        gchar *url_string;
+        GError *err;
+        gpointer user_data;
+        TnyGetMsgCallback callback;
+        TnyStatusCallback status_callback;
+        TnySessionCamel *session;
+        TnyIdleStopper *stopper;
+        gboolean cancelled;
+
+} FindMsgInfo;
+
+static void
+tny_camel_folder_find_msg_async_destroyer (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (info->self);
+
+        /* thread reference */
+        _tny_camel_folder_unreason (priv);
+        g_object_unref (info->self);
+
+        if (info->err)
+                g_error_free (info->err);
+
+        tny_idle_stopper_destroy (info->stopper);
+        info->stopper = NULL;
+
+        /**/
+
+        camel_object_unref (info->session);
+
+        return;
+}
+
+static gboolean
+tny_camel_folder_find_msg_async_callback (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+        TnyFolderChange *change;
+
+        if (info->msg) 
+        {
+                change = tny_folder_change_new (info->self);
+                tny_folder_change_set_check_duplicates (change, TRUE);
+                tny_folder_change_set_received_msg (change, info->msg);
+                notify_folder_observers_about (info->self, change, info->session);
+                g_object_unref (change);
+        }
+
+        if (info->callback) {
+                tny_lockable_lock (info->session->priv->ui_lock);
+                info->callback (info->self, info->cancelled, info->msg, info->err, info->user_data);
+                tny_lockable_unlock (info->session->priv->ui_lock);
+        }
+
+        if (info->msg)
+                g_object_unref (info->msg);
+
+        tny_idle_stopper_stop (info->stopper);
+
+        return FALSE;
+}
+
+
+static void
+tny_camel_folder_find_msg_async_cancelled_destroyer (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (info->self);
+
+        /* thread reference */
+        _tny_camel_folder_unreason (priv);
+        g_object_unref (info->self);
+
+        if (info->err)
+                g_error_free (info->err);
+
+        tny_idle_stopper_destroy (info->stopper);
+        info->stopper = NULL;
+
+        /**/
+
+        camel_object_unref (info->session);
+
+        return;
+}
+
+static gboolean
+tny_camel_folder_find_msg_async_cancelled_callback (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+        if (info->callback) {
+                tny_lockable_lock (info->session->priv->ui_lock);
+                info->callback (info->self, TRUE, NULL, info->err, info->user_data);
+                tny_lockable_unlock (info->session->priv->ui_lock);
+        }
+        return FALSE;
+}
+
+static gpointer 
+tny_camel_folder_find_msg_async_thread (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+
+        info->msg = tny_folder_find_msg (info->self, info->url_string, &info->err);
+
+        info->cancelled = FALSE;
+        if (info->err != NULL) {
+                if (camel_strstrcase (info->err->message, "cancel") != NULL)
+                        info->cancelled = TRUE;
+        }
+
+        /* Free the URL */
+        g_free (info->url_string);
+
+        return NULL;
+}
+
+static void
+tny_camel_folder_find_msg_async (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        TNY_CAMEL_FOLDER_GET_CLASS (self)->find_msg_async(self, url_string, callback, status_callback, user_data);
+        return;
+}
+
+
+static void
+tny_camel_folder_find_msg_async_default (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        FindMsgInfo *info;
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
+        TnyCamelQueue *queue;
+
+        /* Idle info for the callbacks */
+        info = g_slice_new (FindMsgInfo);
+        info->cancelled = FALSE;
+        info->session = TNY_FOLDER_PRIV_GET_SESSION (priv);
+        camel_object_ref (info->session);
+        info->self = self;
+        info->url_string = g_strdup (url_string);
+        info->callback = callback;
+        info->status_callback = status_callback;
+        info->user_data = user_data;
+        info->err = NULL;
+
+        info->stopper = tny_idle_stopper_new();
+
+        /* thread reference */
+        _tny_camel_folder_reason (priv);
+        g_object_ref (info->self);
+
+        if (!TNY_IS_CAMEL_POP_FOLDER (self))
+                queue = TNY_FOLDER_PRIV_GET_MSG_QUEUE (priv);
+        else
+                queue = TNY_FOLDER_PRIV_GET_QUEUE (priv);
+
+        _tny_camel_queue_launch (queue, 
+                tny_camel_folder_find_msg_async_thread, 
+                tny_camel_folder_find_msg_async_callback,
+                tny_camel_folder_find_msg_async_destroyer, 
+                tny_camel_folder_find_msg_async_cancelled_callback,
+                tny_camel_folder_find_msg_async_cancelled_destroyer, 
+                &info->cancelled,
+                info, sizeof (FindMsgInfo), 
+                __FUNCTION__);
+
+        return;
+}
-
-static TnyMsgReceiveStrategy* 
@@ -5887 +6060 @@
-        klass->find_msg= tny_camel_folder_find_msg;
-        klass->get_msg_async= tny_camel_folder_get_msg_async;
+        klass->find_msg_async= tny_camel_folder_find_msg_async;
-        klass->get_id= tny_camel_folder_get_id;
-        klass->get_name= tny_camel_folder_get_name;
@@ -5953 +6127 @@
-        class->find_msg= tny_camel_folder_find_msg_default;
-        class->get_msg_async= tny_camel_folder_get_msg_async_default;
+        class->find_msg_async= tny_camel_folder_find_msg_async_default;
-        class->get_id= tny_camel_folder_get_id_default;
-        class->get_name= tny_camel_folder_get_name_default;

trunk/libtinymail-camel/tny-camel-folder.h

@@ -68 +68 @@
-        TnyMsg* (*find_msg) (TnyFolder *self, const gchar *url_string, GError **err);
-        void (*get_msg_async) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
+        void (*find_msg_async) (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        void (*get_headers) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
-        void (*get_headers_async) (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data);

trunk/libtinymail/tny-folder.c

@@ -1213 +1213 @@
- * </programlisting></informalexample>
- *
+ * Deprecated: 1.0: Use tny_folder_find_msg_async in stead
- * returns: (null-ok) (caller-owns): The message instance or NULL
- * since: 1.0
@@ -1226 +1227 @@
-        g_assert (url_string);
-        g_assert (strlen (url_string) > 0);
-//
+
-        g_assert (TNY_FOLDER_GET_IFACE (self)->find_msg!= NULL);
-#endif
@@ -1285 +1286 @@
-
-        TNY_FOLDER_GET_IFACE (self)->get_msg_async(self, header, callback, status_callback, user_data);
+
+        return;
+}
+
+/**
+ * tny_folder_find_msg_async:
+ * @self: a #TnyFolder
+ * @url_string: the url string
+ * @callback: (null-ok): a #TnyGetMsgCallback or NULL
+ * @status_callback: (null-ok): a #TnyStatusCallback or NULL
+ * @user_data: (null-ok): user data that will be passed to the callbacks
+ *
+ * Get a message in @self identified by @url_string asynchronously.
+ *
+ * Example:
+ * <informalexample><programlisting>
+ * static void 
+ * status_cb (GObject *sender, TnyStatus *status, gpointer user_data)
+ * {
+ *       printf (".");
+ * }
+ * static void
+ * folder_find_msg_cb (TnyFolder *folder, gboolean cancelled, TnyMsg *msg, GError **err, gpointer user_data)
+ * {
+ *       TnyMsgView *message_view = user_data;
+ *       if (!err && msg && !cancelled)
+ *           tny_msg_view_set_msg (message_view, msg);
+ * }
+ * TnyMsgView *message_view = tny_platform_factory_new_msg_view (platfact);
+ * TnyFolder *folder = ...; gchar *url_string = ...;
+ * tny_folder_find_msg_async (folder, msg_url,
+ *          folder_get_msg_cb, status_cb, message_view); 
+ * </programlisting></informalexample>
+ *
+ * since: 1.0
+ * audience: application-developer
+ **/
+void
+tny_folder_find_msg_async (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+#ifdef DBC /* require */
+        g_assert (TNY_IS_FOLDER (self));
+        g_assert (url_string);
+        g_assert (strlen (url_string) > 0);
+        g_assert (strstr (url_string, ":") != NULL);
+        g_assert (TNY_FOLDER_GET_IFACE (self)->get_msg_async!= NULL);
+#endif
+
+        TNY_FOLDER_GET_IFACE (self)->find_msg_async(self, url_string, callback, status_callback, user_data);
-
-        return;

trunk/libtinymail/tny-folder.h

@@ -110 +110 @@
-        TnyMsg* (*find_msg) (TnyFolder *self, const gchar *url_string, GError **err);
-        void (*get_msg_async) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
+        void (*find_msg_async) (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        void (*get_headers) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
-        void (*get_headers_async) (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data);
@@ -148 +149 @@
-void tny_folder_add_msg_async (TnyFolder *self, TnyMsg *msg, TnyFolderCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-void tny_folder_sync_async (TnyFolder *self, gboolean expunge, TnyFolderCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-TnyMsg* tny_folder_find_msg (TnyFolder *self, const gchar *url_string, GError **err);
-void tny_folder_get_msg_async (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
+void tny_folder_find_msg_async (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-void tny_folder_get_headers_async (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-TnyAccount* tny_folder_get_account (TnyFolder *self);
@@ -177 +178 @@
-void tny_folder_remove_msgs (TnyFolder *self, TnyList *headers, GError **err);
-TnyMsg* tny_folder_get_msg (TnyFolder *self, TnyHeader *header, GError **err);
+TnyMsg* tny_folder_find_msg (TnyFolder *self, const gchar *url_string, GError **err);
-void tny_folder_refresh (TnyFolder *self, GError **err);
-void tny_folder_transfer_msgs (TnyFolder *self, TnyList *header_list, TnyFolder *folder_dst, gboolean delete_originals, GError **err);

trunk/libtinymail/tny-merge-folder.c

@@ -634 +634 @@
-
-        thread = g_thread_create (get_msg_async_thread, info, FALSE, NULL);
+
+        return;
+}
+
+
+typedef struct 
+{
+        TnyFolder *self;
+        TnyMsg *msg;
+        gchar *url_string;
+        GError *err;
+        gpointer user_data;
+        guint depth;
+        TnyGetMsgCallback callback;
+        TnyStatusCallback status_callback;
+} FindMsgInfo;
+
+static void
+find_msg_async_destroyer (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+
+        /* thread reference */
+        g_object_unref (info->self);
+
+        if (info->msg)
+                g_object_unref (info->msg);
+
+        if (info->url_string)
+                g_free (info->url_string);
+
+        if (info->err)
+                g_error_free (info->err);
+
+        g_slice_free (FindMsgInfo, info);
+}
+
+static gboolean
+find_msg_async_callback (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+        TnyMergeFolderPriv *priv = TNY_MERGE_FOLDER_GET_PRIVATE (info->self);
+
+        if (info->callback) { 
+                /* TNY TODO: the cancelled field */
+                tny_lockable_lock (priv->ui_locker);
+                info->callback (info->self, FALSE, info->msg, info->err, info->user_data);
+                tny_lockable_unlock (priv->ui_locker);
+        }
+
+        return FALSE;
+}
+
+static gpointer 
+find_msg_async_thread (gpointer thr_user_data)
+{
+        FindMsgInfo *info = (FindMsgInfo *) thr_user_data;
+
+        info->msg = tny_folder_find_msg (info->self, info->url_string, &info->err);
+
+        if (info->err != NULL)
+        {
+                if (info->msg && G_IS_OBJECT (info->msg))
+                        g_object_unref (info->msg);
+                info->msg = NULL;
+        }
+
+        if (info->callback)
+        {
+                if (info->depth > 0)
+                {
+                        g_idle_add_full (G_PRIORITY_HIGH, 
+                                find_msg_async_callback, 
+                                info, find_msg_async_destroyer);
+                } else {
+                        find_msg_async_callback (info);
+                        find_msg_async_destroyer (info);
+                }
+        } else /* thread reference */
+                g_object_unref (info->self);
+
+        g_thread_exit (NULL);
+
+        return NULL;
+
+}
+
+static void
+tny_merge_folder_find_msg_async (TnyFolder *self, const gchar *url_string, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        FindMsgInfo *info;
+        GThread *thread;
+
+        info = g_slice_new (FindMsgInfo);
+        info->self = self;
+        info->url_string = g_strdup (url_string);
+        info->callback = callback;
+        info->status_callback = status_callback;
+        info->user_data = user_data;
+        info->depth = g_main_depth ();
+        info->err = NULL;
+
+        /* thread reference */
+        g_object_ref (info->self);
+
+        thread = g_thread_create (find_msg_async_thread, info, FALSE, NULL);
-
-        return;
@@ -1855 +1961 @@
-        klass->find_msg= tny_merge_folder_find_msg;
-        klass->get_msg_async= tny_merge_folder_get_msg_async;
+        klass->find_msg_async= tny_merge_folder_find_msg_async;
-        klass->get_headers= tny_merge_folder_get_headers;
-        klass->get_headers_async= tny_merge_folder_get_headers_async;