4 * Consolidate mail from remote POP3 accounts.
6 * Copyright (c) 2007-2009 by the citadel.org team
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #if TIME_WITH_SYS_TIME
28 # include <sys/time.h>
32 # include <sys/time.h>
41 #include <sys/types.h>
43 #include <libcitadel.h>
46 #include "citserver.h"
49 #include "ctdl_module.h"
50 #include "clientsocket.h"
52 #include "internet_addressing.h"
54 #include "citadel_dirs.h"
57 struct pop3aggr *next;
58 char roomname[ROOMNAMELEN];
66 struct pop3aggr *palist = NULL;
69 void pop3_do_fetching(char *roomname, char *pop3host, char *pop3user, char *pop3pass, int keep)
79 struct CtdlMessage *msg = NULL;
83 struct cdbdata *cdbut;
87 CtdlLogPrintf(CTDL_DEBUG, "POP3: %s %s %s <password>\n", roomname, pop3host, pop3user);
88 CtdlLogPrintf(CTDL_NOTICE, "Connecting to <%s>\n", pop3host);
90 if (CtdlThreadCheckStop())
93 sock = sock_connect(pop3host, "110", "tcp");
95 CtdlLogPrintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
99 if (CtdlThreadCheckStop())
102 CtdlLogPrintf(CTDL_DEBUG, "Connected!\n");
103 CCC->sReadBuf = NewStrBuf();
104 CCC->sMigrateBuf = NewStrBuf();
107 /* Read the server greeting */
108 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
109 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
110 if (strncasecmp(buf, "+OK", 3)) goto bail;
112 if (CtdlThreadCheckStop())
115 /* Identify ourselves. NOTE: we have to append a CR to each command. The LF will
116 * automatically be appended by sock_puts(). Believe it or not, leaving out the CR
117 * will cause problems if the server happens to be Exchange, which is so b0rken it
118 * actually barfs on LF-terminated newlines.
120 snprintf(buf, sizeof buf, "USER %s\r", pop3user);
121 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
122 if (sock_puts(&sock, buf) <0) goto bail;
123 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
124 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
125 if (strncasecmp(buf, "+OK", 3)) goto bail;
127 if (CtdlThreadCheckStop())
131 snprintf(buf, sizeof buf, "PASS %s\r", pop3pass);
132 CtdlLogPrintf(CTDL_DEBUG, "<PASS <password>\n");
133 if (sock_puts(&sock, buf) <0) goto bail;
134 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
135 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
136 if (strncasecmp(buf, "+OK", 3)) goto bail;
138 if (CtdlThreadCheckStop())
141 /* Get the list of messages */
142 snprintf(buf, sizeof buf, "LIST\r");
143 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
144 if (sock_puts(&sock, buf) <0) goto bail;
145 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
146 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
147 if (strncasecmp(buf, "+OK", 3)) goto bail;
149 if (CtdlThreadCheckStop())
153 if (CtdlThreadCheckStop())
156 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
157 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
158 msg_to_fetch = atoi(buf);
159 if (msg_to_fetch > 0) {
160 if (alloc_msgs == 0) {
162 msglist = malloc((alloc_msgs * (sizeof(int))));
164 else if (num_msgs >= alloc_msgs) {
165 alloc_msgs = alloc_msgs * 2;
166 msglist = realloc(msglist, (alloc_msgs * sizeof(int)));
168 if (msglist == NULL) goto bail;
169 msglist[num_msgs++] = msg_to_fetch;
171 } while (buf[0] != '.');
173 if (num_msgs) for (i=0; i<num_msgs; ++i) {
175 /* Find out the UIDL of the message, to determine whether we've already downloaded it */
176 snprintf(buf, sizeof buf, "UIDL %d\r", msglist[i]);
177 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
178 if (sock_puts(&sock, buf) <0) goto bail;
179 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
180 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
181 if (strncasecmp(buf, "+OK", 3)) goto bail;
182 extract_token(this_uidl, buf, 2, ' ', sizeof this_uidl);
184 snprintf(utmsgid, sizeof utmsgid, "pop3/%s/%s@%s", roomname, this_uidl, pop3host);
186 if (CtdlThreadCheckStop())
189 cdbut = cdb_fetch(CDB_USETABLE, utmsgid, strlen(utmsgid));
191 /* message has already been seen */
192 CtdlLogPrintf(CTDL_DEBUG, "%s has already been seen\n", utmsgid);
195 /* rewrite the record anyway, to update the timestamp */
196 strcpy(ut.ut_msgid, utmsgid);
197 ut.ut_timestamp = time(NULL);
198 cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid), &ut, sizeof(struct UseTable) );
201 /* Message has not been seen. Tell the server to fetch the message... */
202 snprintf(buf, sizeof buf, "RETR %d\r", msglist[i]);
203 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
204 if (sock_puts(&sock, buf) <0) goto bail;
205 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
206 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
207 if (strncasecmp(buf, "+OK", 3)) goto bail;
209 if (CtdlThreadCheckStop())
212 /* If we get to this point, the message is on its way. Read it. */
213 body = CtdlReadMessageBody(HKEY("."), config.c_maxmsglen, NULL, 1, &sock);
214 if (body == NULL) goto bail;
216 CtdlLogPrintf(CTDL_DEBUG, "Converting message...\n");
217 msg = convert_internet_message(body);
218 body = NULL; /* yes, this should be dereferenced, NOT freed */
220 /* Do Something With It (tm) */
221 msgnum = CtdlSubmitMsg(msg, NULL, roomname, 0);
223 /* Message has been committed to the store */
226 snprintf(buf, sizeof buf, "DELE %d\r", msglist[i]);
227 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
228 if (sock_puts(&sock, buf) <0) goto bail;
229 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
230 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf); /* errors here are non-fatal */
233 /* write the uidl to the use table so we don't fetch this message again */
234 strcpy(ut.ut_msgid, utmsgid);
235 ut.ut_timestamp = time(NULL);
236 cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid),
237 &ut, sizeof(struct UseTable) );
239 CtdlFreeMessage(msg);
244 snprintf(buf, sizeof buf, "QUIT\r");
245 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
246 if (sock_puts(&sock, buf) <0) goto bail;
247 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
248 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
250 FreeStrBuf(&CCC->sReadBuf);
251 FreeStrBuf(&CCC->sMigrateBuf);
255 if (msglist) free(msglist);
260 * Scan a room's netconfig to determine whether it requires POP3 aggregation
262 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
264 char filename[PATH_MAX];
268 struct pop3aggr *pptr;
270 if (CtdlThreadCheckStop())
273 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
275 /* Only do net processing for rooms that have netconfigs */
276 fp = fopen(filename, "r");
281 while (fgets(buf, sizeof buf, fp) != NULL) {
282 buf[strlen(buf)-1] = 0;
284 extract_token(instr, buf, 0, '|', sizeof instr);
285 if (!strcasecmp(instr, "pop3client")) {
286 pptr = (struct pop3aggr *) malloc(sizeof(struct pop3aggr));
288 safestrncpy(pptr->roomname, qrbuf->QRname, sizeof pptr->roomname);
289 extract_token(pptr->pop3host, buf, 1, '|', sizeof pptr->pop3host);
290 extract_token(pptr->pop3user, buf, 2, '|', sizeof pptr->pop3user);
291 extract_token(pptr->pop3pass, buf, 3, '|', sizeof pptr->pop3pass);
292 pptr->keep = extract_int(buf, 4);
293 pptr->interval = extract_long(buf, 5);
306 void pop3client_scan(void) {
307 static time_t last_run = 0L;
308 static int doing_pop3client = 0;
309 struct pop3aggr *pptr;
311 CitContext popclientCC;
313 /* Give this thread its own private CitContext */
314 CtdlFillSystemContext(&popclientCC, "popclient");
315 citthread_setspecific(MyConKey, (void *)&popclientCC );
317 if (config.c_pop3_fastest < config.c_pop3_fetch)
318 fastest_scan = config.c_pop3_fastest;
320 fastest_scan = config.c_pop3_fetch;
323 * Run POP3 aggregation no more frequently than once every n seconds
325 if ( (time(NULL) - last_run) < fastest_scan ) {
326 CtdlClearSystemContext();
331 * This is a simple concurrency check to make sure only one pop3client run
332 * is done at a time. We could do this with a mutex, but since we
333 * don't really require extremely fine granularity here, we'll do it
334 * with a static variable instead.
336 if (doing_pop3client) return;
337 doing_pop3client = 1;
339 CtdlLogPrintf(CTDL_DEBUG, "pop3client started\n");
340 CtdlForEachRoom(pop3client_scan_room, NULL);
342 while (palist != NULL && !CtdlThreadCheckStop()) {
343 if ((palist->interval && time(NULL) > (last_run + palist->interval))
344 || (time(NULL) > last_run + config.c_pop3_fetch))
345 pop3_do_fetching(palist->roomname, palist->pop3host,
346 palist->pop3user, palist->pop3pass, palist->keep);
348 palist = palist->next;
352 CtdlLogPrintf(CTDL_DEBUG, "pop3client ended\n");
353 last_run = time(NULL);
354 doing_pop3client = 0;
355 CtdlClearSystemContext();
359 CTDL_MODULE_INIT(pop3client)
363 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER);
366 /* return our Subversion id for the Log */