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