X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fcontext.h;h=65c7515f4f184265e8bb443f6b2ca747bfe9add6;hb=58c77aea1dda7b206b900bafb9278237456ef737;hp=ddf8d6ca136f57d8c550eb969ce46a6d2f9e8d9f;hpb=076aaf225bd8a8713cb16c99463f46518e20f118;p=citadel.git diff --git a/citadel/context.h b/citadel/context.h index ddf8d6ca1..65c7515f4 100644 --- a/citadel/context.h +++ b/citadel/context.h @@ -1,4 +1,3 @@ -/* $Id: sysdep_decls.h 7265 2009-03-25 23:18:46Z dothebart $ */ #ifndef CONTEXT_H #define CONTEXT_H @@ -11,49 +10,68 @@ /* - * Here's the big one... the Citadel context structure. - * + * Values for CitContext.state + * + * A session that is doing nothing is in CON_IDLE state. When activity + * is detected on the socket, it goes to CON_READY, indicating that it + * needs to have a worker thread bound to it. When a thread binds to + * the session, it goes to CON_EXECUTING and does its thing. When the + * transaction is finished, the thread sets it back to CON_IDLE and lets + * it go. + */ +typedef enum __CCState { + CON_IDLE, /* This context is doing nothing */ + CON_GREETING, /* This context needs to output its greeting */ + CON_STARTING, /* This context is outputting its greeting */ + CON_READY, /* This context needs attention */ + CON_EXECUTING, /* This context is bound to a thread */ + CON_SYS /* This is a system context and mustn't be purged */ +} CCState; + +#ifndef __CIT_CONTEXT__ +#define __CIT_CONTEXT__ +typedef struct CitContext CitContext; +#endif + +/* * This structure keeps track of all information relating to a running - * session on the server. We keep one of these for each session thread. - * + * session on the server. We keep one of these for each session. */ struct CitContext { - struct CitContext *prev; /* Link to previous session in list */ - struct CitContext *next; /* Link to next session in the list */ + CitContext *prev; /* Link to previous session in list */ + CitContext *next; /* Link to next session in the list */ int cs_pid; /* session ID */ - int dont_term; /* for special activities like artv so we don't get killed */ + int dont_term; /* for special activities like artv so we don't get killed */ + double created; /* time of birth */ time_t lastcmd; /* time of last command executed */ time_t lastidle; /* For computing idle time */ - int state; /* thread state (see CON_ values below) */ + CCState state; /* thread state (see CON_ values below) */ int kill_me; /* Set to nonzero to flag for termination */ - const char *Pos; /* Our read position inside of the ReadBuf */ - StrBuf *ReadBuf; /* Our block buffered read buffer */ - StrBuf *MigrateBuf; /* Our block buffered read buffer */ + IOBuffer SendBuf, /* Our write Buffer */ + RecvBuf, /* Our block buffered read buffer */ + SBuf; /* Our block buffered read buffer for clients */ + + StrBuf *MigrateBuf; /* Our block buffered read buffer */ + StrBuf *sMigrateBuf; /* Our block buffered read buffer */ - const char *sPos; /* Our read position inside of the ReadBuf */ - StrBuf *sReadBuf; /* Our block buffered read buffer */ - StrBuf *sMigrateBuf; /* Our block buffered read buffer */ int client_socket; int is_local_socket; /* set to 1 if client is on unix domain sock */ /* Redirect this session's output to a memory buffer? */ - char *redirect_buffer; /* the buffer */ - size_t redirect_len; /* length of data in buffer */ - size_t redirect_alloc; /* length of allocated buffer */ + StrBuf *redirect_buffer; /* the buffer */ + StrBuf *StatusMessage; #ifdef HAVE_OPENSSL SSL *ssl; int redirect_ssl; #endif char curr_user[USERNAME_SIZE]; /* name of current user */ - int logged_in; /* logged in */ - int internal_pgm; /* authenticated as internal program */ + int logged_in; /* logged in? */ + int internal_pgm; /* authenticated as internal program? */ int nologin; /* not allowed to log in */ int curr_view; /* The view type for the current user/room */ - int is_master; /* Is this session logged in using the master user? */ - char net_node[32] ;/* Is the client another Citadel server? */ time_t previous_login; /* Date/time of previous login */ char lastcmdname[5]; /* name of last command executed */ unsigned cs_flags; /* miscellaneous flags */ @@ -66,6 +84,7 @@ struct CitContext { int cs_clientdev; /* client developer ID */ int cs_clienttyp; /* client type code */ int cs_clientver; /* client version number */ + char cs_clientinfo[256];/* if its a unix domain socket, some info for logging. */ uid_t cs_UDSclientUID; /* the uid of the client when talking via UDS */ char cs_clientname[32]; /* name of client software */ char cs_host[64]; /* host logged in from */ @@ -85,68 +104,41 @@ struct CitContext { char upl_comment[256]; char upl_filedir[PATH_MAX]; char upl_mimetype[64]; - char dl_is_net; - char upload_type; struct ctdluser user; /* Database record buffers */ struct ctdlroom room; - /* Beginning of cryptography - session nonce */ - char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */ - - /* A linked list of all instant messages sent to us. */ struct ExpressMessage *FirstExpressMessage; int disable_exp; /* Set to 1 to disable incoming pages */ int newmail; /* Other sessions increment this */ - /* Masqueraded values in the 'who is online' list */ - char fake_username[USERNAME_SIZE]; - char fake_hostname[64]; - char fake_roomname[ROOMNAMELEN]; - /* Preferred MIME formats */ char preferred_formats[256]; int msg4_dont_decode; /* Dynamically allocated session data */ - char *session_specific_data; /* Used by individual protocol modules */ + void *session_specific_data; /* Used by individual protocol modules */ struct cit_ical *CIT_ICAL; /* calendaring data */ struct ma_info *ma; /* multipart/alternative data */ const char *ServiceName; /* readable purpose of this session */ + long tcp_port; void *openid_data; /* Data stored by the OpenID module */ char *ldap_dn; /* DN of user when using AUTHMODE_LDAP */ - void (*h_command_function) (void) ; /* service command function */ void (*h_async_function) (void) ; /* do async msgs function */ void (*h_greeting_function) (void) ; /* greeting function for session startup */ -}; -typedef struct CitContext CitContext; + long *cached_msglist; /* results of the previous CtdlForEachMessage() */ + int cached_num_msgs; -/* - * Values for CitContext.state - * - * A session that is doing nothing is in CON_IDLE state. When activity - * is detected on the socket, it goes to CON_READY, indicating that it - * needs to have a worker thread bound to it. When a thread binds to - * the session, it goes to CON_EXECUTING and does its thing. When the - * transaction is finished, the thread sets it back to CON_IDLE and lets - * it go. - */ -enum { - CON_IDLE, /* This context is doing nothing */ - CON_GREETING, /* This context needs to output its greeting */ - CON_STARTING, /* This context is outputting its greeting */ - CON_READY, /* This context needs attention */ - CON_EXECUTING /* This context is bound to a thread */ + char vcard_updated_by_ldap; /* !0 iff ldap changed the vcard, treat as aide update */ }; #define CC MyContext() - -extern citthread_key_t MyConKey; /* TSD key for MyContext() */ +extern pthread_key_t MyConKey; /* TSD key for MyContext() */ extern int num_sessions; extern CitContext masterCC; extern CitContext *ContextList; @@ -156,11 +148,15 @@ void RemoveContext (struct CitContext *); CitContext *CreateNewContext (void); void context_cleanup(void); void kill_session (int session_to_kill); -INLINE void become_session(struct CitContext *which_con); void InitializeMasterCC(void); void dead_session_purge(int force); void set_async_waiting(struct CitContext *ccptr); +CitContext *CloneContext(CitContext *CloneMe); + +/* forcibly close and flush fd's on shutdown */ +void terminate_all_sessions(void); + /* Deprecated, user CtdlBumpNewMailCounter() instead */ void BumpNewMailCounter(long) __attribute__ ((deprecated)); @@ -171,4 +167,12 @@ int CtdlTerminateOtherSession (int session_num); #define TERM_ALLOWED 0x02 #define TERM_KILLED 0x03 #define TERM_NOTALLOWED -1 + +/* + * Bind a thread to a context. (It's inline merely to speed things up.) + */ +static INLINE void become_session(CitContext *which_con) { + pthread_setspecific(MyConKey, (void *)which_con ); +} + #endif /* CONTEXT_H */