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