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