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);
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)
253 long ActiveDeliveries;
257 ActiveDeliveries = 0;
258 It = GetNewHashPos(MyQItem->MailQEntries, 0);
259 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
261 MailQEntry *ThisItem = vQE;
263 if (CheckQEntryActive(ThisItem))
266 ThisItem->Active = 1;
269 ThisItem->Active = 0;
272 return ActiveDeliveries;
275 OneQueItem *DeserializeQueueItem(StrBuf *RawQItem, long QueMsgID)
278 const char *pLine = NULL;
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;
290 Line = NewStrBufPlain(NULL, 128);
291 while (pLine != StrBufNOTNULL) {
292 const char *pItemPart = NULL;
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))
300 QItemHandlerStruct *HS;
301 HS = (QItemHandlerStruct*) vHandler;
302 HS->H(Item, Line, &pItemPart);
308 if (Item->Retry >= MaxRetry)
311 pthread_mutex_lock(&ActiveQItemsLock);
312 if (GetHash(ActiveQItems,
313 LKEY(Item->MessageID),
316 /* WHOOPS. somebody else is already working on this. */
317 pthread_mutex_unlock(&ActiveQItemsLock);
322 /* mark our claim on this. */
324 LKEY(Item->MessageID),
327 pthread_mutex_unlock(&ActiveQItemsLock);
333 StrBuf *SerializeQueueItem(OneQueItem *MyQItem)
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);
347 StrBufAppendBufPlain(QMessage, HKEY("\nsubmitted|"), 0);
348 StrBufAppendPrintf(QMessage, "%ld", MyQItem->Submitted);
350 if (StrLength(MyQItem->BounceTo) > 0) {
351 StrBufAppendBufPlain(QMessage, HKEY("\nbounceto|"), 0);
352 StrBufAppendBuf(QMessage, MyQItem->BounceTo, 0);
355 if (StrLength(MyQItem->EnvelopeFrom) > 0) {
356 StrBufAppendBufPlain(QMessage, HKEY("\nenvelope_from|"), 0);
357 StrBufAppendBuf(QMessage, MyQItem->EnvelopeFrom, 0);
360 if (StrLength(MyQItem->SenderRoom) > 0) {
361 StrBufAppendBufPlain(QMessage, HKEY("\nsource_room|"), 0);
362 StrBufAppendBuf(QMessage, MyQItem->SenderRoom, 0);
365 StrBufAppendBufPlain(QMessage, HKEY("\nretry|"), 0);
366 StrBufAppendPrintf(QMessage, "%ld",
369 StrBufAppendBufPlain(QMessage, HKEY("\nattempted|"), 0);
370 StrBufAppendPrintf(QMessage, "%ld",
371 time(NULL) /*ctdl_ev_now()*/ + MyQItem->Retry);
373 It = GetNewHashPos(MyQItem->MailQEntries, 0);
374 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
376 MailQEntry *ThisItem = vQE;
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);
386 StrBufAppendBufPlain(QMessage, HKEY("\n"), 0);
394 void NewMailQEntry(OneQueItem *Item)
396 Item->Current = (MailQEntry*) malloc(sizeof(MailQEntry));
397 memset(Item->Current, 0, sizeof(MailQEntry));
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),
410 void QItem_Handle_MsgID(OneQueItem *Item, StrBuf *Line, const char **Pos)
412 Item->MessageID = StrBufExtractNext_long(Line, Pos, '|');
415 void QItem_Handle_EnvelopeFrom(OneQueItem *Item, StrBuf *Line, const char **Pos)
417 if (Item->EnvelopeFrom == NULL)
418 Item->EnvelopeFrom = NewStrBufPlain(NULL, StrLength(Line));
419 StrBufExtract_NextToken(Item->EnvelopeFrom, Line, Pos, '|');
422 void QItem_Handle_BounceTo(OneQueItem *Item, StrBuf *Line, const char **Pos)
424 if (Item->BounceTo == NULL)
425 Item->BounceTo = NewStrBufPlain(NULL, StrLength(Line));
426 StrBufExtract_NextToken(Item->BounceTo, Line, Pos, '|');
429 void QItem_Handle_SenderRoom(OneQueItem *Item, StrBuf *Line, const char **Pos)
431 if (Item->SenderRoom == NULL)
432 Item->SenderRoom = NewStrBufPlain(NULL, StrLength(Line));
433 StrBufExtract_NextToken(Item->SenderRoom, Line, Pos, '|');
436 void QItem_Handle_Recipient(OneQueItem *Item, StrBuf *Line, const char **Pos)
438 if (Item->Current == NULL)
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?
449 void QItem_Handle_retry(OneQueItem *Item, StrBuf *Line, const char **Pos)
452 StrBufExtractNext_int(Line, Pos, '|');
453 if (Item->Retry == 0)
454 Item->Retry = SMTP_RETRY_INTERVAL;
460 void QItem_Handle_Submitted(OneQueItem *Item, StrBuf *Line, const char **Pos)
462 Item->Submitted = atol(*Pos);
466 void QItem_Handle_Attempted(OneQueItem *Item, StrBuf *Line, const char **Pos)
468 Item->ReattemptWhen = StrBufExtractNext_int(Line, Pos, '|');
474 * this one has to have the context for loading the message via the redirect buffer...
476 StrBuf *smtp_load_msg(OneQueItem *MyQItem, int n, char **Author, char **Address)
481 CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
482 CtdlOutputMsg(MyQItem->MessageID,
483 MT_RFC822, HEADERS_ALL,
485 (ESC_DOT|SUPPRESS_ENV_TO),
489 SendMsg = CCC->redirect_buffer;
490 CCC->redirect_buffer = NULL;
491 if ((StrLength(SendMsg) > 0) &&
492 ChrPtr(SendMsg)[StrLength(SendMsg) - 1] != '\n') {
493 SMTPC_syslog(LOG_WARNING,
494 "[%d] Possible problem: message did not "
495 "correctly terminate. (expecting 0x10, got 0x%02x)\n",
496 MsgCount, //yes uncool, but best choice here...
497 ChrPtr(SendMsg)[StrLength(SendMsg) - 1] );
498 StrBufAppendBufPlain(SendMsg, HKEY("\r\n"), 0);
506 * smtp_do_bounce() is caled by smtp_do_procmsg() to scan a set of delivery
507 * instructions for "5" codes (permanent fatal errors) and produce/deliver
508 * a "bounce" message (delivery status notification).
510 void smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt)
514 struct CtdlMessage *bmsg = NULL;
518 struct recptypes *valid;
526 int first_attempt = 0;
527 int successful_bounce = 0;
531 SMTPCM_syslog(LOG_DEBUG, "smtp_do_bounce() called\n");
533 if (MyQItem->SendBounceMail == 0)
536 now = time (NULL); //ev_time();
538 if ( (now - MyQItem->Submitted) > SMTP_GIVE_UP ) {
542 if (MyQItem->Retry == SMTP_RETRY_INTERVAL) {
547 * Now go through the instructions checking for stuff.
549 Msg = NewStrBufPlain(NULL, 1024);
550 It = GetNewHashPos(MyQItem->MailQEntries, 0);
551 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
553 MailQEntry *ThisItem = vQE;
554 if ((ThisItem->Active && (ThisItem->Status == 5)) || /* failed now? */
555 ((give_up == 1) && (ThisItem->Status != 2)) ||
556 ((first_attempt == 1) && (ThisItem->Status != 2)))
557 /* giving up after failed attempts... */
561 StrBufAppendBuf(Msg, ThisItem->Recipient, 0);
562 StrBufAppendBufPlain(Msg, HKEY(": "), 0);
563 StrBufAppendBuf(Msg, ThisItem->StatusMessage, 0);
564 StrBufAppendBufPlain(Msg, HKEY("\r\n"), 0);
569 /* Deliver the bounce if there's anything worth mentioning */
570 SMTPC_syslog(LOG_DEBUG, "num_bounces = %d\n", num_bounces);
572 if (num_bounces == 0) {
577 boundary = NewStrBufPlain(HKEY("=_Citadel_Multipart_"));
578 StrBufAppendPrintf(boundary,
584 /* Start building our bounce message; go shopping for memory first. */
585 BounceMB = NewStrBufPlain(
587 1024 + /* mime stuff.... */
588 StrLength(Msg) + /* the bounce information... */
589 StrLength(OMsgTxt)); /* the original message */
590 if (BounceMB == NULL) {
591 FreeStrBuf(&boundary);
592 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
597 bmsg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
599 FreeStrBuf(&boundary);
600 FreeStrBuf(&BounceMB);
601 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
605 memset(bmsg, 0, sizeof(struct CtdlMessage));
608 StrBufAppendBufPlain(BounceMB, HKEY("Content-type: multipart/mixed; boundary=\""), 0);
609 StrBufAppendBuf(BounceMB, boundary, 0);
610 StrBufAppendBufPlain(BounceMB, HKEY("\"\r\n"), 0);
611 StrBufAppendBufPlain(BounceMB, HKEY("MIME-Version: 1.0\r\n"), 0);
612 StrBufAppendBufPlain(BounceMB, HKEY("X-Mailer: " CITADEL "\r\n"), 0);
613 StrBufAppendBufPlain(BounceMB, HKEY("\r\nThis is a multipart message in MIME format.\r\n\r\n"), 0);
614 StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
615 StrBufAppendBuf(BounceMB, boundary, 0);
616 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
617 StrBufAppendBufPlain(BounceMB, HKEY("Content-type: text/plain\r\n\r\n"), 0);
620 StrBufAppendBufPlain(
623 "A message you sent could not be delivered "
624 "to some or all of its recipients\n"
625 "due to prolonged unavailability "
626 "of its destination(s).\n"
627 "Giving up on the following addresses:\n\n"
630 StrBufAppendBufPlain(
633 "A message you sent could not be delivered "
634 "to some or all of its recipients.\n"
635 "The following addresses "
636 "were undeliverable:\n\n"
639 StrBufAppendBuf(BounceMB, Msg, 0);
642 if (StrLength(MyQItem->SenderRoom) > 0)
644 StrBufAppendBufPlain(
646 HKEY("The message was originaly posted in: "), 0);
647 StrBufAppendBuf(BounceMB, MyQItem->SenderRoom, 0);
648 StrBufAppendBufPlain(
653 /* Attach the original message */
654 StrBufAppendBufPlain(BounceMB, HKEY("\r\n--"), 0);
655 StrBufAppendBuf(BounceMB, boundary, 0);
656 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
657 StrBufAppendBufPlain(BounceMB,
658 HKEY("Content-type: message/rfc822\r\n"), 0);
659 StrBufAppendBufPlain(BounceMB,
660 HKEY("Content-Transfer-Encoding: 7bit\r\n"), 0);
661 StrBufAppendBufPlain(BounceMB,
662 HKEY("Content-Disposition: inline\r\n"), 0);
663 StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
664 StrBufAppendBuf(BounceMB, OMsgTxt, 0);
666 /* Close the multipart MIME scope */
667 StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
668 StrBufAppendBuf(BounceMB, boundary, 0);
669 StrBufAppendBufPlain(BounceMB, HKEY("--\r\n"), 0);
671 bmsg->cm_magic = CTDLMESSAGE_MAGIC;
672 bmsg->cm_anon_type = MES_NORMAL;
673 bmsg->cm_format_type = FMT_RFC822;
675 bmsg->cm_fields['O'] = strdup(MAILROOM);
676 bmsg->cm_fields['A'] = strdup("Citadel");
677 bmsg->cm_fields['N'] = strdup(config.c_nodename);
678 bmsg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
679 bmsg->cm_fields['M'] = SmashStrBuf(&BounceMB);
681 /* First try the user who sent the message */
682 if (StrLength(MyQItem->BounceTo) == 0) {
683 SMTPCM_syslog(LOG_ERR, "No bounce address specified\n");
686 SMTPC_syslog(LOG_DEBUG, "bounce to user? <%s>\n",
687 ChrPtr(MyQItem->BounceTo));
690 /* Can we deliver the bounce to the original sender? */
691 valid = validate_recipients(ChrPtr(MyQItem->BounceTo), NULL, 0);
692 if ((valid != NULL) && (valid->num_error == 0)) {
693 CtdlSubmitMsg(bmsg, valid, "", QP_EADDR);
694 successful_bounce = 1;
697 /* If not, post it in the Aide> room */
698 if (successful_bounce == 0) {
699 CtdlSubmitMsg(bmsg, NULL, config.c_aideroom, QP_EADDR);
702 /* Free up the memory we used */
703 free_recipients(valid);
704 FreeStrBuf(&boundary);
705 CtdlFreeMessage(bmsg);
706 SMTPCM_syslog(LOG_DEBUG, "Done processing bounces\n");
709 ParsedURL *LoadRelayUrls(OneQueItem *MyQItem,
714 ParsedURL *RelayUrls = NULL;
716 ParsedURL **Url = &MyQItem->URL;
718 nRelays = get_hosts(mxbuf, "fallbackhost");
722 const char *Pos = NULL;
723 All = NewStrBufPlain(mxbuf, -1);
724 One = NewStrBufPlain(NULL, StrLength(All) + 1);
726 while ((Pos != StrBufNOTNULL) &&
730 StrBufExtract_NextToken(One, All, &Pos, '|');
731 if (!ParseURL(Url, One, DefaultMXPort)) {
732 SMTPC_syslog(LOG_DEBUG,
733 "Failed to parse: %s\n",
738 MyQItem->HaveRelay = 1;
744 nRelays = get_hosts(mxbuf, "smarthost");
749 const char *Pos = NULL;
750 All = NewStrBufPlain(mxbuf, -1);
751 One = NewStrBufPlain(NULL, StrLength(All) + 1);
753 while ((Pos != StrBufNOTNULL) &&
757 StrBufExtract_NextToken(One, All, &Pos, '|');
758 User = strchr(ChrPtr(One), ' ');
760 if (!strcmp(User + 1, Author) ||
761 !strcmp(User + 1, Address))
762 StrBufCutAt(One, 0, User);
767 if (!ParseURL(Url, One, DefaultMXPort)) {
768 SMTPC_syslog(LOG_DEBUG,
769 "Failed to parse: %s\n",
773 ///if (!Url->IsIP)) // todo dupe me fork ipv6
775 MyQItem->HaveRelay = 1;
786 * Called by smtp_do_queue() to handle an individual message.
788 void smtp_do_procmsg(long msgnum, void *userdata) {
790 int mynumsessions = num_sessions;
791 struct CtdlMessage *msg = NULL;
793 char *Address = NULL;
805 if (mynumsessions > max_sessions_for_outbound_smtp) {
806 SMTPC_syslog(LOG_DEBUG,
807 "skipping because of num jobs %d > %d max_sessions_for_outbound_smtp",
809 max_sessions_for_outbound_smtp);
812 SMTPC_syslog(LOG_DEBUG, "smtp_do_procmsg(%ld)\n", msgnum);
813 ///strcpy(envelope_from, "");
815 msg = CtdlFetchMessage(msgnum, 1);
817 SMTPC_syslog(LOG_ERR, "tried %ld but no such message!\n",
822 pch = instr = msg->cm_fields['M'];
824 /* Strip out the headers (no not amd any other non-instruction) line */
825 while (pch != NULL) {
826 pch = strchr(pch, '\n');
827 if ((pch != NULL) && (*(pch + 1) == '\n')) {
832 PlainQItem = NewStrBufPlain(instr, -1);
833 CtdlFreeMessage(msg);
834 MyQItem = DeserializeQueueItem(PlainQItem, msgnum);
835 FreeStrBuf(&PlainQItem);
837 if (MyQItem == NULL) {
838 SMTPC_syslog(LOG_ERR,
839 "Msg No %ld: already in progress!\n",
841 return; /* s.b. else is already processing... */
845 * Postpone delivery if we've already tried recently.
848 if ((MyQItem->ReattemptWhen != 0) &&
849 (now < MyQItem->ReattemptWhen) &&
850 (run_queue_now == 0))
852 SMTPC_syslog(LOG_DEBUG,
853 "Retry time not yet reached. %ld seconds left.",
854 MyQItem->ReattemptWhen - now);
856 It = GetNewHashPos(MyQItem->MailQEntries, 0);
857 pthread_mutex_lock(&ActiveQItemsLock);
859 if (GetHashPosFromKey(ActiveQItems,
860 LKEY(MyQItem->MessageID),
863 DeleteEntryFromHash(ActiveQItems, It);
866 pthread_mutex_unlock(&ActiveQItemsLock);
867 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
873 * Bail out if there's no actual message associated with this
875 if (MyQItem->MessageID < 0L) {
876 SMTPCM_syslog(LOG_ERR, "no 'msgid' directive found!\n");
877 It = GetNewHashPos(MyQItem->MailQEntries, 0);
878 pthread_mutex_lock(&ActiveQItemsLock);
880 if (GetHashPosFromKey(ActiveQItems,
881 LKEY(MyQItem->MessageID),
884 DeleteEntryFromHash(ActiveQItems, It);
887 pthread_mutex_unlock(&ActiveQItemsLock);
889 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
894 It = GetNewHashPos(MyQItem->MailQEntries, 0);
895 while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
897 MailQEntry *ThisItem = vQE;
898 SMTPC_syslog(LOG_DEBUG, "SMTP Queue: Task: <%s> %d\n",
899 ChrPtr(ThisItem->Recipient),
904 MyQItem->NotYetShutdownDeliveries =
905 MyQItem->ActiveDeliveries = CountActiveQueueEntries(MyQItem);
907 /* failsafe against overload:
908 * will we exceed the limit set?
910 if ((MyQItem->ActiveDeliveries + mynumsessions > max_sessions_for_outbound_smtp) &&
911 /* if yes, did we reach more than half of the quota? */
912 ((mynumsessions * 2) > max_sessions_for_outbound_smtp) &&
913 /* if... would we ever fit into half of the quota?? */
914 (((MyQItem->ActiveDeliveries * 2) < max_sessions_for_outbound_smtp)))
916 /* abort delivery for another time. */
917 SMTPC_syslog(LOG_DEBUG,
918 "SMTP Queue: skipping because of num jobs %d + %ld > %d max_sessions_for_outbound_smtp",
920 MyQItem->ActiveDeliveries,
921 max_sessions_for_outbound_smtp);
923 FreeQueItem(&MyQItem);
929 if (MyQItem->ActiveDeliveries > 0)
931 ParsedURL *RelayUrls = NULL;
934 int m = MyQItem->ActiveDeliveries;
937 Msg = smtp_load_msg(MyQItem, n, &Author, &Address);
938 RelayUrls = LoadRelayUrls(MyQItem, Author, Address);
939 if (Author != NULL) free (Author);
940 if (Address != NULL) free (Address);
942 It = GetNewHashPos(MyQItem->MailQEntries, 0);
944 (GetNextHashPos(MyQItem->MailQEntries,
945 It, &len, &Key, &vQE)))
947 MailQEntry *ThisItem = vQE;
949 if (ThisItem->Active == 1)
951 int KeepBuffers = (i == m);
954 if (nActivated % ndelay_count == 0)
957 if (i > 1) n = MsgCount++;
959 "SMTPC: Trying <%ld> <%s> %d / %d \n",
961 ChrPtr(ThisItem->Recipient),
964 (*((int*) userdata)) ++;
965 smtp_try_one_queue_entry(MyQItem,
972 if (KeepBuffers) HaveBuffers = 1;
981 It = GetNewHashPos(MyQItem->MailQEntries, 0);
982 pthread_mutex_lock(&ActiveQItemsLock);
984 if (GetHashPosFromKey(ActiveQItems,
985 LKEY(MyQItem->MessageID),
988 DeleteEntryFromHash(ActiveQItems, It);
996 SMTPC_syslog(LOG_WARNING,
997 "unable to find QItem with ID[%ld]",
999 while (GetNextHashPos(ActiveQItems,
1005 SMTPC_syslog(LOG_WARNING,
1007 ((OneQueItem *)VData)->MessageID);
1012 pthread_mutex_unlock(&ActiveQItemsLock);
1014 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
1016 // TODO: bounce & delete?
1021 // TODO : free RelayUrls
1028 * smtp_queue_thread()
1030 * Run through the queue sending out messages.
1032 void smtp_do_queue(void) {
1033 int num_processed = 0;
1034 int num_activated = 0;
1036 pthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
1037 SMTPCM_syslog(LOG_INFO, "processing outbound queue");
1039 if (CtdlGetRoom(&CC->room, SMTP_SPOOLOUT_ROOM) != 0) {
1040 SMTPC_syslog(LOG_ERR, "Cannot find room <%s>", SMTP_SPOOLOUT_ROOM);
1043 num_processed = CtdlForEachMessage(MSGS_ALL,
1051 SMTPC_syslog(LOG_INFO,
1052 "queue run completed; %d messages processed %d activated",
1053 num_processed, num_activated);
1060 * Initialize the SMTP outbound queue
1062 void smtp_init_spoolout(void) {
1063 struct ctdlroom qrbuf;
1066 * Create the room. This will silently fail if the room already
1067 * exists, and that's perfectly ok, because we want it to exist.
1069 CtdlCreateRoom(SMTP_SPOOLOUT_ROOM, 3, "", 0, 1, 0, VIEW_QUEUE);
1072 * Make sure it's set to be a "system room" so it doesn't show up
1073 * in the <K>nown rooms list for Aides.
1075 if (CtdlGetRoomLock(&qrbuf, SMTP_SPOOLOUT_ROOM) == 0) {
1076 qrbuf.QRflags2 |= QR2_SYSTEM;
1077 CtdlPutRoomLock(&qrbuf);
1084 /*****************************************************************************/
1085 /* SMTP UTILITY COMMANDS */
1086 /*****************************************************************************/
1088 void cmd_smtp(char *argbuf) {
1095 if (CtdlAccessCheck(ac_aide)) return;
1097 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
1099 if (!strcasecmp(cmd, "mx")) {
1100 extract_token(node, argbuf, 1, '|', sizeof node);
1101 num_mxhosts = getmx(buf, node);
1102 cprintf("%d %d MX hosts listed for %s\n",
1103 LISTING_FOLLOWS, num_mxhosts, node);
1104 for (i=0; i<num_mxhosts; ++i) {
1105 extract_token(node, buf, i, '|', sizeof node);
1106 cprintf("%s\n", node);
1112 else if (!strcasecmp(cmd, "runqueue")) {
1114 cprintf("%d All outbound SMTP will be retried now.\n", CIT_OK);
1119 cprintf("%d Invalid command.\n", ERROR + ILLEGAL_VALUE);
1125 CTDL_MODULE_INIT(smtp_queu)
1131 pstr = getenv("CITSERVER_n_session_max");
1132 if ((pstr != NULL) && (*pstr != '\0'))
1133 max_sessions_for_outbound_smtp = atol(pstr); /* how many sessions might be active till we stop adding more smtp jobs */
1135 pstr = getenv("CITSERVER_smtp_n_delay_count");
1136 if ((pstr != NULL) && (*pstr != '\0'))
1137 ndelay_count = atol(pstr); /* every n queued messages we will sleep... */
1139 pstr = getenv("CITSERVER_smtp_delay");
1140 if ((pstr != NULL) && (*pstr != '\0'))
1141 delay_msec = atol(pstr) * 1000; /* this many seconds. */
1146 CtdlFillSystemContext(&smtp_queue_CC, "SMTP_Send");
1147 ActiveQItems = NewHash(1, lFlathash);
1148 pthread_mutex_init(&ActiveQItemsLock, NULL);
1150 QItemHandlers = NewHash(0, NULL);
1152 RegisterQItemHandler(HKEY("msgid"), QItem_Handle_MsgID);
1153 RegisterQItemHandler(HKEY("envelope_from"), QItem_Handle_EnvelopeFrom);
1154 RegisterQItemHandler(HKEY("retry"), QItem_Handle_retry);
1155 RegisterQItemHandler(HKEY("attempted"), QItem_Handle_Attempted);
1156 RegisterQItemHandler(HKEY("remote"), QItem_Handle_Recipient);
1157 RegisterQItemHandler(HKEY("bounceto"), QItem_Handle_BounceTo);
1158 RegisterQItemHandler(HKEY("source_room"), QItem_Handle_SenderRoom);
1159 RegisterQItemHandler(HKEY("submitted"), QItem_Handle_Submitted);
1161 smtp_init_spoolout();
1163 CtdlRegisterEVCleanupHook(smtp_evq_cleanup);
1165 CtdlRegisterProtoHook(cmd_smtp, "SMTP", "SMTP utility commands");
1166 CtdlRegisterSessionHook(smtp_do_queue, EVT_TIMER, PRIO_SEND + 10);
1169 /* return our Subversion id for the Log */
1170 return "smtpeventclient";