citadel/context.h

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