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 */
51 * Here's the big one... the Citadel context structure.
53 * This structure keeps track of all information relating to a running
54 * session on the server. We keep one of these for each session thread.
58 struct CitContext *prev; /* Link to previous session in list */
59 struct CitContext *next; /* Link to next session in the list */
61 int state; /* thread state (see CON_ values below) */
62 int kill_me; /* Set to nonzero to flag for termination */
64 int cs_pid; /* session ID */
65 int dont_term; /* for special activities like artv so we don't get killed */
66 time_t lastcmd; /* time of last command executed */
67 time_t lastidle; /* For computing idle time */
69 char curr_user[USERNAME_SIZE]; /* name of current user */
70 int logged_in; /* logged in */
71 int internal_pgm; /* authenticated as internal program */
72 int nologin; /* not allowed to log in */
73 int is_local_socket; /* set to 1 if client is on unix domain sock */
74 int curr_view; /* The view type for the current user/room */
75 int is_master; /* Is this session logged in using the master user? */
77 char net_node[32] ;/* Is the client another Citadel server? */
78 time_t previous_login; /* Date/time of previous login */
79 char lastcmdname[5]; /* name of last command executed */
80 unsigned cs_flags; /* miscellaneous flags */
81 void (*h_command_function) (void) ; /* service command function */
82 void (*h_async_function) (void) ; /* do async msgs function */
83 int is_async; /* Nonzero if client accepts async msgs */
84 int async_waiting; /* Nonzero if there are async msgs waiting */
85 int input_waiting; /* Nonzero if there is client input waiting */
87 /* Client information */
88 int cs_clientdev; /* client developer ID */
89 int cs_clienttyp; /* client type code */
90 int cs_clientver; /* client version number */
91 char cs_clientname[32]; /* name of client software */
92 char cs_host[64]; /* host logged in from */
93 char cs_addr[64]; /* address logged in from */
95 /* The Internet type of thing */
96 char cs_inet_email[128]; /* Return address of outbound Internet mail */
97 char cs_inet_other_emails[1024]; /* User's other valid Internet email addresses */
98 char cs_inet_fn[128]; /* Friendly-name of outbound Internet mail */
100 FILE *download_fp; /* Fields relating to file transfer */
101 char download_desired_section[128];
104 char upl_path[PATH_MAX];
105 char upl_comment[256];
106 char upl_filedir[PATH_MAX];
107 char upl_mimetype[64];
111 struct ctdluser user; /* Database record buffers */
112 struct ctdlroom room;
114 /* Beginning of cryptography - session nonce */
115 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
117 /* Redirect this session's output to a memory buffer? */
118 char *redirect_buffer; /* the buffer */
119 size_t redirect_len; /* length of data in buffer */
120 size_t redirect_alloc; /* length of allocated buffer */
127 char *output_buffer; /* hold output for one big dump */
130 /* A linked list of all instant messages sent to us. */
131 struct ExpressMessage *FirstExpressMessage;
132 int disable_exp; /* Set to 1 to disable incoming pages */
133 int newmail; /* Other sessions increment this */
135 /* Masqueraded values in the 'who is online' list */
136 char fake_username[USERNAME_SIZE];
137 char fake_hostname[64];
138 char fake_roomname[ROOMNAMELEN];
140 /* Preferred MIME formats */
141 char preferred_formats[256];
142 int msg4_dont_decode;
144 /* Dynamically allocated session data */
145 char *session_specific_data; /* Used by individual protocol modules */
146 struct cit_ical *CIT_ICAL; /* calendaring data */
147 struct ma_info *ma; /* multipart/alternative data */
148 const char *ServiceName; /* readable purpose of this session */
149 void *openid_data; /* Data stored by the OpenID module */
152 typedef struct CitContext t_context;
155 * Values for CitContext.state
157 * A session that is doing nothing is in CON_IDLE state. When activity
158 * is detected on the socket, it goes to CON_READY, indicating that it
159 * needs to have a worker thread bound to it. When a thread binds to
160 * the session, it goes to CON_EXECUTING and does its thing. When the
161 * transaction is finished, the thread sets it back to CON_IDLE and lets
165 CON_IDLE, /* This context is doing nothing */
166 CON_READY, /* This context needs attention */
167 CON_EXECUTING /* This context is bound to a thread */
171 #define CS_STEALTH 1 /* stealth mode */
172 #define CS_CHAT 2 /* chat mode */
173 #define CS_POSTING 4 /* Posting */
175 struct CitContext *MyContext(void);
176 #define CC MyContext()
179 * This is the control record for the message base...
182 long MMhighest; /* highest message number in file */
183 unsigned MMflags; /* Global system flags */
184 long MMnextuser; /* highest user number on system */
185 long MMnextroom; /* highest room number on system */
186 int version; /* Server-hosted upgrade level */
187 int fulltext_wordbreaker; /* ID of wordbreaker in use */
188 long MMfulltext; /* highest message number indexed */
189 int MMdbversion; /* Version of Berkeley DB used on previous server run */
192 extern struct CitContext *ContextList;
193 extern int ScheduledShutdown;
194 extern struct CitControl CitControl;
196 struct ExpressMessage {
197 struct ExpressMessage *next;
198 time_t timestamp; /* When this message was sent */
199 unsigned flags; /* Special instructions */
200 char sender[256]; /* Name of sending user */
201 char sender_email[256]; /* Email or JID of sending user */
202 char *text; /* Message text (if applicable) */
205 #define EM_BROADCAST 1 /* Broadcast message */
206 #define EM_GO_AWAY 2 /* Server requests client log off */
207 #define EM_CHAT 4 /* Server requests client enter chat */
210 struct ChatLine *next;
214 char chat_username[USERNAME_SIZE];
215 char chat_room[ROOMNAMELEN];
219 * Various things we need to lock and unlock
261 * message transfer formats
264 MT_CITADEL, /* Citadel proprietary */
265 MT_RFC822, /* RFC822 */
266 MT_MIME, /* MIME-formatted message */
267 MT_DOWNLOAD, /* Download a component */
268 MT_SPEW_SECTION /* Download a component in a single operation */
272 * Message format types in the database
274 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
275 #define FMT_FIXED 1 /* Fixed format (proprietary) */
276 #define FMT_RFC822 4 /* Standard (headers are in M field) */
280 * Citadel DataBases (define one for each cdb we need to open)
283 CDB_MSGMAIN, /* message base */
284 CDB_USERS, /* user file */
285 CDB_ROOMS, /* room index */
286 CDB_FLOORTAB, /* floor index */
287 CDB_MSGLISTS, /* room message lists */
288 CDB_VISIT, /* user/room relationships */
289 CDB_DIRECTORY, /* address book directory */
290 CDB_USETABLE, /* network use table */
291 CDB_BIGMSGS, /* larger message bodies */
292 CDB_FULLTEXT, /* full text search index */
293 CDB_EUIDINDEX, /* locate msgs by EUID */
294 CDB_USERSBYNUMBER, /* index of users by number */
295 CDB_OPENID, /* associates OpenIDs with users */
296 MAXCDB /* total number of CDB's defined */
306 * Event types can't be enum'ed, because they must remain consistent between
307 * builds (to allow for binary modules built somewhere else)
309 #define EVT_STOP 0 /* Session is terminating */
310 #define EVT_START 1 /* Session is starting */
311 #define EVT_LOGIN 2 /* A user is logging in */
312 #define EVT_NEWROOM 3 /* Changing rooms */
313 #define EVT_LOGOUT 4 /* A user is logging out */
314 #define EVT_SETPASS 5 /* Setting or changing password */
315 #define EVT_CMD 6 /* Called after each server command */
316 #define EVT_RWHO 7 /* An RWHO command is being executed */
317 #define EVT_ASYNC 8 /* Doing asynchronous messages */
318 #define EVT_STEALTH 9 /* Entering stealth mode */
319 #define EVT_UNSTEALTH 10 /* Exiting stealth mode */
321 #define EVT_TIMER 50 /* Timer events are called once per minute
322 and are not tied to any session */
323 #define EVT_HOUSE 51 /* as needed houskeeping stuff */
325 #define EVT_PURGEUSER 100 /* Deleting a user */
326 #define EVT_NEWUSER 102 /* Creating a user */
328 #define EVT_BEFOREREAD 200
329 #define EVT_BEFORESAVE 201
330 #define EVT_AFTERSAVE 202
331 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
332 /* Priority levels for paging functions (lower is better) */
334 XMSG_PRI_LOCAL, /* Other users on -this- server */
335 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
336 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
341 /* Defines the relationship of a user to a particular room */
347 unsigned int v_flags;
349 char v_answered[SIZ];
353 #define V_FORGET 1 /* User has zapped this room */
354 #define V_LOCKOUT 2 /* User is locked out of this room */
355 #define V_ACCESS 4 /* Access is granted to this room */
358 /* Supplementary data for a message on disk
359 * These are kept separate from the message itself for one of two reasons:
360 * 1. Either their values may change at some point after initial save, or
361 * 2. They are merely caches of data which exist somewhere else, for speed.
364 long meta_msgnum; /* Message number in *local* message base */
365 int meta_refcount; /* Number of rooms pointing to this msg */
366 char meta_content_type[64]; /* Cached MIME content-type */
367 long meta_rfc822_length; /* Cache of RFC822-translated msg length */
368 char mimetype[64]; /* if we were able to guess the mimetype for the data */
371 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
372 * have to wait for various disk-intensive operations to complete synchronously.
373 * This is the record format.
376 long arcq_msgnum; /* Message number being adjusted */
377 int arcq_delta; /* Adjustment ( usually 1 or -1 ) */
382 * Serialization routines use this struct to return a pointer and a length
391 * The S_USETABLE database is used in several modules now, so we define its format here.
400 /* Preferred field order */
401 /* ********** Important fields */
402 /* *************** Semi-important fields */
403 /* * Message text (MUST be last) */
404 #define FORDER "IPTAFONHRDBCEWJGKLQSVXZYUM"
406 #endif /* SERVER_H */