1 // Implements the message store.
3 // Copyright (c) 1987-2023 by the citadel.org team
5 // This program is open source software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License version 3.
14 #include <libcitadel.h>
15 #include "ctdl_module.h"
16 #include "citserver.h"
19 #include "clientsocket.h"
23 #include "internet_addressing.h"
24 #include "euidindex.h"
26 #include "journaling.h"
28 struct addresses_to_be_filed *atbf = NULL;
30 // These are the four-character field headers we use when outputting
31 // messages in Citadel format (as opposed to RFC822 format).
33 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
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,
42 "from", // A -> eAuthor
43 NULL, // B -> eBig_message
44 NULL, // C (formerly used as eRemoteRoom)
45 NULL, // D (formerly used as eDestination)
46 "exti", // E -> eXclusivID
47 "rfca", // F -> erFc822Addr
49 "hnod", // H (formerly used as eHumanNode)
50 "msgn", // I -> emessageId
51 "jrnl", // J -> eJournal
52 "rep2", // K -> eReplyTo
53 "list", // L -> eListID
54 "text", // M -> eMesageText
55 NULL, // N (formerly used as eNodename)
56 "room", // O -> eOriginalRoom
57 "path", // P -> eMessagePath
59 "rcpt", // R -> eRecipient
60 NULL, // S (formerly used as eSpecialField)
61 "time", // T -> eTimestamp
62 "subj", // U -> eMsgSubject
63 "nvto", // V -> eenVelopeTo
64 "wefw", // W -> eWeferences
66 "cccc", // Y -> eCarbonCopY
71 HashList *msgKeyLookup = NULL;
73 int GetFieldFromMnemonic(eMsgField *f, const char* c) {
75 if (GetHash(msgKeyLookup, c, 4, &v)) {
82 void FillMsgKeyLookupTable(void) {
85 msgKeyLookup = NewHash (1, FourHash);
87 for (i=0; i < 91; i++) {
88 if (msgkeys[i] != NULL) {
89 Put(msgKeyLookup, msgkeys[i], 4, (void*)i, reference_free_handler);
95 eMsgField FieldOrder[] = {
96 /* Important fields */
104 /* Semi-important fields */
109 /* G is not used yet */
112 /* Q is not used yet */
114 /* X is not used yet */
115 /* Z is not used yet */
122 /* Message text (MUST be last) */
124 /* Not saved to disk:
129 static const long NDiskFields = sizeof(FieldOrder) / sizeof(eMsgField);
132 int CM_IsEmpty(struct CtdlMessage *Msg, eMsgField which) {
133 return !((Msg->cm_fields[which] != NULL) && (Msg->cm_fields[which][0] != '\0'));
137 void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) {
138 if (Msg->cm_fields[which] != NULL) {
139 free (Msg->cm_fields[which]);
141 if (length < 0) { // You can set the length to -1 to have CM_SetField measure it for you
142 length = strlen(buf);
144 Msg->cm_fields[which] = malloc(length + 1);
145 memcpy(Msg->cm_fields[which], buf, length);
146 Msg->cm_fields[which][length] = '\0';
147 Msg->cm_lengths[which] = length;
151 void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue) {
154 len = snprintf(buf, sizeof(buf), "%ld", lvalue);
155 CM_SetField(Msg, which, buf, len);
159 void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen) {
160 if (Msg->cm_fields[WhichToCut] == NULL)
163 if (Msg->cm_lengths[WhichToCut] > maxlen)
165 Msg->cm_fields[WhichToCut][maxlen] = '\0';
166 Msg->cm_lengths[WhichToCut] = maxlen;
171 void CM_FlushField(struct CtdlMessage *Msg, eMsgField which) {
172 if (Msg->cm_fields[which] != NULL)
173 free (Msg->cm_fields[which]);
174 Msg->cm_fields[which] = NULL;
175 Msg->cm_lengths[which] = 0;
179 void CM_Flush(struct CtdlMessage *Msg) {
182 if (CM_IsValidMsg(Msg) == 0) {
186 for (i = 0; i < 256; ++i) {
187 CM_FlushField(Msg, i);
192 void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy) {
194 if (Msg->cm_fields[WhichToPutTo] != NULL) {
195 free (Msg->cm_fields[WhichToPutTo]);
198 if (Msg->cm_fields[WhichtToCopy] != NULL) {
199 len = Msg->cm_lengths[WhichtToCopy];
200 Msg->cm_fields[WhichToPutTo] = malloc(len + 1);
201 memcpy(Msg->cm_fields[WhichToPutTo], Msg->cm_fields[WhichtToCopy], len);
202 Msg->cm_fields[WhichToPutTo][len] = '\0';
203 Msg->cm_lengths[WhichToPutTo] = len;
206 Msg->cm_fields[WhichToPutTo] = NULL;
207 Msg->cm_lengths[WhichToPutTo] = 0;
212 void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) {
213 if (Msg->cm_fields[which] != NULL) {
218 oldmsgsize = Msg->cm_lengths[which] + 1;
219 newmsgsize = length + oldmsgsize;
221 new = malloc(newmsgsize);
222 memcpy(new, buf, length);
223 memcpy(new + length, Msg->cm_fields[which], oldmsgsize);
224 free(Msg->cm_fields[which]);
225 Msg->cm_fields[which] = new;
226 Msg->cm_lengths[which] = newmsgsize - 1;
229 Msg->cm_fields[which] = malloc(length + 1);
230 memcpy(Msg->cm_fields[which], buf, length);
231 Msg->cm_fields[which][length] = '\0';
232 Msg->cm_lengths[which] = length;
237 void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length) {
238 if (Msg->cm_fields[which] != NULL) {
239 free (Msg->cm_fields[which]);
242 Msg->cm_fields[which] = *buf;
244 if (length < 0) { // You can set the length to -1 to have CM_SetField measure it for you
245 Msg->cm_lengths[which] = strlen(Msg->cm_fields[which]);
248 Msg->cm_lengths[which] = length;
253 void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf) {
254 if (Msg->cm_fields[which] != NULL) {
255 free (Msg->cm_fields[which]);
258 Msg->cm_lengths[which] = StrLength(*buf);
259 Msg->cm_fields[which] = SmashStrBuf(buf);
263 void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen) {
264 if (Msg->cm_fields[which] != NULL) {
265 *retlen = Msg->cm_lengths[which];
266 *ret = Msg->cm_fields[which];
267 Msg->cm_fields[which] = NULL;
268 Msg->cm_lengths[which] = 0;
277 // Returns 1 if the supplied pointer points to a valid Citadel message.
278 // If the pointer is NULL or the magic number check fails, returns 0.
279 int CM_IsValidMsg(struct CtdlMessage *msg) {
283 if ((msg->cm_magic) != CTDLMESSAGE_MAGIC) {
284 syslog(LOG_WARNING, "msgbase: CM_IsValidMsg() self-check failed");
291 void CM_FreeContents(struct CtdlMessage *msg) {
294 for (i = 0; i < 256; ++i)
295 if (msg->cm_fields[i] != NULL) {
296 free(msg->cm_fields[i]);
297 msg->cm_lengths[i] = 0;
300 msg->cm_magic = 0; // just in case
304 // 'Destructor' for struct CtdlMessage
305 void CM_Free(struct CtdlMessage *msg) {
306 if (CM_IsValidMsg(msg) == 0) {
307 if (msg != NULL) free (msg);
310 CM_FreeContents(msg);
315 int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg) {
317 len = OrgMsg->cm_lengths[i];
318 NewMsg->cm_fields[i] = malloc(len + 1);
319 if (NewMsg->cm_fields[i] == NULL) {
322 memcpy(NewMsg->cm_fields[i], OrgMsg->cm_fields[i], len);
323 NewMsg->cm_fields[i][len] = '\0';
324 NewMsg->cm_lengths[i] = len;
329 struct CtdlMessage *CM_Duplicate(struct CtdlMessage *OrgMsg) {
331 struct CtdlMessage *NewMsg;
333 if (CM_IsValidMsg(OrgMsg) == 0) {
336 NewMsg = (struct CtdlMessage *)malloc(sizeof(struct CtdlMessage));
337 if (NewMsg == NULL) {
341 memcpy(NewMsg, OrgMsg, sizeof(struct CtdlMessage));
343 memset(&NewMsg->cm_fields, 0, sizeof(char*) * 256);
345 for (i = 0; i < 256; ++i) {
346 if (OrgMsg->cm_fields[i] != NULL) {
347 if (!CM_DupField(i, OrgMsg, NewMsg)) {
358 // Determine if a given message matches the fields in a message template.
359 // Return 0 for a successful match.
360 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) {
363 // If there aren't any fields in the template, all messages will match.
364 if (template == NULL) return(0);
366 // Null messages are bogus.
367 if (msg == NULL) return(1);
369 for (i='A'; i<='Z'; ++i) {
370 if (template->cm_fields[i] != NULL) {
371 if (msg->cm_fields[i] == NULL) {
372 // Considered equal if temmplate is empty string
373 if (IsEmptyStr(template->cm_fields[i])) continue;
376 if ((template->cm_lengths[i] != msg->cm_lengths[i]) ||
377 (strcasecmp(msg->cm_fields[i], template->cm_fields[i])))
382 // All compares succeeded: we have a match!
387 // Retrieve the "seen" message list for the current room.
388 void CtdlGetSeen(char *buf, int which_set) {
391 // Learn about the user and room in question
392 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
394 if (which_set == ctdlsetseen_seen) {
395 safestrncpy(buf, vbuf.v_seen, SIZ);
397 if (which_set == ctdlsetseen_answered) {
398 safestrncpy(buf, vbuf.v_answered, SIZ);
403 // Manipulate the "seen msgs" string (or other message set strings)
404 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
405 int target_setting, int which_set,
406 struct ctdluser *which_user, struct ctdlroom *which_room) {
407 struct cdbdata *cdbfr;
421 char *is_set; // actually an array of booleans
423 // Don't bother doing *anything* if we were passed a list of zero messages
424 if (num_target_msgnums < 1) {
428 // If no room was specified, we go with the current room.
430 which_room = &CC->room;
433 // If no user was specified, we go with the current user.
435 which_user = &CC->user;
438 syslog(LOG_DEBUG, "msgbase: CtdlSetSeen(%d msgs starting with %ld, %s, %d) in <%s>",
439 num_target_msgnums, target_msgnums[0],
440 (target_setting ? "SET" : "CLEAR"),
444 // Learn about the user and room in question
445 CtdlGetRelationship(&vbuf, which_user, which_room);
447 // Load the message list
448 cdbfr = cdb_fetch(CDB_MSGLISTS, &which_room->QRnumber, sizeof(long));
450 msglist = (long *) cdbfr->ptr;
451 cdbfr->ptr = NULL; // CtdlSetSeen() now owns this memory (this needs attention if we move to LMDB)
452 num_msgs = cdbfr->len / sizeof(long);
456 return; // No messages at all? No further action.
459 is_set = malloc(num_msgs * sizeof(char));
460 memset(is_set, 0, (num_msgs * sizeof(char)) );
462 // Decide which message set we're manipulating
464 case ctdlsetseen_seen:
465 vset = NewStrBufPlain(vbuf.v_seen, -1);
467 case ctdlsetseen_answered:
468 vset = NewStrBufPlain(vbuf.v_answered, -1);
475 #if 0 // This is a special diagnostic section. Do not allow it to run during normal operation.
476 syslog(LOG_DEBUG, "There are %d messages in the room.\n", num_msgs);
477 for (i=0; i<num_msgs; ++i) {
478 if ((i > 0) && (msglist[i] <= msglist[i-1])) abort();
480 syslog(LOG_DEBUG, "We are twiddling %d of them.\n", num_target_msgnums);
481 for (k=0; k<num_target_msgnums; ++k) {
482 if ((k > 0) && (target_msgnums[k] <= target_msgnums[k-1])) abort();
486 // Translate the existing sequence set into an array of booleans
487 setstr = NewStrBuf();
491 while (StrBufExtract_NextToken(setstr, vset, &pvset, ',') >= 0) {
493 StrBufExtract_token(lostr, setstr, 0, ':');
494 if (StrBufNum_tokens(setstr, ':') >= 2) {
495 StrBufExtract_token(histr, setstr, 1, ':');
499 StrBufAppendBuf(histr, lostr, 0);
502 if (!strcmp(ChrPtr(histr), "*")) {
509 for (i = 0; i < num_msgs; ++i) {
510 if ((msglist[i] >= lo) && (msglist[i] <= hi)) {
519 // Now translate the array of booleans back into a sequence set
525 for (i=0; i<num_msgs; ++i) {
529 for (k=0; k<num_target_msgnums; ++k) {
530 if (msglist[i] == target_msgnums[k]) {
531 is_seen = target_setting;
535 if ((was_seen == 0) && (is_seen == 1)) {
538 else if ((was_seen == 1) && (is_seen == 0)) {
541 if (StrLength(vset) > 0) {
542 StrBufAppendBufPlain(vset, HKEY(","), 0);
545 StrBufAppendPrintf(vset, "%ld", hi);
548 StrBufAppendPrintf(vset, "%ld:%ld", lo, hi);
552 if ((is_seen) && (i == num_msgs - 1)) {
553 if (StrLength(vset) > 0) {
554 StrBufAppendBufPlain(vset, HKEY(","), 0);
556 if ((i==0) || (was_seen == 0)) {
557 StrBufAppendPrintf(vset, "%ld", msglist[i]);
560 StrBufAppendPrintf(vset, "%ld:%ld", lo, msglist[i]);
567 // We will have to stuff this string back into a 4096 byte buffer, so if it's
568 // larger than that now, truncate it by removing tokens from the beginning.
569 // The limit of 100 iterations is there to prevent an infinite loop in case
570 // something unexpected happens.
571 int number_of_truncations = 0;
572 while ( (StrLength(vset) > SIZ) && (number_of_truncations < 100) ) {
573 StrBufRemove_token(vset, 0, ',');
574 ++number_of_truncations;
577 // If we're truncating the sequence set of messages marked with the 'seen' flag,
578 // we want the earliest messages (the truncated ones) to be marked, not unmarked.
579 // Otherwise messages at the beginning will suddenly appear to be 'unseen'.
580 if ( (which_set == ctdlsetseen_seen) && (number_of_truncations > 0) ) {
582 first_tok = NewStrBuf();
583 StrBufExtract_token(first_tok, vset, 0, ',');
584 StrBufRemove_token(vset, 0, ',');
586 if (StrBufNum_tokens(first_tok, ':') > 1) {
587 StrBufRemove_token(first_tok, 0, ':');
591 new_set = NewStrBuf();
592 StrBufAppendBufPlain(new_set, HKEY("1:"), 0);
593 StrBufAppendBuf(new_set, first_tok, 0);
594 StrBufAppendBufPlain(new_set, HKEY(":"), 0);
595 StrBufAppendBuf(new_set, vset, 0);
598 FreeStrBuf(&first_tok);
602 // Decide which message set we're manipulating. Zero the buffers so they compress well.
604 case ctdlsetseen_seen:
605 memset(vbuf.v_seen, 0, sizeof vbuf.v_seen);
606 safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen);
608 case ctdlsetseen_answered:
609 memset(vbuf.v_answered, 0, sizeof vbuf.v_seen);
610 safestrncpy(vbuf.v_answered, ChrPtr(vset), sizeof vbuf.v_answered);
616 CtdlSetRelationship(&vbuf, which_user, which_room);
621 // API function to perform an operation for each qualifying message in the
622 // current room. (Returns the number of messages processed.)
623 int CtdlForEachMessage(int mode, long ref, char *search_string,
625 struct CtdlMessage *compare,
626 ForEachMsgCallback CallBack,
631 struct cdbdata *cdbfr;
632 long *msglist = NULL;
634 int num_processed = 0;
637 struct CtdlMessage *msg = NULL;
640 int printed_lastold = 0;
641 int num_search_msgs = 0;
642 long *search_msgs = NULL;
644 int need_to_free_re = 0;
647 if ((content_type) && (!IsEmptyStr(content_type))) {
648 regcomp(&re, content_type, 0);
652 // Learn about the user and room in question
653 if (server_shutting_down) {
654 if (need_to_free_re) regfree(&re);
657 CtdlGetUser(&CC->user, CC->curr_user);
659 if (server_shutting_down) {
660 if (need_to_free_re) regfree(&re);
663 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
665 if (server_shutting_down) {
666 if (need_to_free_re) regfree(&re);
670 // Load the message list
671 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
673 if (need_to_free_re) regfree(&re);
674 return 0; // No messages at all? No further action.
677 msglist = (long *) cdbfr->ptr;
678 num_msgs = cdbfr->len / sizeof(long);
680 cdbfr->ptr = NULL; // clear this so that cdb_free() doesn't free it
681 cdb_free(cdbfr); // we own this memory now
684 * Now begin the traversal.
686 if (num_msgs > 0) for (a = 0; a < num_msgs; ++a) {
688 /* If the caller is looking for a specific MIME type, filter
689 * out all messages which are not of the type requested.
691 if ((content_type != NULL) && (!IsEmptyStr(content_type))) {
693 /* This call to GetMetaData() sits inside this loop
694 * so that we only do the extra database read per msg
695 * if we need to. Doing the extra read all the time
696 * really kills the server. If we ever need to use
697 * metadata for another search criterion, we need to
698 * move the read somewhere else -- but still be smart
699 * enough to only do the read if the caller has
700 * specified something that will need it.
702 if (server_shutting_down) {
703 if (need_to_free_re) regfree(&re);
707 GetMetaData(&smi, msglist[a]);
709 /* if (strcasecmp(smi.meta_content_type, content_type)) { old non-regex way */
710 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) != 0) {
716 num_msgs = sort_msglist(msglist, num_msgs);
718 /* If a template was supplied, filter out the messages which
719 * don't match. (This could induce some delays!)
722 if (compare != NULL) {
723 for (a = 0; a < num_msgs; ++a) {
724 if (server_shutting_down) {
725 if (need_to_free_re) regfree(&re);
729 msg = CtdlFetchMessage(msglist[a], 1);
731 if (CtdlMsgCmp(msg, compare)) {
740 /* If a search string was specified, get a message list from
741 * the full text index and remove messages which aren't on both
745 * Since the lists are sorted and strictly ascending, and the
746 * output list is guaranteed to be shorter than or equal to the
747 * input list, we overwrite the bottom of the input list. This
748 * eliminates the need to memmove big chunks of the list over and
751 if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
753 /* Call search module via hook mechanism.
754 * NULL means use any search function available.
755 * otherwise replace with a char * to name of search routine
757 CtdlModuleDoSearch(&num_search_msgs, &search_msgs, search_string, "fulltext");
759 if (num_search_msgs > 0) {
763 orig_num_msgs = num_msgs;
765 for (i=0; i<orig_num_msgs; ++i) {
766 for (j=0; j<num_search_msgs; ++j) {
767 if (msglist[i] == search_msgs[j]) {
768 msglist[num_msgs++] = msglist[i];
774 num_msgs = 0; /* No messages qualify */
776 if (search_msgs != NULL) free(search_msgs);
778 /* Now that we've purged messages which don't contain the search
779 * string, treat a MSGS_SEARCH just like a MSGS_ALL from this
786 * Now iterate through the message list, according to the
787 * criteria supplied by the caller.
790 for (a = 0; a < num_msgs; ++a) {
791 if (server_shutting_down) {
792 if (need_to_free_re) regfree(&re);
794 return num_processed;
796 thismsg = msglist[a];
797 if (mode == MSGS_ALL) {
801 is_seen = is_msg_in_sequence_set(vbuf.v_seen, thismsg);
802 if (is_seen) lastold = thismsg;
808 || ((mode == MSGS_OLD) && (is_seen))
809 || ((mode == MSGS_NEW) && (!is_seen))
810 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
811 || ((mode == MSGS_FIRST) && (a < ref))
812 || ((mode == MSGS_GT) && (thismsg > ref))
813 || ((mode == MSGS_LT) && (thismsg < ref))
814 || ((mode == MSGS_EQ) && (thismsg == ref))
817 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
819 CallBack(lastold, userdata);
825 CallBack(thismsg, userdata);
830 if (need_to_free_re) regfree(&re);
833 * We cache the most recent msglist in order to do security checks later
835 if (CC->client_socket > 0) {
836 if (CC->cached_msglist != NULL) {
837 free(CC->cached_msglist);
839 CC->cached_msglist = msglist;
840 CC->cached_num_msgs = num_msgs;
846 return num_processed;
851 * memfmout() - Citadel text formatter and paginator.
852 * Although the original purpose of this routine was to format
853 * text to the reader's screen width, all we're really using it
854 * for here is to format text out to 80 columns before sending it
855 * to the client. The client software may reformat it again.
858 char *mptr, /* where are we going to get our text from? */
859 const char *nl /* string to terminate lines with */
862 unsigned char ch = 0;
869 while (ch=*(mptr++), ch != 0) {
872 if (client_write(outbuf, len) == -1) {
873 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
877 if (client_write(nl, nllen) == -1) {
878 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
883 else if (ch == '\r') {
884 /* Ignore carriage returns. Newlines are always LF or CRLF but never CR. */
886 else if (isspace(ch)) {
887 if (column > 72) { /* Beyond 72 columns, break on the next space */
888 if (client_write(outbuf, len) == -1) {
889 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
893 if (client_write(nl, nllen) == -1) {
894 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
907 if (column > 1000) { /* Beyond 1000 columns, break anywhere */
908 if (client_write(outbuf, len) == -1) {
909 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
913 if (client_write(nl, nllen) == -1) {
914 syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
922 if (client_write(outbuf, len) == -1) {
923 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
926 client_write(nl, nllen);
933 * Callback function for mime parser that simply lists the part
935 void list_this_part(char *name, char *filename, char *partnum, char *disp,
936 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
937 char *cbid, void *cbuserdata)
941 ma = (struct ma_info *)cbuserdata;
942 if (ma->is_ma == 0) {
943 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
957 * Callback function for multipart prefix
959 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
960 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
961 char *cbid, void *cbuserdata)
965 ma = (struct ma_info *)cbuserdata;
966 if (!strcasecmp(cbtype, "multipart/alternative")) {
970 if (ma->is_ma == 0) {
971 cprintf("pref=%s|%s\n", partnum, cbtype);
977 * Callback function for multipart sufffix
979 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
980 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
981 char *cbid, void *cbuserdata)
985 ma = (struct ma_info *)cbuserdata;
986 if (ma->is_ma == 0) {
987 cprintf("suff=%s|%s\n", partnum, cbtype);
989 if (!strcasecmp(cbtype, "multipart/alternative")) {
996 * Callback function for mime parser that opens a section for downloading
997 * we use serv_files function here:
999 extern void OpenCmdResult(char *filename, const char *mime_type);
1000 void mime_download(char *name, char *filename, char *partnum, char *disp,
1001 void *content, char *cbtype, char *cbcharset, size_t length,
1002 char *encoding, char *cbid, void *cbuserdata)
1006 /* Silently go away if there's already a download open. */
1007 if (CC->download_fp != NULL)
1011 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1012 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1014 CC->download_fp = tmpfile();
1015 if (CC->download_fp == NULL) {
1016 syslog(LOG_ERR, "msgbase: mime_download() couldn't write: %m");
1017 cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
1021 rv = fwrite(content, length, 1, CC->download_fp);
1023 syslog(LOG_ERR, "msgbase: mime_download() Couldn't write: %m");
1024 cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
1025 fclose(CC->download_fp);
1026 CC->download_fp = NULL;
1029 fflush(CC->download_fp);
1030 rewind(CC->download_fp);
1032 OpenCmdResult(filename, cbtype);
1038 * Callback function for mime parser that outputs a section all at once.
1039 * We can specify the desired section by part number *or* content-id.
1041 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
1042 void *content, char *cbtype, char *cbcharset, size_t length,
1043 char *encoding, char *cbid, void *cbuserdata)
1045 int *found_it = (int *)cbuserdata;
1048 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1049 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1052 cprintf("%d %d|-1|%s|%s|%s\n",
1059 client_write(content, length);
1064 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length) {
1065 struct CtdlMessage *ret = NULL;
1067 const char *upper_bound;
1069 cit_uint8_t field_header;
1073 upper_bound = Buffer + Length;
1078 // Parse the three bytes that begin EVERY message on disk.
1079 // The first is always 0xFF, the on-disk magic number.
1080 // The second is the anonymous/public type byte.
1081 // The third is the format type byte (vari, fixed, or MIME).
1085 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1088 ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1089 memset(ret, 0, sizeof(struct CtdlMessage));
1091 ret->cm_magic = CTDLMESSAGE_MAGIC;
1092 ret->cm_anon_type = *mptr++; // Anon type byte
1093 ret->cm_format_type = *mptr++; // Format type byte
1095 // The rest is zero or more arbitrary fields. Load them in.
1096 // We're done when we encounter either a zero-length field or
1097 // have just processed the 'M' (message text) field.
1100 field_header = '\0';
1103 while (field_header == '\0') { // work around possibly buggy messages
1104 if (mptr >= upper_bound) {
1107 field_header = *mptr++;
1109 if (mptr >= upper_bound) {
1112 which = field_header;
1115 CM_SetField(ret, which, mptr, len);
1117 mptr += len + 1; // advance to next field
1119 } while ((mptr < upper_bound) && (field_header != 'M'));
1124 // Load a message from disk into memory.
1125 // This is used by CtdlOutputMsg() and other fetch functions.
1127 // NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1128 // using the CM_Free(); function.
1130 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) {
1131 struct cdbdata *dmsgtext;
1132 struct CtdlMessage *ret = NULL;
1134 syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1135 dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1136 if (dmsgtext == NULL) {
1137 syslog(LOG_ERR, "msgbase: message #%ld was not found", msgnum);
1141 if (dmsgtext->ptr[dmsgtext->len - 1] != '\0') {
1142 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1143 dmsgtext->ptr[dmsgtext->len - 1] = '\0';
1146 ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext->ptr, dmsgtext->len);
1154 // Always make sure there's something in the msg text field. If
1155 // it's NULL, the message text is most likely stored separately,
1156 // so go ahead and fetch that. Failing that, just set a dummy
1157 // body so other code doesn't barf.
1159 if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) {
1160 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1161 if (dmsgtext != NULL) {
1162 CM_SetAsField(ret, eMesageText, &dmsgtext->ptr, dmsgtext->len - 1);
1166 if (CM_IsEmpty(ret, eMesageText)) {
1167 CM_SetField(ret, eMesageText, HKEY("\r\n\r\n (no text)\r\n"));
1174 // Pre callback function for multipart/alternative
1176 // NOTE: this differs from the standard behavior for a reason. Normally when
1177 // displaying multipart/alternative you want to show the _last_ usable
1178 // format in the message. Here we show the _first_ one, because it's
1179 // usually text/plain. Since this set of functions is designed for text
1180 // output to non-MIME-aware clients, this is the desired behavior.
1182 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1183 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1184 char *cbid, void *cbuserdata)
1188 ma = (struct ma_info *)cbuserdata;
1189 syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);
1190 if (!strcasecmp(cbtype, "multipart/alternative")) {
1194 if (!strcasecmp(cbtype, "message/rfc822")) {
1201 // Post callback function for multipart/alternative
1203 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1204 void *content, char *cbtype, char *cbcharset, size_t length,
1205 char *encoding, char *cbid, void *cbuserdata)
1209 ma = (struct ma_info *)cbuserdata;
1210 syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);
1211 if (!strcasecmp(cbtype, "multipart/alternative")) {
1215 if (!strcasecmp(cbtype, "message/rfc822")) {
1221 // Inline callback function for mime parser that wants to display text
1222 void fixed_output(char *name, char *filename, char *partnum, char *disp,
1223 void *content, char *cbtype, char *cbcharset, size_t length,
1224 char *encoding, char *cbid, void *cbuserdata)
1231 ma = (struct ma_info *)cbuserdata;
1234 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1235 partnum, filename, cbtype, (long)length
1238 // If we're in the middle of a multipart/alternative scope and
1239 // we've already printed another section, skip this one.
1240 if ( (ma->is_ma) && (ma->did_print) ) {
1241 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1246 if ( (!strcasecmp(cbtype, "text/plain"))
1247 || (IsEmptyStr(cbtype)) ) {
1250 client_write(wptr, length);
1251 if (wptr[length-1] != '\n') {
1258 if (!strcasecmp(cbtype, "text/html")) {
1259 ptr = html_to_ascii(content, length, 80, 0);
1261 client_write(ptr, wlen);
1262 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1269 if (ma->use_fo_hooks) {
1270 if (PerformFixedOutputHooks(cbtype, content, length)) { // returns nonzero if it handled the part
1275 if (strncasecmp(cbtype, "multipart/", 10)) {
1276 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1277 partnum, filename, cbtype, (long)length);
1283 // The client is elegant and sophisticated and wants to be choosy about
1284 // MIME content types, so figure out which multipart/alternative part
1285 // we're going to send.
1287 // We use a system of weights. When we find a part that matches one of the
1288 // MIME types we've declared as preferential, we can store it in ma->chosen_part
1289 // and then set ma->chosen_pref to that MIME type's position in our preference
1290 // list. If we then hit another match, we only replace the first match if
1291 // the preference value is lower.
1292 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1293 void *content, char *cbtype, char *cbcharset, size_t length,
1294 char *encoding, char *cbid, void *cbuserdata)
1300 ma = (struct ma_info *)cbuserdata;
1302 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1303 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1304 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1305 if (i < ma->chosen_pref) {
1306 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1307 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1308 ma->chosen_pref = i;
1315 // Now that we've chosen our preferred part, output it.
1316 void output_preferred(char *name,
1330 int add_newline = 0;
1333 char *decoded = NULL;
1334 size_t bytes_decoded;
1337 ma = (struct ma_info *)cbuserdata;
1339 // This is not the MIME part you're looking for...
1340 if (strcasecmp(partnum, ma->chosen_part)) return;
1342 // If the content-type of this part is in our preferred formats
1343 // list, we can simply output it verbatim.
1344 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1345 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1346 if (!strcasecmp(buf, cbtype)) {
1347 /* Yeah! Go! W00t!! */
1348 if (ma->dont_decode == 0)
1349 rc = mime_decode_now (content,
1355 break; // Give us the chance, maybe theres another one.
1357 if (rc == 0) text_content = (char *)content;
1359 text_content = decoded;
1360 length = bytes_decoded;
1363 if (text_content[length-1] != '\n') {
1366 cprintf("Content-type: %s", cbtype);
1367 if (!IsEmptyStr(cbcharset)) {
1368 cprintf("; charset=%s", cbcharset);
1370 cprintf("\nContent-length: %d\n",
1371 (int)(length + add_newline) );
1372 if (!IsEmptyStr(encoding)) {
1373 cprintf("Content-transfer-encoding: %s\n", encoding);
1376 cprintf("Content-transfer-encoding: 7bit\n");
1378 cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1380 if (client_write(text_content, length) == -1)
1382 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1385 if (add_newline) cprintf("\n");
1386 if (decoded != NULL) free(decoded);
1391 // No translations required or possible: output as text/plain
1392 cprintf("Content-type: text/plain\n\n");
1394 if (ma->dont_decode == 0)
1395 rc = mime_decode_now (content,
1401 return; // Give us the chance, maybe theres another one.
1403 if (rc == 0) text_content = (char *)content;
1405 text_content = decoded;
1406 length = bytes_decoded;
1409 fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, length, encoding, cbid, cbuserdata);
1410 if (decoded != NULL) free(decoded);
1415 char desired_section[64];
1421 // Callback function
1422 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1423 void *content, char *cbtype, char *cbcharset, size_t length,
1424 char *encoding, char *cbid, void *cbuserdata)
1426 struct encapmsg *encap;
1428 encap = (struct encapmsg *)cbuserdata;
1430 // Only proceed if this is the desired section...
1431 if (!strcasecmp(encap->desired_section, partnum)) {
1432 encap->msglen = length;
1433 encap->msg = malloc(length + 2);
1434 memcpy(encap->msg, content, length);
1440 // Determine whether the specified message exists in the cached_msglist
1441 // (This is a security check)
1442 int check_cached_msglist(long msgnum) {
1444 // cases in which we skip the check
1445 if (!CC) return om_ok; // not a session
1446 if (CC->client_socket <= 0) return om_ok; // not a client session
1447 if (CC->cached_msglist == NULL) return om_access_denied; // no msglist fetched
1448 if (CC->cached_num_msgs == 0) return om_access_denied; // nothing to check
1450 // Do a binary search within the cached_msglist for the requested msgnum
1452 int max = (CC->cached_num_msgs - 1);
1454 while (max >= min) {
1455 int middle = min + (max-min) / 2 ;
1456 if (msgnum == CC->cached_msglist[middle]) {
1459 if (msgnum > CC->cached_msglist[middle]) {
1467 return om_access_denied;
1471 // Get a message off disk. (returns om_* values found in msgbase.h)
1472 int CtdlOutputMsg(long msg_num, // message number (local) to fetch
1473 int mode, // how would you like that message?
1474 int headers_only, // eschew the message body?
1475 int do_proto, // do Citadel protocol responses?
1476 int crlf, // Use CRLF newlines instead of LF?
1477 char *section, // NULL or a message/rfc822 section
1478 int flags, // various flags; see msgbase.h
1483 struct CtdlMessage *TheMessage = NULL;
1484 int retcode = CIT_OK;
1485 struct encapmsg encap;
1488 syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)",
1490 (section ? section : "<>")
1493 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1496 if (r == om_not_logged_in) {
1497 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1500 cprintf("%d An unknown error has occurred.\n", ERROR);
1507 * Check to make sure the message is actually IN this room
1509 r = check_cached_msglist(msg_num);
1510 if (r == om_access_denied) {
1511 /* Not in the cache? We get ONE shot to check it again. */
1512 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1513 r = check_cached_msglist(msg_num);
1516 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s",
1517 msg_num, CC->room.QRname
1520 if (r == om_access_denied) {
1521 cprintf("%d message %ld was not found in this room\n",
1522 ERROR + HIGHER_ACCESS_REQUIRED,
1531 * Fetch the message from disk. If we're in HEADERS_FAST mode,
1532 * request that we don't even bother loading the body into memory.
1534 if (headers_only == HEADERS_FAST) {
1535 TheMessage = CtdlFetchMessage(msg_num, 0);
1538 TheMessage = CtdlFetchMessage(msg_num, 1);
1541 if (TheMessage == NULL) {
1542 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n",
1543 ERROR + MESSAGE_NOT_FOUND, msg_num);
1544 return(om_no_such_msg);
1547 /* Here is the weird form of this command, to process only an
1548 * encapsulated message/rfc822 section.
1550 if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1551 memset(&encap, 0, sizeof encap);
1552 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1553 mime_parser(CM_RANGE(TheMessage, eMesageText),
1554 *extract_encapsulated_message,
1555 NULL, NULL, (void *)&encap, 0
1558 if ((Author != NULL) && (*Author == NULL))
1561 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1563 if ((Address != NULL) && (*Address == NULL))
1566 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1568 if ((MessageID != NULL) && (*MessageID == NULL))
1571 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1573 CM_Free(TheMessage);
1577 encap.msg[encap.msglen] = 0;
1578 TheMessage = convert_internet_message(encap.msg);
1579 encap.msg = NULL; /* no free() here, TheMessage owns it now */
1581 /* Now we let it fall through to the bottom of this
1582 * function, because TheMessage now contains the
1583 * encapsulated message instead of the top-level
1584 * message. Isn't that neat?
1589 cprintf("%d msg %ld has no part %s\n",
1590 ERROR + MESSAGE_NOT_FOUND,
1594 retcode = om_no_such_msg;
1599 /* Ok, output the message now */
1600 if (retcode == CIT_OK)
1601 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1602 if ((Author != NULL) && (*Author == NULL))
1605 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1607 if ((Address != NULL) && (*Address == NULL))
1610 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1612 if ((MessageID != NULL) && (*MessageID == NULL))
1615 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1618 CM_Free(TheMessage);
1624 void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) {
1627 char display_name[256];
1629 /* begin header processing loop for Citadel message format */
1630 safestrncpy(display_name, "<unknown>", sizeof display_name);
1631 if (!CM_IsEmpty(TheMessage, eAuthor)) {
1632 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1633 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1634 safestrncpy(display_name, "****", sizeof display_name);
1636 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1637 safestrncpy(display_name, "anonymous", sizeof display_name);
1640 safestrncpy(display_name, buf, sizeof display_name);
1642 if ((is_room_aide())
1643 && ((TheMessage->cm_anon_type == MES_ANONONLY)
1644 || (TheMessage->cm_anon_type == MES_ANONOPT))) {
1645 size_t tmp = strlen(display_name);
1646 snprintf(&display_name[tmp],
1647 sizeof display_name - tmp,
1652 /* Now spew the header fields in the order we like them. */
1653 for (i=0; i< NDiskFields; ++i) {
1655 Field = FieldOrder[i];
1656 if (Field != eMesageText) {
1657 if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) {
1658 if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) {
1659 sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1661 if (Field == eAuthor) {
1663 cprintf("%s=%s\n", msgkeys[Field], display_name);
1666 /* Masquerade display name if needed */
1669 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1672 /* Give the client a hint about whether the message originated locally */
1673 if (Field == erFc822Addr) {
1674 if (IsDirectory(TheMessage->cm_fields[Field] ,0)) {
1675 cprintf("locl=yes\n"); // message originated locally.
1687 void OutputRFC822MsgHeaders(
1688 struct CtdlMessage *TheMessage,
1689 int flags, /* should the message be exported clean */
1690 const char *nl, int nlen,
1691 char *mid, long sizeof_mid,
1692 char *suser, long sizeof_suser,
1693 char *luser, long sizeof_luser,
1694 char *fuser, long sizeof_fuser,
1695 char *snode, long sizeof_snode)
1697 char datestamp[100];
1698 int subject_found = 0;
1705 for (i = 0; i < NDiskFields; ++i) {
1706 if (TheMessage->cm_fields[FieldOrder[i]]) {
1707 mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1708 switch (FieldOrder[i]) {
1710 safestrncpy(luser, mptr, sizeof_luser);
1711 safestrncpy(suser, mptr, sizeof_suser);
1714 if ((flags & QP_EADDR) != 0) {
1715 mptr = qp_encode_email_addrs(mptr);
1717 sanitize_truncated_recipient(mptr);
1718 cprintf("CC: %s%s", mptr, nl);
1721 cprintf("Return-Path: %s%s", mptr, nl);
1724 cprintf("List-ID: %s%s", mptr, nl);
1727 if ((flags & QP_EADDR) != 0)
1728 mptr = qp_encode_email_addrs(mptr);
1730 while ((*hptr != '\0') && isspace(*hptr))
1732 if (!IsEmptyStr(hptr))
1733 cprintf("Envelope-To: %s%s", hptr, nl);
1736 cprintf("Subject: %s%s", mptr, nl);
1740 safestrncpy(mid, mptr, sizeof_mid);
1743 safestrncpy(fuser, mptr, sizeof_fuser);
1746 if (haschar(mptr, '@') == 0) {
1747 sanitize_truncated_recipient(mptr);
1748 cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1752 if ((flags & QP_EADDR) != 0) {
1753 mptr = qp_encode_email_addrs(mptr);
1755 sanitize_truncated_recipient(mptr);
1756 cprintf("To: %s", mptr);
1761 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1762 cprintf("Date: %s%s", datestamp, nl);
1765 cprintf("References: ");
1766 k = num_tokens(mptr, '|');
1767 for (j=0; j<k; ++j) {
1768 extract_token(buf, mptr, j, '|', sizeof buf);
1769 cprintf("<%s>", buf);
1780 while ((*hptr != '\0') && isspace(*hptr))
1782 if (!IsEmptyStr(hptr))
1783 cprintf("Reply-To: %s%s", mptr, nl);
1795 /* these don't map to mime message headers. */
1798 if (mptr != mpptr) {
1803 if (subject_found == 0) {
1804 cprintf("Subject: (no subject)%s", nl);
1809 void Dump_RFC822HeadersBody(
1810 struct CtdlMessage *TheMessage,
1811 int headers_only, /* eschew the message body? */
1812 int flags, /* should the bessage be exported clean? */
1813 const char *nl, int nlen)
1815 cit_uint8_t prev_ch;
1817 const char *StartOfText = StrBufNOTNULL;
1820 int nllen = strlen(nl);
1824 mptr = TheMessage->cm_fields[eMesageText];
1827 while (*mptr != '\0') {
1828 if (*mptr == '\r') {
1835 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1837 eoh = *(mptr+1) == '\n';
1841 StartOfText = strchr(StartOfText, '\n');
1842 StartOfText = strchr(StartOfText, '\n');
1845 if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1846 ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1847 ((headers_only != HEADERS_NONE) &&
1848 (headers_only != HEADERS_ONLY))
1850 if (*mptr == '\n') {
1851 memcpy(&outbuf[outlen], nl, nllen);
1853 outbuf[outlen] = '\0';
1856 outbuf[outlen++] = *mptr;
1860 if (flags & ESC_DOT) {
1861 if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1862 outbuf[outlen++] = '.';
1867 if (outlen > 1000) {
1868 if (client_write(outbuf, outlen) == -1) {
1869 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1872 lfSent = (outbuf[outlen - 1] == '\n');
1877 client_write(outbuf, outlen);
1878 lfSent = (outbuf[outlen - 1] == '\n');
1881 client_write(nl, nlen);
1885 /* If the format type on disk is 1 (fixed-format), then we want
1886 * everything to be output completely literally ... regardless of
1887 * what message transfer format is in use.
1889 void DumpFormatFixed(
1890 struct CtdlMessage *TheMessage,
1891 int mode, /* how would you like that message? */
1892 const char *nl, int nllen)
1900 mptr = TheMessage->cm_fields[eMesageText];
1902 if (mode == MT_MIME) {
1903 cprintf("Content-type: text/plain\n\n");
1907 while (ch = *mptr++, ch > 0) {
1911 if ((buflen > 250) && (!xlline)){
1915 while ((buflen > 0) &&
1916 (!isspace(buf[buflen])))
1922 mptr -= tbuflen - buflen;
1928 /* if we reach the outer bounds of our buffer, abort without respect for what we purge. */
1929 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1934 memcpy (&buf[buflen], nl, nllen);
1938 if (client_write(buf, buflen) == -1) {
1939 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
1951 if (!IsEmptyStr(buf)) {
1952 cprintf("%s%s", buf, nl);
1958 * Get a message off disk. (returns om_* values found in msgbase.h)
1960 int CtdlOutputPreLoadedMsg(
1961 struct CtdlMessage *TheMessage,
1962 int mode, /* how would you like that message? */
1963 int headers_only, /* eschew the message body? */
1964 int do_proto, /* do Citadel protocol responses? */
1965 int crlf, /* Use CRLF newlines instead of LF? */
1966 int flags /* should the bessage be exported clean? */
1969 const char *nl; /* newline string */
1973 /* Buffers needed for RFC822 translation. These are all filled
1974 * using functions that are bounds-checked, and therefore we can
1975 * make them substantially smaller than SIZ.
1983 syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
1984 ((TheMessage == NULL) ? "NULL" : "not null"),
1985 mode, headers_only, do_proto, crlf
1988 strcpy(mid, "unknown");
1989 nl = (crlf ? "\r\n" : "\n");
1990 nlen = crlf ? 2 : 1;
1992 if (!CM_IsValidMsg(TheMessage)) {
1993 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
1994 return(om_no_such_msg);
1997 /* Suppress envelope recipients if required to avoid disclosing BCC addresses.
1998 * Pad it with spaces in order to avoid changing the RFC822 length of the message.
2000 if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
2001 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
2004 /* Are we downloading a MIME component? */
2005 if (mode == MT_DOWNLOAD) {
2006 if (TheMessage->cm_format_type != FMT_RFC822) {
2008 cprintf("%d This is not a MIME message.\n",
2009 ERROR + ILLEGAL_VALUE);
2010 } else if (CC->download_fp != NULL) {
2011 if (do_proto) cprintf(
2012 "%d You already have a download open.\n",
2013 ERROR + RESOURCE_BUSY);
2015 /* Parse the message text component */
2016 mime_parser(CM_RANGE(TheMessage, eMesageText),
2017 *mime_download, NULL, NULL, NULL, 0);
2018 /* If there's no file open by this time, the requested
2019 * section wasn't found, so print an error
2021 if (CC->download_fp == NULL) {
2022 if (do_proto) cprintf(
2023 "%d Section %s not found.\n",
2024 ERROR + FILE_NOT_FOUND,
2025 CC->download_desired_section);
2028 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2031 // MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
2032 // in a single server operation instead of opening a download file.
2033 if (mode == MT_SPEW_SECTION) {
2034 if (TheMessage->cm_format_type != FMT_RFC822) {
2036 cprintf("%d This is not a MIME message.\n",
2037 ERROR + ILLEGAL_VALUE);
2040 // Locate and parse the component specified by the caller
2042 mime_parser(CM_RANGE(TheMessage, eMesageText), *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
2044 // If section wasn't found, print an error
2047 cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
2051 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2054 // now for the user-mode message reading loops
2055 if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
2057 // Does the caller want to skip the headers?
2058 if (headers_only == HEADERS_NONE) goto START_TEXT;
2060 // Tell the client which format type we're using.
2061 if ( (mode == MT_CITADEL) && (do_proto) ) {
2062 cprintf("type=%d\n", TheMessage->cm_format_type); // Tell the client which format type we're using.
2065 // nhdr=yes means that we're only displaying headers, no body
2066 if ( (TheMessage->cm_anon_type == MES_ANONONLY)
2067 && ((mode == MT_CITADEL) || (mode == MT_MIME))
2070 cprintf("nhdr=yes\n");
2073 if ((mode == MT_CITADEL) || (mode == MT_MIME)) {
2074 OutputCtdlMsgHeaders(TheMessage, do_proto);
2077 // begin header processing loop for RFC822 transfer format
2082 if (mode == MT_RFC822)
2083 OutputRFC822MsgHeaders(
2088 suser, sizeof(suser),
2089 luser, sizeof(luser),
2090 fuser, sizeof(fuser),
2091 snode, sizeof(snode)
2095 for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2096 suser[i] = tolower(suser[i]);
2097 if (!isalnum(suser[i])) suser[i]='_';
2100 if (mode == MT_RFC822) {
2101 /* Construct a fun message id */
2102 cprintf("Message-ID: <%s", mid);
2103 if (strchr(mid, '@')==NULL) {
2104 cprintf("@%s", snode);
2108 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2109 cprintf("From: \"----\" <x@x.org>%s", nl);
2111 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2112 cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2114 else if (!IsEmptyStr(fuser)) {
2115 cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2118 cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2121 /* Blank line signifying RFC822 end-of-headers */
2122 if (TheMessage->cm_format_type != FMT_RFC822) {
2127 // end header processing loop ... at this point, we're in the text
2129 if (headers_only == HEADERS_FAST) goto DONE;
2131 // Tell the client about the MIME parts in this message
2132 if (TheMessage->cm_format_type == FMT_RFC822) {
2133 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2134 memset(&ma, 0, sizeof(struct ma_info));
2135 mime_parser(CM_RANGE(TheMessage, eMesageText),
2136 (do_proto ? *list_this_part : NULL),
2137 (do_proto ? *list_this_pref : NULL),
2138 (do_proto ? *list_this_suff : NULL),
2141 else if (mode == MT_RFC822) { // unparsed RFC822 dump
2142 Dump_RFC822HeadersBody(
2151 if (headers_only == HEADERS_ONLY) {
2155 // signify start of msg text
2156 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2157 if (do_proto) cprintf("text\n");
2160 if (TheMessage->cm_format_type == FMT_FIXED)
2163 mode, // how would you like that message?
2166 // If the message on disk is format 0 (Citadel vari-format), we
2167 // output using the formatter at 80 columns. This is the final output
2168 // form if the transfer format is RFC822, but if the transfer format
2169 // is Citadel proprietary, it'll still work, because the indentation
2170 // for new paragraphs is correct and the client will reformat the
2171 // message to the reader's screen width.
2173 if (TheMessage->cm_format_type == FMT_CITADEL) {
2174 if (mode == MT_MIME) {
2175 cprintf("Content-type: text/x-citadel-variformat\n\n");
2177 memfmout(TheMessage->cm_fields[eMesageText], nl);
2180 // If the message on disk is format 4 (MIME), we've gotta hand it
2181 // off to the MIME parser. The client has already been told that
2182 // this message is format 1 (fixed format), so the callback function
2183 // we use will display those parts as-is.
2185 if (TheMessage->cm_format_type == FMT_RFC822) {
2186 memset(&ma, 0, sizeof(struct ma_info));
2188 if (mode == MT_MIME) {
2189 ma.use_fo_hooks = 0;
2190 strcpy(ma.chosen_part, "1");
2191 ma.chosen_pref = 9999;
2192 ma.dont_decode = CC->msg4_dont_decode;
2193 mime_parser(CM_RANGE(TheMessage, eMesageText),
2194 *choose_preferred, *fixed_output_pre,
2195 *fixed_output_post, (void *)&ma, 1);
2196 mime_parser(CM_RANGE(TheMessage, eMesageText),
2197 *output_preferred, NULL, NULL, (void *)&ma, 1);
2200 ma.use_fo_hooks = 1;
2201 mime_parser(CM_RANGE(TheMessage, eMesageText),
2202 *fixed_output, *fixed_output_pre,
2203 *fixed_output_post, (void *)&ma, 0);
2208 DONE: /* now we're done */
2209 if (do_proto) cprintf("000\n");
2213 // Save one or more message pointers into a specified room
2214 // (Returns 0 for success, nonzero for failure)
2215 // roomname may be NULL to use the current room
2217 // Note that the 'supplied_msg' field may be set to NULL, in which case
2218 // the message will be fetched from disk, by number, if we need to perform
2219 // replication checks. This adds an additional database read, so if the
2220 // caller already has the message in memory then it should be supplied. (Obviously
2221 // this mode of operation only works if we're saving a single message.)
2223 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2224 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj
2227 char hold_rm[ROOMNAMELEN];
2228 struct cdbdata *cdbfr;
2231 long highest_msg = 0L;
2234 struct CtdlMessage *msg = NULL;
2236 long *msgs_to_be_merged = NULL;
2237 int num_msgs_to_be_merged = 0;
2240 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2241 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2244 strcpy(hold_rm, CC->room.QRname);
2247 if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2248 if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2249 if (num_newmsgs > 1) supplied_msg = NULL;
2251 /* Now the regular stuff */
2252 if (CtdlGetRoomLock(&CC->room,
2253 ((roomname != NULL) ? roomname : CC->room.QRname) )
2255 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2256 return(ERROR + ROOM_NOT_FOUND);
2260 msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2261 num_msgs_to_be_merged = 0;
2264 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
2265 if (cdbfr == NULL) {
2270 msglist = (long *) cdbfr->ptr;
2271 cdbfr->ptr = NULL; // CtdlSaveMsgPointerInRoom() now owns this memory (this needs attention if we move to LMDB)
2272 num_msgs = cdbfr->len / sizeof(long);
2277 /* Create a list of msgid's which were supplied by the caller, but do
2278 * not already exist in the target room. It is absolutely taboo to
2279 * have more than one reference to the same message in a room.
2281 for (i=0; i<num_newmsgs; ++i) {
2283 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2284 if (msglist[j] == newmsgidlist[i]) {
2289 msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2293 syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2296 * Now merge the new messages
2298 msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2299 if (msglist == NULL) {
2300 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2301 free(msgs_to_be_merged);
2302 return (ERROR + INTERNAL_ERROR);
2304 memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2305 num_msgs += num_msgs_to_be_merged;
2307 /* Sort the message list, so all the msgid's are in order */
2308 num_msgs = sort_msglist(msglist, num_msgs);
2310 /* Determine the highest message number */
2311 highest_msg = msglist[num_msgs - 1];
2313 /* Write it back to disk. */
2314 cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long),
2315 msglist, (int)(num_msgs * sizeof(long)));
2317 /* Free up the memory we used. */
2320 /* Update the highest-message pointer and unlock the room. */
2321 CC->room.QRhighest = highest_msg;
2322 CtdlPutRoomLock(&CC->room);
2324 /* Perform replication checks if necessary */
2325 if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2326 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2328 for (i=0; i<num_msgs_to_be_merged; ++i) {
2329 msgid = msgs_to_be_merged[i];
2331 if (supplied_msg != NULL) {
2335 msg = CtdlFetchMessage(msgid, 0);
2339 ReplicationChecks(msg);
2341 /* If the message has an Exclusive ID, index that... */
2342 if (!CM_IsEmpty(msg, eExclusiveID)) {
2343 index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2346 /* Free up the memory we may have allocated */
2347 if (msg != supplied_msg) {
2356 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2359 /* Submit this room for processing by hooks */
2360 int total_roomhook_errors = PerformRoomHooks(&CC->room);
2361 if (total_roomhook_errors) {
2362 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2365 /* Go back to the room we were in before we wandered here... */
2366 CtdlGetRoom(&CC->room, hold_rm);
2368 /* Bump the reference count for all messages which were merged */
2369 if (!suppress_refcount_adj) {
2370 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2373 /* Free up memory... */
2374 if (msgs_to_be_merged != NULL) {
2375 free(msgs_to_be_merged);
2378 /* Return success. */
2384 * This is the same as CtdlSaveMsgPointersInRoom() but it only accepts
2387 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid,
2388 int do_repl_check, struct CtdlMessage *supplied_msg)
2390 return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, supplied_msg, 0);
2395 * Message base operation to save a new message to the message store
2396 * (returns new message number)
2398 * This is the back end for CtdlSubmitMsg() and should not be directly
2399 * called by server-side modules.
2402 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) {
2410 * If the message is big, set its body aside for storage elsewhere
2411 * and we hide the message body from the serializer
2413 if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG) {
2415 holdM = msg->cm_fields[eMesageText];
2416 msg->cm_fields[eMesageText] = NULL;
2417 holdMLen = msg->cm_lengths[eMesageText];
2418 msg->cm_lengths[eMesageText] = 0;
2421 /* Serialize our data structure for storage in the database */
2422 CtdlSerializeMessage(&smr, msg);
2425 /* put the message body back into the message */
2426 msg->cm_fields[eMesageText] = holdM;
2427 msg->cm_lengths[eMesageText] = holdMLen;
2432 cprintf("%d Unable to serialize message\n",
2433 ERROR + INTERNAL_ERROR);
2436 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2442 /* Write our little bundle of joy into the message base */
2443 retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len);
2445 syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval);
2449 retval = cdb_store(CDB_BIGMSGS,
2456 syslog(LOG_ERR, "msgbase: failed to store message body for msgid %ld: %ld", msgid, retval);
2461 /* Free the memory we used for the serialized message */
2468 long send_message(struct CtdlMessage *msg) {
2474 /* Get a new message number */
2475 newmsgid = get_new_message_number();
2477 /* Generate an ID if we don't have one already */
2478 if (CM_IsEmpty(msg, emessageId)) {
2479 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%08lX-%08lX@%s",
2480 (long unsigned int) time(NULL),
2481 (long unsigned int) newmsgid,
2482 CtdlGetConfigStr("c_fqdn")
2485 CM_SetField(msg, emessageId, msgidbuf, msgidbuflen);
2488 retval = CtdlSaveThisMessage(msg, newmsgid, 1);
2494 /* Return the *local* message ID to the caller
2495 * (even if we're storing an incoming network message)
2502 * Serialize a struct CtdlMessage into the format used on disk.
2504 * This function loads up a "struct ser_ret" (defined in server.h) which
2505 * contains the length of the serialized message and a pointer to the
2506 * serialized message in memory. THE LATTER MUST BE FREED BY THE CALLER.
2508 void CtdlSerializeMessage(struct ser_ret *ret, /* return values */
2509 struct CtdlMessage *msg) /* unserialized msg */
2515 * Check for valid message format
2517 if (CM_IsValidMsg(msg) == 0) {
2518 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2525 for (i=0; i < NDiskFields; ++i)
2526 if (msg->cm_fields[FieldOrder[i]] != NULL)
2527 ret->len += msg->cm_lengths[FieldOrder[i]] + 2;
2529 ret->ser = malloc(ret->len);
2530 if (ret->ser == NULL) {
2531 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret->len);
2538 ret->ser[1] = msg->cm_anon_type;
2539 ret->ser[2] = msg->cm_format_type;
2542 for (i=0; i < NDiskFields; ++i) {
2543 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2544 ret->ser[wlen++] = (char)FieldOrder[i];
2546 memcpy(&ret->ser[wlen],
2547 msg->cm_fields[FieldOrder[i]],
2548 msg->cm_lengths[FieldOrder[i]] + 1);
2550 wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2554 if (ret->len != wlen) {
2555 syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen);
2563 * Check to see if any messages already exist in the current room which
2564 * carry the same Exclusive ID as this one. If any are found, delete them.
2566 void ReplicationChecks(struct CtdlMessage *msg) {
2567 long old_msgnum = (-1L);
2569 if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2571 syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2573 /* No exclusive id? Don't do anything. */
2574 if (msg == NULL) return;
2575 if (CM_IsEmpty(msg, eExclusiveID)) return;
2577 /*syslog(LOG_DEBUG, "msgbase: exclusive ID: <%s> for room <%s>",
2578 msg->cm_fields[eExclusiveID], CC->room.QRname);*/
2580 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2581 if (old_msgnum > 0L) {
2582 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2583 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2589 * Save a message to disk and submit it into the delivery system.
2591 long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */
2592 struct recptypes *recps, /* recipients (if mail) */
2593 const char *force /* force a particular room? */
2595 char hold_rm[ROOMNAMELEN];
2596 char actual_rm[ROOMNAMELEN];
2597 char force_room[ROOMNAMELEN];
2598 char content_type[SIZ]; /* We have to learn this */
2599 char recipient[SIZ];
2600 char bounce_to[1024];
2603 const char *mptr = NULL;
2604 struct ctdluser userbuf;
2606 struct MetaData smi;
2607 char *collected_addresses = NULL;
2608 struct addresses_to_be_filed *aptr = NULL;
2609 StrBuf *saved_rfc822_version = NULL;
2610 int qualified_for_journaling = 0;
2612 syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2613 if (CM_IsValidMsg(msg) == 0) return(-1); /* self check */
2615 /* If this message has no timestamp, we take the liberty of
2616 * giving it one, right now.
2618 if (CM_IsEmpty(msg, eTimestamp)) {
2619 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2622 /* If this message has no path, we generate one.
2624 if (CM_IsEmpty(msg, eMessagePath)) {
2625 if (!CM_IsEmpty(msg, eAuthor)) {
2626 CM_CopyField(msg, eMessagePath, eAuthor);
2627 for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2628 if (isspace(msg->cm_fields[eMessagePath][a])) {
2629 msg->cm_fields[eMessagePath][a] = ' ';
2634 CM_SetField(msg, eMessagePath, HKEY("unknown"));
2638 if (force == NULL) {
2639 force_room[0] = '\0';
2642 strcpy(force_room, force);
2645 /* Learn about what's inside, because it's what's inside that counts */
2646 if (CM_IsEmpty(msg, eMesageText)) {
2647 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2651 switch (msg->cm_format_type) {
2653 strcpy(content_type, "text/x-citadel-variformat");
2656 strcpy(content_type, "text/plain");
2659 strcpy(content_type, "text/plain");
2660 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
2663 safestrncpy(content_type, &mptr[13], sizeof content_type);
2664 string_trim(content_type);
2665 aptr = content_type;
2666 while (!IsEmptyStr(aptr)) {
2678 /* Goto the correct room */
2679 room = (recps) ? CC->room.QRname : SENTITEMS;
2680 syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2681 strcpy(hold_rm, CC->room.QRname);
2682 strcpy(actual_rm, CC->room.QRname);
2683 if (recps != NULL) {
2684 strcpy(actual_rm, SENTITEMS);
2687 /* If the user is a twit, move to the twit room for posting */
2689 if (CC->user.axlevel == AxProbU) {
2690 strcpy(hold_rm, actual_rm);
2691 strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2692 syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2696 /* ...or if this message is destined for Aide> then go there. */
2697 if (!IsEmptyStr(force_room)) {
2698 strcpy(actual_rm, force_room);
2701 syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2702 if (strcasecmp(actual_rm, CC->room.QRname)) {
2703 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2707 * If this message has no O (room) field, generate one.
2709 if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2710 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
2713 /* Perform "before save" hooks (aborting if any return nonzero) */
2714 syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2715 if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2718 * If this message has an Exclusive ID, and the room is replication
2719 * checking enabled, then do replication checks.
2721 if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2722 ReplicationChecks(msg);
2725 /* Save it to disk */
2726 syslog(LOG_DEBUG, "msgbase: saving to disk");
2727 newmsgid = send_message(msg);
2728 if (newmsgid <= 0L) return(-5);
2730 /* Write a supplemental message info record. This doesn't have to
2731 * be a critical section because nobody else knows about this message
2734 syslog(LOG_DEBUG, "msgbase: creating metadata record");
2735 memset(&smi, 0, sizeof(struct MetaData));
2736 smi.meta_msgnum = newmsgid;
2737 smi.meta_refcount = 0;
2738 safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type);
2741 * Measure how big this message will be when rendered as RFC822.
2742 * We do this for two reasons:
2743 * 1. We need the RFC822 length for the new metadata record, so the
2744 * POP and IMAP services don't have to calculate message lengths
2745 * while the user is waiting (multiplied by potentially hundreds
2746 * or thousands of messages).
2747 * 2. If journaling is enabled, we will need an RFC822 version of the
2748 * message to attach to the journalized copy.
2750 if (CC->redirect_buffer != NULL) {
2751 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2752 exit(CTDLEXIT_REDIRECT);
2754 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2755 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2756 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2757 saved_rfc822_version = CC->redirect_buffer;
2758 CC->redirect_buffer = NULL;
2762 /* Now figure out where to store the pointers */
2763 syslog(LOG_DEBUG, "msgbase: storing pointers");
2765 /* If this is being done by the networker delivering a private
2766 * message, we want to BYPASS saving the sender's copy (because there
2767 * is no local sender; it would otherwise go to the Trashcan).
2769 if ((!CC->internal_pgm) || (recps == NULL)) {
2770 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2771 syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm);
2772 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2776 /* For internet mail, drop a copy in the outbound queue room */
2777 if ((recps != NULL) && (recps->num_internet > 0)) {
2778 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2781 /* If other rooms are specified, drop them there too. */
2782 if ((recps != NULL) && (recps->num_room > 0)) {
2783 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2784 extract_token(recipient, recps->recp_room, i, '|', sizeof recipient);
2785 syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2786 CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2790 /* Decide where bounces need to be delivered */
2791 if ((recps != NULL) && (recps->bounce_to == NULL)) {
2792 if (CC->logged_in) {
2793 strcpy(bounce_to, CC->user.fullname);
2795 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2796 strcpy(bounce_to, msg->cm_fields[eAuthor]);
2798 recps->bounce_to = bounce_to;
2801 CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2803 // If this is private, local mail, make a copy in the recipient's mailbox and bump the reference count.
2804 if ((recps != NULL) && (recps->num_local > 0)) {
2808 pch = recps->recp_local;
2809 recps->recp_local = recipient;
2810 ntokens = num_tokens(pch, '|');
2811 for (i=0; i<ntokens; ++i) {
2812 extract_token(recipient, pch, i, '|', sizeof recipient);
2813 syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2814 if (CtdlGetUser(&userbuf, recipient) == 0) {
2815 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2816 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2817 CtdlBumpNewMailCounter(userbuf.usernum); // if this user is logged in, tell them they have new mail.
2818 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2821 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2822 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2825 recps->recp_local = pch;
2828 /* Perform "after save" hooks */
2829 syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2831 PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2832 CM_FlushField(msg, eVltMsgNum);
2834 /* Go back to the room we started from */
2835 syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2836 if (strcasecmp(hold_rm, CC->room.QRname)) {
2837 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2841 * Any addresses to harvest for someone's address book?
2843 if ( (CC->logged_in) && (recps != NULL) ) {
2844 collected_addresses = harvest_collected_addresses(msg);
2847 if (collected_addresses != NULL) {
2848 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2849 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2850 aptr->roomname = strdup(actual_rm);
2851 aptr->collected_addresses = collected_addresses;
2852 begin_critical_section(S_ATBF);
2855 end_critical_section(S_ATBF);
2859 * Determine whether this message qualifies for journaling.
2861 if (!CM_IsEmpty(msg, eJournal)) {
2862 qualified_for_journaling = 0;
2865 if (recps == NULL) {
2866 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2868 else if (recps->num_local + recps->num_internet > 0) {
2869 qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2872 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2877 * Do we have to perform journaling? If so, hand off the saved
2878 * RFC822 version will be handed off to the journaler for background
2879 * submit. Otherwise, we have to free the memory ourselves.
2881 if (saved_rfc822_version != NULL) {
2882 if (qualified_for_journaling) {
2883 JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2886 FreeStrBuf(&saved_rfc822_version);
2890 if ((recps != NULL) && (recps->bounce_to == bounce_to))
2891 recps->bounce_to = NULL;
2899 * Convenience function for generating small administrative messages.
2901 long quickie_message(char *from,
2909 struct CtdlMessage *msg;
2910 struct recptypes *recp = NULL;
2912 msg = malloc(sizeof(struct CtdlMessage));
2913 memset(msg, 0, sizeof(struct CtdlMessage));
2914 msg->cm_magic = CTDLMESSAGE_MAGIC;
2915 msg->cm_anon_type = MES_NORMAL;
2916 msg->cm_format_type = format_type;
2918 if (!IsEmptyStr(from)) {
2919 CM_SetField(msg, eAuthor, from, -1);
2921 else if (!IsEmptyStr(fromaddr)) {
2923 CM_SetField(msg, eAuthor, fromaddr, -1);
2924 pAt = strchr(msg->cm_fields[eAuthor], '@');
2926 CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
2930 msg->cm_fields[eAuthor] = strdup("Citadel");
2933 if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr, -1);
2934 if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room, -1);
2935 if (!IsEmptyStr(to)) {
2936 CM_SetField(msg, eRecipient, to, -1);
2937 recp = validate_recipients(to, NULL, 0);
2939 if (!IsEmptyStr(subject)) {
2940 CM_SetField(msg, eMsgSubject, subject, -1);
2942 if (!IsEmptyStr(text)) {
2943 CM_SetField(msg, eMesageText, text, -1);
2946 long msgnum = CtdlSubmitMsg(msg, recp, room);
2948 if (recp != NULL) free_recipients(recp);
2954 * Back end function used by CtdlMakeMessage() and similar functions
2956 StrBuf *CtdlReadMessageBodyBuf(char *terminator, // token signalling EOT
2958 size_t maxlen, // maximum message length
2959 StrBuf *exist, // if non-null, append to it; exist is ALWAYS freed
2960 int crlf // CRLF newlines instead of LF
2968 LineBuf = NewStrBufPlain(NULL, SIZ);
2969 if (exist == NULL) {
2970 Message = NewStrBufPlain(NULL, 4 * SIZ);
2973 Message = NewStrBufDup(exist);
2976 /* Do we need to change leading ".." to "." for SMTP escaping? */
2977 if ((tlen == 1) && (*terminator == '.')) {
2981 /* read in the lines of message text one by one */
2983 if (CtdlClientGetLine(LineBuf) < 0) {
2986 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
2989 if ( (!flushing) && (!finished) ) {
2991 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
2994 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
2997 /* Unescape SMTP-style input of two dots at the beginning of the line */
2998 if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
2999 StrBufCutLeft(LineBuf, 1);
3001 StrBufAppendBuf(Message, LineBuf, 0);
3004 /* if we've hit the max msg length, flush the rest */
3005 if (StrLength(Message) >= maxlen) {
3009 } while (!finished);
3010 FreeStrBuf(&LineBuf);
3013 syslog(LOG_ERR, "msgbase: exceeded maximum message length of %ld - message was truncated", maxlen);
3020 // Back end function used by CtdlMakeMessage() and similar functions
3021 char *CtdlReadMessageBody(char *terminator, // token signalling EOT
3023 size_t maxlen, // maximum message length
3024 StrBuf *exist, // if non-null, append to it; exist is ALWAYS freed
3025 int crlf // CRLF newlines instead of LF
3029 Message = CtdlReadMessageBodyBuf(terminator,
3035 if (Message == NULL) {
3039 return SmashStrBuf(&Message);
3044 struct CtdlMessage *CtdlMakeMessage(
3045 struct ctdluser *author, /* author's user structure */
3046 char *recipient, /* NULL if it's not mail */
3047 char *recp_cc, /* NULL if it's not mail */
3048 char *room, /* room where it's going */
3049 int type, /* see MES_ types in header file */
3050 int format_type, /* variformat, plain text, MIME... */
3051 char *fake_name, /* who we're masquerading as */
3052 char *my_email, /* which of my email addresses to use (empty is ok) */
3053 char *subject, /* Subject (optional) */
3054 char *supplied_euid, /* ...or NULL if this is irrelevant */
3055 char *preformatted_text, /* ...or NULL to read text from client */
3056 char *references /* Thread references */
3058 return CtdlMakeMessageLen(
3059 author, /* author's user structure */
3060 recipient, /* NULL if it's not mail */
3061 (recipient)?strlen(recipient) : 0,
3062 recp_cc, /* NULL if it's not mail */
3063 (recp_cc)?strlen(recp_cc): 0,
3064 room, /* room where it's going */
3065 (room)?strlen(room): 0,
3066 type, /* see MES_ types in header file */
3067 format_type, /* variformat, plain text, MIME... */
3068 fake_name, /* who we're masquerading as */
3069 (fake_name)?strlen(fake_name): 0,
3070 my_email, /* which of my email addresses to use (empty is ok) */
3071 (my_email)?strlen(my_email): 0,
3072 subject, /* Subject (optional) */
3073 (subject)?strlen(subject): 0,
3074 supplied_euid, /* ...or NULL if this is irrelevant */
3075 (supplied_euid)?strlen(supplied_euid):0,
3076 preformatted_text, /* ...or NULL to read text from client */
3077 (preformatted_text)?strlen(preformatted_text) : 0,
3078 references, /* Thread references */
3079 (references)?strlen(references):0);
3085 * Build a binary message to be saved on disk.
3086 * (NOTE: if you supply 'preformatted_text', the buffer you give it
3087 * will become part of the message. This means you are no longer
3088 * responsible for managing that memory -- it will be freed along with
3089 * the rest of the fields when CM_Free() is called.)
3091 struct CtdlMessage *CtdlMakeMessageLen(
3092 struct ctdluser *author, /* author's user structure */
3093 char *recipient, /* NULL if it's not mail */
3095 char *recp_cc, /* NULL if it's not mail */
3097 char *room, /* room where it's going */
3099 int type, /* see MES_ types in header file */
3100 int format_type, /* variformat, plain text, MIME... */
3101 char *fake_name, /* who we're masquerading as */
3103 char *my_email, /* which of my email addresses to use (empty is ok) */
3105 char *subject, /* Subject (optional) */
3107 char *supplied_euid, /* ...or NULL if this is irrelevant */
3109 char *preformatted_text, /* ...or NULL to read text from client */
3111 char *references, /* Thread references */
3116 struct CtdlMessage *msg;
3118 StrBuf *FakeEncAuthor = NULL;
3120 msg = malloc(sizeof(struct CtdlMessage));
3121 memset(msg, 0, sizeof(struct CtdlMessage));
3122 msg->cm_magic = CTDLMESSAGE_MAGIC;
3123 msg->cm_anon_type = type;
3124 msg->cm_format_type = format_type;
3126 if (recipient != NULL) rcplen = string_trim(recipient);
3127 if (recp_cc != NULL) cclen = string_trim(recp_cc);
3129 /* Path or Return-Path */
3131 CM_SetField(msg, eMessagePath, my_email, myelen);
3133 else if (!IsEmptyStr(author->fullname)) {
3134 CM_SetField(msg, eMessagePath, author->fullname, -1);
3136 convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
3138 blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
3139 CM_SetField(msg, eTimestamp, buf, blen);
3142 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
3145 FakeAuthor = NewStrBufPlain (author->fullname, -1);
3147 StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
3148 CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
3149 FreeStrBuf(&FakeAuthor);
3151 if (!!IsEmptyStr(CC->room.QRname)) {
3152 if (CC->room.QRflags & QR_MAILBOX) { /* room */
3153 CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11], -1);
3156 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
3161 CM_SetField(msg, eRecipient, recipient, rcplen);
3164 CM_SetField(msg, eCarbonCopY, recp_cc, cclen);
3168 CM_SetField(msg, erFc822Addr, my_email, myelen);
3170 else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3171 CM_SetField(msg, erFc822Addr, CC->cs_inet_email, -1);
3174 if (subject != NULL) {
3176 length = string_trim(subject);
3182 while ((subject[i] != '\0') &&
3183 (IsAscii = isascii(subject[i]) != 0 ))
3186 CM_SetField(msg, eMsgSubject, subject, subjlen);
3187 else /* ok, we've got utf8 in the string. */
3190 rfc2047Subj = rfc2047encode(subject, length);
3191 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3198 CM_SetField(msg, eExclusiveID, supplied_euid, euidlen);
3202 CM_SetField(msg, eWeferences, references, reflen);
3205 if (preformatted_text != NULL) {
3206 CM_SetField(msg, eMesageText, preformatted_text, textlen);
3210 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3211 if (MsgBody != NULL) {
3212 CM_SetAsFieldSB(msg, eMesageText, &MsgBody);
3221 * API function to delete messages which match a set of criteria
3222 * (returns the actual number of messages deleted)
3224 int CtdlDeleteMessages(const char *room_name, // which room
3225 long *dmsgnums, // array of msg numbers to be deleted
3226 int num_dmsgnums, // number of msgs to be deleted, or 0 for "any"
3227 char *content_type // or "" for any. regular expressions expected.
3229 struct ctdlroom qrbuf;
3230 struct cdbdata *cdbfr;
3231 long *msglist = NULL;
3232 long *dellist = NULL;
3235 int num_deleted = 0;
3237 struct MetaData smi;
3240 int need_to_free_re = 0;
3242 if (content_type) if (!IsEmptyStr(content_type)) {
3243 regcomp(&re, content_type, 0);
3244 need_to_free_re = 1;
3246 syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3248 /* get room record, obtaining a lock... */
3249 if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3250 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3251 if (need_to_free_re) regfree(&re);
3252 return(0); /* room not found */
3254 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
3256 if (cdbfr != NULL) {
3257 dellist = malloc(cdbfr->len);
3258 msglist = (long *) cdbfr->ptr;
3259 cdbfr->ptr = NULL; // CtdlDeleteMessages() now owns this memory (this needs attention if we move to LMDB)
3260 num_msgs = cdbfr->len / sizeof(long);
3264 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3265 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3266 int have_more_del = 1;
3268 num_msgs = sort_msglist(msglist, num_msgs);
3269 if (num_dmsgnums > 1) {
3270 num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3274 while ((i < num_msgs) && (have_more_del)) {
3277 /* Set/clear a bit for each criterion */
3279 /* 0 messages in the list or a null list means that we are
3280 * interested in deleting any messages which meet the other criteria.
3283 delete_this |= 0x01;
3286 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3291 if (msglist[i] == dmsgnums[j]) {
3292 delete_this |= 0x01;
3295 have_more_del = (j < num_dmsgnums);
3298 if (have_contenttype) {
3299 GetMetaData(&smi, msglist[i]);
3300 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3301 delete_this |= 0x02;
3304 delete_this |= 0x02;
3307 /* Delete message only if all bits are set */
3308 if (delete_this == 0x03) {
3309 dellist[num_deleted++] = msglist[i];
3316 StrBuf *dbg = NewStrBuf();
3317 for (i = 0; i < num_deleted; i++)
3318 StrBufAppendPrintf(dbg, ", %ld", dellist[i]);
3319 syslog(LOG_DEBUG, "msgbase: Deleting: %s", ChrPtr(dbg));
3323 num_msgs = sort_msglist(msglist, num_msgs);
3324 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long),
3325 msglist, (int)(num_msgs * sizeof(long)));
3328 qrbuf.QRhighest = msglist[num_msgs - 1];
3330 qrbuf.QRhighest = 0;
3332 CtdlPutRoomLock(&qrbuf);
3334 /* Go through the messages we pulled out of the index, and decrement
3335 * their reference counts by 1. If this is the only room the message
3336 * was in, the reference count will reach zero and the message will
3337 * automatically be deleted from the database. We do this in a
3338 * separate pass because there might be plug-in hooks getting called,
3339 * and we don't want that happening during an S_ROOMS critical
3343 for (i=0; i<num_deleted; ++i) {
3344 PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3346 AdjRefCountList(dellist, num_deleted, -1);
3348 /* Now free the memory we used, and go away. */
3349 if (msglist != NULL) free(msglist);
3350 if (dellist != NULL) free(dellist);
3351 syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3352 if (need_to_free_re) regfree(&re);
3353 return (num_deleted);
3358 * GetMetaData() - Get the supplementary record for a message
3360 void GetMetaData(struct MetaData *smibuf, long msgnum)
3362 struct cdbdata *cdbsmi;
3365 memset(smibuf, 0, sizeof(struct MetaData));
3366 smibuf->meta_msgnum = msgnum;
3367 smibuf->meta_refcount = 1; /* Default reference count is 1 */
3369 /* Use the negative of the message number for its supp record index */
3370 TheIndex = (0L - msgnum);
3372 cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3373 if (cdbsmi == NULL) {
3374 return; /* record not found; leave it alone */
3376 memcpy(smibuf, cdbsmi->ptr,
3377 ((cdbsmi->len > sizeof(struct MetaData)) ?
3378 sizeof(struct MetaData) : cdbsmi->len)
3386 * PutMetaData() - (re)write supplementary record for a message
3388 void PutMetaData(struct MetaData *smibuf)
3392 /* Use the negative of the message number for the metadata db index */
3393 TheIndex = (0L - smibuf->meta_msgnum);
3395 cdb_store(CDB_MSGMAIN,
3396 &TheIndex, (int)sizeof(long),
3397 smibuf, (int)sizeof(struct MetaData)
3403 * Convenience function to process a big block of AdjRefCount() operations
3405 void AdjRefCountList(long *msgnum, long nmsg, int incr)
3409 for (i = 0; i < nmsg; i++) {
3410 AdjRefCount(msgnum[i], incr);
3416 * AdjRefCount - adjust the reference count for a message. We need to delete from disk any message whose reference count reaches zero.
3418 void AdjRefCount(long msgnum, int incr)
3420 struct MetaData smi;
3423 /* This is a *tight* critical section; please keep it that way, as
3424 * it may get called while nested in other critical sections.
3425 * Complicating this any further will surely cause deadlock!
3427 begin_critical_section(S_SUPPMSGMAIN);
3428 GetMetaData(&smi, msgnum);
3429 smi.meta_refcount += incr;
3431 end_critical_section(S_SUPPMSGMAIN);
3432 syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3434 /* If the reference count is now zero, delete both the message and its metadata record.
3436 if (smi.meta_refcount == 0) {
3437 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3439 /* Call delete hooks with NULL room to show it has gone altogether */
3440 PerformDeleteHooks(NULL, msgnum);
3442 /* Remove from message base */
3444 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3445 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));
3447 /* Remove metadata record */
3448 delnum = (0L - msgnum);
3449 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3455 * Write a generic object to this room
3457 * Returns the message number of the written object, in case you need it.
3459 long CtdlWriteObject(char *req_room, /* Room to stuff it in */
3460 char *content_type, /* MIME type of this object */
3461 char *raw_message, /* Data to be written */
3462 off_t raw_length, /* Size of raw_message */
3463 struct ctdluser *is_mailbox, /* Mailbox room? */
3464 int is_binary, /* Is encoding necessary? */
3465 unsigned int flags /* Internal save flags */
3467 struct ctdlroom qrbuf;
3468 char roomname[ROOMNAMELEN];
3469 struct CtdlMessage *msg;
3470 StrBuf *encoded_message = NULL;
3472 if (is_mailbox != NULL) {
3473 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3476 safestrncpy(roomname, req_room, sizeof(roomname));
3479 syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3482 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3485 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3488 StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3489 StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3490 StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3493 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3496 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3500 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3503 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3506 syslog(LOG_DEBUG, "msgbase: allocating");
3507 msg = malloc(sizeof(struct CtdlMessage));
3508 memset(msg, 0, sizeof(struct CtdlMessage));
3509 msg->cm_magic = CTDLMESSAGE_MAGIC;
3510 msg->cm_anon_type = MES_NORMAL;
3511 msg->cm_format_type = 4;
3512 CM_SetField(msg, eAuthor, CC->user.fullname, -1);
3513 CM_SetField(msg, eOriginalRoom, req_room, -1);
3514 msg->cm_flags = flags;
3516 CM_SetAsFieldSB(msg, eMesageText, &encoded_message);
3518 /* Create the requested room if we have to. */
3519 if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3520 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3523 /* Now write the data */
3524 long new_msgnum = CtdlSubmitMsg(msg, NULL, roomname);
3530 /************************************************************************/
3531 /* MODULE INITIALIZATION */
3532 /************************************************************************/
3534 char *ctdl_module_init_msgbase(void) {
3536 FillMsgKeyLookupTable();
3539 /* return our module id for the log */