citadel/modules/pop3client/serv_pop3client.c

   1 /*
   2  * $Id$
   3  *
   4  * Consolidate mail from remote POP3 accounts.
   5  *
   6  * Copyright (c) 2007-2009 by the citadel.org team
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <stdio.h>
  26
  27 #if TIME_WITH_SYS_TIME
  28 # include <sys/time.h>
  29 # include <time.h>
  30 #else
  31 # if HAVE_SYS_TIME_H
  32 #  include <sys/time.h>
  33 # else
  34 #  include <time.h>
  35 # endif
  36 #endif
  37
  38 #include <ctype.h>
  39 #include <string.h>
  40 #include <errno.h>
  41 #include <sys/types.h>
  42 #include <sys/stat.h>
  43 #include <libcitadel.h>
  44 #include "citadel.h"
  45 #include "server.h"
  46 #include "citserver.h"
  47 #include "support.h"
  48 #include "config.h"
  49 #include "ctdl_module.h"
  50 #include "clientsocket.h"
  51 #include "msgbase.h"
  52 #include "internet_addressing.h"
  53 #include "database.h"
  54 #include "citadel_dirs.h"
  55
  56 struct pop3aggr {
  57         struct pop3aggr *next;
  58         char roomname[ROOMNAMELEN];
  59         char pop3host[128];
  60         char pop3user[128];
  61         char pop3pass[128];
  62         int keep;
  63         time_t interval;
  64 };
  65
  66 struct pop3aggr *palist = NULL;
  67
  68
  69 void pop3_do_fetching(char *roomname, char *pop3host, char *pop3user, char *pop3pass, int keep)
  70 {
  71         int sock;
  72         char buf[SIZ];
  73         int msg_to_fetch = 0;
  74         int *msglist = NULL;
  75         int num_msgs = 0;
  76         int alloc_msgs = 0;
  77         int i;
  78         char *body = NULL;
  79         struct CtdlMessage *msg = NULL;
  80         long msgnum = 0;
  81         char this_uidl[64];
  82         char utmsgid[SIZ];
  83         struct cdbdata *cdbut;
  84         struct UseTable ut;
  85
  86         CtdlLogPrintf(CTDL_DEBUG, "POP3: %s %s %s <password>\n", roomname, pop3host, pop3user);
  87         CtdlLogPrintf(CTDL_NOTICE, "Connecting to <%s>\n", pop3host);
  88
  89         if (CtdlThreadCheckStop())
  90                 return;
  91
  92         sock = sock_connect(pop3host, "110", "tcp");
  93         if (sock < 0) {
  94                 CtdlLogPrintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
  95                 return;
  96         }
  97
  98         if (CtdlThreadCheckStop())
  99                 goto bail;
 100
 101         CtdlLogPrintf(CTDL_DEBUG, "Connected!\n");
 102
 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;
 107
 108         if (CtdlThreadCheckStop())
 109                 goto bail;
 110
 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.
 115          */
 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;
 122
 123         if (CtdlThreadCheckStop())
 124                 goto bail;
 125
 126         /* Password */
 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;
 133
 134         if (CtdlThreadCheckStop())
 135                 goto bail;
 136
 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;
 144
 145         if (CtdlThreadCheckStop())
 146                 goto bail;
 147
 148         do {
 149                 if (CtdlThreadCheckStop())
 150                         goto bail;
 151
 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) {
 157                                 alloc_msgs = 100;
 158                                 msglist = malloc((alloc_msgs * (sizeof(int))));
 159                         }
 160                         else if (num_msgs >= alloc_msgs) {
 161                                 alloc_msgs = alloc_msgs * 2;
 162                                 msglist = realloc(msglist, (alloc_msgs * sizeof(int)));
 163                         }
 164                         if (msglist == NULL) goto bail;
 165                         msglist[num_msgs++] = msg_to_fetch;
 166                 }
 167         } while (buf[0] != '.');
 168
 169         if (num_msgs) for (i=0; i<num_msgs; ++i) {
 170
 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);
 179
 180                 snprintf(utmsgid, sizeof utmsgid, "pop3/%s/%s@%s", roomname, this_uidl, pop3host);
 181
 182                 if (CtdlThreadCheckStop())
 183                         goto bail;
 184
 185                 cdbut = cdb_fetch(CDB_USETABLE, utmsgid, strlen(utmsgid));
 186                 if (cdbut != NULL) {
 187                         /* message has already been seen */
 188                         CtdlLogPrintf(CTDL_DEBUG, "%s has already been seen\n", utmsgid);
 189                         cdb_free(cdbut);
 190
 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) );
 195                 }
 196                 else {
 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;
 204
 205                         if (CtdlThreadCheckStop())
 206                                 goto bail;
 207
 208                         /* If we get to this point, the message is on its way.  Read it. */
 209                         body = CtdlReadMessageBody(".", config.c_maxmsglen, NULL, 1, sock);
 210                         if (body == NULL) goto bail;
 211
 212                         CtdlLogPrintf(CTDL_DEBUG, "Converting message...\n");
 213                         msg = convert_internet_message(body);
 214                         body = NULL;    /* yes, this should be dereferenced, NOT freed */
 215
 216                         /* Do Something With It (tm) */
 217                         msgnum = CtdlSubmitMsg(msg, NULL, roomname, 0);
 218                         if (msgnum > 0L) {
 219                                 /* Message has been committed to the store */
 220
 221                                 if (!keep) {
 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 */
 227                                 }
 228
 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) );
 234                         }
 235                         CtdlFreeMessage(msg);
 236                 }
 237         }
 238
 239         /* Log out */
 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);
 245 bail:   sock_close(sock);
 246         if (msglist) free(msglist);
 247 }
 248
 249
 250 /*
 251  * Scan a room's netconfig to determine whether it requires POP3 aggregation
 252  */
 253 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
 254 {
 255         char filename[PATH_MAX];
 256         char buf[1024];
 257         char instr[32];
 258         FILE *fp;
 259         struct pop3aggr *pptr;
 260
 261         if (CtdlThreadCheckStop())
 262                 return;
 263
 264         assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
 265
 266         /* Only do net processing for rooms that have netconfigs */
 267         fp = fopen(filename, "r");
 268         if (fp == NULL) {
 269                 return;
 270         }
 271
 272         while (fgets(buf, sizeof buf, fp) != NULL) {
 273                 buf[strlen(buf)-1] = 0;
 274
 275                 extract_token(instr, buf, 0, '|', sizeof instr);
 276                 if (!strcasecmp(instr, "pop3client")) {
 277                         pptr = (struct pop3aggr *) malloc(sizeof(struct pop3aggr));
 278                         if (pptr != NULL) {
 279                                 safestrncpy(pptr->roomname, qrbuf->QRname, sizeof pptr->roomname);
 280                                 extract_token(pptr->pop3host, buf, 1, '|', sizeof pptr->pop3host);
 281                                 extract_token(pptr->pop3user, buf, 2, '|', sizeof pptr->pop3user);
 282                                 extract_token(pptr->pop3pass, buf, 3, '|', sizeof pptr->pop3pass);
 283                                 pptr->keep = extract_int(buf, 4);
 284                                 pptr->interval = extract_long(buf, 5);
 285                                 pptr->next = palist;
 286                                 palist = pptr;
 287                         }
 288                 }
 289
 290         }
 291
 292         fclose(fp);
 293
 294 }
 295
 296
 297 void pop3client_scan(void) {
 298         static time_t last_run = 0L;
 299         static int doing_pop3client = 0;
 300         struct pop3aggr *pptr;
 301         time_t fastest_scan;
 302
 303         if (config.c_pop3_fastest < config.c_pop3_fetch)
 304                 fastest_scan = config.c_pop3_fastest;
 305         else
 306                 fastest_scan = config.c_pop3_fetch;
 307
 308         /*
 309          * Run POP3 aggregation no more frequently than once every n seconds
 310          */
 311         if ( (time(NULL) - last_run) < fastest_scan ) {
 312                 return;
 313         }
 314
 315         /*
 316          * This is a simple concurrency check to make sure only one pop3client run
 317          * is done at a time.  We could do this with a mutex, but since we
 318          * don't really require extremely fine granularity here, we'll do it
 319          * with a static variable instead.
 320          */
 321         if (doing_pop3client) return;
 322         doing_pop3client = 1;
 323
 324         CtdlLogPrintf(CTDL_DEBUG, "pop3client started\n");
 325         CtdlForEachRoom(pop3client_scan_room, NULL);
 326
 327         while (palist != NULL && !CtdlThreadCheckStop()) {
 328                 if ((palist->interval && time(NULL) > (last_run + palist->interval))
 329                         || (time(NULL) > last_run + config.c_pop3_fetch))
 330                                 pop3_do_fetching(palist->roomname, palist->pop3host,
 331                                         palist->pop3user, palist->pop3pass, palist->keep);
 332                 pptr = palist;
 333                 palist = palist->next;
 334                 free(pptr);
 335         }
 336
 337         CtdlLogPrintf(CTDL_DEBUG, "pop3client ended\n");
 338         last_run = time(NULL);
 339         doing_pop3client = 0;
 340 }
 341
 342
 343 CTDL_MODULE_INIT(pop3client)
 344 {
 345         if (!threading)
 346         {
 347                 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER);
 348         }
 349
 350         /* return our Subversion id for the Log */
 351         return "$Id$";
 352 }