2 * This module handles shared rooms, inter-Citadel mail, and outbound
3 * mailing list processing.
5 * Copyright (c) 2000-2011 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * ** NOTE ** A word on the S_NETCONFIGS semaphore:
22 * This is a fairly high-level type of critical section. It ensures that no
23 * two threads work on the netconfigs files at the same time. Since we do
24 * so many things inside these, here are the rules:
25 * 1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
26 * 2. Do *not* perform any I/O with the client during these sections.
41 #include <sys/types.h>
43 #if TIME_WITH_SYS_TIME
44 # include <sys/time.h>
48 # include <sys/time.h>
56 # if HAVE_SYS_SYSCALL_H
57 # include <sys/syscall.h>
64 #include <libcitadel.h>
67 #include "citserver.h"
73 #include "internet_addressing.h"
74 #include "serv_network.h"
75 #include "clientsocket.h"
77 #include "citadel_dirs.h"
86 #include "netconfig.h"
87 #include "ctdl_module.h"
89 struct CitContext networker_client_CC;
91 typedef enum _eNWCState {
106 typedef struct _async_networker {
108 DNSQueryParts HostLookup;
111 StrBuf *SpoolFileName;
112 StrBuf *tempFileName;
120 typedef eNextState(*NWClientHandler)(AsyncNetworker* NW);
121 eNextState nwc_get_one_host_ip(AsyncIO *IO);
123 eNextState nwc_connect_ip(AsyncIO *IO);
125 eNextState NWC_SendQUIT(AsyncNetworker *NW);
126 eNextState NWC_DispatchWriteDone(AsyncIO *IO);
128 void DeleteNetworker(void *vptr)
130 AsyncNetworker *NW = (AsyncNetworker *)vptr;
131 FreeStrBuf(&NW->SpoolFileName);
132 FreeStrBuf(&NW->tempFileName);
133 FreeStrBuf(&NW->node);
134 FreeStrBuf(&NW->host);
135 FreeStrBuf(&NW->port);
136 FreeStrBuf(&NW->secret);
137 FreeStrBuf(&NW->Url);
138 ((struct CitContext*)NW->IO.CitContext)->state = CON_IDLE;
139 ((struct CitContext*)NW->IO.CitContext)->kill_me = 1;
140 FreeAsyncIOContents(&NW->IO);
144 #define NWC_DBG_SEND() syslog(LOG_DEBUG, "NW client[%ld]: > %s", NW->n, ChrPtr(NW->IO.SendBuf.Buf))
145 #define NWC_DBG_READ() syslog(LOG_DEBUG, "NW client[%ld]: < %s\n", NW->n, ChrPtr(NW->IO.IOBuf))
146 #define NWC_OK (strncasecmp(ChrPtr(NW->IO.IOBuf), "+OK", 3) == 0)
148 eNextState FinalizeNetworker(AsyncIO *IO)
150 AsyncNetworker *NW = (AsyncNetworker *)IO->Data;
152 network_talking_to(SKEY(NW->node), NTT_REMOVE);
154 DeleteNetworker(IO->Data);
158 eNextState NWC_ReadGreeting(AsyncNetworker *NW)
160 char connected_to[SIZ];
162 /* Read the server greeting */
163 /* Check that the remote is who we think it is and warn the Aide if not */
164 extract_token (connected_to, ChrPtr(NW->IO.IOBuf), 1, ' ', sizeof connected_to);
165 if (strcmp(connected_to, ChrPtr(NW->node)) != 0)
167 StrBufPrintf(NW->IO.ErrMsg,
168 "Connected to node \"%s\" but I was expecting to connect to node \"%s\".",
169 connected_to, ChrPtr(NW->node));
170 syslog(LOG_ERR, "%s\n", ChrPtr(NW->IO.ErrMsg));
171 CtdlAideMessage(ChrPtr(NW->IO.ErrMsg), "Network error");
172 return eAbort;/// todo: aide message in anderer queue speichern
177 eNextState NWC_SendAuth(AsyncNetworker *NW)
179 /* We're talking to the correct node. Now identify ourselves. */
180 StrBufPrintf(NW->IO.SendBuf.Buf, "NETP %s|%s\n",
187 eNextState NWC_ReadAuthReply(AsyncNetworker *NW)
190 if (ChrPtr(NW->IO.IOBuf)[0] == '2')
196 StrBufPrintf(NW->IO.ErrMsg,
197 "Connected to node \"%s\" but my secret wasn't accurate.",
199 syslog(LOG_ERR, "%s\n", ChrPtr(NW->IO.ErrMsg));
200 CtdlAideMessage(ChrPtr(NW->IO.ErrMsg), "Network error");
206 eNextState NWC_SendNDOP(AsyncNetworker *NW)
208 NW->tempFileName = NewStrBuf();
209 NW->SpoolFileName = NewStrBuf();
210 StrBufPrintf(NW->tempFileName,
214 time(NULL),// TODO: get time from libev
216 StrBufPrintf(NW->SpoolFileName,
220 time(NULL),// TODO: get time from libev
223 /* We're talking to the correct node. Now identify ourselves. */
224 StrBufPlain(NW->IO.SendBuf.Buf, HKEY("NDOP\n"));
229 eNextState NWC_ReadNDOPReply(AsyncNetworker *NW)
233 if (ChrPtr(NW->IO.IOBuf)[0] == '2')
236 NW->IO.IOB.TotalSentAlready = 0;
237 TotalSendSize = atol (ChrPtr(NW->IO.IOBuf) + 4);
238 syslog(LOG_DEBUG, "Expecting to transfer %ld bytes\n", NW->IO.IOB.TotalSendSize);
239 if (TotalSendSize <= 0) {
240 NW->State = eNUOP - 1;
244 fd = open(ChrPtr(NW->SpoolFileName),
245 O_EXCL|O_CREAT|O_NONBLOCK|O_WRONLY,
250 "cannot open %s: %s\n",
251 ChrPtr(NW->SpoolFileName),
254 NW->State = eQUIT - 1;
257 FDIOBufferInit(&NW->IO.IOB, &NW->IO.RecvBuf, fd, TotalSendSize);
267 eNextState NWC_SendREAD(AsyncNetworker *NW)
271 if (NW->IO.IOB.TotalSentAlready < NW->IO.IOB.TotalSendSize)
274 * If shutting down we can exit here and unlink the temp file.
275 * this shouldn't loose us any messages.
277 if (server_shutting_down)
279 FDIOBufferDelete(&NW->IO.IOB);
280 unlink(ChrPtr(NW->tempFileName));
283 StrBufPrintf(NW->IO.SendBuf.Buf, "READ %ld|%ld\n",
284 NW->IO.IOB.TotalSentAlready,
285 NW->IO.IOB.TotalSendSize);
287 ((NW->IO.IOB.TotalSendSize - NW->IO.IOB.TotalSentAlready > IGNET_PACKET_SIZE)
288 ? IGNET_PACKET_SIZE :
289 (NW->IO.IOB.TotalSendSize - NW->IO.IOB.TotalSentAlready))
298 rc = NWC_DispatchWriteDone(&NW->IO);
305 eNextState NWC_ReadREADState(AsyncNetworker *NW)
308 if (ChrPtr(NW->IO.IOBuf)[0] == '6')
310 NW->IO.IOB.ChunkSendRemain =
311 NW->IO.IOB.ChunkSize = atol(ChrPtr(NW->IO.IOBuf)+4);
316 eNextState NWC_ReadREADBlobDone(AsyncNetworker *NW);
317 eNextState NWC_ReadREADBlob(AsyncNetworker *NW)
320 if (NW->IO.IOB.TotalSendSize == NW->IO.IOB.TotalSentAlready)
324 FDIOBufferDelete(&NW->IO.IOB);
326 if (link(ChrPtr(NW->SpoolFileName), ChrPtr(NW->tempFileName)) != 0) {
328 "Could not link %s to %s: %s\n",
329 ChrPtr(NW->tempFileName),
330 ChrPtr(NW->SpoolFileName),
334 unlink(ChrPtr(NW->tempFileName));
335 return NWC_DispatchWriteDone(&NW->IO);
339 NW->IO.IOB.ChunkSendRemain = NW->IO.IOB.ChunkSize;
340 return NWC_DispatchWriteDone(&NW->IO);
344 eNextState NWC_ReadREADBlobDone(AsyncNetworker *NW)
347 if (NW->IO.IOB.TotalSendSize == NW->IO.IOB.TotalSentAlready)
351 FDIOBufferDelete(&NW->IO.IOB);
353 if (link(ChrPtr(NW->SpoolFileName), ChrPtr(NW->tempFileName)) != 0) {
355 "Could not link %s to %s: %s\n",
356 ChrPtr(NW->tempFileName),
357 ChrPtr(NW->SpoolFileName),
361 unlink(ChrPtr(NW->tempFileName));
362 return NWC_DispatchWriteDone(&NW->IO);
366 NW->IO.IOB.ChunkSendRemain = NW->IO.IOB.ChunkSize;
367 return NWC_DispatchWriteDone(&NW->IO);
370 eNextState NWC_SendCLOS(AsyncNetworker *NW)
372 StrBufPlain(NW->IO.SendBuf.Buf, HKEY("CLOS\n"));
377 eNextState NWC_ReadCLOSReply(AsyncNetworker *NW)
380 if (ChrPtr(NW->IO.IOBuf)[0] != '2')
381 return eTerminateConnection;
386 eNextState NWC_SendNUOP(AsyncNetworker *NW)
393 StrBufPrintf(NW->tempFileName,
397 fd = open(ChrPtr(NW->tempFileName), O_RDONLY);
399 if (errno != ENOENT) {
401 "cannot open %s: %s\n",
402 ChrPtr(NW->tempFileName),
406 rc = NWC_SendQUIT(NW);
410 if (fstat(fd, &statbuf) == -1) {
411 syslog(9, "FSTAT FAILED %s [%s]--\n",
412 ChrPtr(NW->tempFileName),
414 if (fd > 0) close(fd);
417 TotalSendSize = statbuf.st_size;
418 if (TotalSendSize == 0) {
420 "Nothing to send.\n");
422 rc = NWC_SendQUIT(NW);
426 FDIOBufferInit(&NW->IO.IOB, &NW->IO.SendBuf, fd, TotalSendSize);
428 StrBufPlain(NW->IO.SendBuf.Buf, HKEY("NUOP\n"));
433 eNextState NWC_ReadNUOPReply(AsyncNetworker *NW)
436 if (ChrPtr(NW->IO.IOBuf)[0] != '2')
441 eNextState NWC_SendWRIT(AsyncNetworker *NW)
443 StrBufPrintf(NW->IO.SendBuf.Buf, "WRIT %ld\n",
444 NW->IO.IOB.TotalSendSize - NW->IO.IOB.TotalSentAlready);
448 eNextState NWC_ReadWRITReply(AsyncNetworker *NW)
451 if (ChrPtr(NW->IO.IOBuf)[0] != '7')
456 NW->IO.IOB.ChunkSendRemain =
457 NW->IO.IOB.ChunkSize = atol(ChrPtr(NW->IO.IOBuf)+4);
461 eNextState NWC_SendBlobDone(AsyncNetworker *NW)
464 if (NW->IO.IOB.TotalSendSize == NW->IO.IOB.TotalSentAlready)
468 FDIOBufferDelete(&NW->IO.IOB);
469 rc = NWC_DispatchWriteDone(&NW->IO);
475 NW->IO.IOB.ChunkSendRemain = NW->IO.IOB.ChunkSize;
476 return NWC_DispatchWriteDone(&NW->IO);
480 eNextState NWC_SendUCLS(AsyncNetworker *NW)
482 StrBufPlain(NW->IO.SendBuf.Buf, HKEY("UCLS 1\n"));
487 eNextState NWC_ReadUCLS(AsyncNetworker *NW)
491 syslog(LOG_NOTICE, "Sent %ld octets to <%s>\n", NW->IO.IOB.ChunkSize, ChrPtr(NW->node));
492 if (ChrPtr(NW->IO.IOBuf)[0] == '2') {
493 syslog(LOG_DEBUG, "Removing <%s>\n", ChrPtr(NW->tempFileName));
494 unlink(ChrPtr(NW->tempFileName));
499 eNextState NWC_SendQUIT(AsyncNetworker *NW)
501 StrBufPlain(NW->IO.SendBuf.Buf, HKEY("QUIT\n"));
507 eNextState NWC_ReadQUIT(AsyncNetworker *NW)
515 NWClientHandler NWC_ReadHandlers[] = {
528 long NWC_ConnTimeout = 100;
530 const long NWC_SendTimeouts[] = {
540 const ConstStr NWC[] = {
541 {HKEY("Connection broken during ")},
542 {HKEY("Connection broken during ")},
543 {HKEY("Connection broken during ")},
544 {HKEY("Connection broken during ")},
545 {HKEY("Connection broken during ")},
546 {HKEY("Connection broken during ")},
547 {HKEY("Connection broken during ")},
548 {HKEY("Connection broken during ")}
551 NWClientHandler NWC_SendHandlers[] = {
556 NWC_ReadREADBlobDone,
565 const long NWC_ReadTimeouts[] = {
581 eNextState nwc_get_one_host_ip_done(AsyncIO *IO)
583 AsyncNetworker *NW = IO->Data;
584 struct hostent *hostent;
588 hostent = NW->HostLookup.VParsedDNSReply;
589 if ((NW->HostLookup.DNSStatus == ARES_SUCCESS) &&
590 (hostent != NULL) ) {
591 memset(&NW->IO.ConnectMe->Addr, 0, sizeof(struct in6_addr));
592 if (NW->IO.ConnectMe->IPv6) {
593 memcpy(&NW->IO.ConnectMe->Addr.sin6_addr.s6_addr,
594 &hostent->h_addr_list[0],
595 sizeof(struct in6_addr));
597 NW->IO.ConnectMe->Addr.sin6_family = hostent->h_addrtype;
598 NW->IO.ConnectMe->Addr.sin6_port = htons(atol(ChrPtr(NW->port)));//// TODO use the one from the URL.
601 struct sockaddr_in *addr = (struct sockaddr_in*) &NW->IO.ConnectMe->Addr;
602 /* Bypass the ns lookup result like this: IO->Addr.sin_addr.s_addr = inet_addr("127.0.0.1"); */
603 // addr->sin_addr.s_addr = htonl((uint32_t)&hostent->h_addr_list[0]);
604 memcpy(&addr->sin_addr.s_addr,
605 hostent->h_addr_list[0],
608 addr->sin_family = hostent->h_addrtype;
609 addr->sin_port = htons(504);/// default citadel port
612 return nwc_connect_ip(IO);
619 eNextState nwc_get_one_host_ip(AsyncIO *IO)
621 AsyncNetworker *NW = IO->Data;
623 * here we start with the lookup of one host.
628 syslog(LOG_DEBUG, "NWC: %s\n", __FUNCTION__);
631 "NWC client[%ld]: looking up %s-Record %s : %d ...\n",
633 (NW->IO.ConnectMe->IPv6)? "aaaa": "a",
634 NW->IO.ConnectMe->Host,
635 NW->IO.ConnectMe->Port);
637 QueueQuery((NW->IO.ConnectMe->IPv6)? ns_t_aaaa : ns_t_a,
638 NW->IO.ConnectMe->Host,
641 nwc_get_one_host_ip_done);
642 IO->NextState = eReadDNSReply;
643 return IO->NextState;
646 * @brief lineread Handler; understands when to read more POP3 lines, and when this is a one-lined reply.
648 eReadState NWC_ReadServerStatus(AsyncIO *IO)
650 // AsyncNetworker *NW = IO->Data;
651 eReadState Finished = eBufferNotEmpty;
653 switch (IO->NextState) {
658 case eTerminateConnection:
660 Finished = eReadFail;
666 Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
678 eNextState NWC_FailNetworkConnection(AsyncIO *IO)
683 void NWC_SetTimeout(eNextState NextTCPState, AsyncNetworker *NW)
685 double Timeout = 0.0;
687 syslog(LOG_DEBUG, "NWC3: %s\n", __FUNCTION__);
689 switch (NextTCPState) {
695 Timeout = NWC_ReadTimeouts[NW->State];
706 case eTerminateConnection:
709 case eReadMore://// TODO
712 SetNextTimeout(&NW->IO, Timeout);
716 eNextState NWC_DispatchReadDone(AsyncIO *IO)
718 syslog(LOG_DEBUG, "NWC: %s\n", __FUNCTION__);
719 AsyncNetworker *NW = IO->Data;
722 rc = NWC_ReadHandlers[NW->State](NW);
725 NWC_SetTimeout(rc, NW);
728 eNextState NWC_DispatchWriteDone(AsyncIO *IO)
730 syslog(LOG_DEBUG, "NWC: %s\n", __FUNCTION__);
731 AsyncNetworker *NW = IO->Data;
734 rc = NWC_SendHandlers[NW->State](NW);
735 NWC_SetTimeout(rc, NW);
739 /*****************************************************************************/
740 /* Networker CLIENT ERROR CATCHERS */
741 /*****************************************************************************/
742 eNextState NWC_Terminate(AsyncIO *IO)
744 syslog(LOG_DEBUG, "Nw: %s\n", __FUNCTION__);
745 FinalizeNetworker(IO);
749 eNextState NWC_Timeout(AsyncIO *IO)
751 syslog(LOG_DEBUG, "NW: %s\n", __FUNCTION__);
753 return NWC_FailNetworkConnection(IO);
755 eNextState NWC_ConnFail(AsyncIO *IO)
757 /// AsyncNetworker *NW = IO->Data;
759 syslog(LOG_DEBUG, "NW: %s\n", __FUNCTION__);
760 //// StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State])); todo
761 return NWC_FailNetworkConnection(IO);
763 eNextState NWC_DNSFail(AsyncIO *IO)
765 /// AsyncNetworker *NW = IO->Data;
767 syslog(LOG_DEBUG, "NW: %s\n", __FUNCTION__);
768 //// StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State])); todo
769 return NWC_FailNetworkConnection(IO);
771 eNextState NWC_Shutdown(AsyncIO *IO)
773 syslog(LOG_DEBUG, "NW: %s\n", __FUNCTION__);
774 //// pop3aggr *pMsg = IO->Data;
776 FinalizeNetworker(IO);
781 eNextState nwc_connect_ip(AsyncIO *IO)
783 AsyncNetworker *NW = IO->Data;
785 syslog(LOG_DEBUG, "NW: %s\n", __FUNCTION__);
786 syslog(LOG_DEBUG, "network: polling <%s>\n", ChrPtr(NW->node));
787 syslog(LOG_NOTICE, "Connecting to <%s> at %s:%s\n",
792 return InitEventIO(IO, NW,
798 void RunNetworker(AsyncNetworker *NW)
802 ParseURL(&NW->IO.ConnectMe, NW->Url, 504);
805 NW->IO.SendDone = NWC_DispatchWriteDone;
806 NW->IO.ReadDone = NWC_DispatchReadDone;
807 NW->IO.Terminate = NWC_Terminate;
808 NW->IO.LineReader = NWC_ReadServerStatus;
809 NW->IO.ConnFail = NWC_ConnFail;
810 NW->IO.DNSFail = NWC_DNSFail;
811 NW->IO.Timeout = NWC_Timeout;
812 NW->IO.ShutdownAbort = NWC_Shutdown;
814 NW->IO.SendBuf.Buf = NewStrBufPlain(NULL, 1024);
815 NW->IO.RecvBuf.Buf = NewStrBufPlain(NULL, 1024);
816 NW->IO.IOBuf = NewStrBuf();
818 NW->IO.NextState = eReadMessage;
819 SubC = CloneContext (&networker_client_CC);
820 SubC->session_specific_data = (char*) NW;
821 NW->IO.CitContext = SubC;
823 safestrncpy(SubC->cs_host,
825 sizeof(SubC->cs_host));
827 if (NW->IO.ConnectMe->IsIP) {
828 QueueEventContext(&NW->IO,
831 else { /* uneducated admin has chosen to add DNS to the equation... */
832 QueueEventContext(&NW->IO,
833 nwc_get_one_host_ip);
838 * Poll other Citadel nodes and transfer inbound/outbound network data.
839 * Set "full" to nonzero to force a poll of every node, or to zero to poll
840 * only nodes to which we have data to send.
842 void network_poll_other_citadel_nodes(int full_poll, char *working_ignetcfg)
853 if ((working_ignetcfg == NULL) || (*working_ignetcfg == '\0')) {
854 syslog(LOG_DEBUG, "network: no neighbor nodes are configured - not polling.\n");
857 CfgData = NewStrBufPlain(working_ignetcfg, -1);
858 Line = NewStrBufPlain(NULL, StrLength(CfgData));
863 /* Use the string tokenizer to grab one line at a time */
864 StrBufSipLine(Line, CfgData, &CfgPtr);
865 Done = CfgPtr == StrBufNOTNULL;
866 if (StrLength(Line) > 0)
868 if(server_shutting_down)
869 return;/* TODO free stuff*/
872 NW = (AsyncNetworker*)malloc(sizeof(AsyncNetworker));
873 memset(NW, 0, sizeof(AsyncNetworker));
875 NW->node = NewStrBufPlain(NULL, StrLength(Line));
876 NW->host = NewStrBufPlain(NULL, StrLength(Line));
877 NW->port = NewStrBufPlain(NULL, StrLength(Line));
878 NW->secret = NewStrBufPlain(NULL, StrLength(Line));
880 StrBufExtract_NextToken(NW->node, Line, &lptr, '|');
881 StrBufExtract_NextToken(NW->secret, Line, &lptr, '|');
882 StrBufExtract_NextToken(NW->host, Line, &lptr, '|');
883 StrBufExtract_NextToken(NW->port, Line, &lptr, '|');
884 if ( (StrLength(NW->node) != 0) &&
885 (StrLength(NW->secret) != 0) &&
886 (StrLength(NW->host) != 0) &&
887 (StrLength(NW->port) != 0))
892 NW->SpoolFileName = NewStrBufPlain(ctdl_netout_dir, -1);
893 StrBufAppendBufPlain(NW->SpoolFileName, HKEY("/"), 0);
894 StrBufAppendBuf(NW->SpoolFileName, NW->node, 0);
895 if (access(ChrPtr(NW->SpoolFileName), R_OK) == 0) {
901 NW->Url = NewStrBufPlain(NULL, StrLength(Line));
902 StrBufPrintf(NW->Url, "citadel://:%s@%s:%s",
906 if (!network_talking_to(SKEY(NW->node), NTT_CHECK))
908 network_talking_to(SKEY(NW->node), NTT_ADD);
916 FreeStrBuf(&CfgData);
922 void network_do_clientqueue(void)
924 char *working_ignetcfg;
925 int full_processing = 1;
926 static time_t last_run = 0L;
929 * Run the full set of processing tasks no more frequently
930 * than once every n seconds
932 if ( (time(NULL) - last_run) < config.c_net_freq ) {
934 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
935 config.c_net_freq - (time(NULL)- last_run)
939 working_ignetcfg = load_working_ignetcfg();
941 * Poll other Citadel nodes. Maybe. If "full_processing" is set
942 * then we poll everyone. Otherwise we only poll nodes we have stuff
945 network_poll_other_citadel_nodes(full_processing, working_ignetcfg);
946 if (working_ignetcfg)
947 free(working_ignetcfg);
955 CTDL_MODULE_INIT(network_client)
959 CtdlFillSystemContext(&networker_client_CC, "CitNetworker");
961 CtdlRegisterSessionHook(network_do_clientqueue, EVT_TIMER);
963 return "network_client";