X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Ftechdoc%2Fhack.txt;h=1af927555f80139ae118509743c5f3dd9773da18;hb=10ef619598720fc710f58a1d0ce18e250114a600;hp=0345beb96a58fe47c0e37a07b493ea0062a57a0d;hpb=4452cc5785cead33a6af5df79ee2cdf72d296e48;p=citadel.git diff --git a/citadel/techdoc/hack.txt b/citadel/techdoc/hack.txt index 0345beb96..1af927555 100644 --- a/citadel/techdoc/hack.txt +++ b/citadel/techdoc/hack.txt @@ -36,8 +36,6 @@ struct ctdluser { /* User record */ time_t lastcall; /* Last time the user called */ int USuserpurge; /* Purge time (in days) for user */ char fullname[64]; /* Name for Citadel messages & mail */ - CIT_UBYTE USscreenwidth; /* Screen width (for textmode users)*/ - CIT_UBYTE USscreenheight; /* Screen height(for textmode users)*/ }; Most fields here should be fairly self-explanatory. The ones that might @@ -50,14 +48,9 @@ a separate Citadel password. usernum -- these are assigned sequentially, and NEVER REUSED. This is important because it allows us to use this number in other data structures -without having to worry about users being added/removed later on, as you'll + without having to worry about users being added/removed later on, as you'll see later in this document. - The screenwidth and screenheight fields are almost never used anymore. Back -when people were calling into dialup systems we had no way of knowing the -user's screen dimensions, but modern networks almost always transmit this -information so we set it up dynamically. - ROOM RECORDS ------------ @@ -234,64 +227,99 @@ can do wildcard matching without worrying about unpacking binary data such as message ID's first. To provide later downward compatability all software should be written to IGNORE fields not currently defined. - The type bytes currently defined are: - -BYTE Mnemonic Comments - -A Author Name of originator of message. -B Big message This is a flag which indicates that the message is - big, and Citadel is storing the body in a separate - record. You will never see this field because the - internal API handles it. -D Destination Contains name of the system this message should - be sent to, for mail routing (private mail only). -E Exclusive ID A persistent alphanumeric Message ID used for - network replication. When a message arrives that - contains an Exclusive ID, any existing messages which - contain the same Exclusive ID and are *older* than this - message should be deleted. If there exist any messages - with the same Exclusive ID that are *newer*, then this - message should be dropped. -F rFc822 address For Internet mail, this is the delivery address of the - message author. -H Human node name Human-readable name of system message originated on. -I Original ID A 32-bit integer containing the message ID on the - system the message *originated* on. -J Journal The presence of this field indicates that the message - is disqualified from being journaled, perhaps because - it is itself a journalized message and we wish to - avoid double journaling. -M Message Text Normal ASCII, newlines seperated by CR's or LF's, - null terminated as always. -N Nodename Contains node name of system message originated on. -O Room Room of origin. -P Path Complete path of message, as in the UseNet news - standard. A user should be able to send Internet mail - to this path. (Note that your system name will not be - tacked onto this until you're sending the message to - someone else) -R Recipient Only present in Mail messages. -S Special field Only meaningful for messages being spooled over a - network. Usually means that the message isn't really - a message, but rather some other network function: - -> "S" followed by "FILE" (followed by a null, of - course) means that the message text is actually an - IGnet/Open file transfer. - -> "S" followed by "CANCEL" means that this message - should be deleted from the local message base once - it has been replicated to all network systems. -T date/Time A 32-bit integer containing the date and time of - the message in standard UNIX format (the number - of seconds since January 1, 1970 GMT). -U sUbject Optional. Developers may choose whether they wish to - generate or display subject fields. -V enVelope-to The recipient specified in incoming SMTP messages. -Y carbon copY Optional, and only in Mail messages. -0 Error This field is typically never found in a message on - disk or in transit. Message scanning modules are - expected to fill in this field when rejecting a message - with an explanation as to what happened (virus found, - message looks like spam, etc.) + The type bytes currently defined are: + +BYTE Enum Mnemonic Enum / Comments + +A eAuthor Author eAuthor + Name of originator of message. +B eBig_message Big message eBig_message + This is a flag which indicates that the message is + big, and Citadel is storing the body in a separate + record. You will never see this field because the + internal API handles it. +C eRemoteRoom RemoteRoom eRemoteRoom + when sent via Citadel Networking, this is the room + its going to be put on the remote site. +D eDestination Destination eDestination + Contains name of the system this message should + be sent to, for mail routing (private mail only). +E eExclusiveID Exclusive ID eExclusiveID + A persistent alphanumeric Message ID used for + network replication. When a message arrives that + contains an Exclusive ID, any existing messages which + contain the same Exclusive ID and are *older* than this + message should be deleted. If there exist any messages + with the same Exclusive ID that are *newer*, then this + message should be dropped. +F erFc822Addr rFc822 address erFc822Addr + For Internet mail, this is the delivery address of the + message author. +H eHumanNode Human node name eHumanNode + Human-readable name of system message originated on. +I emessageId Message ID emessageId + An RFC822-compatible message ID for this message. +J eJournal Journal eJournal + The presence of this field indicates that the message + is disqualified from being journaled, perhaps because + it is itself a journalized message and we wish to + avoid double journaling. +K eReplyTo Reply-To eReplyTo + the Reply-To header for mailinglist outbound messages +L eListID List-ID eListID + Mailing list identification, as per RFC 2919 +M eMesageText Message Text eMesageText + Normal ASCII, newlines seperated by CR's or LF's, + null terminated as always. +N eNodeName Nodename eNodeName + Contains node name of system message originated on. +O eOriginalRoom Room eOriginalRoom - Room of origin. +P eMessagePath Path eMessagePath + Complete path of message, as in the UseNet news + standard. A user should be able to send Internet mail + to this path. (Note that your system name will not be + tacked onto this until you're sending the message to + someone else) +R eRecipient Recipient eRecipient - Only present in Mail messages. +S eSpecialField Special field eSpecialField + Only meaningful for messages being spooled over a + network. Usually means that the message isn't really + a message, but rather some other network function: + -> "S" followed by "FILE" (followed by a null, of + course) means that the message text is actually an + IGnet/Open file transfer. (OBSOLETE) + -> "S" followed by "CANCEL" means that this message + should be deleted from the local message base once + it has been replicated to all network systems. +T eTimestamp date/Time eTimestamp + Unix timestamp containing the creation date/time of + the message. +U eMsgSubject sUbject eMsgSubject - Optional. + Developers may choose whether they wish to + generate or display subject fields. +V eenVelopeTo enVelope-to eenVelopeTo + The recipient specified in incoming SMTP messages. +W eWeferences Wefewences eWeferences + Previous message ID's for conversation threading. When + converting from RFC822 we use References: if present, or + In-Reply-To: otherwise. + (Who in extnotify spool messages which don't need to know + other message ids) +Y eCarbonCopY carbon copY eCarbonCopY + Optional, and only in Mail messages. +0 eErrorMsg Error eErrorMsg + This field is typically never found in a message on + disk or in transit. Message scanning modules are + expected to fill in this field when rejecting a message + with an explanation as to what happened (virus found, + message looks like spam, etc.) +1 eSuppressIdx suppress index eSuppressIdx + The presence of this field indicates that the message is + disqualified from being added to the full text index. +2 eExtnotify extnotify eExtnotify - Used internally by the serv_extnotify module. +3 eVltMsgNum msgnum eVltMsgNum + Used internally to pass the local message number in the + database to after-save hooks. Discarded afterwards. EXAMPLE