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