Files
evolution/camel/camel-store.h
Not Zed 24b06cb2a4 Use a bag instead of a hashtable to track the cache streams.
2002-12-07  Not Zed  <NotZed@Ximian.com>

	* camel-data-cache.c (data_cache_init): Use a bag instead of a
	hashtable to track the cache streams.
	(data_cache_finalise): Same.
	(free_busy): No longer needed.
	(data_cache_expire): use bag instead of hashtable.
	(stream_finalised): No longer required.
	(camel_data_cache_add): objectbagise
	(camel_data_cache_get): "
	(camel_data_cache_remove): "
	(data_cache_path): Set the now expired date before running expiry,
	so it plays better with multiple threads.  Still a couple of
	harmless races.

2002-12-06  Not Zed  <NotZed@Ximian.com>

	* providers/local/camel-spool-store.c (scan_dir): folders ->
	object bag.
	(get_folder_info_mbox): folders -> object bag.

	* providers/local/camel-mh-store.c (folder_info_new): folders ->
	object bag.

	* providers/local/camel-maildir-store.c (scan_dir): folders ->
	object bag.

	* providers/local/camel-local-store.c (rename_folder): folders ->
	object bag.

	* camel-private.h (CamelStorePrivate): Remove 'cache' lock,
	handled by the objectbag.

	* providers/imap/camel-imap-store.c (copy_folder): Removed.
	(imap_store_refresh_folders): folders -> object bag.
	(get_folder_counts): folders -> object bag.

	* camel-vee-store.c (vee_get_folder): changes for folders
	objectbag.
	(vee_get_folder_info): Change to use folders objectbag.  Also,
	dont refresh the base folder if we're in FAST mode.
	(build_info): Removed, no longer needed.
	(vee_rename_folder): Fixed for folders objectbag.

	* camel-store.c (camel_store_init): init the folders objectbag.
	(camel_store_finalize): Destroy the folders object bag.
	(folder_matches):
	(folder_finalize): Removed, now handled implicitly by the
	objectbag.
	(camel_store_get_folder): object bag changes.
	(camel_store_delete_folder): "
	(get_subfolders): Removed, now handled without a callback.
	(camel_store_rename_folder): Changed to use object bag of folders.
	(trash_add_folder): Removed.
	(init_trash): use folders object bag.
	(copy_folder_cache):
	(sync_folder): Removed, no longer needed.  Weird arsed code anyway.
	(store_sync): Use folder object bag instead of hashtable.
	(camel_store_unsubscribe_folder): "
	(camel_store_init): remove cache_lock init, no longer used.
	(camel_store_finalize): Same for cleanup.

2002-12-05  Not Zed  <NotZed@Ximian.com>

	* camel-store.h (struct _CamelStore): change folders from a
	hashtable into a CamelObjectBag.

	* camel-object.c (camel_object_ref): Use type_lock instead of
	class lock for ref counting.
	(camel_object_unref): Use type_lock instead of class lock for
	unref.
	(camel_object_unref): If the object is 'bagged', then also look
	hooks, and remove it from any bags.
	(camel_object_bag_new):
	(camel_object_bag_destroy):
	(camel_object_bag_add):
	(camel_object_bag_get):
	(camel_object_bag_remove_unlocked):
	(camel_object_bag_list):
	(camel_object_bag_abort):
	(camel_object_bag_remove): New functions to implement a utility
	object which can manage a 'bag' of weakly ref'd children in an
	atomic & threadsafe way.

svn path=/trunk/; revision=19056
2002-12-09 00:28:06 +00:00

237 lines
7.6 KiB
C

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-store.h : Abstract class for an email store */
/*
*
* Authors: Bertrand Guiheneuf <bertrand@helixcode.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
*/
#ifndef CAMEL_STORE_H
#define CAMEL_STORE_H 1
#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus }*/
/* for mode_t */
#include <sys/types.h>
#include <camel/camel-object.h>
#include <camel/camel-service.h>
enum {
CAMEL_STORE_ARG_FIRST = CAMEL_SERVICE_ARG_FIRST + 100,
};
typedef struct _CamelFolderInfo {
struct _CamelFolderInfo *parent,
*sibling,
*child;
char *url;
char *name;
char *full_name;
char *path;
int unread_message_count;
guint32 flags;
} CamelFolderInfo;
/* Note: these are abstractions (duh), its upto the provider to make them make sense */
/* a folder which can't contain messages */
#define CAMEL_FOLDER_NOSELECT (1<<0)
/* a folder which cannot have children */
#define CAMEL_FOLDER_NOINFERIORS (1<<1)
/* a folder which has children (not yet fully implemented) */
#define CAMEL_FOLDER_CHILDREN (1<<2)
/* a folder which is subscribed */
#define CAMEL_FOLDER_SUBSCRIBED (1<<3)
/* Structure of rename event's event_data */
typedef struct _CamelRenameInfo {
char *old_base;
struct _CamelFolderInfo *new;
} CamelRenameInfo;
#define CAMEL_STORE_TYPE (camel_store_get_type ())
#define CAMEL_STORE(obj) (CAMEL_CHECK_CAST((obj), CAMEL_STORE_TYPE, CamelStore))
#define CAMEL_STORE_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_STORE_TYPE, CamelStoreClass))
#define CAMEL_IS_STORE(o) (CAMEL_CHECK_TYPE((o), CAMEL_STORE_TYPE))
/* Flags for store flags */
#define CAMEL_STORE_SUBSCRIPTIONS (1 << 0)
#define CAMEL_STORE_VTRASH (1 << 1)
#define CAMEL_STORE_FILTER_INBOX (1 << 2)
struct _CamelStore
{
CamelService parent_object;
struct _CamelStorePrivate *priv;
CamelFolder *vtrash;
CamelObjectBag *folders;
int flags;
/* FIXME: This is a temporary measure until IMAP namespaces are properly implemented,
after that, all external folder api's will assume a dir separator of '/' */
/* This is always a copy of IMAP_STORE()->dir_sep, or '/' */
char dir_sep;
};
/* open mode for folder */
#define CAMEL_STORE_FOLDER_CREATE (1<<0)
#define CAMEL_STORE_FOLDER_BODY_INDEX (1<<1)
#define CAMEL_STORE_FOLDER_PRIVATE (1<<2) /* a private folder, that shouldn't show up in unmatched/folder info's, etc */
#define CAMEL_STORE_FOLDER_INFO_FAST (1 << 0)
#define CAMEL_STORE_FOLDER_INFO_RECURSIVE (1 << 1)
#define CAMEL_STORE_FOLDER_INFO_SUBSCRIBED (1 << 2)
typedef struct {
CamelServiceClass parent_class;
GHashFunc hash_folder_name;
GCompareFunc compare_folder_name;
CamelFolder * (*get_folder) (CamelStore *store,
const char *folder_name,
guint32 flags,
CamelException *ex);
CamelFolder * (*get_inbox) (CamelStore *store,
CamelException *ex);
void (*init_trash) (CamelStore *store);
CamelFolder * (*get_trash) (CamelStore *store,
CamelException *ex);
CamelFolderInfo *(*create_folder) (CamelStore *store,
const char *parent_name,
const char *folder_name,
CamelException *ex);
void (*delete_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*rename_folder) (CamelStore *store,
const char *old_name,
const char *new_name,
CamelException *ex);
void (*sync) (CamelStore *store,
CamelException *ex);
CamelFolderInfo *(*get_folder_info) (CamelStore *store,
const char *top,
guint32 flags,
CamelException *ex);
void (*free_folder_info) (CamelStore *store,
CamelFolderInfo *fi);
gboolean (*folder_subscribed) (CamelStore *store,
const char *folder_name);
void (*subscribe_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*unsubscribe_folder) (CamelStore *store,
const char *folder_name,
CamelException *ex);
void (*noop) (CamelStore *store,
CamelException *ex);
} CamelStoreClass;
/* Standard Camel function */
CamelType camel_store_get_type (void);
/* public methods */
CamelFolder * camel_store_get_folder (CamelStore *store,
const char *folder_name,
guint32 flags,
CamelException *ex);
CamelFolder * camel_store_get_inbox (CamelStore *store,
CamelException *ex);
CamelFolder * camel_store_get_trash (CamelStore *store,
CamelException *ex);
CamelFolderInfo *camel_store_create_folder (CamelStore *store,
const char *parent_name,
const char *folder_name,
CamelException *ex);
void camel_store_delete_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_rename_folder (CamelStore *store,
const char *old_name,
const char *new_name,
CamelException *ex);
void camel_store_sync (CamelStore *store,
CamelException *ex);
CamelFolderInfo *camel_store_get_folder_info (CamelStore *store,
const char *top,
guint32 flags,
CamelException *ex);
void camel_store_free_folder_info (CamelStore *store,
CamelFolderInfo *fi);
void camel_store_free_folder_info_full (CamelStore *store,
CamelFolderInfo *fi);
void camel_store_free_folder_info_nop (CamelStore *store,
CamelFolderInfo *fi);
void camel_folder_info_free (CamelFolderInfo *fi);
void camel_folder_info_build_path (CamelFolderInfo *fi,
char separator);
CamelFolderInfo *camel_folder_info_build (GPtrArray *folders,
const char *namespace,
char separator,
gboolean short_names);
CamelFolderInfo *camel_folder_info_clone (CamelFolderInfo *fi);
gboolean camel_store_supports_subscriptions (CamelStore *store);
gboolean camel_store_folder_subscribed (CamelStore *store,
const char *folder_name);
void camel_store_subscribe_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_unsubscribe_folder (CamelStore *store,
const char *folder_name,
CamelException *ex);
void camel_store_noop (CamelStore *store,
CamelException *ex);
gboolean camel_store_uri_cmp (CamelStore *store, const char *uria, const char *urib);
/* utility needed by some stores */
int camel_mkdir_hier (const char *path, mode_t mode);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CAMEL_STORE_H */