Changeset 1737

Timestamp:

03/16/07 15:11:45

Author:

pvanhoof

Message:

APIs added

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-camel/tny-camel-store-account.c (modified) (3 diffs)
• trunk/libtinymail-camel/tny-camel-store-account.h (modified) (1 diff)
• trunk/libtinymail/tny-account-store.c (modified) (7 diffs)
• trunk/libtinymail/tny-folder.c (modified) (2 diffs)
• trunk/libtinymail/tny-folder.h (modified) (2 diffs)
• trunk/libtinymail/tny-list.c (modified) (1 diff)
• trunk/libtinymail/tny-store-account.c (modified) (2 diffs)
• trunk/libtinymail/tny-store-account.h (modified) (2 diffs)

trunk/ChangeLog

@@ -4 +4 @@
-        GPL
-
-
+
+
+
+
+
+
+
+
+
-
-        * libtinymailui/tny-msg-view.c: fixed a typo in a function name

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

@@ -1356 +1356 @@
-}
-
+
+
+
+static TnyMsg*
+tny_camel_folder_find_msg (TnyFolder *self, const gchar *url_string, GError **err)
+{
+        return TNY_CAMEL_FOLDER_GET_CLASS (self)->find_msg_func (self, url_string, err);
+}
+
+static TnyMsg*
+tny_camel_folder_find_msg_default (TnyFolder *self, const gchar *url_string, GError **err)
+{
+        TnyCamelFolderPriv *priv = TNY_CAMEL_FOLDER_GET_PRIVATE (self);
+        TnyMsg *retval = NULL;
+        TnyHeader *hdr;
+        CamelMessageInfo *info;
+        const gchar *uid;
+
+        if (!_tny_session_check_operation (TNY_FOLDER_PRIV_GET_SESSION(priv), err, 
+                        TNY_FOLDER_ERROR, TNY_FOLDER_ERROR_GET_MSG))
+                return;
+
+        if (!priv->receive_strat) {
+                _tny_session_stop_operation (TNY_FOLDER_PRIV_GET_SESSION (priv));
+                return NULL;
+        }
+
+        g_static_rec_mutex_lock (priv->folder_lock);
+
+        if (!priv->folder || !priv->loaded || !CAMEL_IS_FOLDER (priv->folder))
+                if (!load_folder_no_lock (priv))
+                {
+                        g_static_rec_mutex_unlock (priv->folder_lock);
+                        _tny_session_stop_operation (TNY_FOLDER_PRIV_GET_SESSION (priv));
+                        return NULL;
+                }
+
+        uid = strrchr (url_string, '/');
+        if (uid && uid[0] != '/' && strlen (uid) > 1)
+        {
+                uid++;
+                info = camel_message_info_new_uid (NULL, uid);
+                hdr = _tny_camel_header_new ();
+                _tny_camel_header_set_as_memory (TNY_CAMEL_HEADER (hdr), info);
+                retval = tny_msg_receive_strategy_perform_get_msg (priv->receive_strat, self, hdr, err);
+                g_object_unref (G_OBJECT (hdr));
+        } else {
+                g_set_error (err, TNY_FOLDER_ERROR, 
+                                TNY_FOLDER_ERROR_GET_MSG,
+                                "This url string is malformated");
+                retval = NULL;
+        }
+
+        g_static_rec_mutex_unlock (priv->folder_lock);
+
+        _tny_session_stop_operation (TNY_FOLDER_PRIV_GET_SESSION (priv));
+
+        return retval;
+}
-
-static const gchar*
@@ -3086 +3145 @@
-        klass->get_headers_func = tny_camel_folder_get_headers;
-        klass->get_msg_func = tny_camel_folder_get_msg;
+        klass->find_msg_func = tny_camel_folder_find_msg;
-        klass->get_msg_async_func = tny_camel_folder_get_msg_async;
-        klass->get_id_func = tny_camel_folder_get_id;
@@ -3126 +3186 @@
-        klass->remove_observer_func = tny_camel_folder_store_remove_observer;
-
-
-        return;
-}
@@ -3145 +3204 @@
-        class->get_headers_func = tny_camel_folder_get_headers_default;
-        class->get_msg_func = tny_camel_folder_get_msg_default;
+        class->find_msg_func = tny_camel_folder_find_msg_default;
-        class->get_msg_async_func = tny_camel_folder_get_msg_async_default;
-        class->get_id_func = tny_camel_folder_get_id_default;

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

@@ -62 +62 @@
-        void (*set_msg_receive_strategy_func) (TnyFolder *self, TnyMsgReceiveStrategy *st);
-        TnyMsg* (*get_msg_func) (TnyFolder *self, TnyHeader *header, GError **err);
+        TnyMsg* (*find_msg_func) (TnyFolder *self, const gchar *url_string, GError **err);
-        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);

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

@@ -889 +889 @@
-}
-
+static TnyFolder*
+tny_camel_store_account_find_folder (TnyStoreAccount *self, const gchar *url_string, GError **err)
+{
+        return TNY_CAMEL_STORE_ACCOUNT_GET_CLASS (self)->find_folder_func (self, url_string, err);
+}
+
+static TnyFolder*
+tny_camel_store_account_find_folder_default (TnyStoreAccount *self, const gchar *url_string, GError **err)
+{
+        TnyFolder *retval = NULL;
+        TnyCamelAccountPriv *apriv = TNY_CAMEL_ACCOUNT_GET_PRIVATE (self);
+        TnyCamelStoreAccountPriv *priv = TNY_CAMEL_STORE_ACCOUNT_GET_PRIVATE (self);    
+        CamelException ex = CAMEL_EXCEPTION_INITIALISER;    
+        CamelFolderInfo *iter; guint32 flags; CamelStore *store;
+
+        g_assert (CAMEL_IS_SESSION (apriv->session));
+
+        if (!_tny_session_check_operation (apriv->session, err, 
+                        TNY_FOLDER_STORE_ERROR, TNY_FOLDER_STORE_ERROR_GET_FOLDERS))
+                return;
+
+        if (apriv->service == NULL || !CAMEL_IS_SERVICE (apriv->service))
+        {
+                g_set_error (err, TNY_FOLDER_STORE_ERROR, 
+                                TNY_FOLDER_STORE_ERROR_GET_FOLDERS,
+                                "Account not ready for this operation (%s)",
+                                camel_exception_get_description (apriv->ex));
+                _tny_session_stop_operation (apriv->session);
+                return;
+        }
+
+        store = CAMEL_STORE (apriv->service);
+
+        if (camel_exception_is_set (&ex))
+        {
+                g_set_error (err, TNY_FOLDER_STORE_ERROR, 
+                        TNY_FOLDER_STORE_ERROR_GET_FOLDERS,
+                        camel_exception_get_description (&ex));
+                camel_exception_clear (&ex);
+
+                if (store && CAMEL_IS_OBJECT (store))
+                        camel_object_unref (CAMEL_OBJECT (store));
+                _tny_session_stop_operation (apriv->session);
+                return;
+        }
+
+        g_assert (CAMEL_IS_STORE (store));
+
+        flags = CAMEL_STORE_FOLDER_INFO_FAST | CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL;
+
+        if (!camel_session_is_online ((CamelSession*) apriv->session))
+                flags |= CAMEL_STORE_FOLDER_INFO_SUBSCRIBED;
+
+        iter = camel_store_get_folder_info (store, url_string, flags, &ex);
+
+        if (camel_exception_is_set (&ex))
+        {
+                g_set_error (err, TNY_FOLDER_STORE_ERROR, 
+                        TNY_FOLDER_STORE_ERROR_GET_FOLDERS,
+                        camel_exception_get_description (&ex));
+                camel_exception_clear (&ex);
+
+                if (CAMEL_IS_OBJECT (store))
+                {
+                        if (iter && CAMEL_IS_STORE (store))
+                                camel_store_free_folder_info (store, iter);
+                        camel_object_unref (CAMEL_OBJECT (store));
+                }
+                _tny_session_stop_operation (apriv->session);
+                return;
+        }
+
+        if (iter)
+        {
+                gboolean was_new = FALSE;
+
+                TnyCamelFolder *folder = (TnyCamelFolder *) tny_camel_store_account_factor_folder (
+                        TNY_CAMEL_STORE_ACCOUNT (self), 
+                        iter->full_name, &was_new);
+
+                if (was_new && folder != NULL)
+                        _tny_camel_folder_set_folder_info (TNY_FOLDER_STORE (self), folder, iter);
+
+                retval = (TnyFolder *) folder;
+        }
+
+        _tny_session_stop_operation (apriv->session);
+
+        return retval;
+}
-
-static void
@@ -912 +1002 @@
-        klass->subscribe_func = tny_camel_store_account_subscribe;
-        klass->unsubscribe_func = tny_camel_store_account_unsubscribe;
+        klass->find_folder_func = tny_camel_store_account_find_folder;
-
-        return;
@@ -936 +1027 @@
-        class->add_observer_func = tny_camel_store_account_add_observer_default;
-        class->remove_observer_func = tny_camel_store_account_remove_observer_default;
+        class->find_folder_func = tny_camel_store_account_find_folder_default;
-
-        /* Protected default implementation */

trunk/libtinymail-camel/tny-camel-store-account.h

@@ -57 +57 @@
-        void (*remove_observer_func) (TnyFolderStore *self, TnyFolderStoreObserver *observer);
-
+        TnyFolder * (*find_folder_func) (TnyStoreAccount *self, const gchar *url_string, GError **err);
+
-        /* protected virtual methods*/
-        TnyFolder * (*factor_folder_func) (TnyCamelStoreAccount *self, const gchar *full_name, gboolean *was_new);

trunk/libtinymail/tny-account-store.c

@@ -39 +39 @@
-/**
- * tny_account_store_find_account:
-Transport
+Store
- * @url_string: the url-string of the account to find
- *
@@ -48 +48 @@
- * Implementors: when implementing a platform-specific library, you must
- * implement this method. Let it return the account that corresponds to
-
+
+
- *
- * This method can be used to resolve url-strings to #TnyAccount instances.
@@ -81 +82 @@
-/**
- * tny_account_store_alert:
-Transport
+Store
- * @type: the message type (severity)
- * @prompt: the prompt
@@ -150 +151 @@
-/**
- * tny_account_store_get_device:
-Transport
+Store
- *
- * This method returns a #TnyDevice instance. You must unreference the return
@@ -184 +185 @@
-/**
- * tny_account_store_get_cache_dir:
-Transport
+Store
- * 
- * Get the local path that will be used for storing the disk cache
@@ -222 +223 @@
-/**
- * tny_account_store_get_accounts:
-Transport
+Store
- * @list: a #TnyList instance that will be filled with #TnyAccount instances
- * @types: a #TnyGetAccountsRequestType that describes which account types are needed
@@ -339 +340 @@
-/**
- * tny_account_store_add_transport_account:
-Transport
+Store
- * @account: the account to add
- * 

trunk/libtinymail/tny-folder.c

@@ -795 +795 @@
- * @err: a #GError object or NULL
- * 
-You must unreference the
-
+If not NULL, you must 
+unreference the 
- * 
- * Example:
@@ -834 +834 @@
-
-
+
+/**
+ * tny_folder_find_msg:
+ * @self: a #TnyFolder object
+ * @url_string: the url string
+ * @err: a #GError object or NULL
+ * 
+ * Get a message in @self identified by @url_string. If not NULL, you must 
+ * unreference the return value after use.
+ * 
+ * Example:
+ * <informalexample><programlisting>
+ * TnyMsgView *message_view = tny_platform_factory_new_msg_view (platfact);
+ * TnyFolder *folder = ...
+ * TnyMsg *message = tny_folder_get_msg (folder, "imap://account/INBOX/100", NULL);
+ * tny_msg_view_set_msg (message_view, message);
+ * g_object_unref (G_OBJECT (message));
+ * </programlisting></informalexample>
+ *
+ * Return value: The message instance or NULL on failure
+ *
+ **/
+TnyMsg*
+tny_folder_find_msg (TnyFolder *self, const gchar *url_string, GError **err)
+{
+        TnyMsg *retval;
+
+#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)->find_msg_func != NULL);
+#endif
+
+        retval = TNY_FOLDER_GET_IFACE (self)->find_msg_func (self, url_string, err);
+
+#ifdef DBC /* ensure */
+        if (retval)
+                g_assert (TNY_IS_MSG (retval));
+#endif
+
+        return retval;
+}
-
-

trunk/libtinymail/tny-folder.h

@@ -93 +93 @@
-        void (*set_msg_receive_strategy_func) (TnyFolder *self, TnyMsgReceiveStrategy *st);
-        TnyMsg* (*get_msg_func) (TnyFolder *self, TnyHeader *header, GError **err);
+        TnyMsg* (*find_msg_func) (TnyFolder *self, const gchar *url_string, GError **err);
-        void (*get_msg_async_func) (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data);
-        void (*get_headers_func) (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);
@@ -128 +129 @@
-void tny_folder_sync (TnyFolder *self, gboolean expunge, 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_get_msg_async (TnyFolder *self, TnyHeader *header, TnyGetMsgCallback callback, gpointer user_data);
-void tny_folder_get_headers (TnyFolder *self, TnyList *headers, gboolean refresh, GError **err);

trunk/libtinymail/tny-list.c

@@ -134 +134 @@
-#endif
-
-
+ 
-
-#ifdef DBC /* ensure */

trunk/libtinymail/tny-store-account.c

@@ -20 +20 @@
-#include <config.h>
-
+#ifdef DBC
+#include <string.h>
+#endif
+
-#include <tny-store-account.h>
-#include <tny-folder-store.h>
@@ -25 +29 @@
-
-guint tny_store_account_signals [TNY_STORE_ACCOUNT_LAST_SIGNAL];
+
+/**
+ * tny_store_account_find_folder:
+ * @self: a #TnyStoreAccount object
+ * @url_string: the url-string of the folder to find
+ *
+ * Try to find the folder in @self that corresponds to @url_string. If this 
+ * method does not return NULL, the returned value is the found folder and
+ * must be unreferenced after use.
+ *
+ * Implementors: when implementing a #TnyStoreAccount, you must implement
+ * this method. Let it return the folder that corresponds to @url_string or 
+ * let it return NULL.
+ *
+ * This method can be used to resolve url-strings to #TnyAccount instances.
+ *
+ * Return value: the found account or NULL.
+ **/
+TnyFolder* 
+tny_store_account_find_folder (TnyStoreAccount *self, const gchar *url_string, GError **err)
+{
+        TnyFolder *retval;
+
+#ifdef DBC /* require */
+        g_assert (TNY_IS_STORE_ACCOUNT (self));
+        g_assert (url_string);
+        g_assert (strlen (url_string) > 0);
+        g_assert (strstr (url_string, "://"));
+        g_assert (TNY_STORE_ACCOUNT_GET_IFACE (self)->find_folder_func != NULL);
+#endif
+
+        retval = TNY_STORE_ACCOUNT_GET_IFACE (self)->find_folder_func (self, url_string, err);
+
+#ifdef DBC /* ensure */
+        if (retval)
+                g_assert (TNY_IS_FOLDER (retval));
+#endif
+
+        return retval;
+}
-
-/**

trunk/libtinymail/tny-store-account.h

@@ -59 +59 @@
-        void (*subscribe_func) (TnyStoreAccount *self, TnyFolder *folder);
-        void (*unsubscribe_func) (TnyStoreAccount *self, TnyFolder *folder);
+        TnyFolder * (*find_folder_func) (TnyStoreAccount *self, const gchar *url_string, GError **err);
-};
-
@@ -65 +66 @@
-void tny_store_account_subscribe (TnyStoreAccount *self, TnyFolder *folder);
-void tny_store_account_unsubscribe (TnyStoreAccount *self, TnyFolder *folder);
+TnyFolder* tny_store_account_find_folder (TnyStoreAccount *self, const gchar *url_string, GError **err);
-
-