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