Give event clients a citadel session context.
[citadel.git] / citadel / event_client.c
1 /*
2  *
3  * Copyright (c) 1998-2009 by the citadel.org team
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 3 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, write to the Free Software
17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19
20 #include "sysdep.h"
21 #include <stdlib.h>
22 #include <unistd.h>
23 #include <stdio.h>
24 #include <termios.h>
25 #include <fcntl.h>
26 #include <signal.h>
27 #include <pwd.h>
28 #include <errno.h>
29 #include <sys/types.h>
30 #include <syslog.h>
31
32 #if TIME_WITH_SYS_TIME
33 # include <sys/time.h>
34 # include <time.h>
35 #else
36 # if HAVE_SYS_TIME_H
37 #  include <sys/time.h>
38 # else
39 #  include <time.h>
40 # endif
41 #endif
42 #include <sys/wait.h>
43 #include <ctype.h>
44 #include <string.h>
45 #include <limits.h>
46 #include <sys/socket.h>
47 #include <netinet/in.h>
48 #include <arpa/inet.h>
49 #include <assert.h>
50
51 #include <libcitadel.h>
52 #include "citadel.h"
53 #include "server.h"
54 #include "citserver.h"
55 #include "support.h"
56 #include "config.h"
57 #include "control.h"
58 #include "user_ops.h"
59 #include "database.h"
60 #include "msgbase.h"
61 #include "internet_addressing.h"
62 #include "genstamp.h"
63 #include "domain.h"
64 #include "clientsocket.h"
65 #include "locate_host.h"
66 #include "citadel_dirs.h"
67
68 #include "event_client.h"
69
70 extern citthread_mutex_t EventQueueMutex;
71 extern HashList *InboundEventQueue;
72 extern struct ev_loop *event_base;
73 extern ev_async AddJob;   
74 extern ev_async ExitEventLoop;
75
76 static void
77 IO_abort_shutdown_callback(struct ev_loop *loop, ev_cleanup *watcher, int revents)
78 {
79         CtdlLogPrintf(CTDL_DEBUG, "EVENT Q: %s\n", __FUNCTION__);
80
81         AsyncIO *IO = watcher->data;
82         IO->ShutdownAbort(IO);
83 }
84         
85 int QueueEventContext(AsyncIO *IO, IO_CallBack CB)
86 {
87         IOAddHandler *h;
88         int i;
89
90         h = (IOAddHandler*)malloc(sizeof(IOAddHandler));
91         h->IO = IO;
92         h->EvAttch = CB;
93         ev_cleanup_init(&IO->abort_by_shutdown, 
94                         IO_abort_shutdown_callback);
95         IO->abort_by_shutdown.data = IO;
96         ev_cleanup_start(event_base, &IO->abort_by_shutdown);
97
98         citthread_mutex_lock(&EventQueueMutex);
99         CtdlLogPrintf(CTDL_DEBUG, "EVENT Q\n");
100         i = GetCount(InboundEventQueue);
101         Put(InboundEventQueue, IKEY(i), h, NULL);
102         citthread_mutex_unlock(&EventQueueMutex);
103
104         ev_async_send (event_base, &AddJob);
105         CtdlLogPrintf(CTDL_DEBUG, "EVENT Q Done.\n");
106         return 0;
107 }
108
109
110 int ShutDownEventQueue(void)
111 {
112         citthread_mutex_lock(&EventQueueMutex);
113         ev_async_send (EV_DEFAULT_ &ExitEventLoop);
114         citthread_mutex_unlock(&EventQueueMutex);
115         return 0;
116 }
117
118 void FreeAsyncIOContents(AsyncIO *IO)
119 {
120         FreeStrBuf(&IO->IOBuf);
121         FreeStrBuf(&IO->SendBuf.Buf);
122         FreeStrBuf(&IO->RecvBuf.Buf);
123 }
124
125
126 void ShutDownCLient(AsyncIO *IO)
127 {
128         CtdlLogPrintf(CTDL_DEBUG, "EVENT x %d\n", IO->SendBuf.fd);
129
130         ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
131
132         if (IO->SendBuf.fd != 0)
133         {
134                 ev_io_stop(event_base, &IO->send_event);
135                 ev_io_stop(event_base, &IO->recv_event);
136                 ev_timer_stop (event_base, &IO->rw_timeout);
137                 close(IO->SendBuf.fd);
138                 IO->SendBuf.fd = 0;
139                 IO->RecvBuf.fd = 0;
140         }
141         if (IO->DNSChannel != NULL) {
142                 ares_destroy(IO->DNSChannel);
143                 ev_io_stop(event_base, &IO->dns_recv_event);
144                 ev_io_stop(event_base, &IO->dns_send_event);
145                 IO->DNSChannel = NULL;
146         }
147         assert(IO->Terminate);
148         become_session(IO->CitContext);
149         IO->Terminate(IO);
150         
151 }
152
153
154 eReadState HandleInbound(AsyncIO *IO)
155 {
156         eReadState Finished = eBufferNotEmpty;
157         
158         become_session(IO->CitContext);
159
160         while ((Finished == eBufferNotEmpty) && (IO->NextState == eReadMessage)){
161                 if (IO->RecvBuf.nBlobBytesWanted != 0) { 
162                                 
163                 }
164                 else { /* Reading lines... */
165 //// lex line reply in callback, or do it ourselves. as nnn-blabla means continue reading in SMTP
166                         if (IO->LineReader)
167                                 Finished = IO->LineReader(IO);
168                         else 
169                                 Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
170                                 
171                         switch (Finished) {
172                         case eMustReadMore: /// read new from socket... 
173                                 return Finished;
174                                 break;
175                         case eBufferNotEmpty: /* shouldn't happen... */
176                         case eReadSuccess: /// done for now...
177                                 break;
178                         case eReadFail: /// WHUT?
179                                 ///todo: shut down! 
180                                 break;
181                         }
182                                         
183                 }
184                         
185                 if (Finished != eMustReadMore) {
186                         assert(IO->ReadDone);
187                         ev_io_stop(event_base, &IO->recv_event);
188                         IO->NextState = IO->ReadDone(IO);
189                         Finished = StrBufCheckBuffer(&IO->RecvBuf);
190                 }
191         }
192
193
194         if ((IO->NextState == eSendReply) ||
195             (IO->NextState == eSendMore))
196         {
197                 assert(IO->SendDone);
198                 IO->NextState = IO->SendDone(IO);
199                 ev_io_start(event_base, &IO->send_event);
200         }
201         else if ((IO->NextState == eTerminateConnection) ||
202                  (IO->NextState == eAbort) )
203                 ShutDownCLient(IO);
204         return Finished;
205 }
206
207
208 static void
209 IO_send_callback(struct ev_loop *loop, ev_io *watcher, int revents)
210 {
211         int rc;
212         AsyncIO *IO = watcher->data;
213
214         become_session(IO->CitContext);
215         rc = StrBuf_write_one_chunk_callback(watcher->fd, 0/*TODO*/, &IO->SendBuf);
216
217         if (rc == 0)
218         {               
219 #ifdef BIGBAD_IODBG
220                 {
221                         int rv = 0;
222                         char fn [SIZ];
223                         FILE *fd;
224                         const char *pch = ChrPtr(IO->SendBuf.Buf);
225                         const char *pchh = IO->SendBuf.ReadWritePointer;
226                         long nbytes;
227
228                         if (pchh == NULL)
229                                 pchh = pch;
230                         
231                         nbytes = StrLength(IO->SendBuf.Buf) - (pchh - pch);
232                         snprintf(fn, SIZ, "/tmp/foolog_ev_%s.%d", "smtpev", IO->SendBuf.fd);
233                 
234                         fd = fopen(fn, "a+");
235                         fprintf(fd, "Read: BufSize: %ld BufContent: [",
236                                 nbytes);
237                         rv = fwrite(pchh, nbytes, 1, fd);
238                         fprintf(fd, "]\n");
239                 
240                         
241                         fclose(fd);
242                 }
243 #endif
244                 ev_io_stop(event_base, &IO->send_event);
245                 switch (IO->NextState) {
246                 case eSendReply:
247                         break;
248                 case eSendMore:
249                         assert(IO->SendDone);
250                         IO->NextState = IO->SendDone(IO);
251
252                         if ((IO->NextState == eTerminateConnection) ||
253                             (IO->NextState == eAbort) )
254                                 ShutDownCLient(IO);
255                         else {
256                                 ev_io_start(event_base, &IO->send_event);
257                         }
258                         break;
259                 case eReadMessage:
260                         if (StrBufCheckBuffer(&IO->RecvBuf) == eBufferNotEmpty) {
261                                 HandleInbound(IO);
262                         }
263                         else {
264                                 ev_io_start(event_base, &IO->recv_event);
265                         }
266
267                         break;
268                 case eTerminateConnection:
269                 case eAbort:
270                         break;
271                 }
272         }
273         else if (rc < 0) {
274                 assert(IO->Timeout);
275                 IO->Timeout(IO);
276         }
277         /* else : must write more. */
278 }
279 static void
280 set_start_callback(struct ev_loop *loop, AsyncIO *IO, int revents)
281 {
282         
283         switch(IO->NextState) {
284         case eReadMessage:
285                 ev_io_start(event_base, &IO->recv_event);
286                 break;
287         case eSendReply:
288         case eSendMore:
289                 become_session(IO->CitContext);
290                 IO_send_callback(loop, &IO->send_event, revents);
291                 break;
292         case eTerminateConnection:
293         case eAbort:
294                 /// TODO: WHUT?
295                 break;
296         }
297 }
298
299 static void
300 IO_Timout_callback(struct ev_loop *loop, ev_timer *watcher, int revents)
301 {
302         AsyncIO *IO = watcher->data;
303
304         ev_timer_stop (event_base, &IO->rw_timeout);
305         become_session(IO->CitContext);
306
307         assert(IO->Timeout);
308         IO->Timeout(IO);
309 }
310 static void
311 IO_connfail_callback(struct ev_loop *loop, ev_timer *watcher, int revents)
312 {
313         AsyncIO *IO = watcher->data;
314
315         ev_timer_stop (event_base, &IO->conn_fail);
316         ev_io_stop(loop, &IO->conn_event);
317         become_session(IO->CitContext);
318
319         assert(IO->ConnFail);
320         IO->ConnFail(IO);
321 }
322 static void
323 IO_connestd_callback(struct ev_loop *loop, ev_io *watcher, int revents)
324 {
325         AsyncIO *IO = watcher->data;
326
327         ev_io_stop(loop, &IO->conn_event);
328         ev_timer_stop (event_base, &IO->conn_fail);
329         set_start_callback(loop, IO, revents);
330 }
331 static void
332 IO_recv_callback(struct ev_loop *loop, ev_io *watcher, int revents)
333 {
334         ssize_t nbytes;
335         AsyncIO *IO = watcher->data;
336
337         nbytes = StrBuf_read_one_chunk_callback(watcher->fd, 0 /*TODO */, &IO->RecvBuf);
338         if (nbytes > 0) {
339                 HandleInbound(IO);
340         } else if (nbytes == 0) {
341                 assert(IO->Timeout);
342                 IO->Timeout(IO); /* this is a timeout... */
343                 return;
344         } else if (nbytes == -1) {
345 /// TODO: FD is gone. kick it.        sock_buff_invoke_free(sb, errno);
346                 return;
347         }
348 }
349
350 void
351 IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents)
352 {
353         AsyncIO *IO = watcher->data;
354         CtdlLogPrintf(CTDL_DEBUG, "event: %s\n", __FUNCTION__);
355         become_session(IO->CitContext);
356
357         IO->DNSQuery->PostDNS(IO);
358 }
359
360 eNextState event_connect_socket(AsyncIO *IO, double conn_timeout, double first_rw_timeout)
361 {
362         int fdflags; 
363         int rc = -1;
364
365         IO->SendBuf.fd = IO->RecvBuf.fd = 
366                 socket(
367                         (IO->ConnectMe->IPv6)?PF_INET6:PF_INET, 
368                         SOCK_STREAM, 
369                         IPPROTO_TCP);
370
371         if (IO->SendBuf.fd < 0) {
372                 CtdlLogPrintf(CTDL_ERR, "EVENT: socket() failed: %s\n", strerror(errno));
373                 StrBufPrintf(IO->ErrMsg, "Failed to create socket: %s", strerror(errno));
374 //              freeaddrinfo(res);
375                 return eAbort;
376         }
377         fdflags = fcntl(IO->SendBuf.fd, F_GETFL);
378         if (fdflags < 0) {
379                 CtdlLogPrintf(CTDL_DEBUG,
380                               "EVENT: unable to get socket flags! %s \n",
381                               strerror(errno));
382                 StrBufPrintf(IO->ErrMsg, "Failed to get socket flags: %s", strerror(errno));
383                 return eAbort;
384         }
385         fdflags = fdflags | O_NONBLOCK;
386         if (fcntl(IO->SendBuf.fd, F_SETFL, fdflags) < 0) {
387                 CtdlLogPrintf(CTDL_DEBUG,
388                               "EVENT: unable to set socket nonblocking flags! %s \n",
389                               strerror(errno));
390                 StrBufPrintf(IO->ErrMsg, "Failed to set socket flags: %s", strerror(errno));
391                 close(IO->SendBuf.fd);
392                 IO->SendBuf.fd = IO->RecvBuf.fd = -1;
393                 return eAbort;
394         }
395 /* TODO: maye we could use offsetof() to calc the position of data... 
396  * http://doc.dvgu.ru/devel/ev.html#associating_custom_data_with_a_watcher
397  */
398         ev_io_init(&IO->recv_event, IO_recv_callback, IO->RecvBuf.fd, EV_READ);
399         IO->recv_event.data = IO;
400         ev_io_init(&IO->send_event, IO_send_callback, IO->SendBuf.fd, EV_WRITE);
401         IO->send_event.data = IO;
402
403         ev_timer_init(&IO->conn_fail, IO_connfail_callback, conn_timeout, 0);
404         IO->conn_fail.data = IO;
405         ev_timer_init(&IO->rw_timeout, IO_Timout_callback, first_rw_timeout, 0);
406         IO->rw_timeout.data = IO;
407
408         if (IO->ConnectMe->IPv6)
409                 rc = connect(IO->SendBuf.fd, &IO->ConnectMe->Addr, sizeof(struct sockaddr_in6));
410         else
411                 rc = connect(IO->SendBuf.fd, (struct sockaddr_in *)&IO->ConnectMe->Addr, sizeof(struct sockaddr_in));
412
413         if (rc >= 0){
414 ////            freeaddrinfo(res);
415                 set_start_callback(event_base, IO, 0);
416                 ev_timer_start(event_base, &IO->rw_timeout);
417                 return IO->NextState;
418         }
419         else if (errno == EINPROGRESS) {
420
421                 ev_io_init(&IO->conn_event, IO_connestd_callback, IO->SendBuf.fd, EV_READ|EV_WRITE);
422                 IO->conn_event.data = IO;
423
424                 ev_io_start(event_base, &IO->conn_event);
425                 ev_timer_start(event_base, &IO->conn_fail);
426                 return IO->NextState;
427         }
428         else {
429                 CtdlLogPrintf(CTDL_ERR, "connect() failed: %s\n", strerror(errno));
430                 StrBufPrintf(IO->ErrMsg, "Failed to connect: %s", strerror(errno));
431                 assert(IO->ConnFail);
432                 IO->ConnFail(IO);
433                 return eAbort;
434         }
435         return IO->NextState;
436 }
437
438 void SetNextTimeout(AsyncIO *IO, double timeout)
439 {
440         IO->rw_timeout.repeat = timeout;
441         ev_timer_again (event_base,  &IO->rw_timeout);
442 }
443
444 eNextState InitEventIO(AsyncIO *IO, 
445                        void *pData, 
446                        double conn_timeout, 
447                        double first_rw_timeout,
448                        int ReadFirst)
449 {
450         IO->Data = pData;
451         become_session(IO->CitContext);
452         
453         if (ReadFirst) {
454                 IO->NextState = eReadMessage;
455         }
456         else {
457                 IO->NextState = eSendReply;
458         }
459         return event_connect_socket(IO, conn_timeout, first_rw_timeout);
460 }