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 "room_ops.h"
  50 #include "ctdl_module.h"
  51 #include "clientsocket.h"
  52 #include "msgbase.h"
  53 #include "internet_addressing.h"
  54 #include "database.h"
  55 #include "citadel_dirs.h"
  56
  57 struct pop3aggr {
  58         struct pop3aggr *next;
  59         char roomname[ROOMNAMELEN];
  60         char pop3host[128];
  61         char pop3user[128];
  62         char pop3pass[128];
  63         int keep;
  64         time_t interval;
  65 };
  66
  67 struct pop3aggr *palist = NULL;
  68
  69
  70 void pop3_do_fetching(char *roomname, char *pop3host, char *pop3user, char *pop3pass, int keep)
  71 {
  72         int sock;
  73         char buf[SIZ];
  74         int msg_to_fetch = 0;
  75         int *msglist = NULL;
  76         int num_msgs = 0;
  77         int alloc_msgs = 0;
  78         int i;
  79         char *body = NULL;
  80         struct CtdlMessage *msg = NULL;
  81         long msgnum = 0;
  82         char this_uidl[64];
  83         char utmsgid[SIZ];
  84         struct cdbdata *cdbut;
  85         struct UseTable ut;
  86
  87         CtdlLogPrintf(CTDL_DEBUG, "POP3: %s %s %s <password>\n", roomname, pop3host, pop3user);
  88         CtdlLogPrintf(CTDL_NOTICE, "Connecting to <%s>\n", pop3host);
  89
  90         if (CtdlThreadCheckStop())
  91                 return;
  92
  93         sock = sock_connect(pop3host, "110", "tcp");
  94         if (sock < 0) {
  95                 CtdlLogPrintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
  96                 return;
  97         }
  98
  99         if (CtdlThreadCheckStop())
 100                 goto bail;
 101
 102         CtdlLogPrintf(CTDL_DEBUG, "Connected!\n");
 103
 104         /* Read the server greeting */
 105         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 106         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 107         if (strncasecmp(buf, "+OK", 3)) goto bail;
 108
 109         if (CtdlThreadCheckStop())
 110                 goto bail;
 111
 112         /* Identify ourselves.  NOTE: we have to append a CR to each command.  The LF will
 113          * automatically be appended by sock_puts().  Believe it or not, leaving out the CR
 114          * will cause problems if the server happens to be Exchange, which is so b0rken it
 115          * actually barfs on LF-terminated newlines.
 116          */
 117         snprintf(buf, sizeof buf, "USER %s\r", pop3user);
 118         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 119         if (sock_puts(sock, buf) <0) goto bail;
 120         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 121         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 122         if (strncasecmp(buf, "+OK", 3)) goto bail;
 123
 124         if (CtdlThreadCheckStop())
 125                 goto bail;
 126
 127         /* Password */
 128         snprintf(buf, sizeof buf, "PASS %s\r", pop3pass);
 129         CtdlLogPrintf(CTDL_DEBUG, "<PASS <password>\n");
 130         if (sock_puts(sock, buf) <0) goto bail;
 131         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 132         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 133         if (strncasecmp(buf, "+OK", 3)) goto bail;
 134
 135         if (CtdlThreadCheckStop())
 136                 goto bail;
 137
 138         /* Get the list of messages */
 139         snprintf(buf, sizeof buf, "LIST\r");
 140         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 141         if (sock_puts(sock, buf) <0) goto bail;
 142         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 143         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 144         if (strncasecmp(buf, "+OK", 3)) goto bail;
 145
 146         if (CtdlThreadCheckStop())
 147                 goto bail;
 148
 149         do {
 150                 if (CtdlThreadCheckStop())
 151                         goto bail;
 152
 153                 if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 154                 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 155                 msg_to_fetch = atoi(buf);
 156                 if (msg_to_fetch > 0) {
 157                         if (alloc_msgs == 0) {
 158                                 alloc_msgs = 100;
 159                                 msglist = malloc((alloc_msgs * (sizeof(int))));
 160                         }
 161                         else if (num_msgs >= alloc_msgs) {
 162                                 alloc_msgs = alloc_msgs * 2;
 163                                 msglist = realloc(msglist, (alloc_msgs * sizeof(int)));
 164                         }
 165                         if (msglist == NULL) goto bail;
 166                         msglist[num_msgs++] = msg_to_fetch;
 167                 }
 168         } while (buf[0] != '.');
 169
 170         if (num_msgs) for (i=0; i<num_msgs; ++i) {
 171
 172                 /* Find out the UIDL of the message, to determine whether we've already downloaded it */
 173                 snprintf(buf, sizeof buf, "UIDL %d\r", msglist[i]);
 174                 CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 175                 if (sock_puts(sock, buf) <0) goto bail;
 176                 if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 177                 CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 178                 if (strncasecmp(buf, "+OK", 3)) goto bail;
 179                 extract_token(this_uidl, buf, 2, ' ', sizeof this_uidl);
 180
 181                 snprintf(utmsgid, sizeof utmsgid, "pop3/%s/%s@%s", roomname, this_uidl, pop3host);
 182
 183                 if (CtdlThreadCheckStop())
 184                         goto bail;
 185
 186                 cdbut = cdb_fetch(CDB_USETABLE, utmsgid, strlen(utmsgid));
 187                 if (cdbut != NULL) {
 188                         /* message has already been seen */
 189                         CtdlLogPrintf(CTDL_DEBUG, "%s has already been seen\n", utmsgid);
 190                         cdb_free(cdbut);
 191
 192                         /* rewrite the record anyway, to update the timestamp */
 193                         strcpy(ut.ut_msgid, utmsgid);
 194                         ut.ut_timestamp = time(NULL);
 195                         cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid), &ut, sizeof(struct UseTable) );
 196                 }
 197                 else {
 198                         /* Message has not been seen. Tell the server to fetch the message... */
 199                         snprintf(buf, sizeof buf, "RETR %d\r", msglist[i]);
 200                         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 201                         if (sock_puts(sock, buf) <0) goto bail;
 202                         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 203                         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 204                         if (strncasecmp(buf, "+OK", 3)) goto bail;
 205
 206                         if (CtdlThreadCheckStop())
 207                                 goto bail;
 208
 209                         /* If we get to this point, the message is on its way.  Read it. */
 210                         body = CtdlReadMessageBody(".", config.c_maxmsglen, NULL, 1, sock);
 211                         if (body == NULL) goto bail;
 212
 213                         CtdlLogPrintf(CTDL_DEBUG, "Converting message...\n");
 214                         msg = convert_internet_message(body);
 215                         body = NULL;    /* yes, this should be dereferenced, NOT freed */
 216
 217                         /* Do Something With It (tm) */
 218                         msgnum = CtdlSubmitMsg(msg, NULL, roomname, 0);
 219                         if (msgnum > 0L) {
 220                                 /* Message has been committed to the store */
 221
 222                                 if (!keep) {
 223                                         snprintf(buf, sizeof buf, "DELE %d\r", msglist[i]);
 224                                         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 225                                         if (sock_puts(sock, buf) <0) goto bail;
 226                                         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 227                                         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf); /* errors here are non-fatal */
 228                                 }
 229
 230                                 /* write the uidl to the use table so we don't fetch this message again */
 231                                 strcpy(ut.ut_msgid, utmsgid);
 232                                 ut.ut_timestamp = time(NULL);
 233                                 cdb_store(CDB_USETABLE, utmsgid, strlen(utmsgid),
 234                                                 &ut, sizeof(struct UseTable) );
 235                         }
 236                         CtdlFreeMessage(msg);
 237                 }
 238         }
 239
 240         /* Log out */
 241         snprintf(buf, sizeof buf, "QUIT\r");
 242         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
 243         if (sock_puts(sock, buf) <0) goto bail;
 244         if (sock_getln(sock, buf, sizeof buf) < 0) goto bail;
 245         CtdlLogPrintf(CTDL_DEBUG, ">%s\n", buf);
 246 bail:   sock_close(sock);
 247         if (msglist) free(msglist);
 248 }
 249
 250
 251 /*
 252  * Scan a room's netconfig to determine whether it requires POP3 aggregation
 253  */
 254 void pop3client_scan_room(struct ctdlroom *qrbuf, void *data)
 255 {
 256         char filename[PATH_MAX];
 257         char buf[1024];
 258         char instr[32];
 259         FILE *fp;
 260         struct pop3aggr *pptr;
 261
 262         if (CtdlThreadCheckStop())
 263                 return;
 264
 265         assoc_file_name(filename, sizeof filename, qrbuf, ctdl_netcfg_dir);
 266
 267         /* Only do net processing for rooms that have netconfigs */
 268         fp = fopen(filename, "r");
 269         if (fp == NULL) {
 270                 return;
 271         }
 272
 273         while (fgets(buf, sizeof buf, fp) != NULL) {
 274                 buf[strlen(buf)-1] = 0;
 275
 276                 extract_token(instr, buf, 0, '|', sizeof instr);
 277                 if (!strcasecmp(instr, "pop3client")) {
 278                         pptr = (struct pop3aggr *) malloc(sizeof(struct pop3aggr));
 279                         if (pptr != NULL) {
 280                                 safestrncpy(pptr->roomname, qrbuf->QRname, sizeof pptr->roomname);
 281                                 extract_token(pptr->pop3host, buf, 1, '|', sizeof pptr->pop3host);
 282                                 extract_token(pptr->pop3user, buf, 2, '|', sizeof pptr->pop3user);
 283                                 extract_token(pptr->pop3pass, buf, 3, '|', sizeof pptr->pop3pass);
 284                                 pptr->keep = extract_int(buf, 4);
 285                                 pptr->interval = extract_long(buf, 5);
 286                                 pptr->next = palist;
 287                                 palist = pptr;
 288                         }
 289                 }
 290
 291         }
 292
 293         fclose(fp);
 294
 295 }
 296
 297
 298 void pop3client_scan(void) {
 299         static time_t last_run = 0L;
 300         static int doing_pop3client = 0;
 301         struct pop3aggr *pptr;
 302         time_t fastest_scan;
 303
 304         if (config.c_pop3_fastest < config.c_pop3_fetch)
 305                 fastest_scan = config.c_pop3_fastest;
 306         else
 307                 fastest_scan = config.c_pop3_fetch;
 308
 309         /*
 310          * Run POP3 aggregation no more frequently than once every n seconds
 311          */
 312         if ( (time(NULL) - last_run) < fastest_scan ) {
 313                 return;
 314         }
 315
 316         /*
 317          * This is a simple concurrency check to make sure only one pop3client run
 318          * is done at a time.  We could do this with a mutex, but since we
 319          * don't really require extremely fine granularity here, we'll do it
 320          * with a static variable instead.
 321          */
 322         if (doing_pop3client) return;
 323         doing_pop3client = 1;
 324
 325         CtdlLogPrintf(CTDL_DEBUG, "pop3client started\n");
 326         ForEachRoom(pop3client_scan_room, NULL);
 327
 328         while (palist != NULL && !CtdlThreadCheckStop()) {
 329                 if ((palist->interval && time(NULL) > (last_run + palist->interval))
 330                         || (time(NULL) > last_run + config.c_pop3_fetch))
 331                                 pop3_do_fetching(palist->roomname, palist->pop3host,
 332                                         palist->pop3user, palist->pop3pass, palist->keep);
 333                 pptr = palist;
 334                 palist = palist->next;
 335                 free(pptr);
 336         }
 337
 338         CtdlLogPrintf(CTDL_DEBUG, "pop3client ended\n");
 339         last_run = time(NULL);
 340         doing_pop3client = 0;
 341 }
 342
 343
 344 CTDL_MODULE_INIT(pop3client)
 345 {
 346         if (!threading)
 347         {
 348                 CtdlRegisterSessionHook(pop3client_scan, EVT_TIMER);
 349         }
 350
 351         /* return our Subversion id for the Log */
 352         return "$Id$";
 353 }