4 * This module glues libSieve to the Citadel server in order to implement
5 * the Sieve mailbox filtering language (RFC 3028).
7 * This code is released under the terms of the GNU General Public License.
18 #include <sys/types.h>
20 #if TIME_WITH_SYS_TIME
21 # include <sys/time.h>
25 # include <sys/time.h>
36 #include "citserver.h"
43 #include "internet_addressing.h"
47 #include "ctdl_module.h"
52 #include "serv_sieve.h"
54 struct RoomProcList *sieve_list = NULL;
55 char *msiv_extensions = NULL;
59 * Callback function to send libSieve trace messages to Citadel log facility
61 int ctdl_debug(sieve2_context_t *s, void *my)
63 lprintf(CTDL_DEBUG, "Sieve: %s\n", sieve2_getvalue_string(s, "message"));
69 * Callback function to log script parsing errors
71 int ctdl_errparse(sieve2_context_t *s, void *my)
73 lprintf(CTDL_WARNING, "Error in script, line %d: %s\n",
74 sieve2_getvalue_int(s, "lineno"),
75 sieve2_getvalue_string(s, "message")
82 * Callback function to log script execution errors
84 int ctdl_errexec(sieve2_context_t *s, void *my)
86 lprintf(CTDL_WARNING, "Error executing script: %s\n",
87 sieve2_getvalue_string(s, "message")
94 * Callback function to redirect a message to a different folder
96 int ctdl_redirect(sieve2_context_t *s, void *my)
98 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
99 struct CtdlMessage *msg = NULL;
100 struct recptypes *valid = NULL;
103 safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
105 lprintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
107 valid = validate_recipients(recp);
109 lprintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
110 return SIEVE2_ERROR_BADARGS;
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;
118 msg = CtdlFetchMessage(cs->msgnum, 1);
120 lprintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
121 free_recipients(valid);
122 return SIEVE2_ERROR_BADARGS;
125 CtdlSubmitMsg(msg, valid, NULL);
126 cs->cancel_implicit_keep = 1;
127 free_recipients(valid);
128 CtdlFreeMessage(msg);
134 * Callback function to indicate that a message *will* be kept in the inbox
136 int ctdl_keep(sieve2_context_t *s, void *my)
138 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
140 lprintf(CTDL_DEBUG, "Action is KEEP\n");
143 cs->cancel_implicit_keep = 1;
149 * Callback function to file a message into a different mailbox
151 int ctdl_fileinto(sieve2_context_t *s, void *my)
153 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
154 const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
156 char foldername[256];
157 char original_room_name[ROOMNAMELEN];
159 lprintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
161 /* FILEINTO 'INBOX' is the same thing as KEEP */
162 if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
164 cs->cancel_implicit_keep = 1;
168 /* Remember what room we came from */
169 safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
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);
175 /* Then a regular room name match (public and private rooms) */
177 safestrncpy(foldername, dest_folder, sizeof foldername);
178 c = getroom(&CC->room, foldername);
182 lprintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
183 return SIEVE2_ERROR_BADARGS;
186 /* Yes, we actually have to go there */
187 usergoto(NULL, 0, 0, NULL, NULL);
189 c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL);
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);
197 cs->cancel_implicit_keep = 1;
201 return SIEVE2_ERROR_BADARGS;
207 * Callback function to indicate that a message should be discarded.
209 int ctdl_discard(sieve2_context_t *s, void *my)
211 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
213 lprintf(CTDL_DEBUG, "Action is DISCARD\n");
215 /* Cancel the implicit keep. That's all there is to it. */
216 cs->cancel_implicit_keep = 1;
223 * Callback function to indicate that a message should be rejected
225 int ctdl_reject(sieve2_context_t *s, void *my)
227 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
228 char *reject_text = NULL;
230 lprintf(CTDL_DEBUG, "Action is REJECT\n");
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);
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;
245 "Content-type: text/plain\n"
247 "The message was refused by the recipient's mail filtering program.\n"
248 "The reason given was as follows:\n"
253 sieve2_getvalue_string(s, "message")
256 quickie_message( /* This delivers the message */
263 "Delivery status notification"
267 cs->cancel_implicit_keep = 1;
274 * Callback function to indicate that a vacation message should be generated
276 int ctdl_vacation(sieve2_context_t *s, void *my)
278 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
279 struct sdm_vacation *vptr;
282 char *vacamsg_text = NULL;
283 char vacamsg_subject[1024];
285 lprintf(CTDL_DEBUG, "Action is VACATION\n");
287 message = sieve2_getvalue_string(s, "message");
288 if (message == NULL) return SIEVE2_ERROR_BADARGS;
290 if (sieve2_getvalue_string(s, "subject") != NULL) {
291 safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject);
294 snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject);
297 days = sieve2_getvalue_int(s, "days");
298 if (days < 1) days = 1;
299 if (days > MAX_VACATION) days = MAX_VACATION;
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);
311 /* Assemble the reject message. */
312 vacamsg_text = malloc(strlen(message) + 1024);
313 if (vacamsg_text == NULL) {
314 return SIEVE2_ERROR_FAIL;
317 sprintf(vacamsg_text,
318 "Content-type: text/plain\n"
326 quickie_message( /* This delivers the message */
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.
341 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
342 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
343 vptr->timestamp = time(NULL);
348 /* If we get to this point, create a new record.
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;
361 * Callback function to parse addresses per local system convention
362 * It is disabled because we don't support subaddresses.
365 int ctdl_getsubaddress(sieve2_context_t *s, void *my)
367 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
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
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);
383 * Callback function to parse message envelope
385 int ctdl_getenvelope(sieve2_context_t *s, void *my)
387 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
389 lprintf(CTDL_DEBUG, "Action is GETENVELOPE\n");
390 sieve2_setvalue_string(s, "to", cs->envelope_to);
391 sieve2_setvalue_string(s, "from", cs->envelope_from);
397 * Callback function to fetch message body
398 * (Uncomment the code if we implement this extension)
400 int ctdl_getbody(sieve2_context_t *s, void *my)
402 return SIEVE2_ERROR_UNSUPPORTED;
409 * Callback function to fetch message size
411 int ctdl_getsize(sieve2_context_t *s, void *my)
413 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
416 GetMetaData(&smi, cs->msgnum);
418 if (smi.meta_rfc822_length > 0L) {
419 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
423 return SIEVE2_ERROR_UNSUPPORTED;
428 * Callback function to retrieve the sieve script
430 int ctdl_getscript(sieve2_context_t *s, void *my) {
431 struct sdm_script *sptr;
432 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
434 for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) {
435 if (sptr->script_active > 0) {
436 lprintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
437 sieve2_setvalue_string(s, "script", sptr->script_content);
442 lprintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n");
443 return SIEVE2_ERROR_GETSCRIPT;
447 * Callback function to retrieve message headers
449 int ctdl_getheaders(sieve2_context_t *s, void *my) {
451 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
453 lprintf(CTDL_DEBUG, "ctdl_getheaders() was called\n");
454 sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
461 * Add a room to the list of those rooms which potentially require sieve processing
463 void sieve_queue_room(struct ctdlroom *which_room) {
464 struct RoomProcList *ptr;
466 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
467 if (ptr == NULL) return;
469 safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
470 begin_critical_section(S_SIEVELIST);
471 ptr->next = sieve_list;
473 end_critical_section(S_SIEVELIST);
474 lprintf(CTDL_DEBUG, "<%s> queued for Sieve processing\n", which_room->QRname);
480 * Perform sieve processing for one message (called by sieve_do_room() for each message)
482 void sieve_do_msg(long msgnum, void *userdata) {
483 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
484 sieve2_context_t *sieve2_context = u->sieve2_context;
485 struct ctdl_sieve my;
487 struct CtdlMessage *msg;
489 size_t headers_len = 0;
492 lprintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
494 msg = CtdlFetchMessage(msgnum, 0);
495 if (msg == NULL) return;
498 * Grab the message headers so we can feed them to libSieve.
500 CC->redirect_buffer = malloc(SIZ);
501 CC->redirect_len = 0;
502 CC->redirect_alloc = SIZ;
503 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
504 my.rfc822headers = CC->redirect_buffer;
505 headers_len = CC->redirect_len;
506 CC->redirect_buffer = NULL;
507 CC->redirect_len = 0;
508 CC->redirect_alloc = 0;
511 * libSieve clobbers the stack if it encounters badly formed
512 * headers. Sanitize our headers by stripping nonprintable
515 for (i=0; i<headers_len; ++i) {
516 if (!isascii(my.rfc822headers[i])) {
517 my.rfc822headers[i] = '_';
521 my.keep = 0; /* Set to 1 to declare an *explicit* keep */
522 my.cancel_implicit_keep = 0; /* Some actions will cancel the implicit keep */
523 my.usernum = atol(CC->room.QRname); /* Keep track of the owner of the room's namespace */
524 my.msgnum = msgnum; /* Keep track of the message number in our local store */
525 my.u = u; /* Hand off a pointer to the rest of this info */
527 /* Keep track of the recipient so we can do handling based on it later */
528 process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
530 /* Keep track of the sender so we can use it for REJECT and VACATION responses */
531 if (msg->cm_fields['F'] != NULL) {
532 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
534 else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
535 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
537 else if (msg->cm_fields['A'] != NULL) {
538 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
541 strcpy(my.sender, "");
544 /* Keep track of the subject so we can use it for VACATION responses */
545 if (msg->cm_fields['U'] != NULL) {
546 safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject);
549 strcpy(my.subject, "");
552 /* Keep track of the envelope-from address (use body-from if not found) */
553 if (msg->cm_fields['P'] != NULL) {
554 safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from);
556 else if (msg->cm_fields['F'] != NULL) {
557 safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof my.envelope_from);
560 strcpy(my.envelope_from, "");
563 len = strlen(my.envelope_from);
564 for (i=0; i<len; ++i) {
565 if (isspace(my.envelope_from[i])) my.envelope_from[i] = '_';
567 if (haschar(my.envelope_from, '@') == 0) {
568 strcat(my.envelope_from, "@");
569 strcat(my.envelope_from, config.c_fqdn);
572 /* Keep track of the envelope-to address (use body-to if not found) */
573 if (msg->cm_fields['V'] != NULL) {
574 safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to);
576 else if (msg->cm_fields['R'] != NULL) {
577 safestrncpy(my.envelope_to, msg->cm_fields['R'], sizeof my.envelope_to);
578 if (msg->cm_fields['D'] != NULL) {
579 strcat(my.envelope_to, "@");
580 strcat(my.envelope_to, msg->cm_fields['D']);
584 strcpy(my.envelope_to, "");
587 len = strlen(my.envelope_to);
588 for (i=0; i<len; ++i) {
589 if (isspace(my.envelope_to[i])) my.envelope_to[i] = '_';
591 if (haschar(my.envelope_to, '@') == 0) {
592 strcat(my.envelope_to, "@");
593 strcat(my.envelope_to, config.c_fqdn);
596 CtdlFreeMessage(msg);
598 sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
600 lprintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
601 res = sieve2_execute(sieve2_context, &my);
602 if (res != SIEVE2_OK) {
603 lprintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
606 free(my.rfc822headers);
607 my.rfc822headers = NULL;
610 * Delete the message from the inbox unless either we were told not to, or
611 * if no other action was successfully taken.
613 if ( (!my.keep) && (my.cancel_implicit_keep) ) {
614 lprintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n");
615 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
618 lprintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
619 u->lastproc = msgnum;
627 * Given the on-disk representation of our Sieve config, load
628 * it into an in-memory data structure.
630 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
634 struct sdm_script *sptr;
635 struct sdm_vacation *vptr;
638 while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
640 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
642 extract_token(keyword, c, 0, '|', sizeof keyword);
644 if (!strcasecmp(keyword, "lastproc")) {
645 u->lastproc = extract_long(c, 1);
648 else if (!strcasecmp(keyword, "script")) {
649 sptr = malloc(sizeof(struct sdm_script));
650 extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
651 sptr->script_active = extract_int(c, 2);
652 remove_token(c, 0, '|');
653 remove_token(c, 0, '|');
654 remove_token(c, 0, '|');
655 sptr->script_content = strdup(c);
656 sptr->next = u->first_script;
657 u->first_script = sptr;
660 else if (!strcasecmp(keyword, "vacation")) {
662 if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
667 if (strncasecmp(vacrec, "vacation|", 9)) {
668 vptr = malloc(sizeof(struct sdm_vacation));
669 extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
670 vptr->timestamp = extract_long(vacrec, 1);
671 vptr->next = u->first_vacation;
672 u->first_vacation = vptr;
677 /* ignore unknown keywords */
682 * We found the Sieve configuration for this user.
683 * Now do something with it.
685 void get_sieve_config_backend(long msgnum, void *userdata) {
686 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
687 struct CtdlMessage *msg;
690 u->config_msgnum = msgnum;
691 msg = CtdlFetchMessage(msgnum, 1);
693 u->config_msgnum = (-1) ;
697 conf = msg->cm_fields['M'];
698 msg->cm_fields['M'] = NULL;
699 CtdlFreeMessage(msg);
702 parse_sieve_config(conf, u);
710 * Write our citadel sieve config back to disk
712 * (Set yes_write_to_disk to nonzero to make it actually write the config;
713 * otherwise it just frees the data structures.)
715 void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
717 struct sdm_script *sptr;
718 struct sdm_vacation *vptr;
724 "Content-type: application/x-citadel-sieve-config\n"
726 CTDLSIEVECONFIGSEPARATOR
728 CTDLSIEVECONFIGSEPARATOR
733 while (u->first_script != NULL) {
736 tsize = tlen + strlen(u->first_script->script_content) +256;
737 text = realloc(text, tsize);
738 sprintf(&text[strlen(text)], "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
739 u->first_script->script_name,
740 u->first_script->script_active,
741 u->first_script->script_content
743 sptr = u->first_script;
744 u->first_script = u->first_script->next;
745 free(sptr->script_content);
749 if (u->first_vacation != NULL) {
751 tsize = strlen(text) + 256;
752 for (vptr = u->first_vacation; vptr != NULL; vptr = vptr->next) {
753 tsize += strlen(vptr->fromaddr + 32);
755 text = realloc(text, tsize);
757 sprintf(&text[strlen(text)], "vacation|\n");
758 while (u->first_vacation != NULL) {
759 if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
760 sprintf(&text[strlen(text)], "%s|%ld\n",
761 u->first_vacation->fromaddr,
762 u->first_vacation->timestamp
765 vptr = u->first_vacation;
766 u->first_vacation = u->first_vacation->next;
769 sprintf(&text[strlen(text)], CTDLSIEVECONFIGSEPARATOR);
772 /* Save the config */
773 quickie_message("Citadel", NULL, NULL, u->config_roomname,
776 "Sieve configuration"
780 /* And delete the old one */
781 if (u->config_msgnum > 0) {
782 CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "");
789 * This is our callback registration table for libSieve.
791 sieve2_callback_t ctdl_sieve_callbacks[] = {
792 { SIEVE2_ACTION_REJECT, ctdl_reject },
793 { SIEVE2_ACTION_VACATION, ctdl_vacation },
794 { SIEVE2_ERRCALL_PARSE, ctdl_errparse },
795 { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec },
796 { SIEVE2_ACTION_FILEINTO, ctdl_fileinto },
797 { SIEVE2_ACTION_REDIRECT, ctdl_redirect },
798 { SIEVE2_ACTION_DISCARD, ctdl_discard },
799 { SIEVE2_ACTION_KEEP, ctdl_keep },
800 { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript },
801 { SIEVE2_DEBUG_TRACE, ctdl_debug },
802 { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders },
803 { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize },
804 { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope },
806 * These actions are unsupported by Citadel so we don't declare them.
808 { SIEVE2_ACTION_NOTIFY, ctdl_notify },
809 { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress },
810 { SIEVE2_MESSAGE_GETBODY, ctdl_getbody },
818 * Perform sieve processing for a single room
820 void sieve_do_room(char *roomname) {
822 struct sdm_userdata u;
823 sieve2_context_t *sieve2_context = NULL; /* Context for sieve parser */
824 int res; /* Return code from libsieve calls */
825 long orig_lastproc = 0;
827 memset(&u, 0, sizeof u);
829 /* See if the user who owns this 'mailbox' has any Sieve scripts that
832 snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM);
833 if (getroom(&CC->room, u.config_roomname) != 0) {
834 lprintf(CTDL_DEBUG, "<%s> does not exist. No processing is required.\n", u.config_roomname);
839 * Find the sieve scripts and control record and do something
841 u.config_msgnum = (-1);
842 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
843 get_sieve_config_backend, (void *)&u );
845 if (u.config_msgnum < 0) {
846 lprintf(CTDL_DEBUG, "No Sieve rules exist. No processing is required.\n");
850 lprintf(CTDL_DEBUG, "Rules found. Performing Sieve processing for <%s>\n", roomname);
852 if (getroom(&CC->room, roomname) != 0) {
853 lprintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
857 /* Initialize the Sieve parser */
859 res = sieve2_alloc(&sieve2_context);
860 if (res != SIEVE2_OK) {
861 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
865 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
866 if (res != SIEVE2_OK) {
867 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
871 /* Validate the script */
873 struct ctdl_sieve my; /* dummy ctdl_sieve struct just to pass "u" slong */
874 memset(&my, 0, sizeof my);
876 res = sieve2_validate(sieve2_context, &my);
877 if (res != SIEVE2_OK) {
878 lprintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
882 /* Do something useful */
883 u.sieve2_context = sieve2_context;
884 orig_lastproc = u.lastproc;
885 CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
891 res = sieve2_free(&sieve2_context);
892 if (res != SIEVE2_OK) {
893 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
896 /* Rewrite the config if we have to */
897 rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ;
902 * Perform sieve processing for all rooms which require it
904 void perform_sieve_processing(void) {
905 struct RoomProcList *ptr = NULL;
907 if (sieve_list != NULL) {
908 lprintf(CTDL_DEBUG, "Begin Sieve processing\n");
909 while (sieve_list != NULL) {
910 char spoolroomname[ROOMNAMELEN];
911 safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
912 begin_critical_section(S_SIEVELIST);
914 /* pop this record off the list */
916 sieve_list = sieve_list->next;
919 /* invalidate any duplicate entries to prevent double processing */
920 for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
921 if (!strcasecmp(ptr->name, spoolroomname)) {
926 end_critical_section(S_SIEVELIST);
927 if (spoolroomname[0] != 0) {
928 sieve_do_room(spoolroomname);
935 void msiv_load(struct sdm_userdata *u) {
936 char hold_rm[ROOMNAMELEN];
938 strcpy(hold_rm, CC->room.QRname); /* save current room */
940 /* Take a spin through the user's personal address book */
941 if (getroom(&CC->room, USERCONFIGROOM) == 0) {
943 u->config_msgnum = (-1);
944 strcpy(u->config_roomname, CC->room.QRname);
945 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
946 get_sieve_config_backend, (void *)u );
950 if (strcmp(CC->room.QRname, hold_rm)) {
951 getroom(&CC->room, hold_rm); /* return to saved room */
955 void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) {
956 rewrite_ctdl_sieve_config(u, yes_write_to_disk);
961 * Select the active script.
962 * (Set script_name to an empty string to disable all scripts)
964 * Returns 0 on success or nonzero for error.
966 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
968 struct sdm_script *s;
970 /* First see if the supplied value is ok */
972 if (IsEmptyStr(script_name)) {
976 for (s=u->first_script; s!=NULL; s=s->next) {
977 if (!strcasecmp(s->script_name, script_name)) {
985 /* Now set the active script */
986 for (s=u->first_script; s!=NULL; s=s->next) {
987 if (!strcasecmp(s->script_name, script_name)) {
988 s->script_active = 1;
991 s->script_active = 0;
1000 * Fetch a script by name.
1002 * Returns NULL if the named script was not found, or a pointer to the script
1003 * if it was found. NOTE: the caller does *not* own the memory returned by
1004 * this function. Copy it if you need to keep it.
1006 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
1007 struct sdm_script *s;
1009 for (s=u->first_script; s!=NULL; s=s->next) {
1010 if (!strcasecmp(s->script_name, script_name)) {
1011 if (s->script_content != NULL) {
1012 return (s->script_content);
1022 * Delete a script by name.
1024 * Returns 0 if the script was deleted.
1025 * 1 if the script was not found.
1026 * 2 if the script cannot be deleted because it is active.
1028 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
1029 struct sdm_script *s = NULL;
1030 struct sdm_script *script_to_delete = NULL;
1032 for (s=u->first_script; s!=NULL; s=s->next) {
1033 if (!strcasecmp(s->script_name, script_name)) {
1034 script_to_delete = s;
1035 if (s->script_active) {
1041 if (script_to_delete == NULL) return(1);
1043 if (u->first_script == script_to_delete) {
1044 u->first_script = u->first_script->next;
1046 else for (s=u->first_script; s!=NULL; s=s->next) {
1047 if (s->next == script_to_delete) {
1048 s->next = s->next->next;
1052 free(script_to_delete->script_content);
1053 free(script_to_delete);
1059 * Add or replace a new script.
1060 * NOTE: after this function returns, "u" owns the memory that "script_content"
1063 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
1065 struct sdm_script *s, *sptr;
1067 for (s=u->first_script; s!=NULL; s=s->next) {
1068 if (!strcasecmp(s->script_name, script_name)) {
1069 if (s->script_content != NULL) {
1070 free(s->script_content);
1072 s->script_content = script_content;
1077 if (replaced == 0) {
1078 sptr = malloc(sizeof(struct sdm_script));
1079 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
1080 sptr->script_content = script_content;
1081 sptr->script_active = 0;
1082 sptr->next = u->first_script;
1083 u->first_script = sptr;
1090 * Citadel protocol to manage sieve scripts.
1091 * This is basically a simplified (read: doesn't resemble IMAP) version
1092 * of the 'managesieve' protocol.
1094 void cmd_msiv(char *argbuf) {
1096 struct sdm_userdata u;
1097 char script_name[256];
1098 char *script_content = NULL;
1099 struct sdm_script *s;
1101 int changes_made = 0;
1103 memset(&u, 0, sizeof(struct sdm_userdata));
1105 if (CtdlAccessCheck(ac_logged_in)) return;
1106 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
1109 if (!strcasecmp(subcmd, "putscript")) {
1110 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1111 if (!IsEmptyStr(script_name)) {
1112 cprintf("%d Transmit script now\n", SEND_LISTING);
1113 script_content = CtdlReadMessageBody("000", config.c_maxmsglen, NULL, 0);
1114 msiv_putscript(&u, script_name, script_content);
1118 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1122 else if (!strcasecmp(subcmd, "listscripts")) {
1123 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
1124 for (s=u.first_script; s!=NULL; s=s->next) {
1125 if (s->script_content != NULL) {
1126 cprintf("%s|%d|\n", s->script_name, s->script_active);
1132 else if (!strcasecmp(subcmd, "setactive")) {
1133 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1134 if (msiv_setactive(&u, script_name) == 0) {
1135 cprintf("%d ok\n", CIT_OK);
1139 cprintf("%d Script '%s' does not exist.\n",
1140 ERROR + ILLEGAL_VALUE,
1146 else if (!strcasecmp(subcmd, "getscript")) {
1147 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1148 script_content = msiv_getscript(&u, script_name);
1149 if (script_content != NULL) {
1152 cprintf("%d Script:\n", LISTING_FOLLOWS);
1153 script_len = strlen(script_content);
1154 client_write(script_content, script_len);
1155 if (script_content[script_len-1] != '\n') {
1161 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1165 else if (!strcasecmp(subcmd, "deletescript")) {
1166 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1167 i = msiv_deletescript(&u, script_name);
1169 cprintf("%d ok\n", CIT_OK);
1173 cprintf("%d Script '%s' does not exist.\n",
1174 ERROR + ILLEGAL_VALUE,
1179 cprintf("%d Script '%s' is active and cannot be deleted.\n",
1180 ERROR + ILLEGAL_VALUE,
1185 cprintf("%d unknown error\n", ERROR);
1190 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
1193 msiv_store(&u, changes_made);
1198 void ctdl_sieve_init(void) {
1200 sieve2_context_t *sieve2_context = NULL;
1204 * We don't really care about dumping the entire credits to the log
1205 * every time the server is initialized. The documentation will suffice
1206 * for that purpose. We are making a call to sieve2_credits() in order
1207 * to demonstrate that we have successfully linked in to libsieve.
1209 cred = strdup(sieve2_credits());
1210 if (cred == NULL) return;
1212 if (strlen(cred) > 60) {
1213 strcpy(&cred[55], "...");
1216 lprintf(CTDL_INFO, "%s\n",cred);
1219 /* Briefly initialize a Sieve parser instance just so we can list the
1220 * extensions that are available.
1222 res = sieve2_alloc(&sieve2_context);
1223 if (res != SIEVE2_OK) {
1224 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
1228 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1229 if (res != SIEVE2_OK) {
1230 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
1234 msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1235 lprintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
1237 BAIL: res = sieve2_free(&sieve2_context);
1238 if (res != SIEVE2_OK) {
1239 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
1244 int serv_sieve_room(struct ctdlroom *room)
1246 if (!strcasecmp(&room->QRname[11], MAILROOM)) {
1247 sieve_queue_room(room);
1252 #endif /* HAVE_LIBSIEVE */
1254 CTDL_MODULE_INIT(sieve)
1257 #ifdef HAVE_LIBSIEVE
1260 CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1262 CtdlRegisterRoomHook(serv_sieve_room);
1264 CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
1266 #else /* HAVE_LIBSIEVE */
1268 lprintf(CTDL_INFO, "This server is missing libsieve. Mailbox filtering will be disabled.\n");
1270 #endif /* HAVE_LIBSIEVE */
1272 /* return our Subversion id for the Log */