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, char **Author, char **Address)
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                       Author,
492                       Address);
493
494         SendMsg = CCC->redirect_buffer;
495         CCC->redirect_buffer = NULL;
496         if ((StrLength(SendMsg) > 0) &&
497             ChrPtr(SendMsg)[StrLength(SendMsg) - 1] != '\n') {
498                 SMTPC_syslog(LOG_WARNING,
499                              "[%d] Possible problem: message did not "
500                              "correctly terminate. (expecting 0x10, got 0x%02x)\n",
501                              MsgCount, //yes uncool, but best choice here...
502                              ChrPtr(SendMsg)[StrLength(SendMsg) - 1] );
503                 StrBufAppendBufPlain(SendMsg, HKEY("\r\n"), 0);
504         }
505         return SendMsg;
506 }
507
508
509
510 /*
511  * smtp_do_bounce() is caled by smtp_do_procmsg() to scan a set of delivery
512  * instructions for "5" codes (permanent fatal errors) and produce/deliver
513  * a "bounce" message (delivery status notification).
514  */
515 void smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt)
516 {
517         static int seq = 0;
518
519         struct CtdlMessage *bmsg = NULL;
520         StrBuf *boundary;
521         StrBuf *Msg = NULL;
522         StrBuf *BounceMB;
523         struct recptypes *valid;
524         time_t now;
525
526         HashPos *It;
527         void *vQE;
528         long len;
529         const char *Key;
530
531         int first_attempt = 0;
532         int successful_bounce = 0;
533         int num_bounces = 0;
534         int give_up = 0;
535
536         SMTPCM_syslog(LOG_DEBUG, "smtp_do_bounce() called\n");
537
538         if (MyQItem->SendBounceMail == 0)
539                 return;
540
541         now = time (NULL); //ev_time();
542
543         if ( (now - MyQItem->Submitted) > SMTP_GIVE_UP ) {
544                 give_up = 1;
545         }
546
547         if (MyQItem->Retry == SMTP_RETRY_INTERVAL) {
548                 first_attempt = 1;
549         }
550
551         /*
552          * Now go through the instructions checking for stuff.
553          */
554         Msg = NewStrBufPlain(NULL, 1024);
555         It = GetNewHashPos(MyQItem->MailQEntries, 0);
556         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
557         {
558                 MailQEntry *ThisItem = vQE;
559                 if ((ThisItem->Active && (ThisItem->Status == 5)) || /* failed now? */
560                     ((give_up == 1) && (ThisItem->Status != 2)) ||
561                     ((first_attempt == 1) && (ThisItem->Status != 2)))
562                         /* giving up after failed attempts... */
563                 {
564                         ++num_bounces;
565
566                         StrBufAppendBuf(Msg, ThisItem->Recipient, 0);
567                         StrBufAppendBufPlain(Msg, HKEY(": "), 0);
568                         StrBufAppendBuf(Msg, ThisItem->StatusMessage, 0);
569                         StrBufAppendBufPlain(Msg, HKEY("\r\n"), 0);
570                 }
571         }
572         DeleteHashPos(&It);
573
574         /* Deliver the bounce if there's anything worth mentioning */
575         SMTPC_syslog(LOG_DEBUG, "num_bounces = %d\n", num_bounces);
576
577         if (num_bounces == 0) {
578                 FreeStrBuf(&Msg);
579                 return;
580         }
581
582         boundary = NewStrBufPlain(HKEY("=_Citadel_Multipart_"));
583         StrBufAppendPrintf(boundary,
584                            "%s_%04x%04x",
585                            config.c_fqdn,
586                            getpid(),
587                            ++seq);
588
589         /* Start building our bounce message; go shopping for memory first. */
590         BounceMB = NewStrBufPlain(
591                 NULL,
592                 1024 + /* mime stuff.... */
593                 StrLength(Msg) +  /* the bounce information... */
594                 StrLength(OMsgTxt)); /* the original message */
595         if (BounceMB == NULL) {
596                 FreeStrBuf(&boundary);
597                 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
598
599                 return;
600         }
601
602         bmsg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
603         if (bmsg == NULL) {
604                 FreeStrBuf(&boundary);
605                 FreeStrBuf(&BounceMB);
606                 SMTPCM_syslog(LOG_ERR, "Failed to alloc() bounce message.\n");
607
608                 return;
609         }
610         memset(bmsg, 0, sizeof(struct CtdlMessage));
611
612
613         StrBufAppendBufPlain(BounceMB, HKEY("Content-type: multipart/mixed; boundary=\""), 0);
614         StrBufAppendBuf(BounceMB, boundary, 0);
615         StrBufAppendBufPlain(BounceMB, HKEY("\"\r\n"), 0);
616         StrBufAppendBufPlain(BounceMB, HKEY("MIME-Version: 1.0\r\n"), 0);
617         StrBufAppendBufPlain(BounceMB, HKEY("X-Mailer: " CITADEL "\r\n"), 0);
618         StrBufAppendBufPlain(BounceMB, HKEY("\r\nThis is a multipart message in MIME format.\r\n\r\n"), 0);
619         StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
620         StrBufAppendBuf(BounceMB, boundary, 0);
621         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
622         StrBufAppendBufPlain(BounceMB, HKEY("Content-type: text/plain\r\n\r\n"), 0);
623
624         if (give_up)
625                 StrBufAppendBufPlain(
626                         BounceMB,
627                         HKEY(
628                                 "A message you sent could not be delivered "
629                                 "to some or all of its recipients\n"
630                                 "due to prolonged unavailability "
631                                 "of its destination(s).\n"
632                                 "Giving up on the following addresses:\n\n"
633                                 ), 0);
634         else
635                 StrBufAppendBufPlain(
636                         BounceMB,
637                         HKEY(
638                                 "A message you sent could not be delivered "
639                                 "to some or all of its recipients.\n"
640                                 "The following addresses "
641                                 "were undeliverable:\n\n"
642                                 ), 0);
643
644         StrBufAppendBuf(BounceMB, Msg, 0);
645         FreeStrBuf(&Msg);
646
647         if (StrLength(MyQItem->SenderRoom) > 0)
648         {
649                 StrBufAppendBufPlain(
650                         BounceMB,
651                         HKEY("The message was originaly posted in: "), 0);
652                 StrBufAppendBuf(BounceMB, MyQItem->SenderRoom, 0);
653                 StrBufAppendBufPlain(
654                         BounceMB,
655                         HKEY("\n"), 0);
656         }
657
658         /* Attach the original message */
659         StrBufAppendBufPlain(BounceMB, HKEY("\r\n--"), 0);
660         StrBufAppendBuf(BounceMB, boundary, 0);
661         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
662         StrBufAppendBufPlain(BounceMB,
663                              HKEY("Content-type: message/rfc822\r\n"), 0);
664         StrBufAppendBufPlain(BounceMB,
665                              HKEY("Content-Transfer-Encoding: 7bit\r\n"), 0);
666         StrBufAppendBufPlain(BounceMB,
667                              HKEY("Content-Disposition: inline\r\n"), 0);
668         StrBufAppendBufPlain(BounceMB, HKEY("\r\n"), 0);
669         StrBufAppendBuf(BounceMB, OMsgTxt, 0);
670
671         /* Close the multipart MIME scope */
672         StrBufAppendBufPlain(BounceMB, HKEY("--"), 0);
673         StrBufAppendBuf(BounceMB, boundary, 0);
674         StrBufAppendBufPlain(BounceMB, HKEY("--\r\n"), 0);
675
676         bmsg->cm_magic = CTDLMESSAGE_MAGIC;
677         bmsg->cm_anon_type = MES_NORMAL;
678         bmsg->cm_format_type = FMT_RFC822;
679
680         bmsg->cm_fields['O'] = strdup(MAILROOM);
681         bmsg->cm_fields['A'] = strdup("Citadel");
682         bmsg->cm_fields['N'] = strdup(config.c_nodename);
683         bmsg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
684         bmsg->cm_fields['M'] = SmashStrBuf(&BounceMB);
685
686         /* First try the user who sent the message */
687         if (StrLength(MyQItem->BounceTo) == 0) {
688                 SMTPCM_syslog(LOG_ERR, "No bounce address specified\n");
689         }
690         else {
691                 SMTPC_syslog(LOG_DEBUG, "bounce to user? <%s>\n",
692                        ChrPtr(MyQItem->BounceTo));
693         }
694
695         /* Can we deliver the bounce to the original sender? */
696         valid = validate_recipients(ChrPtr(MyQItem->BounceTo), NULL, 0);
697         if ((valid != NULL) && (valid->num_error == 0)) {
698                 CtdlSubmitMsg(bmsg, valid, "", QP_EADDR);
699                 successful_bounce = 1;
700         }
701
702         /* If not, post it in the Aide> room */
703         if (successful_bounce == 0) {
704                 CtdlSubmitMsg(bmsg, NULL, config.c_aideroom, QP_EADDR);
705         }
706
707         /* Free up the memory we used */
708         free_recipients(valid);
709         FreeStrBuf(&boundary);
710         CtdlFreeMessage(bmsg);
711         SMTPCM_syslog(LOG_DEBUG, "Done processing bounces\n");
712 }
713
714 ParsedURL *LoadRelayUrls(OneQueItem *MyQItem,
715                          char *Author,
716                          char *Address)
717 {
718         int nRelays = 0;
719         ParsedURL *RelayUrls = NULL;
720         char mxbuf[SIZ];
721         ParsedURL **Url = &MyQItem->URL;
722
723         nRelays = get_hosts(mxbuf, "fallbackhost");
724         if (nRelays > 0) {
725                 StrBuf *All;
726                 StrBuf *One;
727                 const char *Pos = NULL;
728                 All = NewStrBufPlain(mxbuf, -1);
729                 One = NewStrBufPlain(NULL, StrLength(All) + 1);
730                 
731                 while ((Pos != StrBufNOTNULL) &&
732                        ((Pos == NULL) ||
733                         !IsEmptyStr(Pos)))
734                 {
735                         StrBufExtract_NextToken(One, All, &Pos, '|');
736                         if (!ParseURL(Url, One, DefaultMXPort)) {
737                                 SMTPC_syslog(LOG_DEBUG,
738                                              "Failed to parse: %s\n",
739                                              ChrPtr(One));
740                         }
741                         else {
742                                 (*Url)->IsRelay = 1;
743                                 MyQItem->HaveRelay = 1;
744                         }
745                 }
746                 FreeStrBuf(&All);
747                 FreeStrBuf(&One);
748         }
749         nRelays = get_hosts(mxbuf, "smarthost");
750         if (nRelays > 0) {
751                 char *User;
752                 StrBuf *All;
753                 StrBuf *One;
754                 const char *Pos = NULL;
755                 All = NewStrBufPlain(mxbuf, -1);
756                 One = NewStrBufPlain(NULL, StrLength(All) + 1);
757                 
758                 while ((Pos != StrBufNOTNULL) &&
759                        ((Pos == NULL) ||
760                         !IsEmptyStr(Pos)))
761                 {
762                         StrBufExtract_NextToken(One, All, &Pos, '|');
763                         User = strchr(ChrPtr(One), ' ');
764                         if (User != NULL) {
765                                 if (!strcmp(User + 1, Author) ||
766                                     !strcmp(User + 1, Address))
767                                         StrBufCutAt(One, 0, User);
768                                 else
769                                         continue;
770
771                         }
772                         if (!ParseURL(Url, One, DefaultMXPort)) {
773                                 SMTPC_syslog(LOG_DEBUG,
774                                              "Failed to parse: %s\n",
775                                              ChrPtr(One));
776                         }
777                         else {
778                                 ///if (!Url->IsIP)) // todo dupe me fork ipv6
779                                 (*Url)->IsRelay = 1;
780                                 MyQItem->HaveRelay = 1;
781                         }
782                 }
783                 FreeStrBuf(&All);
784                 FreeStrBuf(&One);
785         }
786         return RelayUrls;
787 }
788 /*
789  * smtp_do_procmsg()
790  *
791  * Called by smtp_do_queue() to handle an individual message.
792  */
793 void smtp_do_procmsg(long msgnum, void *userdata) {
794         time_t now;
795         int mynumsessions = num_sessions;
796         struct CtdlMessage *msg = NULL;
797         char *Author = NULL;
798         char *Address = NULL;
799         char *instr = NULL;
800         StrBuf *PlainQItem;
801         OneQueItem *MyQItem;
802         char *pch;
803         HashPos  *It;
804         void *vQE;
805         long len;
806         const char *Key;
807         int HaveBuffers = 0;
808         StrBuf *Msg =NULL;
809
810         if (mynumsessions > max_sessions_for_outbound_smtp) {
811                 SMTPC_syslog(LOG_DEBUG,
812                              "skipping because of num jobs %d > %d max_sessions_for_outbound_smtp",
813                              mynumsessions,
814                              max_sessions_for_outbound_smtp);
815         }
816
817         SMTPC_syslog(LOG_DEBUG, "smtp_do_procmsg(%ld)\n", msgnum);
818         ///strcpy(envelope_from, "");
819
820         msg = CtdlFetchMessage(msgnum, 1);
821         if (msg == NULL) {
822                 SMTPC_syslog(LOG_ERR, "tried %ld but no such message!\n",
823                        msgnum);
824                 return;
825         }
826
827         pch = instr = msg->cm_fields['M'];
828
829         /* Strip out the headers (no not amd any other non-instruction) line */
830         while (pch != NULL) {
831                 pch = strchr(pch, '\n');
832                 if ((pch != NULL) && (*(pch + 1) == '\n')) {
833                         instr = pch + 2;
834                         pch = NULL;
835                 }
836         }
837         PlainQItem = NewStrBufPlain(instr, -1);
838         CtdlFreeMessage(msg);
839         MyQItem = DeserializeQueueItem(PlainQItem, msgnum);
840         FreeStrBuf(&PlainQItem);
841
842         if (MyQItem == NULL) {
843                 SMTPC_syslog(LOG_ERR,
844                              "Msg No %ld: already in progress!\n",
845                              msgnum);
846                 return; /* s.b. else is already processing... */
847         }
848
849         /*
850          * Postpone delivery if we've already tried recently.
851          */
852         now = time(NULL);
853         if ((MyQItem->ReattemptWhen != 0) && 
854             (now < MyQItem->ReattemptWhen) &&
855             (run_queue_now == 0))
856         {
857                 SMTPC_syslog(LOG_DEBUG, 
858                              "Retry time not yet reached. %ld seconds left.",
859                              MyQItem->ReattemptWhen - now);
860
861                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
862                 pthread_mutex_lock(&ActiveQItemsLock);
863                 {
864                         if (GetHashPosFromKey(ActiveQItems,
865                                               LKEY(MyQItem->MessageID),
866                                               It))
867                         {
868                                 DeleteEntryFromHash(ActiveQItems, It);
869                         }
870                 }
871                 pthread_mutex_unlock(&ActiveQItemsLock);
872                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
873                 DeleteHashPos(&It);
874                 return;
875         }
876
877         /*
878          * Bail out if there's no actual message associated with this
879          */
880         if (MyQItem->MessageID < 0L) {
881                 SMTPCM_syslog(LOG_ERR, "no 'msgid' directive found!\n");
882                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
883                 pthread_mutex_lock(&ActiveQItemsLock);
884                 {
885                         if (GetHashPosFromKey(ActiveQItems,
886                                               LKEY(MyQItem->MessageID),
887                                               It))
888                         {
889                                 DeleteEntryFromHash(ActiveQItems, It);
890                         }
891                 }
892                 pthread_mutex_unlock(&ActiveQItemsLock);
893                 DeleteHashPos(&It);
894                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
895                 return;
896         }
897
898
899         It = GetNewHashPos(MyQItem->MailQEntries, 0);
900         while (GetNextHashPos(MyQItem->MailQEntries, It, &len, &Key, &vQE))
901         {
902                 MailQEntry *ThisItem = vQE;
903                 SMTPC_syslog(LOG_DEBUG, "SMTP Queue: Task: <%s> %d\n",
904                              ChrPtr(ThisItem->Recipient),
905                              ThisItem->Active);
906         }
907         DeleteHashPos(&It);
908
909         MyQItem->NotYetShutdownDeliveries = 
910                 MyQItem->ActiveDeliveries = CountActiveQueueEntries(MyQItem, 1);
911
912         /* failsafe against overload: 
913          * will we exceed the limit set? 
914          */
915         if ((MyQItem->ActiveDeliveries + mynumsessions > max_sessions_for_outbound_smtp) && 
916             /* if yes, did we reach more than half of the quota? */
917             ((mynumsessions * 2) > max_sessions_for_outbound_smtp) && 
918             /* if... would we ever fit into half of the quota?? */
919             (((MyQItem->ActiveDeliveries * 2)  < max_sessions_for_outbound_smtp)))
920         {
921                 /* abort delivery for another time. */
922                 SMTPC_syslog(LOG_DEBUG,
923                              "SMTP Queue: skipping because of num jobs %d + %ld > %d max_sessions_for_outbound_smtp",
924                              mynumsessions,
925                              MyQItem->ActiveDeliveries,
926                              max_sessions_for_outbound_smtp);
927
928                 FreeQueItem(&MyQItem);
929
930                 return;
931         }
932
933
934         if (MyQItem->ActiveDeliveries > 0)
935         {
936                 ParsedURL *RelayUrls = NULL;
937                 int nActivated = 0;
938                 int n = MsgCount++;
939                 int m = MyQItem->ActiveDeliveries;
940                 int i = 1;
941
942                 Msg = smtp_load_msg(MyQItem, n, &Author, &Address);
943                 RelayUrls = LoadRelayUrls(MyQItem, Author, Address);
944                 if (Author != NULL) free (Author);
945                 if (Address != NULL) free (Address);
946
947                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
948                 while ((i <= m) &&
949                        (GetNextHashPos(MyQItem->MailQEntries,
950                                        It, &len, &Key, &vQE)))
951                 {
952                         MailQEntry *ThisItem = vQE;
953
954                         if (ThisItem->Active == 1)
955                         {
956                                 int KeepBuffers = (i == m);
957
958                                 nActivated++;
959                                 if (nActivated % ndelay_count == 0)
960                                         usleep(delay_msec);
961
962                                 if (i > 1) n = MsgCount++;
963                                 syslog(LOG_DEBUG,
964                                        "SMTPC: Trying <%ld> <%s> %d / %d \n",
965                                        MyQItem->MessageID,
966                                        ChrPtr(ThisItem->Recipient),
967                                        i,
968                                        m);
969                                 (*((int*) userdata)) ++;
970                                 smtp_try_one_queue_entry(MyQItem,
971                                                          ThisItem,
972                                                          Msg,
973                                                          KeepBuffers,
974                                                          n,
975                                                          RelayUrls);
976
977                                 if (KeepBuffers) HaveBuffers = 1;
978
979                                 i++;
980                         }
981                 }
982                 DeleteHashPos(&It);
983         }
984         else
985         {
986                 It = GetNewHashPos(MyQItem->MailQEntries, 0);
987                 pthread_mutex_lock(&ActiveQItemsLock);
988                 {
989                         if (GetHashPosFromKey(ActiveQItems,
990                                               LKEY(MyQItem->MessageID),
991                                               It))
992                         {
993                                 DeleteEntryFromHash(ActiveQItems, It);
994                         }
995                         else
996                         {
997                                 long len;
998                                 const char* Key;
999                                 void *VData;
1000
1001                                 SMTPC_syslog(LOG_WARNING,
1002                                              "unable to find QItem with ID[%ld]",
1003                                              MyQItem->MessageID);
1004                                 while (GetNextHashPos(ActiveQItems,
1005                                                       It,
1006                                                       &len,
1007                                                       &Key,
1008                                                       &VData))
1009                                 {
1010                                         SMTPC_syslog(LOG_WARNING,
1011                                                      "have: ID[%ld]",
1012                                                      ((OneQueItem *)VData)->MessageID);
1013                                 }
1014                         }
1015
1016                 }
1017                 pthread_mutex_unlock(&ActiveQItemsLock);
1018                 DeleteHashPos(&It);
1019                 ////FreeQueItem(&MyQItem); TODO: DeleteEntryFromHash frees this?
1020
1021 // TODO: bounce & delete?
1022
1023         }
1024         if (!HaveBuffers) {
1025                 FreeStrBuf (&Msg);
1026 // TODO : free RelayUrls
1027         }
1028 }
1029
1030
1031
1032 /*
1033  * smtp_queue_thread()
1034  *
1035  * Run through the queue sending out messages.
1036  */
1037 void smtp_do_queue(void) {
1038         int num_processed = 0;
1039         int num_activated = 0;
1040
1041         pthread_setspecific(MyConKey, (void *)&smtp_queue_CC);
1042         SMTPCM_syslog(LOG_INFO, "processing outbound queue");
1043
1044         if (CtdlGetRoom(&CC->room, SMTP_SPOOLOUT_ROOM) != 0) {
1045                 SMTPC_syslog(LOG_ERR, "Cannot find room <%s>", SMTP_SPOOLOUT_ROOM);
1046         }
1047         else {
1048                 num_processed = CtdlForEachMessage(MSGS_ALL,
1049                                                    0L,
1050                                                    NULL,
1051                                                    SPOOLMIME,
1052                                                    NULL,
1053                                                    smtp_do_procmsg,
1054                                                    &num_activated);
1055         }
1056         SMTPC_syslog(LOG_INFO,
1057                      "queue run completed; %d messages processed %d activated",
1058                      num_processed, num_activated);
1059
1060 }
1061
1062
1063
1064 /*
1065  * Initialize the SMTP outbound queue
1066  */
1067 void smtp_init_spoolout(void) {
1068         struct ctdlroom qrbuf;
1069
1070         /*
1071          * Create the room.  This will silently fail if the room already
1072          * exists, and that's perfectly ok, because we want it to exist.
1073          */
1074         CtdlCreateRoom(SMTP_SPOOLOUT_ROOM, 3, "", 0, 1, 0, VIEW_QUEUE);
1075
1076         /*
1077          * Make sure it's set to be a "system room" so it doesn't show up
1078          * in the <K>nown rooms list for Aides.
1079          */
1080         if (CtdlGetRoomLock(&qrbuf, SMTP_SPOOLOUT_ROOM) == 0) {
1081                 qrbuf.QRflags2 |= QR2_SYSTEM;
1082                 CtdlPutRoomLock(&qrbuf);
1083         }
1084 }
1085
1086
1087
1088
1089 /*****************************************************************************/
1090 /*                          SMTP UTILITY COMMANDS                            */
1091 /*****************************************************************************/
1092
1093 void cmd_smtp(char *argbuf) {
1094         char cmd[64];
1095         char node[256];
1096         char buf[1024];
1097         int i;
1098         int num_mxhosts;
1099
1100         if (CtdlAccessCheck(ac_aide)) return;
1101
1102         extract_token(cmd, argbuf, 0, '|', sizeof cmd);
1103
1104         if (!strcasecmp(cmd, "mx")) {
1105                 extract_token(node, argbuf, 1, '|', sizeof node);
1106                 num_mxhosts = getmx(buf, node);
1107                 cprintf("%d %d MX hosts listed for %s\n",
1108                         LISTING_FOLLOWS, num_mxhosts, node);
1109                 for (i=0; i<num_mxhosts; ++i) {
1110                         extract_token(node, buf, i, '|', sizeof node);
1111                         cprintf("%s\n", node);
1112                 }
1113                 cprintf("000\n");
1114                 return;
1115         }
1116
1117         else if (!strcasecmp(cmd, "runqueue")) {
1118                 run_queue_now = 1;
1119                 cprintf("%d All outbound SMTP will be retried now.\n", CIT_OK);
1120                 return;
1121         }
1122
1123         else {
1124                 cprintf("%d Invalid command.\n", ERROR + ILLEGAL_VALUE);
1125         }
1126
1127 }
1128
1129
1130 CTDL_MODULE_INIT(smtp_queu)
1131 {
1132         char *pstr;
1133
1134         if (!threading)
1135         {
1136                 pstr = getenv("CITSERVER_n_session_max");
1137                 if ((pstr != NULL) && (*pstr != '\0'))
1138                         max_sessions_for_outbound_smtp = atol(pstr); /* how many sessions might be active till we stop adding more smtp jobs */
1139
1140                 pstr = getenv("CITSERVER_smtp_n_delay_count");
1141                 if ((pstr != NULL) && (*pstr != '\0'))
1142                         ndelay_count = atol(pstr); /* every n queued messages we will sleep... */
1143
1144                 pstr = getenv("CITSERVER_smtp_delay");
1145                 if ((pstr != NULL) && (*pstr != '\0'))
1146                         delay_msec = atol(pstr) * 1000; /* this many seconds. */
1147
1148
1149
1150
1151                 CtdlFillSystemContext(&smtp_queue_CC, "SMTP_Send");
1152                 ActiveQItems = NewHash(1, lFlathash);
1153                 pthread_mutex_init(&ActiveQItemsLock, NULL);
1154
1155                 QItemHandlers = NewHash(0, NULL);
1156
1157                 RegisterQItemHandler(HKEY("msgid"),             QItem_Handle_MsgID);
1158                 RegisterQItemHandler(HKEY("envelope_from"),     QItem_Handle_EnvelopeFrom);
1159                 RegisterQItemHandler(HKEY("retry"),             QItem_Handle_retry);
1160                 RegisterQItemHandler(HKEY("attempted"),         QItem_Handle_Attempted);
1161                 RegisterQItemHandler(HKEY("remote"),            QItem_Handle_Recipient);
1162                 RegisterQItemHandler(HKEY("bounceto"),          QItem_Handle_BounceTo);
1163                 RegisterQItemHandler(HKEY("source_room"),       QItem_Handle_SenderRoom);
1164                 RegisterQItemHandler(HKEY("submitted"),         QItem_Handle_Submitted);
1165
1166                 smtp_init_spoolout();
1167
1168                 CtdlRegisterEVCleanupHook(smtp_evq_cleanup);
1169
1170                 CtdlRegisterProtoHook(cmd_smtp, "SMTP", "SMTP utility commands");
1171                 CtdlRegisterSessionHook(smtp_do_queue, EVT_TIMER, PRIO_SEND + 10);
1172         }
1173
1174         /* return our Subversion id for the Log */
1175         return "smtpeventclient";
1176 }