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 if (length < 0) { // You can set the length to -1 to have CM_SetField measure it for you
153 length = strlen(buf);
155 Msg->cm_fields[which] = malloc(length + 1);
156 memcpy(Msg->cm_fields[which], buf, length);
157 Msg->cm_fields[which][length] = '\0';
158 Msg->cm_lengths[which] = length;
162 void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue)
166 len = snprintf(buf, sizeof(buf), "%ld", lvalue);
167 CM_SetField(Msg, which, buf, len);
171 void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen)
173 if (Msg->cm_fields[WhichToCut] == NULL)
176 if (Msg->cm_lengths[WhichToCut] > maxlen)
178 Msg->cm_fields[WhichToCut][maxlen] = '\0';
179 Msg->cm_lengths[WhichToCut] = maxlen;
184 void CM_FlushField(struct CtdlMessage *Msg, eMsgField which)
186 if (Msg->cm_fields[which] != NULL)
187 free (Msg->cm_fields[which]);
188 Msg->cm_fields[which] = NULL;
189 Msg->cm_lengths[which] = 0;
193 void CM_Flush(struct CtdlMessage *Msg)
197 if (CM_IsValidMsg(Msg) == 0) {
201 for (i = 0; i < 256; ++i) {
202 CM_FlushField(Msg, i);
207 void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy)
210 if (Msg->cm_fields[WhichToPutTo] != NULL) {
211 free (Msg->cm_fields[WhichToPutTo]);
214 if (Msg->cm_fields[WhichtToCopy] != NULL) {
215 len = Msg->cm_lengths[WhichtToCopy];
216 Msg->cm_fields[WhichToPutTo] = malloc(len + 1);
217 memcpy(Msg->cm_fields[WhichToPutTo], Msg->cm_fields[WhichtToCopy], len);
218 Msg->cm_fields[WhichToPutTo][len] = '\0';
219 Msg->cm_lengths[WhichToPutTo] = len;
222 Msg->cm_fields[WhichToPutTo] = NULL;
223 Msg->cm_lengths[WhichToPutTo] = 0;
228 void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length)
230 if (Msg->cm_fields[which] != NULL) {
235 oldmsgsize = Msg->cm_lengths[which] + 1;
236 newmsgsize = length + oldmsgsize;
238 new = malloc(newmsgsize);
239 memcpy(new, buf, length);
240 memcpy(new + length, Msg->cm_fields[which], oldmsgsize);
241 free(Msg->cm_fields[which]);
242 Msg->cm_fields[which] = new;
243 Msg->cm_lengths[which] = newmsgsize - 1;
246 Msg->cm_fields[which] = malloc(length + 1);
247 memcpy(Msg->cm_fields[which], buf, length);
248 Msg->cm_fields[which][length] = '\0';
249 Msg->cm_lengths[which] = length;
254 void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length)
256 if (Msg->cm_fields[which] != NULL) {
257 free (Msg->cm_fields[which]);
260 Msg->cm_fields[which] = *buf;
262 if (length < 0) { // You can set the length to -1 to have CM_SetField measure it for you
263 Msg->cm_lengths[which] = strlen(Msg->cm_fields[which]);
266 Msg->cm_lengths[which] = length;
271 void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf)
273 if (Msg->cm_fields[which] != NULL) {
274 free (Msg->cm_fields[which]);
277 Msg->cm_lengths[which] = StrLength(*buf);
278 Msg->cm_fields[which] = SmashStrBuf(buf);
282 void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen)
284 if (Msg->cm_fields[which] != NULL) {
285 *retlen = Msg->cm_lengths[which];
286 *ret = Msg->cm_fields[which];
287 Msg->cm_fields[which] = NULL;
288 Msg->cm_lengths[which] = 0;
298 * Returns 1 if the supplied pointer points to a valid Citadel message.
299 * If the pointer is NULL or the magic number check fails, returns 0.
301 int CM_IsValidMsg(struct CtdlMessage *msg) {
305 if ((msg->cm_magic) != CTDLMESSAGE_MAGIC) {
306 syslog(LOG_WARNING, "msgbase: CM_IsValidMsg() self-check failed");
313 void CM_FreeContents(struct CtdlMessage *msg)
317 for (i = 0; i < 256; ++i)
318 if (msg->cm_fields[i] != NULL) {
319 free(msg->cm_fields[i]);
320 msg->cm_lengths[i] = 0;
323 msg->cm_magic = 0; /* just in case */
328 * 'Destructor' for struct CtdlMessage
330 void CM_Free(struct CtdlMessage *msg)
332 if (CM_IsValidMsg(msg) == 0) {
333 if (msg != NULL) free (msg);
336 CM_FreeContents(msg);
341 int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg)
344 len = OrgMsg->cm_lengths[i];
345 NewMsg->cm_fields[i] = malloc(len + 1);
346 if (NewMsg->cm_fields[i] == NULL) {
349 memcpy(NewMsg->cm_fields[i], OrgMsg->cm_fields[i], len);
350 NewMsg->cm_fields[i][len] = '\0';
351 NewMsg->cm_lengths[i] = len;
356 struct CtdlMessage * CM_Duplicate(struct CtdlMessage *OrgMsg)
359 struct CtdlMessage *NewMsg;
361 if (CM_IsValidMsg(OrgMsg) == 0) {
364 NewMsg = (struct CtdlMessage *)malloc(sizeof(struct CtdlMessage));
365 if (NewMsg == NULL) {
369 memcpy(NewMsg, OrgMsg, sizeof(struct CtdlMessage));
371 memset(&NewMsg->cm_fields, 0, sizeof(char*) * 256);
373 for (i = 0; i < 256; ++i) {
374 if (OrgMsg->cm_fields[i] != NULL) {
375 if (!CM_DupField(i, OrgMsg, NewMsg)) {
386 /* Determine if a given message matches the fields in a message template.
387 * Return 0 for a successful match.
389 int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) {
392 /* If there aren't any fields in the template, all messages will
395 if (template == NULL) return(0);
397 /* Null messages are bogus. */
398 if (msg == NULL) return(1);
400 for (i='A'; i<='Z'; ++i) {
401 if (template->cm_fields[i] != NULL) {
402 if (msg->cm_fields[i] == NULL) {
403 /* Considered equal if temmplate is empty string */
404 if (IsEmptyStr(template->cm_fields[i])) continue;
407 if ((template->cm_lengths[i] != msg->cm_lengths[i]) ||
408 (strcasecmp(msg->cm_fields[i], template->cm_fields[i])))
413 /* All compares succeeded: we have a match! */
419 * Retrieve the "seen" message list for the current room.
421 void CtdlGetSeen(char *buf, int which_set) {
424 /* Learn about the user and room in question */
425 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
427 if (which_set == ctdlsetseen_seen) {
428 safestrncpy(buf, vbuf.v_seen, SIZ);
430 if (which_set == ctdlsetseen_answered) {
431 safestrncpy(buf, vbuf.v_answered, SIZ);
437 * Manipulate the "seen msgs" string (or other message set strings)
439 void CtdlSetSeen(long *target_msgnums, int num_target_msgnums,
440 int target_setting, int which_set,
441 struct ctdluser *which_user, struct ctdlroom *which_room) {
442 struct cdbdata *cdbfr;
456 char *is_set; /* actually an array of booleans */
458 /* Don't bother doing *anything* if we were passed a list of zero messages */
459 if (num_target_msgnums < 1) {
463 /* If no room was specified, we go with the current room. */
465 which_room = &CC->room;
468 /* If no user was specified, we go with the current user. */
470 which_user = &CC->user;
473 syslog(LOG_DEBUG, "msgbase: CtdlSetSeen(%d msgs starting with %ld, %s, %d) in <%s>",
474 num_target_msgnums, target_msgnums[0],
475 (target_setting ? "SET" : "CLEAR"),
479 /* Learn about the user and room in question */
480 CtdlGetRelationship(&vbuf, which_user, which_room);
482 /* Load the message list */
483 cdbfr = cdb_fetch(CDB_MSGLISTS, &which_room->QRnumber, sizeof(long));
485 msglist = (long *) cdbfr->ptr;
486 cdbfr->ptr = NULL; /* CtdlSetSeen() now owns this memory */
487 num_msgs = cdbfr->len / sizeof(long);
490 return; /* No messages at all? No further action. */
493 is_set = malloc(num_msgs * sizeof(char));
494 memset(is_set, 0, (num_msgs * sizeof(char)) );
496 /* Decide which message set we're manipulating */
498 case ctdlsetseen_seen:
499 vset = NewStrBufPlain(vbuf.v_seen, -1);
501 case ctdlsetseen_answered:
502 vset = NewStrBufPlain(vbuf.v_answered, -1);
509 #if 0 /* This is a special diagnostic section. Do not allow it to run during normal operation. */
510 syslog(LOG_DEBUG, "There are %d messages in the room.\n", num_msgs);
511 for (i=0; i<num_msgs; ++i) {
512 if ((i > 0) && (msglist[i] <= msglist[i-1])) abort();
514 syslog(LOG_DEBUG, "We are twiddling %d of them.\n", num_target_msgnums);
515 for (k=0; k<num_target_msgnums; ++k) {
516 if ((k > 0) && (target_msgnums[k] <= target_msgnums[k-1])) abort();
520 /* Translate the existing sequence set into an array of booleans */
521 setstr = NewStrBuf();
525 while (StrBufExtract_NextToken(setstr, vset, &pvset, ',') >= 0) {
527 StrBufExtract_token(lostr, setstr, 0, ':');
528 if (StrBufNum_tokens(setstr, ':') >= 2) {
529 StrBufExtract_token(histr, setstr, 1, ':');
533 StrBufAppendBuf(histr, lostr, 0);
536 if (!strcmp(ChrPtr(histr), "*")) {
543 for (i = 0; i < num_msgs; ++i) {
544 if ((msglist[i] >= lo) && (msglist[i] <= hi)) {
553 /* Now translate the array of booleans back into a sequence set */
559 for (i=0; i<num_msgs; ++i) {
563 for (k=0; k<num_target_msgnums; ++k) {
564 if (msglist[i] == target_msgnums[k]) {
565 is_seen = target_setting;
569 if ((was_seen == 0) && (is_seen == 1)) {
572 else if ((was_seen == 1) && (is_seen == 0)) {
575 if (StrLength(vset) > 0) {
576 StrBufAppendBufPlain(vset, HKEY(","), 0);
579 StrBufAppendPrintf(vset, "%ld", hi);
582 StrBufAppendPrintf(vset, "%ld:%ld", lo, hi);
586 if ((is_seen) && (i == num_msgs - 1)) {
587 if (StrLength(vset) > 0) {
588 StrBufAppendBufPlain(vset, HKEY(","), 0);
590 if ((i==0) || (was_seen == 0)) {
591 StrBufAppendPrintf(vset, "%ld", msglist[i]);
594 StrBufAppendPrintf(vset, "%ld:%ld", lo, msglist[i]);
602 * We will have to stuff this string back into a 4096 byte buffer, so if it's
603 * larger than that now, truncate it by removing tokens from the beginning.
604 * The limit of 100 iterations is there to prevent an infinite loop in case
605 * something unexpected happens.
607 int number_of_truncations = 0;
608 while ( (StrLength(vset) > SIZ) && (number_of_truncations < 100) ) {
609 StrBufRemove_token(vset, 0, ',');
610 ++number_of_truncations;
614 * If we're truncating the sequence set of messages marked with the 'seen' flag,
615 * we want the earliest messages (the truncated ones) to be marked, not unmarked.
616 * Otherwise messages at the beginning will suddenly appear to be 'unseen'.
618 if ( (which_set == ctdlsetseen_seen) && (number_of_truncations > 0) ) {
620 first_tok = NewStrBuf();
621 StrBufExtract_token(first_tok, vset, 0, ',');
622 StrBufRemove_token(vset, 0, ',');
624 if (StrBufNum_tokens(first_tok, ':') > 1) {
625 StrBufRemove_token(first_tok, 0, ':');
629 new_set = NewStrBuf();
630 StrBufAppendBufPlain(new_set, HKEY("1:"), 0);
631 StrBufAppendBuf(new_set, first_tok, 0);
632 StrBufAppendBufPlain(new_set, HKEY(":"), 0);
633 StrBufAppendBuf(new_set, vset, 0);
636 FreeStrBuf(&first_tok);
640 /* Decide which message set we're manipulating */
642 case ctdlsetseen_seen:
643 safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen);
645 case ctdlsetseen_answered:
646 safestrncpy(vbuf.v_answered, ChrPtr(vset), sizeof vbuf.v_answered);
652 CtdlSetRelationship(&vbuf, which_user, which_room);
658 * API function to perform an operation for each qualifying message in the
659 * current room. (Returns the number of messages processed.)
661 int CtdlForEachMessage(int mode, long ref, char *search_string,
663 struct CtdlMessage *compare,
664 ForEachMsgCallback CallBack,
669 struct cdbdata *cdbfr;
670 long *msglist = NULL;
672 int num_processed = 0;
675 struct CtdlMessage *msg = NULL;
678 int printed_lastold = 0;
679 int num_search_msgs = 0;
680 long *search_msgs = NULL;
682 int need_to_free_re = 0;
685 if ((content_type) && (!IsEmptyStr(content_type))) {
686 regcomp(&re, content_type, 0);
690 /* Learn about the user and room in question */
691 if (server_shutting_down) {
692 if (need_to_free_re) regfree(&re);
695 CtdlGetUser(&CC->user, CC->curr_user);
697 if (server_shutting_down) {
698 if (need_to_free_re) regfree(&re);
701 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
703 if (server_shutting_down) {
704 if (need_to_free_re) regfree(&re);
708 /* Load the message list */
709 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
711 if (need_to_free_re) regfree(&re);
712 return 0; /* No messages at all? No further action. */
715 msglist = (long *) cdbfr->ptr;
716 num_msgs = cdbfr->len / sizeof(long);
718 cdbfr->ptr = NULL; /* clear this so that cdb_free() doesn't free it */
719 cdb_free(cdbfr); /* we own this memory now */
722 * Now begin the traversal.
724 if (num_msgs > 0) for (a = 0; a < num_msgs; ++a) {
726 /* If the caller is looking for a specific MIME type, filter
727 * out all messages which are not of the type requested.
729 if ((content_type != NULL) && (!IsEmptyStr(content_type))) {
731 /* This call to GetMetaData() sits inside this loop
732 * so that we only do the extra database read per msg
733 * if we need to. Doing the extra read all the time
734 * really kills the server. If we ever need to use
735 * metadata for another search criterion, we need to
736 * move the read somewhere else -- but still be smart
737 * enough to only do the read if the caller has
738 * specified something that will need it.
740 if (server_shutting_down) {
741 if (need_to_free_re) regfree(&re);
745 GetMetaData(&smi, msglist[a]);
747 /* if (strcasecmp(smi.meta_content_type, content_type)) { old non-regex way */
748 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) != 0) {
754 num_msgs = sort_msglist(msglist, num_msgs);
756 /* If a template was supplied, filter out the messages which
757 * don't match. (This could induce some delays!)
760 if (compare != NULL) {
761 for (a = 0; a < num_msgs; ++a) {
762 if (server_shutting_down) {
763 if (need_to_free_re) regfree(&re);
767 msg = CtdlFetchMessage(msglist[a], 1);
769 if (CtdlMsgCmp(msg, compare)) {
778 /* If a search string was specified, get a message list from
779 * the full text index and remove messages which aren't on both
783 * Since the lists are sorted and strictly ascending, and the
784 * output list is guaranteed to be shorter than or equal to the
785 * input list, we overwrite the bottom of the input list. This
786 * eliminates the need to memmove big chunks of the list over and
789 if ( (num_msgs > 0) && (mode == MSGS_SEARCH) && (search_string) ) {
791 /* Call search module via hook mechanism.
792 * NULL means use any search function available.
793 * otherwise replace with a char * to name of search routine
795 CtdlModuleDoSearch(&num_search_msgs, &search_msgs, search_string, "fulltext");
797 if (num_search_msgs > 0) {
801 orig_num_msgs = num_msgs;
803 for (i=0; i<orig_num_msgs; ++i) {
804 for (j=0; j<num_search_msgs; ++j) {
805 if (msglist[i] == search_msgs[j]) {
806 msglist[num_msgs++] = msglist[i];
812 num_msgs = 0; /* No messages qualify */
814 if (search_msgs != NULL) free(search_msgs);
816 /* Now that we've purged messages which don't contain the search
817 * string, treat a MSGS_SEARCH just like a MSGS_ALL from this
824 * Now iterate through the message list, according to the
825 * criteria supplied by the caller.
828 for (a = 0; a < num_msgs; ++a) {
829 if (server_shutting_down) {
830 if (need_to_free_re) regfree(&re);
832 return num_processed;
834 thismsg = msglist[a];
835 if (mode == MSGS_ALL) {
839 is_seen = is_msg_in_sequence_set(
840 vbuf.v_seen, thismsg);
841 if (is_seen) lastold = thismsg;
847 || ((mode == MSGS_OLD) && (is_seen))
848 || ((mode == MSGS_NEW) && (!is_seen))
849 || ((mode == MSGS_LAST) && (a >= (num_msgs - ref)))
850 || ((mode == MSGS_FIRST) && (a < ref))
851 || ((mode == MSGS_GT) && (thismsg > ref))
852 || ((mode == MSGS_LT) && (thismsg < ref))
853 || ((mode == MSGS_EQ) && (thismsg == ref))
856 if ((mode == MSGS_NEW) && (CC->user.flags & US_LASTOLD) && (lastold > 0L) && (printed_lastold == 0) && (!is_seen)) {
858 CallBack(lastold, userdata);
864 CallBack(thismsg, userdata);
869 if (need_to_free_re) regfree(&re);
872 * We cache the most recent msglist in order to do security checks later
874 if (CC->client_socket > 0) {
875 if (CC->cached_msglist != NULL) {
876 free(CC->cached_msglist);
878 CC->cached_msglist = msglist;
879 CC->cached_num_msgs = num_msgs;
885 return num_processed;
890 * memfmout() - Citadel text formatter and paginator.
891 * Although the original purpose of this routine was to format
892 * text to the reader's screen width, all we're really using it
893 * for here is to format text out to 80 columns before sending it
894 * to the client. The client software may reformat it again.
897 char *mptr, /* where are we going to get our text from? */
898 const char *nl /* string to terminate lines with */
901 unsigned char ch = 0;
908 while (ch=*(mptr++), ch != 0) {
911 if (client_write(outbuf, len) == -1) {
912 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
916 if (client_write(nl, nllen) == -1) {
917 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
922 else if (ch == '\r') {
923 /* Ignore carriage returns. Newlines are always LF or CRLF but never CR. */
925 else if (isspace(ch)) {
926 if (column > 72) { /* Beyond 72 columns, break on the next space */
927 if (client_write(outbuf, len) == -1) {
928 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
932 if (client_write(nl, nllen) == -1) {
933 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
946 if (column > 1000) { /* Beyond 1000 columns, break anywhere */
947 if (client_write(outbuf, len) == -1) {
948 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
952 if (client_write(nl, nllen) == -1) {
953 syslog(LOG_ERR, "msgbase: memfmout(): aborting due to write failure");
961 if (client_write(outbuf, len) == -1) {
962 syslog(LOG_ERR, "msgbase: memfmout() aborting due to write failure");
965 client_write(nl, nllen);
972 * Callback function for mime parser that simply lists the part
974 void list_this_part(char *name, char *filename, char *partnum, char *disp,
975 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
976 char *cbid, void *cbuserdata)
980 ma = (struct ma_info *)cbuserdata;
981 if (ma->is_ma == 0) {
982 cprintf("part=%s|%s|%s|%s|%s|%ld|%s|%s\n",
996 * Callback function for multipart prefix
998 void list_this_pref(char *name, char *filename, char *partnum, char *disp,
999 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1000 char *cbid, void *cbuserdata)
1004 ma = (struct ma_info *)cbuserdata;
1005 if (!strcasecmp(cbtype, "multipart/alternative")) {
1009 if (ma->is_ma == 0) {
1010 cprintf("pref=%s|%s\n", partnum, cbtype);
1016 * Callback function for multipart sufffix
1018 void list_this_suff(char *name, char *filename, char *partnum, char *disp,
1019 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1020 char *cbid, void *cbuserdata)
1024 ma = (struct ma_info *)cbuserdata;
1025 if (ma->is_ma == 0) {
1026 cprintf("suff=%s|%s\n", partnum, cbtype);
1028 if (!strcasecmp(cbtype, "multipart/alternative")) {
1035 * Callback function for mime parser that opens a section for downloading
1036 * we use serv_files function here:
1038 extern void OpenCmdResult(char *filename, const char *mime_type);
1039 void mime_download(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)
1045 /* Silently go away if there's already a download open. */
1046 if (CC->download_fp != NULL)
1050 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1051 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1053 CC->download_fp = tmpfile();
1054 if (CC->download_fp == NULL) {
1055 syslog(LOG_EMERG, "msgbase: mime_download() couldn't write: %m");
1056 cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno));
1060 rv = fwrite(content, length, 1, CC->download_fp);
1062 syslog(LOG_EMERG, "msgbase: mime_download() Couldn't write: %m");
1063 cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG);
1064 fclose(CC->download_fp);
1065 CC->download_fp = NULL;
1068 fflush(CC->download_fp);
1069 rewind(CC->download_fp);
1071 OpenCmdResult(filename, cbtype);
1077 * Callback function for mime parser that outputs a section all at once.
1078 * We can specify the desired section by part number *or* content-id.
1080 void mime_spew_section(char *name, char *filename, char *partnum, char *disp,
1081 void *content, char *cbtype, char *cbcharset, size_t length,
1082 char *encoding, char *cbid, void *cbuserdata)
1084 int *found_it = (int *)cbuserdata;
1087 (!IsEmptyStr(partnum) && (!strcasecmp(CC->download_desired_section, partnum)))
1088 || (!IsEmptyStr(cbid) && (!strcasecmp(CC->download_desired_section, cbid)))
1091 cprintf("%d %d|-1|%s|%s|%s\n",
1098 client_write(content, length);
1103 struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const char *Buffer, long Length)
1105 struct CtdlMessage *ret = NULL;
1107 const char *upper_bound;
1109 cit_uint8_t field_header;
1113 upper_bound = Buffer + Length;
1118 /* Parse the three bytes that begin EVERY message on disk.
1119 * The first is always 0xFF, the on-disk magic number.
1120 * The second is the anonymous/public type byte.
1121 * The third is the format type byte (vari, fixed, or MIME).
1125 syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum);
1128 ret = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1129 memset(ret, 0, sizeof(struct CtdlMessage));
1131 ret->cm_magic = CTDLMESSAGE_MAGIC;
1132 ret->cm_anon_type = *mptr++; /* Anon type byte */
1133 ret->cm_format_type = *mptr++; /* Format type byte */
1136 * The rest is zero or more arbitrary fields. Load them in.
1137 * We're done when we encounter either a zero-length field or
1138 * have just processed the 'M' (message text) field.
1141 field_header = '\0';
1144 /* work around possibly buggy messages: */
1145 while (field_header == '\0') {
1146 if (mptr >= upper_bound) {
1149 field_header = *mptr++;
1151 if (mptr >= upper_bound) {
1154 which = field_header;
1157 CM_SetField(ret, which, mptr, len);
1159 mptr += len + 1; /* advance to next field */
1161 } while ((mptr < upper_bound) && (field_header != 'M'));
1168 * Load a message from disk into memory.
1169 * This is used by CtdlOutputMsg() and other fetch functions.
1171 * NOTE: Caller is responsible for freeing the returned CtdlMessage struct
1172 * using the CM_Free(); function.
1174 struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body)
1176 struct cdbdata *dmsgtext;
1177 struct CtdlMessage *ret = NULL;
1179 syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body);
1180 dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
1181 if (dmsgtext == NULL) {
1182 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Failed!", msgnum, with_body);
1186 if (dmsgtext->ptr[dmsgtext->len - 1] != '\0') {
1187 syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Forcefully terminating message!!", msgnum, with_body);
1188 dmsgtext->ptr[dmsgtext->len - 1] = '\0';
1191 ret = CtdlDeserializeMessage(msgnum, with_body, dmsgtext->ptr, dmsgtext->len);
1199 /* Always make sure there's something in the msg text field. If
1200 * it's NULL, the message text is most likely stored separately,
1201 * so go ahead and fetch that. Failing that, just set a dummy
1202 * body so other code doesn't barf.
1204 if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) {
1205 dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long));
1206 if (dmsgtext != NULL) {
1207 CM_SetAsField(ret, eMesageText, &dmsgtext->ptr, dmsgtext->len - 1);
1211 if (CM_IsEmpty(ret, eMesageText)) {
1212 CM_SetField(ret, eMesageText, HKEY("\r\n\r\n (no text)\r\n"));
1220 * Pre callback function for multipart/alternative
1222 * NOTE: this differs from the standard behavior for a reason. Normally when
1223 * displaying multipart/alternative you want to show the _last_ usable
1224 * format in the message. Here we show the _first_ one, because it's
1225 * usually text/plain. Since this set of functions is designed for text
1226 * output to non-MIME-aware clients, this is the desired behavior.
1229 void fixed_output_pre(char *name, char *filename, char *partnum, char *disp,
1230 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding,
1231 char *cbid, void *cbuserdata)
1235 ma = (struct ma_info *)cbuserdata;
1236 syslog(LOG_DEBUG, "msgbase: fixed_output_pre() type=<%s>", cbtype);
1237 if (!strcasecmp(cbtype, "multipart/alternative")) {
1241 if (!strcasecmp(cbtype, "message/rfc822")) {
1248 * Post callback function for multipart/alternative
1250 void fixed_output_post(char *name, char *filename, char *partnum, char *disp,
1251 void *content, char *cbtype, char *cbcharset, size_t length,
1252 char *encoding, char *cbid, void *cbuserdata)
1256 ma = (struct ma_info *)cbuserdata;
1257 syslog(LOG_DEBUG, "msgbase: fixed_output_post() type=<%s>", cbtype);
1258 if (!strcasecmp(cbtype, "multipart/alternative")) {
1262 if (!strcasecmp(cbtype, "message/rfc822")) {
1269 * Inline callback function for mime parser that wants to display text
1271 void fixed_output(char *name, char *filename, char *partnum, char *disp,
1272 void *content, char *cbtype, char *cbcharset, size_t length,
1273 char *encoding, char *cbid, void *cbuserdata)
1280 ma = (struct ma_info *)cbuserdata;
1283 "msgbase: fixed_output() part %s: %s (%s) (%ld bytes)",
1284 partnum, filename, cbtype, (long)length
1288 * If we're in the middle of a multipart/alternative scope and
1289 * we've already printed another section, skip this one.
1291 if ( (ma->is_ma) && (ma->did_print) ) {
1292 syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype);
1297 if ( (!strcasecmp(cbtype, "text/plain"))
1298 || (IsEmptyStr(cbtype)) ) {
1301 client_write(wptr, length);
1302 if (wptr[length-1] != '\n') {
1309 if (!strcasecmp(cbtype, "text/html")) {
1310 ptr = html_to_ascii(content, length, 80);
1312 client_write(ptr, wlen);
1313 if ((wlen > 0) && (ptr[wlen-1] != '\n')) {
1320 if (ma->use_fo_hooks) {
1321 if (PerformFixedOutputHooks(cbtype, content, length)) {
1322 /* above function returns nonzero if it handled the part */
1327 if (strncasecmp(cbtype, "multipart/", 10)) {
1328 cprintf("Part %s: %s (%s) (%ld bytes)\r\n",
1329 partnum, filename, cbtype, (long)length);
1336 * The client is elegant and sophisticated and wants to be choosy about
1337 * MIME content types, so figure out which multipart/alternative part
1338 * we're going to send.
1340 * We use a system of weights. When we find a part that matches one of the
1341 * MIME types we've declared as preferential, we can store it in ma->chosen_part
1342 * and then set ma->chosen_pref to that MIME type's position in our preference
1343 * list. If we then hit another match, we only replace the first match if
1344 * the preference value is lower.
1346 void choose_preferred(char *name, char *filename, char *partnum, char *disp,
1347 void *content, char *cbtype, char *cbcharset, size_t length,
1348 char *encoding, char *cbid, void *cbuserdata)
1354 ma = (struct ma_info *)cbuserdata;
1356 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1357 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1358 if ( (!strcasecmp(buf, cbtype)) && (!ma->freeze) ) {
1359 if (i < ma->chosen_pref) {
1360 syslog(LOG_DEBUG, "msgbase: setting chosen part to <%s>", partnum);
1361 safestrncpy(ma->chosen_part, partnum, sizeof ma->chosen_part);
1362 ma->chosen_pref = i;
1370 * Now that we've chosen our preferred part, output it.
1372 void output_preferred(char *name,
1386 int add_newline = 0;
1389 char *decoded = NULL;
1390 size_t bytes_decoded;
1393 ma = (struct ma_info *)cbuserdata;
1395 /* This is not the MIME part you're looking for... */
1396 if (strcasecmp(partnum, ma->chosen_part)) return;
1398 /* If the content-type of this part is in our preferred formats
1399 * list, we can simply output it verbatim.
1401 for (i=0; i<num_tokens(CC->preferred_formats, '|'); ++i) {
1402 extract_token(buf, CC->preferred_formats, i, '|', sizeof buf);
1403 if (!strcasecmp(buf, cbtype)) {
1404 /* Yeah! Go! W00t!! */
1405 if (ma->dont_decode == 0)
1406 rc = mime_decode_now (content,
1412 break; /* Give us the chance, maybe theres another one. */
1414 if (rc == 0) text_content = (char *)content;
1416 text_content = decoded;
1417 length = bytes_decoded;
1420 if (text_content[length-1] != '\n') {
1423 cprintf("Content-type: %s", cbtype);
1424 if (!IsEmptyStr(cbcharset)) {
1425 cprintf("; charset=%s", cbcharset);
1427 cprintf("\nContent-length: %d\n",
1428 (int)(length + add_newline) );
1429 if (!IsEmptyStr(encoding)) {
1430 cprintf("Content-transfer-encoding: %s\n", encoding);
1433 cprintf("Content-transfer-encoding: 7bit\n");
1435 cprintf("X-Citadel-MSG4-Partnum: %s\n", partnum);
1437 if (client_write(text_content, length) == -1)
1439 syslog(LOG_ERR, "msgbase: output_preferred() aborting due to write failure");
1442 if (add_newline) cprintf("\n");
1443 if (decoded != NULL) free(decoded);
1448 /* No translations required or possible: output as text/plain */
1449 cprintf("Content-type: text/plain\n\n");
1451 if (ma->dont_decode == 0)
1452 rc = mime_decode_now (content,
1458 return; /* Give us the chance, maybe theres another one. */
1460 if (rc == 0) text_content = (char *)content;
1462 text_content = decoded;
1463 length = bytes_decoded;
1466 fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset,
1467 length, encoding, cbid, cbuserdata);
1468 if (decoded != NULL) free(decoded);
1473 char desired_section[64];
1480 * Callback function for
1482 void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp,
1483 void *content, char *cbtype, char *cbcharset, size_t length,
1484 char *encoding, char *cbid, void *cbuserdata)
1486 struct encapmsg *encap;
1488 encap = (struct encapmsg *)cbuserdata;
1490 /* Only proceed if this is the desired section... */
1491 if (!strcasecmp(encap->desired_section, partnum)) {
1492 encap->msglen = length;
1493 encap->msg = malloc(length + 2);
1494 memcpy(encap->msg, content, length);
1501 * Determine whether the specified message exists in the cached_msglist
1502 * (This is a security check)
1504 int check_cached_msglist(long msgnum) {
1506 /* cases in which we skip the check */
1507 if (!CC) return om_ok; /* not a session */
1508 if (CC->client_socket <= 0) return om_ok; /* not a client session */
1509 if (CC->cached_msglist == NULL) return om_access_denied; /* no msglist fetched */
1510 if (CC->cached_num_msgs == 0) return om_access_denied; /* nothing to check */
1513 /* Do a binary search within the cached_msglist for the requested msgnum */
1515 int max = (CC->cached_num_msgs - 1);
1517 while (max >= min) {
1518 int middle = min + (max-min) / 2 ;
1519 if (msgnum == CC->cached_msglist[middle]) {
1522 if (msgnum > CC->cached_msglist[middle]) {
1530 return om_access_denied;
1535 * Get a message off disk. (returns om_* values found in msgbase.h)
1538 int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */
1539 int mode, /* how would you like that message? */
1540 int headers_only, /* eschew the message body? */
1541 int do_proto, /* do Citadel protocol responses? */
1542 int crlf, /* Use CRLF newlines instead of LF? */
1543 char *section, /* NULL or a message/rfc822 section */
1544 int flags, /* various flags; see msgbase.h */
1549 struct CtdlMessage *TheMessage = NULL;
1550 int retcode = CIT_OK;
1551 struct encapmsg encap;
1554 syslog(LOG_DEBUG, "msgbase: CtdlOutputMsg(msgnum=%ld, mode=%d, section=%s)",
1556 (section ? section : "<>")
1559 r = CtdlDoIHavePermissionToReadMessagesInThisRoom();
1562 if (r == om_not_logged_in) {
1563 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
1566 cprintf("%d An unknown error has occurred.\n", ERROR);
1573 * Check to make sure the message is actually IN this room
1575 r = check_cached_msglist(msg_num);
1576 if (r == om_access_denied) {
1577 /* Not in the cache? We get ONE shot to check it again. */
1578 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, NULL, NULL);
1579 r = check_cached_msglist(msg_num);
1582 syslog(LOG_DEBUG, "msgbase: security check fail; message %ld is not in %s",
1583 msg_num, CC->room.QRname
1586 if (r == om_access_denied) {
1587 cprintf("%d message %ld was not found in this room\n",
1588 ERROR + HIGHER_ACCESS_REQUIRED,
1597 * Fetch the message from disk. If we're in HEADERS_FAST mode,
1598 * request that we don't even bother loading the body into memory.
1600 if (headers_only == HEADERS_FAST) {
1601 TheMessage = CtdlFetchMessage(msg_num, 0);
1604 TheMessage = CtdlFetchMessage(msg_num, 1);
1607 if (TheMessage == NULL) {
1608 if (do_proto) cprintf("%d Can't locate msg %ld on disk\n",
1609 ERROR + MESSAGE_NOT_FOUND, msg_num);
1610 return(om_no_such_msg);
1613 /* Here is the weird form of this command, to process only an
1614 * encapsulated message/rfc822 section.
1616 if (section) if (!IsEmptyStr(section)) if (strcmp(section, "0")) {
1617 memset(&encap, 0, sizeof encap);
1618 safestrncpy(encap.desired_section, section, sizeof encap.desired_section);
1619 mime_parser(CM_RANGE(TheMessage, eMesageText),
1620 *extract_encapsulated_message,
1621 NULL, NULL, (void *)&encap, 0
1624 if ((Author != NULL) && (*Author == NULL))
1627 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1629 if ((Address != NULL) && (*Address == NULL))
1632 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1634 if ((MessageID != NULL) && (*MessageID == NULL))
1637 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1639 CM_Free(TheMessage);
1643 encap.msg[encap.msglen] = 0;
1644 TheMessage = convert_internet_message(encap.msg);
1645 encap.msg = NULL; /* no free() here, TheMessage owns it now */
1647 /* Now we let it fall through to the bottom of this
1648 * function, because TheMessage now contains the
1649 * encapsulated message instead of the top-level
1650 * message. Isn't that neat?
1655 cprintf("%d msg %ld has no part %s\n",
1656 ERROR + MESSAGE_NOT_FOUND,
1660 retcode = om_no_such_msg;
1665 /* Ok, output the message now */
1666 if (retcode == CIT_OK)
1667 retcode = CtdlOutputPreLoadedMsg(TheMessage, mode, headers_only, do_proto, crlf, flags);
1668 if ((Author != NULL) && (*Author == NULL))
1671 CM_GetAsField(TheMessage, eAuthor, Author, &len);
1673 if ((Address != NULL) && (*Address == NULL))
1676 CM_GetAsField(TheMessage, erFc822Addr, Address, &len);
1678 if ((MessageID != NULL) && (*MessageID == NULL))
1681 CM_GetAsField(TheMessage, emessageId, MessageID, &len);
1684 CM_Free(TheMessage);
1690 void OutputCtdlMsgHeaders(
1691 struct CtdlMessage *TheMessage,
1692 int do_proto) /* do Citadel protocol responses? */
1696 char display_name[256];
1698 /* begin header processing loop for Citadel message format */
1699 safestrncpy(display_name, "<unknown>", sizeof display_name);
1700 if (!CM_IsEmpty(TheMessage, eAuthor)) {
1701 strcpy(buf, TheMessage->cm_fields[eAuthor]);
1702 if (TheMessage->cm_anon_type == MES_ANONONLY) {
1703 safestrncpy(display_name, "****", sizeof display_name);
1705 else if (TheMessage->cm_anon_type == MES_ANONOPT) {
1706 safestrncpy(display_name, "anonymous", sizeof display_name);
1709 safestrncpy(display_name, buf, sizeof display_name);
1711 if ((is_room_aide())
1712 && ((TheMessage->cm_anon_type == MES_ANONONLY)
1713 || (TheMessage->cm_anon_type == MES_ANONOPT))) {
1714 size_t tmp = strlen(display_name);
1715 snprintf(&display_name[tmp],
1716 sizeof display_name - tmp,
1721 /* Now spew the header fields in the order we like them. */
1722 for (i=0; i< NDiskFields; ++i) {
1724 Field = FieldOrder[i];
1725 if (Field != eMesageText) {
1726 if ( (!CM_IsEmpty(TheMessage, Field))
1727 && (msgkeys[Field] != NULL) ) {
1728 if ((Field == eenVelopeTo) ||
1729 (Field == eRecipient) ||
1730 (Field == eCarbonCopY)) {
1731 sanitize_truncated_recipient(TheMessage->cm_fields[Field]);
1733 if (Field == eAuthor) {
1734 if (do_proto) cprintf("%s=%s\n",
1738 /* Masquerade display name if needed */
1741 cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]);
1750 void OutputRFC822MsgHeaders(
1751 struct CtdlMessage *TheMessage,
1752 int flags, /* should the message be exported clean */
1753 const char *nl, int nlen,
1754 char *mid, long sizeof_mid,
1755 char *suser, long sizeof_suser,
1756 char *luser, long sizeof_luser,
1757 char *fuser, long sizeof_fuser,
1758 char *snode, long sizeof_snode)
1760 char datestamp[100];
1761 int subject_found = 0;
1768 for (i = 0; i < NDiskFields; ++i) {
1769 if (TheMessage->cm_fields[FieldOrder[i]]) {
1770 mptr = mpptr = TheMessage->cm_fields[FieldOrder[i]];
1771 switch (FieldOrder[i]) {
1773 safestrncpy(luser, mptr, sizeof_luser);
1774 safestrncpy(suser, mptr, sizeof_suser);
1777 if ((flags & QP_EADDR) != 0) {
1778 mptr = qp_encode_email_addrs(mptr);
1780 sanitize_truncated_recipient(mptr);
1781 cprintf("CC: %s%s", mptr, nl);
1784 cprintf("Return-Path: %s%s", mptr, nl);
1787 cprintf("List-ID: %s%s", mptr, nl);
1790 if ((flags & QP_EADDR) != 0)
1791 mptr = qp_encode_email_addrs(mptr);
1793 while ((*hptr != '\0') && isspace(*hptr))
1795 if (!IsEmptyStr(hptr))
1796 cprintf("Envelope-To: %s%s", hptr, nl);
1799 cprintf("Subject: %s%s", mptr, nl);
1803 safestrncpy(mid, mptr, sizeof_mid);
1806 safestrncpy(fuser, mptr, sizeof_fuser);
1808 if (haschar(mptr, '@') == 0) {
1809 sanitize_truncated_recipient(mptr);
1810 cprintf("To: %s@%s", mptr, CtdlGetConfigStr("c_fqdn"));
1814 if ((flags & QP_EADDR) != 0) {
1815 mptr = qp_encode_email_addrs(mptr);
1817 sanitize_truncated_recipient(mptr);
1818 cprintf("To: %s", mptr);
1823 datestring(datestamp, sizeof datestamp, atol(mptr), DATESTRING_RFC822);
1824 cprintf("Date: %s%s", datestamp, nl);
1827 cprintf("References: ");
1828 k = num_tokens(mptr, '|');
1829 for (j=0; j<k; ++j) {
1830 extract_token(buf, mptr, j, '|', sizeof buf);
1831 cprintf("<%s>", buf);
1842 while ((*hptr != '\0') && isspace(*hptr))
1844 if (!IsEmptyStr(hptr))
1845 cprintf("Reply-To: %s%s", mptr, nl);
1857 /* these don't map to mime message headers. */
1860 if (mptr != mpptr) {
1865 if (subject_found == 0) {
1866 cprintf("Subject: (no subject)%s", nl);
1871 void Dump_RFC822HeadersBody(
1872 struct CtdlMessage *TheMessage,
1873 int headers_only, /* eschew the message body? */
1874 int flags, /* should the bessage be exported clean? */
1875 const char *nl, int nlen)
1877 cit_uint8_t prev_ch;
1879 const char *StartOfText = StrBufNOTNULL;
1882 int nllen = strlen(nl);
1886 mptr = TheMessage->cm_fields[eMesageText];
1889 while (*mptr != '\0') {
1890 if (*mptr == '\r') {
1897 eoh = (*(mptr+1) == '\r') && (*(mptr+2) == '\n');
1899 eoh = *(mptr+1) == '\n';
1903 StartOfText = strchr(StartOfText, '\n');
1904 StartOfText = strchr(StartOfText, '\n');
1907 if (((headers_only == HEADERS_NONE) && (mptr >= StartOfText)) ||
1908 ((headers_only == HEADERS_ONLY) && (mptr < StartOfText)) ||
1909 ((headers_only != HEADERS_NONE) &&
1910 (headers_only != HEADERS_ONLY))
1912 if (*mptr == '\n') {
1913 memcpy(&outbuf[outlen], nl, nllen);
1915 outbuf[outlen] = '\0';
1918 outbuf[outlen++] = *mptr;
1922 if (flags & ESC_DOT) {
1923 if ((prev_ch == '\n') && (*mptr == '.') && ((*(mptr+1) == '\r') || (*(mptr+1) == '\n'))) {
1924 outbuf[outlen++] = '.';
1929 if (outlen > 1000) {
1930 if (client_write(outbuf, outlen) == -1) {
1931 syslog(LOG_ERR, "msgbase: Dump_RFC822HeadersBody() aborting due to write failure");
1934 lfSent = (outbuf[outlen - 1] == '\n');
1939 client_write(outbuf, outlen);
1940 lfSent = (outbuf[outlen - 1] == '\n');
1943 client_write(nl, nlen);
1947 /* If the format type on disk is 1 (fixed-format), then we want
1948 * everything to be output completely literally ... regardless of
1949 * what message transfer format is in use.
1951 void DumpFormatFixed(
1952 struct CtdlMessage *TheMessage,
1953 int mode, /* how would you like that message? */
1954 const char *nl, int nllen)
1962 mptr = TheMessage->cm_fields[eMesageText];
1964 if (mode == MT_MIME) {
1965 cprintf("Content-type: text/plain\n\n");
1969 while (ch = *mptr++, ch > 0) {
1973 if ((buflen > 250) && (!xlline)){
1977 while ((buflen > 0) &&
1978 (!isspace(buf[buflen])))
1984 mptr -= tbuflen - buflen;
1990 /* if we reach the outer bounds of our buffer, abort without respect for what we purge. */
1991 if (xlline && ((isspace(ch)) || (buflen > SIZ - nllen - 2))) {
1996 memcpy (&buf[buflen], nl, nllen);
2000 if (client_write(buf, buflen) == -1) {
2001 syslog(LOG_ERR, "msgbase: DumpFormatFixed() aborting due to write failure");
2013 if (!IsEmptyStr(buf)) {
2014 cprintf("%s%s", buf, nl);
2020 * Get a message off disk. (returns om_* values found in msgbase.h)
2022 int CtdlOutputPreLoadedMsg(
2023 struct CtdlMessage *TheMessage,
2024 int mode, /* how would you like that message? */
2025 int headers_only, /* eschew the message body? */
2026 int do_proto, /* do Citadel protocol responses? */
2027 int crlf, /* Use CRLF newlines instead of LF? */
2028 int flags /* should the bessage be exported clean? */
2031 const char *nl; /* newline string */
2035 /* Buffers needed for RFC822 translation. These are all filled
2036 * using functions that are bounds-checked, and therefore we can
2037 * make them substantially smaller than SIZ.
2045 syslog(LOG_DEBUG, "msgbase: CtdlOutputPreLoadedMsg(TheMessage=%s, %d, %d, %d, %d",
2046 ((TheMessage == NULL) ? "NULL" : "not null"),
2047 mode, headers_only, do_proto, crlf
2050 strcpy(mid, "unknown");
2051 nl = (crlf ? "\r\n" : "\n");
2052 nlen = crlf ? 2 : 1;
2054 if (!CM_IsValidMsg(TheMessage)) {
2055 syslog(LOG_ERR, "msgbase: error; invalid preloaded message for output");
2056 return(om_no_such_msg);
2059 /* Suppress envelope recipients if required to avoid disclosing BCC addresses.
2060 * Pad it with spaces in order to avoid changing the RFC822 length of the message.
2062 if ( (flags & SUPPRESS_ENV_TO) && (!CM_IsEmpty(TheMessage, eenVelopeTo)) ) {
2063 memset(TheMessage->cm_fields[eenVelopeTo], ' ', TheMessage->cm_lengths[eenVelopeTo]);
2066 /* Are we downloading a MIME component? */
2067 if (mode == MT_DOWNLOAD) {
2068 if (TheMessage->cm_format_type != FMT_RFC822) {
2070 cprintf("%d This is not a MIME message.\n",
2071 ERROR + ILLEGAL_VALUE);
2072 } else if (CC->download_fp != NULL) {
2073 if (do_proto) cprintf(
2074 "%d You already have a download open.\n",
2075 ERROR + RESOURCE_BUSY);
2077 /* Parse the message text component */
2078 mime_parser(CM_RANGE(TheMessage, eMesageText),
2079 *mime_download, NULL, NULL, NULL, 0);
2080 /* If there's no file open by this time, the requested
2081 * section wasn't found, so print an error
2083 if (CC->download_fp == NULL) {
2084 if (do_proto) cprintf(
2085 "%d Section %s not found.\n",
2086 ERROR + FILE_NOT_FOUND,
2087 CC->download_desired_section);
2090 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2093 /* MT_SPEW_SECTION is like MT_DOWNLOAD except it outputs the whole MIME part
2094 * in a single server operation instead of opening a download file.
2096 if (mode == MT_SPEW_SECTION) {
2097 if (TheMessage->cm_format_type != FMT_RFC822) {
2099 cprintf("%d This is not a MIME message.\n",
2100 ERROR + ILLEGAL_VALUE);
2102 /* Parse the message text component */
2105 mime_parser(CM_RANGE(TheMessage, eMesageText),
2106 *mime_spew_section, NULL, NULL, (void *)&found_it, 0);
2107 /* If section wasn't found, print an error
2110 if (do_proto) cprintf(
2111 "%d Section %s not found.\n",
2112 ERROR + FILE_NOT_FOUND,
2113 CC->download_desired_section);
2116 return((CC->download_fp != NULL) ? om_ok : om_mime_error);
2119 /* now for the user-mode message reading loops */
2120 if (do_proto) cprintf("%d msg:\n", LISTING_FOLLOWS);
2122 /* Does the caller want to skip the headers? */
2123 if (headers_only == HEADERS_NONE) goto START_TEXT;
2125 /* Tell the client which format type we're using. */
2126 if ( (mode == MT_CITADEL) && (do_proto) ) {
2127 cprintf("type=%d\n", TheMessage->cm_format_type);
2130 /* nhdr=yes means that we're only displaying headers, no body */
2131 if ( (TheMessage->cm_anon_type == MES_ANONONLY)
2132 && ((mode == MT_CITADEL) || (mode == MT_MIME))
2135 cprintf("nhdr=yes\n");
2138 if ((mode == MT_CITADEL) || (mode == MT_MIME))
2139 OutputCtdlMsgHeaders(TheMessage, do_proto);
2142 /* begin header processing loop for RFC822 transfer format */
2147 if (mode == MT_RFC822)
2148 OutputRFC822MsgHeaders(
2153 suser, sizeof(suser),
2154 luser, sizeof(luser),
2155 fuser, sizeof(fuser),
2156 snode, sizeof(snode)
2160 for (i=0; !IsEmptyStr(&suser[i]); ++i) {
2161 suser[i] = tolower(suser[i]);
2162 if (!isalnum(suser[i])) suser[i]='_';
2165 if (mode == MT_RFC822) {
2166 /* Construct a fun message id */
2167 cprintf("Message-ID: <%s", mid);
2168 if (strchr(mid, '@')==NULL) {
2169 cprintf("@%s", snode);
2173 if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONONLY)) {
2174 cprintf("From: \"----\" <x@x.org>%s", nl);
2176 else if (!is_room_aide() && (TheMessage->cm_anon_type == MES_ANONOPT)) {
2177 cprintf("From: \"anonymous\" <x@x.org>%s", nl);
2179 else if (!IsEmptyStr(fuser)) {
2180 cprintf("From: \"%s\" <%s>%s", luser, fuser, nl);
2183 cprintf("From: \"%s\" <%s@%s>%s", luser, suser, snode, nl);
2186 /* Blank line signifying RFC822 end-of-headers */
2187 if (TheMessage->cm_format_type != FMT_RFC822) {
2192 /* end header processing loop ... at this point, we're in the text */
2194 if (headers_only == HEADERS_FAST) goto DONE;
2196 /* Tell the client about the MIME parts in this message */
2197 if (TheMessage->cm_format_type == FMT_RFC822) {
2198 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2199 memset(&ma, 0, sizeof(struct ma_info));
2200 mime_parser(CM_RANGE(TheMessage, eMesageText),
2201 (do_proto ? *list_this_part : NULL),
2202 (do_proto ? *list_this_pref : NULL),
2203 (do_proto ? *list_this_suff : NULL),
2206 else if (mode == MT_RFC822) { /* unparsed RFC822 dump */
2207 Dump_RFC822HeadersBody(
2216 if (headers_only == HEADERS_ONLY) {
2220 /* signify start of msg text */
2221 if ( (mode == MT_CITADEL) || (mode == MT_MIME) ) {
2222 if (do_proto) cprintf("text\n");
2225 if (TheMessage->cm_format_type == FMT_FIXED)
2228 mode, /* how would you like that message? */
2231 /* If the message on disk is format 0 (Citadel vari-format), we
2232 * output using the formatter at 80 columns. This is the final output
2233 * form if the transfer format is RFC822, but if the transfer format
2234 * is Citadel proprietary, it'll still work, because the indentation
2235 * for new paragraphs is correct and the client will reformat the
2236 * message to the reader's screen width.
2238 if (TheMessage->cm_format_type == FMT_CITADEL) {
2239 if (mode == MT_MIME) {
2240 cprintf("Content-type: text/x-citadel-variformat\n\n");
2242 memfmout(TheMessage->cm_fields[eMesageText], nl);
2245 /* If the message on disk is format 4 (MIME), we've gotta hand it
2246 * off to the MIME parser. The client has already been told that
2247 * this message is format 1 (fixed format), so the callback function
2248 * we use will display those parts as-is.
2250 if (TheMessage->cm_format_type == FMT_RFC822) {
2251 memset(&ma, 0, sizeof(struct ma_info));
2253 if (mode == MT_MIME) {
2254 ma.use_fo_hooks = 0;
2255 strcpy(ma.chosen_part, "1");
2256 ma.chosen_pref = 9999;
2257 ma.dont_decode = CC->msg4_dont_decode;
2258 mime_parser(CM_RANGE(TheMessage, eMesageText),
2259 *choose_preferred, *fixed_output_pre,
2260 *fixed_output_post, (void *)&ma, 1);
2261 mime_parser(CM_RANGE(TheMessage, eMesageText),
2262 *output_preferred, NULL, NULL, (void *)&ma, 1);
2265 ma.use_fo_hooks = 1;
2266 mime_parser(CM_RANGE(TheMessage, eMesageText),
2267 *fixed_output, *fixed_output_pre,
2268 *fixed_output_post, (void *)&ma, 0);
2273 DONE: /* now we're done */
2274 if (do_proto) cprintf("000\n");
2279 * Save one or more message pointers into a specified room
2280 * (Returns 0 for success, nonzero for failure)
2281 * roomname may be NULL to use the current room
2283 * Note that the 'supplied_msg' field may be set to NULL, in which case
2284 * the message will be fetched from disk, by number, if we need to perform
2285 * replication checks. This adds an additional database read, so if the
2286 * caller already has the message in memory then it should be supplied. (Obviously
2287 * this mode of operation only works if we're saving a single message.)
2289 int CtdlSaveMsgPointersInRoom(char *roomname, long newmsgidlist[], int num_newmsgs,
2290 int do_repl_check, struct CtdlMessage *supplied_msg, int suppress_refcount_adj
2293 char hold_rm[ROOMNAMELEN];
2294 struct cdbdata *cdbfr;
2297 long highest_msg = 0L;
2300 struct CtdlMessage *msg = NULL;
2302 long *msgs_to_be_merged = NULL;
2303 int num_msgs_to_be_merged = 0;
2306 "msgbase: CtdlSaveMsgPointersInRoom(room=%s, num_msgs=%d, repl=%d, suppress_rca=%d)",
2307 roomname, num_newmsgs, do_repl_check, suppress_refcount_adj
2310 strcpy(hold_rm, CC->room.QRname);
2313 if (newmsgidlist == NULL) return(ERROR + INTERNAL_ERROR);
2314 if (num_newmsgs < 1) return(ERROR + INTERNAL_ERROR);
2315 if (num_newmsgs > 1) supplied_msg = NULL;
2317 /* Now the regular stuff */
2318 if (CtdlGetRoomLock(&CC->room,
2319 ((roomname != NULL) ? roomname : CC->room.QRname) )
2321 syslog(LOG_ERR, "msgbase: no such room <%s>", roomname);
2322 return(ERROR + ROOM_NOT_FOUND);
2326 msgs_to_be_merged = malloc(sizeof(long) * num_newmsgs);
2327 num_msgs_to_be_merged = 0;
2330 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
2331 if (cdbfr == NULL) {
2335 msglist = (long *) cdbfr->ptr;
2336 cdbfr->ptr = NULL; /* CtdlSaveMsgPointerInRoom() now owns this memory */
2337 num_msgs = cdbfr->len / sizeof(long);
2342 /* Create a list of msgid's which were supplied by the caller, but do
2343 * not already exist in the target room. It is absolutely taboo to
2344 * have more than one reference to the same message in a room.
2346 for (i=0; i<num_newmsgs; ++i) {
2348 if (num_msgs > 0) for (j=0; j<num_msgs; ++j) {
2349 if (msglist[j] == newmsgidlist[i]) {
2354 msgs_to_be_merged[num_msgs_to_be_merged++] = newmsgidlist[i];
2358 syslog(LOG_DEBUG, "msgbase: %d unique messages to be merged", num_msgs_to_be_merged);
2361 * Now merge the new messages
2363 msglist = realloc(msglist, (sizeof(long) * (num_msgs + num_msgs_to_be_merged)) );
2364 if (msglist == NULL) {
2365 syslog(LOG_ALERT, "msgbase: ERROR; can't realloc message list!");
2366 free(msgs_to_be_merged);
2367 return (ERROR + INTERNAL_ERROR);
2369 memcpy(&msglist[num_msgs], msgs_to_be_merged, (sizeof(long) * num_msgs_to_be_merged) );
2370 num_msgs += num_msgs_to_be_merged;
2372 /* Sort the message list, so all the msgid's are in order */
2373 num_msgs = sort_msglist(msglist, num_msgs);
2375 /* Determine the highest message number */
2376 highest_msg = msglist[num_msgs - 1];
2378 /* Write it back to disk. */
2379 cdb_store(CDB_MSGLISTS, &CC->room.QRnumber, (int)sizeof(long),
2380 msglist, (int)(num_msgs * sizeof(long)));
2382 /* Free up the memory we used. */
2385 /* Update the highest-message pointer and unlock the room. */
2386 CC->room.QRhighest = highest_msg;
2387 CtdlPutRoomLock(&CC->room);
2389 /* Perform replication checks if necessary */
2390 if ( (DoesThisRoomNeedEuidIndexing(&CC->room)) && (do_repl_check) ) {
2391 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() doing repl checks");
2393 for (i=0; i<num_msgs_to_be_merged; ++i) {
2394 msgid = msgs_to_be_merged[i];
2396 if (supplied_msg != NULL) {
2400 msg = CtdlFetchMessage(msgid, 0);
2404 ReplicationChecks(msg);
2406 /* If the message has an Exclusive ID, index that... */
2407 if (!CM_IsEmpty(msg, eExclusiveID)) {
2408 index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgid);
2411 /* Free up the memory we may have allocated */
2412 if (msg != supplied_msg) {
2421 syslog(LOG_DEBUG, "msgbase: CtdlSaveMsgPointerInRoom() skips repl checks");
2424 /* Submit this room for processing by hooks */
2425 int total_roomhook_errors = PerformRoomHooks(&CC->room);
2426 if (total_roomhook_errors) {
2427 syslog(LOG_WARNING, "msgbase: room hooks returned %d errors", total_roomhook_errors);
2430 /* Go back to the room we were in before we wandered here... */
2431 CtdlGetRoom(&CC->room, hold_rm);
2433 /* Bump the reference count for all messages which were merged */
2434 if (!suppress_refcount_adj) {
2435 AdjRefCountList(msgs_to_be_merged, num_msgs_to_be_merged, +1);
2438 /* Free up memory... */
2439 if (msgs_to_be_merged != NULL) {
2440 free(msgs_to_be_merged);
2443 /* Return success. */
2449 * This is the same as CtdlSaveMsgPointersInRoom() but it only accepts
2452 int CtdlSaveMsgPointerInRoom(char *roomname, long msgid,
2453 int do_repl_check, struct CtdlMessage *supplied_msg)
2455 return CtdlSaveMsgPointersInRoom(roomname, &msgid, 1, do_repl_check, supplied_msg, 0);
2462 * Message base operation to save a new message to the message store
2463 * (returns new message number)
2465 * This is the back end for CtdlSubmitMsg() and should not be directly
2466 * called by server-side modules.
2469 long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) {
2477 * If the message is big, set its body aside for storage elsewhere
2478 * and we hide the message body from the serializer
2480 if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG)
2483 holdM = msg->cm_fields[eMesageText];
2484 msg->cm_fields[eMesageText] = NULL;
2485 holdMLen = msg->cm_lengths[eMesageText];
2486 msg->cm_lengths[eMesageText] = 0;
2489 /* Serialize our data structure for storage in the database */
2490 CtdlSerializeMessage(&smr, msg);
2493 /* put the message body back into the message */
2494 msg->cm_fields[eMesageText] = holdM;
2495 msg->cm_lengths[eMesageText] = holdMLen;
2500 cprintf("%d Unable to serialize message\n",
2501 ERROR + INTERNAL_ERROR);
2504 syslog(LOG_ERR, "msgbase: CtdlSaveMessage() unable to serialize message");
2510 /* Write our little bundle of joy into the message base */
2511 retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long),
2514 syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval);
2518 retval = cdb_store(CDB_BIGMSGS,
2525 syslog(LOG_ERR, "msgbase: failed to store message body for msgid %ld: %ld", msgid, retval);
2530 /* Free the memory we used for the serialized message */
2536 long send_message(struct CtdlMessage *msg) {
2542 /* Get a new message number */
2543 newmsgid = get_new_message_number();
2545 /* Generate an ID if we don't have one already */
2546 if (CM_IsEmpty(msg, emessageId)) {
2547 msgidbuflen = snprintf(msgidbuf, sizeof msgidbuf, "%08lX-%08lX@%s",
2548 (long unsigned int) time(NULL),
2549 (long unsigned int) newmsgid,
2550 CtdlGetConfigStr("c_fqdn")
2553 CM_SetField(msg, emessageId, msgidbuf, msgidbuflen);
2556 retval = CtdlSaveThisMessage(msg, newmsgid, 1);
2562 /* Return the *local* message ID to the caller
2563 * (even if we're storing an incoming network message)
2571 * Serialize a struct CtdlMessage into the format used on disk and network.
2573 * This function loads up a "struct ser_ret" (defined in server.h) which
2574 * contains the length of the serialized message and a pointer to the
2575 * serialized message in memory. THE LATTER MUST BE FREED BY THE CALLER.
2577 void CtdlSerializeMessage(struct ser_ret *ret, /* return values */
2578 struct CtdlMessage *msg) /* unserialized msg */
2584 * Check for valid message format
2586 if (CM_IsValidMsg(msg) == 0) {
2587 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() aborting due to invalid message");
2594 for (i=0; i < NDiskFields; ++i)
2595 if (msg->cm_fields[FieldOrder[i]] != NULL)
2596 ret->len += msg->cm_lengths[FieldOrder[i]] + 2;
2598 ret->ser = malloc(ret->len);
2599 if (ret->ser == NULL) {
2600 syslog(LOG_ERR, "msgbase: CtdlSerializeMessage() malloc(%ld) failed: %m", (long)ret->len);
2607 ret->ser[1] = msg->cm_anon_type;
2608 ret->ser[2] = msg->cm_format_type;
2611 for (i=0; i < NDiskFields; ++i)
2612 if (msg->cm_fields[FieldOrder[i]] != NULL)
2614 ret->ser[wlen++] = (char)FieldOrder[i];
2616 memcpy(&ret->ser[wlen],
2617 msg->cm_fields[FieldOrder[i]],
2618 msg->cm_lengths[FieldOrder[i]] + 1);
2620 wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1;
2623 if (ret->len != wlen) {
2624 syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen);
2632 * Check to see if any messages already exist in the current room which
2633 * carry the same Exclusive ID as this one. If any are found, delete them.
2635 void ReplicationChecks(struct CtdlMessage *msg) {
2636 long old_msgnum = (-1L);
2638 if (DoesThisRoomNeedEuidIndexing(&CC->room) == 0) return;
2640 syslog(LOG_DEBUG, "msgbase: performing replication checks in <%s>", CC->room.QRname);
2642 /* No exclusive id? Don't do anything. */
2643 if (msg == NULL) return;
2644 if (CM_IsEmpty(msg, eExclusiveID)) return;
2646 /*syslog(LOG_DEBUG, "msgbase: exclusive ID: <%s> for room <%s>",
2647 msg->cm_fields[eExclusiveID], CC->room.QRname);*/
2649 old_msgnum = CtdlLocateMessageByEuid(msg->cm_fields[eExclusiveID], &CC->room);
2650 if (old_msgnum > 0L) {
2651 syslog(LOG_DEBUG, "msgbase: ReplicationChecks() replacing message %ld", old_msgnum);
2652 CtdlDeleteMessages(CC->room.QRname, &old_msgnum, 1, "");
2659 * Save a message to disk and submit it into the delivery system.
2661 long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */
2662 recptypes *recps, /* recipients (if mail) */
2663 const char *force, /* force a particular room? */
2664 int flags /* should the message be exported clean? */
2667 char hold_rm[ROOMNAMELEN];
2668 char actual_rm[ROOMNAMELEN];
2669 char force_room[ROOMNAMELEN];
2670 char content_type[SIZ]; /* We have to learn this */
2671 char recipient[SIZ];
2672 char bounce_to[1024];
2675 const char *mptr = NULL;
2676 struct ctdluser userbuf;
2678 struct MetaData smi;
2679 char *collected_addresses = NULL;
2680 struct addresses_to_be_filed *aptr = NULL;
2681 StrBuf *saved_rfc822_version = NULL;
2682 int qualified_for_journaling = 0;
2684 syslog(LOG_DEBUG, "msgbase: CtdlSubmitMsg() called");
2685 if (CM_IsValidMsg(msg) == 0) return(-1); /* self check */
2687 /* If this message has no timestamp, we take the liberty of
2688 * giving it one, right now.
2690 if (CM_IsEmpty(msg, eTimestamp)) {
2691 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
2694 /* If this message has no path, we generate one.
2696 if (CM_IsEmpty(msg, eMessagePath)) {
2697 if (!CM_IsEmpty(msg, eAuthor)) {
2698 CM_CopyField(msg, eMessagePath, eAuthor);
2699 for (a=0; !IsEmptyStr(&msg->cm_fields[eMessagePath][a]); ++a) {
2700 if (isspace(msg->cm_fields[eMessagePath][a])) {
2701 msg->cm_fields[eMessagePath][a] = ' ';
2706 CM_SetField(msg, eMessagePath, HKEY("unknown"));
2710 if (force == NULL) {
2711 force_room[0] = '\0';
2714 strcpy(force_room, force);
2717 /* Learn about what's inside, because it's what's inside that counts */
2718 if (CM_IsEmpty(msg, eMesageText)) {
2719 syslog(LOG_ERR, "msgbase: ERROR; attempt to save message with NULL body");
2723 switch (msg->cm_format_type) {
2725 strcpy(content_type, "text/x-citadel-variformat");
2728 strcpy(content_type, "text/plain");
2731 strcpy(content_type, "text/plain");
2732 mptr = bmstrcasestr(msg->cm_fields[eMesageText], "Content-type:");
2735 safestrncpy(content_type, &mptr[13], sizeof content_type);
2736 striplt(content_type);
2737 aptr = content_type;
2738 while (!IsEmptyStr(aptr)) {
2750 /* Goto the correct room */
2751 room = (recps) ? CC->room.QRname : SENTITEMS;
2752 syslog(LOG_DEBUG, "msgbase: selected room %s", room);
2753 strcpy(hold_rm, CC->room.QRname);
2754 strcpy(actual_rm, CC->room.QRname);
2755 if (recps != NULL) {
2756 strcpy(actual_rm, SENTITEMS);
2759 /* If the user is a twit, move to the twit room for posting */
2761 if (CC->user.axlevel == AxProbU) {
2762 strcpy(hold_rm, actual_rm);
2763 strcpy(actual_rm, CtdlGetConfigStr("c_twitroom"));
2764 syslog(LOG_DEBUG, "msgbase: diverting to twit room");
2768 /* ...or if this message is destined for Aide> then go there. */
2769 if (!IsEmptyStr(force_room)) {
2770 strcpy(actual_rm, force_room);
2773 syslog(LOG_DEBUG, "msgbase: final selection: %s (%s)", actual_rm, room);
2774 if (strcasecmp(actual_rm, CC->room.QRname)) {
2775 /* CtdlGetRoom(&CC->room, actual_rm); */
2776 CtdlUserGoto(actual_rm, 0, 1, NULL, NULL, NULL, NULL);
2780 * If this message has no O (room) field, generate one.
2782 if (CM_IsEmpty(msg, eOriginalRoom) && !IsEmptyStr(CC->room.QRname)) {
2783 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
2786 /* Perform "before save" hooks (aborting if any return nonzero) */
2787 syslog(LOG_DEBUG, "msgbase: performing before-save hooks");
2788 if (PerformMessageHooks(msg, recps, EVT_BEFORESAVE) > 0) return(-3);
2791 * If this message has an Exclusive ID, and the room is replication
2792 * checking enabled, then do replication checks.
2794 if (DoesThisRoomNeedEuidIndexing(&CC->room)) {
2795 ReplicationChecks(msg);
2798 /* Save it to disk */
2799 syslog(LOG_DEBUG, "msgbase: saving to disk");
2800 newmsgid = send_message(msg);
2801 if (newmsgid <= 0L) return(-5);
2803 /* Write a supplemental message info record. This doesn't have to
2804 * be a critical section because nobody else knows about this message
2807 syslog(LOG_DEBUG, "msgbase: creating metadata record");
2808 memset(&smi, 0, sizeof(struct MetaData));
2809 smi.meta_msgnum = newmsgid;
2810 smi.meta_refcount = 0;
2811 safestrncpy(smi.meta_content_type, content_type,
2812 sizeof smi.meta_content_type);
2815 * Measure how big this message will be when rendered as RFC822.
2816 * We do this for two reasons:
2817 * 1. We need the RFC822 length for the new metadata record, so the
2818 * POP and IMAP services don't have to calculate message lengths
2819 * while the user is waiting (multiplied by potentially hundreds
2820 * or thousands of messages).
2821 * 2. If journaling is enabled, we will need an RFC822 version of the
2822 * message to attach to the journalized copy.
2824 if (CC->redirect_buffer != NULL) {
2825 syslog(LOG_ALERT, "msgbase: CC->redirect_buffer is not NULL during message submission!");
2828 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
2829 CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, QP_EADDR);
2830 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
2831 saved_rfc822_version = CC->redirect_buffer;
2832 CC->redirect_buffer = NULL;
2836 /* Now figure out where to store the pointers */
2837 syslog(LOG_DEBUG, "msgbase: storing pointers");
2839 /* If this is being done by the networker delivering a private
2840 * message, we want to BYPASS saving the sender's copy (because there
2841 * is no local sender; it would otherwise go to the Trashcan).
2843 if ((!CC->internal_pgm) || (recps == NULL)) {
2844 if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) {
2845 syslog(LOG_ERR, "msgbase: ERROR saving message pointer!");
2846 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2850 /* For internet mail, drop a copy in the outbound queue room */
2851 if ((recps != NULL) && (recps->num_internet > 0)) {
2852 CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, newmsgid, 0, msg);
2855 /* If other rooms are specified, drop them there too. */
2856 if ((recps != NULL) && (recps->num_room > 0))
2857 for (i=0; i<num_tokens(recps->recp_room, '|'); ++i) {
2858 extract_token(recipient, recps->recp_room, i,
2859 '|', sizeof recipient);
2860 syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient);
2861 CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg);
2864 /* Bump this user's messages posted counter. */
2865 syslog(LOG_DEBUG, "msgbase: updating user");
2866 CtdlLockGetCurrentUser();
2867 CC->user.posted = CC->user.posted + 1;
2868 CtdlPutCurrentUserLock();
2870 /* Decide where bounces need to be delivered */
2871 if ((recps != NULL) && (recps->bounce_to == NULL))
2873 if (CC->logged_in) {
2874 strcpy(bounce_to, CC->user.fullname);
2876 else if (!IsEmptyStr(msg->cm_fields[eAuthor])){
2877 strcpy(bounce_to, msg->cm_fields[eAuthor]);
2879 recps->bounce_to = bounce_to;
2882 CM_SetFieldLONG(msg, eVltMsgNum, newmsgid);
2884 /* If this is private, local mail, make a copy in the
2885 * recipient's mailbox and bump the reference count.
2887 if ((recps != NULL) && (recps->num_local > 0)) {
2891 pch = recps->recp_local;
2892 recps->recp_local = recipient;
2893 ntokens = num_tokens(pch, '|');
2894 for (i=0; i<ntokens; ++i) {
2895 extract_token(recipient, pch, i, '|', sizeof recipient);
2896 syslog(LOG_DEBUG, "msgbase: delivering private local mail to <%s>", recipient);
2897 if (CtdlGetUser(&userbuf, recipient) == 0) {
2898 CtdlMailboxName(actual_rm, sizeof actual_rm, &userbuf, MAILROOM);
2899 CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 0, msg);
2900 CtdlBumpNewMailCounter(userbuf.usernum);
2901 PerformMessageHooks(msg, recps, EVT_AFTERUSRMBOXSAVE);
2904 syslog(LOG_DEBUG, "msgbase: no user <%s>", recipient);
2905 CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg);
2908 recps->recp_local = pch;
2911 /* Perform "after save" hooks */
2912 syslog(LOG_DEBUG, "msgbase: performing after-save hooks");
2914 PerformMessageHooks(msg, recps, EVT_AFTERSAVE);
2915 CM_FlushField(msg, eVltMsgNum);
2917 /* Go back to the room we started from */
2918 syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm);
2919 if (strcasecmp(hold_rm, CC->room.QRname))
2920 CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL);
2923 * Any addresses to harvest for someone's address book?
2925 if ( (CC->logged_in) && (recps != NULL) ) {
2926 collected_addresses = harvest_collected_addresses(msg);
2929 if (collected_addresses != NULL) {
2930 aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed));
2931 CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM);
2932 aptr->roomname = strdup(actual_rm);
2933 aptr->collected_addresses = collected_addresses;
2934 begin_critical_section(S_ATBF);
2937 end_critical_section(S_ATBF);
2941 * Determine whether this message qualifies for journaling.
2943 if (!CM_IsEmpty(msg, eJournal)) {
2944 qualified_for_journaling = 0;
2947 if (recps == NULL) {
2948 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2950 else if (recps->num_local + recps->num_ignet + recps->num_internet > 0) {
2951 qualified_for_journaling = CtdlGetConfigInt("c_journal_email");
2954 qualified_for_journaling = CtdlGetConfigInt("c_journal_pubmsgs");
2959 * Do we have to perform journaling? If so, hand off the saved
2960 * RFC822 version will be handed off to the journaler for background
2961 * submit. Otherwise, we have to free the memory ourselves.
2963 if (saved_rfc822_version != NULL) {
2964 if (qualified_for_journaling) {
2965 JournalBackgroundSubmit(msg, saved_rfc822_version, recps);
2968 FreeStrBuf(&saved_rfc822_version);
2972 if ((recps != NULL) && (recps->bounce_to == bounce_to))
2973 recps->bounce_to = NULL;
2981 * Convenience function for generating small administrative messages.
2983 long quickie_message(const char *from,
2984 const char *fromaddr,
2989 const char *subject)
2991 struct CtdlMessage *msg;
2992 recptypes *recp = NULL;
2994 msg = malloc(sizeof(struct CtdlMessage));
2995 memset(msg, 0, sizeof(struct CtdlMessage));
2996 msg->cm_magic = CTDLMESSAGE_MAGIC;
2997 msg->cm_anon_type = MES_NORMAL;
2998 msg->cm_format_type = format_type;
3000 if (!IsEmptyStr(from)) {
3001 CM_SetField(msg, eAuthor, from, -1);
3003 else if (!IsEmptyStr(fromaddr)) {
3005 CM_SetField(msg, eAuthor, fromaddr, -1);
3006 pAt = strchr(msg->cm_fields[eAuthor], '@');
3008 CM_CutFieldAt(msg, eAuthor, pAt - msg->cm_fields[eAuthor]);
3012 msg->cm_fields[eAuthor] = strdup("Citadel");
3015 if (!IsEmptyStr(fromaddr)) CM_SetField(msg, erFc822Addr, fromaddr, -1);
3016 if (!IsEmptyStr(room)) CM_SetField(msg, eOriginalRoom, room, -1);
3017 if (!IsEmptyStr(to)) {
3018 CM_SetField(msg, eRecipient, to, -1);
3019 recp = validate_recipients(to, NULL, 0);
3021 if (!IsEmptyStr(subject)) {
3022 CM_SetField(msg, eMsgSubject, subject, -1);
3024 if (!IsEmptyStr(text)) {
3025 CM_SetField(msg, eMesageText, text, -1);
3028 long msgnum = CtdlSubmitMsg(msg, recp, room, 0);
3030 if (recp != NULL) free_recipients(recp);
3036 * Back end function used by CtdlMakeMessage() and similar functions
3038 StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */
3040 size_t maxlen, /* maximum message length */
3041 StrBuf *exist, /* if non-null, append to it;
3042 exist is ALWAYS freed */
3043 int crlf /* CRLF newlines instead of LF */
3052 LineBuf = NewStrBufPlain(NULL, SIZ);
3053 if (exist == NULL) {
3054 Message = NewStrBufPlain(NULL, 4 * SIZ);
3057 Message = NewStrBufDup(exist);
3060 /* Do we need to change leading ".." to "." for SMTP escaping? */
3061 if ((tlen == 1) && (*terminator == '.')) {
3065 /* read in the lines of message text one by one */
3067 if (CtdlClientGetLine(LineBuf) < 0) {
3070 if ((StrLength(LineBuf) == tlen) && (!strcmp(ChrPtr(LineBuf), terminator))) {
3073 if ( (!flushing) && (!finished) ) {
3075 StrBufAppendBufPlain(LineBuf, HKEY("\r\n"), 0);
3078 StrBufAppendBufPlain(LineBuf, HKEY("\n"), 0);
3081 /* Unescape SMTP-style input of two dots at the beginning of the line */
3082 if ((dotdot) && (StrLength(LineBuf) > 1) && (ChrPtr(LineBuf)[0] == '.')) {
3083 StrBufCutLeft(LineBuf, 1);
3085 StrBufAppendBuf(Message, LineBuf, 0);
3088 /* if we've hit the max msg length, flush the rest */
3089 if (StrLength(Message) >= maxlen) flushing = 1;
3091 } while (!finished);
3092 FreeStrBuf(&LineBuf);
3098 * Back end function used by CtdlMakeMessage() and similar functions
3100 char *CtdlReadMessageBody(char *terminator, /* token signalling EOT */
3102 size_t maxlen, /* maximum message length */
3103 StrBuf *exist, /* if non-null, append to it;
3104 exist is ALWAYS freed */
3105 int crlf /* CRLF newlines instead of LF */
3110 Message = CtdlReadMessageBodyBuf(terminator,
3116 if (Message == NULL)
3119 return SmashStrBuf(&Message);
3122 struct CtdlMessage *CtdlMakeMessage(
3123 struct ctdluser *author, /* author's user structure */
3124 char *recipient, /* NULL if it's not mail */
3125 char *recp_cc, /* NULL if it's not mail */
3126 char *room, /* room where it's going */
3127 int type, /* see MES_ types in header file */
3128 int format_type, /* variformat, plain text, MIME... */
3129 char *fake_name, /* who we're masquerading as */
3130 char *my_email, /* which of my email addresses to use (empty is ok) */
3131 char *subject, /* Subject (optional) */
3132 char *supplied_euid, /* ...or NULL if this is irrelevant */
3133 char *preformatted_text, /* ...or NULL to read text from client */
3134 char *references /* Thread references */
3137 return CtdlMakeMessageLen(
3138 author, /* author's user structure */
3139 recipient, /* NULL if it's not mail */
3140 (recipient)?strlen(recipient) : 0,
3141 recp_cc, /* NULL if it's not mail */
3142 (recp_cc)?strlen(recp_cc): 0,
3143 room, /* room where it's going */
3144 (room)?strlen(room): 0,
3145 type, /* see MES_ types in header file */
3146 format_type, /* variformat, plain text, MIME... */
3147 fake_name, /* who we're masquerading as */
3148 (fake_name)?strlen(fake_name): 0,
3149 my_email, /* which of my email addresses to use (empty is ok) */
3150 (my_email)?strlen(my_email): 0,
3151 subject, /* Subject (optional) */
3152 (subject)?strlen(subject): 0,
3153 supplied_euid, /* ...or NULL if this is irrelevant */
3154 (supplied_euid)?strlen(supplied_euid):0,
3155 preformatted_text, /* ...or NULL to read text from client */
3156 (preformatted_text)?strlen(preformatted_text) : 0,
3157 references, /* Thread references */
3158 (references)?strlen(references):0);
3163 * Build a binary message to be saved on disk.
3164 * (NOTE: if you supply 'preformatted_text', the buffer you give it
3165 * will become part of the message. This means you are no longer
3166 * responsible for managing that memory -- it will be freed along with
3167 * the rest of the fields when CM_Free() is called.)
3170 struct CtdlMessage *CtdlMakeMessageLen(
3171 struct ctdluser *author, /* author's user structure */
3172 char *recipient, /* NULL if it's not mail */
3174 char *recp_cc, /* NULL if it's not mail */
3176 char *room, /* room where it's going */
3178 int type, /* see MES_ types in header file */
3179 int format_type, /* variformat, plain text, MIME... */
3180 char *fake_name, /* who we're masquerading as */
3182 char *my_email, /* which of my email addresses to use (empty is ok) */
3184 char *subject, /* Subject (optional) */
3186 char *supplied_euid, /* ...or NULL if this is irrelevant */
3188 char *preformatted_text, /* ...or NULL to read text from client */
3190 char *references, /* Thread references */
3194 /* Don't confuse the poor folks if it's not routed mail. * /
3195 char dest_node[256] = "";*/
3198 struct CtdlMessage *msg;
3200 StrBuf *FakeEncAuthor = NULL;
3202 msg = malloc(sizeof(struct CtdlMessage));
3203 memset(msg, 0, sizeof(struct CtdlMessage));
3204 msg->cm_magic = CTDLMESSAGE_MAGIC;
3205 msg->cm_anon_type = type;
3206 msg->cm_format_type = format_type;
3208 if (recipient != NULL) rcplen = striplt(recipient);
3209 if (recp_cc != NULL) cclen = striplt(recp_cc);
3211 /* Path or Return-Path */
3213 CM_SetField(msg, eMessagePath, my_email, myelen);
3215 else if (!IsEmptyStr(author->fullname)) {
3216 CM_SetField(msg, eMessagePath, author->fullname, -1);
3218 convert_spaces_to_underscores(msg->cm_fields[eMessagePath]);
3220 blen = snprintf(buf, sizeof buf, "%ld", (long)time(NULL));
3221 CM_SetField(msg, eTimestamp, buf, blen);
3224 FakeAuthor = NewStrBufPlain (fake_name, fnlen);
3227 FakeAuthor = NewStrBufPlain (author->fullname, -1);
3229 StrBufRFC2047encode(&FakeEncAuthor, FakeAuthor);
3230 CM_SetAsFieldSB(msg, eAuthor, &FakeEncAuthor);
3231 FreeStrBuf(&FakeAuthor);
3233 if (!!IsEmptyStr(CC->room.QRname)) {
3234 if (CC->room.QRflags & QR_MAILBOX) { /* room */
3235 CM_SetField(msg, eOriginalRoom, &CC->room.QRname[11], -1);
3238 CM_SetField(msg, eOriginalRoom, CC->room.QRname, -1);
3243 CM_SetField(msg, eRecipient, recipient, rcplen);
3246 CM_SetField(msg, eCarbonCopY, recp_cc, cclen);
3250 CM_SetField(msg, erFc822Addr, my_email, myelen);
3252 else if ( (author == &CC->user) && (!IsEmptyStr(CC->cs_inet_email)) ) {
3253 CM_SetField(msg, erFc822Addr, CC->cs_inet_email, -1);
3256 if (subject != NULL) {
3258 length = striplt(subject);
3264 while ((subject[i] != '\0') &&
3265 (IsAscii = isascii(subject[i]) != 0 ))
3268 CM_SetField(msg, eMsgSubject, subject, subjlen);
3269 else /* ok, we've got utf8 in the string. */
3272 rfc2047Subj = rfc2047encode(subject, length);
3273 CM_SetAsField(msg, eMsgSubject, &rfc2047Subj, strlen(rfc2047Subj));
3280 CM_SetField(msg, eExclusiveID, supplied_euid, euidlen);
3284 CM_SetField(msg, eWeferences, references, reflen);
3287 if (preformatted_text != NULL) {
3288 CM_SetField(msg, eMesageText, preformatted_text, textlen);
3292 MsgBody = CtdlReadMessageBodyBuf(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
3293 if (MsgBody != NULL) {
3294 CM_SetAsFieldSB(msg, eMesageText, &MsgBody);
3305 * API function to delete messages which match a set of criteria
3306 * (returns the actual number of messages deleted)
3308 int CtdlDeleteMessages(const char *room_name, /* which room */
3309 long *dmsgnums, /* array of msg numbers to be deleted */
3310 int num_dmsgnums, /* number of msgs to be deleted, or 0 for "any" */
3311 char *content_type /* or "" for any. regular expressions expected. */
3314 struct ctdlroom qrbuf;
3315 struct cdbdata *cdbfr;
3316 long *msglist = NULL;
3317 long *dellist = NULL;
3320 int num_deleted = 0;
3322 struct MetaData smi;
3325 int need_to_free_re = 0;
3327 if (content_type) if (!IsEmptyStr(content_type)) {
3328 regcomp(&re, content_type, 0);
3329 need_to_free_re = 1;
3331 syslog(LOG_DEBUG, "msgbase: CtdlDeleteMessages(%s, %d msgs, %s)", room_name, num_dmsgnums, content_type);
3333 /* get room record, obtaining a lock... */
3334 if (CtdlGetRoomLock(&qrbuf, room_name) != 0) {
3335 syslog(LOG_ERR, "msgbase: CtdlDeleteMessages(): Room <%s> not found", room_name);
3336 if (need_to_free_re) regfree(&re);
3337 return(0); /* room not found */
3339 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
3341 if (cdbfr != NULL) {
3342 dellist = malloc(cdbfr->len);
3343 msglist = (long *) cdbfr->ptr;
3344 cdbfr->ptr = NULL; /* CtdlDeleteMessages() now owns this memory */
3345 num_msgs = cdbfr->len / sizeof(long);
3349 int have_contenttype = (content_type != NULL) && !IsEmptyStr(content_type);
3350 int have_delmsgs = (num_dmsgnums == 0) || (dmsgnums == NULL);
3351 int have_more_del = 1;
3353 num_msgs = sort_msglist(msglist, num_msgs);
3354 if (num_dmsgnums > 1)
3355 num_dmsgnums = sort_msglist(dmsgnums, num_dmsgnums);
3358 StrBuf *dbg = NewStrBuf();
3359 for (i = 0; i < num_dmsgnums; i++)
3360 StrBufAppendPrintf(dbg, ", %ld", dmsgnums[i]);
3361 syslog(LOG_DEBUG, "msgbase: Deleting before: %s", ChrPtr(dbg));
3366 while ((i < num_msgs) && (have_more_del)) {
3369 /* Set/clear a bit for each criterion */
3371 /* 0 messages in the list or a null list means that we are
3372 * interested in deleting any messages which meet the other criteria.
3375 delete_this |= 0x01;
3378 while ((i < num_msgs) && (msglist[i] < dmsgnums[j])) i++;
3383 if (msglist[i] == dmsgnums[j]) {
3384 delete_this |= 0x01;
3387 have_more_del = (j < num_dmsgnums);
3390 if (have_contenttype) {
3391 GetMetaData(&smi, msglist[i]);
3392 if (regexec(&re, smi.meta_content_type, 1, &pm, 0) == 0) {
3393 delete_this |= 0x02;
3396 delete_this |= 0x02;
3399 /* Delete message only if all bits are set */
3400 if (delete_this == 0x03) {
3401 dellist[num_deleted++] = msglist[i];
3408 StrBuf *dbg = NewStrBuf();
3409 for (i = 0; i < num_deleted; i++)
3410 StrBufAppendPrintf(dbg, ", %ld", dellist[i]);
3411 syslog(LOG_DEBUG, "msgbase: Deleting: %s", ChrPtr(dbg));
3415 num_msgs = sort_msglist(msglist, num_msgs);
3416 cdb_store(CDB_MSGLISTS, &qrbuf.QRnumber, (int)sizeof(long),
3417 msglist, (int)(num_msgs * sizeof(long)));
3420 qrbuf.QRhighest = msglist[num_msgs - 1];
3422 qrbuf.QRhighest = 0;
3424 CtdlPutRoomLock(&qrbuf);
3426 /* Go through the messages we pulled out of the index, and decrement
3427 * their reference counts by 1. If this is the only room the message
3428 * was in, the reference count will reach zero and the message will
3429 * automatically be deleted from the database. We do this in a
3430 * separate pass because there might be plug-in hooks getting called,
3431 * and we don't want that happening during an S_ROOMS critical
3435 for (i=0; i<num_deleted; ++i) {
3436 PerformDeleteHooks(qrbuf.QRname, dellist[i]);
3438 AdjRefCountList(dellist, num_deleted, -1);
3440 /* Now free the memory we used, and go away. */
3441 if (msglist != NULL) free(msglist);
3442 if (dellist != NULL) free(dellist);
3443 syslog(LOG_DEBUG, "msgbase: %d message(s) deleted", num_deleted);
3444 if (need_to_free_re) regfree(&re);
3445 return (num_deleted);
3450 * GetMetaData() - Get the supplementary record for a message
3452 void GetMetaData(struct MetaData *smibuf, long msgnum)
3454 struct cdbdata *cdbsmi;
3457 memset(smibuf, 0, sizeof(struct MetaData));
3458 smibuf->meta_msgnum = msgnum;
3459 smibuf->meta_refcount = 1; /* Default reference count is 1 */
3461 /* Use the negative of the message number for its supp record index */
3462 TheIndex = (0L - msgnum);
3464 cdbsmi = cdb_fetch(CDB_MSGMAIN, &TheIndex, sizeof(long));
3465 if (cdbsmi == NULL) {
3466 return; /* record not found; leave it alone */
3468 memcpy(smibuf, cdbsmi->ptr,
3469 ((cdbsmi->len > sizeof(struct MetaData)) ?
3470 sizeof(struct MetaData) : cdbsmi->len)
3478 * PutMetaData() - (re)write supplementary record for a message
3480 void PutMetaData(struct MetaData *smibuf)
3484 /* Use the negative of the message number for the metadata db index */
3485 TheIndex = (0L - smibuf->meta_msgnum);
3487 cdb_store(CDB_MSGMAIN,
3488 &TheIndex, (int)sizeof(long),
3489 smibuf, (int)sizeof(struct MetaData)
3495 * Convenience function to process a big block of AdjRefCount() operations
3497 void AdjRefCountList(long *msgnum, long nmsg, int incr)
3501 for (i = 0; i < nmsg; i++) {
3502 AdjRefCount(msgnum[i], incr);
3508 * AdjRefCount - adjust the reference count for a message. We need to delete from disk any message whose reference count reaches zero.
3510 void AdjRefCount(long msgnum, int incr)
3512 struct MetaData smi;
3515 /* This is a *tight* critical section; please keep it that way, as
3516 * it may get called while nested in other critical sections.
3517 * Complicating this any further will surely cause deadlock!
3519 begin_critical_section(S_SUPPMSGMAIN);
3520 GetMetaData(&smi, msgnum);
3521 smi.meta_refcount += incr;
3523 end_critical_section(S_SUPPMSGMAIN);
3524 syslog(LOG_DEBUG, "msgbase: AdjRefCount() msg %ld ref count delta %+d, is now %d", msgnum, incr, smi.meta_refcount);
3526 /* If the reference count is now zero, delete both the message and its metadata record.
3528 if (smi.meta_refcount == 0) {
3529 syslog(LOG_DEBUG, "msgbase: deleting message <%ld>", msgnum);
3531 /* Call delete hooks with NULL room to show it has gone altogether */
3532 PerformDeleteHooks(NULL, msgnum);
3534 /* Remove from message base */
3536 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3537 cdb_delete(CDB_BIGMSGS, &delnum, (int)sizeof(long));
3539 /* Remove metadata record */
3540 delnum = (0L - msgnum);
3541 cdb_delete(CDB_MSGMAIN, &delnum, (int)sizeof(long));
3547 * Write a generic object to this room
3549 * Note: this could be much more efficient. Right now we use two temporary
3550 * files, and still pull the message into memory as with all others.
3552 void CtdlWriteObject(char *req_room, /* Room to stuff it in */
3553 char *content_type, /* MIME type of this object */
3554 char *raw_message, /* Data to be written */
3555 off_t raw_length, /* Size of raw_message */
3556 struct ctdluser *is_mailbox, /* Mailbox room? */
3557 int is_binary, /* Is encoding necessary? */
3558 int is_unique, /* Del others of this type? */
3559 unsigned int flags /* Internal save flags */
3562 struct ctdlroom qrbuf;
3563 char roomname[ROOMNAMELEN];
3564 struct CtdlMessage *msg;
3565 StrBuf *encoded_message = NULL;
3567 if (is_mailbox != NULL) {
3568 CtdlMailboxName(roomname, sizeof roomname, is_mailbox, req_room);
3571 safestrncpy(roomname, req_room, sizeof(roomname));
3574 syslog(LOG_DEBUG, "msfbase: raw length is %ld", (long)raw_length);
3577 encoded_message = NewStrBufPlain(NULL, (size_t) (((raw_length * 134) / 100) + 4096 ) );
3580 encoded_message = NewStrBufPlain(NULL, (size_t)(raw_length + 4096));
3583 StrBufAppendBufPlain(encoded_message, HKEY("Content-type: "), 0);
3584 StrBufAppendBufPlain(encoded_message, content_type, -1, 0);
3585 StrBufAppendBufPlain(encoded_message, HKEY("\n"), 0);
3588 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: base64\n\n"), 0);
3591 StrBufAppendBufPlain(encoded_message, HKEY("Content-transfer-encoding: 7bit\n\n"), 0);
3595 StrBufBase64Append(encoded_message, NULL, raw_message, raw_length, 0);
3598 StrBufAppendBufPlain(encoded_message, raw_message, raw_length, 0);
3601 syslog(LOG_DEBUG, "msgbase: allocating");
3602 msg = malloc(sizeof(struct CtdlMessage));
3603 memset(msg, 0, sizeof(struct CtdlMessage));
3604 msg->cm_magic = CTDLMESSAGE_MAGIC;
3605 msg->cm_anon_type = MES_NORMAL;
3606 msg->cm_format_type = 4;
3607 CM_SetField(msg, eAuthor, CC->user.fullname, -1);
3608 CM_SetField(msg, eOriginalRoom, req_room, -1);
3609 msg->cm_flags = flags;
3611 CM_SetAsFieldSB(msg, eMesageText, &encoded_message);
3613 /* Create the requested room if we have to. */
3614 if (CtdlGetRoom(&qrbuf, roomname) != 0) {
3615 CtdlCreateRoom(roomname, ( (is_mailbox != NULL) ? 5 : 3 ), "", 0, 1, 0, VIEW_BBS);
3617 /* If the caller specified this object as unique, delete all
3618 * other objects of this type that are currently in the room.
3621 syslog(LOG_DEBUG, "msgbase: deleted %d other msgs of this type",
3622 CtdlDeleteMessages(roomname, NULL, 0, content_type)
3625 /* Now write the data */
3626 CtdlSubmitMsg(msg, NULL, roomname, 0);
3631 /************************************************************************/
3632 /* MODULE INITIALIZATION */
3633 /************************************************************************/
3635 CTDL_MODULE_INIT(msgbase)
3638 FillMsgKeyLookupTable();
3641 /* return our module id for the log */