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