2 * Copyright (c) 1998-2012 by the citadel.org team
4 * This program is open source software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 3.
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.
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"
63 int DebugEventLoop = 0;
64 int DebugEventLoopBacktrace = 0;
68 /*****************************************************************************
69 * libevent / curl integration *
70 *****************************************************************************/
71 #define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCurl != 0))
73 #define EVCURL_syslog(LEVEL, FORMAT, ...) \
74 DBGLOG (LEVEL) syslog(LEVEL, "EVCURL:IO[%ld]CC[%d] " FORMAT, \
75 IO->ID, CCID, __VA_ARGS__)
77 #define EVCURLM_syslog(LEVEL, FORMAT) \
78 DBGLOG (LEVEL) syslog(LEVEL, "EVCURL:IO[%ld]CC[%d] " FORMAT, \
81 #define CURL_syslog(LEVEL, FORMAT, ...) \
82 DBGLOG (LEVEL) syslog(LEVEL, "CURL: " FORMAT, __VA_ARGS__)
84 #define CURLM_syslog(LEVEL, FORMAT) \
85 DBGLOG (LEVEL) syslog(LEVEL, "CURL: " FORMAT)
89 sta = curl_multi_setopt(mhnd, (CURLMOPT_##s), (v)); \
91 EVQ_syslog(LOG_ERR, "error setting option " \
92 #s " on curl multi handle: %s\n", \
93 curl_easy_strerror(sta)); \
99 typedef struct _evcurl_global_data {
104 } evcurl_global_data;
107 evcurl_global_data global;
117 CURLM_syslog(LOG_DEBUG,
118 "gotstatus(): about to call curl_multi_info_read\n");
119 while ((msg = curl_multi_info_read(global.mhnd, &nmsg))) {
120 CURL_syslog(LOG_DEBUG,
121 "got curl multi_info message msg=%d\n",
124 if (CURLMSG_DONE == msg->msg) {
126 char *chandle = NULL;
132 chnd = msg->easy_handle;
133 sta = curl_easy_getinfo(chnd,
138 "error asking curl for private"
139 " cookie of curl handle: %s\n",
140 curl_easy_strerror(sta));
143 IO = (AsyncIO *)chandle;
145 EVCURL_syslog(LOG_ERR,
146 "Error, invalid IO context %p\n",
150 SetEVState(IO, eCurlGotStatus);
152 EVCURLM_syslog(LOG_DEBUG, "request complete\n");
154 IO->Now = ev_now(event_base);
156 ev_io_stop(event_base, &IO->recv_event);
157 ev_io_stop(event_base, &IO->send_event);
159 sta = msg->data.result;
161 EVCURL_syslog(LOG_ERR,
162 "error description: %s\n",
163 IO->HttpReq.errdesc);
164 EVCURL_syslog(LOG_ERR,
165 "error performing request: %s\n",
166 curl_easy_strerror(sta));
168 sta = curl_easy_getinfo(chnd,
169 CURLINFO_RESPONSE_CODE,
170 &IO->HttpReq.httpcode);
172 EVCURL_syslog(LOG_ERR,
173 "error asking curl for "
174 "response code from request: %s\n",
175 curl_easy_strerror(sta));
176 EVCURL_syslog(LOG_DEBUG,
177 "http response code was %ld\n",
178 (long)IO->HttpReq.httpcode);
181 curl_slist_free_all(IO->HttpReq.headers);
182 msta = curl_multi_remove_handle(global.mhnd, chnd);
184 EVCURL_syslog(LOG_ERR,
185 "warning problem detaching "
186 "completed handle from curl multi: "
188 curl_multi_strerror(msta));
190 ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
192 IO->HttpReq.attached = 0;
193 switch(IO->SendDone(IO))
196 curl_easy_cleanup(IO->HttpReq.chnd);
197 IO->HttpReq.chnd = NULL;
209 curl_easy_cleanup(IO->HttpReq.chnd);
210 IO->HttpReq.chnd = NULL;
212 case eTerminateConnection:
214 curl_easy_cleanup(IO->HttpReq.chnd);
215 IO->HttpReq.chnd = NULL;
216 FreeStrBuf(&IO->HttpReq.ReplyData);
217 FreeURL(&IO->ConnectMe);
218 RemoveContext(IO->CitContext);
226 stepmulti(void *data, curl_socket_t fd, int which)
228 int running_handles = 0;
231 msta = curl_multi_socket_action(global.mhnd,
236 CURLM_syslog(LOG_DEBUG, "stepmulti(): calling gotstatus()\n");
239 "error in curl processing events"
240 "on multi handle, fd %d: %s\n",
242 curl_multi_strerror(msta));
244 if (global.nrun != running_handles)
245 gotstatus(running_handles);
249 gottime(struct ev_loop *loop, ev_timer *timeev, int events)
251 CURLM_syslog(LOG_DEBUG, "EVCURL: waking up curl for timeout\n");
252 stepmulti(NULL, CURL_SOCKET_TIMEOUT, 0);
256 got_in(struct ev_loop *loop, ev_io *ioev, int events)
258 CURL_syslog(LOG_DEBUG,
259 "EVCURL: waking up curl for io on fd %d\n",
262 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_IN);
266 got_out(struct ev_loop *loop, ev_io *ioev, int events)
268 CURL_syslog(LOG_DEBUG,
269 "waking up curl for io on fd %d\n",
272 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_OUT);
276 gotdata(void *data, size_t size, size_t nmemb, void *cglobal)
278 AsyncIO *IO = (AsyncIO*) cglobal;
280 SetEVState(IO, eCurlGotData);
281 if (IO->HttpReq.ReplyData == NULL)
283 IO->HttpReq.ReplyData = NewStrBufPlain(NULL, SIZ);
285 IO->Now = ev_now(event_base);
286 return CurlFillStrBuf_callback(data,
289 IO->HttpReq.ReplyData);
293 gotwatchtime(CURLM *multi, long tblock_ms, void *cglobal) {
294 CURL_syslog(LOG_DEBUG, "EVCURL: gotwatchtime called %ld ms\n", tblock_ms);
295 evcurl_global_data *global = cglobal;
296 ev_timer_stop(EV_DEFAULT, &global->timeev);
297 if (tblock_ms < 0 || 14000 < tblock_ms)
299 ev_timer_set(&global->timeev, 0.5e-3 + 1.0e-3 * tblock_ms, 14.0);
300 ev_timer_start(EV_DEFAULT_UC, &global->timeev);
301 curl_multi_perform(global, &global->nrun);
306 gotwatchsock(CURL *easy,
312 evcurl_global_data *global = cglobal;
313 CURLM *mhnd = global->mhnd;
315 AsyncIO *IO = (AsyncIO*) vIO;
320 sta = curl_easy_getinfo(easy, CURLINFO_PRIVATE, &f);
323 "EVCURL: error asking curl for private "
324 "cookie of curl handle: %s\n",
325 curl_easy_strerror(sta));
329 SetEVState(IO, eCurlNewIO);
330 EVCURL_syslog(LOG_DEBUG,
331 "EVCURL: got socket for URL: %s\n",
332 IO->ConnectMe->PlainUrl);
334 if (IO->SendBuf.fd != 0)
336 ev_io_stop(event_base, &IO->recv_event);
337 ev_io_stop(event_base, &IO->send_event);
340 ev_io_init(&IO->recv_event, &got_in, fd, EV_READ);
341 ev_io_init(&IO->send_event, &got_out, fd, EV_WRITE);
342 curl_multi_assign(mhnd, fd, IO);
345 SetEVState(IO, eCurlGotIO);
346 IO->Now = ev_now(event_base);
352 Action = "CURL_POLL_NONE";
354 case CURL_POLL_REMOVE:
355 Action = "CURL_POLL_REMOVE";
358 Action = "CURL_POLL_IN";
361 Action = "CURL_POLL_OUT";
363 case CURL_POLL_INOUT:
364 Action = "CURL_POLL_INOUT";
369 EVCURL_syslog(LOG_DEBUG,
370 "EVCURL: gotwatchsock called fd=%d action=%s[%d]\n",
371 (int)fd, Action, action);
376 EVCURLM_syslog(LOG_DEBUG,
378 "to register this sockwatcker\n");
380 case CURL_POLL_REMOVE:
381 EVCURLM_syslog(LOG_DEBUG,
382 "called last time to unregister "
383 "this sockwatcher\n");
384 ev_io_stop(event_base, &IO->recv_event);
385 ev_io_stop(event_base, &IO->send_event);
388 ev_io_start(event_base, &IO->recv_event);
389 ev_io_stop(event_base, &IO->send_event);
392 ev_io_start(event_base, &IO->send_event);
393 ev_io_stop(event_base, &IO->recv_event);
395 case CURL_POLL_INOUT:
396 ev_io_start(event_base, &IO->send_event);
397 ev_io_start(event_base, &IO->recv_event);
403 void curl_init_connectionpool(void)
407 ev_timer_init(&global.timeev, &gottime, 14.0, 14.0);
408 global.timeev.data = (void *)&global;
410 CURLcode sta = curl_global_init(CURL_GLOBAL_ALL);
415 "error initializing curl library: %s\n",
416 curl_easy_strerror(sta));
420 mhnd = global.mhnd = curl_multi_init();
423 CURLM_syslog(LOG_ERR,
424 "error initializing curl multi handle\n");
428 MOPT(SOCKETFUNCTION, &gotwatchsock);
429 MOPT(SOCKETDATA, (void *)&global);
430 MOPT(TIMERFUNCTION, &gotwatchtime);
431 MOPT(TIMERDATA, (void *)&global);
436 int evcurl_init(AsyncIO *IO)
441 EVCURLM_syslog(LOG_DEBUG, "EVCURL: evcurl_init called ms\n");
442 IO->HttpReq.attached = 0;
443 chnd = IO->HttpReq.chnd = curl_easy_init();
446 EVCURLM_syslog(LOG_ERR, "EVCURL: error initializing curl handle\n");
451 OPT(VERBOSE, (long)1);
456 OPT(FAILONERROR, (long)1);
458 OPT(FOLLOWLOCATION, (long)0);
459 OPT(MAXREDIRS, (long)0);
460 OPT(USERAGENT, CITADEL);
462 OPT(TIMEOUT, (long)1800);
463 OPT(LOW_SPEED_LIMIT, (long)64);
464 OPT(LOW_SPEED_TIME, (long)600);
465 OPT(CONNECTTIMEOUT, (long)600);
466 OPT(PRIVATE, (void *)IO);
468 OPT(FORBID_REUSE, 1);
469 OPT(WRITEFUNCTION, &gotdata);
470 OPT(WRITEDATA, (void *)IO);
471 OPT(ERRORBUFFER, IO->HttpReq.errdesc);
473 if ((!IsEmptyStr(config.c_ip_addr))
474 && (strcmp(config.c_ip_addr, "*"))
475 && (strcmp(config.c_ip_addr, "::"))
476 && (strcmp(config.c_ip_addr, "0.0.0.0"))
479 OPT(INTERFACE, config.c_ip_addr);
482 #ifdef CURLOPT_HTTP_CONTENT_DECODING
483 OPT(HTTP_CONTENT_DECODING, 1);
487 IO->HttpReq.headers = curl_slist_append(IO->HttpReq.headers,
488 "Connection: close");
494 static void IOcurl_abort_shutdown_callback(struct ev_loop *loop,
499 AsyncIO *IO = watcher->data;
504 SetEVState(IO, eCurlShutdown);
505 IO->Now = ev_now(event_base);
506 EVCURL_syslog(LOG_DEBUG, "EVENT Curl: %s\n", __FUNCTION__);
508 curl_slist_free_all(IO->HttpReq.headers);
509 msta = curl_multi_remove_handle(global.mhnd, IO->HttpReq.chnd);
512 EVCURL_syslog(LOG_ERR,
513 "EVCURL: warning problem detaching completed handle "
514 "from curl multi: %s\n",
515 curl_multi_strerror(msta));
518 curl_easy_cleanup(IO->HttpReq.chnd);
519 IO->HttpReq.chnd = NULL;
520 ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
521 ev_io_stop(event_base, &IO->recv_event);
522 ev_io_stop(event_base, &IO->send_event);
523 assert(IO->ShutdownAbort);
524 IO->ShutdownAbort(IO);
527 evcurl_handle_start(AsyncIO *IO)
533 SetEVState(IO, eCurlStart);
534 chnd = IO->HttpReq.chnd;
535 EVCURL_syslog(LOG_DEBUG,
536 "EVCURL: Loading URL: %s\n", IO->ConnectMe->PlainUrl);
537 OPT(URL, IO->ConnectMe->PlainUrl);
538 if (StrLength(IO->ConnectMe->CurlCreds))
540 OPT(HTTPAUTH, (long)CURLAUTH_BASIC);
541 OPT(USERPWD, ChrPtr(IO->ConnectMe->CurlCreds));
543 if (StrLength(IO->HttpReq.PostData) > 0)
545 OPT(POSTFIELDS, ChrPtr(IO->HttpReq.PostData));
546 OPT(POSTFIELDSIZE, StrLength(IO->HttpReq.PostData));
549 else if ((IO->HttpReq.PlainPostDataLen != 0) &&
550 (IO->HttpReq.PlainPostData != NULL))
552 OPT(POSTFIELDS, IO->HttpReq.PlainPostData);
553 OPT(POSTFIELDSIZE, IO->HttpReq.PlainPostDataLen);
555 OPT(HTTPHEADER, IO->HttpReq.headers);
557 IO->NextState = eConnect;
558 EVCURLM_syslog(LOG_DEBUG, "EVCURL: attaching to curl multi handle\n");
559 msta = curl_multi_add_handle(global.mhnd, IO->HttpReq.chnd);
562 EVCURL_syslog(LOG_ERR,
563 "EVCURL: error attaching to curl multi handle: %s\n",
564 curl_multi_strerror(msta));
567 IO->HttpReq.attached = 1;
568 ev_async_send (event_base, &WakeupCurl);
570 ev_cleanup_init(&IO->abort_by_shutdown,
571 IOcurl_abort_shutdown_callback);
573 ev_cleanup_start(event_base, &IO->abort_by_shutdown);
578 static void WakeupCurlCallback(EV_P_ ev_async *w, int revents)
580 CURLM_syslog(LOG_DEBUG, "waking up curl multi handle\n");
582 curl_multi_perform(&global, CURL_POLL_NONE);
585 static void evcurl_shutdown (void)
587 curl_global_cleanup();
588 curl_multi_cleanup(global.mhnd);
589 CURLM_syslog(LOG_DEBUG, "exiting\n");
591 /*****************************************************************************
592 * libevent integration *
593 *****************************************************************************/
595 * client event queue plus its methods.
596 * this currently is the main loop (which may change in some future?)
598 int evbase_count = 0;
599 pthread_mutex_t EventQueueMutex; /* locks the access to the following vars: */
600 pthread_mutex_t EventExitQueueMutex; /* locks the access to the event queue pointer on exit. */
601 HashList *QueueEvents = NULL;
602 HashList *InboundEventQueue = NULL;
603 HashList *InboundEventQueues[2] = { NULL, NULL };
604 extern void ShutDownCLient(AsyncIO *IO);
607 ev_async ExitEventLoop;
609 static void QueueEventAddCallback(EV_P_ ev_async *w, int revents)
619 /* get the control command... */
620 pthread_mutex_lock(&EventQueueMutex);
622 if (InboundEventQueues[0] == InboundEventQueue) {
623 InboundEventQueue = InboundEventQueues[1];
624 q = InboundEventQueues[0];
627 InboundEventQueue = InboundEventQueues[0];
628 q = InboundEventQueues[1];
630 pthread_mutex_unlock(&EventQueueMutex);
631 Now = ev_now (event_base);
632 It = GetNewHashPos(q, 0);
633 while (GetNextHashPos(q, It, &len, &Key, &v))
636 if (h->IO->ID == 0) {
637 h->IO->ID = EvIDSource++;
639 if (h->IO->StartIO == 0.0)
640 h->IO->StartIO = Now;
642 SetEVState(h->IO, eIOAttach);
644 Ctx = h->IO->CitContext;
648 switch (h->EvAttch(h->IO))
662 case eTerminateConnection:
664 ShutDownCLient(h->IO);
669 DeleteHashContent(&q);
670 EVQM_syslog(LOG_DEBUG, "EVENT Q Add done.\n");
674 static void EventExitCallback(EV_P_ ev_async *w, int revents)
676 ev_break(event_base, EVBREAK_ALL);
678 EVQM_syslog(LOG_DEBUG, "EVENT Q exiting.\n");
683 void InitEventQueue(void)
685 pthread_mutex_init(&EventQueueMutex, NULL);
686 pthread_mutex_init(&EventExitQueueMutex, NULL);
688 QueueEvents = NewHash(1, Flathash);
689 InboundEventQueues[0] = NewHash(1, Flathash);
690 InboundEventQueues[1] = NewHash(1, Flathash);
691 InboundEventQueue = InboundEventQueues[0];
693 extern void CtdlDestroyEVCleanupHooks(void);
695 extern int EVQShutDown;
697 * this thread operates the select() etc. via libev.
699 void *client_event_thread(void *arg)
701 struct CitContext libev_client_CC;
703 CtdlFillSystemContext(&libev_client_CC, "LibEv Thread");
704 // citthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
705 EVQM_syslog(LOG_DEBUG, "client_event_thread() initializing\n");
707 event_base = ev_default_loop (EVFLAG_AUTO);
708 ev_async_init(&AddJob, QueueEventAddCallback);
709 ev_async_start(event_base, &AddJob);
710 ev_async_init(&ExitEventLoop, EventExitCallback);
711 ev_async_start(event_base, &ExitEventLoop);
712 ev_async_init(&WakeupCurl, WakeupCurlCallback);
713 ev_async_start(event_base, &WakeupCurl);
715 curl_init_connectionpool();
717 ev_run (event_base, 0);
719 EVQM_syslog(LOG_DEBUG, "client_event_thread() exiting\n");
721 ///what todo here? CtdlClearSystemContext();
722 pthread_mutex_lock(&EventExitQueueMutex);
723 ev_loop_destroy (EV_DEFAULT_UC);
725 DeleteHash(&QueueEvents);
726 InboundEventQueue = NULL;
727 DeleteHash(&InboundEventQueues[0]);
728 DeleteHash(&InboundEventQueues[1]);
729 /* citthread_mutex_destroy(&EventQueueMutex); TODO */
732 CtdlDestroyEVCleanupHooks();
734 pthread_mutex_unlock(&EventExitQueueMutex);
739 /*----------------------------------------------------------------------------*/
741 * DB-Queue; does async bdb operations.
742 * has its own set of handlers.
746 pthread_mutex_t DBEventQueueMutex; /* locks the access to the following vars: */
747 pthread_mutex_t DBEventExitQueueMutex; /* locks the access to the db-event queue pointer on exit. */
748 HashList *DBQueueEvents = NULL;
749 HashList *DBInboundEventQueue = NULL;
750 HashList *DBInboundEventQueues[2] = { NULL, NULL };
753 ev_async DBExitEventLoop;
755 extern void ShutDownDBCLient(AsyncIO *IO);
757 static void DBQueueEventAddCallback(EV_P_ ev_async *w, int revents)
767 /* get the control command... */
768 pthread_mutex_lock(&DBEventQueueMutex);
770 if (DBInboundEventQueues[0] == DBInboundEventQueue) {
771 DBInboundEventQueue = DBInboundEventQueues[1];
772 q = DBInboundEventQueues[0];
775 DBInboundEventQueue = DBInboundEventQueues[0];
776 q = DBInboundEventQueues[1];
778 pthread_mutex_unlock(&DBEventQueueMutex);
780 Now = ev_now (event_db);
781 It = GetNewHashPos(q, 0);
782 while (GetNextHashPos(q, It, &len, &Key, &v))
787 h->IO->ID = EvIDSource++;
788 if (h->IO->StartDB == 0.0)
789 h->IO->StartDB = Now;
792 SetEVState(h->IO, eDBAttach);
793 Ctx = h->IO->CitContext;
795 ev_cleanup_start(event_db, &h->IO->db_abort_by_shutdown);
796 rc = h->EvAttch(h->IO);
800 ShutDownDBCLient(h->IO);
806 DeleteHashContent(&q);
807 EVQM_syslog(LOG_DEBUG, "DBEVENT Q Add done.\n");
811 static void DBEventExitCallback(EV_P_ ev_async *w, int revents)
813 EVQM_syslog(LOG_DEBUG, "DB EVENT Q exiting.\n");
814 ev_break(event_db, EVBREAK_ALL);
819 void DBInitEventQueue(void)
821 pthread_mutex_init(&DBEventQueueMutex, NULL);
822 pthread_mutex_init(&DBEventExitQueueMutex, NULL);
824 DBQueueEvents = NewHash(1, Flathash);
825 DBInboundEventQueues[0] = NewHash(1, Flathash);
826 DBInboundEventQueues[1] = NewHash(1, Flathash);
827 DBInboundEventQueue = DBInboundEventQueues[0];
831 * this thread operates writing to the message database via libev.
833 void *db_event_thread(void *arg)
836 struct CitContext libev_msg_CC;
838 CtdlFillSystemContext(&libev_msg_CC, "LibEv DB IO Thread");
840 EVQM_syslog(LOG_DEBUG, "dbevent_thread() initializing\n");
842 tmp = event_db = ev_loop_new (EVFLAG_AUTO);
844 ev_async_init(&DBAddJob, DBQueueEventAddCallback);
845 ev_async_start(event_db, &DBAddJob);
846 ev_async_init(&DBExitEventLoop, DBEventExitCallback);
847 ev_async_start(event_db, &DBExitEventLoop);
849 ev_run (event_db, 0);
851 pthread_mutex_lock(&DBEventExitQueueMutex);
854 EVQM_syslog(LOG_INFO, "dbevent_thread() exiting\n");
856 DeleteHash(&DBQueueEvents);
857 DBInboundEventQueue = NULL;
858 DeleteHash(&DBInboundEventQueues[0]);
859 DeleteHash(&DBInboundEventQueues[1]);
861 /* citthread_mutex_destroy(&DBEventQueueMutex); TODO */
863 ev_loop_destroy (tmp);
864 pthread_mutex_unlock(&DBEventExitQueueMutex);
868 void ShutDownEventQueues(void)
870 EVQM_syslog(LOG_DEBUG, "EVENT Qs triggering exits.\n");
872 pthread_mutex_lock(&DBEventQueueMutex);
873 ev_async_send (event_db, &DBExitEventLoop);
874 pthread_mutex_unlock(&DBEventQueueMutex);
876 pthread_mutex_lock(&EventQueueMutex);
877 ev_async_send (EV_DEFAULT_ &ExitEventLoop);
878 pthread_mutex_unlock(&EventQueueMutex);
881 void DebugEventloopEnable(const int n)
885 void DebugEventloopBacktraceEnable(const int n)
887 DebugEventLoopBacktrace = n;
890 void DebugCurlEnable(const int n)
895 CTDL_MODULE_INIT(event_client)
899 CtdlRegisterDebugFlagHook(HKEY("eventloop"), DebugEventloopEnable, &DebugEventLoop);
900 CtdlRegisterDebugFlagHook(HKEY("eventloopbacktrace"), DebugEventloopBacktraceEnable, &DebugEventLoopBacktrace);
901 CtdlRegisterDebugFlagHook(HKEY("curl"), DebugCurlEnable, &DebugCurl);
904 CtdlThreadCreate(client_event_thread);
905 CtdlThreadCreate(db_event_thread);