From: Art Cancro Date: Thu, 16 Jul 2020 21:12:17 +0000 (-0400) Subject: module 'sieve' is renamed to 'inboxrules' X-Git-Tag: v939~244 X-Git-Url: https://code.citadel.org/?p=citadel.git;a=commitdiff_plain;h=3101d92471592f0f1ffaf19fcd7f779b02057ef7 module 'sieve' is renamed to 'inboxrules' --- diff --git a/citadel/modules/inboxrules/.gitignore b/citadel/modules/inboxrules/.gitignore new file mode 100644 index 000000000..5761abcfd --- /dev/null +++ b/citadel/modules/inboxrules/.gitignore @@ -0,0 +1 @@ +*.o diff --git a/citadel/modules/inboxrules/serv_inboxrules.c b/citadel/modules/inboxrules/serv_inboxrules.c new file mode 100644 index 000000000..30feea856 --- /dev/null +++ b/citadel/modules/inboxrules/serv_inboxrules.c @@ -0,0 +1,958 @@ +/* + * Inbox handling rules + * + * Copyright (c) 1987-2020 by the citadel.org team + * + * This program is open source software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ + +#include "sysdep.h" +#include +#include +#include +#include +#include +#include +#include +#include + +#if TIME_WITH_SYS_TIME +# include +# include +#else +# if HAVE_SYS_TIME_H +# include +# else +# include +# endif +#endif + +#include +#include +#include +#include +#include "citadel.h" +#include "server.h" +#include "citserver.h" +#include "support.h" +#include "config.h" +#include "database.h" +#include "msgbase.h" +#include "internet_addressing.h" +#include "ctdl_module.h" + + +#if 0 + +/* + * Callback function to redirect a message to a different folder + */ +int ctdl_redirect(void) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + struct CtdlMessage *msg = NULL; + recptypes *valid = NULL; + char recp[256]; + + safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp); + + syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>", recp); + + valid = validate_recipients(recp, NULL, 0); + if (valid == NULL) { + syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); + return SIEVE2_ERROR_BADARGS; + } + if (valid->num_error > 0) { + syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); + free_recipients(valid); + return SIEVE2_ERROR_BADARGS; + } + + msg = CtdlFetchMessage(cs->msgnum, 1, 1); + if (msg == NULL) { + syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld", cs->msgnum); + free_recipients(valid); + return SIEVE2_ERROR_BADARGS; + } + + CtdlSubmitMsg(msg, valid, NULL, 0); + cs->cancel_implicit_keep = 1; + free_recipients(valid); + CM_Free(msg); + return SIEVE2_OK; +} + + +/* + * Callback function to indicate that a message *will* be kept in the inbox + */ +int ctdl_keep(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + + syslog(LOG_DEBUG, "Action is KEEP"); + + cs->keep = 1; + cs->cancel_implicit_keep = 1; + return SIEVE2_OK; +} + + +/* + * Callback function to file a message into a different mailbox + */ +int ctdl_fileinto(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + const char *dest_folder = sieve2_getvalue_string(s, "mailbox"); + int c; + char foldername[256]; + char original_room_name[ROOMNAMELEN]; + + syslog(LOG_DEBUG, "Action is FILEINTO, destination is <%s>", dest_folder); + + /* FILEINTO 'INBOX' is the same thing as KEEP */ + if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) { + cs->keep = 1; + cs->cancel_implicit_keep = 1; + return SIEVE2_OK; + } + + /* Remember what room we came from */ + safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name); + + /* First try a mailbox name match (check personal mail folders first) */ + snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder); + c = CtdlGetRoom(&CC->room, foldername); + + /* Then a regular room name match (public and private rooms) */ + if (c != 0) { + safestrncpy(foldername, dest_folder, sizeof foldername); + c = CtdlGetRoom(&CC->room, foldername); + } + + if (c != 0) { + syslog(LOG_WARNING, "FILEINTO failed: target <%s> does not exist", dest_folder); + return SIEVE2_ERROR_BADARGS; + } + + /* Yes, we actually have to go there */ + CtdlUserGoto(NULL, 0, 0, NULL, NULL, NULL, NULL); + + c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL, 0); + + /* Go back to the room we came from */ + if (strcasecmp(original_room_name, CC->room.QRname)) { + CtdlUserGoto(original_room_name, 0, 0, NULL, NULL, NULL, NULL); + } + + if (c == 0) { + cs->cancel_implicit_keep = 1; + return SIEVE2_OK; + } + else { + return SIEVE2_ERROR_BADARGS; + } +} + + +/* + * Callback function to indicate that a message should be discarded. + */ +int ctdl_discard(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + + syslog(LOG_DEBUG, "Action is DISCARD"); + + /* Cancel the implicit keep. That's all there is to it. */ + cs->cancel_implicit_keep = 1; + return SIEVE2_OK; +} + + +/* + * Callback function to indicate that a message should be rejected + */ +int ctdl_reject(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + char *reject_text = NULL; + + syslog(LOG_DEBUG, "Action is REJECT"); + + /* If we don't know who sent the message, do a DISCARD instead. */ + if (IsEmptyStr(cs->sender)) { + syslog(LOG_INFO, "Unknown sender. Doing DISCARD instead of REJECT."); + return ctdl_discard(s, my); + } + + /* Assemble the reject message. */ + reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024); + if (reject_text == NULL) { + return SIEVE2_ERROR_FAIL; + } + + sprintf(reject_text, + "Content-type: text/plain\n" + "\n" + "The message was refused by the recipient's mail filtering program.\n" + "The reason given was as follows:\n" + "\n" + "%s\n" + "\n" + , + sieve2_getvalue_string(s, "message") + ); + + quickie_message( /* This delivers the message */ + NULL, + cs->envelope_to, + cs->sender, + NULL, + reject_text, + FMT_RFC822, + "Delivery status notification" + ); + + free(reject_text); + cs->cancel_implicit_keep = 1; + return SIEVE2_OK; +} + + +/* + * Callback function to indicate that a vacation message should be generated + */ +int ctdl_vacation(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + struct sdm_vacation *vptr; + int days = 1; + const char *message; + char *vacamsg_text = NULL; + char vacamsg_subject[1024]; + + syslog(LOG_DEBUG, "Action is VACATION"); + + message = sieve2_getvalue_string(s, "message"); + if (message == NULL) return SIEVE2_ERROR_BADARGS; + + if (sieve2_getvalue_string(s, "subject") != NULL) { + safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject); + } + else { + snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject); + } + + days = sieve2_getvalue_int(s, "days"); + if (days < 1) days = 1; + if (days > MAX_VACATION) days = MAX_VACATION; + + /* Check to see whether we've already alerted this sender that we're on vacation. */ + for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) { + if (!strcasecmp(vptr->fromaddr, cs->sender)) { + if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) { + syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender); + return SIEVE2_OK; + } + } + } + + /* Assemble the reject message. */ + vacamsg_text = malloc(strlen(message) + 1024); + if (vacamsg_text == NULL) { + return SIEVE2_ERROR_FAIL; + } + + sprintf(vacamsg_text, + "Content-type: text/plain charset=utf-8\n" + "\n" + "%s\n" + "\n" + , + message + ); + + quickie_message( /* This delivers the message */ + NULL, + cs->envelope_to, + cs->sender, + NULL, + vacamsg_text, + FMT_RFC822, + vacamsg_subject + ); + + free(vacamsg_text); + + /* Now update the list to reflect the fact that we've alerted this sender. + * If they're already in the list, just update the timestamp. + */ + for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) { + if (!strcasecmp(vptr->fromaddr, cs->sender)) { + vptr->timestamp = time(NULL); + return SIEVE2_OK; + } + } + + /* If we get to this point, create a new record. + */ + vptr = malloc(sizeof(struct sdm_vacation)); + memset(vptr, 0, sizeof(struct sdm_vacation)); + vptr->timestamp = time(NULL); + safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr); + vptr->next = cs->u->first_vacation; + cs->u->first_vacation = vptr; + + return SIEVE2_OK; +} + + +/* + * Callback function to parse message envelope + */ +int ctdl_getenvelope(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + + syslog(LOG_DEBUG, "Action is GETENVELOPE"); + syslog(LOG_DEBUG, "EnvFrom: %s", cs->envelope_from); + syslog(LOG_DEBUG, "EnvTo: %s", cs->envelope_to); + + if (cs->envelope_from != NULL) { + if ((cs->envelope_from[0] != '@')&&(cs->envelope_from[strlen(cs->envelope_from)-1] != '@')) { + sieve2_setvalue_string(s, "from", cs->envelope_from); + } + else { + sieve2_setvalue_string(s, "from", "invalid_envelope_from@example.org"); + } + } + else { + sieve2_setvalue_string(s, "from", "null_envelope_from@example.org"); + } + + + if (cs->envelope_to != NULL) { + if ((cs->envelope_to[0] != '@') && (cs->envelope_to[strlen(cs->envelope_to)-1] != '@')) { + sieve2_setvalue_string(s, "to", cs->envelope_to); + } + else { + sieve2_setvalue_string(s, "to", "invalid_envelope_to@example.org"); + } + } + else { + sieve2_setvalue_string(s, "to", "null_envelope_to@example.org"); + } + + return SIEVE2_OK; +} + + + +/* + * Callback function to fetch message size + */ +int ctdl_getsize(sieve2_context_t *s, void *my) +{ + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + struct MetaData smi; + + GetMetaData(&smi, cs->msgnum); + + if (smi.meta_rfc822_length > 0L) { + sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length); + return SIEVE2_OK; + } + + return SIEVE2_ERROR_UNSUPPORTED; +} + + +/* + * Return a pointer to the active Sieve script. + * (Caller does NOT own the memory and should not free the returned pointer.) + */ +char *get_active_script(struct sdm_userdata *u) { + struct sdm_script *sptr; + + for (sptr=u->first_script; sptr!=NULL; sptr=sptr->next) { + if (sptr->script_active > 0) { + syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name); + return(sptr->script_content); + } + } + + syslog(LOG_DEBUG, "get_active_script() found no active script"); + return(NULL); +} + + +/* + * Callback function to retrieve the sieve script + */ +int ctdl_getscript(sieve2_context_t *s, void *my) { + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + + char *active_script = get_active_script(cs->u); + if (active_script != NULL) { + sieve2_setvalue_string(s, "script", active_script); + return SIEVE2_OK; + } + + return SIEVE2_ERROR_GETSCRIPT; +} + + +/* + * Callback function to retrieve message headers + */ +int ctdl_getheaders(sieve2_context_t *s, void *my) { + + struct ctdl_sieve *cs = (struct ctdl_sieve *)my; + + syslog(LOG_DEBUG, "ctdl_getheaders() was called"); + sieve2_setvalue_string(s, "allheaders", cs->rfc822headers); + return SIEVE2_OK; +} + + + +/* + * Perform sieve processing for one message (called by sieve_do_room() for each message) + */ +void sieve_do_msg(long msgnum, void *userdata) { + struct sdm_userdata *u = (struct sdm_userdata *) userdata; + sieve2_context_t *sieve2_context; + struct ctdl_sieve my; + int res; + struct CtdlMessage *msg; + int i; + size_t headers_len = 0; + int len = 0; + + if (u == NULL) { + syslog(LOG_ERR, "Can't process message <%ld> without userdata!", msgnum); + return; + } + + sieve2_context = u->sieve2_context; + + syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum); + + /* + * Make sure you include message body so you can get those second-level headers ;) + */ + msg = CtdlFetchMessage(msgnum, 1, 1); + if (msg == NULL) return; + + /* + * Grab the message headers so we can feed them to libSieve. + * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers. + */ + CC->redirect_buffer = NewStrBufPlain(NULL, SIZ); + CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0); + headers_len = StrLength(CC->redirect_buffer); + my.rfc822headers = SmashStrBuf(&CC->redirect_buffer); + + /* + * libSieve clobbers the stack if it encounters badly formed + * headers. Sanitize our headers by stripping nonprintable + * characters. + */ + for (i=0; iroom.QRname); /* Keep track of the owner of the room's namespace */ + my.msgnum = msgnum; /* Keep track of the message number in our local store */ + my.u = u; /* Hand off a pointer to the rest of this info */ + + /* Keep track of the recipient so we can do handling based on it later */ + process_rfc822_addr(msg->cm_fields[eRecipient], my.recp_user, my.recp_node, my.recp_name); + + /* Keep track of the sender so we can use it for REJECT and VACATION responses */ + if (!CM_IsEmpty(msg, erFc822Addr)) { + safestrncpy(my.sender, msg->cm_fields[erFc822Addr], sizeof my.sender); + } + else if (!CM_IsEmpty(msg, eAuthor)) { + safestrncpy(my.sender, msg->cm_fields[eAuthor], sizeof my.sender); + } + else { + strcpy(my.sender, ""); + } + + /* Keep track of the subject so we can use it for VACATION responses */ + if (!CM_IsEmpty(msg, eMsgSubject)) { + safestrncpy(my.subject, msg->cm_fields[eMsgSubject], sizeof my.subject); + } + else { + strcpy(my.subject, ""); + } + + /* Keep track of the envelope-from address (use body-from if not found) */ + if (!CM_IsEmpty(msg, eMessagePath)) { + safestrncpy(my.envelope_from, msg->cm_fields[eMessagePath], sizeof my.envelope_from); + stripallbut(my.envelope_from, '<', '>'); + } + else if (!CM_IsEmpty(msg, erFc822Addr)) { + safestrncpy(my.envelope_from, msg->cm_fields[erFc822Addr], sizeof my.envelope_from); + stripallbut(my.envelope_from, '<', '>'); + } + else { + strcpy(my.envelope_from, ""); + } + + len = strlen(my.envelope_from); + for (i=0; icm_fields[eenVelopeTo], sizeof my.envelope_to); + stripallbut(my.envelope_to, '<', '>'); + } + else if (!CM_IsEmpty(msg, eRecipient)) { + safestrncpy(my.envelope_to, msg->cm_fields[eRecipient], sizeof my.envelope_to); + stripallbut(my.envelope_to, '<', '>'); + } + else { + strcpy(my.envelope_to, ""); + } + + len = strlen(my.envelope_to); + for (i=0; iroom.QRname, &msgnum, 1, ""); + } + + syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum); + u->lastproc = msgnum; + + return; +} + + + +/* + * Given the on-disk representation of our Sieve config, load + * it into an in-memory data structure. + */ +void parse_sieve_config(char *conf, struct sdm_userdata *u) { + char *ptr; + char *c, *vacrec; + char keyword[256]; + struct sdm_script *sptr; + struct sdm_vacation *vptr; + + ptr = conf; + while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) { + *ptr = 0; + ptr += strlen(CTDLSIEVECONFIGSEPARATOR); + + extract_token(keyword, c, 0, '|', sizeof keyword); + + if (!strcasecmp(keyword, "lastproc")) { + u->lastproc = extract_long(c, 1); + } + + else if (!strcasecmp(keyword, "script")) { + sptr = malloc(sizeof(struct sdm_script)); + extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name); + sptr->script_active = extract_int(c, 2); + remove_token(c, 0, '|'); + remove_token(c, 0, '|'); + remove_token(c, 0, '|'); + sptr->script_content = strdup(c); + sptr->next = u->first_script; + u->first_script = sptr; + } + + else if (!strcasecmp(keyword, "vacation")) { + + if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) { + + *c = 0; + ++c; + + if (strncasecmp(vacrec, "vacation|", 9)) { + vptr = malloc(sizeof(struct sdm_vacation)); + extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr); + vptr->timestamp = extract_long(vacrec, 1); + vptr->next = u->first_vacation; + u->first_vacation = vptr; + } + } + } + + /* ignore unknown keywords */ + } +} + +/* + * We found the Sieve configuration for this user. + * Now do something with it. + */ +void get_sieve_config_backend(long msgnum, void *userdata) { + struct sdm_userdata *u = (struct sdm_userdata *) userdata; + struct CtdlMessage *msg; + char *conf; + long conflen; + + u->config_msgnum = msgnum; + msg = CtdlFetchMessage(msgnum, 1, 1); + if (msg == NULL) { + u->config_msgnum = (-1) ; + return; + } + + CM_GetAsField(msg, eMesageText, &conf, &conflen); + + CM_Free(msg); + + if (conf != NULL) { + parse_sieve_config(conf, u); + free(conf); + } + +} + + +/* + * Write our citadel sieve config back to disk + * + * (Set yes_write_to_disk to nonzero to make it actually write the config; + * otherwise it just frees the data structures.) + */ +void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) { + StrBuf *text; + struct sdm_script *sptr; + struct sdm_vacation *vptr; + + text = NewStrBufPlain(NULL, SIZ); + StrBufPrintf(text, + "Content-type: application/x-citadel-sieve-config\n" + "\n" + CTDLSIEVECONFIGSEPARATOR + "lastproc|%ld" + CTDLSIEVECONFIGSEPARATOR + , + u->lastproc + ); + + while (u->first_script != NULL) { + StrBufAppendPrintf(text, + "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR, + u->first_script->script_name, + u->first_script->script_active, + u->first_script->script_content + ); + sptr = u->first_script; + u->first_script = u->first_script->next; + free(sptr->script_content); + free(sptr); + } + + if (u->first_vacation != NULL) { + + StrBufAppendPrintf(text, "vacation|\n"); + while (u->first_vacation != NULL) { + if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) { + StrBufAppendPrintf(text, "%s|%ld\n", + u->first_vacation->fromaddr, + u->first_vacation->timestamp + ); + } + vptr = u->first_vacation; + u->first_vacation = u->first_vacation->next; + free(vptr); + } + StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR); + } + + if (yes_write_to_disk) + { + /* Save the config */ + quickie_message("Citadel", NULL, NULL, u->config_roomname, + ChrPtr(text), + 4, + "Sieve configuration" + ); + + /* And delete the old one */ + if (u->config_msgnum > 0) { + CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, ""); + } + } + + FreeStrBuf (&text); + +} + + +/* + * This is our callback registration table for libSieve. + */ +sieve2_callback_t ctdl_sieve_callbacks[] = { + { SIEVE2_ACTION_REJECT, ctdl_reject }, + { SIEVE2_ACTION_VACATION, ctdl_vacation }, + { SIEVE2_ERRCALL_PARSE, ctdl_errparse }, + { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec }, + { SIEVE2_ACTION_FILEINTO, ctdl_fileinto }, + { SIEVE2_ACTION_REDIRECT, ctdl_redirect }, + { SIEVE2_ACTION_DISCARD, ctdl_discard }, + { SIEVE2_ACTION_KEEP, ctdl_keep }, + { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript }, + { SIEVE2_DEBUG_TRACE, ctdl_debug }, + { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders }, + { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize }, + { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope }, + { 0 } +}; + + +/* + * Perform sieve processing for a single room + */ +void sieve_do_room(char *roomname) { + + struct sdm_userdata u; + sieve2_context_t *sieve2_context = NULL; /* Context for sieve parser */ + int res; /* Return code from libsieve calls */ + long orig_lastproc = 0; + + memset(&u, 0, sizeof u); + + /* See if the user who owns this 'mailbox' has any Sieve scripts that + * require execution. + */ + snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM); + if (CtdlGetRoom(&CC->room, u.config_roomname) != 0) { + syslog(LOG_DEBUG, "<%s> does not exist. No processing is required.", u.config_roomname); + return; + } + + /* + * Find the sieve scripts and control record and do something + */ + u.config_msgnum = (-1); + CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, get_sieve_config_backend, (void *)&u ); + + if (u.config_msgnum < 0) { + syslog(LOG_DEBUG, "No Sieve rules exist. No processing is required."); + return; + } + + /* + * Check to see whether the script is empty and should not be processed. + * A script is considered non-empty if it contains at least one semicolon. + */ + if ( + (get_active_script(&u) == NULL) + || (strchr(get_active_script(&u), ';') == NULL) + ) { + syslog(LOG_DEBUG, "Sieve script is empty. No processing is required."); + return; + } + + syslog(LOG_DEBUG, "Rules found. Performing Sieve processing for <%s>", roomname); + + if (CtdlGetRoom(&CC->room, roomname) != 0) { + syslog(LOG_ERR, "ERROR: cannot load <%s>", roomname); + return; + } + + /* Initialize the Sieve parser */ + + res = sieve2_alloc(&sieve2_context); + if (res != SIEVE2_OK) { + syslog(LOG_ERR, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res)); + return; + } + + res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks); + if (res != SIEVE2_OK) { + syslog(LOG_ERR, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res)); + goto BAIL; + } + + /* Validate the script */ + + struct ctdl_sieve my; /* dummy ctdl_sieve struct just to pass "u" along */ + memset(&my, 0, sizeof my); + my.u = &u; + res = sieve2_validate(sieve2_context, &my); + if (res != SIEVE2_OK) { + syslog(LOG_ERR, "sieve2_validate() returned %d: %s", res, sieve2_errstr(res)); + goto BAIL; + } + + /* Do something useful */ + u.sieve2_context = sieve2_context; + orig_lastproc = u.lastproc; + CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL, sieve_do_msg, (void *) &u); + +BAIL: + res = sieve2_free(&sieve2_context); + if (res != SIEVE2_OK) { + syslog(LOG_ERR, "sieve2_free() returned %d: %s", res, sieve2_errstr(res)); + } + + /* Rewrite the config if we have to (we're not the user right now) */ + rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ; +} + + + + +#endif + + + + +/* + * Get InBox Rules + * + * This is a client-facing function which fetches the user's inbox rules -- it omits all lines containing anything other than a rule. + */ +void cmd_gibr(char *argbuf) { + + if (CtdlAccessCheck(ac_logged_in)) return; + + cprintf("%d inbox rules for %s\n", LISTING_FOLLOWS, CC->user.fullname); + + struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1, 1); + if (msg != NULL) { + if (!CM_IsEmpty(msg, eMesageText)) { + char *token; + char *rest = msg->cm_fields[eMesageText]; + while ((token = strtok_r(rest, "\n", &rest))) { + + // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule" + if (!strncasecmp(token, "# WEBCIT_RULE|", 14)) { + strcpy(token, "rule|"); + strcpy(&token[5], &token[14]); + } + + // Output only lines containing rules. + if (!strncasecmp(token, "rule|", 5)) { + cprintf("%s\n", token); + } + } + } + CM_Free(msg); + } + cprintf("000\n"); +} + + +/* + * Put InBox Rules + * + * User transmits the new inbox rules for the account. They are inserted into the account, replacing the ones already there. + */ +void cmd_pibr(char *argbuf) { + if (CtdlAccessCheck(ac_logged_in)) return; + + unbuffer_output(); + cprintf("%d send new rules\n", SEND_LISTING); + char *newrules = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0); + StrBuf *NewConfig = NewStrBufPlain("Content-type: application/x-citadel-sieve-config; charset=UTF-8\nContent-transfer-encoding: 8bit\n\n", -1); + + char *token; + char *rest = newrules; + while ((token = strtok_r(rest, "\n", &rest))) { + // Accept only lines containing rules + if (!strncasecmp(token, "rule|", 5)) { + StrBufAppendBufPlain(NewConfig, token, -1, 0); + StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0); + } + } + free(newrules); + + // Fetch the existing config so we can merge in anything that is NOT a rule + // (Does not start with "rule|" but has at least one vertical bar) + struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1, 1); + if (msg != NULL) { + if (!CM_IsEmpty(msg, eMesageText)) { + rest = msg->cm_fields[eMesageText]; + while ((token = strtok_r(rest, "\n", &rest))) { + // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule" + if ((strncasecmp(token, "# WEBCIT_RULE|", 14)) && (strncasecmp(token, "rule|", 5)) && (haschar(token, '|'))) { + StrBufAppendBufPlain(NewConfig, token, -1, 0); + StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0); + } + } + } + CM_Free(msg); + } + + /* we have composed the new configuration , now save it */ + long old_msgnum = CC->user.msgnum_inboxrules; + char userconfigroomname[ROOMNAMELEN]; + CtdlMailboxName(userconfigroomname, sizeof userconfigroomname, &CC->user, USERCONFIGROOM); + long new_msgnum = quickie_message("Citadel", NULL, NULL, userconfigroomname, ChrPtr(NewConfig), FMT_RFC822, "inbox rules configuration"); + FreeStrBuf(&NewConfig); + CtdlGetUserLock(&CC->user, CC->curr_user); + CC->user.msgnum_inboxrules = new_msgnum; + CtdlPutUserLock(&CC->user); + if (old_msgnum > 0) { + syslog(LOG_DEBUG, "Deleting old message %ld from %s", old_msgnum, userconfigroomname); + CtdlDeleteMessages(userconfigroomname, &old_msgnum, 1, ""); + } +} + + +CTDL_MODULE_INIT(sieve) +{ + if (!threading) + { + // ctdl_sieve_init(); + CtdlRegisterProtoHook(cmd_gibr, "GIBR", "Get InBox Rules"); + CtdlRegisterProtoHook(cmd_pibr, "PIBR", "Put InBox Rules"); + // CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE, PRIO_HOUSE + 10); + // CtdlRegisterCleanupHook(cleanup_sieve); + } + + /* return our module name for the log */ + return "inboxrules"; +} diff --git a/citadel/modules/sieve/.gitignore b/citadel/modules/sieve/.gitignore deleted file mode 100644 index 5761abcfd..000000000 --- a/citadel/modules/sieve/.gitignore +++ /dev/null @@ -1 +0,0 @@ -*.o diff --git a/citadel/modules/sieve/serv_sieve.c b/citadel/modules/sieve/serv_sieve.c deleted file mode 100644 index 24438b0b9..000000000 --- a/citadel/modules/sieve/serv_sieve.c +++ /dev/null @@ -1,958 +0,0 @@ -/* - * Inbox handling rules - * - * Copyright (c) 1987-2020 by the citadel.org team - * - * This program is open source software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 3. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - */ - -#include "sysdep.h" -#include -#include -#include -#include -#include -#include -#include -#include - -#if TIME_WITH_SYS_TIME -# include -# include -#else -# if HAVE_SYS_TIME_H -# include -# else -# include -# endif -#endif - -#include -#include -#include -#include -#include "citadel.h" -#include "server.h" -#include "citserver.h" -#include "support.h" -#include "config.h" -#include "database.h" -#include "msgbase.h" -#include "internet_addressing.h" -#include "ctdl_module.h" - - -#if 0 - -/* - * Callback function to redirect a message to a different folder - */ -int ctdl_redirect(void) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - struct CtdlMessage *msg = NULL; - recptypes *valid = NULL; - char recp[256]; - - safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp); - - syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>", recp); - - valid = validate_recipients(recp, NULL, 0); - if (valid == NULL) { - syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); - return SIEVE2_ERROR_BADARGS; - } - if (valid->num_error > 0) { - syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); - free_recipients(valid); - return SIEVE2_ERROR_BADARGS; - } - - msg = CtdlFetchMessage(cs->msgnum, 1, 1); - if (msg == NULL) { - syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld", cs->msgnum); - free_recipients(valid); - return SIEVE2_ERROR_BADARGS; - } - - CtdlSubmitMsg(msg, valid, NULL, 0); - cs->cancel_implicit_keep = 1; - free_recipients(valid); - CM_Free(msg); - return SIEVE2_OK; -} - - -/* - * Callback function to indicate that a message *will* be kept in the inbox - */ -int ctdl_keep(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - syslog(LOG_DEBUG, "Action is KEEP"); - - cs->keep = 1; - cs->cancel_implicit_keep = 1; - return SIEVE2_OK; -} - - -/* - * Callback function to file a message into a different mailbox - */ -int ctdl_fileinto(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - const char *dest_folder = sieve2_getvalue_string(s, "mailbox"); - int c; - char foldername[256]; - char original_room_name[ROOMNAMELEN]; - - syslog(LOG_DEBUG, "Action is FILEINTO, destination is <%s>", dest_folder); - - /* FILEINTO 'INBOX' is the same thing as KEEP */ - if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) { - cs->keep = 1; - cs->cancel_implicit_keep = 1; - return SIEVE2_OK; - } - - /* Remember what room we came from */ - safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name); - - /* First try a mailbox name match (check personal mail folders first) */ - snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder); - c = CtdlGetRoom(&CC->room, foldername); - - /* Then a regular room name match (public and private rooms) */ - if (c != 0) { - safestrncpy(foldername, dest_folder, sizeof foldername); - c = CtdlGetRoom(&CC->room, foldername); - } - - if (c != 0) { - syslog(LOG_WARNING, "FILEINTO failed: target <%s> does not exist", dest_folder); - return SIEVE2_ERROR_BADARGS; - } - - /* Yes, we actually have to go there */ - CtdlUserGoto(NULL, 0, 0, NULL, NULL, NULL, NULL); - - c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL, 0); - - /* Go back to the room we came from */ - if (strcasecmp(original_room_name, CC->room.QRname)) { - CtdlUserGoto(original_room_name, 0, 0, NULL, NULL, NULL, NULL); - } - - if (c == 0) { - cs->cancel_implicit_keep = 1; - return SIEVE2_OK; - } - else { - return SIEVE2_ERROR_BADARGS; - } -} - - -/* - * Callback function to indicate that a message should be discarded. - */ -int ctdl_discard(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - syslog(LOG_DEBUG, "Action is DISCARD"); - - /* Cancel the implicit keep. That's all there is to it. */ - cs->cancel_implicit_keep = 1; - return SIEVE2_OK; -} - - -/* - * Callback function to indicate that a message should be rejected - */ -int ctdl_reject(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - char *reject_text = NULL; - - syslog(LOG_DEBUG, "Action is REJECT"); - - /* If we don't know who sent the message, do a DISCARD instead. */ - if (IsEmptyStr(cs->sender)) { - syslog(LOG_INFO, "Unknown sender. Doing DISCARD instead of REJECT."); - return ctdl_discard(s, my); - } - - /* Assemble the reject message. */ - reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024); - if (reject_text == NULL) { - return SIEVE2_ERROR_FAIL; - } - - sprintf(reject_text, - "Content-type: text/plain\n" - "\n" - "The message was refused by the recipient's mail filtering program.\n" - "The reason given was as follows:\n" - "\n" - "%s\n" - "\n" - , - sieve2_getvalue_string(s, "message") - ); - - quickie_message( /* This delivers the message */ - NULL, - cs->envelope_to, - cs->sender, - NULL, - reject_text, - FMT_RFC822, - "Delivery status notification" - ); - - free(reject_text); - cs->cancel_implicit_keep = 1; - return SIEVE2_OK; -} - - -/* - * Callback function to indicate that a vacation message should be generated - */ -int ctdl_vacation(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - struct sdm_vacation *vptr; - int days = 1; - const char *message; - char *vacamsg_text = NULL; - char vacamsg_subject[1024]; - - syslog(LOG_DEBUG, "Action is VACATION"); - - message = sieve2_getvalue_string(s, "message"); - if (message == NULL) return SIEVE2_ERROR_BADARGS; - - if (sieve2_getvalue_string(s, "subject") != NULL) { - safestrncpy(vacamsg_subject, sieve2_getvalue_string(s, "subject"), sizeof vacamsg_subject); - } - else { - snprintf(vacamsg_subject, sizeof vacamsg_subject, "Re: %s", cs->subject); - } - - days = sieve2_getvalue_int(s, "days"); - if (days < 1) days = 1; - if (days > MAX_VACATION) days = MAX_VACATION; - - /* Check to see whether we've already alerted this sender that we're on vacation. */ - for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) { - if (!strcasecmp(vptr->fromaddr, cs->sender)) { - if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) { - syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender); - return SIEVE2_OK; - } - } - } - - /* Assemble the reject message. */ - vacamsg_text = malloc(strlen(message) + 1024); - if (vacamsg_text == NULL) { - return SIEVE2_ERROR_FAIL; - } - - sprintf(vacamsg_text, - "Content-type: text/plain charset=utf-8\n" - "\n" - "%s\n" - "\n" - , - message - ); - - quickie_message( /* This delivers the message */ - NULL, - cs->envelope_to, - cs->sender, - NULL, - vacamsg_text, - FMT_RFC822, - vacamsg_subject - ); - - free(vacamsg_text); - - /* Now update the list to reflect the fact that we've alerted this sender. - * If they're already in the list, just update the timestamp. - */ - for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) { - if (!strcasecmp(vptr->fromaddr, cs->sender)) { - vptr->timestamp = time(NULL); - return SIEVE2_OK; - } - } - - /* If we get to this point, create a new record. - */ - vptr = malloc(sizeof(struct sdm_vacation)); - memset(vptr, 0, sizeof(struct sdm_vacation)); - vptr->timestamp = time(NULL); - safestrncpy(vptr->fromaddr, cs->sender, sizeof vptr->fromaddr); - vptr->next = cs->u->first_vacation; - cs->u->first_vacation = vptr; - - return SIEVE2_OK; -} - - -/* - * Callback function to parse message envelope - */ -int ctdl_getenvelope(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - syslog(LOG_DEBUG, "Action is GETENVELOPE"); - syslog(LOG_DEBUG, "EnvFrom: %s", cs->envelope_from); - syslog(LOG_DEBUG, "EnvTo: %s", cs->envelope_to); - - if (cs->envelope_from != NULL) { - if ((cs->envelope_from[0] != '@')&&(cs->envelope_from[strlen(cs->envelope_from)-1] != '@')) { - sieve2_setvalue_string(s, "from", cs->envelope_from); - } - else { - sieve2_setvalue_string(s, "from", "invalid_envelope_from@example.org"); - } - } - else { - sieve2_setvalue_string(s, "from", "null_envelope_from@example.org"); - } - - - if (cs->envelope_to != NULL) { - if ((cs->envelope_to[0] != '@') && (cs->envelope_to[strlen(cs->envelope_to)-1] != '@')) { - sieve2_setvalue_string(s, "to", cs->envelope_to); - } - else { - sieve2_setvalue_string(s, "to", "invalid_envelope_to@example.org"); - } - } - else { - sieve2_setvalue_string(s, "to", "null_envelope_to@example.org"); - } - - return SIEVE2_OK; -} - - - -/* - * Callback function to fetch message size - */ -int ctdl_getsize(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - struct MetaData smi; - - GetMetaData(&smi, cs->msgnum); - - if (smi.meta_rfc822_length > 0L) { - sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length); - return SIEVE2_OK; - } - - return SIEVE2_ERROR_UNSUPPORTED; -} - - -/* - * Return a pointer to the active Sieve script. - * (Caller does NOT own the memory and should not free the returned pointer.) - */ -char *get_active_script(struct sdm_userdata *u) { - struct sdm_script *sptr; - - for (sptr=u->first_script; sptr!=NULL; sptr=sptr->next) { - if (sptr->script_active > 0) { - syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name); - return(sptr->script_content); - } - } - - syslog(LOG_DEBUG, "get_active_script() found no active script"); - return(NULL); -} - - -/* - * Callback function to retrieve the sieve script - */ -int ctdl_getscript(sieve2_context_t *s, void *my) { - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - char *active_script = get_active_script(cs->u); - if (active_script != NULL) { - sieve2_setvalue_string(s, "script", active_script); - return SIEVE2_OK; - } - - return SIEVE2_ERROR_GETSCRIPT; -} - - -/* - * Callback function to retrieve message headers - */ -int ctdl_getheaders(sieve2_context_t *s, void *my) { - - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - syslog(LOG_DEBUG, "ctdl_getheaders() was called"); - sieve2_setvalue_string(s, "allheaders", cs->rfc822headers); - return SIEVE2_OK; -} - - - -/* - * Perform sieve processing for one message (called by sieve_do_room() for each message) - */ -void sieve_do_msg(long msgnum, void *userdata) { - struct sdm_userdata *u = (struct sdm_userdata *) userdata; - sieve2_context_t *sieve2_context; - struct ctdl_sieve my; - int res; - struct CtdlMessage *msg; - int i; - size_t headers_len = 0; - int len = 0; - - if (u == NULL) { - syslog(LOG_ERR, "Can't process message <%ld> without userdata!", msgnum); - return; - } - - sieve2_context = u->sieve2_context; - - syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum); - - /* - * Make sure you include message body so you can get those second-level headers ;) - */ - msg = CtdlFetchMessage(msgnum, 1, 1); - if (msg == NULL) return; - - /* - * Grab the message headers so we can feed them to libSieve. - * Use HEADERS_ONLY rather than HEADERS_FAST in order to include second-level headers. - */ - CC->redirect_buffer = NewStrBufPlain(NULL, SIZ); - CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1, 0); - headers_len = StrLength(CC->redirect_buffer); - my.rfc822headers = SmashStrBuf(&CC->redirect_buffer); - - /* - * libSieve clobbers the stack if it encounters badly formed - * headers. Sanitize our headers by stripping nonprintable - * characters. - */ - for (i=0; iroom.QRname); /* Keep track of the owner of the room's namespace */ - my.msgnum = msgnum; /* Keep track of the message number in our local store */ - my.u = u; /* Hand off a pointer to the rest of this info */ - - /* Keep track of the recipient so we can do handling based on it later */ - process_rfc822_addr(msg->cm_fields[eRecipient], my.recp_user, my.recp_node, my.recp_name); - - /* Keep track of the sender so we can use it for REJECT and VACATION responses */ - if (!CM_IsEmpty(msg, erFc822Addr)) { - safestrncpy(my.sender, msg->cm_fields[erFc822Addr], sizeof my.sender); - } - else if (!CM_IsEmpty(msg, eAuthor)) { - safestrncpy(my.sender, msg->cm_fields[eAuthor], sizeof my.sender); - } - else { - strcpy(my.sender, ""); - } - - /* Keep track of the subject so we can use it for VACATION responses */ - if (!CM_IsEmpty(msg, eMsgSubject)) { - safestrncpy(my.subject, msg->cm_fields[eMsgSubject], sizeof my.subject); - } - else { - strcpy(my.subject, ""); - } - - /* Keep track of the envelope-from address (use body-from if not found) */ - if (!CM_IsEmpty(msg, eMessagePath)) { - safestrncpy(my.envelope_from, msg->cm_fields[eMessagePath], sizeof my.envelope_from); - stripallbut(my.envelope_from, '<', '>'); - } - else if (!CM_IsEmpty(msg, erFc822Addr)) { - safestrncpy(my.envelope_from, msg->cm_fields[erFc822Addr], sizeof my.envelope_from); - stripallbut(my.envelope_from, '<', '>'); - } - else { - strcpy(my.envelope_from, ""); - } - - len = strlen(my.envelope_from); - for (i=0; icm_fields[eenVelopeTo], sizeof my.envelope_to); - stripallbut(my.envelope_to, '<', '>'); - } - else if (!CM_IsEmpty(msg, eRecipient)) { - safestrncpy(my.envelope_to, msg->cm_fields[eRecipient], sizeof my.envelope_to); - stripallbut(my.envelope_to, '<', '>'); - } - else { - strcpy(my.envelope_to, ""); - } - - len = strlen(my.envelope_to); - for (i=0; iroom.QRname, &msgnum, 1, ""); - } - - syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum); - u->lastproc = msgnum; - - return; -} - - - -/* - * Given the on-disk representation of our Sieve config, load - * it into an in-memory data structure. - */ -void parse_sieve_config(char *conf, struct sdm_userdata *u) { - char *ptr; - char *c, *vacrec; - char keyword[256]; - struct sdm_script *sptr; - struct sdm_vacation *vptr; - - ptr = conf; - while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) { - *ptr = 0; - ptr += strlen(CTDLSIEVECONFIGSEPARATOR); - - extract_token(keyword, c, 0, '|', sizeof keyword); - - if (!strcasecmp(keyword, "lastproc")) { - u->lastproc = extract_long(c, 1); - } - - else if (!strcasecmp(keyword, "script")) { - sptr = malloc(sizeof(struct sdm_script)); - extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name); - sptr->script_active = extract_int(c, 2); - remove_token(c, 0, '|'); - remove_token(c, 0, '|'); - remove_token(c, 0, '|'); - sptr->script_content = strdup(c); - sptr->next = u->first_script; - u->first_script = sptr; - } - - else if (!strcasecmp(keyword, "vacation")) { - - if (c != NULL) while (vacrec=c, c=strchr(c, '\n'), (c != NULL)) { - - *c = 0; - ++c; - - if (strncasecmp(vacrec, "vacation|", 9)) { - vptr = malloc(sizeof(struct sdm_vacation)); - extract_token(vptr->fromaddr, vacrec, 0, '|', sizeof vptr->fromaddr); - vptr->timestamp = extract_long(vacrec, 1); - vptr->next = u->first_vacation; - u->first_vacation = vptr; - } - } - } - - /* ignore unknown keywords */ - } -} - -/* - * We found the Sieve configuration for this user. - * Now do something with it. - */ -void get_sieve_config_backend(long msgnum, void *userdata) { - struct sdm_userdata *u = (struct sdm_userdata *) userdata; - struct CtdlMessage *msg; - char *conf; - long conflen; - - u->config_msgnum = msgnum; - msg = CtdlFetchMessage(msgnum, 1, 1); - if (msg == NULL) { - u->config_msgnum = (-1) ; - return; - } - - CM_GetAsField(msg, eMesageText, &conf, &conflen); - - CM_Free(msg); - - if (conf != NULL) { - parse_sieve_config(conf, u); - free(conf); - } - -} - - -/* - * Write our citadel sieve config back to disk - * - * (Set yes_write_to_disk to nonzero to make it actually write the config; - * otherwise it just frees the data structures.) - */ -void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) { - StrBuf *text; - struct sdm_script *sptr; - struct sdm_vacation *vptr; - - text = NewStrBufPlain(NULL, SIZ); - StrBufPrintf(text, - "Content-type: application/x-citadel-sieve-config\n" - "\n" - CTDLSIEVECONFIGSEPARATOR - "lastproc|%ld" - CTDLSIEVECONFIGSEPARATOR - , - u->lastproc - ); - - while (u->first_script != NULL) { - StrBufAppendPrintf(text, - "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR, - u->first_script->script_name, - u->first_script->script_active, - u->first_script->script_content - ); - sptr = u->first_script; - u->first_script = u->first_script->next; - free(sptr->script_content); - free(sptr); - } - - if (u->first_vacation != NULL) { - - StrBufAppendPrintf(text, "vacation|\n"); - while (u->first_vacation != NULL) { - if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) { - StrBufAppendPrintf(text, "%s|%ld\n", - u->first_vacation->fromaddr, - u->first_vacation->timestamp - ); - } - vptr = u->first_vacation; - u->first_vacation = u->first_vacation->next; - free(vptr); - } - StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR); - } - - if (yes_write_to_disk) - { - /* Save the config */ - quickie_message("Citadel", NULL, NULL, u->config_roomname, - ChrPtr(text), - 4, - "Sieve configuration" - ); - - /* And delete the old one */ - if (u->config_msgnum > 0) { - CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, ""); - } - } - - FreeStrBuf (&text); - -} - - -/* - * This is our callback registration table for libSieve. - */ -sieve2_callback_t ctdl_sieve_callbacks[] = { - { SIEVE2_ACTION_REJECT, ctdl_reject }, - { SIEVE2_ACTION_VACATION, ctdl_vacation }, - { SIEVE2_ERRCALL_PARSE, ctdl_errparse }, - { SIEVE2_ERRCALL_RUNTIME, ctdl_errexec }, - { SIEVE2_ACTION_FILEINTO, ctdl_fileinto }, - { SIEVE2_ACTION_REDIRECT, ctdl_redirect }, - { SIEVE2_ACTION_DISCARD, ctdl_discard }, - { SIEVE2_ACTION_KEEP, ctdl_keep }, - { SIEVE2_SCRIPT_GETSCRIPT, ctdl_getscript }, - { SIEVE2_DEBUG_TRACE, ctdl_debug }, - { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders }, - { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize }, - { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope }, - { 0 } -}; - - -/* - * Perform sieve processing for a single room - */ -void sieve_do_room(char *roomname) { - - struct sdm_userdata u; - sieve2_context_t *sieve2_context = NULL; /* Context for sieve parser */ - int res; /* Return code from libsieve calls */ - long orig_lastproc = 0; - - memset(&u, 0, sizeof u); - - /* See if the user who owns this 'mailbox' has any Sieve scripts that - * require execution. - */ - snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM); - if (CtdlGetRoom(&CC->room, u.config_roomname) != 0) { - syslog(LOG_DEBUG, "<%s> does not exist. No processing is required.", u.config_roomname); - return; - } - - /* - * Find the sieve scripts and control record and do something - */ - u.config_msgnum = (-1); - CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, get_sieve_config_backend, (void *)&u ); - - if (u.config_msgnum < 0) { - syslog(LOG_DEBUG, "No Sieve rules exist. No processing is required."); - return; - } - - /* - * Check to see whether the script is empty and should not be processed. - * A script is considered non-empty if it contains at least one semicolon. - */ - if ( - (get_active_script(&u) == NULL) - || (strchr(get_active_script(&u), ';') == NULL) - ) { - syslog(LOG_DEBUG, "Sieve script is empty. No processing is required."); - return; - } - - syslog(LOG_DEBUG, "Rules found. Performing Sieve processing for <%s>", roomname); - - if (CtdlGetRoom(&CC->room, roomname) != 0) { - syslog(LOG_ERR, "ERROR: cannot load <%s>", roomname); - return; - } - - /* Initialize the Sieve parser */ - - res = sieve2_alloc(&sieve2_context); - if (res != SIEVE2_OK) { - syslog(LOG_ERR, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res)); - return; - } - - res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks); - if (res != SIEVE2_OK) { - syslog(LOG_ERR, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res)); - goto BAIL; - } - - /* Validate the script */ - - struct ctdl_sieve my; /* dummy ctdl_sieve struct just to pass "u" along */ - memset(&my, 0, sizeof my); - my.u = &u; - res = sieve2_validate(sieve2_context, &my); - if (res != SIEVE2_OK) { - syslog(LOG_ERR, "sieve2_validate() returned %d: %s", res, sieve2_errstr(res)); - goto BAIL; - } - - /* Do something useful */ - u.sieve2_context = sieve2_context; - orig_lastproc = u.lastproc; - CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL, sieve_do_msg, (void *) &u); - -BAIL: - res = sieve2_free(&sieve2_context); - if (res != SIEVE2_OK) { - syslog(LOG_ERR, "sieve2_free() returned %d: %s", res, sieve2_errstr(res)); - } - - /* Rewrite the config if we have to (we're not the user right now) */ - rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ; -} - - - - -#endif - - - - -/* - * Get InBox Rules - * - * This is a client-facing function which fetches the user's inbox rules -- it omits all lines containing anything other than a rule. - */ -void cmd_gibr(char *argbuf) { - - if (CtdlAccessCheck(ac_logged_in)) return; - - cprintf("%d inbox rules for %s\n", LISTING_FOLLOWS, CC->user.fullname); - - struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1, 1); - if (msg != NULL) { - if (!CM_IsEmpty(msg, eMesageText)) { - char *token; - char *rest = msg->cm_fields[eMesageText]; - while ((token = strtok_r(rest, "\n", &rest))) { - - // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule" - if (!strncasecmp(token, "# WEBCIT_RULE|", 14)) { - strcpy(token, "rule|"); - strcpy(&token[5], &token[14]); - } - - // Output only lines containing rules. - if (!strncasecmp(token, "rule|", 5)) { - cprintf("%s\n", token); - } - } - } - CM_Free(msg); - } - cprintf("000\n"); -} - - -/* - * Put InBox Rules - * - * User transmits the new inbox rules for the account. They are inserted into the account, replacing the ones already there. - */ -void cmd_pibr(char *argbuf) { - if (CtdlAccessCheck(ac_logged_in)) return; - - unbuffer_output(); - cprintf("%d send new rules\n", SEND_LISTING); - char *newrules = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0); - StrBuf *NewConfig = NewStrBufPlain("Content-type: application/x-citadel-sieve-config; charset=UTF-8\nContent-transfer-encoding: 8bit\n\n", -1); - - char *token; - char *rest = newrules; - while ((token = strtok_r(rest, "\n", &rest))) { - // Accept only lines containing rules - if (!strncasecmp(token, "rule|", 5)) { - StrBufAppendBufPlain(NewConfig, token, -1, 0); - StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0); - } - } - free(newrules); - - // Fetch the existing config so we can merge in anything that is NOT a rule - // (Does not start with "rule|" but has at least one vertical bar) - struct CtdlMessage *msg = CtdlFetchMessage(CC->user.msgnum_inboxrules, 1, 1); - if (msg != NULL) { - if (!CM_IsEmpty(msg, eMesageText)) { - rest = msg->cm_fields[eMesageText]; - while ((token = strtok_r(rest, "\n", &rest))) { - // for backwards compatibility, "# WEBCIT_RULE" is an alias for "rule" - if ((strncasecmp(token, "# WEBCIT_RULE|", 14)) && (strncasecmp(token, "rule|", 5)) && (haschar(token, '|'))) { - StrBufAppendBufPlain(NewConfig, token, -1, 0); - StrBufAppendBufPlain(NewConfig, HKEY("\n"), 0); - } - } - } - CM_Free(msg); - } - - /* we have composed the new configuration , now save it */ - long old_msgnum = CC->user.msgnum_inboxrules; - char userconfigroomname[ROOMNAMELEN]; - CtdlMailboxName(userconfigroomname, sizeof userconfigroomname, &CC->user, USERCONFIGROOM); - long new_msgnum = quickie_message("Citadel", NULL, NULL, userconfigroomname, ChrPtr(NewConfig), FMT_RFC822, "inbox rules configuration"); - FreeStrBuf(&NewConfig); - CtdlGetUserLock(&CC->user, CC->curr_user); - CC->user.msgnum_inboxrules = new_msgnum; - CtdlPutUserLock(&CC->user); - if (old_msgnum > 0) { - syslog(LOG_DEBUG, "Deleting old message %ld from %s", old_msgnum, userconfigroomname); - CtdlDeleteMessages(userconfigroomname, &old_msgnum, 1, ""); - } -} - - -CTDL_MODULE_INIT(sieve) -{ - if (!threading) - { - // ctdl_sieve_init(); - CtdlRegisterProtoHook(cmd_gibr, "GIBR", "Get InBox Rules"); - CtdlRegisterProtoHook(cmd_pibr, "PIBR", "Put InBox Rules"); - // CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE, PRIO_HOUSE + 10); - // CtdlRegisterCleanupHook(cleanup_sieve); - } - - /* return our module name for the log */ - return "sieve"; -}