* This module glues libSieve to the Citadel server in order to implement
* the Sieve mailbox filtering language (RFC 3028).
*
- * Copyright (c) 1987-2010 by the citadel.org team
+ * Copyright (c) 1987-2012 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"
struct RoomProcList *sieve_list = NULL;
char *msiv_extensions = NULL;
+int SieveDebugEnable = 0;
+
+#define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (SieveDebugEnable != 0))
+
+#define SV_syslog(LEVEL, FORMAT, ...) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "Sieve: " FORMAT, __VA_ARGS__)
+
+#define SVM_syslog(LEVEL, FORMAT) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "Sieve: " FORMAT);
/*
*/
int ctdl_debug(sieve2_context_t *s, void *my)
{
- syslog(LOG_DEBUG, "Sieve: %s\n", sieve2_getvalue_string(s, "message"));
+ SV_syslog(LOG_DEBUG, "%s", sieve2_getvalue_string(s, "message"));
return SIEVE2_OK;
}
*/
int ctdl_errparse(sieve2_context_t *s, void *my)
{
- syslog(LOG_WARNING, "Error in script, line %d: %s\n",
- sieve2_getvalue_int(s, "lineno"),
- sieve2_getvalue_string(s, "message")
+ SV_syslog(LOG_WARNING, "Error in script, line %d: %s",
+ sieve2_getvalue_int(s, "lineno"),
+ sieve2_getvalue_string(s, "message")
);
return SIEVE2_OK;
}
*/
int ctdl_errexec(sieve2_context_t *s, void *my)
{
- syslog(LOG_WARNING, "Error executing script: %s\n",
- sieve2_getvalue_string(s, "message")
- );
+ SV_syslog(LOG_WARNING, "Error executing script: %s",
+ sieve2_getvalue_string(s, "message")
+ );
return SIEVE2_OK;
}
safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
- syslog(LOG_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
+ SV_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>\n", recp);
+ SV_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>\n", recp);
+ SV_syslog(LOG_WARNING, "REDIRECT failed: bad recipient <%s>", recp);
free_recipients(valid);
return SIEVE2_ERROR_BADARGS;
}
msg = CtdlFetchMessage(cs->msgnum, 1);
if (msg == NULL) {
- syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
+ SV_syslog(LOG_WARNING, "REDIRECT failed: unable to fetch msg %ld", cs->msgnum);
free_recipients(valid);
return SIEVE2_ERROR_BADARGS;
}
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- syslog(LOG_DEBUG, "Action is KEEP\n");
+ SVM_syslog(LOG_DEBUG, "Action is KEEP");
cs->keep = 1;
cs->cancel_implicit_keep = 1;
char foldername[256];
char original_room_name[ROOMNAMELEN];
- syslog(LOG_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
+ SV_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)) ) {
}
if (c != 0) {
- syslog(LOG_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
+ SV_syslog(LOG_WARNING, "FILEINTO failed: target <%s> does not exist", dest_folder);
return SIEVE2_ERROR_BADARGS;
}
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- syslog(LOG_DEBUG, "Action is DISCARD\n");
+ SVM_syslog(LOG_DEBUG, "Action is DISCARD");
/* Cancel the implicit keep. That's all there is to it. */
cs->cancel_implicit_keep = 1;
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
char *reject_text = NULL;
- syslog(LOG_DEBUG, "Action is REJECT\n");
+ SVM_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.\n");
+ SVM_syslog(LOG_INFO, "Unknown sender. Doing DISCARD instead of REJECT.");
return ctdl_discard(s, my);
}
char *vacamsg_text = NULL;
char vacamsg_subject[1024];
- syslog(LOG_DEBUG, "Action is VACATION\n");
+ SVM_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) ) {
- syslog(LOG_DEBUG, "Already alerted <%s> recently.\n", cs->sender);
+ SV_syslog(LOG_DEBUG, "Already alerted <%s> recently.", cs->sender);
return SIEVE2_OK;
}
}
{
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- syslog(LOG_DEBUG, "Action is GETENVELOPE\nEnvFrom: %s\n EnvTo: %s\n",
- cs->envelope_from, cs->envelope_to);
+ SVM_syslog(LOG_DEBUG, "Action is GETENVELOPE");
+ SV_syslog(LOG_DEBUG, "EnvFrom: %s", cs->envelope_from);
+ SV_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 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) {
- syslog(LOG_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
- sieve2_setvalue_string(s, "script", sptr->script_content);
- return SIEVE2_OK;
+ SV_syslog(LOG_DEBUG, "get_active_script() is using script '%s'", sptr->script_name);
+ return(sptr->script_content);
}
}
-
- syslog(LOG_DEBUG, "ctdl_getscript() found no active script\n");
+
+ SVM_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;
}
struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
- syslog(LOG_DEBUG, "ctdl_getheaders() was called\n");
+ SVM_syslog(LOG_DEBUG, "ctdl_getheaders() was called");
sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
return SIEVE2_OK;
}
ptr->next = sieve_list;
sieve_list = ptr;
end_critical_section(S_SIEVELIST);
- syslog(LOG_DEBUG, "<%s> queued for Sieve processing\n", which_room->QRname);
+ SV_syslog(LOG_DEBUG, "<%s> queued for Sieve processing", which_room->QRname);
}
if (u == NULL)
{
- syslog(LOG_EMERG, "Can't process message <%ld> without userdata!\n", msgnum);
+ SV_syslog(LOG_EMERG, "Can't process message <%ld> without userdata!", msgnum);
return;
}
sieve2_context = u->sieve2_context;
- syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
+ SV_syslog(LOG_DEBUG, "Performing sieve processing on msg <%ld>", msgnum);
/*
* Make sure you include message body so you can get those second-level headers ;)
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 (msg->cm_fields[erFc822Addr] != NULL) {
+ 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[eAuthor] != NULL) && (msg->cm_fields[eNodeName] != NULL) ) {
+ snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields[eAuthor], msg->cm_fields[eNodeName]);
}
- else if (msg->cm_fields['A'] != NULL) {
- safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
+ else if (msg->cm_fields[eAuthor] != NULL) {
+ 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 (msg->cm_fields[eMsgSubject] != NULL) {
+ 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 (msg->cm_fields[eMessagePath] != NULL) {
+ 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 (msg->cm_fields[erFc822Addr] != NULL) {
+ safestrncpy(my.envelope_from, msg->cm_fields[erFc822Addr], sizeof my.envelope_from);
stripallbut(my.envelope_from, '<', '>');
}
else {
}
/* 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 (msg->cm_fields[eenVelopeTo] != NULL) {
+ 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) {
+ else if (msg->cm_fields[eRecipient] != NULL) {
+ safestrncpy(my.envelope_to, msg->cm_fields[eRecipient], sizeof my.envelope_to);
+ if (msg->cm_fields[eDestination] != NULL) {
strcat(my.envelope_to, "@");
- strcat(my.envelope_to, msg->cm_fields['D']);
+ strcat(my.envelope_to, msg->cm_fields[eDestination]);
}
stripallbut(my.envelope_to, '<', '>');
}
}
CtdlFreeMessage(msg);
-
- sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
- syslog(LOG_DEBUG, "Calling sieve2_execute()\n");
+ SVM_syslog(LOG_DEBUG, "Calling sieve2_execute()");
res = sieve2_execute(sieve2_context, &my);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "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) ) {
- syslog(LOG_DEBUG, "keep is 0 -- deleting message from inbox\n");
+ SVM_syslog(LOG_DEBUG, "keep is 0 -- deleting message from inbox");
CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");
}
- syslog(LOG_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
+ SV_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);
return;
}
- conf = msg->cm_fields['M'];
- msg->cm_fields['M'] = NULL;
+ CM_GetAsField(msg, eMesageText, &conf, &conflen);
+
CtdlFreeMessage(msg);
if (conf != NULL) {
*/
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.\n", u.config_roomname);
+ SV_syslog(LOG_DEBUG, "<%s> does not exist. No processing is required.", u.config_roomname);
return;
}
get_sieve_config_backend, (void *)&u );
if (u.config_msgnum < 0) {
- syslog(LOG_DEBUG, "No Sieve rules exist. No processing is required.\n");
+ SVM_syslog(LOG_DEBUG, "No Sieve rules exist. No processing is required.");
return;
}
- syslog(LOG_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)
+ ) {
+ SVM_syslog(LOG_DEBUG, "Sieve script is empty. No processing is required.");
+ return;
+ }
+
+ SV_syslog(LOG_DEBUG, "Rules found. Performing Sieve processing for <%s>", roomname);
if (CtdlGetRoom(&CC->room, roomname) != 0) {
- syslog(LOG_CRIT, "ERROR: cannot load <%s>\n", roomname);
+ SV_syslog(LOG_CRIT, "ERROR: cannot load <%s>", roomname);
return;
}
res = sieve2_alloc(&sieve2_context);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res));
return;
}
res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res));
goto BAIL;
}
my.u = &u;
res = sieve2_validate(sieve2_context, &my);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_validate() returned %d: %s", res, sieve2_errstr(res));
goto BAIL;
}
BAIL:
res = sieve2_free(&sieve2_context);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_free() returned %d: %s", res, sieve2_errstr(res));
}
/* Rewrite the config if we have to */
struct RoomProcList *ptr = NULL;
if (sieve_list != NULL) {
- syslog(LOG_DEBUG, "Begin Sieve processing\n");
+ SVM_syslog(LOG_DEBUG, "Begin Sieve processing");
while (sieve_list != NULL) {
char spoolroomname[ROOMNAMELEN];
safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
strcpy(&cred[55], "...");
}
- syslog(LOG_INFO, "%s\n",cred);
+ SV_syslog(LOG_INFO, "%s",cred);
free(cred);
/* Briefly initialize a Sieve parser instance just so we can list the
*/
res = sieve2_alloc(&sieve2_context);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_alloc() returned %d: %s", res, sieve2_errstr(res));
return;
}
res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_callbacks() returned %d: %s", res, sieve2_errstr(res));
goto BAIL;
}
msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
- syslog(LOG_INFO, "Extensions: %s\n", msiv_extensions);
+ SV_syslog(LOG_INFO, "Extensions: %s", msiv_extensions);
BAIL: res = sieve2_free(&sieve2_context);
if (res != SIEVE2_OK) {
- syslog(LOG_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
+ SV_syslog(LOG_CRIT, "sieve2_free() returned %d: %s", res, sieve2_errstr(res));
}
}
return 0;
}
+void LogSieveDebugEnable(const int n)
+{
+ SieveDebugEnable = n;
+}
CTDL_MODULE_INIT(sieve)
{
if (!threading)
{
-
+ CtdlRegisterDebugFlagHook(HKEY("sieve"), LogSieveDebugEnable, &SieveDebugEnable);
ctdl_sieve_init();
CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
CtdlRegisterRoomHook(serv_sieve_room);
- CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE);
+ CtdlRegisterSessionHook(perform_sieve_processing, EVT_HOUSE, PRIO_HOUSE + 10);
CtdlRegisterCleanupHook(cleanup_sieve);
}
- /* return our Subversion id for the Log */
+ /* return our module name for the log */
return "sieve";
}