citadel/server/context.h

   1
   2 #ifndef CONTEXT_H
   3 #define CONTEXT_H
   4
   5 #include <stdarg.h>
   6 #include "sysdep.h"
   7 #include "server.h"
   8 #include "sysdep_decls.h"
   9 #include "threads.h"
  10
  11
  12 // Values for CitContext.state
  13 //
  14 // A session that is doing nothing is in CON_IDLE state.  When activity
  15 // is detected on the socket, it goes to CON_READY, indicating that it
  16 // needs to have a worker thread bound to it.  When a thread binds to
  17 // the session, it goes to CON_EXECUTING and does its thing.  When the
  18 // transaction is finished, the thread sets it back to CON_IDLE and lets
  19 // it go.
  20 typedef enum __CCState {
  21         CON_IDLE,               // This context is doing nothing
  22         CON_GREETING,           // This context needs to output its greeting
  23         CON_STARTING,           // This context is outputting its greeting
  24         CON_READY,              // This context needs attention
  25         CON_EXECUTING,          // This context is bound to a thread
  26         CON_SYS                 // This is a system context and mustn't be purged
  27 } CCState;
  28
  29 #ifndef __CIT_CONTEXT__
  30 #define __CIT_CONTEXT__
  31 typedef struct CitContext CitContext;
  32 #endif
  33
  34 // This structure keeps track of all information relating to a running
  35 // session on the server.  We keep one of these for each session.
  36 struct CitContext {
  37         CitContext *prev;       /* Link to previous session in list */
  38         CitContext *next;       /* Link to next session in the list */
  39
  40         int cs_pid;             /* session ID */
  41         int dont_term;          /* for special activities like artv so we don't get killed */
  42         double created;         /* time of birth */
  43         time_t lastcmd;         /* time of last command executed */
  44         time_t lastidle;        /* For computing idle time */
  45         CCState state;          /* thread state (see CON_ values below) */
  46         int kill_me;            /* Set to nonzero to flag for termination */
  47
  48         IOBuffer SendBuf,       /* Our write Buffer */
  49                 RecvBuf,        /* Our block buffered read buffer */
  50                 SBuf;           /* Our block buffered read buffer for clients */
  51
  52         StrBuf *MigrateBuf;     /* Our block buffered read buffer */
  53         StrBuf *sMigrateBuf;    /* Our block buffered read buffer */
  54
  55         int client_socket;
  56         int is_local_client;    /* set to 1 if client is running on the same host */
  57         /* Redirect this session's output to a memory buffer? */
  58         StrBuf *redirect_buffer;                /* the buffer */
  59         StrBuf *StatusMessage;
  60 #ifdef HAVE_OPENSSL
  61         SSL *ssl;
  62         int redirect_ssl;
  63 #endif
  64
  65         char curr_user[USERNAME_SIZE];  /* name of current user */
  66         int logged_in;          /* logged in? */
  67         int internal_pgm;       /* authenticated as internal program? */
  68         int nologin;            /* not allowed to log in */
  69         int curr_view;          /* The view type for the current user/room */
  70
  71         time_t previous_login;  /* Date/time of previous login */
  72         char lastcmdname[5];    /* name of last command executed */
  73         unsigned cs_flags;      /* miscellaneous flags */
  74         int is_async;           /* Nonzero if client accepts async msgs */
  75         int async_waiting;      /* Nonzero if there are async msgs waiting */
  76         int input_waiting;      /* Nonzero if there is client input waiting */
  77         int can_receive_im;     /* Session is capable of receiving instant messages */
  78
  79         /* Client information */
  80         int cs_clientdev;       /* client developer ID */
  81         int cs_clienttyp;       /* client type code */
  82         int cs_clientver;       /* client version number */
  83         char cs_clientinfo[256];/* if its a unix domain socket, some info for logging. */
  84         uid_t cs_UDSclientUID;  /* the uid of the client when talking via UDS */
  85         char cs_clientname[32]; /* name of client software */
  86         char cs_host[64];       /* host logged in from */
  87         char cs_addr[64];       /* address logged in from */
  88
  89         /* The Internet type of thing */
  90         char cs_principal_id[256];              /* User principal identity for XMPP, ActivityPub, etc. */
  91         char cs_inet_email[128];                /* Return address of outbound Internet mail */
  92         char cs_inet_other_emails[1024];        /* User's other valid Internet email addresses */
  93         char cs_inet_fn[128];                   /* Friendly-name of outbound Internet mail */
  94
  95         FILE *download_fp;      /* Fields relating to file transfer */
  96         size_t download_fp_total;
  97         char download_desired_section[128];
  98         FILE *upload_fp;
  99         char upl_file[256];
 100         char upl_path[PATH_MAX];
 101         char upl_comment[256];
 102         char upl_filedir[PATH_MAX];
 103         char upl_mimetype[64];
 104
 105         struct ctdluser user;   /* Database record buffers */
 106         struct ctdlroom room;
 107
 108         /* A linked list of all instant messages sent to us. */
 109         struct ExpressMessage *FirstExpressMessage;
 110         int disable_exp;        /* Set to 1 to disable incoming pages */
 111         int newmail;            /* Other sessions increment this */
 112
 113         /* Preferred MIME formats */
 114         char preferred_formats[256];
 115         int msg4_dont_decode;
 116
 117         /* Dynamically allocated session data */
 118         void *session_specific_data;            /* Used by individual protocol modules */
 119         struct cit_ical *CIT_ICAL;              /* calendaring data */
 120         struct ma_info *ma;                     /* multipart/alternative data */
 121         const char *ServiceName;                /* readable purpose of this session */
 122         long tcp_port;
 123         char *ldap_dn;                          /* DN of user when using AUTHMODE_LDAP */
 124
 125         void (*h_command_function) (void) ;     /* service command function */
 126         void (*h_async_function) (void) ;       /* do async msgs function */
 127         void (*h_greeting_function) (void) ;    /* greeting function for session startup */
 128
 129         long *cached_msglist;                   /* results of the previous CtdlForEachMessage() */
 130         int cached_num_msgs;
 131
 132         char vcard_updated_by_ldap;             /* !0 iff ldap changed the vcard, treat as aide update */
 133 };
 134
 135 #define CC MyContext()
 136
 137 extern pthread_key_t MyConKey;                  /* TSD key for MyContext() */
 138 extern int num_sessions;
 139 extern CitContext masterCC;
 140 extern CitContext *ContextList;
 141
 142 CitContext *MyContext (void);
 143 void RemoveContext (struct CitContext *);
 144 CitContext *CreateNewContext (void);
 145 void context_cleanup(void);
 146 void kill_session (int session_to_kill);
 147 void InitializeMasterCC(void);
 148 void dead_session_purge(int force);
 149 void set_async_waiting(struct CitContext *ccptr);
 150
 151 CitContext *CloneContext(CitContext *CloneMe);
 152
 153 /* forcibly close and flush fd's on shutdown */
 154 void terminate_all_sessions(void);
 155
 156 void terminate_idle_sessions(void);
 157 int CtdlTerminateOtherSession (int session_num);
 158 /* bits returned by CtdlTerminateOtherSession */
 159 #define TERM_FOUND      0x01
 160 #define TERM_ALLOWED    0x02
 161 #define TERM_KILLED     0x03
 162 #define TERM_NOTALLOWED -1
 163
 164 /*
 165  * Bind a thread to a context.  (It's inline merely to speed things up.)
 166  */
 167 static INLINE void become_session(CitContext *which_con) {
 168         pthread_setspecific(MyConKey, (void *)which_con );
 169 }
 170
 171 #endif /* CONTEXT_H */