X-Git-Url: https://code.citadel.org/?p=citadel.git;a=blobdiff_plain;f=citadel%2Fmodules%2Fsieve%2Fserv_sieve.c;h=24438b0b9bf2fff12154197cba05372cc97754c7;hp=f8c6e8c3589ac9336788f8d4cb00fa8a33a6c30a;hb=e830265f9a3238898ea25e8ed4782e50f2b7a775;hpb=0eea6dcc234e0f524bbf2a1d909455d41ed02314 diff --git a/citadel/modules/sieve/serv_sieve.c b/citadel/modules/sieve/serv_sieve.c index f8c6e8c35..24438b0b9 100644 --- a/citadel/modules/sieve/serv_sieve.c +++ b/citadel/modules/sieve/serv_sieve.c @@ -1,24 +1,15 @@ /* - * $Id$ + * Inbox handling rules * - * This module glues libSieve to the Citadel server in order to implement - * the Sieve mailbox filtering language (RFC 3028). + * Copyright (c) 1987-2020 by the citadel.org team * - * Copyright (c) 1987-2010 by the citadel.org team - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. + * 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. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "sysdep.h" @@ -55,75 +46,38 @@ #include "msgbase.h" #include "internet_addressing.h" #include "ctdl_module.h" -#include "serv_sieve.h" - -struct RoomProcList *sieve_list = NULL; -char *msiv_extensions = NULL; - - -/* - * Callback function to send libSieve trace messages to Citadel log facility - */ -int ctdl_debug(sieve2_context_t *s, void *my) -{ - CtdlLogPrintf(CTDL_DEBUG, "Sieve: %s\n", sieve2_getvalue_string(s, "message")); - return SIEVE2_OK; -} - - -/* - * Callback function to log script parsing errors - */ -int ctdl_errparse(sieve2_context_t *s, void *my) -{ - CtdlLogPrintf(CTDL_WARNING, "Error in script, line %d: %s\n", - sieve2_getvalue_int(s, "lineno"), - sieve2_getvalue_string(s, "message") - ); - return SIEVE2_OK; -} - -/* - * Callback function to log script execution errors - */ -int ctdl_errexec(sieve2_context_t *s, void *my) -{ - CtdlLogPrintf(CTDL_WARNING, "Error executing script: %s\n", - sieve2_getvalue_string(s, "message") - ); - return SIEVE2_OK; -} +#if 0 /* * Callback function to redirect a message to a different folder */ -int ctdl_redirect(sieve2_context_t *s, void *my) +int ctdl_redirect(void) { struct ctdl_sieve *cs = (struct ctdl_sieve *)my; struct CtdlMessage *msg = NULL; - struct recptypes *valid = NULL; + recptypes *valid = NULL; char recp[256]; safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp); - CtdlLogPrintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp); + syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>", recp); valid = validate_recipients(recp, NULL, 0); if (valid == NULL) { - CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp); + syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); return SIEVE2_ERROR_BADARGS; } if (valid->num_error > 0) { - CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp); + syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp); free_recipients(valid); return SIEVE2_ERROR_BADARGS; } - msg = CtdlFetchMessage(cs->msgnum, 1); + msg = CtdlFetchMessage(cs->msgnum, 1, 1); if (msg == NULL) { - CtdlLogPrintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum); + syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld", cs->msgnum); free_recipients(valid); return SIEVE2_ERROR_BADARGS; } @@ -131,7 +85,7 @@ int ctdl_redirect(sieve2_context_t *s, void *my) CtdlSubmitMsg(msg, valid, NULL, 0); cs->cancel_implicit_keep = 1; free_recipients(valid); - CtdlFreeMessage(msg); + CM_Free(msg); return SIEVE2_OK; } @@ -143,7 +97,7 @@ int ctdl_keep(sieve2_context_t *s, void *my) { struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - CtdlLogPrintf(CTDL_DEBUG, "Action is KEEP\n"); + syslog(LOG_DEBUG, "Action is KEEP"); cs->keep = 1; cs->cancel_implicit_keep = 1; @@ -162,7 +116,7 @@ int ctdl_fileinto(sieve2_context_t *s, void *my) char foldername[256]; char original_room_name[ROOMNAMELEN]; - CtdlLogPrintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder); + 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)) ) { @@ -185,18 +139,18 @@ int ctdl_fileinto(sieve2_context_t *s, void *my) } if (c != 0) { - CtdlLogPrintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder); + 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); + 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); + CtdlUserGoto(original_room_name, 0, 0, NULL, NULL, NULL, NULL); } if (c == 0) { @@ -216,7 +170,7 @@ int ctdl_discard(sieve2_context_t *s, void *my) { struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - CtdlLogPrintf(CTDL_DEBUG, "Action is DISCARD\n"); + syslog(LOG_DEBUG, "Action is DISCARD"); /* Cancel the implicit keep. That's all there is to it. */ cs->cancel_implicit_keep = 1; @@ -224,7 +178,6 @@ int ctdl_discard(sieve2_context_t *s, void *my) } - /* * Callback function to indicate that a message should be rejected */ @@ -233,11 +186,11 @@ int ctdl_reject(sieve2_context_t *s, void *my) struct ctdl_sieve *cs = (struct ctdl_sieve *)my; char *reject_text = NULL; - CtdlLogPrintf(CTDL_DEBUG, "Action is REJECT\n"); + syslog(LOG_DEBUG, "Action is REJECT"); /* If we don't know who sent the message, do a DISCARD instead. */ if (IsEmptyStr(cs->sender)) { - CtdlLogPrintf(CTDL_INFO, "Unknown sender. Doing DISCARD instead of REJECT.\n"); + syslog(LOG_INFO, "Unknown sender. Doing DISCARD instead of REJECT."); return ctdl_discard(s, my); } @@ -275,7 +228,6 @@ int ctdl_reject(sieve2_context_t *s, void *my) } - /* * Callback function to indicate that a vacation message should be generated */ @@ -288,7 +240,7 @@ int ctdl_vacation(sieve2_context_t *s, void *my) char *vacamsg_text = NULL; char vacamsg_subject[1024]; - CtdlLogPrintf(CTDL_DEBUG, "Action is VACATION\n"); + syslog(LOG_DEBUG, "Action is VACATION"); message = sieve2_getvalue_string(s, "message"); if (message == NULL) return SIEVE2_ERROR_BADARGS; @@ -308,7 +260,7 @@ int ctdl_vacation(sieve2_context_t *s, void *my) for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) { if (!strcasecmp(vptr->fromaddr, cs->sender)) { if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) { - CtdlLogPrintf(CTDL_DEBUG, "Already alerted <%s> recently.\n", cs->sender); + syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender); return SIEVE2_OK; } } @@ -364,28 +316,6 @@ int ctdl_vacation(sieve2_context_t *s, void *my) } -/* - * Callback function to parse addresses per local system convention - * It is disabled because we don't support subaddresses. - */ -#if 0 -int ctdl_getsubaddress(sieve2_context_t *s, void *my) -{ - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - - /* libSieve does not take ownership of the memory used here. But, since we - * are just pointing to locations inside a struct which we are going to free - * later, we're ok. - */ - sieve2_setvalue_string(s, "user", cs->recp_user); - sieve2_setvalue_string(s, "detail", ""); - sieve2_setvalue_string(s, "localpart", cs->recp_user); - sieve2_setvalue_string(s, "domain", cs->recp_node); - return SIEVE2_OK; -} -#endif - - /* * Callback function to parse message envelope */ @@ -393,8 +323,9 @@ int ctdl_getenvelope(sieve2_context_t *s, void *my) { struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - CtdlLogPrintf(CTDL_DEBUG, "Action is GETENVELOPE\nEnvFrom: %s\n EnvTo: %s\n", - cs->envelope_from, cs->envelope_to); + 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] != '@')) { @@ -425,17 +356,6 @@ int ctdl_getenvelope(sieve2_context_t *s, void *my) } -/* - * Callback function to fetch message body - * (Uncomment the code if we implement this extension) - * -int ctdl_getbody(sieve2_context_t *s, void *my) -{ - return SIEVE2_ERROR_UNSUPPORTED; -} - * - */ - /* * Callback function to fetch message size @@ -457,24 +377,40 @@ int ctdl_getsize(sieve2_context_t *s, void *my) /* - * Callback function to retrieve the sieve script + * Return a pointer to the active Sieve script. + * (Caller does NOT own the memory and should not free the returned pointer.) */ -int ctdl_getscript(sieve2_context_t *s, void *my) { +char *get_active_script(struct sdm_userdata *u) { struct sdm_script *sptr; - struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) { + for (sptr=u->first_script; sptr!=NULL; sptr=sptr->next) { if (sptr->script_active > 0) { - CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name); - sieve2_setvalue_string(s, "script", sptr->script_content); - return SIEVE2_OK; + syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name); + return(sptr->script_content); } } - - CtdlLogPrintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n"); + + 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 */ @@ -482,32 +418,13 @@ int ctdl_getheaders(sieve2_context_t *s, void *my) { struct ctdl_sieve *cs = (struct ctdl_sieve *)my; - CtdlLogPrintf(CTDL_DEBUG, "ctdl_getheaders() was called\n"); + syslog(LOG_DEBUG, "ctdl_getheaders() was called"); sieve2_setvalue_string(s, "allheaders", cs->rfc822headers); return SIEVE2_OK; } -/* - * Add a room to the list of those rooms which potentially require sieve processing - */ -void sieve_queue_room(struct ctdlroom *which_room) { - struct RoomProcList *ptr; - - ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList)); - if (ptr == NULL) return; - - safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name); - begin_critical_section(S_SIEVELIST); - ptr->next = sieve_list; - sieve_list = ptr; - end_critical_section(S_SIEVELIST); - CtdlLogPrintf(CTDL_DEBUG, "<%s> queued for Sieve processing\n", which_room->QRname); -} - - - /* * Perform sieve processing for one message (called by sieve_do_room() for each message) */ @@ -521,20 +438,19 @@ void sieve_do_msg(long msgnum, void *userdata) { size_t headers_len = 0; int len = 0; - if (u == NULL) - { - CtdlLogPrintf(CTDL_EMERG, "Can't process message <%ld> without userdata!\n", msgnum); + if (u == NULL) { + syslog(LOG_ERR, "Can't process message <%ld> without userdata!", msgnum); return; } sieve2_context = u->sieve2_context; - CtdlLogPrintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum); + 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); + msg = CtdlFetchMessage(msgnum, 1, 1); if (msg == NULL) return; /* @@ -564,37 +480,34 @@ void sieve_do_msg(long msgnum, void *userdata) { 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['R'], my.recp_user, my.recp_node, my.recp_name); + 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 (msg->cm_fields['F'] != NULL) { - safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender); + if (!CM_IsEmpty(msg, erFc822Addr)) { + safestrncpy(my.sender, msg->cm_fields[erFc822Addr], sizeof my.sender); } - else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) { - snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']); - } - else if (msg->cm_fields['A'] != NULL) { - safestrncpy(my.sender, msg->cm_fields['A'], 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 (msg->cm_fields['U'] != NULL) { - safestrncpy(my.subject, msg->cm_fields['U'], sizeof my.subject); + 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 (msg->cm_fields['P'] != NULL) { - safestrncpy(my.envelope_from, msg->cm_fields['P'], sizeof my.envelope_from); + if (!CM_IsEmpty(msg, eMessagePath)) { + safestrncpy(my.envelope_from, msg->cm_fields[eMessagePath], sizeof my.envelope_from); stripallbut(my.envelope_from, '<', '>'); } - else if (msg->cm_fields['F'] != NULL) { - safestrncpy(my.envelope_from, msg->cm_fields['F'], sizeof 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 { @@ -607,20 +520,16 @@ void sieve_do_msg(long msgnum, void *userdata) { } if (haschar(my.envelope_from, '@') == 0) { strcat(my.envelope_from, "@"); - strcat(my.envelope_from, config.c_fqdn); + strcat(my.envelope_from, CtdlGetConfigStr("c_fqdn")); } /* Keep track of the envelope-to address (use body-to if not found) */ - if (msg->cm_fields['V'] != NULL) { - safestrncpy(my.envelope_to, msg->cm_fields['V'], sizeof my.envelope_to); + if (!CM_IsEmpty(msg, eenVelopeTo)) { + safestrncpy(my.envelope_to, msg->cm_fields[eenVelopeTo], sizeof my.envelope_to); stripallbut(my.envelope_to, '<', '>'); } - else if (msg->cm_fields['R'] != NULL) { - safestrncpy(my.envelope_to, msg->cm_fields['R'], sizeof my.envelope_to); - if (msg->cm_fields['D'] != NULL) { - strcat(my.envelope_to, "@"); - strcat(my.envelope_to, msg->cm_fields['D']); - } + else if (!CM_IsEmpty(msg, eRecipient)) { + safestrncpy(my.envelope_to, msg->cm_fields[eRecipient], sizeof my.envelope_to); stripallbut(my.envelope_to, '<', '>'); } else { @@ -633,17 +542,15 @@ void sieve_do_msg(long msgnum, void *userdata) { } if (haschar(my.envelope_to, '@') == 0) { strcat(my.envelope_to, "@"); - strcat(my.envelope_to, config.c_fqdn); + strcat(my.envelope_to, CtdlGetConfigStr("c_fqdn")); } - CtdlFreeMessage(msg); - - sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers); + CM_Free(msg); - CtdlLogPrintf(CTDL_DEBUG, "Calling sieve2_execute()\n"); + syslog(LOG_DEBUG, "Calling sieve2_execute()"); res = sieve2_execute(sieve2_context, &my); if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res)); + syslog(LOG_ERR, "sieve2_execute() returned %d: %s", res, sieve2_errstr(res)); } free(my.rfc822headers); @@ -654,11 +561,11 @@ void sieve_do_msg(long msgnum, void *userdata) { * if no other action was successfully taken. */ if ( (!my.keep) && (my.cancel_implicit_keep) ) { - CtdlLogPrintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n"); + syslog(LOG_DEBUG, "keep is 0 -- deleting message from inbox"); CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, ""); } - CtdlLogPrintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum); + syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum); u->lastproc = msgnum; return; @@ -729,17 +636,18 @@ 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); + msg = CtdlFetchMessage(msgnum, 1, 1); if (msg == NULL) { u->config_msgnum = (-1) ; return; } - conf = msg->cm_fields['M']; - msg->cm_fields['M'] = NULL; - CtdlFreeMessage(msg); + CM_GetAsField(msg, eMesageText, &conf, &conflen); + + CM_Free(msg); if (conf != NULL) { parse_sieve_config(conf, u); @@ -838,14 +746,6 @@ sieve2_callback_t ctdl_sieve_callbacks[] = { { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders }, { SIEVE2_MESSAGE_GETSIZE, ctdl_getsize }, { SIEVE2_MESSAGE_GETENVELOPE, ctdl_getenvelope }, -/* - * These actions are unsupported by Citadel so we don't declare them. - * - { SIEVE2_ACTION_NOTIFY, ctdl_notify }, - { SIEVE2_MESSAGE_GETSUBADDRESS, ctdl_getsubaddress }, - { SIEVE2_MESSAGE_GETBODY, ctdl_getbody }, - * - */ { 0 } }; @@ -867,7 +767,7 @@ void sieve_do_room(char *roomname) { */ snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM); if (CtdlGetRoom(&CC->room, u.config_roomname) != 0) { - CtdlLogPrintf(CTDL_DEBUG, "<%s> does not exist. No processing is required.\n", u.config_roomname); + syslog(LOG_DEBUG, "<%s> does not exist. No processing is required.", u.config_roomname); return; } @@ -875,18 +775,29 @@ void sieve_do_room(char *roomname) { * 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 ); + CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, get_sieve_config_backend, (void *)&u ); if (u.config_msgnum < 0) { - CtdlLogPrintf(CTDL_DEBUG, "No Sieve rules exist. No processing is required.\n"); + syslog(LOG_DEBUG, "No Sieve rules exist. No processing is required."); return; } - CtdlLogPrintf(CTDL_DEBUG, "Rules found. Performing Sieve processing for <%s>\n", roomname); + /* + * 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) { - CtdlLogPrintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname); + syslog(LOG_ERR, "ERROR: cannot load <%s>", roomname); return; } @@ -894,418 +805,154 @@ void sieve_do_room(char *roomname) { res = sieve2_alloc(&sieve2_context); if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res)); + 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) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res)); + 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" slong */ + 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) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res)); + 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 - ); + CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL, sieve_do_msg, (void *) &u); BAIL: res = sieve2_free(&sieve2_context); if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res)); + syslog(LOG_ERR, "sieve2_free() returned %d: %s", res, sieve2_errstr(res)); } - /* Rewrite the config if we have to */ + /* Rewrite the config if we have to (we're not the user right now) */ rewrite_ctdl_sieve_config(&u, (u.lastproc > orig_lastproc) ) ; } -/* - * Perform sieve processing for all rooms which require it - */ -void perform_sieve_processing(void) { - struct RoomProcList *ptr = NULL; - - if (sieve_list != NULL) { - CtdlLogPrintf(CTDL_DEBUG, "Begin Sieve processing\n"); - while (sieve_list != NULL) { - char spoolroomname[ROOMNAMELEN]; - safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname); - begin_critical_section(S_SIEVELIST); - - /* pop this record off the list */ - ptr = sieve_list; - sieve_list = sieve_list->next; - free(ptr); - - /* invalidate any duplicate entries to prevent double processing */ - for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) { - if (!strcasecmp(ptr->name, spoolroomname)) { - ptr->name[0] = 0; - } - } - - end_critical_section(S_SIEVELIST); - if (spoolroomname[0] != 0) { - sieve_do_room(spoolroomname); - } - } - } -} - - -void msiv_load(struct sdm_userdata *u) { - char hold_rm[ROOMNAMELEN]; - - strcpy(hold_rm, CC->room.QRname); /* save current room */ - - /* Take a spin through the user's personal address book */ - if (CtdlGetRoom(&CC->room, USERCONFIGROOM) == 0) { - - u->config_msgnum = (-1); - strcpy(u->config_roomname, CC->room.QRname); - CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, - get_sieve_config_backend, (void *)u ); - - } - if (strcmp(CC->room.QRname, hold_rm)) { - CtdlGetRoom(&CC->room, hold_rm); /* return to saved room */ - } -} -void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) { -/* - * Initialise the sieve configs last processed message number. - * We don't need to get the highest message number for the users inbox since the systems - * highest message number will be higher than that and loer than this scripts message number - * This prevents this new script from processing any old messages in the inbox. - * Most importantly it will prevent vacation messages being sent to lots of old messages - * in the inbox. - */ - u->lastproc = CtdlGetCurrentMessageNumber(); - rewrite_ctdl_sieve_config(u, yes_write_to_disk); -} - - -/* - * Select the active script. - * (Set script_name to an empty string to disable all scripts) - * - * Returns 0 on success or nonzero for error. - */ -int msiv_setactive(struct sdm_userdata *u, char *script_name) { - int ok = 0; - struct sdm_script *s; - - /* First see if the supplied value is ok */ - - if (IsEmptyStr(script_name)) { - ok = 1; - } - else { - for (s=u->first_script; s!=NULL; s=s->next) { - if (!strcasecmp(s->script_name, script_name)) { - ok = 1; - } - } - } - - if (!ok) return(-1); - - /* Now set the active script */ - for (s=u->first_script; s!=NULL; s=s->next) { - if (!strcasecmp(s->script_name, script_name)) { - s->script_active = 1; - } - else { - s->script_active = 0; - } - } - - return(0); -} - - -/* - * Fetch a script by name. - * - * Returns NULL if the named script was not found, or a pointer to the script - * if it was found. NOTE: the caller does *not* own the memory returned by - * this function. Copy it if you need to keep it. - */ -char *msiv_getscript(struct sdm_userdata *u, char *script_name) { - struct sdm_script *s; +#endif - for (s=u->first_script; s!=NULL; s=s->next) { - if (!strcasecmp(s->script_name, script_name)) { - if (s->script_content != NULL) { - return (s->script_content); - } - } - } - return(NULL); -} /* - * Delete a script by name. + * Get InBox Rules * - * Returns 0 if the script was deleted. - * 1 if the script was not found. - * 2 if the script cannot be deleted because it is active. + * This is a client-facing function which fetches the user's inbox rules -- it omits all lines containing anything other than a rule. */ -int msiv_deletescript(struct sdm_userdata *u, char *script_name) { - struct sdm_script *s = NULL; - struct sdm_script *script_to_delete = NULL; - - for (s=u->first_script; s!=NULL; s=s->next) { - if (!strcasecmp(s->script_name, script_name)) { - script_to_delete = s; - if (s->script_active) { - return(2); - } - } - } +void cmd_gibr(char *argbuf) { - if (script_to_delete == NULL) return(1); + if (CtdlAccessCheck(ac_logged_in)) return; - if (u->first_script == script_to_delete) { - u->first_script = u->first_script->next; - } - else for (s=u->first_script; s!=NULL; s=s->next) { - if (s->next == script_to_delete) { - s->next = s->next->next; - } - } + cprintf("%d inbox rules for %s\n", LISTING_FOLLOWS, CC->user.fullname); - free(script_to_delete->script_content); - free(script_to_delete); - return(0); -} + 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]); + } -/* - * Add or replace a new script. - * NOTE: after this function returns, "u" owns the memory that "script_content" - * was pointing to. - */ -void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) { - int replaced = 0; - struct sdm_script *s, *sptr; - - for (s=u->first_script; s!=NULL; s=s->next) { - if (!strcasecmp(s->script_name, script_name)) { - if (s->script_content != NULL) { - free(s->script_content); + // Output only lines containing rules. + if (!strncasecmp(token, "rule|", 5)) { + cprintf("%s\n", token); + } } - s->script_content = script_content; - replaced = 1; } + CM_Free(msg); } - - if (replaced == 0) { - sptr = malloc(sizeof(struct sdm_script)); - safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name); - sptr->script_content = script_content; - sptr->script_active = 0; - sptr->next = u->first_script; - u->first_script = sptr; - } + cprintf("000\n"); } - /* - * Citadel protocol to manage sieve scripts. - * This is basically a simplified (read: doesn't resemble IMAP) version - * of the 'managesieve' protocol. + * 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_msiv(char *argbuf) { - char subcmd[256]; - struct sdm_userdata u; - char script_name[256]; - char *script_content = NULL; - struct sdm_script *s; - int i; - int changes_made = 0; - - memset(&u, 0, sizeof(struct sdm_userdata)); - +void cmd_pibr(char *argbuf) { if (CtdlAccessCheck(ac_logged_in)) return; - extract_token(subcmd, argbuf, 0, '|', sizeof subcmd); - msiv_load(&u); - - if (!strcasecmp(subcmd, "putscript")) { - extract_token(script_name, argbuf, 1, '|', sizeof script_name); - if (!IsEmptyStr(script_name)) { - cprintf("%d Transmit script now\n", SEND_LISTING); - script_content = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0); - msiv_putscript(&u, script_name, script_content); - changes_made = 1; - } - else { - cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE); - } - } - - else if (!strcasecmp(subcmd, "listscripts")) { - cprintf("%d Scripts:\n", LISTING_FOLLOWS); - for (s=u.first_script; s!=NULL; s=s->next) { - if (s->script_content != NULL) { - cprintf("%s|%d|\n", s->script_name, s->script_active); - } - } - cprintf("000\n"); - } - - else if (!strcasecmp(subcmd, "setactive")) { - extract_token(script_name, argbuf, 1, '|', sizeof script_name); - if (msiv_setactive(&u, script_name) == 0) { - cprintf("%d ok\n", CIT_OK); - changes_made = 1; - } - else { - cprintf("%d Script '%s' does not exist.\n", - ERROR + ILLEGAL_VALUE, - script_name - ); - } - } - else if (!strcasecmp(subcmd, "getscript")) { - extract_token(script_name, argbuf, 1, '|', sizeof script_name); - script_content = msiv_getscript(&u, script_name); - if (script_content != NULL) { - int script_len; - - cprintf("%d Script:\n", LISTING_FOLLOWS); - script_len = strlen(script_content); - client_write(script_content, script_len); - if (script_content[script_len-1] != '\n') { - cprintf("\n"); + 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); + } } - cprintf("000\n"); - } - else { - cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE); - } - } - - else if (!strcasecmp(subcmd, "deletescript")) { - extract_token(script_name, argbuf, 1, '|', sizeof script_name); - i = msiv_deletescript(&u, script_name); - if (i == 0) { - cprintf("%d ok\n", CIT_OK); - changes_made = 1; - } - else if (i == 1) { - cprintf("%d Script '%s' does not exist.\n", - ERROR + ILLEGAL_VALUE, - script_name - ); - } - else if (i == 2) { - cprintf("%d Script '%s' is active and cannot be deleted.\n", - ERROR + ILLEGAL_VALUE, - script_name - ); - } - else { - cprintf("%d unknown error\n", ERROR); } + CM_Free(msg); } - else { - cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED); + /* 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, ""); } - - msiv_store(&u, changes_made); } - -void ctdl_sieve_init(void) { - char *cred = NULL; - sieve2_context_t *sieve2_context = NULL; - int res; - - /* - * We don't really care about dumping the entire credits to the log - * every time the server is initialized. The documentation will suffice - * for that purpose. We are making a call to sieve2_credits() in order - * to demonstrate that we have successfully linked in to libsieve. - */ - cred = strdup(sieve2_credits()); - if (cred == NULL) return; - - if (strlen(cred) > 60) { - strcpy(&cred[55], "..."); - } - - CtdlLogPrintf(CTDL_INFO, "%s\n",cred); - free(cred); - - /* Briefly initialize a Sieve parser instance just so we can list the - * extensions that are available. - */ - res = sieve2_alloc(&sieve2_context); - if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res)); - return; - } - - res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks); - if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res)); - goto BAIL; - } - - msiv_extensions = strdup(sieve2_listextensions(sieve2_context)); - CtdlLogPrintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions); - -BAIL: res = sieve2_free(&sieve2_context); - if (res != SIEVE2_OK) { - CtdlLogPrintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res)); - } - -} - -int serv_sieve_room(struct ctdlroom *room) -{ - if (!strcasecmp(&room->QRname[11], MAILROOM)) { - sieve_queue_room(room); - } - return 0; -} - CTDL_MODULE_INIT(sieve) { if (!threading) { - - ctdl_sieve_init(); - CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts"); - CtdlRegisterRoomHook(serv_sieve_room); - CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE); + // 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 Subversion id for the Log */ - return "$Id$"; + /* return our module name for the log */ + return "sieve"; } -