Changeset 1092

Timestamp:

11/06/06 15:19:14

Author:

pvanhoof

Message:

Introduction of the TnyMsgRemoveStrategy?

Files:

• trunk (modified) (1 prop)
• trunk/.svnignore (modified) (1 diff)
• trunk/ChangeLog (modified) (1 diff)
• trunk/bindings/python/Makefile.am (modified) (1 diff)
• trunk/libtinymail-camel/Makefile.am (modified) (2 diffs)
• trunk/libtinymail-camel/tny-camel-folder-priv.h (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-folder.c (modified) (59 diffs)
• trunk/libtinymail-camel/tny-camel-folder.h (modified) (1 diff)
• trunk/libtinymail-camel/tny-camel-msg-remove-strategy.c (added)
• trunk/libtinymail-camel/tny-camel-msg-remove-strategy.h (added)
• trunk/libtinymail-test/tny-folder-test.c (modified) (1 diff)
• trunk/libtinymail/Makefile.am (modified) (2 diffs)
• trunk/libtinymail/tny-folder.c (modified) (8 diffs)
• trunk/libtinymail/tny-folder.h (modified) (4 diffs)
• trunk/libtinymail/tny-msg-remove-strategy.c (added)
• trunk/libtinymail/tny-msg-remove-strategy.h (added)
• trunk/libtinymail/tny-shared.h (modified) (1 diff)
• trunk/tinymail/tny-demoui-summary-view.c (modified) (3 diffs)

trunk/.svnignore

@@ -2 +2 @@
-tags
-py*
-anjuta
+*
-config.h
-stamp-h1

trunk/ChangeLog

@@ +1 @@
+2006-11-06  Philip van Hoof <pvanhoof@gnome.org>
+
+        * Introduction of the TnyMsgRemoveStrategy, which makes it more
+        flexible to define how tinymail should remove messages (as this might
+        be specific per device). Although this means a major API change, not a
+        lot external API has changed. A default remove strategy is used for
+        each folder and is implemented as TnyCamelMsgRemoveStrategy. This
+        is an overwritable property.
+
+        * This was a major API change
+
-2006-11-06  Sergio Villar Senin <svillar@igalia.com>
-

trunk/bindings/python/Makefile.am

@@ -88 +88 @@
-        $(top_srcdir)/libtinymail/tny-store-account.h \
-        $(top_srcdir)/libtinymail/tny-stream.h \
-
+
+
-
-tinymail.defs: $(tinymail_h_files) tinymail.defs.extra $(top_srcdir)/bindings/python/filter.py 

trunk/libtinymail-camel/Makefile.am

@@ -10 +10 @@
-libtinymail_camel_1_0_headers =                 \
-        tny-camel-mime-part.h                   \
+        tny-camel-msg-remove-strategy.h         \
-        tny-camel-header.h                      \
-        tny-camel-msg.h                         \
@@ -29 +30 @@
-libtinymail_camel_1_0_la_SOURCES =              \
-        tny-session-camel-priv.h                \
+        tny-camel-msg-remove-strategy.c         \
-        tny-camel-common.c                      \
-        tny-camel-common-priv.h                 \

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

@@ -46 +46 @@
-        TnyFolderType cached_folder_type;
-        GList *possible_headers;
-
+
+
-};
-

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

@@ -44 +44 @@
-#include <errno.h>
-
+#include <tny-camel-msg-remove-strategy.h>
-#include <tny-session-camel.h>
-#include "tny-camel-account-priv.h"
@@ -64 +65 @@
-        
-        When we know a new message got added to this folder 
-
-        
-        
-        
-        
+
+       
+       
+       
+       
-}
-*/
@@ -75 +76 @@
-pos_header_check (gpointer data, gpointer udata)
-{
-
-
-
+
+
-           this might imply that a header is still referenced and therefore not
-           destroyed) .. I don't know, it's definitely a bug. Also check #1 on 
-           the trac's tickets. */
-
+
-        if (data)
-        {
@@ -93 +93 @@
-{
-
-    
+
-        {
-                g_mutex_lock (priv->poshdr_lock);
@@ -103 +103 @@
-                priv->possible_headers = NULL;
-                g_mutex_unlock (priv->poshdr_lock);
-
+
-                if (CAMEL_IS_OBJECT (priv->folder))
-                {
-                        g_critical ("Killing invalid CamelObject (should be a Camelfolder) at 0x%x\n", priv->folder);
-                    
-                        while (((CamelObject*)priv->folder)->ref_count >= 1)
-                                camel_object_unref (CAMEL_OBJECT (priv->folder));
-                } else
-    
-
-
+
+
+
-        if (G_LIKELY (priv->folder) && CAMEL_IS_FOLDER (priv->folder))
-        {
-    
+
-                if (((CamelObject*)priv->folder)->ref_count)
-                        if (priv->folder_changed_id != 0)
-                                camel_object_remove_event (priv->folder, priv->folder_changed_id);
-                */
-
+
-                g_mutex_lock (priv->poshdr_lock);
-                if (priv->possible_headers) 
@@ -130 +129 @@
-                priv->possible_headers = NULL;
-                g_mutex_unlock (priv->poshdr_lock);
-
+
-                while (((CamelObject*)priv->folder)->ref_count >= 1)
-                        camel_object_unref (CAMEL_OBJECT (priv->folder));
@@ -136 +135 @@
-        }
-
-    
+
-        priv->cached_length = 0;
-        priv->cached_folder_type = TNY_FOLDER_TYPE_UNKNOWN;
@@ -158 +157 @@
-        if (priv->folder && !CAMEL_IS_FOLDER (priv->folder))
-                unload_folder_no_lock (priv, FALSE);
-
+
-        if (!priv->folder && !priv->loaded && priv->folder_name)
-        {
@@ -164 +163 @@
-                CamelStore *store = (CamelStore*) _tny_camel_account_get_service 
-                        (TNY_CAMEL_ACCOUNT (priv->account));
-
+
-                g_mutex_lock (priv->poshdr_lock);
-                if (priv->possible_headers)
@@ -173 +172 @@
-                priv->possible_headers = NULL;
-                g_mutex_unlock (priv->poshdr_lock);
-
+
-                priv->folder = camel_store_get_folder 
-                        (store, priv->folder_name, 0, &ex);
@@ -182 +181 @@
-                                while (((CamelObject*)priv->folder)->ref_count >= 1)
-                                        camel_object_unref (CAMEL_OBJECT (priv->folder));
-
+
-                        priv->folder = NULL;
-                        priv->loaded = FALSE;
-                        return FALSE;
-                }
-
-           
+
+
-
-                /* priv->folder_changed_id = camel_object_hook_event (priv->folder, 
@@ -211 +210 @@
-{
-        gboolean retval;
-
+
-        g_mutex_lock (priv->folder_lock);
-        retval = load_folder_no_lock (priv);
@@ -221 +220 @@
-
-static void 
-
-
-
-
+
+
+
+
+
+
-
-        g_mutex_lock (priv->folder_lock);
@@ -234 +235 @@
-                        return;
-                }
-
-
-
+
+
-
-        g_mutex_unlock (priv->folder_lock);
@@ -257 +257 @@
-                        return;
-                }
-
+
-        camel_folder_sync (priv->folder, TRUE, &ex);
-
@@ -275 +275 @@
-                if (!load_folder_no_lock (priv))
-                        return NULL;
-
+
-        retval = priv->folder;
-
@@ -420 +420 @@
-        gpointer user_data;
-        gboolean cancelled;
-    
+
-} RefreshFolderInfo;
-
@@ -519 +519 @@
-                destroy_progress_idle (info);
-        }
-
+
-        return;
-}
@@ -537 +537 @@
-
-        g_mutex_lock (priv->folder_lock);
-
+
-        if (!load_folder_no_lock (priv))
-        {
@@ -546 +546 @@
-                return NULL;
-        }
-
+
-        info->cancelled = FALSE;
-        str = g_strdup_printf (_("Reading folder `%s'"), priv->folder->full_name);
@@ -553 +553 @@
-        g_free (str);
-        camel_folder_refresh_info (priv->folder, ex);
-       
+
-
-        if (G_LIKELY (priv->folder) && CAMEL_IS_FOLDER (priv->folder) && G_LIKELY (priv->has_summary_cap))
@@ -563 +563 @@
-        g_mutex_unlock (priv->folder_lock);
-
-      
+
-        g_object_unref (G_OBJECT (self));
-
@@ -581 +581 @@
-                }
-        }
-
+
-        g_thread_exit (NULL);
-
@@ -592 +592 @@
-        RefreshFolderInfo *info = g_new0 (RefreshFolderInfo, 1);
-        GThread *thread;
-
+
-        info->self = self;
-        info->callback = callback;
@@ -598 +598 @@
-        info->user_data = user_data;
-        info->depth = g_main_depth ();
-
+
-        /* thread reference */
-        g_object_ref (G_OBJECT (self));
@@ -624 +624 @@
-                return;
-        }
-
+
-        _tny_camel_account_start_camel_operation (TNY_CAMEL_ACCOUNT (priv->account), 
-                NULL, NULL, NULL);
@@ -630 +630 @@
-        _tny_camel_account_stop_camel_operation (TNY_CAMEL_ACCOUNT (priv->account));
-
-    
+
-        if (G_LIKELY (priv->folder) && CAMEL_IS_FOLDER (priv->folder) && G_LIKELY (priv->has_summary_cap))
-                priv->unread_length = (guint)camel_folder_get_unread_message_count (priv->folder);
@@ -656 +656 @@
-        }
-
-    
+
-
-        ptr = g_new (FldAndPriv, 1);
@@ -666 +666 @@
-        {
-                camel_folder_refresh_info (priv->folder, &ex);
-        
+       
-                if (G_LIKELY (priv->folder) && CAMEL_IS_FOLDER (priv->folder) && G_LIKELY (priv->has_summary_cap))
-                        priv->unread_length = (guint)camel_folder_get_unread_message_count (priv->folder);
-        }
-    
-        priv->cached_length = 0;
-
-    
+
-                uids = camel_folder_get_uids (priv->folder);
-
+
-        /* TODO: remove this warning, as it's not really strange. But needed for debugging aid
-           for ticket #1 on the trac. So if we fix this bug, remove this. */
-
-    
+
+
-                g_ptr_array_foreach (uids, add_message_with_uid, ptr);
-    
-        g_free (ptr);
-
-        if (uids)
-                camel_folder_free_uids (priv->folder, uids); 
-
+
-        g_object_unref (G_OBJECT (headers));
-        g_mutex_unlock (priv->folder_lock);
@@ -695 +693 @@
-
-static TnyMsg*
-essage
+sg
-{
-        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
-        TnyMsg *message = NULL;
-    
+
-        const gchar *id;
-        CamelException *ex = camel_exception_new ();
-
+
-        g_mutex_lock (priv->folder_lock);
-
-        id = tny_header_get_uid (TNY_HEADER (header));
-
+
-        if (!load_folder_no_lock (priv))
-        {
@@ -720 +718 @@
-        if (camel_exception_get_id (ex) == CAMEL_EXCEPTION_NONE)
-        {
-tny_camel_header_new (
+TNY_CAMEL_HEADER (tny_camel_header_new ()
-
-                /* I don't reuse the header because that would keep a reference
@@ -761 +759 @@
-                if (!load_folder (priv))
-                        return NULL;
-            
-                name = camel_folder_get_name (priv->folder);
-        } else
@@ -883 +880 @@
-{
-        TnyCamelFolder *self = g_object_new (TNY_TYPE_CAMEL_FOLDER, NULL);
-
+
-        tny_camel_folder_set_folder (self, camel_folder);
-
@@ -916 +913 @@
-        g_mutex_lock (priv->folder_lock);
-
-    
+
-        {
-                TnyCamelStoreAccountPriv *apriv = TNY_CAMEL_STORE_ACCOUNT_GET_PRIVATE (priv->account);
-                apriv->managed_folders = g_list_remove (apriv->managed_folders, self);
-        }
-
+
-        if (!priv->iter_parented && priv->iter)
-        {
-    
+
-                camel_store_free_folder_info (store, priv->iter);
-        }
-
+
-        unload_folder_no_lock (priv, TRUE);
-
@@ -940 +937 @@
-        priv->cached_name = NULL;
-
+        if (G_LIKELY (priv->remove_strat))
+                g_object_unref (G_OBJECT (priv->remove_strat));
+        priv->remove_strat = NULL;
-
-        g_mutex_unlock (priv->folder_lock);
@@ -948 +948 @@
-        g_mutex_free (priv->poshdr_lock);
-        priv->poshdr_lock = NULL;
-
+
-        if (priv->folder_name)
-                g_free (priv->folder_name);
-
+
-        (*parent_class->finalize) (object);
-
@@ -971 +971 @@
-void 
-_tny_camel_folder_check_uncache (TnyCamelFolder *self, TnyCamelFolderPriv *priv)
-    
+
-        if (priv->headers_managed == 0)
-                tny_camel_folder_uncache (self);
@@ -977 +977 @@
-
-
+static TnyMsgRemoveStrategy* 
+tny_camel_folder_get_msg_remove_strategy (TnyFolder *self)
+{
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
+
+        return TNY_MSG_REMOVE_STRATEGY (g_object_ref (G_OBJECT (priv->remove_strat)));
+}
+
+static void 
+tny_camel_folder_set_msg_remove_strategy (TnyFolder *self, TnyMsgRemoveStrategy *st)
+{
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
+
+        if (priv->remove_strat)
+                g_object_unref (G_OBJECT (priv->remove_strat));
+
+        priv->remove_strat = TNY_MSG_REMOVE_STRATEGY (g_object_ref (G_OBJECT (st)));
+
+        return;
+}
+
+
-static void
-tny_folder_init (gpointer g, gpointer iface_data)
@@ -982 +1004 @@
-        TnyFolderIface *klass = (TnyFolderIface *)g;
-
+        klass->get_msg_remove_strategy_func = tny_camel_folder_get_msg_remove_strategy;
+        klass->set_msg_remove_strategy_func = tny_camel_folder_set_msg_remove_strategy;
-        klass->get_headers_func = tny_camel_folder_get_headers;
-essage_func = tny_camel_folder_get_message
+sg_func = tny_camel_folder_get_msg
-        klass->get_id_func = tny_camel_folder_get_id;
-        klass->set_name_func = tny_camel_folder_set_name;
@@ -994 +1018 @@
-        klass->refresh_async_func = tny_camel_folder_refresh_async;
-        klass->refresh_func = tny_camel_folder_refresh;
-essage_func = tny_camel_folder_remove_message
+sg_func = tny_camel_folder_remove_msg
-        klass->expunge_func = tny_camel_folder_expunge;
-
@@ -1015 +1039 @@
-        TnyCamelFolder *cfol = TNY_CAMEL_FOLDER (folder);
-        TnyCamelFolderPriv *cpriv = TNY_CAMEL_FOLDER_GET_PRIVATE (cfol);
-    
+
-        CamelException ex = CAMEL_EXCEPTION_INITIALISER;    
-
-       
+
-                return;
-
@@ -1025 +1049 @@
-        parlen = strlen (folname);
-
- 
+
-           /INBOX/test/test */
-
-    
+
+
-        {
-                gchar *ccfoln = cfolname + parlen;
@@ -1065 +1089 @@
-
-        folname = priv->folder_name;
-    
+
-        info = camel_store_create_folder (store, priv->folder_name, name, &ex);
-
+
-        _tny_camel_folder_set_id (TNY_CAMEL_FOLDER (folder), info->full_name);
-    
+
-
-        /* TODO: Error handling using 'ex' */
-
-    
+
-}
-
@@ -1080 +1104 @@
-_tny_camel_folder_set_folder_type (TnyCamelFolder *folder, CamelFolderInfo *folder_info)
-{
-    
+
-
-        if (!folder_info)
@@ -1113 +1137 @@
-{
-        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (folder);
-
+
-        priv->iter = iter;
-    
-
+
+
-        return;
-}
@@ -1132 +1156 @@
-        TnyCamelStoreAccountPriv *apriv = TNY_CAMEL_STORE_ACCOUNT_GET_PRIVATE (priv->account);
-        CamelFolderInfo *iter;
-
-
-        if (!priv->folder_name)
@@ -1144 +1167 @@
-                priv->iter_parented = FALSE;
-        } 
-
+
-        iter = priv->iter;
-   
-    
-                      
+
+
+
-          iter = iter->child;
-                
-          while (iter)
-  
+
-                if (_tny_folder_store_query_passes (query, iter))
-                {
@@ -1170 +1192 @@
-
-                        tny_list_prepend (list, G_OBJECT (folder));
-          
+
-                iter = iter->next;
-          }
-        }
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-} GetFoldersInfo;
-
@@ -1193 +1216 @@
-{
-        GetFoldersInfo *info = thr_user_data;
-
+
-        /* gidle reference */
-        g_object_unref (G_OBJECT (info->self));
@@ -1218 +1241 @@
-{
-        GetFoldersInfo *info = (GetFoldersInfo*) thr_user_data;
-
+
-        tny_folder_store_get_folders (TNY_FOLDER_STORE (info->self),
-                info->list, info->query);
-
+
-        if (info->query)
-                g_object_unref (G_OBJECT (info->query));
-
-    
+
-        g_object_unref (G_OBJECT (info->self));
-        g_object_unref (G_OBJECT (info->list));
-
+
-        if (info->callback)
-        {
@@ -1235 +1258 @@
-                g_object_ref (G_OBJECT (info->list));
-
-    
+
-                {
-                        g_idle_add_full (G_PRIORITY_HIGH, 
@@ -1246 +1269 @@
-        }
-
-
-        g_thread_exit (NULL);
-
+
-        return NULL;
-}
@@ -1255 +1277 @@
-tny_camel_folder_get_folders_async (TnyFolderStore *self, TnyList *list, TnyGetFoldersCallback callback, TnyFolderStoreQuery *query, gpointer user_data)
-{
-    
+
-}
-
@@ -1265 +1287 @@
-
-        info->self = self;
-    
+
-        info->callback = callback;
-        info->user_data = user_data;
-        info->query = query;
-    
-
+
+
-        /* thread reference */
-        g_object_ref (G_OBJECT (info->self));
@@ -1276 +1298 @@
-        if (info->query)
-                g_object_ref (G_OBJECT (info->query));
-
+
-        thread = g_thread_create (tny_camel_folder_get_folders_async_thread,
-                        info, FALSE, NULL);    
@@ -1293 +1315 @@
-        klass->get_folders_func = tny_camel_folder_get_folders;
-        klass->get_folders_async_func = tny_camel_folder_get_folders_async;
-
-    
+
+
-}
-
@@ -1306 +1328 @@
-        object_class->finalize = tny_camel_folder_finalize;
-
-    
+
-        class->get_folders_func = tny_camel_folder_get_folders_default;
-        class->create_folder_func = tny_camel_folder_create_folder_default;
-        class->remove_folder_func = tny_camel_folder_remove_folder_default;
-
+
-        g_type_class_add_private (object_class, sizeof (TnyCamelFolderPriv));
-
@@ -1324 +1346 @@
-        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
-
-    
+
-        priv->iter_parented = FALSE;
-        priv->headers_managed = 0;
@@ -1334 +1356 @@
-        priv->cached_name = NULL;
-        priv->cached_folder_type = TNY_FOLDER_TYPE_UNKNOWN;
-
+
+
+
-        return;
-}

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

@@ -49 +49 @@
-{
-        GObjectClass parent;
-
-    
+
+
-        void (*get_folders_async_func) (TnyFolderStore *self, TnyList *list, TnyGetFoldersCallback callback, TnyFolderStoreQuery *query, gpointer user_data);
-        void (*get_folders_func) (TnyFolderStore *self, TnyList *list, TnyFolderStoreQuery *query);

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

@@ -148 +148 @@
-tny_folder_test_remove_message (void)
-{
-    
+
-        gint orig_length = 0, test_len = 0, new_len = 0, headers_len = 0;
-        TnyIterator *iter;
-    
-
-    
+
+
+
-        {
-                GUNIT_WARNING ("Test cannot continue (are you online?)");
-    
+
-        }
-
-    
+
+
-        tny_folder_refresh (iface);
-        
-        tny_folder_get_headers (iface, headers, FALSE);
-        orig_length = tny_list_get_length (headers);
-        
-
+       
+
-        str = g_strdup_printf ("I received %d headers, the folder tells me it has %d messages\n", orig_length, test_len);
-        gunit_fail_unless (orig_length == test_len, str);
-        g_free (str);
-
-    
-    
-    
-
-    
-       tny_folder_remove_message
-    
-
-    
-
-
-    
-    
+
+
+
+
+
+
+       tny_folder_remove_msg
+
+
+
+
+
+
+
-        gunit_fail_unless (new_len == orig_length, str);
-        g_free (str);
-
-    
-    
+
+
+
-        headers_len = tny_list_get_length (headers);
-        g_object_unref (G_OBJECT (headers));
-
-       
+
+
-        gunit_fail_unless (new_len == orig_length, str);
-        g_free (str);
-
-    
-    
-
-
-        
-    
+
+
+
+
+
+       
+
-        gunit_fail_unless (new_len == orig_length-1, str);
-        g_free (str);
-
-    
-    
+
+
+
-        headers_len = tny_list_get_length (headers);
-        g_object_unref (G_OBJECT (headers));
-
-       
+
+
-        gunit_fail_unless (new_len == orig_length-1, str);
-        g_free (str);
-
+
-}
-

trunk/libtinymail/Makefile.am

@@ -20 +20 @@
-        tny-simple-list.h \
-        tny-folder-store.h \
-
+
+
-
-libtinymail_1_0_la_SOURCES = \
@@ -42 +43 @@
-        tny-simple-list-iterator.c \
-        tny-folder-store.c \
-
+
+
-
-libtinymail_1_0_la_LIBADD = $(LIBTINYMAIL_LIBS)

trunk/libtinymail/tny-folder.c

@@ -26 +26 @@
-guint tny_folder_signals [TNY_FOLDER_LAST_SIGNAL];
-
+
+/**
+ * tny_folder_get_msg_remove_strategy:
+ * @self: a TnyFolder object
+ *
+ * Get the strategy for removing a message. The return value of this method
+ * must be unreferenced after use.
+ * 
+ * Return value: the strategy for removing a message
+ **/
+TnyMsgRemoveStrategy* 
+tny_folder_get_msg_remove_strategy (TnyFolder *self)
+{
+#ifdef DEBUG
+        if (!TNY_FOLDER_GET_IFACE (self)->get_msg_remove_strategy_func)
+                g_critical ("You must implement tny_folder_get_msg_remove_strategy\n");
+#endif
+        return TNY_FOLDER_GET_IFACE (self)->get_msg_remove_strategy_func (self);
+}
+
+/**
+ * tny_folder_set_msg_remove_strategy:
+ * @self: a TnyFolder object
+ * @st: a #TnyMsgRemoveStrategy object
+ *
+ * Set the strategy for removing a message
+ * 
+ **/
+void 
+tny_folder_set_msg_remove_strategy (TnyFolder *self, TnyMsgRemoveStrategy *st)
+{
+#ifdef DEBUG
+        if (!TNY_FOLDER_GET_IFACE (self)->set_msg_remove_strategy_func)
+                g_critical ("You must implement tny_folder_set_msg_remove_strategy\n");
+#endif
+        TNY_FOLDER_GET_IFACE (self)->set_msg_remove_strategy_func (self, st);
+        return;
+}
+
-/**
- * tny_folder_expunge:
@@ -37 +76 @@
- * TnyHeader *header = ...
- * TnyFolder *folder = tny_header_ge