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))
207 case eTerminateConnection:
209 curl_easy_cleanup(IO->HttpReq.chnd);
210 IO->HttpReq.chnd = NULL;
211 FreeStrBuf(&IO->HttpReq.ReplyData);
212 FreeURL(&IO->ConnectMe);
213 RemoveContext(IO->CitContext);
221 stepmulti(void *data, curl_socket_t fd, int which)
223 int running_handles = 0;
226 msta = curl_multi_socket_action(global.mhnd,
231 CURLM_syslog(LOG_DEBUG, "stepmulti(): calling gotstatus()\n");
234 "error in curl processing events"
235 "on multi handle, fd %d: %s\n",
237 curl_multi_strerror(msta));
239 if (global.nrun != running_handles)
240 gotstatus(running_handles);
244 gottime(struct ev_loop *loop, ev_timer *timeev, int events)
246 CURLM_syslog(LOG_DEBUG, "EVCURL: waking up curl for timeout\n");
247 stepmulti(NULL, CURL_SOCKET_TIMEOUT, 0);
251 got_in(struct ev_loop *loop, ev_io *ioev, int events)
253 CURL_syslog(LOG_DEBUG,
254 "EVCURL: waking up curl for io on fd %d\n",
257 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_IN);
261 got_out(struct ev_loop *loop, ev_io *ioev, int events)
263 CURL_syslog(LOG_DEBUG,
264 "waking up curl for io on fd %d\n",
267 stepmulti(ioev->data, ioev->fd, CURL_CSELECT_OUT);
271 gotdata(void *data, size_t size, size_t nmemb, void *cglobal)
273 AsyncIO *IO = (AsyncIO*) cglobal;
275 SetEVState(IO, eCurlGotData);
276 if (IO->HttpReq.ReplyData == NULL)
278 IO->HttpReq.ReplyData = NewStrBufPlain(NULL, SIZ);
280 IO->Now = ev_now(event_base);
281 return CurlFillStrBuf_callback(data,
284 IO->HttpReq.ReplyData);
288 gotwatchtime(CURLM *multi, long tblock_ms, void *cglobal) {
289 CURL_syslog(LOG_DEBUG, "EVCURL: gotwatchtime called %ld ms\n", tblock_ms);
290 evcurl_global_data *global = cglobal;
291 ev_timer_stop(EV_DEFAULT, &global->timeev);
292 if (tblock_ms < 0 || 14000 < tblock_ms)
294 ev_timer_set(&global->timeev, 0.5e-3 + 1.0e-3 * tblock_ms, 14.0);
295 ev_timer_start(EV_DEFAULT_UC, &global->timeev);
296 curl_multi_perform(global, &global->nrun);
301 gotwatchsock(CURL *easy,
307 evcurl_global_data *global = cglobal;
308 CURLM *mhnd = global->mhnd;
310 AsyncIO *IO = (AsyncIO*) vIO;
315 sta = curl_easy_getinfo(easy, CURLINFO_PRIVATE, &f);
318 "EVCURL: error asking curl for private "
319 "cookie of curl handle: %s\n",
320 curl_easy_strerror(sta));
324 SetEVState(IO, eCurlNewIO);
325 EVCURL_syslog(LOG_DEBUG,
326 "EVCURL: got socket for URL: %s\n",
327 IO->ConnectMe->PlainUrl);
329 if (IO->SendBuf.fd != 0)
331 ev_io_stop(event_base, &IO->recv_event);
332 ev_io_stop(event_base, &IO->send_event);
335 ev_io_init(&IO->recv_event, &got_in, fd, EV_READ);
336 ev_io_init(&IO->send_event, &got_out, fd, EV_WRITE);
337 curl_multi_assign(mhnd, fd, IO);
340 SetEVState(IO, eCurlGotIO);
341 IO->Now = ev_now(event_base);
347 Action = "CURL_POLL_NONE";
349 case CURL_POLL_REMOVE:
350 Action = "CURL_POLL_REMOVE";
353 Action = "CURL_POLL_IN";
356 Action = "CURL_POLL_OUT";
358 case CURL_POLL_INOUT:
359 Action = "CURL_POLL_INOUT";
364 EVCURL_syslog(LOG_DEBUG,
365 "EVCURL: gotwatchsock called fd=%d action=%s[%d]\n",
366 (int)fd, Action, action);
371 EVCURLM_syslog(LOG_DEBUG,
373 "to register this sockwatcker\n");
375 case CURL_POLL_REMOVE:
376 EVCURLM_syslog(LOG_DEBUG,
377 "called last time to unregister "
378 "this sockwatcher\n");
379 ev_io_stop(event_base, &IO->recv_event);
380 ev_io_stop(event_base, &IO->send_event);
383 ev_io_start(event_base, &IO->recv_event);
384 ev_io_stop(event_base, &IO->send_event);
387 ev_io_start(event_base, &IO->send_event);
388 ev_io_stop(event_base, &IO->recv_event);
390 case CURL_POLL_INOUT:
391 ev_io_start(event_base, &IO->send_event);
392 ev_io_start(event_base, &IO->recv_event);
398 void curl_init_connectionpool(void)
402 ev_timer_init(&global.timeev, &gottime, 14.0, 14.0);
403 global.timeev.data = (void *)&global;
405 CURLcode sta = curl_global_init(CURL_GLOBAL_ALL);
410 "error initializing curl library: %s\n",
411 curl_easy_strerror(sta));
415 mhnd = global.mhnd = curl_multi_init();
418 CURLM_syslog(LOG_ERR,
419 "error initializing curl multi handle\n");
423 MOPT(SOCKETFUNCTION, &gotwatchsock);
424 MOPT(SOCKETDATA, (void *)&global);
425 MOPT(TIMERFUNCTION, &gotwatchtime);
426 MOPT(TIMERDATA, (void *)&global);
431 int evcurl_init(AsyncIO *IO)
436 EVCURLM_syslog(LOG_DEBUG, "EVCURL: evcurl_init called ms\n");
437 IO->HttpReq.attached = 0;
438 chnd = IO->HttpReq.chnd = curl_easy_init();
441 EVCURLM_syslog(LOG_ERR, "EVCURL: error initializing curl handle\n");
446 OPT(VERBOSE, (long)1);
451 OPT(FAILONERROR, (long)1);
453 OPT(FOLLOWLOCATION, (long)0);
454 OPT(MAXREDIRS, (long)0);
455 OPT(USERAGENT, CITADEL);
457 OPT(TIMEOUT, (long)1800);
458 OPT(LOW_SPEED_LIMIT, (long)64);
459 OPT(LOW_SPEED_TIME, (long)600);
460 OPT(CONNECTTIMEOUT, (long)600);
461 OPT(PRIVATE, (void *)IO);
463 OPT(FORBID_REUSE, 1);
464 OPT(WRITEFUNCTION, &gotdata);
465 OPT(WRITEDATA, (void *)IO);
466 OPT(ERRORBUFFER, IO->HttpReq.errdesc);
468 if ((!IsEmptyStr(config.c_ip_addr))
469 && (strcmp(config.c_ip_addr, "*"))
470 && (strcmp(config.c_ip_addr, "::"))
471 && (strcmp(config.c_ip_addr, "0.0.0.0"))
474 OPT(INTERFACE, config.c_ip_addr);
477 #ifdef CURLOPT_HTTP_CONTENT_DECODING
478 OPT(HTTP_CONTENT_DECODING, 1);
482 IO->HttpReq.headers = curl_slist_append(IO->HttpReq.headers,
483 "Connection: close");
489 static void IOcurl_abort_shutdown_callback(struct ev_loop *loop,
494 AsyncIO *IO = watcher->data;
499 SetEVState(IO, eCurlShutdown);
500 IO->Now = ev_now(event_base);
501 EVCURL_syslog(LOG_DEBUG, "EVENT Curl: %s\n", __FUNCTION__);
503 curl_slist_free_all(IO->HttpReq.headers);
504 msta = curl_multi_remove_handle(global.mhnd, IO->HttpReq.chnd);
507 EVCURL_syslog(LOG_ERR,
508 "EVCURL: warning problem detaching completed handle "
509 "from curl multi: %s\n",
510 curl_multi_strerror(msta));
513 curl_easy_cleanup(IO->HttpReq.chnd);
514 IO->HttpReq.chnd = NULL;
515 ev_cleanup_stop(event_base, &IO->abort_by_shutdown);
516 ev_io_stop(event_base, &IO->recv_event);
517 ev_io_stop(event_base, &IO->send_event);
518 assert(IO->ShutdownAbort);
519 IO->ShutdownAbort(IO);
522 evcurl_handle_start(AsyncIO *IO)
528 SetEVState(IO, eCurlStart);
529 chnd = IO->HttpReq.chnd;
530 EVCURL_syslog(LOG_DEBUG,
531 "EVCURL: Loading URL: %s\n", IO->ConnectMe->PlainUrl);
532 OPT(URL, IO->ConnectMe->PlainUrl);
533 if (StrLength(IO->ConnectMe->CurlCreds))
535 OPT(HTTPAUTH, (long)CURLAUTH_BASIC);
536 OPT(USERPWD, ChrPtr(IO->ConnectMe->CurlCreds));
538 if (StrLength(IO->HttpReq.PostData) > 0)
540 OPT(POSTFIELDS, ChrPtr(IO->HttpReq.PostData));
541 OPT(POSTFIELDSIZE, StrLength(IO->HttpReq.PostData));
544 else if ((IO->HttpReq.PlainPostDataLen != 0) &&
545 (IO->HttpReq.PlainPostData != NULL))
547 OPT(POSTFIELDS, IO->HttpReq.PlainPostData);
548 OPT(POSTFIELDSIZE, IO->HttpReq.PlainPostDataLen);
550 OPT(HTTPHEADER, IO->HttpReq.headers);
552 IO->NextState = eConnect;
553 EVCURLM_syslog(LOG_DEBUG, "EVCURL: attaching to curl multi handle\n");
554 msta = curl_multi_add_handle(global.mhnd, IO->HttpReq.chnd);
557 EVCURL_syslog(LOG_ERR,
558 "EVCURL: error attaching to curl multi handle: %s\n",
559 curl_multi_strerror(msta));
562 IO->HttpReq.attached = 1;
563 ev_async_send (event_base, &WakeupCurl);
565 ev_cleanup_init(&IO->abort_by_shutdown,
566 IOcurl_abort_shutdown_callback);
568 ev_cleanup_start(event_base, &IO->abort_by_shutdown);
573 static void WakeupCurlCallback(EV_P_ ev_async *w, int revents)
575 CURLM_syslog(LOG_DEBUG, "waking up curl multi handle\n");
577 curl_multi_perform(&global, CURL_POLL_NONE);
580 static void evcurl_shutdown (void)
582 curl_global_cleanup();
583 curl_multi_cleanup(global.mhnd);
584 CURLM_syslog(LOG_DEBUG, "exiting\n");
586 /*****************************************************************************
587 * libevent integration *
588 *****************************************************************************/
590 * client event queue plus its methods.
591 * this currently is the main loop (which may change in some future?)
593 int evbase_count = 0;
594 pthread_mutex_t EventQueueMutex; /* locks the access to the following vars: */
595 pthread_mutex_t EventExitQueueMutex; /* locks the access to the event queue pointer on exit. */
596 HashList *QueueEvents = NULL;
597 HashList *InboundEventQueue = NULL;
598 HashList *InboundEventQueues[2] = { NULL, NULL };
599 extern void ShutDownCLient(AsyncIO *IO);
602 ev_async ExitEventLoop;
604 static void QueueEventAddCallback(EV_P_ ev_async *w, int revents)
614 /* get the control command... */
615 pthread_mutex_lock(&EventQueueMutex);
617 if (InboundEventQueues[0] == InboundEventQueue) {
618 InboundEventQueue = InboundEventQueues[1];
619 q = InboundEventQueues[0];
622 InboundEventQueue = InboundEventQueues[0];
623 q = InboundEventQueues[1];
625 pthread_mutex_unlock(&EventQueueMutex);
626 Now = ev_now (event_base);
627 It = GetNewHashPos(q, 0);
628 while (GetNextHashPos(q, It, &len, &Key, &v))
631 if (h->IO->ID == 0) {
632 h->IO->ID = EvIDSource++;
634 if (h->IO->StartIO == 0.0)
635 h->IO->StartIO = Now;
637 SetEVState(h->IO, eIOAttach);
639 Ctx = h->IO->CitContext;
643 switch (h->EvAttch(h->IO))
657 case eTerminateConnection:
659 ShutDownCLient(h->IO);
664 DeleteHashContent(&q);
665 EVQM_syslog(LOG_DEBUG, "EVENT Q Add done.\n");
669 static void EventExitCallback(EV_P_ ev_async *w, int revents)
671 ev_break(event_base, EVBREAK_ALL);
673 EVQM_syslog(LOG_DEBUG, "EVENT Q exiting.\n");
678 void InitEventQueue(void)
680 pthread_mutex_init(&EventQueueMutex, NULL);
681 pthread_mutex_init(&EventExitQueueMutex, NULL);
683 QueueEvents = NewHash(1, Flathash);
684 InboundEventQueues[0] = NewHash(1, Flathash);
685 InboundEventQueues[1] = NewHash(1, Flathash);
686 InboundEventQueue = InboundEventQueues[0];
688 extern void CtdlDestroyEVCleanupHooks(void);
690 extern int EVQShutDown;
692 * this thread operates the select() etc. via libev.
694 void *client_event_thread(void *arg)
696 struct CitContext libev_client_CC;
698 CtdlFillSystemContext(&libev_client_CC, "LibEv Thread");
699 // citthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
700 EVQM_syslog(LOG_DEBUG, "client_event_thread() initializing\n");
702 event_base = ev_default_loop (EVFLAG_AUTO);
703 ev_async_init(&AddJob, QueueEventAddCallback);
704 ev_async_start(event_base, &AddJob);
705 ev_async_init(&ExitEventLoop, EventExitCallback);
706 ev_async_start(event_base, &ExitEventLoop);
707 ev_async_init(&WakeupCurl, WakeupCurlCallback);
708 ev_async_start(event_base, &WakeupCurl);
710 curl_init_connectionpool();
712 ev_run (event_base, 0);
714 EVQM_syslog(LOG_DEBUG, "client_event_thread() exiting\n");
716 ///what todo here? CtdlClearSystemContext();
717 pthread_mutex_lock(&EventExitQueueMutex);
718 ev_loop_destroy (EV_DEFAULT_UC);
720 DeleteHash(&QueueEvents);
721 InboundEventQueue = NULL;
722 DeleteHash(&InboundEventQueues[0]);
723 DeleteHash(&InboundEventQueues[1]);
724 /* citthread_mutex_destroy(&EventQueueMutex); TODO */
727 CtdlDestroyEVCleanupHooks();
729 pthread_mutex_unlock(&EventExitQueueMutex);
734 /*----------------------------------------------------------------------------*/
736 * DB-Queue; does async bdb operations.
737 * has its own set of handlers.
741 pthread_mutex_t DBEventQueueMutex; /* locks the access to the following vars: */
742 pthread_mutex_t DBEventExitQueueMutex; /* locks the access to the db-event queue pointer on exit. */
743 HashList *DBQueueEvents = NULL;
744 HashList *DBInboundEventQueue = NULL;
745 HashList *DBInboundEventQueues[2] = { NULL, NULL };
748 ev_async DBExitEventLoop;
750 extern void ShutDownDBCLient(AsyncIO *IO);
752 static void DBQueueEventAddCallback(EV_P_ ev_async *w, int revents)
762 /* get the control command... */
763 pthread_mutex_lock(&DBEventQueueMutex);
765 if (DBInboundEventQueues[0] == DBInboundEventQueue) {
766 DBInboundEventQueue = DBInboundEventQueues[1];
767 q = DBInboundEventQueues[0];
770 DBInboundEventQueue = DBInboundEventQueues[0];
771 q = DBInboundEventQueues[1];
773 pthread_mutex_unlock(&DBEventQueueMutex);
775 Now = ev_now (event_db);
776 It = GetNewHashPos(q, 0);
777 while (GetNextHashPos(q, It, &len, &Key, &v))
782 h->IO->ID = EvIDSource++;
783 if (h->IO->StartDB == 0.0)
784 h->IO->StartDB = Now;
787 SetEVState(h->IO, eDBAttach);
788 Ctx = h->IO->CitContext;
790 ev_cleanup_start(event_db, &h->IO->db_abort_by_shutdown);
791 rc = h->EvAttch(h->IO);
795 ShutDownDBCLient(h->IO);
801 DeleteHashContent(&q);
802 EVQM_syslog(LOG_DEBUG, "DBEVENT Q Add done.\n");
806 static void DBEventExitCallback(EV_P_ ev_async *w, int revents)
808 EVQM_syslog(LOG_DEBUG, "DB EVENT Q exiting.\n");
809 ev_break(event_db, EVBREAK_ALL);
814 void DBInitEventQueue(void)
816 pthread_mutex_init(&DBEventQueueMutex, NULL);
817 pthread_mutex_init(&DBEventExitQueueMutex, NULL);
819 DBQueueEvents = NewHash(1, Flathash);
820 DBInboundEventQueues[0] = NewHash(1, Flathash);
821 DBInboundEventQueues[1] = NewHash(1, Flathash);
822 DBInboundEventQueue = DBInboundEventQueues[0];
826 * this thread operates writing to the message database via libev.
828 void *db_event_thread(void *arg)
831 struct CitContext libev_msg_CC;
833 CtdlFillSystemContext(&libev_msg_CC, "LibEv DB IO Thread");
835 EVQM_syslog(LOG_DEBUG, "dbevent_thread() initializing\n");
837 tmp = event_db = ev_loop_new (EVFLAG_AUTO);
839 ev_async_init(&DBAddJob, DBQueueEventAddCallback);
840 ev_async_start(event_db, &DBAddJob);
841 ev_async_init(&DBExitEventLoop, DBEventExitCallback);
842 ev_async_start(event_db, &DBExitEventLoop);
844 ev_run (event_db, 0);
846 pthread_mutex_lock(&DBEventExitQueueMutex);
849 EVQM_syslog(LOG_INFO, "dbevent_thread() exiting\n");
851 DeleteHash(&DBQueueEvents);
852 DBInboundEventQueue = NULL;
853 DeleteHash(&DBInboundEventQueues[0]);
854 DeleteHash(&DBInboundEventQueues[1]);
856 /* citthread_mutex_destroy(&DBEventQueueMutex); TODO */
858 ev_loop_destroy (tmp);
859 pthread_mutex_unlock(&DBEventExitQueueMutex);
863 void ShutDownEventQueues(void)
865 EVQM_syslog(LOG_DEBUG, "EVENT Qs triggering exits.\n");
867 pthread_mutex_lock(&DBEventQueueMutex);
868 ev_async_send (event_db, &DBExitEventLoop);
869 pthread_mutex_unlock(&DBEventQueueMutex);
871 pthread_mutex_lock(&EventQueueMutex);
872 ev_async_send (EV_DEFAULT_ &ExitEventLoop);
873 pthread_mutex_unlock(&EventQueueMutex);
876 void DebugEventloopEnable(const int n)
880 void DebugEventloopBacktraceEnable(const int n)
882 DebugEventLoopBacktrace = n;
885 void DebugCurlEnable(const int n)
890 CTDL_MODULE_INIT(event_client)
894 CtdlRegisterDebugFlagHook(HKEY("eventloop"), DebugEventloopEnable, &DebugEventLoop);
895 CtdlRegisterDebugFlagHook(HKEY("eventloopbacktrace"), DebugEventloopBacktraceEnable, &DebugEventLoopBacktrace);
896 CtdlRegisterDebugFlagHook(HKEY("curl"), DebugCurlEnable, &DebugCurl);
899 CtdlThreadCreate(client_event_thread);
900 CtdlThreadCreate(db_event_thread);