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;
86 CtdlLogPrintf(CTDL_DEBUG, "POP3: %s %s %s <password>\n", roomname, pop3host, pop3user);
87 CtdlLogPrintf(CTDL_NOTICE, "Connecting to <%s>\n", pop3host);
89 if (CtdlThreadCheckStop())
92 sock = sock_connect(pop3host, "110", "tcp");
94 CtdlLogPrintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
98 if (CtdlThreadCheckStop())
101 CtdlLogPrintf(CTDL_DEBUG, "Connected!\n");
103 /* Read the server greeting */
104 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
105 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
106 if (strncasecmp(buf, "+OK", 3)) goto bail;
108 if (CtdlThreadCheckStop())
111 /* Identify ourselves. NOTE: we have to append a CR to each command. The LF will
112 * automatically be appended by sock_puts(). Believe it or not, leaving out the CR
113 * will cause problems if the server happens to be Exchange, which is so b0rken it
114 * actually barfs on LF-terminated newlines.
116 snprintf(buf, sizeof buf, "USER %s\r", pop3user);
117 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
118 if (sock_puts(&sock, buf) <0) goto bail;
119 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
120 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
121 if (strncasecmp(buf, "+OK", 3)) goto bail;
123 if (CtdlThreadCheckStop())
127 snprintf(buf, sizeof buf, "PASS %s\r", pop3pass);
128 CtdlLogPrintf(CTDL_DEBUG, "<PASS <password>\n");
129 if (sock_puts(&sock, buf) <0) goto bail;
130 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
131 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
132 if (strncasecmp(buf, "+OK", 3)) goto bail;
134 if (CtdlThreadCheckStop())
137 /* Get the list of messages */
138 snprintf(buf, sizeof buf, "LIST\r");
139 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
140 if (sock_puts(&sock, buf) <0) goto bail;
141 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
142 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
143 if (strncasecmp(buf, "+OK", 3)) goto bail;
145 if (CtdlThreadCheckStop())
149 if (CtdlThreadCheckStop())
152 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
153 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
154 msg_to_fetch = atoi(buf);
155 if (msg_to_fetch > 0) {
156 if (alloc_msgs == 0) {
158 msglist = malloc((alloc_msgs * (sizeof(int))));
160 else if (num_msgs >= alloc_msgs) {
161 alloc_msgs = alloc_msgs * 2;
162 msglist = realloc(msglist, (alloc_msgs * sizeof(int)));
164 if (msglist == NULL) goto bail;
165 msglist[num_msgs++] = msg_to_fetch;
167 } while (buf[0] != '.');
169 if (num_msgs) for (i=0; i<num_msgs; ++i) {
171 /* Find out the UIDL of the message, to determine whether we've already downloaded it */
172 snprintf(buf, sizeof buf, "UIDL %d\r", msglist[i]);
173 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
174 if (sock_puts(&sock, buf) <0) goto bail;
175 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
176 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
177 if (strncasecmp(buf, "+OK", 3)) goto bail;
178 extract_token(this_uidl, buf, 2, ' ', sizeof this_uidl);
180 snprintf(utmsgid, sizeof utmsgid, "pop3/%s/%s@%s", roomname, this_uidl, pop3host);
182 if (CtdlThreadCheckStop())
185 cdbut = cdb_fetch(CDB_USETABLE, utmsgid, strlen(utmsgid));
187 /* message has already been seen */
188 CtdlLogPrintf(CTDL_DEBUG, "%s has already been seen\n", utmsgid);
191 /* rewrite the record anyway, to update the timestamp */
192 strcpy(ut.ut_msgid, utmsgid);
193 ut.ut_timestamp = time(NULL);
194 cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid), &ut, sizeof(struct UseTable) );
197 /* Message has not been seen. Tell the server to fetch the message... */
198 snprintf(buf, sizeof buf, "RETR %d\r", msglist[i]);
199 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
200 if (sock_puts(&sock, buf) <0) goto bail;
201 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
202 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
203 if (strncasecmp(buf, "+OK", 3)) goto bail;
205 if (CtdlThreadCheckStop())
208 /* If we get to this point, the message is on its way. Read it. */
209 body = CtdlReadMessageBody(HKEY("."), config.c_maxmsglen, NULL, 1, &sock);
210 if (body == NULL) goto bail;
212 CtdlLogPrintf(CTDL_DEBUG, "Converting message...\n");
213 msg = convert_internet_message(body);
214 body = NULL; /* yes, this should be dereferenced, NOT freed */
216 /* Do Something With It (tm) */
217 msgnum = CtdlSubmitMsg(msg, NULL, roomname, 0);
219 /* Message has been committed to the store */
222 snprintf(buf, sizeof buf, "DELE %d\r", msglist[i]);
223 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
224 if (sock_puts(&sock, buf) <0) goto bail;
225 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
226 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf); /* errors here are non-fatal */
229 /* write the uidl to the use table so we don't fetch this message again */
230 strcpy(ut.ut_msgid, utmsgid);
231 ut.ut_timestamp = time(NULL);
232 cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid),
233 &ut, sizeof(struct UseTable) );
235 CtdlFreeMessage(msg);
240 snprintf(buf, sizeof buf, "QUIT\r");
241 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
242 if (sock_puts(&sock, buf) <0) goto bail;
243 if (sock_getln(&sock, buf, sizeof buf) < 0) goto bail;
244 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
248 if (msglist) free(msglist);
253 * Scan a room's netconfig to determine whether it requires POP3 aggregation
255 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
257 char filename[PATH_MAX];
261 struct pop3aggr *pptr;
263 if (CtdlThreadCheckStop())
266 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
268 /* Only do net processing for rooms that have netconfigs */
269 fp = fopen(filename, "r");
274 while (fgets(buf, sizeof buf, fp) != NULL) {
275 buf[strlen(buf)-1] = 0;
277 extract_token(instr, buf, 0, '|', sizeof instr);
278 if (!strcasecmp(instr, "pop3client")) {
279 pptr = (struct pop3aggr *) malloc(sizeof(struct pop3aggr));
281 safestrncpy(pptr->roomname, qrbuf->QRname, sizeof pptr->roomname);
282 extract_token(pptr->pop3host, buf, 1, '|', sizeof pptr->pop3host);
283 extract_token(pptr->pop3user, buf, 2, '|', sizeof pptr->pop3user);
284 extract_token(pptr->pop3pass, buf, 3, '|', sizeof pptr->pop3pass);
285 pptr->keep = extract_int(buf, 4);
286 pptr->interval = extract_long(buf, 5);
299 void pop3client_scan(void) {
300 static time_t last_run = 0L;
301 static int doing_pop3client = 0;
302 struct pop3aggr *pptr;
305 if (config.c_pop3_fastest < config.c_pop3_fetch)
306 fastest_scan = config.c_pop3_fastest;
308 fastest_scan = config.c_pop3_fetch;
311 * Run POP3 aggregation no more frequently than once every n seconds
313 if ( (time(NULL) - last_run) < fastest_scan ) {
318 * This is a simple concurrency check to make sure only one pop3client run
319 * is done at a time. We could do this with a mutex, but since we
320 * don't really require extremely fine granularity here, we'll do it
321 * with a static variable instead.
323 if (doing_pop3client) return;
324 doing_pop3client = 1;
326 CtdlLogPrintf(CTDL_DEBUG, "pop3client started\n");
327 CtdlForEachRoom(pop3client_scan_room, NULL);
329 while (palist != NULL && !CtdlThreadCheckStop()) {
330 if ((palist->interval && time(NULL) > (last_run + palist->interval))
331 || (time(NULL) > last_run + config.c_pop3_fetch))
332 pop3_do_fetching(palist->roomname, palist->pop3host,
333 palist->pop3user, palist->pop3pass, palist->keep);
335 palist = palist->next;
339 CtdlLogPrintf(CTDL_DEBUG, "pop3client ended\n");
340 last_run = time(NULL);
341 doing_pop3client = 0;
345 CTDL_MODULE_INIT(pop3client)
349 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER);
352 /* return our Subversion id for the Log */