citadel/serv_sieve.c

   1 /*
   2  * $Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $
   3  *
   4  * This module glues libSieve to the Citadel server in order to implement
   5  * the Sieve mailbox filtering language (RFC 3028).
   6  *
   7  * This code is released under the terms of the GNU General Public License.
   8  */
   9
  10 #include "sysdep.h"
  11 #include <stdlib.h>
  12 #include <unistd.h>
  13 #include <stdio.h>
  14 #include <fcntl.h>
  15 #include <signal.h>
  16 #include <pwd.h>
  17 #include <errno.h>
  18 #include <sys/types.h>
  19
  20 #if TIME_WITH_SYS_TIME
  21 # include <sys/time.h>
  22 # include <time.h>
  23 #else
  24 # if HAVE_SYS_TIME_H
  25 #  include <sys/time.h>
  26 # else
  27 #  include <time.h>
  28 # endif
  29 #endif
  30
  31 #include <sys/wait.h>
  32 #include <string.h>
  33 #include <limits.h>
  34 #include "citadel.h"
  35 #include "server.h"
  36 #include "sysdep_decls.h"
  37 #include "citserver.h"
  38 #include "support.h"
  39 #include "config.h"
  40 #include "serv_extensions.h"
  41 #include "room_ops.h"
  42 #include "policy.h"
  43 #include "database.h"
  44 #include "msgbase.h"
  45 #include "internet_addressing.h"
  46 #include "tools.h"
  47
  48 #ifdef HAVE_LIBSIEVE
  49
  50 #include "serv_sieve.h"
  51
  52 struct RoomProcList *sieve_list = NULL;
  53 char *msiv_extensions = NULL;
  54
  55
  56 /*
  57  * Callback function to send libSieve trace messages to Citadel log facility
  58  * Set ctdl_libsieve_debug=1 to see extremely verbose libSieve trace
  59  */
  60 int ctdl_debug(sieve2_context_t *s, void *my)
  61 {
  62         static int ctdl_libsieve_debug = 0;
  63
  64         if (ctdl_libsieve_debug) {
  65                 lprintf(CTDL_DEBUG, "Sieve: level [%d] module [%s] file [%s] function [%s]\n",
  66                         sieve2_getvalue_int(s, "level"),
  67                         sieve2_getvalue_string(s, "module"),
  68                         sieve2_getvalue_string(s, "file"),
  69                         sieve2_getvalue_string(s, "function"));
  70                 lprintf(CTDL_DEBUG, "       message [%s]\n",
  71                         sieve2_getvalue_string(s, "message"));
  72         }
  73         return SIEVE2_OK;
  74 }
  75
  76
  77 /*
  78  * Callback function to log script parsing errors
  79  */
  80 int ctdl_errparse(sieve2_context_t *s, void *my)
  81 {
  82         lprintf(CTDL_WARNING, "Error in script, line %d: %s\n",
  83                 sieve2_getvalue_int(s, "lineno"),
  84                 sieve2_getvalue_string(s, "message")
  85         );
  86         return SIEVE2_OK;
  87 }
  88
  89
  90 /*
  91  * Callback function to log script execution errors
  92  */
  93 int ctdl_errexec(sieve2_context_t *s, void *my)
  94 {
  95         lprintf(CTDL_WARNING, "Error executing script: %s\n",
  96                 sieve2_getvalue_string(s, "message")
  97         );
  98         return SIEVE2_OK;
  99 }
 100
 101
 102 /*
 103  * Callback function to redirect a message to a different folder
 104  */
 105 int ctdl_redirect(sieve2_context_t *s, void *my)
 106 {
 107         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 108         struct CtdlMessage *msg = NULL;
 109         struct recptypes *valid = NULL;
 110         char recp[256];
 111
 112         safestrncpy(recp, sieve2_getvalue_string(s, "address"), sizeof recp);
 113
 114         lprintf(CTDL_DEBUG, "Action is REDIRECT, recipient <%s>\n", recp);
 115
 116         valid = validate_recipients(recp);
 117         if (valid == NULL) {
 118                 lprintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
 119                 return SIEVE2_ERROR_BADARGS;
 120         }
 121         if (valid->num_error > 0) {
 122                 lprintf(CTDL_WARNING, "REDIRECT failed: bad recipient <%s>\n", recp);
 123                 free(valid);
 124                 return SIEVE2_ERROR_BADARGS;
 125         }
 126
 127         msg = CtdlFetchMessage(cs->msgnum, 1);
 128         if (msg == NULL) {
 129                 lprintf(CTDL_WARNING, "REDIRECT failed: unable to fetch msg %ld\n", cs->msgnum);
 130                 free(valid);
 131                 return SIEVE2_ERROR_BADARGS;
 132         }
 133
 134         CtdlSubmitMsg(msg, valid, NULL);
 135         cs->cancel_implicit_keep = 1;
 136         free(valid);
 137         CtdlFreeMessage(msg);
 138         return SIEVE2_OK;
 139 }
 140
 141
 142 /*
 143  * Callback function to indicate that a message *will* be kept in the inbox
 144  */
 145 int ctdl_keep(sieve2_context_t *s, void *my)
 146 {
 147         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 148
 149         lprintf(CTDL_DEBUG, "Action is KEEP\n");
 150
 151         cs->keep = 1;
 152         cs->cancel_implicit_keep = 1;
 153         return SIEVE2_OK;
 154 }
 155
 156
 157 /*
 158  * Callback function to file a message into a different mailbox
 159  */
 160 int ctdl_fileinto(sieve2_context_t *s, void *my)
 161 {
 162         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 163         const char *dest_folder = sieve2_getvalue_string(s, "mailbox");
 164         int c;
 165         char foldername[256];
 166         char original_room_name[ROOMNAMELEN];
 167
 168         lprintf(CTDL_DEBUG, "Action is FILEINTO, destination is <%s>\n", dest_folder);
 169
 170         /* FILEINTO 'INBOX' is the same thing as KEEP */
 171         if ( (!strcasecmp(dest_folder, "INBOX")) || (!strcasecmp(dest_folder, MAILROOM)) ) {
 172                 cs->keep = 1;
 173                 cs->cancel_implicit_keep = 1;
 174                 return SIEVE2_OK;
 175         }
 176
 177         /* Remember what room we came from */
 178         safestrncpy(original_room_name, CC->room.QRname, sizeof original_room_name);
 179
 180         /* First try a mailbox name match (check personal mail folders first) */
 181         snprintf(foldername, sizeof foldername, "%010ld.%s", cs->usernum, dest_folder);
 182         c = getroom(&CC->room, foldername);
 183
 184         /* Then a regular room name match (public and private rooms) */
 185         if (c < 0) {
 186                 safestrncpy(foldername, dest_folder, sizeof foldername);
 187                 c = getroom(&CC->room, foldername);
 188         }
 189
 190         if (c < 0) {
 191                 lprintf(CTDL_WARNING, "FILEINTO failed: target <%s> does not exist\n", dest_folder);
 192                 return SIEVE2_ERROR_BADARGS;
 193         }
 194
 195         /* Yes, we actually have to go there */
 196         usergoto(NULL, 0, 0, NULL, NULL);
 197
 198         c = CtdlSaveMsgPointersInRoom(NULL, &cs->msgnum, 1, 0, NULL);
 199
 200         /* Go back to the room we came from */
 201         if (strcasecmp(original_room_name, CC->room.QRname)) {
 202                 usergoto(original_room_name, 0, 0, NULL, NULL);
 203         }
 204
 205         if (c == 0) {
 206                 cs->cancel_implicit_keep = 1;
 207                 return SIEVE2_OK;
 208         }
 209         else {
 210                 return SIEVE2_ERROR_BADARGS;
 211         }
 212 }
 213
 214
 215 /*
 216  * Callback function to indicate that a message should be discarded.
 217  */
 218 int ctdl_discard(sieve2_context_t *s, void *my)
 219 {
 220         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 221
 222         lprintf(CTDL_DEBUG, "Action is DISCARD\n");
 223
 224         /* Yes, this is really all there is to it.  Since we are not setting "keep" to 1,
 225          * the message will be discarded because "some other action" was successfully taken.
 226          */
 227         cs->cancel_implicit_keep = 1;
 228         return SIEVE2_OK;
 229 }
 230
 231
 232
 233 /*
 234  * Callback function to indicate that a message should be rejected
 235  */
 236 int ctdl_reject(sieve2_context_t *s, void *my)
 237 {
 238         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 239         char *reject_text = NULL;
 240
 241         lprintf(CTDL_DEBUG, "Action is REJECT\n");
 242
 243         /* If we don't know who sent the message, do a DISCARD instead. */
 244         if (strlen(cs->sender) == 0) {
 245                 lprintf(CTDL_INFO, "Unknown sender.  Doing DISCARD instead of REJECT.\n");
 246                 return ctdl_discard(s, my);
 247         }
 248
 249         /* Assemble the reject message. */
 250         reject_text = malloc(strlen(sieve2_getvalue_string(s, "message")) + 1024);
 251         if (reject_text == NULL) {
 252                 return SIEVE2_ERROR_FAIL;
 253         }
 254
 255         sprintf(reject_text,
 256                 "Content-type: text/plain\n"
 257                 "\n"
 258                 "The message was refused by the recipient's mail filtering program.\n"
 259                 "The reason given was as follows:\n"
 260                 "\n"
 261                 "%s\n"
 262                 "\n"
 263         ,
 264                 sieve2_getvalue_string(s, "message")
 265         );
 266
 267         quickie_message(        /* This delivers the message */
 268                 "Citadel",
 269                 cs->sender,
 270                 NULL,
 271                 reject_text,
 272                 FMT_RFC822,
 273                 "Delivery status notification"
 274         );
 275
 276         free(reject_text);
 277         cs->cancel_implicit_keep = 1;
 278         return SIEVE2_OK;
 279 }
 280
 281
 282
 283 /*
 284  * Callback function to indicate that a vacation message should be generated
 285  * FIXME implement this
 286  */
 287 int ctdl_vacation(sieve2_context_t *s, void *my)
 288 {
 289         lprintf(CTDL_DEBUG, "Action is VACATION\n");
 290         return SIEVE2_ERROR_UNSUPPORTED;
 291 }
 292
 293
 294 /*
 295  * Callback function to parse addresses per local system convention
 296  * It is disabled because we don't support subaddresses.
 297  */
 298 #if 0
 299 int ctdl_getsubaddress(sieve2_context_t *s, void *my)
 300 {
 301         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 302
 303         /* libSieve does not take ownership of the memory used here.  But, since we
 304          * are just pointing to locations inside a struct which we are going to free
 305          * later, we're ok.
 306          */
 307         sieve2_setvalue_string(s, "user", cs->recp_user);
 308         sieve2_setvalue_string(s, "detail", "");
 309         sieve2_setvalue_string(s, "localpart", cs->recp_user);
 310         sieve2_setvalue_string(s, "domain", cs->recp_node);
 311         return SIEVE2_OK;
 312 }
 313 #endif
 314
 315
 316 /*
 317  * Callback function to parse message envelope
 318  * FIXME implement this
 319  */
 320 int ctdl_getenvelope(sieve2_context_t *s, void *my)
 321 {
 322         return SIEVE2_ERROR_UNSUPPORTED;
 323 }
 324
 325
 326 /*
 327  * Callback function to fetch message body
 328  * FIXME implement this
 329  */
 330 int ctdl_getbody(sieve2_context_t *s, void *my)
 331 {
 332         return SIEVE2_ERROR_UNSUPPORTED;
 333 }
 334
 335
 336 /*
 337  * Callback function to fetch message size
 338  */
 339 int ctdl_getsize(sieve2_context_t *s, void *my)
 340 {
 341         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 342         struct MetaData smi;
 343
 344         GetMetaData(&smi, cs->msgnum);
 345
 346         if (smi.meta_rfc822_length > 0L) {
 347                 sieve2_setvalue_int(s, "size", (int)smi.meta_rfc822_length);
 348                 return SIEVE2_OK;
 349         }
 350
 351         return SIEVE2_ERROR_UNSUPPORTED;
 352 }
 353
 354
 355 /*
 356  * Callback function to retrieve the sieve script
 357  */
 358 int ctdl_getscript(sieve2_context_t *s, void *my) {
 359         struct sdm_script *sptr;
 360         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 361
 362         for (sptr=cs->u->first_script; sptr!=NULL; sptr=sptr->next) {
 363                 if (sptr->script_active > 0) {
 364                         lprintf(CTDL_DEBUG, "ctdl_getscript() is using script '%s'\n", sptr->script_name);
 365                         sieve2_setvalue_string(s, "script", sptr->script_content);
 366                         return SIEVE2_OK;
 367                 }
 368         }
 369
 370         lprintf(CTDL_DEBUG, "ctdl_getscript() found no active script\n");
 371         return SIEVE2_ERROR_GETSCRIPT;
 372 }
 373
 374 /*
 375  * Callback function to retrieve message headers
 376  */
 377 int ctdl_getheaders(sieve2_context_t *s, void *my) {
 378
 379         struct ctdl_sieve *cs = (struct ctdl_sieve *)my;
 380
 381         lprintf(CTDL_DEBUG, "ctdl_getheaders() was called\n");
 382
 383         sieve2_setvalue_string(s, "allheaders", cs->rfc822headers);
 384         return SIEVE2_OK;
 385 }
 386
 387
 388
 389 /*
 390  * Add a room to the list of those rooms which potentially require sieve processing
 391  */
 392 void sieve_queue_room(struct ctdlroom *which_room) {
 393         struct RoomProcList *ptr;
 394
 395         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 396         if (ptr == NULL) return;
 397
 398         safestrncpy(ptr->name, which_room->QRname, sizeof ptr->name);
 399         begin_critical_section(S_SIEVELIST);
 400         ptr->next = sieve_list;
 401         sieve_list = ptr;
 402         end_critical_section(S_SIEVELIST);
 403 }
 404
 405
 406
 407 /*
 408  * Perform sieve processing for one message (called by sieve_do_room() for each message)
 409  */
 410 void sieve_do_msg(long msgnum, void *userdata) {
 411         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
 412         sieve2_context_t *sieve2_context = u->sieve2_context;
 413         struct ctdl_sieve my;
 414         int res;
 415         struct CtdlMessage *msg;
 416
 417         lprintf(CTDL_DEBUG, "Performing sieve processing on msg <%ld>\n", msgnum);
 418
 419         msg = CtdlFetchMessage(msgnum, 0);
 420         if (msg == NULL) return;
 421
 422         CC->redirect_buffer = malloc(SIZ);
 423         CC->redirect_len = 0;
 424         CC->redirect_alloc = SIZ;
 425         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ONLY, 0, 1);
 426         my.rfc822headers = CC->redirect_buffer;
 427         CC->redirect_buffer = NULL;
 428         CC->redirect_len = 0;
 429         CC->redirect_alloc = 0;
 430
 431         my.keep = 0;                            /* Set to 1 to declare an *explicit* keep */
 432         my.cancel_implicit_keep = 0;            /* Some actions will cancel the implicit keep */
 433         my.usernum = atol(CC->room.QRname);     /* Keep track of the owner of the room's namespace */
 434         my.msgnum = msgnum;                     /* Keep track of the message number in our local store */
 435         my.u = u;                               /* Hand off a pointer to the rest of this info */
 436
 437         /* Keep track of the recipient so we can do handling based on it later */
 438         process_rfc822_addr(msg->cm_fields['R'], my.recp_user, my.recp_node, my.recp_name);
 439
 440         /* Keep track of the sender so we can use it for REJECT and VACATION responses */
 441         if (msg->cm_fields['F'] != NULL) {
 442                 safestrncpy(my.sender, msg->cm_fields['F'], sizeof my.sender);
 443         }
 444         else if ( (msg->cm_fields['A'] != NULL) && (msg->cm_fields['N'] != NULL) ) {
 445                 snprintf(my.sender, sizeof my.sender, "%s@%s", msg->cm_fields['A'], msg->cm_fields['N']);
 446         }
 447         else if (msg->cm_fields['A'] != NULL) {
 448                 safestrncpy(my.sender, msg->cm_fields['A'], sizeof my.sender);
 449         }
 450         else {
 451                 strcpy(my.sender, "");
 452         }
 453
 454         free(msg);
 455
 456         sieve2_setvalue_string(sieve2_context, "allheaders", my.rfc822headers);
 457
 458         lprintf(CTDL_DEBUG, "Calling sieve2_execute()\n");
 459         res = sieve2_execute(sieve2_context, &my);
 460         if (res != SIEVE2_OK) {
 461                 lprintf(CTDL_CRIT, "sieve2_execute() returned %d: %s\n", res, sieve2_errstr(res));
 462         }
 463
 464         free(my.rfc822headers);
 465         my.rfc822headers = NULL;
 466
 467         /*
 468          * Delete the message from the inbox unless either we were told not to, or
 469          * if no other action was successfully taken.
 470          */
 471         if ( (!my.keep) && (my.cancel_implicit_keep) ) {
 472                 lprintf(CTDL_DEBUG, "keep is 0 -- deleting message from inbox\n");
 473                 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "", 0);
 474         }
 475
 476         lprintf(CTDL_DEBUG, "Completed sieve processing on msg <%ld>\n", msgnum);
 477         u->lastproc = msgnum;
 478
 479         return;
 480 }
 481
 482
 483
 484 /*
 485  * Given the on-disk representation of our Sieve config, load
 486  * it into an in-memory data structure.
 487  */
 488 void parse_sieve_config(char *conf, struct sdm_userdata *u) {
 489         char *ptr;
 490         char *c;
 491         char keyword[256];
 492         struct sdm_script *sptr;
 493
 494         ptr = conf;
 495         while (c = ptr, ptr = bmstrcasestr(ptr, CTDLSIEVECONFIGSEPARATOR), ptr != NULL) {
 496                 *ptr = 0;
 497                 ptr += strlen(CTDLSIEVECONFIGSEPARATOR);
 498
 499                 extract_token(keyword, c, 0, '|', sizeof keyword);
 500
 501                 if (!strcasecmp(keyword, "lastproc")) {
 502                         u->lastproc = extract_long(c, 1);
 503                 }
 504
 505                 else if (!strcasecmp(keyword, "script")) {
 506                         sptr = malloc(sizeof(struct sdm_script));
 507                         extract_token(sptr->script_name, c, 1, '|', sizeof sptr->script_name);
 508                         sptr->script_active = extract_int(c, 2);
 509                         remove_token(c, 0, '|');
 510                         remove_token(c, 0, '|');
 511                         remove_token(c, 0, '|');
 512                         sptr->script_content = strdup(c);
 513                         sptr->next = u->first_script;
 514                         u->first_script = sptr;
 515                 }
 516
 517                 /* ignore unknown keywords */
 518         }
 519 }
 520
 521 /*
 522  * We found the Sieve configuration for this user.
 523  * Now do something with it.
 524  */
 525 void get_sieve_config_backend(long msgnum, void *userdata) {
 526         struct sdm_userdata *u = (struct sdm_userdata *) userdata;
 527         struct CtdlMessage *msg;
 528         char *conf;
 529
 530         u->config_msgnum = msgnum;
 531         msg = CtdlFetchMessage(msgnum, 1);
 532         if (msg == NULL) {
 533                 u->config_msgnum = (-1) ;
 534                 return;
 535         }
 536
 537         conf = msg->cm_fields['M'];
 538         msg->cm_fields['M'] = NULL;
 539         CtdlFreeMessage(msg);
 540
 541         if (conf != NULL) {
 542                 parse_sieve_config(conf, u);
 543                 free(conf);
 544         }
 545
 546 }
 547
 548
 549 /*
 550  * Write our citadel sieve config back to disk
 551  */
 552 void rewrite_ctdl_sieve_config(struct sdm_userdata *u) {
 553         char *text;
 554         struct sdm_script *sptr;
 555
 556
 557         text = malloc(1024);
 558         snprintf(text, 1024,
 559                 "Content-type: application/x-citadel-sieve-config\n"
 560                 "\n"
 561                 CTDLSIEVECONFIGSEPARATOR
 562                 "lastproc|%ld"
 563                 CTDLSIEVECONFIGSEPARATOR
 564         ,
 565                 u->lastproc
 566         );
 567
 568         while (u->first_script != NULL) {
 569                 text = realloc(text, strlen(text) + strlen(u->first_script->script_content) + 256);
 570                 sprintf(&text[strlen(text)], "script|%s|%d|%s" CTDLSIEVECONFIGSEPARATOR,
 571                         u->first_script->script_name,
 572                         u->first_script->script_active,
 573                         u->first_script->script_content
 574                 );
 575                 sptr = u->first_script;
 576                 u->first_script = u->first_script->next;
 577                 free(sptr->script_content);
 578                 free(sptr);
 579         }
 580
 581         /* Save the config */
 582         quickie_message("Citadel", NULL, u->config_roomname,
 583                         text,
 584                         4,
 585                         "Sieve configuration"
 586         );
 587
 588         /* And delete the old one */
 589         if (u->config_msgnum > 0) {
 590                 CtdlDeleteMessages(u->config_roomname, &u->config_msgnum, 1, "", 0);
 591         }
 592
 593 }
 594
 595
 596 /*
 597  * This is our callback registration table for libSieve.
 598  */
 599 sieve2_callback_t ctdl_sieve_callbacks[] = {
 600         { SIEVE2_ACTION_REJECT,         ctdl_reject                             },
 601         { SIEVE2_ACTION_NOTIFY,         NULL    /* ctdl_notify */               },
 602         { SIEVE2_ACTION_VACATION,       ctdl_vacation                           },
 603         { SIEVE2_ERRCALL_PARSE,         ctdl_errparse                           },
 604         { SIEVE2_ERRCALL_RUNTIME,       ctdl_errexec                            },
 605         { SIEVE2_ACTION_FILEINTO,       ctdl_fileinto                           },
 606         { SIEVE2_ACTION_REDIRECT,       ctdl_redirect                           },
 607         { SIEVE2_ACTION_DISCARD,        ctdl_discard                            },
 608         { SIEVE2_ACTION_KEEP,           ctdl_keep                               },
 609         { SIEVE2_SCRIPT_GETSCRIPT,      ctdl_getscript                          },
 610         { SIEVE2_DEBUG_TRACE,           ctdl_debug                              },
 611         { SIEVE2_MESSAGE_GETALLHEADERS, ctdl_getheaders                         },
 612         { SIEVE2_MESSAGE_GETSUBADDRESS, NULL    /* ctdl_getsubaddress */        },
 613         { SIEVE2_MESSAGE_GETENVELOPE,   ctdl_getenvelope                        },
 614         { SIEVE2_MESSAGE_GETBODY,       ctdl_getbody                            },
 615         { SIEVE2_MESSAGE_GETSIZE,       ctdl_getsize                            },
 616         { 0 }
 617 };
 618
 619
 620 /*
 621  * Perform sieve processing for a single room
 622  */
 623 void sieve_do_room(char *roomname) {
 624
 625         struct sdm_userdata u;
 626         sieve2_context_t *sieve2_context = NULL;        /* Context for sieve parser */
 627         int res;                                        /* Return code from libsieve calls */
 628         long orig_lastproc = 0;
 629
 630         memset(&u, 0, sizeof u);
 631
 632         /* See if the user who owns this 'mailbox' has any Sieve scripts that
 633          * require execution.
 634          */
 635         snprintf(u.config_roomname, sizeof u.config_roomname, "%010ld.%s", atol(roomname), SIEVERULES);
 636         if (getroom(&CC->room, u.config_roomname) != 0) {
 637                 lprintf(CTDL_DEBUG, "<%s> does not exist.  No processing is required.\n", u.config_roomname);
 638                 return;
 639         }
 640
 641         /*
 642          * Find the sieve scripts and control record and do something
 643          */
 644         u.config_msgnum = (-1);
 645         CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
 646                 get_sieve_config_backend, (void *)&u );
 647
 648         if (u.config_msgnum < 0) {
 649                 lprintf(CTDL_DEBUG, "No Sieve rules exist.  No processing is required.\n");
 650                 return;
 651         }
 652
 653         lprintf(CTDL_DEBUG, "Rules found.  Performing Sieve processing for <%s>\n", roomname);
 654
 655         if (getroom(&CC->room, roomname) != 0) {
 656                 lprintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", roomname);
 657                 return;
 658         }
 659
 660         /* Initialize the Sieve parser */
 661
 662         res = sieve2_alloc(&sieve2_context);
 663         if (res != SIEVE2_OK) {
 664                 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
 665                 return;
 666         }
 667
 668         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
 669         if (res != SIEVE2_OK) {
 670                 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
 671                 goto BAIL;
 672         }
 673
 674         /* Validate the script */
 675
 676         struct ctdl_sieve my;           /* dummy ctdl_sieve struct just to pass "u" slong */
 677         memset(&my, 0, sizeof my);
 678         my.u = &u;
 679         res = sieve2_validate(sieve2_context, &my);
 680         if (res != SIEVE2_OK) {
 681                 lprintf(CTDL_CRIT, "sieve2_validate() returned %d: %s\n", res, sieve2_errstr(res));
 682                 goto BAIL;
 683         }
 684
 685         /* Do something useful */
 686         u.sieve2_context = sieve2_context;
 687         orig_lastproc = u.lastproc;
 688         CtdlForEachMessage(MSGS_GT, u.lastproc, NULL, NULL, NULL,
 689                 sieve_do_msg,
 690                 (void *) &u
 691         );
 692
 693 BAIL:
 694         res = sieve2_free(&sieve2_context);
 695         if (res != SIEVE2_OK) {
 696                 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
 697         }
 698
 699         /* Rewrite the config if we have to */
 700         if (u.lastproc > orig_lastproc) {
 701                 rewrite_ctdl_sieve_config(&u);
 702         }
 703 }
 704
 705
 706 /*
 707  * Perform sieve processing for all rooms which require it
 708  */
 709 void perform_sieve_processing(void) {
 710         struct RoomProcList *ptr = NULL;
 711
 712         if (sieve_list != NULL) {
 713                 lprintf(CTDL_DEBUG, "Begin Sieve processing\n");
 714                 while (sieve_list != NULL) {
 715                         char spoolroomname[ROOMNAMELEN];
 716                         safestrncpy(spoolroomname, sieve_list->name, sizeof spoolroomname);
 717                         begin_critical_section(S_SIEVELIST);
 718
 719                         /* pop this record off the list */
 720                         ptr = sieve_list;
 721                         sieve_list = sieve_list->next;
 722                         free(ptr);
 723
 724                         /* invalidate any duplicate entries to prevent double processing */
 725                         for (ptr=sieve_list; ptr!=NULL; ptr=ptr->next) {
 726                                 if (!strcasecmp(ptr->name, spoolroomname)) {
 727                                         ptr->name[0] = 0;
 728                                 }
 729                         }
 730
 731                         end_critical_section(S_SIEVELIST);
 732                         if (spoolroomname[0] != 0) {
 733                                 sieve_do_room(spoolroomname);
 734                         }
 735                 }
 736         }
 737 }
 738
 739
 740 void msiv_load(struct sdm_userdata *u) {
 741         char hold_rm[ROOMNAMELEN];
 742
 743         strcpy(hold_rm, CC->room.QRname);       /* save current room */
 744
 745         /* Take a spin through the user's personal address book */
 746         if (getroom(&CC->room, SIEVERULES) == 0) {
 747
 748                 u->config_msgnum = (-1);
 749                 strcpy(u->config_roomname, CC->room.QRname);
 750                 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL,
 751                         get_sieve_config_backend, (void *)u );
 752
 753         }
 754
 755         if (strcmp(CC->room.QRname, hold_rm)) {
 756                 getroom(&CC->room, hold_rm);    /* return to saved room */
 757         }
 758 }
 759
 760 void msiv_store(struct sdm_userdata *u) {
 761         rewrite_ctdl_sieve_config(u);
 762 }
 763
 764
 765 /*
 766  * Select the active script.
 767  * (Set script_name to an empty string to disable all scripts)
 768  *
 769  * Returns 0 on success or nonzero for error.
 770  */
 771 int msiv_setactive(struct sdm_userdata *u, char *script_name) {
 772         int ok = 0;
 773         struct sdm_script *s;
 774
 775         /* First see if the supplied value is ok */
 776
 777         if (strlen(script_name) == 0) {
 778                 ok = 1;
 779         }
 780         else {
 781                 for (s=u->first_script; s!=NULL; s=s->next) {
 782                         if (!strcasecmp(s->script_name, script_name)) {
 783                                 ok = 1;
 784                         }
 785                 }
 786         }
 787
 788         if (!ok) return(-1);
 789
 790         /* Now set the active script */
 791         for (s=u->first_script; s!=NULL; s=s->next) {
 792                 if (!strcasecmp(s->script_name, script_name)) {
 793                         s->script_active = 1;
 794                 }
 795                 else {
 796                         s->script_active = 0;
 797                 }
 798         }
 799
 800         return(0);
 801 }
 802
 803
 804 /*
 805  * Fetch a script by name.
 806  *
 807  * Returns NULL if the named script was not found, or a pointer to the script
 808  * if it was found.   NOTE: the caller does *not* own the memory returned by
 809  * this function.  Copy it if you need to keep it.
 810  */
 811 char *msiv_getscript(struct sdm_userdata *u, char *script_name) {
 812         struct sdm_script *s;
 813
 814         for (s=u->first_script; s!=NULL; s=s->next) {
 815                 if (!strcasecmp(s->script_name, script_name)) {
 816                         if (s->script_content != NULL) {
 817                                 return (s->script_content);
 818                         }
 819                 }
 820         }
 821
 822         return(NULL);
 823 }
 824
 825
 826 /*
 827  * Delete a script by name.
 828  *
 829  * Returns 0 if the script was deleted.
 830  *       1 if the script was not found.
 831  *       2 if the script cannot be deleted because it is active.
 832  */
 833 int msiv_deletescript(struct sdm_userdata *u, char *script_name) {
 834         struct sdm_script *s = NULL;
 835         struct sdm_script *script_to_delete = NULL;
 836
 837         for (s=u->first_script; s!=NULL; s=s->next) {
 838                 if (!strcasecmp(s->script_name, script_name)) {
 839                         script_to_delete = s;
 840                         if (s->script_active) {
 841                                 return(2);
 842                         }
 843                 }
 844         }
 845
 846         if (script_to_delete == NULL) return(1);
 847
 848         if (u->first_script == script_to_delete) {
 849                 u->first_script = u->first_script->next;
 850         }
 851         else for (s=u->first_script; s!=NULL; s=s->next) {
 852                 if (s->next == script_to_delete) {
 853                         s->next = s->next->next;
 854                 }
 855         }
 856
 857         free(script_to_delete->script_content);
 858         free(script_to_delete);
 859         return(0);
 860 }
 861
 862
 863 /*
 864  * Add or replace a new script.
 865  * NOTE: after this function returns, "u" owns the memory that "script_content"
 866  * was pointing to.
 867  */
 868 void msiv_putscript(struct sdm_userdata *u, char *script_name, char *script_content) {
 869         int replaced = 0;
 870         struct sdm_script *s, *sptr;
 871
 872         for (s=u->first_script; s!=NULL; s=s->next) {
 873                 if (!strcasecmp(s->script_name, script_name)) {
 874                         if (s->script_content != NULL) {
 875                                 free(s->script_content);
 876                         }
 877                         s->script_content = script_content;
 878                         replaced = 1;
 879                 }
 880         }
 881
 882         if (replaced == 0) {
 883                 sptr = malloc(sizeof(struct sdm_script));
 884                 safestrncpy(sptr->script_name, script_name, sizeof sptr->script_name);
 885                 sptr->script_content = script_content;
 886                 sptr->script_active = 0;
 887                 sptr->next = u->first_script;
 888                 u->first_script = sptr;
 889         }
 890 }
 891
 892
 893
 894 /*
 895  * Citadel protocol to manage sieve scripts.
 896  * This is basically a simplified (read: doesn't resemble IMAP) version
 897  * of the 'managesieve' protocol.
 898  */
 899 void cmd_msiv(char *argbuf) {
 900         char subcmd[256];
 901         struct sdm_userdata u;
 902         char script_name[256];
 903         char *script_content = NULL;
 904         struct sdm_script *s;
 905         int i;
 906
 907         memset(&u, 0, sizeof(struct sdm_userdata));
 908
 909         if (CtdlAccessCheck(ac_logged_in)) return;
 910         extract_token(subcmd, argbuf, 0, '|', sizeof subcmd);
 911         msiv_load(&u);
 912
 913         if (!strcasecmp(subcmd, "putscript")) {
 914                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
 915                 if (strlen(script_name) > 0) {
 916                         cprintf("%d Transmit script now\n", SEND_LISTING);
 917                         script_content = CtdlReadMessageBody("000", config.c_maxmsglen, NULL, 0);
 918                         msiv_putscript(&u, script_name, script_content);
 919                 }
 920                 else {
 921                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
 922                 }
 923         }
 924
 925         else if (!strcasecmp(subcmd, "listscripts")) {
 926                 cprintf("%d Scripts:\n", LISTING_FOLLOWS);
 927                 for (s=u.first_script; s!=NULL; s=s->next) {
 928                         if (s->script_content != NULL) {
 929                                 cprintf("%s|%d|\n", s->script_name, s->script_active);
 930                         }
 931                 }
 932                 cprintf("000\n");
 933         }
 934
 935         else if (!strcasecmp(subcmd, "setactive")) {
 936                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
 937                 if (msiv_setactive(&u, script_name) == 0) {
 938                         cprintf("%d ok\n", CIT_OK);
 939                 }
 940                 else {
 941                         cprintf("%d Script '%s' does not exist.\n",
 942                                 ERROR + ILLEGAL_VALUE,
 943                                 script_name
 944                         );
 945                 }
 946         }
 947
 948         else if (!strcasecmp(subcmd, "getscript")) {
 949                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
 950                 script_content = msiv_getscript(&u, script_name);
 951                 if (script_content != NULL) {
 952                         cprintf("%d Script:\n", SEND_LISTING);
 953                         cprintf("%s000\n", script_content);
 954                 }
 955                 else {
 956                         cprintf("%d Invalid script name.\n", ERROR + ILLEGAL_VALUE);
 957                 }
 958         }
 959
 960         else if (!strcasecmp(subcmd, "deletescript")) {
 961                 extract_token(script_name, argbuf, 1, '|', sizeof script_name);
 962                 i = msiv_deletescript(&u, script_name);
 963                 if (i == 0) {
 964                         cprintf("%d ok\n", CIT_OK);
 965                 }
 966                 else if (i == 1) {
 967                         cprintf("%d Script '%s' does not exist.\n",
 968                                 ERROR + ILLEGAL_VALUE,
 969                                 script_name
 970                         );
 971                 }
 972                 else if (i == 2) {
 973                         cprintf("%d Script '%s' is active and cannot be deleted.\n",
 974                                 ERROR + ILLEGAL_VALUE,
 975                                 script_name
 976                         );
 977                 }
 978                 else {
 979                         cprintf("%d unknown error\n", ERROR);
 980                 }
 981         }
 982
 983         else {
 984                 cprintf("%d Invalid subcommand\n", ERROR + CMD_NOT_SUPPORTED);
 985         }
 986
 987         msiv_store(&u);
 988 }
 989
 990
 991
 992 void ctdl_sieve_init(void) {
 993         char *cred = NULL;
 994         sieve2_context_t *sieve2_context = NULL;
 995         int res;
 996
 997         /*
 998          *      We don't really care about dumping the entire credits to the log
 999          *      every time the server is initialized.  The documentation will suffice
1000          *      for that purpose.  We are making a call to sieve2_credits() in order
1001          *      to demonstrate that we have successfully linked in to libsieve.
1002          */
1003         cred = strdup(sieve2_credits());
1004         if (cred == NULL) return;
1005
1006         if (strlen(cred) > 60) {
1007                 strcpy(&cred[55], "...");
1008         }
1009
1010         lprintf(CTDL_INFO, "%s\n",cred);
1011         free(cred);
1012
1013         /* Briefly initialize a Sieve parser instance just so we can list the
1014          * extensions that are available.
1015          */
1016         res = sieve2_alloc(&sieve2_context);
1017         if (res != SIEVE2_OK) {
1018                 lprintf(CTDL_CRIT, "sieve2_alloc() returned %d: %s\n", res, sieve2_errstr(res));
1019                 return;
1020         }
1021
1022         res = sieve2_callbacks(sieve2_context, ctdl_sieve_callbacks);
1023         if (res != SIEVE2_OK) {
1024                 lprintf(CTDL_CRIT, "sieve2_callbacks() returned %d: %s\n", res, sieve2_errstr(res));
1025                 goto BAIL;
1026         }
1027
1028         msiv_extensions = strdup(sieve2_listextensions(sieve2_context));
1029         lprintf(CTDL_INFO, "Extensions: %s\n", msiv_extensions);
1030
1031 BAIL:   res = sieve2_free(&sieve2_context);
1032         if (res != SIEVE2_OK) {
1033                 lprintf(CTDL_CRIT, "sieve2_free() returned %d: %s\n", res, sieve2_errstr(res));
1034         }
1035
1036 }
1037
1038
1039
1040 char *serv_sieve_init(void)
1041 {
1042         ctdl_sieve_init();
1043         CtdlRegisterProtoHook(cmd_msiv, "MSIV", "Manage Sieve scripts");
1044         return "$Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $";
1045 }
1046
1047 #else   /* HAVE_LIBSIEVE */
1048
1049 char *serv_sieve_init(void)
1050 {
1051         lprintf(CTDL_INFO, "This server is missing libsieve.  Mailbox filtering will be disabled.\n");
1052         return "$Id: serv_sieve.c 3850 2005-09-13 14:00:24Z ajc $";
1053 }
1054
1055 #endif  /* HAVE_LIBSIEVE */