2 * Copyright (c) 1998-2009 by the citadel.org team
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <sys/types.h>
31 #if TIME_WITH_SYS_TIME
32 # include <sys/time.h>
36 # include <sys/time.h>
45 #include <sys/socket.h>
46 #include <netinet/in.h>
48 #include <arpa/inet.h>
49 #include <libcitadel.h>
50 #include <curl/curl.h>
51 #include <curl/multi.h>
54 #include "citserver.h"
57 #include "ctdl_module.h"
59 #include "event_client.h"
60 #include "serv_curl.h"
65 /*****************************************************************************
66 * libevent / curl integration *
67 *****************************************************************************/
70 sta = curl_multi_setopt(mhnd, (CURLMOPT_##s), (v)); \
72 syslog(LOG_ERR, "EVCURL: error setting option " #s " on curl multi handle: %s\n", curl_easy_strerror(sta)); \
77 typedef struct _evcurl_global_data {
85 evcurl_global_data global;
95 syslog(LOG_DEBUG, "CURLEV: gotstatus(): about to call curl_multi_info_read\n");
96 while ((msg = curl_multi_info_read(global.mhnd, &nmsg))) {
97 syslog(LOG_ERR, "EVCURL: got curl multi_info message msg=%d\n", msg->msg);
98 if (CURLMSG_DONE == msg->msg) {
106 chnd = msg->easy_handle;
107 sta = curl_easy_getinfo(chnd, CURLINFO_PRIVATE, &chandle);
108 syslog(LOG_ERR, "EVCURL: request complete\n");
110 syslog(LOG_ERR, "EVCURL: error asking curl for private cookie of curl handle: %s\n", curl_easy_strerror(sta));
111 IO = (AsyncIO *)chandle;
113 ev_io_stop(event_base, &IO->recv_event);
114 ev_io_stop(event_base, &IO->send_event);
116 sta = msg->data.result;
118 EV_syslog(LOG_ERR, "EVCURL: error description: %s\n", IO->HttpReq.errdesc);
119 EV_syslog(LOG_ERR, "EVCURL: error performing request: %s\n", curl_easy_strerror(sta));
121 sta = curl_easy_getinfo(chnd, CURLINFO_RESPONSE_CODE, &IO->HttpReq.httpcode);
123 EV_syslog(LOG_ERR, "EVCURL: error asking curl for response code from request: %s\n", curl_easy_strerror(sta));
124 EV_syslog(LOG_ERR, "EVCURL: http response code was %ld\n", (long)IO->HttpReq.httpcode);
127 curl_slist_free_all(IO->HttpReq.headers);
128 msta = curl_multi_remove_handle(global.mhnd, chnd);
130 EV_syslog(LOG_ERR, "EVCURL: warning problem detaching completed handle from curl multi: %s\n", curl_multi_strerror(msta));
132 ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
134 IO->HttpReq.attached = 0;
135 switch(IO->SendDone(IO))
138 curl_easy_cleanup(IO->HttpReq.chnd);
139 IO->HttpReq.chnd = NULL;
151 curl_easy_cleanup(IO->HttpReq.chnd);
152 IO->HttpReq.chnd = NULL;
154 case eTerminateConnection:
156 curl_easy_cleanup(IO->HttpReq.chnd);
157 IO->HttpReq.chnd = NULL;
158 FreeStrBuf(&IO->HttpReq.ReplyData);
159 FreeURL(&IO->ConnectMe);
160 RemoveContext(IO->CitContext);
168 stepmulti(void *data, curl_socket_t fd, int which)
170 int running_handles = 0;
173 msta = curl_multi_socket_action(global.mhnd, fd, which, &running_handles);
174 syslog(LOG_DEBUG, "EVCURL: stepmulti(): calling gotstatus()\n");
176 syslog(LOG_ERR, "EVCURL: error in curl processing events on multi handle, fd %d: %s\n", (int)fd, curl_multi_strerror(msta));
177 if (global.nrun != running_handles)
178 gotstatus(running_handles);
182 gottime(struct ev_loop *loop, ev_timer *timeev, int events) {
183 syslog(LOG_DEBUG, "EVCURL: waking up curl for timeout\n");
184 stepmulti(NULL, CURL_SOCKET_TIMEOUT, 0);
188 got_in(struct ev_loop *loop, ev_io *ioev, int events) {
189 syslog(LOG_DEBUG, "EVCURL: waking up curl for io on fd %d\n", (int)ioev->fd);
190 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_IN);
194 got_out(struct ev_loop *loop, ev_io *ioev, int events) {
195 syslog(LOG_DEBUG, "EVCURL: waking up curl for io on fd %d\n", (int)ioev->fd);
196 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_OUT);
200 gotdata(void *data, size_t size, size_t nmemb, void *cglobal) {
201 AsyncIO *IO = (AsyncIO*) cglobal;
203 if (IO->HttpReq.ReplyData == NULL)
205 IO->HttpReq.ReplyData = NewStrBufPlain(NULL, SIZ);
207 return CurlFillStrBuf_callback(data, size, nmemb, IO->HttpReq.ReplyData);
211 gotwatchtime(CURLM *multi, long tblock_ms, void *cglobal) {
212 syslog(LOG_DEBUG, "EVCURL: gotwatchtime called %ld ms\n", tblock_ms);
213 evcurl_global_data *global = cglobal;
214 ev_timer_stop(EV_DEFAULT, &global->timeev);
215 if (tblock_ms < 0 || 14000 < tblock_ms)
217 ev_timer_set(&global->timeev, 0.5e-3 + 1.0e-3 * tblock_ms, 14.0);
218 ev_timer_start(EV_DEFAULT_UC, &global->timeev);
219 curl_multi_perform(global, &global->nrun);
224 gotwatchsock(CURL *easy, curl_socket_t fd, int action, void *cglobal, void *vIO) {
225 evcurl_global_data *global = cglobal;
226 CURLM *mhnd = global->mhnd;
228 AsyncIO *IO = (AsyncIO*) vIO;
233 sta = curl_easy_getinfo(easy, CURLINFO_PRIVATE, &f);
235 EV_syslog(LOG_ERR, "EVCURL: error asking curl for private cookie of curl handle: %s\n", curl_easy_strerror(sta));
239 EV_syslog(LOG_DEBUG, "EVCURL: got socket for URL: %s\n", IO->ConnectMe->PlainUrl);
240 if (IO->SendBuf.fd != 0)
242 ev_io_stop(event_base, &IO->recv_event);
243 ev_io_stop(event_base, &IO->send_event);
246 ev_io_init(&IO->recv_event, &got_in, fd, EV_READ);
247 ev_io_init(&IO->send_event, &got_out, fd, EV_WRITE);
248 curl_multi_assign(mhnd, fd, IO);
255 Action = "CURL_POLL_NONE";
257 case CURL_POLL_REMOVE:
258 Action = "CURL_POLL_REMOVE";
261 Action = "CURL_POLL_IN";
264 Action = "CURL_POLL_OUT";
266 case CURL_POLL_INOUT:
267 Action = "CURL_POLL_INOUT";
272 EV_syslog(LOG_DEBUG, "EVCURL: gotwatchsock called fd=%d action=%s[%d]\n", (int)fd, Action, action);
277 EVM_syslog(LOG_ERR,"EVCURL: called first time to register this sockwatcker\n");
279 case CURL_POLL_REMOVE:
280 EVM_syslog(LOG_ERR,"EVCURL: called last time to unregister this sockwatcher\n");
281 ev_io_stop(event_base, &IO->recv_event);
282 ev_io_stop(event_base, &IO->send_event);
285 ev_io_start(event_base, &IO->recv_event);
286 ev_io_stop(event_base, &IO->send_event);
289 ev_io_start(event_base, &IO->send_event);
290 ev_io_stop(event_base, &IO->recv_event);
292 case CURL_POLL_INOUT:
293 ev_io_start(event_base, &IO->send_event);
294 ev_io_start(event_base, &IO->recv_event);
300 void curl_init_connectionpool(void)
304 ev_timer_init(&global.timeev, &gottime, 14.0, 14.0);
305 global.timeev.data = (void *)&global;
307 CURLcode sta = curl_global_init(CURL_GLOBAL_ALL);
311 syslog(LOG_ERR,"EVCURL: error initializing curl library: %s\n", curl_easy_strerror(sta));
314 mhnd = global.mhnd = curl_multi_init();
317 syslog(LOG_ERR,"EVCURL: error initializing curl multi handle\n");
321 MOPT(SOCKETFUNCTION, &gotwatchsock);
322 MOPT(SOCKETDATA, (void *)&global);
323 MOPT(TIMERFUNCTION, &gotwatchtime);
324 MOPT(TIMERDATA, (void *)&global);
332 int evcurl_init(AsyncIO *IO,
335 IO_CallBack CallBack,
336 IO_CallBack Terminate,
337 IO_CallBack ShutdownAbort)
342 EVM_syslog(LOG_DEBUG, "EVCURL: evcurl_init called ms\n");
343 IO->HttpReq.attached = 0;
344 IO->SendDone = CallBack;
345 IO->Terminate = Terminate;
346 IO->ShutdownAbort = ShutdownAbort;
347 chnd = IO->HttpReq.chnd = curl_easy_init();
350 EVM_syslog(LOG_ERR, "EVCURL: error initializing curl handle\n");
354 strcpy(IO->HttpReq.errdesc, Desc);
356 OPT(VERBOSE, (long)1);
357 /* unset in production */
360 OPT(FAILONERROR, (long)1);
362 OPT(FOLLOWLOCATION, (long)1);
363 OPT(MAXREDIRS, (long)7);
364 OPT(USERAGENT, CITADEL);
366 OPT(TIMEOUT, (long)1800);
367 OPT(LOW_SPEED_LIMIT, (long)64);
368 OPT(LOW_SPEED_TIME, (long)600);
369 OPT(CONNECTTIMEOUT, (long)600);
370 OPT(PRIVATE, (void *)IO);
372 OPT(FORBID_REUSE, 1);
373 OPT(WRITEFUNCTION, &gotdata);
374 OPT(WRITEDATA, (void *)IO);
375 OPT(ERRORBUFFER, IO->HttpReq.errdesc);
378 (!IsEmptyStr(config.c_ip_addr))
379 && (strcmp(config.c_ip_addr, "*"))
380 && (strcmp(config.c_ip_addr, "::"))
381 && (strcmp(config.c_ip_addr, "0.0.0.0"))
383 OPT(INTERFACE, config.c_ip_addr);
385 /* point to a structure that points back to the perl structure and stuff */
386 EV_syslog(LOG_DEBUG, "EVCURL: Loading URL: %s\n", IO->ConnectMe->PlainUrl);
387 OPT(URL, IO->ConnectMe->PlainUrl);
388 if (StrLength(IO->ConnectMe->CurlCreds))
390 OPT(HTTPAUTH, (long)CURLAUTH_BASIC);
391 OPT(USERPWD, ChrPtr(IO->ConnectMe->CurlCreds));
393 #ifdef CURLOPT_HTTP_CONTENT_DECODING
394 OPT(HTTP_CONTENT_DECODING, 1);
397 if (StrLength(IO->HttpReq.PostData) > 0)
399 OPT(POSTFIELDS, ChrPtr(IO->HttpReq.PostData));
400 OPT(POSTFIELDSIZE, StrLength(IO->HttpReq.PostData));
403 else if ((IO->HttpReq.PlainPostDataLen != 0) && (IO->HttpReq.PlainPostData != NULL))
405 OPT(POSTFIELDS, IO->HttpReq.PlainPostData);
406 OPT(POSTFIELDSIZE, IO->HttpReq.PlainPostDataLen);
409 IO->HttpReq.headers = curl_slist_append(IO->HttpReq.headers, "Connection: close");
410 OPT(HTTPHEADER, IO->HttpReq.headers);
416 static void IOcurl_abort_shutdown_callback(struct ev_loop *loop, ev_cleanup *watcher, int revents)
419 AsyncIO *IO = watcher->data;
420 EV_syslog(LOG_DEBUG, "EVENT Curl: %s\n", __FUNCTION__);
422 curl_slist_free_all(IO->HttpReq.headers);
423 msta = curl_multi_remove_handle(global.mhnd, IO->HttpReq.chnd);
425 EV_syslog(LOG_ERR, "EVCURL: warning problem detaching completed handle from curl multi: %s\n", curl_multi_strerror(msta));
427 curl_easy_cleanup(IO->HttpReq.chnd);
428 IO->HttpReq.chnd = NULL;
429 ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
430 ev_io_stop(event_base, &IO->recv_event);
431 ev_io_stop(event_base, &IO->send_event);
432 assert(IO->ShutdownAbort);
433 IO->ShutdownAbort(IO);
436 evcurl_handle_start(AsyncIO *IO)
439 IO->NextState = eConnect;
440 EVM_syslog(LOG_DEBUG, "EVCURL: attaching to curl multi handle\n");
441 msta = curl_multi_add_handle(global.mhnd, IO->HttpReq.chnd);
443 EV_syslog(LOG_ERR, "EVCURL: error attaching to curl multi handle: %s\n", curl_multi_strerror(msta));
444 IO->HttpReq.attached = 1;
445 ev_async_send (event_base, &WakeupCurl);
446 ev_cleanup_init(&IO->abort_by_shutdown,
447 IOcurl_abort_shutdown_callback);
448 ev_cleanup_start(event_base, &IO->abort_by_shutdown);
452 static void WakeupCurlCallback(EV_P_ ev_async *w, int revents)
454 syslog(LOG_DEBUG, "EVCURL: waking up curl multi handle\n");
456 curl_multi_perform(&global, CURL_POLL_NONE);
459 static void evcurl_shutdown (void)
461 curl_multi_cleanup(global.mhnd);
463 /*****************************************************************************
464 * libevent integration *
465 *****************************************************************************/
467 * client event queue plus its methods.
468 * this currently is the main loop (which may change in some future?)
470 int evbase_count = 0;
471 int event_add_pipe[2] = {-1, -1};
472 pthread_mutex_t EventQueueMutex; /* locks the access to the following vars: */
473 HashList *QueueEvents = NULL;
474 HashList *InboundEventQueue = NULL;
475 HashList *InboundEventQueues[2] = { NULL, NULL };
478 ev_async ExitEventLoop;
480 static void QueueEventAddCallback(EV_P_ ev_async *w, int revents)
488 /* get the control command... */
489 pthread_mutex_lock(&EventQueueMutex);
491 if (InboundEventQueues[0] == InboundEventQueue) {
492 InboundEventQueue = InboundEventQueues[1];
493 q = InboundEventQueues[0];
496 InboundEventQueue = InboundEventQueues[0];
497 q = InboundEventQueues[1];
499 pthread_mutex_unlock(&EventQueueMutex);
501 It = GetNewHashPos(q, 0);
502 while (GetNextHashPos(q, It, &len, &Key, &v))
506 h->IO->ID = EvIDSource++;
510 DeleteHashContent(&q);
511 syslog(LOG_DEBUG, "EVENT Q Add done.\n");
515 static void EventExitCallback(EV_P_ ev_async *w, int revents)
517 ev_break(event_base, EVBREAK_ALL);
519 syslog(LOG_DEBUG, "EVENT Q exiting.\n");
524 void InitEventQueue(void)
526 struct rlimit LimitSet;
528 pthread_mutex_init(&EventQueueMutex, NULL);
530 if (pipe(event_add_pipe) != 0) {
531 syslog(LOG_EMERG, "Unable to create pipe for libev queueing: %s\n", strerror(errno));
534 LimitSet.rlim_cur = 1;
535 LimitSet.rlim_max = 1;
536 setrlimit(event_add_pipe[1], &LimitSet);
538 QueueEvents = NewHash(1, Flathash);
539 InboundEventQueues[0] = NewHash(1, Flathash);
540 InboundEventQueues[1] = NewHash(1, Flathash);
541 InboundEventQueue = InboundEventQueues[0];
544 * this thread operates the select() etc. via libev.
548 void *client_event_thread(void *arg)
550 struct CitContext libev_client_CC;
552 CtdlFillSystemContext(&libev_client_CC, "LibEv Thread");
553 // citthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
554 syslog(LOG_DEBUG, "client_ev_thread() initializing\n");
556 event_base = ev_default_loop (EVFLAG_AUTO);
557 ev_async_init(&AddJob, QueueEventAddCallback);
558 ev_async_start(event_base, &AddJob);
559 ev_async_init(&ExitEventLoop, EventExitCallback);
560 ev_async_start(event_base, &ExitEventLoop);
561 ev_async_init(&WakeupCurl, WakeupCurlCallback);
562 ev_async_start(event_base, &WakeupCurl);
564 curl_init_connectionpool();
566 ev_run (event_base, 0);
569 ///what todo here? CtdlClearSystemContext();
570 ev_loop_destroy (EV_DEFAULT_UC);
571 curl_global_cleanup();
572 curl_multi_cleanup(global.mhnd);
573 DeleteHash(&QueueEvents);
574 InboundEventQueue = NULL;
575 DeleteHash(&InboundEventQueues[0]);
576 DeleteHash(&InboundEventQueues[1]);
577 /* citthread_mutex_destroy(&EventQueueMutex); TODO */
582 /*------------------------------------------------------------------------------*/
584 * DB-Queue; does async bdb operations.
585 * has its own set of handlers.
589 int evdb_add_pipe[2] = {-1, -1};
590 pthread_mutex_t DBEventQueueMutex; /* locks the access to the following vars: */
591 HashList *DBQueueEvents = NULL;
592 HashList *DBInboundEventQueue = NULL;
593 HashList *DBInboundEventQueues[2] = { NULL, NULL };
596 ev_async DBExitEventLoop;
598 extern void ShutDownDBCLient(AsyncIO *IO);
600 static void DBQueueEventAddCallback(EV_P_ ev_async *w, int revents)
608 /* get the control command... */
609 pthread_mutex_lock(&DBEventQueueMutex);
611 if (DBInboundEventQueues[0] == DBInboundEventQueue) {
612 DBInboundEventQueue = DBInboundEventQueues[1];
613 q = DBInboundEventQueues[0];
616 DBInboundEventQueue = DBInboundEventQueues[0];
617 q = DBInboundEventQueues[1];
619 pthread_mutex_unlock(&DBEventQueueMutex);
621 It = GetNewHashPos(q, 0);
622 while (GetNextHashPos(q, It, &len, &Key, &v))
627 h->IO->ID = EvIDSource++;
628 rc = h->EvAttch(h->IO);
632 ShutDownDBCLient(h->IO);
638 DeleteHashContent(&q);
639 syslog(LOG_DEBUG, "DBEVENT Q Add done.\n");
643 static void DBEventExitCallback(EV_P_ ev_async *w, int revents)
645 syslog(LOG_DEBUG, "EVENT Q exiting.\n");
646 ev_break(event_db, EVBREAK_ALL);
651 void DBInitEventQueue(void)
653 struct rlimit LimitSet;
655 pthread_mutex_init(&DBEventQueueMutex, NULL);
657 if (pipe(evdb_add_pipe) != 0) {
658 syslog(LOG_EMERG, "Unable to create pipe for libev queueing: %s\n", strerror(errno));
661 LimitSet.rlim_cur = 1;
662 LimitSet.rlim_max = 1;
663 setrlimit(evdb_add_pipe[1], &LimitSet);
665 DBQueueEvents = NewHash(1, Flathash);
666 DBInboundEventQueues[0] = NewHash(1, Flathash);
667 DBInboundEventQueues[1] = NewHash(1, Flathash);
668 DBInboundEventQueue = DBInboundEventQueues[0];
672 * this thread operates writing to the message database via libev.
676 void *db_event_thread(void *arg)
678 struct CitContext libev_msg_CC;
680 CtdlFillSystemContext(&libev_msg_CC, "LibEv DB IO Thread");
681 // citthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
682 syslog(LOG_DEBUG, "client_msgev_thread() initializing\n");
684 event_db = ev_loop_new (EVFLAG_AUTO);
686 ev_async_init(&DBAddJob, DBQueueEventAddCallback);
687 ev_async_start(event_db, &DBAddJob);
688 ev_async_init(&DBExitEventLoop, DBEventExitCallback);
689 ev_async_start(event_db, &DBExitEventLoop);
691 ev_run (event_db, 0);
694 //// what to do here? CtdlClearSystemContext();
695 ev_loop_destroy (event_db);
697 DeleteHash(&DBQueueEvents);
698 DBInboundEventQueue = NULL;
699 DeleteHash(&DBInboundEventQueues[0]);
700 DeleteHash(&DBInboundEventQueues[1]);
701 /* citthread_mutex_destroy(&DBEventQueueMutex); TODO */
706 CTDL_MODULE_INIT(event_client)
712 CtdlThreadCreate(/*"Client event", */ client_event_thread);
713 CtdlThreadCreate(/*"DB event", */db_event_thread);
714 /// todo register shutdown callback.