8 #define INLINE __inline__
15 #define OPENSSL_NO_KRB5 /* work around redhat b0rken ssl headers */
16 #include <openssl/ssl.h>
20 * New format for a message in memory
23 int cm_magic; /* Self-check (NOT SAVED TO DISK) */
24 char cm_anon_type; /* Anonymous or author-visible */
25 char cm_format_type; /* Format type */
26 char *cm_fields[256]; /* Data fields */
27 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
30 #define CTDLMESSAGE_MAGIC 0x159d
31 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
36 * Exit codes 101 through 109 are used for conditions in which
37 * we deliberately do NOT want the service to automatically
40 #define CTDLEXIT_CONFIG 101 /* Could not read citadel.config */
41 #define CTDLEXIT_CONTROL 102 /* Could not acquire lock */
42 #define CTDLEXIT_HOME 103 /* Citadel home directory not found */
43 #define CTDLEXIT_OOD 104 /* Out Of Date config - rerun setup */
44 #define CTDLEXIT_DB 105 /* Unable to initialize database */
45 #define CTDLEXIT_LIBCITADEL 106 /* Incorrect version of libcitadel */
46 #define CTDLEXIT_SHUTDOWN 150 /* we're going down. watcher don't
54 * Here's the big one... the Citadel context structure.
56 * This structure keeps track of all information relating to a running
57 * session on the server. We keep one of these for each session thread.
61 struct CitContext *prev; /* Link to previous session in list */
62 struct CitContext *next; /* Link to next session in the list */
64 int state; /* thread state (see CON_ values below) */
65 int kill_me; /* Set to nonzero to flag for termination */
67 int cs_pid; /* session ID */
68 int dont_term; /* for special activities like artv so we don't get killed */
69 time_t lastcmd; /* time of last command executed */
70 time_t lastidle; /* For computing idle time */
72 char curr_user[USERNAME_SIZE]; /* name of current user */
73 int logged_in; /* logged in */
74 int internal_pgm; /* authenticated as internal program */
75 int nologin; /* not allowed to log in */
76 int is_local_socket; /* set to 1 if client is on unix domain sock */
77 int curr_view; /* The view type for the current user/room */
78 int is_master; /* Is this session logged in using the master user? */
80 char net_node[32] ;/* Is the client another Citadel server? */
81 time_t previous_login; /* Date/time of previous login */
82 char lastcmdname[5]; /* name of last command executed */
83 unsigned cs_flags; /* miscellaneous flags */
84 void (*h_command_function) (void) ; /* service command function */
85 void (*h_async_function) (void) ; /* do async msgs function */
86 int is_async; /* Nonzero if client accepts async msgs */
87 int async_waiting; /* Nonzero if there are async msgs waiting */
88 int input_waiting; /* Nonzero if there is client input waiting */
90 /* Client information */
91 int cs_clientdev; /* client developer ID */
92 int cs_clienttyp; /* client type code */
93 int cs_clientver; /* client version number */
94 char cs_clientname[32]; /* name of client software */
95 char cs_host[64]; /* host logged in from */
96 char cs_addr[64]; /* address logged in from */
98 /* The Internet type of thing */
99 char cs_inet_email[128]; /* Return address of outbound Internet mail */
100 char cs_inet_other_emails[1024]; /* User's other valid Internet email addresses */
101 char cs_inet_fn[128]; /* Friendly-name of outbound Internet mail */
103 FILE *download_fp; /* Fields relating to file transfer */
104 char download_desired_section[128];
107 char upl_path[PATH_MAX];
108 char upl_comment[256];
109 char upl_filedir[PATH_MAX];
110 char upl_mimetype[64];
114 struct ctdluser user; /* Database record buffers */
115 struct ctdlroom room;
117 /* Beginning of cryptography - session nonce */
118 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
120 /* Redirect this session's output to a memory buffer? */
121 char *redirect_buffer; /* the buffer */
122 size_t redirect_len; /* length of data in buffer */
123 size_t redirect_alloc; /* length of allocated buffer */
129 /* A linked list of all instant messages sent to us. */
130 struct ExpressMessage *FirstExpressMessage;
131 int disable_exp; /* Set to 1 to disable incoming pages */
132 int newmail; /* Other sessions increment this */
134 /* Masqueraded values in the 'who is online' list */
135 char fake_username[USERNAME_SIZE];
136 char fake_hostname[64];
137 char fake_roomname[ROOMNAMELEN];
139 /* Preferred MIME formats */
140 char preferred_formats[256];
141 int msg4_dont_decode;
143 /* Dynamically allocated session data */
144 char *session_specific_data; /* Used by individual protocol modules */
145 struct cit_ical *CIT_ICAL; /* calendaring data */
146 struct ma_info *ma; /* multipart/alternative data */
147 const char *ServiceName; /* readable purpose of this session */
148 void *openid_data; /* Data stored by the OpenID module */
151 typedef struct CitContext t_context;
154 * Values for CitContext.state
156 * A session that is doing nothing is in CON_IDLE state. When activity
157 * is detected on the socket, it goes to CON_READY, indicating that it
158 * needs to have a worker thread bound to it. When a thread binds to
159 * the session, it goes to CON_EXECUTING and does its thing. When the
160 * transaction is finished, the thread sets it back to CON_IDLE and lets
164 CON_IDLE, /* This context is doing nothing */
165 CON_READY, /* This context needs attention */
166 CON_EXECUTING /* This context is bound to a thread */
170 #define CS_STEALTH 1 /* stealth mode */
171 #define CS_CHAT 2 /* chat mode */
172 #define CS_POSTING 4 /* Posting */
174 struct CitContext *MyContext(void);
175 #define CC MyContext()
178 * This is the control record for the message base...
181 long MMhighest; /* highest message number in file */
182 unsigned MMflags; /* Global system flags */
183 long MMnextuser; /* highest user number on system */
184 long MMnextroom; /* highest room number on system */
185 int version; /* Server-hosted upgrade level */
186 int fulltext_wordbreaker; /* ID of wordbreaker in use */
187 long MMfulltext; /* highest message number indexed */
188 int MMdbversion; /* Version of Berkeley DB used on previous server run */
191 extern struct CitContext *ContextList;
192 extern int ScheduledShutdown;
193 extern struct CitControl CitControl;
195 struct ExpressMessage {
196 struct ExpressMessage *next;
197 time_t timestamp; /* When this message was sent */
198 unsigned flags; /* Special instructions */
199 char sender[256]; /* Name of sending user */
200 char sender_email[256]; /* Email or JID of sending user */
201 char *text; /* Message text (if applicable) */
204 #define EM_BROADCAST 1 /* Broadcast message */
205 #define EM_GO_AWAY 2 /* Server requests client log off */
206 #define EM_CHAT 4 /* Server requests client enter chat */
209 struct ChatLine *next;
213 char chat_username[USERNAME_SIZE];
214 char chat_room[ROOMNAMELEN];
218 * Various things we need to lock and unlock
262 * message transfer formats
265 MT_CITADEL, /* Citadel proprietary */
266 MT_RFC822, /* RFC822 */
267 MT_MIME, /* MIME-formatted message */
268 MT_DOWNLOAD, /* Download a component */
269 MT_SPEW_SECTION /* Download a component in a single operation */
273 * Message format types in the database
275 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
276 #define FMT_FIXED 1 /* Fixed format (proprietary) */
277 #define FMT_RFC822 4 /* Standard (headers are in M field) */
281 * Citadel DataBases (define one for each cdb we need to open)
284 CDB_MSGMAIN, /* message base */
285 CDB_USERS, /* user file */
286 CDB_ROOMS, /* room index */
287 CDB_FLOORTAB, /* floor index */
288 CDB_MSGLISTS, /* room message lists */
289 CDB_VISIT, /* user/room relationships */
290 CDB_DIRECTORY, /* address book directory */
291 CDB_USETABLE, /* network use table */
292 CDB_BIGMSGS, /* larger message bodies */
293 CDB_FULLTEXT, /* full text search index */
294 CDB_EUIDINDEX, /* locate msgs by EUID */
295 CDB_USERSBYNUMBER, /* index of users by number */
296 CDB_OPENID, /* associates OpenIDs with users */
297 MAXCDB /* total number of CDB's defined */
307 * Event types can't be enum'ed, because they must remain consistent between
308 * builds (to allow for binary modules built somewhere else)
310 #define EVT_STOP 0 /* Session is terminating */
311 #define EVT_START 1 /* Session is starting */
312 #define EVT_LOGIN 2 /* A user is logging in */
313 #define EVT_NEWROOM 3 /* Changing rooms */
314 #define EVT_LOGOUT 4 /* A user is logging out */
315 #define EVT_SETPASS 5 /* Setting or changing password */
316 #define EVT_CMD 6 /* Called after each server command */
317 #define EVT_RWHO 7 /* An RWHO command is being executed */
318 #define EVT_ASYNC 8 /* Doing asynchronous messages */
319 #define EVT_STEALTH 9 /* Entering stealth mode */
320 #define EVT_UNSTEALTH 10 /* Exiting stealth mode */
322 #define EVT_TIMER 50 /* Timer events are called once per minute
323 and are not tied to any session */
324 #define EVT_HOUSE 51 /* as needed houskeeping stuff */
326 #define EVT_PURGEUSER 100 /* Deleting a user */
327 #define EVT_NEWUSER 102 /* Creating a user */
329 #define EVT_BEFOREREAD 200
330 #define EVT_BEFORESAVE 201
331 #define EVT_AFTERSAVE 202
332 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
333 /* Priority levels for paging functions (lower is better) */
335 XMSG_PRI_LOCAL, /* Other users on -this- server */
336 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
337 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
342 /* Defines the relationship of a user to a particular room */
348 unsigned int v_flags;
350 char v_answered[SIZ];
354 #define V_FORGET 1 /* User has zapped this room */
355 #define V_LOCKOUT 2 /* User is locked out of this room */
356 #define V_ACCESS 4 /* Access is granted to this room */
359 /* Supplementary data for a message on disk
360 * These are kept separate from the message itself for one of two reasons:
361 * 1. Either their values may change at some point after initial save, or
362 * 2. They are merely caches of data which exist somewhere else, for speed.
365 long meta_msgnum; /* Message number in *local* message base */
366 int meta_refcount; /* Number of rooms pointing to this msg */
367 char meta_content_type[64]; /* Cached MIME content-type */
368 long meta_rfc822_length; /* Cache of RFC822-translated msg length */
369 char mimetype[64]; /* if we were able to guess the mimetype for the data */
372 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
373 * have to wait for various disk-intensive operations to complete synchronously.
374 * This is the record format.
377 long arcq_msgnum; /* Message number being adjusted */
378 int arcq_delta; /* Adjustment ( usually 1 or -1 ) */
383 * Serialization routines use this struct to return a pointer and a length
392 * The S_USETABLE database is used in several modules now, so we define its format here.
401 /* Preferred field order */
402 /* ********** Important fields */
403 /* *************** Semi-important fields */
404 /* * Message text (MUST be last) */
405 #define FORDER "IPTAFONHRDBCEWJGKLQSVXZYUM"
407 #endif /* SERVER_H */