1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Authors: Jeffrey Stedfast <fejj@ximian.com>
4 * Michael Zucchi <notzed@ximian.com>
6 * Copyright 2001 Ximian, Inc. (www.ximian.com)
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU Lesser General Public
10 * License as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this program; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
31 #include <glib/gi18n-lib.h>
33 #include "camel-exception.h"
34 #include "camel-mime-message.h"
35 #include "camel-private.h"
36 #include "camel-store.h"
37 #include "camel-vee-store.h"
38 #include "camel-vtrash-folder.h"
41 /* Returns the class for a CamelFolder */
42 #define CF_CLASS(so) ((CamelFolderClass *)((CamelObject *)(so))->klass)
45 const char *full_name;
50 const char *error_copy;
52 { CAMEL_VTRASH_NAME, N_("Trash"), "(match-all (system-flag \"Deleted\"))", CAMEL_MESSAGE_DELETED, CAMEL_FOLDER_IS_TRASH,
53 N_("Cannot copy messages to the Trash folder") },
54 { CAMEL_VJUNK_NAME, N_("Junk"), "(match-all (system-flag \"Junk\"))", CAMEL_MESSAGE_JUNK, CAMEL_FOLDER_IS_JUNK,
55 N_("Cannot copy messages to the Junk folder") },
58 static CamelVeeFolderClass *camel_vtrash_folder_parent;
60 static void camel_vtrash_folder_class_init (CamelVTrashFolderClass *klass);
63 camel_vtrash_folder_init (CamelVTrashFolder *vtrash)
65 /*CamelFolder *folder = CAMEL_FOLDER (vtrash);*/
69 camel_vtrash_folder_get_type (void)
71 static CamelType type = CAMEL_INVALID_TYPE;
73 if (type == CAMEL_INVALID_TYPE) {
74 type = camel_type_register (camel_vee_folder_get_type (),
76 sizeof (CamelVTrashFolder),
77 sizeof (CamelVTrashFolderClass),
78 (CamelObjectClassInitFunc) camel_vtrash_folder_class_init,
80 (CamelObjectInitFunc) camel_vtrash_folder_init,
88 * camel_vtrash_folder_new:
89 * @parent_store: the parent #CamelVeeStore object
90 * @type: type of vfolder, #CAMEL_VTRASH_FOLDER_TRASH or #CAMEL_VTRASH_FOLDER_JUNK currently.
91 * @ex: a #CamelException
93 * Create a new CamelVTrashFolder object.
95 * Returns a new #CamelVTrashFolder object
98 camel_vtrash_folder_new (CamelStore *parent_store, camel_vtrash_folder_t type)
100 CamelVTrashFolder *vtrash;
102 g_assert(type < CAMEL_VTRASH_FOLDER_LAST);
104 vtrash = (CamelVTrashFolder *)camel_object_new(camel_vtrash_folder_get_type());
105 camel_vee_folder_construct(CAMEL_VEE_FOLDER (vtrash), parent_store, vdata[type].full_name, _(vdata[type].name),
106 CAMEL_STORE_FOLDER_PRIVATE|CAMEL_STORE_FOLDER_CREATE|CAMEL_STORE_VEE_FOLDER_AUTO);
108 ((CamelFolder *)vtrash)->folder_flags |= vdata[type].flags;
109 camel_vee_folder_set_expression((CamelVeeFolder *)vtrash, vdata[type].expr);
110 vtrash->bit = vdata[type].bit;
113 return (CamelFolder *)vtrash;
117 vtrash_getv(CamelObject *object, CamelException *ex, CamelArgGetV *args)
119 CamelFolder *folder = (CamelFolder *)object;
122 int unread = -1, deleted = 0, junked = 0, visible = 0, count = -1;
124 for (i=0;i<args->argc;i++) {
125 CamelArgGet *arg = &args->argv[i];
129 /* NB: this is a copy of camel-folder.c with the unread count logic altered.
130 makes sure its still atomically calculated */
131 switch (tag & CAMEL_ARG_TAG) {
132 case CAMEL_FOLDER_ARG_UNREAD:
133 case CAMEL_FOLDER_ARG_DELETED:
134 case CAMEL_FOLDER_ARG_JUNKED:
135 case CAMEL_FOLDER_ARG_VISIBLE:
136 /* This is so we can get the values atomically, and also so we can calculate them only once */
139 CamelMessageInfo *info;
142 count = camel_folder_summary_count(folder->summary);
143 for (j=0; j<count; j++) {
144 if ((info = camel_folder_summary_index(folder->summary, j))) {
145 guint32 flags = camel_message_info_flags(info);
147 if ((flags & (CAMEL_MESSAGE_SEEN)) == 0)
149 if (flags & CAMEL_MESSAGE_DELETED)
151 if (flags & CAMEL_MESSAGE_JUNK)
153 if ((flags & (CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_JUNK)) == 0)
155 camel_message_info_free(info);
160 switch (tag & CAMEL_ARG_TAG) {
161 case CAMEL_FOLDER_ARG_UNREAD:
164 case CAMEL_FOLDER_ARG_DELETED:
167 case CAMEL_FOLDER_ARG_JUNKED:
170 case CAMEL_FOLDER_ARG_VISIBLE:
175 *arg->ca_int = count;
181 arg->tag = (tag & CAMEL_ARG_TYPE) | CAMEL_ARG_IGNORE;
184 return ((CamelObjectClass *)camel_vtrash_folder_parent)->getv(object, ex, args);
188 vtrash_append_message (CamelFolder *folder, CamelMimeMessage *message,
189 const CamelMessageInfo *info, char **appended_uid,
192 camel_exception_setv(ex, CAMEL_EXCEPTION_SYSTEM,
193 _(vdata[((CamelVTrashFolder *)folder)->type].error_copy));
196 struct _transfer_data {
204 transfer_messages(CamelFolder *folder, struct _transfer_data *md, CamelException *ex)
208 if (!camel_exception_is_set (ex))
209 camel_folder_transfer_messages_to(md->folder, md->uids, md->dest, NULL, md->delete, ex);
211 for (i=0;i<md->uids->len;i++)
212 g_free(md->uids->pdata[i]);
213 g_ptr_array_free(md->uids, TRUE);
214 camel_object_unref((CamelObject *)md->folder);
219 vtrash_transfer_messages_to (CamelFolder *source, GPtrArray *uids,
220 CamelFolder *dest, GPtrArray **transferred_uids,
221 gboolean delete_originals, CamelException *ex)
223 CamelVeeMessageInfo *mi;
225 GHashTable *batch = NULL;
227 struct _transfer_data *md;
228 guint32 sbit = ((CamelVTrashFolder *)source)->bit;
230 /* This is a special case of transfer_messages_to: Either the
231 * source or the destination is a vtrash folder (but not both
232 * since a store should never have more than one).
235 if (transferred_uids)
236 *transferred_uids = NULL;
238 if (CAMEL_IS_VTRASH_FOLDER (dest)) {
239 /* Copy to trash is meaningless. */
240 if (!delete_originals) {
241 camel_exception_setv(ex, CAMEL_EXCEPTION_SYSTEM,
242 _(vdata[((CamelVTrashFolder *)dest)->type].error_copy));
246 /* Move to trash is the same as setting the message flag */
247 for (i = 0; i < uids->len; i++)
248 camel_folder_set_message_flags(source, uids->pdata[i], ((CamelVTrashFolder *)dest)->bit, ~0);
252 /* Moving/Copying from the trash to the original folder = undelete.
253 * Moving/Copying from the trash to a different folder = move/copy.
255 * Need to check this uid by uid, but we batch up the copies.
258 for (i = 0; i < uids->len; i++) {
259 mi = (CamelVeeMessageInfo *)camel_folder_get_message_info (source, uids->pdata[i]);
261 g_warning ("Cannot find uid %s in source folder during transfer", (char *) uids->pdata[i]);
265 if (dest == mi->real->summary->folder) {
266 /* Just unset the flag on the original message */
267 camel_folder_set_message_flags (source, uids->pdata[i], sbit, 0);
270 batch = g_hash_table_new(NULL, NULL);
271 md = g_hash_table_lookup(batch, mi->real->summary->folder);
273 md = g_malloc0(sizeof(*md));
274 md->folder = mi->real->summary->folder;
275 camel_object_ref((CamelObject *)md->folder);
276 md->uids = g_ptr_array_new();
278 g_hash_table_insert(batch, mi->real->summary->folder, md);
281 tuid = uids->pdata[i];
284 g_ptr_array_add(md->uids, g_strdup(tuid));
286 camel_folder_free_message_info (source, (CamelMessageInfo *)mi);
290 g_hash_table_foreach(batch, (GHFunc)transfer_messages, ex);
291 g_hash_table_destroy(batch);
296 vtrash_search_by_expression(CamelFolder *folder, const char *expression, CamelException *ex)
299 GPtrArray *matches, *result = g_ptr_array_new(), *uids = g_ptr_array_new();
300 struct _CamelVeeFolderPrivate *p = ((CamelVeeFolder *)folder)->priv;
302 /* we optimise the search by only searching for messages which we have anyway */
303 CAMEL_VEE_FOLDER_LOCK(folder, subfolder_lock);
306 CamelFolder *f = node->data;
309 GPtrArray *infos = camel_folder_get_summary(f);
311 camel_vee_folder_hash_folder(f, hash);
313 for (i=0;i<infos->len;i++) {
314 CamelMessageInfo *mi = infos->pdata[i];
316 if (camel_message_info_flags(mi) & ((CamelVTrashFolder *)folder)->bit)
317 g_ptr_array_add(uids, (void *)camel_message_info_uid(mi));
321 && (matches = camel_folder_search_by_uids(f, expression, uids, NULL))) {
322 for (i = 0; i < matches->len; i++) {
323 char *uid = matches->pdata[i], *vuid;
325 vuid = g_malloc(strlen(uid)+9);
326 memcpy(vuid, hash, 8);
328 g_ptr_array_add(result, vuid);
330 camel_folder_search_free(f, matches);
332 g_ptr_array_set_size(uids, 0);
333 camel_folder_free_summary(f, infos);
335 node = g_list_next(node);
337 CAMEL_VEE_FOLDER_UNLOCK(folder, subfolder_lock);
339 g_ptr_array_free(uids, TRUE);
345 vtrash_search_by_uids(CamelFolder *folder, const char *expression, GPtrArray *uids, CamelException *ex)
348 GPtrArray *matches, *result = g_ptr_array_new(), *folder_uids = g_ptr_array_new();
349 struct _CamelVeeFolderPrivate *p = ((CamelVeeFolder *)folder)->priv;
351 CAMEL_VEE_FOLDER_LOCK(folder, subfolder_lock);
355 CamelFolder *f = node->data;
359 camel_vee_folder_hash_folder(f, hash);
361 /* map the vfolder uid's to the source folder uid's first */
362 g_ptr_array_set_size(uids, 0);
363 for (i=0;i<uids->len;i++) {
364 char *uid = uids->pdata[i];
366 if (strlen(uid) >= 8 && strncmp(uid, hash, 8) == 0) {
367 CamelMessageInfo *mi;
369 mi = camel_folder_get_message_info(f, uid+8);
371 if(camel_message_info_flags(mi) & ((CamelVTrashFolder *)folder)->bit)
372 g_ptr_array_add(folder_uids, uid+8);
373 camel_folder_free_message_info(f, mi);
378 if (folder_uids->len > 0
379 && (matches = camel_folder_search_by_uids(f, expression, folder_uids, ex))) {
380 for (i = 0; i < matches->len; i++) {
381 char *uid = matches->pdata[i], *vuid;
383 vuid = g_malloc(strlen(uid)+9);
384 memcpy(vuid, hash, 8);
386 g_ptr_array_add(result, vuid);
388 camel_folder_search_free(f, matches);
390 node = g_list_next(node);
393 CAMEL_VEE_FOLDER_UNLOCK(folder, subfolder_lock);
395 g_ptr_array_free(folder_uids, TRUE);
401 vtrash_uid_removed(CamelVTrashFolder *vf, const char *uid, char hash[8])
404 CamelVeeMessageInfo *vinfo;
406 vuid = g_alloca(strlen(uid)+9);
407 memcpy(vuid, hash, 8);
409 vinfo = (CamelVeeMessageInfo *)camel_folder_summary_uid(((CamelFolder *)vf)->summary, vuid);
411 camel_folder_change_info_remove_uid(((CamelVeeFolder *)vf)->changes, vuid);
412 camel_folder_summary_remove(((CamelFolder *)vf)->summary, (CamelMessageInfo *)vinfo);
413 camel_message_info_free(vinfo);
418 vtrash_uid_added(CamelVTrashFolder *vf, const char *uid, CamelMessageInfo *info, char hash[8])
421 CamelVeeMessageInfo *vinfo;
423 vuid = g_alloca(strlen(uid)+9);
424 memcpy(vuid, hash, 8);
426 vinfo = (CamelVeeMessageInfo *)camel_folder_summary_uid(((CamelFolder *)vf)->summary, vuid);
428 camel_vee_summary_add((CamelVeeSummary *)((CamelFolder *)vf)->summary, info, hash);
429 camel_folder_change_info_add_uid(((CamelVeeFolder *)vf)->changes, vuid);
431 camel_folder_change_info_change_uid(((CamelVeeFolder *)vf)->changes, vuid);
432 camel_message_info_free(vinfo);
437 vtrash_folder_changed(CamelVeeFolder *vf, CamelFolder *sub, CamelFolderChangeInfo *changes)
439 CamelMessageInfo *info;
441 CamelFolderChangeInfo *vf_changes = NULL;
444 camel_vee_folder_hash_folder(sub, hash);
446 CAMEL_VEE_FOLDER_LOCK(vf, summary_lock);
448 /* remove any removed that we also have */
449 for (i=0;i<changes->uid_removed->len;i++)
450 vtrash_uid_removed((CamelVTrashFolder *)vf, (const char *)changes->uid_removed->pdata[i], hash);
452 /* check any changed still deleted/junked */
453 for (i=0;i<changes->uid_changed->len;i++) {
454 const char *uid = changes->uid_changed->pdata[i];
456 info = camel_folder_get_message_info(sub, uid);
460 if ((camel_message_info_flags(info) & ((CamelVTrashFolder *)vf)->bit) == 0)
461 vtrash_uid_removed((CamelVTrashFolder *)vf, uid, hash);
463 vtrash_uid_added((CamelVTrashFolder *)vf, uid, info, hash);
465 camel_message_info_free(info);
468 /* add any new ones which are already matching */
469 for (i=0;i<changes->uid_added->len;i++) {
470 const char *uid = changes->uid_added->pdata[i];
472 info = camel_folder_get_message_info(sub, uid);
476 if ((camel_message_info_flags(info) & ((CamelVTrashFolder *)vf)->bit) != 0)
477 vtrash_uid_added((CamelVTrashFolder *)vf, uid, info, hash);
479 camel_message_info_free(info);
482 if (camel_folder_change_info_changed(((CamelVeeFolder *)vf)->changes)) {
483 vf_changes = ((CamelVeeFolder *)vf)->changes;
484 ((CamelVeeFolder *)vf)->changes = camel_folder_change_info_new();
487 CAMEL_VEE_FOLDER_UNLOCK(vf, summary_lock);
490 camel_object_trigger_event(vf, "folder_changed", vf_changes);
491 camel_folder_change_info_free(vf_changes);
496 vtrash_add_folder(CamelVeeFolder *vf, CamelFolder *sub)
501 CamelFolderChangeInfo *vf_changes = NULL;
503 camel_vee_folder_hash_folder(sub, hash);
505 CAMEL_VEE_FOLDER_LOCK(vf, summary_lock);
507 infos = camel_folder_get_summary(sub);
508 for (i=0;i<infos->len;i++) {
509 CamelMessageInfo *info = infos->pdata[i];
511 if ((camel_message_info_flags(info) & ((CamelVTrashFolder *)vf)->bit))
512 vtrash_uid_added((CamelVTrashFolder *)vf, camel_message_info_uid(info), info, hash);
514 camel_folder_free_summary(sub, infos);
516 if (camel_folder_change_info_changed(vf->changes)) {
517 vf_changes = vf->changes;
518 vf->changes = camel_folder_change_info_new();
521 CAMEL_VEE_FOLDER_UNLOCK(vf, summary_lock);
524 camel_object_trigger_event(vf, "folder_changed", vf_changes);
525 camel_folder_change_info_free(vf_changes);
530 vtrash_remove_folder(CamelVeeFolder *vf, CamelFolder *sub)
535 CamelFolderChangeInfo *vf_changes = NULL;
536 CamelFolderSummary *ssummary = sub->summary;
539 camel_vee_folder_hash_folder(sub, hash);
541 CAMEL_VEE_FOLDER_LOCK(vf, summary_lock);
545 infos = camel_folder_get_summary(sub);
546 for (i=0;i<infos->len;i++) {
547 CamelVeeMessageInfo *mi = infos->pdata[i];
549 if (mi == NULL || mi->real == NULL)
552 if (mi->real->summary == ssummary) {
553 const char *uid = camel_message_info_uid(mi);
555 camel_folder_change_info_remove_uid(vf->changes, uid);
559 } else if (last+1 == i) {
562 camel_folder_summary_remove_range(((CamelFolder *)vf)->summary, start, last);
568 camel_folder_free_summary(sub, infos);
571 camel_folder_summary_remove_range(((CamelFolder *)vf)->summary, start, last);
573 if (camel_folder_change_info_changed(vf->changes)) {
574 vf_changes = vf->changes;
575 vf->changes = camel_folder_change_info_new();
578 CAMEL_VEE_FOLDER_UNLOCK(vf, summary_lock);
581 camel_object_trigger_event(vf, "folder_changed", vf_changes);
582 camel_folder_change_info_free(vf_changes);
587 vtrash_rebuild_folder(CamelVeeFolder *vf, CamelFolder *source, CamelException *ex)
589 /* we should always be in sync */
594 camel_vtrash_folder_class_init (CamelVTrashFolderClass *klass)
596 CamelFolderClass *folder_class = (CamelFolderClass *) klass;
598 camel_vtrash_folder_parent = CAMEL_VEE_FOLDER_CLASS(camel_vee_folder_get_type());
600 ((CamelObjectClass *)klass)->getv = vtrash_getv;
602 folder_class->append_message = vtrash_append_message;
603 folder_class->transfer_messages_to = vtrash_transfer_messages_to;
604 folder_class->search_by_expression = vtrash_search_by_expression;
605 folder_class->search_by_uids = vtrash_search_by_uids;
607 ((CamelVeeFolderClass *)klass)->add_folder = vtrash_add_folder;
608 ((CamelVeeFolderClass *)klass)->remove_folder = vtrash_remove_folder;
609 ((CamelVeeFolderClass *)klass)->rebuild_folder = vtrash_rebuild_folder;
611 ((CamelVeeFolderClass *)klass)->folder_changed = vtrash_folder_changed;