X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fmsgbase.c;h=77bc946156b93f57f13931ad2b2ef985aff9f916;hb=068d33e5d8569b2c4a2c8582178427892b0a8dee;hp=2574758927a6f8e3059dde07c6cedddbfbe2980b;hpb=97812f00652c44ac174a4ec2a3e17e94863c8bbe;p=citadel.git diff --git a/citadel/msgbase.c b/citadel/msgbase.c index 257475892..77bc94615 100644 --- a/citadel/msgbase.c +++ b/citadel/msgbase.c @@ -1,16 +1,14 @@ -/* - * Implements the message store. - * - * Copyright (c) 1987-2020 by the citadel.org team - * - * This program is open source software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 3. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - */ +// Implements the message store. +// +// Copyright (c) 1987-2021 by the citadel.org team +// +// This program is open source software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License version 3. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. #include @@ -34,10 +32,8 @@ struct addresses_to_be_filed *atbf = NULL; -/* - * These are the four-character field headers we use when outputting - * messages in Citadel format (as opposed to RFC822 format). - */ +// These are the four-character field headers we use when outputting +// messages in Citadel format (as opposed to RFC822 format). char *msgkeys[] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, @@ -61,7 +57,7 @@ char *msgkeys[] = { "rep2", // K -> eReplyTo "list", // L -> eListID "text", // M -> eMesageText - NULL, // N (formerly used as eNodeName) + NULL, // N (formerly used as eNodename) "room", // O -> eOriginalRoom "path", // P -> eMessagePath NULL, // Q @@ -76,10 +72,10 @@ char *msgkeys[] = { NULL // Z }; + HashList *msgKeyLookup = NULL; -int GetFieldFromMnemonic(eMsgField *f, const char* c) -{ +int GetFieldFromMnemonic(eMsgField *f, const char* c) { void *v = NULL; if (GetHash(msgKeyLookup, c, 4, &v)) { *f = (eMsgField) v; @@ -88,8 +84,7 @@ int GetFieldFromMnemonic(eMsgField *f, const char* c) return 0; } -void FillMsgKeyLookupTable(void) -{ +void FillMsgKeyLookupTable(void) { long i; msgKeyLookup = NewHash (1, FourHash); @@ -101,6 +96,7 @@ void FillMsgKeyLookupTable(void) } } + eMsgField FieldOrder[] = { /* Important fields */ emessageId , @@ -138,14 +134,12 @@ eMsgField FieldOrder[] = { static const long NDiskFields = sizeof(FieldOrder) / sizeof(eMsgField); -int CM_IsEmpty(struct CtdlMessage *Msg, eMsgField which) -{ +int CM_IsEmpty(struct CtdlMessage *Msg, eMsgField which) { return !((Msg->cm_fields[which] != NULL) && (Msg->cm_fields[which][0] != '\0')); } -void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) -{ +void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) { if (Msg->cm_fields[which] != NULL) { free (Msg->cm_fields[which]); } @@ -159,8 +153,7 @@ void CM_SetField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long } -void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue) -{ +void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue) { char buf[128]; long len; len = snprintf(buf, sizeof(buf), "%ld", lvalue); @@ -168,8 +161,7 @@ void CM_SetFieldLONG(struct CtdlMessage *Msg, eMsgField which, long lvalue) } -void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen) -{ +void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen) { if (Msg->cm_fields[WhichToCut] == NULL) return; @@ -181,8 +173,7 @@ void CM_CutFieldAt(struct CtdlMessage *Msg, eMsgField WhichToCut, long maxlen) } -void CM_FlushField(struct CtdlMessage *Msg, eMsgField which) -{ +void CM_FlushField(struct CtdlMessage *Msg, eMsgField which) { if (Msg->cm_fields[which] != NULL) free (Msg->cm_fields[which]); Msg->cm_fields[which] = NULL; @@ -190,8 +181,7 @@ void CM_FlushField(struct CtdlMessage *Msg, eMsgField which) } -void CM_Flush(struct CtdlMessage *Msg) -{ +void CM_Flush(struct CtdlMessage *Msg) { int i; if (CM_IsValidMsg(Msg) == 0) { @@ -204,8 +194,7 @@ void CM_Flush(struct CtdlMessage *Msg) } -void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy) -{ +void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField WhichtToCopy) { long len; if (Msg->cm_fields[WhichToPutTo] != NULL) { free (Msg->cm_fields[WhichToPutTo]); @@ -225,8 +214,7 @@ void CM_CopyField(struct CtdlMessage *Msg, eMsgField WhichToPutTo, eMsgField Whi } -void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) -{ +void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf, long length) { if (Msg->cm_fields[which] != NULL) { long oldmsgsize; long newmsgsize; @@ -251,8 +239,7 @@ void CM_PrependToField(struct CtdlMessage *Msg, eMsgField which, const char *buf } -void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length) -{ +void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long length) { if (Msg->cm_fields[which] != NULL) { free (Msg->cm_fields[which]); } @@ -268,8 +255,7 @@ void CM_SetAsField(struct CtdlMessage *Msg, eMsgField which, char **buf, long le } -void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf) -{ +void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf) { if (Msg->cm_fields[which] != NULL) { free (Msg->cm_fields[which]); } @@ -279,8 +265,7 @@ void CM_SetAsFieldSB(struct CtdlMessage *Msg, eMsgField which, StrBuf **buf) } -void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen) -{ +void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *retlen) { if (Msg->cm_fields[which] != NULL) { *retlen = Msg->cm_lengths[which]; *ret = Msg->cm_fields[which]; @@ -294,10 +279,8 @@ void CM_GetAsField(struct CtdlMessage *Msg, eMsgField which, char **ret, long *r } -/* - * Returns 1 if the supplied pointer points to a valid Citadel message. - * If the pointer is NULL or the magic number check fails, returns 0. - */ +// Returns 1 if the supplied pointer points to a valid Citadel message. +// If the pointer is NULL or the magic number check fails, returns 0. int CM_IsValidMsg(struct CtdlMessage *msg) { if (msg == NULL) { return 0; @@ -310,8 +293,7 @@ int CM_IsValidMsg(struct CtdlMessage *msg) { } -void CM_FreeContents(struct CtdlMessage *msg) -{ +void CM_FreeContents(struct CtdlMessage *msg) { int i; for (i = 0; i < 256; ++i) @@ -320,15 +302,12 @@ void CM_FreeContents(struct CtdlMessage *msg) msg->cm_lengths[i] = 0; } - msg->cm_magic = 0; /* just in case */ + msg->cm_magic = 0; // just in case } -/* - * 'Destructor' for struct CtdlMessage - */ -void CM_Free(struct CtdlMessage *msg) -{ +// 'Destructor' for struct CtdlMessage +void CM_Free(struct CtdlMessage *msg) { if (CM_IsValidMsg(msg) == 0) { if (msg != NULL) free (msg); return; @@ -338,8 +317,7 @@ void CM_Free(struct CtdlMessage *msg) } -int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg) -{ +int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *NewMsg) { long len; len = OrgMsg->cm_lengths[i]; NewMsg->cm_fields[i] = malloc(len + 1); @@ -353,8 +331,7 @@ int CM_DupField(eMsgField i, struct CtdlMessage *OrgMsg, struct CtdlMessage *New } -struct CtdlMessage * CM_Duplicate(struct CtdlMessage *OrgMsg) -{ +struct CtdlMessage *CM_Duplicate(struct CtdlMessage *OrgMsg) { int i; struct CtdlMessage *NewMsg; @@ -383,24 +360,21 @@ struct CtdlMessage * CM_Duplicate(struct CtdlMessage *OrgMsg) } -/* Determine if a given message matches the fields in a message template. - * Return 0 for a successful match. - */ +// Determine if a given message matches the fields in a message template. +// Return 0 for a successful match. int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) { int i; - /* If there aren't any fields in the template, all messages will - * match. - */ + // If there aren't any fields in the template, all messages will match. if (template == NULL) return(0); - /* Null messages are bogus. */ + // Null messages are bogus. if (msg == NULL) return(1); for (i='A'; i<='Z'; ++i) { if (template->cm_fields[i] != NULL) { if (msg->cm_fields[i] == NULL) { - /* Considered equal if temmplate is empty string */ + // Considered equal if temmplate is empty string if (IsEmptyStr(template->cm_fields[i])) continue; return 1; } @@ -415,13 +389,11 @@ int CtdlMsgCmp(struct CtdlMessage *msg, struct CtdlMessage *template) { } -/* - * Retrieve the "seen" message list for the current room. - */ +// Retrieve the "seen" message list for the current room. void CtdlGetSeen(char *buf, int which_set) { visit vbuf; - /* Learn about the user and room in question */ + // Learn about the user and room in question CtdlGetRelationship(&vbuf, &CC->user, &CC->room); if (which_set == ctdlsetseen_seen) { @@ -433,9 +405,7 @@ void CtdlGetSeen(char *buf, int which_set) { } -/* - * Manipulate the "seen msgs" string (or other message set strings) - */ +// Manipulate the "seen msgs" string (or other message set strings) void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, int target_setting, int which_set, struct ctdluser *which_user, struct ctdlroom *which_room) { @@ -453,19 +423,19 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, StrBuf *lostr; StrBuf *histr; const char *pvset; - char *is_set; /* actually an array of booleans */ + char *is_set; // actually an array of booleans - /* Don't bother doing *anything* if we were passed a list of zero messages */ + // Don't bother doing *anything* if we were passed a list of zero messages if (num_target_msgnums < 1) { return; } - /* If no room was specified, we go with the current room. */ + // If no room was specified, we go with the current room. if (!which_room) { which_room = &CC->room; } - /* If no user was specified, we go with the current user. */ + // If no user was specified, we go with the current user. if (!which_user) { which_user = &CC->user; } @@ -476,18 +446,19 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, which_set, which_room->QRname); - /* Learn about the user and room in question */ + // Learn about the user and room in question CtdlGetRelationship(&vbuf, which_user, which_room); - /* Load the message list */ + // Load the message list cdbfr = cdb_fetch(CDB_MSGLISTS, &which_room->QRnumber, sizeof(long)); if (cdbfr != NULL) { msglist = (long *) cdbfr->ptr; - cdbfr->ptr = NULL; /* CtdlSetSeen() now owns this memory */ + cdbfr->ptr = NULL; // CtdlSetSeen() now owns this memory num_msgs = cdbfr->len / sizeof(long); cdb_free(cdbfr); - } else { - return; /* No messages at all? No further action. */ + } + else { + return; // No messages at all? No further action. } is_set = malloc(num_msgs * sizeof(char)); @@ -506,7 +477,7 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, } -#if 0 /* This is a special diagnostic section. Do not allow it to run during normal operation. */ +#if 0 // This is a special diagnostic section. Do not allow it to run during normal operation. syslog(LOG_DEBUG, "There are %d messages in the room.\n", num_msgs); for (i=0; i 0) && (msglist[i] <= msglist[i-1])) abort(); @@ -517,7 +488,7 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, } #endif - /* Translate the existing sequence set into an array of booleans */ + // Translate the existing sequence set into an array of booleans setstr = NewStrBuf(); lostr = NewStrBuf(); histr = NewStrBuf(); @@ -550,7 +521,7 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, FreeStrBuf(&lostr); FreeStrBuf(&histr); - /* Now translate the array of booleans back into a sequence set */ + // Now translate the array of booleans back into a sequence set FlushStrBuf(vset); was_seen = 0; lo = (-1); @@ -559,7 +530,7 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, for (i=0; i SIZ) && (number_of_truncations < 100) ) { StrBufRemove_token(vset, 0, ','); ++number_of_truncations; } - /* - * If we're truncating the sequence set of messages marked with the 'seen' flag, - * we want the earliest messages (the truncated ones) to be marked, not unmarked. - * Otherwise messages at the beginning will suddenly appear to be 'unseen'. - */ + // If we're truncating the sequence set of messages marked with the 'seen' flag, + // we want the earliest messages (the truncated ones) to be marked, not unmarked. + // Otherwise messages at the beginning will suddenly appear to be 'unseen'. if ( (which_set == ctdlsetseen_seen) && (number_of_truncations > 0) ) { StrBuf *first_tok; first_tok = NewStrBuf(); @@ -637,7 +604,7 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, vset = new_set; } - /* Decide which message set we're manipulating */ + // Decide which message set we're manipulating switch (which_set) { case ctdlsetseen_seen: safestrncpy(vbuf.v_seen, ChrPtr(vset), sizeof vbuf.v_seen); @@ -654,10 +621,8 @@ void CtdlSetSeen(long *target_msgnums, int num_target_msgnums, } -/* - * API function to perform an operation for each qualifying message in the - * current room. (Returns the number of messages processed.) - */ +// API function to perform an operation for each qualifying message in the +// current room. (Returns the number of messages processed.) int CtdlForEachMessage(int mode, long ref, char *search_string, char *content_type, struct CtdlMessage *compare, @@ -1052,14 +1017,14 @@ void mime_download(char *name, char *filename, char *partnum, char *disp, ) { CC->download_fp = tmpfile(); if (CC->download_fp == NULL) { - syslog(LOG_EMERG, "msgbase: mime_download() couldn't write: %m"); + syslog(LOG_ERR, "msgbase: mime_download() couldn't write: %m"); cprintf("%d cannot open temporary file: %s\n", ERROR + INTERNAL_ERROR, strerror(errno)); return; } rv = fwrite(content, length, 1, CC->download_fp); if (rv <= 0) { - syslog(LOG_EMERG, "msgbase: mime_download() Couldn't write: %m"); + syslog(LOG_ERR, "msgbase: mime_download() Couldn't write: %m"); cprintf("%d unable to write tempfile.\n", ERROR + TOO_BIG); fclose(CC->download_fp); CC->download_fp = NULL; @@ -1115,11 +1080,11 @@ struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const cha return NULL; } - /* Parse the three bytes that begin EVERY message on disk. - * The first is always 0xFF, the on-disk magic number. - * The second is the anonymous/public type byte. - * The third is the format type byte (vari, fixed, or MIME). - */ + // Parse the three bytes that begin EVERY message on disk. + // The first is always 0xFF, the on-disk magic number. + // The second is the anonymous/public type byte. + // The third is the format type byte (vari, fixed, or MIME). + // ch = *mptr++; if (ch != 255) { syslog(LOG_ERR, "msgbase: message %ld appears to be corrupted", msgnum); @@ -1129,20 +1094,18 @@ struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const cha memset(ret, 0, sizeof(struct CtdlMessage)); ret->cm_magic = CTDLMESSAGE_MAGIC; - ret->cm_anon_type = *mptr++; /* Anon type byte */ - ret->cm_format_type = *mptr++; /* Format type byte */ + ret->cm_anon_type = *mptr++; // Anon type byte + ret->cm_format_type = *mptr++; // Format type byte - /* - * The rest is zero or more arbitrary fields. Load them in. - * We're done when we encounter either a zero-length field or - * have just processed the 'M' (message text) field. - */ + // The rest is zero or more arbitrary fields. Load them in. + // We're done when we encounter either a zero-length field or + // have just processed the 'M' (message text) field. + // do { field_header = '\0'; long len; - /* work around possibly buggy messages: */ - while (field_header == '\0') { + while (field_header == '\0') { // work around possibly buggy messages if (mptr >= upper_bound) { break; } @@ -1156,30 +1119,27 @@ struct CtdlMessage *CtdlDeserializeMessage(long msgnum, int with_body, const cha CM_SetField(ret, which, mptr, len); - mptr += len + 1; /* advance to next field */ + mptr += len + 1; // advance to next field } while ((mptr < upper_bound) && (field_header != 'M')); - return (ret); } -/* - * Load a message from disk into memory. - * This is used by CtdlOutputMsg() and other fetch functions. - * - * NOTE: Caller is responsible for freeing the returned CtdlMessage struct - * using the CM_Free(); function. - */ -struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) -{ +// Load a message from disk into memory. +// This is used by CtdlOutputMsg() and other fetch functions. +// +// NOTE: Caller is responsible for freeing the returned CtdlMessage struct +// using the CM_Free(); function. +// +struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) { struct cdbdata *dmsgtext; struct CtdlMessage *ret = NULL; syslog(LOG_DEBUG, "msgbase: CtdlFetchMessage(%ld, %d)", msgnum, with_body); dmsgtext = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long)); if (dmsgtext == NULL) { - syslog(LOG_ERR, "msgbase: CtdlFetchMessage(%ld, %d) Failed!", msgnum, with_body); + syslog(LOG_ERR, "msgbase: message #%ld was not found", msgnum); return NULL; } @@ -1196,11 +1156,11 @@ struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) return NULL; } - /* Always make sure there's something in the msg text field. If - * it's NULL, the message text is most likely stored separately, - * so go ahead and fetch that. Failing that, just set a dummy - * body so other code doesn't barf. - */ + // Always make sure there's something in the msg text field. If + // it's NULL, the message text is most likely stored separately, + // so go ahead and fetch that. Failing that, just set a dummy + // body so other code doesn't barf. + // if ( (CM_IsEmpty(ret, eMesageText)) && (with_body) ) { dmsgtext = cdb_fetch(CDB_BIGMSGS, &msgnum, sizeof(long)); if (dmsgtext != NULL) { @@ -1216,16 +1176,14 @@ struct CtdlMessage *CtdlFetchMessage(long msgnum, int with_body) } -/* - * Pre callback function for multipart/alternative - * - * NOTE: this differs from the standard behavior for a reason. Normally when - * displaying multipart/alternative you want to show the _last_ usable - * format in the message. Here we show the _first_ one, because it's - * usually text/plain. Since this set of functions is designed for text - * output to non-MIME-aware clients, this is the desired behavior. - * - */ +// Pre callback function for multipart/alternative +// +// NOTE: this differs from the standard behavior for a reason. Normally when +// displaying multipart/alternative you want to show the _last_ usable +// format in the message. Here we show the _first_ one, because it's +// usually text/plain. Since this set of functions is designed for text +// output to non-MIME-aware clients, this is the desired behavior. +// void fixed_output_pre(char *name, char *filename, char *partnum, char *disp, void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *cbuserdata) @@ -1244,9 +1202,9 @@ void fixed_output_pre(char *name, char *filename, char *partnum, char *disp, } -/* - * Post callback function for multipart/alternative - */ +// +// Post callback function for multipart/alternative +// void fixed_output_post(char *name, char *filename, char *partnum, char *disp, void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *cbuserdata) @@ -1265,9 +1223,8 @@ void fixed_output_post(char *name, char *filename, char *partnum, char *disp, } -/* - * Inline callback function for mime parser that wants to display text - */ +// Inline callback function for mime parser that wants to display text +// void fixed_output(char *name, char *filename, char *partnum, char *disp, void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *cbuserdata) @@ -1284,10 +1241,9 @@ void fixed_output(char *name, char *filename, char *partnum, char *disp, partnum, filename, cbtype, (long)length ); - /* - * If we're in the middle of a multipart/alternative scope and - * we've already printed another section, skip this one. - */ + // If we're in the middle of a multipart/alternative scope and + // we've already printed another section, skip this one. + // if ( (ma->is_ma) && (ma->did_print) ) { syslog(LOG_DEBUG, "msgbase: skipping part %s (%s)", partnum, cbtype); return; @@ -1318,8 +1274,7 @@ void fixed_output(char *name, char *filename, char *partnum, char *disp, } if (ma->use_fo_hooks) { - if (PerformFixedOutputHooks(cbtype, content, length)) { - /* above function returns nonzero if it handled the part */ + if (PerformFixedOutputHooks(cbtype, content, length)) { // returns nonzero if it handled the part return; } } @@ -1332,17 +1287,16 @@ void fixed_output(char *name, char *filename, char *partnum, char *disp, } -/* - * The client is elegant and sophisticated and wants to be choosy about - * MIME content types, so figure out which multipart/alternative part - * we're going to send. - * - * We use a system of weights. When we find a part that matches one of the - * MIME types we've declared as preferential, we can store it in ma->chosen_part - * and then set ma->chosen_pref to that MIME type's position in our preference - * list. If we then hit another match, we only replace the first match if - * the preference value is lower. - */ +// The client is elegant and sophisticated and wants to be choosy about +// MIME content types, so figure out which multipart/alternative part +// we're going to send. +// +// We use a system of weights. When we find a part that matches one of the +// MIME types we've declared as preferential, we can store it in ma->chosen_part +// and then set ma->chosen_pref to that MIME type's position in our preference +// list. If we then hit another match, we only replace the first match if +// the preference value is lower. +// void choose_preferred(char *name, char *filename, char *partnum, char *disp, void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *cbuserdata) @@ -1366,9 +1320,8 @@ void choose_preferred(char *name, char *filename, char *partnum, char *disp, } -/* - * Now that we've chosen our preferred part, output it. - */ +// Now that we've chosen our preferred part, output it. +// void output_preferred(char *name, char *filename, char *partnum, @@ -1392,12 +1345,11 @@ void output_preferred(char *name, ma = (struct ma_info *)cbuserdata; - /* This is not the MIME part you're looking for... */ + // This is not the MIME part you're looking for... if (strcasecmp(partnum, ma->chosen_part)) return; - /* If the content-type of this part is in our preferred formats - * list, we can simply output it verbatim. - */ + // If the content-type of this part is in our preferred formats + // list, we can simply output it verbatim. for (i=0; ipreferred_formats, '|'); ++i) { extract_token(buf, CC->preferred_formats, i, '|', sizeof buf); if (!strcasecmp(buf, cbtype)) { @@ -1409,7 +1361,7 @@ void output_preferred(char *name, &decoded, &bytes_decoded); if (rc < 0) - break; /* Give us the chance, maybe theres another one. */ + break; // Give us the chance, maybe theres another one. if (rc == 0) text_content = (char *)content; else { @@ -1445,7 +1397,7 @@ void output_preferred(char *name, } } - /* No translations required or possible: output as text/plain */ + // No translations required or possible: output as text/plain cprintf("Content-type: text/plain\n\n"); rc = 0; if (ma->dont_decode == 0) @@ -1455,7 +1407,7 @@ void output_preferred(char *name, &decoded, &bytes_decoded); if (rc < 0) - return; /* Give us the chance, maybe theres another one. */ + return; // Give us the chance, maybe theres another one. if (rc == 0) text_content = (char *)content; else { @@ -1463,8 +1415,7 @@ void output_preferred(char *name, length = bytes_decoded; } - fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, - length, encoding, cbid, cbuserdata); + fixed_output(name, filename, partnum, disp, text_content, cbtype, cbcharset, length, encoding, cbid, cbuserdata); if (decoded != NULL) free(decoded); } @@ -1476,9 +1427,7 @@ struct encapmsg { }; -/* - * Callback function for - */ +// Callback function void extract_encapsulated_message(char *name, char *filename, char *partnum, char *disp, void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *cbuserdata) @@ -1487,7 +1436,7 @@ void extract_encapsulated_message(char *name, char *filename, char *partnum, cha encap = (struct encapmsg *)cbuserdata; - /* Only proceed if this is the desired section... */ + // Only proceed if this is the desired section... if (!strcasecmp(encap->desired_section, partnum)) { encap->msglen = length; encap->msg = malloc(length + 2); @@ -1497,20 +1446,17 @@ void extract_encapsulated_message(char *name, char *filename, char *partnum, cha } -/* - * Determine whether the specified message exists in the cached_msglist - * (This is a security check) - */ +// Determine whether the specified message exists in the cached_msglist +// (This is a security check) int check_cached_msglist(long msgnum) { - /* cases in which we skip the check */ - if (!CC) return om_ok; /* not a session */ - if (CC->client_socket <= 0) return om_ok; /* not a client session */ - if (CC->cached_msglist == NULL) return om_access_denied; /* no msglist fetched */ - if (CC->cached_num_msgs == 0) return om_access_denied; /* nothing to check */ - + // cases in which we skip the check + if (!CC) return om_ok; // not a session + if (CC->client_socket <= 0) return om_ok; // not a client session + if (CC->cached_msglist == NULL) return om_access_denied; // no msglist fetched + if (CC->cached_num_msgs == 0) return om_access_denied; // nothing to check - /* Do a binary search within the cached_msglist for the requested msgnum */ + // Do a binary search within the cached_msglist for the requested msgnum int min = 0; int max = (CC->cached_num_msgs - 1); @@ -1531,17 +1477,14 @@ int check_cached_msglist(long msgnum) { } -/* - * Get a message off disk. (returns om_* values found in msgbase.h) - * - */ -int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */ - int mode, /* how would you like that message? */ - int headers_only, /* eschew the message body? */ - int do_proto, /* do Citadel protocol responses? */ - int crlf, /* Use CRLF newlines instead of LF? */ - char *section, /* NULL or a message/rfc822 section */ - int flags, /* various flags; see msgbase.h */ +// Get a message off disk. (returns om_* values found in msgbase.h) +int CtdlOutputMsg(long msg_num, // message number (local) to fetch + int mode, // how would you like that message? + int headers_only, // eschew the message body? + int do_proto, // do Citadel protocol responses? + int crlf, // Use CRLF newlines instead of LF? + char *section, // NULL or a message/rfc822 section + int flags, // various flags; see msgbase.h char **Author, char **Address, char **MessageID @@ -1687,10 +1630,7 @@ int CtdlOutputMsg(long msg_num, /* message number (local) to fetch */ } -void OutputCtdlMsgHeaders( - struct CtdlMessage *TheMessage, - int do_proto) /* do Citadel protocol responses? */ -{ +void OutputCtdlMsgHeaders(struct CtdlMessage *TheMessage, int do_proto) { int i; char buf[SIZ]; char display_name[256]; @@ -1723,23 +1663,29 @@ void OutputCtdlMsgHeaders( eMsgField Field; Field = FieldOrder[i]; if (Field != eMesageText) { - if ( (!CM_IsEmpty(TheMessage, Field)) - && (msgkeys[Field] != NULL) ) { - if ((Field == eenVelopeTo) || - (Field == eRecipient) || - (Field == eCarbonCopY)) { + if ( (!CM_IsEmpty(TheMessage, Field)) && (msgkeys[Field] != NULL) ) { + if ((Field == eenVelopeTo) || (Field == eRecipient) || (Field == eCarbonCopY)) { sanitize_truncated_recipient(TheMessage->cm_fields[Field]); } if (Field == eAuthor) { - if (do_proto) cprintf("%s=%s\n", - msgkeys[Field], - display_name); + if (do_proto) { + cprintf("%s=%s\n", msgkeys[Field], display_name); + } } /* Masquerade display name if needed */ else { if (do_proto) { cprintf("%s=%s\n", msgkeys[Field], TheMessage->cm_fields[Field]); } + } + /* Give the client a hint about whether the message originated locally */ + if (Field == erFc822Addr) { + if (IsDirectory(TheMessage->cm_fields[Field] ,0)) { + cprintf("locl=yes\n"); // message originated locally. + } + + + } } } @@ -1804,6 +1750,7 @@ void OutputRFC822MsgHeaders( break; case erFc822Addr: safestrncpy(fuser, mptr, sizeof_fuser); + break; case eRecipient: if (haschar(mptr, '@') == 0) { sanitize_truncated_recipient(mptr); @@ -2124,7 +2071,7 @@ int CtdlOutputPreLoadedMsg( /* Tell the client which format type we're using. */ if ( (mode == MT_CITADEL) && (do_proto) ) { - cprintf("type=%d\n", TheMessage->cm_format_type); + cprintf("type=%d\n", TheMessage->cm_format_type); // Tell the client which format type we're using. } /* nhdr=yes means that we're only displaying headers, no body */ @@ -2135,9 +2082,9 @@ int CtdlOutputPreLoadedMsg( cprintf("nhdr=yes\n"); } - if ((mode == MT_CITADEL) || (mode == MT_MIME)) + if ((mode == MT_CITADEL) || (mode == MT_MIME)) { OutputCtdlMsgHeaders(TheMessage, do_proto); - + } /* begin header processing loop for RFC822 transfer format */ strcpy(suser, ""); @@ -2456,8 +2403,6 @@ int CtdlSaveMsgPointerInRoom(char *roomname, long msgid, } - - /* * Message base operation to save a new message to the message store * (returns new message number) @@ -2477,8 +2422,7 @@ long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) { * If the message is big, set its body aside for storage elsewhere * and we hide the message body from the serializer */ - if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG) - { + if (!CM_IsEmpty(msg, eMesageText) && msg->cm_lengths[eMesageText] > BIGMSG) { is_bigmsg = 1; holdM = msg->cm_fields[eMesageText]; msg->cm_fields[eMesageText] = NULL; @@ -2508,8 +2452,7 @@ long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) { } /* Write our little bundle of joy into the message base */ - retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), - smr.ser, smr.len); + retval = cdb_store(CDB_MSGMAIN, &msgid, (int)sizeof(long), smr.ser, smr.len); if (retval < 0) { syslog(LOG_ERR, "msgbase: can't store message %ld: %ld", msgid, retval); } @@ -2533,6 +2476,7 @@ long CtdlSaveThisMessage(struct CtdlMessage *msg, long msgid, int Reply) { return(retval); } + long send_message(struct CtdlMessage *msg) { long newmsgid; long retval; @@ -2566,9 +2510,8 @@ long send_message(struct CtdlMessage *msg) { } - /* - * Serialize a struct CtdlMessage into the format used on disk and network. + * Serialize a struct CtdlMessage into the format used on disk. * * This function loads up a "struct ser_ret" (defined in server.h) which * contains the length of the serialized message and a pointer to the @@ -2608,9 +2551,8 @@ void CtdlSerializeMessage(struct ser_ret *ret, /* return values */ ret->ser[2] = msg->cm_format_type; wlen = 3; - for (i=0; i < NDiskFields; ++i) - if (msg->cm_fields[FieldOrder[i]] != NULL) - { + for (i=0; i < NDiskFields; ++i) { + if (msg->cm_fields[FieldOrder[i]] != NULL) { ret->ser[wlen++] = (char)FieldOrder[i]; memcpy(&ret->ser[wlen], @@ -2619,6 +2561,7 @@ void CtdlSerializeMessage(struct ser_ret *ret, /* return values */ wlen = wlen + msg->cm_lengths[FieldOrder[i]] + 1; } + } if (ret->len != wlen) { syslog(LOG_ERR, "msgbase: ERROR; len=%ld wlen=%ld", (long)ret->len, (long)wlen); @@ -2654,16 +2597,13 @@ void ReplicationChecks(struct CtdlMessage *msg) { } - /* * Save a message to disk and submit it into the delivery system. */ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ - recptypes *recps, /* recipients (if mail) */ - const char *force, /* force a particular room? */ - int flags /* should the message be exported clean? */ - ) -{ + struct recptypes *recps, /* recipients (if mail) */ + const char *force /* force a particular room? */ +) { char hold_rm[ROOMNAMELEN]; char actual_rm[ROOMNAMELEN]; char force_room[ROOMNAMELEN]; @@ -2808,8 +2748,7 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ memset(&smi, 0, sizeof(struct MetaData)); smi.meta_msgnum = newmsgid; smi.meta_refcount = 0; - safestrncpy(smi.meta_content_type, content_type, - sizeof smi.meta_content_type); + safestrncpy(smi.meta_content_type, content_type, sizeof smi.meta_content_type); /* * Measure how big this message will be when rendered as RFC822. @@ -2842,7 +2781,7 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ */ if ((!CC->internal_pgm) || (recps == NULL)) { if (CtdlSaveMsgPointerInRoom(actual_rm, newmsgid, 1, msg) != 0) { - syslog(LOG_ERR, "msgbase: ERROR saving message pointer!"); + syslog(LOG_ERR, "msgbase: ERROR saving message pointer %ld in %s", newmsgid, actual_rm); CtdlSaveMsgPointerInRoom(CtdlGetConfigStr("c_aideroom"), newmsgid, 0, msg); } } @@ -2853,13 +2792,13 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ } /* If other rooms are specified, drop them there too. */ - if ((recps != NULL) && (recps->num_room > 0)) + if ((recps != NULL) && (recps->num_room > 0)) { for (i=0; irecp_room, '|'); ++i) { - extract_token(recipient, recps->recp_room, i, - '|', sizeof recipient); + extract_token(recipient, recps->recp_room, i, '|', sizeof recipient); syslog(LOG_DEBUG, "msgbase: delivering to room <%s>", recipient); CtdlSaveMsgPointerInRoom(recipient, newmsgid, 0, msg); } + } /* Bump this user's messages posted counter. */ syslog(LOG_DEBUG, "msgbase: updating user"); @@ -2868,12 +2807,11 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ CtdlPutCurrentUserLock(); /* Decide where bounces need to be delivered */ - if ((recps != NULL) && (recps->bounce_to == NULL)) - { + if ((recps != NULL) && (recps->bounce_to == NULL)) { if (CC->logged_in) { strcpy(bounce_to, CC->user.fullname); } - else { + else if (!IsEmptyStr(msg->cm_fields[eAuthor])){ strcpy(bounce_to, msg->cm_fields[eAuthor]); } recps->bounce_to = bounce_to; @@ -2881,20 +2819,17 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ CM_SetFieldLONG(msg, eVltMsgNum, newmsgid); - /* If this is private, local mail, make a copy in the * recipient's mailbox and bump the reference count. */ - if ((recps != NULL) && (recps->num_local > 0)) - { + if ((recps != NULL) && (recps->num_local > 0)) { char *pch; int ntokens; pch = recps->recp_local; recps->recp_local = recipient; ntokens = num_tokens(pch, '|'); - for (i=0; i", recipient); if (CtdlGetUser(&userbuf, recipient) == 0) { @@ -2919,8 +2854,9 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ /* Go back to the room we started from */ syslog(LOG_DEBUG, "msgbase: returning to original room %s", hold_rm); - if (strcasecmp(hold_rm, CC->room.QRname)) + if (strcasecmp(hold_rm, CC->room.QRname)) { CtdlUserGoto(hold_rm, 0, 1, NULL, NULL, NULL, NULL); + } /* * Any addresses to harvest for someone's address book? @@ -2930,10 +2866,8 @@ long CtdlSubmitMsg(struct CtdlMessage *msg, /* message to save */ } if (collected_addresses != NULL) { - aptr = (struct addresses_to_be_filed *) - malloc(sizeof(struct addresses_to_be_filed)); - CtdlMailboxName(actual_rm, sizeof actual_rm, - &CC->user, USERCONTACTSROOM); + aptr = (struct addresses_to_be_filed *) malloc(sizeof(struct addresses_to_be_filed)); + CtdlMailboxName(actual_rm, sizeof actual_rm, &CC->user, USERCONTACTSROOM); aptr->roomname = strdup(actual_rm); aptr->collected_addresses = collected_addresses; begin_critical_section(S_ATBF); @@ -2994,7 +2928,7 @@ long quickie_message(const char *from, const char *subject) { struct CtdlMessage *msg; - recptypes *recp = NULL; + struct recptypes *recp = NULL; msg = malloc(sizeof(struct CtdlMessage)); memset(msg, 0, sizeof(struct CtdlMessage)); @@ -3030,7 +2964,7 @@ long quickie_message(const char *from, CM_SetField(msg, eMesageText, text, -1); } - long msgnum = CtdlSubmitMsg(msg, recp, room, 0); + long msgnum = CtdlSubmitMsg(msg, recp, room); CM_Free(msg); if (recp != NULL) free_recipients(recp); return msgnum; @@ -3046,8 +2980,7 @@ StrBuf *CtdlReadMessageBodyBuf(char *terminator, /* token signalling EOT */ StrBuf *exist, /* if non-null, append to it; exist is ALWAYS freed */ int crlf /* CRLF newlines instead of LF */ - ) -{ +) { StrBuf *Message; StrBuf *LineBuf; int flushing = 0; @@ -3124,6 +3057,7 @@ char *CtdlReadMessageBody(char *terminator, /* token signalling EOT */ return SmashStrBuf(&Message); } + struct CtdlMessage *CtdlMakeMessage( struct ctdluser *author, /* author's user structure */ char *recipient, /* NULL if it's not mail */ @@ -3137,8 +3071,7 @@ struct CtdlMessage *CtdlMakeMessage( char *supplied_euid, /* ...or NULL if this is irrelevant */ char *preformatted_text, /* ...or NULL to read text from client */ char *references /* Thread references */ -) -{ +) { return CtdlMakeMessageLen( author, /* author's user structure */ recipient, /* NULL if it's not mail */ @@ -3164,6 +3097,7 @@ struct CtdlMessage *CtdlMakeMessage( } + /* * Build a binary message to be saved on disk. * (NOTE: if you supply 'preformatted_text', the buffer you give it @@ -3171,7 +3105,6 @@ struct CtdlMessage *CtdlMakeMessage( * responsible for managing that memory -- it will be freed along with * the rest of the fields when CM_Free() is called.) */ - struct CtdlMessage *CtdlMakeMessageLen( struct ctdluser *author, /* author's user structure */ char *recipient, /* NULL if it's not mail */ @@ -3194,10 +3127,7 @@ struct CtdlMessage *CtdlMakeMessageLen( long textlen, char *references, /* Thread references */ long reflen - ) -{ - /* Don't confuse the poor folks if it's not routed mail. * / - char dest_node[256] = "";*/ +) { long blen; char buf[1024]; struct CtdlMessage *msg; @@ -3304,18 +3234,15 @@ struct CtdlMessage *CtdlMakeMessageLen( } - - /* * API function to delete messages which match a set of criteria * (returns the actual number of messages deleted) */ -int CtdlDeleteMessages(const char *room_name, /* which room */ - long *dmsgnums, /* array of msg numbers to be deleted */ - int num_dmsgnums, /* number of msgs to be deleted, or 0 for "any" */ - char *content_type /* or "" for any. regular expressions expected. */ - ) -{ +int CtdlDeleteMessages(const char *room_name, // which room + long *dmsgnums, // array of msg numbers to be deleted + int num_dmsgnums, // number of msgs to be deleted, or 0 for "any" + char *content_type // or "" for any. regular expressions expected. +) { struct ctdlroom qrbuf; struct cdbdata *cdbfr; long *msglist = NULL; @@ -3562,8 +3489,7 @@ void CtdlWriteObject(char *req_room, /* Room to stuff it in */ int is_binary, /* Is encoding necessary? */ int is_unique, /* Del others of this type? */ unsigned int flags /* Internal save flags */ - ) -{ +) { struct ctdlroom qrbuf; char roomname[ROOMNAMELEN]; struct CtdlMessage *msg; @@ -3628,7 +3554,7 @@ void CtdlWriteObject(char *req_room, /* Room to stuff it in */ ); } /* Now write the data */ - CtdlSubmitMsg(msg, NULL, roomname, 0); + CtdlSubmitMsg(msg, NULL, roomname); CM_Free(msg); }