citadel/modules/smtp/serv_smtpqueue.c

   1 /*
   2  * This module is an SMTP and ESMTP implementation for the Citadel system.
   3  * It is compliant with all of the following:
   4  *
   5  * RFC  821 - Simple Mail Transfer Protocol
   6  * RFC  876 - Survey of SMTP Implementations
   7  * RFC 1047 - Duplicate messages and SMTP
   8  * RFC 1652 - 8 bit MIME
   9  * RFC 1869 - Extended Simple Mail Transfer Protocol
  10  * RFC 1870 - SMTP Service Extension for Message Size Declaration
  11  * RFC 2033 - Local Mail Transfer Protocol
  12  * RFC 2197 - SMTP Service Extension for Command Pipelining
  13  * RFC 2476 - Message Submission
  14  * RFC 2487 - SMTP Service Extension for Secure SMTP over TLS
  15  * RFC 2554 - SMTP Service Extension for Authentication
  16  * RFC 2821 - Simple Mail Transfer Protocol
  17  * RFC 2822 - Internet Message Format
  18  * RFC 2920 - SMTP Service Extension for Command Pipelining
  19  *
  20  * The VRFY and EXPN commands have been removed from this implementation
  21  * because nobody uses these commands anymore, except for spammers.
  22  *
  23  * Copyright (c) 1998-2012 by the citadel.org team
  24  *
  25  *  This program is open source software; you can redistribute it and/or modify
  26  *  it under the terms of the GNU General Public License version 3.
  27  *
  28  *
  29  *
  30  *  This program is distributed in the hope that it will be useful,
  31  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  *  GNU General Public License for more details.
  34  *
  35  *
  36  *
  37  *
  38  */
  39
  40 #include "sysdep.h"
  41 #include <stdlib.h>
  42 #include <unistd.h>
  43 #include <stdio.h>
  44 #include <termios.h>
  45 #include <fcntl.h>
  46 #include <signal.h>
  47 #include <pwd.h>
  48 #include <errno.h>
  49 #include <sys/types.h>
  50 #include <syslog.h>
  51
  52 #if TIME_WITH_SYS_TIME
  53 # include <sys/time.h>
  54 # include <time.h>
  55 #else
  56 # if HAVE_SYS_TIME_H
  57 #  include <sys/time.h>
  58 # else
  59 #  include <time.h>
  60 # endif
  61 #endif
  62 #include <sys/wait.h>
  63 #include <ctype.h>
  64 #include <string.h>
  65 #include <limits.h>
  66 #include <sys/socket.h>
  67 #include <netinet/in.h>
  68 #include <arpa/inet.h>
  69 #include <libcitadel.h>
  70 #include "citadel.h"
  71 #include "server.h"
  72 #include "citserver.h"
  73 #include "support.h"
  74 #include "config.h"
  75 #include "control.h"
  76 #include "user_ops.h"
  77 #include "database.h"
  78 #include "msgbase.h"
  79 #include "internet_addressing.h"
  80 #include "genstamp.h"
  81 #include "domain.h"
  82 #include "clientsocket.h"
  83 #include "locate_host.h"
  84 #include "citadel_dirs.h"
  85
  86 #include "ctdl_module.h"
  87
  88 #include "smtpqueue.h"
  89 #include "smtp_clienthandlers.h"
  90 #include "event_client.h"
  91
  92
  93 struct CitContext smtp_queue_CC;
  94 pthread_mutex_t ActiveQItemsLock;
  95 HashList *ActiveQItems  = NULL;
  96 HashList *QItemHandlers = NULL;
  97 const unsigned short DefaultMXPort = 25;
  98 int max_sessions_for_outbound_smtp = 500; /* how many sessions might be active till we stop adding more smtp jobs */
  99 int ndelay_count = 50; /* every n queued messages we will sleep... */
 100 int delay_msec = 5000; /* this many seconds. */
 101
 102 static const long MaxRetry = SMTP_RETRY_INTERVAL * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2;
 103 int MsgCount            = 0;
 104 int run_queue_now       = 0;    /* Set to 1 to ignore SMTP send retry times */
 105
 106 void RegisterQItemHandler(const char *Key, long Len, QItemHandler H)
 107 {
 108         QItemHandlerStruct *HS = (QItemHandlerStruct*)malloc(sizeof(QItemHandlerStruct));
 109         HS->H = H;
 110         Put(QItemHandlers, Key, Len, HS, NULL);
 111 }
 112
 113
 114
 115 void smtp_try_one_queue_entry(OneQueItem *MyQItem,
 116                               MailQEntry *MyQEntry,
 117                               StrBuf *MsgText,
 118 /* KeepMsgText allows us to use MsgText as ours. */
 119                               int KeepMsgText,
 120                               int MsgCount,
 121                               ParsedURL *RelayUrls);
 122
 123
 124 void smtp_evq_cleanup(void)
 125 {
 126
 127         pthread_mutex_lock(&ActiveQItemsLock);
 128         DeleteHash(&QItemHandlers);
 129         DeleteHash(&ActiveQItems);
 130         pthread_mutex_unlock(&ActiveQItemsLock);
 131         pthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
 132 /*      citthread_mutex_destroy(&ActiveQItemsLock); TODO */
 133 }
 134
 135 int DecreaseQReference(OneQueItem *MyQItem)
 136 {
 137         int IDestructQueItem;
 138
 139         pthread_mutex_lock(&ActiveQItemsLock);
 140         MyQItem->ActiveDeliveries--;
 141         IDestructQueItem = MyQItem->ActiveDeliveries == 0;
 142         pthread_mutex_unlock(&ActiveQItemsLock);
 143         return IDestructQueItem;
 144 }
 145
 146 void DecreaseShutdownDeliveries(OneQueItem *MyQItem)
 147 {
 148         pthread_mutex_lock(&ActiveQItemsLock);
 149         MyQItem->NotYetShutdownDeliveries--;
 150         pthread_mutex_unlock(&ActiveQItemsLock);
 151 }
 152
 153 int GetShutdownDeliveries(OneQueItem *MyQItem)
 154 {
 155         int DestructNow;
 156
 157         pthread_mutex_lock(&ActiveQItemsLock);
 158         DestructNow = MyQItem->ActiveDeliveries == 0;
 159         pthread_mutex_unlock(&ActiveQItemsLock);
 160         return DestructNow;
 161 }
 162 void RemoveQItem(OneQueItem *MyQItem)
 163 {
 164         long len;
 165         const char* Key;
 166         void *VData;
 167         HashPos  *It;
 168
 169         pthread_mutex_lock(&ActiveQItemsLock);
 170         It = GetNewHashPos(ActiveQItems, 0);
 171         if (GetHashPosFromKey(ActiveQItems, LKEY(MyQItem->MessageID), It))
 172                 DeleteEntryFromHash(ActiveQItems, It);
 173         else
 174         {
 175                 SMTPC_syslog(LOG_WARNING,
 176                              "unable to find QItem with ID[%ld]",
 177                              MyQItem->MessageID);
 178                 while (GetNextHashPos(ActiveQItems, It, &len, &Key, &VData))
 179                         SMTPC_syslog(LOG_WARNING,
 180                                      "have_: ID[%ld]",
 181                                      ((OneQueItem *)VData)->MessageID);
 182         }
 183         pthread_mutex_unlock(&ActiveQItemsLock);
 184         DeleteHashPos(&It);
 185 }
 186
 187
 188 void FreeMailQEntry(void *qv)
 189 {
 190         MailQEntry *Q = qv;
 191 /*
 192         SMTPC_syslog(LOG_DEBUG, "---------------%s--------------", __FUNCTION__);
 193         cit_backtrace();
 194 */
 195         FreeStrBuf(&Q->Recipient);
 196         FreeStrBuf(&Q->StatusMessage);
 197
 198         memset(Q, 0, sizeof(MailQEntry));
 199         free(Q);
 200 }
 201 void FreeQueItem(OneQueItem **Item)
 202 {
 203 /*
 204         SMTPC_syslog(LOG_DEBUG, "---------------%s--------------", __FUNCTION__);
 205         cit_backtrace();
 206 */
 207         DeleteHash(&(*Item)->MailQEntries);
 208         FreeStrBuf(&(*Item)->EnvelopeFrom);
 209         FreeStrBuf(&(*Item)->BounceTo);
 210         FreeStrBuf(&(*Item)->SenderRoom);
 211         FreeURL(&(*Item)->URL);
 212         memset(*Item, 0, sizeof(OneQueItem));
 213         free(*Item);
 214         Item = NULL;
 215 }
 216 void HFreeQueItem(void *Item)
 217 {
 218         FreeQueItem((OneQueItem**)&Item);
 219 }
 220
 221 /* inspect recipients with a status of:
 222  * - 0 (no delivery yet attempted)
 223  * - 3/4 (transient errors
 224  *        were experienced and it's time to try again)
 225  */
 226 int CheckQEntryActive(MailQEntry *ThisItem)
 227 {
 228         if ((ThisItem->Status == 0) ||
 229             (ThisItem->Status == 3) ||
 230             (ThisItem->Status == 4))
 231         {
 232                 return 1;
 233         }
 234         else
 235                 return 0;
 236 }
 237 int CheckQEntryIsBounce(MailQEntry *ThisItem)
 238 {
 239         if ((ThisItem->Status == 3) ||
 240             (ThisItem->Status == 4) ||
 241             (ThisItem->Status == 5))
 242         {
 243                 return 1;
 244         }
 245         else
 246                 return 0;
 247 }
 248
 249 int CountActiveQueueEntries(OneQueItem *MyQItem)
 250 {
 251         HashPos  *It;
 252         long len;
 253         long ActiveDeliveries;
 254         const char *Key;
 255         void *vQE;
 256
 257         ActiveDeliveries = 0;
 258         It = GetNewHashPos(MyQItem->MailQEntries, 0);
 259         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
 260         {
 261                 MailQEntry *ThisItem = vQE;
 262
 263                 if (CheckQEntryActive(ThisItem))
 264                 {
 265                         ActiveDeliveries++;
 266                         ThisItem->Active = 1;
 267                 }
 268                 else
 269                         ThisItem->Active = 0;
 270         }
 271         DeleteHashPos(&It);
 272         return ActiveDeliveries;
 273 }
 274
 275 OneQueItem *DeserializeQueueItem(StrBuf *RawQItem, long QueMsgID)
 276 {
 277         OneQueItem *Item;
 278         const char *pLine = NULL;
 279         StrBuf *Line;
 280         StrBuf *Token;
 281         void *v;
 282
 283         Item = (OneQueItem*)malloc(sizeof(OneQueItem));
 284         memset(Item, 0, sizeof(OneQueItem));
 285         Item->Retry = SMTP_RETRY_INTERVAL;
 286         Item->MessageID = -1;
 287         Item->QueMsgID = QueMsgID;
 288
 289         Token = NewStrBuf();
 290         Line = NewStrBufPlain(NULL, 128);
 291         while (pLine != StrBufNOTNULL) {
 292                 const char *pItemPart = NULL;
 293                 void *vHandler;
 294
 295                 StrBufExtract_NextToken(Line, RawQItem, &pLine, '\n');
 296                 if (StrLength(Line) == 0) continue;
 297                 StrBufExtract_NextToken(Token, Line, &pItemPart, '|');
 298                 if (GetHash(QItemHandlers, SKEY(Token), &vHandler))
 299                 {
 300                         QItemHandlerStruct *HS;
 301                         HS = (QItemHandlerStruct*) vHandler;
 302                         HS->H(Item, Line, &pItemPart);
 303                 }
 304         }
 305         FreeStrBuf(&Line);
 306         FreeStrBuf(&Token);
 307
 308         if (Item->Retry >= MaxRetry)
 309                 Item->FailNow = 1;
 310
 311         pthread_mutex_lock(&ActiveQItemsLock);
 312         if (GetHash(ActiveQItems,
 313                     LKEY(Item->MessageID),
 314                     &v))
 315         {
 316                 /* WHOOPS. somebody else is already working on this. */
 317                 pthread_mutex_unlock(&ActiveQItemsLock);
 318                 FreeQueItem(&Item);
 319                 return NULL;
 320         }
 321         else {
 322                 /* mark our claim on this. */
 323                 Put(ActiveQItems,
 324                     LKEY(Item->MessageID),
 325                     Item,
 326                     HFreeQueItem);
 327                 pthread_mutex_unlock(&ActiveQItemsLock);
 328         }
 329
 330         return Item;
 331 }
 332
 333 StrBuf *SerializeQueueItem(OneQueItem *MyQItem)
 334 {
 335         StrBuf *QMessage;
 336         HashPos  *It;
 337         const char *Key;
 338         long len;
 339         void *vQE;
 340
 341         QMessage = NewStrBufPlain(NULL, SIZ);
 342         StrBufPrintf(QMessage, "Content-type: %s\n", SPOOLMIME);
 343 //      "attempted|%ld\n"  "retry|%ld\n",, (long)time(NULL), (long)retry );
 344         StrBufAppendBufPlain(QMessage, HKEY("\nmsgid|"), 0);
 345         StrBufAppendPrintf(QMessage, "%ld", MyQItem->MessageID);
 346
 347         StrBufAppendBufPlain(QMessage, HKEY("\nsubmitted|"), 0);
 348         StrBufAppendPrintf(QMessage, "%ld", MyQItem->Submitted);
 349
 350         if (StrLength(MyQItem->BounceTo) > 0) {
 351                 StrBufAppendBufPlain(QMessage, HKEY("\nbounceto|"), 0);
 352                 StrBufAppendBuf(QMessage, MyQItem->BounceTo, 0);
 353         }
 354
 355         if (StrLength(MyQItem->EnvelopeFrom) > 0) {
 356                 StrBufAppendBufPlain(QMessage, HKEY("\nenvelope_from|"), 0);
 357                 StrBufAppendBuf(QMessage, MyQItem->EnvelopeFrom, 0);
 358         }
 359
 360         if (StrLength(MyQItem->SenderRoom) > 0) {
 361                 StrBufAppendBufPlain(QMessage, HKEY("\nsource_room|"), 0);
 362                 StrBufAppendBuf(QMessage, MyQItem->SenderRoom, 0);
 363         }
 364
 365         StrBufAppendBufPlain(QMessage, HKEY("\nretry|"), 0);
 366         StrBufAppendPrintf(QMessage, "%ld",
 367                            MyQItem->Retry);
 368
 369         StrBufAppendBufPlain(QMessage, HKEY("\nattempted|"), 0);
 370         StrBufAppendPrintf(QMessage, "%ld",
 371                            time(NULL) /*ctdl_ev_now()*/ + MyQItem->Retry);
 372
 373         It = GetNewHashPos(MyQItem->MailQEntries, 0);
 374         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
 375         {
 376                 MailQEntry *ThisItem = vQE;
 377
 378                 StrBufAppendBufPlain(QMessage, HKEY("\nremote|"), 0);
 379                 StrBufAppendBuf(QMessage, ThisItem->Recipient, 0);
 380                 StrBufAppendBufPlain(QMessage, HKEY("|"), 0);
 381                 StrBufAppendPrintf(QMessage, "%d", ThisItem->Status);
 382                 StrBufAppendBufPlain(QMessage, HKEY("|"), 0);
 383                 StrBufAppendBuf(QMessage, ThisItem->StatusMessage, 0);
 384         }
 385         DeleteHashPos(&It);
 386         StrBufAppendBufPlain(QMessage, HKEY("\n"), 0);
 387         return QMessage;
 388 }
 389
 390
 391
 392
 393
 394 void NewMailQEntry(OneQueItem *Item)
 395 {
 396         Item->Current = (MailQEntry*) malloc(sizeof(MailQEntry));
 397         memset(Item->Current, 0, sizeof(MailQEntry));
 398
 399         if (Item->MailQEntries == NULL)
 400                 Item->MailQEntries = NewHash(1, Flathash);
 401         /* alocate big buffer so we won't get problems reallocating later. */
 402         Item->Current->StatusMessage = NewStrBufPlain(NULL, SIZ);
 403         Item->Current->n = GetCount(Item->MailQEntries);
 404         Put(Item->MailQEntries,
 405             IKEY(Item->Current->n),
 406             Item->Current,
 407             FreeMailQEntry);
 408 }
 409
 410 void QItem_Handle_MsgID(OneQueItem *Item, StrBuf *Line, const char **Pos)
 411 {
 412         Item->MessageID = StrBufExtractNext_long(Line, Pos, '|');
 413 }
 414
 415 void QItem_Handle_EnvelopeFrom(OneQueItem *Item, StrBuf *Line, const char **Pos)
 416 {
 417         if (Item->EnvelopeFrom == NULL)
 418                 Item->EnvelopeFrom = NewStrBufPlain(NULL, StrLength(Line));
 419         StrBufExtract_NextToken(Item->EnvelopeFrom, Line, Pos, '|');
 420 }
 421
 422 void QItem_Handle_BounceTo(OneQueItem *Item, StrBuf *Line, const char **Pos)
 423 {
 424         if (Item->BounceTo == NULL)
 425                 Item->BounceTo = NewStrBufPlain(NULL, StrLength(Line));
 426         StrBufExtract_NextToken(Item->BounceTo, Line, Pos, '|');
 427 }
 428
 429 void QItem_Handle_SenderRoom(OneQueItem *Item, StrBuf *Line, const char **Pos)
 430 {
 431         if (Item->SenderRoom == NULL)
 432                 Item->SenderRoom = NewStrBufPlain(NULL, StrLength(Line));
 433         StrBufExtract_NextToken(Item->SenderRoom, Line, Pos, '|');
 434 }
 435
 436 void QItem_Handle_Recipient(OneQueItem *Item, StrBuf *Line, const char **Pos)
 437 {
 438         if (Item->Current == NULL)
 439                 NewMailQEntry(Item);
 440         if (Item->Current->Recipient == NULL)
 441                 Item->Current->Recipient=NewStrBufPlain(NULL, StrLength(Line));
 442         StrBufExtract_NextToken(Item->Current->Recipient, Line, Pos, '|');
 443         Item->Current->Status = StrBufExtractNext_int(Line, Pos, '|');
 444         StrBufExtract_NextToken(Item->Current->StatusMessage, Line, Pos, '|');
 445         Item->Current = NULL; // TODO: is this always right?
 446 }
 447
 448
 449 void QItem_Handle_retry(OneQueItem *Item, StrBuf *Line, const char **Pos)
 450 {
 451         Item->Retry =
 452                 StrBufExtractNext_int(Line, Pos, '|');
 453         if (Item->Retry == 0)
 454                 Item->Retry = SMTP_RETRY_INTERVAL;
 455         else
 456                 Item->Retry *= 2;
 457 }
 458
 459
 460 void QItem_Handle_Submitted(OneQueItem *Item, StrBuf *Line, const char **Pos)
 461 {
 462         Item->Submitted = atol(*Pos);
 463
 464 }
 465
 466 void QItem_Handle_Attempted(OneQueItem *Item, StrBuf *Line, const char **Pos)
 467 {
 468         Item->ReattemptWhen = StrBufExtractNext_int(Line, Pos, '|');
 469 }
 470
 471
 472
 473 /**
 474  * this one has to have the context for loading the message via the redirect buffer...
 475  */
 476 StrBuf *smtp_load_msg(OneQueItem *MyQItem, int n)
 477 {
 478         CitContext *CCC=CC;
 479         StrBuf *SendMsg;
 480
 481         CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 482         CtdlOutputMsg(MyQItem->MessageID,
 483                       MT_RFC822, HEADERS_ALL,
 484                       0, 1, NULL,
 485                       (ESC_DOT|SUPPRESS_ENV_TO) );
 486
 487         SendMsg = CCC->redirect_buffer;
 488         CCC->redirect_buffer = NULL;
 489         if ((StrLength(SendMsg) > 0) &&
 490             ChrPtr(SendMsg)[StrLength(SendMsg) - 1] != '\n') {
 491                 SMTPC_syslog(LOG_WARNING,
 492                              "[%d] Possible problem: message did not "
 493                              "correctly terminate. (expecting 0x10, got 0x%02x)\n",
 494                              MsgCount, //yes uncool, but best choice here...
 495                              ChrPtr(SendMsg)[StrLength(SendMsg) - 1] );
 496                 StrBufAppendBufPlain(SendMsg, HKEY("\r\n"), 0);
 497         }
 498         return SendMsg;
 499 }
 500
 501
 502
 503 /*
 504  * smtp_do_bounce() is caled by smtp_do_procmsg() to scan a set of delivery
 505  * instructions for "5" codes (permanent fatal errors) and produce/deliver
 506  * a "bounce" message (delivery status notification).
 507  */
 508 void smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt)
 509 {
 510         static int seq = 0;
 511
 512         struct CtdlMessage *bmsg = NULL;
 513         StrBuf *boundary;
 514         StrBuf *Msg = NULL;
 515         StrBuf *BounceMB;
 516         struct recptypes *valid;
 517         time_t now;
 518
 519         HashPos *It;
 520         void *vQE;
 521         long len;
 522         const char *Key;
 523
 524         int first_attempt = 0;
 525         int successful_bounce = 0;
 526         int num_bounces = 0;
 527         int give_up = 0;
 528
 529         SMTPCM_syslog(LOG_DEBUG, "smtp_do_bounce() called\n");
 530
 531         if (MyQItem->SendBounceMail == 0)
 532                 return;
 533
 534         now = time (NULL); //ev_time();
 535
 536         if ( (now - MyQItem->Submitted) > SMTP_GIVE_UP ) {
 537                 give_up = 1;
 538         }
 539
 540         if (MyQItem->Retry == SMTP_RETRY_INTERVAL) {
 541                 first_attempt = 1;
 542         }
 543
 544         /*
 545          * Now go through the instructions checking for stuff.
 546          */
 547         Msg = NewStrBufPlain(NULL, 1024);
 548         It = GetNewHashPos(MyQItem->MailQEntries, 0);
 549         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
 550         {
 551                 MailQEntry *ThisItem = vQE;
 552                 if ((ThisItem->Active && (ThisItem->Status == 5)) || /* failed now? */
 553                     ((give_up == 1) && (ThisItem->Status != 2)) ||
 554                     ((first_attempt == 1) && (ThisItem->Status != 2)))
 555                         /* giving up after failed attempts... */
 556                 {
 557                         ++num_bounces;
 558
 559                         StrBufAppendBuf(Msg, ThisItem->Recipient, 0);
 560                         StrBufAppendBufPlain(Msg, HKEY(": "), 0);
 561                         StrBufAppendBuf(Msg, ThisItem->StatusMessage, 0);
 562                         StrBufAppendBufPlain(Msg, HKEY("\r\n"), 0);
 563                 }
 564         }
 565         DeleteHashPos(&It);
 566
 567         /* Deliver the bounce if there's anything worth mentioning */
 568         SMTPC_syslog(LOG_DEBUG, "num_bounces = %d\n", num_bounces);
 569
 570         if (num_bounces == 0) {
 571                 FreeStrBuf(&Msg);
 572                 return;
 573         }
 574
 575         boundary = NewStrBufPlain(HKEY("=_Citadel_Multipart_"));
 576         StrBufAppendPrintf(boundary,
 577                            "%s_%04x%04x",
 578                            config.c_fqdn,
 579                            getpid(),
 580                            ++seq);
 581
 582         /* Start building our bounce message; go shopping for memory first. */
 583         BounceMB = NewStrBufPlain(
 584                 NULL,
 585                 1024 + /* mime stuff.... */
 586                 StrLength(Msg) +  /* the bounce information... */
 587                 StrLength(OMsgTxt)); /* the original message */
 588         if (BounceMB == NULL) {
 589                 FreeStrBuf(&boundary);
 590                 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
 591
 592                 return;
 593         }
 594
 595         bmsg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
 596         if (bmsg == NULL) {
 597                 FreeStrBuf(&boundary);
 598                 FreeStrBuf(&BounceMB);
 599                 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
 600
 601                 return;
 602         }
 603         memset(bmsg, 0, sizeof(struct CtdlMessage));
 604
 605
 606         StrBufAppendBufPlain(BounceMB, HKEY("Content-type: multipart/mixed; boundary=\""), 0);
 607         StrBufAppendBuf(BounceMB, boundary, 0);
 608         StrBufAppendBufPlain(BounceMB, HKEY("\"\r\n"), 0);
 609         StrBufAppendBufPlain(BounceMB, HKEY("MIME-Version: 1.0\r\n"), 0);
 610         StrBufAppendBufPlain(BounceMB, HKEY("X-Mailer: " CITADEL "\r\n"), 0);
 611         StrBufAppendBufPlain(BounceMB, HKEY("\r\nThis is a multipart message in MIME format.\r\n\r\n"), 0);
 612         StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
 613         StrBufAppendBuf(BounceMB, boundary, 0);
 614         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
 615         StrBufAppendBufPlain(BounceMB, HKEY("Content-type: text/plain\r\n\r\n"), 0);
 616
 617         if (give_up)
 618                 StrBufAppendBufPlain(
 619                         BounceMB,
 620                         HKEY(
 621                                 "A message you sent could not be delivered "
 622                                 "to some or all of its recipients\n"
 623                                 "due to prolonged unavailability "
 624                                 "of its destination(s).\n"
 625                                 "Giving up on the following addresses:\n\n"
 626                                 ), 0);
 627         else
 628                 StrBufAppendBufPlain(
 629                         BounceMB,
 630                         HKEY(
 631                                 "A message you sent could not be delivered "
 632                                 "to some or all of its recipients.\n"
 633                                 "The following addresses "
 634                                 "were undeliverable:\n\n"
 635                                 ), 0);
 636
 637         StrBufAppendBuf(BounceMB, Msg, 0);
 638         FreeStrBuf(&Msg);
 639
 640         if (StrLength(MyQItem->SenderRoom) > 0)
 641         {
 642                 StrBufAppendBufPlain(
 643                         BounceMB,
 644                         HKEY("The message was originaly posted in: "), 0);
 645                 StrBufAppendBuf(BounceMB, MyQItem->SenderRoom, 0);
 646                 StrBufAppendBufPlain(
 647                         BounceMB,
 648                         HKEY("\n"), 0);
 649         }
 650
 651         /* Attach the original message */
 652         StrBufAppendBufPlain(BounceMB, HKEY("\r\n--"), 0);
 653         StrBufAppendBuf(BounceMB, boundary, 0);
 654         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
 655         StrBufAppendBufPlain(BounceMB,
 656                              HKEY("Content-type: message/rfc822\r\n"), 0);
 657         StrBufAppendBufPlain(BounceMB,
 658                              HKEY("Content-Transfer-Encoding: 7bit\r\n"), 0);
 659         StrBufAppendBufPlain(BounceMB,
 660                              HKEY("Content-Disposition: inline\r\n"), 0);
 661         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
 662         StrBufAppendBuf(BounceMB, OMsgTxt, 0);
 663
 664         /* Close the multipart MIME scope */
 665         StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
 666         StrBufAppendBuf(BounceMB, boundary, 0);
 667         StrBufAppendBufPlain(BounceMB, HKEY("--\r\n"), 0);
 668
 669         bmsg->cm_magic = CTDLMESSAGE_MAGIC;
 670         bmsg->cm_anon_type = MES_NORMAL;
 671         bmsg->cm_format_type = FMT_RFC822;
 672
 673         bmsg->cm_fields['O'] = strdup(MAILROOM);
 674         bmsg->cm_fields['A'] = strdup("Citadel");
 675         bmsg->cm_fields['N'] = strdup(config.c_nodename);
 676         bmsg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
 677         bmsg->cm_fields['M'] = SmashStrBuf(&BounceMB);
 678
 679         /* First try the user who sent the message */
 680         if (StrLength(MyQItem->BounceTo) == 0) {
 681                 SMTPCM_syslog(LOG_ERR, "No bounce address specified\n");
 682         }
 683         else {
 684                 SMTPC_syslog(LOG_DEBUG, "bounce to user? <%s>\n",
 685                        ChrPtr(MyQItem->BounceTo));
 686         }
 687
 688         /* Can we deliver the bounce to the original sender? */
 689         valid = validate_recipients(ChrPtr(MyQItem->BounceTo), NULL, 0);
 690         if ((valid != NULL) && (valid->num_error == 0)) {
 691                 CtdlSubmitMsg(bmsg, valid, "", QP_EADDR);
 692                 successful_bounce = 1;
 693         }
 694
 695         /* If not, post it in the Aide> room */
 696         if (successful_bounce == 0) {
 697                 CtdlSubmitMsg(bmsg, NULL, config.c_aideroom, QP_EADDR);
 698         }
 699
 700         /* Free up the memory we used */
 701         free_recipients(valid);
 702         FreeStrBuf(&boundary);
 703         CtdlFreeMessage(bmsg);
 704         SMTPCM_syslog(LOG_DEBUG, "Done processing bounces\n");
 705 }
 706
 707 /*
 708  * smtp_do_procmsg()
 709  *
 710  * Called by smtp_do_queue() to handle an individual message.
 711  */
 712 void smtp_do_procmsg(long msgnum, void *userdata) {
 713         time_t now;
 714         int mynumsessions = num_sessions;
 715         struct CtdlMessage *msg = NULL;
 716         char *instr = NULL;
 717         StrBuf *PlainQItem;
 718         OneQueItem *MyQItem;
 719         char *pch;
 720         HashPos  *It;
 721         void *vQE;
 722         long len;
 723         const char *Key;
 724         int nRelays = 0;
 725         ParsedURL *RelayUrls = NULL;
 726         int HaveBuffers = 0;
 727         StrBuf *Msg =NULL;
 728
 729         if (mynumsessions > max_sessions_for_outbound_smtp) {
 730                 SMTPC_syslog(LOG_DEBUG,
 731                              "skipping because of num jobs %d > %d max_sessions_for_outbound_smtp",
 732                              mynumsessions,
 733                              max_sessions_for_outbound_smtp);
 734         }
 735
 736         SMTPC_syslog(LOG_DEBUG, "smtp_do_procmsg(%ld)\n", msgnum);
 737         ///strcpy(envelope_from, "");
 738
 739         msg = CtdlFetchMessage(msgnum, 1);
 740         if (msg == NULL) {
 741                 SMTPC_syslog(LOG_ERR, "tried %ld but no such message!\n",
 742                        msgnum);
 743                 return;
 744         }
 745
 746         pch = instr = msg->cm_fields['M'];
 747
 748         /* Strip out the headers (no not amd any other non-instruction) line */
 749         while (pch != NULL) {
 750                 pch = strchr(pch, '\n');
 751                 if ((pch != NULL) && (*(pch + 1) == '\n')) {
 752                         instr = pch + 2;
 753                         pch = NULL;
 754                 }
 755         }
 756         PlainQItem = NewStrBufPlain(instr, -1);
 757         CtdlFreeMessage(msg);
 758         MyQItem = DeserializeQueueItem(PlainQItem, msgnum);
 759         FreeStrBuf(&PlainQItem);
 760
 761         if (MyQItem == NULL) {
 762                 SMTPC_syslog(LOG_ERR,
 763                              "Msg No %ld: already in progress!\n",
 764                              msgnum);
 765                 return; /* s.b. else is already processing... */
 766         }
 767
 768         /*
 769          * Postpone delivery if we've already tried recently.
 770          */
 771         now = time(NULL);
 772         if ((MyQItem->ReattemptWhen != 0) &&
 773             (now < MyQItem->ReattemptWhen) &&
 774             (run_queue_now == 0))
 775         {
 776                 SMTPC_syslog(LOG_DEBUG,
 777                              "Retry time not yet reached. %ld seconds left.",
 778                              MyQItem->ReattemptWhen - now);
 779
 780                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
 781                 pthread_mutex_lock(&ActiveQItemsLock);
 782                 {
 783                         if (GetHashPosFromKey(ActiveQItems,
 784                                               LKEY(MyQItem->MessageID),
 785                                               It))
 786                         {
 787                                 DeleteEntryFromHash(ActiveQItems, It);
 788                         }
 789                 }
 790                 pthread_mutex_unlock(&ActiveQItemsLock);
 791                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
 792                 DeleteHashPos(&It);
 793                 return;
 794         }
 795
 796         /*
 797          * Bail out if there's no actual message associated with this
 798          */
 799         if (MyQItem->MessageID < 0L) {
 800                 SMTPCM_syslog(LOG_ERR, "no 'msgid' directive found!\n");
 801                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
 802                 pthread_mutex_lock(&ActiveQItemsLock);
 803                 {
 804                         if (GetHashPosFromKey(ActiveQItems,
 805                                               LKEY(MyQItem->MessageID),
 806                                               It))
 807                         {
 808                                 DeleteEntryFromHash(ActiveQItems, It);
 809                         }
 810                 }
 811                 pthread_mutex_unlock(&ActiveQItemsLock);
 812                 DeleteHashPos(&It);
 813                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
 814                 return;
 815         }
 816
 817         {
 818                 char mxbuf[SIZ];
 819                 ParsedURL **Url = &MyQItem->URL;
 820                 nRelays = get_hosts(mxbuf, "fallbackhost");
 821                 if (nRelays > 0) {
 822                         StrBuf *All;
 823                         StrBuf *One;
 824                         const char *Pos = NULL;
 825                         All = NewStrBufPlain(mxbuf, -1);
 826                         One = NewStrBufPlain(NULL, StrLength(All) + 1);
 827
 828                         while ((Pos != StrBufNOTNULL) &&
 829                                ((Pos == NULL) ||
 830                                 !IsEmptyStr(Pos)))
 831                         {
 832                                 StrBufExtract_NextToken(One, All, &Pos, '|');
 833                                 if (!ParseURL(Url, One, DefaultMXPort)) {
 834                                         SMTPC_syslog(LOG_DEBUG,
 835                                                      "Failed to parse: %s\n",
 836                                                      ChrPtr(One));
 837                                 }
 838                                 else {
 839                                         (*Url)->IsRelay = 1;
 840                                         MyQItem->HaveRelay = 1;
 841                                 }
 842                         }
 843                         FreeStrBuf(&All);
 844                         FreeStrBuf(&One);
 845                 }
 846                 nRelays = get_hosts(mxbuf, "smarthost");
 847                 if (nRelays > 0) {
 848                         StrBuf *All;
 849                         StrBuf *One;
 850                         const char *Pos = NULL;
 851                         All = NewStrBufPlain(mxbuf, -1);
 852                         One = NewStrBufPlain(NULL, StrLength(All) + 1);
 853
 854                         while ((Pos != StrBufNOTNULL) &&
 855                                ((Pos == NULL) ||
 856                                 !IsEmptyStr(Pos)))
 857                         {
 858                                 StrBufExtract_NextToken(One, All, &Pos, '|');
 859                                 if (!ParseURL(Url, One, DefaultMXPort)) {
 860                                         SMTPC_syslog(LOG_DEBUG,
 861                                                      "Failed to parse: %s\n",
 862                                                      ChrPtr(One));
 863                                 }
 864                                 else {
 865                                         ///if (!Url->IsIP)) // todo dupe me fork ipv6
 866                                         (*Url)->IsRelay = 1;
 867                                         MyQItem->HaveRelay = 1;
 868                                 }
 869                         }
 870                         FreeStrBuf(&All);
 871                         FreeStrBuf(&One);
 872                 }
 873
 874         }
 875
 876         It = GetNewHashPos(MyQItem->MailQEntries, 0);
 877         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
 878         {
 879                 MailQEntry *ThisItem = vQE;
 880                 SMTPC_syslog(LOG_DEBUG, "SMTP Queue: Task: <%s> %d\n",
 881                              ChrPtr(ThisItem->Recipient),
 882                              ThisItem->Active);
 883         }
 884         DeleteHashPos(&It);
 885
 886         MyQItem->NotYetShutdownDeliveries =
 887         MyQItem->ActiveDeliveries = CountActiveQueueEntries(MyQItem);
 888
 889         /* failsafe against overload:
 890          * will we exceed the limit set?
 891          */
 892         if ((MyQItem->ActiveDeliveries + mynumsessions > max_sessions_for_outbound_smtp) &&
 893             /* if yes, did we reach more than half of the quota? */
 894             ((mynumsessions * 2) > max_sessions_for_outbound_smtp) &&
 895             /* if... would we ever fit into half of the quota?? */
 896             (((MyQItem->ActiveDeliveries * 2)  < max_sessions_for_outbound_smtp)))
 897         {
 898                 /* abort delivery for another time. */
 899                 SMTPC_syslog(LOG_DEBUG,
 900                              "SMTP Queue: skipping because of num jobs %d + %ld > %d max_sessions_for_outbound_smtp",
 901                              mynumsessions,
 902                              MyQItem->ActiveDeliveries,
 903                              max_sessions_for_outbound_smtp);
 904
 905                 FreeQueItem(&MyQItem);
 906
 907                 return;
 908         }
 909
 910
 911         if (MyQItem->ActiveDeliveries > 0)
 912         {
 913                 int nActivated = 0;
 914                 int n = MsgCount++;
 915                 int m = MyQItem->ActiveDeliveries;
 916                 int i = 1;
 917                 Msg = smtp_load_msg(MyQItem, n);
 918                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
 919                 while ((i <= m) &&
 920                        (GetNextHashPos(MyQItem->MailQEntries,
 921                                        It, &len, &Key, &vQE)))
 922                 {
 923                         MailQEntry *ThisItem = vQE;
 924
 925                         if (ThisItem->Active == 1)
 926                         {
 927                                 int KeepBuffers = (i == m);
 928
 929                                 nActivated++;
 930                                 if (nActivated % ndelay_count == 0)
 931                                         usleep(delay_msec);
 932
 933                                 if (i > 1) n = MsgCount++;
 934                                 syslog(LOG_DEBUG,
 935                                        "SMTPC: Trying <%ld> <%s> %d / %d \n",
 936                                        MyQItem->MessageID,
 937                                        ChrPtr(ThisItem->Recipient),
 938                                        i,
 939                                        m);
 940                                 (*((int*) userdata)) ++;
 941                                 smtp_try_one_queue_entry(MyQItem,
 942                                                          ThisItem,
 943                                                          Msg,
 944                                                          KeepBuffers,
 945                                                          n,
 946                                                          RelayUrls);
 947
 948                                 if (KeepBuffers) HaveBuffers = 1;
 949
 950                                 i++;
 951                         }
 952                 }
 953                 DeleteHashPos(&It);
 954         }
 955         else
 956         {
 957                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
 958                 pthread_mutex_lock(&ActiveQItemsLock);
 959                 {
 960                         if (GetHashPosFromKey(ActiveQItems,
 961                                               LKEY(MyQItem->MessageID),
 962                                               It))
 963                         {
 964                                 DeleteEntryFromHash(ActiveQItems, It);
 965                         }
 966                         else
 967                         {
 968                                 long len;
 969                                 const char* Key;
 970                                 void *VData;
 971
 972                                 SMTPC_syslog(LOG_WARNING,
 973                                              "unable to find QItem with ID[%ld]",
 974                                              MyQItem->MessageID);
 975                                 while (GetNextHashPos(ActiveQItems,
 976                                                       It,
 977                                                       &len,
 978                                                       &Key,
 979                                                       &VData))
 980                                 {
 981                                         SMTPC_syslog(LOG_WARNING,
 982                                                      "have: ID[%ld]",
 983                                                      ((OneQueItem *)VData)->MessageID);
 984                                 }
 985                         }
 986
 987                 }
 988                 pthread_mutex_unlock(&ActiveQItemsLock);
 989                 DeleteHashPos(&It);
 990                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
 991
 992 // TODO: bounce & delete?
 993
 994         }
 995         if (!HaveBuffers) {
 996                 FreeStrBuf (&Msg);
 997 // TODO : free RelayUrls
 998         }
 999 }
1000
1001
1002
1003 /*
1004  * smtp_queue_thread()
1005  *
1006  * Run through the queue sending out messages.
1007  */
1008 void smtp_do_queue(void) {
1009         int num_processed = 0;
1010         int num_activated = 0;
1011
1012         pthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
1013         SMTPCM_syslog(LOG_INFO, "processing outbound queue");
1014
1015         if (CtdlGetRoom(&CC->room, SMTP_SPOOLOUT_ROOM) != 0) {
1016                 SMTPC_syslog(LOG_ERR, "Cannot find room <%s>", SMTP_SPOOLOUT_ROOM);
1017         }
1018         else {
1019                 num_processed = CtdlForEachMessage(MSGS_ALL,
1020                                                    0L,
1021                                                    NULL,
1022                                                    SPOOLMIME,
1023                                                    NULL,
1024                                                    smtp_do_procmsg,
1025                                                    &num_activated);
1026         }
1027         SMTPC_syslog(LOG_INFO,
1028                      "queue run completed; %d messages processed %d activated",
1029                      num_processed, num_activated);
1030
1031 }
1032
1033
1034
1035 /*
1036  * Initialize the SMTP outbound queue
1037  */
1038 void smtp_init_spoolout(void) {
1039         struct ctdlroom qrbuf;
1040
1041         /*
1042          * Create the room.  This will silently fail if the room already
1043          * exists, and that's perfectly ok, because we want it to exist.
1044          */
1045         CtdlCreateRoom(SMTP_SPOOLOUT_ROOM, 3, "", 0, 1, 0, VIEW_QUEUE);
1046
1047         /*
1048          * Make sure it's set to be a "system room" so it doesn't show up
1049          * in the <K>nown rooms list for Aides.
1050          */
1051         if (CtdlGetRoomLock(&qrbuf, SMTP_SPOOLOUT_ROOM) == 0) {
1052                 qrbuf.QRflags2 |= QR2_SYSTEM;
1053                 CtdlPutRoomLock(&qrbuf);
1054         }
1055 }
1056
1057
1058
1059
1060 /*****************************************************************************/
1061 /*                          SMTP UTILITY COMMANDS                            */
1062 /*****************************************************************************/
1063
1064 void cmd_smtp(char *argbuf) {
1065         char cmd[64];
1066         char node[256];
1067         char buf[1024];
1068         int i;
1069         int num_mxhosts;
1070
1071         if (CtdlAccessCheck(ac_aide)) return;
1072
1073         extract_token(cmd, argbuf, 0, '|', sizeof cmd);
1074
1075         if (!strcasecmp(cmd, "mx")) {
1076                 extract_token(node, argbuf, 1, '|', sizeof node);
1077                 num_mxhosts = getmx(buf, node);
1078                 cprintf("%d %d MX hosts listed for %s\n",
1079                         LISTING_FOLLOWS, num_mxhosts, node);
1080                 for (i=0; i<num_mxhosts; ++i) {
1081                         extract_token(node, buf, i, '|', sizeof node);
1082                         cprintf("%s\n", node);
1083                 }
1084                 cprintf("000\n");
1085                 return;
1086         }
1087
1088         else if (!strcasecmp(cmd, "runqueue")) {
1089                 run_queue_now = 1;
1090                 cprintf("%d All outbound SMTP will be retried now.\n", CIT_OK);
1091                 return;
1092         }
1093
1094         else {
1095                 cprintf("%d Invalid command.\n", ERROR + ILLEGAL_VALUE);
1096         }
1097
1098 }
1099
1100
1101 CTDL_MODULE_INIT(smtp_queu)
1102 {
1103         char *pstr;
1104
1105         if (!threading)
1106         {
1107                 pstr = getenv("CITSERVER_n_session_max");
1108                 if ((pstr != NULL) && (*pstr != '\0'))
1109                         max_sessions_for_outbound_smtp = atol(pstr); /* how many sessions might be active till we stop adding more smtp jobs */
1110
1111                 pstr = getenv("CITSERVER_smtp_n_delay_count");
1112                 if ((pstr != NULL) && (*pstr != '\0'))
1113                         ndelay_count = atol(pstr); /* every n queued messages we will sleep... */
1114
1115                 pstr = getenv("CITSERVER_smtp_delay");
1116                 if ((pstr != NULL) && (*pstr != '\0'))
1117                         delay_msec = atol(pstr) * 1000; /* this many seconds. */
1118
1119
1120
1121
1122                 CtdlFillSystemContext(&smtp_queue_CC, "SMTP_Send");
1123                 ActiveQItems = NewHash(1, lFlathash);
1124                 pthread_mutex_init(&ActiveQItemsLock, NULL);
1125
1126                 QItemHandlers = NewHash(0, NULL);
1127
1128                 RegisterQItemHandler(HKEY("msgid"),             QItem_Handle_MsgID);
1129                 RegisterQItemHandler(HKEY("envelope_from"),     QItem_Handle_EnvelopeFrom);
1130                 RegisterQItemHandler(HKEY("retry"),             QItem_Handle_retry);
1131                 RegisterQItemHandler(HKEY("attempted"),         QItem_Handle_Attempted);
1132                 RegisterQItemHandler(HKEY("remote"),            QItem_Handle_Recipient);
1133                 RegisterQItemHandler(HKEY("bounceto"),          QItem_Handle_BounceTo);
1134                 RegisterQItemHandler(HKEY("source_room"),       QItem_Handle_SenderRoom);
1135                 RegisterQItemHandler(HKEY("submitted"),         QItem_Handle_Submitted);
1136
1137                 smtp_init_spoolout();
1138
1139                 CtdlRegisterEVCleanupHook(smtp_evq_cleanup);
1140
1141                 CtdlRegisterProtoHook(cmd_smtp, "SMTP", "SMTP utility commands");
1142                 CtdlRegisterSessionHook(smtp_do_queue, EVT_TIMER, PRIO_SEND + 10);
1143         }
1144
1145         /* return our Subversion id for the Log */
1146         return "smtpeventclient";
1147 }