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