2 * $Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $
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 "sysdep_decls.h"
37 #include "citserver.h"
40 #include "serv_extensions.h"
45 #include "internet_addressing.h"
50 #include "serv_sieve.h"
52 struct RoomProcList *sieve_list = NULL;
53 char *msiv_extensions = NULL;
57 * Callback function to send libSieve trace messages to Citadel log facility
58 * Set ctdl_libsieve_debug=1 to see extremely verbose libSieve trace
60 int ctdl_debug(sieve2_context_t *s, void *my)
62 static int ctdl_libsieve_debug = 0;
64 if (ctdl_libsieve_debug) {
66 lprintf(CTDL_DEBUG, "Sieve: level [%d] module [%s] file [%s] function [%s]\n",
67 sieve2_getvalue_int(s, "level"),
68 sieve2_getvalue_string(s, "module"),
69 sieve2_getvalue_string(s, "file"),
70 sieve2_getvalue_string(s, "function"));
72 lprintf(CTDL_DEBUG, "Sieve: %s\n",
73 sieve2_getvalue_string(s, "message"));
80 * Callback function to log script parsing errors
82 int ctdl_errparse(sieve2_context_t *s, void *my)
84 lprintf(CTDL_WARNING, "Error in script, line %d: %s\n",
85 sieve2_getvalue_int(s, "lineno"),
86 sieve2_getvalue_string(s, "message")
93 * Callback function to log script execution errors
95 int ctdl_errexec(sieve2_context_t *s, void *my)
97 lprintf(CTDL_WARNING, "Error executing script: %s\n",
98 sieve2_getvalue_string(s, "message")
105 * Callback function to redirect a message to a different folder
107 int ctdl_redirect(sieve2_context_t *s, void *my)
109 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
110 struct CtdlMessage *msg = NULL;
111 struct recptypes *valid = NULL;
114 safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
116 lprintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
118 valid = validate_recipients(recp);
120 lprintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
121 return SIEVE2_ERROR_BADARGS;
123 if (valid->num_error > 0) {
124 lprintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
126 return SIEVE2_ERROR_BADARGS;
129 msg = CtdlFetchMessage(cs->msgnum, 1);
131 lprintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
133 return SIEVE2_ERROR_BADARGS;
136 CtdlSubmitMsg(msg, valid, NULL);
137 cs->cancel_implicit_keep = 1;
139 CtdlFreeMessage(msg);
145 * Callback function to indicate that a message *will* be kept in the inbox
147 int ctdl_keep(sieve2_context_t *s, void *my)
149 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
151 lprintf(CTDL_DEBUG, "Action is KEEP\n");
154 cs->cancel_implicit_keep = 1;
160 * Callback function to file a message into a different mailbox
162 int ctdl_fileinto(sieve2_context_t *s, void *my)
164 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
165 const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
167 char foldername[256];
168 char original_room_name[ROOMNAMELEN];
170 lprintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
172 /* FILEINTO 'INBOX' is the same thing as KEEP */
173 if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
175 cs->cancel_implicit_keep = 1;
179 /* Remember what room we came from */
180 safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
182 /* First try a mailbox name match (check personal mail folders first) */
183 snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
184 c = getroom(&CC->room, foldername);
186 /* Then a regular room name match (public and private rooms) */
188 safestrncpy(foldername, dest_folder, sizeof foldername);
189 c = getroom(&CC->room, foldername);
193 lprintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
194 return SIEVE2_ERROR_BADARGS;
197 /* Yes, we actually have to go there */
198 usergoto(NULL, 0, 0, NULL, NULL);
200 c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL);
202 /* Go back to the room we came from */
203 if (strcasecmp(original_room_name, CC->room.QRname)) {
204 usergoto(original_room_name, 0, 0, NULL, NULL);
208 cs->cancel_implicit_keep = 1;
212 return SIEVE2_ERROR_BADARGS;
218 * Callback function to indicate that a message should be discarded.
220 int ctdl_discard(sieve2_context_t *s, void *my)
222 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
224 lprintf(CTDL_DEBUG, "Action is DISCARD\n");
226 /* Cancel the implicit keep. That's all there is to it. */
227 cs->cancel_implicit_keep = 1;
234 * Callback function to indicate that a message should be rejected
236 int ctdl_reject(sieve2_context_t *s, void *my)
238 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
239 char *reject_text = NULL;
241 lprintf(CTDL_DEBUG, "Action is REJECT\n");
243 /* If we don't know who sent the message, do a DISCARD instead. */
244 if (strlen(cs->sender) == 0) {
245 lprintf(CTDL_INFO, "Unknown sender. Doing DISCARD instead of REJECT.\n");
246 return ctdl_discard(s, my);
249 /* Assemble the reject message. */
250 reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024);
251 if (reject_text == NULL) {
252 return SIEVE2_ERROR_FAIL;
256 "Content-type: text/plain\n"
258 "The message was refused by the recipient's mail filtering program.\n"
259 "The reason given was as follows:\n"
264 sieve2_getvalue_string(s, "message")
267 quickie_message( /* This delivers the message */
268 "Citadel", /* FIXME make it myself */
273 "Delivery status notification"
277 cs->cancel_implicit_keep = 1;
284 * Callback function to indicate that a vacation message should be generated
286 int ctdl_vacation(sieve2_context_t *s, void *my)
288 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
289 struct sdm_vacation *vptr;
292 char *vacamsg_text = NULL;
294 lprintf(CTDL_DEBUG, "Action is VACATION\n");
296 message = sieve2_getvalue_string(s, "message");
297 if (message == NULL) return SIEVE2_ERROR_BADARGS;
299 days = sieve2_getvalue_int(s, "days");
300 if (days < 1) days = 1;
301 if (days > MAX_VACATION) days = MAX_VACATION;
303 /* Check to see whether we've already alerted this sender that we're on vacation. */
304 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
305 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
306 if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) {
307 lprintf(CTDL_DEBUG, "Already alerted <%s> recently.\n", cs->sender);
313 /* Assemble the reject message. */
314 vacamsg_text = malloc(strlen(message) + 1024);
315 if (vacamsg_text == NULL) {
316 return SIEVE2_ERROR_FAIL;
319 sprintf(vacamsg_text,
320 "Content-type: text/plain\n"
328 quickie_message( /* This delivers the message */
329 "Citadel", /* FIXME make it myself */
334 "Delivery status notification"
339 /* Now update the list to reflect the fact that we've alerted this sender.
340 * If they're already in the list, just update the timestamp.
342 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
343 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
344 vptr->timestamp = time(NULL);
349 /* If we get to this point, create a new record.
351 vptr = malloc(sizeof(struct sdm_vacation));
352 vptr->timestamp = time(NULL);
353 safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr);
354 vptr->next = cs->u->first_vacation;
355 cs->u->first_vacation = vptr;
362 * Callback function to parse addresses per local system convention
363 * It is disabled because we don't support subaddresses.
366 int ctdl_getsubaddress(sieve2_context_t *s, void *my)
368 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
370 /* libSieve does not take ownership of the memory used here. But, since we
371 * are just pointing to locations inside a struct which we are going to free
374 sieve2_setvalue_string(s, "user", cs->recp_user);
375 sieve2_setvalue_string(s, "detail", "");
376 sieve2_setvalue_string(s, "localpart", cs->recp_user);
377 sieve2_setvalue_string(s, "domain", cs->recp_node);
384 * Callback function to parse message envelope
386 int ctdl_getenvelope(sieve2_context_t *s, void *my)
388 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
390 lprintf(CTDL_DEBUG, "Action is GETENVELOPE\n");
391 sieve2_setvalue_string(s, "to", cs->envelope_to);
392 sieve2_setvalue_string(s, "from", cs->envelope_from);
398 * Callback function to fetch message body
399 * FIXME implement this
402 int ctdl_getbody(sieve2_context_t *s, void *my)
404 return SIEVE2_ERROR_UNSUPPORTED;
410 * Callback function to fetch message size
412 int ctdl_getsize(sieve2_context_t *s, void *my)
414 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
417 GetMetaData(&smi, cs->msgnum);
419 if (smi.meta_rfc822_length > 0L) {
420 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
424 return SIEVE2_ERROR_UNSUPPORTED;
429 * Callback function to retrieve the sieve script
431 int ctdl_getscript(sieve2_context_t *s, void *my) {
432 struct sdm_script *sptr;
433 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
435 for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) {
436 if (sptr->script_active > 0) {
437 lprintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
438 sieve2_setvalue_string(s, "script", sptr->script_content);
443 lprintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n");
444 return SIEVE2_ERROR_GETSCRIPT;
448 * Callback function to retrieve message headers
450 int ctdl_getheaders(sieve2_context_t *s, void *my) {
452 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
454 lprintf(CTDL_DEBUG, "ctdl_getheaders() was called\n");
456 sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
463 * Add a room to the list of those rooms which potentially require sieve processing
465 void sieve_queue_room(struct ctdlroom *which_room) {
466 struct RoomProcList *ptr;
468 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
469 if (ptr == NULL) return;
471 safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
472 begin_critical_section(S_SIEVELIST);
473 ptr->next = sieve_list;
475 end_critical_section(S_SIEVELIST);
481 * Perform sieve processing for one message (called by sieve_do_room() for each message)
483 void sieve_do_msg(long msgnum, void *userdata) {
484 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
485 sieve2_context_t *sieve2_context = u->sieve2_context;
486 struct ctdl_sieve my;
488 struct CtdlMessage *msg;
490 lprintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
492 msg = CtdlFetchMessage(msgnum, 0);
493 if (msg == NULL) return;
495 CC->redirect_buffer = malloc(SIZ);
496 CC->redirect_len = 0;
497 CC->redirect_alloc = SIZ;
498 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
499 my.rfc822headers = CC->redirect_buffer;
500 CC->redirect_buffer = NULL;
501 CC->redirect_len = 0;
502 CC->redirect_alloc = 0;
504 my.keep = 0; /* Set to 1 to declare an *explicit* keep */
505 my.cancel_implicit_keep = 0; /* Some actions will cancel the implicit keep */
506 my.usernum = atol(CC->room.QRname); /* Keep track of the owner of the room's namespace */
507 my.msgnum = msgnum; /* Keep track of the message number in our local store */
508 my.u = u; /* Hand off a pointer to the rest of this info */
510 /* Keep track of the recipient so we can do handling based on it later */
511 process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
513 /* Keep track of the sender so we can use it for REJECT and VACATION responses */
514 if (msg->cm_fields['F'] != NULL) {
515 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
517 else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
518 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
520 else if (msg->cm_fields['A'] != NULL) {
521 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
524 strcpy(my.sender, "");
527 /* Keep track of the subject so we can use it for VACATION responses */
528 if (msg->cm_fields['U'] != NULL) {
529 safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject);
532 strcpy(my.subject, "");
535 /* Keep track of the envelope-from address (use body-from if not found) */
536 if (msg->cm_fields['P'] != NULL) {
537 safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from);
539 else if (msg->cm_fields['F'] != NULL) {
540 safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof my.envelope_from);
543 strcpy(my.envelope_from, "");
546 /* Keep track of the envelope-to address */
547 if (msg->cm_fields['V'] != NULL) {
548 safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to);
551 strcpy(my.envelope_to, "");
556 sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
558 lprintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
559 res = sieve2_execute(sieve2_context, &my);
560 if (res != SIEVE2_OK) {
561 lprintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
564 free(my.rfc822headers);
565 my.rfc822headers = NULL;
568 * Delete the message from the inbox unless either we were told not to, or
569 * if no other action was successfully taken.
571 if ( (!my.keep) && (my.cancel_implicit_keep) ) {
572 lprintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n");
573 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "", 0);
576 lprintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
577 u->lastproc = msgnum;
585 * Given the on-disk representation of our Sieve config, load
586 * it into an in-memory data structure.
588 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
592 struct sdm_script *sptr;
593 struct sdm_vacation *vptr;
596 while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
598 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
600 extract_token(keyword, c, 0, '|', sizeof keyword);
602 if (!strcasecmp(keyword, "lastproc")) {
603 u->lastproc = extract_long(c, 1);
606 else if (!strcasecmp(keyword, "script")) {
607 sptr = malloc(sizeof(struct sdm_script));
608 extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
609 sptr->script_active = extract_int(c, 2);
610 remove_token(c, 0, '|');
611 remove_token(c, 0, '|');
612 remove_token(c, 0, '|');
613 sptr->script_content = strdup(c);
614 sptr->next = u->first_script;
615 u->first_script = sptr;
618 else if (!strcasecmp(keyword, "vacation")) {
620 if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
625 if (strncasecmp(vacrec, "vacation|", 9)) {
626 vptr = malloc(sizeof(struct sdm_vacation));
627 extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
628 vptr->timestamp = extract_long(vacrec, 1);
629 vptr->next = u->first_vacation;
630 u->first_vacation = vptr;
635 /* ignore unknown keywords */
640 * We found the Sieve configuration for this user.
641 * Now do something with it.
643 void get_sieve_config_backend(long msgnum, void *userdata) {
644 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
645 struct CtdlMessage *msg;
648 u->config_msgnum = msgnum;
649 msg = CtdlFetchMessage(msgnum, 1);
651 u->config_msgnum = (-1) ;
655 conf = msg->cm_fields['M'];
656 msg->cm_fields['M'] = NULL;
657 CtdlFreeMessage(msg);
660 parse_sieve_config(conf, u);
668 * Write our citadel sieve config back to disk
670 void rewrite_ctdl_sieve_config(struct sdm_userdata *u) {
672 struct sdm_script *sptr;
673 struct sdm_vacation *vptr;
678 "Content-type: application/x-citadel-sieve-config\n"
680 CTDLSIEVECONFIGSEPARATOR
682 CTDLSIEVECONFIGSEPARATOR
687 while (u->first_script != NULL) {
688 text = realloc(text, strlen(text) + strlen(u->first_script->script_content) + 256);
689 sprintf(&text[strlen(text)], "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
690 u->first_script->script_name,
691 u->first_script->script_active,
692 u->first_script->script_content
694 sptr = u->first_script;
695 u->first_script = u->first_script->next;
696 free(sptr->script_content);
700 if (u->first_vacation != NULL) {
702 size_t realloc_len = strlen(text) + 256;
703 for (vptr = u->first_vacation; vptr != NULL; vptr = vptr->next) {
704 realloc_len += strlen(vptr->fromaddr + 32);
706 text = realloc(text, realloc_len);
708 sprintf(&text[strlen(text)], "vacation|\n");
709 while (u->first_vacation != NULL) {
710 if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
711 sprintf(&text[strlen(text)], "%s|%ld\n",
712 u->first_vacation->fromaddr,
713 u->first_vacation->timestamp
716 vptr = u->first_vacation;
717 u->first_vacation = u->first_vacation->next;
720 sprintf(&text[strlen(text)], CTDLSIEVECONFIGSEPARATOR);
723 /* Save the config */
724 quickie_message("Citadel", NULL, u->config_roomname,
727 "Sieve configuration"
730 /* And delete the old one */
731 if (u->config_msgnum > 0) {
732 CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "", 0);
739 * This is our callback registration table for libSieve.
741 sieve2_callback_t ctdl_sieve_callbacks[] = {
742 { SIEVE2_ACTION_REJECT, ctdl_reject },
743 { SIEVE2_ACTION_VACATION, ctdl_vacation },
744 { SIEVE2_ERRCALL_PARSE, ctdl_errparse },
745 { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec },
746 { SIEVE2_ACTION_FILEINTO, ctdl_fileinto },
747 { SIEVE2_ACTION_REDIRECT, ctdl_redirect },
748 { SIEVE2_ACTION_DISCARD, ctdl_discard },
749 { SIEVE2_ACTION_KEEP, ctdl_keep },
750 { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript },
751 { SIEVE2_DEBUG_TRACE, ctdl_debug },
752 { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders },
753 { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize },
754 { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope },
756 * These actions are unsupported by Citadel so we don't declare them.
758 { SIEVE2_ACTION_NOTIFY, ctdl_notify },
759 { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress },
760 { SIEVE2_MESSAGE_GETBODY, ctdl_getbody },
768 * Perform sieve processing for a single room
770 void sieve_do_room(char *roomname) {
772 struct sdm_userdata u;
773 sieve2_context_t *sieve2_context = NULL; /* Context for sieve parser */
774 int res; /* Return code from libsieve calls */
775 long orig_lastproc = 0;
777 memset(&u, 0, sizeof u);
779 /* See if the user who owns this 'mailbox' has any Sieve scripts that
782 snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), SIEVERULES);
783 if (getroom(&CC->room, u.config_roomname) != 0) {
784 lprintf(CTDL_DEBUG, "<%s> does not exist. No processing is required.\n", u.config_roomname);
789 * Find the sieve scripts and control record and do something
791 u.config_msgnum = (-1);
792 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
793 get_sieve_config_backend, (void *)&u );
795 if (u.config_msgnum < 0) {
796 lprintf(CTDL_DEBUG, "No Sieve rules exist. No processing is required.\n");
800 lprintf(CTDL_DEBUG, "Rules found. Performing Sieve processing for <%s>\n", roomname);
802 if (getroom(&CC->room, roomname) != 0) {
803 lprintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
807 /* Initialize the Sieve parser */
809 res = sieve2_alloc(&sieve2_context);
810 if (res != SIEVE2_OK) {
811 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
815 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
816 if (res != SIEVE2_OK) {
817 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
821 /* Validate the script */
823 struct ctdl_sieve my; /* dummy ctdl_sieve struct just to pass "u" slong */
824 memset(&my, 0, sizeof my);
826 res = sieve2_validate(sieve2_context, &my);
827 if (res != SIEVE2_OK) {
828 lprintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
832 /* Do something useful */
833 u.sieve2_context = sieve2_context;
834 orig_lastproc = u.lastproc;
835 CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
841 res = sieve2_free(&sieve2_context);
842 if (res != SIEVE2_OK) {
843 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
846 /* Rewrite the config if we have to */
847 if (u.lastproc > orig_lastproc) {
848 rewrite_ctdl_sieve_config(&u);
854 * Perform sieve processing for all rooms which require it
856 void perform_sieve_processing(void) {
857 struct RoomProcList *ptr = NULL;
859 if (sieve_list != NULL) {
860 lprintf(CTDL_DEBUG, "Begin Sieve processing\n");
861 while (sieve_list != NULL) {
862 char spoolroomname[ROOMNAMELEN];
863 safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
864 begin_critical_section(S_SIEVELIST);
866 /* pop this record off the list */
868 sieve_list = sieve_list->next;
871 /* invalidate any duplicate entries to prevent double processing */
872 for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
873 if (!strcasecmp(ptr->name, spoolroomname)) {
878 end_critical_section(S_SIEVELIST);
879 if (spoolroomname[0] != 0) {
880 sieve_do_room(spoolroomname);
887 void msiv_load(struct sdm_userdata *u) {
888 char hold_rm[ROOMNAMELEN];
890 strcpy(hold_rm, CC->room.QRname); /* save current room */
892 /* Take a spin through the user's personal address book */
893 if (getroom(&CC->room, SIEVERULES) == 0) {
895 u->config_msgnum = (-1);
896 strcpy(u->config_roomname, CC->room.QRname);
897 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
898 get_sieve_config_backend, (void *)u );
902 if (strcmp(CC->room.QRname, hold_rm)) {
903 getroom(&CC->room, hold_rm); /* return to saved room */
907 void msiv_store(struct sdm_userdata *u) {
908 rewrite_ctdl_sieve_config(u);
913 * Select the active script.
914 * (Set script_name to an empty string to disable all scripts)
916 * Returns 0 on success or nonzero for error.
918 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
920 struct sdm_script *s;
922 /* First see if the supplied value is ok */
924 if (strlen(script_name) == 0) {
928 for (s=u->first_script; s!=NULL; s=s->next) {
929 if (!strcasecmp(s->script_name, script_name)) {
937 /* Now set the active script */
938 for (s=u->first_script; s!=NULL; s=s->next) {
939 if (!strcasecmp(s->script_name, script_name)) {
940 s->script_active = 1;
943 s->script_active = 0;
952 * Fetch a script by name.
954 * Returns NULL if the named script was not found, or a pointer to the script
955 * if it was found. NOTE: the caller does *not* own the memory returned by
956 * this function. Copy it if you need to keep it.
958 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
959 struct sdm_script *s;
961 for (s=u->first_script; s!=NULL; s=s->next) {
962 if (!strcasecmp(s->script_name, script_name)) {
963 if (s->script_content != NULL) {
964 return (s->script_content);
974 * Delete a script by name.
976 * Returns 0 if the script was deleted.
977 * 1 if the script was not found.
978 * 2 if the script cannot be deleted because it is active.
980 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
981 struct sdm_script *s = NULL;
982 struct sdm_script *script_to_delete = NULL;
984 for (s=u->first_script; s!=NULL; s=s->next) {
985 if (!strcasecmp(s->script_name, script_name)) {
986 script_to_delete = s;
987 if (s->script_active) {
993 if (script_to_delete == NULL) return(1);
995 if (u->first_script == script_to_delete) {
996 u->first_script = u->first_script->next;
998 else for (s=u->first_script; s!=NULL; s=s->next) {
999 if (s->next == script_to_delete) {
1000 s->next = s->next->next;
1004 free(script_to_delete->script_content);
1005 free(script_to_delete);
1011 * Add or replace a new script.
1012 * NOTE: after this function returns, "u" owns the memory that "script_content"
1015 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
1017 struct sdm_script *s, *sptr;
1019 for (s=u->first_script; s!=NULL; s=s->next) {
1020 if (!strcasecmp(s->script_name, script_name)) {
1021 if (s->script_content != NULL) {
1022 free(s->script_content);
1024 s->script_content = script_content;
1029 if (replaced == 0) {
1030 sptr = malloc(sizeof(struct sdm_script));
1031 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
1032 sptr->script_content = script_content;
1033 sptr->script_active = 0;
1034 sptr->next = u->first_script;
1035 u->first_script = sptr;
1042 * Citadel protocol to manage sieve scripts.
1043 * This is basically a simplified (read: doesn't resemble IMAP) version
1044 * of the 'managesieve' protocol.
1046 void cmd_msiv(char *argbuf) {
1048 struct sdm_userdata u;
1049 char script_name[256];
1050 char *script_content = NULL;
1051 struct sdm_script *s;
1054 memset(&u, 0, sizeof(struct sdm_userdata));
1056 if (CtdlAccessCheck(ac_logged_in)) return;
1057 extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
1060 if (!strcasecmp(subcmd, "putscript")) {
1061 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1062 if (strlen(script_name) > 0) {
1063 cprintf("%d Transmit script now\n", SEND_LISTING);
1064 script_content = CtdlReadMessageBody("000", config.c_maxmsglen, NULL, 0);
1065 msiv_putscript(&u, script_name, script_content);
1068 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1072 else if (!strcasecmp(subcmd, "listscripts")) {
1073 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
1074 for (s=u.first_script; s!=NULL; s=s->next) {
1075 if (s->script_content != NULL) {
1076 cprintf("%s|%d|\n", s->script_name, s->script_active);
1082 else if (!strcasecmp(subcmd, "setactive")) {
1083 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1084 if (msiv_setactive(&u, script_name) == 0) {
1085 cprintf("%d ok\n", CIT_OK);
1088 cprintf("%d Script '%s' does not exist.\n",
1089 ERROR + ILLEGAL_VALUE,
1095 else if (!strcasecmp(subcmd, "getscript")) {
1096 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1097 script_content = msiv_getscript(&u, script_name);
1098 if (script_content != NULL) {
1099 cprintf("%d Script:\n", SEND_LISTING);
1100 cprintf("%s000\n", script_content);
1103 cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
1107 else if (!strcasecmp(subcmd, "deletescript")) {
1108 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
1109 i = msiv_deletescript(&u, script_name);
1111 cprintf("%d ok\n", CIT_OK);
1114 cprintf("%d Script '%s' does not exist.\n",
1115 ERROR + ILLEGAL_VALUE,
1120 cprintf("%d Script '%s' is active and cannot be deleted.\n",
1121 ERROR + ILLEGAL_VALUE,
1126 cprintf("%d unknown error\n", ERROR);
1131 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
1139 void ctdl_sieve_init(void) {
1141 sieve2_context_t *sieve2_context = NULL;
1145 * We don't really care about dumping the entire credits to the log
1146 * every time the server is initialized. The documentation will suffice
1147 * for that purpose. We are making a call to sieve2_credits() in order
1148 * to demonstrate that we have successfully linked in to libsieve.
1150 cred = strdup(sieve2_credits());
1151 if (cred == NULL) return;
1153 if (strlen(cred) > 60) {
1154 strcpy(&cred[55], "...");
1157 lprintf(CTDL_INFO, "%s\n",cred);
1160 /* Briefly initialize a Sieve parser instance just so we can list the
1161 * extensions that are available.
1163 res = sieve2_alloc(&sieve2_context);
1164 if (res != SIEVE2_OK) {
1165 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
1169 res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1170 if (res != SIEVE2_OK) {
1171 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
1175 msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1176 lprintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
1178 BAIL: res = sieve2_free(&sieve2_context);
1179 if (res != SIEVE2_OK) {
1180 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
1187 char *serv_sieve_init(void)
1190 CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1191 return "$Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $";
1194 #else /* HAVE_LIBSIEVE */
1196 char *serv_sieve_init(void)
1198 lprintf(CTDL_INFO, "This server is missing libsieve. Mailbox filtering will be disabled.\n");
1199 return "$Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $";
1202 #endif /* HAVE_LIBSIEVE */