4 * This module glues libSieve to the Citadel server in order to implement
5 * the Sieve mailbox filtering language (RFC 3028).
7 * Copyright (c) 1987-2010 by the citadel.org team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <sys/types.h>
34 #if TIME_WITH_SYS_TIME
35 # include <sys/time.h>
39 # include <sys/time.h>
48 #include <libcitadel.h>
51 #include "citserver.h"
57 #include "internet_addressing.h"
58 #include "ctdl_module.h"
59 #include "serv_sieve.h"
61 struct RoomProcList *sieve_list = NULL;
62 char *msiv_extensions = NULL;
66 * Callback function to send libSieve trace messages to Citadel log facility
68 int ctdl_debug(sieve2_context_t *s, void *my)
70 CtdlLogPrintf(CTDL_DEBUG, "Sieve: %s\n", sieve2_getvalue_string(s, "message"));
76 * Callback function to log script parsing errors
78 int ctdl_errparse(sieve2_context_t *s, void *my)
80 CtdlLogPrintf(CTDL_WARNING, "Error in script, line %d: %s\n",
81 sieve2_getvalue_int(s, "lineno"),
82 sieve2_getvalue_string(s, "message")
89 * Callback function to log script execution errors
91 int ctdl_errexec(sieve2_context_t *s, void *my)
93 CtdlLogPrintf(CTDL_WARNING, "Error executing script: %s\n",
94 sieve2_getvalue_string(s, "message")
101 * Callback function to redirect a message to a different folder
103 int ctdl_redirect(sieve2_context_t *s, void *my)
105 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
106 struct CtdlMessage *msg = NULL;
107 struct recptypes *valid = NULL;
110 safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
112 CtdlLogPrintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
114 valid = validate_recipients(recp, NULL, 0);
116 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
117 return SIEVE2_ERROR_BADARGS;
119 if (valid->num_error > 0) {
120 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
121 free_recipients(valid);
122 return SIEVE2_ERROR_BADARGS;
125 msg = CtdlFetchMessage(cs->msgnum, 1);
127 CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
128 free_recipients(valid);
129 return SIEVE2_ERROR_BADARGS;
132 CtdlSubmitMsg(msg, valid, NULL, 0);
133 cs->cancel_implicit_keep = 1;
134 free_recipients(valid);
135 CtdlFreeMessage(msg);
141 * Callback function to indicate that a message *will* be kept in the inbox
143 int ctdl_keep(sieve2_context_t *s, void *my)
145 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
147 CtdlLogPrintf(CTDL_DEBUG, "Action is KEEP\n");
150 cs->cancel_implicit_keep = 1;
156 * Callback function to file a message into a different mailbox
158 int ctdl_fileinto(sieve2_context_t *s, void *my)
160 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
161 const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
163 char foldername[256];
164 char original_room_name[ROOMNAMELEN];
166 CtdlLogPrintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
168 /* FILEINTO 'INBOX' is the same thing as KEEP */
169 if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
171 cs->cancel_implicit_keep = 1;
175 /* Remember what room we came from */
176 safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
178 /* First try a mailbox name match (check personal mail folders first) */
179 snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
180 c = CtdlGetRoom(&CC->room, foldername);
182 /* Then a regular room name match (public and private rooms) */
184 safestrncpy(foldername, dest_folder, sizeof foldername);
185 c = CtdlGetRoom(&CC->room, foldername);
189 CtdlLogPrintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
190 return SIEVE2_ERROR_BADARGS;
193 /* Yes, we actually have to go there */
194 CtdlUserGoto(NULL, 0, 0, NULL, NULL);
196 c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL, 0);
198 /* Go back to the room we came from */
199 if (strcasecmp(original_room_name, CC->room.QRname)) {
200 CtdlUserGoto(original_room_name, 0, 0, NULL, NULL);
204 cs->cancel_implicit_keep = 1;
208 return SIEVE2_ERROR_BADARGS;
214 * Callback function to indicate that a message should be discarded.
216 int ctdl_discard(sieve2_context_t *s, void *my)
218 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
220 CtdlLogPrintf(CTDL_DEBUG, "Action is DISCARD\n");
222 /* Cancel the implicit keep. That's all there is to it. */
223 cs->cancel_implicit_keep = 1;
230 * Callback function to indicate that a message should be rejected
232 int ctdl_reject(sieve2_context_t *s, void *my)
234 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
235 char *reject_text = NULL;
237 CtdlLogPrintf(CTDL_DEBUG, "Action is REJECT\n");
239 /* If we don't know who sent the message, do a DISCARD instead. */
240 if (IsEmptyStr(cs->sender)) {
241 CtdlLogPrintf(CTDL_INFO, "Unknown sender. Doing DISCARD instead of REJECT.\n");
242 return ctdl_discard(s, my);
245 /* Assemble the reject message. */
246 reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024);
247 if (reject_text == NULL) {
248 return SIEVE2_ERROR_FAIL;
252 "Content-type: text/plain\n"
254 "The message was refused by the recipient's mail filtering program.\n"
255 "The reason given was as follows:\n"
260 sieve2_getvalue_string(s, "message")
263 quickie_message( /* This delivers the message */
270 "Delivery status notification"
274 cs->cancel_implicit_keep = 1;
281 * Callback function to indicate that a vacation message should be generated
283 int ctdl_vacation(sieve2_context_t *s, void *my)
285 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
286 struct sdm_vacation *vptr;
289 char *vacamsg_text = NULL;
290 char vacamsg_subject[1024];
292 CtdlLogPrintf(CTDL_DEBUG, "Action is VACATION\n");
294 message = sieve2_getvalue_string(s, "message");
295 if (message == NULL) return SIEVE2_ERROR_BADARGS;
297 if (sieve2_getvalue_string(s, "subject") != NULL) {
298 safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject);
301 snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject);
304 days = sieve2_getvalue_int(s, "days");
305 if (days < 1) days = 1;
306 if (days > MAX_VACATION) days = MAX_VACATION;
308 /* Check to see whether we've already alerted this sender that we're on vacation. */
309 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
310 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
311 if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) {
312 CtdlLogPrintf(CTDL_DEBUG, "Already alerted <%s> recently.\n", cs->sender);
318 /* Assemble the reject message. */
319 vacamsg_text = malloc(strlen(message) + 1024);
320 if (vacamsg_text == NULL) {
321 return SIEVE2_ERROR_FAIL;
324 sprintf(vacamsg_text,
325 "Content-type: text/plain charset=utf-8\n"
333 quickie_message( /* This delivers the message */
345 /* Now update the list to reflect the fact that we've alerted this sender.
346 * If they're already in the list, just update the timestamp.
348 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
349 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
350 vptr->timestamp = time(NULL);
355 /* If we get to this point, create a new record.
357 vptr = malloc(sizeof(struct sdm_vacation));
358 memset(vptr, 0, sizeof(struct sdm_vacation));
359 vptr->timestamp = time(NULL);
360 safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr);
361 vptr->next = cs->u->first_vacation;
362 cs->u->first_vacation = vptr;
369 * Callback function to parse addresses per local system convention
370 * It is disabled because we don't support subaddresses.
373 int ctdl_getsubaddress(sieve2_context_t *s, void *my)
375 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
377 /* libSieve does not take ownership of the memory used here. But, since we
378 * are just pointing to locations inside a struct which we are going to free
381 sieve2_setvalue_string(s, "user", cs->recp_user);
382 sieve2_setvalue_string(s, "detail", "");
383 sieve2_setvalue_string(s, "localpart", cs->recp_user);
384 sieve2_setvalue_string(s, "domain", cs->recp_node);
391 * Callback function to parse message envelope
393 int ctdl_getenvelope(sieve2_context_t *s, void *my)
395 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
397 CtdlLogPrintf(CTDL_DEBUG, "Action is GETENVELOPE\nEnvFrom: %s\n EnvTo: %s\n",
398 cs->envelope_from, cs->envelope_to);
400 if (cs->envelope_from != NULL) {
401 if ((cs->envelope_from[0] != '@')&&(cs->envelope_from[strlen(cs->envelope_from)-1] != '@')) {
402 sieve2_setvalue_string(s, "from", cs->envelope_from);
405 sieve2_setvalue_string(s, "from", "invalid_envelope_from@example.org");
409 sieve2_setvalue_string(s, "from", "null_envelope_from@example.org");
413 if (cs->envelope_to != NULL) {
414 if ((cs->envelope_to[0] != '@') && (cs->envelope_to[strlen(cs->envelope_to)-1] != '@')) {
415 sieve2_setvalue_string(s, "to", cs->envelope_to);
418 sieve2_setvalue_string(s, "to", "invalid_envelope_to@example.org");
422 sieve2_setvalue_string(s, "to", "null_envelope_to@example.org");
430 * Callback function to fetch message body
431 * (Uncomment the code if we implement this extension)
433 int ctdl_getbody(sieve2_context_t *s, void *my)
435 return SIEVE2_ERROR_UNSUPPORTED;
442 * Callback function to fetch message size
444 int ctdl_getsize(sieve2_context_t *s, void *my)
446 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
449 GetMetaData(&smi, cs->msgnum);
451 if (smi.meta_rfc822_length > 0L) {
452 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
456 return SIEVE2_ERROR_UNSUPPORTED;
461 * Callback function to retrieve the sieve script
463 int ctdl_getscript(sieve2_context_t *s, void *my) {
464 struct sdm_script *sptr;
465 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
467 for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) {
468 if (sptr->script_active > 0) {
469 CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
470 sieve2_setvalue_string(s, "script", sptr->script_content);
475 CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n");
476 return SIEVE2_ERROR_GETSCRIPT;
480 * Callback function to retrieve message headers
482 int ctdl_getheaders(sieve2_context_t *s, void *my) {
484 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
486 CtdlLogPrintf(CTDL_DEBUG, "ctdl_getheaders() was called\n");
487 sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
494 * Add a room to the list of those rooms which potentially require sieve processing
496 void sieve_queue_room(struct ctdlroom *which_room) {
497 struct RoomProcList *ptr;
499 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
500 if (ptr == NULL) return;
502 safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
503 begin_critical_section(S_SIEVELIST);
504 ptr->next = sieve_list;
506 end_critical_section(S_SIEVELIST);
507 CtdlLogPrintf(CTDL_DEBUG, "<%s> queued for Sieve processing\n", which_room->QRname);
513 * Perform sieve processing for one message (called by sieve_do_room() for each message)
515 void sieve_do_msg(long msgnum, void *userdata) {
516 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
517 sieve2_context_t *sieve2_context;
518 struct ctdl_sieve my;
520 struct CtdlMessage *msg;
522 size_t headers_len = 0;
527 CtdlLogPrintf(CTDL_EMERG, "Can't process message <%ld> without userdata!\n", msgnum);
531 sieve2_context = u->sieve2_context;
533 CtdlLogPrintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
536 * Make sure you include message body so you can get those second-level headers ;)
538 msg = CtdlFetchMessage(msgnum, 1);
539 if (msg == NULL) return;
542 * Grab the message headers so we can feed them to libSieve.
543 * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers.
545 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
546 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0);
547 headers_len = StrLength(CC->redirect_buffer);
548 my.rfc822headers = SmashStrBuf(&CC->redirect_buffer);
551 * libSieve clobbers the stack if it encounters badly formed
552 * headers. Sanitize our headers by stripping nonprintable
555 for (i=0; i<headers_len; ++i) {
556 if (!isascii(my.rfc822headers[i])) {
557 my.rfc822headers[i] = '_';
561 my.keep = 0; /* Set to 1 to declare an *explicit* keep */
562 my.cancel_implicit_keep = 0; /* Some actions will cancel the implicit keep */
563 my.usernum = atol(CC->room.QRname); /* Keep track of the owner of the room's namespace */
564 my.msgnum = msgnum; /* Keep track of the message number in our local store */
565 my.u = u; /* Hand off a pointer to the rest of this info */
567 /* Keep track of the recipient so we can do handling based on it later */
568 process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
570 /* Keep track of the sender so we can use it for REJECT and VACATION responses */
571 if (msg->cm_fields['F'] != NULL) {
572 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
574 else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
575 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
577 else if (msg->cm_fields['A'] != NULL) {
578 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
581 strcpy(my.sender, "");
584 /* Keep track of the subject so we can use it for VACATION responses */
585 if (msg->cm_fields['U'] != NULL) {
586 safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject);
589 strcpy(my.subject, "");
592 /* Keep track of the envelope-from address (use body-from if not found) */
593 if (msg->cm_fields['P'] != NULL) {
594 safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from);
595 stripallbut(my.envelope_from, '<', '>');
597 else if (msg->cm_fields['F'] != NULL) {
598 safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof my.envelope_from);
599 stripallbut(my.envelope_from, '<', '>');
602 strcpy(my.envelope_from, "");
605 len = strlen(my.envelope_from);
606 for (i=0; i<len; ++i) {
607 if (isspace(my.envelope_from[i])) my.envelope_from[i] = '_';
609 if (haschar(my.envelope_from, '@') == 0) {
610 strcat(my.envelope_from, "@");
611 strcat(my.envelope_from, config.c_fqdn);
614 /* Keep track of the envelope-to address (use body-to if not found) */
615 if (msg->cm_fields['V'] != NULL) {
616 safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to);
617 stripallbut(my.envelope_to, '<', '>');
619 else if (msg->cm_fields['R'] != NULL) {
620 safestrncpy(my.envelope_to, msg->cm_fields['R'], sizeof my.envelope_to);
621 if (msg->cm_fields['D'] != NULL) {
622 strcat(my.envelope_to, "@");
623 strcat(my.envelope_to, msg->cm_fields['D']);
625 stripallbut(my.envelope_to, '<', '>');
628 strcpy(my.envelope_to, "");
631 len = strlen(my.envelope_to);
632 for (i=0; i<len; ++i) {
633 if (isspace(my.envelope_to[i])) my.envelope_to[i] = '_';
635 if (haschar(my.envelope_to, '@') == 0) {
636 strcat(my.envelope_to, "@");
637 strcat(my.envelope_to, config.c_fqdn);
640 CtdlFreeMessage(msg);
642 sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
644 CtdlLogPrintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
645 res = sieve2_execute(sieve2_context, &my);
646 if (res != SIEVE2_OK) {
647 CtdlLogPrintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
650 free(my.rfc822headers);
651 my.rfc822headers = NULL;
654 * Delete the message from the inbox unless either we were told not to, or
655 * if no other action was successfully taken.
657 if ( (!my.keep) && (my.cancel_implicit_keep) ) {
658 CtdlLogPrintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n");
659 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
662 CtdlLogPrintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
663 u->lastproc = msgnum;
671 * Given the on-disk representation of our Sieve config, load
672 * it into an in-memory data structure.
674 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
678 struct sdm_script *sptr;
679 struct sdm_vacation *vptr;
682 while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
684 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
686 extract_token(keyword, c, 0, '|', sizeof keyword);
688 if (!strcasecmp(keyword, "lastproc")) {
689 u->lastproc = extract_long(c, 1);
692 else if (!strcasecmp(keyword, "script")) {
693 sptr = malloc(sizeof(struct sdm_script));
694 extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
695 sptr->script_active = extract_int(c, 2);
696 remove_token(c, 0, '|');
697 remove_token(c, 0, '|');
698 remove_token(c, 0, '|');
699 sptr->script_content = strdup(c);
700 sptr->next = u->first_script;
701 u->first_script = sptr;
704 else if (!strcasecmp(keyword, "vacation")) {
706 if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
711 if (strncasecmp(vacrec, "vacation|", 9)) {
712 vptr = malloc(sizeof(struct sdm_vacation));
713 extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
714 vptr->timestamp = extract_long(vacrec, 1);
715 vptr->next = u->first_vacation;
716 u->first_vacation = vptr;
721 /* ignore unknown keywords */
726 * We found the Sieve configuration for this user.
727 * Now do something with it.
729 void get_sieve_config_backend(long msgnum, void *userdata) {
730 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
731 struct CtdlMessage *msg;
734 u->config_msgnum = msgnum;
735 msg = CtdlFetchMessage(msgnum, 1);
737 u->config_msgnum = (-1) ;
741 conf = msg->cm_fields['M'];
742 msg->cm_fields['M'] = NULL;
743 CtdlFreeMessage(msg);
746 parse_sieve_config(conf, u);
754 * Write our citadel sieve config back to disk
756 * (Set yes_write_to_disk to nonzero to make it actually write the config;
757 * otherwise it just frees the data structures.)
759 void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
761 struct sdm_script *sptr;
762 struct sdm_vacation *vptr;
764 text = NewStrBufPlain(NULL, SIZ);
766 "Content-type: application/x-citadel-sieve-config\n"
768 CTDLSIEVECONFIGSEPARATOR
770 CTDLSIEVECONFIGSEPARATOR
775 while (u->first_script != NULL) {
776 StrBufAppendPrintf(text,
777 "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
778 u->first_script->script_name,
779 u->first_script->script_active,
780 u->first_script->script_content
782 sptr = u->first_script;
783 u->first_script = u->first_script->next;
784 free(sptr->script_content);
788 if (u->first_vacation != NULL) {
790 StrBufAppendPrintf(text, "vacation|\n");
791 while (u->first_vacation != NULL) {
792 if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
793 StrBufAppendPrintf(text, "%s|%ld\n",
794 u->first_vacation->fromaddr,
795 u->first_vacation->timestamp
798 vptr = u->first_vacation;
799 u->first_vacation = u->first_vacation->next;
802 StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR);
805 if (yes_write_to_disk)
807 /* Save the config */
808 quickie_message("Citadel", NULL, NULL, u->config_roomname,
811 "Sieve configuration"
814 /* And delete the old one */
815 if (u->config_msgnum > 0) {
816 CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "");
826 * This is our callback registration table for libSieve.
828 sieve2_callback_t ctdl_sieve_callbacks[] = {
829 { SIEVE2_ACTION_REJECT, ctdl_reject },
830 { SIEVE2_ACTION_VACATION, ctdl_vacation },
831 { SIEVE2_ERRCALL_PARSE, ctdl_errparse },
832 { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec },
833 { SIEVE2_ACTION_FILEINTO, ctdl_fileinto },
834 { SIEVE2_ACTION_REDIRECT, ctdl_redirect },
835 { SIEVE2_ACTION_DISCARD, ctdl_discard },
836 { SIEVE2_ACTION_KEEP, ctdl_keep },
837 { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript },
838 { SIEVE2_DEBUG_TRACE, ctdl_debug },
839 { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders },
840 { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize },
841 { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope },
843 * These actions are unsupported by Citadel so we don't declare them.
845 { SIEVE2_ACTION_NOTIFY, ctdl_notify },
846 { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress },
847 { SIEVE2_MESSAGE_GETBODY, ctdl_getbody },
855 * Perform sieve processing for a single room
857 void sieve_do_room(char *roomname) {
859 struct sdm_userdata u;
860 sieve2_context_t *sieve2_context = NULL; /* Context for sieve parser */
861 int res; /* Return code from libsieve calls */
862 long orig_lastproc = 0;
864 memset(&u, 0, sizeof u);
866 /* See if the user who owns this 'mailbox' has any Sieve scripts that
869 snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM);
870 if (CtdlGetRoom(&CC->room, u.config_roomname) != 0) {
871 CtdlLogPrintf(CTDL_DEBUG, "<%s> does not exist. No processing is required.\n", u.config_roomname);
876 * Find the sieve scripts and control record and do something
878 u.config_msgnum = (-1);
879 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
880 get_sieve_config_backend, (void *)&u );
882 if (u.config_msgnum < 0) {
883 CtdlLogPrintf(CTDL_DEBUG, "No Sieve rules exist. No processing is required.\n");
887 CtdlLogPrintf(CTDL_DEBUG, "Rules found. Performing Sieve processing for <%s>\n", roomname);
889 if (CtdlGetRoom(&CC->room, roomname) != 0) {
890 CtdlLogPrintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
894 /* Initialize the Sieve parser */
896 res = sieve2_alloc(&sieve2_context);
897 if (res != SIEVE2_OK) {
898 CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
902 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
903 if (res != SIEVE2_OK) {
904 CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
908 /* Validate the script */
910 struct ctdl_sieve my; /* dummy ctdl_sieve struct just to pass "u" slong */
911 memset(&my, 0, sizeof my);
913 res = sieve2_validate(sieve2_context, &my);
914 if (res != SIEVE2_OK) {
915 CtdlLogPrintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
919 /* Do something useful */
920 u.sieve2_context = sieve2_context;
921 orig_lastproc = u.lastproc;
922 CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
928 res = sieve2_free(&sieve2_context);
929 if (res != SIEVE2_OK) {
930 CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
933 /* Rewrite the config if we have to */
934 rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ;
939 * Perform sieve processing for all rooms which require it
941 void perform_sieve_processing(void) {
942 struct RoomProcList *ptr = NULL;
944 if (sieve_list != NULL) {
945 CtdlLogPrintf(CTDL_DEBUG, "Begin Sieve processing\n");
946 while (sieve_list != NULL) {
947 char spoolroomname[ROOMNAMELEN];
948 safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
949 begin_critical_section(S_SIEVELIST);
951 /* pop this record off the list */
953 sieve_list = sieve_list->next;
956 /* invalidate any duplicate entries to prevent double processing */
957 for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
958 if (!strcasecmp(ptr->name, spoolroomname)) {
963 end_critical_section(S_SIEVELIST);
964 if (spoolroomname[0] != 0) {
965 sieve_do_room(spoolroomname);
972 void msiv_load(struct sdm_userdata *u) {
973 char hold_rm[ROOMNAMELEN];
975 strcpy(hold_rm, CC->room.QRname); /* save current room */
977 /* Take a spin through the user's personal address book */
978 if (CtdlGetRoom(&CC->room, USERCONFIGROOM) == 0) {
980 u->config_msgnum = (-1);
981 strcpy(u->config_roomname, CC->room.QRname);
982 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
983 get_sieve_config_backend, (void *)u );
987 if (strcmp(CC->room.QRname, hold_rm)) {
988 CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */
992 void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) {
994 * Initialise the sieve configs last processed message number.
995 * We don't need to get the highest message number for the users inbox since the systems
996 * highest message number will be higher than that and loer than this scripts message number
997 * This prevents this new script from processing any old messages in the inbox.
998 * Most importantly it will prevent vacation messages being sent to lots of old messages
1001 u->lastproc = CtdlGetCurrentMessageNumber();
1002 rewrite_ctdl_sieve_config(u, yes_write_to_disk);
1007 * Select the active script.
1008 * (Set script_name to an empty string to disable all scripts)
1010 * Returns 0 on success or nonzero for error.
1012 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
1014 struct sdm_script *s;
1016 /* First see if the supplied value is ok */
1018 if (IsEmptyStr(script_name)) {
1022 for (s=u->first_script; s!=NULL; s=s->next) {
1023 if (!strcasecmp(s->script_name, script_name)) {
1029 if (!ok) return(-1);
1031 /* Now set the active script */
1032 for (s=u->first_script; s!=NULL; s=s->next) {
1033 if (!strcasecmp(s->script_name, script_name)) {
1034 s->script_active = 1;
1037 s->script_active = 0;
1046 * Fetch a script by name.
1048 * Returns NULL if the named script was not found, or a pointer to the script
1049 * if it was found. NOTE: the caller does *not* own the memory returned by
1050 * this function. Copy it if you need to keep it.
1052 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
1053 struct sdm_script *s;
1055 for (s=u->first_script; s!=NULL; s=s->next) {
1056 if (!strcasecmp(s->script_name, script_name)) {
1057 if (s->script_content != NULL) {
1058 return (s->script_content);
1068 * Delete a script by name.
1070 * Returns 0 if the script was deleted.
1071 * 1 if the script was not found.
1072 * 2 if the script cannot be deleted because it is active.
1074 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
1075 struct sdm_script *s = NULL;
1076 struct sdm_script *script_to_delete = NULL;
1078 for (s=u->first_script; s!=NULL; s=s->next) {
1079 if (!strcasecmp(s->script_name, script_name)) {
1080 script_to_delete = s;
1081 if (s->script_active) {
1087 if (script_to_delete == NULL) return(1);
1089 if (u->first_script == script_to_delete) {
1090 u->first_script = u->first_script->next;
1092 else for (s=u->first_script; s!=NULL; s=s->next) {
1093 if (s->next == script_to_delete) {
1094 s->next = s->next->next;
1098 free(script_to_delete->script_content);
1099 free(script_to_delete);
1105 * Add or replace a new script.
1106 * NOTE: after this function returns, "u" owns the memory that "script_content"
1109 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
1111 struct sdm_script *s, *sptr;
1113 for (s=u->first_script; s!=NULL; s=s->next) {
1114 if (!strcasecmp(s->script_name, script_name)) {
1115 if (s->script_content != NULL) {
1116 free(s->script_content);
1118 s->script_content = script_content;
1123 if (replaced == 0) {
1124 sptr = malloc(sizeof(struct sdm_script));
1125 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
1126 sptr->script_content = script_content;
1127 sptr->script_active = 0;
1128 sptr->next = u->first_script;
1129 u->first_script = sptr;
1136 * Citadel protocol to manage sieve scripts.
1137 * This is basically a simplified (read: doesn't resemble IMAP) version
1138 * of the 'managesieve' protocol.
1140 void cmd_msiv(char *argbuf) {
1142 struct sdm_userdata u;
1143 char script_name[256];
1144 char *script_content = NULL;
1145 struct sdm_script *s;
1147 int changes_made = 0;
1149 memset(&u, 0, sizeof(struct sdm_userdata));
1151 if (CtdlAccessCheck(ac_logged_in)) return;
1152 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
1155 if (!strcasecmp(subcmd, "putscript")) {
1156 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1157 if (!IsEmptyStr(script_name)) {
1158 cprintf("%d Transmit script now\n", SEND_LISTING);
1159 script_content = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
1160 msiv_putscript(&u, script_name, script_content);
1164 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1168 else if (!strcasecmp(subcmd, "listscripts")) {
1169 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
1170 for (s=u.first_script; s!=NULL; s=s->next) {
1171 if (s->script_content != NULL) {
1172 cprintf("%s|%d|\n", s->script_name, s->script_active);
1178 else if (!strcasecmp(subcmd, "setactive")) {
1179 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1180 if (msiv_setactive(&u, script_name) == 0) {
1181 cprintf("%d ok\n", CIT_OK);
1185 cprintf("%d Script '%s' does not exist.\n",
1186 ERROR + ILLEGAL_VALUE,
1192 else if (!strcasecmp(subcmd, "getscript")) {
1193 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1194 script_content = msiv_getscript(&u, script_name);
1195 if (script_content != NULL) {
1198 cprintf("%d Script:\n", LISTING_FOLLOWS);
1199 script_len = strlen(script_content);
1200 client_write(script_content, script_len);
1201 if (script_content[script_len-1] != '\n') {
1207 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1211 else if (!strcasecmp(subcmd, "deletescript")) {
1212 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1213 i = msiv_deletescript(&u, script_name);
1215 cprintf("%d ok\n", CIT_OK);
1219 cprintf("%d Script '%s' does not exist.\n",
1220 ERROR + ILLEGAL_VALUE,
1225 cprintf("%d Script '%s' is active and cannot be deleted.\n",
1226 ERROR + ILLEGAL_VALUE,
1231 cprintf("%d unknown error\n", ERROR);
1236 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
1239 msiv_store(&u, changes_made);
1244 void ctdl_sieve_init(void) {
1246 sieve2_context_t *sieve2_context = NULL;
1250 * We don't really care about dumping the entire credits to the log
1251 * every time the server is initialized. The documentation will suffice
1252 * for that purpose. We are making a call to sieve2_credits() in order
1253 * to demonstrate that we have successfully linked in to libsieve.
1255 cred = strdup(sieve2_credits());
1256 if (cred == NULL) return;
1258 if (strlen(cred) > 60) {
1259 strcpy(&cred[55], "...");
1262 CtdlLogPrintf(CTDL_INFO, "%s\n",cred);
1265 /* Briefly initialize a Sieve parser instance just so we can list the
1266 * extensions that are available.
1268 res = sieve2_alloc(&sieve2_context);
1269 if (res != SIEVE2_OK) {
1270 CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
1274 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1275 if (res != SIEVE2_OK) {
1276 CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
1280 msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1281 CtdlLogPrintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
1283 BAIL: res = sieve2_free(&sieve2_context);
1284 if (res != SIEVE2_OK) {
1285 CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
1290 int serv_sieve_room(struct ctdlroom *room)
1292 if (!strcasecmp(&room->QRname[11], MAILROOM)) {
1293 sieve_queue_room(room);
1298 CTDL_MODULE_INIT(sieve)
1304 CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1305 CtdlRegisterRoomHook(serv_sieve_room);
1306 CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
1309 /* return our Subversion id for the Log */