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;
174 StrBuf *RoomName; // TODO: fill me
177 ePOP3_C_States State;
178 HashList *MsgNumbers;
183 void DeletePOP3Aggregator(void *vptr)
185 pop3aggr *ptr = vptr;
186 DeleteHashPos(&ptr->Pos);
187 DeleteHash(&ptr->MsgNumbers);
188 // FreeStrBuf(&ptr->rooms);
189 FreeStrBuf(&ptr->pop3user);
190 FreeStrBuf(&ptr->pop3pass);
191 FreeStrBuf(&ptr->RoomName);
192 FreeURL(&ptr->IO.ConnectMe);
193 FreeStrBuf(&ptr->Url);
194 FreeStrBuf(&ptr->IO.IOBuf);
195 FreeStrBuf(&ptr->IO.SendBuf.Buf);
196 FreeStrBuf(&ptr->IO.RecvBuf.Buf);
197 DeleteAsyncMsg(&ptr->IO.ReadMsg);
198 ((struct CitContext*)ptr->IO.CitContext)->state = CON_IDLE;
199 ((struct CitContext*)ptr->IO.CitContext)->kill_me = 1;
200 FreeAsyncIOContents(&ptr->IO);
204 eNextState FinalizePOP3AggrRun(AsyncIO *IO)
207 pop3aggr *cpptr = (pop3aggr *)IO->Data;
209 EVP3C_syslog(LOG_INFO,
210 "%s@%s: fetched %ld new of %d messages in %fs. bye.",
211 ChrPtr(cpptr->pop3user),
212 ChrPtr(cpptr->pop3pass),
214 GetCount(cpptr->MsgNumbers),
215 IO->Now - cpptr->IOStart
218 It = GetNewHashPos(POP3FetchUrls, 0);
219 pthread_mutex_lock(&POP3QueueMutex);
221 if (GetHashPosFromKey(POP3FetchUrls, SKEY(cpptr->Url), It))
222 DeleteEntryFromHash(POP3FetchUrls, It);
224 pthread_mutex_unlock(&POP3QueueMutex);
229 eNextState FailAggregationRun(AsyncIO *IO)
234 eNextState POP3C_ReadGreeting(pop3aggr *RecvMsg)
236 AsyncIO *IO = &RecvMsg->IO;
238 /* Read the server greeting */
239 if (!POP3C_OK) return eTerminateConnection;
240 else return eSendReply;
243 eNextState POP3C_SendUser(pop3aggr *RecvMsg)
245 AsyncIO *IO = &RecvMsg->IO;
246 /* Identify ourselves. NOTE: we have to append a CR to each command.
247 * The LF will automatically be appended by sock_puts(). Believe it
248 * or not, leaving out the CR will cause problems if the server happens
249 * to be Exchange, which is so b0rken it actually barfs on
250 * LF-terminated newlines.
252 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
253 "USER %s\r\n", ChrPtr(RecvMsg->pop3user));
258 eNextState POP3C_GetUserState(pop3aggr *RecvMsg)
260 AsyncIO *IO = &RecvMsg->IO;
262 if (!POP3C_OK) return eTerminateConnection;
263 else return eSendReply;
266 eNextState POP3C_SendPassword(pop3aggr *RecvMsg)
268 AsyncIO *IO = &RecvMsg->IO;
270 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
271 "PASS %s\r\n", ChrPtr(RecvMsg->pop3pass));
272 EVP3CM_syslog(LOG_DEBUG, "<PASS <password>\n");
273 // POP3C_DBG_SEND(); No, we won't write the passvoid to syslog...
277 eNextState POP3C_GetPassState(pop3aggr *RecvMsg)
279 AsyncIO *IO = &RecvMsg->IO;
281 if (!POP3C_OK) return eTerminateConnection;
282 else return eSendReply;
285 eNextState POP3C_SendListCommand(pop3aggr *RecvMsg)
287 AsyncIO *IO = &RecvMsg->IO;
288 /* Get the list of messages */
289 StrBufPlain(RecvMsg->IO.SendBuf.Buf, HKEY("LIST\r\n"));
294 eNextState POP3C_GetListCommandState(pop3aggr *RecvMsg)
296 AsyncIO *IO = &RecvMsg->IO;
298 if (!POP3C_OK) return eTerminateConnection;
299 RecvMsg->MsgNumbers = NewHash(1, NULL);
305 eNextState POP3C_GetListOneLine(pop3aggr *RecvMsg)
307 AsyncIO *IO = &RecvMsg->IO;
312 FetchItem *OneMsg = NULL;
315 if ((StrLength(RecvMsg->IO.IOBuf) == 1) &&
316 (ChrPtr(RecvMsg->IO.IOBuf)[0] == '.'))
318 if (GetCount(RecvMsg->MsgNumbers) == 0)
320 //// RecvMsg->Sate = ReadQuitState;
324 RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
329 OneMsg = (FetchItem*) malloc(sizeof(FetchItem));
330 memset(OneMsg, 0, sizeof(FetchItem));
331 OneMsg->MSGID = atol(ChrPtr(RecvMsg->IO.IOBuf));
333 pch = strchr(ChrPtr(RecvMsg->IO.IOBuf), ' ');
336 OneMsg->MSGSize = atol(pch + 1);
339 rc = TestValidateHash(RecvMsg->MsgNumbers);
341 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
344 Put(RecvMsg->MsgNumbers, LKEY(OneMsg->MSGID), OneMsg, HfreeFetchItem);
346 rc = TestValidateHash(RecvMsg->MsgNumbers);
348 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
350 //RecvMsg->State --; /* read next Line */
354 eNextState POP3_FetchNetworkUsetableEntry(AsyncIO *IO)
359 struct cdbdata *cdbut;
360 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
362 if((RecvMsg->Pos != NULL) &&
363 GetNextHashPos(RecvMsg->MsgNumbers,
370 if (server_shutting_down)
373 RecvMsg->CurrMsg = (FetchItem*) vData;
374 EVP3CCS_syslog(LOG_DEBUG,
375 "CHECKING: whether %s has already been seen: ",
376 ChrPtr(RecvMsg->CurrMsg->MsgUID));
378 /* Find out if we've already seen this item */
379 safestrncpy(ut.ut_msgid,
380 ChrPtr(RecvMsg->CurrMsg->MsgUID),
381 sizeof(ut.ut_msgid));
382 ut.ut_timestamp = time(NULL);/// TODO: libev timestamp!
384 cdbut = cdb_fetch(CDB_USETABLE, SKEY(RecvMsg->CurrMsg->MsgUID));
386 /* Item has already been seen */
387 EVP3CCSM_syslog(LOG_DEBUG, "YES\n");
390 /* rewrite the record anyway, to update the timestamp */
391 cdb_store(CDB_USETABLE,
392 SKEY(RecvMsg->CurrMsg->MsgUID),
393 &ut, sizeof(struct UseTable) );
394 RecvMsg->CurrMsg->NeedFetch = 0; ////TODO0;
398 EVP3CCSM_syslog(LOG_DEBUG, "NO\n");
399 RecvMsg->CurrMsg->NeedFetch = 1;
401 return NextDBOperation(&RecvMsg->IO,
402 POP3_FetchNetworkUsetableEntry);
406 /* ok, now we know them all,
407 * continue with reading the actual messages. */
408 DeleteHashPos(&RecvMsg->Pos);
410 return QueueEventContext(IO, POP3_C_ReAttachToFetchMessages);
414 eNextState POP3C_GetOneMessagID(pop3aggr *RecvMsg)
416 AsyncIO *IO = &RecvMsg->IO;
423 rc = TestValidateHash(RecvMsg->MsgNumbers);
425 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
427 if((RecvMsg->Pos != NULL) &&
428 GetNextHashPos(RecvMsg->MsgNumbers,
433 RecvMsg->CurrMsg = (FetchItem*) vData;
434 /* Find out the UIDL of the message,
435 * to determine whether we've already downloaded it */
436 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
437 "UIDL %ld\r\n", RecvMsg->CurrMsg->MSGID);
443 DeleteHashPos(&RecvMsg->Pos);
444 /// done receiving uidls.. start looking them up now.
445 RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
446 return QueueDBOperation(&RecvMsg->IO,
447 POP3_FetchNetworkUsetableEntry);
449 return eReadMore; /* TODO */
452 eNextState POP3C_GetOneMessageIDState(pop3aggr *RecvMsg)
454 AsyncIO *IO = &RecvMsg->IO;
457 rc = TestValidateHash(RecvMsg->MsgNumbers);
459 EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
463 if (!POP3C_OK) return eTerminateConnection;
464 RecvMsg->CurrMsg->MsgUIDL =
465 NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf));
466 RecvMsg->CurrMsg->MsgUID =
467 NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf) * 2);
469 StrBufExtract_token(RecvMsg->CurrMsg->MsgUIDL,
470 RecvMsg->IO.IOBuf, 2, ' ');
472 StrBufPrintf(RecvMsg->CurrMsg->MsgUID,
474 ChrPtr(RecvMsg->RoomName),
475 ChrPtr(RecvMsg->CurrMsg->MsgUIDL),
476 RecvMsg->IO.ConnectMe->User,
477 RecvMsg->IO.ConnectMe->Host);
483 eNextState POP3C_SendGetOneMsg(pop3aggr *RecvMsg)
485 AsyncIO *IO = &RecvMsg->IO;
490 RecvMsg->CurrMsg = NULL;
491 while ((RecvMsg->Pos != NULL) &&
492 GetNextHashPos(RecvMsg->MsgNumbers,
496 (RecvMsg->CurrMsg = (FetchItem*) vData,
497 RecvMsg->CurrMsg->NeedFetch == 0))
500 if ((RecvMsg->CurrMsg != NULL ) && (RecvMsg->CurrMsg->NeedFetch == 1))
502 /* Message has not been seen.
503 * Tell the server to fetch the message... */
504 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
505 "RETR %ld\r\n", RecvMsg->CurrMsg->MSGID);
510 RecvMsg->State = ReadQuitState;
511 return POP3_C_DispatchWriteDone(&RecvMsg->IO);
516 eNextState POP3C_ReadMessageBodyFollowing(pop3aggr *RecvMsg)
518 AsyncIO *IO = &RecvMsg->IO;
520 if (!POP3C_OK) return eTerminateConnection;
521 RecvMsg->IO.ReadMsg = NewAsyncMsg(HKEY("."),
522 RecvMsg->CurrMsg->MSGSize,
531 eNextState POP3C_StoreMsgRead(AsyncIO *IO)
533 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
536 EVP3CCS_syslog(LOG_DEBUG,
537 "MARKING: %s as seen: ",
538 ChrPtr(RecvMsg->CurrMsg->MsgUID));
540 safestrncpy(ut.ut_msgid,
541 ChrPtr(RecvMsg->CurrMsg->MsgUID),
542 sizeof(ut.ut_msgid));
543 ut.ut_timestamp = time(NULL); /* TODO: use libev time */
544 cdb_store(CDB_USETABLE,
545 ChrPtr(RecvMsg->CurrMsg->MsgUID),
546 StrLength(RecvMsg->CurrMsg->MsgUID),
548 sizeof(struct UseTable) );
550 return QueueEventContext(&RecvMsg->IO, POP3_C_ReAttachToFetchMessages);
552 eNextState POP3C_SaveMsg(AsyncIO *IO)
555 pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
557 /* Do Something With It (tm) */
558 msgnum = CtdlSubmitMsg(RecvMsg->CurrMsg->Msg,
560 ChrPtr(RecvMsg->RoomName),
564 /* Message has been committed to the store
565 * write the uidl to the use table
566 * so we don't fetch this message again
569 CtdlFreeMessage(RecvMsg->CurrMsg->Msg);
572 return NextDBOperation(&RecvMsg->IO, POP3C_StoreMsgRead);
575 eNextState POP3C_ReadMessageBody(pop3aggr *RecvMsg)
577 AsyncIO *IO = &RecvMsg->IO;
578 EVP3CM_syslog(LOG_DEBUG, "Converting message...");
579 RecvMsg->CurrMsg->Msg =
580 convert_internet_message_buf(&RecvMsg->IO.ReadMsg->MsgBuf);
581 StopClientWatchers(IO, 0);
582 return QueueDBOperation(&RecvMsg->IO, POP3C_SaveMsg);
585 eNextState POP3C_SendDelete(pop3aggr *RecvMsg)
587 AsyncIO *IO = &RecvMsg->IO;
588 if (!RecvMsg->keep) {
589 StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
590 "DELE %ld\r\n", RecvMsg->CurrMsg->MSGID);
595 RecvMsg->State = ReadMessageBodyFollowing;
596 return POP3_C_DispatchWriteDone(&RecvMsg->IO);
599 eNextState POP3C_ReadDeleteState(pop3aggr *RecvMsg)
601 AsyncIO *IO = &RecvMsg->IO;
603 RecvMsg->State = GetOneMessageIDState;
607 eNextState POP3C_SendQuit(pop3aggr *RecvMsg)
609 AsyncIO *IO = &RecvMsg->IO;
611 StrBufPlain(RecvMsg->IO.SendBuf.Buf,
618 eNextState POP3C_ReadQuitState(pop3aggr *RecvMsg)
620 AsyncIO *IO = &RecvMsg->IO;
622 return eTerminateConnection;
625 const long POP3_C_ConnTimeout = 1000;
626 const long DefaultPOP3Port = 110;
628 Pop3ClientHandler POP3C_ReadHandlers[] = {
632 POP3C_GetListCommandState,
633 POP3C_GetListOneLine,
634 POP3C_GetOneMessageIDState,
635 POP3C_ReadMessageBodyFollowing,
636 POP3C_ReadMessageBody,
637 POP3C_ReadDeleteState,
641 const long POP3_C_SendTimeouts[POP3C_MaxRead] = {
651 const ConstStr POP3C_ReadErrors[POP3C_MaxRead] = {
652 {HKEY("Connection broken during ")},
653 {HKEY("Connection broken during ")},
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 ")}
662 Pop3ClientHandler POP3C_SendHandlers[] = {
663 NULL, /* we don't send a greeting */
666 POP3C_SendListCommand,
668 POP3C_GetOneMessagID,
675 const long POP3_C_ReadTimeouts[] = {
687 /*****************************************************************************/
688 /* POP3 CLIENT DISPATCHER */
689 /*****************************************************************************/
691 void POP3SetTimeout(eNextState NextTCPState, pop3aggr *pMsg)
693 AsyncIO *IO = &pMsg->IO;
694 double Timeout = 0.0;
696 EVP3C_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
698 switch (NextTCPState) {
702 Timeout = POP3_C_SendTimeouts[pMsg->State];
704 if (pMsg->State == eDATABody) {
705 / * if we're sending a huge message, we need more time. * /
706 Timeout += StrLength(pMsg->msgtext) / 1024;
712 Timeout = POP3_C_ReadTimeouts[pMsg->State];
714 if (pMsg->State == eDATATerminateBody) {
716 * some mailservers take a nap before accepting the message
717 * content inspection and such.
719 Timeout += StrLength(pMsg->msgtext) / 1024;
730 case eTerminateConnection:
733 case eReadMore://// TODO
736 SetNextTimeout(&pMsg->IO, Timeout);
738 eNextState POP3_C_DispatchReadDone(AsyncIO *IO)
740 /* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
741 pop3aggr *pMsg = IO->Data;
744 rc = POP3C_ReadHandlers[pMsg->State](pMsg);
747 POP3SetTimeout(rc, pMsg);
750 eNextState POP3_C_DispatchWriteDone(AsyncIO *IO)
752 pop3aggr *pMsg = IO->Data;
755 /* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
756 rc = POP3C_SendHandlers[pMsg->State](pMsg);
757 POP3SetTimeout(rc, pMsg);
762 /*****************************************************************************/
763 /* POP3 CLIENT ERROR CATCHERS */
764 /*****************************************************************************/
765 eNextState POP3_C_Terminate(AsyncIO *IO)
767 /// pop3aggr *pMsg = (pop3aggr *)IO->Data;
769 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
770 FinalizePOP3AggrRun(IO);
773 eNextState POP3_C_TerminateDB(AsyncIO *IO)
775 /// pop3aggr *pMsg = (pop3aggr *)IO->Data;
777 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
778 FinalizePOP3AggrRun(IO);
781 eNextState POP3_C_Timeout(AsyncIO *IO)
783 pop3aggr *pMsg = IO->Data;
785 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
786 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
787 return FailAggregationRun(IO);
789 eNextState POP3_C_ConnFail(AsyncIO *IO)
791 pop3aggr *pMsg = (pop3aggr *)IO->Data;
793 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
794 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
795 return FailAggregationRun(IO);
797 eNextState POP3_C_DNSFail(AsyncIO *IO)
799 pop3aggr *pMsg = (pop3aggr *)IO->Data;
801 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
802 StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
803 return FailAggregationRun(IO);
805 eNextState POP3_C_Shutdown(AsyncIO *IO)
807 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
808 //// pop3aggr *pMsg = IO->Data;
810 ////pMsg->MyQEntry->Status = 3;
811 ///StrBufPlain(pMsg->MyQEntry->StatusMessage, HKEY("server shutdown during message retrieval."));
812 FinalizePOP3AggrRun(IO);
818 * @brief lineread Handler; understands when to read more POP3 lines,
819 * and when this is a one-lined reply.
821 eReadState POP3_C_ReadServerStatus(AsyncIO *IO)
823 eReadState Finished = eBufferNotEmpty;
825 switch (IO->NextState) {
830 case eTerminateConnection:
832 Finished = eReadFail;
839 Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
843 Finished = CtdlReadMessageBodyAsync(IO);
849 /*****************************************************************************
850 * So we connect our Server IP here. *
851 *****************************************************************************/
852 eNextState POP3_C_ReAttachToFetchMessages(AsyncIO *IO)
854 pop3aggr *cpptr = IO->Data;
856 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
857 ////??? cpptr->State ++;
858 if (cpptr->Pos == NULL)
859 cpptr->Pos = GetNewHashPos(cpptr->MsgNumbers, 0);
861 POP3_C_DispatchWriteDone(IO);
862 ReAttachIO(IO, cpptr, 0);
863 IO->NextState = eReadMessage;
864 return IO->NextState;
867 eNextState pop3_connect_ip(AsyncIO *IO)
869 pop3aggr *cpptr = IO->Data;
871 if (cpptr->IOStart == 0.0) /* whith or without DNS? */
872 cpptr->IOStart = IO->Now;
874 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
876 return EvConnectSock(IO,
878 POP3_C_ReadTimeouts[0],
882 eNextState pop3_get_one_host_ip_done(AsyncIO *IO)
884 pop3aggr *cpptr = IO->Data;
885 struct hostent *hostent;
889 hostent = cpptr->HostLookup.VParsedDNSReply;
890 if ((cpptr->HostLookup.DNSStatus == ARES_SUCCESS) &&
891 (hostent != NULL) ) {
892 memset(&cpptr->IO.ConnectMe->Addr, 0, sizeof(struct in6_addr));
893 if (cpptr->IO.ConnectMe->IPv6) {
894 memcpy(&cpptr->IO.ConnectMe->Addr.sin6_addr.s6_addr,
895 &hostent->h_addr_list[0],
896 sizeof(struct in6_addr));
898 cpptr->IO.ConnectMe->Addr.sin6_family =
900 cpptr->IO.ConnectMe->Addr.sin6_port =
901 htons(DefaultPOP3Port);
904 struct sockaddr_in *addr =
905 (struct sockaddr_in*)
906 &cpptr->IO.ConnectMe->Addr;
908 memcpy(&addr->sin_addr.s_addr,
909 hostent->h_addr_list[0],
912 addr->sin_family = hostent->h_addrtype;
913 addr->sin_port = htons(DefaultPOP3Port);
915 return pop3_connect_ip(IO);
921 eNextState pop3_get_one_host_ip(AsyncIO *IO)
923 pop3aggr *cpptr = IO->Data;
925 cpptr->IOStart = IO->Now;
927 EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
929 EVP3CCS_syslog(LOG_DEBUG,
930 "POP3 client[%ld]: looking up %s-Record %s : %d ...\n",
932 (cpptr->IO.ConnectMe->IPv6)? "aaaa": "a",
933 cpptr->IO.ConnectMe->Host,
934 cpptr->IO.ConnectMe->Port);
936 QueueQuery((cpptr->IO.ConnectMe->IPv6)? ns_t_aaaa : ns_t_a,
937 cpptr->IO.ConnectMe->Host,
940 pop3_get_one_host_ip_done);
941 IO->NextState = eReadDNSReply;
942 return IO->NextState;
947 int pop3_do_fetching(pop3aggr *cpptr)
949 AsyncIO *IO = &cpptr->IO;
954 POP3_C_ReadServerStatus,
956 POP3_C_DispatchWriteDone,
957 POP3_C_DispatchReadDone,
964 safestrncpy(((CitContext *)cpptr->IO.CitContext)->cs_host,
966 sizeof(((CitContext *)cpptr->IO.CitContext)->cs_host));
968 if (cpptr->IO.ConnectMe->IsIP) {
969 QueueEventContext(&cpptr->IO,
973 QueueEventContext(&cpptr->IO,
974 pop3_get_one_host_ip);
980 * Scan a room's netconfig to determine whether it requires POP3 aggregation
982 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
989 char filename[PATH_MAX];
993 const char *CfgPtr, *lPtr;
996 // pop3_room_counter *Count = NULL;
999 pthread_mutex_lock(&POP3QueueMutex);
1000 if (GetHash(POP3QueueRooms, LKEY(qrbuf->QRnumber), &vptr))
1002 pthread_mutex_unlock(&POP3QueueMutex);
1003 EVP3CQ_syslog(LOG_DEBUG,
1004 "pop3client: [%ld] %s already in progress.",
1009 pthread_mutex_unlock(&POP3QueueMutex);
1011 if (server_shutting_down) return;
1013 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
1015 if (server_shutting_down)
1018 /* Only do net processing for rooms that have netconfigs */
1019 fd = open(filename, 0);
1023 if (server_shutting_down)
1025 if (fstat(fd, &statbuf) == -1) {
1026 EVP3CQ_syslog(LOG_INFO,
1027 "ERROR: could not stat configfile '%s' - %s",
1032 if (server_shutting_down)
1034 CfgData = NewStrBufPlain(NULL, statbuf.st_size + 1);
1035 if (StrBufReadBLOB(CfgData, &fd, 1, statbuf.st_size, &Err) < 0) {
1037 FreeStrBuf(&CfgData);
1038 EVP3CQ_syslog(LOG_INFO,
1039 "ERROR: reading config '%s' - %s",
1040 filename, strerror(errno));
1044 if (server_shutting_down)
1048 CfgType = NewStrBuf();
1049 Line = NewStrBufPlain(NULL, StrLength(CfgData));
1054 Done = StrBufSipLine(Line, CfgData, &CfgPtr) == 0;
1055 if (StrLength(Line) > 0)
1058 StrBufExtract_NextToken(CfgType, Line, &lPtr, '|');
1059 if (!strcasecmp("pop3client", ChrPtr(CfgType)))
1066 Count = malloc(sizeof(pop3_room_counter));
1071 cptr = (pop3aggr *) malloc(sizeof(pop3aggr));
1072 memset(cptr, 0, sizeof(pop3aggr));
1073 ///TODO do we need this? cptr->roomlist_parts=1;
1075 NewStrBufPlain(qrbuf->QRname, -1);
1077 NewStrBufPlain(NULL, StrLength(Line));
1079 NewStrBufPlain(NULL, StrLength(Line));
1080 cptr->Url = NewStrBuf();
1083 StrBufExtract_NextToken(Tmp, Line, &lPtr, '|');
1084 StrBufExtract_NextToken(cptr->pop3user,
1089 StrBufExtract_NextToken(cptr->pop3pass,
1094 cptr->keep = StrBufExtractNext_long(Line,
1098 cptr->interval = StrBufExtractNext_long(Line,
1102 StrBufAppendBufPlain(cptr->Url, HKEY("pop3://"), 0);
1103 StrBufUrlescUPAppend(cptr->Url, cptr->pop3user, NULL);
1104 StrBufAppendBufPlain(cptr->Url, HKEY(":"), 0);
1105 StrBufUrlescUPAppend(cptr->Url, cptr->pop3pass, NULL);
1106 StrBufAppendBufPlain(cptr->Url, HKEY("@"), 0);
1107 StrBufAppendBuf(cptr->Url, Tmp, 0);
1108 StrBufAppendBufPlain(cptr->Url, HKEY("/"), 0);
1109 StrBufUrlescAppend(cptr->Url, cptr->RoomName, NULL);
1112 ParseURL(&cptr->IO.ConnectMe, cptr->Url, 110);
1116 /* todo: we need to reunite the url to be shure. */
1118 pthread_mutex_lock(&POP3ueueMutex);
1119 GetHash(POP3FetchUrls, SKEY(ptr->Url), &vptr);
1120 use_this_cptr = (pop3aggr *)vptr;
1122 if (use_this_rncptr != NULL)
1124 /* mustn't attach to an active session */
1125 if (use_this_cptr->RefCount > 0)
1127 DeletePOP3Cfg(cptr);
1133 StrBufAppendBufPlain(
1134 use_this_cptr->rooms,
1137 if (use_this_cptr->roomlist_parts == 1)
1139 use_this_cptr->OtherQRnumbers
1140 = NewHash(1, lFlathash);
1142 QRnumber = (long*)malloc(sizeof(long));
1143 *QRnumber = qrbuf->QRnumber;
1144 Put(use_this_cptr->OtherQRnumbers,
1145 LKEY(qrbuf->QRnumber),
1149 use_this_cptr->roomlist_parts++;
1151 pthread_mutex_unlock(&POP3QueueMutex);
1154 pthread_mutex_unlock(&RSSQueueMutex);
1156 cptr->n = Pop3ClientID++;
1157 pthread_mutex_lock(&POP3QueueMutex);
1161 DeletePOP3Aggregator);
1163 pthread_mutex_unlock(&POP3QueueMutex);
1173 FreeStrBuf(&CfgType);
1174 FreeStrBuf(&CfgData);
1177 static int doing_pop3client = 0;
1179 void pop3client_scan(void) {
1180 static time_t last_run = 0L;
1181 time_t fastest_scan;
1188 become_session(&pop3_client_CC);
1190 if (config.c_pop3_fastest < config.c_pop3_fetch)
1191 fastest_scan = config.c_pop3_fastest;
1193 fastest_scan = config.c_pop3_fetch;
1196 * Run POP3 aggregation no more frequently than once every n seconds
1198 if ( (time(NULL) - last_run) < fastest_scan ) {
1203 * This is a simple concurrency check to make sure only one pop3client
1204 * run is done at a time. We could do this with a mutex, but since we
1205 * don't really require extremely fine granularity here, we'll do it
1206 * with a static variable instead.
1208 if (doing_pop3client) return;
1209 doing_pop3client = 1;
1211 EVP3CQM_syslog(LOG_DEBUG, "pop3client started");
1212 CtdlForEachRoom(pop3client_scan_room, NULL);
1214 pthread_mutex_lock(&POP3QueueMutex);
1215 it = GetNewHashPos(POP3FetchUrls, 0);
1216 while (!server_shutting_down &&
1217 GetNextHashPos(POP3FetchUrls, it, &len, &Key, &vrptr) &&
1219 cptr = (pop3aggr *)vrptr;
1220 if (cptr->RefCount == 0)
1221 if (!pop3_do_fetching(cptr))
1222 DeletePOP3Aggregator(cptr);////TODO
1225 if ((palist->interval && time(NULL) > (last_run + palist->interval))
1226 || (time(NULL) > last_run + config.c_pop3_fetch))
1227 pop3_do_fetching(palist->roomname, palist->pop3host,
1228 palist->pop3user, palist->pop3pass, palist->keep);
1230 palist = palist->next;
1235 pthread_mutex_unlock(&POP3QueueMutex);
1237 EVP3CQM_syslog(LOG_DEBUG, "pop3client ended");
1238 last_run = time(NULL);
1239 doing_pop3client = 0;
1243 void pop3_cleanup(void)
1245 /* citthread_mutex_destroy(&POP3QueueMutex); TODO */
1246 while (doing_pop3client != 0) ;
1247 DeleteHash(&POP3FetchUrls);
1248 DeleteHash(&POP3QueueRooms);
1253 void LogDebugEnablePOP3Client(const int n)
1255 POP3ClientDebugEnabled = n;
1258 CTDL_MODULE_INIT(pop3client)
1262 CtdlFillSystemContext(&pop3_client_CC, "POP3aggr");
1263 pthread_mutex_init(&POP3QueueMutex, NULL);
1264 POP3QueueRooms = NewHash(1, lFlathash);
1265 POP3FetchUrls = NewHash(1, NULL);
1266 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER, PRIO_AGGR + 50);
1267 CtdlRegisterEVCleanupHook(pop3_cleanup);
1268 CtdlRegisterDebugFlagHook(HKEY("pop3client"), LogDebugEnablePOP3Client, &POP3ClientDebugEnabled);
1271 /* return our module id for the log */
1272 return "pop3client";