moved whitespace around
[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                         long len;
1492                         CM_GetAsField(TheMessage, eAuthor, Author, &len);
1493                 }
1494                 if ((Address != NULL) && (*Address == NULL)) {  
1495                         long len;
1496                         CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1497                 }
1498                 if ((MessageID != NULL) && (*MessageID == NULL)) {      
1499                         long len;
1500                         CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1501                 }
1502                 CM_Free(TheMessage);
1503                 TheMessage = NULL;
1504
1505                 if (encap.msg) {
1506                         encap.msg[encap.msglen] = 0;
1507                         TheMessage = convert_internet_message(encap.msg);
1508                         encap.msg = NULL;       // no free() here, TheMessage owns it now
1509
1510                         // Now we let it fall through to the bottom of this function, because TheMessage now contains the
1511                         // encapsulated message instead of the top-level message.  Isn't that neat?
1512                 }
1513                 else {
1514                         if (do_proto) {
1515                                 cprintf("%d msg %ld has no part %s\n", ERROR + MESSAGE_NOT_FOUND, msg_num, section);
1516                         }
1517                         retcode = om_no_such_msg;
1518                 }
1519
1520         }
1521
1522         // Ok, output the message now
1523         if (retcode == CIT_OK) {
1524                 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1525         }
1526         if ((Author != NULL) && (*Author == NULL)) {
1527                 long len;
1528                 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1529         }
1530         if ((Address != NULL) && (*Address == NULL)) {  
1531                 long len;
1532                 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1533         }
1534         if ((MessageID != NULL) && (*MessageID == NULL)) {      
1535                 long len;
1536                 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1537         }
1538
1539         CM_Free(TheMessage);
1540
1541         return(retcode);
1542 }
1543
1544
1545 void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) {
1546         int i;
1547         char buf[SIZ];
1548         char display_name[256];
1549
1550         // begin header processing loop for Citadel message format
1551         safestrncpy(display_name, "<unknown>", sizeof display_name);
1552         if (!CM_IsEmpty(TheMessage, eAuthor)) {
1553                 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1554                 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1555                         safestrncpy(display_name, "****", sizeof display_name);
1556                 }
1557                 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1558                         safestrncpy(display_name, "anonymous", sizeof display_name);
1559                 }
1560                 else {
1561                         safestrncpy(display_name, buf, sizeof display_name);
1562                 }
1563                 if (    (is_room_aide())
1564                         && (    (TheMessage->cm_anon_type == MES_ANONONLY)
1565                                 || (TheMessage->cm_anon_type == MES_ANONOPT)
1566                         )
1567                 ) {
1568                         size_t tmp = strlen(display_name);
1569                         snprintf(&display_name[tmp], sizeof display_name - tmp, " [%s]", buf);
1570                 }
1571         }
1572
1573         // Now spew the header fields in the order we like them.
1574         for (i=0; i< NDiskFields; ++i) {
1575                 eMsgField Field;
1576                 Field = FieldOrder[i];
1577                 if (Field != eMessageText) {
1578                         if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) {
1579                                 if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) {
1580                                         sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1581                                 }
1582                                 if (Field == eAuthor) {
1583                                         if (do_proto) {
1584                                                 cprintf("%s=%s\n", msgkeys[Field], display_name);
1585                                         }
1586                                 }
1587                                 // Masquerade display name if needed
1588                                 else {
1589                                         if (do_proto) {
1590                                                 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1591                                         }
1592                                 }
1593                                 // Give the client a hint about whether the message originated locally
1594                                 if (Field == erFc822Addr) {
1595                                         if (IsDirectory(TheMessage->cm_fields[Field] ,0)) {
1596                                                 cprintf("locl=yes\n");                          // message originated locally.
1597                                         }
1598
1599
1600
1601                                 }
1602                         }
1603                 }
1604         }
1605 }
1606
1607
1608 void OutputRFC822MsgHeaders(
1609         struct CtdlMessage *TheMessage,
1610         int flags,              // should the message be exported clean
1611         const char *nl, int nlen,
1612         char *mid, long sizeof_mid,
1613         char *suser, long sizeof_suser,
1614         char *luser, long sizeof_luser,
1615         char *fuser, long sizeof_fuser,
1616         char *snode, long sizeof_snode)
1617 {
1618         char datestamp[100];
1619         int subject_found = 0;
1620         char buf[SIZ];
1621         int i, j, k;
1622         char *mptr = NULL;
1623         char *mpptr = NULL;
1624         char *hptr;
1625
1626         for (i = 0; i < NDiskFields; ++i) {
1627                 if (TheMessage->cm_fields[FieldOrder[i]]) {
1628                         mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1629                         switch (FieldOrder[i]) {
1630                         case eAuthor:
1631                                 safestrncpy(luser, mptr, sizeof_luser);
1632                                 safestrncpy(suser, mptr, sizeof_suser);
1633                                 break;
1634                         case eCarbonCopY:
1635                                 if ((flags & QP_EADDR) != 0) {
1636                                         mptr = qp_encode_email_addrs(mptr);
1637                                 }
1638                                 sanitize_truncated_recipient(mptr);
1639                                 cprintf("CC: %s%s", mptr, nl);
1640                                 break;
1641                         case eMessagePath:
1642                                 cprintf("Return-Path: %s%s", mptr, nl);
1643                                 break;
1644                         case eListID:
1645                                 cprintf("List-ID: %s%s", mptr, nl);
1646                                 break;
1647                         case eenVelopeTo:
1648                                 if ((flags & QP_EADDR) != 0) 
1649                                         mptr = qp_encode_email_addrs(mptr);
1650                                 hptr = mptr;
1651                                 while ((*hptr != '\0') && isspace(*hptr))
1652                                         hptr ++;
1653                                 if (!IsEmptyStr(hptr))
1654                                         cprintf("Envelope-To: %s%s", hptr, nl);
1655                                 break;
1656                         case eMsgSubject:
1657                                 cprintf("Subject: %s%s", mptr, nl);
1658                                 subject_found = 1;
1659                                 break;
1660                         case emessageId:
1661                                 safestrncpy(mid, mptr, sizeof_mid);
1662                                 break;
1663                         case erFc822Addr:
1664                                 safestrncpy(fuser, mptr, sizeof_fuser);
1665                                 break;
1666                         case eRecipient:
1667                                 if (haschar(mptr, '@') == 0) {
1668                                         sanitize_truncated_recipient(mptr);
1669                                         cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1670                                         cprintf("%s", nl);
1671                                 }
1672                                 else {
1673                                         if ((flags & QP_EADDR) != 0) {
1674                                                 mptr = qp_encode_email_addrs(mptr);
1675                                         }
1676                                         sanitize_truncated_recipient(mptr);
1677                                         cprintf("To: %s", mptr);
1678                                         cprintf("%s", nl);
1679                                 }
1680                                 break;
1681                         case eTimestamp:
1682                                 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1683                                 cprintf("Date: %s%s", datestamp, nl);
1684                                 break;
1685                         case eWeferences:
1686                                 cprintf("References: ");
1687                                 k = num_tokens(mptr, '|');
1688                                 for (j=0; j<k; ++j) {
1689                                         extract_token(buf, mptr, j, '|', sizeof buf);
1690                                         cprintf("<%s>", buf);
1691                                         if (j == (k-1)) {
1692                                                 cprintf("%s", nl);
1693                                         }
1694                                         else {
1695                                                 cprintf(" ");
1696                                         }
1697                                 }
1698                                 break;
1699                         case eReplyTo:
1700                                 hptr = mptr;
1701                                 while ((*hptr != '\0') && isspace(*hptr))
1702                                         hptr ++;
1703                                 if (!IsEmptyStr(hptr))
1704                                         cprintf("Reply-To: %s%s", mptr, nl);
1705                                 break;
1706
1707                         case eExclusiveID:
1708                         case eJournal:
1709                         case eMessageText:
1710                         case eBig_message:
1711                         case eOriginalRoom:
1712                         case eErrorMsg:
1713                         case eSuppressIdx:
1714                         case eExtnotify:
1715                         case eVltMsgNum:
1716                                 // these don't map to mime message headers.
1717                                 break;
1718                         }
1719                         if (mptr != mpptr) {
1720                                 free (mptr);
1721                         }
1722                 }
1723         }
1724         if (subject_found == 0) {
1725                 cprintf("Subject: (no subject)%s", nl);
1726         }
1727 }
1728
1729
1730 void Dump_RFC822HeadersBody(
1731         struct CtdlMessage *TheMessage,
1732         int headers_only,       // eschew the message body?
1733         int flags,              // should the bessage be exported clean?
1734         const char *nl, int nlen)
1735 {
1736         cit_uint8_t prev_ch;
1737         int eoh = 0;
1738         const char *StartOfText = StrBufNOTNULL;
1739         char outbuf[1024];
1740         int outlen = 0;
1741         int nllen = strlen(nl);
1742         char *mptr;
1743         int lfSent = 0;
1744
1745         mptr = TheMessage->cm_fields[eMessageText];
1746
1747         prev_ch = '\0';
1748         while (*mptr != '\0') {
1749                 if (*mptr == '\r') {
1750                         // do nothing
1751                 }
1752                 else {
1753                         if ((!eoh) && (*mptr == '\n')) {
1754                                 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1755                                 if (!eoh) {
1756                                         eoh = *(mptr+1) == '\n';
1757                                 }
1758                                 if (eoh) {
1759                                         StartOfText = mptr;
1760                                         StartOfText = strchr(StartOfText, '\n');
1761                                         StartOfText = strchr(StartOfText, '\n');
1762                                 }
1763                         }
1764                         if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1765                             ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1766                             ((headers_only != HEADERS_NONE) && 
1767                              (headers_only != HEADERS_ONLY))
1768                         ) {
1769                                 if (*mptr == '\n') {
1770                                         memcpy(&outbuf[outlen], nl, nllen);
1771                                         outlen += nllen;
1772                                         outbuf[outlen] = '\0';
1773                                 }
1774                                 else {
1775                                         outbuf[outlen++] = *mptr;
1776                                 }
1777                         }
1778                 }
1779                 if (flags & ESC_DOT) {
1780                         if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1781                                 outbuf[outlen++] = '.';
1782                         }
1783                         prev_ch = *mptr;
1784                 }
1785                 ++mptr;
1786                 if (outlen > 1000) {
1787                         if (client_write(outbuf, outlen) == -1) {
1788                                 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1789                                 return;
1790                         }
1791                         lfSent =  (outbuf[outlen - 1] == '\n');
1792                         outlen = 0;
1793                 }
1794         }
1795         if (outlen > 0) {
1796                 client_write(outbuf, outlen);
1797                 lfSent =  (outbuf[outlen - 1] == '\n');
1798         }
1799         if (!lfSent)
1800                 client_write(nl, nlen);
1801 }
1802
1803
1804 // If the format type on disk is 1 (fixed-format), then we want
1805 // everything to be output completely literally ... regardless of
1806 // what message transfer format is in use.
1807 void DumpFormatFixed(
1808         struct CtdlMessage *TheMessage,
1809         int mode,               // how would you like that message?
1810         const char *nl, int nllen)
1811 {
1812         cit_uint8_t ch;
1813         char buf[SIZ];
1814         int buflen;
1815         int xlline = 0;
1816         char *mptr;
1817
1818         mptr = TheMessage->cm_fields[eMessageText];
1819         
1820         if (mode == MT_MIME) {
1821                 cprintf("Content-type: text/plain\n\n");
1822         }
1823         *buf = '\0';
1824         buflen = 0;
1825         while (ch = *mptr++, ch > 0) {
1826                 if (ch == '\n')
1827                         ch = '\r';
1828
1829                 if ((buflen > 250) && (!xlline)){
1830                         int tbuflen;
1831                         tbuflen = buflen;
1832
1833                         while ((buflen > 0) && 
1834                                (!isspace(buf[buflen])))
1835                                 buflen --;
1836                         if (buflen == 0) {
1837                                 xlline = 1;
1838                         }
1839                         else {
1840                                 mptr -= tbuflen - buflen;
1841                                 buf[buflen] = '\0';
1842                                 ch = '\r';
1843                         }
1844                 }
1845
1846                 // if we reach the outer bounds of our buffer, abort without respect for what we purge.
1847                 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1848                         ch = '\r';
1849                 }
1850
1851                 if (ch == '\r') {
1852                         memcpy (&buf[buflen], nl, nllen);
1853                         buflen += nllen;
1854                         buf[buflen] = '\0';
1855
1856                         if (client_write(buf, buflen) == -1) {
1857                                 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
1858                                 return;
1859                         }
1860                         *buf = '\0';
1861                         buflen = 0;
1862                         xlline = 0;
1863                 } else {
1864                         buf[buflen] = ch;
1865                         buflen++;
1866                 }
1867         }
1868         buf[buflen] = '\0';
1869         if (!IsEmptyStr(buf)) {
1870                 cprintf("%s%s", buf, nl);
1871         }
1872 }
1873
1874
1875 // Get a message off disk.  (returns om_* values found in msgbase.h)
1876 int CtdlOutputPreLoadedMsg(
1877                 struct CtdlMessage *TheMessage,
1878                 int mode,               // how would you like that message?
1879                 int headers_only,       // eschew the message body?
1880                 int do_proto,           // do Citadel protocol responses?
1881                 int crlf,               // Use CRLF newlines instead of LF?
1882                 int flags               // should the bessage be exported clean?
1883 ) {
1884         int i;
1885         const char *nl; // newline string
1886         int nlen;
1887         struct ma_info ma;
1888
1889         // Buffers needed for RFC822 translation.  These are all filled
1890         // using functions that are bounds-checked, and therefore we can
1891         // make them substantially smaller than SIZ.
1892         char suser[1024];
1893         char luser[1024];
1894         char fuser[1024];
1895         char snode[1024];
1896         char mid[1024];
1897
1898         syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
1899                    ((TheMessage == NULL) ? "NULL" : "not null"),
1900                    mode, headers_only, do_proto, crlf
1901         );
1902
1903         strcpy(mid, "unknown");
1904         nl = (crlf ? "\r\n" : "\n");
1905         nlen = crlf ? 2 : 1;
1906
1907         if (!CM_IsValidMsg(TheMessage)) {
1908                 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
1909                 return(om_no_such_msg);
1910         }
1911
1912         // Suppress envelope recipients if required to avoid disclosing BCC addresses.
1913         // Pad it with spaces in order to avoid changing the RFC822 length of the message.
1914         if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
1915                 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
1916         }
1917                 
1918         // Are we downloading a MIME component?
1919         if (mode == MT_DOWNLOAD) {
1920                 if (TheMessage->cm_format_type != FMT_RFC822) {
1921                         if (do_proto) {
1922                                 cprintf("%d This is not a MIME message.\n", ERROR + ILLEGAL_VALUE);
1923                         }
1924                 }
1925                 else if (CC->download_fp != NULL) {
1926                         if (do_proto) {
1927                                 cprintf( "%d You already have a download open.\n", ERROR + RESOURCE_BUSY);
1928                         }
1929                 }
1930                 else {
1931                         // Parse the message text component
1932                         mime_parser(CM_RANGE(TheMessage, eMessageText), *mime_download, NULL, NULL, NULL, 0);
1933
1934                         // If there's no file open by this time, the requested * section wasn't found, so print an error
1935                         if (CC->download_fp == NULL) {
1936                                 if (do_proto) {
1937                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1938                                 }
1939                         }
1940                 }
1941                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1942         }
1943
1944         // MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
1945         // in a single server operation instead of opening a download file.
1946         if (mode == MT_SPEW_SECTION) {
1947                 if (TheMessage->cm_format_type != FMT_RFC822) {
1948                         if (do_proto)
1949                                 cprintf("%d This is not a MIME message.\n",
1950                                 ERROR + ILLEGAL_VALUE);
1951                 }
1952                 else {
1953                         // Locate and parse the component specified by the caller
1954                         int found_it = 0;
1955                         mime_parser(CM_RANGE(TheMessage, eMessageText), *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
1956
1957                         // If section wasn't found, print an error
1958                         if (!found_it) {
1959                                 if (do_proto) {
1960                                         cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
1961                                 }
1962                         }
1963                 }
1964                 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
1965         }
1966
1967         // now for the user-mode message reading loops
1968         if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
1969
1970         // Does the caller want to skip the headers?
1971         if (headers_only == HEADERS_NONE) goto START_TEXT;
1972
1973         // Tell the client which format type we're using.
1974         if ( (mode == MT_CITADEL) && (do_proto) ) {
1975                 cprintf("type=%d\n", TheMessage->cm_format_type);       // Tell the client which format type we're using.
1976         }
1977
1978         // nhdr=yes means that we're only displaying headers, no body
1979         if (    (TheMessage->cm_anon_type == MES_ANONONLY)
1980                 && ((mode == MT_CITADEL) || (mode == MT_MIME))
1981                 && (do_proto)
1982         ) {
1983                 cprintf("nhdr=yes\n");
1984         }
1985
1986         if ((mode == MT_CITADEL) || (mode == MT_MIME)) {
1987                 OutputCtdlMsgHeaders(TheMessage, do_proto);
1988         }
1989
1990         // begin header processing loop for RFC822 transfer format
1991         strcpy(suser, "");
1992         strcpy(luser, "");
1993         strcpy(fuser, "");
1994         strcpy(snode, "");
1995         if (mode == MT_RFC822) {
1996                 OutputRFC822MsgHeaders(
1997                         TheMessage,
1998                         flags,
1999                         nl, nlen,
2000                         mid, sizeof(mid),
2001                         suser, sizeof(suser),
2002                         luser, sizeof(luser),
2003                         fuser, sizeof(fuser),
2004                         snode, sizeof(snode)
2005                 );
2006         }
2007
2008         for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2009                 suser[i] = tolower(suser[i]);
2010                 if (!isalnum(suser[i])) suser[i]='_';
2011         }
2012
2013         if (mode == MT_RFC822) {
2014                 // Construct a fun message id
2015                 cprintf("Message-ID: <%s", mid);
2016                 if (strchr(mid, '@')==NULL) {
2017                         cprintf("@%s", snode);
2018                 }
2019                 cprintf(">%s", nl);
2020
2021                 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2022                         cprintf("From: \"----\" <x@x.org>%s", nl);
2023                 }
2024                 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2025                         cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2026                 }
2027                 else if (!IsEmptyStr(fuser)) {
2028                         cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2029                 }
2030                 else {
2031                         cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2032                 }
2033
2034                 // Blank line signifying RFC822 end-of-headers
2035                 if (TheMessage->cm_format_type != FMT_RFC822) {
2036                         cprintf("%s", nl);
2037                 }
2038         }
2039
2040         // end header processing loop ... at this point, we're in the text
2041 START_TEXT:
2042         if (headers_only == HEADERS_FAST) goto DONE;
2043
2044         // Tell the client about the MIME parts in this message
2045         if (TheMessage->cm_format_type == FMT_RFC822) {
2046                 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2047                         memset(&ma, 0, sizeof(struct ma_info));
2048                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2049                                 (do_proto ? *list_this_part : NULL),
2050                                 (do_proto ? *list_this_pref : NULL),
2051                                 (do_proto ? *list_this_suff : NULL),
2052                                 (void *)&ma, 1);
2053                 }
2054                 else if (mode == MT_RFC822) {   // unparsed RFC822 dump
2055                         Dump_RFC822HeadersBody(TheMessage, headers_only, flags, nl, nlen);
2056                         goto DONE;
2057                 }
2058         }
2059
2060         if (headers_only == HEADERS_ONLY) {
2061                 goto DONE;
2062         }
2063
2064         // signify start of msg text
2065         if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2066                 if (do_proto) cprintf("text\n");
2067         }
2068
2069         if (TheMessage->cm_format_type == FMT_FIXED) {
2070                 DumpFormatFixed( TheMessage, mode, nl, nlen);
2071         }
2072
2073         // If the message on disk is format 0 (Citadel vari-format), we
2074         // output using the formatter at 80 columns.  This is the final output
2075         // form if the transfer format is RFC822, but if the transfer format
2076         // is Citadel proprietary, it'll still work, because the indentation
2077         // for new paragraphs is correct and the client will reformat the
2078         // message to the reader's screen width.
2079         //
2080         if (TheMessage->cm_format_type == FMT_CITADEL) {
2081                 if (mode == MT_MIME) {
2082                         cprintf("Content-type: text/x-citadel-variformat\n\n");
2083                 }
2084                 memfmout(TheMessage->cm_fields[eMessageText], nl);
2085         }
2086
2087         // If the message on disk is format 4 (MIME), we've gotta hand it
2088         // off to the MIME parser.  The client has already been told that
2089         // this message is format 1 (fixed format), so the callback function
2090         // we use will display those parts as-is.
2091         //
2092         if (TheMessage->cm_format_type == FMT_RFC822) {
2093                 memset(&ma, 0, sizeof(struct ma_info));
2094
2095                 if (mode == MT_MIME) {
2096                         ma.use_fo_hooks = 0;
2097                         strcpy(ma.chosen_part, "1");
2098                         ma.chosen_pref = 9999;
2099                         ma.dont_decode = CC->msg4_dont_decode;
2100                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2101                                     *choose_preferred, *fixed_output_pre,
2102                                     *fixed_output_post, (void *)&ma, 1);
2103                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2104                                     *output_preferred, NULL, NULL, (void *)&ma, 1);
2105                 }
2106                 else {
2107                         ma.use_fo_hooks = 1;
2108                         mime_parser(CM_RANGE(TheMessage, eMessageText),
2109                                     *fixed_output, *fixed_output_pre,
2110                                     *fixed_output_post, (void *)&ma, 0);
2111                 }
2112
2113         }
2114
2115 DONE:   // now we're done
2116         if (do_proto) cprintf("000\n");
2117         return(om_ok);
2118 }
2119
2120
2121 // Save one or more message pointers into a specified room
2122 // (Returns 0 for success, nonzero for failure)
2123 // roomname may be NULL to use the current room
2124 //
2125 // Note that the 'msg_in' field may be set to NULL, in which case
2126 // the message will be fetched from disk, by number, if we need to perform
2127 // replication checks.  This adds an additional database read, so if the
2128 // caller already has the message in memory then it should be supplied.  (Obviously
2129 // this mode of operation only works if we're saving a single message.)
2130 //
2131 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2132                         int do_repl_check, struct CtdlMessage *msg_in, int suppress_refcount_adj
2133 ) {
2134         int i, j, unique;
2135         char hold_rm[ROOMNAMELEN];
2136         struct cdbdata *cdbfr;
2137         int num_msgs;
2138         long *msglist;
2139         long highest_msg = 0L;
2140
2141         long msgid = 0;
2142         struct CtdlMessage *msg = NULL;
2143
2144         long *msgs_to_be_merged = NULL;
2145         int num_msgs_to_be_merged = 0;
2146
2147         syslog(LOG_DEBUG,
2148                 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2149                 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2150         );
2151
2152         strcpy(hold_rm, CC->room.QRname);
2153
2154         // Sanity checks
2155         if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2156         if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2157         if (num_newmsgs > 1) msg_in = NULL;
2158
2159         // Now the regular stuff
2160         if (CtdlGetRoomLock(&CC->room, ((roomname != NULL) ? roomname : CC->room.QRname) ) != 0) {
2161                 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2162                 return(ERROR + ROOM_NOT_FOUND);
2163         }
2164
2165         msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2166         num_msgs_to_be_merged = 0;
2167         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
2168
2169         // Create a list of msgid's which were supplied by the caller, but do
2170         // not already exist in the target room.  It is absolutely taboo to
2171         // have more than one reference to the same message in a room.
2172         for (i=0; i<num_newmsgs; ++i) {
2173                 unique = 1;
2174                 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2175                         if (msglist[j] == newmsgidlist[i]) {
2176                                 unique = 0;
2177                         }
2178                 }
2179                 if (unique) {
2180                         msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2181                 }
2182         }
2183
2184         syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2185
2186         // Now merge the new messages
2187         msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2188         if (msglist == NULL) {
2189                 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2190                 free(msgs_to_be_merged);
2191                 abort();                                        // FIXME
2192                 return (ERROR + INTERNAL_ERROR);
2193         }
2194         memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2195         num_msgs += num_msgs_to_be_merged;
2196
2197         // Sort the message list, so all the msgid's are in order
2198         num_msgs = sort_msglist(msglist, num_msgs);
2199
2200         // Determine the highest message number
2201         highest_msg = msglist[num_msgs - 1];
2202
2203         // Write it back to disk.
2204         cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
2205
2206         // Free up the memory we used.
2207         free(msglist);
2208
2209         // Update the highest-message pointer and unlock the room.
2210         CC->room.QRhighest = highest_msg;
2211         CtdlPutRoomLock(&CC->room);
2212
2213         // Perform replication checks if necessary
2214         if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2215                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2216
2217                 for (i=0; i<num_msgs_to_be_merged; ++i) {
2218                         msgid = msgs_to_be_merged[i];
2219         
2220                         if (msg_in != NULL) {
2221                                 msg = msg_in;
2222                         }
2223                         else {
2224                                 msg = CtdlFetchMessage(msgid, 0);
2225                         }
2226         
2227                         if (msg != NULL) {
2228                                 ReplicationChecks(msg);
2229                 
2230                                 // If the message has an Exclusive ID, index that...
2231                                 if (!CM_IsEmpty(msg, eExclusiveID)) {
2232                                         index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2233                                 }
2234
2235                                 // Free up the memory we may have allocated
2236                                 if (msg != msg_in) {
2237                                         CM_Free(msg);
2238                                 }
2239                         }
2240         
2241                 }
2242         }
2243
2244         else {
2245                 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2246         }
2247
2248         // Submit this room for processing by hooks
2249         int total_roomhook_errors = PerformRoomHooks(&CC->room);
2250         if (total_roomhook_errors) {
2251                 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2252         }
2253
2254         // Go back to the room we were in before we wandered here...
2255         CtdlGetRoom(&CC->room, hold_rm);
2256
2257         // Bump the reference count for all messages which were merged
2258         if (!suppress_refcount_adj) {
2259                 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2260         }
2261
2262         // Free up memory...
2263         if (msgs_to_be_merged != NULL) {
2264                 free(msgs_to_be_merged);
2265         }
2266
2267         // Return success.
2268         return (0);
2269 }
2270
2271
2272 // This is the same as CtdlSaveMsgPointersInRoom() but it only accepts a single message.
2273 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, int do_repl_check, struct CtdlMessage *msg_in) {
2274         return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, msg_in, 0);
2275 }
2276
2277
2278 // Message base operation to save a new message to the message store
2279 // (returns new message number)
2280 //
2281 // This is the back end for CtdlSubmitMsg() and should not be directly
2282 // called by server-side modules.
2283 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid) {
2284         long error_count = 0;
2285
2286         // Serialize our data structure for storage in the database
2287         struct ser_ret smr = CtdlSerializeMessage(msg);
2288
2289         if (smr.len == 0) {
2290                 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2291                 return (-1);
2292         }
2293
2294         // STORAGE STRATEGY:
2295         // * If headers+content fit are <= 4K, store them together.  It's likely to be one
2296         //   memory page, one disk sector, etc. so we benefit from a single disk operation.
2297         // * If headers+content exceed 4K, store them separately so we don't end up fetching
2298         //   many gigamegs of data when we're just scanning the headers.
2299         // * We are using a threshold of 4000 bytes so that there's some room for overhead
2300         //   if the database or OS adds any metadata to that one disk page.
2301
2302         if (smr.len <= 4000) {                                  // all together less than one page, store them together
2303
2304                 if (cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len)) {
2305                         ++error_count;
2306                 }
2307
2308         }
2309
2310         else {                                                  // exceed one page, store headers in MSGMAIN, body in BIGMSGS
2311
2312                 if (cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, (smr.msgstart - smr.ser))) {
2313                         ++error_count;
2314                 }
2315
2316                 if (cdb_store(CDB_BIGMSGS, &msgid, (int)sizeof(long), smr.msgstart+1, (smr.len - (smr.msgstart - smr.ser) - 1) )) {
2317                         ++error_count;
2318                 }
2319
2320         }
2321
2322         if (error_count > 0) {
2323                 syslog(LOG_ERR, "msgbase: encountered %d errors storing message %ld", error_count, msgid);
2324         }
2325
2326         // Free the memory we used for the serialized message
2327         free(smr.ser);
2328         return(error_count);
2329 }
2330
2331
2332 long send_message(struct CtdlMessage *msg) {
2333         long newmsgid;
2334         long retval;
2335         char msgidbuf[256];
2336         long msgidbuflen;
2337
2338         // Get a new message number
2339         newmsgid = get_new_message_number();
2340
2341         // Generate an ID if we don't have one already
2342         if (CM_IsEmpty(msg, emessageId)) {
2343                 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%lX-%lX@%s",
2344                        (long unsigned int) time(NULL),
2345                        (long unsigned int) newmsgid,
2346                        CtdlGetConfigStr("c_fqdn")
2347                 );
2348                 CM_SetField(msg, emessageId, msgidbuf);
2349         }
2350
2351         retval = CtdlSaveThisMessage(msg, newmsgid);
2352
2353         if (retval == 0) {
2354                 retval = newmsgid;
2355         }
2356
2357         // Return the *local* message ID to the caller (even if we're storing a remotely originated message)
2358         return(retval);
2359 }
2360
2361
2362 // Serialize a struct CtdlMessage into the format used on disk.
2363 // 
2364 // This function returns a "struct ser_ret" (defined in server.h) which
2365 // contains the length of the serialized message and a pointer to the
2366 // serialized message in memory.  THE LATTER MUST BE FREED BY THE CALLER.
2367 struct ser_ret CtdlSerializeMessage(struct CtdlMessage *msg) {
2368         struct ser_ret ret;
2369         size_t wlen;
2370         int i;
2371
2372         ret.len = 0;
2373         ret.ser = NULL;
2374         ret.msgstart = NULL;
2375
2376         // Check for valid message format
2377         if (CM_IsValidMsg(msg) == 0) {
2378                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2379                 return(ret);
2380         }
2381
2382         ret.len = 3;
2383         assert(FieldOrder[NDiskFields-1] == eMessageText);              // Message text MUST be last!
2384         for (i=0; i < NDiskFields; ++i) {
2385                 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2386                         ret.len += msg->cm_lengths[FieldOrder[i]] + 2;
2387                 }
2388         }
2389
2390         ret.ser = malloc(ret.len);
2391         if (ret.ser == NULL) {
2392                 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret.len);
2393                 ret.len = 0;
2394                 ret.ser = NULL;
2395                 ret.msgstart = NULL;
2396                 return(ret);
2397         }
2398
2399         ret.ser[0] = 0xFF;
2400         ret.ser[1] = msg->cm_anon_type;
2401         ret.ser[2] = msg->cm_format_type;
2402         wlen = 3;
2403
2404         for (i=0; i < NDiskFields; ++i) {
2405                 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2406                         if (FieldOrder[i] == eMessageText) {
2407                                 ret.msgstart = &ret.ser[wlen];          // Make a note where the message text begins
2408                         }
2409                         ret.ser[wlen++] = (char)FieldOrder[i];
2410                         memcpy(&ret.ser[wlen], msg->cm_fields[FieldOrder[i]], msg->cm_lengths[FieldOrder[i]] + 1);
2411                         wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2412                 }
2413         }
2414
2415         assert(ret.len == wlen);                                        // Make sure we measured it correctly
2416         return(ret);
2417 }
2418
2419
2420 // Check to see if any messages already exist in the current room which
2421 // carry the same Exclusive ID as this one.  If any are found, delete them.
2422 void ReplicationChecks(struct CtdlMessage *msg) {
2423         long old_msgnum = (-1L);
2424
2425         if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2426
2427         syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2428
2429         // No exclusive id?  Don't do anything.
2430         if (msg == NULL) return;
2431         if (CM_IsEmpty(msg, eExclusiveID)) return;
2432
2433         old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2434         if (old_msgnum > 0L) {
2435                 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2436                 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2437         }
2438 }
2439
2440
2441 // Save a message to disk and submit it into the delivery system.
2442 long CtdlSubmitMsg(struct CtdlMessage *msg,     // message to save
2443                    struct recptypes *recps,     // recipients (if mail)
2444                    const char *force            // force a particular room?
2445 ) {
2446         char hold_rm[ROOMNAMELEN];
2447         char actual_rm[ROOMNAMELEN];
2448         char force_room[ROOMNAMELEN];
2449         char content_type[SIZ];                 // We have to learn this
2450         char recipient[SIZ];
2451         char bounce_to[1024];
2452         const char *room;
2453         long newmsgid;
2454         const char *mptr = NULL;
2455         struct ctdluser userbuf;
2456         int a, i;
2457         struct MetaData smi;
2458         char *collected_addresses = NULL;
2459         struct addresses_to_be_filed *aptr = NULL;
2460         StrBuf *saved_rfc822_version = NULL;
2461         int qualified_for_journaling = 0;
2462
2463         syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2464         if (CM_IsValidMsg(msg) == 0) return(-1);        // self check
2465
2466         // If this message has no timestamp, we take the liberty of giving it one, right now.
2467         if (CM_IsEmpty(msg, eTimestamp)) {
2468                 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2469         }
2470
2471         // If this message has no path, we generate one.
2472         if (CM_IsEmpty(msg, eMessagePath)) {
2473                 if (!CM_IsEmpty(msg, eAuthor)) {
2474                         CM_CopyField(msg, eMessagePath, eAuthor);
2475                         for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2476                                 if (isspace(msg->cm_fields[eMessagePath][a])) {
2477                                         msg->cm_fields[eMessagePath][a] = ' ';
2478                                 }
2479                         }
2480                 }
2481                 else {
2482                         CM_SetField(msg, eMessagePath, "unknown");
2483                 }
2484         }
2485
2486         if (force == NULL) {
2487                 force_room[0] = '\0';
2488         }
2489         else {
2490                 strcpy(force_room, force);
2491         }
2492
2493         // Learn about what's inside, because it's what's inside that counts
2494         if (CM_IsEmpty(msg, eMessageText)) {
2495                 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2496                 return(-2);
2497         }
2498
2499         switch (msg->cm_format_type) {
2500         case 0:
2501                 strcpy(content_type, "text/x-citadel-variformat");
2502                 break;
2503         case 1:
2504                 strcpy(content_type, "text/plain");
2505                 break;
2506         case 4:
2507                 strcpy(content_type, "text/plain");
2508                 mptr = bmstrcasestr(msg->cm_fields[eMessageText], "Content-type:");
2509                 if (mptr != NULL) {
2510                         char *aptr;
2511                         safestrncpy(content_type, &mptr[13], sizeof content_type);
2512                         string_trim(content_type);
2513                         aptr = content_type;
2514                         while (!IsEmptyStr(aptr)) {
2515                                 if (    (*aptr == ';')
2516                                         || (*aptr == ' ')
2517                                         || (*aptr == 13)
2518                                         || (*aptr == 10)
2519                                 ) {
2520                                         *aptr = 0;
2521                                 }
2522                                 else {
2523                                         aptr++;
2524                                 }
2525                         }
2526                 }
2527         }
2528
2529         // Goto the correct room
2530         room = (recps) ? CC->room.QRname : SENTITEMS;
2531         syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2532         strcpy(hold_rm, CC->room.QRname);
2533         strcpy(actual_rm, CC->room.QRname);
2534         if (recps != NULL) {
2535                 strcpy(actual_rm, SENTITEMS);
2536         }
2537
2538         // If the user is a twit, move to the twit room for posting
2539         if (TWITDETECT) {
2540                 if (CC->user.axlevel == AxProbU) {
2541                         strcpy(hold_rm, actual_rm);
2542                         strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2543                         syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2544                 }
2545         }
2546
2547         // ...or if this message is destined for Aide> then go there.
2548         if (!IsEmptyStr(force_room)) {
2549                 strcpy(actual_rm, force_room);
2550         }
2551
2552         syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2553         if (strcasecmp(actual_rm, CC->room.QRname)) {
2554                 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2555         }
2556
2557         // If this message has no O (room) field, generate one.
2558         if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2559                 CM_SetField(msg, eOriginalRoom, CC->room.QRname);
2560         }
2561
2562         // Perform "before save" hooks (aborting if any return nonzero)
2563         syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2564         if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2565
2566         // If this message has an Exclusive ID, and the room is replication
2567         // checking enabled, then do replication checks.
2568         if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2569                 ReplicationChecks(msg);
2570         }
2571
2572         // Save it to disk
2573         syslog(LOG_DEBUG, "msgbase: saving to disk");
2574         newmsgid = send_message(msg);
2575         if (newmsgid <= 0L) return(-5);
2576
2577         // Write a supplemental message info record.  This doesn't have to be
2578         // a critical section because nobody else knows about this message yet.
2579         syslog(LOG_DEBUG, "msgbase: creating metadata record");
2580         memset(&smi, 0, sizeof(struct MetaData));
2581         smi.meta_msgnum = newmsgid;
2582         smi.meta_refcount = 0;
2583         safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type);
2584
2585         // Measure how big this message will be when rendered as RFC822.
2586         // We do this for two reasons:
2587         // 1. We need the RFC822 length for the new metadata record, so the
2588         //    POP and IMAP services don't have to calculate message lengths
2589         //    while the user is waiting (multiplied by potentially hundreds
2590         //    or thousands of messages).
2591         // 2. If journaling is enabled, we will need an RFC822 version of the
2592         //    message to attach to the journalized copy.
2593         if (CC->redirect_buffer != NULL) {
2594                 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2595                 exit(CTDLEXIT_REDIRECT);
2596         }
2597         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2598         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2599         smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2600         saved_rfc822_version = CC->redirect_buffer;
2601         CC->redirect_buffer = NULL;
2602
2603         PutMetaData(&smi);
2604
2605         // Now figure out where to store the pointers
2606         syslog(LOG_DEBUG, "msgbase: storing pointers");
2607
2608         // If this is being done by the networker delivering a private
2609         // message, we want to BYPASS saving the sender's copy (because there
2610         // is no local sender; it would otherwise go to the Trashcan).
2611         if ((!CC->internal_pgm) || (recps == NULL)) {
2612                 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2613                         syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm);
2614                         CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2615                 }
2616         }
2617
2618         // For internet mail, drop a copy in the outbound queue room
2619         if ((recps != NULL) && (recps->num_internet > 0)) {
2620                 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2621         }
2622
2623         // If other rooms are specified, drop them there too.
2624         if ((recps != NULL) && (recps->num_room > 0)) {
2625                 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2626                         extract_token(recipient, recps->recp_room, i, '|', sizeof recipient);
2627                         syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2628                         CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2629                 }
2630         }
2631
2632         // Decide where bounces need to be delivered
2633         if ((recps != NULL) && (recps->bounce_to == NULL)) {
2634                 if (CC->logged_in) {
2635                         strcpy(bounce_to, CC->user.fullname);
2636                 }
2637                 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2638                         strcpy(bounce_to, msg->cm_fields[eAuthor]);
2639                 }
2640                 recps->bounce_to = bounce_to;
2641         }
2642                 
2643         CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2644
2645         // If this is private, local mail, make a copy in the recipient's mailbox and bump the reference count.
2646         if ((recps != NULL) && (recps->num_local > 0)) {
2647                 char *pch;
2648                 int ntokens;
2649
2650                 pch = recps->recp_local;
2651                 recps->recp_local = recipient;
2652                 ntokens = num_tokens(pch, '|');
2653                 for (i=0; i<ntokens; ++i) {
2654                         extract_token(recipient, pch, i, '|', sizeof recipient);
2655                         syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2656                         if (CtdlGetUser(&userbuf, recipient) == 0) {
2657                                 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2658                                 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2659                                 CtdlBumpNewMailCounter(userbuf.usernum);        // if this user is logged in, tell them they have new mail.
2660                                 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2661                         }
2662                         else {
2663                                 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2664                                 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2665                         }
2666                 }
2667                 recps->recp_local = pch;
2668         }
2669
2670         // Perform "after save" hooks
2671         syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2672
2673         PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2674         CM_FlushField(msg, eVltMsgNum);
2675
2676         // Go back to the room we started from
2677         syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2678         if (strcasecmp(hold_rm, CC->room.QRname)) {
2679                 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2680         }
2681
2682         // Any addresses to harvest for someone's address book?
2683         if ( (CC->logged_in) && (recps != NULL) ) {
2684                 collected_addresses = harvest_collected_addresses(msg);
2685         }
2686
2687         if (collected_addresses != NULL) {
2688                 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2689                 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2690                 aptr->roomname = strdup(actual_rm);
2691                 aptr->collected_addresses = collected_addresses;
2692                 begin_critical_section(S_ATBF);
2693                 aptr->next = atbf;
2694                 atbf = aptr;
2695                 end_critical_section(S_ATBF);
2696         }
2697
2698         // Determine whether this message qualifies for journaling.
2699         if (!CM_IsEmpty(msg, eJournal)) {
2700                 qualified_for_journaling = 0;
2701         }
2702         else {
2703                 if (recps == NULL) {
2704                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2705                 }
2706                 else if (recps->num_local + recps->num_internet > 0) {
2707                         qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2708                 }
2709                 else {
2710                         qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2711                 }
2712         }
2713
2714         // Do we have to perform journaling?  If so, hand off the saved
2715         // RFC822 version will be handed off to the journaler for background
2716         // submit.  Otherwise, we have to free the memory ourselves.
2717         if (saved_rfc822_version != NULL) {
2718                 if (qualified_for_journaling) {
2719                         JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2720                 }
2721                 else {
2722                         FreeStrBuf(&saved_rfc822_version);
2723                 }
2724         }
2725
2726         if ((recps != NULL) && (recps->bounce_to == bounce_to))
2727                 recps->bounce_to = NULL;
2728
2729         // Done.
2730         return(newmsgid);
2731 }
2732
2733
2734 // Convenience function for generating small administrative messages.
2735 long quickie_message(char *from,
2736                      char *fromaddr,
2737                      char *to,
2738                      char *room,
2739                      char *text, 
2740                      int format_type,
2741                      char *subject)
2742 {
2743         struct CtdlMessage *msg;
2744         struct recptypes *recp = NULL;
2745
2746         msg = malloc(sizeof(struct CtdlMessage));
2747         memset(msg, 0, sizeof(struct CtdlMessage));
2748         msg->cm_magic = CTDLMESSAGE_MAGIC;
2749         msg->cm_anon_type = MES_NORMAL;
2750         msg->cm_format_type = format_type;
2751
2752         if (!IsEmptyStr(from)) {
2753                 CM_SetField(msg, eAuthor, from);
2754         }
2755         else if (!IsEmptyStr(fromaddr)) {
2756                 char *pAt;
2757                 CM_SetField(msg, eAuthor, fromaddr);
2758                 pAt = strchr(msg->cm_fields[eAuthor], '@');
2759                 if (pAt != NULL) {
2760                         CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
2761                 }
2762         }
2763         else {
2764                 msg->cm_fields[eAuthor] = strdup("Citadel");
2765         }
2766
2767         if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr);
2768         if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room);
2769         if (!IsEmptyStr(to)) {
2770                 CM_SetField(msg, eRecipient, to);
2771                 recp = validate_recipients(to, 0);
2772         }
2773         if (!IsEmptyStr(subject)) {
2774                 CM_SetField(msg, eMsgSubject, subject);
2775         }
2776         if (!IsEmptyStr(text)) {
2777                 CM_SetField(msg, eMessageText, text);
2778         }
2779
2780         long msgnum = CtdlSubmitMsg(msg, recp, room);
2781         CM_Free(msg);
2782         if (recp != NULL) free_recipients(recp);
2783         return msgnum;
2784 }
2785
2786
2787 // Back end function used by CtdlMakeMessage() and similar functions
2788 StrBuf *CtdlReadMessageBodyBuf(char *terminator,        // token signalling EOT
2789                                long tlen,
2790                                size_t maxlen,           // maximum message length
2791                                StrBuf *exist,           // if non-null, append to it; exist is ALWAYS freed
2792                                int crlf                 // CRLF newlines instead of LF
2793 ) {
2794         StrBuf *Message;
2795         StrBuf *LineBuf;
2796         int flushing = 0;
2797         int finished = 0;
2798         int dotdot = 0;
2799
2800         LineBuf = NewStrBufPlain(NULL, SIZ);
2801         if (exist == NULL) {
2802                 Message = NewStrBufPlain(NULL, 4 * SIZ);
2803         }
2804         else {
2805                 Message = NewStrBufDup(exist);
2806         }
2807
2808         // Do we need to change leading ".." to "." for SMTP escaping?
2809         if ((tlen == 1) && (*terminator == '.')) {
2810                 dotdot = 1;
2811         }
2812
2813         // read in the lines of message text one by one
2814         do {
2815                 if (CtdlClientGetLine(LineBuf) < 0) {
2816                         finished = 1;
2817                 }
2818                 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
2819                         finished = 1;
2820                 }
2821                 if ( (!flushing) && (!finished) ) {
2822                         if (crlf) {
2823                                 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
2824                         }
2825                         else {
2826                                 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
2827                         }
2828                         
2829                         // Unescape SMTP-style input of two dots at the beginning of the line
2830                         if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
2831                                 StrBufCutLeft(LineBuf, 1);
2832                         }
2833                         StrBufAppendBuf(Message, LineBuf, 0);
2834                 }
2835
2836                 // if we've hit the max msg length, flush the rest
2837                 if (StrLength(Message) >= maxlen) {
2838                         flushing = 1;
2839                 }
2840
2841         } while (!finished);
2842         FreeStrBuf(&LineBuf);
2843
2844         if (flushing) {
2845                 syslog(LOG_ERR, "msgbase: exceeded maximum message length of %ld - message was truncated", maxlen);
2846         }
2847
2848         return Message;
2849 }
2850
2851
2852 // Back end function used by CtdlMakeMessage() and similar functions
2853 char *CtdlReadMessageBody(char *terminator,     // token signalling EOT
2854                           long tlen,
2855                           size_t maxlen,        // maximum message length
2856                           StrBuf *exist,        // if non-null, append to it; exist is ALWAYS freed
2857                           int crlf              // CRLF newlines instead of LF
2858 ) {
2859         StrBuf *Message;
2860
2861         Message = CtdlReadMessageBodyBuf(terminator,
2862                                          tlen,
2863                                          maxlen,
2864                                          exist,
2865                                          crlf
2866         );
2867         if (Message == NULL) {
2868                 return NULL;
2869         }
2870         else {
2871                 return SmashStrBuf(&Message);
2872         }
2873 }
2874
2875
2876 struct CtdlMessage *CtdlMakeMessage(
2877         struct ctdluser *author,        // author's user structure
2878         char *recipient,                // NULL if it's not mail
2879         char *recp_cc,                  // NULL if it's not mail
2880         char *room,                     // room where it's going
2881         int type,                       // see MES_ types in header file
2882         int format_type,                // variformat, plain text, MIME...
2883         char *fake_name,                // who we're masquerading as
2884         char *my_email,                 // which of my email addresses to use (empty is ok)
2885         char *subject,                  // Subject (optional)
2886         char *euid_in,          // ...or NULL if this is irrelevant
2887         char *preformatted_text,        // ...or NULL to read text from client
2888         char *references                // Thread references
2889 ) {
2890         return CtdlMakeMessageLen(
2891                 author,                                 // author's user structure 
2892                 recipient,                              // NULL if it's not mail
2893                 (recipient)?strlen(recipient) : 0,
2894                 recp_cc,                                // NULL if it's not mail
2895                 (recp_cc)?strlen(recp_cc): 0,
2896                 room,                                   // room where it's going
2897                 (room)?strlen(room): 0,
2898                 type,                                   // see MES_ types in header file
2899                 format_type,                            // variformat, plain text, MIME...
2900                 fake_name,                              // who we're masquerading as
2901                 (fake_name)?strlen(fake_name): 0,
2902                 my_email,                               // which of my email addresses to use (empty is ok)
2903                 (my_email)?strlen(my_email): 0,
2904                 subject,                                // Subject (optional)
2905                 (subject)?strlen(subject): 0,
2906                 euid_in,                                // ...or NULL if this is irrelevant
2907                 (euid_in)?strlen(euid_in):0,
2908                 preformatted_text,                      // ...or NULL to read text from client
2909                 (preformatted_text)?strlen(preformatted_text) : 0,
2910                 references,                             // Thread references
2911                 (references)?strlen(references):0);
2912
2913 }
2914
2915
2916 // Build a binary message to be saved on disk.
2917 // (NOTE: if you supply 'preformatted_text', the buffer you give it
2918 // will become part of the message.  This means you are no longer
2919 // responsible for managing that memory -- it will be freed along with
2920 // the rest of the fields when CM_Free() is called.)
2921 struct CtdlMessage *CtdlMakeMessageLen(
2922         struct ctdluser *author,        // author's user structure
2923         char *recipient,                // NULL if it's not mail
2924         long rcplen,
2925         char *recp_cc,                  // NULL if it's not mail
2926         long cclen,
2927         char *room,                     // room where it's going
2928         long roomlen,
2929         int type,                       // see MES_ types in header file
2930         int format_type,                // variformat, plain text, MIME...
2931         char *fake_name,                // who we're masquerading as
2932         long fnlen,
2933         char *my_email,                 // which of my email addresses to use (empty is ok)
2934         long myelen,
2935         char *subject,                  // Subject (optional)
2936         long subjlen,
2937         char *euid_in,          // ...or NULL if this is irrelevant
2938         long euidlen,
2939         char *preformatted_text,        // ...or NULL to read text from client
2940         long textlen,
2941         char *references,               // Thread references
2942         long reflen
2943 ) {
2944         long blen;
2945         char buf[1024];
2946         struct CtdlMessage *msg;
2947         StrBuf *FakeAuthor;
2948         StrBuf *FakeEncAuthor = NULL;
2949
2950         msg = malloc(sizeof(struct CtdlMessage));
2951         memset(msg, 0, sizeof(struct CtdlMessage));
2952         msg->cm_magic = CTDLMESSAGE_MAGIC;
2953         msg->cm_anon_type = type;
2954         msg->cm_format_type = format_type;
2955
2956         if (recipient != NULL) rcplen = string_trim(recipient);
2957         if (recp_cc != NULL) cclen = string_trim(recp_cc);
2958
2959         // Path or Return-Path
2960         if (myelen > 0) {
2961                 CM_SetField(msg, eMessagePath, my_email);
2962         }
2963         else if (!IsEmptyStr(author->fullname)) {
2964                 CM_SetField(msg, eMessagePath, author->fullname);
2965         }
2966         convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
2967
2968         blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
2969         CM_SetField(msg, eTimestamp, buf);
2970
2971         if (fnlen > 0) {
2972                 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
2973         }
2974         else {
2975                 FakeAuthor = NewStrBufPlain (author->fullname, -1);
2976         }
2977         StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
2978         CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
2979         FreeStrBuf(&FakeAuthor);
2980
2981         if (!!IsEmptyStr(CC->room.QRname)) {
2982                 if (CC->room.QRflags & QR_MAILBOX) {            // room
2983                         CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11]);
2984                 }
2985                 else {
2986                         CM_SetField(msg, eOriginalRoom, CC->room.QRname);
2987                 }
2988         }
2989
2990         if (rcplen > 0) {
2991                 CM_SetField(msg, eRecipient, recipient);
2992         }
2993         if (cclen > 0) {
2994                 CM_SetField(msg, eCarbonCopY, recp_cc);
2995         }
2996
2997         if (myelen > 0) {
2998                 CM_SetField(msg, erFc822Addr, my_email);
2999         }
3000         else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3001                 CM_SetField(msg, erFc822Addr, CC->cs_inet_email);
3002         }
3003
3004         if (subject != NULL) {
3005                 long length;
3006                 length = string_trim(subject);
3007                 if (length > 0) {
3008                         long i;
3009                         long IsAscii;
3010                         IsAscii = -1;
3011                         i = 0;
3012                         while ((subject[i] != '\0') && (IsAscii = isascii(subject[i]) != 0 )) {
3013                                 i++;
3014                         }
3015                         if (IsAscii != 0) {
3016                                 CM_SetField(msg, eMsgSubject, subject);
3017                         }
3018                         else {  // ok, we've got utf8 in the string.
3019                                 char *rfc2047Subj;
3020                                 rfc2047Subj = rfc2047encode(subject, length);
3021                                 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3022                         }
3023
3024                 }
3025         }
3026
3027         if (euidlen > 0) {
3028                 CM_SetField(msg, eExclusiveID, euid_in);
3029         }
3030
3031         if (reflen > 0) {
3032                 CM_SetField(msg, eWeferences, references);
3033         }
3034
3035         if (preformatted_text != NULL) {
3036                 CM_SetField(msg, eMessageText, preformatted_text);
3037         }
3038         else {
3039                 StrBuf *MsgBody;
3040                 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3041                 if (MsgBody != NULL) {
3042                         CM_SetAsFieldSB(msg, eMessageText, &MsgBody);
3043                 }
3044         }
3045
3046         return(msg);
3047 }
3048
3049
3050 // API function to delete messages which match a set of criteria
3051 // (returns the actual number of messages deleted)
3052 int CtdlDeleteMessages(const char *room_name,   // which room
3053                        long *dmsgnums,          // array of msg numbers to be deleted
3054                        int num_dmsgnums,        // number of msgs to be deleted, or 0 for "any"
3055                        char *content_type       // or "" for any.  regular expressions expected.
3056 ) {
3057         struct ctdlroom qrbuf;
3058         struct cdbdata *cdbfr;
3059         long *msglist = NULL;
3060         long *dellist = NULL;
3061         int num_msgs = 0;
3062         int i, j;
3063         int num_deleted = 0;
3064         int delete_this;
3065         struct MetaData smi;
3066         regex_t re;
3067         regmatch_t pm;
3068         int need_to_free_re = 0;
3069
3070         if (content_type) if (!IsEmptyStr(content_type)) {
3071                 regcomp(&re, content_type, 0);
3072                 need_to_free_re = 1;
3073         }
3074         syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3075
3076         // get room record, obtaining a lock...
3077         if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3078                 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3079                 if (need_to_free_re) regfree(&re);
3080                 return(0);      // room not found
3081         }
3082
3083         num_msgs = CtdlFetchMsgList(qrbuf.QRnumber, &msglist);
3084         if (num_msgs > 0) {
3085                 dellist = malloc(num_msgs * sizeof(long));
3086                 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3087                 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3088                 int have_more_del = 1;
3089
3090                 num_msgs = sort_msglist(msglist, num_msgs);
3091                 if (num_dmsgnums > 1) {
3092                         num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3093                 }
3094                 i = 0;
3095                 j = 0;
3096                 while ((i < num_msgs) && (have_more_del)) {
3097                         delete_this = 0x00;
3098
3099                         // Set/clear a bit for each criterion
3100
3101                         // 0 messages in the list or a null list means that we are
3102                         // interested in deleting any messages which meet the other criteria.
3103                         if (have_delmsgs) {
3104                                 delete_this |= 0x01;
3105                         }
3106                         else {
3107                                 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3108
3109                                 if (i >= num_msgs)
3110                                         continue;
3111
3112                                 if (msglist[i] == dmsgnums[j]) {
3113                                         delete_this |= 0x01;
3114                                 }
3115                                 j++;
3116                                 have_more_del = (j < num_dmsgnums);
3117                         }
3118
3119                         if (have_contenttype) {
3120                                 GetMetaData(&smi, msglist[i]);
3121                                 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3122                                         delete_this |= 0x02;
3123                                 }
3124                         }
3125                         else {
3126                                 delete_this |= 0x02;
3127                         }
3128
3129                         // Delete message only if all bits are set
3130                         if (delete_this == 0x03) {
3131                                 dellist[num_deleted++] = msglist[i];
3132                                 msglist[i] = 0L;
3133                         }
3134                         i++;
3135                 }
3136
3137                 num_msgs = sort_msglist(msglist, num_msgs);
3138                 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long), msglist, (int)(num_msgs * sizeof(long)));
3139
3140                 if (num_msgs > 0) {
3141                         qrbuf.QRhighest = msglist[num_msgs - 1];
3142                 }
3143                 else {
3144                         qrbuf.QRhighest = 0;
3145                 }
3146         }
3147         CtdlPutRoomLock(&qrbuf);
3148
3149         // Go through the messages we pulled out of the index, and decrement
3150         // their reference counts by 1.  If this is the only room the message
3151         // was in, the reference count will reach zero and the message will
3152         // automatically be deleted from the database.  We do this in a
3153         // separate pass because there might be plug-in hooks getting called,
3154         // and we don't want that happening during an S_ROOMS critical section.
3155         if (num_deleted) {
3156                 for (i=0; i<num_deleted; ++i) {
3157                         PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3158                 }
3159                 AdjRefCountList(dellist, num_deleted, -1);
3160         }
3161         // Now free the memory we used, and go away.
3162         if (msglist != NULL) free(msglist);
3163         if (dellist != NULL) free(dellist);
3164         syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3165         if (need_to_free_re) regfree(&re);
3166         return (num_deleted);
3167 }
3168
3169
3170 // GetMetaData()  -  Get the supplementary record for a message
3171 void GetMetaData(struct MetaData *smibuf, long msgnum) {
3172         struct cdbdata cdbsmi;
3173         long TheIndex;
3174
3175         memset(smibuf, 0, sizeof(struct MetaData));
3176         smibuf->meta_msgnum = msgnum;
3177         smibuf->meta_refcount = 1;      // Default reference count is 1
3178
3179         // Use the negative of the message number for its supp record index
3180         TheIndex = (0L - msgnum);
3181
3182         cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3183         if (cdbsmi.ptr == NULL) {
3184                 return;                 // record not found; leave it alone
3185         }
3186         memcpy(smibuf, cdbsmi.ptr, ((cdbsmi.len > sizeof(struct MetaData)) ? sizeof(struct MetaData) : cdbsmi.len));
3187         return;
3188 }
3189
3190
3191 // PutMetaData()  -  (re)write supplementary record for a message
3192 void PutMetaData(struct MetaData *smibuf) {
3193         long TheIndex;
3194
3195         // Use the negative of the message number for the metadata db index
3196         TheIndex = (0L - smibuf->meta_msgnum);
3197         cdb_store(CDB_MSGMAIN, &TheIndex, (int)sizeof(long), smibuf, (int)sizeof(struct MetaData));
3198 }
3199
3200
3201 // Convenience function to process a big block of AdjRefCount() operations
3202 void AdjRefCountList(long *msgnum, long nmsg, int incr) {
3203         long i;
3204
3205         for (i = 0; i < nmsg; i++) {
3206                 AdjRefCount(msgnum[i], incr);
3207         }
3208 }
3209
3210
3211 // AdjRefCount - adjust the reference count for a message.
3212 // We need to delete from disk any message whose reference count reaches zero.
3213 void AdjRefCount(long msgnum, int incr) {
3214         struct MetaData smi;
3215         long delnum;
3216
3217         // This is a *tight* critical section; please keep it that way, as
3218         // it may get called while nested in other critical sections.  
3219         // Complicating this any further will surely cause deadlock!
3220         begin_critical_section(S_SUPPMSGMAIN);
3221         GetMetaData(&smi, msgnum);
3222         smi.meta_refcount += incr;
3223         PutMetaData(&smi);
3224         end_critical_section(S_SUPPMSGMAIN);
3225         syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3226
3227         // If the reference count is now zero, delete both the message and its metadata record.
3228         if (smi.meta_refcount == 0) {
3229                 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3230                 
3231                 // Call delete hooks with NULL room to show it has gone altogether
3232                 PerformDeleteHooks(NULL, msgnum);
3233
3234                 // Remove from message base
3235                 delnum = msgnum;
3236                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3237                 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));    // There might not be a bigmsgs.  Not an error.
3238
3239                 // Remove metadata record
3240                 delnum = (0L - msgnum);
3241                 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3242         }
3243 }
3244
3245
3246 // Write a generic object to this room
3247 // Returns the message number of the written object, in case you need it.
3248 long CtdlWriteObject(char *req_room,                    // Room to stuff it in
3249                      char *content_type,                // MIME type of this object
3250                      char *raw_message,                 // Data to be written
3251                      off_t raw_length,                  // Size of raw_message
3252                      struct ctdluser *is_mailbox,       // Mailbox room?
3253                      int is_binary,                     // Is encoding necessary?
3254                      unsigned int flags                 // Internal save flags
3255 ) {
3256         struct ctdlroom qrbuf;
3257         char roomname[ROOMNAMELEN];
3258         struct CtdlMessage *msg;
3259         StrBuf *encoded_message = NULL;
3260
3261         if (is_mailbox != NULL) {
3262                 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3263         }
3264         else {
3265                 safestrncpy(roomname, req_room, sizeof(roomname));
3266         }
3267
3268         syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3269
3270         if (is_binary) {
3271                 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3272         }
3273         else {
3274                 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3275         }
3276
3277         StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3278         StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3279         StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3280
3281         if (is_binary) {
3282                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3283         }
3284         else {
3285                 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3286         }
3287
3288         if (is_binary) {
3289                 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3290         }
3291         else {
3292                 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3293         }
3294
3295         syslog(LOG_DEBUG, "msgbase: allocating");
3296         msg = malloc(sizeof(struct CtdlMessage));
3297         memset(msg, 0, sizeof(struct CtdlMessage));
3298         msg->cm_magic = CTDLMESSAGE_MAGIC;
3299         msg->cm_anon_type = MES_NORMAL;
3300         msg->cm_format_type = 4;
3301         CM_SetField(msg, eAuthor, CC->user.fullname);
3302         CM_SetField(msg, eOriginalRoom, req_room);
3303         msg->cm_flags = flags;
3304         
3305         CM_SetAsFieldSB(msg, eMessageText, &encoded_message);
3306
3307         // Create the requested room if we have to.
3308         if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3309                 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3310         }
3311
3312         // Now write the data
3313         long new_msgnum = CtdlSubmitMsg(msg, NULL, roomname);
3314         CM_Free(msg);
3315         return new_msgnum;
3316 }
3317
3318
3319 // ************************************************************************/
3320 // *                      MODULE INITIALIZATION                           */
3321 // ************************************************************************/
3322
3323 char *ctdl_module_init_msgbase(void) {
3324         if (!threading) {
3325                 FillMsgKeyLookupTable();
3326         }
3327
3328         // return our module id for the log
3329         return "msgbase";
3330 }