6c793c0df9a97dc33b9569195b23e92a468708a9
[citadel.git] / citadel / modules / sieve / serv_sieve.c
1 /*
2  * $Id$
3  *
4  * This module glues libSieve to the Citadel server in order to implement
5  * the Sieve mailbox filtering language (RFC 3028).
6  *
7  * This code is released under the terms of the GNU General Public License. 
8  */
9
10 #include "sysdep.h"
11 #include <stdlib.h>
12 #include <unistd.h>
13 #include <stdio.h>
14 #include <fcntl.h>
15 #include <ctype.h>
16 #include <pwd.h>
17 #include <errno.h>
18 #include <sys/types.h>
19
20 #if TIME_WITH_SYS_TIME
21 # include <sys/time.h>
22 # include <time.h>
23 #else
24 # if HAVE_SYS_TIME_H
25 #  include <sys/time.h>
26 # else
27 #  include <time.h>
28 # endif
29 #endif
30
31 #include <sys/wait.h>
32 #include <string.h>
33 #include <limits.h>
34 #include <libcitadel.h>
35 #include "citadel.h"
36 #include "server.h"
37 #include "citserver.h"
38 #include "support.h"
39 #include "config.h"
40 #include "room_ops.h"
41 #include "policy.h"
42 #include "database.h"
43 #include "msgbase.h"
44 #include "internet_addressing.h"
45 #include "ctdl_module.h"
46 #include "serv_sieve.h"
47
48 struct RoomProcList *sieve_list = NULL;
49 char *msiv_extensions = NULL;
50
51
52 /*
53  * Callback function to send libSieve trace messages to Citadel log facility
54  */
55 int ctdl_debug(sieve2_context_t *s, void *my)
56 {
57         CtdlLogPrintf(CTDL_DEBUG, "Sieve: %s\n", sieve2_getvalue_string(s, "message"));
58         return SIEVE2_OK;
59 }
60
61
62 /*
63  * Callback function to log script parsing errors
64  */
65 int ctdl_errparse(sieve2_context_t *s, void *my)
66 {
67         CtdlLogPrintf(CTDL_WARNING, "Error in script, line %d: %s\n",
68                 sieve2_getvalue_int(s, "lineno"),
69                 sieve2_getvalue_string(s, "message")
70         );
71         return SIEVE2_OK;
72 }
73
74
75 /*
76  * Callback function to log script execution errors
77  */
78 int ctdl_errexec(sieve2_context_t *s, void *my)
79 {
80         CtdlLogPrintf(CTDL_WARNING, "Error executing script: %s\n",
81                 sieve2_getvalue_string(s, "message")
82         );
83         return SIEVE2_OK;
84 }
85
86
87 /*
88  * Callback function to redirect a message to a different folder
89  */
90 int ctdl_redirect(sieve2_context_t *s, void *my)
91 {
92         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
93         struct CtdlMessage *msg = NULL;
94         struct recptypes *valid = NULL;
95         char recp[256];
96
97         safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
98
99         CtdlLogPrintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
100
101         valid = validate_recipients(recp, NULL, 0);
102         if (valid == NULL) {
103                 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
104                 return SIEVE2_ERROR_BADARGS;
105         }
106         if (valid->num_error > 0) {
107                 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
108                 free_recipients(valid);
109                 return SIEVE2_ERROR_BADARGS;
110         }
111
112         msg = CtdlFetchMessage(cs->msgnum, 1);
113         if (msg == NULL) {
114                 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
115                 free_recipients(valid);
116                 return SIEVE2_ERROR_BADARGS;
117         }
118
119         CtdlSubmitMsg(msg, valid, NULL, 0);
120         cs->cancel_implicit_keep = 1;
121         free_recipients(valid);
122         CtdlFreeMessage(msg);
123         return SIEVE2_OK;
124 }
125
126
127 /*
128  * Callback function to indicate that a message *will* be kept in the inbox
129  */
130 int ctdl_keep(sieve2_context_t *s, void *my)
131 {
132         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
133         
134         CtdlLogPrintf(CTDL_DEBUG, "Action is KEEP\n");
135
136         cs->keep = 1;
137         cs->cancel_implicit_keep = 1;
138         return SIEVE2_OK;
139 }
140
141
142 /*
143  * Callback function to file a message into a different mailbox
144  */
145 int ctdl_fileinto(sieve2_context_t *s, void *my)
146 {
147         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
148         const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
149         int c;
150         char foldername[256];
151         char original_room_name[ROOMNAMELEN];
152
153         CtdlLogPrintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
154
155         /* FILEINTO 'INBOX' is the same thing as KEEP */
156         if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
157                 cs->keep = 1;
158                 cs->cancel_implicit_keep = 1;
159                 return SIEVE2_OK;
160         }
161
162         /* Remember what room we came from */
163         safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
164
165         /* First try a mailbox name match (check personal mail folders first) */
166         snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
167         c = getroom(&CC->room, foldername);
168
169         /* Then a regular room name match (public and private rooms) */
170         if (c != 0) {
171                 safestrncpy(foldername, dest_folder, sizeof foldername);
172                 c = getroom(&CC->room, foldername);
173         }
174
175         if (c != 0) {
176                 CtdlLogPrintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
177                 return SIEVE2_ERROR_BADARGS;
178         }
179
180         /* Yes, we actually have to go there */
181         usergoto(NULL, 0, 0, NULL, NULL);
182
183         c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL);
184
185         /* Go back to the room we came from */
186         if (strcasecmp(original_room_name, CC->room.QRname)) {
187                 usergoto(original_room_name, 0, 0, NULL, NULL);
188         }
189
190         if (c == 0) {
191                 cs->cancel_implicit_keep = 1;
192                 return SIEVE2_OK;
193         }
194         else {
195                 return SIEVE2_ERROR_BADARGS;
196         }
197 }
198
199
200 /*
201  * Callback function to indicate that a message should be discarded.
202  */
203 int ctdl_discard(sieve2_context_t *s, void *my)
204 {
205         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
206
207         CtdlLogPrintf(CTDL_DEBUG, "Action is DISCARD\n");
208
209         /* Cancel the implicit keep.  That's all there is to it. */
210         cs->cancel_implicit_keep = 1;
211         return SIEVE2_OK;
212 }
213
214
215
216 /*
217  * Callback function to indicate that a message should be rejected
218  */
219 int ctdl_reject(sieve2_context_t *s, void *my)
220 {
221         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
222         char *reject_text = NULL;
223
224         CtdlLogPrintf(CTDL_DEBUG, "Action is REJECT\n");
225
226         /* If we don't know who sent the message, do a DISCARD instead. */
227         if (IsEmptyStr(cs->sender)) {
228                 CtdlLogPrintf(CTDL_INFO, "Unknown sender.  Doing DISCARD instead of REJECT.\n");
229                 return ctdl_discard(s, my);
230         }
231
232         /* Assemble the reject message. */
233         reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024);
234         if (reject_text == NULL) {
235                 return SIEVE2_ERROR_FAIL;
236         }
237
238         sprintf(reject_text, 
239                 "Content-type: text/plain\n"
240                 "\n"
241                 "The message was refused by the recipient's mail filtering program.\n"
242                 "The reason given was as follows:\n"
243                 "\n"
244                 "%s\n"
245                 "\n"
246         ,
247                 sieve2_getvalue_string(s, "message")
248         );
249
250         quickie_message(        /* This delivers the message */
251                 NULL,
252                 cs->envelope_to,
253                 cs->sender,
254                 NULL,
255                 reject_text,
256                 FMT_RFC822,
257                 "Delivery status notification"
258         );
259
260         free(reject_text);
261         cs->cancel_implicit_keep = 1;
262         return SIEVE2_OK;
263 }
264
265
266
267 /*
268  * Callback function to indicate that a vacation message should be generated
269  */
270 int ctdl_vacation(sieve2_context_t *s, void *my)
271 {
272         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
273         struct sdm_vacation *vptr;
274         int days = 1;
275         const char *message;
276         char *vacamsg_text = NULL;
277         char vacamsg_subject[1024];
278
279         CtdlLogPrintf(CTDL_DEBUG, "Action is VACATION\n");
280
281         message = sieve2_getvalue_string(s, "message");
282         if (message == NULL) return SIEVE2_ERROR_BADARGS;
283
284         if (sieve2_getvalue_string(s, "subject") != NULL) {
285                 safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject);
286         }
287         else {
288                 snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject);
289         }
290
291         days = sieve2_getvalue_int(s, "days");
292         if (days < 1) days = 1;
293         if (days > MAX_VACATION) days = MAX_VACATION;
294
295         /* Check to see whether we've already alerted this sender that we're on vacation. */
296         for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
297                 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
298                         if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) {
299                                 CtdlLogPrintf(CTDL_DEBUG, "Already alerted <%s> recently.\n", cs->sender);
300                                 return SIEVE2_OK;
301                         }
302                 }
303         }
304
305         /* Assemble the reject message. */
306         vacamsg_text = malloc(strlen(message) + 1024);
307         if (vacamsg_text == NULL) {
308                 return SIEVE2_ERROR_FAIL;
309         }
310
311         sprintf(vacamsg_text, 
312                 "Content-type: text/plain\n"
313                 "\n"
314                 "%s\n"
315                 "\n"
316         ,
317                 message
318         );
319
320         quickie_message(        /* This delivers the message */
321                 NULL,
322                 cs->envelope_to,
323                 cs->sender,
324                 NULL,
325                 vacamsg_text,
326                 FMT_RFC822,
327                 vacamsg_subject
328         );
329
330         free(vacamsg_text);
331
332         /* Now update the list to reflect the fact that we've alerted this sender.
333          * If they're already in the list, just update the timestamp.
334          */
335         for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
336                 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
337                         vptr->timestamp = time(NULL);
338                         return SIEVE2_OK;
339                 }
340         }
341
342         /* If we get to this point, create a new record.
343          */
344         vptr = malloc(sizeof(struct sdm_vacation));
345         vptr->timestamp = time(NULL);
346         safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr);
347         vptr->next = cs->u->first_vacation;
348         cs->u->first_vacation = vptr;
349
350         return SIEVE2_OK;
351 }
352
353
354 /*
355  * Callback function to parse addresses per local system convention
356  * It is disabled because we don't support subaddresses.
357  */
358 #if 0
359 int ctdl_getsubaddress(sieve2_context_t *s, void *my)
360 {
361         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
362
363         /* libSieve does not take ownership of the memory used here.  But, since we
364          * are just pointing to locations inside a struct which we are going to free
365          * later, we're ok.
366          */
367         sieve2_setvalue_string(s, "user", cs->recp_user);
368         sieve2_setvalue_string(s, "detail", "");
369         sieve2_setvalue_string(s, "localpart", cs->recp_user);
370         sieve2_setvalue_string(s, "domain", cs->recp_node);
371         return SIEVE2_OK;
372 }
373 #endif
374
375
376 /*
377  * Callback function to parse message envelope
378  */
379 int ctdl_getenvelope(sieve2_context_t *s, void *my)
380 {
381         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
382
383         CtdlLogPrintf(CTDL_DEBUG, "Action is GETENVELOPE\nEnvFrom: %s\n  EnvTo: %s\n",
384                 cs->envelope_from, cs->envelope_to);
385
386         if (cs->envelope_from != NULL) {
387                 if ((cs->envelope_from[0] != '@')&&(cs->envelope_from[strlen(cs->envelope_from)-1] != '@')) {
388                         sieve2_setvalue_string(s, "from", cs->envelope_from);
389                 }
390                 else {
391                         sieve2_setvalue_string(s, "from", "invalid_envelope_from@example.org");
392                 }
393         }
394         else {
395                 sieve2_setvalue_string(s, "from", "null_envelope_from@example.org");
396         }
397
398
399         if (cs->envelope_to != NULL) {
400                 if ((cs->envelope_to[0] != '@') && (cs->envelope_to[strlen(cs->envelope_to)-1] != '@')) {
401                         sieve2_setvalue_string(s, "to", cs->envelope_to);
402                 }
403                 else {
404                         sieve2_setvalue_string(s, "to", "invalid_envelope_to@example.org");
405                 }
406         }
407         else {
408                 sieve2_setvalue_string(s, "to", "null_envelope_to@example.org");
409         }
410
411         return SIEVE2_OK;
412 }
413
414
415 /*
416  * Callback function to fetch message body
417  * (Uncomment the code if we implement this extension)
418  *
419 int ctdl_getbody(sieve2_context_t *s, void *my)
420 {
421         return SIEVE2_ERROR_UNSUPPORTED;
422 }
423  *
424  */
425
426
427 /*
428  * Callback function to fetch message size
429  */
430 int ctdl_getsize(sieve2_context_t *s, void *my)
431 {
432         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
433         struct MetaData smi;
434
435         GetMetaData(&smi, cs->msgnum);
436         
437         if (smi.meta_rfc822_length > 0L) {
438                 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
439                 return SIEVE2_OK;
440         }
441
442         return SIEVE2_ERROR_UNSUPPORTED;
443 }
444
445
446 /*
447  * Callback function to retrieve the sieve script
448  */
449 int ctdl_getscript(sieve2_context_t *s, void *my) {
450         struct sdm_script *sptr;
451         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
452
453         for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) {
454                 if (sptr->script_active > 0) {
455                         CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
456                         sieve2_setvalue_string(s, "script", sptr->script_content);
457                         return SIEVE2_OK;
458                 }
459         }
460                 
461         CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n");
462         return SIEVE2_ERROR_GETSCRIPT;
463 }
464
465 /*
466  * Callback function to retrieve message headers
467  */
468 int ctdl_getheaders(sieve2_context_t *s, void *my) {
469
470         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
471
472         CtdlLogPrintf(CTDL_DEBUG, "ctdl_getheaders() was called\n");
473         sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
474         return SIEVE2_OK;
475 }
476
477
478
479 /*
480  * Add a room to the list of those rooms which potentially require sieve processing
481  */
482 void sieve_queue_room(struct ctdlroom *which_room) {
483         struct RoomProcList *ptr;
484
485         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
486         if (ptr == NULL) return;
487
488         safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
489         begin_critical_section(S_SIEVELIST);
490         ptr->next = sieve_list;
491         sieve_list = ptr;
492         end_critical_section(S_SIEVELIST);
493         CtdlLogPrintf(CTDL_DEBUG, "<%s> queued for Sieve processing\n", which_room->QRname);
494 }
495
496
497
498 /*
499  * Perform sieve processing for one message (called by sieve_do_room() for each message)
500  */
501 void sieve_do_msg(long msgnum, void *userdata) {
502         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
503         sieve2_context_t *sieve2_context;
504         struct ctdl_sieve my;
505         int res;
506         struct CtdlMessage *msg;
507         int i;
508         size_t headers_len = 0;
509         int len = 0;
510
511         if (u == NULL)
512         {
513                 CtdlLogPrintf(CTDL_EMERG, "Can't process message <%ld> without userdata!\n", msgnum);
514                 return;
515         }
516
517         sieve2_context = u->sieve2_context;
518
519         CtdlLogPrintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
520
521         /*
522          * Make sure you include message body so you can get those second-level headers ;)
523          */
524         msg = CtdlFetchMessage(msgnum, 1);
525         if (msg == NULL) return;
526
527         /*
528          * Grab the message headers so we can feed them to libSieve.
529          * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers.
530          */
531         CC->redirect_buffer = malloc(SIZ);
532         CC->redirect_len = 0;
533         CC->redirect_alloc = SIZ;
534         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0);
535         my.rfc822headers = CC->redirect_buffer;
536         headers_len = CC->redirect_len;
537         CC->redirect_buffer = NULL;
538         CC->redirect_len = 0;
539         CC->redirect_alloc = 0;
540
541         /*
542          * libSieve clobbers the stack if it encounters badly formed
543          * headers.  Sanitize our headers by stripping nonprintable
544          * characters.
545          */
546         for (i=0; i<headers_len; ++i) {
547                 if (!isascii(my.rfc822headers[i])) {
548                         my.rfc822headers[i] = '_';
549                 }
550         }
551
552         my.keep = 0;                            /* Set to 1 to declare an *explicit* keep */
553         my.cancel_implicit_keep = 0;            /* Some actions will cancel the implicit keep */
554         my.usernum = atol(CC->room.QRname);     /* Keep track of the owner of the room's namespace */
555         my.msgnum = msgnum;                     /* Keep track of the message number in our local store */
556         my.u = u;                               /* Hand off a pointer to the rest of this info */
557
558         /* Keep track of the recipient so we can do handling based on it later */
559         process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
560
561         /* Keep track of the sender so we can use it for REJECT and VACATION responses */
562         if (msg->cm_fields['F'] != NULL) {
563                 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
564         }
565         else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
566                 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
567         }
568         else if (msg->cm_fields['A'] != NULL) {
569                 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
570         }
571         else {
572                 strcpy(my.sender, "");
573         }
574
575         /* Keep track of the subject so we can use it for VACATION responses */
576         if (msg->cm_fields['U'] != NULL) {
577                 safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject);
578         }
579         else {
580                 strcpy(my.subject, "");
581         }
582
583         /* Keep track of the envelope-from address (use body-from if not found) */
584         if (msg->cm_fields['P'] != NULL) {
585                 safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from);
586                 stripallbut(my.envelope_from, '<', '>');
587         }
588         else if (msg->cm_fields['F'] != NULL) {
589                 safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof my.envelope_from);
590                 stripallbut(my.envelope_from, '<', '>');
591         }
592         else {
593                 strcpy(my.envelope_from, "");
594         }
595
596         len = strlen(my.envelope_from);
597         for (i=0; i<len; ++i) {
598                 if (isspace(my.envelope_from[i])) my.envelope_from[i] = '_';
599         }
600         if (haschar(my.envelope_from, '@') == 0) {
601                 strcat(my.envelope_from, "@");
602                 strcat(my.envelope_from, config.c_fqdn);
603         }
604
605         /* Keep track of the envelope-to address (use body-to if not found) */
606         if (msg->cm_fields['V'] != NULL) {
607                 safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to);
608                 stripallbut(my.envelope_to, '<', '>');
609         }
610         else if (msg->cm_fields['R'] != NULL) {
611                 safestrncpy(my.envelope_to, msg->cm_fields['R'], sizeof my.envelope_to);
612                 if (msg->cm_fields['D'] != NULL) {
613                         strcat(my.envelope_to, "@");
614                         strcat(my.envelope_to, msg->cm_fields['D']);
615                 }
616                 stripallbut(my.envelope_to, '<', '>');
617         }
618         else {
619                 strcpy(my.envelope_to, "");
620         }
621
622         len = strlen(my.envelope_to);
623         for (i=0; i<len; ++i) {
624                 if (isspace(my.envelope_to[i])) my.envelope_to[i] = '_';
625         }
626         if (haschar(my.envelope_to, '@') == 0) {
627                 strcat(my.envelope_to, "@");
628                 strcat(my.envelope_to, config.c_fqdn);
629         }
630
631         CtdlFreeMessage(msg);
632
633         sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
634         
635         CtdlLogPrintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
636         res = sieve2_execute(sieve2_context, &my);
637         if (res != SIEVE2_OK) {
638                 CtdlLogPrintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
639         }
640
641         free(my.rfc822headers);
642         my.rfc822headers = NULL;
643
644         /*
645          * Delete the message from the inbox unless either we were told not to, or
646          * if no other action was successfully taken.
647          */
648         if ( (!my.keep) && (my.cancel_implicit_keep) ) {
649                 CtdlLogPrintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n");
650                 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
651         }
652
653         CtdlLogPrintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
654         u->lastproc = msgnum;
655
656         return;
657 }
658
659
660
661 /*
662  * Given the on-disk representation of our Sieve config, load
663  * it into an in-memory data structure.
664  */
665 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
666         char *ptr;
667         char *c, *vacrec;
668         char keyword[256];
669         struct sdm_script *sptr;
670         struct sdm_vacation *vptr;
671
672         ptr = conf;
673         while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
674                 *ptr = 0;
675                 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
676
677                 extract_token(keyword, c, 0, '|', sizeof keyword);
678
679                 if (!strcasecmp(keyword, "lastproc")) {
680                         u->lastproc = extract_long(c, 1);
681                 }
682
683                 else if (!strcasecmp(keyword, "script")) {
684                         sptr = malloc(sizeof(struct sdm_script));
685                         extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
686                         sptr->script_active = extract_int(c, 2);
687                         remove_token(c, 0, '|');
688                         remove_token(c, 0, '|');
689                         remove_token(c, 0, '|');
690                         sptr->script_content = strdup(c);
691                         sptr->next = u->first_script;
692                         u->first_script = sptr;
693                 }
694
695                 else if (!strcasecmp(keyword, "vacation")) {
696
697                         if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
698
699                                 *c = 0;
700                                 ++c;
701
702                                 if (strncasecmp(vacrec, "vacation|", 9)) {
703                                         vptr = malloc(sizeof(struct sdm_vacation));
704                                         extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
705                                         vptr->timestamp = extract_long(vacrec, 1);
706                                         vptr->next = u->first_vacation;
707                                         u->first_vacation = vptr;
708                                 }
709                         }
710                 }
711
712                 /* ignore unknown keywords */
713         }
714 }
715
716 /*
717  * We found the Sieve configuration for this user.
718  * Now do something with it.
719  */
720 void get_sieve_config_backend(long msgnum, void *userdata) {
721         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
722         struct CtdlMessage *msg;
723         char *conf;
724
725         u->config_msgnum = msgnum;
726         msg = CtdlFetchMessage(msgnum, 1);
727         if (msg == NULL) {
728                 u->config_msgnum = (-1) ;
729                 return;
730         }
731
732         conf = msg->cm_fields['M'];
733         msg->cm_fields['M'] = NULL;
734         CtdlFreeMessage(msg);
735
736         if (conf != NULL) {
737                 parse_sieve_config(conf, u);
738                 free(conf);
739         }
740
741 }
742
743
744 /* 
745  * Write our citadel sieve config back to disk
746  * 
747  * (Set yes_write_to_disk to nonzero to make it actually write the config;
748  * otherwise it just frees the data structures.)
749  */
750 void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
751         char *text;
752         struct sdm_script *sptr;
753         struct sdm_vacation *vptr;
754         size_t tsize;
755
756         text = malloc(1024);
757         tsize = 1024;
758         snprintf(text, 1024,
759                 "Content-type: application/x-citadel-sieve-config\n"
760                 "\n"
761                 CTDLSIEVECONFIGSEPARATOR
762                 "lastproc|%ld"
763                 CTDLSIEVECONFIGSEPARATOR
764         ,
765                 u->lastproc
766         );
767
768         while (u->first_script != NULL) {
769                 size_t tlen;
770                 tlen = strlen(text);
771                 tsize = tlen + strlen(u->first_script->script_content) +256;
772                 text = realloc(text, tsize);
773                 sprintf(&text[strlen(text)], "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
774                         u->first_script->script_name,
775                         u->first_script->script_active,
776                         u->first_script->script_content
777                 );
778                 sptr = u->first_script;
779                 u->first_script = u->first_script->next;
780                 free(sptr->script_content);
781                 free(sptr);
782         }
783
784         if (u->first_vacation != NULL) {
785
786                 tsize = strlen(text) + 256;
787                 for (vptr = u->first_vacation; vptr != NULL; vptr = vptr->next) {
788                         tsize += strlen(vptr->fromaddr + 32);
789                 }
790                 text = realloc(text, tsize);
791
792                 sprintf(&text[strlen(text)], "vacation|\n");
793                 while (u->first_vacation != NULL) {
794                         if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
795                                 sprintf(&text[strlen(text)], "%s|%ld\n",
796                                         u->first_vacation->fromaddr,
797                                         u->first_vacation->timestamp
798                                 );
799                         }
800                         vptr = u->first_vacation;
801                         u->first_vacation = u->first_vacation->next;
802                         free(vptr);
803                 }
804                 sprintf(&text[strlen(text)], CTDLSIEVECONFIGSEPARATOR);
805         }
806
807         if (yes_write_to_disk)
808         {
809                 /* Save the config */
810                 quickie_message("Citadel", NULL, NULL, u->config_roomname,
811                                 text,
812                                 4,
813                                 "Sieve configuration"
814                 );
815                 
816                 /* And delete the old one */
817                 if (u->config_msgnum > 0) {
818                         CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "");
819                 }
820         }
821
822         free (text);
823
824 }
825
826
827 /*
828  * This is our callback registration table for libSieve.
829  */
830 sieve2_callback_t ctdl_sieve_callbacks[] = {
831         { SIEVE2_ACTION_REJECT,         ctdl_reject             },
832         { SIEVE2_ACTION_VACATION,       ctdl_vacation           },
833         { SIEVE2_ERRCALL_PARSE,         ctdl_errparse           },
834         { SIEVE2_ERRCALL_RUNTIME,       ctdl_errexec            },
835         { SIEVE2_ACTION_FILEINTO,       ctdl_fileinto           },
836         { SIEVE2_ACTION_REDIRECT,       ctdl_redirect           },
837         { SIEVE2_ACTION_DISCARD,        ctdl_discard            },
838         { SIEVE2_ACTION_KEEP,           ctdl_keep               },
839         { SIEVE2_SCRIPT_GETSCRIPT,      ctdl_getscript          },
840         { SIEVE2_DEBUG_TRACE,           ctdl_debug              },
841         { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders         },
842         { SIEVE2_MESSAGE_GETSIZE,       ctdl_getsize            },
843         { SIEVE2_MESSAGE_GETENVELOPE,   ctdl_getenvelope        },
844 /*
845  * These actions are unsupported by Citadel so we don't declare them.
846  *
847         { SIEVE2_ACTION_NOTIFY,         ctdl_notify             },
848         { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress      },
849         { SIEVE2_MESSAGE_GETBODY,       ctdl_getbody            },
850  *
851  */
852         { 0 }
853 };
854
855
856 /*
857  * Perform sieve processing for a single room
858  */
859 void sieve_do_room(char *roomname) {
860         
861         struct sdm_userdata u;
862         sieve2_context_t *sieve2_context = NULL;        /* Context for sieve parser */
863         int res;                                        /* Return code from libsieve calls */
864         long orig_lastproc = 0;
865
866         memset(&u, 0, sizeof u);
867
868         /* See if the user who owns this 'mailbox' has any Sieve scripts that
869          * require execution.
870          */
871         snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM);
872         if (getroom(&CC->room, u.config_roomname) != 0) {
873                 CtdlLogPrintf(CTDL_DEBUG, "<%s> does not exist.  No processing is required.\n", u.config_roomname);
874                 return;
875         }
876
877         /*
878          * Find the sieve scripts and control record and do something
879          */
880         u.config_msgnum = (-1);
881         CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
882                 get_sieve_config_backend, (void *)&u );
883
884         if (u.config_msgnum < 0) {
885                 CtdlLogPrintf(CTDL_DEBUG, "No Sieve rules exist.  No processing is required.\n");
886                 return;
887         }
888
889         CtdlLogPrintf(CTDL_DEBUG, "Rules found.  Performing Sieve processing for <%s>\n", roomname);
890
891         if (getroom(&CC->room, roomname) != 0) {
892                 CtdlLogPrintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
893                 return;
894         }
895
896         /* Initialize the Sieve parser */
897         
898         res = sieve2_alloc(&sieve2_context);
899         if (res != SIEVE2_OK) {
900                 CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
901                 return;
902         }
903
904         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
905         if (res != SIEVE2_OK) {
906                 CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
907                 goto BAIL;
908         }
909
910         /* Validate the script */
911
912         struct ctdl_sieve my;           /* dummy ctdl_sieve struct just to pass "u" slong */
913         memset(&my, 0, sizeof my);
914         my.u = &u;
915         res = sieve2_validate(sieve2_context, &my);
916         if (res != SIEVE2_OK) {
917                 CtdlLogPrintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
918                 goto BAIL;
919         }
920
921         /* Do something useful */
922         u.sieve2_context = sieve2_context;
923         orig_lastproc = u.lastproc;
924         CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
925                 sieve_do_msg,
926                 (void *) &u
927         );
928
929 BAIL:
930         res = sieve2_free(&sieve2_context);
931         if (res != SIEVE2_OK) {
932                 CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
933         }
934
935         /* Rewrite the config if we have to */
936         rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ;
937 }
938
939
940 /*
941  * Perform sieve processing for all rooms which require it
942  */
943 void perform_sieve_processing(void) {
944         struct RoomProcList *ptr = NULL;
945
946         if (sieve_list != NULL) {
947                 CtdlLogPrintf(CTDL_DEBUG, "Begin Sieve processing\n");
948                 while (sieve_list != NULL) {
949                         char spoolroomname[ROOMNAMELEN];
950                         safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
951                         begin_critical_section(S_SIEVELIST);
952
953                         /* pop this record off the list */
954                         ptr = sieve_list;
955                         sieve_list = sieve_list->next;
956                         free(ptr);
957
958                         /* invalidate any duplicate entries to prevent double processing */
959                         for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
960                                 if (!strcasecmp(ptr->name, spoolroomname)) {
961                                         ptr->name[0] = 0;
962                                 }
963                         }
964
965                         end_critical_section(S_SIEVELIST);
966                         if (spoolroomname[0] != 0) {
967                                 sieve_do_room(spoolroomname);
968                         }
969                 }
970         }
971 }
972
973
974 void msiv_load(struct sdm_userdata *u) {
975         char hold_rm[ROOMNAMELEN];
976
977         strcpy(hold_rm, CC->room.QRname);       /* save current room */
978
979         /* Take a spin through the user's personal address book */
980         if (getroom(&CC->room, USERCONFIGROOM) == 0) {
981         
982                 u->config_msgnum = (-1);
983                 strcpy(u->config_roomname, CC->room.QRname);
984                 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
985                         get_sieve_config_backend, (void *)u );
986
987         }
988
989         if (strcmp(CC->room.QRname, hold_rm)) {
990                 getroom(&CC->room, hold_rm);    /* return to saved room */
991         }
992 }
993
994 void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) {
995 /*
996  * Initialise the sieve configs last processed message number.
997  * We don't need to get the highest message number for the users inbox since the systems
998  * highest message number will be higher than that and loer than this scripts message number
999  * This prevents this new script from processing any old messages in the inbox.
1000  * Most importantly it will prevent vacation messages being sent to lots of old messages
1001  * in the inbox.
1002  */
1003         u->lastproc = CtdlGetCurrentMessageNumber();
1004         rewrite_ctdl_sieve_config(u, yes_write_to_disk);
1005 }
1006
1007
1008 /*
1009  * Select the active script.
1010  * (Set script_name to an empty string to disable all scripts)
1011  * 
1012  * Returns 0 on success or nonzero for error.
1013  */
1014 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
1015         int ok = 0;
1016         struct sdm_script *s;
1017
1018         /* First see if the supplied value is ok */
1019
1020         if (IsEmptyStr(script_name)) {
1021                 ok = 1;
1022         }
1023         else {
1024                 for (s=u->first_script; s!=NULL; s=s->next) {
1025                         if (!strcasecmp(s->script_name, script_name)) {
1026                                 ok = 1;
1027                         }
1028                 }
1029         }
1030
1031         if (!ok) return(-1);
1032
1033         /* Now set the active script */
1034         for (s=u->first_script; s!=NULL; s=s->next) {
1035                 if (!strcasecmp(s->script_name, script_name)) {
1036                         s->script_active = 1;
1037                 }
1038                 else {
1039                         s->script_active = 0;
1040                 }
1041         }
1042         
1043         return(0);
1044 }
1045
1046
1047 /*
1048  * Fetch a script by name.
1049  *
1050  * Returns NULL if the named script was not found, or a pointer to the script
1051  * if it was found.   NOTE: the caller does *not* own the memory returned by
1052  * this function.  Copy it if you need to keep it.
1053  */
1054 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
1055         struct sdm_script *s;
1056
1057         for (s=u->first_script; s!=NULL; s=s->next) {
1058                 if (!strcasecmp(s->script_name, script_name)) {
1059                         if (s->script_content != NULL) {
1060                                 return (s->script_content);
1061                         }
1062                 }
1063         }
1064
1065         return(NULL);
1066 }
1067
1068
1069 /*
1070  * Delete a script by name.
1071  *
1072  * Returns 0 if the script was deleted.
1073  *       1 if the script was not found.
1074  *       2 if the script cannot be deleted because it is active.
1075  */
1076 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
1077         struct sdm_script *s = NULL;
1078         struct sdm_script *script_to_delete = NULL;
1079
1080         for (s=u->first_script; s!=NULL; s=s->next) {
1081                 if (!strcasecmp(s->script_name, script_name)) {
1082                         script_to_delete = s;
1083                         if (s->script_active) {
1084                                 return(2);
1085                         }
1086                 }
1087         }
1088
1089         if (script_to_delete == NULL) return(1);
1090
1091         if (u->first_script == script_to_delete) {
1092                 u->first_script = u->first_script->next;
1093         }
1094         else for (s=u->first_script; s!=NULL; s=s->next) {
1095                 if (s->next == script_to_delete) {
1096                         s->next = s->next->next;
1097                 }
1098         }
1099
1100         free(script_to_delete->script_content);
1101         free(script_to_delete);
1102         return(0);
1103 }
1104
1105
1106 /*
1107  * Add or replace a new script.  
1108  * NOTE: after this function returns, "u" owns the memory that "script_content"
1109  * was pointing to.
1110  */
1111 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
1112         int replaced = 0;
1113         struct sdm_script *s, *sptr;
1114
1115         for (s=u->first_script; s!=NULL; s=s->next) {
1116                 if (!strcasecmp(s->script_name, script_name)) {
1117                         if (s->script_content != NULL) {
1118                                 free(s->script_content);
1119                         }
1120                         s->script_content = script_content;
1121                         replaced = 1;
1122                 }
1123         }
1124
1125         if (replaced == 0) {
1126                 sptr = malloc(sizeof(struct sdm_script));
1127                 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
1128                 sptr->script_content = script_content;
1129                 sptr->script_active = 0;
1130                 sptr->next = u->first_script;
1131                 u->first_script = sptr;
1132         }
1133 }
1134
1135
1136
1137 /*
1138  * Citadel protocol to manage sieve scripts.
1139  * This is basically a simplified (read: doesn't resemble IMAP) version
1140  * of the 'managesieve' protocol.
1141  */
1142 void cmd_msiv(char *argbuf) {
1143         char subcmd[256];
1144         struct sdm_userdata u;
1145         char script_name[256];
1146         char *script_content = NULL;
1147         struct sdm_script *s;
1148         int i;
1149         int changes_made = 0;
1150
1151         memset(&u, 0, sizeof(struct sdm_userdata));
1152
1153         if (CtdlAccessCheck(ac_logged_in)) return;
1154         extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
1155         msiv_load(&u);
1156
1157         if (!strcasecmp(subcmd, "putscript")) {
1158                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1159                 if (!IsEmptyStr(script_name)) {
1160                         cprintf("%d Transmit script now\n", SEND_LISTING);
1161                         script_content = CtdlReadMessageBody("000", config.c_maxmsglen, NULL, 0, 0);
1162                         msiv_putscript(&u, script_name, script_content);
1163                         changes_made = 1;
1164                 }
1165                 else {
1166                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1167                 }
1168         }       
1169         
1170         else if (!strcasecmp(subcmd, "listscripts")) {
1171                 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
1172                 for (s=u.first_script; s!=NULL; s=s->next) {
1173                         if (s->script_content != NULL) {
1174                                 cprintf("%s|%d|\n", s->script_name, s->script_active);
1175                         }
1176                 }
1177                 cprintf("000\n");
1178         }
1179
1180         else if (!strcasecmp(subcmd, "setactive")) {
1181                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1182                 if (msiv_setactive(&u, script_name) == 0) {
1183                         cprintf("%d ok\n", CIT_OK);
1184                         changes_made = 1;
1185                 }
1186                 else {
1187                         cprintf("%d Script '%s' does not exist.\n",
1188                                 ERROR + ILLEGAL_VALUE,
1189                                 script_name
1190                         );
1191                 }
1192         }
1193
1194         else if (!strcasecmp(subcmd, "getscript")) {
1195                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1196                 script_content = msiv_getscript(&u, script_name);
1197                 if (script_content != NULL) {
1198                         int script_len;
1199
1200                         cprintf("%d Script:\n", LISTING_FOLLOWS);
1201                         script_len = strlen(script_content);
1202                         client_write(script_content, script_len);
1203                         if (script_content[script_len-1] != '\n') {
1204                                 cprintf("\n");
1205                         }
1206                         cprintf("000\n");
1207                 }
1208                 else {
1209                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1210                 }
1211         }
1212
1213         else if (!strcasecmp(subcmd, "deletescript")) {
1214                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1215                 i = msiv_deletescript(&u, script_name);
1216                 if (i == 0) {
1217                         cprintf("%d ok\n", CIT_OK);
1218                         changes_made = 1;
1219                 }
1220                 else if (i == 1) {
1221                         cprintf("%d Script '%s' does not exist.\n",
1222                                 ERROR + ILLEGAL_VALUE,
1223                                 script_name
1224                         );
1225                 }
1226                 else if (i == 2) {
1227                         cprintf("%d Script '%s' is active and cannot be deleted.\n",
1228                                 ERROR + ILLEGAL_VALUE,
1229                                 script_name
1230                         );
1231                 }
1232                 else {
1233                         cprintf("%d unknown error\n", ERROR);
1234                 }
1235         }
1236
1237         else {
1238                 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
1239         }
1240
1241         msiv_store(&u, changes_made);
1242 }
1243
1244
1245
1246 void ctdl_sieve_init(void) {
1247         char *cred = NULL;
1248         sieve2_context_t *sieve2_context = NULL;
1249         int res;
1250
1251         /*
1252          *      We don't really care about dumping the entire credits to the log
1253          *      every time the server is initialized.  The documentation will suffice
1254          *      for that purpose.  We are making a call to sieve2_credits() in order
1255          *      to demonstrate that we have successfully linked in to libsieve.
1256          */
1257         cred = strdup(sieve2_credits());
1258         if (cred == NULL) return;
1259
1260         if (strlen(cred) > 60) {
1261                 strcpy(&cred[55], "...");
1262         }
1263
1264         CtdlLogPrintf(CTDL_INFO, "%s\n",cred);
1265         free(cred);
1266
1267         /* Briefly initialize a Sieve parser instance just so we can list the
1268          * extensions that are available.
1269          */
1270         res = sieve2_alloc(&sieve2_context);
1271         if (res != SIEVE2_OK) {
1272                 CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
1273                 return;
1274         }
1275
1276         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1277         if (res != SIEVE2_OK) {
1278                 CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
1279                 goto BAIL;
1280         }
1281
1282         msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1283         CtdlLogPrintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
1284
1285 BAIL:   res = sieve2_free(&sieve2_context);
1286         if (res != SIEVE2_OK) {
1287                 CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
1288         }
1289
1290 }
1291
1292 int serv_sieve_room(struct ctdlroom *room)
1293 {
1294         if (!strcasecmp(&room->QRname[11], MAILROOM)) {
1295                 sieve_queue_room(room);
1296         }
1297         return 0;
1298 }
1299
1300 CTDL_MODULE_INIT(sieve)
1301 {
1302         if (!threading)
1303         {
1304
1305                 ctdl_sieve_init();
1306                 CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1307                 CtdlRegisterRoomHook(serv_sieve_room);
1308                 CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
1309         }
1310         
1311         /* return our Subversion id for the Log */
1312         return "$Id$";
1313 }
1314