1 ------------------------------------------------------
2 The totally incomplete guide to Citadel internals
3 ------------------------------------------------------
5 Citadel has evolved quite a bit since its early days, and the data structures
6 have evolved with it. This document provides a rough overview of how the
7 system works internally. For details you're going to have to dig through the
8 code, but this'll get you started.
14 As you probably already know by now, Citadel uses a group of tables stored
15 with a record manager (usually Berkeley DB). Since we're using a record
16 manager rather than a relational database, all record structures are managed
17 by Citadel. Here are some of the tables we keep on disk:
23 This table contains all user records. It's indexed by
24 user name (translated to lower case for indexing purposes). The records in
25 this file look something like this:
27 struct ctdluser { /* User record */
28 int version; /* Cit vers. which created this rec */
29 uid_t uid; /* Associate with a unix account? */
30 char password[32]; /* password (for Citadel-only users)*/
31 unsigned flags; /* See US_ flags below */
32 long timescalled; /* Total number of logins */
33 long posted; /* Number of messages posted (ever) */
34 CIT_UBYTE axlevel; /* Access level */
35 long usernum; /* User number (never recycled) */
36 time_t lastcall; /* Last time the user called */
37 int USuserpurge; /* Purge time (in days) for user */
38 char fullname[64]; /* Name for Citadel messages & mail */
41 Most fields here should be fairly self-explanatory. The ones that might
42 deserve some attention are:
44 uid -- if uid is not the same as the uid Citadel is running as, then the
45 account is assumed to belong to the user on the underlying Unix system with
46 that uid. This allows us to require the user's OS password instead of having
47 a separate Citadel password.
49 usernum -- these are assigned sequentially, and NEVER REUSED. This is
50 important because it allows us to use this number in other data structures
51 without having to worry about users being added/removed later on, as you'll
52 see later in this document.
58 These are room records. There is a room record for every room on the
59 system, public or private or mailbox. It's indexed by room name (also in
60 lower case for easy indexing) and it contains records which look like this:
63 char QRname[ROOMNAMELEN]; /* Name of room */
64 char QRpasswd[10]; /* Only valid if it's a private rm */
65 long QRroomaide; /* User number of room aide */
66 long QRhighest; /* Highest message NUMBER in room */
67 time_t QRgen; /* Generation number of room */
68 unsigned QRflags; /* See flag values below */
69 char QRdirname[15]; /* Directory name, if applicable */
70 long QRinfo; /* Info file update relative to msgs*/
71 char QRfloor; /* Which floor this room is on */
72 time_t QRmtime; /* Date/time of last post */
73 struct ExpirePolicy QRep; /* Message expiration policy */
74 long QRnumber; /* Globally unique room number */
75 char QRorder; /* Sort key for room listing order */
76 unsigned QRflags2; /* Additional flags */
77 int QRdefaultview; /* How to display the contents */
80 Again, mostly self-explanatory. Here are the interesting ones:
82 QRnumber is a globally unique room ID, while QRgen is the "generation number"
83 of the room (it's actually a timestamp). The two combined produce a unique
84 value which identifies the room. The reason for two separate fields will be
85 explained below when we discuss the visit table. For now just remember that
86 QRnumber remains the same for the duration of the room's existence, and QRgen
87 is timestamped once during room creation but may be restamped later on when
88 certain circumstances exist.
95 Floors. This is so simplistic it's not worth going into detail about, except
96 to note that we keep a reference count of the number of rooms on each floor.
102 Each record in this table consists of a bunch of message numbers
103 which represent the contents of a room. A message can exist in more than one
104 room (for example, a mail message with multiple recipients -- 'single instance
105 store'). This table is never, ever traversed in its entirety. When you do
106 any type of read operation, it fetches the msglist for the room you're in
107 (using the room's ID as the index key) and then you can go ahead and read
108 those messages one by one.
110 Each room is basically just a list of message numbers. Each time
111 we enter a new message in a room, its message number is appended to the end
112 of the list. If an old message is to be expired, we must delete it from the
113 message base. Reading a room is just a matter of looking up the messages
114 one by one and sending them to the client for display, printing, or whatever.
120 This is the tough one. Put on your thinking cap and grab a fresh cup of
121 coffee before attempting to grok the visit table.
123 This table contains records which establish the relationship between users
124 and rooms. Its index is a hash of the user and room combination in question.
125 When looking for such a relationship, the record in this table can tell the
126 server things like "this user has zapped this room," "this user has access to
127 this private room," etc. It's also where we keep track of which messages
128 the user has marked as "old" and which are "new" (which are not necessarily
129 contiguous; contrast with older Citadel implementations which simply kept a
130 "last read" pointer).
132 Here's what the records look like:
139 unsigned int v_flags;
144 #define V_FORGET 1 /* User has zapped this room */
145 #define V_LOCKOUT 2 /* User is locked out of this room */
146 #define V_ACCESS 4 /* Access is granted to this room */
148 This table is indexed by a concatenation of the first three fields. Whenever
149 we want to learn the relationship between a user and a room, we feed that
150 data to a function which looks up the corresponding record. The record is
151 designed in such a way that an "all zeroes" record (which is what you get if
152 the record isn't found) represents the default relationship.
154 With this data, we now know which private rooms we're allowed to visit: if
155 the V_ACCESS bit is set, the room is one which the user knows, and it may
156 appear in his/her known rooms list. Conversely, we also know which rooms the
157 user has zapped: if the V_FORGET flag is set, we relegate the room to the
158 zapped list and don't bring it up during new message searches. It's also
159 worth noting that the V_LOCKOUT flag works in a similar way to administratively
160 lock users out of rooms.
162 Implementing the "cause all users to forget room" command, then, becomes very
163 simple: we simply change the generation number of the room by putting a new
164 timestamp in the QRgen field. This causes all relevant visit records to
165 become irrelevant, because they appear to point to a different room. At the
166 same time, we don't lose the messages in the room, because the msglists table
167 is indexed by the room number (QRnumber), which never changes.
169 v_seen contains a string which represents the set of messages in this room
170 which the user has read (marked as 'seen' or 'old'). It follows the same
171 syntax used by IMAP and NNTP. When we search for new messages, we simply
172 return any messages that are in the room that are *not* represented by this
173 set. Naturally, when we do want to mark more messages as seen (or unmark
174 them), we change this string. Citadel BBS client implementations are naive
175 and think linearly in terms of "everything is old up to this point," but IMAP
176 clients want to have more granularity.
182 This table simply maps Internet e-mail addresses to Citadel network addresses
183 for quick lookup. It is generated from data in the Global Address Book room.
188 This table keeps track of message ID's of messages arriving over a network,
189 to prevent duplicates from being posted if someone misconfigures the network
190 and a loop is created. This table goes unused on a non-networked Citadel.
195 This is where all message text is stored. It's indexed by message number:
196 give it a number, get back a message. Messages are numbered sequentially, and
197 the message numbers are never reused.
199 We also keep a "metadata" record for each message. This record is also stored
200 in the msgmain table, using the index (0 - msgnum). We keep in the metadata
201 record, among other things, a reference count for each message. Since a
202 message may exist in more than one room, it's important to keep this reference
203 count up to date, and to delete the message from disk when the reference count
206 Here's the format for the message itself:
208 Each message begins with an 0xFF 'start of message' byte.
210 The next byte denotes whether this is an anonymous message. The codes
211 available are MES_NORMAL, MES_ANON, or MES_AN2 (defined in citadel.h).
213 The third byte is a "message type" code. The following codes are defined:
214 0 - "Traditional" Citadel format. Message is to be displayed "formatted."
215 1 - Plain pre-formatted ASCII text (otherwise known as text/plain)
216 4 - MIME formatted message. The text of the message which follows is
217 expected to begin with a "Content-type:" header.
219 After these three opening bytes, the remainder of
220 the message consists of a sequence of character strings. Each string
221 begins with a type byte indicating the meaning of the string and is
222 ended with a null. All strings are printable ASCII: in particular,
223 all numbers are in ASCII rather than binary. This is for simplicity,
224 both in implementing the system and in implementing other code to
225 work with the system. For instance, a database driven off Citadel archives
226 can do wildcard matching without worrying about unpacking binary data such
227 as message ID's first. To provide later downward compatability
228 all software should be written to IGNORE fields not currently defined.
230 The type bytes currently defined are:
232 BYTE Mnemonic Comments
234 A Author Name of originator of message.
235 B Big message This is a flag which indicates that the message is
236 big, and Citadel is storing the body in a separate
237 record. You will never see this field because the
238 internal API handles it.
239 D Destination Contains name of the system this message should
240 be sent to, for mail routing (private mail only).
241 E Exclusive ID A persistent alphanumeric Message ID used for
242 network replication. When a message arrives that
243 contains an Exclusive ID, any existing messages which
244 contain the same Exclusive ID and are *older* than this
245 message should be deleted. If there exist any messages
246 with the same Exclusive ID that are *newer*, then this
247 message should be dropped.
248 F rFc822 address For Internet mail, this is the delivery address of the
250 H Human node name Human-readable name of system message originated on.
251 I Message ID An RFC822-compatible message ID for this message.
252 J Journal The presence of this field indicates that the message
253 is disqualified from being journaled, perhaps because
254 it is itself a journalized message and we wish to
255 avoid double journaling.
256 K Reply-To the Reply-To header for mailinglist outbound messages
257 L List-ID Mailing list identification, as per RFC 2919
258 M Message Text Normal ASCII, newlines seperated by CR's or LF's,
259 null terminated as always.
260 N Nodename Contains node name of system message originated on.
261 O Room Room of origin.
262 P Path Complete path of message, as in the UseNet news
263 standard. A user should be able to send Internet mail
264 to this path. (Note that your system name will not be
265 tacked onto this until you're sending the message to
267 R Recipient Only present in Mail messages.
268 S Special field Only meaningful for messages being spooled over a
269 network. Usually means that the message isn't really
270 a message, but rather some other network function:
271 -> "S" followed by "FILE" (followed by a null, of
272 course) means that the message text is actually an
273 IGnet/Open file transfer. (OBSOLETE)
274 -> "S" followed by "CANCEL" means that this message
275 should be deleted from the local message base once
276 it has been replicated to all network systems.
277 T date/Time Unix timestamp containing the creation date/time of
279 U sUbject Optional. Developers may choose whether they wish to
280 generate or display subject fields.
281 V enVelope-to The recipient specified in incoming SMTP messages.
282 W Wefewences Previous message ID's for conversation threading. When
283 converting from RFC822 we use References: if present, or
284 In-Reply-To: otherwise.
285 Y carbon copY Optional, and only in Mail messages.
286 0 Error This field is typically never found in a message on
287 disk or in transit. Message scanning modules are
288 expected to fill in this field when rejecting a message
289 with an explanation as to what happened (virus found,
290 message looks like spam, etc.)
291 1 suppress index The presence of this field indicates that the message is
292 disqualified from being added to the full text index.
293 2 extnotify Used internally by the serv_extnotify module.
297 Let <FF> be a 0xFF byte, and <0> be a null (0x00) byte. Then a message
300 Apr 12, 1988 23:16 From Test User In Network Test> @lifesys (Life Central)
303 might be stored as...
304 <FF><40><0>I12345<0>Pneighbor!lifesys!test_user<0>T576918988<0> (continued)
305 -----------|Mesg ID#|--Message Path---------------|--Date------
307 AThe Test User<0>ONetwork Test<0>Nlifesys<0>HLife Central<0>MHave a nice day!<0>
308 |-----Author-----|-Room name-----|-nodename-|Human Name-|--Message text-----
310 Weird things can happen if fields are missing, especially if you use the
311 networker. But basically, the date, author, room, and nodename may be in any
312 order. But the leading fields and the message text must remain in the same
313 place. The H field looks better when it is placed immediately after the N
317 EUID (EXCLUSIVE MESSAGE ID'S)
318 -----------------------------
320 This is where the groupware magic happens. Any message in any room may have
321 a field called the Exclusive message ID, or EUID. We keep an index in the
322 table CDB_EUIDINDEX which knows the message number of any item that has an
323 EUID. This allows us to do two things:
325 1. If a subsequent message arrives with the same EUID, it automatically
326 *deletes* the existing one, because the new one is considered a replacement
327 for the existing one.
328 2. If we know the EUID of the item we're looking for, we can fetch it by EUID
329 and get the most up-to-date version, even if it's been updated several times.
331 This functionality is made more useful by server-side hooks. For example,
332 when we save a vCard to an address book room, or an iCalendar item to a
333 calendar room, our server modules detect this condition, and automatically set
334 the EUID of the message to the UUID of the vCard or iCalendar item. Therefore
335 when you save an updated version of an address book entry or a calendar item,
336 the old one is automatically deleted.
340 NETWORKING (REPLICATION)
341 ------------------------
343 Citadel nodes network by sharing one or more rooms. Any Citadel node
344 can choose to share messages with any other Citadel node, through the sending
345 of spool files. The sending system takes all messages it hasn't sent yet, and
346 spools them to the recieving system, which posts them in the rooms.
348 The EUID discussion above is extremely relevant, because EUID is carried over
349 the network as well, and the replacement rules are followed over the network
350 as well. Therefore, when a message containing an EUID is saved in a networked
351 room, it replaces any existing message with the same EUID *on every node in
354 Complexities arise primarily from the possibility of densely connected
355 networks: one does not wish to accumulate multiple copies of a given
356 message, which can easily happen. Nor does one want to see old messages
357 percolating indefinitely through the system.
359 This problem is handled by keeping track of the path a message has taken over
360 the network, like the UseNet news system does. When a system sends out a
361 message, it adds its own name to the bang-path in the <P> field of the
362 message. If no path field is present, it generates one.
364 With the path present, all the networker has to do to assure that it doesn't
365 send another system a message it's already received is check the <P>ath field
366 for that system's name somewhere in the bang path. If it's present, the system
367 has already seen the message, so we don't send it.
369 We also keep a small database, called the "use table," containing the ID's of
370 all messages we've seen recently. If the same message arrives a second or
371 subsequent time, we will find its ID in the use table, indicating that we
372 already have a copy of that message. It will therefore be discarded.
374 The above discussion should make the function of the fields reasonably clear:
376 o Travelling messages need to carry original message-id, system of origin,
377 date of origin, author, and path with them, to keep reproduction and
378 cycling under control.
380 (Uncoincidentally) the format used to transmit messages for networking
381 purposes is precisely that used on disk, serialized. The current
382 distribution includes serv_network.c, which is basically a database replicator;
383 please see network.txt on its operation and functionality (if any).
389 Citadel is 64-bit clean, architecture-independent, and Year 2000
390 compliant. The software should compile on any POSIX compliant system with
391 a full pthreads implementation and TCP/IP support. In the future we may
392 try to port it to non-POSIX systems as well.
394 On the client side, it's also POSIX compliant. The client even seems to
395 build ok on non-POSIX systems with porting libraries (such as Cygwin).
399 SUPPORTING PRIVATE MAIL
400 -----------------------
402 Can one have an elegant kludge? This must come pretty close.
404 Private mail is sent and recieved in the Mail> room, which otherwise
405 behaves pretty much as any other room. To make this work, we have a
406 separate Mail> room for each user behind the scenes. The actual room name
407 in the database looks like "0000001234.Mail" (where '1234' is the user
408 number) and it's flagged with the QR_MAILBOX flag. The user number is
409 stripped off by the server before the name is presented to the client. This
410 provides the ability to give each user a separate namespace for mailboxes
413 This requires a little fiddling to get things just right. For example,
414 make_message() has to be kludged to ask for the name of the recipient
415 of the message whenever a message is entered in Mail>. But basically
416 it works pretty well, keeping the code and user interface simple and
421 PASSWORDS AND NAME VALIDATION
422 -----------------------------
424 This has changed a couple of times over the course of Citadel's history. At
425 this point it's very simple, again due to the fact that record managers are
426 used for everything. The user file (user) is indexed using the user's
427 name, converted to all lower-case. Searching for a user, then, is easy. We
428 just lowercase the name we're looking for and query the database. If no
429 match is found, it is assumed that the user does not exist.
431 This makes it difficult to forge messages from an existing user. (Fine
432 point: nonprinting characters are converted to printing characters, and
433 leading, trailing, and double blanks are deleted.)