citadel/server/msgbase.c

   1 // Implements the message store.
   2 //
   3 // Copyright (c) 1987-2023 by the citadel.org team
   4 //
   5 // This program is open source software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License version 3.
   7
   8 #include <stdlib.h>
   9 #include <unistd.h>
  10 #include <stdio.h>
  11 #include <regex.h>
  12 #include <sys/stat.h>
  13 #include <assert.h>
  14 #include <libcitadel.h>
  15 #include "ctdl_module.h"
  16 #include "citserver.h"
  17 #include "control.h"
  18 #include "config.h"
  19 #include "clientsocket.h"
  20 #include "genstamp.h"
  21 #include "room_ops.h"
  22 #include "user_ops.h"
  23 #include "internet_addressing.h"
  24 #include "euidindex.h"
  25 #include "msgbase.h"
  26 #include "journaling.h"
  27 #include "modules/fulltext/serv_fulltext.h"
  28
  29 struct addresses_to_be_filed *atbf = NULL;
  30
  31 // These are the four-character field headers we use when outputting
  32 // messages in Citadel format (as opposed to RFC822 format).
  33 char *msgkeys[] = {
  34         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  35         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  36         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  37         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  38         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  39         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  40         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  41         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  42         NULL,
  43         "from", // A -> eAuthor
  44         NULL,   // B -> eBig_message
  45         NULL,   // C (formerly used as eRemoteRoom)
  46         NULL,   // D (formerly used as eDestination)
  47         "exti", // E -> eXclusivID
  48         "rfca", // F -> erFc822Addr
  49         NULL,   // G
  50         "hnod", // H (formerly used as eHumanNode)
  51         "msgn", // I -> emessageId
  52         "jrnl", // J -> eJournal
  53         "rep2", // K -> eReplyTo
  54         "list", // L -> eListID
  55         "text", // M -> eMesageText
  56         NULL,   // N (formerly used as eNodename)
  57         "room", // O -> eOriginalRoom
  58         "path", // P -> eMessagePath
  59         NULL,   // Q
  60         "rcpt", // R -> eRecipient
  61         NULL,   // S (formerly used as eSpecialField)
  62         "time", // T -> eTimestamp
  63         "subj", // U -> eMsgSubject
  64         "nvto", // V -> eenVelopeTo
  65         "wefw", // W -> eWeferences
  66         NULL,   // X
  67         "cccc", // Y -> eCarbonCopY
  68         NULL    // Z
  69 };
  70
  71
  72 HashList *msgKeyLookup = NULL;
  73
  74 int GetFieldFromMnemonic(eMsgField *f, const char* c) {
  75         void *v = NULL;
  76         if (GetHash(msgKeyLookup, c, 4, &v)) {
  77                 *f = (eMsgField) v;
  78                 return 1;
  79         }
  80         return 0;
  81 }
  82
  83 void FillMsgKeyLookupTable(void) {
  84         long i;
  85
  86         msgKeyLookup = NewHash (1, FourHash);
  87
  88         for (i=0; i < 91; i++) {
  89                 if (msgkeys[i] != NULL) {
  90                         Put(msgKeyLookup, msgkeys[i], 4, (void*)i, reference_free_handler);
  91                 }
  92         }
  93 }
  94
  95
  96 eMsgField FieldOrder[]  = {
  97 /* Important fields */
  98         emessageId   ,
  99         eMessagePath ,
 100         eTimestamp   ,
 101         eAuthor      ,
 102         erFc822Addr  ,
 103         eOriginalRoom,
 104         eRecipient   ,
 105 /* Semi-important fields */
 106         eBig_message ,
 107         eExclusiveID ,
 108         eWeferences  ,
 109         eJournal     ,
 110 /* G is not used yet */
 111         eReplyTo     ,
 112         eListID      ,
 113 /* Q is not used yet */
 114         eenVelopeTo  ,
 115 /* X is not used yet */
 116 /* Z is not used yet */
 117         eCarbonCopY  ,
 118         eMsgSubject  ,
 119 /* internal only */
 120         eErrorMsg    ,
 121         eSuppressIdx ,
 122         eExtnotify   ,
 123 /* Message text (MUST be last) */
 124         eMesageText
 125 /* Not saved to disk:
 126         eVltMsgNum
 127 */
 128 };
 129
 130 static const long NDiskFields = sizeof(FieldOrder) / sizeof(eMsgField);
 131
 132
 133 int CM_IsEmpty(struct CtdlMessage *Msg, eMsgField which) {
 134         return !((Msg->cm_fields[which] != NULL) && (Msg->cm_fields[which][0] != '\0'));
 135 }
 136
 137
 138 void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf) {
 139         if (Msg->cm_fields[which] != NULL) {
 140                 free(Msg->cm_fields[which]);
 141         }
 142         Msg->cm_fields[which] = strdup(buf);
 143         Msg->cm_lengths[which] = strlen(buf);
 144 }
 145
 146
 147 void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue) {
 148         char buf[128];
 149         long len;
 150         len = snprintf(buf, sizeof(buf), "%ld", lvalue);
 151         CM_SetField(Msg, which, buf);
 152 }
 153
 154
 155 void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen) {
 156         if (Msg->cm_fields[WhichToCut] == NULL)
 157                 return;
 158
 159         if (Msg->cm_lengths[WhichToCut] > maxlen)
 160         {
 161                 Msg->cm_fields[WhichToCut][maxlen] = '\0';
 162                 Msg->cm_lengths[WhichToCut] = maxlen;
 163         }
 164 }
 165
 166
 167 void CM_FlushField(struct CtdlMessage *Msg, eMsgField which) {
 168         if (Msg->cm_fields[which] != NULL)
 169                 free (Msg->cm_fields[which]);
 170         Msg->cm_fields[which] = NULL;
 171         Msg->cm_lengths[which] = 0;
 172 }
 173
 174
 175 void CM_Flush(struct CtdlMessage *Msg) {
 176         int i;
 177
 178         if (CM_IsValidMsg(Msg) == 0) {
 179                 return;
 180         }
 181
 182         for (i = 0; i < 256; ++i) {
 183                 CM_FlushField(Msg, i);
 184         }
 185 }
 186
 187
 188 void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy) {
 189         long len;
 190         if (Msg->cm_fields[WhichToPutTo] != NULL) {
 191                 free (Msg->cm_fields[WhichToPutTo]);
 192         }
 193
 194         if (Msg->cm_fields[WhichtToCopy] != NULL) {
 195                 len = Msg->cm_lengths[WhichtToCopy];
 196                 Msg->cm_fields[WhichToPutTo] = malloc(len + 1);
 197                 memcpy(Msg->cm_fields[WhichToPutTo], Msg->cm_fields[WhichtToCopy], len);
 198                 Msg->cm_fields[WhichToPutTo][len] = '\0';
 199                 Msg->cm_lengths[WhichToPutTo] = len;
 200         }
 201         else {
 202                 Msg->cm_fields[WhichToPutTo] = NULL;
 203                 Msg->cm_lengths[WhichToPutTo] = 0;
 204         }
 205 }
 206
 207
 208 void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) {
 209         if (Msg->cm_fields[which] != NULL) {
 210                 long oldmsgsize;
 211                 long newmsgsize;
 212                 char *new;
 213
 214                 oldmsgsize = Msg->cm_lengths[which] + 1;
 215                 newmsgsize = length + oldmsgsize;
 216
 217                 new = malloc(newmsgsize);
 218                 memcpy(new, buf, length);
 219                 memcpy(new + length, Msg->cm_fields[which], oldmsgsize);
 220                 free(Msg->cm_fields[which]);
 221                 Msg->cm_fields[which] = new;
 222                 Msg->cm_lengths[which] = newmsgsize - 1;
 223         }
 224         else {
 225                 Msg->cm_fields[which] = malloc(length + 1);
 226                 memcpy(Msg->cm_fields[which], buf, length);
 227                 Msg->cm_fields[which][length] = '\0';
 228                 Msg->cm_lengths[which] = length;
 229         }
 230 }
 231
 232
 233 // This is like CM_SetField() except the caller is transferring ownership of the supplied memory to the message
 234 void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length) {
 235         if (Msg->cm_fields[which] != NULL) {
 236                 free (Msg->cm_fields[which]);
 237         }
 238
 239         Msg->cm_fields[which] = *buf;
 240         *buf = NULL;
 241         if (length < 0) {                       // You can set the length to -1 to have CM_SetField measure it for you
 242                 Msg->cm_lengths[which] = strlen(Msg->cm_fields[which]);
 243         }
 244         else {
 245                 Msg->cm_lengths[which] = length;
 246         }
 247 }
 248
 249
 250 void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf) {
 251         if (Msg->cm_fields[which] != NULL) {
 252                 free (Msg->cm_fields[which]);
 253         }
 254
 255         Msg->cm_lengths[which] = StrLength(*buf);
 256         Msg->cm_fields[which] = SmashStrBuf(buf);
 257 }
 258
 259
 260 void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen) {
 261         if (Msg->cm_fields[which] != NULL) {
 262                 *retlen = Msg->cm_lengths[which];
 263                 *ret = Msg->cm_fields[which];
 264                 Msg->cm_fields[which] = NULL;
 265                 Msg->cm_lengths[which] = 0;
 266         }
 267         else {
 268                 *ret = NULL;
 269                 *retlen = 0;
 270         }
 271 }
 272
 273
 274 // Returns 1 if the supplied pointer points to a valid Citadel message.
 275 // If the pointer is NULL or the magic number check fails, returns 0.
 276 int CM_IsValidMsg(struct CtdlMessage *msg) {
 277         if (msg == NULL) {
 278                 return 0;
 279         }
 280         if ((msg->cm_magic) != CTDLMESSAGE_MAGIC) {
 281                 syslog(LOG_WARNING, "msgbase: CM_IsValidMsg() self-check failed");
 282                 return 0;
 283         }
 284         return 1;
 285 }
 286
 287
 288 void CM_FreeContents(struct CtdlMessage *msg) {
 289         int i;
 290
 291         for (i = 0; i < 256; ++i)
 292                 if (msg->cm_fields[i] != NULL) {
 293                         free(msg->cm_fields[i]);
 294                         msg->cm_lengths[i] = 0;
 295                 }
 296
 297         msg->cm_magic = 0;      // just in case
 298 }
 299
 300
 301 // 'Destructor' for struct CtdlMessage
 302 void CM_Free(struct CtdlMessage *msg) {
 303         if (CM_IsValidMsg(msg) == 0) {
 304                 if (msg != NULL) free (msg);
 305                 return;
 306         }
 307         CM_FreeContents(msg);
 308         free(msg);
 309 }
 310
 311
 312 int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg) {
 313         long len;
 314         len = OrgMsg->cm_lengths[i];
 315         NewMsg->cm_fields[i] = malloc(len + 1);
 316         if (NewMsg->cm_fields[i] == NULL) {
 317                 return 0;
 318         }
 319         memcpy(NewMsg->cm_fields[i], OrgMsg->cm_fields[i], len);
 320         NewMsg->cm_fields[i][len] = '\0';
 321         NewMsg->cm_lengths[i] = len;
 322         return 1;
 323 }
 324
 325
 326 struct CtdlMessage *CM_Duplicate(struct CtdlMessage *OrgMsg) {
 327         int i;
 328         struct CtdlMessage *NewMsg;
 329
 330         if (CM_IsValidMsg(OrgMsg) == 0) {
 331                 return NULL;
 332         }
 333         NewMsg = (struct CtdlMessage *)malloc(sizeof(struct CtdlMessage));
 334         if (NewMsg == NULL) {
 335                 return NULL;
 336         }
 337
 338         memcpy(NewMsg, OrgMsg, sizeof(struct CtdlMessage));
 339
 340         memset(&NewMsg->cm_fields, 0, sizeof(char*) * 256);
 341
 342         for (i = 0; i < 256; ++i) {
 343                 if (OrgMsg->cm_fields[i] != NULL) {
 344                         if (!CM_DupField(i, OrgMsg, NewMsg)) {
 345                                 CM_Free(NewMsg);
 346                                 return NULL;
 347                         }
 348                 }
 349         }
 350
 351         return NewMsg;
 352 }
 353
 354
 355 // Determine if a given message matches the fields in a message template.
 356 // Return 0 for a successful match.
 357 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) {
 358         int i;
 359
 360         // If there aren't any fields in the template, all messages will match.
 361         if (template == NULL) return(0);
 362
 363         // Null messages are bogus.
 364         if (msg == NULL) return(1);
 365
 366         for (i='A'; i<='Z'; ++i) {
 367                 if (template->cm_fields[i] != NULL) {
 368                         if (msg->cm_fields[i] == NULL) {
 369                                 // Considered equal if temmplate is empty string
 370                                 if (IsEmptyStr(template->cm_fields[i])) continue;
 371                                 return 1;
 372                         }
 373                         if ((template->cm_lengths[i] != msg->cm_lengths[i]) ||
 374                             (strcasecmp(msg->cm_fields[i], template->cm_fields[i])))
 375                                 return 1;
 376                 }
 377         }
 378
 379         // All compares succeeded: we have a match!
 380         return 0;
 381 }
 382
 383
 384 // Retrieve the "seen" message list for the current room.
 385 void CtdlGetSeen(char *buf, int which_set) {
 386         struct visit vbuf;
 387
 388         // Learn about the user and room in question
 389         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 390
 391         if (which_set == ctdlsetseen_seen) {
 392                 safestrncpy(buf, vbuf.v_seen, SIZ);
 393         }
 394         if (which_set == ctdlsetseen_answered) {
 395                 safestrncpy(buf, vbuf.v_answered, SIZ);
 396         }
 397 }
 398
 399
 400 // Manipulate the "seen msgs" string (or other message set strings)
 401 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
 402                 int target_setting, int which_set,
 403                 struct ctdluser *which_user, struct ctdlroom *which_room) {
 404         int i, k;
 405         int is_seen = 0;
 406         int was_seen = 0;
 407         long lo = (-1L);
 408         long hi = (-1L);
 409         struct visit vbuf;
 410         long *msglist;
 411         int num_msgs = 0;
 412         StrBuf *vset;
 413         StrBuf *setstr;
 414         StrBuf *lostr;
 415         StrBuf *histr;
 416         const char *pvset;
 417         char *is_set;   // actually an array of booleans
 418
 419         // Don't bother doing *anything* if we were passed a list of zero messages
 420         if (num_target_msgnums < 1) {
 421                 return;
 422         }
 423
 424         // If no room was specified, we go with the current room.
 425         if (!which_room) {
 426                 which_room = &CC->room;
 427         }
 428
 429         // If no user was specified, we go with the current user.
 430         if (!which_user) {
 431                 which_user = &CC->user;
 432         }
 433
 434         syslog(LOG_DEBUG, "msgbase: CtdlSetSeen(%d msgs starting with %ld, %s, %d) in <%s>",
 435                    num_target_msgnums, target_msgnums[0],
 436                    (target_setting ? "SET" : "CLEAR"),
 437                    which_set,
 438                    which_room->QRname);
 439
 440         // Learn about the user and room in question
 441         CtdlGetRelationship(&vbuf, which_user, which_room);
 442
 443         // Load the message list
 444         num_msgs = CtdlFetchMsgList(which_room->QRnumber, &msglist);
 445         if (num_msgs <= 0) {
 446                 free(msglist);
 447                 return;
 448         }
 449
 450         is_set = malloc(num_msgs * sizeof(char));
 451         memset(is_set, 0, (num_msgs * sizeof(char)) );
 452
 453         // Decide which message set we're manipulating
 454         switch(which_set) {
 455         case ctdlsetseen_seen:
 456                 vset = NewStrBufPlain(vbuf.v_seen, -1);
 457                 break;
 458         case ctdlsetseen_answered:
 459                 vset = NewStrBufPlain(vbuf.v_answered, -1);
 460                 break;
 461         default:
 462                 vset = NewStrBuf();
 463         }
 464
 465         // Translate the existing sequence set into an array of booleans
 466         setstr = NewStrBuf();
 467         lostr = NewStrBuf();
 468         histr = NewStrBuf();
 469         pvset = NULL;
 470         while (StrBufExtract_NextToken(setstr, vset, &pvset, ',') >= 0) {
 471
 472                 StrBufExtract_token(lostr, setstr, 0, ':');
 473                 if (StrBufNum_tokens(setstr, ':') >= 2) {
 474                         StrBufExtract_token(histr, setstr, 1, ':');
 475                 }
 476                 else {
 477                         FlushStrBuf(histr);
 478                         StrBufAppendBuf(histr, lostr, 0);
 479                 }
 480                 lo = StrTol(lostr);
 481                 if (!strcmp(ChrPtr(histr), "*")) {
 482                         hi = LONG_MAX;
 483                 }
 484                 else {
 485                         hi = StrTol(histr);
 486                 }
 487
 488                 for (i = 0; i < num_msgs; ++i) {
 489                         if ((msglist[i] >= lo) && (msglist[i] <= hi)) {
 490                                 is_set[i] = 1;
 491                         }
 492                 }
 493         }
 494         FreeStrBuf(&setstr);
 495         FreeStrBuf(&lostr);
 496         FreeStrBuf(&histr);
 497
 498         // Now translate the array of booleans back into a sequence set
 499         FlushStrBuf(vset);
 500         was_seen = 0;
 501         lo = (-1);
 502         hi = (-1);
 503
 504         for (i=0; i<num_msgs; ++i) {
 505                 is_seen = is_set[i];
 506
 507                 // Apply changes
 508                 for (k=0; k<num_target_msgnums; ++k) {
 509                         if (msglist[i] == target_msgnums[k]) {
 510                                 is_seen = target_setting;
 511                         }
 512                 }
 513
 514                 if ((was_seen == 0) && (is_seen == 1)) {
 515                         lo = msglist[i];
 516                 }
 517                 else if ((was_seen == 1) && (is_seen == 0)) {
 518                         hi = msglist[i-1];
 519
 520                         if (StrLength(vset) > 0) {
 521                                 StrBufAppendBufPlain(vset, HKEY(","), 0);
 522                         }
 523                         if (lo == hi) {
 524                                 StrBufAppendPrintf(vset, "%ld", hi);
 525                         }
 526                         else {
 527                                 StrBufAppendPrintf(vset, "%ld:%ld", lo, hi);
 528                         }
 529                 }
 530
 531                 if ((is_seen) && (i == num_msgs - 1)) {
 532                         if (StrLength(vset) > 0) {
 533                                 StrBufAppendBufPlain(vset, HKEY(","), 0);
 534                         }
 535                         if ((i==0) || (was_seen == 0)) {
 536                                 StrBufAppendPrintf(vset, "%ld", msglist[i]);
 537                         }
 538                         else {
 539                                 StrBufAppendPrintf(vset, "%ld:%ld", lo, msglist[i]);
 540                         }
 541                 }
 542
 543                 was_seen = is_seen;
 544         }
 545
 546         // We will have to stuff this string back into a 4096 byte buffer, so if it's
 547         // larger than that now, truncate it by removing tokens from the beginning.
 548         // The limit of 100 iterations is there to prevent an infinite loop in case
 549         // something unexpected happens.
 550         int number_of_truncations = 0;
 551         while ( (StrLength(vset) > SIZ) && (number_of_truncations < 100) ) {
 552                 StrBufRemove_token(vset, 0, ',');
 553                 ++number_of_truncations;
 554         }
 555
 556         // If we're truncating the sequence set of messages marked with the 'seen' flag,
 557         // we want the earliest messages (the truncated ones) to be marked, not unmarked.
 558         // Otherwise messages at the beginning will suddenly appear to be 'unseen'.
 559         if ( (which_set == ctdlsetseen_seen) && (number_of_truncations > 0) ) {
 560                 StrBuf *first_tok;
 561                 first_tok = NewStrBuf();
 562                 StrBufExtract_token(first_tok, vset, 0, ',');
 563                 StrBufRemove_token(vset, 0, ',');
 564
 565                 if (StrBufNum_tokens(first_tok, ':') > 1) {
 566                         StrBufRemove_token(first_tok, 0, ':');
 567                 }
 568
 569                 StrBuf *new_set;
 570                 new_set = NewStrBuf();
 571                 StrBufAppendBufPlain(new_set, HKEY("1:"), 0);
 572                 StrBufAppendBuf(new_set, first_tok, 0);
 573                 StrBufAppendBufPlain(new_set, HKEY(":"), 0);
 574                 StrBufAppendBuf(new_set, vset, 0);
 575
 576                 FreeStrBuf(&vset);
 577                 FreeStrBuf(&first_tok);
 578                 vset = new_set;
 579         }
 580
 581         // Decide which message set we're manipulating.  Zero the buffers so they compress well.
 582         switch (which_set) {
 583                 case ctdlsetseen_seen:
 584                         memset(vbuf.v_seen, 0, sizeof vbuf.v_seen);
 585                         safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen);
 586                         break;
 587                 case ctdlsetseen_answered:
 588                         memset(vbuf.v_answered, 0, sizeof vbuf.v_seen);
 589                         safestrncpy(vbuf.v_answered, ChrPtr(vset), sizeof vbuf.v_answered);
 590                         break;
 591         }
 592
 593         free(is_set);
 594         free(msglist);
 595         CtdlSetRelationship(&vbuf, which_user, which_room);
 596         FreeStrBuf(&vset);
 597 }
 598
 599
 600 // API function to perform an operation for each qualifying message in the
 601 // current room.  (Returns the number of messages processed.)
 602 int CtdlForEachMessage(int mode, long ref, char *search_string,
 603                         char *content_type,
 604                         struct CtdlMessage *compare,
 605                         ForEachMsgCallback CallBack,
 606                         void *userdata)
 607 {
 608         int a, i, j;
 609         struct visit vbuf;
 610         long *msglist = NULL;
 611         int num_msgs = 0;
 612         int num_processed = 0;
 613         long thismsg;
 614         struct MetaData smi;
 615         struct CtdlMessage *msg = NULL;
 616         int is_seen = 0;
 617         long lastold = 0L;
 618         int printed_lastold = 0;
 619         regex_t re;
 620         int need_to_free_re = 0;
 621         regmatch_t pm;
 622         Array *search = NULL;
 623
 624         if ((content_type) && (!IsEmptyStr(content_type))) {
 625                 regcomp(&re, content_type, 0);
 626                 need_to_free_re = 1;
 627         }
 628
 629         // Learn about the user and room in question
 630         if (server_shutting_down) {
 631                 if (need_to_free_re) regfree(&re);
 632                 return -1;
 633         }
 634         CtdlGetUser(&CC->user, CC->curr_user);
 635
 636         if (server_shutting_down) {
 637                 if (need_to_free_re) regfree(&re);
 638                 return -1;
 639         }
 640         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 641
 642         if (server_shutting_down) {
 643                 if (need_to_free_re) regfree(&re);
 644                 return -1;
 645         }
 646
 647         // Load the message list
 648         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
 649         if (num_msgs <= 0) {
 650                 free(msglist);
 651                 if (need_to_free_re) regfree(&re);
 652                 return 0;       // No messages at all?  No further action.
 653         }
 654
 655         // Now begin the traversal.
 656         if (num_msgs > 0) for (a = 0; a < num_msgs; ++a) if (msglist[a] > 0) {
 657
 658                 // If the caller is looking for a specific MIME type, filter
 659                 // out all messages which are not of the type requested.
 660                 if ((content_type != NULL) && (!IsEmptyStr(content_type))) {
 661
 662                         // This call to GetMetaData() sits inside this loop
 663                         // so that we only do the extra database read per msg
 664                         // if we need to.  Doing the extra read all the time
 665                         // really kills the server.  If we ever need to use
 666                         // metadata for another search criterion, we need to
 667                         // move the read somewhere else -- but still be smart
 668                         // enough to only do the read if the caller has
 669                         // specified something that will need it.
 670                         if (server_shutting_down) {
 671                                 if (need_to_free_re) regfree(&re);
 672                                 free(msglist);
 673                                 return -1;
 674                         }
 675                         GetMetaData(&smi, msglist[a]);
 676
 677                         if (regexec(&re, smi.meta_content_type, 1, &pm, 0) != 0) {
 678                                 msglist[a] = 0L;
 679                         }
 680                 }
 681         }
 682
 683         num_msgs = sort_msglist(msglist, num_msgs);
 684
 685         // If a template was supplied, filter out the messages which don't match.  (This could induce some delays!)
 686         if (num_msgs > 0) {
 687                 if (compare != NULL) {
 688                         for (a = 0; a < num_msgs; ++a) {
 689                                 if (server_shutting_down) {
 690                                         if (need_to_free_re) regfree(&re);
 691                                         free(msglist);
 692                                         return -1;
 693                                 }
 694                                 msg = CtdlFetchMessage(msglist[a], 1);
 695                                 if (msg != NULL) {
 696                                         if (CtdlMsgCmp(msg, compare)) {
 697                                                 msglist[a] = 0L;
 698                                         }
 699                                         CM_Free(msg);
 700                                 }
 701                         }
 702                 }
 703         }
 704
 705         /* If a search string was specified, get a message list from
 706          * the full text index and remove messages which aren't on both
 707          * lists.
 708          *
 709          * How this works:
 710          * Since the lists are sorted and strictly ascending, and the
 711          * output list is guaranteed to be shorter than or equal to the
 712          * input list, we overwrite the bottom of the input list.  This
 713          * eliminates the need to memmove big chunks of the list over and
 714          * over again.
 715          */
 716         if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
 717
 718                 /* Call search module via hook mechanism.
 719                  * NULL means use any search function available.
 720                  * otherwise replace with a char * to name of search routine
 721                  */
 722                 search = CtdlFullTextSearch(search_string);
 723
 724                 if (array_len(search) > 0) {
 725
 726                         int orig_num_msgs;
 727
 728                         orig_num_msgs = num_msgs;
 729                         num_msgs = 0;
 730                         for (i=0; i<orig_num_msgs; ++i) {
 731                                 for (j=0; j<array_len(search); ++j) {
 732                                         long smsgnum;
 733                                         memcpy(&smsgnum, array_get_element_at(search, j), sizeof(long));
 734                                         if (msglist[i] == smsgnum) {
 735                                                 msglist[num_msgs++] = msglist[i];
 736                                         }
 737                                 }
 738                         }
 739                 }
 740                 else {
 741                         num_msgs = 0;   /* No messages qualify */
 742                 }
 743                 if (search != NULL) array_free(search);
 744
 745                 /* Now that we've purged messages which don't contain the search
 746                  * string, treat a MSGS_SEARCH just like a MSGS_ALL from this
 747                  * point on.
 748                  */
 749                 mode = MSGS_ALL;
 750         }
 751
 752         /*
 753          * Now iterate through the message list, according to the
 754          * criteria supplied by the caller.
 755          */
 756         if (num_msgs > 0)
 757                 for (a = 0; a < num_msgs; ++a) {
 758                         if (server_shutting_down) {
 759                                 if (need_to_free_re) regfree(&re);
 760                                 free(msglist);
 761                                 return num_processed;
 762                         }
 763                         thismsg = msglist[a];
 764                         if (mode == MSGS_ALL) {
 765                                 is_seen = 0;
 766                         }
 767                         else {
 768                                 is_seen = is_msg_in_sequence_set(vbuf.v_seen, thismsg);
 769                                 if (is_seen) lastold = thismsg;
 770                         }
 771                         if (
 772                                 (thismsg > 0L)
 773                         && (
 774                                 (mode == MSGS_ALL)
 775                                 || ((mode == MSGS_OLD) && (is_seen))
 776                                 || ((mode == MSGS_NEW) && (!is_seen))
 777                                 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
 778                                 || ((mode == MSGS_FIRST) && (a < ref))
 779                                 || ((mode == MSGS_GT) && (thismsg > ref))
 780                                 || ((mode == MSGS_LT) && (thismsg < ref))
 781                                 || ((mode == MSGS_EQ) && (thismsg == ref))
 782                             )
 783                             ) {
 784                                 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
 785                                         if (CallBack) {
 786                                                 CallBack(lastold, userdata);
 787                                         }
 788                                         printed_lastold = 1;
 789                                         ++num_processed;
 790                                 }
 791                                 if (CallBack) {
 792                                         CallBack(thismsg, userdata);
 793                                 }
 794                                 ++num_processed;
 795                         }
 796                 }
 797         if (need_to_free_re) regfree(&re);
 798
 799         /*
 800          * We cache the most recent msglist in order to do security checks later
 801          */
 802         if (CC->client_socket > 0) {
 803                 if (CC->cached_msglist != NULL) {
 804                         free(CC->cached_msglist);
 805                 }
 806                 CC->cached_msglist = msglist;
 807                 CC->cached_num_msgs = num_msgs;
 808         }
 809         else {
 810                 free(msglist);
 811         }
 812
 813         return num_processed;
 814 }
 815
 816
 817 /*
 818  * memfmout()  -  Citadel text formatter and paginator.
 819  *           Although the original purpose of this routine was to format
 820  *           text to the reader's screen width, all we're really using it
 821  *           for here is to format text out to 80 columns before sending it
 822  *           to the client.  The client software may reformat it again.
 823  */
 824 void memfmout(
 825         char *mptr,             /* where are we going to get our text from? */
 826         const char *nl          /* string to terminate lines with */
 827 ) {
 828         int column = 0;
 829         unsigned char ch = 0;
 830         char outbuf[1024];
 831         int len = 0;
 832         int nllen = 0;
 833
 834         if (!mptr) return;
 835         nllen = strlen(nl);
 836         while (ch=*(mptr++), ch != 0) {
 837
 838                 if (ch == '\n') {
 839                         if (client_write(outbuf, len) == -1) {
 840                                 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 841                                 return;
 842                         }
 843                         len = 0;
 844                         if (client_write(nl, nllen) == -1) {
 845                                 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 846                                 return;
 847                         }
 848                         column = 0;
 849                 }
 850                 else if (ch == '\r') {
 851                         /* Ignore carriage returns.  Newlines are always LF or CRLF but never CR. */
 852                 }
 853                 else if (isspace(ch)) {
 854                         if (column > 72) {              /* Beyond 72 columns, break on the next space */
 855                                 if (client_write(outbuf, len) == -1) {
 856                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 857                                         return;
 858                                 }
 859                                 len = 0;
 860                                 if (client_write(nl, nllen) == -1) {
 861                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 862                                         return;
 863                                 }
 864                                 column = 0;
 865                         }
 866                         else {
 867                                 outbuf[len++] = ch;
 868                                 ++column;
 869                         }
 870                 }
 871                 else {
 872                         outbuf[len++] = ch;
 873                         ++column;
 874                         if (column > 1000) {            /* Beyond 1000 columns, break anywhere */
 875                                 if (client_write(outbuf, len) == -1) {
 876                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 877                                         return;
 878                                 }
 879                                 len = 0;
 880                                 if (client_write(nl, nllen) == -1) {
 881                                         syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
 882                                         return;
 883                                 }
 884                                 column = 0;
 885                         }
 886                 }
 887         }
 888         if (len) {
 889                 if (client_write(outbuf, len) == -1) {
 890                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
 891                         return;
 892                 }
 893                 client_write(nl, nllen);
 894                 column = 0;
 895         }
 896 }
 897
 898
 899 /*
 900  * Callback function for mime parser that simply lists the part
 901  */
 902 void list_this_part(char *name, char *filename, char *partnum, char *disp,
 903                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 904                     char *cbid, void *cbuserdata)
 905 {
 906         struct ma_info *ma;
 907
 908         ma = (struct ma_info *)cbuserdata;
 909         if (ma->is_ma == 0) {
 910                 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
 911                         name,
 912                         filename,
 913                         partnum,
 914                         disp,
 915                         cbtype,
 916                         (long)length,
 917                         cbid,
 918                         cbcharset);
 919         }
 920 }
 921
 922
 923 /*
 924  * Callback function for multipart prefix
 925  */
 926 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
 927                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 928                     char *cbid, void *cbuserdata)
 929 {
 930         struct ma_info *ma;
 931
 932         ma = (struct ma_info *)cbuserdata;
 933         if (!strcasecmp(cbtype, "multipart/alternative")) {
 934                 ++ma->is_ma;
 935         }
 936
 937         if (ma->is_ma == 0) {
 938                 cprintf("pref=%s|%s\n", partnum, cbtype);
 939         }
 940 }
 941
 942
 943 /*
 944  * Callback function for multipart sufffix
 945  */
 946 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
 947                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
 948                     char *cbid, void *cbuserdata)
 949 {
 950         struct ma_info *ma;
 951
 952         ma = (struct ma_info *)cbuserdata;
 953         if (ma->is_ma == 0) {
 954                 cprintf("suff=%s|%s\n", partnum, cbtype);
 955         }
 956         if (!strcasecmp(cbtype, "multipart/alternative")) {
 957                 --ma->is_ma;
 958         }
 959 }
 960
 961
 962 /*
 963  * Callback function for mime parser that opens a section for downloading
 964  * we use serv_files function here:
 965  */
 966 extern void OpenCmdResult(char *filename, const char *mime_type);
 967 void mime_download(char *name, char *filename, char *partnum, char *disp,
 968                    void *content, char *cbtype, char *cbcharset, size_t length,
 969                    char *encoding, char *cbid, void *cbuserdata)
 970 {
 971         int rv = 0;
 972
 973         /* Silently go away if there's already a download open. */
 974         if (CC->download_fp != NULL)
 975                 return;
 976
 977         if (
 978                 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
 979         ||      (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
 980         ) {
 981                 CC->download_fp = tmpfile();
 982                 if (CC->download_fp == NULL) {
 983                         syslog(LOG_ERR, "msgbase: mime_download() couldn't write: %m");
 984                         cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
 985                         return;
 986                 }
 987
 988                 rv = fwrite(content, length, 1, CC->download_fp);
 989                 if (rv <= 0) {
 990                         syslog(LOG_ERR, "msgbase: mime_download() Couldn't write: %m");
 991                         cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
 992                         fclose(CC->download_fp);
 993                         CC->download_fp = NULL;
 994                         return;
 995                 }
 996                 fflush(CC->download_fp);
 997                 rewind(CC->download_fp);
 998
 999                 OpenCmdResult(filename, cbtype);
1000         }
1001 }
1002
1003
1004 /*
1005  * Callback function for mime parser that outputs a section all at once.
1006  * We can specify the desired section by part number *or* content-id.
1007  */
1008 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
1009                    void *content, char *cbtype, char *cbcharset, size_t length,
1010                    char *encoding, char *cbid, void *cbuserdata)
1011 {
1012         int *found_it = (int *)cbuserdata;
1013
1014         if (
1015                 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1016         ||      (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1017         ) {
1018                 *found_it = 1;
1019                 cprintf("%d %d|-1|%s|%s|%s\n",
1020                         BINARY_FOLLOWS,
1021                         (int)length,
1022                         filename,
1023                         cbtype,
1024                         cbcharset
1025                 );
1026                 client_write(content, length);
1027         }
1028 }
1029
1030
1031 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length) {
1032         struct CtdlMessage *ret = NULL;
1033         const char *mptr;
1034         const char *upper_bound;
1035         cit_uint8_t ch;
1036         cit_uint8_t field_header;
1037         eMsgField which;
1038
1039         mptr = Buffer;
1040         upper_bound = Buffer + Length;
1041         if (msgnum <= 0) {
1042                 return NULL;
1043         }
1044
1045         // Parse the three bytes that begin EVERY message on disk.
1046         // The first is always 0xFF, the on-disk magic number.
1047         // The second is the anonymous/public type byte.
1048         // The third is the format type byte (vari, fixed, or MIME).
1049         //
1050         ch = *mptr++;
1051         if (ch != 255) {
1052                 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1053                 return NULL;
1054         }
1055         ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1056         memset(ret, 0, sizeof(struct CtdlMessage));
1057
1058         ret->cm_magic = CTDLMESSAGE_MAGIC;
1059         ret->cm_anon_type = *mptr++;                            // Anon type byte
1060         ret->cm_format_type = *mptr++;                          // Format type byte
1061
1062         // The rest is zero or more arbitrary fields.  Load them in.
1063         // We're done when we encounter either a zero-length field or
1064         // have just processed the 'M' (message text) field.
1065         //
1066         do {
1067                 field_header = '\0';
1068                 long len;
1069
1070                 while (field_header == '\0') {                  // work around possibly buggy messages
1071                         if (mptr >= upper_bound) {
1072                                 break;
1073                         }
1074                         field_header = *mptr++;
1075                 }
1076                 if (mptr >= upper_bound) {
1077                         break;
1078                 }
1079                 which = field_header;
1080                 len = strlen(mptr);
1081
1082                 CM_SetField(ret, which, mptr);
1083
1084                 mptr += len + 1;                                // advance to next field
1085
1086         } while ((mptr < upper_bound) && (field_header != 'M'));
1087         return (ret);
1088 }
1089
1090
1091 // Load a message from disk into memory.
1092 // This is used by CtdlOutputMsg() and other fetch functions.
1093 //
1094 // NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1095 //       using the CM_Free(); function.
1096 //
1097 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) {
1098         struct cdbdata dmsgtext;
1099         struct CtdlMessage *ret = NULL;
1100
1101         syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1102         dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1103         if (dmsgtext.ptr == NULL) {
1104                 syslog(LOG_ERR, "msgbase: message #%ld was not found", msgnum);
1105                 return NULL;
1106         }
1107
1108         if (dmsgtext.ptr[dmsgtext.len - 1] != '\0') {
1109                 // FIXME LMDB cannot write to immutable memory
1110                 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1111                 dmsgtext.ptr[dmsgtext.len - 1] = '\0';
1112         }
1113
1114         ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext.ptr, dmsgtext.len);
1115         if (ret == NULL) {
1116                 return NULL;
1117         }
1118
1119         // Always make sure there's something in the msg text field.  If
1120         // it's NULL, the message text is most likely stored separately,
1121         // so go ahead and fetch that.  Failing that, just set a dummy
1122         // body so other code doesn't barf.
1123         //
1124         if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) {
1125                 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1126                 if (dmsgtext.ptr != NULL) {
1127                         CM_SetField(ret, eMesageText, dmsgtext.ptr);
1128                 }
1129         }
1130         if (CM_IsEmpty(ret, eMesageText)) {
1131                 CM_SetField(ret, eMesageText, "\r\n\r\n (no text)\r\n");
1132         }
1133
1134         return (ret);
1135 }
1136
1137
1138 // Pre callback function for multipart/alternative
1139 //
1140 // NOTE: this differs from the standard behavior for a reason.  Normally when
1141 //       displaying multipart/alternative you want to show the _last_ usable
1142 //       format in the message.  Here we show the _first_ one, because it's
1143 //       usually text/plain.  Since this set of functions is designed for text
1144 //       output to non-MIME-aware clients, this is the desired behavior.
1145 //
1146 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1147                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1148                 char *cbid, void *cbuserdata)
1149 {
1150         struct ma_info *ma;
1151
1152         ma = (struct ma_info *)cbuserdata;
1153         syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);
1154         if (!strcasecmp(cbtype, "multipart/alternative")) {
1155                 ++ma->is_ma;
1156                 ma->did_print = 0;
1157         }
1158         if (!strcasecmp(cbtype, "message/rfc822")) {
1159                 ++ma->freeze;
1160         }
1161 }
1162
1163
1164 //
1165 // Post callback function for multipart/alternative
1166 //
1167 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1168                 void *content, char *cbtype, char *cbcharset, size_t length,
1169                 char *encoding, char *cbid, void *cbuserdata)
1170 {
1171         struct ma_info *ma;
1172
1173         ma = (struct ma_info *)cbuserdata;
1174         syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);
1175         if (!strcasecmp(cbtype, "multipart/alternative")) {
1176                 --ma->is_ma;
1177                 ma->did_print = 0;
1178         }
1179         if (!strcasecmp(cbtype, "message/rfc822")) {
1180                 --ma->freeze;
1181         }
1182 }
1183
1184
1185 // Inline callback function for mime parser that wants to display text
1186 void fixed_output(char *name, char *filename, char *partnum, char *disp,
1187                 void *content, char *cbtype, char *cbcharset, size_t length,
1188                 char *encoding, char *cbid, void *cbuserdata)
1189 {
1190         char *ptr;
1191         char *wptr;
1192         size_t wlen;
1193         struct ma_info *ma;
1194
1195         ma = (struct ma_info *)cbuserdata;
1196
1197         syslog(LOG_DEBUG,
1198                 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1199                 partnum, filename, cbtype, (long)length
1200         );
1201
1202         // If we're in the middle of a multipart/alternative scope and
1203         // we've already printed another section, skip this one.
1204         if ( (ma->is_ma) && (ma->did_print) ) {
1205                 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1206                 return;
1207         }
1208         ma->did_print = 1;
1209
1210         if ( (!strcasecmp(cbtype, "text/plain"))
1211            || (IsEmptyStr(cbtype)) ) {
1212                 wptr = content;
1213                 if (length > 0) {
1214                         client_write(wptr, length);
1215                         if (wptr[length-1] != '\n') {
1216                                 cprintf("\n");
1217                         }
1218                 }
1219                 return;
1220         }
1221
1222         if (!strcasecmp(cbtype, "text/html")) {
1223                 ptr = html_to_ascii(content, length, 80, 0);
1224                 wlen = strlen(ptr);
1225                 client_write(ptr, wlen);
1226                 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1227                         cprintf("\n");
1228                 }
1229                 free(ptr);
1230                 return;
1231         }
1232
1233         if (ma->use_fo_hooks) {
1234                 if (PerformFixedOutputHooks(cbtype, content, length)) {         // returns nonzero if it handled the part
1235                         return;
1236                 }
1237         }
1238
1239         if (strncasecmp(cbtype, "multipart/", 10)) {
1240                 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1241                         partnum, filename, cbtype, (long)length);
1242                 return;
1243         }
1244 }
1245
1246
1247 // The client is elegant and sophisticated and wants to be choosy about
1248 // MIME content types, so figure out which multipart/alternative part
1249 // we're going to send.
1250 //
1251 // We use a system of weights.  When we find a part that matches one of the
1252 // MIME types we've declared as preferential, we can store it in ma->chosen_part
1253 // and then set ma->chosen_pref to that MIME type's position in our preference
1254 // list.  If we then hit another match, we only replace the first match if
1255 // the preference value is lower.
1256 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1257                 void *content, char *cbtype, char *cbcharset, size_t length,
1258                 char *encoding, char *cbid, void *cbuserdata)
1259 {
1260         char buf[1024];
1261         int i;
1262         struct ma_info *ma;
1263
1264         ma = (struct ma_info *)cbuserdata;
1265
1266         for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1267                 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1268                 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1269                         if (i < ma->chosen_pref) {
1270                                 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1271                                 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1272                                 ma->chosen_pref = i;
1273                         }
1274                 }
1275         }
1276 }
1277
1278
1279 // Now that we've chosen our preferred part, output it.
1280 void output_preferred(char *name,
1281                       char *filename,
1282                       char *partnum,
1283                       char *disp,
1284                       void *content,
1285                       char *cbtype,
1286                       char *cbcharset,
1287                       size_t length,
1288                       char *encoding,
1289                       char *cbid,
1290                       void *cbuserdata)
1291 {
1292         int i;
1293         char buf[128];
1294         int add_newline = 0;
1295         char *text_content;
1296         struct ma_info *ma;
1297         char *decoded = NULL;
1298         size_t bytes_decoded;
1299         int rc = 0;
1300
1301         ma = (struct ma_info *)cbuserdata;
1302
1303         // This is not the MIME part you're looking for...
1304         if (strcasecmp(partnum, ma->chosen_part)) return;
1305
1306         // If the content-type of this part is in our preferred formats
1307         // list, we can simply output it verbatim.
1308         for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1309                 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1310                 if (!strcasecmp(buf, cbtype)) {
1311                         /* Yeah!  Go!  W00t!! */
1312                         if (ma->dont_decode == 0)
1313                                 rc = mime_decode_now (content,
1314                                                       length,
1315                                                       encoding,
1316                                                       &decoded,
1317                                                       &bytes_decoded);
1318                         if (rc < 0)
1319                                 break; // Give us the chance, maybe theres another one.
1320
1321                         if (rc == 0) text_content = (char *)content;
1322                         else {
1323                                 text_content = decoded;
1324                                 length = bytes_decoded;
1325                         }
1326
1327                         if (text_content[length-1] != '\n') {
1328                                 ++add_newline;
1329                         }
1330                         cprintf("Content-type: %s", cbtype);
1331                         if (!IsEmptyStr(cbcharset)) {
1332                                 cprintf("; charset=%s", cbcharset);
1333                         }
1334                         cprintf("\nContent-length: %d\n",
1335                                 (int)(length + add_newline) );
1336                         if (!IsEmptyStr(encoding)) {
1337                                 cprintf("Content-transfer-encoding: %s\n", encoding);
1338                         }
1339                         else {
1340                                 cprintf("Content-transfer-encoding: 7bit\n");
1341                         }
1342                         cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1343                         cprintf("\n");
1344                         if (client_write(text_content, length) == -1)
1345                         {
1346                                 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1347                                 return;
1348                         }
1349                         if (add_newline) cprintf("\n");
1350                         if (decoded != NULL) free(decoded);
1351                         return;
1352                 }
1353         }
1354
1355         // No translations required or possible: output as text/plain
1356         cprintf("Content-type: text/plain\n\n");
1357         rc = 0;
1358         if (ma->dont_decode == 0)
1359                 rc = mime_decode_now (content,
1360                                       length,
1361                                       encoding,
1362                                       &decoded,
1363                                       &bytes_decoded);
1364         if (rc < 0)
1365                 return; // Give us the chance, maybe theres another one.
1366
1367         if (rc == 0) text_content = (char *)content;
1368         else {
1369                 text_content = decoded;
1370                 length = bytes_decoded;
1371         }
1372
1373         fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, length, encoding, cbid, cbuserdata);
1374         if (decoded != NULL) free(decoded);
1375 }
1376
1377
1378 struct encapmsg {
1379         char desired_section[64];
1380         char *msg;
1381         size_t msglen;
1382 };
1383
1384
1385 // Callback function
1386 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1387                    void *content, char *cbtype, char *cbcharset, size_t length,
1388                    char *encoding, char *cbid, void *cbuserdata)
1389 {
1390         struct encapmsg *encap;
1391
1392         encap = (struct encapmsg *)cbuserdata;
1393
1394         // Only proceed if this is the desired section...
1395         if (!strcasecmp(encap->desired_section, partnum)) {
1396                 encap->msglen = length;
1397                 encap->msg = malloc(length + 2);
1398                 memcpy(encap->msg, content, length);
1399                 return;
1400         }
1401 }
1402
1403
1404 // Determine whether the specified message exists in the cached_msglist
1405 // (This is a security check)
1406 int check_cached_msglist(long msgnum) {
1407
1408         // cases in which we skip the check
1409         if (!CC) return om_ok;                                          // not a session
1410         if (CC->client_socket <= 0) return om_ok;                       // not a client session
1411         if (CC->cached_msglist == NULL) return om_access_denied;        // no msglist fetched
1412         if (CC->cached_num_msgs == 0) return om_access_denied;          // nothing to check
1413
1414         // Do a binary search within the cached_msglist for the requested msgnum
1415         int min = 0;
1416         int max = (CC->cached_num_msgs - 1);
1417
1418         while (max >= min) {
1419                 int middle = min + (max-min) / 2 ;
1420                 if (msgnum == CC->cached_msglist[middle]) {
1421                         return om_ok;
1422                 }
1423                 if (msgnum > CC->cached_msglist[middle]) {
1424                         min = middle + 1;
1425                 }
1426                 else {
1427                         max = middle - 1;
1428                 }
1429         }
1430
1431         return om_access_denied;
1432 }
1433
1434
1435 // Get a message off disk.  (returns om_* values found in msgbase.h)
1436 int CtdlOutputMsg(long msg_num,         // message number (local) to fetch
1437                 int mode,               // how would you like that message?
1438                 int headers_only,       // eschew the message body?
1439                 int do_proto,           // do Citadel protocol responses?
1440                 int crlf,               // Use CRLF newlines instead of LF?
1441                 char *section,          // NULL or a message/rfc822 section
1442                 int flags,              // various flags; see msgbase.h
1443                 char **Author,
1444                 char **Address,
1445                 char **MessageID
1446 ) {
1447         struct CtdlMessage *TheMessage = NULL;
1448         int retcode = CIT_OK;
1449         struct encapmsg encap;
1450         int r;
1451
1452         syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)",
1453                 msg_num, mode,
1454                 (section ? section : "<>")
1455         );
1456
1457         r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1458         if (r != om_ok) {
1459                 if (do_proto) {
1460                         if (r == om_not_logged_in) {
1461                                 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1462                         }
1463                         else {
1464                                 cprintf("%d An unknown error has occurred.\n", ERROR);
1465                         }
1466                 }
1467                 return(r);
1468         }
1469
1470         // Check to make sure the message is actually IN this room
1471         r = check_cached_msglist(msg_num);
1472         if (r == om_access_denied) {
1473                 // Not in the cache?  We get ONE shot to check it again.
1474                 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1475                 r = check_cached_msglist(msg_num);
1476         }
1477         if (r != om_ok) {
1478                 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s",
1479                            msg_num, CC->room.QRname
1480                 );
1481                 if (do_proto) {
1482                         if (r == om_access_denied) {
1483                                 cprintf("%d message %ld was not found in this room\n",
1484                                         ERROR + HIGHER_ACCESS_REQUIRED,
1485                                         msg_num
1486                                 );
1487                         }
1488                 }
1489                 return(r);
1490         }
1491
1492         // Fetch the message from disk.  If we're in HEADERS_FAST mode, request that we don't even bother loading the body into memory.
1493         if (headers_only == HEADERS_FAST) {
1494                 TheMessage = CtdlFetchMessage(msg_num, 0);
1495         }
1496         else {
1497                 TheMessage = CtdlFetchMessage(msg_num, 1);
1498         }
1499
1500         if (TheMessage == NULL) {
1501                 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n",
1502                         ERROR + MESSAGE_NOT_FOUND, msg_num);
1503                 return(om_no_such_msg);
1504         }
1505
1506         // Here is the weird form of this command, to process only an encapsulated message/rfc822 section.
1507         if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1508                 memset(&encap, 0, sizeof encap);
1509                 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1510                 mime_parser(CM_RANGE(TheMessage, eMesageText),
1511                             *extract_encapsulated_message,
1512                             NULL, NULL, (void *)&encap, 0
1513                         );
1514
1515                 if ((Author != NULL) && (*Author == NULL)) {
1516                         long len;
1517                         CM_GetAsField(TheMessage, eAuthor, Author, &len);
1518                 }
1519                 if ((Address != NULL) && (*Address == NULL)) {
1520                         long len;
1521                         CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1522                 }
1523                 if ((MessageID != NULL) && (*MessageID == NULL)) {
1524                         long len;
1525                         CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1526                 }
1527                 CM_Free(TheMessage);
1528                 TheMessage = NULL;
1529
1530                 if (encap.msg) {
1531                         encap.msg[encap.msglen] = 0;
1532                         TheMessage = convert_internet_message(encap.msg);
1533                         encap.msg = NULL;       // no free() here, TheMessage owns it now
1534
1535                         // Now we let it fall through to the bottom of this function, because TheMessage now contains the
1536                         // encapsulated message instead of the top-level message.  Isn't that neat?
1537                 }
1538                 else {
1539                         if (do_proto) {
1540                                 cprintf("%d msg %ld has no part %s\n", ERROR + MESSAGE_NOT_FOUND, msg_num, section);
1541                         }
1542                         retcode = om_no_such_msg;
1543                 }
1544
1545         }
1546
1547         // Ok, output the message now
1548         if (retcode == CIT_OK) {
1549                 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1550         }
1551         if ((Author != NULL) && (*Author == NULL)) {
1552                 long len;
1553                 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1554         }
1555         if ((Address != NULL) && (*Address == NULL)) {
1556                 long len;
1557                 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1558         }
1559         if ((MessageID != NULL) && (*MessageID == NULL)) {
1560                 long len;
1561                 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1562         }
1563
1564         CM_Free(TheMessage);
1565
1566         return(retcode);
1567 }
1568
1569
1570 void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) {
1571         int i;
1572         char buf[SIZ];
1573         char display_name[256];
1574
1575         /* begin header processing loop for Citadel message format */
1576         safestrncpy(display_name, "<unknown>", sizeof display_name);
1577         if (!CM_IsEmpty(TheMessage, eAuthor)) {
1578                 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1579                 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1580                         safestrncpy(display_name, "****", sizeof display_name);
1581                 }
1582                 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1583                         safestrncpy(display_name, "anonymous", sizeof display_name);
1584                 }
1585                 else {
1586                         safestrncpy(display_name, buf, sizeof display_name);
1587                 }
1588                 if ((is_room_aide())
1589                     && ((TheMessage->cm_anon_type == MES_ANONONLY)
1590                         || (TheMessage->cm_anon_type == MES_ANONOPT))) {
1591                         size_t tmp = strlen(display_name);
1592                         snprintf(&display_name[tmp],
1593                                  sizeof display_name - tmp,
1594                                  " [%s]", buf);
1595                 }
1596         }
1597
1598         /* Now spew the header fields in the order we like them. */
1599         for (i=0; i< NDiskFields; ++i) {
1600                 eMsgField Field;
1601                 Field = FieldOrder[i];
1602                 if (Field != eMesageText) {
1603                         if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) {
1604                                 if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) {
1605                                         sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1606                                 }
1607                                 if (Field == eAuthor) {
1608                                         if (do_proto) {
1609                                                 cprintf("%s=%s\n", msgkeys[Field], display_name);
1610                                         }
1611                                 }
1612                                 /* Masquerade display name if needed */
1613                                 else {
1614                                         if (do_proto) {
1615                                                 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1616                                         }
1617                                 }
1618                                 /* Give the client a hint about whether the message originated locally */
1619                                 if (Field == erFc822Addr) {
1620                                         if (IsDirectory(TheMessage->cm_fields[Field] ,0)) {
1621                                                 cprintf("locl=yes\n");                          // message originated locally.
1622                                         }
1623
1624
1625
1626                                 }
1627                         }
1628                 }
1629         }
1630 }
1631
1632
1633 void OutputRFC822MsgHeaders(
1634         struct CtdlMessage *TheMessage,
1635         int flags,              /* should the message be exported clean */
1636         const char *nl, int nlen,
1637         char *mid, long sizeof_mid,
1638         char *suser, long sizeof_suser,
1639         char *luser, long sizeof_luser,
1640         char *fuser, long sizeof_fuser,
1641         char *snode, long sizeof_snode)
1642 {
1643         char datestamp[100];
1644         int subject_found = 0;
1645         char buf[SIZ];
1646         int i, j, k;
1647         char *mptr = NULL;
1648         char *mpptr = NULL;
1649         char *hptr;
1650
1651         for (i = 0; i < NDiskFields; ++i) {
1652                 if (TheMessage->cm_fields[FieldOrder[i]]) {
1653                         mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1654                         switch (FieldOrder[i]) {
1655                         case eAuthor:
1656                                 safestrncpy(luser, mptr, sizeof_luser);
1657                                 safestrncpy(suser, mptr, sizeof_suser);
1658                                 break;
1659                         case eCarbonCopY:
1660                                 if ((flags & QP_EADDR) != 0) {
1661                                         mptr = qp_encode_email_addrs(mptr);
1662                                 }
1663                                 sanitize_truncated_recipient(mptr);
1664                                 cprintf("CC: %s%s", mptr, nl);
1665                                 break;
1666                         case eMessagePath:
1667                                 cprintf("Return-Path: %s%s", mptr, nl);
1668                                 break;
1669                         case eListID:
1670                                 cprintf("List-ID: %s%s", mptr, nl);
1671                                 break;
1672                         case eenVelopeTo:
1673                                 if ((flags & QP_EADDR) != 0)
1674                                         mptr = qp_encode_email_addrs(mptr);
1675                                 hptr = mptr;
1676                                 while ((*hptr != '\0') && isspace(*hptr))
1677                                         hptr ++;
1678                                 if (!IsEmptyStr(hptr))
1679                                         cprintf("Envelope-To: %s%s", hptr, nl);
1680                                 break;
1681                         case eMsgSubject:
1682                                 cprintf("Subject: %s%s", mptr, nl);
1683                                 subject_found = 1;
1684                                 break;
1685                         case emessageId:
1686                                 safestrncpy(mid, mptr, sizeof_mid);
1687                                 break;
1688                         case erFc822Addr:
1689                                 safestrncpy(fuser, mptr, sizeof_fuser);
1690                                 break;
1691                         case eRecipient:
1692                                 if (haschar(mptr, '@') == 0) {
1693                                         sanitize_truncated_recipient(mptr);
1694                                         cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1695                                         cprintf("%s", nl);
1696                                 }
1697                                 else {
1698                                         if ((flags & QP_EADDR) != 0) {
1699                                                 mptr = qp_encode_email_addrs(mptr);
1700                                         }
1701                                         sanitize_truncated_recipient(mptr);
1702                                         cprintf("To: %s", mptr);
1703                                         cprintf("%s", nl);
1704                                 }
1705                                 break;
1706                         case eTimestamp:
1707                                 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1708                                 cprintf("Date: %s%s", datestamp, nl);
1709                                 break;
1710                         case eWeferences:
1711                                 cprintf("References: ");
1712                                 k = num_tokens(mptr, '|');
1713                                 for (j=0; j<k; ++j) {
1714                                         extract_token(buf, mptr, j, '|', sizeof buf);
1715                                         cprintf("<%s>", buf);
1716                                         if (j == (k-1)) {
1717                                                 cprintf("%s", nl);
1718                                         }
1719                                         else {
1720                                                 cprintf(" ");
1721                                         }
1722                                 }
1723                                 break;
1724                         case eReplyTo:
1725                                 hptr = mptr;
1726                                 while ((*hptr != '\0') && isspace(*hptr))
1727                                         hptr ++;
1728                                 if (!IsEmptyStr(hptr))
1729                                         cprintf("Reply-To: %s%s", mptr, nl);
1730                                 break;
1731
1732                         case eExclusiveID:
1733                         case eJournal:
1734                         case eMesageText:
1735                         case eBig_message:
1736                         case eOriginalRoom:
1737                         case eErrorMsg:
1738                         case eSuppressIdx:
1739                         case eExtnotify:
1740                         case eVltMsgNum:
1741                                 /* these don't map to mime message headers. */
1742                                 break;
1743                         }
1744                         if (mptr != mpptr) {
1745                                 free (mptr);
1746                         }
1747                 }
1748         }
1749         if (subject_found == 0) {
1750                 cprintf("Subject: (no subject)%s", nl);
1751         }
1752 }
1753
1754
1755 void Dump_RFC822HeadersBody(
1756         struct CtdlMessage *TheMessage,
1757         int headers_only,       /* eschew the message body? */
1758         int flags,              /* should the bessage be exported clean? */
1759         const char *nl, int nlen)
1760 {
1761         cit_uint8_t prev_ch;
1762         int eoh = 0;
1763         const char *StartOfText = StrBufNOTNULL;
1764         char outbuf[1024];
1765         int outlen = 0;
1766         int nllen = strlen(nl);
1767         char *mptr;
1768         int lfSent = 0;
1769
1770         mptr = TheMessage->cm_fields[eMesageText];
1771
1772         prev_ch = '\0';
1773         while (*mptr != '\0') {
1774                 if (*mptr == '\r') {
1775                         /* do nothing */
1776                 }
1777                 else {
1778                         if ((!eoh) &&
1779                             (*mptr == '\n'))
1780                         {
1781                                 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1782                                 if (!eoh)
1783                                         eoh = *(mptr+1) == '\n';
1784                                 if (eoh)
1785                                 {
1786                                         StartOfText = mptr;
1787                                         StartOfText = strchr(StartOfText, '\n');
1788                                         StartOfText = strchr(StartOfText, '\n');
1789                                 }
1790                         }
1791                         if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1792                             ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1793                             ((headers_only != HEADERS_NONE) &&
1794                              (headers_only != HEADERS_ONLY))
1795                         ) {
1796                                 if (*mptr == '\n') {
1797                                         memcpy(&outbuf[outlen], nl, nllen);
1798                                         outlen += nllen;
1799                                         outbuf[outlen] = '\0';
1800                                 }
1801                                 else {
1802                                         outbuf[outlen++] = *mptr;
1803                                 }
1804                         }
1805                 }
1806                 if (flags & ESC_DOT) {
1807                         if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1808                                 outbuf[outlen++] = '.';
1809                         }
1810                         prev_ch = *mptr;
1811                 }
1812                 ++mptr;
1813                 if (outlen > 1000) {
1814                         if (client_write(outbuf, outlen) == -1) {
1815                                 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1816                                 return;
1817                         }
1818                         lfSent =  (outbuf[outlen - 1] == '\n');
1819                         outlen = 0;
1820                 }
1821         }
1822         if (outlen > 0) {
1823                 client_write(outbuf, outlen);
1824                 lfSent =  (outbuf[outlen - 1] == '\n');
1825         }
1826         if (!lfSent)
1827                 client_write(nl, nlen);
1828 }
1829
1830
1831 /* If the format type on disk is 1 (fixed-format), then we want
1832  * everything to be output completely literally ... regardless of
1833  * what message transfer format is in use.
1834  */
1835 void DumpFormatFixed(
1836         struct CtdlMessage *TheMessage,
1837         int mode,               /* how would you like that message? */
1838         const char *nl, int nllen)
1839 {
1840         cit_uint8_t ch;
1841         char buf[SIZ];
1842         int buflen;
1843         int xlline = 0;
1844         char *mptr;
1845
1846         mptr = TheMessage->cm_fields[eMesageText];
1847
1848         if (mode == MT_MIME) {
1849                 cprintf("Content-type: text/plain\n\n");
1850         }
1851         *buf = '\0';
1852         buflen = 0;
1853         while (ch = *mptr++, ch > 0) {
1854                 if (ch == '\n')
1855                         ch = '\r';
1856
1857                 if ((buflen > 250) && (!xlline)){
1858                         int tbuflen;
1859                         tbuflen = buflen;
1860
1861                         while ((buflen > 0) &&
1862                                (!isspace(buf[buflen])))
1863                                 buflen --;
1864                         if (buflen == 0) {
1865                                 xlline = 1;
1866                         }
1867                         else {
1868                                 mptr -= tbuflen - buflen;
1869                                 buf[buflen] = '\0';
1870                                 ch = '\r';
1871                         }
1872                 }
1873
1874                 /* if we reach the outer bounds of our buffer, abort without respect for what we purge. */
1875                 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1876                         ch = '\r';
1877                 }
1878
1879                 if (ch == '\r') {
1880                         memcpy (&buf[buflen], nl, nllen);
1881                         buflen += nllen;
1882                         buf[buflen] = '\0';
1883
1884                         if (client_write(buf, buflen) == -1) {
1885                                 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
1886                                 return;
1887                         }
1888                         *buf = '\0';
1889                         buflen = 0;
1890                         xlline = 0;
1891                 } else {
1892                         buf[buflen] = ch;
1893                         buflen++;
1894                 }
1895         }
1896         buf[buflen] = '\0';
1897         if (!IsEmptyStr(buf)) {
1898                 cprintf("%s%s", buf, nl);
1899         }
1900 }
1901
1902
1903 // Get a message off disk.  (returns om_* values found in msgbase.h)
1904 int CtdlOutputPreLoadedMsg(
1905                 struct CtdlMessage *TheMessage,
1906                 int mode,               // how would you like that message?
1907                 int headers_only,       // eschew the message body?
1908                 int do_proto,           // do Citadel protocol responses?
1909                 int crlf,               // Use CRLF newlines instead of LF?
1910                 int flags               // should the bessage be exported clean?
1911 ) {
1912         int i;
1913         const char *nl; // newline string
1914         int nlen;
1915         struct ma_info ma;
1916
1917         // Buffers needed for RFC822 translation.  These are all filled
1918         // using functions that are bounds-checked, and therefore we can
1919         // make them substantially smaller than SIZ.
1920         char suser[1024];
1921         char luser[1024];
1922         char fuser[1024];
1923         char snode[1024];
1924         char mid[1024];
1925
1926         syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
1927                    ((TheMessage == NULL) ? "NULL" : "not null"),
1928                    mode, headers_only, do_proto, crlf
1929         );
1930
1931         strcpy(mid, "unknown");
1932         nl = (crlf ? "\r\n" : "\n");
1933         nlen = crlf ? 2 : 1;
1934
1935         if (!CM_IsValidMsg(TheMessage)) {
1936                 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
1937                 return(om_no_such_msg);
1938         }
1939
1940         // Suppress envelope recipients if required to avoid disclosing BCC addresses.
1941         // Pad it with spaces in order to avoid changing the RFC822 length of the message.
1942         if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
1943                 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
1944         }
1945
1946         // Are we downloading a MIME component?
1947         if (mode == MT_DOWNLOAD) {
1948                 if (TheMessage->cm_format_type != FMT_RFC822) {
1949                         if (do_proto) {
1950                                 cprintf("%d This is not a MIME message.\n", ERROR + ILLEGAL_VALUE);
1951                         }
1952                 }
1953                 else if (CC->download_fp != NULL) {
1954                         if (do_proto) {
1955                                 cprintf( "%d You already have a download open.\n", ERROR + RESOURCE_BUSY);
1956                         }
1957                 }
1958                 else {
1959                         // Parse the message text component
1960                         mime_parser(CM_RANGE(TheMessage, eMesageText), *mime_download, NULL, NULL, NULL, 0);
1961
1962                         // If there's no file open by this time, the requested * section wasn't found, so print an error
1963                         if (CC->download_fp == NULL) {
1964                                 if (do_proto) {
1965                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1966                                 }
1967                         }
1968                 }
1969                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1970         }
1971
1972         // MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
1973         // in a single server operation instead of opening a download file.
1974         if (mode == MT_SPEW_SECTION) {
1975                 if (TheMessage->cm_format_type != FMT_RFC822) {
1976                         if (do_proto)
1977                                 cprintf("%d This is not a MIME message.\n",
1978                                 ERROR + ILLEGAL_VALUE);
1979                 }
1980                 else {
1981                         // Locate and parse the component specified by the caller
1982                         int found_it = 0;
1983                         mime_parser(CM_RANGE(TheMessage, eMesageText), *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
1984
1985                         // If section wasn't found, print an error
1986                         if (!found_it) {
1987                                 if (do_proto) {
1988                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1989                                 }
1990                         }
1991                 }
1992                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1993         }
1994
1995         // now for the user-mode message reading loops
1996         if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
1997
1998         // Does the caller want to skip the headers?
1999         if (headers_only == HEADERS_NONE) goto START_TEXT;
2000
2001         // Tell the client which format type we're using.
2002         if ( (mode == MT_CITADEL) && (do_proto) ) {
2003                 cprintf("type=%d\n", TheMessage->cm_format_type);       // Tell the client which format type we're using.
2004         }
2005
2006         // nhdr=yes means that we're only displaying headers, no body
2007         if ( (TheMessage->cm_anon_type == MES_ANONONLY)
2008            && ((mode == MT_CITADEL) || (mode == MT_MIME))
2009            && (do_proto)
2010            ) {
2011                 cprintf("nhdr=yes\n");
2012         }
2013
2014         if ((mode == MT_CITADEL) || (mode == MT_MIME)) {
2015                 OutputCtdlMsgHeaders(TheMessage, do_proto);
2016         }
2017
2018         // begin header processing loop for RFC822 transfer format
2019         strcpy(suser, "");
2020         strcpy(luser, "");
2021         strcpy(fuser, "");
2022         strcpy(snode, "");
2023         if (mode == MT_RFC822) {
2024                 OutputRFC822MsgHeaders(
2025                         TheMessage,
2026                         flags,
2027                         nl, nlen,
2028                         mid, sizeof(mid),
2029                         suser, sizeof(suser),
2030                         luser, sizeof(luser),
2031                         fuser, sizeof(fuser),
2032                         snode, sizeof(snode)
2033                 );
2034         }
2035
2036         for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2037                 suser[i] = tolower(suser[i]);
2038                 if (!isalnum(suser[i])) suser[i]='_';
2039         }
2040
2041         if (mode == MT_RFC822) {
2042                 // Construct a fun message id
2043                 cprintf("Message-ID: <%s", mid);
2044                 if (strchr(mid, '@')==NULL) {
2045                         cprintf("@%s", snode);
2046                 }
2047                 cprintf(">%s", nl);
2048
2049                 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2050                         cprintf("From: \"----\" <x@x.org>%s", nl);
2051                 }
2052                 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2053                         cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2054                 }
2055                 else if (!IsEmptyStr(fuser)) {
2056                         cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2057                 }
2058                 else {
2059                         cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2060                 }
2061
2062                 // Blank line signifying RFC822 end-of-headers
2063                 if (TheMessage->cm_format_type != FMT_RFC822) {
2064                         cprintf("%s", nl);
2065                 }
2066         }
2067
2068         // end header processing loop ... at this point, we're in the text
2069 START_TEXT:
2070         if (headers_only == HEADERS_FAST) goto DONE;
2071
2072         // Tell the client about the MIME parts in this message
2073         if (TheMessage->cm_format_type == FMT_RFC822) {
2074                 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2075                         memset(&ma, 0, sizeof(struct ma_info));
2076                         mime_parser(CM_RANGE(TheMessage, eMesageText),
2077                                 (do_proto ? *list_this_part : NULL),
2078                                 (do_proto ? *list_this_pref : NULL),
2079                                 (do_proto ? *list_this_suff : NULL),
2080                                 (void *)&ma, 1);
2081                 }
2082                 else if (mode == MT_RFC822) {   // unparsed RFC822 dump
2083                         Dump_RFC822HeadersBody(
2084                                 TheMessage,
2085                                 headers_only,
2086                                 flags,
2087                                 nl, nlen);
2088                         goto DONE;
2089                 }
2090         }
2091
2092         if (headers_only == HEADERS_ONLY) {
2093                 goto DONE;
2094         }
2095
2096         // signify start of msg text
2097         if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2098                 if (do_proto) cprintf("text\n");
2099         }
2100
2101         if (TheMessage->cm_format_type == FMT_FIXED)
2102                 DumpFormatFixed(
2103                         TheMessage,
2104                         mode,           // how would you like that message?
2105                         nl, nlen);
2106
2107         // If the message on disk is format 0 (Citadel vari-format), we
2108         // output using the formatter at 80 columns.  This is the final output
2109         // form if the transfer format is RFC822, but if the transfer format
2110         // is Citadel proprietary, it'll still work, because the indentation
2111         // for new paragraphs is correct and the client will reformat the
2112         // message to the reader's screen width.
2113         //
2114         if (TheMessage->cm_format_type == FMT_CITADEL) {
2115                 if (mode == MT_MIME) {
2116                         cprintf("Content-type: text/x-citadel-variformat\n\n");
2117                 }
2118                 memfmout(TheMessage->cm_fields[eMesageText], nl);
2119         }
2120
2121         // If the message on disk is format 4 (MIME), we've gotta hand it
2122         // off to the MIME parser.  The client has already been told that
2123         // this message is format 1 (fixed format), so the callback function
2124         // we use will display those parts as-is.
2125         //
2126         if (TheMessage->cm_format_type == FMT_RFC822) {
2127                 memset(&ma, 0, sizeof(struct ma_info));
2128
2129                 if (mode == MT_MIME) {
2130                         ma.use_fo_hooks = 0;
2131                         strcpy(ma.chosen_part, "1");
2132                         ma.chosen_pref = 9999;
2133                         ma.dont_decode = CC->msg4_dont_decode;
2134                         mime_parser(CM_RANGE(TheMessage, eMesageText),
2135                                     *choose_preferred, *fixed_output_pre,
2136                                     *fixed_output_post, (void *)&ma, 1);
2137                         mime_parser(CM_RANGE(TheMessage, eMesageText),
2138                                     *output_preferred, NULL, NULL, (void *)&ma, 1);
2139                 }
2140                 else {
2141                         ma.use_fo_hooks = 1;
2142                         mime_parser(CM_RANGE(TheMessage, eMesageText),
2143                                     *fixed_output, *fixed_output_pre,
2144                                     *fixed_output_post, (void *)&ma, 0);
2145                 }
2146
2147         }
2148
2149 DONE:   // now we're done
2150         if (do_proto) cprintf("000\n");
2151         return(om_ok);
2152 }
2153
2154 // Save one or more message pointers into a specified room
2155 // (Returns 0 for success, nonzero for failure)
2156 // roomname may be NULL to use the current room
2157 //
2158 // Note that the 'supplied_msg' field may be set to NULL, in which case
2159 // the message will be fetched from disk, by number, if we need to perform
2160 // replication checks.  This adds an additional database read, so if the
2161 // caller already has the message in memory then it should be supplied.  (Obviously
2162 // this mode of operation only works if we're saving a single message.)
2163 //
2164 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2165                         int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj
2166 ) {
2167         int i, j, unique;
2168         char hold_rm[ROOMNAMELEN];
2169         struct cdbdata *cdbfr;
2170         int num_msgs;
2171         long *msglist;
2172         long highest_msg = 0L;
2173
2174         long msgid = 0;
2175         struct CtdlMessage *msg = NULL;
2176
2177         long *msgs_to_be_merged = NULL;
2178         int num_msgs_to_be_merged = 0;
2179
2180         syslog(LOG_DEBUG,
2181                 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2182                 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2183         );
2184
2185         strcpy(hold_rm, CC->room.QRname);
2186
2187         // Sanity checks
2188         if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2189         if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2190         if (num_newmsgs > 1) supplied_msg = NULL;
2191
2192         // Now the regular stuff
2193         if (CtdlGetRoomLock(&CC->room, ((roomname != NULL) ? roomname : CC->room.QRname) ) != 0) {
2194                 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2195                 return(ERROR + ROOM_NOT_FOUND);
2196         }
2197
2198         msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2199         num_msgs_to_be_merged = 0;
2200         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
2201
2202         // Create a list of msgid's which were supplied by the caller, but do
2203         // not already exist in the target room.  It is absolutely taboo to
2204         // have more than one reference to the same message in a room.
2205         for (i=0; i<num_newmsgs; ++i) {
2206                 unique = 1;
2207                 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2208                         if (msglist[j] == newmsgidlist[i]) {
2209                                 unique = 0;
2210                         }
2211                 }
2212                 if (unique) {
2213                         msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2214                 }
2215         }
2216
2217         syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2218
2219         // Now merge the new messages
2220         msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2221         if (msglist == NULL) {
2222                 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2223                 free(msgs_to_be_merged);
2224                 abort();                                        // FIXME
2225                 return (ERROR + INTERNAL_ERROR);
2226         }
2227         memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2228         num_msgs += num_msgs_to_be_merged;
2229
2230         // Sort the message list, so all the msgid's are in order
2231         num_msgs = sort_msglist(msglist, num_msgs);
2232
2233         // Determine the highest message number
2234         highest_msg = msglist[num_msgs - 1];
2235
2236         // Write it back to disk.
2237         cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
2238
2239         // Free up the memory we used.
2240         free(msglist);
2241
2242         // Update the highest-message pointer and unlock the room.
2243         CC->room.QRhighest = highest_msg;
2244         CtdlPutRoomLock(&CC->room);
2245
2246         // Perform replication checks if necessary
2247         if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2248                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2249
2250                 for (i=0; i<num_msgs_to_be_merged; ++i) {
2251                         msgid = msgs_to_be_merged[i];
2252
2253                         if (supplied_msg != NULL) {
2254                                 msg = supplied_msg;
2255                         }
2256                         else {
2257                                 msg = CtdlFetchMessage(msgid, 0);
2258                         }
2259
2260                         if (msg != NULL) {
2261                                 ReplicationChecks(msg);
2262
2263                                 // If the message has an Exclusive ID, index that...
2264                                 if (!CM_IsEmpty(msg, eExclusiveID)) {
2265                                         index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2266                                 }
2267
2268                                 // Free up the memory we may have allocated
2269                                 if (msg != supplied_msg) {
2270                                         CM_Free(msg);
2271                                 }
2272                         }
2273
2274                 }
2275         }
2276
2277         else {
2278                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2279         }
2280
2281         // Submit this room for processing by hooks
2282         int total_roomhook_errors = PerformRoomHooks(&CC->room);
2283         if (total_roomhook_errors) {
2284                 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2285         }
2286
2287         // Go back to the room we were in before we wandered here...
2288         CtdlGetRoom(&CC->room, hold_rm);
2289
2290         // Bump the reference count for all messages which were merged
2291         if (!suppress_refcount_adj) {
2292                 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2293         }
2294
2295         // Free up memory...
2296         if (msgs_to_be_merged != NULL) {
2297                 free(msgs_to_be_merged);
2298         }
2299
2300         // Return success.
2301         return (0);
2302 }
2303
2304
2305 // This is the same as CtdlSaveMsgPointersInRoom() but it only accepts a single message.
2306 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *supplied_msg) {
2307         return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, supplied_msg, 0);
2308 }
2309
2310
2311 // Message base operation to save a new message to the message store
2312 // (returns new message number)
2313 //
2314 // This is the back end for CtdlSubmitMsg() and should not be directly
2315 // called by server-side modules.
2316 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) {
2317         long retval;
2318         struct ser_ret smr;
2319         int is_bigmsg = 0;
2320         char *holdM = NULL;
2321         long holdMLen = 0;
2322
2323         // If the message is big, set its body aside for storage elsewhere and we hide the message body from the serializer
2324         if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG) {
2325                 is_bigmsg = 1;
2326                 holdM = msg->cm_fields[eMesageText];
2327                 msg->cm_fields[eMesageText] = NULL;
2328                 holdMLen = msg->cm_lengths[eMesageText];
2329                 msg->cm_lengths[eMesageText] = 0;
2330         }
2331
2332         // Serialize our data structure for storage in the database
2333         CtdlSerializeMessage(&smr, msg);
2334
2335         if (is_bigmsg) {
2336                 // put the message body back into the message
2337                 msg->cm_fields[eMesageText] = holdM;
2338                 msg->cm_lengths[eMesageText] = holdMLen;
2339         }
2340
2341         if (smr.len == 0) {
2342                 if (Reply) {
2343                         cprintf("%d Unable to serialize message\n", ERROR + INTERNAL_ERROR);
2344                 }
2345                 else {
2346                         syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2347                 }
2348                 return (-1L);
2349         }
2350
2351         // Write our little bundle of joy into the message base
2352         retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len);
2353         if (retval < 0) {
2354                 syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval);
2355         }
2356         else {
2357                 if (is_bigmsg) {
2358                         retval = cdb_store(CDB_BIGMSGS, &msgid, (int)sizeof(long), holdM, (holdMLen + 1));
2359                         if (retval < 0) {
2360                                 syslog(LOG_ERR, "msgbase: failed to store message body for msgid %ld: %ld", msgid, retval);
2361                         }
2362                 }
2363         }
2364
2365         // Free the memory we used for the serialized message
2366         free(smr.ser);
2367         return(retval);
2368 }
2369
2370
2371 long send_message(struct CtdlMessage *msg) {
2372         long newmsgid;
2373         long retval;
2374         char msgidbuf[256];
2375         long msgidbuflen;
2376
2377         // Get a new message number
2378         newmsgid = get_new_message_number();
2379
2380         // Generate an ID if we don't have one already
2381         if (CM_IsEmpty(msg, emessageId)) {
2382                 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%08lX-%08lX@%s",
2383                        (long unsigned int) time(NULL),
2384                        (long unsigned int) newmsgid,
2385                        CtdlGetConfigStr("c_fqdn")
2386                 );
2387                 CM_SetField(msg, emessageId, msgidbuf);
2388         }
2389
2390         retval = CtdlSaveThisMessage(msg, newmsgid, 1);
2391
2392         if (retval == 0) {
2393                 retval = newmsgid;
2394         }
2395
2396         // Return the *local* message ID to the caller (even if we're storing a remotely originated message)
2397         return(retval);
2398 }
2399
2400
2401 // Serialize a struct CtdlMessage into the format used on disk.
2402 //
2403 // This function loads up a "struct ser_ret" (defined in server.h) which
2404 // contains the length of the serialized message and a pointer to the
2405 // serialized message in memory.  THE LATTER MUST BE FREED BY THE CALLER.
2406 void CtdlSerializeMessage(struct ser_ret *ret,          // return values
2407                           struct CtdlMessage *msg)      // unserialized msg
2408 {
2409         size_t wlen;
2410         int i;
2411
2412         // Check for valid message format
2413         if (CM_IsValidMsg(msg) == 0) {
2414                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2415                 ret->len = 0;
2416                 ret->ser = NULL;
2417                 return;
2418         }
2419
2420         ret->len = 3;
2421         for (i=0; i < NDiskFields; ++i)
2422                 if (msg->cm_fields[FieldOrder[i]] != NULL)
2423                         ret->len += msg->cm_lengths[FieldOrder[i]] + 2;
2424
2425         ret->ser = malloc(ret->len);
2426         if (ret->ser == NULL) {
2427                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret->len);
2428                 ret->len = 0;
2429                 ret->ser = NULL;
2430                 return;
2431         }
2432
2433         ret->ser[0] = 0xFF;
2434         ret->ser[1] = msg->cm_anon_type;
2435         ret->ser[2] = msg->cm_format_type;
2436         wlen = 3;
2437
2438         for (i=0; i < NDiskFields; ++i) {
2439                 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2440                         ret->ser[wlen++] = (char)FieldOrder[i];
2441
2442                         memcpy(&ret->ser[wlen],
2443                                msg->cm_fields[FieldOrder[i]],
2444                                msg->cm_lengths[FieldOrder[i]] + 1);
2445
2446                         wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2447                 }
2448         }
2449
2450         if (ret->len != wlen) {
2451                 syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen);
2452         }
2453
2454         return;
2455 }
2456
2457
2458 /*
2459  * Check to see if any messages already exist in the current room which
2460  * carry the same Exclusive ID as this one.  If any are found, delete them.
2461  */
2462 void ReplicationChecks(struct CtdlMessage *msg) {
2463         long old_msgnum = (-1L);
2464
2465         if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2466
2467         syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2468
2469         /* No exclusive id?  Don't do anything. */
2470         if (msg == NULL) return;
2471         if (CM_IsEmpty(msg, eExclusiveID)) return;
2472
2473         /*syslog(LOG_DEBUG, "msgbase: exclusive ID: <%s> for room <%s>",
2474           msg->cm_fields[eExclusiveID], CC->room.QRname);*/
2475
2476         old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2477         if (old_msgnum > 0L) {
2478                 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2479                 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2480         }
2481 }
2482
2483
2484 /*
2485  * Save a message to disk and submit it into the delivery system.
2486  */
2487 long CtdlSubmitMsg(struct CtdlMessage *msg,     /* message to save */
2488                    struct recptypes *recps,     /* recipients (if mail) */
2489                    const char *force            /* force a particular room? */
2490 ) {
2491         char hold_rm[ROOMNAMELEN];
2492         char actual_rm[ROOMNAMELEN];
2493         char force_room[ROOMNAMELEN];
2494         char content_type[SIZ];                 /* We have to learn this */
2495         char recipient[SIZ];
2496         char bounce_to[1024];
2497         const char *room;
2498         long newmsgid;
2499         const char *mptr = NULL;
2500         struct ctdluser userbuf;
2501         int a, i;
2502         struct MetaData smi;
2503         char *collected_addresses = NULL;
2504         struct addresses_to_be_filed *aptr = NULL;
2505         StrBuf *saved_rfc822_version = NULL;
2506         int qualified_for_journaling = 0;
2507
2508         syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2509         if (CM_IsValidMsg(msg) == 0) return(-1);        /* self check */
2510
2511         /* If this message has no timestamp, we take the liberty of
2512          * giving it one, right now.
2513          */
2514         if (CM_IsEmpty(msg, eTimestamp)) {
2515                 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2516         }
2517
2518         /* If this message has no path, we generate one.
2519          */
2520         if (CM_IsEmpty(msg, eMessagePath)) {
2521                 if (!CM_IsEmpty(msg, eAuthor)) {
2522                         CM_CopyField(msg, eMessagePath, eAuthor);
2523                         for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2524                                 if (isspace(msg->cm_fields[eMessagePath][a])) {
2525                                         msg->cm_fields[eMessagePath][a] = ' ';
2526                                 }
2527                         }
2528                 }
2529                 else {
2530                         CM_SetField(msg, eMessagePath, "unknown");
2531                 }
2532         }
2533
2534         if (force == NULL) {
2535                 force_room[0] = '\0';
2536         }
2537         else {
2538                 strcpy(force_room, force);
2539         }
2540
2541         /* Learn about what's inside, because it's what's inside that counts */
2542         if (CM_IsEmpty(msg, eMesageText)) {
2543                 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2544                 return(-2);
2545         }
2546
2547         switch (msg->cm_format_type) {
2548         case 0:
2549                 strcpy(content_type, "text/x-citadel-variformat");
2550                 break;
2551         case 1:
2552                 strcpy(content_type, "text/plain");
2553                 break;
2554         case 4:
2555                 strcpy(content_type, "text/plain");
2556                 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
2557                 if (mptr != NULL) {
2558                         char *aptr;
2559                         safestrncpy(content_type, &mptr[13], sizeof content_type);
2560                         string_trim(content_type);
2561                         aptr = content_type;
2562                         while (!IsEmptyStr(aptr)) {
2563                                 if ((*aptr == ';')
2564                                     || (*aptr == ' ')
2565                                     || (*aptr == 13)
2566                                     || (*aptr == 10)) {
2567                                         *aptr = 0;
2568                                 }
2569                                 else aptr++;
2570                         }
2571                 }
2572         }
2573
2574         /* Goto the correct room */
2575         room = (recps) ? CC->room.QRname : SENTITEMS;
2576         syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2577         strcpy(hold_rm, CC->room.QRname);
2578         strcpy(actual_rm, CC->room.QRname);
2579         if (recps != NULL) {
2580                 strcpy(actual_rm, SENTITEMS);
2581         }
2582
2583         /* If the user is a twit, move to the twit room for posting */
2584         if (TWITDETECT) {
2585                 if (CC->user.axlevel == AxProbU) {
2586                         strcpy(hold_rm, actual_rm);
2587                         strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2588                         syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2589                 }
2590         }
2591
2592         /* ...or if this message is destined for Aide> then go there. */
2593         if (!IsEmptyStr(force_room)) {
2594                 strcpy(actual_rm, force_room);
2595         }
2596
2597         syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2598         if (strcasecmp(actual_rm, CC->room.QRname)) {
2599                 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2600         }
2601
2602         /*
2603          * If this message has no O (room) field, generate one.
2604          */
2605         if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2606                 CM_SetField(msg, eOriginalRoom, CC->room.QRname);
2607         }
2608
2609         /* Perform "before save" hooks (aborting if any return nonzero) */
2610         syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2611         if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2612
2613         /*
2614          * If this message has an Exclusive ID, and the room is replication
2615          * checking enabled, then do replication checks.
2616          */
2617         if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2618                 ReplicationChecks(msg);
2619         }
2620
2621         /* Save it to disk */
2622         syslog(LOG_DEBUG, "msgbase: saving to disk");
2623         newmsgid = send_message(msg);
2624         if (newmsgid <= 0L) return(-5);
2625
2626         /* Write a supplemental message info record.  This doesn't have to
2627          * be a critical section because nobody else knows about this message
2628          * yet.
2629          */
2630         syslog(LOG_DEBUG, "msgbase: creating metadata record");
2631         memset(&smi, 0, sizeof(struct MetaData));
2632         smi.meta_msgnum = newmsgid;
2633         smi.meta_refcount = 0;
2634         safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type);
2635
2636         /*
2637          * Measure how big this message will be when rendered as RFC822.
2638          * We do this for two reasons:
2639          * 1. We need the RFC822 length for the new metadata record, so the
2640          *    POP and IMAP services don't have to calculate message lengths
2641          *    while the user is waiting (multiplied by potentially hundreds
2642          *    or thousands of messages).
2643          * 2. If journaling is enabled, we will need an RFC822 version of the
2644          *    message to attach to the journalized copy.
2645          */
2646         if (CC->redirect_buffer != NULL) {
2647                 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2648                 exit(CTDLEXIT_REDIRECT);
2649         }
2650         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2651         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2652         smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2653         saved_rfc822_version = CC->redirect_buffer;
2654         CC->redirect_buffer = NULL;
2655
2656         PutMetaData(&smi);
2657
2658         /* Now figure out where to store the pointers */
2659         syslog(LOG_DEBUG, "msgbase: storing pointers");
2660
2661         /* If this is being done by the networker delivering a private
2662          * message, we want to BYPASS saving the sender's copy (because there
2663          * is no local sender; it would otherwise go to the Trashcan).
2664          */
2665         if ((!CC->internal_pgm) || (recps == NULL)) {
2666                 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2667                         syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm);
2668                         CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2669                 }
2670         }
2671
2672         /* For internet mail, drop a copy in the outbound queue room */
2673         if ((recps != NULL) && (recps->num_internet > 0)) {
2674                 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2675         }
2676
2677         /* If other rooms are specified, drop them there too. */
2678         if ((recps != NULL) && (recps->num_room > 0)) {
2679                 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2680                         extract_token(recipient, recps->recp_room, i, '|', sizeof recipient);
2681                         syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2682                         CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2683                 }
2684         }
2685
2686         /* Decide where bounces need to be delivered */
2687         if ((recps != NULL) && (recps->bounce_to == NULL)) {
2688                 if (CC->logged_in) {
2689                         strcpy(bounce_to, CC->user.fullname);
2690                 }
2691                 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2692                         strcpy(bounce_to, msg->cm_fields[eAuthor]);
2693                 }
2694                 recps->bounce_to = bounce_to;
2695         }
2696
2697         CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2698
2699         // If this is private, local mail, make a copy in the recipient's mailbox and bump the reference count.
2700         if ((recps != NULL) && (recps->num_local > 0)) {
2701                 char *pch;
2702                 int ntokens;
2703
2704                 pch = recps->recp_local;
2705                 recps->recp_local = recipient;
2706                 ntokens = num_tokens(pch, '|');
2707                 for (i=0; i<ntokens; ++i) {
2708                         extract_token(recipient, pch, i, '|', sizeof recipient);
2709                         syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2710                         if (CtdlGetUser(&userbuf, recipient) == 0) {
2711                                 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2712                                 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2713                                 CtdlBumpNewMailCounter(userbuf.usernum);        // if this user is logged in, tell them they have new mail.
2714                                 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2715                         }
2716                         else {
2717                                 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2718                                 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2719                         }
2720                 }
2721                 recps->recp_local = pch;
2722         }
2723
2724         /* Perform "after save" hooks */
2725         syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2726
2727         PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2728         CM_FlushField(msg, eVltMsgNum);
2729
2730         /* Go back to the room we started from */
2731         syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2732         if (strcasecmp(hold_rm, CC->room.QRname)) {
2733                 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2734         }
2735
2736         /*
2737          * Any addresses to harvest for someone's address book?
2738          */
2739         if ( (CC->logged_in) && (recps != NULL) ) {
2740                 collected_addresses = harvest_collected_addresses(msg);
2741         }
2742
2743         if (collected_addresses != NULL) {
2744                 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2745                 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2746                 aptr->roomname = strdup(actual_rm);
2747                 aptr->collected_addresses = collected_addresses;
2748                 begin_critical_section(S_ATBF);
2749                 aptr->next = atbf;
2750                 atbf = aptr;
2751                 end_critical_section(S_ATBF);
2752         }
2753
2754         /*
2755          * Determine whether this message qualifies for journaling.
2756          */
2757         if (!CM_IsEmpty(msg, eJournal)) {
2758                 qualified_for_journaling = 0;
2759         }
2760         else {
2761                 if (recps == NULL) {
2762                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2763                 }
2764                 else if (recps->num_local + recps->num_internet > 0) {
2765                         qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2766                 }
2767                 else {
2768                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2769                 }
2770         }
2771
2772         /*
2773          * Do we have to perform journaling?  If so, hand off the saved
2774          * RFC822 version will be handed off to the journaler for background
2775          * submit.  Otherwise, we have to free the memory ourselves.
2776          */
2777         if (saved_rfc822_version != NULL) {
2778                 if (qualified_for_journaling) {
2779                         JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2780                 }
2781                 else {
2782                         FreeStrBuf(&saved_rfc822_version);
2783                 }
2784         }
2785
2786         if ((recps != NULL) && (recps->bounce_to == bounce_to))
2787                 recps->bounce_to = NULL;
2788
2789         /* Done. */
2790         return(newmsgid);
2791 }
2792
2793
2794 /*
2795  * Convenience function for generating small administrative messages.
2796  */
2797 long quickie_message(char *from,
2798                      char *fromaddr,
2799                      char *to,
2800                      char *room,
2801                      char *text,
2802                      int format_type,
2803                      char *subject)
2804 {
2805         struct CtdlMessage *msg;
2806         struct recptypes *recp = NULL;
2807
2808         msg = malloc(sizeof(struct CtdlMessage));
2809         memset(msg, 0, sizeof(struct CtdlMessage));
2810         msg->cm_magic = CTDLMESSAGE_MAGIC;
2811         msg->cm_anon_type = MES_NORMAL;
2812         msg->cm_format_type = format_type;
2813
2814         if (!IsEmptyStr(from)) {
2815                 CM_SetField(msg, eAuthor, from);
2816         }
2817         else if (!IsEmptyStr(fromaddr)) {
2818                 char *pAt;
2819                 CM_SetField(msg, eAuthor, fromaddr);
2820                 pAt = strchr(msg->cm_fields[eAuthor], '@');
2821                 if (pAt != NULL) {
2822                         CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
2823                 }
2824         }
2825         else {
2826                 msg->cm_fields[eAuthor] = strdup("Citadel");
2827         }
2828
2829         if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr);
2830         if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room);
2831         if (!IsEmptyStr(to)) {
2832                 CM_SetField(msg, eRecipient, to);
2833                 recp = validate_recipients(to, NULL, 0);
2834         }
2835         if (!IsEmptyStr(subject)) {
2836                 CM_SetField(msg, eMsgSubject, subject);
2837         }
2838         if (!IsEmptyStr(text)) {
2839                 CM_SetField(msg, eMesageText, text);
2840         }
2841
2842         long msgnum = CtdlSubmitMsg(msg, recp, room);
2843         CM_Free(msg);
2844         if (recp != NULL) free_recipients(recp);
2845         return msgnum;
2846 }
2847
2848
2849 /*
2850  * Back end function used by CtdlMakeMessage() and similar functions
2851  */
2852 StrBuf *CtdlReadMessageBodyBuf(char *terminator,        // token signalling EOT
2853                                long tlen,
2854                                size_t maxlen,           // maximum message length
2855                                StrBuf *exist,           // if non-null, append to it; exist is ALWAYS freed
2856                                int crlf                 // CRLF newlines instead of LF
2857 ) {
2858         StrBuf *Message;
2859         StrBuf *LineBuf;
2860         int flushing = 0;
2861         int finished = 0;
2862         int dotdot = 0;
2863
2864         LineBuf = NewStrBufPlain(NULL, SIZ);
2865         if (exist == NULL) {
2866                 Message = NewStrBufPlain(NULL, 4 * SIZ);
2867         }
2868         else {
2869                 Message = NewStrBufDup(exist);
2870         }
2871
2872         /* Do we need to change leading ".." to "." for SMTP escaping? */
2873         if ((tlen == 1) && (*terminator == '.')) {
2874                 dotdot = 1;
2875         }
2876
2877         /* read in the lines of message text one by one */
2878         do {
2879                 if (CtdlClientGetLine(LineBuf) < 0) {
2880                         finished = 1;
2881                 }
2882                 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
2883                         finished = 1;
2884                 }
2885                 if ( (!flushing) && (!finished) ) {
2886                         if (crlf) {
2887                                 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
2888                         }
2889                         else {
2890                                 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
2891                         }
2892
2893                         /* Unescape SMTP-style input of two dots at the beginning of the line */
2894                         if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
2895                                 StrBufCutLeft(LineBuf, 1);
2896                         }
2897                         StrBufAppendBuf(Message, LineBuf, 0);
2898                 }
2899
2900                 /* if we've hit the max msg length, flush the rest */
2901                 if (StrLength(Message) >= maxlen) {
2902                         flushing = 1;
2903                 }
2904
2905         } while (!finished);
2906         FreeStrBuf(&LineBuf);
2907
2908         if (flushing) {
2909                 syslog(LOG_ERR, "msgbase: exceeded maximum message length of %ld - message was truncated", maxlen);
2910         }
2911
2912         return Message;
2913 }
2914
2915
2916 // Back end function used by CtdlMakeMessage() and similar functions
2917 char *CtdlReadMessageBody(char *terminator,     // token signalling EOT
2918                           long tlen,
2919                           size_t maxlen,        // maximum message length
2920                           StrBuf *exist,        // if non-null, append to it; exist is ALWAYS freed
2921                           int crlf              // CRLF newlines instead of LF
2922 ) {
2923         StrBuf *Message;
2924
2925         Message = CtdlReadMessageBodyBuf(terminator,
2926                                          tlen,
2927                                          maxlen,
2928                                          exist,
2929                                          crlf
2930         );
2931         if (Message == NULL) {
2932                 return NULL;
2933         }
2934         else {
2935                 return SmashStrBuf(&Message);
2936         }
2937 }
2938
2939
2940 struct CtdlMessage *CtdlMakeMessage(
2941         struct ctdluser *author,        /* author's user structure */
2942         char *recipient,                /* NULL if it's not mail */
2943         char *recp_cc,                  /* NULL if it's not mail */
2944         char *room,                     /* room where it's going */
2945         int type,                       /* see MES_ types in header file */
2946         int format_type,                /* variformat, plain text, MIME... */
2947         char *fake_name,                /* who we're masquerading as */
2948         char *my_email,                 /* which of my email addresses to use (empty is ok) */
2949         char *subject,                  /* Subject (optional) */
2950         char *supplied_euid,            /* ...or NULL if this is irrelevant */
2951         char *preformatted_text,        /* ...or NULL to read text from client */
2952         char *references                /* Thread references */
2953 ) {
2954         return CtdlMakeMessageLen(
2955                 author, /* author's user structure */
2956                 recipient,              /* NULL if it's not mail */
2957                 (recipient)?strlen(recipient) : 0,
2958                 recp_cc,                        /* NULL if it's not mail */
2959                 (recp_cc)?strlen(recp_cc): 0,
2960                 room,                   /* room where it's going */
2961                 (room)?strlen(room): 0,
2962                 type,                   /* see MES_ types in header file */
2963                 format_type,            /* variformat, plain text, MIME... */
2964                 fake_name,              /* who we're masquerading as */
2965                 (fake_name)?strlen(fake_name): 0,
2966                 my_email,                       /* which of my email addresses to use (empty is ok) */
2967                 (my_email)?strlen(my_email): 0,
2968                 subject,                        /* Subject (optional) */
2969                 (subject)?strlen(subject): 0,
2970                 supplied_euid,          /* ...or NULL if this is irrelevant */
2971                 (supplied_euid)?strlen(supplied_euid):0,
2972                 preformatted_text,      /* ...or NULL to read text from client */
2973                 (preformatted_text)?strlen(preformatted_text) : 0,
2974                 references,             /* Thread references */
2975                 (references)?strlen(references):0);
2976
2977 }
2978
2979
2980 /*
2981  * Build a binary message to be saved on disk.
2982  * (NOTE: if you supply 'preformatted_text', the buffer you give it
2983  * will become part of the message.  This means you are no longer
2984  * responsible for managing that memory -- it will be freed along with
2985  * the rest of the fields when CM_Free() is called.)
2986  */
2987 struct CtdlMessage *CtdlMakeMessageLen(
2988         struct ctdluser *author,        /* author's user structure */
2989         char *recipient,                /* NULL if it's not mail */
2990         long rcplen,
2991         char *recp_cc,                  /* NULL if it's not mail */
2992         long cclen,
2993         char *room,                     /* room where it's going */
2994         long roomlen,
2995         int type,                       /* see MES_ types in header file */
2996         int format_type,                /* variformat, plain text, MIME... */
2997         char *fake_name,                /* who we're masquerading as */
2998         long fnlen,
2999         char *my_email,                 /* which of my email addresses to use (empty is ok) */
3000         long myelen,
3001         char *subject,                  /* Subject (optional) */
3002         long subjlen,
3003         char *supplied_euid,            /* ...or NULL if this is irrelevant */
3004         long euidlen,
3005         char *preformatted_text,        /* ...or NULL to read text from client */
3006         long textlen,
3007         char *references,               /* Thread references */
3008         long reflen
3009 ) {
3010         long blen;
3011         char buf[1024];
3012         struct CtdlMessage *msg;
3013         StrBuf *FakeAuthor;
3014         StrBuf *FakeEncAuthor = NULL;
3015
3016         msg = malloc(sizeof(struct CtdlMessage));
3017         memset(msg, 0, sizeof(struct CtdlMessage));
3018         msg->cm_magic = CTDLMESSAGE_MAGIC;
3019         msg->cm_anon_type = type;
3020         msg->cm_format_type = format_type;
3021
3022         if (recipient != NULL) rcplen = string_trim(recipient);
3023         if (recp_cc != NULL) cclen = string_trim(recp_cc);
3024
3025         /* Path or Return-Path */
3026         if (myelen > 0) {
3027                 CM_SetField(msg, eMessagePath, my_email);
3028         }
3029         else if (!IsEmptyStr(author->fullname)) {
3030                 CM_SetField(msg, eMessagePath, author->fullname);
3031         }
3032         convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
3033
3034         blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
3035         CM_SetField(msg, eTimestamp, buf);
3036
3037         if (fnlen > 0) {
3038                 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
3039         }
3040         else {
3041                 FakeAuthor = NewStrBufPlain (author->fullname, -1);
3042         }
3043         StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
3044         CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
3045         FreeStrBuf(&FakeAuthor);
3046
3047         if (!!IsEmptyStr(CC->room.QRname)) {
3048                 if (CC->room.QRflags & QR_MAILBOX) {            /* room */
3049                         CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11]);
3050                 }
3051                 else {
3052                         CM_SetField(msg, eOriginalRoom, CC->room.QRname);
3053                 }
3054         }
3055
3056         if (rcplen > 0) {
3057                 CM_SetField(msg, eRecipient, recipient);
3058         }
3059         if (cclen > 0) {
3060                 CM_SetField(msg, eCarbonCopY, recp_cc);
3061         }
3062
3063         if (myelen > 0) {
3064                 CM_SetField(msg, erFc822Addr, my_email);
3065         }
3066         else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3067                 CM_SetField(msg, erFc822Addr, CC->cs_inet_email);
3068         }
3069
3070         if (subject != NULL) {
3071                 long length;
3072                 length = string_trim(subject);
3073                 if (length > 0) {
3074                         long i;
3075                         long IsAscii;
3076                         IsAscii = -1;
3077                         i = 0;
3078                         while ((subject[i] != '\0') &&
3079                                (IsAscii = isascii(subject[i]) != 0 ))
3080                                 i++;
3081                         if (IsAscii != 0)
3082                                 CM_SetField(msg, eMsgSubject, subject);
3083                         else /* ok, we've got utf8 in the string. */
3084                         {
3085                                 char *rfc2047Subj;
3086                                 rfc2047Subj = rfc2047encode(subject, length);
3087                                 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3088                         }
3089
3090                 }
3091         }
3092
3093         if (euidlen > 0) {
3094                 CM_SetField(msg, eExclusiveID, supplied_euid);
3095         }
3096
3097         if (reflen > 0) {
3098                 CM_SetField(msg, eWeferences, references);
3099         }
3100
3101         if (preformatted_text != NULL) {
3102                 CM_SetField(msg, eMesageText, preformatted_text);
3103         }
3104         else {
3105                 StrBuf *MsgBody;
3106                 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3107                 if (MsgBody != NULL) {
3108                         CM_SetAsFieldSB(msg, eMesageText, &MsgBody);
3109                 }
3110         }
3111
3112         return(msg);
3113 }
3114
3115
3116 /*
3117  * API function to delete messages which match a set of criteria
3118  * (returns the actual number of messages deleted)
3119  */
3120 int CtdlDeleteMessages(const char *room_name,   // which room
3121                        long *dmsgnums,          // array of msg numbers to be deleted
3122                        int num_dmsgnums,        // number of msgs to be deleted, or 0 for "any"
3123                        char *content_type       // or "" for any.  regular expressions expected.
3124 ) {
3125         struct ctdlroom qrbuf;
3126         struct cdbdata *cdbfr;
3127         long *msglist = NULL;
3128         long *dellist = NULL;
3129         int num_msgs = 0;
3130         int i, j;
3131         int num_deleted = 0;
3132         int delete_this;
3133         struct MetaData smi;
3134         regex_t re;
3135         regmatch_t pm;
3136         int need_to_free_re = 0;
3137
3138         if (content_type) if (!IsEmptyStr(content_type)) {
3139                         regcomp(&re, content_type, 0);
3140                         need_to_free_re = 1;
3141                 }
3142         syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3143
3144         /* get room record, obtaining a lock... */
3145         if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3146                 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3147                 if (need_to_free_re) regfree(&re);
3148                 return(0);      /* room not found */
3149         }
3150
3151         num_msgs = CtdlFetchMsgList(qrbuf.QRnumber, &msglist);
3152         if (num_msgs > 0) {
3153                 dellist = malloc(num_msgs * sizeof(long));
3154                 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3155                 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3156                 int have_more_del = 1;
3157
3158                 num_msgs = sort_msglist(msglist, num_msgs);
3159                 if (num_dmsgnums > 1) {
3160                         num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3161                 }
3162                 i = 0;
3163                 j = 0;
3164                 while ((i < num_msgs) && (have_more_del)) {
3165                         delete_this = 0x00;
3166
3167                         /* Set/clear a bit for each criterion */
3168
3169                         /* 0 messages in the list or a null list means that we are
3170                          * interested in deleting any messages which meet the other criteria.
3171                          */
3172                         if (have_delmsgs) {
3173                                 delete_this |= 0x01;
3174                         }
3175                         else {
3176                                 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3177
3178                                 if (i >= num_msgs)
3179                                         continue;
3180
3181                                 if (msglist[i] == dmsgnums[j]) {
3182                                         delete_this |= 0x01;
3183                                 }
3184                                 j++;
3185                                 have_more_del = (j < num_dmsgnums);
3186                         }
3187
3188                         if (have_contenttype) {
3189                                 GetMetaData(&smi, msglist[i]);
3190                                 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3191                                         delete_this |= 0x02;
3192                                 }
3193                         } else {
3194                                 delete_this |= 0x02;
3195                         }
3196
3197                         /* Delete message only if all bits are set */
3198                         if (delete_this == 0x03) {
3199                                 dellist[num_deleted++] = msglist[i];
3200                                 msglist[i] = 0L;
3201                         }
3202                         i++;
3203                 }
3204
3205                 num_msgs = sort_msglist(msglist, num_msgs);
3206                 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
3207
3208                 if (num_msgs > 0) {
3209                         qrbuf.QRhighest = msglist[num_msgs - 1];
3210                 }
3211                 else {
3212                         qrbuf.QRhighest = 0;
3213                 }
3214         }
3215         CtdlPutRoomLock(&qrbuf);
3216
3217         /* Go through the messages we pulled out of the index, and decrement
3218          * their reference counts by 1.  If this is the only room the message
3219          * was in, the reference count will reach zero and the message will
3220          * automatically be deleted from the database.  We do this in a
3221          * separate pass because there might be plug-in hooks getting called,
3222          * and we don't want that happening during an S_ROOMS critical
3223          * section.
3224          */
3225         if (num_deleted) {
3226                 for (i=0; i<num_deleted; ++i) {
3227                         PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3228                 }
3229                 AdjRefCountList(dellist, num_deleted, -1);
3230         }
3231         /* Now free the memory we used, and go away. */
3232         if (msglist != NULL) free(msglist);
3233         if (dellist != NULL) free(dellist);
3234         syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3235         if (need_to_free_re) regfree(&re);
3236         return (num_deleted);
3237 }
3238
3239
3240 /*
3241  * GetMetaData()  -  Get the supplementary record for a message
3242  */
3243 void GetMetaData(struct MetaData *smibuf, long msgnum) {
3244         struct cdbdata cdbsmi;
3245         long TheIndex;
3246
3247         memset(smibuf, 0, sizeof(struct MetaData));
3248         smibuf->meta_msgnum = msgnum;
3249         smibuf->meta_refcount = 1;      /* Default reference count is 1 */
3250
3251         /* Use the negative of the message number for its supp record index */
3252         TheIndex = (0L - msgnum);
3253
3254         cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3255         if (cdbsmi.ptr == NULL) {
3256                 return;                 /* record not found; leave it alone */
3257         }
3258         memcpy(smibuf, cdbsmi.ptr, ((cdbsmi.len > sizeof(struct MetaData)) ? sizeof(struct MetaData) : cdbsmi.len));
3259         return;
3260 }
3261
3262
3263 /*
3264  * PutMetaData()  -  (re)write supplementary record for a message
3265  */
3266 void PutMetaData(struct MetaData *smibuf)
3267 {
3268         long TheIndex;
3269
3270         /* Use the negative of the message number for the metadata db index */
3271         TheIndex = (0L - smibuf->meta_msgnum);
3272
3273         cdb_store(CDB_MSGMAIN,
3274                   &TheIndex, (int)sizeof(long),
3275                   smibuf, (int)sizeof(struct MetaData)
3276         );
3277 }
3278
3279
3280 // Convenience function to process a big block of AdjRefCount() operations
3281 void AdjRefCountList(long *msgnum, long nmsg, int incr) {
3282         long i;
3283
3284         for (i = 0; i < nmsg; i++) {
3285                 AdjRefCount(msgnum[i], incr);
3286         }
3287 }
3288
3289
3290 // AdjRefCount - adjust the reference count for a message.
3291 // We need to delete from disk any message whose reference count reaches zero.
3292 void AdjRefCount(long msgnum, int incr) {
3293         struct MetaData smi;
3294         long delnum;
3295
3296         // This is a *tight* critical section; please keep it that way, as
3297         // it may get called while nested in other critical sections.
3298         // Complicating this any further will surely cause deadlock!
3299         begin_critical_section(S_SUPPMSGMAIN);
3300         GetMetaData(&smi, msgnum);
3301         smi.meta_refcount += incr;
3302         PutMetaData(&smi);
3303         end_critical_section(S_SUPPMSGMAIN);
3304         syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3305
3306         // If the reference count is now zero, delete both the message and its metadata record.
3307         if (smi.meta_refcount == 0) {
3308                 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3309
3310                 // Call delete hooks with NULL room to show it has gone altogether
3311                 PerformDeleteHooks(NULL, msgnum);
3312
3313                 // Remove from message base
3314                 delnum = msgnum;
3315                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3316                 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));    // There might not be a bigmsgs.  Not an error.
3317
3318                 // Remove metadata record
3319                 delnum = (0L - msgnum);
3320                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3321         }
3322 }
3323
3324
3325 // Write a generic object to this room
3326 // Returns the message number of the written object, in case you need it.
3327 long CtdlWriteObject(char *req_room,                    // Room to stuff it in
3328                      char *content_type,                // MIME type of this object
3329                      char *raw_message,                 // Data to be written
3330                      off_t raw_length,                  // Size of raw_message
3331                      struct ctdluser *is_mailbox,       // Mailbox room?
3332                      int is_binary,                     // Is encoding necessary?
3333                      unsigned int flags                 // Internal save flags
3334 ) {
3335         struct ctdlroom qrbuf;
3336         char roomname[ROOMNAMELEN];
3337         struct CtdlMessage *msg;
3338         StrBuf *encoded_message = NULL;
3339
3340         if (is_mailbox != NULL) {
3341                 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3342         }
3343         else {
3344                 safestrncpy(roomname, req_room, sizeof(roomname));
3345         }
3346
3347         syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3348
3349         if (is_binary) {
3350                 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3351         }
3352         else {
3353                 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3354         }
3355
3356         StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3357         StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3358         StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3359
3360         if (is_binary) {
3361                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3362         }
3363         else {
3364                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3365         }
3366
3367         if (is_binary) {
3368                 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3369         }
3370         else {
3371                 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3372         }
3373
3374         syslog(LOG_DEBUG, "msgbase: allocating");
3375         msg = malloc(sizeof(struct CtdlMessage));
3376         memset(msg, 0, sizeof(struct CtdlMessage));
3377         msg->cm_magic = CTDLMESSAGE_MAGIC;
3378         msg->cm_anon_type = MES_NORMAL;
3379         msg->cm_format_type = 4;
3380         CM_SetField(msg, eAuthor, CC->user.fullname);
3381         CM_SetField(msg, eOriginalRoom, req_room);
3382         msg->cm_flags = flags;
3383
3384         CM_SetAsFieldSB(msg, eMesageText, &encoded_message);
3385
3386         /* Create the requested room if we have to. */
3387         if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3388                 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3389         }
3390
3391         /* Now write the data */
3392         long new_msgnum = CtdlSubmitMsg(msg, NULL, roomname);
3393         CM_Free(msg);
3394         return new_msgnum;
3395 }
3396
3397
3398 /************************************************************************/
3399 /*                      MODULE INITIALIZATION                           */
3400 /************************************************************************/
3401
3402 char *ctdl_module_init_msgbase(void) {
3403         if (!threading) {
3404                 FillMsgKeyLookupTable();
3405         }
3406
3407         /* return our module id for the log */
3408         return "msgbase";
3409 }