Merge branch 'master' of ssh://git.citadel.org/appl/gitroot/citadel
[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  * (Caller does NOT own the memory and should not free the returned pointer.)
455  */
456 char *get_active_script(struct sdm_userdata *u) {
457         struct sdm_script *sptr;
458
459         for (sptr=u->first_script; sptr!=NULL; sptr=sptr->next) {
460                 if (sptr->script_active > 0) {
461                         syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name);
462                         return(sptr->script_content);
463                 }
464         }
465
466         syslog(LOG_DEBUG, "get_active_script() found no active script");
467         return(NULL);
468 }
469
470
471 /*
472  * Callback function to retrieve the sieve script
473  */
474 int ctdl_getscript(sieve2_context_t *s, void *my) {
475         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
476
477         char *active_script = get_active_script(cs->u);
478         if (active_script != NULL) {
479                 sieve2_setvalue_string(s, "script", active_script);
480                 return SIEVE2_OK;
481         }
482
483         return SIEVE2_ERROR_GETSCRIPT;
484 }
485
486 /*
487  * Callback function to retrieve message headers
488  */
489 int ctdl_getheaders(sieve2_context_t *s, void *my) {
490
491         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
492
493         syslog(LOG_DEBUG, "ctdl_getheaders() was called");
494         sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
495         return SIEVE2_OK;
496 }
497
498
499
500 /*
501  * Add a room to the list of those rooms which potentially require sieve processing
502  */
503 void sieve_queue_room(struct ctdlroom *which_room) {
504         struct RoomProcList *ptr;
505
506         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
507         if (ptr == NULL) return;
508
509         safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
510         begin_critical_section(S_SIEVELIST);
511         ptr->next = sieve_list;
512         sieve_list = ptr;
513         end_critical_section(S_SIEVELIST);
514         syslog(LOG_DEBUG, "<%s> queued for Sieve processing", which_room->QRname);
515 }
516
517
518
519 /*
520  * Perform sieve processing for one message (called by sieve_do_room() for each message)
521  */
522 void sieve_do_msg(long msgnum, void *userdata) {
523         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
524         sieve2_context_t *sieve2_context;
525         struct ctdl_sieve my;
526         int res;
527         struct CtdlMessage *msg;
528         int i;
529         size_t headers_len = 0;
530         int len = 0;
531
532         if (u == NULL)
533         {
534                 syslog(LOG_EMERG, "Can't process message <%ld> without userdata!", msgnum);
535                 return;
536         }
537
538         sieve2_context = u->sieve2_context;
539
540         syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum);
541
542         /*
543          * Make sure you include message body so you can get those second-level headers ;)
544          */
545         msg = CtdlFetchMessage(msgnum, 1);
546         if (msg == NULL) return;
547
548         /*
549          * Grab the message headers so we can feed them to libSieve.
550          * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers.
551          */
552         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
553         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0);
554         headers_len = StrLength(CC->redirect_buffer);
555         my.rfc822headers = SmashStrBuf(&CC->redirect_buffer);
556
557         /*
558          * libSieve clobbers the stack if it encounters badly formed
559          * headers.  Sanitize our headers by stripping nonprintable
560          * characters.
561          */
562         for (i=0; i<headers_len; ++i) {
563                 if (!isascii(my.rfc822headers[i])) {
564                         my.rfc822headers[i] = '_';
565                 }
566         }
567
568         my.keep = 0;                            /* Set to 1 to declare an *explicit* keep */
569         my.cancel_implicit_keep = 0;            /* Some actions will cancel the implicit keep */
570         my.usernum = atol(CC->room.QRname);     /* Keep track of the owner of the room's namespace */
571         my.msgnum = msgnum;                     /* Keep track of the message number in our local store */
572         my.u = u;                               /* Hand off a pointer to the rest of this info */
573
574         /* Keep track of the recipient so we can do handling based on it later */
575         process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
576
577         /* Keep track of the sender so we can use it for REJECT and VACATION responses */
578         if (msg->cm_fields['F'] != NULL) {
579                 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
580         }
581         else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
582                 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
583         }
584         else if (msg->cm_fields['A'] != NULL) {
585                 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
586         }
587         else {
588                 strcpy(my.sender, "");
589         }
590
591         /* Keep track of the subject so we can use it for VACATION responses */
592         if (msg->cm_fields['U'] != NULL) {
593                 safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject);
594         }
595         else {
596                 strcpy(my.subject, "");
597         }
598
599         /* Keep track of the envelope-from address (use body-from if not found) */
600         if (msg->cm_fields['P'] != NULL) {
601                 safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from);
602                 stripallbut(my.envelope_from, '<', '>');
603         }
604         else if (msg->cm_fields['F'] != NULL) {
605                 safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof my.envelope_from);
606                 stripallbut(my.envelope_from, '<', '>');
607         }
608         else {
609                 strcpy(my.envelope_from, "");
610         }
611
612         len = strlen(my.envelope_from);
613         for (i=0; i<len; ++i) {
614                 if (isspace(my.envelope_from[i])) my.envelope_from[i] = '_';
615         }
616         if (haschar(my.envelope_from, '@') == 0) {
617                 strcat(my.envelope_from, "@");
618                 strcat(my.envelope_from, config.c_fqdn);
619         }
620
621         /* Keep track of the envelope-to address (use body-to if not found) */
622         if (msg->cm_fields['V'] != NULL) {
623                 safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to);
624                 stripallbut(my.envelope_to, '<', '>');
625         }
626         else if (msg->cm_fields['R'] != NULL) {
627                 safestrncpy(my.envelope_to, msg->cm_fields['R'], sizeof my.envelope_to);
628                 if (msg->cm_fields['D'] != NULL) {
629                         strcat(my.envelope_to, "@");
630                         strcat(my.envelope_to, msg->cm_fields['D']);
631                 }
632                 stripallbut(my.envelope_to, '<', '>');
633         }
634         else {
635                 strcpy(my.envelope_to, "");
636         }
637
638         len = strlen(my.envelope_to);
639         for (i=0; i<len; ++i) {
640                 if (isspace(my.envelope_to[i])) my.envelope_to[i] = '_';
641         }
642         if (haschar(my.envelope_to, '@') == 0) {
643                 strcat(my.envelope_to, "@");
644                 strcat(my.envelope_to, config.c_fqdn);
645         }
646
647         CtdlFreeMessage(msg);
648         
649         syslog(LOG_DEBUG, "Calling sieve2_execute()");
650         res = sieve2_execute(sieve2_context, &my);
651         if (res != SIEVE2_OK) {
652                 syslog(LOG_CRIT, "sieve2_execute() returned %d: %s", res, sieve2_errstr(res));
653         }
654
655         free(my.rfc822headers);
656         my.rfc822headers = NULL;
657
658         /*
659          * Delete the message from the inbox unless either we were told not to, or
660          * if no other action was successfully taken.
661          */
662         if ( (!my.keep) && (my.cancel_implicit_keep) ) {
663                 syslog(LOG_DEBUG, "keep is 0 -- deleting message from inbox");
664                 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
665         }
666
667         syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum);
668         u->lastproc = msgnum;
669
670         return;
671 }
672
673
674
675 /*
676  * Given the on-disk representation of our Sieve config, load
677  * it into an in-memory data structure.
678  */
679 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
680         char *ptr;
681         char *c, *vacrec;
682         char keyword[256];
683         struct sdm_script *sptr;
684         struct sdm_vacation *vptr;
685
686         ptr = conf;
687         while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
688                 *ptr = 0;
689                 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
690
691                 extract_token(keyword, c, 0, '|', sizeof keyword);
692
693                 if (!strcasecmp(keyword, "lastproc")) {
694                         u->lastproc = extract_long(c, 1);
695                 }
696
697                 else if (!strcasecmp(keyword, "script")) {
698                         sptr = malloc(sizeof(struct sdm_script));
699                         extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
700                         sptr->script_active = extract_int(c, 2);
701                         remove_token(c, 0, '|');
702                         remove_token(c, 0, '|');
703                         remove_token(c, 0, '|');
704                         sptr->script_content = strdup(c);
705                         sptr->next = u->first_script;
706                         u->first_script = sptr;
707                 }
708
709                 else if (!strcasecmp(keyword, "vacation")) {
710
711                         if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
712
713                                 *c = 0;
714                                 ++c;
715
716                                 if (strncasecmp(vacrec, "vacation|", 9)) {
717                                         vptr = malloc(sizeof(struct sdm_vacation));
718                                         extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
719                                         vptr->timestamp = extract_long(vacrec, 1);
720                                         vptr->next = u->first_vacation;
721                                         u->first_vacation = vptr;
722                                 }
723                         }
724                 }
725
726                 /* ignore unknown keywords */
727         }
728 }
729
730 /*
731  * We found the Sieve configuration for this user.
732  * Now do something with it.
733  */
734 void get_sieve_config_backend(long msgnum, void *userdata) {
735         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
736         struct CtdlMessage *msg;
737         char *conf;
738
739         u->config_msgnum = msgnum;
740         msg = CtdlFetchMessage(msgnum, 1);
741         if (msg == NULL) {
742                 u->config_msgnum = (-1) ;
743                 return;
744         }
745
746         conf = msg->cm_fields['M'];
747         msg->cm_fields['M'] = NULL;
748         CtdlFreeMessage(msg);
749
750         if (conf != NULL) {
751                 parse_sieve_config(conf, u);
752                 free(conf);
753         }
754
755 }
756
757
758 /* 
759  * Write our citadel sieve config back to disk
760  * 
761  * (Set yes_write_to_disk to nonzero to make it actually write the config;
762  * otherwise it just frees the data structures.)
763  */
764 void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
765         StrBuf *text;
766         struct sdm_script *sptr;
767         struct sdm_vacation *vptr;
768         
769         text = NewStrBufPlain(NULL, SIZ);
770         StrBufPrintf(text,
771                      "Content-type: application/x-citadel-sieve-config\n"
772                      "\n"
773                      CTDLSIEVECONFIGSEPARATOR
774                      "lastproc|%ld"
775                      CTDLSIEVECONFIGSEPARATOR
776                      ,
777                      u->lastproc
778                 );
779
780         while (u->first_script != NULL) {
781                 StrBufAppendPrintf(text,
782                                    "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
783                                    u->first_script->script_name,
784                                    u->first_script->script_active,
785                                    u->first_script->script_content
786                         );
787                 sptr = u->first_script;
788                 u->first_script = u->first_script->next;
789                 free(sptr->script_content);
790                 free(sptr);
791         }
792
793         if (u->first_vacation != NULL) {
794
795                 StrBufAppendPrintf(text, "vacation|\n");
796                 while (u->first_vacation != NULL) {
797                         if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
798                                 StrBufAppendPrintf(text, "%s|%ld\n",
799                                                    u->first_vacation->fromaddr,
800                                                    u->first_vacation->timestamp
801                                         );
802                         }
803                         vptr = u->first_vacation;
804                         u->first_vacation = u->first_vacation->next;
805                         free(vptr);
806                 }
807                 StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR);
808         }
809
810         if (yes_write_to_disk)
811         {
812                 /* Save the config */
813                 quickie_message("Citadel", NULL, NULL, u->config_roomname,
814                                 ChrPtr(text),
815                                 4,
816                                 "Sieve configuration"
817                 );
818                 
819                 /* And delete the old one */
820                 if (u->config_msgnum > 0) {
821                         CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "");
822                 }
823         }
824
825         FreeStrBuf (&text);
826
827 }
828
829
830 /*
831  * This is our callback registration table for libSieve.
832  */
833 sieve2_callback_t ctdl_sieve_callbacks[] = {
834         { SIEVE2_ACTION_REJECT,         ctdl_reject             },
835         { SIEVE2_ACTION_VACATION,       ctdl_vacation           },
836         { SIEVE2_ERRCALL_PARSE,         ctdl_errparse           },
837         { SIEVE2_ERRCALL_RUNTIME,       ctdl_errexec            },
838         { SIEVE2_ACTION_FILEINTO,       ctdl_fileinto           },
839         { SIEVE2_ACTION_REDIRECT,       ctdl_redirect           },
840         { SIEVE2_ACTION_DISCARD,        ctdl_discard            },
841         { SIEVE2_ACTION_KEEP,           ctdl_keep               },
842         { SIEVE2_SCRIPT_GETSCRIPT,      ctdl_getscript          },
843         { SIEVE2_DEBUG_TRACE,           ctdl_debug              },
844         { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders         },
845         { SIEVE2_MESSAGE_GETSIZE,       ctdl_getsize            },
846         { SIEVE2_MESSAGE_GETENVELOPE,   ctdl_getenvelope        },
847 /*
848  * These actions are unsupported by Citadel so we don't declare them.
849  *
850         { SIEVE2_ACTION_NOTIFY,         ctdl_notify             },
851         { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress      },
852         { SIEVE2_MESSAGE_GETBODY,       ctdl_getbody            },
853  *
854  */
855         { 0 }
856 };
857
858
859 /*
860  * Perform sieve processing for a single room
861  */
862 void sieve_do_room(char *roomname) {
863         
864         struct sdm_userdata u;
865         sieve2_context_t *sieve2_context = NULL;        /* Context for sieve parser */
866         int res;                                        /* Return code from libsieve calls */
867         long orig_lastproc = 0;
868
869         memset(&u, 0, sizeof u);
870
871         /* See if the user who owns this 'mailbox' has any Sieve scripts that
872          * require execution.
873          */
874         snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM);
875         if (CtdlGetRoom(&CC->room, u.config_roomname) != 0) {
876                 syslog(LOG_DEBUG, "<%s> does not exist.  No processing is required.", u.config_roomname);
877                 return;
878         }
879
880         /*
881          * Find the sieve scripts and control record and do something
882          */
883         u.config_msgnum = (-1);
884         CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
885                 get_sieve_config_backend, (void *)&u );
886
887         if (u.config_msgnum < 0) {
888                 syslog(LOG_DEBUG, "No Sieve rules exist.  No processing is required.");
889                 return;
890         }
891
892         /*
893          * Check to see whether the script is empty and should not be processed.
894          * A script is considered non-empty if it contains at least one semicolon.
895          */
896         if ((strchr(get_active_script(&u), ';') == NULL)) {
897                 syslog(LOG_DEBUG, "Sieve script is empty.  No processing is required.");
898                 return;
899         }
900
901         syslog(LOG_DEBUG, "Rules found.  Performing Sieve processing for <%s>", roomname);
902
903         if (CtdlGetRoom(&CC->room, roomname) != 0) {
904                 syslog(LOG_CRIT, "ERROR: cannot load <%s>", roomname);
905                 return;
906         }
907
908         /* Initialize the Sieve parser */
909         
910         res = sieve2_alloc(&sieve2_context);
911         if (res != SIEVE2_OK) {
912                 syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res));
913                 return;
914         }
915
916         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
917         if (res != SIEVE2_OK) {
918                 syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res));
919                 goto BAIL;
920         }
921
922         /* Validate the script */
923
924         struct ctdl_sieve my;           /* dummy ctdl_sieve struct just to pass "u" slong */
925         memset(&my, 0, sizeof my);
926         my.u = &u;
927         res = sieve2_validate(sieve2_context, &my);
928         if (res != SIEVE2_OK) {
929                 syslog(LOG_CRIT, "sieve2_validate() returned %d: %s", res, sieve2_errstr(res));
930                 goto BAIL;
931         }
932
933         /* Do something useful */
934         u.sieve2_context = sieve2_context;
935         orig_lastproc = u.lastproc;
936         CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
937                 sieve_do_msg,
938                 (void *) &u
939         );
940
941 BAIL:
942         res = sieve2_free(&sieve2_context);
943         if (res != SIEVE2_OK) {
944                 syslog(LOG_CRIT, "sieve2_free() returned %d: %s", res, sieve2_errstr(res));
945         }
946
947         /* Rewrite the config if we have to */
948         rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ;
949 }
950
951
952 /*
953  * Perform sieve processing for all rooms which require it
954  */
955 void perform_sieve_processing(void) {
956         struct RoomProcList *ptr = NULL;
957
958         if (sieve_list != NULL) {
959                 syslog(LOG_DEBUG, "Begin Sieve processing");
960                 while (sieve_list != NULL) {
961                         char spoolroomname[ROOMNAMELEN];
962                         safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
963                         begin_critical_section(S_SIEVELIST);
964
965                         /* pop this record off the list */
966                         ptr = sieve_list;
967                         sieve_list = sieve_list->next;
968                         free(ptr);
969
970                         /* invalidate any duplicate entries to prevent double processing */
971                         for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
972                                 if (!strcasecmp(ptr->name, spoolroomname)) {
973                                         ptr->name[0] = 0;
974                                 }
975                         }
976
977                         end_critical_section(S_SIEVELIST);
978                         if (spoolroomname[0] != 0) {
979                                 sieve_do_room(spoolroomname);
980                         }
981                 }
982         }
983 }
984
985
986 void msiv_load(struct sdm_userdata *u) {
987         char hold_rm[ROOMNAMELEN];
988
989         strcpy(hold_rm, CC->room.QRname);       /* save current room */
990
991         /* Take a spin through the user's personal address book */
992         if (CtdlGetRoom(&CC->room, USERCONFIGROOM) == 0) {
993         
994                 u->config_msgnum = (-1);
995                 strcpy(u->config_roomname, CC->room.QRname);
996                 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
997                         get_sieve_config_backend, (void *)u );
998
999         }
1000
1001         if (strcmp(CC->room.QRname, hold_rm)) {
1002                 CtdlGetRoom(&CC->room, hold_rm);    /* return to saved room */
1003         }
1004 }
1005
1006 void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) {
1007 /*
1008  * Initialise the sieve configs last processed message number.
1009  * We don't need to get the highest message number for the users inbox since the systems
1010  * highest message number will be higher than that and loer than this scripts message number
1011  * This prevents this new script from processing any old messages in the inbox.
1012  * Most importantly it will prevent vacation messages being sent to lots of old messages
1013  * in the inbox.
1014  */
1015         u->lastproc = CtdlGetCurrentMessageNumber();
1016         rewrite_ctdl_sieve_config(u, yes_write_to_disk);
1017 }
1018
1019
1020 /*
1021  * Select the active script.
1022  * (Set script_name to an empty string to disable all scripts)
1023  * 
1024  * Returns 0 on success or nonzero for error.
1025  */
1026 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
1027         int ok = 0;
1028         struct sdm_script *s;
1029
1030         /* First see if the supplied value is ok */
1031
1032         if (IsEmptyStr(script_name)) {
1033                 ok = 1;
1034         }
1035         else {
1036                 for (s=u->first_script; s!=NULL; s=s->next) {
1037                         if (!strcasecmp(s->script_name, script_name)) {
1038                                 ok = 1;
1039                         }
1040                 }
1041         }
1042
1043         if (!ok) return(-1);
1044
1045         /* Now set the active script */
1046         for (s=u->first_script; s!=NULL; s=s->next) {
1047                 if (!strcasecmp(s->script_name, script_name)) {
1048                         s->script_active = 1;
1049                 }
1050                 else {
1051                         s->script_active = 0;
1052                 }
1053         }
1054         
1055         return(0);
1056 }
1057
1058
1059 /*
1060  * Fetch a script by name.
1061  *
1062  * Returns NULL if the named script was not found, or a pointer to the script
1063  * if it was found.   NOTE: the caller does *not* own the memory returned by
1064  * this function.  Copy it if you need to keep it.
1065  */
1066 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
1067         struct sdm_script *s;
1068
1069         for (s=u->first_script; s!=NULL; s=s->next) {
1070                 if (!strcasecmp(s->script_name, script_name)) {
1071                         if (s->script_content != NULL) {
1072                                 return (s->script_content);
1073                         }
1074                 }
1075         }
1076
1077         return(NULL);
1078 }
1079
1080
1081 /*
1082  * Delete a script by name.
1083  *
1084  * Returns 0 if the script was deleted.
1085  *       1 if the script was not found.
1086  *       2 if the script cannot be deleted because it is active.
1087  */
1088 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
1089         struct sdm_script *s = NULL;
1090         struct sdm_script *script_to_delete = NULL;
1091
1092         for (s=u->first_script; s!=NULL; s=s->next) {
1093                 if (!strcasecmp(s->script_name, script_name)) {
1094                         script_to_delete = s;
1095                         if (s->script_active) {
1096                                 return(2);
1097                         }
1098                 }
1099         }
1100
1101         if (script_to_delete == NULL) return(1);
1102
1103         if (u->first_script == script_to_delete) {
1104                 u->first_script = u->first_script->next;
1105         }
1106         else for (s=u->first_script; s!=NULL; s=s->next) {
1107                 if (s->next == script_to_delete) {
1108                         s->next = s->next->next;
1109                 }
1110         }
1111
1112         free(script_to_delete->script_content);
1113         free(script_to_delete);
1114         return(0);
1115 }
1116
1117
1118 /*
1119  * Add or replace a new script.  
1120  * NOTE: after this function returns, "u" owns the memory that "script_content"
1121  * was pointing to.
1122  */
1123 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
1124         int replaced = 0;
1125         struct sdm_script *s, *sptr;
1126
1127         for (s=u->first_script; s!=NULL; s=s->next) {
1128                 if (!strcasecmp(s->script_name, script_name)) {
1129                         if (s->script_content != NULL) {
1130                                 free(s->script_content);
1131                         }
1132                         s->script_content = script_content;
1133                         replaced = 1;
1134                 }
1135         }
1136
1137         if (replaced == 0) {
1138                 sptr = malloc(sizeof(struct sdm_script));
1139                 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
1140                 sptr->script_content = script_content;
1141                 sptr->script_active = 0;
1142                 sptr->next = u->first_script;
1143                 u->first_script = sptr;
1144         }
1145 }
1146
1147
1148
1149 /*
1150  * Citadel protocol to manage sieve scripts.
1151  * This is basically a simplified (read: doesn't resemble IMAP) version
1152  * of the 'managesieve' protocol.
1153  */
1154 void cmd_msiv(char *argbuf) {
1155         char subcmd[256];
1156         struct sdm_userdata u;
1157         char script_name[256];
1158         char *script_content = NULL;
1159         struct sdm_script *s;
1160         int i;
1161         int changes_made = 0;
1162
1163         memset(&u, 0, sizeof(struct sdm_userdata));
1164
1165         if (CtdlAccessCheck(ac_logged_in)) return;
1166         extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
1167         msiv_load(&u);
1168
1169         if (!strcasecmp(subcmd, "putscript")) {
1170                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1171                 if (!IsEmptyStr(script_name)) {
1172                         cprintf("%d Transmit script now\n", SEND_LISTING);
1173                         script_content = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
1174                         msiv_putscript(&u, script_name, script_content);
1175                         changes_made = 1;
1176                 }
1177                 else {
1178                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1179                 }
1180         }       
1181         
1182         else if (!strcasecmp(subcmd, "listscripts")) {
1183                 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
1184                 for (s=u.first_script; s!=NULL; s=s->next) {
1185                         if (s->script_content != NULL) {
1186                                 cprintf("%s|%d|\n", s->script_name, s->script_active);
1187                         }
1188                 }
1189                 cprintf("000\n");
1190         }
1191
1192         else if (!strcasecmp(subcmd, "setactive")) {
1193                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1194                 if (msiv_setactive(&u, script_name) == 0) {
1195                         cprintf("%d ok\n", CIT_OK);
1196                         changes_made = 1;
1197                 }
1198                 else {
1199                         cprintf("%d Script '%s' does not exist.\n",
1200                                 ERROR + ILLEGAL_VALUE,
1201                                 script_name
1202                         );
1203                 }
1204         }
1205
1206         else if (!strcasecmp(subcmd, "getscript")) {
1207                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1208                 script_content = msiv_getscript(&u, script_name);
1209                 if (script_content != NULL) {
1210                         int script_len;
1211
1212                         cprintf("%d Script:\n", LISTING_FOLLOWS);
1213                         script_len = strlen(script_content);
1214                         client_write(script_content, script_len);
1215                         if (script_content[script_len-1] != '\n') {
1216                                 cprintf("\n");
1217                         }
1218                         cprintf("000\n");
1219                 }
1220                 else {
1221                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1222                 }
1223         }
1224
1225         else if (!strcasecmp(subcmd, "deletescript")) {
1226                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1227                 i = msiv_deletescript(&u, script_name);
1228                 if (i == 0) {
1229                         cprintf("%d ok\n", CIT_OK);
1230                         changes_made = 1;
1231                 }
1232                 else if (i == 1) {
1233                         cprintf("%d Script '%s' does not exist.\n",
1234                                 ERROR + ILLEGAL_VALUE,
1235                                 script_name
1236                         );
1237                 }
1238                 else if (i == 2) {
1239                         cprintf("%d Script '%s' is active and cannot be deleted.\n",
1240                                 ERROR + ILLEGAL_VALUE,
1241                                 script_name
1242                         );
1243                 }
1244                 else {
1245                         cprintf("%d unknown error\n", ERROR);
1246                 }
1247         }
1248
1249         else {
1250                 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
1251         }
1252
1253         msiv_store(&u, changes_made);
1254 }
1255
1256
1257
1258 void ctdl_sieve_init(void) {
1259         char *cred = NULL;
1260         sieve2_context_t *sieve2_context = NULL;
1261         int res;
1262
1263         /*
1264          *      We don't really care about dumping the entire credits to the log
1265          *      every time the server is initialized.  The documentation will suffice
1266          *      for that purpose.  We are making a call to sieve2_credits() in order
1267          *      to demonstrate that we have successfully linked in to libsieve.
1268          */
1269         cred = strdup(sieve2_credits());
1270         if (cred == NULL) return;
1271
1272         if (strlen(cred) > 60) {
1273                 strcpy(&cred[55], "...");
1274         }
1275
1276         syslog(LOG_INFO, "%s",cred);
1277         free(cred);
1278
1279         /* Briefly initialize a Sieve parser instance just so we can list the
1280          * extensions that are available.
1281          */
1282         res = sieve2_alloc(&sieve2_context);
1283         if (res != SIEVE2_OK) {
1284                 syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res));
1285                 return;
1286         }
1287
1288         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1289         if (res != SIEVE2_OK) {
1290                 syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res));
1291                 goto BAIL;
1292         }
1293
1294         msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1295         syslog(LOG_INFO, "Extensions: %s", msiv_extensions);
1296
1297 BAIL:   res = sieve2_free(&sieve2_context);
1298         if (res != SIEVE2_OK) {
1299                 syslog(LOG_CRIT, "sieve2_free() returned %d: %s", res, sieve2_errstr(res));
1300         }
1301
1302 }
1303
1304 void cleanup_sieve(void)
1305 {
1306         struct RoomProcList *ptr, *ptr2;
1307
1308         if (msiv_extensions != NULL)
1309                 free(msiv_extensions);
1310         msiv_extensions = NULL;
1311
1312         begin_critical_section(S_SIEVELIST);
1313         ptr=sieve_list;
1314         while (ptr != NULL) {
1315                 ptr2 = ptr->next;
1316                 free(ptr);
1317                 ptr = ptr2;
1318         }
1319         sieve_list = NULL;
1320         end_critical_section(S_SIEVELIST);
1321 }
1322
1323 int serv_sieve_room(struct ctdlroom *room)
1324 {
1325         if (!strcasecmp(&room->QRname[11], MAILROOM)) {
1326                 sieve_queue_room(room);
1327         }
1328         return 0;
1329 }
1330
1331 CTDL_MODULE_INIT(sieve)
1332 {
1333         if (!threading)
1334         {
1335
1336                 ctdl_sieve_init();
1337                 CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1338                 CtdlRegisterRoomHook(serv_sieve_room);
1339                 CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
1340                 CtdlRegisterCleanupHook(cleanup_sieve);
1341         }
1342         
1343         /* return our module name for the log */
1344         return "sieve";
1345 }
1346