b8081fa2c396369514685f9f3c280fa80a9dc9e7
[citadel.git] / citadel / modules / smtp / serv_smtpclient.c
1 /*
2  * Transmit outbound SMTP mail to the big wide world of the Internet
3  *
4  * This is the new, exciting, clever version that makes libcurl do all the work  :)
5  *
6  * Copyright (c) 1997-2018 by the citadel.org team
7  *
8  * This program is open source software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as published
10  * by the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  */
18
19 #include <stdlib.h>
20 #include <unistd.h>
21 #include <stdio.h>
22 #include <sysconfig.h>
23
24 #if TIME_WITH_SYS_TIME
25 #include <sys/time.h>
26 #include <time.h>
27 #else
28 #if HAVE_SYS_TIME_H
29 #include <sys/time.h>
30 #else
31 #include <time.h>
32 #endif
33 #endif
34
35 #include <ctype.h>
36 #include <string.h>
37 #include <errno.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <libcitadel.h>
41 #include <curl/curl.h>
42 #include "citadel.h"
43 #include "server.h"
44 #include "citserver.h"
45 #include "support.h"
46 #include "config.h"
47 #include "ctdl_module.h"
48 #include "clientsocket.h"
49 #include "msgbase.h"
50 #include "domain.h"
51 #include "internet_addressing.h"
52 #include "citadel_dirs.h"
53 #include "modules/smtp/smtp_util.h"
54
55 struct smtpmsgsrc {             // Data passed in and out of libcurl for message upload
56         StrBuf *TheMessage;
57         int bytes_total;
58         int bytes_sent;
59 };
60
61 struct CitContext smtp_client_CC;
62 static int doing_smtpclient = 0;
63 long *smtpq = NULL;             // array of msgnums containing queue instructions
64 int smtpq_count = 0;            // number of queue messages in smtpq
65 int smtpq_alloc = 0;            // current allocation size for smtpq
66
67
68 /*
69  * Initialize the SMTP outbound queue
70  */
71 void smtp_init_spoolout(void)
72 {
73         struct ctdlroom qrbuf;
74
75         /*
76          * Create the room.  This will silently fail if the room already
77          * exists, and that's perfectly ok, because we want it to exist.
78          */
79         CtdlCreateRoom(SMTP_SPOOLOUT_ROOM, 3, "", 0, 1, 0, VIEW_QUEUE);
80
81         /*
82          * Make sure it's set to be a "system room" so it doesn't show up
83          * in the <K>nown rooms list for administrators.
84          */
85         if (CtdlGetRoomLock(&qrbuf, SMTP_SPOOLOUT_ROOM) == 0) {
86                 qrbuf.QRflags2 |= QR2_SYSTEM;
87                 CtdlPutRoomLock(&qrbuf);
88         }
89 }
90
91
92 /* For internet mail, generate delivery instructions.
93  * Yes, this is recursive.  Deal with it.  Infinite recursion does
94  * not happen because the delivery instructions message does not
95  * contain a recipient.
96  */
97 int smtp_aftersave(struct CtdlMessage *msg, recptypes * recps)
98 {
99         if ((recps != NULL) && (recps->num_internet > 0)) {
100                 struct CtdlMessage *imsg = NULL;
101                 char recipient[SIZ];
102                 StrBuf *SpoolMsg = NewStrBuf();
103                 long nTokens;
104                 int i;
105
106                 syslog(LOG_DEBUG, "smtpclient: generating delivery instructions");
107
108                 StrBufPrintf(SpoolMsg,
109                              "Content-type: " SPOOLMIME "\n"
110                              "\n"
111                              "msgid|%s\n"
112                              "submitted|%ld\n" "bounceto|%s\n", msg->cm_fields[eVltMsgNum], (long) time(NULL), recps->bounce_to);
113
114                 if (recps->envelope_from != NULL) {
115                         StrBufAppendBufPlain(SpoolMsg, HKEY("envelope_from|"), 0);
116                         StrBufAppendBufPlain(SpoolMsg, recps->envelope_from, -1, 0);
117                         StrBufAppendBufPlain(SpoolMsg, HKEY("\n"), 0);
118                 }
119                 if (recps->sending_room != NULL) {
120                         StrBufAppendBufPlain(SpoolMsg, HKEY("source_room|"), 0);
121                         StrBufAppendBufPlain(SpoolMsg, recps->sending_room, -1, 0);
122                         StrBufAppendBufPlain(SpoolMsg, HKEY("\n"), 0);
123                 }
124
125                 nTokens = num_tokens(recps->recp_internet, '|');
126                 for (i = 0; i < nTokens; i++) {
127                         long len;
128                         len = extract_token(recipient, recps->recp_internet, i, '|', sizeof recipient);
129                         if (len > 0) {
130                                 StrBufAppendBufPlain(SpoolMsg, HKEY("remote|"), 0);
131                                 StrBufAppendBufPlain(SpoolMsg, recipient, len, 0);
132                                 StrBufAppendBufPlain(SpoolMsg, HKEY("|0||\n"), 0);
133                         }
134                 }
135
136                 imsg = malloc(sizeof(struct CtdlMessage));
137                 memset(imsg, 0, sizeof(struct CtdlMessage));
138                 imsg->cm_magic = CTDLMESSAGE_MAGIC;
139                 imsg->cm_anon_type = MES_NORMAL;
140                 imsg->cm_format_type = FMT_RFC822;
141                 CM_SetField(imsg, eMsgSubject, HKEY("QMSG"));
142                 CM_SetField(imsg, eAuthor, HKEY("Citadel"));
143                 CM_SetField(imsg, eJournal, HKEY("do not journal"));
144                 CM_SetAsFieldSB(imsg, eMesageText, &SpoolMsg);
145                 CtdlSubmitMsg(imsg, NULL, SMTP_SPOOLOUT_ROOM, QP_EADDR);
146                 CM_Free(imsg);
147         }
148         return 0;
149 }
150
151
152 /*
153  * Callback for smtp_attempt_delivery() to supply libcurl with upload data.
154  */
155 static size_t upload_source(void *ptr, size_t size, size_t nmemb, void *userp)
156 {
157         struct smtpmsgsrc *s = (struct smtpmsgsrc *) userp;
158         int sendbytes = 0;
159         const char *send_this = NULL;
160
161         sendbytes = (size * nmemb);
162
163         if (s->bytes_sent >= s->bytes_total) {
164                 return (0);     // no data remaining; we are done
165         }
166
167         if (sendbytes > (s->bytes_total - s->bytes_sent)) {
168                 sendbytes = s->bytes_total - s->bytes_sent;     // can't send more than we have
169         }
170
171         send_this = ChrPtr(s->TheMessage);
172         send_this += s->bytes_sent;     // start where we last left off
173
174         memcpy(ptr, send_this, sendbytes);
175         s->bytes_sent += sendbytes;
176         return (sendbytes);     // return the number of bytes _actually_ copied
177 }
178
179
180 /*
181  * The libcurl API doesn't provide a way to capture the actual SMTP result message returned
182  * by the remote server.  This is an ugly way to extract it, by capturing debug data from
183  * the library and filtering on the lines we want.
184  */
185 int ctdl_libcurl_smtp_debug_callback(CURL * handle, curl_infotype type, char *data, size_t size, void *userptr)
186 {
187         if (type != CURLINFO_HEADER_IN)
188                 return 0;
189         if (!userptr)
190                 return 0;
191         char *debugbuf = (char *) userptr;
192
193         int len = strlen(debugbuf);
194         if (len + size > SIZ)
195                 return 0;
196
197         memcpy(&debugbuf[len], data, size);
198         debugbuf[len + size] = 0;
199         return 0;
200 }
201
202
203 /*
204  * Attempt a delivery to one recipient.
205  * Returns a three-digit SMTP status code.
206  */
207 int smtp_attempt_delivery(long msgid, char *recp, char *envelope_from, char *response)
208 {
209         struct smtpmsgsrc s;
210         char *fromaddr = NULL;
211         CURL *curl;
212         CURLcode res = CURLE_OK;
213         struct curl_slist *recipients = NULL;
214         long response_code = 421;
215         int num_mx = 0;
216         char mxes[SIZ];
217         char user[1024];
218         char node[1024];
219         char name[1024];
220         char try_this_mx[256];
221         char smtp_url[512];
222         int i;
223
224         syslog(LOG_DEBUG, "smtpclient: smtp_attempt_delivery(%ld, %s)", msgid, recp);
225
226         process_rfc822_addr(recp, user, node, name);    // split recipient address into username, hostname, displayname
227         num_mx = getmx(mxes, node);
228         if (num_mx < 1) {
229                 return (421);
230         }
231
232         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
233         CtdlOutputMsg(msgid, MT_RFC822, HEADERS_ALL, 0, 1, NULL, 0, NULL, &fromaddr, NULL);
234         s.TheMessage = CC->redirect_buffer;
235         s.bytes_total = StrLength(CC->redirect_buffer);
236         s.bytes_sent = 0;
237         CC->redirect_buffer = NULL;
238         response_code = 421;
239
240         for (i = 0; ((i < num_mx) && ((response_code / 100) == 4)); ++i) {      // keep trying MXes until one works or we run out
241                 response_code = 421;    // default 421 makes non-protocol errors transient
242                 s.bytes_sent = 0;       // rewind our buffer in case we try multiple MXes
243
244                 curl = curl_easy_init();
245                 if (curl) {
246                         response[0] = 0;
247
248                         if (!IsEmptyStr(envelope_from)) {
249                                 curl_easy_setopt(curl, CURLOPT_MAIL_FROM, envelope_from);
250                         } else {
251                                 curl_easy_setopt(curl, CURLOPT_MAIL_FROM, fromaddr);
252                         }
253
254                         recipients = curl_slist_append(recipients, recp);
255                         curl_easy_setopt(curl, CURLOPT_MAIL_RCPT, recipients);
256                         curl_easy_setopt(curl, CURLOPT_READFUNCTION, upload_source);
257                         curl_easy_setopt(curl, CURLOPT_READDATA, &s);
258                         curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);      // tell libcurl we are uploading
259                         curl_easy_setopt(curl, CURLOPT_TIMEOUT, 20L);   // Time out after 20 seconds
260                         if (CtdlGetConfigInt("c_smtpclient_disable_starttls") == 0) {
261                                 curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);        // Attempt STARTTLS if offered
262                         }
263                         curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
264                         curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
265                         curl_easy_setopt(curl, CURLOPT_DEBUGFUNCTION, ctdl_libcurl_smtp_debug_callback);
266                         curl_easy_setopt(curl, CURLOPT_DEBUGDATA, (void *) response);
267                         curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
268
269                         // Construct an SMTP URL in the form of:
270                         //      smtp[s]://target_host/source_host
271                         // This looks weird but libcurl uses that last part to set our name for EHLO or HELO.
272                         // We check for "smtp://" and "smtps://" because the admin may have put those prefixes in a smart-host entry.
273                         // If there is no prefix we add "smtp://"
274                         extract_token(try_this_mx, mxes, i, '|', (sizeof try_this_mx - 7));
275                         snprintf(smtp_url, sizeof smtp_url, "%s%s/%s", (((!strncasecmp(try_this_mx, HKEY("smtp://")))
276                                                                          ||
277                                                                          (!strncasecmp
278                                                                           (try_this_mx,
279                                                                            HKEY("smtps://")))) ? "" : "smtp://"),
280                                  try_this_mx, CtdlGetConfigStr("c_fqdn")
281                             );
282                         curl_easy_setopt(curl, CURLOPT_URL, smtp_url);
283                         syslog(LOG_DEBUG, "smtpclient: trying %s", smtp_url);   // send the message
284                         res = curl_easy_perform(curl);
285                         curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);
286                         syslog(LOG_DEBUG,
287                                "smtpclient: libcurl returned %d (%s) , SMTP response %ld",
288                                res, curl_easy_strerror(res), response_code);
289
290                         if ((res != CURLE_OK) && (response_code == 0)) {        // check for errors
291                                 response_code = 421;
292                         }
293
294                         curl_slist_free_all(recipients);
295                         recipients = NULL;      // this gets reused; avoid double-free
296                         curl_easy_cleanup(curl);
297                         curl = NULL;    // this gets reused; avoid double-free
298
299                         /* Trim the error message buffer down to just the actual message */
300                         char response_code_str[4];
301                         snprintf(response_code_str, sizeof response_code_str, "%ld", response_code);
302                         char *respstart = strstr(response, response_code_str);
303                         if (respstart == NULL) {
304                                 strcpy(response, smtpstatus(response_code));
305                         } else {
306                                 strcpy(response, respstart);
307                                 char *p;
308                                 for (p = response; *p != 0; ++p) {
309                                         if (*p == '\n')
310                                                 *p = ' ';
311                                         if (*p == '\r')
312                                                 *p = ' ';
313                                         if (!isprint(*p))
314                                                 *p = ' ';
315                                 }
316                         }
317                 }
318         }
319
320         FreeStrBuf(&s.TheMessage);
321         if (fromaddr)
322                 free(fromaddr);
323         return ((int) response_code);
324 }
325
326
327 /*
328  * Process one outbound message.
329  */
330 void smtp_process_one_msg(long qmsgnum)
331 {
332         struct CtdlMessage *msg = NULL;
333         char *instr = NULL;
334         int i;
335         int num_success = 0;
336         int num_fail = 0;
337         int num_delayed = 0;
338         long deletes[2];
339         int delete_this_queue = 0;
340         char server_response[SIZ];
341
342         msg = CtdlFetchMessage(qmsgnum, 1, 1);
343         if (msg == NULL) {
344                 syslog(LOG_WARNING, "smtpclient: %ld does not exist", qmsgnum);
345                 return;
346         }
347
348         instr = msg->cm_fields[eMesageText];
349         msg->cm_fields[eMesageText] = NULL;
350         CM_Free(msg);
351
352         // if the queue message has any CRLF's convert them to LF's
353         char *crlf = NULL;
354         while (crlf = strstr(instr, "\r\n"), crlf != NULL) {
355                 strcpy(crlf, crlf + 1);
356         }
357
358         // Strip out the headers and we are now left with just the instructions.
359         char *soi = strstr(instr, "\n\n");
360         if (soi) {
361                 strcpy(instr, soi + 2);
362         }
363
364         long msgid = 0;
365         time_t submitted = time(NULL);
366         time_t attempted = 0;
367         char *bounceto = NULL;
368         char *envelope_from = NULL;
369
370         char cfgline[SIZ];
371         for (i = 0; i < num_tokens(instr, '\n'); ++i) {
372                 extract_token(cfgline, instr, i, '\n', sizeof cfgline);
373                 if (!strncasecmp(cfgline, HKEY("msgid|")))
374                         msgid = atol(&cfgline[6]);
375                 if (!strncasecmp(cfgline, HKEY("submitted|")))
376                         submitted = atol(&cfgline[10]);
377                 if (!strncasecmp(cfgline, HKEY("attempted|")))
378                         attempted = atol(&cfgline[10]);
379                 if (!strncasecmp(cfgline, HKEY("bounceto|")))
380                         bounceto = strdup(&cfgline[9]);
381                 if (!strncasecmp(cfgline, HKEY("envelope_from|")))
382                         envelope_from = strdup(&cfgline[14]);
383         }
384
385         int should_try_now = 0;
386         if (attempted < submitted) {    // If no attempts have been made yet, try now
387                 should_try_now = 1;
388         } else if ((attempted - submitted) <= 14400) {
389                 if ((time(NULL) - attempted) > 1800) {  // First four hours, retry every 30 minutes
390                         should_try_now = 1;
391                 }
392         } else {
393                 if ((time(NULL) - attempted) > 14400) { // After that, retry once every 4 hours
394                         should_try_now = 1;
395                 }
396         }
397
398         if (should_try_now) {
399                 syslog(LOG_DEBUG, "smtpclient: %ld attempting delivery now", qmsgnum);
400                 StrBuf *NewInstr = NewStrBuf();
401                 StrBufAppendPrintf(NewInstr, "Content-type: " SPOOLMIME "\n\n");
402                 StrBufAppendPrintf(NewInstr, "msgid|%ld\n", msgid);
403                 StrBufAppendPrintf(NewInstr, "submitted|%ld\n", submitted);
404                 if (bounceto)
405                         StrBufAppendPrintf(NewInstr, "bounceto|%s\n", bounceto);
406                 if (envelope_from)
407                         StrBufAppendPrintf(NewInstr, "envelope_from|%s\n", envelope_from);
408
409                 for (i = 0; i < num_tokens(instr, '\n'); ++i) {
410                         extract_token(cfgline, instr, i, '\n', sizeof cfgline);
411                         if (!strncasecmp(cfgline, HKEY("remote|"))) {
412                                 char recp[SIZ];
413                                 int previous_result = extract_int(cfgline, 2);
414                                 if ((previous_result == 0)
415                                     || (previous_result == 4)) {
416                                         int new_result = 421;
417                                         extract_token(recp, cfgline, 1, '|', sizeof recp);
418                                         new_result = smtp_attempt_delivery(msgid, recp, envelope_from, server_response);
419                                         syslog(LOG_DEBUG,
420                                                "smtpclient: recp: <%s> , result: %d (%s)", recp, new_result, server_response);
421                                         if ((new_result / 100) == 2) {
422                                                 ++num_success;
423                                         } else {
424                                                 if ((new_result / 100) == 5) {
425                                                         ++num_fail;
426                                                 } else {
427                                                         ++num_delayed;
428                                                 }
429                                                 StrBufAppendPrintf
430                                                     (NewInstr,
431                                                      "remote|%s|%ld|%ld (%s)\n",
432                                                      recp, (new_result / 100), new_result, server_response);
433                                         }
434                                 }
435                         }
436                 }
437
438                 StrBufAppendPrintf(NewInstr, "attempted|%ld\n", time(NULL));
439
440                 // All deliveries have now been attempted.  Now determine the disposition of this queue entry.
441
442                 time_t age = time(NULL) - submitted;
443                 syslog(LOG_DEBUG,
444                        "smtpclient: submission age: %ldd%ldh%ldm%lds",
445                        (age / 86400), ((age % 86400) / 3600), ((age % 3600) / 60), (age % 60));
446                 syslog(LOG_DEBUG, "smtpclient: num_success=%d , num_fail=%d , num_delayed=%d", num_success, num_fail, num_delayed);
447
448                 // If there are permanent fails on this attempt, deliver a bounce to the user.
449                 // The 5XX fails will be recorded in the rewritten queue, but they will be removed before the next attempt.
450                 if (num_fail > 0) {
451                         smtp_do_bounce(ChrPtr(NewInstr), SDB_BOUNCE_FATALS);
452                 }
453                 // If all deliveries have either succeeded or failed, we are finished with this queue entry.
454                 //
455                 if (num_delayed == 0) {
456                         delete_this_queue = 1;
457                 }
458                 // If it's been more than five days, give up and tell the sender that delivery failed
459                 //
460                 else if ((time(NULL) - submitted) > SMTP_DELIVER_FAIL) {
461                         smtp_do_bounce(ChrPtr(NewInstr), SDB_BOUNCE_ALL);
462                         delete_this_queue = 1;
463                 }
464                 // If it's been more than four hours but less than five days, warn the sender that delivery is delayed
465                 //
466                 else if (((attempted - submitted) < SMTP_DELIVER_WARN)
467                          && ((time(NULL) - submitted) >= SMTP_DELIVER_WARN)) {
468                         smtp_do_bounce(ChrPtr(NewInstr), SDB_WARN);
469                 }
470
471                 if (delete_this_queue) {
472                         syslog(LOG_DEBUG, "smtpclient: %ld deleting", qmsgnum);
473                         deletes[0] = qmsgnum;
474                         deletes[1] = msgid;
475                         CtdlDeleteMessages(SMTP_SPOOLOUT_ROOM, deletes, 2, "");
476                         FreeStrBuf(&NewInstr);  // We have to free NewInstr here, no longer needed
477                 } else {
478                         // replace the old queue entry with the new one
479                         syslog(LOG_DEBUG, "smtpclient: %ld rewriting", qmsgnum);
480                         msg = convert_internet_message_buf(&NewInstr);  // This function will free NewInstr for us
481                         CtdlSubmitMsg(msg, NULL, SMTP_SPOOLOUT_ROOM, 0);
482                         CM_Free(msg);
483                         CtdlDeleteMessages(SMTP_SPOOLOUT_ROOM, &qmsgnum, 1, "");
484                 }
485         } else {
486                 syslog(LOG_DEBUG, "smtpclient: %ld retry time not reached", qmsgnum);
487         }
488
489         if (bounceto != NULL)
490                 free(bounceto);
491         if (envelope_from != NULL)
492                 free(envelope_from);
493         free(instr);
494 }
495
496
497 /*
498  * Callback for smtp_do_queue()
499  */
500 void smtp_add_msg(long msgnum, void *userdata)
501 {
502
503         if (smtpq == NULL) {
504                 smtpq_count = 0;
505                 smtpq_alloc = 100;
506                 smtpq = malloc(smtpq_alloc * sizeof(long));
507         }
508
509         if (smtpq_alloc >= smtpq_count) {
510                 smtpq_alloc += 100;
511                 smtpq = realloc(smtpq, (smtpq_alloc * sizeof(long)));
512         }
513
514         smtpq[smtpq_count++] = msgnum;
515 }
516
517
518 /*
519  * Run through the queue sending out messages.
520  */
521 void smtp_do_queue(void)
522 {
523         int i = 0;
524
525         /*
526          * This is a simple concurrency check to make sure only one smtpclient
527          * run is done at a time.  We could do this with a mutex, but since we
528          * don't really require extremely fine granularity here, we'll do it
529          * with a static variable instead.
530          */
531         if (doing_smtpclient)
532                 return;
533         doing_smtpclient = 1;
534
535         syslog(LOG_DEBUG, "smtpclient: start queue run");
536         pthread_setspecific(MyConKey, (void *) &smtp_client_CC);
537
538         if (CtdlGetRoom(&CC->room, SMTP_SPOOLOUT_ROOM) != 0) {
539                 syslog(LOG_WARNING, "Cannot find room <%s>", SMTP_SPOOLOUT_ROOM);
540                 doing_smtpclient = 0;
541                 return;
542         }
543         // Put the queue in memory so we can close the db cursor
544         CtdlForEachMessage(MSGS_ALL, 0L, NULL, SPOOLMIME, NULL, smtp_add_msg, NULL);
545
546         // We are ready to run through the queue now.
547         for (i = 0; i < smtpq_count; ++i) {
548                 smtp_process_one_msg(smtpq[i]);
549         }
550
551         smtpq_count = 0;        // don't free it, we will use this memory on the next run
552         doing_smtpclient = 0;
553         syslog(LOG_DEBUG, "smtpclient: end queue run");
554 }
555
556
557 /*
558  * Module entry point
559  */
560 CTDL_MODULE_INIT(smtpclient)
561 {
562         if (!threading) {
563                 CtdlFillSystemContext(&smtp_client_CC, "SMTP_Send");
564                 CtdlRegisterMessageHook(smtp_aftersave, EVT_AFTERSAVE);
565                 CtdlRegisterSessionHook(smtp_do_queue, EVT_TIMER, PRIO_AGGR + 50);
566                 smtp_init_spoolout();
567         }
568
569         /* return our module id for the log */
570         return "smtpclient";
571 }