aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-filter-driver.c
blob: 8d8822b72d89ed12f530db99a1a3ca05cce83871 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 *  Copyright (C) 2000 Ximian Inc.
 *
 *  Authors: Michael Zucchi <notzed@ximian.com>
 *           Jeffrey Stedfast <fejj@ximian.com>
 *
 *  This program is free software; you can redistribute it and/or 
 *  modify it under the terms of the GNU General Public License as 
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  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 <string.h>
#include <time.h>

#include <glib.h>

#include "camel-filter-driver.h"
#include "camel-filter-search.h"

#include "camel-exception.h"
#include "camel-service.h"
#include "camel-mime-message.h"

#include "e-util/e-sexp.h"
#include "e-util/e-memory.h"
#include "e-util/e-msgport.h"   /* for edlist */

#define d(x)

/* an invalid pointer */
#define FOLDER_INVALID ((void *)~0)

/* type of status for a log report */
enum filter_log_t {
    FILTER_LOG_NONE,
    FILTER_LOG_START,       /* start of new log entry */
    FILTER_LOG_ACTION,      /* an action performed */
    FILTER_LOG_END,         /* end of log */
};

/* list of rule nodes */
struct _filter_rule {
    struct _filter_rule *next;
    struct _filter_rule *prev;

    char *match;
    char *action;
    char *name;
};

struct _CamelFilterDriverPrivate {
    GHashTable *globals;       /* global variables */

    CamelFolder *defaultfolder; /* defualt folder */
    
    CamelFilterStatusFunc *statusfunc;  /* status callback */
    void *statusdata;       /* status callback data */
    
    /* for callback */
    CamelFilterGetFolderFunc get_folder;
    void *data;
    
    /* run-time data */
    GHashTable *folders;       /* folders that message has been copied to */
    int closed;        /* close count */
    GHashTable *forwards;      /* addresses that have been forwarded the message */
    
    gboolean terminated;       /* message processing was terminated */
    gboolean deleted;          /* message was marked for deletion */
    gboolean copied;           /* message was copied to some folder or another */
    
    CamelMimeMessage *message; /* input message */
    CamelMessageInfo *info;    /* message summary info */
    const char *uid;           /* message uid */
    CamelFolder *source;       /* message source folder */
    
    FILE *logfile;             /* log file */
    
    EDList rules;          /* list of _filter_rule structs */

    CamelException *ex;
    
    /* evaluator */
    ESExp *eval;
};

#define _PRIVATE(o) (((CamelFilterDriver *)(o))->priv)

static void camel_filter_driver_class_init (CamelFilterDriverClass *klass);
static void camel_filter_driver_init       (CamelFilterDriver *obj);
static void camel_filter_driver_finalise   (CamelObject *obj);

static void camel_filter_driver_log (CamelFilterDriver *driver, enum filter_log_t status, const char *desc, ...);

static CamelFolder *open_folder (CamelFilterDriver *d, const char *folder_url);
static int close_folders (CamelFilterDriver *d);

static ESExpResult *do_delete (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *mark_forward (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_copy (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_move (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_stop (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_colour (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_score (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);
static ESExpResult *do_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *);

/* these are our filter actions - each must have a callback */
static struct {
    char *name;
    ESExpFunc *func;
    int type;       /* set to 1 if a function can perform shortcut evaluation, or
                   doesn't execute everything, 0 otherwise */
} symbols[] = {
    { "delete",          (ESExpFunc *) do_delete,    0 },
    { "forward-to",      (ESExpFunc *) mark_forward, 0 },
    { "copy-to",         (ESExpFunc *) do_copy,      0 },
    { "move-to",         (ESExpFunc *) do_move,      0 },
    { "stop",            (ESExpFunc *) do_stop,      0 },
    { "set-colour",      (ESExpFunc *) do_colour,    0 },
    { "set-score",       (ESExpFunc *) do_score,     0 },
    { "set-system-flag", (ESExpFunc *) do_flag,      0 }
};

static CamelObjectClass *camel_filter_driver_parent;

guint
camel_filter_driver_get_type (void)
{
    static CamelType type = CAMEL_INVALID_TYPE;

    if (type == CAMEL_INVALID_TYPE) {
        type = camel_type_register(CAMEL_OBJECT_TYPE, "CamelFilterDriver",
                       sizeof(CamelFilterDriver),
                       sizeof(CamelFilterDriverClass),
                       (CamelObjectClassInitFunc)camel_filter_driver_class_init,
                       NULL,
                       (CamelObjectInitFunc)camel_filter_driver_init,
                       (CamelObjectFinalizeFunc)camel_filter_driver_finalise);
    }
    
    return type;
}

static void
camel_filter_driver_class_init (CamelFilterDriverClass *klass)
{
    /*CamelObjectClass *object_class = (CamelObjectClass *) klass;*/

    camel_filter_driver_parent = camel_type_get_global_classfuncs(camel_object_get_type());
}

static void
camel_filter_driver_init (CamelFilterDriver *obj)
{
    struct _CamelFilterDriverPrivate *p;
    int i;
    
    p = _PRIVATE (obj) = g_malloc0 (sizeof (*p));

    e_dlist_init(&p->rules);

    p->eval = e_sexp_new ();
    /* Load in builtin symbols */
    for (i = 0; i < sizeof (symbols) / sizeof (symbols[0]); i++) {
        if (symbols[i].type == 1) {
            e_sexp_add_ifunction (p->eval, 0, symbols[i].name, (ESExpIFunc *)symbols[i].func, obj);
        } else {
            e_sexp_add_function (p->eval, 0, symbols[i].name, symbols[i].func, obj);
        }
    }
    
    p->globals = g_hash_table_new (g_str_hash, g_str_equal);
    
    p->folders = g_hash_table_new (g_str_hash, g_str_equal);
}

static void
free_hash_strings (void *key, void *value, void *data)
{
    g_free (key);
    g_free (value);
}

static void
camel_filter_driver_finalise (CamelObject *obj)
{
    CamelFilterDriver *driver = (CamelFilterDriver *) obj;
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);    
    struct _filter_rule *node;

    /* close all folders that were opened for appending */
    close_folders (driver);
    g_hash_table_destroy (p->folders);
    
    g_hash_table_foreach (p->globals, free_hash_strings, driver);
    g_hash_table_destroy (p->globals);

    e_sexp_unref(p->eval);
    
    if (p->defaultfolder) {
        camel_folder_thaw (p->defaultfolder);
        camel_object_unref (CAMEL_OBJECT (p->defaultfolder));
    }

    while ((node = (struct _filter_rule *)e_dlist_remhead(&p->rules))) {
        g_free(node->match);
        g_free(node->action);
        g_free(node->name);
        g_free(node);
    }
    
    g_free (p);
}

/**
 * camel_filter_driver_new:
 *
 * Return value: A new CamelFilterDriver object
 **/
CamelFilterDriver *
camel_filter_driver_new (void)
{
    return CAMEL_FILTER_DRIVER (camel_object_new(camel_filter_driver_get_type ()));
}

void
camel_filter_driver_set_folder_func (CamelFilterDriver *d, CamelFilterGetFolderFunc get_folder, void *data)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);

    p->get_folder = get_folder;
    p->data = data;
}

void
camel_filter_driver_set_logfile (CamelFilterDriver *d, FILE *logfile)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);
    
    p->logfile = logfile;
}

void
camel_filter_driver_set_status_func (CamelFilterDriver *d, CamelFilterStatusFunc *func, void *data)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);
    
    p->statusfunc = func;
    p->statusdata = data;
}

void
camel_filter_driver_set_default_folder (CamelFilterDriver *d, CamelFolder *def)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);
    
    if (p->defaultfolder) {
        camel_folder_thaw (p->defaultfolder);
        camel_object_unref (CAMEL_OBJECT (p->defaultfolder));
    }
    
    p->defaultfolder = def;
    
    if (p->defaultfolder) {
        camel_folder_freeze (p->defaultfolder);
        camel_object_ref (CAMEL_OBJECT (p->defaultfolder));
    }
}

void
camel_filter_driver_add_rule(CamelFilterDriver *d, const char *name, const char *match, const char *action)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);
    struct _filter_rule *node;

    node = g_malloc(sizeof(*node));
    node->match = g_strdup(match);
    node->action = g_strdup(action);
    node->name = g_strdup(name);
    e_dlist_addtail(&p->rules, (EDListNode *)node);
}

static void
report_status (CamelFilterDriver *driver, enum camel_filter_status_t status, int pc, const char *desc, ...)
{
    /* call user-defined status report function */
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    va_list ap;
    char *str;
    
    if (p->statusfunc) {
        va_start (ap, desc);
        str = g_strdup_vprintf (desc, ap);
        p->statusfunc (driver, status, pc, str, p->statusdata);
        g_free (str);
    }
}


#if 0
void
camel_filter_driver_set_global (CamelFilterDriver *d, const char *name, const char *value)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (d);
    char *oldkey, *oldvalue;
    
    if (g_hash_table_lookup_extended (p->globals, name, (void *)&oldkey, (void *)&oldvalue)) {
        g_free (oldvalue);
        g_hash_table_insert (p->globals, oldkey, g_strdup (value));
    } else {
        g_hash_table_insert (p->globals, g_strdup (name), g_strdup (value));
    }
}
#endif

static ESExpResult *
do_delete (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    d(fprintf (stderr, "doing delete\n"));
    p->deleted = TRUE;
    camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Delete");
    
    return NULL;
}

static ESExpResult *
mark_forward (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    /*struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);*/
    
    d(fprintf (stderr, "marking message for forwarding\n"));
    /* FIXME: do stuff here */
    camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Forward");
    
    return NULL;
}

static ESExpResult *
do_copy (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    int i;
    
    d(fprintf (stderr, "copying message...\n"));
    
    for (i = 0; i < argc; i++) {
        if (argv[i]->type == ESEXP_RES_STRING) {
            /* open folders we intent to copy to */
            char *folder = argv[i]->value.string;
            CamelFolder *outbox;
            
            outbox = open_folder (driver, folder);
            if (!outbox)
                break;
            
            if (p->uid && p->source && camel_folder_has_summary_capability (p->source)) {
                GPtrArray *uids;
                
                uids = g_ptr_array_new ();
                g_ptr_array_add (uids, (char *) p->uid);
                camel_folder_copy_messages_to (p->source, uids, outbox, p->ex);
                g_ptr_array_free (uids, TRUE);
            } else
                camel_folder_append_message (outbox, p->message, p->info, p->ex);
            
            if (!camel_exception_is_set (p->ex))
                p->copied = TRUE;
            
            camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Copy to folder %s",
                         folder);
        }
    }
    
    return NULL;
}

static ESExpResult *
do_move (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    int i;
    
    d(fprintf (stderr, "moving message...\n"));
    
    for (i = 0; i < argc; i++) {
        if (argv[i]->type == ESEXP_RES_STRING) {
            /* open folders we intent to move to */
            char *folder = argv[i]->value.string;
            CamelFolder *outbox;
            
            outbox = open_folder (driver, folder);
            if (!outbox)
                break;
            
            if (outbox == p->source)
                break;
            
            if (p->uid && p->source && camel_folder_has_summary_capability (p->source)) {
                GPtrArray *uids;
                
                uids = g_ptr_array_new ();
                g_ptr_array_add (uids, (char *) p->uid);
                camel_folder_copy_messages_to (p->source, uids, outbox, p->ex);
                g_ptr_array_free (uids, TRUE);
            } else
                camel_folder_append_message (outbox, p->message, p->info, p->ex);
            
            if (!camel_exception_is_set (p->ex)) {
                /* a 'move' is a copy & delete */
                p->copied = TRUE;
                p->deleted = TRUE;
            }
            
            camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Move to folder %s",
                         folder);
        }
    }
    
    return NULL;
}

static ESExpResult *
do_stop (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Stopped processing");
    d(fprintf (stderr, "terminating message processing\n"));
    p->terminated = TRUE;
    
    return NULL;
}

static ESExpResult *
do_colour (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    d(fprintf (stderr, "setting colour tag\n"));
    if (argc > 0 && argv[0]->type == ESEXP_RES_STRING) {
        if (p->source && p->uid && camel_folder_has_summary_capability (p->source))
            camel_folder_set_message_user_tag(p->source, p->uid, "colour", argv[0]->value.string);
        else
            camel_tag_set (&p->info->user_tags, "colour", argv[0]->value.string);
        camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Set colour to %s", argv[0]->value.string);
    }
    
    return NULL;
}

static ESExpResult *
do_score (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    d(fprintf (stderr, "setting score tag\n"));
    if (argc > 0 && argv[0]->type == ESEXP_RES_INT) {
        char *value;
        
        value = g_strdup_printf ("%d", argv[0]->value.number);
        if (p->source && p->uid && camel_folder_has_summary_capability (p->source))
            camel_folder_set_message_user_tag(p->source, p->uid, "score", value);
        else
            camel_tag_set (&p->info->user_tags, "score", value);
        camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Set score to %d", argv[0]->value.number);
        g_free (value);
    }
    
    return NULL;
}

static ESExpResult *
do_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    d(fprintf (stderr, "setting flag\n"));
    if (argc == 1 && argv[0]->type == ESEXP_RES_STRING) {
        if (p->source && p->uid && camel_folder_has_summary_capability (p->source))
            camel_folder_set_message_flags(p->source, p->uid, camel_system_flag(argv[0]->value.string), ~0);
        else
            p->info->flags |= camel_system_flag (argv[0]->value.string)|CAMEL_MESSAGE_FOLDER_FLAGGED;
        camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Set %s flag", argv[0]->value.string);
    }
    
    return NULL;
}

static CamelFolder *
open_folder (CamelFilterDriver *driver, const char *folder_url)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    CamelFolder *camelfolder;
    CamelException ex;
    
    /* we have a lookup table of currently open folders */
    camelfolder = g_hash_table_lookup (p->folders, folder_url);
    if (camelfolder)
        return camelfolder == FOLDER_INVALID?NULL:camelfolder;
    
    camel_exception_init (&ex);
    camelfolder = p->get_folder (driver, folder_url, p->data, &ex);
    camel_exception_clear (&ex);
    
    if (camelfolder) {
        g_hash_table_insert (p->folders, g_strdup (folder_url), camelfolder);
        camel_folder_freeze (camelfolder);
    } else {
        g_hash_table_insert (p->folders, g_strdup (folder_url), FOLDER_INVALID);
    }
    
    return camelfolder;
}

static void
close_folder (void *key, void *value, void *data)
{   
    CamelFolder *folder = value;
    CamelFilterDriver *driver = data;
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);

    p->closed++;
    g_free (key);

    if (folder != FOLDER_INVALID) {
        camel_folder_sync (folder, FALSE, p->ex);
        camel_folder_thaw (folder);
        camel_object_unref (CAMEL_OBJECT (folder));
    }

    report_status(driver, CAMEL_FILTER_STATUS_PROGRESS, g_hash_table_size(p->folders)* 100 / p->closed, _("Syncing folders"));
}

/* flush/close all folders */
static int
close_folders (CamelFilterDriver *driver)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);

    report_status(driver, CAMEL_FILTER_STATUS_PROGRESS, 0, _("Syncing folders"));

    p->closed = 0;
    g_hash_table_foreach (p->folders, close_folder, driver);
    g_hash_table_destroy (p->folders);
    p->folders = g_hash_table_new (g_str_hash, g_str_equal);
    
    /* FIXME: status from driver */
    return 0;
}

#if 0
static void
free_key (gpointer key, gpointer value, gpointer user_data)
{
    g_free (key);
}
#endif


static void
camel_filter_driver_log (CamelFilterDriver *driver, enum filter_log_t status, const char *desc, ...)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    
    if (p->logfile) {
        char *str = NULL;
        
        if (desc) {
            va_list ap;
            
            va_start (ap, desc);
            str = g_strdup_vprintf (desc, ap);
        }
        
        switch (status) {
        case FILTER_LOG_START: {
            /* write log header */
            const char *subject = NULL;
            char *fromstr;
            const CamelInternetAddress *from;
            char date[50];
            time_t t;
            
            /* FIXME: does this need locking?  Probably */
            
            from = camel_mime_message_get_from (p->message);
            fromstr = camel_address_format((CamelAddress *)from);
            subject = camel_mime_message_get_subject (p->message);
            
            time (&t);
            strftime (date, 49, "%a, %d %b %Y %H:%M:%S", localtime (&t));
            fprintf (p->logfile, "Applied filter \"%s\" to message from %s - \"%s\" at %s\n",
                 str, fromstr ? fromstr : "unknown", subject ? subject : "", date);
            g_free(fromstr);
            break;
        }
        case FILTER_LOG_ACTION:
            fprintf (p->logfile, "Action: %s\n", str);
            break;
        case FILTER_LOG_END:
            fprintf (p->logfile, "\n");
            break;
        default:
            /* nothing else is loggable */
            break;
        }
        
        g_free (str);
    }
}


/**
 * camel_filter_driver_filter_mbox:
 * @driver: CamelFilterDriver
 * @mbox: mbox filename to be filtered
 * @ex: exception
 *
 * Filters an mbox file based on rules defined in the FilterDriver
 * object. Is more efficient as it doesn't need to open the folder
 * through Camel directly.
 *
 * Returns -1 if errors were encountered during filtering,
 * otherwise returns 0.
 *
 **/
int
camel_filter_driver_filter_mbox (CamelFilterDriver *driver, const char *mbox, const char *original_source_url, CamelException *ex)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    CamelMimeParser *mp = NULL;
    char *source_url = NULL;
    int fd = -1;
    int i = 0;
    struct stat st;
    int status;
    off_t last = 0;
    
    fd = open (mbox, O_RDONLY);
    if (fd == -1) {
        camel_exception_set (ex, CAMEL_EXCEPTION_SYSTEM, _("Unable to open spool folder"));
        goto fail;
    }
    /* to get the filesize */
    fstat (fd, &st);
    
    mp = camel_mime_parser_new ();
    camel_mime_parser_scan_from (mp, TRUE);
    if (camel_mime_parser_init_with_fd (mp, fd) == -1) {
        camel_exception_set (ex, CAMEL_EXCEPTION_SYSTEM, _("Unable to process spool folder"));
        goto fail;
    }
    fd = -1;
    
    source_url = g_strdup_printf ("file://%s", mbox);
    
    while (camel_mime_parser_step (mp, 0, 0) == HSCAN_FROM) {
        CamelMessageInfo *info;
        CamelMimeMessage *msg;
        int pc = 0;
        
        if (st.st_size > 0)
            pc = (int)(100.0 * ((double)camel_mime_parser_tell (mp) / (double)st.st_size));
        
        report_status (driver, CAMEL_FILTER_STATUS_START, pc, _("Getting message %d (%d%%)"), i, pc);
        
        msg = camel_mime_message_new ();
        if (camel_mime_part_construct_from_parser (CAMEL_MIME_PART (msg), mp) == -1) {
            report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Failed on message %d"), i);
            camel_exception_set (ex, CAMEL_EXCEPTION_SYSTEM, _("Cannot open message"));
            camel_object_unref (CAMEL_OBJECT (msg));
            goto fail;
        }
        
        info = camel_message_info_new_from_header(((CamelMimePart *)msg)->headers);
        info->size = camel_mime_parser_tell(mp) - last;
        last = camel_mime_parser_tell(mp);
        status = camel_filter_driver_filter_message (driver, msg, info, NULL, NULL, source_url, 
                                 original_source_url ? original_source_url : source_url, ex);
        camel_object_unref (CAMEL_OBJECT (msg));
        if (camel_exception_is_set (ex) || status == -1) {
            report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Failed on message %d"), i);
            camel_message_info_free (info);
            goto fail;
        }
        
        i++;
        
        /* skip over the FROM_END state */
        camel_mime_parser_step (mp, 0, 0);

        camel_message_info_free (info);
    }
    
    if (p->defaultfolder) {
        report_status(driver, CAMEL_FILTER_STATUS_PROGRESS, 100, _("Syncing folder"));
        camel_folder_sync(p->defaultfolder, FALSE, ex);
    }
    
    report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Complete"));
    
    g_free (source_url);
    return 0;
    
fail:
    g_free (source_url);
    if (fd != -1)
        close (fd);
    if (mp)
        camel_object_unref (CAMEL_OBJECT (mp));
    
    return -1;
}


/**
 * camel_filter_driver_filter_folder:
 * @driver: CamelFilterDriver
 * @folder: CamelFolder to be filtered
 * @cache: UID cache (needed for POP folders)
 * @uids: message uids to be filtered or NULL (as a shortcut to filter all messages)
 * @remove: TRUE to mark filtered messages as deleted
 * @ex: exception
 *
 * Filters a folder based on rules defined in the FilterDriver
 * object.
 *
 * Returns -1 if errors were encountered during filtering,
 * otherwise returns 0.
 *
 **/
int
camel_filter_driver_filter_folder (CamelFilterDriver *driver, CamelFolder *folder, CamelUIDCache *cache,
                   GPtrArray *uids, gboolean remove, CamelException *ex)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    int i;
    int freeuids = FALSE;
    CamelMimeMessage *message;
    CamelMessageInfo *info;
    char *source_url, *service_url;
    const char *folder_name;
    int status = 0;
    int need_sep = 0;
    
    service_url = camel_service_get_url (CAMEL_SERVICE (camel_folder_get_parent_store (folder)));
    folder_name = camel_folder_get_full_name (folder);
    
    /* Add a separator unless the first char of folder_name or the last char of service_url is '/' */
    need_sep = (folder_name && *folder_name != '/');
    if (service_url && *service_url && !need_sep) {
        need_sep = (service_url[strlen (service_url)-1] != '/');
    }
    source_url = g_strdup_printf ("%s%s%s",
                      service_url,
                      need_sep ? "/" : "",
                      folder_name);
    g_free (service_url);
    
    if (uids == NULL) {
        uids = camel_folder_get_uids (folder);
        freeuids = TRUE;
    }
    
    for (i = 0; i < uids->len; i++) {
        int pc = (100 * i)/uids->len;
        
        report_status (driver, CAMEL_FILTER_STATUS_START, pc, _("Getting message %d of %d"), i+1,
                   uids->len);
        
        message = camel_folder_get_message (folder, uids->pdata[i], ex);
        if (!message || camel_exception_is_set (ex)) {
            report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Failed at message %d of %d"),
                       i+1, uids->len);
            status = -1;
            break;
        }
        
        if (camel_folder_has_summary_capability (folder))
            info = camel_folder_get_message_info (folder, uids->pdata[i]);
        else
            info = NULL;
        
        status = camel_filter_driver_filter_message (driver, message, info, uids->pdata[i],
                                 folder, source_url, source_url, ex);
        
        if (camel_folder_has_summary_capability (folder))
            camel_folder_free_message_info (folder, info);
        
        if (camel_exception_is_set (ex) || status == -1) {
            report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Failed at message %d of %d"),
                       i+1, uids->len);
            status = -1;
            break;
        }
        
        if (remove)
            camel_folder_set_message_flags (folder, uids->pdata[i],
                            CAMEL_MESSAGE_DELETED | CAMEL_MESSAGE_SEEN, ~0);
        
        if (cache)
            camel_uid_cache_save_uid (cache, uids->pdata[i]);
        
        camel_object_unref (CAMEL_OBJECT (message));
    }
    
    if (freeuids)
        camel_folder_free_uids (folder, uids);
    
    if (p->defaultfolder) {
        report_status (driver, CAMEL_FILTER_STATUS_PROGRESS, 100, _("Syncing folder"));
        camel_folder_sync (p->defaultfolder, FALSE, camel_exception_is_set (ex) ? NULL : ex);
    }
    
    if (i == uids->len)
        report_status (driver, CAMEL_FILTER_STATUS_END, 100, _("Complete"));
    
    g_free (source_url);

    return status;
}


/**
 * camel_filter_driver_filter_message:
 * @driver: CamelFilterDriver
 * @message: message to filter
 * @info: message info or NULL
 * @uid: message uid or NULL
 * @source: source folder or NULL
 * @source_url: url of source folder or NULL
 * @original_source_url: url of original source folder (pre-movemail) or NULL
 * @ex: exception
 *
 * Filters a message based on rules defined in the FilterDriver
 * object. If the source folder (@source) and the uid (@uid) are
 * provided, the filter will operate on the CamelFolder (which in
 * certain cases is more efficient than using the default
 * camel_folder_append_message() function).
 *
 * Returns -1 if errors were encountered during filtering,
 * otherwise returns 0.
 *
 **/
int
camel_filter_driver_filter_message (CamelFilterDriver *driver, CamelMimeMessage *message,
                    CamelMessageInfo *info, const char *uid,
                    CamelFolder *source, const char *source_url,
                    const char *original_source_url,
                    CamelException *ex)
{
    struct _CamelFilterDriverPrivate *p = _PRIVATE (driver);
    struct _filter_rule *node;
    gboolean freeinfo = FALSE;
    gboolean filtered = FALSE;
    ESExpResult *r;
    int result;
    
    if (info == NULL) {
        struct _header_raw *h = CAMEL_MIME_PART (message)->headers;
        
        info = camel_message_info_new_from_header (h);
        freeinfo = TRUE;
    } else {
        if (info->flags & CAMEL_MESSAGE_DELETED)
            return 0;
    }
    
    p->ex = ex;
    p->terminated = FALSE;
    p->deleted = FALSE;
    p->copied = FALSE;
    p->message = message;
    p->info = info;
    p->uid = uid;
    p->source = source;
    
    if (original_source_url && camel_mime_message_get_source (message) == NULL)
        camel_mime_message_set_source (message, original_source_url);
    
    node = (struct _filter_rule *)p->rules.head;
    result = CAMEL_SEARCH_NOMATCH;
    while (node->next && !p->terminated) {
        d(fprintf (stderr, "applying rule %s\naction %s\n", node->match, node->action));
        
        result = camel_filter_search_match (p->message, p->info, 
                            original_source_url ? original_source_url : source_url,
                            node->match, p->ex);

        switch (result) {
        case CAMEL_SEARCH_ERROR:
            goto error;
        case CAMEL_SEARCH_MATCHED:
            filtered = TRUE;
            camel_filter_driver_log (driver, FILTER_LOG_START, node->name);
            
            /* perform necessary filtering actions */
            e_sexp_input_text (p->eval, node->action, strlen (node->action));
            if (e_sexp_parse (p->eval) == -1) {
                camel_exception_setv (ex, 1, _("Error parsing filter: %s: %s"),
                              e_sexp_error (p->eval), node->action);
                goto error;
            }
            r = e_sexp_eval (p->eval);
            if (r == NULL) {
                camel_exception_setv (ex, 1, _("Error executing filter: %s: %s"),
                              e_sexp_error (p->eval), node->action);
                goto error;
            }
            e_sexp_result_free (p->eval, r);
        default:
            break;
        }
        
        node = node->next;
    }
    
    /* *Now* we can set the DELETED flag... */
    if (p->deleted) {
        if (p->source && p->uid)
            camel_folder_set_message_flags(p->source, p->uid, CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_SEEN, ~0);
        else
            info->flags |= CAMEL_MESSAGE_DELETED|CAMEL_MESSAGE_SEEN|CAMEL_MESSAGE_FOLDER_FLAGGED;
    }
    
    /* Logic: if !Moved and there exists a default folder... */
    if (!(p->copied && p->deleted) && p->defaultfolder) {
        /* copy it to the default inbox */
        filtered = TRUE;
        camel_filter_driver_log (driver, FILTER_LOG_ACTION, "Copy to default folder");
        if (p->uid && p->source && camel_folder_has_summary_capability (p->source)) {
            GPtrArray *uids;
            
            uids = g_ptr_array_new ();
            g_ptr_array_add (uids, (char *) p->uid);
            camel_folder_copy_messages_to (p->source, uids, p->defaultfolder, p->ex);
            g_ptr_array_free (uids, TRUE);
        } else {
            camel_folder_append_message (p->defaultfolder, p->message, p->info, p->ex);
        }
    }
    
    if (freeinfo)
        camel_message_info_free (info);
    
    return 0;
    
error:  
    if (filtered)
        camel_filter_driver_log (driver, FILTER_LOG_END, NULL);
    
    if (freeinfo)
        camel_message_info_free (info);
    
    return -1;
}