2 * This module is an SMTP and ESMTP implementation for the Citadel system.
3 * It is compliant with all of the following:
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
20 * The VRFY and EXPN commands have been removed from this implementation
21 * because nobody uses these commands anymore, except for spammers.
23 * Copyright (c) 1998-2012 by the citadel.org team
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.
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.
49 #include <sys/types.h>
52 #if TIME_WITH_SYS_TIME
53 # include <sys/time.h>
57 # include <sys/time.h>
66 #include <sys/socket.h>
67 #include <netinet/in.h>
68 #include <arpa/inet.h>
69 #include <libcitadel.h>
72 #include "citserver.h"
79 #include "internet_addressing.h"
82 #include "clientsocket.h"
83 #include "locate_host.h"
84 #include "citadel_dirs.h"
86 #include "ctdl_module.h"
88 #include "smtpqueue.h"
89 #include "smtp_clienthandlers.h"
90 #include "event_client.h"
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. */
102 static const long MaxRetry = SMTP_RETRY_INTERVAL * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2;
104 int run_queue_now = 0; /* Set to 1 to ignore SMTP send retry times */
106 void RegisterQItemHandler(const char *Key, long Len, QItemHandler H)
108 QItemHandlerStruct *HS = (QItemHandlerStruct*)malloc(sizeof(QItemHandlerStruct));
110 Put(QItemHandlers, Key, Len, HS, NULL);
115 void smtp_try_one_queue_entry(OneQueItem *MyQItem,
116 MailQEntry *MyQEntry,
118 /* KeepMsgText allows us to use MsgText as ours. */
121 ParsedURL *RelayUrls);
124 void smtp_evq_cleanup(void)
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 */
135 int DecreaseQReference(OneQueItem *MyQItem)
137 int IDestructQueItem;
139 pthread_mutex_lock(&ActiveQItemsLock);
140 MyQItem->ActiveDeliveries--;
141 IDestructQueItem = MyQItem->ActiveDeliveries == 0;
142 pthread_mutex_unlock(&ActiveQItemsLock);
143 return IDestructQueItem;
146 void DecreaseShutdownDeliveries(OneQueItem *MyQItem)
148 pthread_mutex_lock(&ActiveQItemsLock);
149 MyQItem->NotYetShutdownDeliveries--;
150 pthread_mutex_unlock(&ActiveQItemsLock);
153 int GetShutdownDeliveries(OneQueItem *MyQItem)
157 pthread_mutex_lock(&ActiveQItemsLock);
158 DestructNow = MyQItem->ActiveDeliveries == 0;
159 pthread_mutex_unlock(&ActiveQItemsLock);
162 void RemoveQItem(OneQueItem *MyQItem)
169 pthread_mutex_lock(&ActiveQItemsLock);
170 It = GetNewHashPos(ActiveQItems, 0);
171 if (GetHashPosFromKey(ActiveQItems, LKEY(MyQItem->MessageID), It))
172 DeleteEntryFromHash(ActiveQItems, It);
175 SMTPC_syslog(LOG_WARNING,
176 "unable to find QItem with ID[%ld]",
178 while (GetNextHashPos(ActiveQItems, It, &len, &Key, &VData))
179 SMTPC_syslog(LOG_WARNING,
181 ((OneQueItem *)VData)->MessageID);
183 pthread_mutex_unlock(&ActiveQItemsLock);
188 void FreeMailQEntry(void *qv)
192 SMTPC_syslog(LOG_DEBUG, "---------------%s--------------", __FUNCTION__);
195 FreeStrBuf(&Q->Recipient);
196 FreeStrBuf(&Q->StatusMessage);
197 FreeStrBuf(&Q->AllStatusMessages);
198 memset(Q, 0, sizeof(MailQEntry));
201 void FreeQueItem(OneQueItem **Item)
204 SMTPC_syslog(LOG_DEBUG, "---------------%s--------------", __FUNCTION__);
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));
216 void HFreeQueItem(void *Item)
218 FreeQueItem((OneQueItem**)&Item);
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)
226 int CheckQEntryActive(MailQEntry *ThisItem)
228 if ((ThisItem->Status == 0) ||
229 (ThisItem->Status == 3) ||
230 (ThisItem->Status == 4))
237 int CheckQEntryIsBounce(MailQEntry *ThisItem)
239 if ((ThisItem->Status == 3) ||
240 (ThisItem->Status == 4) ||
241 (ThisItem->Status == 5))
249 int CountActiveQueueEntries(OneQueItem *MyQItem, int before)
253 long ActiveDeliveries;
257 ActiveDeliveries = 0;
258 It = GetNewHashPos(MyQItem->MailQEntries, 0);
259 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
262 MailQEntry *ThisItem = vQE;
264 if (CheckQEntryActive(ThisItem))
272 ThisItem->Active = Active;
274 ThisItem->StillActive = Active;
277 return ActiveDeliveries;
280 OneQueItem *DeserializeQueueItem(StrBuf *RawQItem, long QueMsgID)
283 const char *pLine = NULL;
288 Item = (OneQueItem*)malloc(sizeof(OneQueItem));
289 memset(Item, 0, sizeof(OneQueItem));
290 Item->Retry = SMTP_RETRY_INTERVAL;
291 Item->MessageID = -1;
292 Item->QueMsgID = QueMsgID;
295 Line = NewStrBufPlain(NULL, 128);
296 while (pLine != StrBufNOTNULL) {
297 const char *pItemPart = NULL;
300 StrBufExtract_NextToken(Line, RawQItem, &pLine, '\n');
301 if (StrLength(Line) == 0) continue;
302 StrBufExtract_NextToken(Token, Line, &pItemPart, '|');
303 if (GetHash(QItemHandlers, SKEY(Token), &vHandler))
305 QItemHandlerStruct *HS;
306 HS = (QItemHandlerStruct*) vHandler;
307 HS->H(Item, Line, &pItemPart);
313 if (Item->Retry >= MaxRetry)
316 pthread_mutex_lock(&ActiveQItemsLock);
317 if (GetHash(ActiveQItems,
318 LKEY(Item->MessageID),
321 /* WHOOPS. somebody else is already working on this. */
322 pthread_mutex_unlock(&ActiveQItemsLock);
327 /* mark our claim on this. */
329 LKEY(Item->MessageID),
332 pthread_mutex_unlock(&ActiveQItemsLock);
338 StrBuf *SerializeQueueItem(OneQueItem *MyQItem)
346 QMessage = NewStrBufPlain(NULL, SIZ);
347 StrBufPrintf(QMessage, "Content-type: %s\n", SPOOLMIME);
348 // "attempted|%ld\n" "retry|%ld\n",, (long)time(NULL), (long)retry );
349 StrBufAppendBufPlain(QMessage, HKEY("\nmsgid|"), 0);
350 StrBufAppendPrintf(QMessage, "%ld", MyQItem->MessageID);
352 StrBufAppendBufPlain(QMessage, HKEY("\nsubmitted|"), 0);
353 StrBufAppendPrintf(QMessage, "%ld", MyQItem->Submitted);
355 if (StrLength(MyQItem->BounceTo) > 0) {
356 StrBufAppendBufPlain(QMessage, HKEY("\nbounceto|"), 0);
357 StrBufAppendBuf(QMessage, MyQItem->BounceTo, 0);
360 if (StrLength(MyQItem->EnvelopeFrom) > 0) {
361 StrBufAppendBufPlain(QMessage, HKEY("\nenvelope_from|"), 0);
362 StrBufAppendBuf(QMessage, MyQItem->EnvelopeFrom, 0);
365 if (StrLength(MyQItem->SenderRoom) > 0) {
366 StrBufAppendBufPlain(QMessage, HKEY("\nsource_room|"), 0);
367 StrBufAppendBuf(QMessage, MyQItem->SenderRoom, 0);
370 StrBufAppendBufPlain(QMessage, HKEY("\nretry|"), 0);
371 StrBufAppendPrintf(QMessage, "%ld",
374 StrBufAppendBufPlain(QMessage, HKEY("\nattempted|"), 0);
375 StrBufAppendPrintf(QMessage, "%ld",
376 time(NULL) /*ctdl_ev_now()*/ + MyQItem->Retry);
378 It = GetNewHashPos(MyQItem->MailQEntries, 0);
379 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
381 MailQEntry *ThisItem = vQE;
383 StrBufAppendBufPlain(QMessage, HKEY("\nremote|"), 0);
384 StrBufAppendBuf(QMessage, ThisItem->Recipient, 0);
385 StrBufAppendBufPlain(QMessage, HKEY("|"), 0);
386 StrBufAppendPrintf(QMessage, "%d", ThisItem->Status);
387 StrBufAppendBufPlain(QMessage, HKEY("|"), 0);
388 if (ThisItem->AllStatusMessages != NULL)
389 StrBufAppendBuf(QMessage, ThisItem->AllStatusMessages, 0);
391 StrBufAppendBuf(QMessage, ThisItem->StatusMessage, 0);
394 StrBufAppendBufPlain(QMessage, HKEY("\n"), 0);
402 void NewMailQEntry(OneQueItem *Item)
404 Item->Current = (MailQEntry*) malloc(sizeof(MailQEntry));
405 memset(Item->Current, 0, sizeof(MailQEntry));
407 if (Item->MailQEntries == NULL)
408 Item->MailQEntries = NewHash(1, Flathash);
409 /* alocate big buffer so we won't get problems reallocating later. */
410 Item->Current->StatusMessage = NewStrBufPlain(NULL, SIZ);
411 Item->Current->n = GetCount(Item->MailQEntries);
412 Put(Item->MailQEntries,
413 IKEY(Item->Current->n),
418 void QItem_Handle_MsgID(OneQueItem *Item, StrBuf *Line, const char **Pos)
420 Item->MessageID = StrBufExtractNext_long(Line, Pos, '|');
423 void QItem_Handle_EnvelopeFrom(OneQueItem *Item, StrBuf *Line, const char **Pos)
425 if (Item->EnvelopeFrom == NULL)
426 Item->EnvelopeFrom = NewStrBufPlain(NULL, StrLength(Line));
427 StrBufExtract_NextToken(Item->EnvelopeFrom, Line, Pos, '|');
430 void QItem_Handle_BounceTo(OneQueItem *Item, StrBuf *Line, const char **Pos)
432 if (Item->BounceTo == NULL)
433 Item->BounceTo = NewStrBufPlain(NULL, StrLength(Line));
434 StrBufExtract_NextToken(Item->BounceTo, Line, Pos, '|');
437 void QItem_Handle_SenderRoom(OneQueItem *Item, StrBuf *Line, const char **Pos)
439 if (Item->SenderRoom == NULL)
440 Item->SenderRoom = NewStrBufPlain(NULL, StrLength(Line));
441 StrBufExtract_NextToken(Item->SenderRoom, Line, Pos, '|');
444 void QItem_Handle_Recipient(OneQueItem *Item, StrBuf *Line, const char **Pos)
446 if (Item->Current == NULL)
448 if (Item->Current->Recipient == NULL)
449 Item->Current->Recipient=NewStrBufPlain(NULL, StrLength(Line));
450 StrBufExtract_NextToken(Item->Current->Recipient, Line, Pos, '|');
451 Item->Current->Status = StrBufExtractNext_int(Line, Pos, '|');
452 StrBufExtract_NextToken(Item->Current->StatusMessage, Line, Pos, '|');
453 Item->Current = NULL; // TODO: is this always right?
457 void QItem_Handle_retry(OneQueItem *Item, StrBuf *Line, const char **Pos)
460 StrBufExtractNext_int(Line, Pos, '|');
461 if (Item->Retry == 0)
462 Item->Retry = SMTP_RETRY_INTERVAL;
468 void QItem_Handle_Submitted(OneQueItem *Item, StrBuf *Line, const char **Pos)
470 Item->Submitted = atol(*Pos);
474 void QItem_Handle_Attempted(OneQueItem *Item, StrBuf *Line, const char **Pos)
476 Item->ReattemptWhen = StrBufExtractNext_int(Line, Pos, '|');
482 * this one has to have the context for loading the message via the redirect buffer...
484 StrBuf *smtp_load_msg(OneQueItem *MyQItem, int n, char **Author, char **Address)
489 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
490 CtdlOutputMsg(MyQItem->MessageID,
491 MT_RFC822, HEADERS_ALL,
493 (ESC_DOT|SUPPRESS_ENV_TO),
497 SendMsg = CCC->redirect_buffer;
498 CCC->redirect_buffer = NULL;
499 if ((StrLength(SendMsg) > 0) &&
500 ChrPtr(SendMsg)[StrLength(SendMsg) - 1] != '\n') {
501 SMTPC_syslog(LOG_WARNING,
502 "[%d] Possible problem: message did not "
503 "correctly terminate. (expecting 0x10, got 0x%02x)\n",
504 MsgCount, //yes uncool, but best choice here...
505 ChrPtr(SendMsg)[StrLength(SendMsg) - 1] );
506 StrBufAppendBufPlain(SendMsg, HKEY("\r\n"), 0);
514 * smtp_do_bounce() is caled by smtp_do_procmsg() to scan a set of delivery
515 * instructions for "5" codes (permanent fatal errors) and produce/deliver
516 * a "bounce" message (delivery status notification).
518 void smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt, ParsedURL *Relay)
522 struct CtdlMessage *bmsg = NULL;
526 struct recptypes *valid;
534 int first_attempt = 0;
535 int successful_bounce = 0;
539 SMTPCM_syslog(LOG_DEBUG, "smtp_do_bounce() called\n");
541 if (MyQItem->SendBounceMail == 0)
544 now = time (NULL); //ev_time();
546 if ( (now - MyQItem->Submitted) > SMTP_GIVE_UP ) {
550 if (MyQItem->Retry == SMTP_RETRY_INTERVAL) {
555 * Now go through the instructions checking for stuff.
557 Msg = NewStrBufPlain(NULL, 1024);
558 It = GetNewHashPos(MyQItem->MailQEntries, 0);
559 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
561 MailQEntry *ThisItem = vQE;
562 if ((ThisItem->Active && (ThisItem->Status == 5)) || /* failed now? */
563 ((give_up == 1) && (ThisItem->Status != 2)) ||
564 ((first_attempt == 1) && (ThisItem->Status != 2)))
565 /* giving up after failed attempts... */
569 StrBufAppendBufPlain(Msg, HKEY(" "), 0);
570 StrBufAppendBuf(Msg, ThisItem->Recipient, 0);
571 StrBufAppendBufPlain(Msg, HKEY(": "), 0);
572 StrBufAppendBuf(Msg, ThisItem->StatusMessage, 0);
573 StrBufAppendBufPlain(Msg, HKEY("\r\n"), 0);
578 /* Deliver the bounce if there's anything worth mentioning */
579 SMTPC_syslog(LOG_DEBUG, "num_bounces = %d\n", num_bounces);
581 if (num_bounces == 0) {
586 if ((StrLength(MyQItem->SenderRoom) == 0) && MyQItem->HaveRelay) {
587 const char *RelayUrlStr = "[not found]";
588 /* one message that relaying is broken is enough; no extra room error message. */
589 StrBuf *RelayDetails = NewStrBuf();
592 RelayUrlStr = ChrPtr(Relay->URL);
594 StrBufPrintf(RelayDetails,
595 "Relaying via %s failed permanently. \n Reason:\n%s\n Revalidate your relay configuration.",
598 CtdlAideMessage(ChrPtr(RelayDetails), "Relaying Failed");
599 FreeStrBuf(&RelayDetails);
602 boundary = NewStrBufPlain(HKEY("=_Citadel_Multipart_"));
603 StrBufAppendPrintf(boundary,
609 /* Start building our bounce message; go shopping for memory first. */
610 BounceMB = NewStrBufPlain(
612 1024 + /* mime stuff.... */
613 StrLength(Msg) + /* the bounce information... */
614 StrLength(OMsgTxt)); /* the original message */
615 if (BounceMB == NULL) {
616 FreeStrBuf(&boundary);
617 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
622 bmsg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
624 FreeStrBuf(&boundary);
625 FreeStrBuf(&BounceMB);
626 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
630 memset(bmsg, 0, sizeof(struct CtdlMessage));
633 StrBufAppendBufPlain(BounceMB, HKEY("Content-type: multipart/mixed; boundary=\""), 0);
634 StrBufAppendBuf(BounceMB, boundary, 0);
635 StrBufAppendBufPlain(BounceMB, HKEY("\"\r\n"), 0);
636 StrBufAppendBufPlain(BounceMB, HKEY("MIME-Version: 1.0\r\n"), 0);
637 StrBufAppendBufPlain(BounceMB, HKEY("X-Mailer: " CITADEL "\r\n"), 0);
638 StrBufAppendBufPlain(BounceMB, HKEY("\r\nThis is a multipart message in MIME format.\r\n\r\n"), 0);
639 StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
640 StrBufAppendBuf(BounceMB, boundary, 0);
641 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
642 StrBufAppendBufPlain(BounceMB, HKEY("Content-type: text/plain\r\n\r\n"), 0);
645 StrBufAppendBufPlain(
648 "A message you sent could not be delivered "
649 "to some or all of its recipients\n"
650 "due to prolonged unavailability "
651 "of its destination(s).\n"
652 "Giving up on the following addresses:\n\n"
655 StrBufAppendBufPlain(
658 "A message you sent could not be delivered "
659 "to some or all of its recipients.\n"
660 "The following addresses "
661 "were undeliverable:\n\n"
664 StrBufAppendBuf(BounceMB, Msg, 0);
667 if (StrLength(MyQItem->SenderRoom) > 0)
669 StrBufAppendBufPlain(
671 HKEY("The message was originaly posted in: "), 0);
672 StrBufAppendBuf(BounceMB, MyQItem->SenderRoom, 0);
673 StrBufAppendBufPlain(
678 /* Attach the original message */
679 StrBufAppendBufPlain(BounceMB, HKEY("\r\n--"), 0);
680 StrBufAppendBuf(BounceMB, boundary, 0);
681 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
682 StrBufAppendBufPlain(BounceMB,
683 HKEY("Content-type: message/rfc822\r\n"), 0);
684 StrBufAppendBufPlain(BounceMB,
685 HKEY("Content-Transfer-Encoding: 7bit\r\n"), 0);
686 StrBufAppendBufPlain(BounceMB,
687 HKEY("Content-Disposition: inline\r\n"), 0);
688 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
689 StrBufAppendBuf(BounceMB, OMsgTxt, 0);
691 /* Close the multipart MIME scope */
692 StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
693 StrBufAppendBuf(BounceMB, boundary, 0);
694 StrBufAppendBufPlain(BounceMB, HKEY("--\r\n"), 0);
696 bmsg->cm_magic = CTDLMESSAGE_MAGIC;
697 bmsg->cm_anon_type = MES_NORMAL;
698 bmsg->cm_format_type = FMT_RFC822;
700 bmsg->cm_fields['O'] = strdup(MAILROOM);
701 bmsg->cm_fields['A'] = strdup("Citadel");
702 bmsg->cm_fields['N'] = strdup(config.c_nodename);
703 bmsg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
704 bmsg->cm_fields['M'] = SmashStrBuf(&BounceMB);
706 /* First try the user who sent the message */
707 if (StrLength(MyQItem->BounceTo) == 0) {
708 SMTPCM_syslog(LOG_ERR, "No bounce address specified\n");
711 SMTPC_syslog(LOG_DEBUG, "bounce to user? <%s>\n",
712 ChrPtr(MyQItem->BounceTo));
715 /* Can we deliver the bounce to the original sender? */
716 valid = validate_recipients(ChrPtr(MyQItem->BounceTo), NULL, 0);
717 if ((valid != NULL) && (valid->num_error == 0)) {
718 CtdlSubmitMsg(bmsg, valid, "", QP_EADDR);
719 successful_bounce = 1;
722 /* If not, post it in the Aide> room */
723 if (successful_bounce == 0) {
724 CtdlSubmitMsg(bmsg, NULL, config.c_aideroom, QP_EADDR);
727 /* Free up the memory we used */
728 free_recipients(valid);
729 FreeStrBuf(&boundary);
730 CtdlFreeMessage(bmsg);
731 SMTPCM_syslog(LOG_DEBUG, "Done processing bounces\n");
734 ParsedURL *LoadRelayUrls(OneQueItem *MyQItem,
739 ParsedURL *RelayUrls = NULL;
741 ParsedURL **Url = &MyQItem->URL;
743 nRelays = get_hosts(mxbuf, "fallbackhost");
747 const char *Pos = NULL;
748 All = NewStrBufPlain(mxbuf, -1);
749 One = NewStrBufPlain(NULL, StrLength(All) + 1);
751 while ((Pos != StrBufNOTNULL) &&
755 StrBufExtract_NextToken(One, All, &Pos, '|');
756 if (!ParseURL(Url, One, DefaultMXPort)) {
757 SMTPC_syslog(LOG_DEBUG,
758 "Failed to parse: %s\n",
763 MyQItem->HaveRelay = 1;
769 nRelays = get_hosts(mxbuf, "smarthost");
774 const char *Pos = NULL;
775 All = NewStrBufPlain(mxbuf, -1);
776 One = NewStrBufPlain(NULL, StrLength(All) + 1);
778 while ((Pos != StrBufNOTNULL) &&
782 StrBufExtract_NextToken(One, All, &Pos, '|');
783 User = strchr(ChrPtr(One), ' ');
785 if (!strcmp(User + 1, Author) ||
786 !strcmp(User + 1, Address))
787 StrBufCutAt(One, 0, User);
789 MyQItem->HaveRelay = 1;
793 if (!ParseURL(Url, One, DefaultMXPort)) {
794 SMTPC_syslog(LOG_DEBUG,
795 "Failed to parse: %s\n",
799 ///if (!Url->IsIP)) // todo dupe me fork ipv6
801 MyQItem->HaveRelay = 1;
812 * Called by smtp_do_queue() to handle an individual message.
814 void smtp_do_procmsg(long msgnum, void *userdata) {
816 int mynumsessions = num_sessions;
817 struct CtdlMessage *msg = NULL;
819 char *Address = NULL;
831 if (mynumsessions > max_sessions_for_outbound_smtp) {
832 SMTPC_syslog(LOG_INFO,
833 "skipping because of num jobs %d > %d max_sessions_for_outbound_smtp",
835 max_sessions_for_outbound_smtp);
838 SMTPC_syslog(LOG_DEBUG, "smtp_do_procmsg(%ld)\n", msgnum);
839 ///strcpy(envelope_from, "");
841 msg = CtdlFetchMessage(msgnum, 1);
843 SMTPC_syslog(LOG_ERR, "tried %ld but no such message!\n",
848 pch = instr = msg->cm_fields['M'];
850 /* Strip out the headers (no not amd any other non-instruction) line */
851 while (pch != NULL) {
852 pch = strchr(pch, '\n');
853 if ((pch != NULL) && (*(pch + 1) == '\n')) {
858 PlainQItem = NewStrBufPlain(instr, -1);
859 CtdlFreeMessage(msg);
860 MyQItem = DeserializeQueueItem(PlainQItem, msgnum);
861 FreeStrBuf(&PlainQItem);
863 if (MyQItem == NULL) {
864 SMTPC_syslog(LOG_ERR,
865 "Msg No %ld: already in progress!\n",
867 return; /* s.b. else is already processing... */
871 * Postpone delivery if we've already tried recently.
874 if ((MyQItem->ReattemptWhen != 0) &&
875 (now < MyQItem->ReattemptWhen) &&
876 (run_queue_now == 0))
878 SMTPC_syslog(LOG_DEBUG,
879 "Retry time not yet reached. %ld seconds left.",
880 MyQItem->ReattemptWhen - now);
882 It = GetNewHashPos(MyQItem->MailQEntries, 0);
883 pthread_mutex_lock(&ActiveQItemsLock);
885 if (GetHashPosFromKey(ActiveQItems,
886 LKEY(MyQItem->MessageID),
889 DeleteEntryFromHash(ActiveQItems, It);
892 pthread_mutex_unlock(&ActiveQItemsLock);
893 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
899 * Bail out if there's no actual message associated with this
901 if (MyQItem->MessageID < 0L) {
902 SMTPCM_syslog(LOG_ERR, "no 'msgid' directive found!\n");
903 It = GetNewHashPos(MyQItem->MailQEntries, 0);
904 pthread_mutex_lock(&ActiveQItemsLock);
906 if (GetHashPosFromKey(ActiveQItems,
907 LKEY(MyQItem->MessageID),
910 DeleteEntryFromHash(ActiveQItems, It);
913 pthread_mutex_unlock(&ActiveQItemsLock);
915 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
920 It = GetNewHashPos(MyQItem->MailQEntries, 0);
921 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
923 MailQEntry *ThisItem = vQE;
924 SMTPC_syslog(LOG_DEBUG, "SMTP Queue: Task: <%s> %d\n",
925 ChrPtr(ThisItem->Recipient),
930 MyQItem->NotYetShutdownDeliveries =
931 MyQItem->ActiveDeliveries = CountActiveQueueEntries(MyQItem, 1);
933 /* failsafe against overload:
934 * will we exceed the limit set?
936 if ((MyQItem->ActiveDeliveries + mynumsessions > max_sessions_for_outbound_smtp) &&
937 /* if yes, did we reach more than half of the quota? */
938 ((mynumsessions * 2) > max_sessions_for_outbound_smtp) &&
939 /* if... would we ever fit into half of the quota?? */
940 (((MyQItem->ActiveDeliveries * 2) < max_sessions_for_outbound_smtp)))
942 /* abort delivery for another time. */
943 SMTPC_syslog(LOG_INFO,
944 "SMTP Queue: skipping because of num jobs %d + %ld > %d max_sessions_for_outbound_smtp",
946 MyQItem->ActiveDeliveries,
947 max_sessions_for_outbound_smtp);
949 It = GetNewHashPos(MyQItem->MailQEntries, 0);
950 pthread_mutex_lock(&ActiveQItemsLock);
952 if (GetHashPosFromKey(ActiveQItems,
953 LKEY(MyQItem->MessageID),
956 DeleteEntryFromHash(ActiveQItems, It);
959 pthread_mutex_unlock(&ActiveQItemsLock);
965 if (MyQItem->ActiveDeliveries > 0)
967 ParsedURL *RelayUrls = NULL;
970 int m = MyQItem->ActiveDeliveries;
973 It = GetNewHashPos(MyQItem->MailQEntries, 0);
975 Msg = smtp_load_msg(MyQItem, n, &Author, &Address);
976 RelayUrls = LoadRelayUrls(MyQItem, Author, Address);
977 if ((RelayUrls == NULL) && MyQItem->HaveRelay) {
980 (GetNextHashPos(MyQItem->MailQEntries,
981 It, &len, &Key, &vQE)))
983 int KeepBuffers = (i == m);
984 MailQEntry *ThisItem = vQE;
985 StrBufPrintf(ThisItem->StatusMessage,
986 "No relay configured matching %s / %s",
987 (Author != NULL)? Author : "",
988 (Address != NULL)? Address : "");
989 ThisItem->Status = 5;
993 if (i > 1) n = MsgCount++;
995 "SMTPC: giving up on <%ld> <%s> %d / %d \n",
997 ChrPtr(ThisItem->Recipient),
1000 (*((int*) userdata)) ++;
1001 smtp_try_one_queue_entry(MyQItem,
1008 if (KeepBuffers) HaveBuffers++;
1012 if (Author != NULL) free (Author);
1013 if (Address != NULL) free (Address);
1018 if (Author != NULL) free (Author);
1019 if (Address != NULL) free (Address);
1022 (GetNextHashPos(MyQItem->MailQEntries,
1023 It, &len, &Key, &vQE)))
1025 MailQEntry *ThisItem = vQE;
1027 if (ThisItem->Active == 1)
1029 int KeepBuffers = (i == m);
1032 if (nActivated % ndelay_count == 0)
1035 if (i > 1) n = MsgCount++;
1037 "SMTPC: Trying <%ld> <%s> %d / %d \n",
1039 ChrPtr(ThisItem->Recipient),
1042 (*((int*) userdata)) ++;
1043 smtp_try_one_queue_entry(MyQItem,
1050 if (KeepBuffers) HaveBuffers++;
1059 It = GetNewHashPos(MyQItem->MailQEntries, 0);
1060 pthread_mutex_lock(&ActiveQItemsLock);
1062 if (GetHashPosFromKey(ActiveQItems,
1063 LKEY(MyQItem->MessageID),
1066 DeleteEntryFromHash(ActiveQItems, It);
1074 SMTPC_syslog(LOG_WARNING,
1075 "unable to find QItem with ID[%ld]",
1076 MyQItem->MessageID);
1077 while (GetNextHashPos(ActiveQItems,
1083 SMTPC_syslog(LOG_WARNING,
1085 ((OneQueItem *)VData)->MessageID);
1090 pthread_mutex_unlock(&ActiveQItemsLock);
1092 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
1094 // TODO: bounce & delete?
1099 // TODO : free RelayUrls
1106 * smtp_queue_thread()
1108 * Run through the queue sending out messages.
1110 void smtp_do_queue(void) {
1111 int num_processed = 0;
1112 int num_activated = 0;
1114 pthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
1115 SMTPCM_syslog(LOG_INFO, "processing outbound queue");
1117 if (CtdlGetRoom(&CC->room, SMTP_SPOOLOUT_ROOM) != 0) {
1118 SMTPC_syslog(LOG_ERR, "Cannot find room <%s>", SMTP_SPOOLOUT_ROOM);
1121 num_processed = CtdlForEachMessage(MSGS_ALL,
1129 SMTPC_syslog(LOG_INFO,
1130 "queue run completed; %d messages processed %d activated",
1131 num_processed, num_activated);
1138 * Initialize the SMTP outbound queue
1140 void smtp_init_spoolout(void) {
1141 struct ctdlroom qrbuf;
1144 * Create the room. This will silently fail if the room already
1145 * exists, and that's perfectly ok, because we want it to exist.
1147 CtdlCreateRoom(SMTP_SPOOLOUT_ROOM, 3, "", 0, 1, 0, VIEW_QUEUE);
1150 * Make sure it's set to be a "system room" so it doesn't show up
1151 * in the <K>nown rooms list for Aides.
1153 if (CtdlGetRoomLock(&qrbuf, SMTP_SPOOLOUT_ROOM) == 0) {
1154 qrbuf.QRflags2 |= QR2_SYSTEM;
1155 CtdlPutRoomLock(&qrbuf);
1162 /*****************************************************************************/
1163 /* SMTP UTILITY COMMANDS */
1164 /*****************************************************************************/
1166 void cmd_smtp(char *argbuf) {
1173 if (CtdlAccessCheck(ac_aide)) return;
1175 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
1177 if (!strcasecmp(cmd, "mx")) {
1178 extract_token(node, argbuf, 1, '|', sizeof node);
1179 num_mxhosts = getmx(buf, node);
1180 cprintf("%d %d MX hosts listed for %s\n",
1181 LISTING_FOLLOWS, num_mxhosts, node);
1182 for (i=0; i<num_mxhosts; ++i) {
1183 extract_token(node, buf, i, '|', sizeof node);
1184 cprintf("%s\n", node);
1190 else if (!strcasecmp(cmd, "runqueue")) {
1192 cprintf("%d All outbound SMTP will be retried now.\n", CIT_OK);
1197 cprintf("%d Invalid command.\n", ERROR + ILLEGAL_VALUE);
1203 CTDL_MODULE_INIT(smtp_queu)
1209 pstr = getenv("CITSERVER_n_session_max");
1210 if ((pstr != NULL) && (*pstr != '\0'))
1211 max_sessions_for_outbound_smtp = atol(pstr); /* how many sessions might be active till we stop adding more smtp jobs */
1213 pstr = getenv("CITSERVER_smtp_n_delay_count");
1214 if ((pstr != NULL) && (*pstr != '\0'))
1215 ndelay_count = atol(pstr); /* every n queued messages we will sleep... */
1217 pstr = getenv("CITSERVER_smtp_delay");
1218 if ((pstr != NULL) && (*pstr != '\0'))
1219 delay_msec = atol(pstr) * 1000; /* this many seconds. */
1224 CtdlFillSystemContext(&smtp_queue_CC, "SMTP_Send");
1225 ActiveQItems = NewHash(1, lFlathash);
1226 pthread_mutex_init(&ActiveQItemsLock, NULL);
1228 QItemHandlers = NewHash(0, NULL);
1230 RegisterQItemHandler(HKEY("msgid"), QItem_Handle_MsgID);
1231 RegisterQItemHandler(HKEY("envelope_from"), QItem_Handle_EnvelopeFrom);
1232 RegisterQItemHandler(HKEY("retry"), QItem_Handle_retry);
1233 RegisterQItemHandler(HKEY("attempted"), QItem_Handle_Attempted);
1234 RegisterQItemHandler(HKEY("remote"), QItem_Handle_Recipient);
1235 RegisterQItemHandler(HKEY("bounceto"), QItem_Handle_BounceTo);
1236 RegisterQItemHandler(HKEY("source_room"), QItem_Handle_SenderRoom);
1237 RegisterQItemHandler(HKEY("submitted"), QItem_Handle_Submitted);
1239 smtp_init_spoolout();
1241 CtdlRegisterEVCleanupHook(smtp_evq_cleanup);
1243 CtdlRegisterProtoHook(cmd_smtp, "SMTP", "SMTP utility commands");
1244 CtdlRegisterSessionHook(smtp_do_queue, EVT_TIMER, PRIO_SEND + 10);
1247 /* return our Subversion id for the Log */
1248 return "smtpeventclient";