4 * Copyright (c) 1987-2020 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
23 #include <sys/types.h>
25 #if TIME_WITH_SYS_TIME
26 # include <sys/time.h>
30 # include <sys/time.h>
39 #include <libcitadel.h>
42 #include "citserver.h"
47 #include "internet_addressing.h"
48 #include "ctdl_module.h"
54 * Callback function to redirect a message to a different folder
56 int ctdl_redirect(void)
58 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
59 struct CtdlMessage *msg = NULL;
60 recptypes *valid = NULL;
63 safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
65 syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>", recp);
67 valid = validate_recipients(recp, NULL, 0);
69 syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp);
70 return SIEVE2_ERROR_BADARGS;
72 if (valid->num_error > 0) {
73 syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp);
74 free_recipients(valid);
75 return SIEVE2_ERROR_BADARGS;
78 msg = CtdlFetchMessage(cs->msgnum, 1);
80 syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld", cs->msgnum);
81 free_recipients(valid);
82 return SIEVE2_ERROR_BADARGS;
85 CtdlSubmitMsg(msg, valid, NULL, 0);
86 cs->cancel_implicit_keep = 1;
87 free_recipients(valid);
94 * Callback function to indicate that a message *will* be kept in the inbox
96 int ctdl_keep(sieve2_context_t *s, void *my)
98 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
100 syslog(LOG_DEBUG, "Action is KEEP");
103 cs->cancel_implicit_keep = 1;
109 * Callback function to file a message into a different mailbox
111 int ctdl_fileinto(sieve2_context_t *s, void *my)
113 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
114 const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
116 char foldername[256];
117 char original_room_name[ROOMNAMELEN];
119 syslog(LOG_DEBUG, "Action is FILEINTO, destination is <%s>", dest_folder);
121 /* FILEINTO 'INBOX' is the same thing as KEEP */
122 if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
124 cs->cancel_implicit_keep = 1;
128 /* Remember what room we came from */
129 safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
131 /* First try a mailbox name match (check personal mail folders first) */
132 snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
133 c = CtdlGetRoom(&CC->room, foldername);
135 /* Then a regular room name match (public and private rooms) */
137 safestrncpy(foldername, dest_folder, sizeof foldername);
138 c = CtdlGetRoom(&CC->room, foldername);
142 syslog(LOG_WARNING, "FILEINTO failed: target <%s> does not exist", dest_folder);
143 return SIEVE2_ERROR_BADARGS;
146 /* Yes, we actually have to go there */
147 CtdlUserGoto(NULL, 0, 0, NULL, NULL, NULL, NULL);
149 c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL, 0);
151 /* Go back to the room we came from */
152 if (strcasecmp(original_room_name, CC->room.QRname)) {
153 CtdlUserGoto(original_room_name, 0, 0, NULL, NULL, NULL, NULL);
157 cs->cancel_implicit_keep = 1;
161 return SIEVE2_ERROR_BADARGS;
167 * Callback function to indicate that a message should be discarded.
169 int ctdl_discard(sieve2_context_t *s, void *my)
171 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
173 syslog(LOG_DEBUG, "Action is DISCARD");
175 /* Cancel the implicit keep. That's all there is to it. */
176 cs->cancel_implicit_keep = 1;
182 * Callback function to indicate that a message should be rejected
184 int ctdl_reject(sieve2_context_t *s, void *my)
186 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
187 char *reject_text = NULL;
189 syslog(LOG_DEBUG, "Action is REJECT");
191 /* If we don't know who sent the message, do a DISCARD instead. */
192 if (IsEmptyStr(cs->sender)) {
193 syslog(LOG_INFO, "Unknown sender. Doing DISCARD instead of REJECT.");
194 return ctdl_discard(s, my);
197 /* Assemble the reject message. */
198 reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024);
199 if (reject_text == NULL) {
200 return SIEVE2_ERROR_FAIL;
204 "Content-type: text/plain\n"
206 "The message was refused by the recipient's mail filtering program.\n"
207 "The reason given was as follows:\n"
212 sieve2_getvalue_string(s, "message")
215 quickie_message( /* This delivers the message */
222 "Delivery status notification"
226 cs->cancel_implicit_keep = 1;
232 * Callback function to indicate that a vacation message should be generated
234 int ctdl_vacation(sieve2_context_t *s, void *my)
236 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
237 struct sdm_vacation *vptr;
240 char *vacamsg_text = NULL;
241 char vacamsg_subject[1024];
243 syslog(LOG_DEBUG, "Action is VACATION");
245 message = sieve2_getvalue_string(s, "message");
246 if (message == NULL) return SIEVE2_ERROR_BADARGS;
248 if (sieve2_getvalue_string(s, "subject") != NULL) {
249 safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject);
252 snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject);
255 days = sieve2_getvalue_int(s, "days");
256 if (days < 1) days = 1;
257 if (days > MAX_VACATION) days = MAX_VACATION;
259 /* Check to see whether we've already alerted this sender that we're on vacation. */
260 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
261 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
262 if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) {
263 syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender);
269 /* Assemble the reject message. */
270 vacamsg_text = malloc(strlen(message) + 1024);
271 if (vacamsg_text == NULL) {
272 return SIEVE2_ERROR_FAIL;
275 sprintf(vacamsg_text,
276 "Content-type: text/plain charset=utf-8\n"
284 quickie_message( /* This delivers the message */
296 /* Now update the list to reflect the fact that we've alerted this sender.
297 * If they're already in the list, just update the timestamp.
299 for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
300 if (!strcasecmp(vptr->fromaddr, cs->sender)) {
301 vptr->timestamp = time(NULL);
306 /* If we get to this point, create a new record.
308 vptr = malloc(sizeof(struct sdm_vacation));
309 memset(vptr, 0, sizeof(struct sdm_vacation));
310 vptr->timestamp = time(NULL);
311 safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr);
312 vptr->next = cs->u->first_vacation;
313 cs->u->first_vacation = vptr;
320 * Callback function to parse message envelope
322 int ctdl_getenvelope(sieve2_context_t *s, void *my)
324 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
326 syslog(LOG_DEBUG, "Action is GETENVELOPE");
327 syslog(LOG_DEBUG, "EnvFrom: %s", cs->envelope_from);
328 syslog(LOG_DEBUG, "EnvTo: %s", cs->envelope_to);
330 if (cs->envelope_from != NULL) {
331 if ((cs->envelope_from[0] != '@')&&(cs->envelope_from[strlen(cs->envelope_from)-1] != '@')) {
332 sieve2_setvalue_string(s, "from", cs->envelope_from);
335 sieve2_setvalue_string(s, "from", "invalid_envelope_from@example.org");
339 sieve2_setvalue_string(s, "from", "null_envelope_from@example.org");
343 if (cs->envelope_to != NULL) {
344 if ((cs->envelope_to[0] != '@') && (cs->envelope_to[strlen(cs->envelope_to)-1] != '@')) {
345 sieve2_setvalue_string(s, "to", cs->envelope_to);
348 sieve2_setvalue_string(s, "to", "invalid_envelope_to@example.org");
352 sieve2_setvalue_string(s, "to", "null_envelope_to@example.org");
361 * Callback function to fetch message size
363 int ctdl_getsize(sieve2_context_t *s, void *my)
365 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
368 GetMetaData(&smi, cs->msgnum);
370 if (smi.meta_rfc822_length > 0L) {
371 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
375 return SIEVE2_ERROR_UNSUPPORTED;
380 * Return a pointer to the active Sieve script.
381 * (Caller does NOT own the memory and should not free the returned pointer.)
383 char *get_active_script(struct sdm_userdata *u) {
384 struct sdm_script *sptr;
386 for (sptr=u->first_script; sptr!=NULL; sptr=sptr->next) {
387 if (sptr->script_active > 0) {
388 syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name);
389 return(sptr->script_content);
393 syslog(LOG_DEBUG, "get_active_script() found no active script");
399 * Callback function to retrieve the sieve script
401 int ctdl_getscript(sieve2_context_t *s, void *my) {
402 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
404 char *active_script = get_active_script(cs->u);
405 if (active_script != NULL) {
406 sieve2_setvalue_string(s, "script", active_script);
410 return SIEVE2_ERROR_GETSCRIPT;
415 * Callback function to retrieve message headers
417 int ctdl_getheaders(sieve2_context_t *s, void *my) {
419 struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
421 syslog(LOG_DEBUG, "ctdl_getheaders() was called");
422 sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
428 * Perform sieve processing for one message (called by sieve_do_room() for each message)
430 void inbox_do_msg(long msgnum, void *userdata) {
431 struct sdm_userdata *u = (struct sdm_userdata *) userdata;
432 sieve2_context_t *sieve2_context;
433 struct ctdl_sieve my;
435 struct CtdlMessage *msg;
437 size_t headers_len = 0;
441 syslog(LOG_ERR, "Can't process message <%ld> without userdata!", msgnum);
445 sieve2_context = u->sieve2_context;
447 syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum);
450 * Make sure you include message body so you can get those second-level headers ;)
452 msg = CtdlFetchMessage(msgnum, 1);
453 if (msg == NULL) return;
456 * Grab the message headers so we can feed them to libSieve.
457 * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers.
459 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
460 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0);
461 headers_len = StrLength(CC->redirect_buffer);
462 my.rfc822headers = SmashStrBuf(&CC->redirect_buffer);
465 * libSieve clobbers the stack if it encounters badly formed
466 * headers. Sanitize our headers by stripping nonprintable
469 for (i=0; i<headers_len; ++i) {
470 if (!isascii(my.rfc822headers[i])) {
471 my.rfc822headers[i] = '_';
475 my.keep = 0; /* Set to 1 to declare an *explicit* keep */
476 my.cancel_implicit_keep = 0; /* Some actions will cancel the implicit keep */
477 my.usernum = atol(CC->room.QRname); /* Keep track of the owner of the room's namespace */
478 my.msgnum = msgnum; /* Keep track of the message number in our local store */
479 my.u = u; /* Hand off a pointer to the rest of this info */
481 /* Keep track of the recipient so we can do handling based on it later */
482 process_rfc822_addr(msg->cm_fields[eRecipient], my.recp_user, my.recp_node, my.recp_name);
484 /* Keep track of the sender so we can use it for REJECT and VACATION responses */
485 if (!CM_IsEmpty(msg, erFc822Addr)) {
486 safestrncpy(my.sender, msg->cm_fields[erFc822Addr], sizeof my.sender);
488 else if (!CM_IsEmpty(msg, eAuthor)) {
489 safestrncpy(my.sender, msg->cm_fields[eAuthor], sizeof my.sender);
492 strcpy(my.sender, "");
495 /* Keep track of the subject so we can use it for VACATION responses */
496 if (!CM_IsEmpty(msg, eMsgSubject)) {
497 safestrncpy(my.subject, msg->cm_fields[eMsgSubject], sizeof my.subject);
500 strcpy(my.subject, "");
503 /* Keep track of the envelope-from address (use body-from if not found) */
504 if (!CM_IsEmpty(msg, eMessagePath)) {
505 safestrncpy(my.envelope_from, msg->cm_fields[eMessagePath], sizeof my.envelope_from);
506 stripallbut(my.envelope_from, '<', '>');
508 else if (!CM_IsEmpty(msg, erFc822Addr)) {
509 safestrncpy(my.envelope_from, msg->cm_fields[erFc822Addr], sizeof my.envelope_from);
510 stripallbut(my.envelope_from, '<', '>');
513 strcpy(my.envelope_from, "");
516 len = strlen(my.envelope_from);
517 for (i=0; i<len; ++i) {
518 if (isspace(my.envelope_from[i])) my.envelope_from[i] = '_';
520 if (haschar(my.envelope_from, '@') == 0) {
521 strcat(my.envelope_from, "@");
522 strcat(my.envelope_from, CtdlGetConfigStr("c_fqdn"));
525 /* Keep track of the envelope-to address (use body-to if not found) */
526 if (!CM_IsEmpty(msg, eenVelopeTo)) {
527 safestrncpy(my.envelope_to, msg->cm_fields[eenVelopeTo], sizeof my.envelope_to);
528 stripallbut(my.envelope_to, '<', '>');
530 else if (!CM_IsEmpty(msg, eRecipient)) {
531 safestrncpy(my.envelope_to, msg->cm_fields[eRecipient], sizeof my.envelope_to);
532 stripallbut(my.envelope_to, '<', '>');
535 strcpy(my.envelope_to, "");
538 len = strlen(my.envelope_to);
539 for (i=0; i<len; ++i) {
540 if (isspace(my.envelope_to[i])) my.envelope_to[i] = '_';
542 if (haschar(my.envelope_to, '@') == 0) {
543 strcat(my.envelope_to, "@");
544 strcat(my.envelope_to, CtdlGetConfigStr("c_fqdn"));
549 syslog(LOG_DEBUG, "Calling sieve2_execute()");
550 res = sieve2_execute(sieve2_context, &my);
551 if (res != SIEVE2_OK) {
552 syslog(LOG_ERR, "sieve2_execute() returned %d: %s", res, sieve2_errstr(res));
555 free(my.rfc822headers);
556 my.rfc822headers = NULL;
559 * Delete the message from the inbox unless either we were told not to, or
560 * if no other action was successfully taken.
562 if ( (!my.keep) && (my.cancel_implicit_keep) ) {
563 syslog(LOG_DEBUG, "keep is 0 -- deleting message from inbox");
564 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
567 syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum);
568 u->lastproc = msgnum;
576 * Given the on-disk representation of our Sieve config, load
577 * it into an in-memory data structure.
579 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
583 struct sdm_script *sptr;
584 struct sdm_vacation *vptr;
587 while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
589 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
591 extract_token(keyword, c, 0, '|', sizeof keyword);
593 if (!strcasecmp(keyword, "lastproc")) {
594 u->lastproc = extract_long(c, 1);
597 else if (!strcasecmp(keyword, "script")) {
598 sptr = malloc(sizeof(struct sdm_script));
599 extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
600 sptr->script_active = extract_int(c, 2);
601 remove_token(c, 0, '|');
602 remove_token(c, 0, '|');
603 remove_token(c, 0, '|');
604 sptr->script_content = strdup(c);
605 sptr->next = u->first_script;
606 u->first_script = sptr;
609 else if (!strcasecmp(keyword, "vacation")) {
611 if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) {
616 if (strncasecmp(vacrec, "vacation|", 9)) {
617 vptr = malloc(sizeof(struct sdm_vacation));
618 extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr);
619 vptr->timestamp = extract_long(vacrec, 1);
620 vptr->next = u->first_vacation;
621 u->first_vacation = vptr;
626 /* ignore unknown keywords */
635 * Write our citadel sieve config back to disk
637 * (Set yes_write_to_disk to nonzero to make it actually write the config;
638 * otherwise it just frees the data structures.)
640 void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
642 struct sdm_script *sptr;
643 struct sdm_vacation *vptr;
645 text = NewStrBufPlain(NULL, SIZ);
647 "Content-type: application/x-citadel-sieve-config\n"
649 CTDLSIEVECONFIGSEPARATOR
651 CTDLSIEVECONFIGSEPARATOR
656 while (u->first_script != NULL) {
657 StrBufAppendPrintf(text,
658 "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
659 u->first_script->script_name,
660 u->first_script->script_active,
661 u->first_script->script_content
663 sptr = u->first_script;
664 u->first_script = u->first_script->next;
665 free(sptr->script_content);
669 if (u->first_vacation != NULL) {
671 StrBufAppendPrintf(text, "vacation|\n");
672 while (u->first_vacation != NULL) {
673 if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
674 StrBufAppendPrintf(text, "%s|%ld\n",
675 u->first_vacation->fromaddr,
676 u->first_vacation->timestamp
679 vptr = u->first_vacation;
680 u->first_vacation = u->first_vacation->next;
683 StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR);
686 if (yes_write_to_disk)
688 /* Save the config */
689 quickie_message("Citadel", NULL, NULL, u->config_roomname,
692 "Sieve configuration"
695 /* And delete the old one */
696 if (u->config_msgnum > 0) {
697 CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "");
707 * This is our callback registration table for libSieve.
709 sieve2_callback_t ctdl_sieve_callbacks[] = {
710 { SIEVE2_ACTION_REJECT, ctdl_reject },
711 { SIEVE2_ACTION_VACATION, ctdl_vacation },
712 { SIEVE2_ERRCALL_PARSE, ctdl_errparse },
713 { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec },
714 { SIEVE2_ACTION_FILEINTO, ctdl_fileinto },
715 { SIEVE2_ACTION_REDIRECT, ctdl_redirect },
716 { SIEVE2_ACTION_DISCARD, ctdl_discard },
717 { SIEVE2_ACTION_KEEP, ctdl_keep },
718 { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript },
719 { SIEVE2_DEBUG_TRACE, ctdl_debug },
720 { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders },
721 { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize },
722 { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope },
740 * The next sections are enums and keys that drive the serialize/deserialize functions for the inbox rules/state configuration.
743 // Fields to be compared
761 char *field_keys[] = {
779 // Field comparison operators
788 char *fcomp_keys[] = {
806 char *action_keys[] = {
815 // Size comparison operators
820 char *scomp_keys[] = {
830 char *final_keys[] = {
835 // This data structure represents ONE inbox rule within the configuration.
838 int field_compare_op;
839 char compared_value[128];
843 char file_into[ROOMNAMELEN];
844 char redirect_to[1024];
845 char autoreply_message[SIZ];
849 // This data structure represents the entire inbox rules configuration AND current state for a single user.
857 // Destructor for 'struct inboxrules'
858 void free_inbox_rules(struct inboxrules *ibr) {
864 // Constructor for 'struct inboxrules' that deserializes the configuration from text input.
865 struct inboxrules *deserialize_inbox_rules(char *serialized_rules) {
868 if (!serialized_rules) {
872 /* Make a copy of the supplied buffer because we're going to shit all over it with strtok_r() */
873 char *sr = strdup(serialized_rules);
878 struct inboxrules *ibr = malloc(sizeof(struct inboxrules));
882 memset(ibr, 0, sizeof(struct inboxrules));
886 while ((token = strtok_r(rest, "\n", &rest))) {
888 // For backwards compatibility, "# WEBCIT_RULE" is an alias for "rule".
889 // Prior to version 930, WebCit converted its rules to Sieve scripts, but saved the rules as comments for later re-editing.
890 // Now, the rules hidden in the comments become the real rules.
891 if (!strncasecmp(token, "# WEBCIT_RULE|", 14)) {
892 strcpy(token, "rule|");
893 strcpy(&token[5], &token[14]);
896 // Lines containing actual rules are double-serialized with Base64. It seemed like a good idea at the time :(
897 if (!strncasecmp(token, "rule|", 5)) {
898 remove_token(&token[5], 0, '|');
899 char *decoded_rule = malloc(strlen(token));
900 CtdlDecodeBase64(decoded_rule, &token[5], strlen(&token[5]));
902 ibr->rules = realloc(ibr->rules, (sizeof(struct irule) * ibr->num_rules));
903 struct irule *new_rule = &ibr->rules[ibr->num_rules - 1];
904 memset(new_rule, 0, sizeof(struct irule));
906 // We have a rule , now parse it
908 int nt = num_tokens(decoded_rule, '|');
909 for (int t=0; t<nt; ++t) {
910 extract_token(rtoken, decoded_rule, t, '|', sizeof(rtoken));
913 case 1: // field to compare
914 for (i=0; i<=field_all; ++i) {
915 if (!strcasecmp(rtoken, field_keys[i])) {
916 new_rule->compared_field = i;
920 case 2: // field comparison operation
921 for (i=0; i<=fcomp_notmatches; ++i) {
922 if (!strcasecmp(rtoken, fcomp_keys[i])) {
923 new_rule->field_compare_op = i;
927 case 3: // field comparison value
928 safestrncpy(new_rule->compared_value, rtoken, sizeof(new_rule->compared_value));
930 case 4: // size comparison operation
931 for (i=0; i<=scomp_smaller; ++i) {
932 if (!strcasecmp(rtoken, scomp_keys[i])) {
933 new_rule->size_compare_op = i;
937 case 5: // size comparison value
938 new_rule->compared_size = atol(rtoken);
941 for (i=0; i<=action_vacation; ++i) {
942 if (!strcasecmp(rtoken, action_keys[i])) {
943 new_rule->action = i;
947 case 7: // file into (target room)
948 safestrncpy(new_rule->file_into, rtoken, sizeof(new_rule->file_into));
950 case 8: // redirect to (target address)
951 safestrncpy(new_rule->redirect_to, rtoken, sizeof(new_rule->redirect_to));
953 case 9: // autoreply message
954 safestrncpy(new_rule->autoreply_message, rtoken, sizeof(new_rule->autoreply_message));
956 case 10: // final_action;
957 for (i=0; i<=final_stop; ++i) {
958 if (!strcasecmp(rtoken, final_keys[i])) {
959 new_rule->final_action = i;
969 // if we re-serialized this now, what would it look like?
970 syslog(LOG_DEBUG, "test reserialize: 0|%s|%s|%s|%s|%ld|%s|%s|%s|%s|%s",
971 field_keys[new_rule->compared_field],
972 fcomp_keys[new_rule->field_compare_op],
973 new_rule->compared_value,
974 scomp_keys[new_rule->size_compare_op],
975 new_rule->compared_size,
976 action_keys[new_rule->action],
978 new_rule->redirect_to,
979 new_rule->autoreply_message,
980 final_keys[new_rule->final_action]
982 // delete the above after moving it to a reserialize function
986 // "lastproc" indicates the newest message number in the inbox that was previously processed by our inbox rules.
987 else if (!strncasecmp(token, "lastproc|", 5)) {
988 ibr->lastproc = atol(&token[9]);
993 free(sr); // free our copy of the source buffer that has now been trashed with null bytes...
994 return(ibr); // and return our complex data type to the caller.
999 * Process a single message. We know the room, the user, the rules, the message number, etc.
1001 void inbox_do_msg(long msgnum, void *userdata) {
1002 struct inboxrules *ii = (struct inboxrules *) userdata;
1003 struct CtdlMessage *msg = NULL;
1004 int headers_loaded = 0;
1005 int body_loaded = 0;
1006 int metadata_loaded = 0;
1007 int rule_activated = 0; // On each rule, this is set if the compare succeeds and the rule activates.
1008 char compare_me[SIZ]; // On each rule, we will store the field to be compared here.
1011 syslog(LOG_DEBUG, "inboxrules: processing message #%ld which is higher than %ld, we are in %s", msgnum, ii->lastproc, CC->room.QRname);
1013 if (ii->num_rules <= 0) {
1014 syslog(LOG_DEBUG, "inboxrules: rule set is empty");
1018 for (i=0; i<ii->num_rules; ++i) {
1019 syslog(LOG_DEBUG, "inboxrules: processing rule %d is %s", i, field_keys[ ii->rules[i].compared_field ]);
1022 // Before doing a field compare, check to see if we have the correct parts of the message in memory.
1024 switch(ii->rules[i].compared_field) {
1025 // These fields require loading only the top-level headers
1026 case field_from: // From:
1027 case field_tocc: // To: or Cc:
1028 case field_subject: // Subject:
1029 case field_replyto: // Reply-to:
1030 case field_listid: // List-ID:
1031 case field_envto: // Envelope-to:
1032 case field_envfrom: // Return-path:
1033 if (!headers_loaded) {
1034 syslog(LOG_DEBUG, "inboxrules: loading headers for message %ld", msgnum);
1035 msg = CtdlFetchMessage(msgnum, 0);
1042 // These fields are not stored as Citadel headers, and therefore require a full message load.
1044 case field_resentfrom:
1045 case field_resentto:
1047 case field_xspamflag:
1048 case field_xspamstatus:
1050 syslog(LOG_DEBUG, "inboxrules: loading all of message %ld", msgnum);
1054 msg = CtdlFetchMessage(msgnum, 1);
1063 if (!metadata_loaded) {
1064 syslog(LOG_DEBUG, "inboxrules: loading metadata for message %ld", msgnum);
1066 metadata_loaded = 1;
1070 syslog(LOG_DEBUG, "this is an always-on rule");
1073 syslog(LOG_DEBUG, "inboxrules: unknown rule key");
1076 // If the rule involves a field comparison, load the field to be compared.
1078 switch(ii->rules[i].compared_field) {
1080 case field_from: // From:
1082 // FIXME we actually need the rfc822 address
1083 syslog(LOG_DEBUG, "eAuthor is <%s>", msg->cm_fields[eAuthor]);
1085 safestrncpy(compare_me, msg->cm_fields[eAuthor], sizeof compare_me);
1087 case field_tocc: // To: or Cc:
1088 if (!IsEmptyStr(msg->cm_fields[eRecipient])) {
1089 safestrncpy(compare_me, msg->cm_fields[eRecipient], sizeof compare_me);
1091 if (!IsEmptyStr(msg->cm_fields[eCarbonCopY])) {
1092 if (!IsEmptyStr(compare_me)) {
1093 strcat(compare_me, ",");
1095 safestrncpy(&compare_me[strlen(compare_me)], msg->cm_fields[eCarbonCopY], (sizeof compare_me - strlen(compare_me)));
1098 case field_subject: // Subject:
1099 safestrncpy(compare_me, msg->cm_fields[eMsgSubject], sizeof compare_me);
1101 case field_replyto: // Reply-to:
1102 safestrncpy(compare_me, msg->cm_fields[eReplyTo], sizeof compare_me);
1104 case field_listid: // List-ID:
1105 safestrncpy(compare_me, msg->cm_fields[eListID], sizeof compare_me);
1107 case field_envto: // Envelope-to:
1108 safestrncpy(compare_me, msg->cm_fields[eenVelopeTo], sizeof compare_me);
1110 case field_envfrom: // Return-path:
1111 safestrncpy(compare_me, msg->cm_fields[eMessagePath], sizeof compare_me);
1115 case field_resentfrom:
1116 case field_resentto:
1118 case field_xspamflag:
1119 case field_xspamstatus:
1125 // Message data to compare is loaded, now do something.
1126 switch(ii->rules[i].compared_field) {
1127 case field_from: // From:
1128 case field_tocc: // To: or Cc:
1129 case field_subject: // Subject:
1130 case field_replyto: // Reply-to:
1131 case field_listid: // List-ID:
1132 case field_envto: // Envelope-to:
1133 case field_envfrom: // Return-path:
1135 case field_resentfrom:
1136 case field_resentto:
1138 case field_xspamflag:
1139 case field_xspamstatus:
1141 // For all of the above fields, we can compare the field we've loaded into the buffer.
1142 // FIXME you are here YOU ARE HERE
1143 syslog(LOG_DEBUG, "Value of field to compare is: <%s>", compare_me);
1144 switch(ii->rules[i].field_compare_op) {
1145 case fcomp_contains:
1147 rule_activated = (bmstrcasestr(compare_me, ii->rules[i].compared_value) ? 1 : 0);
1149 case fcomp_notcontains:
1150 case fcomp_notmatches:
1151 rule_activated = (bmstrcasestr(compare_me, ii->rules[i].compared_value) ? 0 : 1);
1154 rule_activated = (strcasecmp(compare_me, ii->rules[i].compared_value) ? 0 : 1);
1157 rule_activated = (strcasecmp(compare_me, ii->rules[i].compared_value) ? 1 : 0);
1162 rule_activated = 0; // FIXME
1164 case field_all: // This rule always triggers
1172 if (rule_activated) {
1173 syslog(LOG_DEBUG, "rule activated");
1176 syslog(LOG_DEBUG, "rule NOT activated");
1188 //int field_compare_op;
1189 //int compared_field;
1190 //char compared_value[128];
1191 //int size_compare_op;
1192 //long compared_size;
1194 //char file_into[ROOMNAMELEN];
1195 //char redirect_to[1024];
1196 //char autoreply_message[SIZ];
1200 //struct inboxrules {
1203 //struct irule *rules;
1206 // Fetch the message, including the body, we need all of it to run our rules.
1207 //msg = CtdlFetchMessage(msgnum, 0);
1214 * A user account is identified as requring inbox processing.
1217 void do_inbox_processing_for_user(long usernum) {
1218 struct CtdlMessage *msg;
1219 struct inboxrules *ii;
1220 char roomname[ROOMNAMELEN];
1222 if (CtdlGetUserByNumber(&CC->user, usernum) == 0) {
1223 if (CC->user.msgnum_inboxrules <= 0) {
1224 return; // this user has no inbox rules
1227 msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1);
1229 return; // config msgnum is set but that message does not exist
1232 ii = deserialize_inbox_rules(msg->cm_fields[eMesageText]);
1236 return; // config message exists but body is null
1240 syslog(LOG_DEBUG, "inboxrules: for %s", CC->user.fullname);
1242 // do something now FIXME actually write this
1244 snprintf(roomname, sizeof roomname, "%010ld.%s", usernum, MAILROOM);
1245 if (CtdlGetRoom(&CC->room, roomname) == 0) {
1246 syslog(LOG_DEBUG, "GOT DA ROOM! WE R000000000L!");
1248 /* Do something useful */
1249 CtdlForEachMessage(MSGS_GT, ii->lastproc, NULL, NULL, NULL, inbox_do_msg, (void *) ii);
1253 // FIXME reserialize our inbox rules/state and write changes back to the config room
1254 free_inbox_rules(ii);
1260 * Here is an array of users (by number) who have received messages in their inbox and may require processing.
1262 long *users_requiring_inbox_processing = NULL;
1264 int num_urip_alloc = 0;
1268 * Perform inbox processing for all rooms which require it
1270 void perform_inbox_processing(void) {
1271 if (num_urip == 0) {
1272 return; // no action required
1275 for (int i=0; i<num_urip; ++i) {
1276 do_inbox_processing_for_user(users_requiring_inbox_processing[i]);
1279 free(users_requiring_inbox_processing);
1280 users_requiring_inbox_processing = NULL;
1287 * This function is called after a message is saved to a room.
1288 * If it's someone's inbox, we have to check for inbox rules
1290 int serv_inboxrules_roomhook(struct ctdlroom *room) {
1292 // Is this someone's inbox?
1293 if (!strcasecmp(&room->QRname[11], MAILROOM)) {
1294 long usernum = atol(room->QRname);
1297 // first check to see if this user is already on the list
1299 for (int i=0; i<=num_urip; ++i) {
1300 if (users_requiring_inbox_processing[i] == usernum) { // already on the list!
1306 // make room if we need to
1307 if (num_urip_alloc == 0) {
1308 num_urip_alloc = 100;
1309 users_requiring_inbox_processing = malloc(sizeof(long) * num_urip_alloc);
1311 else if (num_urip >= num_urip_alloc) {
1312 num_urip_alloc += 100;
1313 users_requiring_inbox_processing = realloc(users_requiring_inbox_processing, (sizeof(long) * num_urip_alloc));
1316 // now add the user to the list
1317 users_requiring_inbox_processing[num_urip++] = usernum;
1321 // No errors are possible from this function.
1330 * This is a client-facing function which fetches the user's inbox rules -- it omits all lines containing anything other than a rule.
1332 * hmmmmm ... should we try to rebuild this in terms of deserialize_inbox_rules() instread?
1334 void cmd_gibr(char *argbuf) {
1336 if (CtdlAccessCheck(ac_logged_in)) return;
1338 cprintf("%d inbox rules for %s\n", LISTING_FOLLOWS, CC->user.fullname);
1340 struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1);
1342 if (!CM_IsEmpty(msg, eMesageText)) {
1344 char *rest = msg->cm_fields[eMesageText];
1345 while ((token = strtok_r(rest, "\n", &rest))) {
1347 // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule"
1348 if (!strncasecmp(token, "# WEBCIT_RULE|", 14)) {
1349 strcpy(token, "rule|");
1350 strcpy(&token[5], &token[14]);
1353 // Output only lines containing rules.
1354 if (!strncasecmp(token, "rule|", 5)) {
1355 cprintf("%s\n", token);
1368 * User transmits the new inbox rules for the account. They are inserted into the account, replacing the ones already there.
1370 void cmd_pibr(char *argbuf) {
1371 if (CtdlAccessCheck(ac_logged_in)) return;
1374 cprintf("%d send new rules\n", SEND_LISTING);
1375 char *newrules = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
1376 StrBuf *NewConfig = NewStrBufPlain("Content-type: application/x-citadel-sieve-config; charset=UTF-8\nContent-transfer-encoding: 8bit\n\n", -1);
1379 char *rest = newrules;
1380 while ((token = strtok_r(rest, "\n", &rest))) {
1381 // Accept only lines containing rules
1382 if (!strncasecmp(token, "rule|", 5)) {
1383 StrBufAppendBufPlain(NewConfig, token, -1, 0);
1384 StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0);
1389 // Fetch the existing config so we can merge in anything that is NOT a rule
1390 // (Does not start with "rule|" but has at least one vertical bar)
1391 struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1);
1393 if (!CM_IsEmpty(msg, eMesageText)) {
1394 rest = msg->cm_fields[eMesageText];
1395 while ((token = strtok_r(rest, "\n", &rest))) {
1396 // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule"
1397 if ((strncasecmp(token, "# WEBCIT_RULE|", 14)) && (strncasecmp(token, "rule|", 5)) && (haschar(token, '|'))) {
1398 StrBufAppendBufPlain(NewConfig, token, -1, 0);
1399 StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0);
1406 /* we have composed the new configuration , now save it */
1407 long old_msgnum = CC->user.msgnum_inboxrules;
1408 char userconfigroomname[ROOMNAMELEN];
1409 CtdlMailboxName(userconfigroomname, sizeof userconfigroomname, &CC->user, USERCONFIGROOM);
1410 long new_msgnum = quickie_message("Citadel", NULL, NULL, userconfigroomname, ChrPtr(NewConfig), FMT_RFC822, "inbox rules configuration");
1411 FreeStrBuf(&NewConfig);
1412 CtdlGetUserLock(&CC->user, CC->curr_user);
1413 CC->user.msgnum_inboxrules = new_msgnum;
1414 CtdlPutUserLock(&CC->user);
1415 if (old_msgnum > 0) {
1416 syslog(LOG_DEBUG, "Deleting old message %ld from %s", old_msgnum, userconfigroomname);
1417 CtdlDeleteMessages(userconfigroomname, &old_msgnum, 1, "");
1422 CTDL_MODULE_INIT(sieve)
1426 CtdlRegisterProtoHook(cmd_gibr, "GIBR", "Get InBox Rules");
1427 CtdlRegisterProtoHook(cmd_pibr, "PIBR", "Put InBox Rules");
1428 CtdlRegisterRoomHook(serv_inboxrules_roomhook);
1429 CtdlRegisterSessionHook(perform_inbox_processing, EVT_HOUSE, PRIO_HOUSE + 10);
1432 /* return our module name for the log */
1433 return "inboxrules";