2 * Consolidate mail from remote POP3 accounts.
4 * Copyright (c) 2007-2011 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #if TIME_WITH_SYS_TIME
26 # include <sys/time.h>
30 # include <sys/time.h>
39 #include <sys/types.h>
41 #include <libcitadel.h>
44 #include "citserver.h"
47 #include "ctdl_module.h"
48 #include "clientsocket.h"
50 #include "internet_addressing.h"
52 #include "citadel_dirs.h"
53 #include "event_client.h"
56 #define POP3C_OK (strncasecmp(ChrPtr(RecvMsg->IO.IOBuf), "+OK", 3) == 0)
58 int POP3ClientDebugEnabled = 0;
60 #define N ((pop3aggr*)IO->Data)->n
62 #define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (POP3ClientDebugEnabled != 0))
64 #define EVP3C_syslog(LEVEL, FORMAT, ...) \
65 DBGLOG(LEVEL) syslog(LEVEL, \
66 "IO[%ld]CC[%d][%ld]" FORMAT, \
67 IO->ID, CCID, N, __VA_ARGS__)
69 #define EVP3CM_syslog(LEVEL, FORMAT) \
70 DBGLOG(LEVEL) syslog(LEVEL, \
71 "IO[%ld]CC[%d][%ld]" FORMAT, \
74 #define EVP3CQ_syslog(LEVEL, FORMAT, ...) \
75 DBGLOG(LEVEL) syslog(LEVEL, \
79 #define EVP3CQM_syslog(LEVEL, FORMAT) \
80 DBGLOG(LEVEL) syslog(LEVEL, \
84 #define EVP3CCS_syslog(LEVEL, FORMAT, ...) \
85 DBGLOG(LEVEL) syslog(LEVEL, "IO[%ld][%ld]" FORMAT, \
86 IO->ID, N, __VA_ARGS__)
88 #define EVP3CCSM_syslog(LEVEL, FORMAT) \
89 DBGLOG(LEVEL) syslog(LEVEL, "IO[%ld][%ld]" FORMAT, \
92 #define POP3C_DBG_SEND() \
93 EVP3C_syslog(LOG_DEBUG, \
95 ChrPtr(RecvMsg->IO.SendBuf.Buf))
97 #define POP3C_DBG_READ() \
98 EVP3C_syslog(LOG_DEBUG, \
100 ChrPtr(RecvMsg->IO.IOBuf))
103 struct CitContext pop3_client_CC;
105 pthread_mutex_t POP3QueueMutex; /* locks the access to the following vars: */
106 HashList *POP3QueueRooms = NULL;
107 HashList *POP3FetchUrls = NULL;
109 typedef struct pop3aggr pop3aggr;
110 typedef eNextState(*Pop3ClientHandler)(pop3aggr* RecvMsg);
112 eNextState POP3_C_Shutdown(AsyncIO *IO);
113 eNextState POP3_C_Timeout(AsyncIO *IO);
114 eNextState POP3_C_ConnFail(AsyncIO *IO);
115 eNextState POP3_C_DNSFail(AsyncIO *IO);
116 eNextState POP3_C_DispatchReadDone(AsyncIO *IO);
117 eNextState POP3_C_DispatchWriteDone(AsyncIO *IO);
118 eNextState POP3_C_Terminate(AsyncIO *IO);
119 eReadState POP3_C_ReadServerStatus(AsyncIO *IO);
120 eNextState POP3_C_ReAttachToFetchMessages(AsyncIO *IO);
122 typedef struct __pop3_room_counter {
127 typedef enum ePOP3_C_States {
133 GetOneMessageIDState,
134 ReadMessageBodyFollowing,
142 typedef struct _FetchItem {
148 struct CtdlMessage *Msg;
151 void HfreeFetchItem(void *vItem)
153 FetchItem *Item = (FetchItem*) vItem;
154 FreeStrBuf(&Item->MsgUIDL);
155 FreeStrBuf(&Item->MsgUID);
166 DNSQueryParts HostLookup;
169 HashList *OtherQRnumbers;
175 StrBuf *RoomName; // TODO: fill me
178 ePOP3_C_States State;
179 HashList *MsgNumbers;
184 void DeletePOP3Aggregator(void *vptr)
186 pop3aggr *ptr = vptr;
187 DeleteHashPos(&ptr->Pos);
188 DeleteHash(&ptr->MsgNumbers);
189 // FreeStrBuf(&ptr->rooms);
190 FreeStrBuf(&ptr->pop3user);
191 FreeStrBuf(&ptr->pop3pass);
192 FreeStrBuf(&ptr->Host);
193 FreeStrBuf(&ptr->RoomName);
194 FreeURL(&ptr->IO.ConnectMe);
195 FreeStrBuf(&ptr->Url);
196 FreeStrBuf(&ptr->IO.IOBuf);
197 FreeStrBuf(&ptr->IO.SendBuf.Buf);
198 FreeStrBuf(&ptr->IO.RecvBuf.Buf);
199 DeleteAsyncMsg(&ptr->IO.ReadMsg);
200 ((struct CitContext*)ptr->IO.CitContext)->state = CON_IDLE;
201 ((struct CitContext*)ptr->IO.CitContext)->kill_me = 1;
202 FreeAsyncIOContents(&ptr->IO);
206 eNextState FinalizePOP3AggrRun(AsyncIO *IO)
209 pop3aggr *cpptr = (pop3aggr *)IO->Data;
211 EVP3C_syslog(LOG_INFO,
212 "%s@%s: fetched %ld new of %d messages in %fs. bye.",
213 ChrPtr(cpptr->pop3user),
216 GetCount(cpptr->MsgNumbers),
217 IO->Now - cpptr->IOStart
220 It = GetNewHashPos(POP3FetchUrls, 0);
221 pthread_mutex_lock(&POP3QueueMutex);
223 if (GetHashPosFromKey(POP3FetchUrls, SKEY(cpptr->Url), It))
224 DeleteEntryFromHash(POP3FetchUrls, It);
226 pthread_mutex_unlock(&POP3QueueMutex);
231 eNextState FailAggregationRun(AsyncIO *IO)
236 eNextState POP3C_ReadGreeting(pop3aggr *RecvMsg)
238 AsyncIO *IO = &RecvMsg->IO;
240 /* Read the server greeting */
241 if (!POP3C_OK) return eTerminateConnection;
242 else return eSendReply;
245 eNextState POP3C_SendUser(pop3aggr *RecvMsg)
247 AsyncIO *IO = &RecvMsg->IO;
248 /* Identify ourselves. NOTE: we have to append a CR to each command.
249 * The LF will automatically be appended by sock_puts(). Believe it
250 * or not, leaving out the CR will cause problems if the server happens
251 * to be Exchange, which is so b0rken it actually barfs on
252 * LF-terminated newlines.
254 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
255 "USER %s\r\n", ChrPtr(RecvMsg->pop3user));
260 eNextState POP3C_GetUserState(pop3aggr *RecvMsg)
262 AsyncIO *IO = &RecvMsg->IO;
264 if (!POP3C_OK) return eTerminateConnection;
265 else return eSendReply;
268 eNextState POP3C_SendPassword(pop3aggr *RecvMsg)
270 AsyncIO *IO = &RecvMsg->IO;
272 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
273 "PASS %s\r\n", ChrPtr(RecvMsg->pop3pass));
274 EVP3CM_syslog(LOG_DEBUG, "<PASS <password>\n");
275 // POP3C_DBG_SEND(); No, we won't write the passvoid to syslog...
279 eNextState POP3C_GetPassState(pop3aggr *RecvMsg)
281 AsyncIO *IO = &RecvMsg->IO;
283 if (!POP3C_OK) return eTerminateConnection;
284 else return eSendReply;
287 eNextState POP3C_SendListCommand(pop3aggr *RecvMsg)
289 AsyncIO *IO = &RecvMsg->IO;
290 /* Get the list of messages */
291 StrBufPlain(RecvMsg->IO.SendBuf.Buf, HKEY("LIST\r\n"));
296 eNextState POP3C_GetListCommandState(pop3aggr *RecvMsg)
298 AsyncIO *IO = &RecvMsg->IO;
300 if (!POP3C_OK) return eTerminateConnection;
301 RecvMsg->MsgNumbers = NewHash(1, NULL);
307 eNextState POP3C_GetListOneLine(pop3aggr *RecvMsg)
309 AsyncIO *IO = &RecvMsg->IO;
314 FetchItem *OneMsg = NULL;
317 if ((StrLength(RecvMsg->IO.IOBuf) == 1) &&
318 (ChrPtr(RecvMsg->IO.IOBuf)[0] == '.'))
320 if (GetCount(RecvMsg->MsgNumbers) == 0)
322 //// RecvMsg->Sate = ReadQuitState;
326 RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
331 OneMsg = (FetchItem*) malloc(sizeof(FetchItem));
332 memset(OneMsg, 0, sizeof(FetchItem));
333 OneMsg->MSGID = atol(ChrPtr(RecvMsg->IO.IOBuf));
335 pch = strchr(ChrPtr(RecvMsg->IO.IOBuf), ' ');
338 OneMsg->MSGSize = atol(pch + 1);
341 rc = TestValidateHash(RecvMsg->MsgNumbers);
343 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
346 Put(RecvMsg->MsgNumbers, LKEY(OneMsg->MSGID), OneMsg, HfreeFetchItem);
348 rc = TestValidateHash(RecvMsg->MsgNumbers);
350 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
352 //RecvMsg->State --; /* read next Line */
356 eNextState POP3_FetchNetworkUsetableEntry(AsyncIO *IO)
361 struct cdbdata *cdbut;
362 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
364 if((RecvMsg->Pos != NULL) &&
365 GetNextHashPos(RecvMsg->MsgNumbers,
372 if (server_shutting_down)
375 RecvMsg->CurrMsg = (FetchItem*) vData;
376 EVP3CCS_syslog(LOG_DEBUG,
377 "CHECKING: whether %s has already been seen: ",
378 ChrPtr(RecvMsg->CurrMsg->MsgUID));
380 /* Find out if we've already seen this item */
381 safestrncpy(ut.ut_msgid,
382 ChrPtr(RecvMsg->CurrMsg->MsgUID),
383 sizeof(ut.ut_msgid));
384 ut.ut_timestamp = time(NULL);/// TODO: libev timestamp!
386 cdbut = cdb_fetch(CDB_USETABLE, SKEY(RecvMsg->CurrMsg->MsgUID));
388 /* Item has already been seen */
389 EVP3CCSM_syslog(LOG_DEBUG, "YES\n");
392 /* rewrite the record anyway, to update the timestamp */
393 cdb_store(CDB_USETABLE,
394 SKEY(RecvMsg->CurrMsg->MsgUID),
395 &ut, sizeof(struct UseTable) );
396 RecvMsg->CurrMsg->NeedFetch = 0; ////TODO0;
400 EVP3CCSM_syslog(LOG_DEBUG, "NO\n");
401 RecvMsg->CurrMsg->NeedFetch = 1;
403 return NextDBOperation(&RecvMsg->IO,
404 POP3_FetchNetworkUsetableEntry);
408 /* ok, now we know them all,
409 * continue with reading the actual messages. */
410 DeleteHashPos(&RecvMsg->Pos);
412 return QueueEventContext(IO, POP3_C_ReAttachToFetchMessages);
416 eNextState POP3C_GetOneMessagID(pop3aggr *RecvMsg)
418 AsyncIO *IO = &RecvMsg->IO;
425 rc = TestValidateHash(RecvMsg->MsgNumbers);
427 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
429 if((RecvMsg->Pos != NULL) &&
430 GetNextHashPos(RecvMsg->MsgNumbers,
435 RecvMsg->CurrMsg = (FetchItem*) vData;
436 /* Find out the UIDL of the message,
437 * to determine whether we've already downloaded it */
438 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
439 "UIDL %ld\r\n", RecvMsg->CurrMsg->MSGID);
445 DeleteHashPos(&RecvMsg->Pos);
446 /// done receiving uidls.. start looking them up now.
447 RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
448 return QueueDBOperation(&RecvMsg->IO,
449 POP3_FetchNetworkUsetableEntry);
451 return eReadMore; /* TODO */
454 eNextState POP3C_GetOneMessageIDState(pop3aggr *RecvMsg)
456 AsyncIO *IO = &RecvMsg->IO;
459 rc = TestValidateHash(RecvMsg->MsgNumbers);
461 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
465 if (!POP3C_OK) return eTerminateConnection;
466 RecvMsg->CurrMsg->MsgUIDL =
467 NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf));
468 RecvMsg->CurrMsg->MsgUID =
469 NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf) * 2);
471 StrBufExtract_token(RecvMsg->CurrMsg->MsgUIDL,
472 RecvMsg->IO.IOBuf, 2, ' ');
474 StrBufPrintf(RecvMsg->CurrMsg->MsgUID,
476 ChrPtr(RecvMsg->RoomName),
477 ChrPtr(RecvMsg->CurrMsg->MsgUIDL),
478 RecvMsg->IO.ConnectMe->User,
479 RecvMsg->IO.ConnectMe->Host);
485 eNextState POP3C_SendGetOneMsg(pop3aggr *RecvMsg)
487 AsyncIO *IO = &RecvMsg->IO;
492 RecvMsg->CurrMsg = NULL;
493 while ((RecvMsg->Pos != NULL) &&
494 GetNextHashPos(RecvMsg->MsgNumbers,
498 (RecvMsg->CurrMsg = (FetchItem*) vData,
499 RecvMsg->CurrMsg->NeedFetch == 0))
502 if ((RecvMsg->CurrMsg != NULL ) && (RecvMsg->CurrMsg->NeedFetch == 1))
504 /* Message has not been seen.
505 * Tell the server to fetch the message... */
506 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
507 "RETR %ld\r\n", RecvMsg->CurrMsg->MSGID);
512 RecvMsg->State = ReadQuitState;
513 return POP3_C_DispatchWriteDone(&RecvMsg->IO);
518 eNextState POP3C_ReadMessageBodyFollowing(pop3aggr *RecvMsg)
520 AsyncIO *IO = &RecvMsg->IO;
522 if (!POP3C_OK) return eTerminateConnection;
523 RecvMsg->IO.ReadMsg = NewAsyncMsg(HKEY("."),
524 RecvMsg->CurrMsg->MSGSize,
533 eNextState POP3C_StoreMsgRead(AsyncIO *IO)
535 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
538 EVP3CCS_syslog(LOG_DEBUG,
539 "MARKING: %s as seen: ",
540 ChrPtr(RecvMsg->CurrMsg->MsgUID));
542 safestrncpy(ut.ut_msgid,
543 ChrPtr(RecvMsg->CurrMsg->MsgUID),
544 sizeof(ut.ut_msgid));
545 ut.ut_timestamp = time(NULL); /* TODO: use libev time */
546 cdb_store(CDB_USETABLE,
547 ChrPtr(RecvMsg->CurrMsg->MsgUID),
548 StrLength(RecvMsg->CurrMsg->MsgUID),
550 sizeof(struct UseTable) );
552 return QueueEventContext(&RecvMsg->IO, POP3_C_ReAttachToFetchMessages);
554 eNextState POP3C_SaveMsg(AsyncIO *IO)
557 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
559 /* Do Something With It (tm) */
560 msgnum = CtdlSubmitMsg(RecvMsg->CurrMsg->Msg,
562 ChrPtr(RecvMsg->RoomName),
566 /* Message has been committed to the store
567 * write the uidl to the use table
568 * so we don't fetch this message again
571 CtdlFreeMessage(RecvMsg->CurrMsg->Msg);
574 return NextDBOperation(&RecvMsg->IO, POP3C_StoreMsgRead);
577 eNextState POP3C_ReadMessageBody(pop3aggr *RecvMsg)
579 AsyncIO *IO = &RecvMsg->IO;
580 EVP3CM_syslog(LOG_DEBUG, "Converting message...");
581 RecvMsg->CurrMsg->Msg =
582 convert_internet_message_buf(&RecvMsg->IO.ReadMsg->MsgBuf);
583 StopClientWatchers(IO, 0);
584 return QueueDBOperation(&RecvMsg->IO, POP3C_SaveMsg);
587 eNextState POP3C_SendDelete(pop3aggr *RecvMsg)
589 AsyncIO *IO = &RecvMsg->IO;
590 if (!RecvMsg->keep) {
591 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
592 "DELE %ld\r\n", RecvMsg->CurrMsg->MSGID);
597 RecvMsg->State = ReadMessageBodyFollowing;
598 return POP3_C_DispatchWriteDone(&RecvMsg->IO);
601 eNextState POP3C_ReadDeleteState(pop3aggr *RecvMsg)
603 AsyncIO *IO = &RecvMsg->IO;
605 RecvMsg->State = GetOneMessageIDState;
609 eNextState POP3C_SendQuit(pop3aggr *RecvMsg)
611 AsyncIO *IO = &RecvMsg->IO;
613 StrBufPlain(RecvMsg->IO.SendBuf.Buf,
620 eNextState POP3C_ReadQuitState(pop3aggr *RecvMsg)
622 AsyncIO *IO = &RecvMsg->IO;
624 return eTerminateConnection;
627 const long POP3_C_ConnTimeout = 1000;
628 const long DefaultPOP3Port = 110;
630 Pop3ClientHandler POP3C_ReadHandlers[] = {
634 POP3C_GetListCommandState,
635 POP3C_GetListOneLine,
636 POP3C_GetOneMessageIDState,
637 POP3C_ReadMessageBodyFollowing,
638 POP3C_ReadMessageBody,
639 POP3C_ReadDeleteState,
643 const long POP3_C_SendTimeouts[POP3C_MaxRead] = {
653 const ConstStr POP3C_ReadErrors[POP3C_MaxRead] = {
654 {HKEY("Connection broken during ")},
655 {HKEY("Connection broken during ")},
656 {HKEY("Connection broken during ")},
657 {HKEY("Connection broken during ")},
658 {HKEY("Connection broken during ")},
659 {HKEY("Connection broken during ")},
660 {HKEY("Connection broken during ")},
661 {HKEY("Connection broken during ")}
664 Pop3ClientHandler POP3C_SendHandlers[] = {
665 NULL, /* we don't send a greeting */
668 POP3C_SendListCommand,
670 POP3C_GetOneMessagID,
677 const long POP3_C_ReadTimeouts[] = {
689 /*****************************************************************************/
690 /* POP3 CLIENT DISPATCHER */
691 /*****************************************************************************/
693 void POP3SetTimeout(eNextState NextTCPState, pop3aggr *pMsg)
695 AsyncIO *IO = &pMsg->IO;
696 double Timeout = 0.0;
698 EVP3C_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
700 switch (NextTCPState) {
704 Timeout = POP3_C_SendTimeouts[pMsg->State];
706 if (pMsg->State == eDATABody) {
707 / * if we're sending a huge message, we need more time. * /
708 Timeout += StrLength(pMsg->msgtext) / 1024;
714 Timeout = POP3_C_ReadTimeouts[pMsg->State];
716 if (pMsg->State == eDATATerminateBody) {
718 * some mailservers take a nap before accepting the message
719 * content inspection and such.
721 Timeout += StrLength(pMsg->msgtext) / 1024;
732 case eTerminateConnection:
735 case eReadMore://// TODO
738 SetNextTimeout(&pMsg->IO, Timeout);
740 eNextState POP3_C_DispatchReadDone(AsyncIO *IO)
742 /* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
743 pop3aggr *pMsg = IO->Data;
746 rc = POP3C_ReadHandlers[pMsg->State](pMsg);
749 POP3SetTimeout(rc, pMsg);
752 eNextState POP3_C_DispatchWriteDone(AsyncIO *IO)
754 pop3aggr *pMsg = IO->Data;
757 /* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
758 rc = POP3C_SendHandlers[pMsg->State](pMsg);
759 POP3SetTimeout(rc, pMsg);
764 /*****************************************************************************/
765 /* POP3 CLIENT ERROR CATCHERS */
766 /*****************************************************************************/
767 eNextState POP3_C_Terminate(AsyncIO *IO)
769 /// pop3aggr *pMsg = (pop3aggr *)IO->Data;
771 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
772 FinalizePOP3AggrRun(IO);
775 eNextState POP3_C_TerminateDB(AsyncIO *IO)
777 /// pop3aggr *pMsg = (pop3aggr *)IO->Data;
779 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
780 FinalizePOP3AggrRun(IO);
783 eNextState POP3_C_Timeout(AsyncIO *IO)
785 pop3aggr *pMsg = IO->Data;
787 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
788 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
789 return FailAggregationRun(IO);
791 eNextState POP3_C_ConnFail(AsyncIO *IO)
793 pop3aggr *pMsg = (pop3aggr *)IO->Data;
795 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
796 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
797 return FailAggregationRun(IO);
799 eNextState POP3_C_DNSFail(AsyncIO *IO)
801 pop3aggr *pMsg = (pop3aggr *)IO->Data;
803 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
804 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
805 return FailAggregationRun(IO);
807 eNextState POP3_C_Shutdown(AsyncIO *IO)
809 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
810 //// pop3aggr *pMsg = IO->Data;
812 ////pMsg->MyQEntry->Status = 3;
813 ///StrBufPlain(pMsg->MyQEntry->StatusMessage, HKEY("server shutdown during message retrieval."));
814 FinalizePOP3AggrRun(IO);
820 * @brief lineread Handler; understands when to read more POP3 lines,
821 * and when this is a one-lined reply.
823 eReadState POP3_C_ReadServerStatus(AsyncIO *IO)
825 eReadState Finished = eBufferNotEmpty;
827 switch (IO->NextState) {
832 case eTerminateConnection:
834 Finished = eReadFail;
841 Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
845 Finished = CtdlReadMessageBodyAsync(IO);
851 /*****************************************************************************
852 * So we connect our Server IP here. *
853 *****************************************************************************/
854 eNextState POP3_C_ReAttachToFetchMessages(AsyncIO *IO)
856 pop3aggr *cpptr = IO->Data;
858 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
859 ////??? cpptr->State ++;
860 if (cpptr->Pos == NULL)
861 cpptr->Pos = GetNewHashPos(cpptr->MsgNumbers, 0);
863 POP3_C_DispatchWriteDone(IO);
864 ReAttachIO(IO, cpptr, 0);
865 IO->NextState = eReadMessage;
866 return IO->NextState;
869 eNextState pop3_connect_ip(AsyncIO *IO)
871 pop3aggr *cpptr = IO->Data;
873 if (cpptr->IOStart == 0.0) /* whith or without DNS? */
874 cpptr->IOStart = IO->Now;
876 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
878 return EvConnectSock(IO,
880 POP3_C_ReadTimeouts[0],
884 eNextState pop3_get_one_host_ip_done(AsyncIO *IO)
886 pop3aggr *cpptr = IO->Data;
887 struct hostent *hostent;
891 hostent = cpptr->HostLookup.VParsedDNSReply;
892 if ((cpptr->HostLookup.DNSStatus == ARES_SUCCESS) &&
893 (hostent != NULL) ) {
894 memset(&cpptr->IO.ConnectMe->Addr, 0, sizeof(struct in6_addr));
895 if (cpptr->IO.ConnectMe->IPv6) {
896 memcpy(&cpptr->IO.ConnectMe->Addr.sin6_addr.s6_addr,
897 &hostent->h_addr_list[0],
898 sizeof(struct in6_addr));
900 cpptr->IO.ConnectMe->Addr.sin6_family =
902 cpptr->IO.ConnectMe->Addr.sin6_port =
903 htons(DefaultPOP3Port);
906 struct sockaddr_in *addr =
907 (struct sockaddr_in*)
908 &cpptr->IO.ConnectMe->Addr;
910 memcpy(&addr->sin_addr.s_addr,
911 hostent->h_addr_list[0],
914 addr->sin_family = hostent->h_addrtype;
915 addr->sin_port = htons(DefaultPOP3Port);
917 return pop3_connect_ip(IO);
923 eNextState pop3_get_one_host_ip(AsyncIO *IO)
925 pop3aggr *cpptr = IO->Data;
927 cpptr->IOStart = IO->Now;
929 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
931 EVP3CCS_syslog(LOG_DEBUG,
932 "POP3 client[%ld]: looking up %s-Record %s : %d ...\n",
934 (cpptr->IO.ConnectMe->IPv6)? "aaaa": "a",
935 cpptr->IO.ConnectMe->Host,
936 cpptr->IO.ConnectMe->Port);
938 QueueQuery((cpptr->IO.ConnectMe->IPv6)? ns_t_aaaa : ns_t_a,
939 cpptr->IO.ConnectMe->Host,
942 pop3_get_one_host_ip_done);
943 IO->NextState = eReadDNSReply;
944 return IO->NextState;
949 int pop3_do_fetching(pop3aggr *cpptr)
951 AsyncIO *IO = &cpptr->IO;
956 POP3_C_ReadServerStatus,
958 POP3_C_DispatchWriteDone,
959 POP3_C_DispatchReadDone,
966 safestrncpy(((CitContext *)cpptr->IO.CitContext)->cs_host,
968 sizeof(((CitContext *)cpptr->IO.CitContext)->cs_host));
970 if (cpptr->IO.ConnectMe->IsIP) {
971 QueueEventContext(&cpptr->IO,
975 QueueEventContext(&cpptr->IO,
976 pop3_get_one_host_ip);
982 * Scan a room's netconfig to determine whether it requires POP3 aggregation
984 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
991 char filename[PATH_MAX];
995 const char *CfgPtr, *lPtr;
998 // pop3_room_counter *Count = NULL;
1001 pthread_mutex_lock(&POP3QueueMutex);
1002 if (GetHash(POP3QueueRooms, LKEY(qrbuf->QRnumber), &vptr))
1004 pthread_mutex_unlock(&POP3QueueMutex);
1005 EVP3CQ_syslog(LOG_DEBUG,
1006 "pop3client: [%ld] %s already in progress.",
1011 pthread_mutex_unlock(&POP3QueueMutex);
1013 if (server_shutting_down) return;
1015 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
1017 if (server_shutting_down)
1020 /* Only do net processing for rooms that have netconfigs */
1021 fd = open(filename, 0);
1025 if (server_shutting_down)
1027 if (fstat(fd, &statbuf) == -1) {
1028 EVP3CQ_syslog(LOG_INFO,
1029 "ERROR: could not stat configfile '%s' - %s",
1034 if (server_shutting_down)
1036 CfgData = NewStrBufPlain(NULL, statbuf.st_size + 1);
1037 if (StrBufReadBLOB(CfgData, &fd, 1, statbuf.st_size, &Err) < 0) {
1039 FreeStrBuf(&CfgData);
1040 EVP3CQ_syslog(LOG_INFO,
1041 "ERROR: reading config '%s' - %s",
1042 filename, strerror(errno));
1046 if (server_shutting_down)
1050 CfgType = NewStrBuf();
1051 Line = NewStrBufPlain(NULL, StrLength(CfgData));
1056 Done = StrBufSipLine(Line, CfgData, &CfgPtr) == 0;
1057 if (StrLength(Line) > 0)
1060 StrBufExtract_NextToken(CfgType, Line, &lPtr, '|');
1061 if (!strcasecmp("pop3client", ChrPtr(CfgType)))
1067 Count = malloc(sizeof(pop3_room_counter));
1072 cptr = (pop3aggr *) malloc(sizeof(pop3aggr));
1073 memset(cptr, 0, sizeof(pop3aggr));
1074 ///TODO do we need this? cptr->roomlist_parts=1;
1076 NewStrBufPlain(qrbuf->QRname, -1);
1078 NewStrBufPlain(NULL, StrLength(Line));
1080 NewStrBufPlain(NULL, StrLength(Line));
1081 cptr->Url = NewStrBuf();
1083 NewStrBufPlain(NULL, StrLength(Line));
1085 StrBufExtract_NextToken(cptr->Host, Line, &lPtr, '|');
1086 StrBufExtract_NextToken(cptr->pop3user,
1091 StrBufExtract_NextToken(cptr->pop3pass,
1096 cptr->keep = StrBufExtractNext_long(Line,
1100 cptr->interval = StrBufExtractNext_long(Line,
1104 StrBufAppendBufPlain(cptr->Url, HKEY("pop3://"), 0);
1105 StrBufUrlescUPAppend(cptr->Url, cptr->pop3user, NULL);
1106 StrBufAppendBufPlain(cptr->Url, HKEY(":"), 0);
1107 StrBufUrlescUPAppend(cptr->Url, cptr->pop3pass, NULL);
1108 StrBufAppendBufPlain(cptr->Url, HKEY("@"), 0);
1109 StrBufAppendBuf(cptr->Url, cptr->Host, 0);
1110 StrBufAppendBufPlain(cptr->Url, HKEY("/"), 0);
1111 StrBufUrlescAppend(cptr->Url, cptr->RoomName, NULL);
1113 ParseURL(&cptr->IO.ConnectMe, cptr->Url, 110);
1117 /* todo: we need to reunite the url to be shure. */
1119 pthread_mutex_lock(&POP3ueueMutex);
1120 GetHash(POP3FetchUrls, SKEY(ptr->Url), &vptr);
1121 use_this_cptr = (pop3aggr *)vptr;
1123 if (use_this_rncptr != NULL)
1125 /* mustn't attach to an active session */
1126 if (use_this_cptr->RefCount > 0)
1128 DeletePOP3Cfg(cptr);
1134 StrBufAppendBufPlain(
1135 use_this_cptr->rooms,
1138 if (use_this_cptr->roomlist_parts == 1)
1140 use_this_cptr->OtherQRnumbers
1141 = NewHash(1, lFlathash);
1143 QRnumber = (long*)malloc(sizeof(long));
1144 *QRnumber = qrbuf->QRnumber;
1145 Put(use_this_cptr->OtherQRnumbers,
1146 LKEY(qrbuf->QRnumber),
1150 use_this_cptr->roomlist_parts++;
1152 pthread_mutex_unlock(&POP3QueueMutex);
1155 pthread_mutex_unlock(&RSSQueueMutex);
1157 cptr->n = Pop3ClientID++;
1158 pthread_mutex_lock(&POP3QueueMutex);
1162 DeletePOP3Aggregator);
1164 pthread_mutex_unlock(&POP3QueueMutex);
1174 FreeStrBuf(&CfgType);
1175 FreeStrBuf(&CfgData);
1178 static int doing_pop3client = 0;
1180 void pop3client_scan(void) {
1181 static time_t last_run = 0L;
1182 time_t fastest_scan;
1189 become_session(&pop3_client_CC);
1191 if (config.c_pop3_fastest < config.c_pop3_fetch)
1192 fastest_scan = config.c_pop3_fastest;
1194 fastest_scan = config.c_pop3_fetch;
1197 * Run POP3 aggregation no more frequently than once every n seconds
1199 if ( (time(NULL) - last_run) < fastest_scan ) {
1204 * This is a simple concurrency check to make sure only one pop3client
1205 * run is done at a time. We could do this with a mutex, but since we
1206 * don't really require extremely fine granularity here, we'll do it
1207 * with a static variable instead.
1209 if (doing_pop3client) return;
1210 doing_pop3client = 1;
1212 EVP3CQM_syslog(LOG_DEBUG, "pop3client started");
1213 CtdlForEachRoom(pop3client_scan_room, NULL);
1215 pthread_mutex_lock(&POP3QueueMutex);
1216 it = GetNewHashPos(POP3FetchUrls, 0);
1217 while (!server_shutting_down &&
1218 GetNextHashPos(POP3FetchUrls, it, &len, &Key, &vrptr) &&
1220 cptr = (pop3aggr *)vrptr;
1221 if (cptr->RefCount == 0)
1222 if (!pop3_do_fetching(cptr))
1223 DeletePOP3Aggregator(cptr);////TODO
1226 if ((palist->interval && time(NULL) > (last_run + palist->interval))
1227 || (time(NULL) > last_run + config.c_pop3_fetch))
1228 pop3_do_fetching(palist->roomname, palist->pop3host,
1229 palist->pop3user, palist->pop3pass, palist->keep);
1231 palist = palist->next;
1236 pthread_mutex_unlock(&POP3QueueMutex);
1238 EVP3CQM_syslog(LOG_DEBUG, "pop3client ended");
1239 last_run = time(NULL);
1240 doing_pop3client = 0;
1244 void pop3_cleanup(void)
1246 /* citthread_mutex_destroy(&POP3QueueMutex); TODO */
1247 while (doing_pop3client != 0) ;
1248 DeleteHash(&POP3FetchUrls);
1249 DeleteHash(&POP3QueueRooms);
1254 void LogDebugEnablePOP3Client(const int n)
1256 POP3ClientDebugEnabled = n;
1259 CTDL_MODULE_INIT(pop3client)
1263 CtdlFillSystemContext(&pop3_client_CC, "POP3aggr");
1264 pthread_mutex_init(&POP3QueueMutex, NULL);
1265 POP3QueueRooms = NewHash(1, lFlathash);
1266 POP3FetchUrls = NewHash(1, NULL);
1267 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER, PRIO_AGGR + 50);
1268 CtdlRegisterEVCleanupHook(pop3_cleanup);
1269 CtdlRegisterDebugFlagHook(HKEY("pop3client"), LogDebugEnablePOP3Client, &POP3ClientDebugEnabled);
1272 /* return our module id for the log */
1273 return "pop3client";