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