]> code.citadel.org Git - citadel.git/blob - citadel/server/msgbase.c
Remove preprocessor tests for OpenSSL. It's a requirement.
[citadel.git] / citadel / server / msgbase.c
1 // Implements the message store.
2 //
3 // Copyright (c) 1987-2024 by the citadel.org team
4 //
5 // This program is open source software.  Use, duplication, or disclosure
6 // is subject to 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 -> eMessageText
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         eMessageText 
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         if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
716
717                 // Call search module via hook mechanism.
718                 // NULL means use any search function available.
719                 // otherwise replace with a char * to name of search routine
720                 search = CtdlFullTextSearch(search_string);
721
722                 if (array_len(search) > 0) {
723         
724                         int orig_num_msgs;
725
726                         orig_num_msgs = num_msgs;
727                         num_msgs = 0;
728                         for (i=0; i<orig_num_msgs; ++i) {
729                                 for (j=0; j<array_len(search); ++j) {
730                                         long smsgnum;
731                                         memcpy(&smsgnum, array_get_element_at(search, j), sizeof(long));
732                                         if (msglist[i] == smsgnum) {
733                                                 msglist[num_msgs++] = msglist[i];
734                                         }
735                                 }
736                         }
737                 }
738                 else {
739                         num_msgs = 0;   // No messages qualify
740                 }
741                 if (search != NULL) array_free(search);
742
743                 // Now that we've purged messages which don't contain the search
744                 // string, treat a MSGS_SEARCH just like a MSGS_ALL from this
745                 // point on.
746                 mode = MSGS_ALL;
747         }
748
749         // Now iterate through the message list, according to the
750         // criteria supplied by the caller.
751         if (num_msgs > 0)
752                 for (a = 0; a < num_msgs; ++a) {
753                         if (server_shutting_down) {
754                                 if (need_to_free_re) regfree(&re);
755                                 free(msglist);
756                                 return num_processed;
757                         }
758                         thismsg = msglist[a];
759                         if (mode == MSGS_ALL) {
760                                 is_seen = 0;
761                         }
762                         else {
763                                 is_seen = is_msg_in_sequence_set(vbuf.v_seen, thismsg);
764                                 if (is_seen) lastold = thismsg;
765                         }
766                         if (
767                                 (thismsg > 0L)
768                         && (
769                                 (mode == MSGS_ALL)
770                                 || ((mode == MSGS_OLD) && (is_seen))
771                                 || ((mode == MSGS_NEW) && (!is_seen))
772                                 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
773                                 || ((mode == MSGS_FIRST) && (a < ref))
774                                 || ((mode == MSGS_GT) && (thismsg > ref))
775                                 || ((mode == MSGS_LT) && (thismsg < ref))
776                                 || ((mode == MSGS_EQ) && (thismsg == ref))
777                             )
778                             ) {
779                                 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
780                                         if (CallBack) {
781                                                 CallBack(lastold, userdata);
782                                         }
783                                         printed_lastold = 1;
784                                         ++num_processed;
785                                 }
786                                 if (CallBack) {
787                                         CallBack(thismsg, userdata);
788                                 }
789                                 ++num_processed;
790                         }
791                 }
792         if (need_to_free_re) regfree(&re);
793
794         // We cache the most recent msglist in order to do security checks later
795         if (CC->client_socket > 0) {
796                 if (CC->cached_msglist != NULL) {
797                         free(CC->cached_msglist);
798                 }
799                 CC->cached_msglist = msglist;
800                 CC->cached_num_msgs = num_msgs;
801         }
802         else {
803                 free(msglist);
804         }
805
806         return num_processed;
807 }
808
809
810 // memfmout() - Citadel text formatter and paginator.
811 //      Although the original purpose of this routine was to format
812 //      text to the reader's screen width, all we're really using it
813 //      for here is to format text out to 80 columns before sending it
814 //      to the client.  The client software MAY reformat it again.
815 void memfmout(
816         char *mptr,             // where are we going to get our text from?
817         const char *nl          // string to terminate lines with
818 ) {
819         int column = 0;
820         unsigned char ch = 0;
821         char outbuf[1024];
822         int len = 0;
823         int nllen = 0;
824
825         if (!mptr) return;
826         nllen = strlen(nl);
827         while (ch=*(mptr++), ch != 0) {
828
829                 if (ch == '\n') {
830                         if (client_write(outbuf, len) == -1) {
831                                 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
832                                 return;
833                         }
834                         len = 0;
835                         if (client_write(nl, nllen) == -1) {
836                                 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
837                                 return;
838                         }
839                         column = 0;
840                 }
841                 else if (ch == '\r') {
842                         // Ignore carriage returns.  Newlines are always LF or CRLF but never CR.
843                 }
844                 else if (isspace(ch)) {
845                         if (column > 72) {              // Beyond 72 columns, break on the next space
846                                 if (client_write(outbuf, len) == -1) {
847                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
848                                         return;
849                                 }
850                                 len = 0;
851                                 if (client_write(nl, nllen) == -1) {
852                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
853                                         return;
854                                 }
855                                 column = 0;
856                         }
857                         else {
858                                 outbuf[len++] = ch;
859                                 ++column;
860                         }
861                 }
862                 else {
863                         outbuf[len++] = ch;
864                         ++column;
865                         if (column > 1000) {            // Beyond 1000 columns, break anywhere
866                                 if (client_write(outbuf, len) == -1) {
867                                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
868                                         return;
869                                 }
870                                 len = 0;
871                                 if (client_write(nl, nllen) == -1) {
872                                         syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
873                                         return;
874                                 }
875                                 column = 0;
876                         }
877                 }
878         }
879         if (len) {
880                 if (client_write(outbuf, len) == -1) {
881                         syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
882                         return;
883                 }
884                 client_write(nl, nllen);
885                 column = 0;
886         }
887 }
888
889
890 // Callback function for mime parser that simply lists the part
891 void list_this_part(char *name, char *filename, char *partnum, char *disp,
892                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
893                     char *cbid, void *cbuserdata)
894 {
895         struct ma_info *ma;
896         
897         ma = (struct ma_info *)cbuserdata;
898         if (ma->is_ma == 0) {
899                 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
900                         name, 
901                         filename, 
902                         partnum, 
903                         disp, 
904                         cbtype, 
905                         (long)length, 
906                         cbid, 
907                         cbcharset);
908         }
909 }
910
911
912 // Callback function for multipart prefix
913 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
914                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
915                     char *cbid, void *cbuserdata)
916 {
917         struct ma_info *ma;
918         
919         ma = (struct ma_info *)cbuserdata;
920         if (!strcasecmp(cbtype, "multipart/alternative")) {
921                 ++ma->is_ma;
922         }
923
924         if (ma->is_ma == 0) {
925                 cprintf("pref=%s|%s\n", partnum, cbtype);
926         }
927 }
928
929
930 // Callback function for multipart sufffix
931 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
932                     void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
933                     char *cbid, void *cbuserdata)
934 {
935         struct ma_info *ma;
936         
937         ma = (struct ma_info *)cbuserdata;
938         if (ma->is_ma == 0) {
939                 cprintf("suff=%s|%s\n", partnum, cbtype);
940         }
941         if (!strcasecmp(cbtype, "multipart/alternative")) {
942                 --ma->is_ma;
943         }
944 }
945
946
947 // Callback function for mime parser that opens a section for downloading
948 // we use serv_files function here: 
949 extern void OpenCmdResult(char *filename, const char *mime_type);
950 void mime_download(char *name, char *filename, char *partnum, char *disp,
951                    void *content, char *cbtype, char *cbcharset, size_t length,
952                    char *encoding, char *cbid, void *cbuserdata)
953 {
954         int rv = 0;
955
956         // Silently go away if there's already a download open.
957         if (CC->download_fp != NULL)
958                 return;
959
960         if (
961                 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
962         ||      (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
963         ) {
964                 CC->download_fp = tmpfile();
965                 if (CC->download_fp == NULL) {
966                         syslog(LOG_ERR, "msgbase: mime_download() couldn't write: %m");
967                         cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
968                         return;
969                 }
970         
971                 rv = fwrite(content, length, 1, CC->download_fp);
972                 if (rv <= 0) {
973                         syslog(LOG_ERR, "msgbase: mime_download() Couldn't write: %m");
974                         cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
975                         fclose(CC->download_fp);
976                         CC->download_fp = NULL;
977                         return;
978                 }
979                 fflush(CC->download_fp);
980                 rewind(CC->download_fp);
981         
982                 OpenCmdResult(filename, cbtype);
983         }
984 }
985
986
987 // Callback function for mime parser that outputs a section all at once.
988 // We can specify the desired section by part number *or* content-id.
989 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
990                    void *content, char *cbtype, char *cbcharset, size_t length,
991                    char *encoding, char *cbid, void *cbuserdata)
992 {
993         int *found_it = (int *)cbuserdata;
994
995         if (
996                 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
997         ||      (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
998         ) {
999                 *found_it = 1;
1000                 cprintf("%d %d|-1|%s|%s|%s\n",
1001                         BINARY_FOLLOWS,
1002                         (int)length,
1003                         filename,
1004                         cbtype,
1005                         cbcharset
1006                 );
1007                 client_write(content, length);
1008         }
1009 }
1010
1011
1012 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length) {
1013         struct CtdlMessage *ret = NULL;
1014         const char *mptr;
1015         const char *upper_bound;
1016         cit_uint8_t ch;
1017         cit_uint8_t field_header;
1018         eMsgField which;
1019
1020         mptr = Buffer;
1021         upper_bound = Buffer + Length;
1022         if (msgnum <= 0) {
1023                 return NULL;
1024         }
1025
1026         // Parse the three bytes that begin EVERY message on disk.
1027         // The first is always 0xFF, the on-disk magic number.
1028         // The second is the anonymous/public type byte.
1029         // The third is the format type byte (vari, fixed, or MIME).
1030         //
1031         ch = *mptr++;
1032         if (ch != 255) {
1033                 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1034                 return NULL;
1035         }
1036         ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1037         memset(ret, 0, sizeof(struct CtdlMessage));
1038
1039         ret->cm_magic = CTDLMESSAGE_MAGIC;
1040         ret->cm_anon_type = *mptr++;                            // Anon type byte
1041         ret->cm_format_type = *mptr++;                          // Format type byte
1042
1043         // The rest is zero or more arbitrary fields.  Load them in.
1044         // We're done when we encounter either a zero-length field or
1045         // have just processed the 'M' (message text) field.
1046         //
1047         do {
1048                 field_header = '\0';
1049                 long len;
1050
1051                 while (field_header == '\0') {                  // work around possibly buggy messages
1052                         if (mptr >= upper_bound) {
1053                                 break;
1054                         }
1055                         field_header = *mptr++;
1056                 }
1057                 if (mptr >= upper_bound) {
1058                         break;
1059                 }
1060                 which = field_header;
1061                 len = strlen(mptr);
1062
1063                 CM_SetField(ret, which, mptr);
1064
1065                 mptr += len + 1;                                // advance to next field
1066
1067         } while ((mptr < upper_bound) && (field_header != 'M'));
1068         return (ret);
1069 }
1070
1071
1072 // Load a message from disk into memory.
1073 // This is used by CtdlOutputMsg() and other fetch functions.
1074 //
1075 // NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1076 //       using the CM_Free(); function.
1077 //
1078 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) {
1079         struct cdbdata dmsgtext;
1080         struct CtdlMessage *ret = NULL;
1081
1082         syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1083         dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1084         if (dmsgtext.ptr == NULL) {
1085                 syslog(LOG_ERR, "msgbase: message #%ld was not found", msgnum);
1086                 return NULL;
1087         }
1088
1089         if (dmsgtext.ptr[dmsgtext.len - 1] != '\0') {
1090                 // FIXME LMDB cannot write to immutable memory
1091                 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1092                 dmsgtext.ptr[dmsgtext.len - 1] = '\0';
1093         }
1094
1095         ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext.ptr, dmsgtext.len);
1096         if (ret == NULL) {
1097                 return NULL;
1098         }
1099
1100         // Always make sure there's something in the msg text field.  If
1101         // it's NULL, the message text is most likely stored separately,
1102         // so go ahead and fetch that.  Failing that, just set a dummy
1103         // body so other code doesn't barf.
1104         //
1105         if ( (CM_IsEmpty(ret, eMessageText)) && (with_body) ) {
1106                 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1107                 if (dmsgtext.ptr != NULL) {
1108                         CM_SetField(ret, eMessageText, dmsgtext.ptr);
1109                 }
1110         }
1111         if (CM_IsEmpty(ret, eMessageText)) {
1112                 CM_SetField(ret, eMessageText, "\r\n\r\n (no text)\r\n");
1113         }
1114
1115         return (ret);
1116 }
1117
1118
1119 // Pre callback function for multipart/alternative
1120 //
1121 // NOTE: this differs from the standard behavior for a reason.  Normally when
1122 //       displaying multipart/alternative you want to show the _last_ usable
1123 //       format in the message.  Here we show the _first_ one, because it's
1124 //       usually text/plain.  Since this set of functions is designed for text
1125 //       output to non-MIME-aware clients, this is the desired behavior.
1126 //
1127 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1128                 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1129                 char *cbid, void *cbuserdata)
1130 {
1131         struct ma_info *ma;
1132         
1133         ma = (struct ma_info *)cbuserdata;
1134         syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);     
1135         if (!strcasecmp(cbtype, "multipart/alternative")) {
1136                 ++ma->is_ma;
1137                 ma->did_print = 0;
1138         }
1139         if (!strcasecmp(cbtype, "message/rfc822")) {
1140                 ++ma->freeze;
1141         }
1142 }
1143
1144
1145 //
1146 // Post callback function for multipart/alternative
1147 //
1148 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1149                 void *content, char *cbtype, char *cbcharset, size_t length,
1150                 char *encoding, char *cbid, void *cbuserdata)
1151 {
1152         struct ma_info *ma;
1153         
1154         ma = (struct ma_info *)cbuserdata;
1155         syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);    
1156         if (!strcasecmp(cbtype, "multipart/alternative")) {
1157                 --ma->is_ma;
1158                 ma->did_print = 0;
1159         }
1160         if (!strcasecmp(cbtype, "message/rfc822")) {
1161                 --ma->freeze;
1162         }
1163 }
1164
1165
1166 // Inline callback function for mime parser that wants to display text
1167 void fixed_output(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         char *ptr;
1172         char *wptr;
1173         size_t wlen;
1174         struct ma_info *ma;
1175
1176         ma = (struct ma_info *)cbuserdata;
1177
1178         syslog(LOG_DEBUG,
1179                 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1180                 partnum, filename, cbtype, (long)length
1181         );
1182
1183         // If we're in the middle of a multipart/alternative scope and
1184         // we've already printed another section, skip this one.
1185         if ( (ma->is_ma) && (ma->did_print) ) {
1186                 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1187                 return;
1188         }
1189         ma->did_print = 1;
1190
1191         if ( (!strcasecmp(cbtype, "text/plain")) 
1192            || (IsEmptyStr(cbtype)) ) {
1193                 wptr = content;
1194                 if (length > 0) {
1195                         client_write(wptr, length);
1196                         if (wptr[length-1] != '\n') {
1197                                 cprintf("\n");
1198                         }
1199                 }
1200                 return;
1201         }
1202
1203         if (!strcasecmp(cbtype, "text/html")) {
1204                 ptr = html_to_ascii(content, length, 80, 0);
1205                 wlen = strlen(ptr);
1206                 client_write(ptr, wlen);
1207                 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1208                         cprintf("\n");
1209                 }
1210                 free(ptr);
1211                 return;
1212         }
1213
1214         if (ma->use_fo_hooks) {
1215                 if (PerformFixedOutputHooks(cbtype, content, length)) {         // returns nonzero if it handled the part
1216                         return;
1217                 }
1218         }
1219
1220         if (strncasecmp(cbtype, "multipart/", 10)) {
1221                 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1222                         partnum, filename, cbtype, (long)length);
1223                 return;
1224         }
1225 }
1226
1227
1228 // The client is elegant and sophisticated and wants to be choosy about
1229 // MIME content types, so figure out which multipart/alternative part
1230 // we're going to send.
1231 //
1232 // We use a system of weights.  When we find a part that matches one of the
1233 // MIME types we've declared as preferential, we can store it in ma->chosen_part
1234 // and then set ma->chosen_pref to that MIME type's position in our preference
1235 // list.  If we then hit another match, we only replace the first match if
1236 // the preference value is lower.
1237 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1238                 void *content, char *cbtype, char *cbcharset, size_t length,
1239                 char *encoding, char *cbid, void *cbuserdata)
1240 {
1241         char buf[1024];
1242         int i;
1243         struct ma_info *ma;
1244         
1245         ma = (struct ma_info *)cbuserdata;
1246
1247         for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1248                 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1249                 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1250                         if (i < ma->chosen_pref) {
1251                                 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1252                                 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1253                                 ma->chosen_pref = i;
1254                         }
1255                 }
1256         }
1257 }
1258
1259
1260 // Now that we've chosen our preferred part, output it.
1261 void output_preferred(char *name, 
1262                       char *filename, 
1263                       char *partnum, 
1264                       char *disp,
1265                       void *content, 
1266                       char *cbtype, 
1267                       char *cbcharset, 
1268                       size_t length,
1269                       char *encoding, 
1270                       char *cbid, 
1271                       void *cbuserdata)
1272 {
1273         int i;
1274         char buf[128];
1275         int add_newline = 0;
1276         char *text_content;
1277         struct ma_info *ma;
1278         char *decoded = NULL;
1279         size_t bytes_decoded;
1280         int rc = 0;
1281
1282         ma = (struct ma_info *)cbuserdata;
1283
1284         // This is not the MIME part you're looking for...
1285         if (strcasecmp(partnum, ma->chosen_part)) return;
1286
1287         // If the content-type of this part is in our preferred formats
1288         // list, we can simply output it verbatim.
1289         for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1290                 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1291                 if (!strcasecmp(buf, cbtype)) {
1292                         // Yeah!  Go!  W00t!!
1293                         if (ma->dont_decode == 0) 
1294                                 rc = mime_decode_now (content, 
1295                                                       length,
1296                                                       encoding,
1297                                                       &decoded,
1298                                                       &bytes_decoded);
1299                         if (rc < 0)
1300                                 break; // Give us the chance, maybe theres another one.
1301
1302                         if (rc == 0) text_content = (char *)content;
1303                         else {
1304                                 text_content = decoded;
1305                                 length = bytes_decoded;
1306                         }
1307
1308                         if (text_content[length-1] != '\n') {
1309                                 ++add_newline;
1310                         }
1311                         cprintf("Content-type: %s", cbtype);
1312                         if (!IsEmptyStr(cbcharset)) {
1313                                 cprintf("; charset=%s", cbcharset);
1314                         }
1315                         cprintf("\nContent-length: %d\n",
1316                                 (int)(length + add_newline) );
1317                         if (!IsEmptyStr(encoding)) {
1318                                 cprintf("Content-transfer-encoding: %s\n", encoding);
1319                         }
1320                         else {
1321                                 cprintf("Content-transfer-encoding: 7bit\n");
1322                         }
1323                         cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1324                         cprintf("\n");
1325                         if (client_write(text_content, length) == -1)
1326                         {
1327                                 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1328                                 return;
1329                         }
1330                         if (add_newline) cprintf("\n");
1331                         if (decoded != NULL) free(decoded);
1332                         return;
1333                 }
1334         }
1335
1336         // No translations required or possible: output as text/plain
1337         cprintf("Content-type: text/plain\n\n");
1338         rc = 0;
1339         if (ma->dont_decode == 0)
1340                 rc = mime_decode_now (content, 
1341                                       length,
1342                                       encoding,
1343                                       &decoded,
1344                                       &bytes_decoded);
1345         if (rc < 0)
1346                 return; // Give us the chance, maybe theres another one.
1347         
1348         if (rc == 0) text_content = (char *)content;
1349         else {
1350                 text_content = decoded;
1351                 length = bytes_decoded;
1352         }
1353
1354         fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, length, encoding, cbid, cbuserdata);
1355         if (decoded != NULL) free(decoded);
1356 }
1357
1358
1359 struct encapmsg {
1360         char desired_section[64];
1361         char *msg;
1362         size_t msglen;
1363 };
1364
1365
1366 // Callback function
1367 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1368                    void *content, char *cbtype, char *cbcharset, size_t length,
1369                    char *encoding, char *cbid, void *cbuserdata)
1370 {
1371         struct encapmsg *encap;
1372
1373         encap = (struct encapmsg *)cbuserdata;
1374
1375         // Only proceed if this is the desired section...
1376         if (!strcasecmp(encap->desired_section, partnum)) {
1377                 encap->msglen = length;
1378                 encap->msg = malloc(length + 2);
1379                 memcpy(encap->msg, content, length);
1380                 return;
1381         }
1382 }
1383
1384
1385 // Determine whether the specified message exists in the cached_msglist
1386 // (This is a security check)
1387 int check_cached_msglist(long msgnum) {
1388
1389         // cases in which we skip the check
1390         if (!CC) return om_ok;                                          // not a session
1391         if (CC->client_socket <= 0) return om_ok;                       // not a client session
1392         if (CC->cached_msglist == NULL) return om_access_denied;        // no msglist fetched
1393         if (CC->cached_num_msgs == 0) return om_access_denied;          // nothing to check 
1394
1395         // Do a binary search within the cached_msglist for the requested msgnum
1396         int min = 0;
1397         int max = (CC->cached_num_msgs - 1);
1398
1399         while (max >= min) {
1400                 int middle = min + (max-min) / 2 ;
1401                 if (msgnum == CC->cached_msglist[middle]) {
1402                         return om_ok;
1403                 }
1404                 if (msgnum > CC->cached_msglist[middle]) {
1405                         min = middle + 1;
1406                 }
1407                 else {
1408                         max = middle - 1;
1409                 }
1410         }
1411
1412         return om_access_denied;
1413 }
1414
1415
1416 // Get a message off disk.  (returns om_* values found in msgbase.h)
1417 int CtdlOutputMsg(long msg_num,         // message number (local) to fetch
1418                 int mode,               // how would you like that message?
1419                 int headers_only,       // If nonzero, skip the message body.  Also avoids loading it, if it's stored separately.
1420                 int do_proto,           // do Citadel protocol responses?
1421                 int crlf,               // If nonzero, terminate lines with CRLF instead of just LF
1422                 char *section,          // NULL or a message/rfc822 section
1423                 int flags,              // various flags; see msgbase.h
1424                 char **Author,          // If non-NULL, allocate a string buffer and populate the display name (caller must free)
1425                 char **Address,         // If non-NULL, allocate a string buffer and populate the email address (caller must free)
1426                 char **MessageID        // If non-NULL, allocate a string buffer and populate the message ID (caller must free)
1427 ) {
1428         struct CtdlMessage *TheMessage = NULL;
1429         int retcode = CIT_OK;
1430         struct encapmsg encap;
1431         int r;
1432
1433         syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)", 
1434                 msg_num, mode,
1435                 (section ? section : "<>")
1436         );
1437
1438         r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1439         if (r != om_ok) {
1440                 if (do_proto) {
1441                         if (r == om_not_logged_in) {
1442                                 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1443                         }
1444                         else {
1445                                 cprintf("%d An unknown error has occurred.\n", ERROR);
1446                         }
1447                 }
1448                 return(r);
1449         }
1450
1451         // Check to make sure the message is actually IN this room
1452         r = check_cached_msglist(msg_num);
1453         if (r == om_access_denied) {
1454                 // Not in the cache?  We get ONE shot to check it again.
1455                 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1456                 r = check_cached_msglist(msg_num);
1457         }
1458         if (r != om_ok) {
1459                 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s", msg_num, CC->room.QRname);
1460                 if (do_proto) {
1461                         if (r == om_access_denied) {
1462                                 cprintf("%d message %ld was not found in this room\n", ERROR + HIGHER_ACCESS_REQUIRED, msg_num);
1463                         }
1464                 }
1465                 return(r);
1466         }
1467
1468         // Fetch the message from disk.  If we're in HEADERS_FAST mode, request that we don't even bother loading the body into memory.
1469         if (headers_only == HEADERS_FAST) {
1470                 TheMessage = CtdlFetchMessage(msg_num, 0);
1471         }
1472         else {
1473                 TheMessage = CtdlFetchMessage(msg_num, 1);
1474         }
1475
1476         if (TheMessage == NULL) {
1477                 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n", ERROR + MESSAGE_NOT_FOUND, msg_num);
1478                 return(om_no_such_msg);
1479         }
1480
1481         // Here is the weird form of this command, to process only an encapsulated message/rfc822 section.
1482         if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1483                 memset(&encap, 0, sizeof encap);
1484                 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1485                 mime_parser(CM_RANGE(TheMessage, eMessageText),
1486                             *extract_encapsulated_message,
1487                             NULL, NULL, (void *)&encap, 0
1488                         );
1489
1490                 if ((Author != NULL) && (*Author == NULL)) {
1491                         *Author = strdup(TheMessage->cm_fields[eAuthor]);
1492                 }
1493                 if ((Address != NULL) && (*Address == NULL)) {  
1494                         *Address = strdup(TheMessage->cm_fields[erFc822Addr]);
1495                 }
1496                 if ((MessageID != NULL) && (*MessageID == NULL)) {      
1497                         *MessageID = strdup(TheMessage->cm_fields[emessageId]);
1498                 }
1499                 CM_Free(TheMessage);
1500                 TheMessage = NULL;
1501
1502                 if (encap.msg) {
1503                         encap.msg[encap.msglen] = 0;
1504                         TheMessage = convert_internet_message(encap.msg);
1505                         encap.msg = NULL;       // no free() here, TheMessage owns it now
1506
1507                         // Now we let it fall through to the bottom of this function, because TheMessage now contains the
1508                         // encapsulated message instead of the top-level message.  Isn't that neat?
1509                 }
1510                 else {
1511                         if (do_proto) {
1512                                 cprintf("%d msg %ld has no part %s\n", ERROR + MESSAGE_NOT_FOUND, msg_num, section);
1513                         }
1514                         retcode = om_no_such_msg;
1515                 }
1516
1517         }
1518
1519         // Ok, output the message now
1520         if (retcode == CIT_OK) {
1521                 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1522         }
1523         if ((Author != NULL) && (*Author == NULL)) {
1524                 long len;
1525                 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1526         }
1527         if ((Address != NULL) && (*Address == NULL)) {  
1528                 long len;
1529                 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1530         }
1531         if ((MessageID != NULL) && (*MessageID == NULL)) {      
1532                 long len;
1533                 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1534         }
1535
1536         CM_Free(TheMessage);
1537
1538         return(retcode);
1539 }
1540
1541
1542 void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) {
1543         int i;
1544         char buf[SIZ];
1545         char display_name[256];
1546
1547         // begin header processing loop for Citadel message format
1548         safestrncpy(display_name, "<unknown>", sizeof display_name);
1549         if (!CM_IsEmpty(TheMessage, eAuthor)) {
1550                 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1551                 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1552                         safestrncpy(display_name, "****", sizeof display_name);
1553                 }
1554                 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1555                         safestrncpy(display_name, "anonymous", sizeof display_name);
1556                 }
1557                 else {
1558                         safestrncpy(display_name, buf, sizeof display_name);
1559                 }
1560                 if (    (is_room_aide())
1561                         && (    (TheMessage->cm_anon_type == MES_ANONONLY)
1562                                 || (TheMessage->cm_anon_type == MES_ANONOPT)
1563                         )
1564                 ) {
1565                         size_t tmp = strlen(display_name);
1566                         snprintf(&display_name[tmp], sizeof display_name - tmp, " [%s]", buf);
1567                 }
1568         }
1569
1570         // Now spew the header fields in the order we like them.
1571         for (i=0; i< NDiskFields; ++i) {
1572                 eMsgField Field;
1573                 Field = FieldOrder[i];
1574                 if (Field != eMessageText) {
1575                         if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) {
1576                                 if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) {
1577                                         sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1578                                 }
1579                                 if (Field == eAuthor) {
1580                                         if (do_proto) {
1581                                                 cprintf("%s=%s\n", msgkeys[Field], display_name);
1582                                         }
1583                                 }
1584                                 // Masquerade display name if needed
1585                                 else {
1586                                         if (do_proto) {
1587                                                 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1588                                         }
1589                                 }
1590                                 // Give the client a hint about whether the message originated locally
1591                                 if (Field == erFc822Addr) {
1592                                         if (IsDirectory(TheMessage->cm_fields[Field] ,0)) {
1593                                                 cprintf("locl=yes\n");                          // message originated locally.
1594                                         }
1595
1596
1597
1598                                 }
1599                         }
1600                 }
1601         }
1602 }
1603
1604
1605 void OutputRFC822MsgHeaders(
1606         struct CtdlMessage *TheMessage,
1607         int flags,              // should the message be exported clean
1608         const char *nl, int nlen,
1609         char *mid, long sizeof_mid,
1610         char *suser, long sizeof_suser,
1611         char *luser, long sizeof_luser,
1612         char *fuser, long sizeof_fuser,
1613         char *snode, long sizeof_snode)
1614 {
1615         char datestamp[100];
1616         int subject_found = 0;
1617         char buf[SIZ];
1618         int i, j, k;
1619         char *mptr = NULL;
1620         char *mpptr = NULL;
1621         char *hptr;
1622
1623         for (i = 0; i < NDiskFields; ++i) {
1624                 if (TheMessage->cm_fields[FieldOrder[i]]) {
1625                         mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1626                         switch (FieldOrder[i]) {
1627                         case eAuthor:
1628                                 safestrncpy(luser, mptr, sizeof_luser);
1629                                 safestrncpy(suser, mptr, sizeof_suser);
1630                                 break;
1631                         case eCarbonCopY:
1632                                 if ((flags & QP_EADDR) != 0) {
1633                                         mptr = qp_encode_email_addrs(mptr);
1634                                 }
1635                                 sanitize_truncated_recipient(mptr);
1636                                 cprintf("CC: %s%s", mptr, nl);
1637                                 break;
1638                         case eMessagePath:
1639                                 cprintf("Return-Path: %s%s", mptr, nl);
1640                                 break;
1641                         case eListID:
1642                                 cprintf("List-ID: %s%s", mptr, nl);
1643                                 break;
1644                         case eenVelopeTo:
1645                                 if ((flags & QP_EADDR) != 0) 
1646                                         mptr = qp_encode_email_addrs(mptr);
1647                                 hptr = mptr;
1648                                 while ((*hptr != '\0') && isspace(*hptr))
1649                                         hptr ++;
1650                                 if (!IsEmptyStr(hptr))
1651                                         cprintf("Envelope-To: %s%s", hptr, nl);
1652                                 break;
1653                         case eMsgSubject:
1654                                 cprintf("Subject: %s%s", mptr, nl);
1655                                 subject_found = 1;
1656                                 break;
1657                         case emessageId:
1658                                 safestrncpy(mid, mptr, sizeof_mid);
1659                                 break;
1660                         case erFc822Addr:
1661                                 safestrncpy(fuser, mptr, sizeof_fuser);
1662                                 break;
1663                         case eRecipient:
1664                                 if (haschar(mptr, '@') == 0) {
1665                                         sanitize_truncated_recipient(mptr);
1666                                         cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1667                                         cprintf("%s", nl);
1668                                 }
1669                                 else {
1670                                         if ((flags & QP_EADDR) != 0) {
1671                                                 mptr = qp_encode_email_addrs(mptr);
1672                                         }
1673                                         sanitize_truncated_recipient(mptr);
1674                                         cprintf("To: %s", mptr);
1675                                         cprintf("%s", nl);
1676                                 }
1677                                 break;
1678                         case eTimestamp:
1679                                 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1680                                 cprintf("Date: %s%s", datestamp, nl);
1681                                 break;
1682                         case eWeferences:
1683                                 cprintf("References: ");
1684                                 k = num_tokens(mptr, '|');
1685                                 for (j=0; j<k; ++j) {
1686                                         extract_token(buf, mptr, j, '|', sizeof buf);
1687                                         cprintf("<%s>", buf);
1688                                         if (j == (k-1)) {
1689                                                 cprintf("%s", nl);
1690                                         }
1691                                         else {
1692                                                 cprintf(" ");
1693                                         }
1694                                 }
1695                                 break;
1696                         case eReplyTo:
1697                                 hptr = mptr;
1698                                 while ((*hptr != '\0') && isspace(*hptr))
1699                                         hptr ++;
1700                                 if (!IsEmptyStr(hptr))
1701                                         cprintf("Reply-To: %s%s", mptr, nl);
1702                                 break;
1703
1704                         case eExclusiveID:
1705                         case eJournal:
1706                         case eMessageText:
1707                         case eBig_message:
1708                         case eOriginalRoom:
1709                         case eErrorMsg:
1710                         case eSuppressIdx:
1711                         case eExtnotify:
1712                         case eVltMsgNum:
1713                                 // these don't map to mime message headers.
1714                                 break;
1715                         }
1716                         if (mptr != mpptr) {
1717                                 free (mptr);
1718                         }
1719                 }
1720         }
1721         if (subject_found == 0) {
1722                 cprintf("Subject: (no subject)%s", nl);
1723         }
1724 }
1725
1726
1727 void Dump_RFC822HeadersBody(
1728         struct CtdlMessage *TheMessage,
1729         int headers_only,       // eschew the message body?
1730         int flags,              // should the bessage be exported clean?
1731         const char *nl, int nlen)
1732 {
1733         cit_uint8_t prev_ch;
1734         int eoh = 0;
1735         const char *StartOfText = StrBufNOTNULL;
1736         char outbuf[1024];
1737         int outlen = 0;
1738         int nllen = strlen(nl);
1739         char *mptr;
1740         int lfSent = 0;
1741
1742         mptr = TheMessage->cm_fields[eMessageText];
1743
1744         prev_ch = '\0';
1745         while (*mptr != '\0') {
1746                 if (*mptr == '\r') {
1747                         // do nothing
1748                 }
1749                 else {
1750                         if ((!eoh) && (*mptr == '\n')) {
1751                                 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1752                                 if (!eoh) {
1753                                         eoh = *(mptr+1) == '\n';
1754                                 }
1755                                 if (eoh) {
1756                                         StartOfText = mptr;
1757                                         StartOfText = strchr(StartOfText, '\n');
1758                                         StartOfText = strchr(StartOfText, '\n');
1759                                 }
1760                         }
1761                         if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1762                             ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1763                             ((headers_only != HEADERS_NONE) && 
1764                              (headers_only != HEADERS_ONLY))
1765                         ) {
1766                                 if (*mptr == '\n') {
1767                                         memcpy(&outbuf[outlen], nl, nllen);
1768                                         outlen += nllen;
1769                                         outbuf[outlen] = '\0';
1770                                 }
1771                                 else {
1772                                         outbuf[outlen++] = *mptr;
1773                                 }
1774                         }
1775                 }
1776                 if (flags & ESC_DOT) {
1777                         if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1778                                 outbuf[outlen++] = '.';
1779                         }
1780                         prev_ch = *mptr;
1781                 }
1782                 ++mptr;
1783                 if (outlen > 1000) {
1784                         if (client_write(outbuf, outlen) == -1) {
1785                                 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1786                                 return;
1787                         }
1788                         lfSent =  (outbuf[outlen - 1] == '\n');
1789                         outlen = 0;
1790                 }
1791         }
1792         if (outlen > 0) {
1793                 client_write(outbuf, outlen);
1794                 lfSent =  (outbuf[outlen - 1] == '\n');
1795         }
1796         if (!lfSent)
1797                 client_write(nl, nlen);
1798 }
1799
1800
1801 // If the format type on disk is 1 (fixed-format), then we want
1802 // everything to be output completely literally ... regardless of
1803 // what message transfer format is in use.
1804 void DumpFormatFixed(
1805         struct CtdlMessage *TheMessage,
1806         int mode,               // how would you like that message?
1807         const char *nl, int nllen)
1808 {
1809         cit_uint8_t ch;
1810         char buf[SIZ];
1811         int buflen;
1812         int xlline = 0;
1813         char *mptr;
1814
1815         mptr = TheMessage->cm_fields[eMessageText];
1816         
1817         if (mode == MT_MIME) {
1818                 cprintf("Content-type: text/plain\n\n");
1819         }
1820         *buf = '\0';
1821         buflen = 0;
1822         while (ch = *mptr++, ch > 0) {
1823                 if (ch == '\n')
1824                         ch = '\r';
1825
1826                 if ((buflen > 250) && (!xlline)){
1827                         int tbuflen;
1828                         tbuflen = buflen;
1829
1830                         while ((buflen > 0) && 
1831                                (!isspace(buf[buflen])))
1832                                 buflen --;
1833                         if (buflen == 0) {
1834                                 xlline = 1;
1835                         }
1836                         else {
1837                                 mptr -= tbuflen - buflen;
1838                                 buf[buflen] = '\0';
1839                                 ch = '\r';
1840                         }
1841                 }
1842
1843                 // if we reach the outer bounds of our buffer, abort without respect for what we purge.
1844                 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1845                         ch = '\r';
1846                 }
1847
1848                 if (ch == '\r') {
1849                         memcpy (&buf[buflen], nl, nllen);
1850                         buflen += nllen;
1851                         buf[buflen] = '\0';
1852
1853                         if (client_write(buf, buflen) == -1) {
1854                                 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
1855                                 return;
1856                         }
1857                         *buf = '\0';
1858                         buflen = 0;
1859                         xlline = 0;
1860                 } else {
1861                         buf[buflen] = ch;
1862                         buflen++;
1863                 }
1864         }
1865         buf[buflen] = '\0';
1866         if (!IsEmptyStr(buf)) {
1867                 cprintf("%s%s", buf, nl);
1868         }
1869 }
1870
1871
1872 // Get a message off disk.  (returns om_* values found in msgbase.h)
1873 int CtdlOutputPreLoadedMsg(
1874                 struct CtdlMessage *TheMessage,
1875                 int mode,               // how would you like that message?
1876                 int headers_only,       // eschew the message body?
1877                 int do_proto,           // do Citadel protocol responses?
1878                 int crlf,               // Use CRLF newlines instead of LF?
1879                 int flags               // should the bessage be exported clean?
1880 ) {
1881         int i;
1882         const char *nl; // newline string
1883         int nlen;
1884         struct ma_info ma;
1885
1886         // Buffers needed for RFC822 translation.  These are all filled
1887         // using functions that are bounds-checked, and therefore we can
1888         // make them substantially smaller than SIZ.
1889         char suser[1024];
1890         char luser[1024];
1891         char fuser[1024];
1892         char snode[1024];
1893         char mid[1024];
1894
1895         syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
1896                    ((TheMessage == NULL) ? "NULL" : "not null"),
1897                    mode, headers_only, do_proto, crlf
1898         );
1899
1900         strcpy(mid, "unknown");
1901         nl = (crlf ? "\r\n" : "\n");
1902         nlen = crlf ? 2 : 1;
1903
1904         if (!CM_IsValidMsg(TheMessage)) {
1905                 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
1906                 return(om_no_such_msg);
1907         }
1908
1909         // Suppress envelope recipients if required to avoid disclosing BCC addresses.
1910         // Pad it with spaces in order to avoid changing the RFC822 length of the message.
1911         if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
1912                 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
1913         }
1914                 
1915         // Are we downloading a MIME component?
1916         if (mode == MT_DOWNLOAD) {
1917                 if (TheMessage->cm_format_type != FMT_RFC822) {
1918                         if (do_proto) {
1919                                 cprintf("%d This is not a MIME message.\n", ERROR + ILLEGAL_VALUE);
1920                         }
1921                 }
1922                 else if (CC->download_fp != NULL) {
1923                         if (do_proto) {
1924                                 cprintf( "%d You already have a download open.\n", ERROR + RESOURCE_BUSY);
1925                         }
1926                 }
1927                 else {
1928                         // Parse the message text component
1929                         mime_parser(CM_RANGE(TheMessage, eMessageText), *mime_download, NULL, NULL, NULL, 0);
1930
1931                         // If there's no file open by this time, the requested * section wasn't found, so print an error
1932                         if (CC->download_fp == NULL) {
1933                                 if (do_proto) {
1934                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1935                                 }
1936                         }
1937                 }
1938                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1939         }
1940
1941         // MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
1942         // in a single server operation instead of opening a download file.
1943         if (mode == MT_SPEW_SECTION) {
1944                 if (TheMessage->cm_format_type != FMT_RFC822) {
1945                         if (do_proto)
1946                                 cprintf("%d This is not a MIME message.\n",
1947                                 ERROR + ILLEGAL_VALUE);
1948                 }
1949                 else {
1950                         // Locate and parse the component specified by the caller
1951                         int found_it = 0;
1952                         mime_parser(CM_RANGE(TheMessage, eMessageText), *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
1953
1954                         // If section wasn't found, print an error
1955                         if (!found_it) {
1956                                 if (do_proto) {
1957                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1958                                 }
1959                         }
1960                 }
1961                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1962         }
1963
1964         // now for the user-mode message reading loops
1965         if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
1966
1967         // Does the caller want to skip the headers?
1968         if (headers_only == HEADERS_NONE) goto START_TEXT;
1969
1970         // Tell the client which format type we're using.
1971         if ( (mode == MT_CITADEL) && (do_proto) ) {
1972                 cprintf("type=%d\n", TheMessage->cm_format_type);       // Tell the client which format type we're using.
1973         }
1974
1975         // nhdr=yes means that we're only displaying headers, no body
1976         if (    (TheMessage->cm_anon_type == MES_ANONONLY)
1977                 && ((mode == MT_CITADEL) || (mode == MT_MIME))
1978                 && (do_proto)
1979         ) {
1980                 cprintf("nhdr=yes\n");
1981         }
1982
1983         if ((mode == MT_CITADEL) || (mode == MT_MIME)) {
1984                 OutputCtdlMsgHeaders(TheMessage, do_proto);
1985         }
1986
1987         // begin header processing loop for RFC822 transfer format
1988         strcpy(suser, "");
1989         strcpy(luser, "");
1990         strcpy(fuser, "");
1991         strcpy(snode, "");
1992         if (mode == MT_RFC822) {
1993                 OutputRFC822MsgHeaders(
1994                         TheMessage,
1995                         flags,
1996                         nl, nlen,
1997                         mid, sizeof(mid),
1998                         suser, sizeof(suser),
1999                         luser, sizeof(luser),
2000                         fuser, sizeof(fuser),
2001                         snode, sizeof(snode)
2002                 );
2003         }
2004
2005         for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2006                 suser[i] = tolower(suser[i]);
2007                 if (!isalnum(suser[i])) suser[i]='_';
2008         }
2009
2010         if (mode == MT_RFC822) {
2011                 // Make the message ID RFC2822 compliant
2012                 cprintf("Message-ID: <%s%s%s>%s",               // put it in angle brackets
2013                         mid,
2014                         (strchr(mid, '@') ? "" : "@"),          // if there is no domain part,
2015                         (strchr(mid, '@') ? "" : snode),        // tack on ours.
2016                         nl
2017                 );
2018
2019                 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2020                         cprintf("From: \"----\" <x@x.org>%s", nl);
2021                 }
2022                 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2023                         cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2024                 }
2025                 else if (!IsEmptyStr(fuser)) {
2026                         cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2027                 }
2028                 else {
2029                         cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2030                 }
2031
2032                 // Blank line signifying RFC822 end-of-headers
2033                 if (TheMessage->cm_format_type != FMT_RFC822) {
2034                         cprintf("%s", nl);
2035                 }
2036         }
2037
2038         // end header processing loop ... at this point, we're in the text
2039 START_TEXT:
2040         if (headers_only == HEADERS_FAST) goto DONE;
2041
2042         // Tell the client about the MIME parts in this message
2043         if (TheMessage->cm_format_type == FMT_RFC822) {
2044                 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2045                         memset(&ma, 0, sizeof(struct ma_info));
2046                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2047                                 (do_proto ? *list_this_part : NULL),
2048                                 (do_proto ? *list_this_pref : NULL),
2049                                 (do_proto ? *list_this_suff : NULL),
2050                                 (void *)&ma, 1);
2051                 }
2052                 else if (mode == MT_RFC822) {   // unparsed RFC822 dump
2053                         Dump_RFC822HeadersBody(TheMessage, headers_only, flags, nl, nlen);
2054                         goto DONE;
2055                 }
2056         }
2057
2058         if (headers_only == HEADERS_ONLY) {
2059                 goto DONE;
2060         }
2061
2062         // signify start of msg text
2063         if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2064                 if (do_proto) cprintf("text\n");
2065         }
2066
2067         if (TheMessage->cm_format_type == FMT_FIXED) {
2068                 DumpFormatFixed( TheMessage, mode, nl, nlen);
2069         }
2070
2071         // If the message on disk is format 0 (Citadel vari-format), we
2072         // output using the formatter at 80 columns.  This is the final output
2073         // form if the transfer format is RFC822, but if the transfer format
2074         // is Citadel proprietary, it'll still work, because the indentation
2075         // for new paragraphs is correct and the client will reformat the
2076         // message to the reader's screen width.
2077         //
2078         if (TheMessage->cm_format_type == FMT_CITADEL) {
2079                 if (mode == MT_MIME) {
2080                         cprintf("Content-type: text/x-citadel-variformat\n\n");
2081                 }
2082                 memfmout(TheMessage->cm_fields[eMessageText], nl);
2083         }
2084
2085         // If the message on disk is format 4 (MIME), we've gotta hand it
2086         // off to the MIME parser.  The client has already been told that
2087         // this message is format 1 (fixed format), so the callback function
2088         // we use will display those parts as-is.
2089         //
2090         if (TheMessage->cm_format_type == FMT_RFC822) {
2091                 memset(&ma, 0, sizeof(struct ma_info));
2092
2093                 if (mode == MT_MIME) {
2094                         ma.use_fo_hooks = 0;
2095                         strcpy(ma.chosen_part, "1");
2096                         ma.chosen_pref = 9999;
2097                         ma.dont_decode = CC->msg4_dont_decode;
2098                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2099                                     *choose_preferred, *fixed_output_pre,
2100                                     *fixed_output_post, (void *)&ma, 1);
2101                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2102                                     *output_preferred, NULL, NULL, (void *)&ma, 1);
2103                 }
2104                 else {
2105                         ma.use_fo_hooks = 1;
2106                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2107                                     *fixed_output, *fixed_output_pre,
2108                                     *fixed_output_post, (void *)&ma, 0);
2109                 }
2110
2111         }
2112
2113 DONE:   // now we're done
2114         if (do_proto) cprintf("000\n");
2115         return(om_ok);
2116 }
2117
2118
2119 // Save one or more message pointers into a specified room
2120 // (Returns 0 for success, nonzero for failure)
2121 // roomname may be NULL to use the current room
2122 //
2123 // Note that the 'msg_in' field may be set to NULL, in which case
2124 // the message will be fetched from disk, by number, if we need to perform
2125 // replication checks.  This adds an additional database read, so if the
2126 // caller already has the message in memory then it should be supplied.  (Obviously
2127 // this mode of operation only works if we're saving a single message.)
2128 //
2129 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2130                         int do_repl_check, struct CtdlMessage *msg_in, int suppress_refcount_adj
2131 ) {
2132         int i, j, unique;
2133         char hold_rm[ROOMNAMELEN];
2134         struct cdbdata *cdbfr;
2135         int num_msgs;
2136         long *msglist;
2137         long highest_msg = 0L;
2138
2139         long msgid = 0;
2140         struct CtdlMessage *msg = NULL;
2141
2142         long *msgs_to_be_merged = NULL;
2143         int num_msgs_to_be_merged = 0;
2144
2145         syslog(LOG_DEBUG,
2146                 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2147                 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2148         );
2149
2150         strcpy(hold_rm, CC->room.QRname);
2151
2152         // Sanity checks
2153         if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2154         if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2155         if (num_newmsgs > 1) msg_in = NULL;
2156
2157         // Now the regular stuff
2158         if (CtdlGetRoomLock(&CC->room, ((roomname != NULL) ? roomname : CC->room.QRname) ) != 0) {
2159                 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2160                 return(ERROR + ROOM_NOT_FOUND);
2161         }
2162
2163         msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2164         num_msgs_to_be_merged = 0;
2165         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
2166
2167         // Create a list of msgid's which were supplied by the caller, but do
2168         // not already exist in the target room.  It is absolutely taboo to
2169         // have more than one reference to the same message in a room.
2170         for (i=0; i<num_newmsgs; ++i) {
2171                 unique = 1;
2172                 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2173                         if (msglist[j] == newmsgidlist[i]) {
2174                                 unique = 0;
2175                         }
2176                 }
2177                 if (unique) {
2178                         msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2179                 }
2180         }
2181
2182         syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2183
2184         // Now merge the new messages
2185         msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2186         if (msglist == NULL) {
2187                 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2188                 free(msgs_to_be_merged);
2189                 abort();                                        // FIXME
2190                 return (ERROR + INTERNAL_ERROR);
2191         }
2192         memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2193         num_msgs += num_msgs_to_be_merged;
2194
2195         // Sort the message list, so all the msgid's are in order
2196         num_msgs = sort_msglist(msglist, num_msgs);
2197
2198         // Determine the highest message number
2199         highest_msg = msglist[num_msgs - 1];
2200
2201         // Write it back to disk.
2202         cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
2203
2204         // Free up the memory we used.
2205         free(msglist);
2206
2207         // Update the highest-message pointer and unlock the room.
2208         CC->room.QRhighest = highest_msg;
2209         CtdlPutRoomLock(&CC->room);
2210
2211         // Perform replication checks if necessary
2212         if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2213                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2214
2215                 for (i=0; i<num_msgs_to_be_merged; ++i) {
2216                         msgid = msgs_to_be_merged[i];
2217         
2218                         if (msg_in != NULL) {
2219                                 msg = msg_in;
2220                         }
2221                         else {
2222                                 msg = CtdlFetchMessage(msgid, 0);
2223                         }
2224         
2225                         if (msg != NULL) {
2226                                 ReplicationChecks(msg);
2227                 
2228                                 // If the message has an Exclusive ID, index that...
2229                                 if (!CM_IsEmpty(msg, eExclusiveID)) {
2230                                         index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2231                                 }
2232
2233                                 // Free up the memory we may have allocated
2234                                 if (msg != msg_in) {
2235                                         CM_Free(msg);
2236                                 }
2237                         }
2238         
2239                 }
2240         }
2241
2242         else {
2243                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2244         }
2245
2246         // Submit this room for processing by hooks
2247         int total_roomhook_errors = PerformRoomHooks(&CC->room);
2248         if (total_roomhook_errors) {
2249                 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2250         }
2251
2252         // Go back to the room we were in before we wandered here...
2253         CtdlGetRoom(&CC->room, hold_rm);
2254
2255         // Bump the reference count for all messages which were merged
2256         if (!suppress_refcount_adj) {
2257                 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2258         }
2259
2260         // Free up memory...
2261         if (msgs_to_be_merged != NULL) {
2262                 free(msgs_to_be_merged);
2263         }
2264
2265         // Return success.
2266         return (0);
2267 }
2268
2269
2270 // This is the same as CtdlSaveMsgPointersInRoom() but it only accepts a single message.
2271 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg_in) {
2272         return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, msg_in, 0);
2273 }
2274
2275
2276 // Message base operation to save a new message to the message store
2277 // (returns new message number)
2278 //
2279 // This is the back end for CtdlSubmitMsg() and should not be directly
2280 // called by server-side modules.
2281 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid) {
2282         long error_count = 0;
2283
2284         // Serialize our data structure for storage in the database
2285         struct ser_ret smr = CtdlSerializeMessage(msg);
2286
2287         if (smr.len == 0) {
2288                 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2289                 return (-1);
2290         }
2291
2292         // STORAGE STRATEGY:
2293         // * If headers+content fit are <= 4K, store them together.  It's likely to be one
2294         //   memory page, one disk sector, etc. so we benefit from a single disk operation.
2295         // * If headers+content exceed 4K, store them separately so we don't end up fetching
2296         //   many gigamegs of data when we're just scanning the headers.
2297         // * We are using a threshold of 4000 bytes so that there's some room for overhead
2298         //   if the database or OS adds any metadata to that one disk page.
2299
2300         if (smr.len <= 4000) {                                  // all together less than one page, store them together
2301
2302                 if (cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len)) {
2303                         ++error_count;
2304                 }
2305
2306         }
2307
2308         else {                                                  // exceed one page, store headers in MSGMAIN, body in BIGMSGS
2309
2310                 if (cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, (smr.msgstart - smr.ser))) {
2311                         ++error_count;
2312                 }
2313
2314                 if (cdb_store(CDB_BIGMSGS, &msgid, (int)sizeof(long), smr.msgstart+1, (smr.len - (smr.msgstart - smr.ser) - 1) )) {
2315                         ++error_count;
2316                 }
2317
2318         }
2319
2320         if (error_count > 0) {
2321                 syslog(LOG_ERR, "msgbase: encountered %ld errors storing message %ld", error_count, msgid);
2322         }
2323
2324         // Free the memory we used for the serialized message
2325         free(smr.ser);
2326         return(error_count);
2327 }
2328
2329
2330 long send_message(struct CtdlMessage *msg) {
2331         long newmsgid;
2332         long retval;
2333         char msgidbuf[256];
2334         long msgidbuflen;
2335
2336         // Get a new message number
2337         newmsgid = get_new_message_number();
2338
2339         // Generate an ID if we don't have one already
2340         if (CM_IsEmpty(msg, emessageId)) {
2341                 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%lX-%lX@%s",
2342                        (long unsigned int) time(NULL),
2343                        (long unsigned int) newmsgid,
2344                        CtdlGetConfigStr("c_fqdn")
2345                 );
2346                 CM_SetField(msg, emessageId, msgidbuf);
2347         }
2348
2349         retval = CtdlSaveThisMessage(msg, newmsgid);
2350
2351         if (retval == 0) {
2352                 retval = newmsgid;
2353         }
2354
2355         // Return the *local* message ID to the caller (even if we're storing a remotely originated message)
2356         return(retval);
2357 }
2358
2359
2360 // Serialize a struct CtdlMessage into the format used on disk.
2361 // 
2362 // This function returns a "struct ser_ret" (defined in server.h) which
2363 // contains the length of the serialized message and a pointer to the
2364 // serialized message in memory.  THE LATTER MUST BE FREED BY THE CALLER.
2365 struct ser_ret CtdlSerializeMessage(struct CtdlMessage *msg) {
2366         struct ser_ret ret;
2367         size_t wlen;
2368         int i;
2369
2370         ret.len = 0;
2371         ret.ser = NULL;
2372         ret.msgstart = NULL;
2373
2374         // Check for valid message format
2375         if (CM_IsValidMsg(msg) == 0) {
2376                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2377                 return(ret);
2378         }
2379
2380         ret.len = 3;
2381         assert(FieldOrder[NDiskFields-1] == eMessageText);              // Message text MUST be last!
2382         for (i=0; i < NDiskFields; ++i) {
2383                 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2384                         ret.len += msg->cm_lengths[FieldOrder[i]] + 2;
2385                 }
2386         }
2387
2388         ret.ser = malloc(ret.len);
2389         if (ret.ser == NULL) {
2390                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret.len);
2391                 ret.len = 0;
2392                 ret.ser = NULL;
2393                 ret.msgstart = NULL;
2394                 return(ret);
2395         }
2396
2397         ret.ser[0] = 0xFF;
2398         ret.ser[1] = msg->cm_anon_type;
2399         ret.ser[2] = msg->cm_format_type;
2400         wlen = 3;
2401
2402         for (i=0; i < NDiskFields; ++i) {
2403                 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2404                         if (FieldOrder[i] == eMessageText) {
2405                                 ret.msgstart = &ret.ser[wlen];          // Make a note where the message text begins
2406                         }
2407                         ret.ser[wlen++] = (char)FieldOrder[i];
2408                         memcpy(&ret.ser[wlen], msg->cm_fields[FieldOrder[i]], msg->cm_lengths[FieldOrder[i]] + 1);
2409                         wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2410                 }
2411         }
2412
2413         assert(ret.len == wlen);                                        // Make sure we measured it correctly
2414         return(ret);
2415 }
2416
2417
2418 // Check to see if any messages already exist in the current room which
2419 // carry the same Exclusive ID as this one.  If any are found, delete them.
2420 void ReplicationChecks(struct CtdlMessage *msg) {
2421         long old_msgnum = (-1L);
2422
2423         if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2424
2425         syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2426
2427         // No exclusive id?  Don't do anything.
2428         if (msg == NULL) return;
2429         if (CM_IsEmpty(msg, eExclusiveID)) return;
2430
2431         old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2432         if (old_msgnum > 0L) {
2433                 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2434                 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2435         }
2436 }
2437
2438
2439 // Save a message to disk and submit it into the delivery system.
2440 long CtdlSubmitMsg(struct CtdlMessage *msg,     // message to save
2441                    struct recptypes *recps,     // recipients (if mail)
2442                    const char *force            // force a particular room?
2443 ) {
2444         char hold_rm[ROOMNAMELEN];
2445         char actual_rm[ROOMNAMELEN];
2446         char force_room[ROOMNAMELEN];
2447         char content_type[SIZ];                 // We have to learn this
2448         char recipient[SIZ];
2449         char bounce_to[1024];
2450         const char *room;
2451         long newmsgid;
2452         const char *mptr = NULL;
2453         struct ctdluser userbuf;
2454         int a, i;
2455         struct MetaData smi;
2456         char *collected_addresses = NULL;
2457         struct addresses_to_be_filed *aptr = NULL;
2458         StrBuf *saved_rfc822_version = NULL;
2459         int qualified_for_journaling = 0;
2460
2461         syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2462         if (CM_IsValidMsg(msg) == 0) return(-1);        // self check
2463
2464         // If this message has no timestamp, we take the liberty of giving it one, right now.
2465         if (CM_IsEmpty(msg, eTimestamp)) {
2466                 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2467         }
2468
2469         // If this message has no path, we generate one.
2470         if (CM_IsEmpty(msg, eMessagePath)) {
2471                 if (!CM_IsEmpty(msg, eAuthor)) {
2472                         CM_CopyField(msg, eMessagePath, eAuthor);
2473                         for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2474                                 if (isspace(msg->cm_fields[eMessagePath][a])) {
2475                                         msg->cm_fields[eMessagePath][a] = ' ';
2476                                 }
2477                         }
2478                 }
2479                 else {
2480                         CM_SetField(msg, eMessagePath, "unknown");
2481                 }
2482         }
2483
2484         if (force == NULL) {
2485                 force_room[0] = '\0';
2486         }
2487         else {
2488                 strcpy(force_room, force);
2489         }
2490
2491         // Learn about what's inside, because it's what's inside that counts
2492         if (CM_IsEmpty(msg, eMessageText)) {
2493                 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2494                 return(-2);
2495         }
2496
2497         switch (msg->cm_format_type) {
2498         case 0:
2499                 strcpy(content_type, "text/x-citadel-variformat");
2500                 break;
2501         case 1:
2502                 strcpy(content_type, "text/plain");
2503                 break;
2504         case 4:
2505                 strcpy(content_type, "text/plain");
2506                 mptr = bmstrcasestr(msg->cm_fields[eMessageText], "Content-type:");
2507                 if (mptr != NULL) {
2508                         char *aptr;
2509                         safestrncpy(content_type, &mptr[13], sizeof content_type);
2510                         string_trim(content_type);
2511                         aptr = content_type;
2512                         while (!IsEmptyStr(aptr)) {
2513                                 if (    (*aptr == ';')
2514                                         || (*aptr == ' ')
2515                                         || (*aptr == 13)
2516                                         || (*aptr == 10)
2517                                 ) {
2518                                         *aptr = 0;
2519                                 }
2520                                 else {
2521                                         aptr++;
2522                                 }
2523                         }
2524                 }
2525         }
2526
2527         // Goto the correct room
2528         room = (recps) ? CC->room.QRname : SENTITEMS;
2529         syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2530         strcpy(hold_rm, CC->room.QRname);
2531         strcpy(actual_rm, CC->room.QRname);
2532         if (recps != NULL) {
2533                 strcpy(actual_rm, SENTITEMS);
2534         }
2535
2536         // If the user is a twit, move to the twit room for posting
2537         if (TWITDETECT) {
2538                 if (CC->user.axlevel == AxProbU) {
2539                         strcpy(hold_rm, actual_rm);
2540                         strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2541                         syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2542                 }
2543         }
2544
2545         // ...or if this message is destined for Aide> then go there.
2546         if (!IsEmptyStr(force_room)) {
2547                 strcpy(actual_rm, force_room);
2548         }
2549
2550         syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2551         if (strcasecmp(actual_rm, CC->room.QRname)) {
2552                 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2553         }
2554
2555         // If this message has no O (room) field, generate one.
2556         if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2557                 CM_SetField(msg, eOriginalRoom, CC->room.QRname);
2558         }
2559
2560         // Perform "before save" hooks (aborting if any return nonzero)
2561         syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2562         if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2563
2564         // If this message has an Exclusive ID, and the room is replication
2565         // checking enabled, then do replication checks.
2566         if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2567                 ReplicationChecks(msg);
2568         }
2569
2570         // Save it to disk
2571         syslog(LOG_DEBUG, "msgbase: saving to disk");
2572         newmsgid = send_message(msg);
2573         if (newmsgid <= 0L) return(-5);
2574
2575         // Write a supplemental message info record.  This doesn't have to be
2576         // a critical section because nobody else knows about this message yet.
2577         syslog(LOG_DEBUG, "msgbase: creating metadata record");
2578         memset(&smi, 0, sizeof(struct MetaData));
2579         smi.meta_msgnum = newmsgid;
2580         smi.meta_refcount = 0;
2581         safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type);
2582
2583         // Measure how big this message will be when rendered as RFC822.
2584         // We do this for two reasons:
2585         // 1. We need the RFC822 length for the new metadata record, so the
2586         //    POP and IMAP services don't have to calculate message lengths
2587         //    while the user is waiting (multiplied by potentially hundreds
2588         //    or thousands of messages).
2589         // 2. If journaling is enabled, we will need an RFC822 version of the
2590         //    message to attach to the journalized copy.
2591         if (CC->redirect_buffer != NULL) {
2592                 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2593                 exit(CTDLEXIT_REDIRECT);
2594         }
2595         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2596         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2597         smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2598         saved_rfc822_version = CC->redirect_buffer;
2599         CC->redirect_buffer = NULL;
2600
2601         PutMetaData(&smi);
2602
2603         // Now figure out where to store the pointers
2604         syslog(LOG_DEBUG, "msgbase: storing pointers");
2605
2606         // If this is being done by the networker delivering a private
2607         // message, we want to BYPASS saving the sender's copy (because there
2608         // is no local sender; it would otherwise go to the Trashcan).
2609         if ((!CC->internal_pgm) || (recps == NULL)) {
2610                 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2611                         syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm);
2612                         CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2613                 }
2614         }
2615
2616         // For internet mail, drop a copy in the outbound queue room
2617         if ((recps != NULL) && (recps->num_internet > 0)) {
2618                 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2619         }
2620
2621         // If other rooms are specified, drop them there too.
2622         if ((recps != NULL) && (recps->num_room > 0)) {
2623                 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2624                         extract_token(recipient, recps->recp_room, i, '|', sizeof recipient);
2625                         syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2626                         CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2627                 }
2628         }
2629
2630         // Decide where bounces need to be delivered
2631         if ((recps != NULL) && (recps->bounce_to == NULL)) {
2632                 if (CC->logged_in) {
2633                         strcpy(bounce_to, CC->user.fullname);
2634                 }
2635                 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2636                         strcpy(bounce_to, msg->cm_fields[eAuthor]);
2637                 }
2638                 recps->bounce_to = bounce_to;
2639         }
2640                 
2641         CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2642
2643         // If this is private, local mail, make a copy in the recipient's mailbox and bump the reference count.
2644         if ((recps != NULL) && (recps->num_local > 0)) {
2645                 char *pch;
2646                 int ntokens;
2647
2648                 pch = recps->recp_local;
2649                 recps->recp_local = recipient;
2650                 ntokens = num_tokens(pch, '|');
2651                 for (i=0; i<ntokens; ++i) {
2652                         extract_token(recipient, pch, i, '|', sizeof recipient);
2653                         syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2654                         if (CtdlGetUser(&userbuf, recipient) == 0) {
2655                                 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2656                                 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2657                                 CtdlBumpNewMailCounter(userbuf.usernum);        // if this user is logged in, tell them they have new mail.
2658                                 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2659                         }
2660                         else {
2661                                 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2662                                 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2663                         }
2664                 }
2665                 recps->recp_local = pch;
2666         }
2667
2668         // Perform "after save" hooks
2669         syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2670
2671         PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2672         CM_FlushField(msg, eVltMsgNum);
2673
2674         // Go back to the room we started from
2675         syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2676         if (strcasecmp(hold_rm, CC->room.QRname)) {
2677                 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2678         }
2679
2680         // Any addresses to harvest for someone's address book?
2681         if ( (CC->logged_in) && (recps != NULL) ) {
2682                 collected_addresses = harvest_collected_addresses(msg);
2683         }
2684
2685         if (collected_addresses != NULL) {
2686                 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2687                 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2688                 aptr->roomname = strdup(actual_rm);
2689                 aptr->collected_addresses = collected_addresses;
2690                 begin_critical_section(S_ATBF);
2691                 aptr->next = atbf;
2692                 atbf = aptr;
2693                 end_critical_section(S_ATBF);
2694         }
2695
2696         // Determine whether this message qualifies for journaling.
2697         if (!CM_IsEmpty(msg, eJournal)) {
2698                 qualified_for_journaling = 0;
2699         }
2700         else {
2701                 if (recps == NULL) {
2702                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2703                 }
2704                 else if (recps->num_local + recps->num_internet > 0) {
2705                         qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2706                 }
2707                 else {
2708                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2709                 }
2710         }
2711
2712         // Do we have to perform journaling?  If so, hand off the saved
2713         // RFC822 version will be handed off to the journaler for background
2714         // submit.  Otherwise, we have to free the memory ourselves.
2715         if (saved_rfc822_version != NULL) {
2716                 if (qualified_for_journaling) {
2717                         JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2718                 }
2719                 else {
2720                         FreeStrBuf(&saved_rfc822_version);
2721                 }
2722         }
2723
2724         if ((recps != NULL) && (recps->bounce_to == bounce_to))
2725                 recps->bounce_to = NULL;
2726
2727         // Done.
2728         return(newmsgid);
2729 }
2730
2731
2732 // Convenience function for generating small administrative messages.
2733 long quickie_message(char *from,
2734                      char *fromaddr,
2735                      char *to,
2736                      char *room,
2737                      char *text, 
2738                      int format_type,
2739                      char *subject)
2740 {
2741         struct CtdlMessage *msg;
2742         struct recptypes *recp = NULL;
2743
2744         msg = malloc(sizeof(struct CtdlMessage));
2745         memset(msg, 0, sizeof(struct CtdlMessage));
2746         msg->cm_magic = CTDLMESSAGE_MAGIC;
2747         msg->cm_anon_type = MES_NORMAL;
2748         msg->cm_format_type = format_type;
2749
2750         if (!IsEmptyStr(from)) {
2751                 CM_SetField(msg, eAuthor, from);
2752         }
2753         else if (!IsEmptyStr(fromaddr)) {
2754                 char *pAt;
2755                 CM_SetField(msg, eAuthor, fromaddr);
2756                 pAt = strchr(msg->cm_fields[eAuthor], '@');
2757                 if (pAt != NULL) {
2758                         CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
2759                 }
2760         }
2761         else {
2762                 msg->cm_fields[eAuthor] = strdup("Citadel");
2763         }
2764
2765         if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr);
2766         if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room);
2767         if (!IsEmptyStr(to)) {
2768                 CM_SetField(msg, eRecipient, to);
2769                 recp = validate_recipients(to, 0);
2770         }
2771         if (!IsEmptyStr(subject)) {
2772                 CM_SetField(msg, eMsgSubject, subject);
2773         }
2774         if (!IsEmptyStr(text)) {
2775                 CM_SetField(msg, eMessageText, text);
2776         }
2777
2778         long msgnum = CtdlSubmitMsg(msg, recp, room);
2779         CM_Free(msg);
2780         if (recp != NULL) free_recipients(recp);
2781         return msgnum;
2782 }
2783
2784
2785 // Back end function used by CtdlMakeMessage() and similar functions
2786 StrBuf *CtdlReadMessageBodyBuf(char *terminator,        // token signalling EOT
2787                                long tlen,
2788                                size_t maxlen,           // maximum message length
2789                                StrBuf *exist,           // if non-null, append to it; exist is ALWAYS freed
2790                                int crlf                 // CRLF newlines instead of LF
2791 ) {
2792         StrBuf *Message;
2793         StrBuf *LineBuf;
2794         int flushing = 0;
2795         int finished = 0;
2796         int dotdot = 0;
2797
2798         LineBuf = NewStrBufPlain(NULL, SIZ);
2799         if (exist == NULL) {
2800                 Message = NewStrBufPlain(NULL, 4 * SIZ);
2801         }
2802         else {
2803                 Message = NewStrBufDup(exist);
2804         }
2805
2806         // Do we need to change leading ".." to "." for SMTP escaping?
2807         if ((tlen == 1) && (*terminator == '.')) {
2808                 dotdot = 1;
2809         }
2810
2811         // read in the lines of message text one by one
2812         do {
2813                 if (CtdlClientGetLine(LineBuf) < 0) {
2814                         finished = 1;
2815                 }
2816                 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
2817                         finished = 1;
2818                 }
2819                 if ( (!flushing) && (!finished) ) {
2820                         if (crlf) {
2821                                 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
2822                         }
2823                         else {
2824                                 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
2825                         }
2826                         
2827                         // Unescape SMTP-style input of two dots at the beginning of the line
2828                         if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
2829                                 StrBufCutLeft(LineBuf, 1);
2830                         }
2831                         StrBufAppendBuf(Message, LineBuf, 0);
2832                 }
2833
2834                 // if we've hit the max msg length, flush the rest
2835                 if (StrLength(Message) >= maxlen) {
2836                         flushing = 1;
2837                 }
2838
2839         } while (!finished);
2840         FreeStrBuf(&LineBuf);
2841
2842         if (flushing) {
2843                 syslog(LOG_ERR, "msgbase: exceeded maximum message length of %ld - message was truncated", maxlen);
2844         }
2845
2846         return Message;
2847 }
2848
2849
2850 // Back end function used by CtdlMakeMessage() and similar functions
2851 char *CtdlReadMessageBody(char *terminator,     // token signalling EOT
2852                           long tlen,
2853                           size_t maxlen,        // maximum message length
2854                           StrBuf *exist,        // if non-null, append to it; exist is ALWAYS freed
2855                           int crlf              // CRLF newlines instead of LF
2856 ) {
2857         StrBuf *Message;
2858
2859         Message = CtdlReadMessageBodyBuf(terminator,
2860                                          tlen,
2861                                          maxlen,
2862                                          exist,
2863                                          crlf
2864         );
2865         if (Message == NULL) {
2866                 return NULL;
2867         }
2868         else {
2869                 return SmashStrBuf(&Message);
2870         }
2871 }
2872
2873
2874 struct CtdlMessage *CtdlMakeMessage(
2875         struct ctdluser *author,        // author's user structure
2876         char *recipient,                // NULL if it's not mail
2877         char *recp_cc,                  // NULL if it's not mail
2878         char *room,                     // room where it's going
2879         int type,                       // see MES_ types in header file
2880         int format_type,                // variformat, plain text, MIME...
2881         char *fake_name,                // who we're masquerading as
2882         char *my_email,                 // which of my email addresses to use (empty is ok)
2883         char *subject,                  // Subject (optional)
2884         char *euid_in,          // ...or NULL if this is irrelevant
2885         char *preformatted_text,        // ...or NULL to read text from client
2886         char *references                // Thread references
2887 ) {
2888         return CtdlMakeMessageLen(
2889                 author,                                 // author's user structure 
2890                 recipient,                              // NULL if it's not mail
2891                 (recipient)?strlen(recipient) : 0,
2892                 recp_cc,                                // NULL if it's not mail
2893                 (recp_cc)?strlen(recp_cc): 0,
2894                 room,                                   // room where it's going
2895                 (room)?strlen(room): 0,
2896                 type,                                   // see MES_ types in header file
2897                 format_type,                            // variformat, plain text, MIME...
2898                 fake_name,                              // who we're masquerading as
2899                 (fake_name)?strlen(fake_name): 0,
2900                 my_email,                               // which of my email addresses to use (empty is ok)
2901                 (my_email)?strlen(my_email): 0,
2902                 subject,                                // Subject (optional)
2903                 (subject)?strlen(subject): 0,
2904                 euid_in,                                // ...or NULL if this is irrelevant
2905                 (euid_in)?strlen(euid_in):0,
2906                 preformatted_text,                      // ...or NULL to read text from client
2907                 (preformatted_text)?strlen(preformatted_text) : 0,
2908                 references,                             // Thread references
2909                 (references)?strlen(references):0);
2910
2911 }
2912
2913
2914 // Build a binary message to be saved on disk.
2915 // (NOTE: if you supply 'preformatted_text', the buffer you give it
2916 // will become part of the message.  This means you are no longer
2917 // responsible for managing that memory -- it will be freed along with
2918 // the rest of the fields when CM_Free() is called.)
2919 struct CtdlMessage *CtdlMakeMessageLen(
2920         struct ctdluser *author,        // author's user structure
2921         char *recipient,                // NULL if it's not mail
2922         long rcplen,
2923         char *recp_cc,                  // NULL if it's not mail
2924         long cclen,
2925         char *room,                     // room where it's going
2926         long roomlen,
2927         int type,                       // see MES_ types in header file
2928         int format_type,                // variformat, plain text, MIME...
2929         char *fake_name,                // who we're masquerading as
2930         long fnlen,
2931         char *my_email,                 // which of my email addresses to use (empty is ok)
2932         long myelen,
2933         char *subject,                  // Subject (optional)
2934         long subjlen,
2935         char *euid_in,          // ...or NULL if this is irrelevant
2936         long euidlen,
2937         char *preformatted_text,        // ...or NULL to read text from client
2938         long textlen,
2939         char *references,               // Thread references
2940         long reflen
2941 ) {
2942         long blen;
2943         char buf[1024];
2944         struct CtdlMessage *msg;
2945         StrBuf *FakeAuthor;
2946         StrBuf *FakeEncAuthor = NULL;
2947
2948         msg = malloc(sizeof(struct CtdlMessage));
2949         memset(msg, 0, sizeof(struct CtdlMessage));
2950         msg->cm_magic = CTDLMESSAGE_MAGIC;
2951         msg->cm_anon_type = type;
2952         msg->cm_format_type = format_type;
2953
2954         if (recipient != NULL) rcplen = string_trim(recipient);
2955         if (recp_cc != NULL) cclen = string_trim(recp_cc);
2956
2957         // Path or Return-Path
2958         if (myelen > 0) {
2959                 CM_SetField(msg, eMessagePath, my_email);
2960         }
2961         else if (!IsEmptyStr(author->fullname)) {
2962                 CM_SetField(msg, eMessagePath, author->fullname);
2963         }
2964         convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
2965
2966         blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
2967         CM_SetField(msg, eTimestamp, buf);
2968
2969         if (fnlen > 0) {
2970                 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
2971         }
2972         else {
2973                 FakeAuthor = NewStrBufPlain (author->fullname, -1);
2974         }
2975         StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
2976         CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
2977         FreeStrBuf(&FakeAuthor);
2978
2979         if (!!IsEmptyStr(CC->room.QRname)) {
2980                 if (CC->room.QRflags & QR_MAILBOX) {            // room
2981                         CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11]);
2982                 }
2983                 else {
2984                         CM_SetField(msg, eOriginalRoom, CC->room.QRname);
2985                 }
2986         }
2987
2988         if (rcplen > 0) {
2989                 CM_SetField(msg, eRecipient, recipient);
2990         }
2991         if (cclen > 0) {
2992                 CM_SetField(msg, eCarbonCopY, recp_cc);
2993         }
2994
2995         if (myelen > 0) {
2996                 CM_SetField(msg, erFc822Addr, my_email);
2997         }
2998         else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
2999                 CM_SetField(msg, erFc822Addr, CC->cs_inet_email);
3000         }
3001
3002         if (subject != NULL) {
3003                 long length;
3004                 length = string_trim(subject);
3005                 if (length > 0) {
3006                         long i;
3007                         long IsAscii;
3008                         IsAscii = -1;
3009                         i = 0;
3010                         while ((subject[i] != '\0') && (IsAscii = isascii(subject[i]) != 0 )) {
3011                                 i++;
3012                         }
3013                         if (IsAscii != 0) {
3014                                 CM_SetField(msg, eMsgSubject, subject);
3015                         }
3016                         else {  // ok, we've got utf8 in the string.
3017                                 char *rfc2047Subj;
3018                                 rfc2047Subj = rfc2047encode(subject, length);
3019                                 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3020                         }
3021
3022                 }
3023         }
3024
3025         if (euidlen > 0) {
3026                 CM_SetField(msg, eExclusiveID, euid_in);
3027         }
3028
3029         if (reflen > 0) {
3030                 CM_SetField(msg, eWeferences, references);
3031         }
3032
3033         if (preformatted_text != NULL) {
3034                 CM_SetField(msg, eMessageText, preformatted_text);
3035         }
3036         else {
3037                 StrBuf *MsgBody;
3038                 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3039                 if (MsgBody != NULL) {
3040                         CM_SetAsFieldSB(msg, eMessageText, &MsgBody);
3041                 }
3042         }
3043
3044         return(msg);
3045 }
3046
3047
3048 // API function to delete messages which match a set of criteria
3049 // (returns the actual number of messages deleted)
3050 int CtdlDeleteMessages(const char *room_name,   // which room
3051                        long *dmsgnums,          // array of msg numbers to be deleted
3052                        int num_dmsgnums,        // number of msgs to be deleted, or 0 for "any"
3053                        char *content_type       // or "" for any.  regular expressions expected.
3054 ) {
3055         struct ctdlroom qrbuf;
3056         struct cdbdata *cdbfr;
3057         long *msglist = NULL;
3058         long *dellist = NULL;
3059         int num_msgs = 0;
3060         int i, j;
3061         int num_deleted = 0;
3062         int delete_this;
3063         struct MetaData smi;
3064         regex_t re;
3065         regmatch_t pm;
3066         int need_to_free_re = 0;
3067
3068         if (content_type) if (!IsEmptyStr(content_type)) {
3069                 regcomp(&re, content_type, 0);
3070                 need_to_free_re = 1;
3071         }
3072         syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3073
3074         // get room record, obtaining a lock...
3075         if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3076                 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3077                 if (need_to_free_re) regfree(&re);
3078                 return(0);      // room not found
3079         }
3080
3081         num_msgs = CtdlFetchMsgList(qrbuf.QRnumber, &msglist);
3082         if (num_msgs > 0) {
3083                 dellist = malloc(num_msgs * sizeof(long));
3084                 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3085                 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3086                 int have_more_del = 1;
3087
3088                 num_msgs = sort_msglist(msglist, num_msgs);
3089                 if (num_dmsgnums > 1) {
3090                         num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3091                 }
3092                 i = 0;
3093                 j = 0;
3094                 while ((i < num_msgs) && (have_more_del)) {
3095                         delete_this = 0x00;
3096
3097                         // Set/clear a bit for each criterion
3098
3099                         // 0 messages in the list or a null list means that we are
3100                         // interested in deleting any messages which meet the other criteria.
3101                         if (have_delmsgs) {
3102                                 delete_this |= 0x01;
3103                         }
3104                         else {
3105                                 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3106
3107                                 if (i >= num_msgs)
3108                                         continue;
3109
3110                                 if (msglist[i] == dmsgnums[j]) {
3111                                         delete_this |= 0x01;
3112                                 }
3113                                 j++;
3114                                 have_more_del = (j < num_dmsgnums);
3115                         }
3116
3117                         if (have_contenttype) {
3118                                 GetMetaData(&smi, msglist[i]);
3119                                 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3120                                         delete_this |= 0x02;
3121                                 }
3122                         }
3123                         else {
3124                                 delete_this |= 0x02;
3125                         }
3126
3127                         // Delete message only if all bits are set
3128                         if (delete_this == 0x03) {
3129                                 dellist[num_deleted++] = msglist[i];
3130                                 msglist[i] = 0L;
3131                         }
3132                         i++;
3133                 }
3134
3135                 num_msgs = sort_msglist(msglist, num_msgs);
3136                 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
3137
3138                 if (num_msgs > 0) {
3139                         qrbuf.QRhighest = msglist[num_msgs - 1];
3140                 }
3141                 else {
3142                         qrbuf.QRhighest = 0;
3143                 }
3144         }
3145         CtdlPutRoomLock(&qrbuf);
3146
3147         // Go through the messages we pulled out of the index, and decrement
3148         // their reference counts by 1.  If this is the only room the message
3149         // was in, the reference count will reach zero and the message will
3150         // automatically be deleted from the database.  We do this in a
3151         // separate pass because there might be plug-in hooks getting called,
3152         // and we don't want that happening during an S_ROOMS critical section.
3153         if (num_deleted) {
3154                 for (i=0; i<num_deleted; ++i) {
3155                         PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3156                 }
3157                 AdjRefCountList(dellist, num_deleted, -1);
3158         }
3159         // Now free the memory we used, and go away.
3160         if (msglist != NULL) free(msglist);
3161         if (dellist != NULL) free(dellist);
3162         syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3163         if (need_to_free_re) regfree(&re);
3164         return (num_deleted);
3165 }
3166
3167
3168 // GetMetaData()  -  Get the supplementary record for a message
3169 void GetMetaData(struct MetaData *smibuf, long msgnum) {
3170         struct cdbdata cdbsmi;
3171         long TheIndex;
3172
3173         memset(smibuf, 0, sizeof(struct MetaData));
3174         smibuf->meta_msgnum = msgnum;
3175         smibuf->meta_refcount = 1;      // Default reference count is 1
3176
3177         // Use the negative of the message number for its supp record index
3178         TheIndex = (0L - msgnum);
3179
3180         cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3181         if (cdbsmi.ptr == NULL) {
3182                 return;                 // record not found; leave it alone
3183         }
3184         memcpy(smibuf, cdbsmi.ptr, ((cdbsmi.len > sizeof(struct MetaData)) ? sizeof(struct MetaData) : cdbsmi.len));
3185         return;
3186 }
3187
3188
3189 // PutMetaData()  -  (re)write supplementary record for a message
3190 void PutMetaData(struct MetaData *smibuf) {
3191         long TheIndex;
3192
3193         // Use the negative of the message number for the metadata db index
3194         TheIndex = (0L - smibuf->meta_msgnum);
3195         cdb_store(CDB_MSGMAIN, &TheIndex, (int)sizeof(long), smibuf, (int)sizeof(struct MetaData));
3196 }
3197
3198
3199 // Convenience function to process a big block of AdjRefCount() operations
3200 void AdjRefCountList(long *msgnum, long nmsg, int incr) {
3201         long i;
3202
3203         for (i = 0; i < nmsg; i++) {
3204                 AdjRefCount(msgnum[i], incr);
3205         }
3206 }
3207
3208
3209 // AdjRefCount - adjust the reference count for a message.
3210 // We need to delete from disk any message whose reference count reaches zero.
3211 void AdjRefCount(long msgnum, int incr) {
3212         struct MetaData smi;
3213         long delnum;
3214
3215         // This is a *tight* critical section; please keep it that way, as
3216         // it may get called while nested in other critical sections.  
3217         // Complicating this any further will surely cause deadlock!
3218         begin_critical_section(S_SUPPMSGMAIN);
3219         GetMetaData(&smi, msgnum);
3220         smi.meta_refcount += incr;
3221         PutMetaData(&smi);
3222         end_critical_section(S_SUPPMSGMAIN);
3223         syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3224
3225         // If the reference count is now zero, delete both the message and its metadata record.
3226         if (smi.meta_refcount == 0) {
3227                 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3228                 
3229                 // Call delete hooks with NULL room to show it has gone altogether
3230                 PerformDeleteHooks(NULL, msgnum);
3231
3232                 // Remove from message base
3233                 delnum = msgnum;
3234                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3235                 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));    // There might not be a bigmsgs.  Not an error.
3236
3237                 // Remove metadata record
3238                 delnum = (0L - msgnum);
3239                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3240         }
3241 }
3242
3243
3244 // Write a generic object to this room
3245 // Returns the message number of the written object, in case you need it.
3246 long CtdlWriteObject(char *req_room,                    // Room to stuff it in
3247                      char *content_type,                // MIME type of this object
3248                      char *raw_message,                 // Data to be written
3249                      off_t raw_length,                  // Size of raw_message
3250                      struct ctdluser *is_mailbox,       // Mailbox room?
3251                      int is_binary,                     // Is encoding necessary?
3252                      unsigned int flags                 // Internal save flags
3253 ) {
3254         struct ctdlroom qrbuf;
3255         char roomname[ROOMNAMELEN];
3256         struct CtdlMessage *msg;
3257         StrBuf *encoded_message = NULL;
3258
3259         if (is_mailbox != NULL) {
3260                 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3261         }
3262         else {
3263                 safestrncpy(roomname, req_room, sizeof(roomname));
3264         }
3265
3266         syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3267
3268         if (is_binary) {
3269                 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3270         }
3271         else {
3272                 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3273         }
3274
3275         StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3276         StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3277         StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3278
3279         if (is_binary) {
3280                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3281         }
3282         else {
3283                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3284         }
3285
3286         if (is_binary) {
3287                 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3288         }
3289         else {
3290                 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3291         }
3292
3293         syslog(LOG_DEBUG, "msgbase: allocating");
3294         msg = malloc(sizeof(struct CtdlMessage));
3295         memset(msg, 0, sizeof(struct CtdlMessage));
3296         msg->cm_magic = CTDLMESSAGE_MAGIC;
3297         msg->cm_anon_type = MES_NORMAL;
3298         msg->cm_format_type = 4;
3299         CM_SetField(msg, eAuthor, CC->user.fullname);
3300         CM_SetField(msg, eOriginalRoom, req_room);
3301         msg->cm_flags = flags;
3302         
3303         CM_SetAsFieldSB(msg, eMessageText, &encoded_message);
3304
3305         // Create the requested room if we have to.
3306         if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3307                 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3308         }
3309
3310         // Now write the data
3311         long new_msgnum = CtdlSubmitMsg(msg, NULL, roomname);
3312         CM_Free(msg);
3313         return new_msgnum;
3314 }
3315
3316
3317 // ************************************************************************/
3318 // *                      MODULE INITIALIZATION                           */
3319 // ************************************************************************/
3320
3321 char *ctdl_module_init_msgbase(void) {
3322         if (!threading) {
3323                 FillMsgKeyLookupTable();
3324         }
3325
3326         // return our module id for the log
3327         return "msgbase";
3328 }