2 * Implements the message store.
4 * Copyright (c) 1987-2020 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
21 #include <libcitadel.h>
22 #include "ctdl_module.h"
23 #include "citserver.h"
26 #include "clientsocket.h"
30 #include "internet_addressing.h"
31 #include "euidindex.h"
33 #include "journaling.h"
35 struct addresses_to_be_filed *atbf = NULL;
38 * These are the four-character field headers we use when outputting
39 * messages in Citadel format (as opposed to RFC822 format).
42 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
43 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
44 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
45 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
46 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
47 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
48 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
49 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
51 "from", // A -> eAuthor
52 NULL, // B -> eBig_message
53 NULL, // C (formerly used as eRemoteRoom)
54 NULL, // D (formerly used as eDestination)
55 "exti", // E -> eXclusivID
56 "rfca", // F -> erFc822Addr
58 "hnod", // H (formerly used as eHumanNode)
59 "msgn", // I -> emessageId
60 "jrnl", // J -> eJournal
61 "rep2", // K -> eReplyTo
62 "list", // L -> eListID
63 "text", // M -> eMesageText
64 NULL, // N (formerly used as eNodeName)
65 "room", // O -> eOriginalRoom
66 "path", // P -> eMessagePath
68 "rcpt", // R -> eRecipient
69 NULL, // S (formerly used as eSpecialField)
70 "time", // T -> eTimestamp
71 "subj", // U -> eMsgSubject
72 "nvto", // V -> eenVelopeTo
73 "wefw", // W -> eWeferences
75 "cccc", // Y -> eCarbonCopY
79 HashList *msgKeyLookup = NULL;
81 int GetFieldFromMnemonic(eMsgField *f, const char* c)
84 if (GetHash(msgKeyLookup, c, 4, &v)) {
91 void FillMsgKeyLookupTable(void)
95 msgKeyLookup = NewHash (1, FourHash);
97 for (i=0; i < 91; i++) {
98 if (msgkeys[i] != NULL) {
99 Put(msgKeyLookup, msgkeys[i], 4, (void*)i, reference_free_handler);
104 eMsgField FieldOrder[] = {
105 /* Important fields */
113 /* Semi-important fields */
118 /* G is not used yet */
121 /* Q is not used yet */
123 /* X is not used yet */
124 /* Z is not used yet */
131 /* Message text (MUST be last) */
133 /* Not saved to disk:
138 static const long NDiskFields = sizeof(FieldOrder) / sizeof(eMsgField);
141 int CM_IsEmpty(struct CtdlMessage *Msg, eMsgField which)
143 return !((Msg->cm_fields[which] != NULL) && (Msg->cm_fields[which][0] != '\0'));
147 void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length)
149 if (Msg->cm_fields[which] != NULL) {
150 free (Msg->cm_fields[which]);
152 Msg->cm_fields[which] = malloc(length + 1);
153 memcpy(Msg->cm_fields[which], buf, length);
154 Msg->cm_fields[which][length] = '\0';
155 Msg->cm_lengths[which] = length;
159 void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue)
163 len = snprintf(buf, sizeof(buf), "%ld", lvalue);
164 CM_SetField(Msg, which, buf, len);
168 void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen)
170 if (Msg->cm_fields[WhichToCut] == NULL)
173 if (Msg->cm_lengths[WhichToCut] > maxlen)
175 Msg->cm_fields[WhichToCut][maxlen] = '\0';
176 Msg->cm_lengths[WhichToCut] = maxlen;
181 void CM_FlushField(struct CtdlMessage *Msg, eMsgField which)
183 if (Msg->cm_fields[which] != NULL)
184 free (Msg->cm_fields[which]);
185 Msg->cm_fields[which] = NULL;
186 Msg->cm_lengths[which] = 0;
190 void CM_Flush(struct CtdlMessage *Msg)
194 if (CM_IsValidMsg(Msg) == 0) {
198 for (i = 0; i < 256; ++i) {
199 CM_FlushField(Msg, i);
204 void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy)
207 if (Msg->cm_fields[WhichToPutTo] != NULL) {
208 free (Msg->cm_fields[WhichToPutTo]);
211 if (Msg->cm_fields[WhichtToCopy] != NULL) {
212 len = Msg->cm_lengths[WhichtToCopy];
213 Msg->cm_fields[WhichToPutTo] = malloc(len + 1);
214 memcpy(Msg->cm_fields[WhichToPutTo], Msg->cm_fields[WhichtToCopy], len);
215 Msg->cm_fields[WhichToPutTo][len] = '\0';
216 Msg->cm_lengths[WhichToPutTo] = len;
219 Msg->cm_fields[WhichToPutTo] = NULL;
220 Msg->cm_lengths[WhichToPutTo] = 0;
225 void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length)
227 if (Msg->cm_fields[which] != NULL) {
232 oldmsgsize = Msg->cm_lengths[which] + 1;
233 newmsgsize = length + oldmsgsize;
235 new = malloc(newmsgsize);
236 memcpy(new, buf, length);
237 memcpy(new + length, Msg->cm_fields[which], oldmsgsize);
238 free(Msg->cm_fields[which]);
239 Msg->cm_fields[which] = new;
240 Msg->cm_lengths[which] = newmsgsize - 1;
243 Msg->cm_fields[which] = malloc(length + 1);
244 memcpy(Msg->cm_fields[which], buf, length);
245 Msg->cm_fields[which][length] = '\0';
246 Msg->cm_lengths[which] = length;
251 void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length)
253 if (Msg->cm_fields[which] != NULL) {
254 free (Msg->cm_fields[which]);
257 Msg->cm_fields[which] = *buf;
259 Msg->cm_lengths[which] = length;
263 void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf)
265 if (Msg->cm_fields[which] != NULL) {
266 free (Msg->cm_fields[which]);
269 Msg->cm_lengths[which] = StrLength(*buf);
270 Msg->cm_fields[which] = SmashStrBuf(buf);
274 void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen)
276 if (Msg->cm_fields[which] != NULL) {
277 *retlen = Msg->cm_lengths[which];
278 *ret = Msg->cm_fields[which];
279 Msg->cm_fields[which] = NULL;
280 Msg->cm_lengths[which] = 0;
290 * Returns 1 if the supplied pointer points to a valid Citadel message.
291 * If the pointer is NULL or the magic number check fails, returns 0.
293 int CM_IsValidMsg(struct CtdlMessage *msg) {
297 if ((msg->cm_magic) != CTDLMESSAGE_MAGIC) {
298 syslog(LOG_WARNING, "msgbase: CM_IsValidMsg() self-check failed");
305 void CM_FreeContents(struct CtdlMessage *msg)
309 for (i = 0; i < 256; ++i)
310 if (msg->cm_fields[i] != NULL) {
311 free(msg->cm_fields[i]);
312 msg->cm_lengths[i] = 0;
315 msg->cm_magic = 0; /* just in case */
320 * 'Destructor' for struct CtdlMessage
322 void CM_Free(struct CtdlMessage *msg)
324 if (CM_IsValidMsg(msg) == 0) {
325 if (msg != NULL) free (msg);
328 CM_FreeContents(msg);
333 int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg)
336 len = OrgMsg->cm_lengths[i];
337 NewMsg->cm_fields[i] = malloc(len + 1);
338 if (NewMsg->cm_fields[i] == NULL) {
341 memcpy(NewMsg->cm_fields[i], OrgMsg->cm_fields[i], len);
342 NewMsg->cm_fields[i][len] = '\0';
343 NewMsg->cm_lengths[i] = len;
348 struct CtdlMessage * CM_Duplicate(struct CtdlMessage *OrgMsg)
351 struct CtdlMessage *NewMsg;
353 if (CM_IsValidMsg(OrgMsg) == 0) {
356 NewMsg = (struct CtdlMessage *)malloc(sizeof(struct CtdlMessage));
357 if (NewMsg == NULL) {
361 memcpy(NewMsg, OrgMsg, sizeof(struct CtdlMessage));
363 memset(&NewMsg->cm_fields, 0, sizeof(char*) * 256);
365 for (i = 0; i < 256; ++i) {
366 if (OrgMsg->cm_fields[i] != NULL) {
367 if (!CM_DupField(i, OrgMsg, NewMsg)) {
378 /* Determine if a given message matches the fields in a message template.
379 * Return 0 for a successful match.
381 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) {
384 /* If there aren't any fields in the template, all messages will
387 if (template == NULL) return(0);
389 /* Null messages are bogus. */
390 if (msg == NULL) return(1);
392 for (i='A'; i<='Z'; ++i) {
393 if (template->cm_fields[i] != NULL) {
394 if (msg->cm_fields[i] == NULL) {
395 /* Considered equal if temmplate is empty string */
396 if (IsEmptyStr(template->cm_fields[i])) continue;
399 if ((template->cm_lengths[i] != msg->cm_lengths[i]) ||
400 (strcasecmp(msg->cm_fields[i], template->cm_fields[i])))
405 /* All compares succeeded: we have a match! */
411 * Retrieve the "seen" message list for the current room.
413 void CtdlGetSeen(char *buf, int which_set) {
416 /* Learn about the user and room in question */
417 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
419 if (which_set == ctdlsetseen_seen) {
420 safestrncpy(buf, vbuf.v_seen, SIZ);
422 if (which_set == ctdlsetseen_answered) {
423 safestrncpy(buf, vbuf.v_answered, SIZ);
429 * Manipulate the "seen msgs" string (or other message set strings)
431 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
432 int target_setting, int which_set,
433 struct ctdluser *which_user, struct ctdlroom *which_room) {
434 struct cdbdata *cdbfr;
448 char *is_set; /* actually an array of booleans */
450 /* Don't bother doing *anything* if we were passed a list of zero messages */
451 if (num_target_msgnums < 1) {
455 /* If no room was specified, we go with the current room. */
457 which_room = &CC->room;
460 /* If no user was specified, we go with the current user. */
462 which_user = &CC->user;
465 syslog(LOG_DEBUG, "msgbase: CtdlSetSeen(%d msgs starting with %ld, %s, %d) in <%s>",
466 num_target_msgnums, target_msgnums[0],
467 (target_setting ? "SET" : "CLEAR"),
471 /* Learn about the user and room in question */
472 CtdlGetRelationship(&vbuf, which_user, which_room);
474 /* Load the message list */
475 cdbfr = cdb_fetch(CDB_MSGLISTS, &which_room->QRnumber, sizeof(long));
477 msglist = (long *) cdbfr->ptr;
478 cdbfr->ptr = NULL; /* CtdlSetSeen() now owns this memory */
479 num_msgs = cdbfr->len / sizeof(long);
482 return; /* No messages at all? No further action. */
485 is_set = malloc(num_msgs * sizeof(char));
486 memset(is_set, 0, (num_msgs * sizeof(char)) );
488 /* Decide which message set we're manipulating */
490 case ctdlsetseen_seen:
491 vset = NewStrBufPlain(vbuf.v_seen, -1);
493 case ctdlsetseen_answered:
494 vset = NewStrBufPlain(vbuf.v_answered, -1);
501 #if 0 /* This is a special diagnostic section. Do not allow it to run during normal operation. */
502 syslog(LOG_DEBUG, "There are %d messages in the room.\n", num_msgs);
503 for (i=0; i<num_msgs; ++i) {
504 if ((i > 0) && (msglist[i] <= msglist[i-1])) abort();
506 syslog(LOG_DEBUG, "We are twiddling %d of them.\n", num_target_msgnums);
507 for (k=0; k<num_target_msgnums; ++k) {
508 if ((k > 0) && (target_msgnums[k] <= target_msgnums[k-1])) abort();
512 /* Translate the existing sequence set into an array of booleans */
513 setstr = NewStrBuf();
517 while (StrBufExtract_NextToken(setstr, vset, &pvset, ',') >= 0) {
519 StrBufExtract_token(lostr, setstr, 0, ':');
520 if (StrBufNum_tokens(setstr, ':') >= 2) {
521 StrBufExtract_token(histr, setstr, 1, ':');
525 StrBufAppendBuf(histr, lostr, 0);
528 if (!strcmp(ChrPtr(histr), "*")) {
535 for (i = 0; i < num_msgs; ++i) {
536 if ((msglist[i] >= lo) && (msglist[i] <= hi)) {
545 /* Now translate the array of booleans back into a sequence set */
551 for (i=0; i<num_msgs; ++i) {
555 for (k=0; k<num_target_msgnums; ++k) {
556 if (msglist[i] == target_msgnums[k]) {
557 is_seen = target_setting;
561 if ((was_seen == 0) && (is_seen == 1)) {
564 else if ((was_seen == 1) && (is_seen == 0)) {
567 if (StrLength(vset) > 0) {
568 StrBufAppendBufPlain(vset, HKEY(","), 0);
571 StrBufAppendPrintf(vset, "%ld", hi);
574 StrBufAppendPrintf(vset, "%ld:%ld", lo, hi);
578 if ((is_seen) && (i == num_msgs - 1)) {
579 if (StrLength(vset) > 0) {
580 StrBufAppendBufPlain(vset, HKEY(","), 0);
582 if ((i==0) || (was_seen == 0)) {
583 StrBufAppendPrintf(vset, "%ld", msglist[i]);
586 StrBufAppendPrintf(vset, "%ld:%ld", lo, msglist[i]);
594 * We will have to stuff this string back into a 4096 byte buffer, so if it's
595 * larger than that now, truncate it by removing tokens from the beginning.
596 * The limit of 100 iterations is there to prevent an infinite loop in case
597 * something unexpected happens.
599 int number_of_truncations = 0;
600 while ( (StrLength(vset) > SIZ) && (number_of_truncations < 100) ) {
601 StrBufRemove_token(vset, 0, ',');
602 ++number_of_truncations;
606 * If we're truncating the sequence set of messages marked with the 'seen' flag,
607 * we want the earliest messages (the truncated ones) to be marked, not unmarked.
608 * Otherwise messages at the beginning will suddenly appear to be 'unseen'.
610 if ( (which_set == ctdlsetseen_seen) && (number_of_truncations > 0) ) {
612 first_tok = NewStrBuf();
613 StrBufExtract_token(first_tok, vset, 0, ',');
614 StrBufRemove_token(vset, 0, ',');
616 if (StrBufNum_tokens(first_tok, ':') > 1) {
617 StrBufRemove_token(first_tok, 0, ':');
621 new_set = NewStrBuf();
622 StrBufAppendBufPlain(new_set, HKEY("1:"), 0);
623 StrBufAppendBuf(new_set, first_tok, 0);
624 StrBufAppendBufPlain(new_set, HKEY(":"), 0);
625 StrBufAppendBuf(new_set, vset, 0);
628 FreeStrBuf(&first_tok);
632 /* Decide which message set we're manipulating */
634 case ctdlsetseen_seen:
635 safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen);
637 case ctdlsetseen_answered:
638 safestrncpy(vbuf.v_answered, ChrPtr(vset), sizeof vbuf.v_answered);
644 CtdlSetRelationship(&vbuf, which_user, which_room);
650 * API function to perform an operation for each qualifying message in the
651 * current room. (Returns the number of messages processed.)
653 int CtdlForEachMessage(int mode, long ref, char *search_string,
655 struct CtdlMessage *compare,
656 ForEachMsgCallback CallBack,
661 struct cdbdata *cdbfr;
662 long *msglist = NULL;
664 int num_processed = 0;
667 struct CtdlMessage *msg = NULL;
670 int printed_lastold = 0;
671 int num_search_msgs = 0;
672 long *search_msgs = NULL;
674 int need_to_free_re = 0;
677 if ((content_type) && (!IsEmptyStr(content_type))) {
678 regcomp(&re, content_type, 0);
682 /* Learn about the user and room in question */
683 if (server_shutting_down) {
684 if (need_to_free_re) regfree(&re);
687 CtdlGetUser(&CC->user, CC->curr_user);
689 if (server_shutting_down) {
690 if (need_to_free_re) regfree(&re);
693 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
695 if (server_shutting_down) {
696 if (need_to_free_re) regfree(&re);
700 /* Load the message list */
701 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
703 if (need_to_free_re) regfree(&re);
704 return 0; /* No messages at all? No further action. */
707 msglist = (long *) cdbfr->ptr;
708 num_msgs = cdbfr->len / sizeof(long);
710 cdbfr->ptr = NULL; /* clear this so that cdb_free() doesn't free it */
711 cdb_free(cdbfr); /* we own this memory now */
714 * Now begin the traversal.
716 if (num_msgs > 0) for (a = 0; a < num_msgs; ++a) {
718 /* If the caller is looking for a specific MIME type, filter
719 * out all messages which are not of the type requested.
721 if ((content_type != NULL) && (!IsEmptyStr(content_type))) {
723 /* This call to GetMetaData() sits inside this loop
724 * so that we only do the extra database read per msg
725 * if we need to. Doing the extra read all the time
726 * really kills the server. If we ever need to use
727 * metadata for another search criterion, we need to
728 * move the read somewhere else -- but still be smart
729 * enough to only do the read if the caller has
730 * specified something that will need it.
732 if (server_shutting_down) {
733 if (need_to_free_re) regfree(&re);
737 GetMetaData(&smi, msglist[a]);
739 /* if (strcasecmp(smi.meta_content_type, content_type)) { old non-regex way */
740 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) != 0) {
746 num_msgs = sort_msglist(msglist, num_msgs);
748 /* If a template was supplied, filter out the messages which
749 * don't match. (This could induce some delays!)
752 if (compare != NULL) {
753 for (a = 0; a < num_msgs; ++a) {
754 if (server_shutting_down) {
755 if (need_to_free_re) regfree(&re);
759 msg = CtdlFetchMessage(msglist[a], 1, 1);
761 if (CtdlMsgCmp(msg, compare)) {
770 /* If a search string was specified, get a message list from
771 * the full text index and remove messages which aren't on both
775 * Since the lists are sorted and strictly ascending, and the
776 * output list is guaranteed to be shorter than or equal to the
777 * input list, we overwrite the bottom of the input list. This
778 * eliminates the need to memmove big chunks of the list over and
781 if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
783 /* Call search module via hook mechanism.
784 * NULL means use any search function available.
785 * otherwise replace with a char * to name of search routine
787 CtdlModuleDoSearch(&num_search_msgs, &search_msgs, search_string, "fulltext");
789 if (num_search_msgs > 0) {
793 orig_num_msgs = num_msgs;
795 for (i=0; i<orig_num_msgs; ++i) {
796 for (j=0; j<num_search_msgs; ++j) {
797 if (msglist[i] == search_msgs[j]) {
798 msglist[num_msgs++] = msglist[i];
804 num_msgs = 0; /* No messages qualify */
806 if (search_msgs != NULL) free(search_msgs);
808 /* Now that we've purged messages which don't contain the search
809 * string, treat a MSGS_SEARCH just like a MSGS_ALL from this
816 * Now iterate through the message list, according to the
817 * criteria supplied by the caller.
820 for (a = 0; a < num_msgs; ++a) {
821 if (server_shutting_down) {
822 if (need_to_free_re) regfree(&re);
824 return num_processed;
826 thismsg = msglist[a];
827 if (mode == MSGS_ALL) {
831 is_seen = is_msg_in_sequence_set(
832 vbuf.v_seen, thismsg);
833 if (is_seen) lastold = thismsg;
839 || ((mode == MSGS_OLD) && (is_seen))
840 || ((mode == MSGS_NEW) && (!is_seen))
841 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
842 || ((mode == MSGS_FIRST) && (a < ref))
843 || ((mode == MSGS_GT) && (thismsg > ref))
844 || ((mode == MSGS_LT) && (thismsg < ref))
845 || ((mode == MSGS_EQ) && (thismsg == ref))
848 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
850 CallBack(lastold, userdata);
856 CallBack(thismsg, userdata);
861 if (need_to_free_re) regfree(&re);
864 * We cache the most recent msglist in order to do security checks later
866 if (CC->client_socket > 0) {
867 if (CC->cached_msglist != NULL) {
868 free(CC->cached_msglist);
870 CC->cached_msglist = msglist;
871 CC->cached_num_msgs = num_msgs;
877 return num_processed;
882 * memfmout() - Citadel text formatter and paginator.
883 * Although the original purpose of this routine was to format
884 * text to the reader's screen width, all we're really using it
885 * for here is to format text out to 80 columns before sending it
886 * to the client. The client software may reformat it again.
889 char *mptr, /* where are we going to get our text from? */
890 const char *nl /* string to terminate lines with */
893 unsigned char ch = 0;
900 while (ch=*(mptr++), ch != 0) {
903 if (client_write(outbuf, len) == -1) {
904 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
908 if (client_write(nl, nllen) == -1) {
909 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
914 else if (ch == '\r') {
915 /* Ignore carriage returns. Newlines are always LF or CRLF but never CR. */
917 else if (isspace(ch)) {
918 if (column > 72) { /* Beyond 72 columns, break on the next space */
919 if (client_write(outbuf, len) == -1) {
920 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
924 if (client_write(nl, nllen) == -1) {
925 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
938 if (column > 1000) { /* Beyond 1000 columns, break anywhere */
939 if (client_write(outbuf, len) == -1) {
940 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
944 if (client_write(nl, nllen) == -1) {
945 syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
953 if (client_write(outbuf, len) == -1) {
954 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
957 client_write(nl, nllen);
964 * Callback function for mime parser that simply lists the part
966 void list_this_part(char *name, char *filename, char *partnum, char *disp,
967 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
968 char *cbid, void *cbuserdata)
972 ma = (struct ma_info *)cbuserdata;
973 if (ma->is_ma == 0) {
974 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
988 * Callback function for multipart prefix
990 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
991 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
992 char *cbid, void *cbuserdata)
996 ma = (struct ma_info *)cbuserdata;
997 if (!strcasecmp(cbtype, "multipart/alternative")) {
1001 if (ma->is_ma == 0) {
1002 cprintf("pref=%s|%s\n", partnum, cbtype);
1008 * Callback function for multipart sufffix
1010 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
1011 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1012 char *cbid, void *cbuserdata)
1016 ma = (struct ma_info *)cbuserdata;
1017 if (ma->is_ma == 0) {
1018 cprintf("suff=%s|%s\n", partnum, cbtype);
1020 if (!strcasecmp(cbtype, "multipart/alternative")) {
1027 * Callback function for mime parser that opens a section for downloading
1028 * we use serv_files function here:
1030 extern void OpenCmdResult(char *filename, const char *mime_type);
1031 void mime_download(char *name, char *filename, char *partnum, char *disp,
1032 void *content, char *cbtype, char *cbcharset, size_t length,
1033 char *encoding, char *cbid, void *cbuserdata)
1037 /* Silently go away if there's already a download open. */
1038 if (CC->download_fp != NULL)
1042 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1043 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1045 CC->download_fp = tmpfile();
1046 if (CC->download_fp == NULL) {
1047 syslog(LOG_EMERG, "msgbase: mime_download() couldn't write: %m");
1048 cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
1052 rv = fwrite(content, length, 1, CC->download_fp);
1054 syslog(LOG_EMERG, "msgbase: mime_download() Couldn't write: %m");
1055 cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
1056 fclose(CC->download_fp);
1057 CC->download_fp = NULL;
1060 fflush(CC->download_fp);
1061 rewind(CC->download_fp);
1063 OpenCmdResult(filename, cbtype);
1069 * Callback function for mime parser that outputs a section all at once.
1070 * We can specify the desired section by part number *or* content-id.
1072 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
1073 void *content, char *cbtype, char *cbcharset, size_t length,
1074 char *encoding, char *cbid, void *cbuserdata)
1076 int *found_it = (int *)cbuserdata;
1079 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1080 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1083 cprintf("%d %d|-1|%s|%s|%s\n",
1090 client_write(content, length);
1095 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length)
1097 struct CtdlMessage *ret = NULL;
1099 const char *upper_bound;
1101 cit_uint8_t field_header;
1105 upper_bound = Buffer + Length;
1110 /* Parse the three bytes that begin EVERY message on disk.
1111 * The first is always 0xFF, the on-disk magic number.
1112 * The second is the anonymous/public type byte.
1113 * The third is the format type byte (vari, fixed, or MIME).
1117 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1120 ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1121 memset(ret, 0, sizeof(struct CtdlMessage));
1123 ret->cm_magic = CTDLMESSAGE_MAGIC;
1124 ret->cm_anon_type = *mptr++; /* Anon type byte */
1125 ret->cm_format_type = *mptr++; /* Format type byte */
1128 * The rest is zero or more arbitrary fields. Load them in.
1129 * We're done when we encounter either a zero-length field or
1130 * have just processed the 'M' (message text) field.
1133 field_header = '\0';
1136 /* work around possibly buggy messages: */
1137 while (field_header == '\0') {
1138 if (mptr >= upper_bound) {
1141 field_header = *mptr++;
1143 if (mptr >= upper_bound) {
1146 which = field_header;
1149 CM_SetField(ret, which, mptr, len);
1151 mptr += len + 1; /* advance to next field */
1153 } while ((mptr < upper_bound) && (field_header != 'M'));
1160 * Load a message from disk into memory.
1161 * This is used by CtdlOutputMsg() and other fetch functions.
1163 * NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1164 * using the CM_Free(); function.
1166 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body, int run_msg_hooks)
1168 struct cdbdata *dmsgtext;
1169 struct CtdlMessage *ret = NULL;
1171 syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1172 dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1173 if (dmsgtext == NULL) {
1174 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Failed!", msgnum, with_body);
1178 if (dmsgtext->ptr[dmsgtext->len - 1] != '\0') {
1179 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1180 dmsgtext->ptr[dmsgtext->len - 1] = '\0';
1183 ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext->ptr, dmsgtext->len);
1191 /* Always make sure there's something in the msg text field. If
1192 * it's NULL, the message text is most likely stored separately,
1193 * so go ahead and fetch that. Failing that, just set a dummy
1194 * body so other code doesn't barf.
1196 if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) {
1197 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1198 if (dmsgtext != NULL) {
1199 CM_SetAsField(ret, eMesageText, &dmsgtext->ptr, dmsgtext->len - 1);
1203 if (CM_IsEmpty(ret, eMesageText)) {
1204 CM_SetField(ret, eMesageText, HKEY("\r\n\r\n (no text)\r\n"));
1207 /* Perform "before read" hooks (aborting if any return nonzero) */
1208 if (run_msg_hooks && (PerformMessageHooks(ret, NULL, EVT_BEFOREREAD) > 0)) {
1218 * Pre callback function for multipart/alternative
1220 * NOTE: this differs from the standard behavior for a reason. Normally when
1221 * displaying multipart/alternative you want to show the _last_ usable
1222 * format in the message. Here we show the _first_ one, because it's
1223 * usually text/plain. Since this set of functions is designed for text
1224 * output to non-MIME-aware clients, this is the desired behavior.
1227 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1228 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1229 char *cbid, void *cbuserdata)
1233 ma = (struct ma_info *)cbuserdata;
1234 syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);
1235 if (!strcasecmp(cbtype, "multipart/alternative")) {
1239 if (!strcasecmp(cbtype, "message/rfc822")) {
1246 * Post callback function for multipart/alternative
1248 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1249 void *content, char *cbtype, char *cbcharset, size_t length,
1250 char *encoding, char *cbid, void *cbuserdata)
1254 ma = (struct ma_info *)cbuserdata;
1255 syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);
1256 if (!strcasecmp(cbtype, "multipart/alternative")) {
1260 if (!strcasecmp(cbtype, "message/rfc822")) {
1267 * Inline callback function for mime parser that wants to display text
1269 void fixed_output(char *name, char *filename, char *partnum, char *disp,
1270 void *content, char *cbtype, char *cbcharset, size_t length,
1271 char *encoding, char *cbid, void *cbuserdata)
1278 ma = (struct ma_info *)cbuserdata;
1281 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1282 partnum, filename, cbtype, (long)length
1286 * If we're in the middle of a multipart/alternative scope and
1287 * we've already printed another section, skip this one.
1289 if ( (ma->is_ma) && (ma->did_print) ) {
1290 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1295 if ( (!strcasecmp(cbtype, "text/plain"))
1296 || (IsEmptyStr(cbtype)) ) {
1299 client_write(wptr, length);
1300 if (wptr[length-1] != '\n') {
1307 if (!strcasecmp(cbtype, "text/html")) {
1308 ptr = html_to_ascii(content, length, 80);
1310 client_write(ptr, wlen);
1311 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1318 if (ma->use_fo_hooks) {
1319 if (PerformFixedOutputHooks(cbtype, content, length)) {
1320 /* above function returns nonzero if it handled the part */
1325 if (strncasecmp(cbtype, "multipart/", 10)) {
1326 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1327 partnum, filename, cbtype, (long)length);
1334 * The client is elegant and sophisticated and wants to be choosy about
1335 * MIME content types, so figure out which multipart/alternative part
1336 * we're going to send.
1338 * We use a system of weights. When we find a part that matches one of the
1339 * MIME types we've declared as preferential, we can store it in ma->chosen_part
1340 * and then set ma->chosen_pref to that MIME type's position in our preference
1341 * list. If we then hit another match, we only replace the first match if
1342 * the preference value is lower.
1344 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1345 void *content, char *cbtype, char *cbcharset, size_t length,
1346 char *encoding, char *cbid, void *cbuserdata)
1352 ma = (struct ma_info *)cbuserdata;
1354 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1355 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1356 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1357 if (i < ma->chosen_pref) {
1358 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1359 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1360 ma->chosen_pref = i;
1368 * Now that we've chosen our preferred part, output it.
1370 void output_preferred(char *name,
1384 int add_newline = 0;
1387 char *decoded = NULL;
1388 size_t bytes_decoded;
1391 ma = (struct ma_info *)cbuserdata;
1393 /* This is not the MIME part you're looking for... */
1394 if (strcasecmp(partnum, ma->chosen_part)) return;
1396 /* If the content-type of this part is in our preferred formats
1397 * list, we can simply output it verbatim.
1399 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1400 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1401 if (!strcasecmp(buf, cbtype)) {
1402 /* Yeah! Go! W00t!! */
1403 if (ma->dont_decode == 0)
1404 rc = mime_decode_now (content,
1410 break; /* Give us the chance, maybe theres another one. */
1412 if (rc == 0) text_content = (char *)content;
1414 text_content = decoded;
1415 length = bytes_decoded;
1418 if (text_content[length-1] != '\n') {
1421 cprintf("Content-type: %s", cbtype);
1422 if (!IsEmptyStr(cbcharset)) {
1423 cprintf("; charset=%s", cbcharset);
1425 cprintf("\nContent-length: %d\n",
1426 (int)(length + add_newline) );
1427 if (!IsEmptyStr(encoding)) {
1428 cprintf("Content-transfer-encoding: %s\n", encoding);
1431 cprintf("Content-transfer-encoding: 7bit\n");
1433 cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1435 if (client_write(text_content, length) == -1)
1437 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1440 if (add_newline) cprintf("\n");
1441 if (decoded != NULL) free(decoded);
1446 /* No translations required or possible: output as text/plain */
1447 cprintf("Content-type: text/plain\n\n");
1449 if (ma->dont_decode == 0)
1450 rc = mime_decode_now (content,
1456 return; /* Give us the chance, maybe theres another one. */
1458 if (rc == 0) text_content = (char *)content;
1460 text_content = decoded;
1461 length = bytes_decoded;
1464 fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset,
1465 length, encoding, cbid, cbuserdata);
1466 if (decoded != NULL) free(decoded);
1471 char desired_section[64];
1478 * Callback function for
1480 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1481 void *content, char *cbtype, char *cbcharset, size_t length,
1482 char *encoding, char *cbid, void *cbuserdata)
1484 struct encapmsg *encap;
1486 encap = (struct encapmsg *)cbuserdata;
1488 /* Only proceed if this is the desired section... */
1489 if (!strcasecmp(encap->desired_section, partnum)) {
1490 encap->msglen = length;
1491 encap->msg = malloc(length + 2);
1492 memcpy(encap->msg, content, length);
1499 * Determine whether the specified message exists in the cached_msglist
1500 * (This is a security check)
1502 int check_cached_msglist(long msgnum) {
1504 /* cases in which we skip the check */
1505 if (!CC) return om_ok; /* not a session */
1506 if (CC->client_socket <= 0) return om_ok; /* not a client session */
1507 if (CC->cached_msglist == NULL) return om_access_denied; /* no msglist fetched */
1508 if (CC->cached_num_msgs == 0) return om_access_denied; /* nothing to check */
1511 /* Do a binary search within the cached_msglist for the requested msgnum */
1513 int max = (CC->cached_num_msgs - 1);
1515 while (max >= min) {
1516 int middle = min + (max-min) / 2 ;
1517 if (msgnum == CC->cached_msglist[middle]) {
1520 if (msgnum > CC->cached_msglist[middle]) {
1528 return om_access_denied;
1533 * Get a message off disk. (returns om_* values found in msgbase.h)
1536 int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */
1537 int mode, /* how would you like that message? */
1538 int headers_only, /* eschew the message body? */
1539 int do_proto, /* do Citadel protocol responses? */
1540 int crlf, /* Use CRLF newlines instead of LF? */
1541 char *section, /* NULL or a message/rfc822 section */
1542 int flags, /* various flags; see msgbase.h */
1547 struct CtdlMessage *TheMessage = NULL;
1548 int retcode = CIT_OK;
1549 struct encapmsg encap;
1552 syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)",
1554 (section ? section : "<>")
1557 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1560 if (r == om_not_logged_in) {
1561 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1564 cprintf("%d An unknown error has occurred.\n", ERROR);
1571 * Check to make sure the message is actually IN this room
1573 r = check_cached_msglist(msg_num);
1574 if (r == om_access_denied) {
1575 /* Not in the cache? We get ONE shot to check it again. */
1576 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1577 r = check_cached_msglist(msg_num);
1580 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s",
1581 msg_num, CC->room.QRname
1584 if (r == om_access_denied) {
1585 cprintf("%d message %ld was not found in this room\n",
1586 ERROR + HIGHER_ACCESS_REQUIRED,
1595 * Fetch the message from disk. If we're in HEADERS_FAST mode,
1596 * request that we don't even bother loading the body into memory.
1598 if (headers_only == HEADERS_FAST) {
1599 TheMessage = CtdlFetchMessage(msg_num, 0, 1);
1602 TheMessage = CtdlFetchMessage(msg_num, 1, 1);
1605 if (TheMessage == NULL) {
1606 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n",
1607 ERROR + MESSAGE_NOT_FOUND, msg_num);
1608 return(om_no_such_msg);
1611 /* Here is the weird form of this command, to process only an
1612 * encapsulated message/rfc822 section.
1614 if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1615 memset(&encap, 0, sizeof encap);
1616 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1617 mime_parser(CM_RANGE(TheMessage, eMesageText),
1618 *extract_encapsulated_message,
1619 NULL, NULL, (void *)&encap, 0
1622 if ((Author != NULL) && (*Author == NULL))
1625 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1627 if ((Address != NULL) && (*Address == NULL))
1630 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1632 if ((MessageID != NULL) && (*MessageID == NULL))
1635 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1637 CM_Free(TheMessage);
1641 encap.msg[encap.msglen] = 0;
1642 TheMessage = convert_internet_message(encap.msg);
1643 encap.msg = NULL; /* no free() here, TheMessage owns it now */
1645 /* Now we let it fall through to the bottom of this
1646 * function, because TheMessage now contains the
1647 * encapsulated message instead of the top-level
1648 * message. Isn't that neat?
1653 cprintf("%d msg %ld has no part %s\n",
1654 ERROR + MESSAGE_NOT_FOUND,
1658 retcode = om_no_such_msg;
1663 /* Ok, output the message now */
1664 if (retcode == CIT_OK)
1665 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1666 if ((Author != NULL) && (*Author == NULL))
1669 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1671 if ((Address != NULL) && (*Address == NULL))
1674 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1676 if ((MessageID != NULL) && (*MessageID == NULL))
1679 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1682 CM_Free(TheMessage);
1688 void OutputCtdlMsgHeaders(
1689 struct CtdlMessage *TheMessage,
1690 int do_proto) /* do Citadel protocol responses? */
1694 char display_name[256];
1696 /* begin header processing loop for Citadel message format */
1697 safestrncpy(display_name, "<unknown>", sizeof display_name);
1698 if (!CM_IsEmpty(TheMessage, eAuthor)) {
1699 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1700 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1701 safestrncpy(display_name, "****", sizeof display_name);
1703 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1704 safestrncpy(display_name, "anonymous", sizeof display_name);
1707 safestrncpy(display_name, buf, sizeof display_name);
1709 if ((is_room_aide())
1710 && ((TheMessage->cm_anon_type == MES_ANONONLY)
1711 || (TheMessage->cm_anon_type == MES_ANONOPT))) {
1712 size_t tmp = strlen(display_name);
1713 snprintf(&display_name[tmp],
1714 sizeof display_name - tmp,
1719 /* Now spew the header fields in the order we like them. */
1720 for (i=0; i< NDiskFields; ++i) {
1722 Field = FieldOrder[i];
1723 if (Field != eMesageText) {
1724 if ( (!CM_IsEmpty(TheMessage, Field))
1725 && (msgkeys[Field] != NULL) ) {
1726 if ((Field == eenVelopeTo) ||
1727 (Field == eRecipient) ||
1728 (Field == eCarbonCopY)) {
1729 sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1731 if (Field == eAuthor) {
1732 if (do_proto) cprintf("%s=%s\n",
1736 /* Masquerade display name if needed */
1739 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1748 void OutputRFC822MsgHeaders(
1749 struct CtdlMessage *TheMessage,
1750 int flags, /* should the message be exported clean */
1751 const char *nl, int nlen,
1752 char *mid, long sizeof_mid,
1753 char *suser, long sizeof_suser,
1754 char *luser, long sizeof_luser,
1755 char *fuser, long sizeof_fuser,
1756 char *snode, long sizeof_snode)
1758 char datestamp[100];
1759 int subject_found = 0;
1766 for (i = 0; i < NDiskFields; ++i) {
1767 if (TheMessage->cm_fields[FieldOrder[i]]) {
1768 mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1769 switch (FieldOrder[i]) {
1771 safestrncpy(luser, mptr, sizeof_luser);
1772 safestrncpy(suser, mptr, sizeof_suser);
1775 if ((flags & QP_EADDR) != 0) {
1776 mptr = qp_encode_email_addrs(mptr);
1778 sanitize_truncated_recipient(mptr);
1779 cprintf("CC: %s%s", mptr, nl);
1782 cprintf("Return-Path: %s%s", mptr, nl);
1785 cprintf("List-ID: %s%s", mptr, nl);
1788 if ((flags & QP_EADDR) != 0)
1789 mptr = qp_encode_email_addrs(mptr);
1791 while ((*hptr != '\0') && isspace(*hptr))
1793 if (!IsEmptyStr(hptr))
1794 cprintf("Envelope-To: %s%s", hptr, nl);
1797 cprintf("Subject: %s%s", mptr, nl);
1801 safestrncpy(mid, mptr, sizeof_mid);
1804 safestrncpy(fuser, mptr, sizeof_fuser);
1806 if (haschar(mptr, '@') == 0) {
1807 sanitize_truncated_recipient(mptr);
1808 cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1812 if ((flags & QP_EADDR) != 0) {
1813 mptr = qp_encode_email_addrs(mptr);
1815 sanitize_truncated_recipient(mptr);
1816 cprintf("To: %s", mptr);
1821 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1822 cprintf("Date: %s%s", datestamp, nl);
1825 cprintf("References: ");
1826 k = num_tokens(mptr, '|');
1827 for (j=0; j<k; ++j) {
1828 extract_token(buf, mptr, j, '|', sizeof buf);
1829 cprintf("<%s>", buf);
1840 while ((*hptr != '\0') && isspace(*hptr))
1842 if (!IsEmptyStr(hptr))
1843 cprintf("Reply-To: %s%s", mptr, nl);
1855 /* these don't map to mime message headers. */
1858 if (mptr != mpptr) {
1863 if (subject_found == 0) {
1864 cprintf("Subject: (no subject)%s", nl);
1869 void Dump_RFC822HeadersBody(
1870 struct CtdlMessage *TheMessage,
1871 int headers_only, /* eschew the message body? */
1872 int flags, /* should the bessage be exported clean? */
1873 const char *nl, int nlen)
1875 cit_uint8_t prev_ch;
1877 const char *StartOfText = StrBufNOTNULL;
1880 int nllen = strlen(nl);
1884 mptr = TheMessage->cm_fields[eMesageText];
1887 while (*mptr != '\0') {
1888 if (*mptr == '\r') {
1895 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1897 eoh = *(mptr+1) == '\n';
1901 StartOfText = strchr(StartOfText, '\n');
1902 StartOfText = strchr(StartOfText, '\n');
1905 if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1906 ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1907 ((headers_only != HEADERS_NONE) &&
1908 (headers_only != HEADERS_ONLY))
1910 if (*mptr == '\n') {
1911 memcpy(&outbuf[outlen], nl, nllen);
1913 outbuf[outlen] = '\0';
1916 outbuf[outlen++] = *mptr;
1920 if (flags & ESC_DOT) {
1921 if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1922 outbuf[outlen++] = '.';
1927 if (outlen > 1000) {
1928 if (client_write(outbuf, outlen) == -1) {
1929 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1932 lfSent = (outbuf[outlen - 1] == '\n');
1937 client_write(outbuf, outlen);
1938 lfSent = (outbuf[outlen - 1] == '\n');
1941 client_write(nl, nlen);
1945 /* If the format type on disk is 1 (fixed-format), then we want
1946 * everything to be output completely literally ... regardless of
1947 * what message transfer format is in use.
1949 void DumpFormatFixed(
1950 struct CtdlMessage *TheMessage,
1951 int mode, /* how would you like that message? */
1952 const char *nl, int nllen)
1960 mptr = TheMessage->cm_fields[eMesageText];
1962 if (mode == MT_MIME) {
1963 cprintf("Content-type: text/plain\n\n");
1967 while (ch = *mptr++, ch > 0) {
1971 if ((buflen > 250) && (!xlline)){
1975 while ((buflen > 0) &&
1976 (!isspace(buf[buflen])))
1982 mptr -= tbuflen - buflen;
1988 /* if we reach the outer bounds of our buffer, abort without respect for what we purge. */
1989 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1994 memcpy (&buf[buflen], nl, nllen);
1998 if (client_write(buf, buflen) == -1) {
1999 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
2011 if (!IsEmptyStr(buf)) {
2012 cprintf("%s%s", buf, nl);
2018 * Get a message off disk. (returns om_* values found in msgbase.h)
2020 int CtdlOutputPreLoadedMsg(
2021 struct CtdlMessage *TheMessage,
2022 int mode, /* how would you like that message? */
2023 int headers_only, /* eschew the message body? */
2024 int do_proto, /* do Citadel protocol responses? */
2025 int crlf, /* Use CRLF newlines instead of LF? */
2026 int flags /* should the bessage be exported clean? */
2029 const char *nl; /* newline string */
2033 /* Buffers needed for RFC822 translation. These are all filled
2034 * using functions that are bounds-checked, and therefore we can
2035 * make them substantially smaller than SIZ.
2043 syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
2044 ((TheMessage == NULL) ? "NULL" : "not null"),
2045 mode, headers_only, do_proto, crlf
2048 strcpy(mid, "unknown");
2049 nl = (crlf ? "\r\n" : "\n");
2050 nlen = crlf ? 2 : 1;
2052 if (!CM_IsValidMsg(TheMessage)) {
2053 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
2054 return(om_no_such_msg);
2057 /* Suppress envelope recipients if required to avoid disclosing BCC addresses.
2058 * Pad it with spaces in order to avoid changing the RFC822 length of the message.
2060 if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
2061 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
2064 /* Are we downloading a MIME component? */
2065 if (mode == MT_DOWNLOAD) {
2066 if (TheMessage->cm_format_type != FMT_RFC822) {
2068 cprintf("%d This is not a MIME message.\n",
2069 ERROR + ILLEGAL_VALUE);
2070 } else if (CC->download_fp != NULL) {
2071 if (do_proto) cprintf(
2072 "%d You already have a download open.\n",
2073 ERROR + RESOURCE_BUSY);
2075 /* Parse the message text component */
2076 mime_parser(CM_RANGE(TheMessage, eMesageText),
2077 *mime_download, NULL, NULL, NULL, 0);
2078 /* If there's no file open by this time, the requested
2079 * section wasn't found, so print an error
2081 if (CC->download_fp == NULL) {
2082 if (do_proto) cprintf(
2083 "%d Section %s not found.\n",
2084 ERROR + FILE_NOT_FOUND,
2085 CC->download_desired_section);
2088 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2091 /* MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
2092 * in a single server operation instead of opening a download file.
2094 if (mode == MT_SPEW_SECTION) {
2095 if (TheMessage->cm_format_type != FMT_RFC822) {
2097 cprintf("%d This is not a MIME message.\n",
2098 ERROR + ILLEGAL_VALUE);
2100 /* Parse the message text component */
2103 mime_parser(CM_RANGE(TheMessage, eMesageText),
2104 *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
2105 /* If section wasn't found, print an error
2108 if (do_proto) cprintf(
2109 "%d Section %s not found.\n",
2110 ERROR + FILE_NOT_FOUND,
2111 CC->download_desired_section);
2114 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2117 /* now for the user-mode message reading loops */
2118 if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
2120 /* Does the caller want to skip the headers? */
2121 if (headers_only == HEADERS_NONE) goto START_TEXT;
2123 /* Tell the client which format type we're using. */
2124 if ( (mode == MT_CITADEL) && (do_proto) ) {
2125 cprintf("type=%d\n", TheMessage->cm_format_type);
2128 /* nhdr=yes means that we're only displaying headers, no body */
2129 if ( (TheMessage->cm_anon_type == MES_ANONONLY)
2130 && ((mode == MT_CITADEL) || (mode == MT_MIME))
2133 cprintf("nhdr=yes\n");
2136 if ((mode == MT_CITADEL) || (mode == MT_MIME))
2137 OutputCtdlMsgHeaders(TheMessage, do_proto);
2140 /* begin header processing loop for RFC822 transfer format */
2144 if (mode == MT_RFC822)
2145 OutputRFC822MsgHeaders(
2150 suser, sizeof(suser),
2151 luser, sizeof(luser),
2152 fuser, sizeof(fuser),
2153 snode, sizeof(snode)
2157 for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2158 suser[i] = tolower(suser[i]);
2159 if (!isalnum(suser[i])) suser[i]='_';
2162 if (mode == MT_RFC822) {
2163 /* Construct a fun message id */
2164 cprintf("Message-ID: <%s", mid);
2165 if (strchr(mid, '@')==NULL) {
2166 cprintf("@%s", snode);
2170 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2171 cprintf("From: \"----\" <x@x.org>%s", nl);
2173 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2174 cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2176 else if (!IsEmptyStr(fuser)) {
2177 cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2180 cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2183 /* Blank line signifying RFC822 end-of-headers */
2184 if (TheMessage->cm_format_type != FMT_RFC822) {
2189 /* end header processing loop ... at this point, we're in the text */
2191 if (headers_only == HEADERS_FAST) goto DONE;
2193 /* Tell the client about the MIME parts in this message */
2194 if (TheMessage->cm_format_type == FMT_RFC822) {
2195 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2196 memset(&ma, 0, sizeof(struct ma_info));
2197 mime_parser(CM_RANGE(TheMessage, eMesageText),
2198 (do_proto ? *list_this_part : NULL),
2199 (do_proto ? *list_this_pref : NULL),
2200 (do_proto ? *list_this_suff : NULL),
2203 else if (mode == MT_RFC822) { /* unparsed RFC822 dump */
2204 Dump_RFC822HeadersBody(
2213 if (headers_only == HEADERS_ONLY) {
2217 /* signify start of msg text */
2218 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2219 if (do_proto) cprintf("text\n");
2222 if (TheMessage->cm_format_type == FMT_FIXED)
2225 mode, /* how would you like that message? */
2228 /* If the message on disk is format 0 (Citadel vari-format), we
2229 * output using the formatter at 80 columns. This is the final output
2230 * form if the transfer format is RFC822, but if the transfer format
2231 * is Citadel proprietary, it'll still work, because the indentation
2232 * for new paragraphs is correct and the client will reformat the
2233 * message to the reader's screen width.
2235 if (TheMessage->cm_format_type == FMT_CITADEL) {
2236 if (mode == MT_MIME) {
2237 cprintf("Content-type: text/x-citadel-variformat\n\n");
2239 memfmout(TheMessage->cm_fields[eMesageText], nl);
2242 /* If the message on disk is format 4 (MIME), we've gotta hand it
2243 * off to the MIME parser. The client has already been told that
2244 * this message is format 1 (fixed format), so the callback function
2245 * we use will display those parts as-is.
2247 if (TheMessage->cm_format_type == FMT_RFC822) {
2248 memset(&ma, 0, sizeof(struct ma_info));
2250 if (mode == MT_MIME) {
2251 ma.use_fo_hooks = 0;
2252 strcpy(ma.chosen_part, "1");
2253 ma.chosen_pref = 9999;
2254 ma.dont_decode = CC->msg4_dont_decode;
2255 mime_parser(CM_RANGE(TheMessage, eMesageText),
2256 *choose_preferred, *fixed_output_pre,
2257 *fixed_output_post, (void *)&ma, 1);
2258 mime_parser(CM_RANGE(TheMessage, eMesageText),
2259 *output_preferred, NULL, NULL, (void *)&ma, 1);
2262 ma.use_fo_hooks = 1;
2263 mime_parser(CM_RANGE(TheMessage, eMesageText),
2264 *fixed_output, *fixed_output_pre,
2265 *fixed_output_post, (void *)&ma, 0);
2270 DONE: /* now we're done */
2271 if (do_proto) cprintf("000\n");
2276 * Save one or more message pointers into a specified room
2277 * (Returns 0 for success, nonzero for failure)
2278 * roomname may be NULL to use the current room
2280 * Note that the 'supplied_msg' field may be set to NULL, in which case
2281 * the message will be fetched from disk, by number, if we need to perform
2282 * replication checks. This adds an additional database read, so if the
2283 * caller already has the message in memory then it should be supplied. (Obviously
2284 * this mode of operation only works if we're saving a single message.)
2286 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2287 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj
2290 char hold_rm[ROOMNAMELEN];
2291 struct cdbdata *cdbfr;
2294 long highest_msg = 0L;
2297 struct CtdlMessage *msg = NULL;
2299 long *msgs_to_be_merged = NULL;
2300 int num_msgs_to_be_merged = 0;
2303 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2304 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2307 strcpy(hold_rm, CC->room.QRname);
2310 if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2311 if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2312 if (num_newmsgs > 1) supplied_msg = NULL;
2314 /* Now the regular stuff */
2315 if (CtdlGetRoomLock(&CC->room,
2316 ((roomname != NULL) ? roomname : CC->room.QRname) )
2318 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2319 return(ERROR + ROOM_NOT_FOUND);
2323 msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2324 num_msgs_to_be_merged = 0;
2327 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
2328 if (cdbfr == NULL) {
2332 msglist = (long *) cdbfr->ptr;
2333 cdbfr->ptr = NULL; /* CtdlSaveMsgPointerInRoom() now owns this memory */
2334 num_msgs = cdbfr->len / sizeof(long);
2339 /* Create a list of msgid's which were supplied by the caller, but do
2340 * not already exist in the target room. It is absolutely taboo to
2341 * have more than one reference to the same message in a room.
2343 for (i=0; i<num_newmsgs; ++i) {
2345 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2346 if (msglist[j] == newmsgidlist[i]) {
2351 msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2355 syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2358 * Now merge the new messages
2360 msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2361 if (msglist == NULL) {
2362 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2363 free(msgs_to_be_merged);
2364 return (ERROR + INTERNAL_ERROR);
2366 memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2367 num_msgs += num_msgs_to_be_merged;
2369 /* Sort the message list, so all the msgid's are in order */
2370 num_msgs = sort_msglist(msglist, num_msgs);
2372 /* Determine the highest message number */
2373 highest_msg = msglist[num_msgs - 1];
2375 /* Write it back to disk. */
2376 cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long),
2377 msglist, (int)(num_msgs * sizeof(long)));
2379 /* Free up the memory we used. */
2382 /* Update the highest-message pointer and unlock the room. */
2383 CC->room.QRhighest = highest_msg;
2384 CtdlPutRoomLock(&CC->room);
2386 /* Perform replication checks if necessary */
2387 if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2388 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2390 for (i=0; i<num_msgs_to_be_merged; ++i) {
2391 msgid = msgs_to_be_merged[i];
2393 if (supplied_msg != NULL) {
2397 msg = CtdlFetchMessage(msgid, 0, 1);
2401 ReplicationChecks(msg);
2403 /* If the message has an Exclusive ID, index that... */
2404 if (!CM_IsEmpty(msg, eExclusiveID)) {
2405 index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2408 /* Free up the memory we may have allocated */
2409 if (msg != supplied_msg) {
2418 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2421 /* Submit this room for processing by hooks */
2422 PerformRoomHooks(&CC->room);
2424 /* Go back to the room we were in before we wandered here... */
2425 CtdlGetRoom(&CC->room, hold_rm);
2427 /* Bump the reference count for all messages which were merged */
2428 if (!suppress_refcount_adj) {
2429 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2432 /* Free up memory... */
2433 if (msgs_to_be_merged != NULL) {
2434 free(msgs_to_be_merged);
2437 /* Return success. */
2443 * This is the same as CtdlSaveMsgPointersInRoom() but it only accepts
2446 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid,
2447 int do_repl_check, struct CtdlMessage *supplied_msg)
2449 return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, supplied_msg, 0);
2456 * Message base operation to save a new message to the message store
2457 * (returns new message number)
2459 * This is the back end for CtdlSubmitMsg() and should not be directly
2460 * called by server-side modules.
2463 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) {
2471 * If the message is big, set its body aside for storage elsewhere
2472 * and we hide the message body from the serializer
2474 if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG)
2477 holdM = msg->cm_fields[eMesageText];
2478 msg->cm_fields[eMesageText] = NULL;
2479 holdMLen = msg->cm_lengths[eMesageText];
2480 msg->cm_lengths[eMesageText] = 0;
2483 /* Serialize our data structure for storage in the database */
2484 CtdlSerializeMessage(&smr, msg);
2487 /* put the message body back into the message */
2488 msg->cm_fields[eMesageText] = holdM;
2489 msg->cm_lengths[eMesageText] = holdMLen;
2494 cprintf("%d Unable to serialize message\n",
2495 ERROR + INTERNAL_ERROR);
2498 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2504 /* Write our little bundle of joy into the message base */
2505 retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long),
2508 syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval);
2512 retval = cdb_store(CDB_BIGMSGS,
2519 syslog(LOG_ERR, "msgbase: failed to store message body for msgid %ld: %ld", msgid, retval);
2524 /* Free the memory we used for the serialized message */
2530 long send_message(struct CtdlMessage *msg) {
2536 /* Get a new message number */
2537 newmsgid = get_new_message_number();
2539 /* Generate an ID if we don't have one already */
2540 if (CM_IsEmpty(msg, emessageId)) {
2541 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%08lX-%08lX@%s",
2542 (long unsigned int) time(NULL),
2543 (long unsigned int) newmsgid,
2544 CtdlGetConfigStr("c_fqdn")
2547 CM_SetField(msg, emessageId, msgidbuf, msgidbuflen);
2550 retval = CtdlSaveThisMessage(msg, newmsgid, 1);
2556 /* Return the *local* message ID to the caller
2557 * (even if we're storing an incoming network message)
2565 * Serialize a struct CtdlMessage into the format used on disk and network.
2567 * This function loads up a "struct ser_ret" (defined in server.h) which
2568 * contains the length of the serialized message and a pointer to the
2569 * serialized message in memory. THE LATTER MUST BE FREED BY THE CALLER.
2571 void CtdlSerializeMessage(struct ser_ret *ret, /* return values */
2572 struct CtdlMessage *msg) /* unserialized msg */
2578 * Check for valid message format
2580 if (CM_IsValidMsg(msg) == 0) {
2581 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2588 for (i=0; i < NDiskFields; ++i)
2589 if (msg->cm_fields[FieldOrder[i]] != NULL)
2590 ret->len += msg->cm_lengths[FieldOrder[i]] + 2;
2592 ret->ser = malloc(ret->len);
2593 if (ret->ser == NULL) {
2594 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret->len);
2601 ret->ser[1] = msg->cm_anon_type;
2602 ret->ser[2] = msg->cm_format_type;
2605 for (i=0; i < NDiskFields; ++i)
2606 if (msg->cm_fields[FieldOrder[i]] != NULL)
2608 ret->ser[wlen++] = (char)FieldOrder[i];
2610 memcpy(&ret->ser[wlen],
2611 msg->cm_fields[FieldOrder[i]],
2612 msg->cm_lengths[FieldOrder[i]] + 1);
2614 wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2617 if (ret->len != wlen) {
2618 syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen);
2626 * Check to see if any messages already exist in the current room which
2627 * carry the same Exclusive ID as this one. If any are found, delete them.
2629 void ReplicationChecks(struct CtdlMessage *msg) {
2630 long old_msgnum = (-1L);
2632 if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2634 syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2636 /* No exclusive id? Don't do anything. */
2637 if (msg == NULL) return;
2638 if (CM_IsEmpty(msg, eExclusiveID)) return;
2640 /*syslog(LOG_DEBUG, "msgbase: exclusive ID: <%s> for room <%s>",
2641 msg->cm_fields[eExclusiveID], CC->room.QRname);*/
2643 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2644 if (old_msgnum > 0L) {
2645 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2646 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2653 * Save a message to disk and submit it into the delivery system.
2655 long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */
2656 recptypes *recps, /* recipients (if mail) */
2657 const char *force, /* force a particular room? */
2658 int flags /* should the message be exported clean? */
2661 char hold_rm[ROOMNAMELEN];
2662 char actual_rm[ROOMNAMELEN];
2663 char force_room[ROOMNAMELEN];
2664 char content_type[SIZ]; /* We have to learn this */
2665 char recipient[SIZ];
2666 char bounce_to[1024];
2669 const char *mptr = NULL;
2670 struct ctdluser userbuf;
2672 struct MetaData smi;
2673 char *collected_addresses = NULL;
2674 struct addresses_to_be_filed *aptr = NULL;
2675 StrBuf *saved_rfc822_version = NULL;
2676 int qualified_for_journaling = 0;
2678 syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2679 if (CM_IsValidMsg(msg) == 0) return(-1); /* self check */
2681 /* If this message has no timestamp, we take the liberty of
2682 * giving it one, right now.
2684 if (CM_IsEmpty(msg, eTimestamp)) {
2685 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2688 /* If this message has no path, we generate one.
2690 if (CM_IsEmpty(msg, eMessagePath)) {
2691 if (!CM_IsEmpty(msg, eAuthor)) {
2692 CM_CopyField(msg, eMessagePath, eAuthor);
2693 for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2694 if (isspace(msg->cm_fields[eMessagePath][a])) {
2695 msg->cm_fields[eMessagePath][a] = ' ';
2700 CM_SetField(msg, eMessagePath, HKEY("unknown"));
2704 if (force == NULL) {
2705 force_room[0] = '\0';
2708 strcpy(force_room, force);
2711 /* Learn about what's inside, because it's what's inside that counts */
2712 if (CM_IsEmpty(msg, eMesageText)) {
2713 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2717 switch (msg->cm_format_type) {
2719 strcpy(content_type, "text/x-citadel-variformat");
2722 strcpy(content_type, "text/plain");
2725 strcpy(content_type, "text/plain");
2726 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
2729 safestrncpy(content_type, &mptr[13], sizeof content_type);
2730 striplt(content_type);
2731 aptr = content_type;
2732 while (!IsEmptyStr(aptr)) {
2744 /* Goto the correct room */
2745 room = (recps) ? CC->room.QRname : SENTITEMS;
2746 syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2747 strcpy(hold_rm, CC->room.QRname);
2748 strcpy(actual_rm, CC->room.QRname);
2749 if (recps != NULL) {
2750 strcpy(actual_rm, SENTITEMS);
2753 /* If the user is a twit, move to the twit room for posting */
2755 if (CC->user.axlevel == AxProbU) {
2756 strcpy(hold_rm, actual_rm);
2757 strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2758 syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2762 /* ...or if this message is destined for Aide> then go there. */
2763 if (!IsEmptyStr(force_room)) {
2764 strcpy(actual_rm, force_room);
2767 syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2768 if (strcasecmp(actual_rm, CC->room.QRname)) {
2769 /* CtdlGetRoom(&CC->room, actual_rm); */
2770 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2774 * If this message has no O (room) field, generate one.
2776 if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2777 CM_SetField(msg, eOriginalRoom, CC->room.QRname, strlen(CC->room.QRname));
2780 /* Perform "before save" hooks (aborting if any return nonzero) */
2781 syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2782 if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2785 * If this message has an Exclusive ID, and the room is replication
2786 * checking enabled, then do replication checks.
2788 if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2789 ReplicationChecks(msg);
2792 /* Save it to disk */
2793 syslog(LOG_DEBUG, "msgbase: saving to disk");
2794 newmsgid = send_message(msg);
2795 if (newmsgid <= 0L) return(-5);
2797 /* Write a supplemental message info record. This doesn't have to
2798 * be a critical section because nobody else knows about this message
2801 syslog(LOG_DEBUG, "msgbase: creating metadata record");
2802 memset(&smi, 0, sizeof(struct MetaData));
2803 smi.meta_msgnum = newmsgid;
2804 smi.meta_refcount = 0;
2805 safestrncpy(smi.meta_content_type, content_type,
2806 sizeof smi.meta_content_type);
2809 * Measure how big this message will be when rendered as RFC822.
2810 * We do this for two reasons:
2811 * 1. We need the RFC822 length for the new metadata record, so the
2812 * POP and IMAP services don't have to calculate message lengths
2813 * while the user is waiting (multiplied by potentially hundreds
2814 * or thousands of messages).
2815 * 2. If journaling is enabled, we will need an RFC822 version of the
2816 * message to attach to the journalized copy.
2818 if (CC->redirect_buffer != NULL) {
2819 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2822 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2823 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2824 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2825 saved_rfc822_version = CC->redirect_buffer;
2826 CC->redirect_buffer = NULL;
2830 /* Now figure out where to store the pointers */
2831 syslog(LOG_DEBUG, "msgbase: storing pointers");
2833 /* If this is being done by the networker delivering a private
2834 * message, we want to BYPASS saving the sender's copy (because there
2835 * is no local sender; it would otherwise go to the Trashcan).
2837 if ((!CC->internal_pgm) || (recps == NULL)) {
2838 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2839 syslog(LOG_ERR, "msgbase: ERROR saving message pointer!");
2840 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2844 /* For internet mail, drop a copy in the outbound queue room */
2845 if ((recps != NULL) && (recps->num_internet > 0)) {
2846 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2849 /* If other rooms are specified, drop them there too. */
2850 if ((recps != NULL) && (recps->num_room > 0))
2851 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2852 extract_token(recipient, recps->recp_room, i,
2853 '|', sizeof recipient);
2854 syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2855 CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2858 /* Bump this user's messages posted counter. */
2859 syslog(LOG_DEBUG, "msgbase: updating user");
2860 CtdlLockGetCurrentUser();
2861 CC->user.posted = CC->user.posted + 1;
2862 CtdlPutCurrentUserLock();
2864 /* Decide where bounces need to be delivered */
2865 if ((recps != NULL) && (recps->bounce_to == NULL))
2867 if (CC->logged_in) {
2868 strcpy(bounce_to, CC->user.fullname);
2871 strcpy(bounce_to, msg->cm_fields[eAuthor]);
2873 recps->bounce_to = bounce_to;
2876 CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2879 /* If this is private, local mail, make a copy in the
2880 * recipient's mailbox and bump the reference count.
2882 if ((recps != NULL) && (recps->num_local > 0))
2887 pch = recps->recp_local;
2888 recps->recp_local = recipient;
2889 ntokens = num_tokens(pch, '|');
2890 for (i=0; i<ntokens; ++i)
2892 extract_token(recipient, pch, i, '|', sizeof recipient);
2893 syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2894 if (CtdlGetUser(&userbuf, recipient) == 0) {
2895 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2896 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2897 CtdlBumpNewMailCounter(userbuf.usernum);
2898 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2901 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2902 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2905 recps->recp_local = pch;
2908 /* Perform "after save" hooks */
2909 syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2911 PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2912 CM_FlushField(msg, eVltMsgNum);
2914 /* Go back to the room we started from */
2915 syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2916 if (strcasecmp(hold_rm, CC->room.QRname))
2917 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2920 * Any addresses to harvest for someone's address book?
2922 if ( (CC->logged_in) && (recps != NULL) ) {
2923 collected_addresses = harvest_collected_addresses(msg);
2926 if (collected_addresses != NULL) {
2927 aptr = (struct addresses_to_be_filed *)
2928 malloc(sizeof(struct addresses_to_be_filed));
2929 CtdlMailboxName(actual_rm, sizeof actual_rm,
2930 &CC->user, USERCONTACTSROOM);
2931 aptr->roomname = strdup(actual_rm);
2932 aptr->collected_addresses = collected_addresses;
2933 begin_critical_section(S_ATBF);
2936 end_critical_section(S_ATBF);
2940 * Determine whether this message qualifies for journaling.
2942 if (!CM_IsEmpty(msg, eJournal)) {
2943 qualified_for_journaling = 0;
2946 if (recps == NULL) {
2947 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2949 else if (recps->num_local + recps->num_ignet + recps->num_internet > 0) {
2950 qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2953 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2958 * Do we have to perform journaling? If so, hand off the saved
2959 * RFC822 version will be handed off to the journaler for background
2960 * submit. Otherwise, we have to free the memory ourselves.
2962 if (saved_rfc822_version != NULL) {
2963 if (qualified_for_journaling) {
2964 JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2967 FreeStrBuf(&saved_rfc822_version);
2971 if ((recps != NULL) && (recps->bounce_to == bounce_to))
2972 recps->bounce_to = NULL;
2980 * Convenience function for generating small administrative messages.
2982 long quickie_message(const char *from,
2983 const char *fromaddr,
2988 const char *subject)
2990 struct CtdlMessage *msg;
2991 recptypes *recp = NULL;
2993 msg = malloc(sizeof(struct CtdlMessage));
2994 memset(msg, 0, sizeof(struct CtdlMessage));
2995 msg->cm_magic = CTDLMESSAGE_MAGIC;
2996 msg->cm_anon_type = MES_NORMAL;
2997 msg->cm_format_type = format_type;
2999 if (!IsEmptyStr(from)) {
3000 CM_SetField(msg, eAuthor, from, strlen(from));
3002 else if (!IsEmptyStr(fromaddr)) {
3004 CM_SetField(msg, eAuthor, fromaddr, strlen(fromaddr));
3005 pAt = strchr(msg->cm_fields[eAuthor], '@');
3007 CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
3011 msg->cm_fields[eAuthor] = strdup("Citadel");
3014 if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr, strlen(fromaddr));
3015 if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room, strlen(room));
3016 if (!IsEmptyStr(to)) {
3017 CM_SetField(msg, eRecipient, to, strlen(to));
3018 recp = validate_recipients(to, NULL, 0);
3020 if (!IsEmptyStr(subject)) {
3021 CM_SetField(msg, eMsgSubject, subject, strlen(subject));
3023 if (!IsEmptyStr(text)) {
3024 CM_SetField(msg, eMesageText, text, strlen(text));
3027 long msgnum = CtdlSubmitMsg(msg, recp, room, 0);
3029 if (recp != NULL) free_recipients(recp);
3035 * Back end function used by CtdlMakeMessage() and similar functions
3037 StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */
3039 size_t maxlen, /* maximum message length */
3040 StrBuf *exist, /* if non-null, append to it;
3041 exist is ALWAYS freed */
3042 int crlf /* CRLF newlines instead of LF */
3051 LineBuf = NewStrBufPlain(NULL, SIZ);
3052 if (exist == NULL) {
3053 Message = NewStrBufPlain(NULL, 4 * SIZ);
3056 Message = NewStrBufDup(exist);
3059 /* Do we need to change leading ".." to "." for SMTP escaping? */
3060 if ((tlen == 1) && (*terminator == '.')) {
3064 /* read in the lines of message text one by one */
3066 if (CtdlClientGetLine(LineBuf) < 0) {
3069 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
3072 if ( (!flushing) && (!finished) ) {
3074 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
3077 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
3080 /* Unescape SMTP-style input of two dots at the beginning of the line */
3081 if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
3082 StrBufCutLeft(LineBuf, 1);
3084 StrBufAppendBuf(Message, LineBuf, 0);
3087 /* if we've hit the max msg length, flush the rest */
3088 if (StrLength(Message) >= maxlen) flushing = 1;
3090 } while (!finished);
3091 FreeStrBuf(&LineBuf);
3097 * Back end function used by CtdlMakeMessage() and similar functions
3099 char *CtdlReadMessageBody(char *terminator, /* token signalling EOT */
3101 size_t maxlen, /* maximum message length */
3102 StrBuf *exist, /* if non-null, append to it;
3103 exist is ALWAYS freed */
3104 int crlf /* CRLF newlines instead of LF */
3109 Message = CtdlReadMessageBodyBuf(terminator,
3115 if (Message == NULL)
3118 return SmashStrBuf(&Message);
3121 struct CtdlMessage *CtdlMakeMessage(
3122 struct ctdluser *author, /* author's user structure */
3123 char *recipient, /* NULL if it's not mail */
3124 char *recp_cc, /* NULL if it's not mail */
3125 char *room, /* room where it's going */
3126 int type, /* see MES_ types in header file */
3127 int format_type, /* variformat, plain text, MIME... */
3128 char *fake_name, /* who we're masquerading as */
3129 char *my_email, /* which of my email addresses to use (empty is ok) */
3130 char *subject, /* Subject (optional) */
3131 char *supplied_euid, /* ...or NULL if this is irrelevant */
3132 char *preformatted_text, /* ...or NULL to read text from client */
3133 char *references /* Thread references */
3136 return CtdlMakeMessageLen(
3137 author, /* author's user structure */
3138 recipient, /* NULL if it's not mail */
3139 (recipient)?strlen(recipient) : 0,
3140 recp_cc, /* NULL if it's not mail */
3141 (recp_cc)?strlen(recp_cc): 0,
3142 room, /* room where it's going */
3143 (room)?strlen(room): 0,
3144 type, /* see MES_ types in header file */
3145 format_type, /* variformat, plain text, MIME... */
3146 fake_name, /* who we're masquerading as */
3147 (fake_name)?strlen(fake_name): 0,
3148 my_email, /* which of my email addresses to use (empty is ok) */
3149 (my_email)?strlen(my_email): 0,
3150 subject, /* Subject (optional) */
3151 (subject)?strlen(subject): 0,
3152 supplied_euid, /* ...or NULL if this is irrelevant */
3153 (supplied_euid)?strlen(supplied_euid):0,
3154 preformatted_text, /* ...or NULL to read text from client */
3155 (preformatted_text)?strlen(preformatted_text) : 0,
3156 references, /* Thread references */
3157 (references)?strlen(references):0);
3162 * Build a binary message to be saved on disk.
3163 * (NOTE: if you supply 'preformatted_text', the buffer you give it
3164 * will become part of the message. This means you are no longer
3165 * responsible for managing that memory -- it will be freed along with
3166 * the rest of the fields when CM_Free() is called.)
3169 struct CtdlMessage *CtdlMakeMessageLen(
3170 struct ctdluser *author, /* author's user structure */
3171 char *recipient, /* NULL if it's not mail */
3173 char *recp_cc, /* NULL if it's not mail */
3175 char *room, /* room where it's going */
3177 int type, /* see MES_ types in header file */
3178 int format_type, /* variformat, plain text, MIME... */
3179 char *fake_name, /* who we're masquerading as */
3181 char *my_email, /* which of my email addresses to use (empty is ok) */
3183 char *subject, /* Subject (optional) */
3185 char *supplied_euid, /* ...or NULL if this is irrelevant */
3187 char *preformatted_text, /* ...or NULL to read text from client */
3189 char *references, /* Thread references */
3193 /* Don't confuse the poor folks if it's not routed mail. * /
3194 char dest_node[256] = "";*/
3197 struct CtdlMessage *msg;
3199 StrBuf *FakeEncAuthor = NULL;
3201 msg = malloc(sizeof(struct CtdlMessage));
3202 memset(msg, 0, sizeof(struct CtdlMessage));
3203 msg->cm_magic = CTDLMESSAGE_MAGIC;
3204 msg->cm_anon_type = type;
3205 msg->cm_format_type = format_type;
3207 if (recipient != NULL) rcplen = striplt(recipient);
3208 if (recp_cc != NULL) cclen = striplt(recp_cc);
3210 /* Path or Return-Path */
3212 CM_SetField(msg, eMessagePath, my_email, myelen);
3214 else if (!IsEmptyStr(author->fullname)) {
3215 CM_SetField(msg, eMessagePath, author->fullname, strlen(author->fullname));
3217 convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
3219 blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
3220 CM_SetField(msg, eTimestamp, buf, blen);
3223 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
3226 FakeAuthor = NewStrBufPlain (author->fullname, -1);
3228 StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
3229 CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
3230 FreeStrBuf(&FakeAuthor);
3232 if (!!IsEmptyStr(CC->room.QRname)) {
3233 if (CC->room.QRflags & QR_MAILBOX) { /* room */
3234 CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11], strlen(&CC->room.QRname[11]));
3237 CM_SetField(msg, eOriginalRoom, CC->room.QRname, strlen(CC->room.QRname));
3242 CM_SetField(msg, eRecipient, recipient, rcplen);
3245 CM_SetField(msg, eCarbonCopY, recp_cc, cclen);
3249 CM_SetField(msg, erFc822Addr, my_email, myelen);
3251 else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3252 CM_SetField(msg, erFc822Addr, CC->cs_inet_email, strlen(CC->cs_inet_email));
3255 if (subject != NULL) {
3257 length = striplt(subject);
3263 while ((subject[i] != '\0') &&
3264 (IsAscii = isascii(subject[i]) != 0 ))
3267 CM_SetField(msg, eMsgSubject, subject, subjlen);
3268 else /* ok, we've got utf8 in the string. */
3271 rfc2047Subj = rfc2047encode(subject, length);
3272 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3279 CM_SetField(msg, eExclusiveID, supplied_euid, euidlen);
3283 CM_SetField(msg, eWeferences, references, reflen);
3286 if (preformatted_text != NULL) {
3287 CM_SetField(msg, eMesageText, preformatted_text, textlen);
3291 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3292 if (MsgBody != NULL) {
3293 CM_SetAsFieldSB(msg, eMesageText, &MsgBody);
3304 * API function to delete messages which match a set of criteria
3305 * (returns the actual number of messages deleted)
3307 int CtdlDeleteMessages(const char *room_name, /* which room */
3308 long *dmsgnums, /* array of msg numbers to be deleted */
3309 int num_dmsgnums, /* number of msgs to be deleted, or 0 for "any" */
3310 char *content_type /* or "" for any. regular expressions expected. */
3313 struct ctdlroom qrbuf;
3314 struct cdbdata *cdbfr;
3315 long *msglist = NULL;
3316 long *dellist = NULL;
3319 int num_deleted = 0;
3321 struct MetaData smi;
3324 int need_to_free_re = 0;
3326 if (content_type) if (!IsEmptyStr(content_type)) {
3327 regcomp(&re, content_type, 0);
3328 need_to_free_re = 1;
3330 syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3332 /* get room record, obtaining a lock... */
3333 if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3334 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3335 if (need_to_free_re) regfree(&re);
3336 return(0); /* room not found */
3338 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
3340 if (cdbfr != NULL) {
3341 dellist = malloc(cdbfr->len);
3342 msglist = (long *) cdbfr->ptr;
3343 cdbfr->ptr = NULL; /* CtdlDeleteMessages() now owns this memory */
3344 num_msgs = cdbfr->len / sizeof(long);
3348 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3349 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3350 int have_more_del = 1;
3352 num_msgs = sort_msglist(msglist, num_msgs);
3353 if (num_dmsgnums > 1)
3354 num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3357 StrBuf *dbg = NewStrBuf();
3358 for (i = 0; i < num_dmsgnums; i++)
3359 StrBufAppendPrintf(dbg, ", %ld", dmsgnums[i]);
3360 syslog(LOG_DEBUG, "msgbase: Deleting before: %s", ChrPtr(dbg));
3365 while ((i < num_msgs) && (have_more_del)) {
3368 /* Set/clear a bit for each criterion */
3370 /* 0 messages in the list or a null list means that we are
3371 * interested in deleting any messages which meet the other criteria.
3374 delete_this |= 0x01;
3377 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3382 if (msglist[i] == dmsgnums[j]) {
3383 delete_this |= 0x01;
3386 have_more_del = (j < num_dmsgnums);
3389 if (have_contenttype) {
3390 GetMetaData(&smi, msglist[i]);
3391 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3392 delete_this |= 0x02;
3395 delete_this |= 0x02;
3398 /* Delete message only if all bits are set */
3399 if (delete_this == 0x03) {
3400 dellist[num_deleted++] = msglist[i];
3407 StrBuf *dbg = NewStrBuf();
3408 for (i = 0; i < num_deleted; i++)
3409 StrBufAppendPrintf(dbg, ", %ld", dellist[i]);
3410 syslog(LOG_DEBUG, "msgbase: Deleting: %s", ChrPtr(dbg));
3414 num_msgs = sort_msglist(msglist, num_msgs);
3415 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long),
3416 msglist, (int)(num_msgs * sizeof(long)));
3419 qrbuf.QRhighest = msglist[num_msgs - 1];
3421 qrbuf.QRhighest = 0;
3423 CtdlPutRoomLock(&qrbuf);
3425 /* Go through the messages we pulled out of the index, and decrement
3426 * their reference counts by 1. If this is the only room the message
3427 * was in, the reference count will reach zero and the message will
3428 * automatically be deleted from the database. We do this in a
3429 * separate pass because there might be plug-in hooks getting called,
3430 * and we don't want that happening during an S_ROOMS critical
3434 for (i=0; i<num_deleted; ++i) {
3435 PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3437 AdjRefCountList(dellist, num_deleted, -1);
3439 /* Now free the memory we used, and go away. */
3440 if (msglist != NULL) free(msglist);
3441 if (dellist != NULL) free(dellist);
3442 syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3443 if (need_to_free_re) regfree(&re);
3444 return (num_deleted);
3449 * GetMetaData() - Get the supplementary record for a message
3451 void GetMetaData(struct MetaData *smibuf, long msgnum)
3453 struct cdbdata *cdbsmi;
3456 memset(smibuf, 0, sizeof(struct MetaData));
3457 smibuf->meta_msgnum = msgnum;
3458 smibuf->meta_refcount = 1; /* Default reference count is 1 */
3460 /* Use the negative of the message number for its supp record index */
3461 TheIndex = (0L - msgnum);
3463 cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3464 if (cdbsmi == NULL) {
3465 return; /* record not found; leave it alone */
3467 memcpy(smibuf, cdbsmi->ptr,
3468 ((cdbsmi->len > sizeof(struct MetaData)) ?
3469 sizeof(struct MetaData) : cdbsmi->len)
3477 * PutMetaData() - (re)write supplementary record for a message
3479 void PutMetaData(struct MetaData *smibuf)
3483 /* Use the negative of the message number for the metadata db index */
3484 TheIndex = (0L - smibuf->meta_msgnum);
3486 cdb_store(CDB_MSGMAIN,
3487 &TheIndex, (int)sizeof(long),
3488 smibuf, (int)sizeof(struct MetaData)
3494 * Convenience function to process a big block of AdjRefCount() operations
3496 void AdjRefCountList(long *msgnum, long nmsg, int incr)
3500 for (i = 0; i < nmsg; i++) {
3501 AdjRefCount(msgnum[i], incr);
3507 * AdjRefCount - adjust the reference count for a message. We need to delete from disk any message whose reference count reaches zero.
3509 void AdjRefCount(long msgnum, int incr)
3511 struct MetaData smi;
3514 /* This is a *tight* critical section; please keep it that way, as
3515 * it may get called while nested in other critical sections.
3516 * Complicating this any further will surely cause deadlock!
3518 begin_critical_section(S_SUPPMSGMAIN);
3519 GetMetaData(&smi, msgnum);
3520 smi.meta_refcount += incr;
3522 end_critical_section(S_SUPPMSGMAIN);
3523 syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3525 /* If the reference count is now zero, delete both the message and its metadata record.
3527 if (smi.meta_refcount == 0) {
3528 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3530 /* Call delete hooks with NULL room to show it has gone altogether */
3531 PerformDeleteHooks(NULL, msgnum);
3533 /* Remove from message base */
3535 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3536 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));
3538 /* Remove metadata record */
3539 delnum = (0L - msgnum);
3540 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3546 * Write a generic object to this room
3548 * Note: this could be much more efficient. Right now we use two temporary
3549 * files, and still pull the message into memory as with all others.
3551 void CtdlWriteObject(char *req_room, /* Room to stuff it in */
3552 char *content_type, /* MIME type of this object */
3553 char *raw_message, /* Data to be written */
3554 off_t raw_length, /* Size of raw_message */
3555 struct ctdluser *is_mailbox, /* Mailbox room? */
3556 int is_binary, /* Is encoding necessary? */
3557 int is_unique, /* Del others of this type? */
3558 unsigned int flags /* Internal save flags */
3561 struct ctdlroom qrbuf;
3562 char roomname[ROOMNAMELEN];
3563 struct CtdlMessage *msg;
3564 StrBuf *encoded_message = NULL;
3566 if (is_mailbox != NULL) {
3567 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3570 safestrncpy(roomname, req_room, sizeof(roomname));
3573 syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3576 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3579 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3582 StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3583 StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3584 StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3587 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3590 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3594 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3597 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3600 syslog(LOG_DEBUG, "msgbase: allocating");
3601 msg = malloc(sizeof(struct CtdlMessage));
3602 memset(msg, 0, sizeof(struct CtdlMessage));
3603 msg->cm_magic = CTDLMESSAGE_MAGIC;
3604 msg->cm_anon_type = MES_NORMAL;
3605 msg->cm_format_type = 4;
3606 CM_SetField(msg, eAuthor, CC->user.fullname, strlen(CC->user.fullname));
3607 CM_SetField(msg, eOriginalRoom, req_room, strlen(req_room));
3608 msg->cm_flags = flags;
3610 CM_SetAsFieldSB(msg, eMesageText, &encoded_message);
3612 /* Create the requested room if we have to. */
3613 if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3614 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3616 /* If the caller specified this object as unique, delete all
3617 * other objects of this type that are currently in the room.
3620 syslog(LOG_DEBUG, "msgbase: deleted %d other msgs of this type",
3621 CtdlDeleteMessages(roomname, NULL, 0, content_type)
3624 /* Now write the data */
3625 CtdlSubmitMsg(msg, NULL, roomname, 0);
3630 /************************************************************************/
3631 /* MODULE INITIALIZATION */
3632 /************************************************************************/
3634 CTDL_MODULE_INIT(msgbase)
3637 FillMsgKeyLookupTable();
3640 /* return our module id for the log */