diff options
Diffstat (limited to 'camel/camel-store.c')
-rw-r--r-- | camel/camel-store.c | 1150 |
1 files changed, 0 insertions, 1150 deletions
diff --git a/camel/camel-store.c b/camel/camel-store.c deleted file mode 100644 index ab3d667fde..0000000000 --- a/camel/camel-store.c +++ /dev/null @@ -1,1150 +0,0 @@ -/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ -/* camel-store.c : Abstract class for an email store */ - -/* - * Authors: - * Bertrand Guiheneuf <bertrand@helixcode.com> - * Dan Winship <danw@ximian.com> - * - * Copyright 1999, 2000 Ximian, Inc. (www.ximian.com) - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of version 2 of the GNU General Public - * License as published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - * USA - */ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include <sys/stat.h> -#include <sys/types.h> -#include <string.h> - -#include "camel-session.h" -#include "camel-store.h" -#include "camel-folder.h" -#include "camel-vtrash-folder.h" -#include "camel-exception.h" -#include "camel-private.h" - -#define d(x) -#define w(x) - -static CamelServiceClass *parent_class = NULL; - -/* Returns the class for a CamelStore */ -#define CS_CLASS(so) ((CamelStoreClass *)((CamelObject *)(so))->klass) - -static CamelFolder *get_folder (CamelStore *store, const char *folder_name, - guint32 flags, CamelException *ex); -static CamelFolder *get_inbox (CamelStore *store, CamelException *ex); - -static void init_trash (CamelStore *store); -static CamelFolder *get_trash (CamelStore *store, CamelException *ex); - -static CamelFolderInfo *create_folder (CamelStore *store, - const char *parent_name, - const char *folder_name, - CamelException *ex); -static void delete_folder (CamelStore *store, const char *folder_name, - CamelException *ex); -static void rename_folder (CamelStore *store, const char *old_name, - const char *new_name, CamelException *ex); - -static void store_sync (CamelStore *store, CamelException *ex); -static CamelFolderInfo *get_folder_info (CamelStore *store, const char *top, - guint32 flags, CamelException *ex); -static void free_folder_info (CamelStore *store, CamelFolderInfo *tree); - -static gboolean folder_subscribed (CamelStore *store, const char *folder_name); -static void subscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex); -static void unsubscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex); - -static void construct (CamelService *service, CamelSession *session, - CamelProvider *provider, CamelURL *url, - CamelException *ex); - -static int store_setv (CamelObject *object, CamelException *ex, CamelArgV *args); -static int store_getv (CamelObject *object, CamelException *ex, CamelArgGetV *args); - -static void -camel_store_class_init (CamelStoreClass *camel_store_class) -{ - CamelObjectClass *camel_object_class = CAMEL_OBJECT_CLASS (camel_store_class); - CamelServiceClass *camel_service_class = CAMEL_SERVICE_CLASS(camel_store_class); - - parent_class = CAMEL_SERVICE_CLASS (camel_type_get_global_classfuncs (camel_service_get_type ())); - - /* virtual method definition */ - camel_store_class->hash_folder_name = g_str_hash; - camel_store_class->compare_folder_name = g_str_equal; - camel_store_class->get_folder = get_folder; - camel_store_class->get_inbox = get_inbox; - camel_store_class->init_trash = init_trash; - camel_store_class->get_trash = get_trash; - camel_store_class->create_folder = create_folder; - camel_store_class->delete_folder = delete_folder; - camel_store_class->rename_folder = rename_folder; - camel_store_class->sync = store_sync; - camel_store_class->get_folder_info = get_folder_info; - camel_store_class->free_folder_info = free_folder_info; - camel_store_class->folder_subscribed = folder_subscribed; - camel_store_class->subscribe_folder = subscribe_folder; - camel_store_class->unsubscribe_folder = unsubscribe_folder; - - /* virtual method overload */ - camel_service_class->construct = construct; - - camel_object_class->setv = store_setv; - camel_object_class->getv = store_getv; - - camel_object_class_add_event(camel_object_class, "folder_created", NULL); - camel_object_class_add_event(camel_object_class, "folder_deleted", NULL); - camel_object_class_add_event(camel_object_class, "folder_renamed", NULL); - camel_object_class_add_event(camel_object_class, "folder_subscribed", NULL); - camel_object_class_add_event(camel_object_class, "folder_unsubscribed", NULL); -} - -static void -camel_store_init (void *o) -{ - CamelStore *store = o; - CamelStoreClass *store_class = (CamelStoreClass *)CAMEL_OBJECT_GET_CLASS (o); - - if (store_class->hash_folder_name) { - store->folders = g_hash_table_new (store_class->hash_folder_name, - store_class->compare_folder_name); - } else - store->folders = NULL; - - /* set vtrash on by default */ - store->flags = CAMEL_STORE_VTRASH; - - store->dir_sep = '/'; - - store->priv = g_malloc0 (sizeof (*store->priv)); -#ifdef ENABLE_THREADS - store->priv->folder_lock = e_mutex_new (E_MUTEX_REC); - store->priv->cache_lock = e_mutex_new (E_MUTEX_SIMPLE); -#endif -} - -static void -camel_store_finalize (CamelObject *object) -{ - CamelStore *store = CAMEL_STORE (object); - - if (store->folders) { - if (g_hash_table_size (store->folders) != 0) { - d(g_warning ("Folder cache for store %p contains " - "%d folders at destruction.", store, - g_hash_table_size (store->folders))); - } - g_hash_table_destroy (store->folders); - } - -#ifdef ENABLE_THREADS - e_mutex_destroy (store->priv->folder_lock); - e_mutex_destroy (store->priv->cache_lock); -#endif - g_free (store->priv); -} - - -CamelType -camel_store_get_type (void) -{ - static CamelType camel_store_type = CAMEL_INVALID_TYPE; - - if (camel_store_type == CAMEL_INVALID_TYPE) { - camel_store_type = camel_type_register (CAMEL_SERVICE_TYPE, "CamelStore", - sizeof (CamelStore), - sizeof (CamelStoreClass), - (CamelObjectClassInitFunc) camel_store_class_init, - NULL, - (CamelObjectInitFunc) camel_store_init, - (CamelObjectFinalizeFunc) camel_store_finalize ); - } - - return camel_store_type; -} - -static int -store_setv (CamelObject *object, CamelException *ex, CamelArgV *args) -{ - /* CamelStore doesn't currently have anything to set */ - return CAMEL_OBJECT_CLASS (parent_class)->setv (object, ex, args); -} - -static int -store_getv (CamelObject *object, CamelException *ex, CamelArgGetV *args) -{ - /* CamelStore doesn't currently have anything to get */ - return CAMEL_OBJECT_CLASS (parent_class)->getv (object, ex, args); -} - -static gboolean -folder_matches (gpointer key, gpointer value, gpointer user_data) -{ - if (value == user_data) { - g_free (key); - return TRUE; - } else - return FALSE; -} - -static void -folder_finalize (CamelObject *folder, gpointer event_data, gpointer user_data) -{ - CamelStore *store = CAMEL_STORE (user_data); - - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - g_hash_table_foreach_remove (store->folders, folder_matches, folder); - CAMEL_STORE_UNLOCK(store, cache_lock); - } -} - -static void -construct (CamelService *service, CamelSession *session, - CamelProvider *provider, CamelURL *url, - CamelException *ex) -{ - CamelStore *store = CAMEL_STORE(service); - - parent_class->construct(service, session, provider, url, ex); - if (camel_exception_is_set (ex)) - return; - - if (camel_url_get_param(url, "filter")) - store->flags |= CAMEL_STORE_FILTER_INBOX; -} - -static CamelFolder * -get_folder (CamelStore *store, const char *folder_name, guint32 flags, CamelException *ex) -{ - w(g_warning ("CamelStore::get_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); - - camel_exception_setv (ex, CAMEL_EXCEPTION_STORE_INVALID, - _("Cannot get folder: Invalid operation on this store")); - - return NULL; -} - -/** - * camel_store_get_folder: Return the folder corresponding to a path. - * @store: a CamelStore - * @folder_name: name of the folder to get - * @flags: folder flags (create, save body index, etc) - * @ex: a CamelException - * - * Return value: the folder corresponding to the path @folder_name. - **/ -CamelFolder * -camel_store_get_folder (CamelStore *store, const char *folder_name, guint32 flags, CamelException *ex) -{ - CamelFolder *folder = NULL; - - g_return_val_if_fail (folder_name != NULL, NULL); - - CAMEL_STORE_LOCK(store, folder_lock); - - if (store->folders) { - /* Try cache first. */ - CAMEL_STORE_LOCK(store, cache_lock); - folder = g_hash_table_lookup (store->folders, folder_name); - if (folder) - camel_object_ref (CAMEL_OBJECT (folder)); - CAMEL_STORE_UNLOCK(store, cache_lock); - } - - if (!folder) { - folder = CS_CLASS (store)->get_folder (store, folder_name, flags, ex); - if (folder) { - /* Add the folder to the vTrash folder if this store implements it */ - if (store->vtrash) - camel_vee_folder_add_folder (CAMEL_VEE_FOLDER (store->vtrash), folder); - - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - - g_hash_table_insert (store->folders, g_strdup (folder_name), folder); - - camel_object_hook_event (CAMEL_OBJECT (folder), "finalize", folder_finalize, store); - CAMEL_STORE_UNLOCK(store, cache_lock); - } - } - } - - CAMEL_STORE_UNLOCK(store, folder_lock); - return folder; -} - -static CamelFolderInfo * -create_folder (CamelStore *store, const char *parent_name, - const char *folder_name, CamelException *ex) -{ - w(g_warning ("CamelStore::create_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); - - camel_exception_setv (ex, CAMEL_EXCEPTION_STORE_INVALID, - _("Cannot create folder: Invalid operation on this store")); - - return NULL; -} - -/** - * camel_store_create_folder: - * @store: a CamelStore - * @parent_name: name of the new folder's parent, or %NULL - * @folder_name: name of the folder to create - * @ex: a CamelException - * - * Creates a new folder as a child of an existing folder. - * @parent_name can be %NULL to create a new top-level folder. - * - * Return value: info about the created folder, which the caller must - * free with camel_store_free_folder_info(). - **/ -CamelFolderInfo * -camel_store_create_folder (CamelStore *store, const char *parent_name, - const char *folder_name, CamelException *ex) -{ - CamelFolderInfo *fi; - - CAMEL_STORE_LOCK(store, folder_lock); - fi = CS_CLASS (store)->create_folder (store, parent_name, folder_name, ex); - CAMEL_STORE_UNLOCK(store, folder_lock); - - return fi; -} - - -static void -delete_folder (CamelStore *store, const char *folder_name, CamelException *ex) -{ - w(g_warning ("CamelStore::delete_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); -} - -/** - * camel_store_delete_folder: Delete the folder corresponding to a path. - * @store: a CamelStore - * @folder_name: name of the folder to delete - * @ex: a CamelException - * - * Deletes the named folder. The folder must be empty. - **/ -void -camel_store_delete_folder (CamelStore *store, const char *folder_name, CamelException *ex) -{ - CamelFolder *folder = NULL; - char *key; - - CAMEL_STORE_LOCK(store, folder_lock); - - /* NB: Note similarity of this code to unsubscribe_folder */ - - /* if we deleted a folder, force it out of the cache, and also out of the vtrash if setup */ - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - folder = g_hash_table_lookup(store->folders, folder_name); - if (folder) - camel_object_ref((CamelObject *)folder); - CAMEL_STORE_UNLOCK(store, cache_lock); - - if (folder) { - if (store->vtrash) - camel_vee_folder_remove_folder((CamelVeeFolder *)store->vtrash, folder); - camel_folder_delete (folder); - } - } - - CS_CLASS (store)->delete_folder (store, folder_name, ex); - - if (folder) - camel_object_unref((CamelObject *)folder); - - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - if (g_hash_table_lookup_extended(store->folders, folder_name, (void **)&key, (void **)&folder)) { - g_hash_table_remove (store->folders, key); - g_free (key); - } - CAMEL_STORE_UNLOCK(store, cache_lock); - } - - CAMEL_STORE_UNLOCK(store, folder_lock); -} - -static void -rename_folder (CamelStore *store, const char *old_name, const char *new_name, CamelException *ex) -{ - w(g_warning ("CamelStore::rename_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); -} - -struct _get_info { - CamelStore *store; - GPtrArray *folders; - const char *old; - const char *new; -}; - -static void -get_subfolders(char *key, CamelFolder *folder, struct _get_info *info) -{ - int oldlen, namelen; - - namelen = strlen(folder->full_name); - oldlen = strlen(info->old); - - if ((namelen == oldlen && - strcmp(folder->full_name, info->old) == 0) - || ((namelen > oldlen) - && strncmp(folder->full_name, info->old, oldlen) == 0 - && folder->full_name[oldlen] == info->store->dir_sep)) { - - d(printf("Found subfolder of '%s' == '%s'\n", info->old, folder->full_name)); - camel_object_ref((CamelObject *)folder); - g_ptr_array_add(info->folders, folder); - CAMEL_FOLDER_LOCK(folder, lock); - } -} - -/** - * camel_store_rename_folder: - * @store: a CamelStore - * @old_name: the current name of the folder - * @new_name: the new name of the folder - * @ex: a CamelException - * - * Rename a named folder to a new name. - **/ -void -camel_store_rename_folder (CamelStore *store, const char *old_name, const char *new_name, CamelException *ex) -{ - char *key; - CamelFolder *folder, *oldfolder; - struct _get_info info = { store, NULL, old_name, new_name }; - int i; - - d(printf("store rename folder %s '%s' '%s'\n", ((CamelService *)store)->url->protocol, old_name, new_name)); - - if (strcmp(old_name, new_name) == 0) - return; - - info.folders = g_ptr_array_new(); - - CAMEL_STORE_LOCK(store, folder_lock); - - /* If the folder is open (or any subfolders of the open folder) - We need to rename them atomically with renaming the actual folder path */ - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - /* Get all subfolders that are about to have their name changed */ - g_hash_table_foreach(store->folders, (GHFunc)get_subfolders, &info); - CAMEL_STORE_UNLOCK(store, cache_lock); - } - - /* Now try the real rename (will emit renamed event) */ - CS_CLASS (store)->rename_folder (store, old_name, new_name, ex); - - /* If it worked, update all open folders/unlock them */ - if (!camel_exception_is_set(ex)) { - guint32 flags = CAMEL_STORE_FOLDER_INFO_RECURSIVE; - CamelRenameInfo reninfo; - - CAMEL_STORE_LOCK(store, cache_lock); - for (i=0;i<info.folders->len;i++) { - char *new; - - folder = info.folders->pdata[i]; - - new = g_strdup_printf("%s%s", new_name, folder->full_name+strlen(old_name)); - - if (g_hash_table_lookup_extended(store->folders, folder->full_name, (void **)&key, (void **)&oldfolder)) { - g_hash_table_remove(store->folders, key); - g_free(key); - g_hash_table_insert(store->folders, new, oldfolder); - } - - camel_folder_rename(folder, new); - - CAMEL_FOLDER_UNLOCK(folder, lock); - camel_object_unref((CamelObject *)folder); - } - CAMEL_STORE_UNLOCK(store, cache_lock); - - /* Emit changed signal */ - if (store->flags & CAMEL_STORE_SUBSCRIPTIONS) - flags |= CAMEL_STORE_FOLDER_INFO_SUBSCRIBED; - - reninfo.old_base = (char *)old_name; - reninfo.new = ((CamelStoreClass *)((CamelObject *)store)->klass)->get_folder_info(store, new_name, flags, ex); - if (reninfo.new != NULL) { - camel_object_trigger_event(CAMEL_OBJECT(store), "folder_renamed", &reninfo); - ((CamelStoreClass *)((CamelObject *)store)->klass)->free_folder_info(store, reninfo.new); - } - } else { - /* Failed, just unlock our folders for re-use */ - for (i=0;i<info.folders->len;i++) { - folder = info.folders->pdata[i]; - CAMEL_FOLDER_UNLOCK(folder, lock); - camel_object_unref((CamelObject *)folder); - } - } - - CAMEL_STORE_UNLOCK(store, folder_lock); - - g_ptr_array_free(info.folders, TRUE); -} - - -static CamelFolder * -get_inbox (CamelStore *store, CamelException *ex) -{ - /* Default: assume the inbox's name is "inbox" - * and open with default flags. - */ - return CS_CLASS (store)->get_folder (store, "inbox", 0, ex); -} - -/** - * camel_store_get_inbox: - * @store: a CamelStore - * @ex: a CamelException - * - * Return value: the folder in the store into which new mail is - * delivered, or %NULL if no such folder exists. - **/ -CamelFolder * -camel_store_get_inbox (CamelStore *store, CamelException *ex) -{ - CamelFolder *folder; - - CAMEL_STORE_LOCK(store, folder_lock); - folder = CS_CLASS (store)->get_inbox (store, ex); - CAMEL_STORE_UNLOCK(store, folder_lock); - - return folder; -} - - -static void -trash_add_folder (gpointer key, gpointer value, gpointer data) -{ - CamelFolder *folder = CAMEL_FOLDER (value); - CamelStore *store = CAMEL_STORE (data); - - camel_vee_folder_add_folder (CAMEL_VEE_FOLDER (store->vtrash), folder); -} - -static void -trash_finalize (CamelObject *trash, gpointer event_data, gpointer user_data) -{ - CamelStore *store = CAMEL_STORE (user_data); - - store->vtrash = NULL; -} - -static void -init_trash (CamelStore *store) -{ - if ((store->flags & CAMEL_STORE_VTRASH) == 0) - return; - - store->vtrash = camel_vtrash_folder_new (store, CAMEL_VTRASH_NAME); - - if (store->vtrash) { - /* attach to the finalise event of the vtrash */ - camel_object_hook_event (CAMEL_OBJECT (store->vtrash), "finalize", - trash_finalize, store); - - /* add all the pre-opened folders to the vtrash */ - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - g_hash_table_foreach (store->folders, trash_add_folder, store); - CAMEL_STORE_UNLOCK(store, cache_lock); - } - } -} - - -static CamelFolder * -get_trash (CamelStore *store, CamelException *ex) -{ - if (store->vtrash) { - camel_object_ref (CAMEL_OBJECT (store->vtrash)); - return store->vtrash; - } else { - CS_CLASS (store)->init_trash (store); - if (store->vtrash) { - /* We don't ref here because we don't want the - store to own a ref on the trash folder */ - /*camel_object_ref (CAMEL_OBJECT (store->vtrash));*/ - return store->vtrash; - } else { - w(g_warning ("This store does not support vTrash.")); - return NULL; - } - } -} - -/** - * camel_store_get_trash: - * @store: a CamelStore - * @ex: a CamelException - * - * Return value: the folder in the store into which trash is - * delivered, or %NULL if no such folder exists. - **/ -CamelFolder * -camel_store_get_trash (CamelStore *store, CamelException *ex) -{ - CamelFolder *folder; - - if ((store->flags & CAMEL_STORE_VTRASH) == 0) - return NULL; - - CAMEL_STORE_LOCK(store, folder_lock); - folder = CS_CLASS (store)->get_trash (store, ex); - CAMEL_STORE_UNLOCK(store, folder_lock); - - return folder; -} - - -static void -sync_folder (gpointer key, gpointer folder, gpointer ex) -{ - if (!camel_exception_is_set (ex)) - camel_folder_sync (folder, FALSE, ex); - - camel_object_unref (CAMEL_OBJECT (folder)); - g_free (key); -} - -static void -copy_folder_cache (gpointer key, gpointer folder, gpointer hash) -{ - g_hash_table_insert ((GHashTable *) hash, g_strdup (key), folder); - camel_object_ref (CAMEL_OBJECT (folder)); -} - -static void -store_sync (CamelStore *store, CamelException *ex) -{ - if (store->folders) { - CamelException internal_ex; - GHashTable *hash; - - hash = g_hash_table_new (CS_CLASS (store)->hash_folder_name, - CS_CLASS (store)->compare_folder_name); - - camel_exception_init (&internal_ex); - CAMEL_STORE_LOCK(store, cache_lock); - g_hash_table_foreach (store->folders, copy_folder_cache, hash); - CAMEL_STORE_UNLOCK(store, cache_lock); - camel_exception_xfer (ex, &internal_ex); - - g_hash_table_foreach (hash, sync_folder, &internal_ex); - g_hash_table_destroy (hash); - } -} - -/** - * camel_store_sync: - * @store: a CamelStore - * @ex: a CamelException - * - * Syncs any changes that have been made to the store object and its - * folders with the real store. - **/ -void -camel_store_sync (CamelStore *store, CamelException *ex) -{ - g_return_if_fail (CAMEL_IS_STORE (store)); - - CS_CLASS (store)->sync (store, ex); -} - - -static CamelFolderInfo * -get_folder_info (CamelStore *store, const char *top, - guint32 flags, CamelException *ex) -{ - w(g_warning ("CamelStore::get_folder_info not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); - - return NULL; -} - -/** - * camel_store_get_folder_info: - * @store: a CamelStore - * @top: the name of the folder to start from - * @flags: various CAMEL_STORE_FOLDER_INFO_* flags to control behavior - * @ex: a CamelException - * - * This fetches information about the folder structure of @store, - * starting with @top, and returns a tree of CamelFolderInfo - * structures. If @flags includes %CAMEL_STORE_FOLDER_INFO_SUBSCRIBED, - * only subscribed folders will be listed. (This flag can only be used - * for stores that support subscriptions.) If @flags includes - * %CAMEL_STORE_FOLDER_INFO_RECURSIVE, the returned tree will include - * all levels of hierarchy below @top. If not, it will only include - * the immediate subfolders of @top. If @flags includes - * %CAMEL_STORE_FOLDER_INFO_FAST, the unread_message_count fields of - * some or all of the structures may be set to -1, if the store cannot - * determine that information quickly. - * - * Return value: a CamelFolderInfo tree, which must be freed with - * camel_store_free_folder_info. - **/ -CamelFolderInfo * -camel_store_get_folder_info (CamelStore *store, const char *top, - guint32 flags, CamelException *ex) -{ - CamelFolderInfo *ret; - - g_return_val_if_fail (CAMEL_IS_STORE (store), NULL); - g_return_val_if_fail ((store->flags & CAMEL_STORE_SUBSCRIPTIONS) || - !(flags & CAMEL_STORE_FOLDER_INFO_SUBSCRIBED), - NULL); - - CAMEL_STORE_LOCK(store, folder_lock); - ret = CS_CLASS (store)->get_folder_info (store, top, flags, ex); - CAMEL_STORE_UNLOCK(store, folder_lock); - - return ret; -} - - -static void -free_folder_info (CamelStore *store, CamelFolderInfo *fi) -{ - w(g_warning ("CamelStore::free_folder_info not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); -} - -/** - * camel_store_free_folder_info: - * @store: a CamelStore - * @tree: the tree returned by camel_store_get_folder_info() - * - * Frees the data returned by camel_store_get_folder_info(). - **/ -void -camel_store_free_folder_info (CamelStore *store, CamelFolderInfo *fi) -{ - g_return_if_fail (CAMEL_IS_STORE (store)); - - CS_CLASS (store)->free_folder_info (store, fi); -} - -/** - * camel_store_free_folder_info_full: - * @store: a CamelStore - * @tree: the tree returned by camel_store_get_folder_info() - * - * An implementation for CamelStore::free_folder_info. Frees all - * of the data. - **/ -void -camel_store_free_folder_info_full (CamelStore *store, CamelFolderInfo *fi) -{ - camel_folder_info_free (fi); -} - -/** - * camel_store_free_folder_info_nop: - * @store: a CamelStore - * @tree: the tree returned by camel_store_get_folder_info() - * - * An implementation for CamelStore::free_folder_info. Does nothing. - **/ -void -camel_store_free_folder_info_nop (CamelStore *store, CamelFolderInfo *fi) -{ - ; -} - - -/** - * camel_folder_info_free: - * @fi: the CamelFolderInfo - * - * Frees @fi. - **/ -void -camel_folder_info_free (CamelFolderInfo *fi) -{ - if (fi) { - camel_folder_info_free (fi->sibling); - camel_folder_info_free (fi->child); - g_free (fi->name); - g_free (fi->full_name); - g_free (fi->path); - g_free (fi->url); - g_free (fi); - } -} - - -/** - * camel_folder_info_build_path: - * @fi: folder info - * @separator: directory separator - * - * Sets the folder info path based on the folder's full name and - * directory separator. - **/ -void -camel_folder_info_build_path (CamelFolderInfo *fi, char separator) -{ - fi->path = g_strdup_printf("/%s", fi->full_name); - if (separator != '/') { - char *p; - - p = fi->path; - while ((p = strchr (p, separator))) - *p = '/'; - } -} - -static int -folder_info_cmp (const void *ap, const void *bp) -{ - const CamelFolderInfo *a = ((CamelFolderInfo **)ap)[0]; - const CamelFolderInfo *b = ((CamelFolderInfo **)bp)[0]; - - return strcmp (a->full_name, b->full_name); -} - -/** - * camel_folder_info_build: - * @folders: an array of CamelFolderInfo - * @namespace: an ignorable prefix on the folder names - * @separator: the hieararchy separator character - * @short_names: %TRUE if the (short) name of a folder is the part after - * the last @separator in the full name. %FALSE if it is the full name. - * - * This takes an array of folders and attaches them together according - * to the hierarchy described by their full_names and @separator. If - * @namespace is non-%NULL, then it will be ignored as a full_name - * prefix, for purposes of comparison. If necessary, - * camel_folder_info_build will create additional CamelFolderInfo with - * %NULL urls to fill in gaps in the tree. The value of @short_names - * is used in constructing the names of these intermediate folders. - * - * Return value: the top level of the tree of linked folder info. - **/ -CamelFolderInfo * -camel_folder_info_build (GPtrArray *folders, const char *namespace, - char separator, gboolean short_names) -{ - CamelFolderInfo *fi, *pfi, *top = NULL; - GHashTable *hash; - char *name, *p, *pname; - int i, nlen; - - if (!namespace) - namespace = ""; - nlen = strlen (namespace); - - qsort (folders->pdata, folders->len, sizeof (folders->pdata[0]), folder_info_cmp); - - /* Hash the folders. */ - hash = g_hash_table_new (g_str_hash, g_str_equal); - for (i = 0; i < folders->len; i++) { - fi = folders->pdata[i]; - if (!strncmp (namespace, fi->full_name, nlen)) - name = fi->full_name + nlen; - else - name = fi->full_name; - if (*name == separator) - name++; - g_hash_table_insert (hash, name, fi); - } - - /* Now find parents. */ - for (i = 0; i < folders->len; i++) { - fi = folders->pdata[i]; - if (!strncmp (namespace, fi->full_name, nlen)) - name = fi->full_name + nlen; - else - name = fi->full_name; - if (*name == separator) - name++; - - /* set the path if it isn't already set */ - if (!fi->path) - camel_folder_info_build_path (fi, separator); - - p = strrchr (name, separator); - if (p) { - pname = g_strndup (name, p - name); - pfi = g_hash_table_lookup (hash, pname); - if (pfi) { - g_free (pname); - } else { - /* we are missing a folder in the heirarchy so - create a fake folder node */ - CamelURL *url; - char *sep; - - pfi = g_new0 (CamelFolderInfo, 1); - pfi->full_name = pname; - if (short_names) { - pfi->name = strrchr (pname, separator); - if (pfi->name) - pfi->name = g_strdup (pfi->name + 1); - else - pfi->name = g_strdup (pname); - } else - pfi->name = g_strdup (pname); - - url = camel_url_new (fi->url, NULL); - sep = strrchr (url->path, separator); - if (sep) - *sep = '\0'; - else - d(g_warning ("huh, no \"%c\" in \"%s\"?", separator, fi->url)); - - /* since this is a "fake" folder node, it is not selectable */ - camel_url_set_param (url, "noselect", "yes"); - pfi->url = camel_url_to_string (url, 0); - camel_url_free (url); - - g_hash_table_insert (hash, pname, pfi); - g_ptr_array_add (folders, pfi); - } - fi->sibling = pfi->child; - fi->parent = pfi; - pfi->child = fi; - } else if (!top) - top = fi; - } - g_hash_table_destroy (hash); - - /* Link together the top-level folders */ - for (i = 0; i < folders->len; i++) { - fi = folders->pdata[i]; - if (fi->parent || fi == top) - continue; - if (top) - fi->sibling = top; - top = fi; - } - - return top; -} - -static CamelFolderInfo *folder_info_clone_rec(CamelFolderInfo *fi, CamelFolderInfo *parent) -{ - CamelFolderInfo *info; - - info = g_malloc(sizeof(*info)); - info->parent = parent; - info->url = g_strdup(fi->url); - info->name = g_strdup(fi->name); - info->full_name = g_strdup(fi->full_name); - info->path = g_strdup(fi->path); - info->unread_message_count = fi->unread_message_count; - - if (fi->sibling) - info->sibling = folder_info_clone_rec(fi->sibling, parent); - else - info->sibling = NULL; - - if (fi->child) - info->child = folder_info_clone_rec(fi->child, info); - else - info->child = NULL; - - return info; -} - -CamelFolderInfo * -camel_folder_info_clone(CamelFolderInfo *fi) -{ - if (fi == NULL) - return NULL; - - return folder_info_clone_rec(fi, NULL); -} - -gboolean -camel_store_supports_subscriptions (CamelStore *store) -{ - return (store->flags & CAMEL_STORE_SUBSCRIPTIONS); -} - - -static gboolean -folder_subscribed (CamelStore *store, const char *folder_name) -{ - w(g_warning ("CamelStore::folder_subscribed not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); - - return FALSE; -} - -/** - * camel_store_folder_subscribed: Tell whether or not a folder has been subscribed to. - * @store: a CamelStore - * @folder_name: the folder on which we're querying subscribed status. - * Return value: TRUE if folder is subscribed, FALSE if not. - **/ -gboolean -camel_store_folder_subscribed (CamelStore *store, - const char *folder_name) -{ - gboolean ret; - - g_return_val_if_fail (CAMEL_IS_STORE (store), FALSE); - g_return_val_if_fail (store->flags & CAMEL_STORE_SUBSCRIPTIONS, FALSE); - - CAMEL_STORE_LOCK(store, folder_lock); - - ret = CS_CLASS (store)->folder_subscribed (store, folder_name); - - CAMEL_STORE_UNLOCK(store, folder_lock); - - return ret; -} - -static void -subscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex) -{ - w(g_warning ("CamelStore::subscribe_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); -} - -/** - * camel_store_subscribe_folder: marks a folder as subscribed. - * @store: a CamelStore - * @folder_name: the folder to subscribe to. - **/ -void -camel_store_subscribe_folder (CamelStore *store, - const char *folder_name, - CamelException *ex) -{ - g_return_if_fail (CAMEL_IS_STORE (store)); - g_return_if_fail (store->flags & CAMEL_STORE_SUBSCRIPTIONS); - - CAMEL_STORE_LOCK(store, folder_lock); - - CS_CLASS (store)->subscribe_folder (store, folder_name, ex); - - CAMEL_STORE_UNLOCK(store, folder_lock); -} - -static void -unsubscribe_folder (CamelStore *store, const char *folder_name, CamelException *ex) -{ - w(g_warning ("CamelStore::unsubscribe_folder not implemented for `%s'", - camel_type_to_name (CAMEL_OBJECT_GET_TYPE (store)))); -} - - -/** - * camel_store_unsubscribe_folder: marks a folder as unsubscribed. - * @store: a CamelStore - * @folder_name: the folder to unsubscribe from. - **/ -void -camel_store_unsubscribe_folder (CamelStore *store, - const char *folder_name, - CamelException *ex) -{ - CamelFolder *folder = NULL; - char *key; - - g_return_if_fail (CAMEL_IS_STORE (store)); - g_return_if_fail (store->flags & CAMEL_STORE_SUBSCRIPTIONS); - - CAMEL_STORE_LOCK(store, folder_lock); - - /* NB: Note similarity of this code to delete_folder */ - - /* if we deleted a folder, force it out of the cache, and also out of the vtrash if setup */ - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - folder = g_hash_table_lookup(store->folders, folder_name); - if (folder) - camel_object_ref((CamelObject *)folder); - CAMEL_STORE_UNLOCK(store, cache_lock); - - if (folder) { - if (store->vtrash) - camel_vee_folder_remove_folder((CamelVeeFolder *)store->vtrash, folder); - camel_folder_delete (folder); - } - } - - CS_CLASS (store)->unsubscribe_folder (store, folder_name, ex); - - if (folder) - camel_object_unref((CamelObject *)folder); - - if (store->folders) { - CAMEL_STORE_LOCK(store, cache_lock); - if (g_hash_table_lookup_extended(store->folders, folder_name, (void **)&key, (void **)&folder)) { - g_hash_table_remove (store->folders, key); - g_free (key); - } - CAMEL_STORE_UNLOCK(store, cache_lock); - } - - CAMEL_STORE_UNLOCK(store, folder_lock); -} - - -int -camel_mkdir_hier (const char *path, mode_t mode) -{ - char *copy, *p; - - p = copy = g_strdup (path); - do { - p = strchr (p + 1, '/'); - if (p) - *p = '\0'; - if (access (copy, F_OK) == -1) { - if (mkdir (copy, mode) == -1) { - g_free (copy); - return -1; - } - } - if (p) - *p = '/'; - } while (p); - - g_free (copy); - return 0; -} - - -/* Return true if these uri's refer to the same object */ -gboolean -camel_store_uri_cmp(CamelStore *store, const char *uria, const char *urib) -{ - g_assert(CAMEL_IS_STORE(store)); - - return CS_CLASS(store)->compare_folder_name(uria, urib); -} |