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