1 // Implements the message store.
3 // Copyright (c) 1987-2022 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
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
604 case ctdlsetseen_seen:
605 safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen);
607 case ctdlsetseen_answered:
608 safestrncpy(vbuf.v_answered, ChrPtr(vset), sizeof vbuf.v_answered);
614 CtdlSetRelationship(&vbuf, which_user, which_room);
619 // API function to perform an operation for each qualifying message in the
620 // current room. (Returns the number of messages processed.)
621 int CtdlForEachMessage(int mode, long ref, char *search_string,
623 struct CtdlMessage *compare,
624 ForEachMsgCallback CallBack,
629 struct cdbdata *cdbfr;
630 long *msglist = NULL;
632 int num_processed = 0;
635 struct CtdlMessage *msg = NULL;
638 int printed_lastold = 0;
639 int num_search_msgs = 0;
640 long *search_msgs = NULL;
642 int need_to_free_re = 0;
645 if ((content_type) && (!IsEmptyStr(content_type))) {
646 regcomp(&re, content_type, 0);
650 // Learn about the user and room in question
651 if (server_shutting_down) {
652 if (need_to_free_re) regfree(&re);
655 CtdlGetUser(&CC->user, CC->curr_user);
657 if (server_shutting_down) {
658 if (need_to_free_re) regfree(&re);
661 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
663 if (server_shutting_down) {
664 if (need_to_free_re) regfree(&re);
668 // Load the message list
669 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
671 if (need_to_free_re) regfree(&re);
672 return 0; // No messages at all? No further action.
675 msglist = (long *) cdbfr->ptr;
676 num_msgs = cdbfr->len / sizeof(long);
678 cdbfr->ptr = NULL; // clear this so that cdb_free() doesn't free it
679 cdb_free(cdbfr); // we own this memory now
682 * Now begin the traversal.
684 if (num_msgs > 0) for (a = 0; a < num_msgs; ++a) {
686 /* If the caller is looking for a specific MIME type, filter
687 * out all messages which are not of the type requested.
689 if ((content_type != NULL) && (!IsEmptyStr(content_type))) {
691 /* This call to GetMetaData() sits inside this loop
692 * so that we only do the extra database read per msg
693 * if we need to. Doing the extra read all the time
694 * really kills the server. If we ever need to use
695 * metadata for another search criterion, we need to
696 * move the read somewhere else -- but still be smart
697 * enough to only do the read if the caller has
698 * specified something that will need it.
700 if (server_shutting_down) {
701 if (need_to_free_re) regfree(&re);
705 GetMetaData(&smi, msglist[a]);
707 /* if (strcasecmp(smi.meta_content_type, content_type)) { old non-regex way */
708 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) != 0) {
714 num_msgs = sort_msglist(msglist, num_msgs);
716 /* If a template was supplied, filter out the messages which
717 * don't match. (This could induce some delays!)
720 if (compare != NULL) {
721 for (a = 0; a < num_msgs; ++a) {
722 if (server_shutting_down) {
723 if (need_to_free_re) regfree(&re);
727 msg = CtdlFetchMessage(msglist[a], 1);
729 if (CtdlMsgCmp(msg, compare)) {
738 /* If a search string was specified, get a message list from
739 * the full text index and remove messages which aren't on both
743 * Since the lists are sorted and strictly ascending, and the
744 * output list is guaranteed to be shorter than or equal to the
745 * input list, we overwrite the bottom of the input list. This
746 * eliminates the need to memmove big chunks of the list over and
749 if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
751 /* Call search module via hook mechanism.
752 * NULL means use any search function available.
753 * otherwise replace with a char * to name of search routine
755 CtdlModuleDoSearch(&num_search_msgs, &search_msgs, search_string, "fulltext");
757 if (num_search_msgs > 0) {
761 orig_num_msgs = num_msgs;
763 for (i=0; i<orig_num_msgs; ++i) {
764 for (j=0; j<num_search_msgs; ++j) {
765 if (msglist[i] == search_msgs[j]) {
766 msglist[num_msgs++] = msglist[i];
772 num_msgs = 0; /* No messages qualify */
774 if (search_msgs != NULL) free(search_msgs);
776 /* Now that we've purged messages which don't contain the search
777 * string, treat a MSGS_SEARCH just like a MSGS_ALL from this
784 * Now iterate through the message list, according to the
785 * criteria supplied by the caller.
788 for (a = 0; a < num_msgs; ++a) {
789 if (server_shutting_down) {
790 if (need_to_free_re) regfree(&re);
792 return num_processed;
794 thismsg = msglist[a];
795 if (mode == MSGS_ALL) {
799 is_seen = is_msg_in_sequence_set(vbuf.v_seen, thismsg);
800 if (is_seen) lastold = thismsg;
806 || ((mode == MSGS_OLD) && (is_seen))
807 || ((mode == MSGS_NEW) && (!is_seen))
808 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
809 || ((mode == MSGS_FIRST) && (a < ref))
810 || ((mode == MSGS_GT) && (thismsg > ref))
811 || ((mode == MSGS_LT) && (thismsg < ref))
812 || ((mode == MSGS_EQ) && (thismsg == ref))
815 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
817 CallBack(lastold, userdata);
823 CallBack(thismsg, userdata);
828 if (need_to_free_re) regfree(&re);
831 * We cache the most recent msglist in order to do security checks later
833 if (CC->client_socket > 0) {
834 if (CC->cached_msglist != NULL) {
835 free(CC->cached_msglist);
837 CC->cached_msglist = msglist;
838 CC->cached_num_msgs = num_msgs;
844 return num_processed;
849 * memfmout() - Citadel text formatter and paginator.
850 * Although the original purpose of this routine was to format
851 * text to the reader's screen width, all we're really using it
852 * for here is to format text out to 80 columns before sending it
853 * to the client. The client software may reformat it again.
856 char *mptr, /* where are we going to get our text from? */
857 const char *nl /* string to terminate lines with */
860 unsigned char ch = 0;
867 while (ch=*(mptr++), ch != 0) {
870 if (client_write(outbuf, len) == -1) {
871 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
875 if (client_write(nl, nllen) == -1) {
876 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
881 else if (ch == '\r') {
882 /* Ignore carriage returns. Newlines are always LF or CRLF but never CR. */
884 else if (isspace(ch)) {
885 if (column > 72) { /* Beyond 72 columns, break on the next space */
886 if (client_write(outbuf, len) == -1) {
887 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
891 if (client_write(nl, nllen) == -1) {
892 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
905 if (column > 1000) { /* Beyond 1000 columns, break anywhere */
906 if (client_write(outbuf, len) == -1) {
907 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
911 if (client_write(nl, nllen) == -1) {
912 syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
920 if (client_write(outbuf, len) == -1) {
921 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
924 client_write(nl, nllen);
931 * Callback function for mime parser that simply lists the part
933 void list_this_part(char *name, char *filename, char *partnum, char *disp,
934 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
935 char *cbid, void *cbuserdata)
939 ma = (struct ma_info *)cbuserdata;
940 if (ma->is_ma == 0) {
941 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
955 * Callback function for multipart prefix
957 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
958 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
959 char *cbid, void *cbuserdata)
963 ma = (struct ma_info *)cbuserdata;
964 if (!strcasecmp(cbtype, "multipart/alternative")) {
968 if (ma->is_ma == 0) {
969 cprintf("pref=%s|%s\n", partnum, cbtype);
975 * Callback function for multipart sufffix
977 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
978 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
979 char *cbid, void *cbuserdata)
983 ma = (struct ma_info *)cbuserdata;
984 if (ma->is_ma == 0) {
985 cprintf("suff=%s|%s\n", partnum, cbtype);
987 if (!strcasecmp(cbtype, "multipart/alternative")) {
994 * Callback function for mime parser that opens a section for downloading
995 * we use serv_files function here:
997 extern void OpenCmdResult(char *filename, const char *mime_type);
998 void mime_download(char *name, char *filename, char *partnum, char *disp,
999 void *content, char *cbtype, char *cbcharset, size_t length,
1000 char *encoding, char *cbid, void *cbuserdata)
1004 /* Silently go away if there's already a download open. */
1005 if (CC->download_fp != NULL)
1009 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1010 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1012 CC->download_fp = tmpfile();
1013 if (CC->download_fp == NULL) {
1014 syslog(LOG_ERR, "msgbase: mime_download() couldn't write: %m");
1015 cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
1019 rv = fwrite(content, length, 1, CC->download_fp);
1021 syslog(LOG_ERR, "msgbase: mime_download() Couldn't write: %m");
1022 cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
1023 fclose(CC->download_fp);
1024 CC->download_fp = NULL;
1027 fflush(CC->download_fp);
1028 rewind(CC->download_fp);
1030 OpenCmdResult(filename, cbtype);
1036 * Callback function for mime parser that outputs a section all at once.
1037 * We can specify the desired section by part number *or* content-id.
1039 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
1040 void *content, char *cbtype, char *cbcharset, size_t length,
1041 char *encoding, char *cbid, void *cbuserdata)
1043 int *found_it = (int *)cbuserdata;
1046 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1047 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1050 cprintf("%d %d|-1|%s|%s|%s\n",
1057 client_write(content, length);
1062 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length) {
1063 struct CtdlMessage *ret = NULL;
1065 const char *upper_bound;
1067 cit_uint8_t field_header;
1071 upper_bound = Buffer + Length;
1076 // Parse the three bytes that begin EVERY message on disk.
1077 // The first is always 0xFF, the on-disk magic number.
1078 // The second is the anonymous/public type byte.
1079 // The third is the format type byte (vari, fixed, or MIME).
1083 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1086 ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1087 memset(ret, 0, sizeof(struct CtdlMessage));
1089 ret->cm_magic = CTDLMESSAGE_MAGIC;
1090 ret->cm_anon_type = *mptr++; // Anon type byte
1091 ret->cm_format_type = *mptr++; // Format type byte
1093 // The rest is zero or more arbitrary fields. Load them in.
1094 // We're done when we encounter either a zero-length field or
1095 // have just processed the 'M' (message text) field.
1098 field_header = '\0';
1101 while (field_header == '\0') { // work around possibly buggy messages
1102 if (mptr >= upper_bound) {
1105 field_header = *mptr++;
1107 if (mptr >= upper_bound) {
1110 which = field_header;
1113 CM_SetField(ret, which, mptr, len);
1115 mptr += len + 1; // advance to next field
1117 } while ((mptr < upper_bound) && (field_header != 'M'));
1122 // Load a message from disk into memory.
1123 // This is used by CtdlOutputMsg() and other fetch functions.
1125 // NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1126 // using the CM_Free(); function.
1128 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) {
1129 struct cdbdata *dmsgtext;
1130 struct CtdlMessage *ret = NULL;
1132 syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1133 dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1134 if (dmsgtext == NULL) {
1135 syslog(LOG_ERR, "msgbase: message #%ld was not found", msgnum);
1139 if (dmsgtext->ptr[dmsgtext->len - 1] != '\0') {
1140 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1141 dmsgtext->ptr[dmsgtext->len - 1] = '\0';
1144 ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext->ptr, dmsgtext->len);
1152 // Always make sure there's something in the msg text field. If
1153 // it's NULL, the message text is most likely stored separately,
1154 // so go ahead and fetch that. Failing that, just set a dummy
1155 // body so other code doesn't barf.
1157 if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) {
1158 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1159 if (dmsgtext != NULL) {
1160 CM_SetAsField(ret, eMesageText, &dmsgtext->ptr, dmsgtext->len - 1);
1164 if (CM_IsEmpty(ret, eMesageText)) {
1165 CM_SetField(ret, eMesageText, HKEY("\r\n\r\n (no text)\r\n"));
1172 // Pre callback function for multipart/alternative
1174 // NOTE: this differs from the standard behavior for a reason. Normally when
1175 // displaying multipart/alternative you want to show the _last_ usable
1176 // format in the message. Here we show the _first_ one, because it's
1177 // usually text/plain. Since this set of functions is designed for text
1178 // output to non-MIME-aware clients, this is the desired behavior.
1180 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1181 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1182 char *cbid, void *cbuserdata)
1186 ma = (struct ma_info *)cbuserdata;
1187 syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);
1188 if (!strcasecmp(cbtype, "multipart/alternative")) {
1192 if (!strcasecmp(cbtype, "message/rfc822")) {
1199 // Post callback function for multipart/alternative
1201 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1202 void *content, char *cbtype, char *cbcharset, size_t length,
1203 char *encoding, char *cbid, void *cbuserdata)
1207 ma = (struct ma_info *)cbuserdata;
1208 syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);
1209 if (!strcasecmp(cbtype, "multipart/alternative")) {
1213 if (!strcasecmp(cbtype, "message/rfc822")) {
1219 // Inline callback function for mime parser that wants to display text
1220 void fixed_output(char *name, char *filename, char *partnum, char *disp,
1221 void *content, char *cbtype, char *cbcharset, size_t length,
1222 char *encoding, char *cbid, void *cbuserdata)
1229 ma = (struct ma_info *)cbuserdata;
1232 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1233 partnum, filename, cbtype, (long)length
1236 // If we're in the middle of a multipart/alternative scope and
1237 // we've already printed another section, skip this one.
1238 if ( (ma->is_ma) && (ma->did_print) ) {
1239 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1244 if ( (!strcasecmp(cbtype, "text/plain"))
1245 || (IsEmptyStr(cbtype)) ) {
1248 client_write(wptr, length);
1249 if (wptr[length-1] != '\n') {
1256 if (!strcasecmp(cbtype, "text/html")) {
1257 ptr = html_to_ascii(content, length, 80, 0);
1259 client_write(ptr, wlen);
1260 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1267 if (ma->use_fo_hooks) {
1268 if (PerformFixedOutputHooks(cbtype, content, length)) { // returns nonzero if it handled the part
1273 if (strncasecmp(cbtype, "multipart/", 10)) {
1274 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1275 partnum, filename, cbtype, (long)length);
1281 // The client is elegant and sophisticated and wants to be choosy about
1282 // MIME content types, so figure out which multipart/alternative part
1283 // we're going to send.
1285 // We use a system of weights. When we find a part that matches one of the
1286 // MIME types we've declared as preferential, we can store it in ma->chosen_part
1287 // and then set ma->chosen_pref to that MIME type's position in our preference
1288 // list. If we then hit another match, we only replace the first match if
1289 // the preference value is lower.
1290 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1291 void *content, char *cbtype, char *cbcharset, size_t length,
1292 char *encoding, char *cbid, void *cbuserdata)
1298 ma = (struct ma_info *)cbuserdata;
1300 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1301 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1302 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1303 if (i < ma->chosen_pref) {
1304 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1305 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1306 ma->chosen_pref = i;
1313 // Now that we've chosen our preferred part, output it.
1314 void output_preferred(char *name,
1328 int add_newline = 0;
1331 char *decoded = NULL;
1332 size_t bytes_decoded;
1335 ma = (struct ma_info *)cbuserdata;
1337 // This is not the MIME part you're looking for...
1338 if (strcasecmp(partnum, ma->chosen_part)) return;
1340 // If the content-type of this part is in our preferred formats
1341 // list, we can simply output it verbatim.
1342 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1343 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1344 if (!strcasecmp(buf, cbtype)) {
1345 /* Yeah! Go! W00t!! */
1346 if (ma->dont_decode == 0)
1347 rc = mime_decode_now (content,
1353 break; // Give us the chance, maybe theres another one.
1355 if (rc == 0) text_content = (char *)content;
1357 text_content = decoded;
1358 length = bytes_decoded;
1361 if (text_content[length-1] != '\n') {
1364 cprintf("Content-type: %s", cbtype);
1365 if (!IsEmptyStr(cbcharset)) {
1366 cprintf("; charset=%s", cbcharset);
1368 cprintf("\nContent-length: %d\n",
1369 (int)(length + add_newline) );
1370 if (!IsEmptyStr(encoding)) {
1371 cprintf("Content-transfer-encoding: %s\n", encoding);
1374 cprintf("Content-transfer-encoding: 7bit\n");
1376 cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1378 if (client_write(text_content, length) == -1)
1380 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1383 if (add_newline) cprintf("\n");
1384 if (decoded != NULL) free(decoded);
1389 // No translations required or possible: output as text/plain
1390 cprintf("Content-type: text/plain\n\n");
1392 if (ma->dont_decode == 0)
1393 rc = mime_decode_now (content,
1399 return; // Give us the chance, maybe theres another one.
1401 if (rc == 0) text_content = (char *)content;
1403 text_content = decoded;
1404 length = bytes_decoded;
1407 fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, length, encoding, cbid, cbuserdata);
1408 if (decoded != NULL) free(decoded);
1413 char desired_section[64];
1419 // Callback function
1420 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1421 void *content, char *cbtype, char *cbcharset, size_t length,
1422 char *encoding, char *cbid, void *cbuserdata)
1424 struct encapmsg *encap;
1426 encap = (struct encapmsg *)cbuserdata;
1428 // Only proceed if this is the desired section...
1429 if (!strcasecmp(encap->desired_section, partnum)) {
1430 encap->msglen = length;
1431 encap->msg = malloc(length + 2);
1432 memcpy(encap->msg, content, length);
1438 // Determine whether the specified message exists in the cached_msglist
1439 // (This is a security check)
1440 int check_cached_msglist(long msgnum) {
1442 // cases in which we skip the check
1443 if (!CC) return om_ok; // not a session
1444 if (CC->client_socket <= 0) return om_ok; // not a client session
1445 if (CC->cached_msglist == NULL) return om_access_denied; // no msglist fetched
1446 if (CC->cached_num_msgs == 0) return om_access_denied; // nothing to check
1448 // Do a binary search within the cached_msglist for the requested msgnum
1450 int max = (CC->cached_num_msgs - 1);
1452 while (max >= min) {
1453 int middle = min + (max-min) / 2 ;
1454 if (msgnum == CC->cached_msglist[middle]) {
1457 if (msgnum > CC->cached_msglist[middle]) {
1465 return om_access_denied;
1469 // Get a message off disk. (returns om_* values found in msgbase.h)
1470 int CtdlOutputMsg(long msg_num, // message number (local) to fetch
1471 int mode, // how would you like that message?
1472 int headers_only, // eschew the message body?
1473 int do_proto, // do Citadel protocol responses?
1474 int crlf, // Use CRLF newlines instead of LF?
1475 char *section, // NULL or a message/rfc822 section
1476 int flags, // various flags; see msgbase.h
1481 struct CtdlMessage *TheMessage = NULL;
1482 int retcode = CIT_OK;
1483 struct encapmsg encap;
1486 syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)",
1488 (section ? section : "<>")
1491 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1494 if (r == om_not_logged_in) {
1495 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1498 cprintf("%d An unknown error has occurred.\n", ERROR);
1505 * Check to make sure the message is actually IN this room
1507 r = check_cached_msglist(msg_num);
1508 if (r == om_access_denied) {
1509 /* Not in the cache? We get ONE shot to check it again. */
1510 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1511 r = check_cached_msglist(msg_num);
1514 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s",
1515 msg_num, CC->room.QRname
1518 if (r == om_access_denied) {
1519 cprintf("%d message %ld was not found in this room\n",
1520 ERROR + HIGHER_ACCESS_REQUIRED,
1529 * Fetch the message from disk. If we're in HEADERS_FAST mode,
1530 * request that we don't even bother loading the body into memory.
1532 if (headers_only == HEADERS_FAST) {
1533 TheMessage = CtdlFetchMessage(msg_num, 0);
1536 TheMessage = CtdlFetchMessage(msg_num, 1);
1539 if (TheMessage == NULL) {
1540 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n",
1541 ERROR + MESSAGE_NOT_FOUND, msg_num);
1542 return(om_no_such_msg);
1545 /* Here is the weird form of this command, to process only an
1546 * encapsulated message/rfc822 section.
1548 if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1549 memset(&encap, 0, sizeof encap);
1550 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1551 mime_parser(CM_RANGE(TheMessage, eMesageText),
1552 *extract_encapsulated_message,
1553 NULL, NULL, (void *)&encap, 0
1556 if ((Author != NULL) && (*Author == NULL))
1559 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1561 if ((Address != NULL) && (*Address == NULL))
1564 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1566 if ((MessageID != NULL) && (*MessageID == NULL))
1569 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1571 CM_Free(TheMessage);
1575 encap.msg[encap.msglen] = 0;
1576 TheMessage = convert_internet_message(encap.msg);
1577 encap.msg = NULL; /* no free() here, TheMessage owns it now */
1579 /* Now we let it fall through to the bottom of this
1580 * function, because TheMessage now contains the
1581 * encapsulated message instead of the top-level
1582 * message. Isn't that neat?
1587 cprintf("%d msg %ld has no part %s\n",
1588 ERROR + MESSAGE_NOT_FOUND,
1592 retcode = om_no_such_msg;
1597 /* Ok, output the message now */
1598 if (retcode == CIT_OK)
1599 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1600 if ((Author != NULL) && (*Author == NULL))
1603 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1605 if ((Address != NULL) && (*Address == NULL))
1608 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1610 if ((MessageID != NULL) && (*MessageID == NULL))
1613 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1616 CM_Free(TheMessage);
1622 void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) {
1625 char display_name[256];
1627 /* begin header processing loop for Citadel message format */
1628 safestrncpy(display_name, "<unknown>", sizeof display_name);
1629 if (!CM_IsEmpty(TheMessage, eAuthor)) {
1630 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1631 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1632 safestrncpy(display_name, "****", sizeof display_name);
1634 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1635 safestrncpy(display_name, "anonymous", sizeof display_name);
1638 safestrncpy(display_name, buf, sizeof display_name);
1640 if ((is_room_aide())
1641 && ((TheMessage->cm_anon_type == MES_ANONONLY)
1642 || (TheMessage->cm_anon_type == MES_ANONOPT))) {
1643 size_t tmp = strlen(display_name);
1644 snprintf(&display_name[tmp],
1645 sizeof display_name - tmp,
1650 /* Now spew the header fields in the order we like them. */
1651 for (i=0; i< NDiskFields; ++i) {
1653 Field = FieldOrder[i];
1654 if (Field != eMesageText) {
1655 if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) {
1656 if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) {
1657 sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1659 if (Field == eAuthor) {
1661 cprintf("%s=%s\n", msgkeys[Field], display_name);
1664 /* Masquerade display name if needed */
1667 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1670 /* Give the client a hint about whether the message originated locally */
1671 if (Field == erFc822Addr) {
1672 if (IsDirectory(TheMessage->cm_fields[Field] ,0)) {
1673 cprintf("locl=yes\n"); // message originated locally.
1685 void OutputRFC822MsgHeaders(
1686 struct CtdlMessage *TheMessage,
1687 int flags, /* should the message be exported clean */
1688 const char *nl, int nlen,
1689 char *mid, long sizeof_mid,
1690 char *suser, long sizeof_suser,
1691 char *luser, long sizeof_luser,
1692 char *fuser, long sizeof_fuser,
1693 char *snode, long sizeof_snode)
1695 char datestamp[100];
1696 int subject_found = 0;
1703 for (i = 0; i < NDiskFields; ++i) {
1704 if (TheMessage->cm_fields[FieldOrder[i]]) {
1705 mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1706 switch (FieldOrder[i]) {
1708 safestrncpy(luser, mptr, sizeof_luser);
1709 safestrncpy(suser, mptr, sizeof_suser);
1712 if ((flags & QP_EADDR) != 0) {
1713 mptr = qp_encode_email_addrs(mptr);
1715 sanitize_truncated_recipient(mptr);
1716 cprintf("CC: %s%s", mptr, nl);
1719 cprintf("Return-Path: %s%s", mptr, nl);
1722 cprintf("List-ID: %s%s", mptr, nl);
1725 if ((flags & QP_EADDR) != 0)
1726 mptr = qp_encode_email_addrs(mptr);
1728 while ((*hptr != '\0') && isspace(*hptr))
1730 if (!IsEmptyStr(hptr))
1731 cprintf("Envelope-To: %s%s", hptr, nl);
1734 cprintf("Subject: %s%s", mptr, nl);
1738 safestrncpy(mid, mptr, sizeof_mid);
1741 safestrncpy(fuser, mptr, sizeof_fuser);
1744 if (haschar(mptr, '@') == 0) {
1745 sanitize_truncated_recipient(mptr);
1746 cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1750 if ((flags & QP_EADDR) != 0) {
1751 mptr = qp_encode_email_addrs(mptr);
1753 sanitize_truncated_recipient(mptr);
1754 cprintf("To: %s", mptr);
1759 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1760 cprintf("Date: %s%s", datestamp, nl);
1763 cprintf("References: ");
1764 k = num_tokens(mptr, '|');
1765 for (j=0; j<k; ++j) {
1766 extract_token(buf, mptr, j, '|', sizeof buf);
1767 cprintf("<%s>", buf);
1778 while ((*hptr != '\0') && isspace(*hptr))
1780 if (!IsEmptyStr(hptr))
1781 cprintf("Reply-To: %s%s", mptr, nl);
1793 /* these don't map to mime message headers. */
1796 if (mptr != mpptr) {
1801 if (subject_found == 0) {
1802 cprintf("Subject: (no subject)%s", nl);
1807 void Dump_RFC822HeadersBody(
1808 struct CtdlMessage *TheMessage,
1809 int headers_only, /* eschew the message body? */
1810 int flags, /* should the bessage be exported clean? */
1811 const char *nl, int nlen)
1813 cit_uint8_t prev_ch;
1815 const char *StartOfText = StrBufNOTNULL;
1818 int nllen = strlen(nl);
1822 mptr = TheMessage->cm_fields[eMesageText];
1825 while (*mptr != '\0') {
1826 if (*mptr == '\r') {
1833 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1835 eoh = *(mptr+1) == '\n';
1839 StartOfText = strchr(StartOfText, '\n');
1840 StartOfText = strchr(StartOfText, '\n');
1843 if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1844 ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1845 ((headers_only != HEADERS_NONE) &&
1846 (headers_only != HEADERS_ONLY))
1848 if (*mptr == '\n') {
1849 memcpy(&outbuf[outlen], nl, nllen);
1851 outbuf[outlen] = '\0';
1854 outbuf[outlen++] = *mptr;
1858 if (flags & ESC_DOT) {
1859 if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1860 outbuf[outlen++] = '.';
1865 if (outlen > 1000) {
1866 if (client_write(outbuf, outlen) == -1) {
1867 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1870 lfSent = (outbuf[outlen - 1] == '\n');
1875 client_write(outbuf, outlen);
1876 lfSent = (outbuf[outlen - 1] == '\n');
1879 client_write(nl, nlen);
1883 /* If the format type on disk is 1 (fixed-format), then we want
1884 * everything to be output completely literally ... regardless of
1885 * what message transfer format is in use.
1887 void DumpFormatFixed(
1888 struct CtdlMessage *TheMessage,
1889 int mode, /* how would you like that message? */
1890 const char *nl, int nllen)
1898 mptr = TheMessage->cm_fields[eMesageText];
1900 if (mode == MT_MIME) {
1901 cprintf("Content-type: text/plain\n\n");
1905 while (ch = *mptr++, ch > 0) {
1909 if ((buflen > 250) && (!xlline)){
1913 while ((buflen > 0) &&
1914 (!isspace(buf[buflen])))
1920 mptr -= tbuflen - buflen;
1926 /* if we reach the outer bounds of our buffer, abort without respect for what we purge. */
1927 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1932 memcpy (&buf[buflen], nl, nllen);
1936 if (client_write(buf, buflen) == -1) {
1937 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
1949 if (!IsEmptyStr(buf)) {
1950 cprintf("%s%s", buf, nl);
1956 * Get a message off disk. (returns om_* values found in msgbase.h)
1958 int CtdlOutputPreLoadedMsg(
1959 struct CtdlMessage *TheMessage,
1960 int mode, /* how would you like that message? */
1961 int headers_only, /* eschew the message body? */
1962 int do_proto, /* do Citadel protocol responses? */
1963 int crlf, /* Use CRLF newlines instead of LF? */
1964 int flags /* should the bessage be exported clean? */
1967 const char *nl; /* newline string */
1971 /* Buffers needed for RFC822 translation. These are all filled
1972 * using functions that are bounds-checked, and therefore we can
1973 * make them substantially smaller than SIZ.
1981 syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
1982 ((TheMessage == NULL) ? "NULL" : "not null"),
1983 mode, headers_only, do_proto, crlf
1986 strcpy(mid, "unknown");
1987 nl = (crlf ? "\r\n" : "\n");
1988 nlen = crlf ? 2 : 1;
1990 if (!CM_IsValidMsg(TheMessage)) {
1991 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
1992 return(om_no_such_msg);
1995 /* Suppress envelope recipients if required to avoid disclosing BCC addresses.
1996 * Pad it with spaces in order to avoid changing the RFC822 length of the message.
1998 if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
1999 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
2002 /* Are we downloading a MIME component? */
2003 if (mode == MT_DOWNLOAD) {
2004 if (TheMessage->cm_format_type != FMT_RFC822) {
2006 cprintf("%d This is not a MIME message.\n",
2007 ERROR + ILLEGAL_VALUE);
2008 } else if (CC->download_fp != NULL) {
2009 if (do_proto) cprintf(
2010 "%d You already have a download open.\n",
2011 ERROR + RESOURCE_BUSY);
2013 /* Parse the message text component */
2014 mime_parser(CM_RANGE(TheMessage, eMesageText),
2015 *mime_download, NULL, NULL, NULL, 0);
2016 /* If there's no file open by this time, the requested
2017 * section wasn't found, so print an error
2019 if (CC->download_fp == NULL) {
2020 if (do_proto) cprintf(
2021 "%d Section %s not found.\n",
2022 ERROR + FILE_NOT_FOUND,
2023 CC->download_desired_section);
2026 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2029 // MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
2030 // in a single server operation instead of opening a download file.
2031 if (mode == MT_SPEW_SECTION) {
2032 if (TheMessage->cm_format_type != FMT_RFC822) {
2034 cprintf("%d This is not a MIME message.\n",
2035 ERROR + ILLEGAL_VALUE);
2038 // Locate and parse the component specified by the caller
2040 mime_parser(CM_RANGE(TheMessage, eMesageText), *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
2042 // If section wasn't found, print an error
2045 cprintf( "%d Section %s not found.\n", ERROR + FILE_NOT_FOUND, CC->download_desired_section);
2049 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2052 // now for the user-mode message reading loops
2053 if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
2055 // Does the caller want to skip the headers?
2056 if (headers_only == HEADERS_NONE) goto START_TEXT;
2058 // Tell the client which format type we're using.
2059 if ( (mode == MT_CITADEL) && (do_proto) ) {
2060 cprintf("type=%d\n", TheMessage->cm_format_type); // Tell the client which format type we're using.
2063 // nhdr=yes means that we're only displaying headers, no body
2064 if ( (TheMessage->cm_anon_type == MES_ANONONLY)
2065 && ((mode == MT_CITADEL) || (mode == MT_MIME))
2068 cprintf("nhdr=yes\n");
2071 if ((mode == MT_CITADEL) || (mode == MT_MIME)) {
2072 OutputCtdlMsgHeaders(TheMessage, do_proto);
2075 // begin header processing loop for RFC822 transfer format
2080 if (mode == MT_RFC822)
2081 OutputRFC822MsgHeaders(
2086 suser, sizeof(suser),
2087 luser, sizeof(luser),
2088 fuser, sizeof(fuser),
2089 snode, sizeof(snode)
2093 for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2094 suser[i] = tolower(suser[i]);
2095 if (!isalnum(suser[i])) suser[i]='_';
2098 if (mode == MT_RFC822) {
2099 /* Construct a fun message id */
2100 cprintf("Message-ID: <%s", mid);
2101 if (strchr(mid, '@')==NULL) {
2102 cprintf("@%s", snode);
2106 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2107 cprintf("From: \"----\" <x@x.org>%s", nl);
2109 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2110 cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2112 else if (!IsEmptyStr(fuser)) {
2113 cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2116 cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2119 /* Blank line signifying RFC822 end-of-headers */
2120 if (TheMessage->cm_format_type != FMT_RFC822) {
2125 // end header processing loop ... at this point, we're in the text
2127 if (headers_only == HEADERS_FAST) goto DONE;
2129 // Tell the client about the MIME parts in this message
2130 if (TheMessage->cm_format_type == FMT_RFC822) {
2131 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2132 memset(&ma, 0, sizeof(struct ma_info));
2133 mime_parser(CM_RANGE(TheMessage, eMesageText),
2134 (do_proto ? *list_this_part : NULL),
2135 (do_proto ? *list_this_pref : NULL),
2136 (do_proto ? *list_this_suff : NULL),
2139 else if (mode == MT_RFC822) { // unparsed RFC822 dump
2140 Dump_RFC822HeadersBody(
2149 if (headers_only == HEADERS_ONLY) {
2153 // signify start of msg text
2154 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2155 if (do_proto) cprintf("text\n");
2158 if (TheMessage->cm_format_type == FMT_FIXED)
2161 mode, // how would you like that message?
2164 // If the message on disk is format 0 (Citadel vari-format), we
2165 // output using the formatter at 80 columns. This is the final output
2166 // form if the transfer format is RFC822, but if the transfer format
2167 // is Citadel proprietary, it'll still work, because the indentation
2168 // for new paragraphs is correct and the client will reformat the
2169 // message to the reader's screen width.
2171 if (TheMessage->cm_format_type == FMT_CITADEL) {
2172 if (mode == MT_MIME) {
2173 cprintf("Content-type: text/x-citadel-variformat\n\n");
2175 memfmout(TheMessage->cm_fields[eMesageText], nl);
2178 // If the message on disk is format 4 (MIME), we've gotta hand it
2179 // off to the MIME parser. The client has already been told that
2180 // this message is format 1 (fixed format), so the callback function
2181 // we use will display those parts as-is.
2183 if (TheMessage->cm_format_type == FMT_RFC822) {
2184 memset(&ma, 0, sizeof(struct ma_info));
2186 if (mode == MT_MIME) {
2187 ma.use_fo_hooks = 0;
2188 strcpy(ma.chosen_part, "1");
2189 ma.chosen_pref = 9999;
2190 ma.dont_decode = CC->msg4_dont_decode;
2191 mime_parser(CM_RANGE(TheMessage, eMesageText),
2192 *choose_preferred, *fixed_output_pre,
2193 *fixed_output_post, (void *)&ma, 1);
2194 mime_parser(CM_RANGE(TheMessage, eMesageText),
2195 *output_preferred, NULL, NULL, (void *)&ma, 1);
2198 ma.use_fo_hooks = 1;
2199 mime_parser(CM_RANGE(TheMessage, eMesageText),
2200 *fixed_output, *fixed_output_pre,
2201 *fixed_output_post, (void *)&ma, 0);
2206 DONE: /* now we're done */
2207 if (do_proto) cprintf("000\n");
2211 // Save one or more message pointers into a specified room
2212 // (Returns 0 for success, nonzero for failure)
2213 // roomname may be NULL to use the current room
2215 // Note that the 'supplied_msg' field may be set to NULL, in which case
2216 // the message will be fetched from disk, by number, if we need to perform
2217 // replication checks. This adds an additional database read, so if the
2218 // caller already has the message in memory then it should be supplied. (Obviously
2219 // this mode of operation only works if we're saving a single message.)
2221 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2222 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj
2225 char hold_rm[ROOMNAMELEN];
2226 struct cdbdata *cdbfr;
2229 long highest_msg = 0L;
2232 struct CtdlMessage *msg = NULL;
2234 long *msgs_to_be_merged = NULL;
2235 int num_msgs_to_be_merged = 0;
2238 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2239 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2242 strcpy(hold_rm, CC->room.QRname);
2245 if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2246 if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2247 if (num_newmsgs > 1) supplied_msg = NULL;
2249 /* Now the regular stuff */
2250 if (CtdlGetRoomLock(&CC->room,
2251 ((roomname != NULL) ? roomname : CC->room.QRname) )
2253 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2254 return(ERROR + ROOM_NOT_FOUND);
2258 msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2259 num_msgs_to_be_merged = 0;
2262 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
2263 if (cdbfr == NULL) {
2267 msglist = (long *) cdbfr->ptr;
2268 cdbfr->ptr = NULL; /* CtdlSaveMsgPointerInRoom() now owns this memory */
2269 num_msgs = cdbfr->len / sizeof(long);
2274 /* Create a list of msgid's which were supplied by the caller, but do
2275 * not already exist in the target room. It is absolutely taboo to
2276 * have more than one reference to the same message in a room.
2278 for (i=0; i<num_newmsgs; ++i) {
2280 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2281 if (msglist[j] == newmsgidlist[i]) {
2286 msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2290 syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2293 * Now merge the new messages
2295 msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2296 if (msglist == NULL) {
2297 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2298 free(msgs_to_be_merged);
2299 return (ERROR + INTERNAL_ERROR);
2301 memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2302 num_msgs += num_msgs_to_be_merged;
2304 /* Sort the message list, so all the msgid's are in order */
2305 num_msgs = sort_msglist(msglist, num_msgs);
2307 /* Determine the highest message number */
2308 highest_msg = msglist[num_msgs - 1];
2310 /* Write it back to disk. */
2311 cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long),
2312 msglist, (int)(num_msgs * sizeof(long)));
2314 /* Free up the memory we used. */
2317 /* Update the highest-message pointer and unlock the room. */
2318 CC->room.QRhighest = highest_msg;
2319 CtdlPutRoomLock(&CC->room);
2321 /* Perform replication checks if necessary */
2322 if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2323 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2325 for (i=0; i<num_msgs_to_be_merged; ++i) {
2326 msgid = msgs_to_be_merged[i];
2328 if (supplied_msg != NULL) {
2332 msg = CtdlFetchMessage(msgid, 0);
2336 ReplicationChecks(msg);
2338 /* If the message has an Exclusive ID, index that... */
2339 if (!CM_IsEmpty(msg, eExclusiveID)) {
2340 index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2343 /* Free up the memory we may have allocated */
2344 if (msg != supplied_msg) {
2353 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2356 /* Submit this room for processing by hooks */
2357 int total_roomhook_errors = PerformRoomHooks(&CC->room);
2358 if (total_roomhook_errors) {
2359 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2362 /* Go back to the room we were in before we wandered here... */
2363 CtdlGetRoom(&CC->room, hold_rm);
2365 /* Bump the reference count for all messages which were merged */
2366 if (!suppress_refcount_adj) {
2367 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2370 /* Free up memory... */
2371 if (msgs_to_be_merged != NULL) {
2372 free(msgs_to_be_merged);
2375 /* Return success. */
2381 * This is the same as CtdlSaveMsgPointersInRoom() but it only accepts
2384 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid,
2385 int do_repl_check, struct CtdlMessage *supplied_msg)
2387 return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, supplied_msg, 0);
2392 * Message base operation to save a new message to the message store
2393 * (returns new message number)
2395 * This is the back end for CtdlSubmitMsg() and should not be directly
2396 * called by server-side modules.
2399 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) {
2407 * If the message is big, set its body aside for storage elsewhere
2408 * and we hide the message body from the serializer
2410 if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG) {
2412 holdM = msg->cm_fields[eMesageText];
2413 msg->cm_fields[eMesageText] = NULL;
2414 holdMLen = msg->cm_lengths[eMesageText];
2415 msg->cm_lengths[eMesageText] = 0;
2418 /* Serialize our data structure for storage in the database */
2419 CtdlSerializeMessage(&smr, msg);
2422 /* put the message body back into the message */
2423 msg->cm_fields[eMesageText] = holdM;
2424 msg->cm_lengths[eMesageText] = holdMLen;
2429 cprintf("%d Unable to serialize message\n",
2430 ERROR + INTERNAL_ERROR);
2433 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2439 /* Write our little bundle of joy into the message base */
2440 retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len);
2442 syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval);
2446 retval = cdb_store(CDB_BIGMSGS,
2453 syslog(LOG_ERR, "msgbase: failed to store message body for msgid %ld: %ld", msgid, retval);
2458 /* Free the memory we used for the serialized message */
2465 long send_message(struct CtdlMessage *msg) {
2471 /* Get a new message number */
2472 newmsgid = get_new_message_number();
2474 /* Generate an ID if we don't have one already */
2475 if (CM_IsEmpty(msg, emessageId)) {
2476 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%08lX-%08lX@%s",
2477 (long unsigned int) time(NULL),
2478 (long unsigned int) newmsgid,
2479 CtdlGetConfigStr("c_fqdn")
2482 CM_SetField(msg, emessageId, msgidbuf, msgidbuflen);
2485 retval = CtdlSaveThisMessage(msg, newmsgid, 1);
2491 /* Return the *local* message ID to the caller
2492 * (even if we're storing an incoming network message)
2499 * Serialize a struct CtdlMessage into the format used on disk.
2501 * This function loads up a "struct ser_ret" (defined in server.h) which
2502 * contains the length of the serialized message and a pointer to the
2503 * serialized message in memory. THE LATTER MUST BE FREED BY THE CALLER.
2505 void CtdlSerializeMessage(struct ser_ret *ret, /* return values */
2506 struct CtdlMessage *msg) /* unserialized msg */
2512 * Check for valid message format
2514 if (CM_IsValidMsg(msg) == 0) {
2515 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2522 for (i=0; i < NDiskFields; ++i)
2523 if (msg->cm_fields[FieldOrder[i]] != NULL)
2524 ret->len += msg->cm_lengths[FieldOrder[i]] + 2;
2526 ret->ser = malloc(ret->len);
2527 if (ret->ser == NULL) {
2528 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret->len);
2535 ret->ser[1] = msg->cm_anon_type;
2536 ret->ser[2] = msg->cm_format_type;
2539 for (i=0; i < NDiskFields; ++i) {
2540 if (msg->cm_fields[FieldOrder[i]] != NULL) {
2541 ret->ser[wlen++] = (char)FieldOrder[i];
2543 memcpy(&ret->ser[wlen],
2544 msg->cm_fields[FieldOrder[i]],
2545 msg->cm_lengths[FieldOrder[i]] + 1);
2547 wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2551 if (ret->len != wlen) {
2552 syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen);
2560 * Check to see if any messages already exist in the current room which
2561 * carry the same Exclusive ID as this one. If any are found, delete them.
2563 void ReplicationChecks(struct CtdlMessage *msg) {
2564 long old_msgnum = (-1L);
2566 if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2568 syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2570 /* No exclusive id? Don't do anything. */
2571 if (msg == NULL) return;
2572 if (CM_IsEmpty(msg, eExclusiveID)) return;
2574 /*syslog(LOG_DEBUG, "msgbase: exclusive ID: <%s> for room <%s>",
2575 msg->cm_fields[eExclusiveID], CC->room.QRname);*/
2577 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2578 if (old_msgnum > 0L) {
2579 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2580 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2586 * Save a message to disk and submit it into the delivery system.
2588 long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */
2589 struct recptypes *recps, /* recipients (if mail) */
2590 const char *force /* force a particular room? */
2592 char hold_rm[ROOMNAMELEN];
2593 char actual_rm[ROOMNAMELEN];
2594 char force_room[ROOMNAMELEN];
2595 char content_type[SIZ]; /* We have to learn this */
2596 char recipient[SIZ];
2597 char bounce_to[1024];
2600 const char *mptr = NULL;
2601 struct ctdluser userbuf;
2603 struct MetaData smi;
2604 char *collected_addresses = NULL;
2605 struct addresses_to_be_filed *aptr = NULL;
2606 StrBuf *saved_rfc822_version = NULL;
2607 int qualified_for_journaling = 0;
2609 syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2610 if (CM_IsValidMsg(msg) == 0) return(-1); /* self check */
2612 /* If this message has no timestamp, we take the liberty of
2613 * giving it one, right now.
2615 if (CM_IsEmpty(msg, eTimestamp)) {
2616 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2619 /* If this message has no path, we generate one.
2621 if (CM_IsEmpty(msg, eMessagePath)) {
2622 if (!CM_IsEmpty(msg, eAuthor)) {
2623 CM_CopyField(msg, eMessagePath, eAuthor);
2624 for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2625 if (isspace(msg->cm_fields[eMessagePath][a])) {
2626 msg->cm_fields[eMessagePath][a] = ' ';
2631 CM_SetField(msg, eMessagePath, HKEY("unknown"));
2635 if (force == NULL) {
2636 force_room[0] = '\0';
2639 strcpy(force_room, force);
2642 /* Learn about what's inside, because it's what's inside that counts */
2643 if (CM_IsEmpty(msg, eMesageText)) {
2644 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2648 switch (msg->cm_format_type) {
2650 strcpy(content_type, "text/x-citadel-variformat");
2653 strcpy(content_type, "text/plain");
2656 strcpy(content_type, "text/plain");
2657 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
2660 safestrncpy(content_type, &mptr[13], sizeof content_type);
2661 striplt(content_type);
2662 aptr = content_type;
2663 while (!IsEmptyStr(aptr)) {
2675 /* Goto the correct room */
2676 room = (recps) ? CC->room.QRname : SENTITEMS;
2677 syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2678 strcpy(hold_rm, CC->room.QRname);
2679 strcpy(actual_rm, CC->room.QRname);
2680 if (recps != NULL) {
2681 strcpy(actual_rm, SENTITEMS);
2684 /* If the user is a twit, move to the twit room for posting */
2686 if (CC->user.axlevel == AxProbU) {
2687 strcpy(hold_rm, actual_rm);
2688 strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2689 syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2693 /* ...or if this message is destined for Aide> then go there. */
2694 if (!IsEmptyStr(force_room)) {
2695 strcpy(actual_rm, force_room);
2698 syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2699 if (strcasecmp(actual_rm, CC->room.QRname)) {
2700 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2704 * If this message has no O (room) field, generate one.
2706 if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2707 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
2710 /* Perform "before save" hooks (aborting if any return nonzero) */
2711 syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2712 if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2715 * If this message has an Exclusive ID, and the room is replication
2716 * checking enabled, then do replication checks.
2718 if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2719 ReplicationChecks(msg);
2722 /* Save it to disk */
2723 syslog(LOG_DEBUG, "msgbase: saving to disk");
2724 newmsgid = send_message(msg);
2725 if (newmsgid <= 0L) return(-5);
2727 /* Write a supplemental message info record. This doesn't have to
2728 * be a critical section because nobody else knows about this message
2731 syslog(LOG_DEBUG, "msgbase: creating metadata record");
2732 memset(&smi, 0, sizeof(struct MetaData));
2733 smi.meta_msgnum = newmsgid;
2734 smi.meta_refcount = 0;
2735 safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type);
2738 * Measure how big this message will be when rendered as RFC822.
2739 * We do this for two reasons:
2740 * 1. We need the RFC822 length for the new metadata record, so the
2741 * POP and IMAP services don't have to calculate message lengths
2742 * while the user is waiting (multiplied by potentially hundreds
2743 * or thousands of messages).
2744 * 2. If journaling is enabled, we will need an RFC822 version of the
2745 * message to attach to the journalized copy.
2747 if (CC->redirect_buffer != NULL) {
2748 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2751 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2752 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2753 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2754 saved_rfc822_version = CC->redirect_buffer;
2755 CC->redirect_buffer = NULL;
2759 /* Now figure out where to store the pointers */
2760 syslog(LOG_DEBUG, "msgbase: storing pointers");
2762 /* If this is being done by the networker delivering a private
2763 * message, we want to BYPASS saving the sender's copy (because there
2764 * is no local sender; it would otherwise go to the Trashcan).
2766 if ((!CC->internal_pgm) || (recps == NULL)) {
2767 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2768 syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm);
2769 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2773 /* For internet mail, drop a copy in the outbound queue room */
2774 if ((recps != NULL) && (recps->num_internet > 0)) {
2775 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2778 /* If other rooms are specified, drop them there too. */
2779 if ((recps != NULL) && (recps->num_room > 0)) {
2780 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2781 extract_token(recipient, recps->recp_room, i, '|', sizeof recipient);
2782 syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2783 CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2787 /* Bump this user's messages posted counter. */
2788 syslog(LOG_DEBUG, "msgbase: updating user");
2789 CtdlLockGetCurrentUser();
2790 CC->user.posted = CC->user.posted + 1;
2791 CtdlPutCurrentUserLock();
2793 /* Decide where bounces need to be delivered */
2794 if ((recps != NULL) && (recps->bounce_to == NULL)) {
2795 if (CC->logged_in) {
2796 strcpy(bounce_to, CC->user.fullname);
2798 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2799 strcpy(bounce_to, msg->cm_fields[eAuthor]);
2801 recps->bounce_to = bounce_to;
2804 CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2806 /* If this is private, local mail, make a copy in the
2807 * recipient's mailbox and bump the reference count.
2809 if ((recps != NULL) && (recps->num_local > 0)) {
2813 pch = recps->recp_local;
2814 recps->recp_local = recipient;
2815 ntokens = num_tokens(pch, '|');
2816 for (i=0; i<ntokens; ++i) {
2817 extract_token(recipient, pch, i, '|', sizeof recipient);
2818 syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2819 if (CtdlGetUser(&userbuf, recipient) == 0) {
2820 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2821 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2822 CtdlBumpNewMailCounter(userbuf.usernum);
2823 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2826 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2827 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2830 recps->recp_local = pch;
2833 /* Perform "after save" hooks */
2834 syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2836 PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2837 CM_FlushField(msg, eVltMsgNum);
2839 /* Go back to the room we started from */
2840 syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2841 if (strcasecmp(hold_rm, CC->room.QRname)) {
2842 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2846 * Any addresses to harvest for someone's address book?
2848 if ( (CC->logged_in) && (recps != NULL) ) {
2849 collected_addresses = harvest_collected_addresses(msg);
2852 if (collected_addresses != NULL) {
2853 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2854 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2855 aptr->roomname = strdup(actual_rm);
2856 aptr->collected_addresses = collected_addresses;
2857 begin_critical_section(S_ATBF);
2860 end_critical_section(S_ATBF);
2864 * Determine whether this message qualifies for journaling.
2866 if (!CM_IsEmpty(msg, eJournal)) {
2867 qualified_for_journaling = 0;
2870 if (recps == NULL) {
2871 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2873 else if (recps->num_local + recps->num_internet > 0) {
2874 qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2877 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2882 * Do we have to perform journaling? If so, hand off the saved
2883 * RFC822 version will be handed off to the journaler for background
2884 * submit. Otherwise, we have to free the memory ourselves.
2886 if (saved_rfc822_version != NULL) {
2887 if (qualified_for_journaling) {
2888 JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2891 FreeStrBuf(&saved_rfc822_version);
2895 if ((recps != NULL) && (recps->bounce_to == bounce_to))
2896 recps->bounce_to = NULL;
2904 * Convenience function for generating small administrative messages.
2906 long quickie_message(char *from,
2914 struct CtdlMessage *msg;
2915 struct recptypes *recp = NULL;
2917 msg = malloc(sizeof(struct CtdlMessage));
2918 memset(msg, 0, sizeof(struct CtdlMessage));
2919 msg->cm_magic = CTDLMESSAGE_MAGIC;
2920 msg->cm_anon_type = MES_NORMAL;
2921 msg->cm_format_type = format_type;
2923 if (!IsEmptyStr(from)) {
2924 CM_SetField(msg, eAuthor, from, -1);
2926 else if (!IsEmptyStr(fromaddr)) {
2928 CM_SetField(msg, eAuthor, fromaddr, -1);
2929 pAt = strchr(msg->cm_fields[eAuthor], '@');
2931 CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
2935 msg->cm_fields[eAuthor] = strdup("Citadel");
2938 if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr, -1);
2939 if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room, -1);
2940 if (!IsEmptyStr(to)) {
2941 CM_SetField(msg, eRecipient, to, -1);
2942 recp = validate_recipients(to, NULL, 0);
2944 if (!IsEmptyStr(subject)) {
2945 CM_SetField(msg, eMsgSubject, subject, -1);
2947 if (!IsEmptyStr(text)) {
2948 CM_SetField(msg, eMesageText, text, -1);
2951 long msgnum = CtdlSubmitMsg(msg, recp, room);
2953 if (recp != NULL) free_recipients(recp);
2959 * Back end function used by CtdlMakeMessage() and similar functions
2961 StrBuf *CtdlReadMessageBodyBuf(char *terminator, // token signalling EOT
2963 size_t maxlen, // maximum message length
2964 StrBuf *exist, // if non-null, append to it; exist is ALWAYS freed
2965 int crlf // CRLF newlines instead of LF
2973 LineBuf = NewStrBufPlain(NULL, SIZ);
2974 if (exist == NULL) {
2975 Message = NewStrBufPlain(NULL, 4 * SIZ);
2978 Message = NewStrBufDup(exist);
2981 /* Do we need to change leading ".." to "." for SMTP escaping? */
2982 if ((tlen == 1) && (*terminator == '.')) {
2986 /* read in the lines of message text one by one */
2988 if (CtdlClientGetLine(LineBuf) < 0) {
2991 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
2994 if ( (!flushing) && (!finished) ) {
2996 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
2999 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
3002 /* Unescape SMTP-style input of two dots at the beginning of the line */
3003 if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
3004 StrBufCutLeft(LineBuf, 1);
3006 StrBufAppendBuf(Message, LineBuf, 0);
3009 /* if we've hit the max msg length, flush the rest */
3010 if (StrLength(Message) >= maxlen) {
3014 } while (!finished);
3015 FreeStrBuf(&LineBuf);
3018 syslog(LOG_ERR, "msgbase: exceeded maximum message length of %ld - message was truncated", maxlen);
3025 // Back end function used by CtdlMakeMessage() and similar functions
3026 char *CtdlReadMessageBody(char *terminator, // token signalling EOT
3028 size_t maxlen, // maximum message length
3029 StrBuf *exist, // if non-null, append to it; exist is ALWAYS freed
3030 int crlf // CRLF newlines instead of LF
3034 Message = CtdlReadMessageBodyBuf(terminator,
3040 if (Message == NULL) {
3044 return SmashStrBuf(&Message);
3049 struct CtdlMessage *CtdlMakeMessage(
3050 struct ctdluser *author, /* author's user structure */
3051 char *recipient, /* NULL if it's not mail */
3052 char *recp_cc, /* NULL if it's not mail */
3053 char *room, /* room where it's going */
3054 int type, /* see MES_ types in header file */
3055 int format_type, /* variformat, plain text, MIME... */
3056 char *fake_name, /* who we're masquerading as */
3057 char *my_email, /* which of my email addresses to use (empty is ok) */
3058 char *subject, /* Subject (optional) */
3059 char *supplied_euid, /* ...or NULL if this is irrelevant */
3060 char *preformatted_text, /* ...or NULL to read text from client */
3061 char *references /* Thread references */
3063 return CtdlMakeMessageLen(
3064 author, /* author's user structure */
3065 recipient, /* NULL if it's not mail */
3066 (recipient)?strlen(recipient) : 0,
3067 recp_cc, /* NULL if it's not mail */
3068 (recp_cc)?strlen(recp_cc): 0,
3069 room, /* room where it's going */
3070 (room)?strlen(room): 0,
3071 type, /* see MES_ types in header file */
3072 format_type, /* variformat, plain text, MIME... */
3073 fake_name, /* who we're masquerading as */
3074 (fake_name)?strlen(fake_name): 0,
3075 my_email, /* which of my email addresses to use (empty is ok) */
3076 (my_email)?strlen(my_email): 0,
3077 subject, /* Subject (optional) */
3078 (subject)?strlen(subject): 0,
3079 supplied_euid, /* ...or NULL if this is irrelevant */
3080 (supplied_euid)?strlen(supplied_euid):0,
3081 preformatted_text, /* ...or NULL to read text from client */
3082 (preformatted_text)?strlen(preformatted_text) : 0,
3083 references, /* Thread references */
3084 (references)?strlen(references):0);
3090 * Build a binary message to be saved on disk.
3091 * (NOTE: if you supply 'preformatted_text', the buffer you give it
3092 * will become part of the message. This means you are no longer
3093 * responsible for managing that memory -- it will be freed along with
3094 * the rest of the fields when CM_Free() is called.)
3096 struct CtdlMessage *CtdlMakeMessageLen(
3097 struct ctdluser *author, /* author's user structure */
3098 char *recipient, /* NULL if it's not mail */
3100 char *recp_cc, /* NULL if it's not mail */
3102 char *room, /* room where it's going */
3104 int type, /* see MES_ types in header file */
3105 int format_type, /* variformat, plain text, MIME... */
3106 char *fake_name, /* who we're masquerading as */
3108 char *my_email, /* which of my email addresses to use (empty is ok) */
3110 char *subject, /* Subject (optional) */
3112 char *supplied_euid, /* ...or NULL if this is irrelevant */
3114 char *preformatted_text, /* ...or NULL to read text from client */
3116 char *references, /* Thread references */
3121 struct CtdlMessage *msg;
3123 StrBuf *FakeEncAuthor = NULL;
3125 msg = malloc(sizeof(struct CtdlMessage));
3126 memset(msg, 0, sizeof(struct CtdlMessage));
3127 msg->cm_magic = CTDLMESSAGE_MAGIC;
3128 msg->cm_anon_type = type;
3129 msg->cm_format_type = format_type;
3131 if (recipient != NULL) rcplen = striplt(recipient);
3132 if (recp_cc != NULL) cclen = striplt(recp_cc);
3134 /* Path or Return-Path */
3136 CM_SetField(msg, eMessagePath, my_email, myelen);
3138 else if (!IsEmptyStr(author->fullname)) {
3139 CM_SetField(msg, eMessagePath, author->fullname, -1);
3141 convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
3143 blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
3144 CM_SetField(msg, eTimestamp, buf, blen);
3147 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
3150 FakeAuthor = NewStrBufPlain (author->fullname, -1);
3152 StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
3153 CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
3154 FreeStrBuf(&FakeAuthor);
3156 if (!!IsEmptyStr(CC->room.QRname)) {
3157 if (CC->room.QRflags & QR_MAILBOX) { /* room */
3158 CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11], -1);
3161 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
3166 CM_SetField(msg, eRecipient, recipient, rcplen);
3169 CM_SetField(msg, eCarbonCopY, recp_cc, cclen);
3173 CM_SetField(msg, erFc822Addr, my_email, myelen);
3175 else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3176 CM_SetField(msg, erFc822Addr, CC->cs_inet_email, -1);
3179 if (subject != NULL) {
3181 length = striplt(subject);
3187 while ((subject[i] != '\0') &&
3188 (IsAscii = isascii(subject[i]) != 0 ))
3191 CM_SetField(msg, eMsgSubject, subject, subjlen);
3192 else /* ok, we've got utf8 in the string. */
3195 rfc2047Subj = rfc2047encode(subject, length);
3196 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3203 CM_SetField(msg, eExclusiveID, supplied_euid, euidlen);
3207 CM_SetField(msg, eWeferences, references, reflen);
3210 if (preformatted_text != NULL) {
3211 CM_SetField(msg, eMesageText, preformatted_text, textlen);
3215 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3216 if (MsgBody != NULL) {
3217 CM_SetAsFieldSB(msg, eMesageText, &MsgBody);
3226 * API function to delete messages which match a set of criteria
3227 * (returns the actual number of messages deleted)
3229 int CtdlDeleteMessages(const char *room_name, // which room
3230 long *dmsgnums, // array of msg numbers to be deleted
3231 int num_dmsgnums, // number of msgs to be deleted, or 0 for "any"
3232 char *content_type // or "" for any. regular expressions expected.
3234 struct ctdlroom qrbuf;
3235 struct cdbdata *cdbfr;
3236 long *msglist = NULL;
3237 long *dellist = NULL;
3240 int num_deleted = 0;
3242 struct MetaData smi;
3245 int need_to_free_re = 0;
3247 if (content_type) if (!IsEmptyStr(content_type)) {
3248 regcomp(&re, content_type, 0);
3249 need_to_free_re = 1;
3251 syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3253 /* get room record, obtaining a lock... */
3254 if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3255 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3256 if (need_to_free_re) regfree(&re);
3257 return(0); /* room not found */
3259 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
3261 if (cdbfr != NULL) {
3262 dellist = malloc(cdbfr->len);
3263 msglist = (long *) cdbfr->ptr;
3264 cdbfr->ptr = NULL; /* CtdlDeleteMessages() now owns this memory */
3265 num_msgs = cdbfr->len / sizeof(long);
3269 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3270 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3271 int have_more_del = 1;
3273 num_msgs = sort_msglist(msglist, num_msgs);
3274 if (num_dmsgnums > 1)
3275 num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3278 StrBuf *dbg = NewStrBuf();
3279 for (i = 0; i < num_dmsgnums; i++)
3280 StrBufAppendPrintf(dbg, ", %ld", dmsgnums[i]);
3281 syslog(LOG_DEBUG, "msgbase: Deleting before: %s", ChrPtr(dbg));
3286 while ((i < num_msgs) && (have_more_del)) {
3289 /* Set/clear a bit for each criterion */
3291 /* 0 messages in the list or a null list means that we are
3292 * interested in deleting any messages which meet the other criteria.
3295 delete_this |= 0x01;
3298 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3303 if (msglist[i] == dmsgnums[j]) {
3304 delete_this |= 0x01;
3307 have_more_del = (j < num_dmsgnums);
3310 if (have_contenttype) {
3311 GetMetaData(&smi, msglist[i]);
3312 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3313 delete_this |= 0x02;
3316 delete_this |= 0x02;
3319 /* Delete message only if all bits are set */
3320 if (delete_this == 0x03) {
3321 dellist[num_deleted++] = msglist[i];
3328 StrBuf *dbg = NewStrBuf();
3329 for (i = 0; i < num_deleted; i++)
3330 StrBufAppendPrintf(dbg, ", %ld", dellist[i]);
3331 syslog(LOG_DEBUG, "msgbase: Deleting: %s", ChrPtr(dbg));
3335 num_msgs = sort_msglist(msglist, num_msgs);
3336 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long),
3337 msglist, (int)(num_msgs * sizeof(long)));
3340 qrbuf.QRhighest = msglist[num_msgs - 1];
3342 qrbuf.QRhighest = 0;
3344 CtdlPutRoomLock(&qrbuf);
3346 /* Go through the messages we pulled out of the index, and decrement
3347 * their reference counts by 1. If this is the only room the message
3348 * was in, the reference count will reach zero and the message will
3349 * automatically be deleted from the database. We do this in a
3350 * separate pass because there might be plug-in hooks getting called,
3351 * and we don't want that happening during an S_ROOMS critical
3355 for (i=0; i<num_deleted; ++i) {
3356 PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3358 AdjRefCountList(dellist, num_deleted, -1);
3360 /* Now free the memory we used, and go away. */
3361 if (msglist != NULL) free(msglist);
3362 if (dellist != NULL) free(dellist);
3363 syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3364 if (need_to_free_re) regfree(&re);
3365 return (num_deleted);
3370 * GetMetaData() - Get the supplementary record for a message
3372 void GetMetaData(struct MetaData *smibuf, long msgnum)
3374 struct cdbdata *cdbsmi;
3377 memset(smibuf, 0, sizeof(struct MetaData));
3378 smibuf->meta_msgnum = msgnum;
3379 smibuf->meta_refcount = 1; /* Default reference count is 1 */
3381 /* Use the negative of the message number for its supp record index */
3382 TheIndex = (0L - msgnum);
3384 cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3385 if (cdbsmi == NULL) {
3386 return; /* record not found; leave it alone */
3388 memcpy(smibuf, cdbsmi->ptr,
3389 ((cdbsmi->len > sizeof(struct MetaData)) ?
3390 sizeof(struct MetaData) : cdbsmi->len)
3398 * PutMetaData() - (re)write supplementary record for a message
3400 void PutMetaData(struct MetaData *smibuf)
3404 /* Use the negative of the message number for the metadata db index */
3405 TheIndex = (0L - smibuf->meta_msgnum);
3407 cdb_store(CDB_MSGMAIN,
3408 &TheIndex, (int)sizeof(long),
3409 smibuf, (int)sizeof(struct MetaData)
3415 * Convenience function to process a big block of AdjRefCount() operations
3417 void AdjRefCountList(long *msgnum, long nmsg, int incr)
3421 for (i = 0; i < nmsg; i++) {
3422 AdjRefCount(msgnum[i], incr);
3428 * AdjRefCount - adjust the reference count for a message. We need to delete from disk any message whose reference count reaches zero.
3430 void AdjRefCount(long msgnum, int incr)
3432 struct MetaData smi;
3435 /* This is a *tight* critical section; please keep it that way, as
3436 * it may get called while nested in other critical sections.
3437 * Complicating this any further will surely cause deadlock!
3439 begin_critical_section(S_SUPPMSGMAIN);
3440 GetMetaData(&smi, msgnum);
3441 smi.meta_refcount += incr;
3443 end_critical_section(S_SUPPMSGMAIN);
3444 syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3446 /* If the reference count is now zero, delete both the message and its metadata record.
3448 if (smi.meta_refcount == 0) {
3449 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3451 /* Call delete hooks with NULL room to show it has gone altogether */
3452 PerformDeleteHooks(NULL, msgnum);
3454 /* Remove from message base */
3456 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3457 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));
3459 /* Remove metadata record */
3460 delnum = (0L - msgnum);
3461 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3467 * Write a generic object to this room
3469 * Returns the message number of the written object, in case you need it.
3471 long CtdlWriteObject(char *req_room, /* Room to stuff it in */
3472 char *content_type, /* MIME type of this object */
3473 char *raw_message, /* Data to be written */
3474 off_t raw_length, /* Size of raw_message */
3475 struct ctdluser *is_mailbox, /* Mailbox room? */
3476 int is_binary, /* Is encoding necessary? */
3477 unsigned int flags /* Internal save flags */
3479 struct ctdlroom qrbuf;
3480 char roomname[ROOMNAMELEN];
3481 struct CtdlMessage *msg;
3482 StrBuf *encoded_message = NULL;
3484 if (is_mailbox != NULL) {
3485 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3488 safestrncpy(roomname, req_room, sizeof(roomname));
3491 syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3494 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3497 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3500 StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3501 StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3502 StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3505 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3508 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3512 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3515 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3518 syslog(LOG_DEBUG, "msgbase: allocating");
3519 msg = malloc(sizeof(struct CtdlMessage));
3520 memset(msg, 0, sizeof(struct CtdlMessage));
3521 msg->cm_magic = CTDLMESSAGE_MAGIC;
3522 msg->cm_anon_type = MES_NORMAL;
3523 msg->cm_format_type = 4;
3524 CM_SetField(msg, eAuthor, CC->user.fullname, -1);
3525 CM_SetField(msg, eOriginalRoom, req_room, -1);
3526 msg->cm_flags = flags;
3528 CM_SetAsFieldSB(msg, eMesageText, &encoded_message);
3530 /* Create the requested room if we have to. */
3531 if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3532 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3535 /* Now write the data */
3536 long new_msgnum = CtdlSubmitMsg(msg, NULL, roomname);
3542 /************************************************************************/
3543 /* MODULE INITIALIZATION */
3544 /************************************************************************/
3546 char *ctdl_module_init_msgbase(void) {
3548 FillMsgKeyLookupTable();
3551 /* return our module id for the log */