1 /* $Id: sysdep_decls.h 7265 2009-03-25 23:18:46Z dothebart $ */
9 #include "sysdep_decls.h"
14 * Here's the big one... the Citadel context structure.
16 * This structure keeps track of all information relating to a running
17 * session on the server. We keep one of these for each session thread.
21 struct CitContext *prev; /* Link to previous session in list */
22 struct CitContext *next; /* Link to next session in the list */
24 int cs_pid; /* session ID */
25 int dont_term; /* for special activities like artv so we don't get killed */
26 time_t lastcmd; /* time of last command executed */
27 time_t lastidle; /* For computing idle time */
28 int state; /* thread state (see CON_ values below) */
29 int kill_me; /* Set to nonzero to flag for termination */
33 const char *Pos; /* Our read position inside of the ReadBuf */
34 StrBuf *ReadBuf; /* Our block buffered read buffer */
35 StrBuf *MigrateBuf; /* Our block buffered read buffer */
37 const char *sPos; /* Our read position inside of the ReadBuf */
38 StrBuf *sReadBuf; /* Our block buffered read buffer */
39 StrBuf *sMigrateBuf; /* Our block buffered read buffer */
41 int is_local_socket; /* set to 1 if client is on unix domain sock */
42 /* Redirect this session's output to a memory buffer? */
43 StrBuf *redirect_buffer; /* the buffer */
49 char curr_user[USERNAME_SIZE]; /* name of current user */
50 int logged_in; /* logged in */
51 int internal_pgm; /* authenticated as internal program */
52 int nologin; /* not allowed to log in */
53 int curr_view; /* The view type for the current user/room */
54 int is_master; /* Is this session logged in using the master user? */
56 char net_node[32] ;/* Is the client another Citadel server? */
57 time_t previous_login; /* Date/time of previous login */
58 char lastcmdname[5]; /* name of last command executed */
59 unsigned cs_flags; /* miscellaneous flags */
60 int is_async; /* Nonzero if client accepts async msgs */
61 int async_waiting; /* Nonzero if there are async msgs waiting */
62 int input_waiting; /* Nonzero if there is client input waiting */
63 int can_receive_im; /* Session is capable of receiving instant messages */
65 /* Client information */
66 int cs_clientdev; /* client developer ID */
67 int cs_clienttyp; /* client type code */
68 int cs_clientver; /* client version number */
69 uid_t cs_UDSclientUID; /* the uid of the client when talking via UDS */
70 char cs_clientname[32]; /* name of client software */
71 char cs_host[64]; /* host logged in from */
72 char cs_addr[64]; /* address logged in from */
74 /* The Internet type of thing */
75 char cs_inet_email[128]; /* Return address of outbound Internet mail */
76 char cs_inet_other_emails[1024]; /* User's other valid Internet email addresses */
77 char cs_inet_fn[128]; /* Friendly-name of outbound Internet mail */
79 FILE *download_fp; /* Fields relating to file transfer */
80 char download_desired_section[128];
83 char upl_path[PATH_MAX];
84 char upl_comment[256];
85 char upl_filedir[PATH_MAX];
86 char upl_mimetype[64];
90 struct ctdluser user; /* Database record buffers */
93 /* Beginning of cryptography - session nonce */
94 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
97 /* A linked list of all instant messages sent to us. */
98 struct ExpressMessage *FirstExpressMessage;
99 int disable_exp; /* Set to 1 to disable incoming pages */
100 int newmail; /* Other sessions increment this */
102 /* Masqueraded values in the 'who is online' list */
103 char fake_username[USERNAME_SIZE];
104 char fake_hostname[64];
105 char fake_roomname[ROOMNAMELEN];
107 /* Preferred MIME formats */
108 char preferred_formats[256];
109 int msg4_dont_decode;
111 /* Dynamically allocated session data */
112 char *session_specific_data; /* Used by individual protocol modules */
113 struct cit_ical *CIT_ICAL; /* calendaring data */
114 struct ma_info *ma; /* multipart/alternative data */
115 const char *ServiceName; /* readable purpose of this session */
116 void *openid_data; /* Data stored by the OpenID module */
117 char *ldap_dn; /* DN of user when using AUTHMODE_LDAP */
120 void (*h_command_function) (void) ; /* service command function */
121 void (*h_async_function) (void) ; /* do async msgs function */
122 void (*h_greeting_function) (void) ; /* greeting function for session startup */
125 typedef struct CitContext CitContext;
128 * Values for CitContext.state
130 * A session that is doing nothing is in CON_IDLE state. When activity
131 * is detected on the socket, it goes to CON_READY, indicating that it
132 * needs to have a worker thread bound to it. When a thread binds to
133 * the session, it goes to CON_EXECUTING and does its thing. When the
134 * transaction is finished, the thread sets it back to CON_IDLE and lets
138 CON_IDLE, /* This context is doing nothing */
139 CON_GREETING, /* This context needs to output its greeting */
140 CON_STARTING, /* This context is outputting its greeting */
141 CON_READY, /* This context needs attention */
142 CON_EXECUTING /* This context is bound to a thread */
145 #define CC MyContext()
148 extern citthread_key_t MyConKey; /* TSD key for MyContext() */
149 extern int num_sessions;
150 extern CitContext masterCC;
151 extern CitContext *ContextList;
153 CitContext *MyContext (void);
154 void RemoveContext (struct CitContext *);
155 CitContext *CreateNewContext (void);
156 void context_cleanup(void);
157 void kill_session (int session_to_kill);
158 void InitializeMasterCC(void);
159 void dead_session_purge(int force);
160 void set_async_waiting(struct CitContext *ccptr);
162 /* Deprecated, user CtdlBumpNewMailCounter() instead */
163 void BumpNewMailCounter(long) __attribute__ ((deprecated));
165 void terminate_idle_sessions(void);
166 int CtdlTerminateOtherSession (int session_num);
167 /* bits returned by CtdlTerminateOtherSession */
168 #define TERM_FOUND 0x01
169 #define TERM_ALLOWED 0x02
170 #define TERM_KILLED 0x03
171 #define TERM_NOTALLOWED -1
174 * Bind a thread to a context. (It's inline merely to speed things up.)
176 static INLINE void become_session(CitContext *which_con) {
178 pid_t tid = syscall(SYS_gettid);
180 citthread_setspecific(MyConKey, (void *)which_con );
182 CtdlLogPrintf(CTDL_DEBUG, "[%d]: Now doing %s\n",
184 ((which_con != NULL) && (which_con->ServiceName != NULL)) ?
185 which_con->ServiceName:"");
190 #endif /* CONTEXT_H */