/*
- * $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
*
- * This code is released under the terms of the GNU General Public License.
+ * 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 <sys/wait.h>
#include <string.h>
#include <limits.h>
+#include <libcitadel.h>
#include "citadel.h"
#include "server.h"
#include "citserver.h"
#include "support.h"
#include "config.h"
-#include "room_ops.h"
-#include "policy.h"
#include "database.h"
#include "msgbase.h"
#include "internet_addressing.h"
-#include "tools.h"
-
-
#include "ctdl_module.h"
-#ifdef HAVE_LIBSIEVE
-
-#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)
-{
- lprintf(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)
-{
- lprintf(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)
-{
- lprintf(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);
- lprintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
+ syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>", recp);
- valid = validate_recipients(recp);
+ valid = validate_recipients(recp, NULL, 0);
if (valid == NULL) {
- lprintf(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) {
- lprintf(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) {
- lprintf(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;
}
- CtdlSubmitMsg(msg, valid, NULL);
+ CtdlSubmitMsg(msg, valid, NULL, 0);
cs->cancel_implicit_keep = 1;
free_recipients(valid);
- CtdlFreeMessage(msg);
+ CM_Free(msg);
return SIEVE2_OK;
}
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- lprintf(CTDL_DEBUG, "Action is KEEP\n");
+ syslog(LOG_DEBUG, "Action is KEEP");
cs->keep = 1;
cs->cancel_implicit_keep = 1;
char foldername[256];
char original_room_name[ROOMNAMELEN];
- lprintf(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)) ) {
/* First try a mailbox name match (check personal mail folders first) */
snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
- c = getroom(&CC->room, foldername);
+ 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 = getroom(&CC->room, foldername);
+ c = CtdlGetRoom(&CC->room, foldername);
}
if (c != 0) {
- lprintf(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 */
- usergoto(NULL, 0, 0, NULL, NULL);
+ CtdlUserGoto(NULL, 0, 0, NULL, NULL, NULL, NULL);
- c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, 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)) {
- usergoto(original_room_name, 0, 0, NULL, NULL);
+ CtdlUserGoto(original_room_name, 0, 0, NULL, NULL, NULL, NULL);
}
if (c == 0) {
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- lprintf(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;
}
-
/*
* Callback function to indicate that a message should be rejected
*/
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
char *reject_text = NULL;
- lprintf(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)) {
- lprintf(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);
}
}
-
/*
* Callback function to indicate that a vacation message should be generated
*/
char *vacamsg_text = NULL;
char vacamsg_subject[1024];
- lprintf(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;
for (vptr = cs->u->first_vacation; vptr != NULL; vptr = vptr->next) {
if (!strcasecmp(vptr->fromaddr, cs->sender)) {
if ( (time(NULL) - vptr->timestamp) < (days * 86400) ) {
- lprintf(CTDL_DEBUG, "Already alerted <%s> recently.\n", cs->sender);
+ syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender);
return SIEVE2_OK;
}
}
}
sprintf(vacamsg_text,
- "Content-type: text/plain\n"
+ "Content-type: text/plain charset=utf-8\n"
"\n"
"%s\n"
"\n"
/* 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;
}
-/*
- * 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
*/
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- lprintf(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] != '@')) {
}
-/*
- * 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
/*
- * 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) {
- lprintf(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);
}
}
-
- lprintf(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
*/
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- lprintf(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);
- lprintf(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)
*/
void sieve_do_msg(long msgnum, void *userdata) {
struct sdm_userdata *u = (struct sdm_userdata *) userdata;
- sieve2_context_t *sieve2_context = u->sieve2_context;
+ sieve2_context_t *sieve2_context;
struct ctdl_sieve my;
int res;
struct CtdlMessage *msg;
size_t headers_len = 0;
int len = 0;
- if (userdata == NULL)
- {
- lprintf(CTDL_EMERG, "Cant process Message <%ld>without Userdata!\n", msgnum);
+ if (u == NULL) {
+ syslog(LOG_ERR, "Can't process message <%ld> without userdata!", msgnum);
return;
}
- lprintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
+ sieve2_context = u->sieve2_context;
+
+ syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum);
- msg = CtdlFetchMessage(msgnum, 0);
+ /*
+ * 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 = malloc(SIZ);
- CC->redirect_len = 0;
- CC->redirect_alloc = SIZ;
- CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
- my.rfc822headers = CC->redirect_buffer;
- headers_len = CC->redirect_len;
- CC->redirect_buffer = NULL;
- CC->redirect_len = 0;
- CC->redirect_alloc = 0;
+ 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
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 {
}
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 {
}
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);
- lprintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
+ syslog(LOG_DEBUG, "Calling sieve2_execute()");
res = sieve2_execute(sieve2_context, &my);
if (res != SIEVE2_OK) {
- lprintf(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);
* if no other action was successfully taken.
*/
if ( (!my.keep) && (my.cancel_implicit_keep) ) {
- lprintf(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, "");
}
- lprintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
+ syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>", msgnum);
u->lastproc = msgnum;
return;
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);
* otherwise it just frees the data structures.)
*/
void rewrite_ctdl_sieve_config(struct sdm_userdata *u, int yes_write_to_disk) {
- char *text;
+ StrBuf *text;
struct sdm_script *sptr;
struct sdm_vacation *vptr;
- size_t tsize;
-
- text = malloc(1024);
- tsize = 1024;
- snprintf(text, 1024,
- "Content-type: application/x-citadel-sieve-config\n"
- "\n"
- CTDLSIEVECONFIGSEPARATOR
- "lastproc|%ld"
- CTDLSIEVECONFIGSEPARATOR
- ,
- u->lastproc
- );
+
+ 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) {
- size_t tlen;
- tlen = strlen(text);
- tsize = tlen + strlen(u->first_script->script_content) +256;
- text = realloc(text, tsize);
- sprintf(&text[strlen(text)], "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
- u->first_script->script_name,
- u->first_script->script_active,
- u->first_script->script_content
- );
+ 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);
if (u->first_vacation != NULL) {
- tsize = strlen(text) + 256;
- for (vptr = u->first_vacation; vptr != NULL; vptr = vptr->next) {
- tsize += strlen(vptr->fromaddr + 32);
- }
- text = realloc(text, tsize);
-
- sprintf(&text[strlen(text)], "vacation|\n");
+ StrBufAppendPrintf(text, "vacation|\n");
while (u->first_vacation != NULL) {
if ( (time(NULL) - u->first_vacation->timestamp) < (MAX_VACATION * 86400)) {
- sprintf(&text[strlen(text)], "%s|%ld\n",
- u->first_vacation->fromaddr,
- u->first_vacation->timestamp
- );
+ 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);
}
- sprintf(&text[strlen(text)], CTDLSIEVECONFIGSEPARATOR);
+ StrBufAppendPrintf(text, CTDLSIEVECONFIGSEPARATOR);
}
if (yes_write_to_disk)
{
/* Save the config */
quickie_message("Citadel", NULL, NULL, u->config_roomname,
- text,
+ ChrPtr(text),
4,
"Sieve configuration"
);
}
}
- free (text);
+ FreeStrBuf (&text);
}
{ 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 }
};
* require execution.
*/
snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), USERCONFIGROOM);
- if (getroom(&CC->room, u.config_roomname) != 0) {
- lprintf(CTDL_DEBUG, "<%s> does not exist. No processing is required.\n", u.config_roomname);
+ 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 );
+ CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, get_sieve_config_backend, (void *)&u );
if (u.config_msgnum < 0) {
- lprintf(CTDL_DEBUG, "No Sieve rules exist. No processing is required.\n");
+ 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;
}
- lprintf(CTDL_DEBUG, "Rules found. Performing Sieve processing for <%s>\n", roomname);
+ syslog(LOG_DEBUG, "Rules found. Performing Sieve processing for <%s>", roomname);
- if (getroom(&CC->room, roomname) != 0) {
- lprintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
+ if (CtdlGetRoom(&CC->room, roomname) != 0) {
+ syslog(LOG_ERR, "ERROR: cannot load <%s>", roomname);
return;
}
res = sieve2_alloc(&sieve2_context);
if (res != SIEVE2_OK) {
- lprintf(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) {
- lprintf(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) {
- lprintf(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) {
- lprintf(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) {
- lprintf(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 (getroom(&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)) {
- getroom(&CC->room, hold_rm); /* return to saved room */
- }
-}
-
-void msiv_store(struct sdm_userdata *u, int yes_write_to_disk) {
- 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;
- }
- }
- }
+#endif
- 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.
+ * Get InBox Rules
*
- * 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.
+ * This is a client-facing function which fetches the user's inbox rules -- it omits all lines containing anything other than a rule.
*/
-char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
- struct sdm_script *s;
-
- 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);
-}
-
+void cmd_gibr(char *argbuf) {
-/*
- * Delete a script by name.
- *
- * 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.
- */
-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);
- }
- }
- }
-
- 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("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);
}
+ CM_Free(msg);
}
- 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);
- }
- }
-
- else {
- cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
- }
-
- 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], "...");
- }
-
- lprintf(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) {
- lprintf(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) {
- lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
- goto BAIL;
- }
-
- msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
- lprintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
-
-BAIL: res = sieve2_free(&sieve2_context);
- if (res != SIEVE2_OK) {
- lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
+ /* 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, "");
}
-
}
-int serv_sieve_room(struct ctdlroom *room)
-{
- if (!strcasecmp(&room->QRname[11], MAILROOM)) {
- sieve_queue_room(room);
- }
- return 0;
-}
-
-#endif /* HAVE_LIBSIEVE */
CTDL_MODULE_INIT(sieve)
{
-
-#ifdef HAVE_LIBSIEVE
-
- ctdl_sieve_init();
- CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
-
- CtdlRegisterRoomHook(serv_sieve_room);
-
- CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
-
-#else /* HAVE_LIBSIEVE */
-
- lprintf(CTDL_INFO, "This server is missing libsieve. Mailbox filtering will be disabled.\n");
-
-#endif /* HAVE_LIBSIEVE */
-
- /* return our Subversion id for the Log */
- return "$Id$";
+ 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";
}
-
projects / citadel.git / blobdiff