Changeset 2537

Timestamp:

07/31/07 15:27:00

Author:

pvanhoof

Message:

2007-07-31 Philip Van Hoof <pvanhoof@gnome.org>

• • • • Introduction of tny_folder_get_headers_async
        
      • Adaptation of TnyGtkHeaderListModel to use the new API
        

• • • • This was a major API change
        

Files:

• trunk/ChangeLog (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-folder.c (modified) (3 diffs)
• trunk/libtinymail-camel/tny-camel-folder.h (modified) (1 diff)
• trunk/libtinymail/tny-folder.c (modified) (1 diff)
• trunk/libtinymail/tny-folder.h (modified) (2 diffs)
• trunk/libtinymail/tny-merge-folder.c (modified) (2 diffs)
• trunk/libtinymail/tny-shared.h (modified) (1 diff)
• trunk/libtinymailui-gtk/tny-gtk-header-list-model.c (modified) (2 diffs)
• trunk/tests/shared/account-store.c (modified) (1 diff)

trunk/ChangeLog

@@ +1 @@
+2007-07-31  Philip Van Hoof  <pvanhoof@gnome.org>
+
+        * Introduction of tny_folder_get_headers_async
+        * Adaptation of TnyGtkHeaderListModel to use the new API
+
+        * This was a major API change
+
-2007-07-31  Philip Van Hoof  <pvanhoof@gnome.org>
-

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

@@ -1514 +1514 @@
-        tny_list_prepend (headers, (GObject*) header);
-        g_object_unref (header);
+
+        return;
+}
+
+
+
+typedef struct 
+{
+        GError *err;
+        TnyFolder *self;
+        TnyList *headers;
+        gboolean refresh;
+        TnyGetHeadersCallback callback;
+        gpointer user_data;
+        guint depth; 
+        TnySessionCamel *session;
+
+        GCond* condition;
+        gboolean had_callback;
+        GMutex *mutex;
+
+} GetHeadersInfo;
+
+
+static void
+tny_camel_folder_get_headers_async_destroyer (gpointer thr_user_data)
+{
+        GetHeadersInfo *info = thr_user_data;
+
+        /* thread reference */
+        g_object_unref (info->self);
+        g_object_unref (info->headers);
+
+        if (info->err)
+                g_error_free (info->err);
+
+        _tny_session_stop_operation (info->session);
+
+        if (info->condition) {
+                g_mutex_lock (info->mutex);
+                g_cond_broadcast (info->condition);
+                info->had_callback = TRUE;
+                g_mutex_unlock (info->mutex);
+        }
+
+        return;
+}
+
+static gboolean
+tny_camel_folder_get_headers_async_callback (gpointer thr_user_data)
+{
+        GetHeadersInfo *info = thr_user_data;
+        if (info->callback)
+                info->callback (info->self, FALSE, info->headers, &info->err, info->user_data);
+        return FALSE;
+}
+
+static gpointer 
+tny_camel_folder_get_headers_async_thread (gpointer thr_user_data)
+{
+        GetHeadersInfo *info = (GetHeadersInfo*) thr_user_data;
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (info->self);
+
+        GError *err = NULL;
+
+        tny_folder_get_headers (info->self, info->headers, info->refresh, &err);
+
+        if (err != NULL)
+                info->err = g_error_copy ((const GError *) err);
+        else
+                info->err = NULL;
+
+        info->mutex = g_mutex_new ();
+        info->condition = g_cond_new ();
+        info->had_callback = FALSE;
+
+        execute_callback (info->depth, G_PRIORITY_DEFAULT, 
+                tny_camel_folder_get_headers_async_callback, info, 
+                tny_camel_folder_get_headers_async_destroyer);
+
+        /* Wait on the queue for the mainloop callback to be finished */
+        g_mutex_lock (info->mutex);
+        if (!info->had_callback)
+                g_cond_wait (info->condition, info->mutex);
+        g_mutex_unlock (info->mutex);
+
+        g_mutex_free (info->mutex);
+        g_cond_free (info->condition);
+
+        g_slice_free (GetHeadersInfo, info);
+
+        return NULL;
+}
+
+static void
+tny_camel_folder_get_headers_async_cancelled_destroyer (gpointer thr_user_data)
+{
+        GetHeadersInfo *info = thr_user_data;
+        g_error_free (info->err);
+        g_object_unref (info->self);
+        g_object_unref (info->headers);
+        g_slice_free (GetHeadersInfo, info);
+        return;
+}
+
+static gboolean
+tny_camel_folder_get_headers_async_cancelled_callback (gpointer thr_user_data)
+{
+        GetHeadersInfo *info = thr_user_data;
+        if (info->callback)
+                info->callback (info->self, TRUE, info->headers, &info->err, info->user_data);
+        return FALSE;
+}
+
+static void 
+tny_camel_folder_get_headers_async (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        TNY_CAMEL_FOLDER_GET_CLASS (self)->get_headers_async_func (self, headers, refresh, callback, status_callback, user_data);
+        return;
+}
+
+
+static void 
+tny_camel_folder_get_headers_async_default (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        GetHeadersInfo *info;
+        GError *err = NULL;
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
+
+        /* Idle info for the callbacks */
+        info = g_slice_new (GetHeadersInfo);
+        info->session = TNY_FOLDER_PRIV_GET_SESSION (priv);
+        info->self = self;
+        info->headers = headers;
+        info->refresh = refresh;
+        info->callback = callback;
+        info->user_data = user_data;
+        info->depth = g_main_depth ();
+        info->condition = NULL;
+
+        if (!_tny_session_check_operation (TNY_FOLDER_PRIV_GET_SESSION(priv), priv->account, &err, 
+                        TNY_FOLDER_ERROR, TNY_FOLDER_ERROR_REFRESH))
+        {
+                if (callback) {
+                        info->err = g_error_copy (err);
+                        g_object_ref (info->self);
+                        g_object_ref (info->headers);
+
+                        execute_callback (info->depth, G_PRIORITY_DEFAULT,
+                                tny_camel_folder_get_headers_async_cancelled_callback, info, 
+                                tny_camel_folder_get_headers_async_cancelled_destroyer);
+                }
+                g_error_free (err);
+                return;
+        }
+
+        /* thread reference */
+        g_object_ref (info->self);
+        g_object_ref (info->headers);
+
+        _tny_camel_queue_launch (TNY_FOLDER_PRIV_GET_QUEUE (priv), 
+                tny_camel_folder_get_headers_async_thread, info);
-
-        return;
@@ -4670 +4832 @@
-        klass->set_msg_receive_strategy_func = tny_camel_folder_set_msg_receive_strategy;
-        klass->get_headers_func = tny_camel_folder_get_headers;
+        klass->get_headers_async_func = tny_camel_folder_get_headers_async;
-        klass->get_msg_func = tny_camel_folder_get_msg;
-        klass->find_msg_func = tny_camel_folder_find_msg;
@@ -4731 +4894 @@
-        class->set_msg_remove_strategy_func = tny_camel_folder_set_msg_remove_strategy_default;
-        class->get_headers_func = tny_camel_folder_get_headers_default;
+        class->get_headers_async_func = tny_camel_folder_get_headers_async_default;
-        class->get_msg_func = tny_camel_folder_get_msg_default;
-        class->find_msg_func = tny_camel_folder_find_msg_default;

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

@@ -66 +66 @@
-        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
+        void (*get_headers_async_func) (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        const gchar* (*get_name_func) (TnyFolder *self);
-        const gchar* (*get_id_func) (TnyFolder *self);

trunk/libtinymail/tny-folder.c

@@ -1186 +1186 @@
-}
-
+
+/**
+ * tny_folder_get_headers_async:
+ * @self: a TnyFolder object
+ * @headers: A #TnyList instance where the headers will be put
+ * @refresh: whether or not to synchronize with the service first
+ * @callback: the callback that happens when the operation finished
+ * @status_callback: status callback
+ * @user_data: user data
+ * 
+ * Get the list of message header instances that are in @self. Also read
+ * about tny_folder_refresh.
+ *
+ * API warning: it's possible that between the @refresh and @callback, a pointer
+ * to a query object will be placed. This will introduce both an API and ABI 
+ * breakage.
+ **/
+void 
+tny_folder_get_headers_async (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+#ifdef DBC /* require */
+        g_assert (TNY_IS_FOLDER (self));
+        g_assert (headers);
+        g_assert (TNY_IS_LIST (headers));
+        g_assert (TNY_FOLDER_GET_IFACE (self)->get_headers_async_func != NULL);
+#endif
+
+        TNY_FOLDER_GET_IFACE (self)->get_headers_async_func (self, headers, refresh, callback, status_callback, user_data);
+        return;
+}
+
+
-/**
- * tny_folder_get_id:

trunk/libtinymail/tny-folder.h

@@ -101 +101 @@
-        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
+        void (*get_headers_async_func) (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-        const gchar* (*get_name_func) (TnyFolder *self);
-        const gchar* (*get_id_func) (TnyFolder *self);
@@ -139 +140 @@
-void tny_folder_get_msg_async (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, TnyStatusCallback status_callback, gpointer user_data);
-void tny_folder_get_headers (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
+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);
-const gchar* tny_folder_get_id (TnyFolder *self);

trunk/libtinymail/tny-merge-folder.c

@@ -429 +429 @@
-
-        /* thread reference */
-G_OBJECT (info->self)
-G_OBJECT (info->header)
+info->self
+info->header
-
-        thread = g_thread_create (get_msg_async_thread, info, FALSE, NULL);
+
+        return;
+}
+
+
+
+typedef struct 
+{
+        TnyFolder *self;
+        TnyList *headers;
+        TnyRefreshFolderCallback callback;
+        TnyStatusCallback status_callback;
+        gpointer user_data;
+        gboolean cancelled, refresh;
+        guint depth;
+        GError *err;
+} GetHeadersFolderInfo;
+
+
+static void
+get_headers_async_destroyer (gpointer thr_user_data)
+{
+        GetHeadersFolderInfo *info = thr_user_data;
+
+        /* thread reference */
+        g_object_unref (info->self);
+        g_object_unref (info->headers);
+
+        if (info->err)
+                g_error_free (info->err);
+
+        g_slice_free (GetHeadersFolderInfo, thr_user_data);
+
+        return;
+}
+
+static gboolean
+get_headers_async_callback (gpointer thr_user_data)
+{
+        GetHeadersFolderInfo *info = thr_user_data;
+        if (info->callback)
+                info->callback (info->self, info->cancelled, &info->err, info->user_data);
+        return FALSE;
+}
+
+
+static gpointer 
+get_headers_async_thread (gpointer thr_user_data)
+{
+        GetHeadersFolderInfo *info = thr_user_data;
+        TnyFolder *self = info->self;
+        TnyMergeFolderPriv *priv = TNY_MERGE_FOLDER_GET_PRIVATE (self);
+        TnyIterator *iter;
+        GError *err = NULL;
+
+        g_static_rec_mutex_lock (priv->lock);
+
+        info->cancelled = FALSE;
+
+        iter = tny_list_create_iterator (priv->mothers);
+        while (!tny_iterator_is_done (iter))
+        {
+                TnyFolder *cur = TNY_FOLDER (tny_iterator_get_current (iter));
+
+                tny_folder_get_headers (cur, info->headers, info->refresh, &err);
+
+                /* TODO: Handler err */
+
+                /* TODO: Handle progress status callbacks ( info->status_callback )
+                 * you might have to start using refresh_async for that (in a 
+                 * serialized way, else you'd launch a buch of concurrent threads
+                 * and ain't going to be nice, perhaps). */
+
+                g_object_unref (cur);
+                tny_iterator_next (iter);
+        }
+        g_object_unref (iter);
+
+        info->err = NULL;
+
+        g_static_rec_mutex_unlock (priv->lock);
+
+        if (info->callback)
+        {
+                if (info->depth > 0)
+                {
+                        g_idle_add_full (G_PRIORITY_HIGH, 
+                                get_headers_async_callback, 
+                                info, get_headers_async_destroyer);
+                } else {
+                        get_headers_async_callback (info);
+                        get_headers_async_destroyer (info);
+                }
+        } else { /* Thread reference */
+                g_object_unref (info->self);
+                g_object_unref (info->headers);
+        }
+
+        g_thread_exit (NULL);
+
+        return NULL;
+}
+
+
+static void
+tny_merge_folder_get_headers_async (TnyFolder *self, TnyList *headers, gboolean refresh, TnyGetHeadersCallback callback, TnyStatusCallback status_callback, gpointer user_data)
+{
+        GetHeadersFolderInfo *info;
+        GThread *thread;
+
+        info = g_slice_new (GetHeadersFolderInfo);
+        info->err = NULL;
+        info->self = self;
+        info->headers = headers;
+        info->refresh = refresh;
+        info->callback = callback;
+        info->status_callback = status_callback;
+        info->user_data = user_data;
+        info->depth = g_main_depth ();
+
+        /* thread reference */
+        g_object_ref (self);
+        g_object_ref (headers);
+
+        thread = g_thread_create (get_headers_async_thread, info, FALSE, NULL);
-
-        return;
@@ -1309 +1434 @@
-        klass->get_msg_async_func = tny_merge_folder_get_msg_async;
-        klass->get_headers_func = tny_merge_folder_get_headers;
+        klass->get_headers_async_func = tny_merge_folder_get_headers_async;
-        klass->get_name_func = tny_merge_folder_get_name;
-        klass->get_id_func = tny_merge_folder_get_id;

trunk/libtinymail/tny-shared.h

@@ -60 +60 @@
-typedef void (*TnyForgetPassFunc) (TnyAccount *self);
-typedef void (*TnyRefreshFolderCallback) (TnyFolder *self, gboolean cancelled, GError **err, gpointer user_data);
+typedef void (*TnyGetHeadersCallback) (TnyFolder *self, gboolean cancelled, TnyList *headers, GError **err, gpointer user_data);
-typedef void (*TnyGetMsgCallback) (TnyFolder *folder, gboolean cancelled, TnyMsg *msg, GError **err, gpointer user_data);
-typedef void (*TnySyncFolderCallback) (TnyFolder *folder, gboolean cancelled, GError **err, gpointer user_data);

trunk/libtinymailui-gtk/tny-gtk-header-list-model.c

@@ -914 +914 @@
-}
-
+static void
+get_hdrs_callback (TnyFolder *self, gboolean cancelled, TnyList *headers, GError **err, gpointer user_data)
+{
+        return;
+}
+
+static void 
+get_hdrs_status_callback (GObject *self, TnyStatus *status, gpointer user_data)
+{
+        return;
+}
-
-/**
@@ -957 +968 @@
-        /* Get a new list of headers */
-        /* TODO add error handling and reporting here */
- (folder, TNY_LIST (self), refresh
+_async (folder, TNY_LIST (self), refresh, get_hdrs_callback, get_hdrs_status_callback
-
-        iter.stamp = priv->stamp;

trunk/tests/shared/account-store.c

@@ -173 +173 @@
-
-        self->session = tny_session_camel_new (TNY_ACCOUNT_STORE (self));
-        tny_session_camel_set_async_connecting (self->session, FALSE);
-
-        self->force_online = force_online;