/*
- * Aggregate remote POP3 accounts
+ * Consolidate mail from remote POP3 accounts.
+ *
+ * Copyright (c) 2007-2015 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as published
+ * by the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*/
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
+#include <sysconfig.h>
#if TIME_WITH_SYS_TIME
# include <sys/time.h>
#include <ctype.h>
#include <string.h>
#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <libcitadel.h>
#include "citadel.h"
#include "server.h"
#include "citserver.h"
#include "support.h"
#include "config.h"
-#include "tools.h"
-#include "room_ops.h"
#include "ctdl_module.h"
#include "clientsocket.h"
+#include "msgbase.h"
+#include "internet_addressing.h"
+#include "database.h"
+#include "citadel_dirs.h"
+#include "event_client.h"
-struct pop3aggr {
- struct pop3aggr *next;
- char roomname[ROOMNAMELEN];
- char pop3host[128];
- char pop3user[128];
- char pop3pass[128];
+
+#define POP3C_OK (strncasecmp(ChrPtr(RecvMsg->IO.IOBuf), "+OK", 3) == 0)
+int Pop3ClientID = 0;
+int POP3ClientDebugEnabled = 0;
+
+#define N ((pop3aggr*)IO->Data)->n
+
+#define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (POP3ClientDebugEnabled != 0))
+
+#define EVP3C_syslog(LEVEL, FORMAT, ...) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "%s[%ld]CC[%d][%ld]POP3: " FORMAT, \
+ IOSTR, IO->ID, CCID, N, __VA_ARGS__)
+
+#define EVP3CM_syslog(LEVEL, FORMAT) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "%s[%ld]CC[%d][%ld]POP3: " FORMAT, \
+ IOSTR, IO->ID, CCID, N)
+
+#define EVP3CQ_syslog(LEVEL, FORMAT, ...) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "%s P3Q:" FORMAT, \
+ IOSTR, __VA_ARGS__)
+
+#define EVP3CQM_syslog(LEVEL, FORMAT) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "%s P3Q" FORMAT, \
+ IOSTR)
+
+#define EVP3CCS_syslog(LEVEL, FORMAT, ...) \
+ DBGLOG(LEVEL) syslog(LEVEL, "%s[%ld][%ld]POP3: " FORMAT, \
+ IOSTR, IO->ID, N, __VA_ARGS__)
+
+#define EVP3CCSM_syslog(LEVEL, FORMAT) \
+ DBGLOG(LEVEL) syslog(LEVEL, "%s[%ld][%ld]POP3: " FORMAT, \
+ IOSTR, IO->ID, N)
+
+#define POP3C_DBG_SEND() \
+ EVP3C_syslog(LOG_DEBUG, \
+ "%s[%ld]CC[%d][%ld]POP3: > %s\n", \
+ IOSTR, IO->ID, CCID, N, \
+ ChrPtr(RecvMsg->IO.SendBuf.Buf))
+
+#define POP3C_DBG_READ() \
+ EVP3C_syslog(LOG_DEBUG, \
+ "%s[%ld]CC[%d][%ld]POP3: < %s\n", \
+ IOSTR, IO->ID, CCID, N, \
+ ChrPtr(RecvMsg->IO.IOBuf))
+
+
+struct CitContext pop3_client_CC;
+
+pthread_mutex_t POP3QueueMutex; /* locks the access to the following vars: */
+HashList *POP3QueueRooms = NULL;
+HashList *POP3FetchUrls = NULL;
+
+typedef struct pop3aggr pop3aggr;
+typedef eNextState(*Pop3ClientHandler)(pop3aggr* RecvMsg);
+
+eNextState POP3_C_Shutdown(AsyncIO *IO);
+eNextState POP3_C_Timeout(AsyncIO *IO);
+eNextState POP3_C_ConnFail(AsyncIO *IO);
+eNextState POP3_C_DNSFail(AsyncIO *IO);
+eNextState POP3_C_DispatchReadDone(AsyncIO *IO);
+eNextState POP3_C_DispatchWriteDone(AsyncIO *IO);
+eNextState POP3_C_Terminate(AsyncIO *IO);
+eReadState POP3_C_ReadServerStatus(AsyncIO *IO);
+eNextState POP3_C_ReAttachToFetchMessages(AsyncIO *IO);
+
+typedef struct __pop3_room_counter {
+ int count;
+ long QRnumber;
+}pop3_room_counter;
+
+typedef enum ePOP3_C_States {
+ ReadGreeting,
+ GetUserState,
+ GetPassState,
+ GetListCommandState,
+ GetListOneLine,
+ GetOneMessageIDState,
+ ReadMessageBodyFollowing,
+ ReadMessageBody,
+ GetDeleteState,
+ ReadQuitState,
+ POP3C_MaxRead
+}ePOP3_C_States;
+
+
+typedef struct _FetchItem {
+ long MSGID;
+ long MSGSize;
+ StrBuf *MsgUIDL;
+ StrBuf *MsgUID;
+ int NeedFetch;
+ struct CtdlMessage *Msg;
+} FetchItem;
+
+void HfreeFetchItem(void *vItem)
+{
+ FetchItem *Item = (FetchItem*) vItem;
+ FreeStrBuf(&Item->MsgUIDL);
+ FreeStrBuf(&Item->MsgUID);
+ free(Item);
+}
+
+
+
+typedef enum _POP3State {
+ eCreated,
+ eGreeting,
+ eUser,
+ ePassword,
+ eListing,
+ eUseTable,
+ eGetMsgID,
+ eGetMsg,
+ eStoreMsg,
+ eDelete,
+ eQuit
+} POP3State;
+
+ConstStr POP3States[] = {
+ {HKEY("Aggregator created")},
+ {HKEY("Reading Greeting")},
+ {HKEY("Sending User")},
+ {HKEY("Sending Password")},
+ {HKEY("Listing")},
+ {HKEY("Fetching Usetable")},
+ {HKEY("Get MSG ID")},
+ {HKEY("Get Message")},
+ {HKEY("Store Msg")},
+ {HKEY("Delete Upstream")},
+ {HKEY("Quit")}
};
-struct pop3aggr *palist = NULL;
+static void SetPOP3State(AsyncIO *IO, POP3State State)
+{
+ CitContext* CCC = IO->CitContext;
+ if (CCC != NULL)
+ memcpy(CCC->cs_clientname, POP3States[State].Key, POP3States[State].len + 1);
+}
+
-#ifdef POP3_AGGREGATION
+struct pop3aggr {
+ AsyncIO IO;
+
+ long n;
+ double IOStart;
+ long count;
+ long RefCount;
+ DNSQueryParts HostLookup;
+ long QRnumber;
+ HashList *OtherQRnumbers;
+
+ StrBuf *Url;
+ StrBuf *pop3user;
+ StrBuf *pop3pass;
+ StrBuf *Host;
+ StrBuf *RoomName; // TODO: fill me
+ int keep;
+ time_t interval;
+ ePOP3_C_States State;
+ HashList *MsgNumbers;
+ HashPos *Pos;
+ FetchItem *CurrMsg;
+};
-void pop3_do_fetching(char *roomname, char *pop3host, char *pop3user, char *pop3pass)
+void DeletePOP3Aggregator(void *vptr)
{
- int sock;
- char buf[SIZ];
+ pop3aggr *ptr = vptr;
+ DeleteHashPos(&ptr->Pos);
+ DeleteHash(&ptr->MsgNumbers);
+// FreeStrBuf(&ptr->rooms);
+ FreeStrBuf(&ptr->pop3user);
+ FreeStrBuf(&ptr->pop3pass);
+ FreeStrBuf(&ptr->Host);
+ FreeStrBuf(&ptr->RoomName);
+ FreeURL(&ptr->IO.ConnectMe);
+ FreeStrBuf(&ptr->Url);
+ FreeStrBuf(&ptr->IO.IOBuf);
+ FreeStrBuf(&ptr->IO.SendBuf.Buf);
+ FreeStrBuf(&ptr->IO.RecvBuf.Buf);
+ DeleteAsyncMsg(&ptr->IO.ReadMsg);
+ if (((struct CitContext*)ptr->IO.CitContext)) {
+ ((struct CitContext*)ptr->IO.CitContext)->state = CON_IDLE;
+ ((struct CitContext*)ptr->IO.CitContext)->kill_me = 1;
+ }
+ FreeAsyncIOContents(&ptr->IO);
+ free(ptr);
+}
- lprintf(CTDL_DEBUG, "POP3: %s %s %s %s\n", roomname, pop3host, pop3user, pop3pass);
- lprintf(CTDL_NOTICE, "Connecting to <%s>\n", pop3host);
- sock = sock_connect(pop3host, "110", "tcp");
- if (sock < 0) {
- lprintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
- return;
+eNextState FinalizePOP3AggrRun(AsyncIO *IO)
+{
+ HashPos *It;
+ pop3aggr *cpptr = (pop3aggr *)IO->Data;
+
+ EVP3C_syslog(LOG_INFO,
+ "%s@%s: fetched %ld new of %d messages in %fs. bye.",
+ ChrPtr(cpptr->pop3user),
+ ChrPtr(cpptr->Host),
+ cpptr->count,
+ GetCount(cpptr->MsgNumbers),
+ IO->Now - cpptr->IOStart
+ );
+
+ It = GetNewHashPos(POP3FetchUrls, 0);
+ pthread_mutex_lock(&POP3QueueMutex);
+ {
+ if (GetHashPosFromKey(POP3FetchUrls, SKEY(cpptr->Url), It))
+ DeleteEntryFromHash(POP3FetchUrls, It);
}
-
- lprintf(CTDL_DEBUG, "Connected!\n");
+ pthread_mutex_unlock(&POP3QueueMutex);
+ DeleteHashPos(&It);
+ return eAbort;
+}
+eNextState FailAggregationRun(AsyncIO *IO)
+{
+ return eAbort;
+}
+
+eNextState POP3C_ReadGreeting(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ SetPOP3State(IO, eGreeting);
+ POP3C_DBG_READ();
/* Read the server greeting */
- if (sock_gets(sock, buf) < 0) goto bail;
- lprintf(CTDL_DEBUG, ">%s\n", buf);
- if (strncasecmp(buf, "+OK", 3)) goto bail;
-
- /* Identify ourselves */
- snprintf(buf, sizeof buf, "USER %s", pop3user);
- lprintf(CTDL_DEBUG, "<%s\n", buf);
- if (sock_puts(sock, buf) <0) goto bail;
- if (sock_gets(sock, buf) < 0) goto bail;
- lprintf(CTDL_DEBUG, ">%s\n", buf);
- if (strncasecmp(buf, "+OK", 3)) goto bail;
+ if (!POP3C_OK) return eTerminateConnection;
+ else return eSendReply;
+}
+
+eNextState POP3C_SendUser(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ SetPOP3State(IO, eUser);
+ /* Identify ourselves. NOTE: we have to append a CR to each command.
+ * The LF will automatically be appended by sock_puts(). Believe it
+ * or not, leaving out the CR will cause problems if the server happens
+ * to be Exchange, which is so b0rken it actually barfs on
+ * LF-terminated newlines.
+ */
+ StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
+ "USER %s\r\n", ChrPtr(RecvMsg->pop3user));
+ POP3C_DBG_SEND();
+ return eReadMessage;
+}
+
+eNextState POP3C_GetUserState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ if (!POP3C_OK) return eTerminateConnection;
+ else return eSendReply;
+}
+eNextState POP3C_SendPassword(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ SetPOP3State(IO, ePassword);
/* Password */
- snprintf(buf, sizeof buf, "PASS %s", pop3pass);
- lprintf(CTDL_DEBUG, "<%s\n", buf);
- if (sock_puts(sock, buf) <0) goto bail;
- if (sock_gets(sock, buf) < 0) goto bail;
- lprintf(CTDL_DEBUG, ">%s\n", buf);
- if (strncasecmp(buf, "+OK", 3)) goto bail;
+ StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
+ "PASS %s\r\n", ChrPtr(RecvMsg->pop3pass));
+ EVP3CM_syslog(LOG_DEBUG, "<PASS <password>\n");
+// POP3C_DBG_SEND(); No, we won't write the passvoid to syslog...
+ return eReadMessage;
+}
+
+eNextState POP3C_GetPassState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ if (!POP3C_OK) return eTerminateConnection;
+ else return eSendReply;
+}
+
+eNextState POP3C_SendListCommand(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ SetPOP3State(IO, eListing);
+
+ /* Get the list of messages */
+ StrBufPlain(RecvMsg->IO.SendBuf.Buf, HKEY("LIST\r\n"));
+ POP3C_DBG_SEND();
+ return eReadMessage;
+}
+
+eNextState POP3C_GetListCommandState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ if (!POP3C_OK) return eTerminateConnection;
+ RecvMsg->MsgNumbers = NewHash(1, NULL);
+ RecvMsg->State++;
+ return eReadMore;
+}
+
+
+eNextState POP3C_GetListOneLine(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+#if 0
+ int rc;
+#endif
+ const char *pch;
+ FetchItem *OneMsg = NULL;
+ POP3C_DBG_READ();
+
+ if ((StrLength(RecvMsg->IO.IOBuf) == 1) &&
+ (ChrPtr(RecvMsg->IO.IOBuf)[0] == '.'))
+ {
+ if (GetCount(RecvMsg->MsgNumbers) == 0)
+ {
+ //// RecvMsg->Sate = ReadQuitState;
+ }
+ else
+ {
+ RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
+ }
+ return eSendReply;
+
+ }
+
+ /*
+ * work around buggy pop3 servers which send
+ * empty lines in their listings.
+ */
+ if ((StrLength(RecvMsg->IO.IOBuf) == 0) ||
+ !isdigit(ChrPtr(RecvMsg->IO.IOBuf)[0]))
+ {
+ return eReadMore;
+ }
+
+ OneMsg = (FetchItem*) malloc(sizeof(FetchItem));
+ memset(OneMsg, 0, sizeof(FetchItem));
+ OneMsg->MSGID = atol(ChrPtr(RecvMsg->IO.IOBuf));
+
+ pch = strchr(ChrPtr(RecvMsg->IO.IOBuf), ' ');
+ if (pch != NULL)
+ {
+ OneMsg->MSGSize = atol(pch + 1);
+ }
+#if 0
+ rc = TestValidateHash(RecvMsg->MsgNumbers);
+ if (rc != 0)
+ EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
+#endif
+
+ Put(RecvMsg->MsgNumbers, LKEY(OneMsg->MSGID), OneMsg, HfreeFetchItem);
+#if 0
+ rc = TestValidateHash(RecvMsg->MsgNumbers);
+ if (rc != 0)
+ EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
+#endif
+ //RecvMsg->State --; /* read next Line */
+ return eReadMore;
+}
+
+eNextState POP3_FetchNetworkUsetableEntry(AsyncIO *IO)
+{
+ long HKLen;
+ const char *HKey;
+ void *vData;
+ pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
+ time_t seenstamp = 0;
+
+ SetPOP3State(IO, eUseTable);
+
+ if((RecvMsg->Pos != NULL) &&
+ GetNextHashPos(RecvMsg->MsgNumbers,
+ RecvMsg->Pos,
+ &HKLen,
+ &HKey,
+ &vData))
+ {
+ if (server_shutting_down)
+ return eAbort;
+
+ RecvMsg->CurrMsg = (FetchItem*)vData;
+
+ seenstamp = CheckIfAlreadySeen("POP3 Item Seen",
+ RecvMsg->CurrMsg->MsgUID,
+ EvGetNow(IO),
+ EvGetNow(IO) - USETABLE_ANTIEXPIRE,
+ eCheckUpdate,
+ IO->ID, CCID);
+ if (seenstamp != 0)
+ {
+ /* Item has already been seen */
+ RecvMsg->CurrMsg->NeedFetch = 0;
+ }
+ else
+ {
+ EVP3CCSM_syslog(LOG_DEBUG, "NO\n");
+ RecvMsg->CurrMsg->NeedFetch = 1;
+ }
+ return NextDBOperation(&RecvMsg->IO,
+ POP3_FetchNetworkUsetableEntry);
+ }
+ else
+ {
+ /* ok, now we know them all,
+ * continue with reading the actual messages. */
+ DeleteHashPos(&RecvMsg->Pos);
+ return DBQueueEventContext(IO, POP3_C_ReAttachToFetchMessages);
+ }
+}
+
+eNextState POP3C_GetOneMessagID(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ long HKLen;
+ const char *HKey;
+ void *vData;
+
+ SetPOP3State(IO, eGetMsgID);
+#if 0
+ int rc;
+ rc = TestValidateHash(RecvMsg->MsgNumbers);
+ if (rc != 0)
+ EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
+#endif
+ if((RecvMsg->Pos != NULL) &&
+ GetNextHashPos(RecvMsg->MsgNumbers,
+ RecvMsg->Pos,
+ &HKLen, &HKey,
+ &vData))
+ {
+ RecvMsg->CurrMsg = (FetchItem*) vData;
+ /* Find out the UIDL of the message,
+ * to determine whether we've already downloaded it */
+ StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
+ "UIDL %ld\r\n", RecvMsg->CurrMsg->MSGID);
+ POP3C_DBG_SEND();
+ }
+ else
+ {
+ RecvMsg->State++;
+ DeleteHashPos(&RecvMsg->Pos);
+ /// done receiving uidls.. start looking them up now.
+ RecvMsg->Pos = GetNewHashPos(RecvMsg->MsgNumbers, 0);
+ return EventQueueDBOperation(&RecvMsg->IO,
+ POP3_FetchNetworkUsetableEntry,
+ 0);
+ }
+ return eReadMore; /* TODO */
+}
+
+eNextState POP3C_GetOneMessageIDState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+#if 0
+ int rc;
+ rc = TestValidateHash(RecvMsg->MsgNumbers);
+ if (rc != 0)
+ EVP3CCS_syslog(LOG_DEBUG, "Hash Invalid: %d\n", rc);
+#endif
+
+ POP3C_DBG_READ();
+ if (!POP3C_OK) return eTerminateConnection;
+ RecvMsg->CurrMsg->MsgUIDL =
+ NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf));
+ RecvMsg->CurrMsg->MsgUID =
+ NewStrBufPlain(NULL, StrLength(RecvMsg->IO.IOBuf) * 2);
+
+ StrBufExtract_token(RecvMsg->CurrMsg->MsgUIDL,
+ RecvMsg->IO.IOBuf, 2, ' ');
+
+ StrBufPrintf(RecvMsg->CurrMsg->MsgUID,
+ "pop3/%s/%s:%s@%s",
+ ChrPtr(RecvMsg->RoomName),
+ ChrPtr(RecvMsg->CurrMsg->MsgUIDL),
+ RecvMsg->IO.ConnectMe->User,
+ RecvMsg->IO.ConnectMe->Host);
+ RecvMsg->State --;
+ return eSendReply;
+}
+
+
+eNextState POP3C_SendGetOneMsg(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ long HKLen;
+ const char *HKey;
+ void *vData;
+
+ SetPOP3State(IO, eGetMsg);
+
+ EVP3CM_syslog(LOG_DEBUG, "fast forwarding to the next unknown message");
+
+ RecvMsg->CurrMsg = NULL;
+ while ((RecvMsg->Pos != NULL) &&
+ GetNextHashPos(RecvMsg->MsgNumbers,
+ RecvMsg->Pos,
+ &HKLen, &HKey,
+ &vData) &&
+ (RecvMsg->CurrMsg = (FetchItem*) vData,
+ RecvMsg->CurrMsg->NeedFetch == 0))
+ {}
+
+ if ((RecvMsg->CurrMsg != NULL ) && (RecvMsg->CurrMsg->NeedFetch == 1))
+ {
+ EVP3CM_syslog(LOG_DEBUG, "fetching next");
+ /* Message has not been seen.
+ * Tell the server to fetch the message... */
+ StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
+ "RETR %ld\r\n", RecvMsg->CurrMsg->MSGID);
+ POP3C_DBG_SEND();
+ return eReadMessage;
+ }
+ else {
+ EVP3CM_syslog(LOG_DEBUG, "no more messages to fetch.");
+ RecvMsg->State = ReadQuitState;
+ return POP3_C_DispatchWriteDone(&RecvMsg->IO);
+ }
+}
+
+
+eNextState POP3C_ReadMessageBodyFollowing(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ if (!POP3C_OK) return eTerminateConnection;
+ RecvMsg->IO.ReadMsg = NewAsyncMsg(HKEY("."),
+ RecvMsg->CurrMsg->MSGSize,
+ CtdlGetConfigLong("c_maxmsglen"),
+ NULL, -1,
+ 1);
+
+ return eReadPayload;
+}
+
+
+eNextState POP3C_StoreMsgRead(AsyncIO *IO)
+{
+ pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
+
+ SetPOP3State(IO, eStoreMsg);
+
+ EVP3CCS_syslog(LOG_DEBUG,
+ "MARKING: %s as seen: ",
+ ChrPtr(RecvMsg->CurrMsg->MsgUID));
+ CheckIfAlreadySeen("POP3 Item Seen",
+ RecvMsg->CurrMsg->MsgUID,
+ EvGetNow(IO),
+ EvGetNow(IO) - USETABLE_ANTIEXPIRE,
+ eWrite,
+ IO->ID, CCID);
+
+ return DBQueueEventContext(&RecvMsg->IO, POP3_C_ReAttachToFetchMessages);
+}
+eNextState POP3C_SaveMsg(AsyncIO *IO)
+{
+ long msgnum;
+ pop3aggr *RecvMsg = (pop3aggr *) IO->Data;
+
+ /* Do Something With It (tm) */
+ msgnum = CtdlSubmitMsg(RecvMsg->CurrMsg->Msg,
+ NULL,
+ ChrPtr(RecvMsg->RoomName),
+ 0);
+ if (msgnum > 0L)
+ {
+ /* Message has been committed to the store
+ * write the uidl to the use table
+ * so we don't fetch this message again
+ */
+ }
+ CM_Free(RecvMsg->CurrMsg->Msg);
+
+ RecvMsg->count ++;
+ return NextDBOperation(&RecvMsg->IO, POP3C_StoreMsgRead);
+}
+
+eNextState POP3C_ReadMessageBody(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ EVP3CM_syslog(LOG_DEBUG, "Converting message...");
+ RecvMsg->CurrMsg->Msg =
+ convert_internet_message_buf(&RecvMsg->IO.ReadMsg->MsgBuf);
+ return EventQueueDBOperation(&RecvMsg->IO, POP3C_SaveMsg, 0);
+}
+
+eNextState POP3C_SendDelete(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+
+ SetPOP3State(IO, eDelete);
+
+ if (!RecvMsg->keep) {
+ StrBufPrintf(RecvMsg->IO.SendBuf.Buf,
+ "DELE %ld\r\n", RecvMsg->CurrMsg->MSGID);
+ POP3C_DBG_SEND();
+ return eReadMessage;
+ }
+ else {
+ RecvMsg->State = ReadMessageBodyFollowing;
+ return POP3_C_DispatchWriteDone(&RecvMsg->IO);
+ }
+}
+eNextState POP3C_ReadDeleteState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ RecvMsg->State = GetOneMessageIDState;
+ return POP3_C_DispatchWriteDone(&RecvMsg->IO);
+}
- sock_puts(sock, "QUIT");
-bail: sock_close(sock);
+eNextState POP3C_SendQuit(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ SetPOP3State(IO, eQuit);
+
+ /* Log out */
+ StrBufPlain(RecvMsg->IO.SendBuf.Buf,
+ HKEY("QUIT\r\n3)"));
+ POP3C_DBG_SEND();
+ return eReadMessage;
}
+eNextState POP3C_ReadQuitState(pop3aggr *RecvMsg)
+{
+ AsyncIO *IO = &RecvMsg->IO;
+ POP3C_DBG_READ();
+ return eTerminateConnection;
+}
+
+const long POP3_C_ConnTimeout = 1000;
+const long DefaultPOP3Port = 110;
+
+Pop3ClientHandler POP3C_ReadHandlers[] = {
+ POP3C_ReadGreeting,
+ POP3C_GetUserState,
+ POP3C_GetPassState,
+ POP3C_GetListCommandState,
+ POP3C_GetListOneLine,
+ POP3C_GetOneMessageIDState,
+ POP3C_ReadMessageBodyFollowing,
+ POP3C_ReadMessageBody,
+ POP3C_ReadDeleteState,
+ POP3C_ReadQuitState,
+};
+
+const long POP3_C_SendTimeouts[POP3C_MaxRead] = {
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100
+};
+const ConstStr POP3C_ReadErrors[POP3C_MaxRead] = {
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")},
+ {HKEY("Connection broken during ")}
+};
+
+Pop3ClientHandler POP3C_SendHandlers[] = {
+ NULL, /* we don't send a greeting */
+ POP3C_SendUser,
+ POP3C_SendPassword,
+ POP3C_SendListCommand,
+ NULL,
+ POP3C_GetOneMessagID,
+ POP3C_SendGetOneMsg,
+ NULL,
+ POP3C_SendDelete,
+ POP3C_SendQuit
+};
+
+const long POP3_C_ReadTimeouts[] = {
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100,
+ 100
+};
+/*****************************************************************************/
+/* POP3 CLIENT DISPATCHER */
+/*****************************************************************************/
+
+void POP3SetTimeout(eNextState NextTCPState, pop3aggr *pMsg)
+{
+ AsyncIO *IO = &pMsg->IO;
+ double Timeout = 0.0;
+
+ EVP3C_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+
+ switch (NextTCPState) {
+ case eSendFile:
+ case eSendReply:
+ case eSendMore:
+ Timeout = POP3_C_SendTimeouts[pMsg->State];
/*
- * Scan a room's netconfig to determine whether it requires POP3 aggregation
+ if (pMsg->State == eDATABody) {
+ / * if we're sending a huge message, we need more time. * /
+ Timeout += StrLength(pMsg->msgtext) / 1024;
+ }
+*/
+ break;
+ case eReadFile:
+ case eReadMessage:
+ Timeout = POP3_C_ReadTimeouts[pMsg->State];
+/*
+ if (pMsg->State == eDATATerminateBody) {
+ / *
+ * some mailservers take a nap before accepting the message
+ * content inspection and such.
+ * /
+ Timeout += StrLength(pMsg->msgtext) / 1024;
+ }
+*/
+ break;
+ case eReadPayload:
+ Timeout = 100000;
+ /* TODO!!! */
+ break;
+ case eSendDNSQuery:
+ case eReadDNSReply:
+ case eConnect:
+ case eTerminateConnection:
+ case eDBQuery:
+ case eAbort:
+ case eReadMore://// TODO
+ return;
+ }
+ SetNextTimeout(&pMsg->IO, Timeout);
+}
+eNextState POP3_C_DispatchReadDone(AsyncIO *IO)
+{
+/* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
+ pop3aggr *pMsg = IO->Data;
+ eNextState rc;
+
+ rc = POP3C_ReadHandlers[pMsg->State](pMsg);
+ if (rc != eReadMore)
+ pMsg->State++;
+ POP3SetTimeout(rc, pMsg);
+ return rc;
+}
+eNextState POP3_C_DispatchWriteDone(AsyncIO *IO)
+{
+ pop3aggr *pMsg = IO->Data;
+ eNextState rc;
+
+/* EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__); to noisy anyways. */
+ rc = POP3C_SendHandlers[pMsg->State](pMsg);
+ POP3SetTimeout(rc, pMsg);
+ return rc;
+}
+
+
+/*****************************************************************************/
+/* POP3 CLIENT ERROR CATCHERS */
+/*****************************************************************************/
+eNextState POP3_C_Terminate(AsyncIO *IO)
+{
+/// pop3aggr *pMsg = (pop3aggr *)IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+ FinalizePOP3AggrRun(IO);
+ return eAbort;
+}
+eNextState POP3_C_TerminateDB(AsyncIO *IO)
+{
+/// pop3aggr *pMsg = (pop3aggr *)IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+ FinalizePOP3AggrRun(IO);
+ return eAbort;
+}
+eNextState POP3_C_Timeout(AsyncIO *IO)
+{
+ pop3aggr *pMsg = IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+ StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
+ return FailAggregationRun(IO);
+}
+eNextState POP3_C_ConnFail(AsyncIO *IO)
+{
+ pop3aggr *pMsg = (pop3aggr *)IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+ StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
+ return FailAggregationRun(IO);
+}
+eNextState POP3_C_DNSFail(AsyncIO *IO)
+{
+ pop3aggr *pMsg = (pop3aggr *)IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+ StrBufPlain(IO->ErrMsg, CKEY(POP3C_ReadErrors[pMsg->State]));
+ return FailAggregationRun(IO);
+}
+eNextState POP3_C_Shutdown(AsyncIO *IO)
+{
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+//// pop3aggr *pMsg = IO->Data;
+
+////pMsg->MyQEntry->Status = 3;
+///StrBufPlain(pMsg->MyQEntry->StatusMessage, HKEY("server shutdown during message retrieval."));
+ FinalizePOP3AggrRun(IO);
+ return eAbort;
+}
+
+
+/**
+ * @brief lineread Handler; understands when to read more POP3 lines,
+ * and when this is a one-lined reply.
*/
-void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
+eReadState POP3_C_ReadServerStatus(AsyncIO *IO)
+{
+ eReadState Finished = eBufferNotEmpty;
+
+ switch (IO->NextState) {
+ case eSendDNSQuery:
+ case eReadDNSReply:
+ case eDBQuery:
+ case eConnect:
+ case eTerminateConnection:
+ case eAbort:
+ Finished = eReadFail;
+ break;
+ case eSendFile:
+ case eSendReply:
+ case eSendMore:
+ case eReadMore:
+ case eReadMessage:
+ Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
+ break;
+ case eReadFile:
+ case eReadPayload:
+ Finished = CtdlReadMessageBodyAsync(IO);
+ break;
+ }
+ return Finished;
+}
+
+/*****************************************************************************
+ * So we connect our Server IP here. *
+ *****************************************************************************/
+eNextState POP3_C_ReAttachToFetchMessages(AsyncIO *IO)
+{
+ pop3aggr *cpptr = IO->Data;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+////??? cpptr->State ++;
+ if (cpptr->Pos == NULL)
+ cpptr->Pos = GetNewHashPos(cpptr->MsgNumbers, 0);
+
+ POP3_C_DispatchWriteDone(IO);
+ ReAttachIO(IO, cpptr, 0);
+ IO->NextState = eReadMessage;
+ return IO->NextState;
+}
+
+eNextState pop3_connect_ip(AsyncIO *IO)
+{
+ pop3aggr *cpptr = IO->Data;
+
+ if (cpptr->IOStart == 0.0) /* whith or without DNS? */
+ cpptr->IOStart = IO->Now;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+
+ return EvConnectSock(IO,
+ POP3_C_ConnTimeout,
+ POP3_C_ReadTimeouts[0],
+ 1);
+}
+
+eNextState pop3_get_one_host_ip_done(AsyncIO *IO)
{
- char filename[PATH_MAX];
- char buf[1024];
- char instr[32];
- FILE *fp;
- struct pop3aggr *pptr;
+ pop3aggr *cpptr = IO->Data;
+ struct hostent *hostent;
- assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
+ QueryCbDone(IO);
- /* Only do net processing for rooms that have netconfigs */
- fp = fopen(filename, "r");
- if (fp == NULL) {
+ hostent = cpptr->HostLookup.VParsedDNSReply;
+ if ((cpptr->HostLookup.DNSStatus == ARES_SUCCESS) &&
+ (hostent != NULL) ) {
+ memset(&cpptr->IO.ConnectMe->Addr, 0, sizeof(struct in6_addr));
+ if (cpptr->IO.ConnectMe->IPv6) {
+ memcpy(&cpptr->IO.ConnectMe->Addr.sin6_addr.s6_addr,
+ &hostent->h_addr_list[0],
+ sizeof(struct in6_addr));
+
+ cpptr->IO.ConnectMe->Addr.sin6_family =
+ hostent->h_addrtype;
+ cpptr->IO.ConnectMe->Addr.sin6_port =
+ htons(DefaultPOP3Port);
+ }
+ else {
+ struct sockaddr_in *addr =
+ (struct sockaddr_in*)
+ &cpptr->IO.ConnectMe->Addr;
+
+ memcpy(&addr->sin_addr.s_addr,
+ hostent->h_addr_list[0],
+ sizeof(uint32_t));
+
+ addr->sin_family = hostent->h_addrtype;
+ addr->sin_port = htons(DefaultPOP3Port);
+ }
+ return pop3_connect_ip(IO);
+ }
+ else
+ return eAbort;
+}
+
+eNextState pop3_get_one_host_ip(AsyncIO *IO)
+{
+ pop3aggr *cpptr = IO->Data;
+
+ cpptr->IOStart = IO->Now;
+
+ EVP3CCS_syslog(LOG_DEBUG, "POP3: %s\n", __FUNCTION__);
+
+ EVP3CCS_syslog(LOG_DEBUG,
+ "POP3 client[%ld]: looking up %s-Record %s : %d ...\n",
+ cpptr->n,
+ (cpptr->IO.ConnectMe->IPv6)? "aaaa": "a",
+ cpptr->IO.ConnectMe->Host,
+ cpptr->IO.ConnectMe->Port);
+
+ QueueQuery((cpptr->IO.ConnectMe->IPv6)? ns_t_aaaa : ns_t_a,
+ cpptr->IO.ConnectMe->Host,
+ &cpptr->IO,
+ &cpptr->HostLookup,
+ pop3_get_one_host_ip_done);
+ IO->NextState = eReadDNSReply;
+ return IO->NextState;
+}
+
+
+
+int pop3_do_fetching(pop3aggr *cpptr)
+{
+ AsyncIO *IO = &cpptr->IO;
+
+ InitIOStruct(IO,
+ cpptr,
+ eReadMessage,
+ POP3_C_ReadServerStatus,
+ POP3_C_DNSFail,
+ POP3_C_DispatchWriteDone,
+ POP3_C_DispatchReadDone,
+ POP3_C_Terminate,
+ POP3_C_TerminateDB,
+ POP3_C_ConnFail,
+ POP3_C_Timeout,
+ POP3_C_Shutdown);
+
+ safestrncpy(((CitContext *)cpptr->IO.CitContext)->cs_host,
+ ChrPtr(cpptr->Url),
+ sizeof(((CitContext *)cpptr->IO.CitContext)->cs_host));
+
+ if (cpptr->IO.ConnectMe->IsIP) {
+ QueueEventContext(&cpptr->IO,
+ pop3_connect_ip);
+ }
+ else {
+ QueueEventContext(&cpptr->IO,
+ pop3_get_one_host_ip);
+ }
+ return 1;
+}
+
+/*
+ * Scan a room's netconfig to determine whether it requires POP3 aggregation
+ */
+void pop3client_scan_room(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCFG)
+{
+ const RoomNetCfgLine *pLine;
+ void *vptr;
+
+ pthread_mutex_lock(&POP3QueueMutex);
+ if (GetHash(POP3QueueRooms, LKEY(qrbuf->QRnumber), &vptr))
+ {
+ pthread_mutex_unlock(&POP3QueueMutex);
+ EVP3CQ_syslog(LOG_DEBUG,
+ "pop3client: [%ld] %s already in progress.",
+ qrbuf->QRnumber,
+ qrbuf->QRname);
return;
}
+ pthread_mutex_unlock(&POP3QueueMutex);
+
+ if (server_shutting_down) return;
+
+ pLine = OneRNCFG->NetConfigs[pop3client];
+
+ while (pLine != NULL)
+ {
+ pop3aggr *cptr;
+
+ cptr = (pop3aggr *) malloc(sizeof(pop3aggr));
+ memset(cptr, 0, sizeof(pop3aggr));
+ ///TODO do we need this? cptr->roomlist_parts=1;
+ cptr->RoomName = NewStrBufPlain(qrbuf->QRname, -1);
+ cptr->pop3user = NewStrBufDup(pLine->Value[1]);
+ cptr->pop3pass = NewStrBufDup(pLine->Value[2]);
+ cptr->Url = NewStrBuf();
+ cptr->Host = NewStrBufDup(pLine->Value[0]);
+
+ cptr->keep = atol(ChrPtr(pLine->Value[3]));
+ cptr->interval = atol(ChrPtr(pLine->Value[4]));
- while (fgets(buf, sizeof buf, fp) != NULL) {
- buf[strlen(buf)-1] = 0;
+ StrBufAppendBufPlain(cptr->Url, HKEY("pop3://"), 0);
+ StrBufUrlescUPAppend(cptr->Url, cptr->pop3user, NULL);
+ StrBufAppendBufPlain(cptr->Url, HKEY(":"), 0);
+ StrBufUrlescUPAppend(cptr->Url, cptr->pop3pass, NULL);
+ StrBufAppendBufPlain(cptr->Url, HKEY("@"), 0);
+ StrBufAppendBuf(cptr->Url, cptr->Host, 0);
+ StrBufAppendBufPlain(cptr->Url, HKEY("/"), 0);
+ StrBufUrlescAppend(cptr->Url, cptr->RoomName, NULL);
- extract_token(instr, buf, 0, '|', sizeof instr);
- if (!strcasecmp(instr, "pop3client")) {
- pptr = (struct pop3aggr *) malloc(sizeof(struct pop3aggr));
- if (pptr != NULL) {
- safestrncpy(pptr->roomname, qrbuf->QRname, sizeof pptr->roomname);
- extract_token(pptr->pop3host, buf, 1, '|', sizeof pptr->pop3host);
- extract_token(pptr->pop3user, buf, 2, '|', sizeof pptr->pop3user);
- extract_token(pptr->pop3pass, buf, 3, '|', sizeof pptr->pop3pass);
- pptr->next = palist;
- palist = pptr;
+ ParseURL(&cptr->IO.ConnectMe, cptr->Url, 110);
+
+
+#if 0
+/* todo: we need to reunite the url to be shure. */
+
+ pthread_mutex_lock(&POP3ueueMutex);
+ GetHash(POP3FetchUrls, SKEY(ptr->Url), &vptr);
+ use_this_cptr = (pop3aggr *)vptr;
+
+ if (use_this_rncptr != NULL)
+ {
+ /* mustn't attach to an active session */
+ if (use_this_cptr->RefCount > 0)
+ {
+ DeletePOP3Cfg(cptr);
+/// Count->count--;
}
- }
+ else
+ {
+ long *QRnumber;
+ StrBufAppendBufPlain(
+ use_this_cptr->rooms,
+ qrbuf->QRname,
+ -1, 0);
+ if (use_this_cptr->roomlist_parts == 1)
+ {
+ use_this_cptr->OtherQRnumbers
+ = NewHash(1, lFlathash);
+ }
+ QRnumber = (long*)malloc(sizeof(long));
+ *QRnumber = qrbuf->QRnumber;
+ Put(use_this_cptr->OtherQRnumbers,
+ LKEY(qrbuf->QRnumber),
+ QRnumber,
+ NULL);
- }
+ use_this_cptr->roomlist_parts++;
+ }
+ pthread_mutex_unlock(&POP3QueueMutex);
+ continue;
+ }
+ pthread_mutex_unlock(&RSSQueueMutex);
+#endif
+ cptr->n = Pop3ClientID++;
+ pthread_mutex_lock(&POP3QueueMutex);
+ Put(POP3FetchUrls,
+ SKEY(cptr->Url),
+ cptr,
+ DeletePOP3Aggregator);
- fclose(fp);
+ pthread_mutex_unlock(&POP3QueueMutex);
+ pLine = pLine->next;
+ }
}
+static int doing_pop3client = 0;
void pop3client_scan(void) {
static time_t last_run = 0L;
- static int doing_pop3client = 0;
- struct pop3aggr *pptr;
+ time_t fastest_scan;
+ HashPos *it;
+ long len;
+ const char *Key;
+ void *vrptr;
+ pop3aggr *cptr;
+
+ become_session(&pop3_client_CC);
+
+ if (CtdlGetConfigLong("c_pop3_fastest") < CtdlGetConfigLong("c_pop3_fetch"))
+ fastest_scan = CtdlGetConfigLong("c_pop3_fastest");
+ else
+ fastest_scan = CtdlGetConfigLong("c_pop3_fetch");
/*
* Run POP3 aggregation no more frequently than once every n seconds
*/
- if ( (time(NULL) - last_run) < config.c_net_freq ) {
+ if ( (time(NULL) - last_run) < fastest_scan ) {
return;
}
/*
- * This is a simple concurrency check to make sure only one pop3client run
- * is done at a time. We could do this with a mutex, but since we
+ * This is a simple concurrency check to make sure only one pop3client
+ * run is done at a time. We could do this with a mutex, but since we
* don't really require extremely fine granularity here, we'll do it
* with a static variable instead.
*/
if (doing_pop3client) return;
doing_pop3client = 1;
- lprintf(CTDL_DEBUG, "pop3client started\n");
- ForEachRoom(pop3client_scan_room, NULL);
+ EVP3CQM_syslog(LOG_DEBUG, "pop3client started");
+ CtdlForEachNetCfgRoom(pop3client_scan_room, NULL);
+
+ pthread_mutex_lock(&POP3QueueMutex);
+ it = GetNewHashPos(POP3FetchUrls, 0);
+ while (!server_shutting_down &&
+ GetNextHashPos(POP3FetchUrls, it, &len, &Key, &vrptr) &&
+ (vrptr != NULL)) {
+ cptr = (pop3aggr *)vrptr;
+ if (cptr->RefCount == 0)
+ if (!pop3_do_fetching(cptr))
+ DeletePOP3Aggregator(cptr);////TODO
- while (palist != NULL) {
- pop3_do_fetching(palist->roomname, palist->pop3host, palist->pop3user, palist->pop3pass);
+/*
+ if ((palist->interval && time(NULL) > (last_run + palist->interval))
+ || (time(NULL) > last_run + CtdlGetConfigLong("c_pop3_fetch")))
+ pop3_do_fetching(palist->roomname, palist->pop3host,
+ palist->pop3user, palist->pop3pass, palist->keep);
pptr = palist;
palist = palist->next;
free(pptr);
+*/
}
+ DeleteHashPos(&it);
+ pthread_mutex_unlock(&POP3QueueMutex);
- lprintf(CTDL_DEBUG, "pop3client ended\n");
+ EVP3CQM_syslog(LOG_DEBUG, "pop3client ended");
+ last_run = time(NULL);
doing_pop3client = 0;
}
-#endif
+
+void pop3_cleanup(void)
+{
+ /* citthread_mutex_destroy(&POP3QueueMutex); TODO */
+ while (doing_pop3client != 0) ;
+ DeleteHash(&POP3FetchUrls);
+ DeleteHash(&POP3QueueRooms);
+}
+
+
+
+void LogDebugEnablePOP3Client(const int n)
+{
+ POP3ClientDebugEnabled = n;
+}
CTDL_MODULE_INIT(pop3client)
{
-#ifdef POP3_AGGREGATION
- CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER);
-#endif
+ if (!threading)
+ {
+ CtdlFillSystemContext(&pop3_client_CC, "POP3aggr");
+ CtdlREGISTERRoomCfgType(pop3client, ParseGeneric, 0, 5, SerializeGeneric, DeleteGenericCfgLine);
+ pthread_mutex_init(&POP3QueueMutex, NULL);
+ POP3QueueRooms = NewHash(1, lFlathash);
+ POP3FetchUrls = NewHash(1, NULL);
+ CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER, PRIO_AGGR + 50);
+ CtdlRegisterEVCleanupHook(pop3_cleanup);
+ CtdlRegisterDebugFlagHook(HKEY("pop3client"), LogDebugEnablePOP3Client, &POP3ClientDebugEnabled);
+ }
- /* return our Subversion id for the Log */
- return "$Id: $";
+ /* return our module id for the log */
+ return "pop3client";
}