c2578036035f92bc73062aaf81566b8912a6a43e
[citadel.git] / 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         StrBuf *StatusMessage;
62 #ifdef HAVE_OPENSSL
63         SSL *ssl;
64         int redirect_ssl;
65 #endif
66
67         char curr_user[USERNAME_SIZE];  /* name of current user */
68         int logged_in;          /* logged in */
69         int internal_pgm;       /* authenticated as internal program */
70         int nologin;            /* not allowed to log in */
71         int curr_view;          /* The view type for the current user/room */
72         int is_master;          /* Is this session logged in using the master user? */
73
74         char net_node[32]       ;/* Is the client another Citadel server? */
75         time_t previous_login;  /* Date/time of previous login */
76         char lastcmdname[5];    /* name of last command executed */
77         unsigned cs_flags;      /* miscellaneous flags */
78         int is_async;           /* Nonzero if client accepts async msgs */
79         int async_waiting;      /* Nonzero if there are async msgs waiting */
80         int input_waiting;      /* Nonzero if there is client input waiting */
81         int can_receive_im;     /* Session is capable of receiving instant messages */
82
83         /* Client information */
84         int cs_clientdev;       /* client developer ID */
85         int cs_clienttyp;       /* client type code */
86         int cs_clientver;       /* client version number */
87         char cs_clientinfo[256];/* if its a unix domain socket, some info for logging. */
88         uid_t cs_UDSclientUID;  /* the uid of the client when talking via UDS */
89         char cs_clientname[32]; /* name of client software */
90         char cs_host[64];       /* host logged in from */
91         char cs_addr[64];       /* address logged in from */
92
93         /* The Internet type of thing */
94         char cs_inet_email[128];                /* Return address of outbound Internet mail */
95         char cs_inet_other_emails[1024];        /* User's other valid Internet email addresses */
96         char cs_inet_fn[128];                   /* Friendly-name of outbound Internet mail */
97
98         FILE *download_fp;      /* Fields relating to file transfer */
99         size_t download_fp_total;
100         char download_desired_section[128];
101         FILE *upload_fp;
102         char upl_file[256];
103         char upl_path[PATH_MAX];
104         char upl_comment[256];
105         char upl_filedir[PATH_MAX];
106         char upl_mimetype[64];
107         char dl_is_net;
108         char upload_type;
109
110         struct ctdluser user;   /* Database record buffers */
111         struct ctdlroom room;
112
113         /* A linked list of all instant messages sent to us. */
114         struct ExpressMessage *FirstExpressMessage;
115         int disable_exp;        /* Set to 1 to disable incoming pages */
116         int newmail;            /* Other sessions increment this */
117
118         /* Masqueraded values in the 'who is online' list */
119         char fake_username[USERNAME_SIZE];
120         char fake_hostname[64];
121         char fake_roomname[ROOMNAMELEN];
122
123         /* Preferred MIME formats */
124         char preferred_formats[256];
125         int msg4_dont_decode;
126
127         /* Dynamically allocated session data */
128         char *session_specific_data;            /* Used by individual protocol modules */
129         struct cit_ical *CIT_ICAL;              /* calendaring data */
130         struct ma_info *ma;                     /* multipart/alternative data */
131         const char *ServiceName;                /* readable purpose of this session */
132         long tcp_port;
133         void *openid_data;                      /* Data stored by the OpenID module */
134         char *ldap_dn;                          /* DN of user when using AUTHMODE_LDAP */
135
136         void (*h_command_function) (void) ;     /* service command function */
137         void (*h_async_function) (void) ;       /* do async msgs function */
138         void (*h_greeting_function) (void) ;    /* greeting function for session startup */
139
140         long *cached_msglist;                   /* results of the previous CtdlForEachMessage() */
141         int cached_num_msgs;
142 };
143
144 typedef struct CitContext CitContext;
145
146
147 #define CC MyContext()
148
149
150 extern pthread_key_t MyConKey;                  /* TSD key for MyContext() */
151 extern int num_sessions;
152 extern CitContext masterCC;
153 extern CitContext *ContextList;
154
155 CitContext *MyContext (void);
156 void RemoveContext (struct CitContext *);
157 CitContext *CreateNewContext (void);
158 void context_cleanup(void);
159 void kill_session (int session_to_kill);
160 void InitializeMasterCC(void);
161 void dead_session_purge(int force);
162 void set_async_waiting(struct CitContext *ccptr);
163
164 CitContext *CloneContext(CitContext *CloneMe);
165
166 /* forcibly close and flush fd's on shutdown */
167 void terminate_all_sessions(void);
168
169 /* Deprecated, user CtdlBumpNewMailCounter() instead */
170 void BumpNewMailCounter(long) __attribute__ ((deprecated));
171
172 void terminate_idle_sessions(void);
173 int CtdlTerminateOtherSession (int session_num);
174 /* bits returned by CtdlTerminateOtherSession */
175 #define TERM_FOUND      0x01
176 #define TERM_ALLOWED    0x02
177 #define TERM_KILLED     0x03
178 #define TERM_NOTALLOWED -1
179
180 /*
181  * Bind a thread to a context.  (It's inline merely to speed things up.)
182  */
183 static INLINE void become_session(CitContext *which_con) {
184 /*
185         pid_t tid = syscall(SYS_gettid);
186 */
187         pthread_setspecific(MyConKey, (void *)which_con );
188 /*
189         syslog(LOG_DEBUG, "[%d]: Now doing %s\n", 
190                       (int) tid, 
191                       ((which_con != NULL) && (which_con->ServiceName != NULL)) ? 
192                       which_con->ServiceName:"");
193 */
194 }
195
196
197 #endif /* CONTEXT_H */