citadel/modules/sieve/serv_sieve.c

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