src/src/deliver.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2013 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8 /* The main code for delivering a message. */
   9
  10
  11 #include "exim.h"
  12
  13
  14 /* Data block for keeping track of subprocesses for parallel remote
  15 delivery. */
  16
  17 typedef struct pardata {
  18   address_item *addrlist;      /* chain of addresses */
  19   address_item *addr;          /* next address data expected for */
  20   pid_t pid;                   /* subprocess pid */
  21   int fd;                      /* pipe fd for getting result from subprocess */
  22   int transport_count;         /* returned transport count value */
  23   BOOL done;                   /* no more data needed */
  24   uschar *msg;                 /* error message */
  25   uschar *return_path;         /* return_path for these addresses */
  26 } pardata;
  27
  28 /* Values for the process_recipients variable */
  29
  30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
  31        RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
  32        RECIP_FAIL_LOOP};
  33
  34 /* Mutually recursive functions for marking addresses done. */
  35
  36 static void child_done(address_item *, uschar *);
  37 static void address_done(address_item *, uschar *);
  38
  39 /* Table for turning base-62 numbers into binary */
  40
  41 static uschar tab62[] =
  42           {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0,     /* 0-9 */
  43            0,10,11,12,13,14,15,16,17,18,19,20,  /* A-K */
  44           21,22,23,24,25,26,27,28,29,30,31,32,  /* L-W */
  45           33,34,35, 0, 0, 0, 0, 0,              /* X-Z */
  46            0,36,37,38,39,40,41,42,43,44,45,46,  /* a-k */
  47           47,48,49,50,51,52,53,54,55,56,57,58,  /* l-w */
  48           59,60,61};                            /* x-z */
  49
  50
  51 /*************************************************
  52 *            Local static variables              *
  53 *************************************************/
  54
  55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
  56 writing code. */
  57
  58 static address_item *addr_defer = NULL;
  59 static address_item *addr_failed = NULL;
  60 static address_item *addr_fallback = NULL;
  61 static address_item *addr_local = NULL;
  62 static address_item *addr_new = NULL;
  63 static address_item *addr_remote = NULL;
  64 static address_item *addr_route = NULL;
  65 static address_item *addr_succeed = NULL;
  66
  67 static FILE *message_log = NULL;
  68 static BOOL update_spool;
  69 static BOOL remove_journal;
  70 static int  parcount = 0;
  71 static pardata *parlist = NULL;
  72 static int  return_count;
  73 static uschar *frozen_info = US"";
  74 static uschar *used_return_path = NULL;
  75
  76 static uschar spoolname[PATH_MAX];
  77
  78
  79
  80 /*************************************************
  81 *             Make a new address item            *
  82 *************************************************/
  83
  84 /* This function gets the store and initializes with default values. The
  85 transport_return value defaults to DEFER, so that any unexpected failure to
  86 deliver does not wipe out the message. The default unique string is set to a
  87 copy of the address, so that its domain can be lowercased.
  88
  89 Argument:
  90   address     the RFC822 address string
  91   copy        force a copy of the address
  92
  93 Returns:      a pointer to an initialized address_item
  94 */
  95
  96 address_item *
  97 deliver_make_addr(uschar *address, BOOL copy)
  98 {
  99 address_item *addr = store_get(sizeof(address_item));
 100 *addr = address_defaults;
 101 if (copy) address = string_copy(address);
 102 addr->address = address;
 103 addr->unique = string_copy(address);
 104 return addr;
 105 }
 106
 107
 108
 109
 110 /*************************************************
 111 *     Set expansion values for an address        *
 112 *************************************************/
 113
 114 /* Certain expansion variables are valid only when handling an address or
 115 address list. This function sets them up or clears the values, according to its
 116 argument.
 117
 118 Arguments:
 119   addr          the address in question, or NULL to clear values
 120 Returns:        nothing
 121 */
 122
 123 void
 124 deliver_set_expansions(address_item *addr)
 125 {
 126 if (addr == NULL)
 127   {
 128   uschar ***p = address_expansions;
 129   while (*p != NULL) **p++ = NULL;
 130   return;
 131   }
 132
 133 /* Exactly what gets set depends on whether there is one or more addresses, and
 134 what they contain. These first ones are always set, taking their values from
 135 the first address. */
 136
 137 if (addr->host_list == NULL)
 138   {
 139   deliver_host = deliver_host_address = US"";
 140   }
 141 else
 142   {
 143   deliver_host = addr->host_list->name;
 144   deliver_host_address = addr->host_list->address;
 145   }
 146
 147 deliver_recipients = addr;
 148 deliver_address_data = addr->p.address_data;
 149 deliver_domain_data = addr->p.domain_data;
 150 deliver_localpart_data = addr->p.localpart_data;
 151
 152 /* These may be unset for multiple addresses */
 153
 154 deliver_domain = addr->domain;
 155 self_hostname = addr->self_hostname;
 156
 157 #ifdef EXPERIMENTAL_BRIGHTMAIL
 158 bmi_deliver = 1;    /* deliver by default */
 159 bmi_alt_location = NULL;
 160 bmi_base64_verdict = NULL;
 161 bmi_base64_tracker_verdict = NULL;
 162 #endif
 163
 164 /* If there's only one address we can set everything. */
 165
 166 if (addr->next == NULL)
 167   {
 168   address_item *addr_orig;
 169
 170   deliver_localpart = addr->local_part;
 171   deliver_localpart_prefix = addr->prefix;
 172   deliver_localpart_suffix = addr->suffix;
 173
 174   for (addr_orig = addr; addr_orig->parent != NULL;
 175     addr_orig = addr_orig->parent);
 176   deliver_domain_orig = addr_orig->domain;
 177
 178   /* Re-instate any prefix and suffix in the original local part. In all
 179   normal cases, the address will have a router associated with it, and we can
 180   choose the caseful or caseless version accordingly. However, when a system
 181   filter sets up a pipe, file, or autoreply delivery, no router is involved.
 182   In this case, though, there won't be any prefix or suffix to worry about. */
 183
 184   deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
 185     addr_orig->router->caseful_local_part?
 186       addr_orig->cc_local_part : addr_orig->lc_local_part;
 187
 188   /* If there's a parent, make its domain and local part available, and if
 189   delivering to a pipe or file, or sending an autoreply, get the local
 190   part from the parent. For pipes and files, put the pipe or file string
 191   into address_pipe and address_file. */
 192
 193   if (addr->parent != NULL)
 194     {
 195     deliver_domain_parent = addr->parent->domain;
 196     deliver_localpart_parent = (addr->parent->router == NULL)?
 197       addr->parent->local_part :
 198         addr->parent->router->caseful_local_part?
 199           addr->parent->cc_local_part : addr->parent->lc_local_part;
 200
 201     /* File deliveries have their own flag because they need to be picked out
 202     as special more often. */
 203
 204     if (testflag(addr, af_pfr))
 205       {
 206       if (testflag(addr, af_file)) address_file = addr->local_part;
 207         else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
 208       deliver_localpart = addr->parent->local_part;
 209       deliver_localpart_prefix = addr->parent->prefix;
 210       deliver_localpart_suffix = addr->parent->suffix;
 211       }
 212     }
 213
 214 #ifdef EXPERIMENTAL_BRIGHTMAIL
 215     /* Set expansion variables related to Brightmail AntiSpam */
 216     bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
 217     bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
 218     /* get message delivery status (0 - don't deliver | 1 - deliver) */
 219     bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
 220     /* if message is to be delivered, get eventual alternate location */
 221     if (bmi_deliver == 1) {
 222       bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
 223     };
 224 #endif
 225
 226   }
 227
 228 /* For multiple addresses, don't set local part, and leave the domain and
 229 self_hostname set only if it is the same for all of them. It is possible to
 230 have multiple pipe and file addresses, but only when all addresses have routed
 231 to the same pipe or file. */
 232
 233 else
 234   {
 235   address_item *addr2;
 236   if (testflag(addr, af_pfr))
 237     {
 238     if (testflag(addr, af_file)) address_file = addr->local_part;
 239       else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
 240     }
 241   for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
 242     {
 243     if (deliver_domain != NULL &&
 244         Ustrcmp(deliver_domain, addr2->domain) != 0)
 245       deliver_domain = NULL;
 246     if (self_hostname != NULL && (addr2->self_hostname == NULL ||
 247         Ustrcmp(self_hostname, addr2->self_hostname) != 0))
 248       self_hostname = NULL;
 249     if (deliver_domain == NULL && self_hostname == NULL) break;
 250     }
 251   }
 252 }
 253
 254
 255
 256
 257 /*************************************************
 258 *                Open a msglog file              *
 259 *************************************************/
 260
 261 /* This function is used both for normal message logs, and for files in the
 262 msglog directory that are used to catch output from pipes. Try to create the
 263 directory if it does not exist. From release 4.21, normal message logs should
 264 be created when the message is received.
 265
 266 Argument:
 267   filename  the file name
 268   mode      the mode required
 269   error     used for saying what failed
 270
 271 Returns:    a file descriptor, or -1 (with errno set)
 272 */
 273
 274 static int
 275 open_msglog_file(uschar *filename, int mode, uschar **error)
 276 {
 277 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
 278
 279 if (fd < 0 && errno == ENOENT)
 280   {
 281   uschar temp[16];
 282   sprintf(CS temp, "msglog/%s", message_subdir);
 283   if (message_subdir[0] == 0) temp[6] = 0;
 284   (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
 285   fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
 286   }
 287
 288 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
 289 function is called as root). Double check the mode, because the group setting
 290 doesn't always get set automatically. */
 291
 292 if (fd >= 0)
 293   {
 294   (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
 295   if (fchown(fd, exim_uid, exim_gid) < 0)
 296     {
 297     *error = US"chown";
 298     return -1;
 299     }
 300   if (fchmod(fd, mode) < 0)
 301     {
 302     *error = US"chmod";
 303     return -1;
 304     }
 305   }
 306 else *error = US"create";
 307
 308 return fd;
 309 }
 310
 311
 312
 313
 314 /*************************************************
 315 *           Write to msglog if required          *
 316 *************************************************/
 317
 318 /* Write to the message log, if configured. This function may also be called
 319 from transports.
 320
 321 Arguments:
 322   format       a string format
 323
 324 Returns:       nothing
 325 */
 326
 327 void
 328 deliver_msglog(const char *format, ...)
 329 {
 330 va_list ap;
 331 if (!message_logs) return;
 332 va_start(ap, format);
 333 vfprintf(message_log, format, ap);
 334 fflush(message_log);
 335 va_end(ap);
 336 }
 337
 338
 339
 340
 341 /*************************************************
 342 *            Replicate status for batch          *
 343 *************************************************/
 344
 345 /* When a transport handles a batch of addresses, it may treat them
 346 individually, or it may just put the status in the first one, and return FALSE,
 347 requesting that the status be copied to all the others externally. This is the
 348 replication function. As well as the status, it copies the transport pointer,
 349 which may have changed if appendfile passed the addresses on to a different
 350 transport.
 351
 352 Argument:    pointer to the first address in a chain
 353 Returns:     nothing
 354 */
 355
 356 static void
 357 replicate_status(address_item *addr)
 358 {
 359 address_item *addr2;
 360 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
 361   {
 362   addr2->transport = addr->transport;
 363   addr2->transport_return = addr->transport_return;
 364   addr2->basic_errno = addr->basic_errno;
 365   addr2->more_errno = addr->more_errno;
 366   addr2->special_action = addr->special_action;
 367   addr2->message = addr->message;
 368   addr2->user_message = addr->user_message;
 369   }
 370 }
 371
 372
 373
 374 /*************************************************
 375 *              Compare lists of hosts            *
 376 *************************************************/
 377
 378 /* This function is given two pointers to chains of host items, and it yields
 379 TRUE if the lists refer to the same hosts in the same order, except that
 380
 381 (1) Multiple hosts with the same non-negative MX values are permitted to appear
 382     in different orders. Round-robinning nameservers can cause this to happen.
 383
 384 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
 385     permitted to appear in different orders. This is caused by randomizing
 386     hosts lists.
 387
 388 This enables Exim to use a single SMTP transaction for sending to two entirely
 389 different domains that happen to end up pointing at the same hosts.
 390
 391 Arguments:
 392   one       points to the first host list
 393   two       points to the second host list
 394
 395 Returns:    TRUE if the lists refer to the same host set
 396 */
 397
 398 static BOOL
 399 same_hosts(host_item *one, host_item *two)
 400 {
 401 while (one != NULL && two != NULL)
 402   {
 403   if (Ustrcmp(one->name, two->name) != 0)
 404     {
 405     int mx = one->mx;
 406     host_item *end_one = one;
 407     host_item *end_two = two;
 408
 409     /* Batch up only if there was no MX and the list was not randomized */
 410
 411     if (mx == MX_NONE) return FALSE;
 412
 413     /* Find the ends of the shortest sequence of identical MX values */
 414
 415     while (end_one->next != NULL && end_one->next->mx == mx &&
 416            end_two->next != NULL && end_two->next->mx == mx)
 417       {
 418       end_one = end_one->next;
 419       end_two = end_two->next;
 420       }
 421
 422     /* If there aren't any duplicates, there's no match. */
 423
 424     if (end_one == one) return FALSE;
 425
 426     /* For each host in the 'one' sequence, check that it appears in the 'two'
 427     sequence, returning FALSE if not. */
 428
 429     for (;;)
 430       {
 431       host_item *hi;
 432       for (hi = two; hi != end_two->next; hi = hi->next)
 433         if (Ustrcmp(one->name, hi->name) == 0) break;
 434       if (hi == end_two->next) return FALSE;
 435       if (one == end_one) break;
 436       one = one->next;
 437       }
 438
 439     /* All the hosts in the 'one' sequence were found in the 'two' sequence.
 440     Ensure both are pointing at the last host, and carry on as for equality. */
 441
 442     two = end_two;
 443     }
 444
 445   /* Hosts matched */
 446
 447   one = one->next;
 448   two = two->next;
 449   }
 450
 451 /* True if both are NULL */
 452
 453 return (one == two);
 454 }
 455
 456
 457
 458 /*************************************************
 459 *              Compare header lines              *
 460 *************************************************/
 461
 462 /* This function is given two pointers to chains of header items, and it yields
 463 TRUE if they are the same header texts in the same order.
 464
 465 Arguments:
 466   one       points to the first header list
 467   two       points to the second header list
 468
 469 Returns:    TRUE if the lists refer to the same header set
 470 */
 471
 472 static BOOL
 473 same_headers(header_line *one, header_line *two)
 474 {
 475 for (;;)
 476   {
 477   if (one == two) return TRUE;   /* Includes the case where both NULL */
 478   if (one == NULL || two == NULL) return FALSE;
 479   if (Ustrcmp(one->text, two->text) != 0) return FALSE;
 480   one = one->next;
 481   two = two->next;
 482   }
 483 }
 484
 485
 486
 487 /*************************************************
 488 *            Compare string settings             *
 489 *************************************************/
 490
 491 /* This function is given two pointers to strings, and it returns
 492 TRUE if they are the same pointer, or if the two strings are the same.
 493
 494 Arguments:
 495   one       points to the first string
 496   two       points to the second string
 497
 498 Returns:    TRUE or FALSE
 499 */
 500
 501 static BOOL
 502 same_strings(uschar *one, uschar *two)
 503 {
 504 if (one == two) return TRUE;   /* Includes the case where both NULL */
 505 if (one == NULL || two == NULL) return FALSE;
 506 return (Ustrcmp(one, two) == 0);
 507 }
 508
 509
 510
 511 /*************************************************
 512 *        Compare uid/gid for addresses           *
 513 *************************************************/
 514
 515 /* This function is given a transport and two addresses. It yields TRUE if the
 516 uid/gid/initgroups settings for the two addresses are going to be the same when
 517 they are delivered.
 518
 519 Arguments:
 520   tp            the transort
 521   addr1         the first address
 522   addr2         the second address
 523
 524 Returns:        TRUE or FALSE
 525 */
 526
 527 static BOOL
 528 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
 529 {
 530 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
 531   {
 532   if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
 533        (testflag(addr1, af_uid_set) &&
 534          (addr1->uid != addr2->uid ||
 535           testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
 536     return FALSE;
 537   }
 538
 539 if (!tp->gid_set && tp->expand_gid == NULL)
 540   {
 541   if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
 542      (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
 543     return FALSE;
 544   }
 545
 546 return TRUE;
 547 }
 548
 549
 550
 551
 552 /*************************************************
 553 *      Record that an address is complete        *
 554 *************************************************/
 555
 556 /* This function records that an address is complete. This is straightforward
 557 for most addresses, where the unique address is just the full address with the
 558 domain lower cased. For homonyms (addresses that are the same as one of their
 559 ancestors) their are complications. Their unique addresses have \x\ prepended
 560 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
 561 cousins.
 562
 563 Exim used to record the unique addresses of homonyms as "complete". This,
 564 however, fails when the pattern of redirection varies over time (e.g. if taking
 565 unseen copies at only some times of day) because the prepended numbers may vary
 566 from one delivery run to the next. This problem is solved by never recording
 567 prepended unique addresses as complete. Instead, when a homonymic address has
 568 actually been delivered via a transport, we record its basic unique address
 569 followed by the name of the transport. This is checked in subsequent delivery
 570 runs whenever an address is routed to a transport.
 571
 572 If the completed address is a top-level one (has no parent, which means it
 573 cannot be homonymic) we also add the original address to the non-recipients
 574 tree, so that it gets recorded in the spool file and therefore appears as
 575 "done" in any spool listings. The original address may differ from the unique
 576 address in the case of the domain.
 577
 578 Finally, this function scans the list of duplicates, marks as done any that
 579 match this address, and calls child_done() for their ancestors.
 580
 581 Arguments:
 582   addr        address item that has been completed
 583   now         current time as a string
 584
 585 Returns:      nothing
 586 */
 587
 588 static void
 589 address_done(address_item *addr, uschar *now)
 590 {
 591 address_item *dup;
 592
 593 update_spool = TRUE;        /* Ensure spool gets updated */
 594
 595 /* Top-level address */
 596
 597 if (addr->parent == NULL)
 598   {
 599   tree_add_nonrecipient(addr->unique);
 600   tree_add_nonrecipient(addr->address);
 601   }
 602
 603 /* Homonymous child address */
 604
 605 else if (testflag(addr, af_homonym))
 606   {
 607   if (addr->transport != NULL)
 608     {
 609     tree_add_nonrecipient(
 610       string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
 611     }
 612   }
 613
 614 /* Non-homonymous child address */
 615
 616 else tree_add_nonrecipient(addr->unique);
 617
 618 /* Check the list of duplicate addresses and ensure they are now marked
 619 done as well. */
 620
 621 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
 622   {
 623   if (Ustrcmp(addr->unique, dup->unique) == 0)
 624     {
 625     tree_add_nonrecipient(dup->unique);
 626     child_done(dup, now);
 627     }
 628   }
 629 }
 630
 631
 632
 633
 634 /*************************************************
 635 *      Decrease counts in parents and mark done  *
 636 *************************************************/
 637
 638 /* This function is called when an address is complete. If there is a parent
 639 address, its count of children is decremented. If there are still other
 640 children outstanding, the function exits. Otherwise, if the count has become
 641 zero, address_done() is called to mark the parent and its duplicates complete.
 642 Then loop for any earlier ancestors.
 643
 644 Arguments:
 645   addr      points to the completed address item
 646   now       the current time as a string, for writing to the message log
 647
 648 Returns:    nothing
 649 */
 650
 651 static void
 652 child_done(address_item *addr, uschar *now)
 653 {
 654 address_item *aa;
 655 while (addr->parent != NULL)
 656   {
 657   addr = addr->parent;
 658   if ((addr->child_count -= 1) > 0) return;   /* Incomplete parent */
 659   address_done(addr, now);
 660
 661   /* Log the completion of all descendents only when there is no ancestor with
 662   the same original address. */
 663
 664   for (aa = addr->parent; aa != NULL; aa = aa->parent)
 665     if (Ustrcmp(aa->address, addr->address) == 0) break;
 666   if (aa != NULL) continue;
 667
 668   deliver_msglog("%s %s: children all complete\n", now, addr->address);
 669   DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
 670   }
 671 }
 672
 673
 674
 675
 676 static uschar *
 677 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
 678 {
 679   s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
 680     US" [", addr->host_used->address, US"]");
 681   if ((log_extra_selector & LX_outgoing_port) != 0)
 682     s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
 683       addr->host_used->port));
 684   return s;
 685 }
 686
 687 #ifdef SUPPORT_TLS
 688 static uschar *
 689 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
 690 {
 691   if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
 692     s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
 693   if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
 694        addr->cipher != NULL)
 695     s = string_append(s, sizep, ptrp, 2, US" CV=",
 696       testflag(addr, af_cert_verified)? "yes":"no");
 697   if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
 698     s = string_append(s, sizep, ptrp, 3, US" DN=\"",
 699       string_printing(addr->peerdn), US"\"");
 700   return s;
 701 }
 702 #endif
 703
 704 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
 705 this is a nonstandard call; no two-character delivery flag is written
 706 but sender-host and sender are prefixed and "msg" is inserted in the log line.
 707
 708 Arguments:
 709   flags         passed to log_write()
 710 */
 711 void
 712 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
 713 {
 714 uschar *log_address;
 715 int size = 256;         /* Used for a temporary, */
 716 int ptr = 0;            /* expanding buffer, for */
 717 uschar *s;              /* building log lines;   */
 718 void *reset_point;      /* released afterwards.  */
 719
 720
 721 /* Log the delivery on the main log. We use an extensible string to build up
 722 the log line, and reset the store afterwards. Remote deliveries should always
 723 have a pointer to the host item that succeeded; local deliveries can have a
 724 pointer to a single host item in their host list, for use by the transport. */
 725
 726 #ifdef EXPERIMENTAL_TPDA
 727   tpda_delivery_ip = NULL;      /* presume no successful remote delivery */
 728   tpda_delivery_port = 0;
 729   tpda_delivery_fqdn = NULL;
 730   tpda_delivery_local_part = NULL;
 731   tpda_delivery_domain = NULL;
 732   tpda_delivery_confirmation = NULL;
 733 #endif
 734
 735 s = reset_point = store_get(size);
 736
 737 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
 738 if (msg)
 739   s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
 740 else
 741   {
 742   s[ptr++] = logchar;
 743   s = string_append(s, &size, &ptr, 2, US"> ", log_address);
 744   }
 745
 746 if ((log_extra_selector & LX_sender_on_delivery) != 0  ||  msg)
 747   s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
 748
 749 #ifdef EXPERIMENTAL_SRS
 750 if(addr->p.srs_sender)
 751   s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
 752 #endif
 753
 754 /* You might think that the return path must always be set for a successful
 755 delivery; indeed, I did for some time, until this statement crashed. The case
 756 when it is not set is for a delivery to /dev/null which is optimised by not
 757 being run at all. */
 758
 759 if (used_return_path != NULL &&
 760       (log_extra_selector & LX_return_path_on_delivery) != 0)
 761   s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
 762
 763 if (msg)
 764   s = string_append(s, &size, &ptr, 2, US" ", msg);
 765
 766 /* For a delivery from a system filter, there may not be a router */
 767 if (addr->router != NULL)
 768   s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
 769
 770 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
 771
 772 if ((log_extra_selector & LX_delivery_size) != 0)
 773   s = string_append(s, &size, &ptr, 2, US" S=",
 774     string_sprintf("%d", transport_count));
 775
 776 /* Local delivery */
 777
 778 if (addr->transport->info->local)
 779   {
 780   if (addr->host_list != NULL)
 781     {
 782     s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
 783     #ifdef EXPERIMENTAL_TPDA
 784       tpda_delivery_fqdn = addr->host_list->name;
 785     #endif
 786     }
 787   if (addr->shadow_message != NULL)
 788     s = string_cat(s, &size, &ptr, addr->shadow_message,
 789       Ustrlen(addr->shadow_message));
 790   }
 791
 792 /* Remote delivery */
 793
 794 else
 795   {
 796   if (addr->host_used != NULL)
 797     {
 798     s = d_hostlog(s, &size, &ptr, addr);
 799     if (continue_sequence > 1)
 800       s = string_cat(s, &size, &ptr, US"*", 1);
 801
 802     #ifdef EXPERIMENTAL_TPDA
 803     tpda_delivery_ip =           addr->host_used->address;
 804     tpda_delivery_port =         addr->host_used->port;
 805     tpda_delivery_fqdn =         addr->host_used->name;
 806     tpda_delivery_local_part =   addr->local_part;
 807     tpda_delivery_domain =       addr->domain;
 808     tpda_delivery_confirmation = addr->message;
 809     #endif
 810     }
 811
 812   #ifdef SUPPORT_TLS
 813   s = d_tlslog(s, &size, &ptr, addr);
 814   #endif
 815
 816   if (addr->authenticator)
 817     {
 818     s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
 819     if (addr->auth_id)
 820       {
 821       s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
 822       if (log_extra_selector & LX_smtp_mailauth  &&  addr->auth_sndr)
 823         s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
 824       }
 825     }
 826
 827   #ifdef EXPERIMENTAL_PRDR
 828   if (addr->flags & af_prdr_used)
 829     s = string_append(s, &size, &ptr, 1, US" PRDR");
 830   #endif
 831   }
 832
 833 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
 834
 835 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
 836     addr->message != NULL &&
 837     ((addr->host_used != NULL) || (Ustrcmp(addr->transport->driver_name, "lmtp") == 0)))
 838   {
 839   int i;
 840   uschar *p = big_buffer;
 841   uschar *ss = addr->message;
 842   *p++ = '\"';
 843   for (i = 0; i < 100 && ss[i] != 0; i++)
 844     {
 845     if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
 846     *p++ = ss[i];
 847     }
 848   *p++ = '\"';
 849   *p = 0;
 850   s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
 851   }
 852
 853 /* Time on queue and actual time taken to deliver */
 854
 855 if ((log_extra_selector & LX_queue_time) != 0)
 856   {
 857   s = string_append(s, &size, &ptr, 2, US" QT=",
 858     readconf_printtime(time(NULL) - received_time));
 859   }
 860
 861 if ((log_extra_selector & LX_deliver_time) != 0)
 862   {
 863   s = string_append(s, &size, &ptr, 2, US" DT=",
 864     readconf_printtime(addr->more_errno));
 865   }
 866
 867 /* string_cat() always leaves room for the terminator. Release the
 868 store we used to build the line after writing it. */
 869
 870 s[ptr] = 0;
 871 log_write(0, flags, "%s", s);
 872
 873 #ifdef EXPERIMENTAL_TPDA
 874 if (addr->transport->tpda_delivery_action)
 875   {
 876   DEBUG(D_deliver)
 877     debug_printf("  TPDA(Delivery): tpda_deliver_action=|%s| tpda_delivery_IP=%s\n",
 878       addr->transport->tpda_delivery_action, tpda_delivery_ip);
 879
 880   router_name =    addr->router->name;
 881   transport_name = addr->transport->name;
 882   if (!expand_string(addr->transport->tpda_delivery_action) && *expand_string_message)
 883     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand tpda_deliver_action in %s: %s\n",
 884       transport_name, expand_string_message);
 885   router_name = NULL;
 886   transport_name = NULL;
 887   }
 888 #endif
 889 store_reset(reset_point);
 890 return;
 891 }
 892
 893
 894
 895 /*************************************************
 896 *    Actions at the end of handling an address   *
 897 *************************************************/
 898
 899 /* This is a function for processing a single address when all that can be done
 900 with it has been done.
 901
 902 Arguments:
 903   addr         points to the address block
 904   result       the result of the delivery attempt
 905   logflags     flags for log_write() (LOG_MAIN and/or LOG_PANIC)
 906   driver_type  indicates which type of driver (transport, or router) was last
 907                  to process the address
 908   logchar      '=' or '-' for use when logging deliveries with => or ->
 909
 910 Returns:       nothing
 911 */
 912
 913 static void
 914 post_process_one(address_item *addr, int result, int logflags, int driver_type,
 915   int logchar)
 916 {
 917 uschar *now = tod_stamp(tod_log);
 918 uschar *driver_kind = NULL;
 919 uschar *driver_name = NULL;
 920 uschar *log_address;
 921
 922 int size = 256;         /* Used for a temporary, */
 923 int ptr = 0;            /* expanding buffer, for */
 924 uschar *s;              /* building log lines;   */
 925 void *reset_point;      /* released afterwards.  */
 926
 927
 928 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
 929
 930 /* Set up driver kind and name for logging. Disable logging if the router or
 931 transport has disabled it. */
 932
 933 if (driver_type == DTYPE_TRANSPORT)
 934   {
 935   if (addr->transport != NULL)
 936     {
 937     driver_name = addr->transport->name;
 938     driver_kind = US" transport";
 939     disable_logging = addr->transport->disable_logging;
 940     }
 941   else driver_kind = US"transporting";
 942   }
 943 else if (driver_type == DTYPE_ROUTER)
 944   {
 945   if (addr->router != NULL)
 946     {
 947     driver_name = addr->router->name;
 948     driver_kind = US" router";
 949     disable_logging = addr->router->disable_logging;
 950     }
 951   else driver_kind = US"routing";
 952   }
 953
 954 /* If there's an error message set, ensure that it contains only printing
 955 characters - it should, but occasionally things slip in and this at least
 956 stops the log format from getting wrecked. We also scan the message for an LDAP
 957 expansion item that has a password setting, and flatten the password. This is a
 958 fudge, but I don't know a cleaner way of doing this. (If the item is badly
 959 malformed, it won't ever have gone near LDAP.) */
 960
 961 if (addr->message != NULL)
 962   {
 963   addr->message = string_printing(addr->message);
 964   if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
 965       (Ustrstr(addr->message, "mysql") != NULL ||
 966        Ustrstr(addr->message, "pgsql") != NULL ||
 967 #ifdef EXPERIMENTAL_REDIS
 968        Ustrstr(addr->message, "redis") != NULL ||
 969 #endif
 970        Ustrstr(addr->message, "sqlite") != NULL ||
 971        Ustrstr(addr->message, "ldap:") != NULL ||
 972        Ustrstr(addr->message, "ldapdn:") != NULL ||
 973        Ustrstr(addr->message, "ldapm:") != NULL))
 974     {
 975       addr->message = string_sprintf("Temporary internal error");
 976     }
 977   }
 978
 979 /* If we used a transport that has one of the "return_output" options set, and
 980 if it did in fact generate some output, then for return_output we treat the
 981 message as failed if it was not already set that way, so that the output gets
 982 returned to the sender, provided there is a sender to send it to. For
 983 return_fail_output, do this only if the delivery failed. Otherwise we just
 984 unlink the file, and remove the name so that if the delivery failed, we don't
 985 try to send back an empty or unwanted file. The log_output options operate only
 986 on a non-empty file.
 987
 988 In any case, we close the message file, because we cannot afford to leave a
 989 file-descriptor for one address while processing (maybe very many) others. */
 990
 991 if (addr->return_file >= 0 && addr->return_filename != NULL)
 992   {
 993   BOOL return_output = FALSE;
 994   struct stat statbuf;
 995   (void)EXIMfsync(addr->return_file);
 996
 997   /* If there is no output, do nothing. */
 998
 999   if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1000     {
1001     transport_instance *tb = addr->transport;
1002
1003     /* Handle logging options */
1004
1005     if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1006                           (result == DEFER && tb->log_defer_output))
1007       {
1008       uschar *s;
1009       FILE *f = Ufopen(addr->return_filename, "rb");
1010       if (f == NULL)
1011         log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1012           "from %s transport: %s", addr->return_filename, tb->name,
1013           strerror(errno));
1014       else
1015         {
1016         s = US Ufgets(big_buffer, big_buffer_size, f);
1017         if (s != NULL)
1018           {
1019           uschar *p = big_buffer + Ustrlen(big_buffer);
1020           while (p > big_buffer && isspace(p[-1])) p--;
1021           *p = 0;
1022           s = string_printing(big_buffer);
1023           log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1024             addr->address, tb->name, s);
1025           }
1026         (void)fclose(f);
1027         }
1028       }
1029
1030     /* Handle returning options, but only if there is an address to return
1031     the text to. */
1032
1033     if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1034       {
1035       if (tb->return_output)
1036         {
1037         addr->transport_return = result = FAIL;
1038         if (addr->basic_errno == 0 && addr->message == NULL)
1039           addr->message = US"return message generated";
1040         return_output = TRUE;
1041         }
1042       else
1043         if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1044       }
1045     }
1046
1047   /* Get rid of the file unless it might be returned, but close it in
1048   all cases. */
1049
1050   if (!return_output)
1051     {
1052     Uunlink(addr->return_filename);
1053     addr->return_filename = NULL;
1054     addr->return_file = -1;
1055     }
1056
1057   (void)close(addr->return_file);
1058   }
1059
1060 /* The sucess case happens only after delivery by a transport. */
1061
1062 if (result == OK)
1063   {
1064   addr->next = addr_succeed;
1065   addr_succeed = addr;
1066
1067   /* Call address_done() to ensure that we don't deliver to this address again,
1068   and write appropriate things to the message log. If it is a child address, we
1069   call child_done() to scan the ancestors and mark them complete if this is the
1070   last child to complete. */
1071
1072   address_done(addr, now);
1073   DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1074
1075   if (addr->parent == NULL)
1076     {
1077     deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1078       driver_name, driver_kind);
1079     }
1080   else
1081     {
1082     deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1083       addr->parent->address, driver_name, driver_kind);
1084     child_done(addr, now);
1085     }
1086
1087   delivery_log(LOG_MAIN, addr, logchar, NULL);
1088   }
1089
1090
1091 /* Soft failure, or local delivery process failed; freezing may be
1092 requested. */
1093
1094 else if (result == DEFER || result == PANIC)
1095   {
1096   if (result == PANIC) logflags |= LOG_PANIC;
1097
1098   /* This puts them on the chain in reverse order. Do not change this, because
1099   the code for handling retries assumes that the one with the retry
1100   information is last. */
1101
1102   addr->next = addr_defer;
1103   addr_defer = addr;
1104
1105   /* The only currently implemented special action is to freeze the
1106   message. Logging of this is done later, just before the -H file is
1107   updated. */
1108
1109   if (addr->special_action == SPECIAL_FREEZE)
1110     {
1111     deliver_freeze = TRUE;
1112     deliver_frozen_at = time(NULL);
1113     update_spool = TRUE;
1114     }
1115
1116   /* If doing a 2-stage queue run, we skip writing to either the message
1117   log or the main log for SMTP defers. */
1118
1119   if (!queue_2stage || addr->basic_errno != 0)
1120     {
1121     uschar ss[32];
1122
1123     /* For errors of the type "retry time not reached" (also remotes skipped
1124     on queue run), logging is controlled by L_retry_defer. Note that this kind
1125     of error number is negative, and all the retry ones are less than any
1126     others. */
1127
1128     unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1129       L_retry_defer : 0;
1130
1131     /* Build up the line that is used for both the message log and the main
1132     log. */
1133
1134     s = reset_point = store_get(size);
1135
1136     /* Create the address string for logging. Must not do this earlier, because
1137     an OK result may be changed to FAIL when a pipe returns text. */
1138
1139     log_address = string_log_address(addr,
1140       (log_write_selector & L_all_parents) != 0, result == OK);
1141
1142     s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1143
1144     /* Either driver_name contains something and driver_kind contains
1145     " router" or " transport" (note the leading space), or driver_name is
1146     a null string and driver_kind contains "routing" without the leading
1147     space, if all routing has been deferred. When a domain has been held,
1148     so nothing has been done at all, both variables contain null strings. */
1149
1150     if (driver_name == NULL)
1151       {
1152       if (driver_kind != NULL)
1153         s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1154       }
1155      else
1156       {
1157       if (driver_kind[1] == 't' && addr->router != NULL)
1158         s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1159       Ustrcpy(ss, " ?=");
1160       ss[1] = toupper(driver_kind[1]);
1161       s = string_append(s, &size, &ptr, 2, ss, driver_name);
1162       }
1163
1164     sprintf(CS ss, " defer (%d)", addr->basic_errno);
1165     s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1166
1167     if (addr->basic_errno > 0)
1168       s = string_append(s, &size, &ptr, 2, US": ",
1169         US strerror(addr->basic_errno));
1170
1171     if (addr->message != NULL)
1172       s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1173
1174     s[ptr] = 0;
1175
1176     /* Log the deferment in the message log, but don't clutter it
1177     up with retry-time defers after the first delivery attempt. */
1178
1179     if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1180       deliver_msglog("%s %s\n", now, s);
1181
1182     /* Write the main log and reset the store */
1183
1184     log_write(use_log_selector, logflags, "== %s", s);
1185     store_reset(reset_point);
1186     }
1187   }
1188
1189
1190 /* Hard failure. If there is an address to which an error message can be sent,
1191 put this address on the failed list. If not, put it on the deferred list and
1192 freeze the mail message for human attention. The latter action can also be
1193 explicitly requested by a router or transport. */
1194
1195 else
1196   {
1197   /* If this is a delivery error, or a message for which no replies are
1198   wanted, and the message's age is greater than ignore_bounce_errors_after,
1199   force the af_ignore_error flag. This will cause the address to be discarded
1200   later (with a log entry). */
1201
1202   if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1203     setflag(addr, af_ignore_error);
1204
1205   /* Freeze the message if requested, or if this is a bounce message (or other
1206   message with null sender) and this address does not have its own errors
1207   address. However, don't freeze if errors are being ignored. The actual code
1208   to ignore occurs later, instead of sending a message. Logging of freezing
1209   occurs later, just before writing the -H file. */
1210
1211   if (!testflag(addr, af_ignore_error) &&
1212       (addr->special_action == SPECIAL_FREEZE ||
1213         (sender_address[0] == 0 && addr->p.errors_address == NULL)
1214       ))
1215     {
1216     frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1217       (sender_local && !local_error_message)?
1218         US" (message created with -f <>)" : US" (delivery error message)";
1219     deliver_freeze = TRUE;
1220     deliver_frozen_at = time(NULL);
1221     update_spool = TRUE;
1222
1223     /* The address is put on the defer rather than the failed queue, because
1224     the message is being retained. */
1225
1226     addr->next = addr_defer;
1227     addr_defer = addr;
1228     }
1229
1230   /* Don't put the address on the nonrecipients tree yet; wait until an
1231   error message has been successfully sent. */
1232
1233   else
1234     {
1235     addr->next = addr_failed;
1236     addr_failed = addr;
1237     }
1238
1239   /* Build up the log line for the message and main logs */
1240
1241   s = reset_point = store_get(size);
1242
1243   /* Create the address string for logging. Must not do this earlier, because
1244   an OK result may be changed to FAIL when a pipe returns text. */
1245
1246   log_address = string_log_address(addr,
1247     (log_write_selector & L_all_parents) != 0, result == OK);
1248
1249   s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1250
1251   if ((log_extra_selector & LX_sender_on_delivery) != 0)
1252     s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1253
1254   /* Return path may not be set if no delivery actually happened */
1255
1256   if (used_return_path != NULL &&
1257       (log_extra_selector & LX_return_path_on_delivery) != 0)
1258     s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1259
1260   if (addr->router != NULL)
1261     s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1262   if (addr->transport != NULL)
1263     s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1264
1265   if (addr->host_used != NULL)
1266     s = d_hostlog(s, &size, &ptr, addr);
1267
1268   #ifdef SUPPORT_TLS
1269   s = d_tlslog(s, &size, &ptr, addr);
1270   #endif
1271
1272   if (addr->basic_errno > 0)
1273     s = string_append(s, &size, &ptr, 2, US": ",
1274       US strerror(addr->basic_errno));
1275
1276   if (addr->message != NULL)
1277     s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1278
1279   s[ptr] = 0;
1280
1281   /* Do the logging. For the message log, "routing failed" for those cases,
1282   just to make it clearer. */
1283
1284   if (driver_name == NULL)
1285     deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1286   else
1287     deliver_msglog("%s %s\n", now, s);
1288
1289   log_write(0, LOG_MAIN, "** %s", s);
1290   store_reset(reset_point);
1291   }
1292
1293 /* Ensure logging is turned on again in all cases */
1294
1295 disable_logging = FALSE;
1296 }
1297
1298
1299
1300
1301 /*************************************************
1302 *            Address-independent error           *
1303 *************************************************/
1304
1305 /* This function is called when there's an error that is not dependent on a
1306 particular address, such as an expansion string failure. It puts the error into
1307 all the addresses in a batch, logs the incident on the main and panic logs, and
1308 clears the expansions. It is mostly called from local_deliver(), but can be
1309 called for a remote delivery via findugid().
1310
1311 Arguments:
1312   logit        TRUE if (MAIN+PANIC) logging required
1313   addr         the first of the chain of addresses
1314   code         the error code
1315   format       format string for error message, or NULL if already set in addr
1316   ...          arguments for the format
1317
1318 Returns:       nothing
1319 */
1320
1321 static void
1322 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1323 {
1324 address_item *addr2;
1325 addr->basic_errno = code;
1326
1327 if (format != NULL)
1328   {
1329   va_list ap;
1330   uschar buffer[512];
1331   va_start(ap, format);
1332   if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1333     log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1334       "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1335   va_end(ap);
1336   addr->message = string_copy(buffer);
1337   }
1338
1339 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1340   {
1341   addr2->basic_errno = code;
1342   addr2->message = addr->message;
1343   }
1344
1345 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1346 deliver_set_expansions(NULL);
1347 }
1348
1349
1350
1351
1352 /*************************************************
1353 *         Check a "never users" list             *
1354 *************************************************/
1355
1356 /* This function is called to check whether a uid is on one of the two "never
1357 users" lists.
1358
1359 Arguments:
1360   uid         the uid to be checked
1361   nusers      the list to be scanned; the first item in the list is the count
1362
1363 Returns:      TRUE if the uid is on the list
1364 */
1365
1366 static BOOL
1367 check_never_users(uid_t uid, uid_t *nusers)
1368 {
1369 int i;
1370 if (nusers == NULL) return FALSE;
1371 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1372 return FALSE;
1373 }
1374
1375
1376
1377 /*************************************************
1378 *          Find uid and gid for a transport      *
1379 *************************************************/
1380
1381 /* This function is called for both local and remote deliveries, to find the
1382 uid/gid under which to run the delivery. The values are taken preferentially
1383 from the transport (either explicit or deliver_as_creator), then from the
1384 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1385 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1386 panic error is logged, and the function fails (which normally leads to delivery
1387 deferral).
1388
1389 Arguments:
1390   addr         the address (possibly a chain)
1391   tp           the transport
1392   uidp         pointer to uid field
1393   gidp         pointer to gid field
1394   igfp         pointer to the use_initgroups field
1395
1396 Returns:       FALSE if failed - error has been set in address(es)
1397 */
1398
1399 static BOOL
1400 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1401   BOOL *igfp)
1402 {
1403 uschar *nuname = NULL;
1404 BOOL gid_set = FALSE;
1405
1406 /* Default initgroups flag comes from the transport */
1407
1408 *igfp = tp->initgroups;
1409
1410 /* First see if there's a gid on the transport, either fixed or expandable.
1411 The expanding function always logs failure itself. */
1412
1413 if (tp->gid_set)
1414   {
1415   *gidp = tp->gid;
1416   gid_set = TRUE;
1417   }
1418 else if (tp->expand_gid != NULL)
1419   {
1420   if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1421     &(addr->message))) gid_set = TRUE;
1422   else
1423     {
1424     common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1425     return FALSE;
1426     }
1427   }
1428
1429 /* If the transport did not set a group, see if the router did. */
1430
1431 if (!gid_set && testflag(addr, af_gid_set))
1432   {
1433   *gidp = addr->gid;
1434   gid_set = TRUE;
1435   }
1436
1437 /* Pick up a uid from the transport if one is set. */
1438
1439 if (tp->uid_set) *uidp = tp->uid;
1440
1441 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1442 it does not provide a passwd value from which a gid can be taken. */
1443
1444 else if (tp->expand_uid != NULL)
1445   {
1446   struct passwd *pw;
1447   if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1448        uidp, &(addr->message)))
1449     {
1450     common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1451     return FALSE;
1452     }
1453   if (!gid_set && pw != NULL)
1454     {
1455     *gidp = pw->pw_gid;
1456     gid_set = TRUE;
1457     }
1458   }
1459
1460 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1461
1462 else if (tp->deliver_as_creator)
1463   {
1464   *uidp = originator_uid;
1465   if (!gid_set)
1466     {
1467     *gidp = originator_gid;
1468     gid_set = TRUE;
1469     }
1470   }
1471
1472 /* Otherwise see if the address specifies the uid and if so, take it and its
1473 initgroups flag. */
1474
1475 else if (testflag(addr, af_uid_set))
1476   {
1477   *uidp = addr->uid;
1478   *igfp = testflag(addr, af_initgroups);
1479   }
1480
1481 /* Nothing has specified the uid - default to the Exim user, and group if the
1482 gid is not set. */
1483
1484 else
1485   {
1486   *uidp = exim_uid;
1487   if (!gid_set)
1488     {
1489     *gidp = exim_gid;
1490     gid_set = TRUE;
1491     }
1492   }
1493
1494 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1495 defaulting to the Exim uid. In other words, if the configuration has specified
1496 a uid, it must also provide a gid. */
1497
1498 if (!gid_set)
1499   {
1500   common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1501     "%s transport", tp->name);
1502   return FALSE;
1503   }
1504
1505 /* Check that the uid is not on the lists of banned uids that may not be used
1506 for delivery processes. */
1507
1508 if (check_never_users(*uidp, never_users))
1509   nuname = US"never_users";
1510 else if (check_never_users(*uidp, fixed_never_users))
1511   nuname = US"fixed_never_users";
1512
1513 if (nuname != NULL)
1514   {
1515   common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1516     "is on the %s list", (long int)(*uidp), tp->name, nuname);
1517   return FALSE;
1518   }
1519
1520 /* All is well */
1521
1522 return TRUE;
1523 }
1524
1525
1526
1527
1528 /*************************************************
1529 *   Check the size of a message for a transport  *
1530 *************************************************/
1531
1532 /* Checks that the message isn't too big for the selected transport.
1533 This is called only when it is known that the limit is set.
1534
1535 Arguments:
1536   tp          the transport
1537   addr        the (first) address being delivered
1538
1539 Returns:      OK
1540               DEFER   expansion failed or did not yield an integer
1541               FAIL    message too big
1542 */
1543
1544 int
1545 check_message_size(transport_instance *tp, address_item *addr)
1546 {
1547 int rc = OK;
1548 int size_limit;
1549
1550 deliver_set_expansions(addr);
1551 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1552 deliver_set_expansions(NULL);
1553
1554 if (expand_string_message != NULL)
1555   {
1556   rc = DEFER;
1557   if (size_limit == -1)
1558     addr->message = string_sprintf("failed to expand message_size_limit "
1559       "in %s transport: %s", tp->name, expand_string_message);
1560   else
1561     addr->message = string_sprintf("invalid message_size_limit "
1562       "in %s transport: %s", tp->name, expand_string_message);
1563   }
1564 else if (size_limit > 0 && message_size > size_limit)
1565   {
1566   rc = FAIL;
1567   addr->message =
1568     string_sprintf("message is too big (transport limit = %d)",
1569       size_limit);
1570   }
1571
1572 return rc;
1573 }
1574
1575
1576
1577 /*************************************************
1578 *  Transport-time check for a previous delivery  *
1579 *************************************************/
1580
1581 /* Check that this base address hasn't previously been delivered to its routed
1582 transport. If it has been delivered, mark it done. The check is necessary at
1583 delivery time in order to handle homonymic addresses correctly in cases where
1584 the pattern of redirection changes between delivery attempts (so the unique
1585 fields change). Non-homonymic previous delivery is detected earlier, at routing
1586 time (which saves unnecessary routing).
1587
1588 Arguments:
1589   addr      the address item
1590   testing   TRUE if testing wanted only, without side effects
1591
1592 Returns:    TRUE if previously delivered by the transport
1593 */
1594
1595 static BOOL
1596 previously_transported(address_item *addr, BOOL testing)
1597 {
1598 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1599   addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1600
1601 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1602   {
1603   DEBUG(D_deliver|D_route|D_transport)
1604     debug_printf("%s was previously delivered (%s transport): discarded\n",
1605     addr->address, addr->transport->name);
1606   if (!testing) child_done(addr, tod_stamp(tod_log));
1607   return TRUE;
1608   }
1609
1610 return FALSE;
1611 }
1612
1613
1614
1615 /******************************************************
1616 *      Check for a given header in a header string    *
1617 ******************************************************/
1618
1619 /* This function is used when generating quota warnings. The configuration may
1620 specify any header lines it likes in quota_warn_message. If certain of them are
1621 missing, defaults are inserted, so we need to be able to test for the presence
1622 of a given header.
1623
1624 Arguments:
1625   hdr         the required header name
1626   hstring     the header string
1627
1628 Returns:      TRUE  the header is in the string
1629               FALSE the header is not in the string
1630 */
1631
1632 static BOOL
1633 contains_header(uschar *hdr, uschar *hstring)
1634 {
1635 int len = Ustrlen(hdr);
1636 uschar *p = hstring;
1637 while (*p != 0)
1638   {
1639   if (strncmpic(p, hdr, len) == 0)
1640     {
1641     p += len;
1642     while (*p == ' ' || *p == '\t') p++;
1643     if (*p == ':') return TRUE;
1644     }
1645   while (*p != 0 && *p != '\n') p++;
1646   if (*p == '\n') p++;
1647   }
1648 return FALSE;
1649 }
1650
1651
1652
1653
1654 /*************************************************
1655 *           Perform a local delivery             *
1656 *************************************************/
1657
1658 /* Each local delivery is performed in a separate process which sets its
1659 uid and gid as specified. This is a safer way than simply changing and
1660 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1661 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1662 all systems have seteuid().
1663
1664 If the uid/gid are specified in the transport_instance, they are used; the
1665 transport initialization must ensure that either both or neither are set.
1666 Otherwise, the values associated with the address are used. If neither are set,
1667 it is a configuration error.
1668
1669 The transport or the address may specify a home directory (transport over-
1670 rides), and if they do, this is set as $home. If neither have set a working
1671 directory, this value is used for that as well. Otherwise $home is left unset
1672 and the cwd is set to "/" - a directory that should be accessible to all users.
1673
1674 Using a separate process makes it more complicated to get error information
1675 back. We use a pipe to pass the return code and also an error code and error
1676 text string back to the parent process.
1677
1678 Arguments:
1679   addr       points to an address block for this delivery; for "normal" local
1680              deliveries this is the only address to be delivered, but for
1681              pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1682              a number of addresses can be handled simultaneously, and in this
1683              case addr will point to a chain of addresses with the same
1684              characteristics.
1685
1686   shadowing  TRUE if running a shadow transport; this causes output from pipes
1687              to be ignored.
1688
1689 Returns:     nothing
1690 */
1691
1692 static void
1693 deliver_local(address_item *addr, BOOL shadowing)
1694 {
1695 BOOL use_initgroups;
1696 uid_t uid;
1697 gid_t gid;
1698 int status, len, rc;
1699 int pfd[2];
1700 pid_t pid;
1701 uschar *working_directory;
1702 address_item *addr2;
1703 transport_instance *tp = addr->transport;
1704
1705 /* Set up the return path from the errors or sender address. If the transport
1706 has its own return path setting, expand it and replace the existing value. */
1707
1708 if(addr->p.errors_address != NULL)
1709   return_path = addr->p.errors_address;
1710 #ifdef EXPERIMENTAL_SRS
1711 else if(addr->p.srs_sender != NULL)
1712   return_path = addr->p.srs_sender;
1713 #endif
1714 else
1715   return_path = sender_address;
1716
1717 if (tp->return_path != NULL)
1718   {
1719   uschar *new_return_path = expand_string(tp->return_path);
1720   if (new_return_path == NULL)
1721     {
1722     if (!expand_string_forcedfail)
1723       {
1724       common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1725         US"Failed to expand return path \"%s\" in %s transport: %s",
1726         tp->return_path, tp->name, expand_string_message);
1727       return;
1728       }
1729     }
1730   else return_path = new_return_path;
1731   }
1732
1733 /* For local deliveries, one at a time, the value used for logging can just be
1734 set directly, once and for all. */
1735
1736 used_return_path = return_path;
1737
1738 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1739 gets put into the address(es), and the expansions are unset, so we can just
1740 return. */
1741
1742 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1743
1744 /* See if either the transport or the address specifies a home directory. A
1745 home directory set in the address may already be expanded; a flag is set to
1746 indicate that. In other cases we must expand it. */
1747
1748 if ((deliver_home = tp->home_dir) != NULL ||       /* Set in transport, or */
1749      ((deliver_home = addr->home_dir) != NULL &&   /* Set in address and */
1750        !testflag(addr, af_home_expanded)))         /*   not expanded */
1751   {
1752   uschar *rawhome = deliver_home;
1753   deliver_home = NULL;                      /* in case it contains $home */
1754   deliver_home = expand_string(rawhome);
1755   if (deliver_home == NULL)
1756     {
1757     common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1758       "to expand for %s transport: %s", rawhome, tp->name,
1759       expand_string_message);
1760     return;
1761     }
1762   if (*deliver_home != '/')
1763     {
1764     common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1765       "is not absolute for %s transport", deliver_home, tp->name);
1766     return;
1767     }
1768   }
1769
1770 /* See if either the transport or the address specifies a current directory,
1771 and if so, expand it. If nothing is set, use the home directory, unless it is
1772 also unset in which case use "/", which is assumed to be a directory to which
1773 all users have access. It is necessary to be in a visible directory for some
1774 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1775 2.5) require this. */
1776
1777 working_directory = (tp->current_dir != NULL)?
1778   tp->current_dir : addr->current_dir;
1779
1780 if (working_directory != NULL)
1781   {
1782   uschar *raw = working_directory;
1783   working_directory = expand_string(raw);
1784   if (working_directory == NULL)
1785     {
1786     common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1787       "failed to expand for %s transport: %s", raw, tp->name,
1788       expand_string_message);
1789     return;
1790     }
1791   if (*working_directory != '/')
1792     {
1793     common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1794       "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1795     return;
1796     }
1797   }
1798 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1799
1800 /* If one of the return_output flags is set on the transport, create and open a
1801 file in the message log directory for the transport to write its output onto.
1802 This is mainly used by pipe transports. The file needs to be unique to the
1803 address. This feature is not available for shadow transports. */
1804
1805 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1806     tp->log_output || tp->log_fail_output))
1807   {
1808   uschar *error;
1809   addr->return_filename =
1810     string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1811       message_id, getpid(), return_count++);
1812   addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1813   if (addr->return_file < 0)
1814     {
1815     common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1816       "to return message: %s", error, tp->name, strerror(errno));
1817     return;
1818     }
1819   }
1820
1821 /* Create the pipe for inter-process communication. */
1822
1823 if (pipe(pfd) != 0)
1824   {
1825   common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1826     strerror(errno));
1827   return;
1828   }
1829
1830 /* Now fork the process to do the real work in the subprocess, but first
1831 ensure that all cached resources are freed so that the subprocess starts with
1832 a clean slate and doesn't interfere with the parent process. */
1833
1834 search_tidyup();
1835
1836 if ((pid = fork()) == 0)
1837   {
1838   BOOL replicate = TRUE;
1839
1840   /* Prevent core dumps, as we don't want them in users' home directories.
1841   HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1842   system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1843   RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1844   complain if the error is "not supported".
1845
1846   There are two scenarios where changing the max limit has an effect.  In one,
1847   the user is using a .forward and invoking a command of their choice via pipe;
1848   for these, we do need the max limit to be 0 unless the admin chooses to
1849   permit an increased limit.  In the other, the command is invoked directly by
1850   the transport and is under administrator control, thus being able to raise
1851   the limit aids in debugging.  So there's no general always-right answer.
1852
1853   Thus we inhibit core-dumps completely but let individual transports, while
1854   still root, re-raise the limits back up to aid debugging.  We make the
1855   default be no core-dumps -- few enough people can use core dumps in
1856   diagnosis that it's reasonable to make them something that has to be explicitly requested.
1857   */
1858
1859   #ifdef RLIMIT_CORE
1860   struct rlimit rl;
1861   rl.rlim_cur = 0;
1862   rl.rlim_max = 0;
1863   if (setrlimit(RLIMIT_CORE, &rl) < 0)
1864     {
1865     #ifdef SETRLIMIT_NOT_SUPPORTED
1866     if (errno != ENOSYS && errno != ENOTSUP)
1867     #endif
1868       log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1869         strerror(errno));
1870     }
1871   #endif
1872
1873   /* Reset the random number generator, so different processes don't all
1874   have the same sequence. */
1875
1876   random_seed = 0;
1877
1878   /* If the transport has a setup entry, call this first, while still
1879   privileged. (Appendfile uses this to expand quota, for example, while
1880   able to read private files.) */
1881
1882   if (addr->transport->setup != NULL)
1883     {
1884     switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1885            &(addr->message)))
1886       {
1887       case DEFER:
1888       addr->transport_return = DEFER;
1889       goto PASS_BACK;
1890
1891       case FAIL:
1892       addr->transport_return = PANIC;
1893       goto PASS_BACK;
1894       }
1895     }
1896
1897   /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1898   when the process becomes unprivileged, it won't be able to write to the
1899   process log. SIGHUP is ignored throughout exim, except when it is being
1900   run as a daemon. */
1901
1902   signal(SIGINT, SIG_IGN);
1903   signal(SIGTERM, SIG_IGN);
1904   signal(SIGUSR1, SIG_IGN);
1905
1906   /* Close the unwanted half of the pipe, and set close-on-exec for the other
1907   half - for transports that exec things (e.g. pipe). Then set the required
1908   gid/uid. */
1909
1910   (void)close(pfd[pipe_read]);
1911   (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1912     FD_CLOEXEC);
1913   exim_setugid(uid, gid, use_initgroups,
1914     string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1915       addr->address, addr->transport->name));
1916
1917   DEBUG(D_deliver)
1918     {
1919     address_item *batched;
1920     debug_printf("  home=%s current=%s\n", deliver_home, working_directory);
1921     for (batched = addr->next; batched != NULL; batched = batched->next)
1922       debug_printf("additional batched address: %s\n", batched->address);
1923     }
1924
1925   /* Set an appropriate working directory. */
1926
1927   if (Uchdir(working_directory) < 0)
1928     {
1929     addr->transport_return = DEFER;
1930     addr->basic_errno = errno;
1931     addr->message = string_sprintf("failed to chdir to %s", working_directory);
1932     }
1933
1934   /* If successful, call the transport */
1935
1936   else
1937     {
1938     BOOL ok = TRUE;
1939     set_process_info("delivering %s to %s using %s", message_id,
1940      addr->local_part, addr->transport->name);
1941
1942     /* Setting this global in the subprocess means we need never clear it */
1943     transport_name = addr->transport->name;
1944
1945     /* If a transport filter has been specified, set up its argument list.
1946     Any errors will get put into the address, and FALSE yielded. */
1947
1948     if (addr->transport->filter_command != NULL)
1949       {
1950       ok = transport_set_up_command(&transport_filter_argv,
1951         addr->transport->filter_command,
1952         TRUE, PANIC, addr, US"transport filter", NULL);
1953       transport_filter_timeout = addr->transport->filter_timeout;
1954       }
1955     else transport_filter_argv = NULL;
1956
1957     if (ok)
1958       {
1959       debug_print_string(addr->transport->debug_string);
1960       replicate = !(addr->transport->info->code)(addr->transport, addr);
1961       }
1962     }
1963
1964   /* Pass the results back down the pipe. If necessary, first replicate the
1965   status in the top address to the others in the batch. The label is the
1966   subject of a goto when a call to the transport's setup function fails. We
1967   pass the pointer to the transport back in case it got changed as a result of
1968   file_format in appendfile. */
1969
1970   PASS_BACK:
1971
1972   if (replicate) replicate_status(addr);
1973   for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1974     {
1975     int i;
1976     int local_part_length = Ustrlen(addr2->local_part);
1977     uschar *s;
1978     int ret;
1979
1980     if(  (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1981       || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1982       || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1983       || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1984       || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1985       || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1986       || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1987         sizeof(transport_instance *))) != sizeof(transport_instance *)
1988
1989     /* For a file delivery, pass back the local part, in case the original
1990     was only part of the final delivery path. This gives more complete
1991     logging. */
1992
1993       || (testflag(addr2, af_file)
1994           && (  (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1995              || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1996              )
1997          )
1998       )
1999       log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2000         ret == -1 ? strerror(errno) : "short write");
2001
2002     /* Now any messages */
2003
2004     for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2005       {
2006       int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2007       if(  (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2008         || (message_length > 0  && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2009         )
2010         log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2011           ret == -1 ? strerror(errno) : "short write");
2012       }
2013     }
2014
2015   /* OK, this process is now done. Free any cached resources that it opened,
2016   and close the pipe we were writing down before exiting. */
2017
2018   (void)close(pfd[pipe_write]);
2019   search_tidyup();
2020   exit(EXIT_SUCCESS);
2021   }
2022
2023 /* Back in the main process: panic if the fork did not succeed. This seems
2024 better than returning an error - if forking is failing it is probably best
2025 not to try other deliveries for this message. */
2026
2027 if (pid < 0)
2028   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2029     addr->address);
2030
2031 /* Read the pipe to get the delivery status codes and error messages. Our copy
2032 of the writing end must be closed first, as otherwise read() won't return zero
2033 on an empty pipe. We check that a status exists for each address before
2034 overwriting the address structure. If data is missing, the default DEFER status
2035 will remain. Afterwards, close the reading end. */
2036
2037 (void)close(pfd[pipe_write]);
2038
2039 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2040   {
2041   len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2042   if (len > 0)
2043     {
2044     int i;
2045     uschar **sptr;
2046
2047     addr2->transport_return = status;
2048     len = read(pfd[pipe_read], (void *)&transport_count,
2049       sizeof(transport_count));
2050     len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2051     len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2052     len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2053     len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2054     len = read(pfd[pipe_read], (void *)&(addr2->transport),
2055       sizeof(transport_instance *));
2056
2057     if (testflag(addr2, af_file))
2058       {
2059       int local_part_length;
2060       len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2061       len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2062       big_buffer[local_part_length] = 0;
2063       addr2->local_part = string_copy(big_buffer);
2064       }
2065
2066     for (i = 0, sptr = &(addr2->message); i < 2;
2067          i++, sptr = &(addr2->user_message))
2068       {
2069       int message_length;
2070       len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2071       if (message_length > 0)
2072         {
2073         len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2074         if (len > 0) *sptr = string_copy(big_buffer);
2075         }
2076       }
2077     }
2078
2079   else
2080     {
2081     log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2082       "from delivery subprocess", addr2->unique);
2083     break;
2084     }
2085   }
2086
2087 (void)close(pfd[pipe_read]);
2088
2089 /* Unless shadowing, write all successful addresses immediately to the journal
2090 file, to ensure they are recorded asap. For homonymic addresses, use the base
2091 address plus the transport name. Failure to write the journal is panic-worthy,
2092 but don't stop, as it may prove possible subsequently to update the spool file
2093 in order to record the delivery. */
2094
2095 if (!shadowing)
2096   {
2097   for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2098     {
2099     if (addr2->transport_return != OK) continue;
2100
2101     if (testflag(addr2, af_homonym))
2102       sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2103     else
2104       sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2105
2106     /* In the test harness, wait just a bit to let the subprocess finish off
2107     any debug output etc first. */
2108
2109     if (running_in_test_harness) millisleep(300);
2110
2111     DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2112     len = Ustrlen(big_buffer);
2113     if (write(journal_fd, big_buffer, len) != len)
2114       log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2115         big_buffer, strerror(errno));
2116     }
2117
2118   /* Ensure the journal file is pushed out to disk. */
2119
2120   if (EXIMfsync(journal_fd) < 0)
2121     log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2122       strerror(errno));
2123   }
2124
2125 /* Wait for the process to finish. If it terminates with a non-zero code,
2126 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2127 status values of all the addresses as they are. Take care to handle the case
2128 when the subprocess doesn't seem to exist. This has been seen on one system
2129 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2130 happens, wait() doesn't recognize the termination of child processes. Exim now
2131 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2132
2133 while ((rc = wait(&status)) != pid)
2134   {
2135   if (rc < 0 && errno == ECHILD)      /* Process has vanished */
2136     {
2137     log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2138       addr->transport->driver_name);
2139     status = 0;
2140     break;
2141     }
2142   }
2143
2144 if ((status & 0xffff) != 0)
2145   {
2146   int msb = (status >> 8) & 255;
2147   int lsb = status & 255;
2148   int code = (msb == 0)? (lsb & 0x7f) : msb;
2149   if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2150     addr->special_action = SPECIAL_FREEZE;
2151   log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2152     "status 0x%04x: %s %d",
2153     addr->transport->driver_name,
2154     status,
2155     (msb == 0)? "terminated by signal" : "exit code",
2156     code);
2157   }
2158
2159 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2160
2161 if (addr->special_action == SPECIAL_WARN &&
2162     addr->transport->warn_message != NULL)
2163   {
2164   int fd;
2165   uschar *warn_message;
2166
2167   DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2168
2169   warn_message = expand_string(addr->transport->warn_message);
2170   if (warn_message == NULL)
2171     log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2172       "message for %s transport): %s", addr->transport->warn_message,
2173       addr->transport->name, expand_string_message);
2174   else
2175     {
2176     pid_t pid = child_open_exim(&fd);
2177     if (pid > 0)
2178       {
2179       FILE *f = fdopen(fd, "wb");
2180       if (errors_reply_to != NULL &&
2181           !contains_header(US"Reply-To", warn_message))
2182         fprintf(f, "Reply-To: %s\n", errors_reply_to);
2183       fprintf(f, "Auto-Submitted: auto-replied\n");
2184       if (!contains_header(US"From", warn_message)) moan_write_from(f);
2185       fprintf(f, "%s", CS warn_message);
2186
2187       /* Close and wait for child process to complete, without a timeout. */
2188
2189       (void)fclose(f);
2190       (void)child_close(pid, 0);
2191       }
2192     }
2193
2194   addr->special_action = SPECIAL_NONE;
2195   }
2196 }
2197
2198
2199
2200 /*************************************************
2201 *              Do local deliveries               *
2202 *************************************************/
2203
2204 /* This function processes the list of addresses in addr_local. True local
2205 deliveries are always done one address at a time. However, local deliveries can
2206 be batched up in some cases. Typically this is when writing batched SMTP output
2207 files for use by some external transport mechanism, or when running local
2208 deliveries over LMTP.
2209
2210 Arguments:   None
2211 Returns:     Nothing
2212 */
2213
2214 static void
2215 do_local_deliveries(void)
2216 {
2217 open_db dbblock;
2218 open_db *dbm_file = NULL;
2219 time_t now = time(NULL);
2220
2221 /* Loop until we have exhausted the supply of local deliveries */
2222
2223 while (addr_local != NULL)
2224   {
2225   time_t delivery_start;
2226   int deliver_time;
2227   address_item *addr2, *addr3, *nextaddr;
2228   int logflags = LOG_MAIN;
2229   int logchar = dont_deliver? '*' : '=';
2230   transport_instance *tp;
2231
2232   /* Pick the first undelivered address off the chain */
2233
2234   address_item *addr = addr_local;
2235   addr_local = addr->next;
2236   addr->next = NULL;
2237
2238   DEBUG(D_deliver|D_transport)
2239     debug_printf("--------> %s <--------\n", addr->address);
2240
2241   /* An internal disaster if there is no transport. Should not occur! */
2242
2243   if ((tp = addr->transport) == NULL)
2244     {
2245     logflags |= LOG_PANIC;
2246     disable_logging = FALSE;  /* Jic */
2247     addr->message =
2248       (addr->router != NULL)?
2249         string_sprintf("No transport set by %s router", addr->router->name)
2250         :
2251         string_sprintf("No transport set by system filter");
2252     post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2253     continue;
2254     }
2255
2256   /* Check that this base address hasn't previously been delivered to this
2257   transport. The check is necessary at this point to handle homonymic addresses
2258   correctly in cases where the pattern of redirection changes between delivery
2259   attempts. Non-homonymic previous delivery is detected earlier, at routing
2260   time. */
2261
2262   if (previously_transported(addr, FALSE)) continue;
2263
2264   /* There are weird cases where logging is disabled */
2265
2266   disable_logging = tp->disable_logging;
2267
2268   /* Check for batched addresses and possible amalgamation. Skip all the work
2269   if either batch_max <= 1 or there aren't any other addresses for local
2270   delivery. */
2271
2272   if (tp->batch_max > 1 && addr_local != NULL)
2273     {
2274     int batch_count = 1;
2275     BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2276     BOOL uses_lp = (testflag(addr, af_pfr) &&
2277       (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2278       readconf_depends((driver_instance *)tp, US"local_part");
2279     uschar *batch_id = NULL;
2280     address_item **anchor = &addr_local;
2281     address_item *last = addr;
2282     address_item *next;
2283
2284     /* Expand the batch_id string for comparison with other addresses.
2285     Expansion failure suppresses batching. */
2286
2287     if (tp->batch_id != NULL)
2288       {
2289       deliver_set_expansions(addr);
2290       batch_id = expand_string(tp->batch_id);
2291       deliver_set_expansions(NULL);
2292       if (batch_id == NULL)
2293         {
2294         log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2295           "in %s transport (%s): %s", tp->name, addr->address,
2296           expand_string_message);
2297         batch_count = tp->batch_max;
2298         }
2299       }
2300
2301     /* Until we reach the batch_max limit, pick off addresses which have the
2302     same characteristics. These are:
2303
2304       same transport
2305       not previously delivered (see comment about 50 lines above)
2306       same local part if the transport's configuration contains $local_part
2307         or if this is a file or pipe delivery from a redirection
2308       same domain if the transport's configuration contains $domain
2309       same errors address
2310       same additional headers
2311       same headers to be removed
2312       same uid/gid for running the transport
2313       same first host if a host list is set
2314     */
2315
2316     while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2317       {
2318       BOOL ok =
2319         tp == next->transport &&
2320         !previously_transported(next, TRUE) &&
2321         (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2322         (!uses_lp  || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2323         (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2324         same_strings(next->p.errors_address, addr->p.errors_address) &&
2325         same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2326         same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2327         same_ugid(tp, addr, next) &&
2328         ((addr->host_list == NULL && next->host_list == NULL) ||
2329          (addr->host_list != NULL && next->host_list != NULL &&
2330           Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2331
2332       /* If the transport has a batch_id setting, batch_id will be non-NULL
2333       from the expansion outside the loop. Expand for this address and compare.
2334       Expansion failure makes this address ineligible for batching. */
2335
2336       if (ok && batch_id != NULL)
2337         {
2338         uschar *bid;
2339         address_item *save_nextnext = next->next;
2340         next->next = NULL;            /* Expansion for a single address */
2341         deliver_set_expansions(next);
2342         next->next = save_nextnext;
2343         bid = expand_string(tp->batch_id);
2344         deliver_set_expansions(NULL);
2345         if (bid == NULL)
2346           {
2347           log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2348             "in %s transport (%s): %s", tp->name, next->address,
2349             expand_string_message);
2350           ok = FALSE;
2351           }
2352         else ok = (Ustrcmp(batch_id, bid) == 0);
2353         }
2354
2355       /* Take address into batch if OK. */
2356
2357       if (ok)
2358         {
2359         *anchor = next->next;           /* Include the address */
2360         next->next = NULL;
2361         last->next = next;
2362         last = next;
2363         batch_count++;
2364         }
2365       else anchor = &(next->next);      /* Skip the address */
2366       }
2367     }
2368
2369   /* We now have one or more addresses that can be delivered in a batch. Check
2370   whether the transport is prepared to accept a message of this size. If not,
2371   fail them all forthwith. If the expansion fails, or does not yield an
2372   integer, defer delivery. */
2373
2374   if (tp->message_size_limit != NULL)
2375     {
2376     int rc = check_message_size(tp, addr);
2377     if (rc != OK)
2378       {
2379       replicate_status(addr);
2380       while (addr != NULL)
2381         {
2382         addr2 = addr->next;
2383         post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2384         addr = addr2;
2385         }
2386       continue;    /* With next batch of addresses */
2387       }
2388     }
2389
2390   /* If we are not running the queue, or if forcing, all deliveries will be
2391   attempted. Otherwise, we must respect the retry times for each address. Even
2392   when not doing this, we need to set up the retry key string, and determine
2393   whether a retry record exists, because after a successful delivery, a delete
2394   retry item must be set up. Keep the retry database open only for the duration
2395   of these checks, rather than for all local deliveries, because some local
2396   deliveries (e.g. to pipes) can take a substantial time. */
2397
2398   dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2399   if (dbm_file == NULL)
2400     {
2401     DEBUG(D_deliver|D_retry|D_hints_lookup)
2402       debug_printf("no retry data available\n");
2403     }
2404
2405   addr2 = addr;
2406   addr3 = NULL;
2407   while (addr2 != NULL)
2408     {
2409     BOOL ok = TRUE;   /* to deliver this address */
2410     uschar *retry_key;
2411
2412     /* Set up the retry key to include the domain or not, and change its
2413     leading character from "R" to "T". Must make a copy before doing this,
2414     because the old key may be pointed to from a "delete" retry item after
2415     a routing delay. */
2416
2417     retry_key = string_copy(
2418       (tp->retry_use_local_part)? addr2->address_retry_key :
2419         addr2->domain_retry_key);
2420     *retry_key = 'T';
2421
2422     /* Inspect the retry data. If there is no hints file, delivery happens. */
2423
2424     if (dbm_file != NULL)
2425       {
2426       dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2427
2428       /* If there is no retry record, delivery happens. If there is,
2429       remember it exists so it can be deleted after a successful delivery. */
2430
2431       if (retry_record != NULL)
2432         {
2433         setflag(addr2, af_lt_retry_exists);
2434
2435         /* A retry record exists for this address. If queue running and not
2436         forcing, inspect its contents. If the record is too old, or if its
2437         retry time has come, or if it has passed its cutoff time, delivery
2438         will go ahead. */
2439
2440         DEBUG(D_retry)
2441           {
2442           debug_printf("retry record exists: age=%s ",
2443             readconf_printtime(now - retry_record->time_stamp));
2444           debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2445           debug_printf("  time to retry = %s expired = %d\n",
2446             readconf_printtime(retry_record->next_try - now),
2447             retry_record->expired);
2448           }
2449
2450         if (queue_running && !deliver_force)
2451           {
2452           ok = (now - retry_record->time_stamp > retry_data_expire) ||
2453                (now >= retry_record->next_try) ||
2454                retry_record->expired;
2455
2456           /* If we haven't reached the retry time, there is one more check
2457           to do, which is for the ultimate address timeout. */
2458
2459           if (!ok)
2460             ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2461                 retry_record, now);
2462           }
2463         }
2464       else DEBUG(D_retry) debug_printf("no retry record exists\n");
2465       }
2466
2467     /* This address is to be delivered. Leave it on the chain. */
2468
2469     if (ok)
2470       {
2471       addr3 = addr2;
2472       addr2 = addr2->next;
2473       }
2474
2475     /* This address is to be deferred. Take it out of the chain, and
2476     post-process it as complete. Must take it out of the chain first,
2477     because post processing puts it on another chain. */
2478
2479     else
2480       {
2481       address_item *this = addr2;
2482       this->message = US"Retry time not yet reached";
2483       this->basic_errno = ERRNO_LRETRY;
2484       if (addr3 == NULL) addr2 = addr = addr2->next;
2485         else addr2 = addr3->next = addr2->next;
2486       post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2487       }
2488     }
2489
2490   if (dbm_file != NULL) dbfn_close(dbm_file);
2491
2492   /* If there are no addresses left on the chain, they all deferred. Loop
2493   for the next set of addresses. */
2494
2495   if (addr == NULL) continue;
2496
2497   /* So, finally, we do have some addresses that can be passed to the
2498   transport. Before doing so, set up variables that are relevant to a
2499   single delivery. */
2500
2501   deliver_set_expansions(addr);
2502   delivery_start = time(NULL);
2503   deliver_local(addr, FALSE);
2504   deliver_time = (int)(time(NULL) - delivery_start);
2505
2506   /* If a shadow transport (which must perforce be another local transport), is
2507   defined, and its condition is met, we must pass the message to the shadow
2508   too, but only those addresses that succeeded. We do this by making a new
2509   chain of addresses - also to keep the original chain uncontaminated. We must
2510   use a chain rather than doing it one by one, because the shadow transport may
2511   batch.
2512
2513   NOTE: if the condition fails because of a lookup defer, there is nothing we
2514   can do! */
2515
2516   if (tp->shadow != NULL &&
2517       (tp->shadow_condition == NULL ||
2518       expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2519     {
2520     transport_instance *stp;
2521     address_item *shadow_addr = NULL;
2522     address_item **last = &shadow_addr;
2523
2524     for (stp = transports; stp != NULL; stp = stp->next)
2525       if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2526
2527     if (stp == NULL)
2528       log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2529         tp->shadow);
2530
2531     /* Pick off the addresses that have succeeded, and make clones. Put into
2532     the shadow_message field a pointer to the shadow_message field of the real
2533     address. */
2534
2535     else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2536       {
2537       if (addr2->transport_return != OK) continue;
2538       addr3 = store_get(sizeof(address_item));
2539       *addr3 = *addr2;
2540       addr3->next = NULL;
2541       addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2542       addr3->transport = stp;
2543       addr3->transport_return = DEFER;
2544       addr3->return_filename = NULL;
2545       addr3->return_file = -1;
2546       *last = addr3;
2547       last = &(addr3->next);
2548       }
2549
2550     /* If we found any addresses to shadow, run the delivery, and stick any
2551     message back into the shadow_message field in the original. */
2552
2553     if (shadow_addr != NULL)
2554       {
2555       int save_count = transport_count;
2556
2557       DEBUG(D_deliver|D_transport)
2558         debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2559       deliver_local(shadow_addr, TRUE);
2560
2561       for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2562         {
2563         int sresult = shadow_addr->transport_return;
2564         *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2565           string_sprintf(" ST=%s", stp->name) :
2566           string_sprintf(" ST=%s (%s%s%s)", stp->name,
2567             (shadow_addr->basic_errno <= 0)?
2568               US"" : US strerror(shadow_addr->basic_errno),
2569             (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2570               US"" : US": ",
2571             (shadow_addr->message != NULL)? shadow_addr->message :
2572               (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2573
2574         DEBUG(D_deliver|D_transport)
2575           debug_printf("%s shadow transport returned %s for %s\n",
2576             stp->name,
2577             (sresult == OK)?    "OK" :
2578             (sresult == DEFER)? "DEFER" :
2579             (sresult == FAIL)?  "FAIL" :
2580             (sresult == PANIC)? "PANIC" : "?",
2581             shadow_addr->address);
2582         }
2583
2584       DEBUG(D_deliver|D_transport)
2585         debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2586
2587       transport_count = save_count;   /* Restore original transport count */
2588       }
2589     }
2590
2591   /* Cancel the expansions that were set up for the delivery. */
2592
2593   deliver_set_expansions(NULL);
2594
2595   /* Now we can process the results of the real transport. We must take each
2596   address off the chain first, because post_process_one() puts it on another
2597   chain. */
2598
2599   for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2600     {
2601     int result = addr2->transport_return;
2602     nextaddr = addr2->next;
2603
2604     DEBUG(D_deliver|D_transport)
2605       debug_printf("%s transport returned %s for %s\n",
2606         tp->name,
2607         (result == OK)?    "OK" :
2608         (result == DEFER)? "DEFER" :
2609         (result == FAIL)?  "FAIL" :
2610         (result == PANIC)? "PANIC" : "?",
2611         addr2->address);
2612
2613     /* If there is a retry_record, or if delivery is deferred, build a retry
2614     item for setting a new retry time or deleting the old retry record from
2615     the database. These items are handled all together after all addresses
2616     have been handled (so the database is open just for a short time for
2617     updating). */
2618
2619     if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2620       {
2621       int flags = (result == DEFER)? 0 : rf_delete;
2622       uschar *retry_key = string_copy((tp->retry_use_local_part)?
2623         addr2->address_retry_key : addr2->domain_retry_key);
2624       *retry_key = 'T';
2625       retry_add_item(addr2, retry_key, flags);
2626       }
2627
2628     /* Done with this address */
2629
2630     if (result == OK) addr2->more_errno = deliver_time;
2631     post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2632
2633     /* If a pipe delivery generated text to be sent back, the result may be
2634     changed to FAIL, and we must copy this for subsequent addresses in the
2635     batch. */
2636
2637     if (addr2->transport_return != result)
2638       {
2639       for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2640         {
2641         addr3->transport_return = addr2->transport_return;
2642         addr3->basic_errno = addr2->basic_errno;
2643         addr3->message = addr2->message;
2644         }
2645       result = addr2->transport_return;
2646       }
2647
2648     /* Whether or not the result was changed to FAIL, we need to copy the
2649     return_file value from the first address into all the addresses of the
2650     batch, so they are all listed in the error message. */
2651
2652     addr2->return_file = addr->return_file;
2653
2654     /* Change log character for recording successful deliveries. */
2655
2656     if (result == OK) logchar = '-';
2657     }
2658   }        /* Loop back for next batch of addresses */
2659 }
2660
2661
2662
2663
2664 /*************************************************
2665 *           Sort remote deliveries               *
2666 *************************************************/
2667
2668 /* This function is called if remote_sort_domains is set. It arranges that the
2669 chain of addresses for remote deliveries is ordered according to the strings
2670 specified. Try to make this shuffling reasonably efficient by handling
2671 sequences of addresses rather than just single ones.
2672
2673 Arguments:  None
2674 Returns:    Nothing
2675 */
2676
2677 static void
2678 sort_remote_deliveries(void)
2679 {
2680 int sep = 0;
2681 address_item **aptr = &addr_remote;
2682 uschar *listptr = remote_sort_domains;
2683 uschar *pattern;
2684 uschar patbuf[256];
2685
2686 while (*aptr != NULL &&
2687        (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2688        != NULL)
2689   {
2690   address_item *moved = NULL;
2691   address_item **bptr = &moved;
2692
2693   while (*aptr != NULL)
2694     {
2695     address_item **next;
2696     deliver_domain = (*aptr)->domain;   /* set $domain */
2697     if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2698           &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2699       {
2700       aptr = &((*aptr)->next);
2701       continue;
2702       }
2703
2704     next = &((*aptr)->next);
2705     while (*next != NULL &&
2706            (deliver_domain = (*next)->domain,  /* Set $domain */
2707             match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2708               &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2709       next = &((*next)->next);
2710
2711     /* If the batch of non-matchers is at the end, add on any that were
2712     extracted further up the chain, and end this iteration. Otherwise,
2713     extract them from the chain and hang on the moved chain. */
2714
2715     if (*next == NULL)
2716       {
2717       *next = moved;
2718       break;
2719       }
2720
2721     *bptr = *aptr;
2722     *aptr = *next;
2723     *next = NULL;
2724     bptr = next;
2725     aptr = &((*aptr)->next);
2726     }
2727
2728   /* If the loop ended because the final address matched, *aptr will
2729   be NULL. Add on to the end any extracted non-matching addresses. If
2730   *aptr is not NULL, the loop ended via "break" when *next is null, that
2731   is, there was a string of non-matching addresses at the end. In this
2732   case the extracted addresses have already been added on the end. */
2733
2734   if (*aptr == NULL) *aptr = moved;
2735   }
2736
2737 DEBUG(D_deliver)
2738   {
2739   address_item *addr;
2740   debug_printf("remote addresses after sorting:\n");
2741   for (addr = addr_remote; addr != NULL; addr = addr->next)
2742     debug_printf("  %s\n", addr->address);
2743   }
2744 }
2745
2746
2747
2748 /*************************************************
2749 *  Read from pipe for remote delivery subprocess *
2750 *************************************************/
2751
2752 /* This function is called when the subprocess is complete, but can also be
2753 called before it is complete, in order to empty a pipe that is full (to prevent
2754 deadlock). It must therefore keep track of its progress in the parlist data
2755 block.
2756
2757 We read the pipe to get the delivery status codes and a possible error message
2758 for each address, optionally preceded by unusability data for the hosts and
2759 also by optional retry data.
2760
2761 Read in large chunks into the big buffer and then scan through, interpreting
2762 the data therein. In most cases, only a single read will be necessary. No
2763 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2764 that we read the next chunk when there is less than 2500 bytes left in the
2765 non-final chunk, we can assume each item is complete in the buffer before
2766 handling it. Each item is written using a single write(), which is atomic for
2767 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2768 often bigger) so even if we are reading while the subprocess is still going, we
2769 should never have only a partial item in the buffer.
2770
2771 Argument:
2772   poffset     the offset of the parlist item
2773   eop         TRUE if the process has completed
2774
2775 Returns:      TRUE if the terminating 'Z' item has been read,
2776               or there has been a disaster (i.e. no more data needed);
2777               FALSE otherwise
2778 */
2779
2780 static BOOL
2781 par_read_pipe(int poffset, BOOL eop)
2782 {
2783 host_item *h;
2784 pardata *p = parlist + poffset;
2785 address_item *addrlist = p->addrlist;
2786 address_item *addr = p->addr;
2787 pid_t pid = p->pid;
2788 int fd = p->fd;
2789 uschar *endptr = big_buffer;
2790 uschar *ptr = endptr;
2791 uschar *msg = p->msg;
2792 BOOL done = p->done;
2793 BOOL unfinished = TRUE;
2794
2795 /* Loop through all items, reading from the pipe when necessary. The pipe
2796 is set up to be non-blocking, but there are two different Unix mechanisms in
2797 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2798 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2799 which returns 0 for both end of file and no more data. We distinguish the
2800 two cases by taking 0 as end of file only when we know the process has
2801 completed.
2802
2803 Each separate item is written to the pipe in a single write(), and as they are
2804 all short items, the writes will all be atomic and we should never find
2805 ourselves in the position of having read an incomplete item. "Short" in this
2806 case can mean up to about 1K in the case when there is a long error message
2807 associated with an address. */
2808
2809 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2810   (int)p->pid, eop? "ended" : "not ended");
2811
2812 while (!done)
2813   {
2814   retry_item *r, **rp;
2815   int remaining = endptr - ptr;
2816
2817   /* Read (first time) or top up the chars in the buffer if necessary.
2818   There will be only one read if we get all the available data (i.e. don't
2819   fill the buffer completely). */
2820
2821   if (remaining < 2500 && unfinished)
2822     {
2823     int len;
2824     int available = big_buffer_size - remaining;
2825
2826     if (remaining > 0) memmove(big_buffer, ptr, remaining);
2827
2828     ptr = big_buffer;
2829     endptr = big_buffer + remaining;
2830     len = read(fd, endptr, available);
2831
2832     DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2833
2834     /* If the result is EAGAIN and the process is not complete, just
2835     stop reading any more and process what we have already. */
2836
2837     if (len < 0)
2838       {
2839       if (!eop && errno == EAGAIN) len = 0; else
2840         {
2841         msg = string_sprintf("failed to read pipe from transport process "
2842           "%d for transport %s: %s", pid, addr->transport->driver_name,
2843           strerror(errno));
2844         break;
2845         }
2846       }
2847
2848     /* If the length is zero (eof or no-more-data), just process what we
2849     already have. Note that if the process is still running and we have
2850     read all the data in the pipe (but less that "available") then we
2851     won't read any more, as "unfinished" will get set FALSE. */
2852
2853     endptr += len;
2854     unfinished = len == available;
2855     }
2856
2857   /* If we are at the end of the available data, exit the loop. */
2858
2859   if (ptr >= endptr) break;
2860
2861   /* Handle each possible type of item, assuming the complete item is
2862   available in store. */
2863
2864   switch (*ptr++)
2865     {
2866     /* Host items exist only if any hosts were marked unusable. Match
2867     up by checking the IP address. */
2868
2869     case 'H':
2870     for (h = addrlist->host_list; h != NULL; h = h->next)
2871       {
2872       if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2873       h->status = ptr[0];
2874       h->why = ptr[1];
2875       }
2876     ptr += 2;
2877     while (*ptr++);
2878     break;
2879
2880     /* Retry items are sent in a preceding R item for each address. This is
2881     kept separate to keep each message short enough to guarantee it won't
2882     be split in the pipe. Hopefully, in the majority of cases, there won't in
2883     fact be any retry items at all.
2884
2885     The complete set of retry items might include an item to delete a
2886     routing retry if there was a previous routing delay. However, routing
2887     retries are also used when a remote transport identifies an address error.
2888     In that case, there may also be an "add" item for the same key. Arrange
2889     that a "delete" item is dropped in favour of an "add" item. */
2890
2891     case 'R':
2892     if (addr == NULL) goto ADDR_MISMATCH;
2893
2894     DEBUG(D_deliver|D_retry)
2895       debug_printf("reading retry information for %s from subprocess\n",
2896         ptr+1);
2897
2898     /* Cut out any "delete" items on the list. */
2899
2900     for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2901       {
2902       if (Ustrcmp(r->key, ptr+1) == 0)           /* Found item with same key */
2903         {
2904         if ((r->flags & rf_delete) == 0) break;  /* It was not "delete" */
2905         *rp = r->next;                           /* Excise a delete item */
2906         DEBUG(D_deliver|D_retry)
2907           debug_printf("  existing delete item dropped\n");
2908         }
2909       }
2910
2911     /* We want to add a delete item only if there is no non-delete item;
2912     however we still have to step ptr through the data. */
2913
2914     if (r == NULL || (*ptr & rf_delete) == 0)
2915       {
2916       r = store_get(sizeof(retry_item));
2917       r->next = addr->retries;
2918       addr->retries = r;
2919       r->flags = *ptr++;
2920       r->key = string_copy(ptr);
2921       while (*ptr++);
2922       memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2923       ptr += sizeof(r->basic_errno);
2924       memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2925       ptr += sizeof(r->more_errno);
2926       r->message = (*ptr)? string_copy(ptr) : NULL;
2927       DEBUG(D_deliver|D_retry)
2928         debug_printf("  added %s item\n",
2929           ((r->flags & rf_delete) == 0)? "retry" : "delete");
2930       }
2931
2932     else
2933       {
2934       DEBUG(D_deliver|D_retry)
2935         debug_printf("  delete item not added: non-delete item exists\n");
2936       ptr++;
2937       while(*ptr++);
2938       ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2939       }
2940
2941     while(*ptr++);
2942     break;
2943
2944     /* Put the amount of data written into the parlist block */
2945
2946     case 'S':
2947     memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2948     ptr += sizeof(transport_count);
2949     break;
2950
2951     /* Address items are in the order of items on the address chain. We
2952     remember the current address value in case this function is called
2953     several times to empty the pipe in stages. Information about delivery
2954     over TLS is sent in a preceding X item for each address. We don't put
2955     it in with the other info, in order to keep each message short enough to
2956     guarantee it won't be split in the pipe. */
2957
2958     #ifdef SUPPORT_TLS
2959     case 'X':
2960     if (addr == NULL) goto ADDR_MISMATCH;            /* Below, in 'A' handler */
2961     addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2962     while (*ptr++);
2963     addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2964     while (*ptr++);
2965     break;
2966     #endif
2967
2968     case 'C':   /* client authenticator information */
2969     switch (*ptr++)
2970     {
2971     case '1':
2972       addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2973       break;
2974     case '2':
2975       addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2976       break;
2977     case '3':
2978       addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2979       break;
2980     }
2981     while (*ptr++);
2982     break;
2983
2984 #ifdef EXPERIMENTAL_PRDR
2985     case 'P':
2986       addr->flags |= af_prdr_used; break;
2987 #endif
2988
2989     case 'A':
2990     if (addr == NULL)
2991       {
2992       ADDR_MISMATCH:
2993       msg = string_sprintf("address count mismatch for data read from pipe "
2994         "for transport process %d for transport %s", pid,
2995           addrlist->transport->driver_name);
2996       done = TRUE;
2997       break;
2998       }
2999
3000     addr->transport_return = *ptr++;
3001     addr->special_action = *ptr++;
3002     memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3003     ptr += sizeof(addr->basic_errno);
3004     memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3005     ptr += sizeof(addr->more_errno);
3006     memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3007     ptr += sizeof(addr->flags);
3008     addr->message = (*ptr)? string_copy(ptr) : NULL;
3009     while(*ptr++);
3010     addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3011     while(*ptr++);
3012
3013     /* Always two strings for host information, followed by the port number */
3014
3015     if (*ptr != 0)
3016       {
3017       h = store_get(sizeof(host_item));
3018       h->name = string_copy(ptr);
3019       while (*ptr++);
3020       h->address = string_copy(ptr);
3021       while(*ptr++);
3022       memcpy(&(h->port), ptr, sizeof(h->port));
3023       ptr += sizeof(h->port);
3024       addr->host_used = h;
3025       }
3026     else ptr++;
3027
3028     /* Finished with this address */
3029
3030     addr = addr->next;
3031     break;
3032
3033     /* Z marks the logical end of the data. It is followed by '0' if
3034     continue_transport was NULL at the end of transporting, otherwise '1'.
3035     We need to know when it becomes NULL during a delivery down a passed SMTP
3036     channel so that we don't try to pass anything more down it. Of course, for
3037     most normal messages it will remain NULL all the time. */
3038
3039     case 'Z':
3040     if (*ptr == '0')
3041       {
3042       continue_transport = NULL;
3043       continue_hostname = NULL;
3044       }
3045     done = TRUE;
3046     DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3047     break;
3048
3049     /* Anything else is a disaster. */
3050
3051     default:
3052     msg = string_sprintf("malformed data (%d) read from pipe for transport "
3053       "process %d for transport %s", ptr[-1], pid,
3054         addr->transport->driver_name);
3055     done = TRUE;
3056     break;
3057     }
3058   }
3059
3060 /* The done flag is inspected externally, to determine whether or not to
3061 call the function again when the process finishes. */
3062
3063 p->done = done;
3064
3065 /* If the process hadn't finished, and we haven't seen the end of the data
3066 or suffered a disaster, update the rest of the state, and return FALSE to
3067 indicate "not finished". */
3068
3069 if (!eop && !done)
3070   {
3071   p->addr = addr;
3072   p->msg = msg;
3073   return FALSE;
3074   }
3075
3076 /* Close our end of the pipe, to prevent deadlock if the far end is still
3077 pushing stuff into it. */
3078
3079 (void)close(fd);
3080 p->fd = -1;
3081
3082 /* If we have finished without error, but haven't had data for every address,
3083 something is wrong. */
3084
3085 if (msg == NULL && addr != NULL)
3086   msg = string_sprintf("insufficient address data read from pipe "
3087     "for transport process %d for transport %s", pid,
3088       addr->transport->driver_name);
3089
3090 /* If an error message is set, something has gone wrong in getting back
3091 the delivery data. Put the message into each address and freeze it. */
3092
3093 if (msg != NULL)
3094   {
3095   for (addr = addrlist; addr != NULL; addr = addr->next)
3096     {
3097     addr->transport_return = DEFER;
3098     addr->special_action = SPECIAL_FREEZE;
3099     addr->message = msg;
3100     }
3101   }
3102
3103 /* Return TRUE to indicate we have got all we need from this process, even
3104 if it hasn't actually finished yet. */
3105
3106 return TRUE;
3107 }
3108
3109
3110
3111 /*************************************************
3112 *   Post-process a set of remote addresses       *
3113 *************************************************/
3114
3115 /* Do what has to be done immediately after a remote delivery for each set of
3116 addresses, then re-write the spool if necessary. Note that post_process_one
3117 puts the address on an appropriate queue; hence we must fish off the next
3118 one first. This function is also called if there is a problem with setting
3119 up a subprocess to do a remote delivery in parallel. In this case, the final
3120 argument contains a message, and the action must be forced to DEFER.
3121
3122 Argument:
3123    addr      pointer to chain of address items
3124    logflags  flags for logging
3125    msg       NULL for normal cases; -> error message for unexpected problems
3126    fallback  TRUE if processing fallback hosts
3127
3128 Returns:     nothing
3129 */
3130
3131 static void
3132 remote_post_process(address_item *addr, int logflags, uschar *msg,
3133   BOOL fallback)
3134 {
3135 host_item *h;
3136
3137 /* If any host addresses were found to be unusable, add them to the unusable
3138 tree so that subsequent deliveries don't try them. */
3139
3140 for (h = addr->host_list; h != NULL; h = h->next)
3141   {
3142   if (h->address == NULL) continue;
3143   if (h->status >= hstatus_unusable) tree_add_unusable(h);
3144   }
3145
3146 /* Now handle each address on the chain. The transport has placed '=' or '-'
3147 into the special_action field for each successful delivery. */
3148
3149 while (addr != NULL)
3150   {
3151   address_item *next = addr->next;
3152
3153   /* If msg == NULL (normal processing) and the result is DEFER and we are
3154   processing the main hosts and there are fallback hosts available, put the
3155   address on the list for fallback delivery. */
3156
3157   if (addr->transport_return == DEFER &&
3158       addr->fallback_hosts != NULL &&
3159       !fallback &&
3160       msg == NULL)
3161     {
3162     addr->host_list = addr->fallback_hosts;
3163     addr->next = addr_fallback;
3164     addr_fallback = addr;
3165     DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3166     }
3167
3168   /* If msg is set (=> unexpected problem), set it in the address before
3169   doing the ordinary post processing. */
3170
3171   else
3172     {
3173     if (msg != NULL)
3174       {
3175       addr->message = msg;
3176       addr->transport_return = DEFER;
3177       }
3178     (void)post_process_one(addr, addr->transport_return, logflags,
3179       DTYPE_TRANSPORT, addr->special_action);
3180     }
3181
3182   /* Next address */
3183
3184   addr = next;
3185   }
3186
3187 /* If we have just delivered down a passed SMTP channel, and that was
3188 the last address, the channel will have been closed down. Now that
3189 we have logged that delivery, set continue_sequence to 1 so that
3190 any subsequent deliveries don't get "*" incorrectly logged. */
3191
3192 if (continue_transport == NULL) continue_sequence = 1;
3193 }
3194
3195
3196
3197 /*************************************************
3198 *     Wait for one remote delivery subprocess    *
3199 *************************************************/
3200
3201 /* This function is called while doing remote deliveries when either the
3202 maximum number of processes exist and we need one to complete so that another
3203 can be created, or when waiting for the last ones to complete. It must wait for
3204 the completion of one subprocess, empty the control block slot, and return a
3205 pointer to the address chain.
3206
3207 Arguments:    none
3208 Returns:      pointer to the chain of addresses handled by the process;
3209               NULL if no subprocess found - this is an unexpected error
3210 */
3211
3212 static address_item *
3213 par_wait(void)
3214 {
3215 int poffset, status;
3216 address_item *addr, *addrlist;
3217 pid_t pid;
3218
3219 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3220   "to finish", message_id);
3221
3222 /* Loop until either a subprocess completes, or there are no subprocesses in
3223 existence - in which case give an error return. We cannot proceed just by
3224 waiting for a completion, because a subprocess may have filled up its pipe, and
3225 be waiting for it to be emptied. Therefore, if no processes have finished, we
3226 wait for one of the pipes to acquire some data by calling select(), with a
3227 timeout just in case.
3228
3229 The simple approach is just to iterate after reading data from a ready pipe.
3230 This leads to non-ideal behaviour when the subprocess has written its final Z
3231 item, closed the pipe, and is in the process of exiting (the common case). A
3232 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3233 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3234 actually finished.
3235
3236 To avoid this, if all the data that is needed has been read from a subprocess
3237 after select(), an explicit wait() for it is done. We know that all it is doing
3238 is writing to the pipe and then exiting, so the wait should not be long.
3239
3240 The non-blocking waitpid() is to some extent just insurance; if we could
3241 reliably detect end-of-file on the pipe, we could always know when to do a
3242 blocking wait() for a completed process. However, because some systems use
3243 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3244 use code that functions without the need to recognize EOF.
3245
3246 There's a double loop here just in case we end up with a process that is not in
3247 the list of remote delivery processes. Something has obviously gone wrong if
3248 this is the case. (For example, a process that is incorrectly left over from
3249 routing or local deliveries might be found.) The damage can be minimized by
3250 looping back and looking for another process. If there aren't any, the error
3251 return will happen. */
3252
3253 for (;;)   /* Normally we do not repeat this loop */
3254   {
3255   while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3256     {
3257     struct timeval tv;
3258     fd_set select_pipes;
3259     int maxpipe, readycount;
3260
3261     /* A return value of -1 can mean several things. If errno != ECHILD, it
3262     either means invalid options (which we discount), or that this process was
3263     interrupted by a signal. Just loop to try the waitpid() again.
3264
3265     If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3266     in existence. This should never happen, and is an unexpected error.
3267     However, there is a nasty complication when running under Linux. If "strace
3268     -f" is being used under Linux to trace this process and its children,
3269     subprocesses are "stolen" from their parents and become the children of the
3270     tracing process. A general wait such as the one we've just obeyed returns
3271     as if there are no children while subprocesses are running. Once a
3272     subprocess completes, it is restored to the parent, and waitpid(-1) finds
3273     it. Thanks to Joachim Wieland for finding all this out and suggesting a
3274     palliative.
3275
3276     This does not happen using "truss" on Solaris, nor (I think) with other
3277     tracing facilities on other OS. It seems to be specific to Linux.
3278
3279     What we do to get round this is to use kill() to see if any of our
3280     subprocesses are still in existence. If kill() gives an OK return, we know
3281     it must be for one of our processes - it can't be for a re-use of the pid,
3282     because if our process had finished, waitpid() would have found it. If any
3283     of our subprocesses are in existence, we proceed to use select() as if
3284     waitpid() had returned zero. I think this is safe. */
3285
3286     if (pid < 0)
3287       {
3288       if (errno != ECHILD) continue;   /* Repeats the waitpid() */
3289
3290       DEBUG(D_deliver)
3291         debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3292           "for process existence\n");
3293
3294       for (poffset = 0; poffset < remote_max_parallel; poffset++)
3295         {
3296         if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3297           {
3298           DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3299             "stolen by strace\n", (int)pid);
3300           break;   /* With poffset set */
3301           }
3302         }
3303
3304       if (poffset >= remote_max_parallel)
3305         {
3306         DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3307         return NULL;   /* This is the error return */
3308         }
3309       }
3310
3311     /* A pid value greater than 0 breaks the "while" loop. A negative value has
3312     been handled above. A return value of zero means that there is at least one
3313     subprocess, but there are no completed subprocesses. See if any pipes are
3314     ready with any data for reading. */
3315
3316     DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3317
3318     maxpipe = 0;
3319     FD_ZERO(&select_pipes);
3320     for (poffset = 0; poffset < remote_max_parallel; poffset++)
3321       {
3322       if (parlist[poffset].pid != 0)
3323         {
3324         int fd = parlist[poffset].fd;
3325         FD_SET(fd, &select_pipes);
3326         if (fd > maxpipe) maxpipe = fd;
3327         }
3328       }
3329
3330     /* Stick in a 60-second timeout, just in case. */
3331
3332     tv.tv_sec = 60;
3333     tv.tv_usec = 0;
3334
3335     readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3336          NULL, NULL, &tv);
3337
3338     /* Scan through the pipes and read any that are ready; use the count
3339     returned by select() to stop when there are no more. Select() can return
3340     with no processes (e.g. if interrupted). This shouldn't matter.
3341
3342     If par_read_pipe() returns TRUE, it means that either the terminating Z was
3343     read, or there was a disaster. In either case, we are finished with this
3344     process. Do an explicit wait() for the process and break the main loop if
3345     it succeeds.
3346
3347     It turns out that we have to deal with the case of an interrupted system
3348     call, which can happen on some operating systems if the signal handling is
3349     set up to do that by default. */
3350
3351     for (poffset = 0;
3352          readycount > 0 && poffset < remote_max_parallel;
3353          poffset++)
3354       {
3355       if ((pid = parlist[poffset].pid) != 0 &&
3356            FD_ISSET(parlist[poffset].fd, &select_pipes))
3357         {
3358         readycount--;
3359         if (par_read_pipe(poffset, FALSE))    /* Finished with this pipe */
3360           {
3361           for (;;)                            /* Loop for signals */
3362             {
3363             pid_t endedpid = waitpid(pid, &status, 0);
3364             if (endedpid == pid) goto PROCESS_DONE;
3365             if (endedpid != (pid_t)(-1) || errno != EINTR)
3366               log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3367                 "%d (errno = %d) from waitpid() for process %d",
3368                 (int)endedpid, errno, (int)pid);
3369             }
3370           }
3371         }
3372       }
3373
3374     /* Now go back and look for a completed subprocess again. */
3375     }
3376
3377   /* A completed process was detected by the non-blocking waitpid(). Find the
3378   data block that corresponds to this subprocess. */
3379
3380   for (poffset = 0; poffset < remote_max_parallel; poffset++)
3381     if (pid == parlist[poffset].pid) break;
3382
3383   /* Found the data block; this is a known remote delivery process. We don't
3384   need to repeat the outer loop. This should be what normally happens. */
3385
3386   if (poffset < remote_max_parallel) break;
3387
3388   /* This situation is an error, but it's probably better to carry on looking
3389   for another process than to give up (as we used to do). */
3390
3391   log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3392     "transport process list", pid);
3393   }  /* End of the "for" loop */
3394
3395 /* Come here when all the data was completely read after a select(), and
3396 the process in pid has been wait()ed for. */
3397
3398 PROCESS_DONE:
3399
3400 DEBUG(D_deliver)
3401   {
3402   if (status == 0)
3403     debug_printf("remote delivery process %d ended\n", (int)pid);
3404   else
3405     debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3406       status);
3407   }
3408
3409 set_process_info("delivering %s", message_id);
3410
3411 /* Get the chain of processed addresses */
3412
3413 addrlist = parlist[poffset].addrlist;
3414
3415 /* If the process did not finish cleanly, record an error and freeze (except
3416 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3417 in case the delivery did actually happen. */
3418
3419 if ((status & 0xffff) != 0)
3420   {
3421   uschar *msg;
3422   int msb = (status >> 8) & 255;
3423   int lsb = status & 255;
3424   int code = (msb == 0)? (lsb & 0x7f) : msb;
3425
3426   msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3427     "%s %d",
3428     addrlist->transport->driver_name,
3429     status,
3430     (msb == 0)? "terminated by signal" : "exit code",
3431     code);
3432
3433   if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3434     addrlist->special_action = SPECIAL_FREEZE;
3435
3436   for (addr = addrlist; addr != NULL; addr = addr->next)
3437     {
3438     addr->transport_return = DEFER;
3439     addr->message = msg;
3440     }
3441
3442   remove_journal = FALSE;
3443   }
3444
3445 /* Else complete reading the pipe to get the result of the delivery, if all
3446 the data has not yet been obtained. */
3447
3448 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3449
3450 /* Put the data count and return path into globals, mark the data slot unused,
3451 decrement the count of subprocesses, and return the address chain. */
3452
3453 transport_count = parlist[poffset].transport_count;
3454 used_return_path = parlist[poffset].return_path;
3455 parlist[poffset].pid = 0;
3456 parcount--;
3457 return addrlist;
3458 }
3459
3460
3461
3462 /*************************************************
3463 *      Wait for subprocesses and post-process    *
3464 *************************************************/
3465
3466 /* This function waits for subprocesses until the number that are still running
3467 is below a given threshold. For each complete subprocess, the addresses are
3468 post-processed. If we can't find a running process, there is some shambles.
3469 Better not bomb out, as that might lead to multiple copies of the message. Just
3470 log and proceed as if all done.
3471
3472 Arguments:
3473   max         maximum number of subprocesses to leave running
3474   fallback    TRUE if processing fallback hosts
3475
3476 Returns:      nothing
3477 */
3478
3479 static void
3480 par_reduce(int max, BOOL fallback)
3481 {
3482 while (parcount > max)
3483   {
3484   address_item *doneaddr = par_wait();
3485   if (doneaddr == NULL)
3486     {
3487     log_write(0, LOG_MAIN|LOG_PANIC,
3488       "remote delivery process count got out of step");
3489     parcount = 0;
3490     }
3491   else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3492   }
3493 }
3494
3495
3496
3497
3498 static void
3499 rmt_dlv_checked_write(int fd, void * buf, int size)
3500 {
3501 int ret = write(fd, buf, size);
3502 if(ret != size)
3503   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3504     ret == -1 ? strerror(errno) : "short write");
3505 }
3506
3507 /*************************************************
3508 *           Do remote deliveries                 *
3509 *************************************************/
3510
3511 /* This function is called to process the addresses in addr_remote. We must
3512 pick off the queue all addresses that have the same transport, remote
3513 destination, and errors address, and hand them to the transport in one go,
3514 subject to some configured limitations. If this is a run to continue delivering
3515 to an existing delivery channel, skip all but those addresses that can go to
3516 that channel. The skipped addresses just get deferred.
3517
3518 If mua_wrapper is set, all addresses must be able to be sent in a single
3519 transaction. If not, this function yields FALSE.
3520
3521 In Exim 4, remote deliveries are always done in separate processes, even
3522 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3523 is so that the base process can retain privilege. This makes the
3524 implementation of fallback transports feasible (though not initially done.)
3525
3526 We create up to the configured number of subprocesses, each of which passes
3527 back the delivery state via a pipe. (However, when sending down an existing
3528 connection, remote_max_parallel is forced to 1.)
3529
3530 Arguments:
3531   fallback  TRUE if processing fallback hosts
3532
3533 Returns:    TRUE normally
3534             FALSE if mua_wrapper is set and the addresses cannot all be sent
3535               in one transaction
3536 */
3537
3538 static BOOL
3539 do_remote_deliveries(BOOL fallback)
3540 {
3541 int parmax;
3542 int delivery_count;
3543 int poffset;
3544
3545 parcount = 0;    /* Number of executing subprocesses */
3546
3547 /* When sending down an existing channel, only do one delivery at a time.
3548 We use a local variable (parmax) to hold the maximum number of processes;
3549 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3550
3551 if (continue_transport != NULL) remote_max_parallel = 1;
3552 parmax = remote_max_parallel;
3553
3554 /* If the data for keeping a list of processes hasn't yet been
3555 set up, do so. */
3556
3557 if (parlist == NULL)
3558   {
3559   parlist = store_get(remote_max_parallel * sizeof(pardata));
3560   for (poffset = 0; poffset < remote_max_parallel; poffset++)
3561     parlist[poffset].pid = 0;
3562   }
3563
3564 /* Now loop for each remote delivery */
3565
3566 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3567   {
3568   pid_t pid;
3569   uid_t uid;
3570   gid_t gid;
3571   int pfd[2];
3572   int address_count = 1;
3573   int address_count_max;
3574   BOOL multi_domain;
3575   BOOL use_initgroups;
3576   BOOL pipe_done = FALSE;
3577   transport_instance *tp;
3578   address_item **anchor = &addr_remote;
3579   address_item *addr = addr_remote;
3580   address_item *last = addr;
3581   address_item *next;
3582
3583   /* Pull the first address right off the list. */
3584
3585   addr_remote = addr->next;
3586   addr->next = NULL;
3587
3588   DEBUG(D_deliver|D_transport)
3589     debug_printf("--------> %s <--------\n", addr->address);
3590
3591   /* If no transport has been set, there has been a big screw-up somewhere. */
3592
3593   if ((tp = addr->transport) == NULL)
3594     {
3595     disable_logging = FALSE;  /* Jic */
3596     remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3597       US"No transport set by router", fallback);
3598     continue;
3599     }
3600
3601   /* Check that this base address hasn't previously been delivered to this
3602   transport. The check is necessary at this point to handle homonymic addresses
3603   correctly in cases where the pattern of redirection changes between delivery
3604   attempts. Non-homonymic previous delivery is detected earlier, at routing
3605   time. */
3606
3607   if (previously_transported(addr, FALSE)) continue;
3608
3609   /* Force failure if the message is too big. */
3610
3611   if (tp->message_size_limit != NULL)
3612     {
3613     int rc = check_message_size(tp, addr);
3614     if (rc != OK)
3615       {
3616       addr->transport_return = rc;
3617       remote_post_process(addr, LOG_MAIN, NULL, fallback);
3618       continue;
3619       }
3620     }
3621
3622   /* Get the flag which specifies whether the transport can handle different
3623   domains that nevertheless resolve to the same set of hosts. */
3624
3625   multi_domain = tp->multi_domain;
3626
3627   /* Get the maximum it can handle in one envelope, with zero meaning
3628   unlimited, which is forced for the MUA wrapper case. */
3629
3630   address_count_max = tp->max_addresses;
3631   if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3632
3633
3634   /************************************************************************/
3635   /*****    This is slightly experimental code, but should be safe.   *****/
3636
3637   /* The address_count_max value is the maximum number of addresses that the
3638   transport can send in one envelope. However, the transport must be capable of
3639   dealing with any number of addresses. If the number it gets exceeds its
3640   envelope limitation, it must send multiple copies of the message. This can be
3641   done over a single connection for SMTP, so uses less resources than making
3642   multiple connections. On the other hand, if remote_max_parallel is greater
3643   than one, it is perhaps a good idea to use parallel processing to move the
3644   message faster, even if that results in multiple simultaneous connections to
3645   the same host.
3646
3647   How can we come to some compromise between these two ideals? What we do is to
3648   limit the number of addresses passed to a single instance of a transport to
3649   the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3650   number of addresses routed to remote transports divided by
3651   remote_max_parallel. For example, if the message has 100 remote recipients,
3652   remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3653   once. But if rcpt_max is 100, we could send up to 100.
3654
3655   Of course, not all the remotely addresses in a message are going to go to the
3656   same set of hosts (except in smarthost configurations), so this is just a
3657   heuristic way of dividing up the work.
3658
3659   Furthermore (1), because this may not be wanted in some cases, and also to
3660   cope with really pathological cases, there is also a limit to the number of
3661   messages that are sent over one connection. This is the same limit that is
3662   used when sending several different messages over the same connection.
3663   Continue_sequence is set when in this situation, to the number sent so
3664   far, including this message.
3665
3666   Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3667   is probably because they are using VERP, in which case they want to pass only
3668   one address at a time to the transport, in order to be able to use
3669   $local_part and $domain in constructing a new return path. We could test for
3670   the use of these variables, but as it is so likely they will be used when the
3671   maximum is 1, we don't bother. Just leave the value alone. */
3672
3673   if (address_count_max != 1 &&
3674       address_count_max < remote_delivery_count/remote_max_parallel)
3675     {
3676     int new_max = remote_delivery_count/remote_max_parallel;
3677     int message_max = tp->connection_max_messages;
3678     if (connection_max_messages >= 0) message_max = connection_max_messages;
3679     message_max -= continue_sequence - 1;
3680     if (message_max > 0 && new_max > address_count_max * message_max)
3681       new_max = address_count_max * message_max;
3682     address_count_max = new_max;
3683     }
3684
3685   /************************************************************************/
3686
3687
3688   /* Pick off all addresses which have the same transport, errors address,
3689   destination, and extra headers. In some cases they point to the same host
3690   list, but we also need to check for identical host lists generated from
3691   entirely different domains. The host list pointers can be NULL in the case
3692   where the hosts are defined in the transport. There is also a configured
3693   maximum limit of addresses that can be handled at once (see comments above
3694   for how it is computed). */
3695
3696   while ((next = *anchor) != NULL && address_count < address_count_max)
3697     {
3698     if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3699         &&
3700         tp == next->transport
3701         &&
3702         same_hosts(next->host_list, addr->host_list)
3703         &&
3704         same_strings(next->p.errors_address, addr->p.errors_address)
3705         &&
3706         same_headers(next->p.extra_headers, addr->p.extra_headers)
3707         &&
3708         same_ugid(tp, next, addr)
3709         &&
3710         (next->p.remove_headers == addr->p.remove_headers ||
3711           (next->p.remove_headers != NULL &&
3712            addr->p.remove_headers != NULL &&
3713            Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3714       {
3715       *anchor = next->next;
3716       next->next = NULL;
3717       next->first = addr;  /* remember top one (for retry processing) */
3718       last->next = next;
3719       last = next;
3720       address_count++;
3721       }
3722     else anchor = &(next->next);
3723     }
3724
3725   /* If we are acting as an MUA wrapper, all addresses must go in a single
3726   transaction. If not, put them back on the chain and yield FALSE. */
3727
3728   if (mua_wrapper && addr_remote != NULL)
3729     {
3730     last->next = addr_remote;
3731     addr_remote = addr;
3732     return FALSE;
3733     }
3734
3735   /* Set up the expansion variables for this set of addresses */
3736
3737   deliver_set_expansions(addr);
3738
3739   /* Ensure any transport-set auth info is fresh */
3740   addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3741
3742   /* Compute the return path, expanding a new one if required. The old one
3743   must be set first, as it might be referred to in the expansion. */
3744
3745   if(addr->p.errors_address != NULL)
3746     return_path = addr->p.errors_address;
3747 #ifdef EXPERIMENTAL_SRS
3748   else if(addr->p.srs_sender != NULL)
3749     return_path = addr->p.srs_sender;
3750 #endif
3751   else
3752     return_path = sender_address;
3753
3754   if (tp->return_path != NULL)
3755     {
3756     uschar *new_return_path = expand_string(tp->return_path);
3757     if (new_return_path == NULL)
3758       {
3759       if (!expand_string_forcedfail)
3760         {
3761         remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3762           string_sprintf("Failed to expand return path \"%s\": %s",
3763           tp->return_path, expand_string_message), fallback);
3764         continue;
3765         }
3766       }
3767     else return_path = new_return_path;
3768     }
3769
3770   /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3771   logs and sets up error messages, so we just post-process and continue with
3772   the next address. */
3773
3774   if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3775     {
3776     remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3777     continue;
3778     }
3779
3780   /* If this transport has a setup function, call it now so that it gets
3781   run in this process and not in any subprocess. That way, the results of
3782   any setup that are retained by the transport can be reusable. One of the
3783   things the setup does is to set the fallback host lists in the addresses.
3784   That is why it is called at this point, before the continue delivery
3785   processing, because that might use the fallback hosts. */
3786
3787   if (tp->setup != NULL)
3788     (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3789
3790   /* If this is a run to continue delivery down an already-established
3791   channel, check that this set of addresses matches the transport and
3792   the channel. If it does not, defer the addresses. If a host list exists,
3793   we must check that the continue host is on the list. Otherwise, the
3794   host is set in the transport. */
3795
3796   continue_more = FALSE;           /* In case got set for the last lot */
3797   if (continue_transport != NULL)
3798     {
3799     BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3800     if (ok && addr->host_list != NULL)
3801       {
3802       host_item *h;
3803       ok = FALSE;
3804       for (h = addr->host_list; h != NULL; h = h->next)
3805         {
3806         if (Ustrcmp(h->name, continue_hostname) == 0)
3807           { ok = TRUE; break; }
3808         }
3809       }
3810
3811     /* Addresses not suitable; defer or queue for fallback hosts (which
3812     might be the continue host) and skip to next address. */
3813
3814     if (!ok)
3815       {
3816       DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3817       next = addr;
3818
3819       if (addr->fallback_hosts != NULL && !fallback)
3820         {
3821         for (;;)
3822           {
3823           next->host_list = next->fallback_hosts;
3824           DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3825           if (next->next == NULL) break;
3826           next = next->next;
3827           }
3828         next->next = addr_fallback;
3829         addr_fallback = addr;
3830         }
3831
3832       else
3833         {
3834         while (next->next != NULL) next = next->next;
3835         next->next = addr_defer;
3836         addr_defer = addr;
3837         }
3838
3839       continue;
3840       }
3841
3842     /* Set a flag indicating whether there are further addresses that list
3843     the continued host. This tells the transport to leave the channel open,
3844     but not to pass it to another delivery process. */
3845
3846     for (next = addr_remote; next != NULL; next = next->next)
3847       {
3848       host_item *h;
3849       for (h = next->host_list; h != NULL; h = h->next)
3850         {
3851         if (Ustrcmp(h->name, continue_hostname) == 0)
3852           { continue_more = TRUE; break; }
3853         }
3854       }
3855     }
3856
3857   /* The transports set up the process info themselves as they may connect
3858   to more than one remote machine. They also have to set up the filter
3859   arguments, if required, so that the host name and address are available
3860   for expansion. */
3861
3862   transport_filter_argv = NULL;
3863
3864   /* Create the pipe for inter-process communication. If pipe creation
3865   fails, it is probably because the value of remote_max_parallel is so
3866   large that too many file descriptors for pipes have been created. Arrange
3867   to wait for a process to finish, and then try again. If we still can't
3868   create a pipe when all processes have finished, break the retry loop. */
3869
3870   while (!pipe_done)
3871     {
3872     if (pipe(pfd) == 0) pipe_done = TRUE;
3873       else if (parcount > 0) parmax = parcount;
3874         else break;
3875
3876     /* We need to make the reading end of the pipe non-blocking. There are
3877     two different options for this. Exim is cunningly (I hope!) coded so
3878     that it can use either of them, though it prefers O_NONBLOCK, which
3879     distinguishes between EOF and no-more-data. */
3880
3881     #ifdef O_NONBLOCK
3882     (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3883     #else
3884     (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3885     #endif
3886
3887     /* If the maximum number of subprocesses already exist, wait for a process
3888     to finish. If we ran out of file descriptors, parmax will have been reduced
3889     from its initial value of remote_max_parallel. */
3890
3891     par_reduce(parmax - 1, fallback);
3892     }
3893
3894   /* If we failed to create a pipe and there were no processes to wait
3895   for, we have to give up on this one. Do this outside the above loop
3896   so that we can continue the main loop. */
3897
3898   if (!pipe_done)
3899     {
3900     remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3901       string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3902     continue;
3903     }
3904
3905   /* Find a free slot in the pardata list. Must do this after the possible
3906   waiting for processes to finish, because a terminating process will free
3907   up a slot. */
3908
3909   for (poffset = 0; poffset < remote_max_parallel; poffset++)
3910     if (parlist[poffset].pid == 0) break;
3911
3912   /* If there isn't one, there has been a horrible disaster. */
3913
3914   if (poffset >= remote_max_parallel)
3915     {
3916     (void)close(pfd[pipe_write]);
3917     (void)close(pfd[pipe_read]);
3918     remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3919       US"Unexpectedly no free subprocess slot", fallback);
3920     continue;
3921     }
3922
3923   /* Now fork a subprocess to do the remote delivery, but before doing so,
3924   ensure that any cached resourses are released so as not to interfere with
3925   what happens in the subprocess. */
3926
3927   search_tidyup();
3928
3929   if ((pid = fork()) == 0)
3930     {
3931     int fd = pfd[pipe_write];
3932     host_item *h;
3933
3934     /* Setting this global in the subprocess means we need never clear it */
3935     transport_name = tp->name;
3936
3937     /* There are weird circumstances in which logging is disabled */
3938     disable_logging = tp->disable_logging;
3939
3940     /* Show pids on debug output if parallelism possible */
3941
3942     if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3943       {
3944       DEBUG(D_any|D_v) debug_selector |= D_pid;
3945       DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3946       }
3947
3948     /* Reset the random number generator, so different processes don't all
3949     have the same sequence. In the test harness we want different, but
3950     predictable settings for each delivery process, so do something explicit
3951     here rather they rely on the fixed reset in the random number function. */
3952
3953     random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3954
3955     /* Set close-on-exec on the pipe so that it doesn't get passed on to
3956     a new process that may be forked to do another delivery down the same
3957     SMTP connection. */
3958
3959     (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3960
3961     /* Close open file descriptors for the pipes of other processes
3962     that are running in parallel. */
3963
3964     for (poffset = 0; poffset < remote_max_parallel; poffset++)
3965       if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3966
3967     /* This process has inherited a copy of the file descriptor
3968     for the data file, but its file pointer is shared with all the
3969     other processes running in parallel. Therefore, we have to re-open
3970     the file in order to get a new file descriptor with its own
3971     file pointer. We don't need to lock it, as the lock is held by
3972     the parent process. There doesn't seem to be any way of doing
3973     a dup-with-new-file-pointer. */
3974
3975     (void)close(deliver_datafile);
3976     sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3977       message_id);
3978     deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3979
3980     if (deliver_datafile < 0)
3981       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3982         "parallel delivery: %s", spoolname, strerror(errno));
3983
3984     /* Set the close-on-exec flag */
3985
3986     (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3987       FD_CLOEXEC);
3988
3989     /* Set the uid/gid of this process; bombs out on failure. */
3990
3991     exim_setugid(uid, gid, use_initgroups,
3992       string_sprintf("remote delivery to %s with transport=%s",
3993         addr->address, tp->name));
3994
3995     /* Close the unwanted half of this process' pipe, set the process state,
3996     and run the transport. Afterwards, transport_count will contain the number
3997     of bytes written. */
3998
3999     (void)close(pfd[pipe_read]);
4000     set_process_info("delivering %s using %s", message_id, tp->name);
4001     debug_print_string(tp->debug_string);
4002     if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4003
4004     set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4005       message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4006
4007     /* Ensure any cached resources that we used are now released */
4008
4009     search_tidyup();
4010
4011     /* Pass the result back down the pipe. This is a lot more information
4012     than is needed for a local delivery. We have to send back the error
4013     status for each address, the usability status for each host that is
4014     flagged as unusable, and all the retry items. When TLS is in use, we
4015     send also the cipher and peerdn information. Each type of information
4016     is flagged by an identifying byte, and is then in a fixed format (with
4017     strings terminated by zeros), and there is a final terminator at the
4018     end. The host information and retry information is all attached to
4019     the first address, so that gets sent at the start. */
4020
4021     /* Host unusability information: for most success cases this will
4022     be null. */
4023
4024     for (h = addr->host_list; h != NULL; h = h->next)
4025       {
4026       if (h->address == NULL || h->status < hstatus_unusable) continue;
4027       sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4028       rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4029       }
4030
4031     /* The number of bytes written. This is the same for each address. Even
4032     if we sent several copies of the message down the same connection, the
4033     size of each one is the same, and it's that value we have got because
4034     transport_count gets reset before calling transport_write_message(). */
4035
4036     big_buffer[0] = 'S';
4037     memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4038     rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4039
4040     /* Information about what happened to each address. Four item types are
4041     used: an optional 'X' item first, for TLS information, then an optional "C"
4042     item for any client-auth info followed by 'R' items for any retry settings,
4043     and finally an 'A' item for the remaining data. */
4044
4045     for(; addr != NULL; addr = addr->next)
4046       {
4047       uschar *ptr;
4048       retry_item *r;
4049
4050       /* The certificate verification status goes into the flags */
4051
4052       if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4053
4054       /* Use an X item only if there's something to send */
4055
4056       #ifdef SUPPORT_TLS
4057       if (addr->cipher != NULL)
4058         {
4059         ptr = big_buffer;
4060         sprintf(CS ptr, "X%.128s", addr->cipher);
4061         while(*ptr++);
4062         if (addr->peerdn == NULL) *ptr++ = 0; else
4063           {
4064           sprintf(CS ptr, "%.512s", addr->peerdn);
4065           while(*ptr++);
4066           }
4067         rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4068         }
4069       #endif
4070
4071       if (client_authenticator)
4072         {
4073         ptr = big_buffer;
4074         sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4075         while(*ptr++);
4076         rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4077         }
4078       if (client_authenticated_id)
4079         {
4080         ptr = big_buffer;
4081         sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4082         while(*ptr++);
4083         rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4084         }
4085       if (client_authenticated_sender)
4086         {
4087         ptr = big_buffer;
4088         sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4089         while(*ptr++);
4090         rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4091         }
4092
4093       #ifdef EXPERIMENTAL_PRDR
4094       if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4095       #endif
4096
4097       /* Retry information: for most success cases this will be null. */
4098
4099       for (r = addr->retries; r != NULL; r = r->next)
4100         {
4101         uschar *ptr;
4102         sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4103         ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4104         memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4105         ptr += sizeof(r->basic_errno);
4106         memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4107         ptr += sizeof(r->more_errno);
4108         if (r->message == NULL) *ptr++ = 0; else
4109           {
4110           sprintf(CS ptr, "%.512s", r->message);
4111           while(*ptr++);
4112           }
4113         rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4114         }
4115
4116       /* The rest of the information goes in an 'A' item. */
4117
4118       ptr = big_buffer + 3;
4119       sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4120         addr->special_action);
4121       memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4122       ptr += sizeof(addr->basic_errno);
4123       memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4124       ptr += sizeof(addr->more_errno);
4125       memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4126       ptr += sizeof(addr->flags);
4127
4128       if (addr->message == NULL) *ptr++ = 0; else
4129         {
4130         sprintf(CS ptr, "%.1024s", addr->message);
4131         while(*ptr++);
4132         }
4133
4134       if (addr->user_message == NULL) *ptr++ = 0; else
4135         {
4136         sprintf(CS ptr, "%.1024s", addr->user_message);
4137         while(*ptr++);
4138         }
4139
4140       if (addr->host_used == NULL) *ptr++ = 0; else
4141         {
4142         sprintf(CS ptr, "%.256s", addr->host_used->name);
4143         while(*ptr++);
4144         sprintf(CS ptr, "%.64s", addr->host_used->address);
4145         while(*ptr++);
4146         memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4147         ptr += sizeof(addr->host_used->port);
4148         }
4149       rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4150       }
4151
4152     /* Add termination flag, close the pipe, and that's it. The character
4153     after 'Z' indicates whether continue_transport is now NULL or not.
4154     A change from non-NULL to NULL indicates a problem with a continuing
4155     connection. */
4156
4157     big_buffer[0] = 'Z';
4158     big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4159     rmt_dlv_checked_write(fd, big_buffer, 2);
4160     (void)close(fd);
4161     exit(EXIT_SUCCESS);
4162     }
4163
4164   /* Back in the mainline: close the unwanted half of the pipe. */
4165
4166   (void)close(pfd[pipe_write]);
4167
4168   /* Fork failed; defer with error message */
4169
4170   if (pid < 0)
4171     {
4172     (void)close(pfd[pipe_read]);
4173     remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4174       string_sprintf("fork failed for remote delivery to %s: %s",
4175         addr->domain, strerror(errno)), fallback);
4176     continue;
4177     }
4178
4179   /* Fork succeeded; increment the count, and remember relevant data for
4180   when the process finishes. */
4181
4182   parcount++;
4183   parlist[poffset].addrlist = parlist[poffset].addr = addr;
4184   parlist[poffset].pid = pid;
4185   parlist[poffset].fd = pfd[pipe_read];
4186   parlist[poffset].done = FALSE;
4187   parlist[poffset].msg = NULL;
4188   parlist[poffset].return_path = return_path;
4189
4190   /* If the process we've just started is sending a message down an existing
4191   channel, wait for it now. This ensures that only one such process runs at
4192   once, whatever the value of remote_max parallel. Otherwise, we might try to
4193   send two or more messages simultaneously down the same channel. This could
4194   happen if there are different domains that include the same host in otherwise
4195   different host lists.
4196
4197   Also, if the transport closes down the channel, this information gets back
4198   (continue_transport gets set to NULL) before we consider any other addresses
4199   in this message. */
4200
4201   if (continue_transport != NULL) par_reduce(0, fallback);
4202
4203   /* Otherwise, if we are running in the test harness, wait a bit, to let the
4204   newly created process get going before we create another process. This should
4205   ensure repeatability in the tests. We only need to wait a tad. */
4206
4207   else if (running_in_test_harness) millisleep(500);
4208   }
4209
4210 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4211 are still running and post-process their addresses. */
4212
4213 par_reduce(0, fallback);
4214 return TRUE;
4215 }
4216
4217
4218
4219
4220 /*************************************************
4221 *   Split an address into local part and domain  *
4222 *************************************************/
4223
4224 /* This function initializes an address for routing by splitting it up into a
4225 local part and a domain. The local part is set up twice - once in its original
4226 casing, and once in lower case, and it is dequoted. We also do the "percent
4227 hack" for configured domains. This may lead to a DEFER result if a lookup
4228 defers. When a percent-hacking takes place, we insert a copy of the original
4229 address as a new parent of this address, as if we have had a redirection.
4230
4231 Argument:
4232   addr      points to an addr_item block containing the address
4233
4234 Returns:    OK
4235             DEFER   - could not determine if domain is %-hackable
4236 */
4237
4238 int
4239 deliver_split_address(address_item *addr)
4240 {
4241 uschar *address = addr->address;
4242 uschar *domain = Ustrrchr(address, '@');
4243 uschar *t;
4244 int len = domain - address;
4245
4246 addr->domain = string_copylc(domain+1);    /* Domains are always caseless */
4247
4248 /* The implication in the RFCs (though I can't say I've seen it spelled out
4249 explicitly) is that quoting should be removed from local parts at the point
4250 where they are locally interpreted. [The new draft "821" is more explicit on
4251 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4252 removing quoting backslashes and any unquoted doublequotes. */
4253
4254 t = addr->cc_local_part = store_get(len+1);
4255 while(len-- > 0)
4256   {
4257   register int c = *address++;
4258   if (c == '\"') continue;
4259   if (c == '\\')
4260     {
4261     *t++ = *address++;
4262     len--;
4263     }
4264   else *t++ = c;
4265   }
4266 *t = 0;
4267
4268 /* We do the percent hack only for those domains that are listed in
4269 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4270
4271 if (percent_hack_domains != NULL)
4272   {
4273   int rc;
4274   uschar *new_address = NULL;
4275   uschar *local_part = addr->cc_local_part;
4276
4277   deliver_domain = addr->domain;  /* set $domain */
4278
4279   while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4280            &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4281              == OK &&
4282          (t = Ustrrchr(local_part, '%')) != NULL)
4283     {
4284     new_address = string_copy(local_part);
4285     new_address[t - local_part] = '@';
4286     deliver_domain = string_copylc(t+1);
4287     local_part = string_copyn(local_part, t - local_part);
4288     }
4289
4290   if (rc == DEFER) return DEFER;   /* lookup deferred */
4291
4292   /* If hackery happened, set up new parent and alter the current address. */
4293
4294   if (new_address != NULL)
4295     {
4296     address_item *new_parent = store_get(sizeof(address_item));
4297     *new_parent = *addr;
4298     addr->parent = new_parent;
4299     addr->address = new_address;
4300     addr->unique = string_copy(new_address);
4301     addr->domain = deliver_domain;
4302     addr->cc_local_part = local_part;
4303     DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4304       addr->address);
4305     }
4306   }
4307
4308 /* Create the lowercased version of the final local part, and make that the
4309 default one to be used. */
4310
4311 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4312 return OK;
4313 }
4314
4315
4316
4317
4318 /*************************************************
4319 *      Get next error message text               *
4320 *************************************************/
4321
4322 /* If f is not NULL, read the next "paragraph", from a customized error message
4323 text file, terminated by a line containing ****, and expand it.
4324
4325 Arguments:
4326   f          NULL or a file to read from
4327   which      string indicating which string (for errors)
4328
4329 Returns:     NULL or an expanded string
4330 */
4331
4332 static uschar *
4333 next_emf(FILE *f, uschar *which)
4334 {
4335 int size = 256;
4336 int ptr = 0;
4337 uschar *para, *yield;
4338 uschar buffer[256];
4339
4340 if (f == NULL) return NULL;
4341
4342 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4343     Ustrcmp(buffer, "****\n") == 0) return NULL;
4344
4345 para = store_get(size);
4346 for (;;)
4347   {
4348   para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4349   if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4350       Ustrcmp(buffer, "****\n") == 0) break;
4351   }
4352 para[ptr] = 0;
4353
4354 yield = expand_string(para);
4355 if (yield != NULL) return yield;
4356
4357 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4358   "bounce_message_file or warn_message_file (%s): %s", which,
4359   expand_string_message);
4360 return NULL;
4361 }
4362
4363
4364
4365
4366 /*************************************************
4367 *      Close down a passed transport channel     *
4368 *************************************************/
4369
4370 /* This function is called when a passed transport channel cannot be used.
4371 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4372 so that the function call can be the argument of a "return" statement.
4373
4374 Arguments:  None
4375 Returns:    DELIVER_NOT_ATTEMPTED
4376 */
4377
4378 static int
4379 continue_closedown(void)
4380 {
4381 if (continue_transport != NULL)
4382   {
4383   transport_instance *t;
4384   for (t = transports; t != NULL; t = t->next)
4385     {
4386     if (Ustrcmp(t->name, continue_transport) == 0)
4387       {
4388       if (t->info->closedown != NULL) (t->info->closedown)(t);
4389       break;
4390       }
4391     }
4392   }
4393 return DELIVER_NOT_ATTEMPTED;
4394 }
4395
4396
4397
4398
4399 /*************************************************
4400 *           Print address information            *
4401 *************************************************/
4402
4403 /* This function is called to output an address, or information about an
4404 address, for bounce or defer messages. If the hide_child flag is set, all we
4405 output is the original ancestor address.
4406
4407 Arguments:
4408   addr         points to the address
4409   f            the FILE to print to
4410   si           an initial string
4411   sc           a continuation string for before "generated"
4412   se           an end string
4413
4414 Returns:       TRUE if the address is not hidden
4415 */
4416
4417 static BOOL
4418 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4419   uschar *se)
4420 {
4421 BOOL yield = TRUE;
4422 uschar *printed = US"";
4423 address_item *ancestor = addr;
4424 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4425
4426 fprintf(f, "%s", CS si);
4427
4428 if (addr->parent != NULL && testflag(addr, af_hide_child))
4429   {
4430   printed = US"an undisclosed address";
4431   yield = FALSE;
4432   }
4433 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4434   printed = addr->address;
4435
4436 else
4437   {
4438   uschar *s = addr->address;
4439   uschar *ss;
4440
4441   if (addr->address[0] == '>') { ss = US"mail"; s++; }
4442   else if (addr->address[0] == '|') ss = US"pipe";
4443   else ss = US"save";
4444
4445   fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4446   printed = addr->parent->address;
4447   }
4448
4449 fprintf(f, "%s", CS string_printing(printed));
4450
4451 if (ancestor != addr)
4452   {
4453   uschar *original = (ancestor->onetime_parent == NULL)?
4454     ancestor->address : ancestor->onetime_parent;
4455   if (strcmpic(original, printed) != 0)
4456     fprintf(f, "%s(%sgenerated from %s)", sc,
4457       (ancestor != addr->parent)? "ultimately " : "",
4458       string_printing(original));
4459   }
4460
4461 fprintf(f, "%s", CS se);
4462 return yield;
4463 }
4464
4465
4466
4467
4468
4469 /*************************************************
4470 *         Print error for an address             *
4471 *************************************************/
4472
4473 /* This function is called to print the error information out of an address for
4474 a bounce or a warning message. It tries to format the message reasonably by
4475 introducing newlines. All lines are indented by 4; the initial printing
4476 position must be set before calling.
4477
4478 This function used always to print the error. Nowadays we want to restrict it
4479 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4480 and filter "fail". We no longer pass other information willy-nilly in bounce
4481 and warning messages. Text in user_message is always output; text in message
4482 only if the af_pass_message flag is set.
4483
4484 Arguments:
4485   addr         the address
4486   f            the FILE to print on
4487   t            some leading text
4488
4489 Returns:       nothing
4490 */
4491
4492 static void
4493 print_address_error(address_item *addr, FILE *f, uschar *t)
4494 {
4495 int count = Ustrlen(t);
4496 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4497
4498 if (s == NULL)
4499   {
4500   if (addr->user_message != NULL) s = addr->user_message; else return;
4501   }
4502
4503 fprintf(f, "\n    %s", t);
4504
4505 while (*s != 0)
4506   {
4507   if (*s == '\\' && s[1] == 'n')
4508     {
4509     fprintf(f, "\n    ");
4510     s += 2;
4511     count = 0;
4512     }
4513   else
4514     {
4515     fputc(*s, f);
4516     count++;
4517     if (*s++ == ':' && isspace(*s) && count > 45)
4518       {
4519       fprintf(f, "\n   ");  /* sic (because space follows) */
4520       count = 0;
4521       }
4522     }
4523   }
4524 }
4525
4526
4527
4528
4529
4530
4531 /*************************************************
4532 *     Check list of addresses for duplication    *
4533 *************************************************/
4534
4535 /* This function was introduced when the test for duplicate addresses that are
4536 not pipes, files, or autoreplies was moved from the middle of routing to when
4537 routing was complete. That was to fix obscure cases when the routing history
4538 affects the subsequent routing of identical addresses. This function is called
4539 after routing, to check that the final routed addresses are not duplicates.
4540
4541 If we detect a duplicate, we remember what it is a duplicate of. Note that
4542 pipe, file, and autoreply de-duplication is handled during routing, so we must
4543 leave such "addresses" alone here, as otherwise they will incorrectly be
4544 discarded.
4545
4546 Argument:     address of list anchor
4547 Returns:      nothing
4548 */
4549
4550 static void
4551 do_duplicate_check(address_item **anchor)
4552 {
4553 address_item *addr;
4554 while ((addr = *anchor) != NULL)
4555   {
4556   tree_node *tnode;
4557   if (testflag(addr, af_pfr))
4558     {
4559     anchor = &(addr->next);
4560     }
4561   else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4562     {
4563     DEBUG(D_deliver|D_route)
4564       debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4565     *anchor = addr->next;
4566     addr->dupof = tnode->data.ptr;
4567     addr->next = addr_duplicate;
4568     addr_duplicate = addr;
4569     }
4570   else
4571     {
4572     tree_add_duplicate(addr->unique, addr);
4573     anchor = &(addr->next);
4574     }
4575   }
4576 }
4577
4578
4579
4580
4581 /*************************************************
4582 *              Deliver one message               *
4583 *************************************************/
4584
4585 /* This is the function which is called when a message is to be delivered. It
4586 is passed the id of the message. It is possible that the message no longer
4587 exists, if some other process has delivered it, and it is also possible that
4588 the message is being worked on by another process, in which case the data file
4589 will be locked.
4590
4591 If no delivery is attempted for any of the above reasons, the function returns
4592 DELIVER_NOT_ATTEMPTED.
4593
4594 If the give_up flag is set true, do not attempt any deliveries, but instead
4595 fail all outstanding addresses and return the message to the sender (or
4596 whoever).
4597
4598 A delivery operation has a process all to itself; we never deliver more than
4599 one message in the same process. Therefore we needn't worry too much about
4600 store leakage.
4601
4602 Arguments:
4603   id          the id of the message to be delivered
4604   forced      TRUE if delivery was forced by an administrator; this overrides
4605               retry delays and causes a delivery to be tried regardless
4606   give_up     TRUE if an administrator has requested that delivery attempts
4607               be abandoned
4608
4609 Returns:      When the global variable mua_wrapper is FALSE:
4610                 DELIVER_ATTEMPTED_NORMAL   if a delivery attempt was made
4611                 DELIVER_NOT_ATTEMPTED      otherwise (see comment above)
4612               When the global variable mua_wrapper is TRUE:
4613                 DELIVER_MUA_SUCCEEDED      if delivery succeeded
4614                 DELIVER_MUA_FAILED         if delivery failed
4615                 DELIVER_NOT_ATTEMPTED      if not attempted (should not occur)
4616 */
4617
4618 int
4619 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4620 {
4621 int i, rc;
4622 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4623 time_t now = time(NULL);
4624 address_item *addr_last = NULL;
4625 uschar *filter_message = NULL;
4626 FILE *jread;
4627 int process_recipients = RECIP_ACCEPT;
4628 open_db dbblock;
4629 open_db *dbm_file;
4630 extern int acl_where;
4631
4632 uschar *info = (queue_run_pid == (pid_t)0)?
4633   string_sprintf("delivering %s", id) :
4634   string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4635
4636 /* If the D_process_info bit is on, set_process_info() will output debugging
4637 information. If not, we want to show this initial information if D_deliver or
4638 D_queue_run is set or in verbose mode. */
4639
4640 set_process_info("%s", info);
4641
4642 if ((debug_selector & D_process_info) == 0 &&
4643     (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4644   debug_printf("%s\n", info);
4645
4646 /* Ensure that we catch any subprocesses that are created. Although Exim
4647 sets SIG_DFL as its initial default, some routes through the code end up
4648 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4649 has been forked, but no re-exec has been done. We use sigaction rather than
4650 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4651 sure it is turned off. (There was a problem on AIX with this.) */
4652
4653 #ifdef SA_NOCLDWAIT
4654   {
4655   struct sigaction act;
4656   act.sa_handler = SIG_DFL;
4657   sigemptyset(&(act.sa_mask));
4658   act.sa_flags = 0;
4659   sigaction(SIGCHLD, &act, NULL);
4660   }
4661 #else
4662 signal(SIGCHLD, SIG_DFL);
4663 #endif
4664
4665 /* Make the forcing flag available for routers and transports, set up the
4666 global message id field, and initialize the count for returned files and the
4667 message size. This use of strcpy() is OK because the length id is checked when
4668 it is obtained from a command line (the -M or -q options), and otherwise it is
4669 known to be a valid message id. */
4670
4671 Ustrcpy(message_id, id);
4672 deliver_force = forced;
4673 return_count = 0;
4674 message_size = 0;
4675
4676 /* Initialize some flags */
4677
4678 update_spool = FALSE;
4679 remove_journal = TRUE;
4680
4681 /* Set a known context for any ACLs we call via expansions */
4682 acl_where = ACL_WHERE_DELIVERY;
4683
4684 /* Reset the random number generator, so that if several delivery processes are
4685 started from a queue runner that has already used random numbers (for sorting),
4686 they don't all get the same sequence. */
4687
4688 random_seed = 0;
4689
4690 /* Open and lock the message's data file. Exim locks on this one because the
4691 header file may get replaced as it is re-written during the delivery process.
4692 Any failures cause messages to be written to the log, except for missing files
4693 while queue running - another process probably completed delivery. As part of
4694 opening the data file, message_subdir gets set. */
4695
4696 if (!spool_open_datafile(id))
4697   return continue_closedown();  /* yields DELIVER_NOT_ATTEMPTED */
4698
4699 /* The value of message_size at this point has been set to the data length,
4700 plus one for the blank line that notionally precedes the data. */
4701
4702 /* Now read the contents of the header file, which will set up the headers in
4703 store, and also the list of recipients and the tree of non-recipients and
4704 assorted flags. It updates message_size. If there is a reading or format error,
4705 give up; if the message has been around for sufficiently long, remove it. */
4706
4707 sprintf(CS spoolname, "%s-H", id);
4708 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4709   {
4710   if (errno == ERRNO_SPOOLFORMAT)
4711     {
4712     struct stat statbuf;
4713     sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4714       spoolname);
4715     if (Ustat(big_buffer, &statbuf) == 0)
4716       log_write(0, LOG_MAIN, "Format error in spool file %s: "
4717         "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4718     else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4719     }
4720   else
4721     log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4722       strerror(errno));
4723
4724   /* If we managed to read the envelope data, received_time contains the
4725   time the message was received. Otherwise, we can calculate it from the
4726   message id. */
4727
4728   if (rc != spool_read_hdrerror)
4729     {
4730     received_time = 0;
4731     for (i = 0; i < 6; i++)
4732       received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4733     }
4734
4735   /* If we've had this malformed message too long, sling it. */
4736
4737   if (now - received_time > keep_malformed)
4738     {
4739     sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4740     Uunlink(spoolname);
4741     sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4742     Uunlink(spoolname);
4743     sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4744     Uunlink(spoolname);
4745     sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4746     Uunlink(spoolname);
4747     log_write(0, LOG_MAIN, "Message removed because older than %s",
4748       readconf_printtime(keep_malformed));
4749     }
4750
4751   (void)close(deliver_datafile);
4752   deliver_datafile = -1;
4753   return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4754   }
4755
4756 /* The spool header file has been read. Look to see if there is an existing
4757 journal file for this message. If there is, it means that a previous delivery
4758 attempt crashed (program or host) before it could update the spool header file.
4759 Read the list of delivered addresses from the journal and add them to the
4760 nonrecipients tree. Then update the spool file. We can leave the journal in
4761 existence, as it will get further successful deliveries added to it in this
4762 run, and it will be deleted if this function gets to its end successfully.
4763 Otherwise it might be needed again. */
4764
4765 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4766 jread = Ufopen(spoolname, "rb");
4767 if (jread != NULL)
4768   {
4769   while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4770     {
4771     int n = Ustrlen(big_buffer);
4772     big_buffer[n-1] = 0;
4773     tree_add_nonrecipient(big_buffer);
4774     DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4775       "journal file\n", big_buffer);
4776     }
4777   (void)fclose(jread);
4778   /* Panic-dies on error */
4779   (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4780   }
4781 else if (errno != ENOENT)
4782   {
4783   log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4784     "%s", strerror(errno));
4785   return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4786   }
4787
4788 /* A null recipients list indicates some kind of disaster. */
4789
4790 if (recipients_list == NULL)
4791   {
4792   (void)close(deliver_datafile);
4793   deliver_datafile = -1;
4794   log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4795   return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4796   }
4797
4798
4799 /* Handle a message that is frozen. There are a number of different things that
4800 can happen, but in the default situation, unless forced, no delivery is
4801 attempted. */
4802
4803 if (deliver_freeze)
4804   {
4805   #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4806   /* Moving to another directory removes the message from Exim's view. Other
4807   tools must be used to deal with it. Logging of this action happens in
4808   spool_move_message() and its subfunctions. */
4809
4810   if (move_frozen_messages &&
4811       spool_move_message(id, message_subdir, US"", US"F"))
4812     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4813   #endif
4814
4815   /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4816   maximum time to keep messages that are frozen. Thaw if we reach it, with a
4817   flag causing all recipients to be failed. The time is the age of the
4818   message, not the time since freezing. */
4819
4820   if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4821     {
4822     log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4823     process_recipients = RECIP_FAIL_TIMEOUT;
4824     }
4825
4826   /* For bounce messages (and others with no sender), thaw if the error message
4827   ignore timer is exceeded. The message will be discarded if this delivery
4828   fails. */
4829
4830   else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4831     {
4832     log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4833     }
4834
4835   /* If this is a bounce message, or there's no auto thaw, or we haven't
4836   reached the auto thaw time yet, and this delivery is not forced by an admin
4837   user, do not attempt delivery of this message. Note that forced is set for
4838   continuing messages down the same channel, in order to skip load checking and
4839   ignore hold domains, but we don't want unfreezing in that case. */
4840
4841   else
4842     {
4843     if ((sender_address[0] == 0 ||
4844          auto_thaw <= 0 ||
4845          now <= deliver_frozen_at + auto_thaw
4846         )
4847         &&
4848         (!forced || !deliver_force_thaw || !admin_user ||
4849           continue_hostname != NULL
4850         ))
4851       {
4852       (void)close(deliver_datafile);
4853       deliver_datafile = -1;
4854       log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4855       return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4856       }
4857
4858     /* If delivery was forced (by an admin user), assume a manual thaw.
4859     Otherwise it's an auto thaw. */
4860
4861     if (forced)
4862       {
4863       deliver_manual_thaw = TRUE;
4864       log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4865       }
4866     else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4867     }
4868
4869   /* We get here if any of the rules for unfreezing have triggered. */
4870
4871   deliver_freeze = FALSE;
4872   update_spool = TRUE;
4873   }
4874
4875
4876 /* Open the message log file if we are using them. This records details of
4877 deliveries, deferments, and failures for the benefit of the mail administrator.
4878 The log is not used by exim itself to track the progress of a message; that is
4879 done by rewriting the header spool file. */
4880
4881 if (message_logs)
4882   {
4883   uschar *error;
4884   int fd;
4885
4886   sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4887   fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4888
4889   if (fd < 0)
4890     {
4891     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4892       spoolname, strerror(errno));
4893     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4894     }
4895
4896   /* Make a C stream out of it. */
4897
4898   message_log = fdopen(fd, "a");
4899   if (message_log == NULL)
4900     {
4901     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4902       spoolname, strerror(errno));
4903     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4904     }
4905   }
4906
4907
4908 /* If asked to give up on a message, log who did it, and set the action for all
4909 the addresses. */
4910
4911 if (give_up)
4912   {
4913   struct passwd *pw = getpwuid(real_uid);
4914   log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4915         US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4916   process_recipients = RECIP_FAIL;
4917   }
4918
4919 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4920
4921 else if (received_count > received_headers_max)
4922   process_recipients = RECIP_FAIL_LOOP;
4923
4924 /* Otherwise, if a system-wide, address-independent message filter is
4925 specified, run it now, except in the case when we are failing all recipients as
4926 a result of timeout_frozen_after. If the system filter yields "delivered", then
4927 ignore the true recipients of the message. Failure of the filter file is
4928 logged, and the delivery attempt fails. */
4929
4930 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4931   {
4932   int rc;
4933   int filtertype;
4934   ugid_block ugid;
4935   redirect_block redirect;
4936
4937   if (system_filter_uid_set)
4938     {
4939     ugid.uid = system_filter_uid;
4940     ugid.gid = system_filter_gid;
4941     ugid.uid_set = ugid.gid_set = TRUE;
4942     }
4943   else
4944     {
4945     ugid.uid_set = ugid.gid_set = FALSE;
4946     }
4947
4948   return_path = sender_address;
4949   enable_dollar_recipients = TRUE;   /* Permit $recipients in system filter */
4950   system_filtering = TRUE;
4951
4952   /* Any error in the filter file causes a delivery to be abandoned. */
4953
4954   redirect.string = system_filter;
4955   redirect.isfile = TRUE;
4956   redirect.check_owner = redirect.check_group = FALSE;
4957   redirect.owners = NULL;
4958   redirect.owngroups = NULL;
4959   redirect.pw = NULL;
4960   redirect.modemask = 0;
4961
4962   DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4963
4964   rc = rda_interpret(
4965     &redirect,              /* Where the data is */
4966     RDO_DEFER |             /* Turn on all the enabling options */
4967       RDO_FAIL |            /* Leave off all the disabling options */
4968       RDO_FILTER |
4969       RDO_FREEZE |
4970       RDO_REALLOG |
4971       RDO_REWRITE,
4972     NULL,                   /* No :include: restriction (not used in filter) */
4973     NULL,                   /* No sieve vacation directory (not sieve!) */
4974     NULL,                   /* No sieve enotify mailto owner (not sieve!) */
4975     NULL,                   /* No sieve user address (not sieve!) */
4976     NULL,                   /* No sieve subaddress (not sieve!) */
4977     &ugid,                  /* uid/gid data */
4978     &addr_new,              /* Where to hang generated addresses */
4979     &filter_message,        /* Where to put error message */
4980     NULL,                   /* Don't skip syntax errors */
4981     &filtertype,            /* Will always be set to FILTER_EXIM for this call */
4982     US"system filter");     /* For error messages */
4983
4984   DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4985
4986   if (rc == FF_ERROR || rc == FF_NONEXIST)
4987     {
4988     (void)close(deliver_datafile);
4989     deliver_datafile = -1;
4990     log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4991       string_printing(filter_message));
4992     return continue_closedown();   /* yields DELIVER_NOT_ATTEMPTED */
4993     }
4994
4995   /* Reset things. If the filter message is an empty string, which can happen
4996   for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4997
4998   system_filtering = FALSE;
4999   enable_dollar_recipients = FALSE;
5000   if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5001
5002   /* Save the values of the system filter variables so that user filters
5003   can use them. */
5004
5005   memcpy(filter_sn, filter_n, sizeof(filter_sn));
5006
5007   /* The filter can request that delivery of the original addresses be
5008   deferred. */
5009
5010   if (rc == FF_DEFER)
5011     {
5012     process_recipients = RECIP_DEFER;
5013     deliver_msglog("Delivery deferred by system filter\n");
5014     log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5015     }
5016
5017   /* The filter can request that a message be frozen, but this does not
5018   take place if the message has been manually thawed. In that case, we must
5019   unset "delivered", which is forced by the "freeze" command to make -bF
5020   work properly. */
5021
5022   else if (rc == FF_FREEZE && !deliver_manual_thaw)
5023     {
5024     deliver_freeze = TRUE;
5025     deliver_frozen_at = time(NULL);
5026     process_recipients = RECIP_DEFER;
5027     frozen_info = string_sprintf(" by the system filter%s%s",
5028       (filter_message == NULL)? US"" : US": ",
5029       (filter_message == NULL)? US"" : filter_message);
5030     }
5031
5032   /* The filter can request that a message be failed. The error message may be
5033   quite long - it is sent back to the sender in the bounce - but we don't want
5034   to fill up the log with repetitions of it. If it starts with << then the text
5035   between << and >> is written to the log, with the rest left for the bounce
5036   message. */
5037
5038   else if (rc == FF_FAIL)
5039     {
5040     uschar *colon = US"";
5041     uschar *logmsg = US"";
5042     int loglen = 0;
5043
5044     process_recipients = RECIP_FAIL_FILTER;
5045
5046     if (filter_message != NULL)
5047       {
5048       uschar *logend;
5049       colon = US": ";
5050       if (filter_message[0] == '<' && filter_message[1] == '<' &&
5051           (logend = Ustrstr(filter_message, ">>")) != NULL)
5052         {
5053         logmsg = filter_message + 2;
5054         loglen = logend - logmsg;
5055         filter_message = logend + 2;
5056         if (filter_message[0] == 0) filter_message = NULL;
5057         }
5058       else
5059         {
5060         logmsg = filter_message;
5061         loglen = Ustrlen(filter_message);
5062         }
5063       }
5064
5065     log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5066       logmsg);
5067     }
5068
5069   /* Delivery can be restricted only to those recipients (if any) that the
5070   filter specified. */
5071
5072   else if (rc == FF_DELIVERED)
5073     {
5074     process_recipients = RECIP_IGNORE;
5075     if (addr_new == NULL)
5076       log_write(0, LOG_MAIN, "=> discarded (system filter)");
5077     else
5078       log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5079     }
5080
5081   /* If any new addresses were created by the filter, fake up a "parent"
5082   for them. This is necessary for pipes, etc., which are expected to have
5083   parents, and it also gives some sensible logging for others. Allow
5084   pipes, files, and autoreplies, and run them as the filter uid if set,
5085   otherwise as the current uid. */
5086
5087   if (addr_new != NULL)
5088     {
5089     int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5090     int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5091
5092     /* The text "system-filter" is tested in transport_set_up_command() and in
5093     set_up_shell_command() in the pipe transport, to enable them to permit
5094     $recipients, so don't change it here without also changing it there. */
5095
5096     address_item *p = addr_new;
5097     address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5098
5099     parent->domain = string_copylc(qualify_domain_recipient);
5100     parent->local_part = US"system-filter";
5101
5102     /* As part of this loop, we arrange for addr_last to end up pointing
5103     at the final address. This is used if we go on to add addresses for the
5104     original recipients. */
5105
5106     while (p != NULL)
5107       {
5108       if (parent->child_count == SHRT_MAX)
5109         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5110           "than %d delivery addresses", SHRT_MAX);
5111       parent->child_count++;
5112       p->parent = parent;
5113
5114       if (testflag(p, af_pfr))
5115         {
5116         uschar *tpname;
5117         uschar *type;
5118         p->uid = uid;
5119         p->gid = gid;
5120         setflag(p, af_uid_set |
5121                    af_gid_set |
5122                    af_allow_file |
5123                    af_allow_pipe |
5124                    af_allow_reply);
5125
5126         /* Find the name of the system filter's appropriate pfr transport */
5127
5128         if (p->address[0] == '|')
5129           {
5130           type = US"pipe";
5131           tpname = system_filter_pipe_transport;
5132           address_pipe = p->address;
5133           }
5134         else if (p->address[0] == '>')
5135           {
5136           type = US"reply";
5137           tpname = system_filter_reply_transport;
5138           }
5139         else
5140           {
5141           if (p->address[Ustrlen(p->address)-1] == '/')
5142             {
5143             type = US"directory";
5144             tpname = system_filter_directory_transport;
5145             }
5146           else
5147             {
5148             type = US"file";
5149             tpname = system_filter_file_transport;
5150             }
5151           address_file = p->address;
5152           }
5153
5154         /* Now find the actual transport, first expanding the name. We have
5155         set address_file or address_pipe above. */
5156
5157         if (tpname != NULL)
5158           {
5159           uschar *tmp = expand_string(tpname);
5160           address_file = address_pipe = NULL;
5161           if (tmp == NULL)
5162             p->message = string_sprintf("failed to expand \"%s\" as a "
5163               "system filter transport name", tpname);
5164           tpname = tmp;
5165           }
5166         else
5167           {
5168           p->message = string_sprintf("system_filter_%s_transport is unset",
5169             type);
5170           }
5171
5172         if (tpname != NULL)
5173           {
5174           transport_instance *tp;
5175           for (tp = transports; tp != NULL; tp = tp->next)
5176             {
5177             if (Ustrcmp(tp->name, tpname) == 0)
5178               {
5179               p->transport = tp;
5180               break;
5181               }
5182             }
5183           if (tp == NULL)
5184             p->message = string_sprintf("failed to find \"%s\" transport "
5185               "for system filter delivery", tpname);
5186           }
5187
5188         /* If we couldn't set up a transport, defer the delivery, putting the
5189         error on the panic log as well as the main log. */
5190
5191         if (p->transport == NULL)
5192           {
5193           address_item *badp = p;
5194           p = p->next;
5195           if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5196           badp->local_part = badp->address;   /* Needed for log line */
5197           post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5198           continue;
5199           }
5200         }    /* End of pfr handling */
5201
5202       /* Either a non-pfr delivery, or we found a transport */
5203
5204       DEBUG(D_deliver|D_filter)
5205         debug_printf("system filter added %s\n", p->address);
5206
5207       addr_last = p;
5208       p = p->next;
5209       }    /* Loop through all addr_new addresses */
5210     }
5211   }
5212
5213
5214 /* Scan the recipients list, and for every one that is not in the non-
5215 recipients tree, add an addr item to the chain of new addresses. If the pno
5216 value is non-negative, we must set the onetime parent from it. This which
5217 points to the relevant entry in the recipients list.
5218
5219 This processing can be altered by the setting of the process_recipients
5220 variable, which is changed if recipients are to be ignored, failed, or
5221 deferred. This can happen as a result of system filter activity, or if the -Mg
5222 option is used to fail all of them.
5223
5224 Duplicate addresses are handled later by a different tree structure; we can't
5225 just extend the non-recipients tree, because that will be re-written to the
5226 spool if the message is deferred, and in any case there are casing
5227 complications for local addresses. */
5228
5229 if (process_recipients != RECIP_IGNORE)
5230   {
5231   for (i = 0; i < recipients_count; i++)
5232     {
5233     if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5234       {
5235       recipient_item *r = recipients_list + i;
5236       address_item *new = deliver_make_addr(r->address, FALSE);
5237       new->p.errors_address = r->errors_to;
5238
5239       if (r->pno >= 0)
5240         new->onetime_parent = recipients_list[r->pno].address;
5241
5242       switch (process_recipients)
5243         {
5244         /* RECIP_DEFER is set when a system filter freezes a message. */
5245
5246         case RECIP_DEFER:
5247         new->next = addr_defer;
5248         addr_defer = new;
5249         break;
5250
5251
5252         /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5253         command. */
5254
5255         case RECIP_FAIL_FILTER:
5256         new->message =
5257           (filter_message == NULL)? US"delivery cancelled" : filter_message;
5258         setflag(new, af_pass_message);
5259         goto RECIP_QUEUE_FAILED;   /* below */
5260
5261
5262         /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5263         than the value in timeout_frozen_after. Treat non-bounce messages
5264         similarly to -Mg; for bounce messages we just want to discard, so
5265         don't put the address on the failed list. The timeout has already
5266         been logged. */
5267
5268         case RECIP_FAIL_TIMEOUT:
5269         new->message  = US"delivery cancelled; message timed out";
5270         goto RECIP_QUEUE_FAILED;   /* below */
5271
5272
5273         /* RECIP_FAIL is set when -Mg has been used. */
5274
5275         case RECIP_FAIL:
5276         new->message  = US"delivery cancelled by administrator";
5277         /* Fall through */
5278
5279         /* Common code for the failure cases above. If this is not a bounce
5280         message, put the address on the failed list so that it is used to
5281         create a bounce. Otherwise do nothing - this just discards the address.
5282         The incident has already been logged. */
5283
5284         RECIP_QUEUE_FAILED:
5285         if (sender_address[0] != 0)
5286           {
5287           new->next = addr_failed;
5288           addr_failed = new;
5289           }
5290         break;
5291
5292
5293         /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5294         in the message. Process each address as a routing failure; if this
5295         is a bounce message, it will get frozen. */
5296
5297         case RECIP_FAIL_LOOP:
5298         new->message = US"Too many \"Received\" headers - suspected mail loop";
5299         post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5300         break;
5301
5302
5303         /* Value should be RECIP_ACCEPT; take this as the safe default. */
5304
5305         default:
5306         if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5307         addr_last = new;
5308         break;
5309         }
5310       }
5311     }
5312   }
5313
5314 DEBUG(D_deliver)
5315   {
5316   address_item *p = addr_new;
5317   debug_printf("Delivery address list:\n");
5318   while (p != NULL)
5319     {
5320     debug_printf("  %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5321       p->onetime_parent);
5322     p = p->next;
5323     }
5324   }
5325
5326 /* Set up the buffers used for copying over the file when delivering. */
5327
5328 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5329 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5330
5331
5332
5333 /* Until there are no more new addresses, handle each one as follows:
5334
5335  . If this is a generated address (indicated by the presence of a parent
5336    pointer) then check to see whether it is a pipe, file, or autoreply, and
5337    if so, handle it directly here. The router that produced the address will
5338    have set the allow flags into the address, and also set the uid/gid required.
5339    Having the routers generate new addresses and then checking them here at
5340    the outer level is tidier than making each router do the checking, and
5341    means that routers don't need access to the failed address queue.
5342
5343  . Break up the address into local part and domain, and make lowercased
5344    versions of these strings. We also make unquoted versions of the local part.
5345
5346  . Handle the percent hack for those domains for which it is valid.
5347
5348  . For child addresses, determine if any of the parents have the same address.
5349    If so, generate a different string for previous delivery checking. Without
5350    this code, if the address spqr generates spqr via a forward or alias file,
5351    delivery of the generated spqr stops further attempts at the top level spqr,
5352    which is not what is wanted - it may have generated other addresses.
5353
5354  . Check on the retry database to see if routing was previously deferred, but
5355    only if in a queue run. Addresses that are to be routed are put on the
5356    addr_route chain. Addresses that are to be deferred are put on the
5357    addr_defer chain. We do all the checking first, so as not to keep the
5358    retry database open any longer than necessary.
5359
5360  . Now we run the addresses through the routers. A router may put the address
5361    on either the addr_local or the addr_remote chain for local or remote
5362    delivery, respectively, or put it on the addr_failed chain if it is
5363    undeliveable, or it may generate child addresses and put them on the
5364    addr_new chain, or it may defer an address. All the chain anchors are
5365    passed as arguments so that the routers can be called for verification
5366    purposes as well.
5367
5368  . If new addresses have been generated by the routers, da capo.
5369 */
5370
5371 header_rewritten = FALSE;          /* No headers rewritten yet */
5372 while (addr_new != NULL)           /* Loop until all addresses dealt with */
5373   {
5374   address_item *addr, *parent;
5375   dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5376
5377   /* Failure to open the retry database is treated the same as if it does
5378   not exist. In both cases, dbm_file is NULL. */
5379
5380   if (dbm_file == NULL)
5381     {
5382     DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5383       debug_printf("no retry data available\n");
5384     }
5385
5386   /* Scan the current batch of new addresses, to handle pipes, files and
5387   autoreplies, and determine which others are ready for routing. */
5388
5389   while (addr_new != NULL)
5390     {
5391     int rc;
5392     uschar *p;
5393     tree_node *tnode;
5394     dbdata_retry *domain_retry_record;
5395     dbdata_retry *address_retry_record;
5396
5397     addr = addr_new;
5398     addr_new = addr->next;
5399
5400     DEBUG(D_deliver|D_retry|D_route)
5401       {
5402       debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5403       debug_printf("Considering: %s\n", addr->address);
5404       }
5405
5406     /* Handle generated address that is a pipe or a file or an autoreply. */
5407
5408     if (testflag(addr, af_pfr))
5409       {
5410       /* If an autoreply in a filter could not generate a syntactically valid
5411       address, give up forthwith. Set af_ignore_error so that we don't try to
5412       generate a bounce. */
5413
5414       if (testflag(addr, af_bad_reply))
5415         {
5416         addr->basic_errno = ERRNO_BADADDRESS2;
5417         addr->local_part = addr->address;
5418         addr->message =
5419           US"filter autoreply generated syntactically invalid recipient";
5420         setflag(addr, af_ignore_error);
5421         (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5422         continue;   /* with the next new address */
5423         }
5424
5425       /* If two different users specify delivery to the same pipe or file or
5426       autoreply, there should be two different deliveries, so build a unique
5427       string that incorporates the original address, and use this for
5428       duplicate testing and recording delivery, and also for retrying. */
5429
5430       addr->unique =
5431         string_sprintf("%s:%s", addr->address, addr->parent->unique +
5432           (testflag(addr->parent, af_homonym)? 3:0));
5433
5434       addr->address_retry_key = addr->domain_retry_key =
5435         string_sprintf("T:%s", addr->unique);
5436
5437       /* If a filter file specifies two deliveries to the same pipe or file,
5438       we want to de-duplicate, but this is probably not wanted for two mail
5439       commands to the same address, where probably both should be delivered.
5440       So, we have to invent a different unique string in that case. Just
5441       keep piling '>' characters on the front. */
5442
5443       if (addr->address[0] == '>')
5444         {
5445         while (tree_search(tree_duplicates, addr->unique) != NULL)
5446           addr->unique = string_sprintf(">%s", addr->unique);
5447         }
5448
5449       else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5450         {
5451         DEBUG(D_deliver|D_route)
5452           debug_printf("%s is a duplicate address: discarded\n", addr->address);
5453         addr->dupof = tnode->data.ptr;
5454         addr->next = addr_duplicate;
5455         addr_duplicate = addr;
5456         continue;
5457         }
5458
5459       DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5460
5461       /* Check for previous delivery */
5462
5463       if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5464         {
5465         DEBUG(D_deliver|D_route)
5466           debug_printf("%s was previously delivered: discarded\n", addr->address);
5467         child_done(addr, tod_stamp(tod_log));
5468         continue;
5469         }
5470
5471       /* Save for checking future duplicates */
5472
5473       tree_add_duplicate(addr->unique, addr);
5474
5475       /* Set local part and domain */
5476
5477       addr->local_part = addr->address;
5478       addr->domain = addr->parent->domain;
5479
5480       /* Ensure that the delivery is permitted. */
5481
5482       if (testflag(addr, af_file))
5483         {
5484         if (!testflag(addr, af_allow_file))
5485           {
5486           addr->basic_errno = ERRNO_FORBIDFILE;
5487           addr->message = US"delivery to file forbidden";
5488           (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5489           continue;   /* with the next new address */
5490           }
5491         }
5492       else if (addr->address[0] == '|')
5493         {
5494         if (!testflag(addr, af_allow_pipe))
5495           {
5496           addr->basic_errno = ERRNO_FORBIDPIPE;
5497           addr->message = US"delivery to pipe forbidden";
5498           (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5499           continue;   /* with the next new address */
5500           }
5501         }
5502       else if (!testflag(addr, af_allow_reply))
5503         {
5504         addr->basic_errno = ERRNO_FORBIDREPLY;
5505         addr->message = US"autoreply forbidden";
5506         (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5507         continue;     /* with the next new address */
5508         }
5509
5510       /* If the errno field is already set to BADTRANSPORT, it indicates
5511       failure to expand a transport string, or find the associated transport,
5512       or an unset transport when one is required. Leave this test till now so
5513       that the forbid errors are given in preference. */
5514
5515       if (addr->basic_errno == ERRNO_BADTRANSPORT)
5516         {
5517         (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5518         continue;
5519         }
5520
5521       /* Treat /dev/null as a special case and abandon the delivery. This
5522       avoids having to specify a uid on the transport just for this case.
5523       Arrange for the transport name to be logged as "**bypassed**". */
5524
5525       if (Ustrcmp(addr->address, "/dev/null") == 0)
5526         {
5527         uschar *save = addr->transport->name;
5528         addr->transport->name = US"**bypassed**";
5529         (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5530         addr->transport->name = save;
5531         continue;   /* with the next new address */
5532         }
5533
5534       /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5535       delivery. */
5536
5537       DEBUG(D_deliver|D_route)
5538         debug_printf("queued for %s transport\n", addr->transport->name);
5539       addr->next = addr_local;
5540       addr_local = addr;
5541       continue;       /* with the next new address */
5542       }
5543
5544     /* Handle normal addresses. First, split up into local part and domain,
5545     handling the %-hack if necessary. There is the possibility of a defer from
5546     a lookup in percent_hack_domains. */
5547
5548     if ((rc = deliver_split_address(addr)) == DEFER)
5549       {
5550       addr->message = US"cannot check percent_hack_domains";
5551       addr->basic_errno = ERRNO_LISTDEFER;
5552       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5553       continue;
5554       }
5555
5556     /* Check to see if the domain is held. If so, proceed only if the
5557     delivery was forced by hand. */
5558
5559     deliver_domain = addr->domain;  /* set $domain */
5560     if (!forced && hold_domains != NULL &&
5561          (rc = match_isinlist(addr->domain, &hold_domains, 0,
5562            &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5563            NULL)) != FAIL)
5564       {
5565       if (rc == DEFER)
5566         {
5567         addr->message = US"hold_domains lookup deferred";
5568         addr->basic_errno = ERRNO_LISTDEFER;
5569         }
5570       else
5571         {
5572         addr->message = US"domain is held";
5573         addr->basic_errno = ERRNO_HELD;
5574         }
5575       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5576       continue;
5577       }
5578
5579     /* Now we can check for duplicates and previously delivered addresses. In
5580     order to do this, we have to generate a "unique" value for each address,
5581     because there may be identical actual addresses in a line of descendents.
5582     The "unique" field is initialized to the same value as the "address" field,
5583     but gets changed here to cope with identically-named descendents. */
5584
5585     for (parent = addr->parent; parent != NULL; parent = parent->parent)
5586       if (strcmpic(addr->address, parent->address) == 0) break;
5587
5588     /* If there's an ancestor with the same name, set the homonym flag. This
5589     influences how deliveries are recorded. Then add a prefix on the front of
5590     the unique address. We use \n\ where n starts at 0 and increases each time.
5591     It is unlikely to pass 9, but if it does, it may look odd but will still
5592     work. This means that siblings or cousins with the same names are treated
5593     as duplicates, which is what we want. */
5594
5595     if (parent != NULL)
5596       {
5597       setflag(addr, af_homonym);
5598       if (parent->unique[0] != '\\')
5599         addr->unique = string_sprintf("\\0\\%s", addr->address);
5600       else
5601         addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5602           addr->address);
5603       }
5604
5605     /* Ensure that the domain in the unique field is lower cased, because
5606     domains are always handled caselessly. */
5607
5608     p = Ustrrchr(addr->unique, '@');
5609     while (*p != 0) { *p = tolower(*p); p++; }
5610
5611     DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5612
5613     if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5614       {
5615       DEBUG(D_deliver|D_route)
5616         debug_printf("%s was previously delivered: discarded\n", addr->unique);
5617       child_done(addr, tod_stamp(tod_log));
5618       continue;
5619       }
5620
5621     /* Get the routing retry status, saving the two retry keys (with and
5622     without the local part) for subsequent use. If there is no retry record for
5623     the standard address routing retry key, we look for the same key with the
5624     sender attached, because this form is used by the smtp transport after a
5625     4xx response to RCPT when address_retry_include_sender is true. */
5626
5627     addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5628     addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5629       addr->domain);
5630
5631     if (dbm_file == NULL)
5632       domain_retry_record = address_retry_record = NULL;
5633     else
5634       {
5635       domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5636       if (domain_retry_record != NULL &&
5637           now - domain_retry_record->time_stamp > retry_data_expire)
5638         domain_retry_record = NULL;    /* Ignore if too old */
5639
5640       address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5641       if (address_retry_record != NULL &&
5642           now - address_retry_record->time_stamp > retry_data_expire)
5643         address_retry_record = NULL;   /* Ignore if too old */
5644
5645       if (address_retry_record == NULL)
5646         {
5647         uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5648           sender_address);
5649         address_retry_record = dbfn_read(dbm_file, altkey);
5650         if (address_retry_record != NULL &&
5651             now - address_retry_record->time_stamp > retry_data_expire)
5652           address_retry_record = NULL;   /* Ignore if too old */
5653         }
5654       }
5655
5656     DEBUG(D_deliver|D_retry)
5657       {
5658       if (domain_retry_record == NULL)
5659         debug_printf("no domain retry record\n");
5660       if (address_retry_record == NULL)
5661         debug_printf("no address retry record\n");
5662       }
5663
5664     /* If we are sending a message down an existing SMTP connection, we must
5665     assume that the message which created the connection managed to route
5666     an address to that connection. We do not want to run the risk of taking
5667     a long time over routing here, because if we do, the server at the other
5668     end of the connection may time it out. This is especially true for messages
5669     with lots of addresses. For this kind of delivery, queue_running is not
5670     set, so we would normally route all addresses. We take a pragmatic approach
5671     and defer routing any addresses that have any kind of domain retry record.
5672     That is, we don't even look at their retry times. It doesn't matter if this
5673     doesn't work occasionally. This is all just an optimization, after all.
5674
5675     The reason for not doing the same for address retries is that they normally
5676     arise from 4xx responses, not DNS timeouts. */
5677
5678     if (continue_hostname != NULL && domain_retry_record != NULL)
5679       {
5680       addr->message = US"reusing SMTP connection skips previous routing defer";
5681       addr->basic_errno = ERRNO_RRETRY;
5682       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5683       }
5684
5685     /* If we are in a queue run, defer routing unless there is no retry data or
5686     we've passed the next retry time, or this message is forced. In other
5687     words, ignore retry data when not in a queue run.
5688
5689     However, if the domain retry time has expired, always allow the routing
5690     attempt. If it fails again, the address will be failed. This ensures that
5691     each address is routed at least once, even after long-term routing
5692     failures.
5693
5694     If there is an address retry, check that too; just wait for the next
5695     retry time. This helps with the case when the temporary error on the
5696     address was really message-specific rather than address specific, since
5697     it allows other messages through.
5698
5699     We also wait for the next retry time if this is a message sent down an
5700     existing SMTP connection (even though that will be forced). Otherwise there
5701     will be far too many attempts for an address that gets a 4xx error. In
5702     fact, after such an error, we should not get here because, the host should
5703     not be remembered as one this message needs. However, there was a bug that
5704     used to cause this to  happen, so it is best to be on the safe side.
5705
5706     Even if we haven't reached the retry time in the hints, there is one more
5707     check to do, which is for the ultimate address timeout. We only do this
5708     check if there is an address retry record and there is not a domain retry
5709     record; this implies that previous attempts to handle the address had the
5710     retry_use_local_parts option turned on. We use this as an approximation
5711     for the destination being like a local delivery, for example delivery over
5712     LMTP to an IMAP message store. In this situation users are liable to bump
5713     into their quota and thereby have intermittently successful deliveries,
5714     which keep the retry record fresh, which can lead to us perpetually
5715     deferring messages. */
5716
5717     else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5718             &&
5719             ((domain_retry_record != NULL &&
5720               now < domain_retry_record->next_try &&
5721               !domain_retry_record->expired)
5722             ||
5723             (address_retry_record != NULL &&
5724               now < address_retry_record->next_try))
5725             &&
5726             (domain_retry_record != NULL ||
5727              address_retry_record == NULL ||
5728              !retry_ultimate_address_timeout(addr->address_retry_key,
5729                addr->domain, address_retry_record, now)))
5730       {
5731       addr->message = US"retry time not reached";
5732       addr->basic_errno = ERRNO_RRETRY;
5733       (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5734       }
5735
5736     /* The domain is OK for routing. Remember if retry data exists so it
5737     can be cleaned up after a successful delivery. */
5738
5739     else
5740       {
5741       if (domain_retry_record != NULL || address_retry_record != NULL)
5742         setflag(addr, af_dr_retry_exists);
5743       addr->next = addr_route;
5744       addr_route = addr;
5745       DEBUG(D_deliver|D_route)
5746         debug_printf("%s: queued for routing\n", addr->address);
5747       }
5748     }
5749
5750   /* The database is closed while routing is actually happening. Requests to
5751   update it are put on a chain and all processed together at the end. */
5752
5753   if (dbm_file != NULL) dbfn_close(dbm_file);
5754
5755   /* If queue_domains is set, we don't even want to try routing addresses in
5756   those domains. During queue runs, queue_domains is forced to be unset.
5757   Optimize by skipping this pass through the addresses if nothing is set. */
5758
5759   if (!deliver_force && queue_domains != NULL)
5760     {
5761     address_item *okaddr = NULL;
5762     while (addr_route != NULL)
5763       {
5764       address_item *addr = addr_route;
5765       addr_route = addr->next;
5766
5767       deliver_domain = addr->domain;  /* set $domain */
5768       if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5769             &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5770               != OK)
5771         {
5772         if (rc == DEFER)
5773           {
5774           addr->basic_errno = ERRNO_LISTDEFER;
5775           addr->message = US"queue_domains lookup deferred";
5776           (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5777           }
5778         else
5779           {
5780           addr->next = okaddr;
5781           okaddr = addr;
5782           }
5783         }
5784       else
5785         {
5786         addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5787         addr->message = US"domain is in queue_domains";
5788         (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5789         }
5790       }
5791
5792     addr_route = okaddr;
5793     }
5794
5795   /* Now route those addresses that are not deferred. */
5796
5797   while (addr_route != NULL)
5798     {
5799     int rc;
5800     address_item *addr = addr_route;
5801     uschar *old_domain = addr->domain;
5802     uschar *old_unique = addr->unique;
5803     addr_route = addr->next;
5804     addr->next = NULL;
5805
5806     /* Just in case some router parameter refers to it. */
5807
5808     return_path = (addr->p.errors_address != NULL)?
5809       addr->p.errors_address : sender_address;
5810
5811     /* If a router defers an address, add a retry item. Whether or not to
5812     use the local part in the key is a property of the router. */
5813
5814     if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5815          &addr_succeed, v_none)) == DEFER)
5816       retry_add_item(addr, (addr->router->retry_use_local_part)?
5817         string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5818         string_sprintf("R:%s", addr->domain), 0);
5819
5820     /* Otherwise, if there is an existing retry record in the database, add
5821     retry items to delete both forms. We must also allow for the possibility
5822     of a routing retry that includes the sender address. Since the domain might
5823     have been rewritten (expanded to fully qualified) as a result of routing,
5824     ensure that the rewritten form is also deleted. */
5825
5826     else if (testflag(addr, af_dr_retry_exists))
5827       {
5828       uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5829         sender_address);
5830       retry_add_item(addr, altkey, rf_delete);
5831       retry_add_item(addr, addr->address_retry_key, rf_delete);
5832       retry_add_item(addr, addr->domain_retry_key, rf_delete);
5833       if (Ustrcmp(addr->domain, old_domain) != 0)
5834         retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5835       }
5836
5837     /* DISCARD is given for :blackhole: and "seen finish". The event has been
5838     logged, but we need to ensure the address (and maybe parents) is marked
5839     done. */
5840
5841     if (rc == DISCARD)
5842       {
5843       address_done(addr, tod_stamp(tod_log));
5844       continue;  /* route next address */
5845       }
5846
5847     /* The address is finished with (failed or deferred). */
5848
5849     if (rc != OK)
5850       {
5851       (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5852       continue;  /* route next address */
5853       }
5854
5855     /* The address has been routed. If the router changed the domain, it will
5856     also have changed the unique address. We have to test whether this address
5857     has already been delivered, because it's the unique address that finally
5858     gets recorded. */
5859
5860     if (addr->unique != old_unique &&
5861         tree_search(tree_nonrecipients, addr->unique) != 0)
5862       {
5863       DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5864         "discarded\n", addr->address);
5865       if (addr_remote == addr) addr_remote = addr->next;
5866       else if (addr_local == addr) addr_local = addr->next;
5867       }
5868
5869     /* If the router has same_domain_copy_routing set, we are permitted to copy
5870     the routing for any other addresses with the same domain. This is an
5871     optimisation to save repeated DNS lookups for "standard" remote domain
5872     routing. The option is settable only on routers that generate host lists.
5873     We play it very safe, and do the optimization only if the address is routed
5874     to a remote transport, there are no header changes, and the domain was not
5875     modified by the router. */
5876
5877     if (addr_remote == addr &&
5878         addr->router->same_domain_copy_routing &&
5879         addr->p.extra_headers == NULL &&
5880         addr->p.remove_headers == NULL &&
5881         old_domain == addr->domain)
5882       {
5883       address_item **chain = &addr_route;
5884       while (*chain != NULL)
5885         {
5886         address_item *addr2 = *chain;
5887         if (Ustrcmp(addr2->domain, addr->domain) != 0)
5888           {
5889           chain = &(addr2->next);
5890           continue;
5891           }
5892
5893         /* Found a suitable address; take it off the routing list and add it to
5894         the remote delivery list. */
5895
5896         *chain = addr2->next;
5897         addr2->next = addr_remote;
5898         addr_remote = addr2;
5899
5900         /* Copy the routing data */
5901
5902         addr2->domain = addr->domain;
5903         addr2->router = addr->router;
5904         addr2->transport = addr->transport;
5905         addr2->host_list = addr->host_list;
5906         addr2->fallback_hosts = addr->fallback_hosts;
5907         addr2->p.errors_address = addr->p.errors_address;
5908         copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5909
5910         DEBUG(D_deliver|D_route)
5911           {
5912           debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5913                        "routing %s\n"
5914                        "Routing for %s copied from %s\n",
5915             addr2->address, addr2->address, addr->address);
5916           }
5917         }
5918       }
5919     }  /* Continue with routing the next address. */
5920   }    /* Loop to process any child addresses that the routers created, and
5921           any rerouted addresses that got put back on the new chain. */
5922
5923
5924 /* Debugging: show the results of the routing */
5925
5926 DEBUG(D_deliver|D_retry|D_route)
5927   {
5928   address_item *p = addr_local;
5929   debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5930   debug_printf("After routing:\n  Local deliveries:\n");
5931   while (p != NULL)
5932     {
5933     debug_printf("    %s\n", p->address);
5934     p = p->next;
5935     }
5936
5937   p = addr_remote;
5938   debug_printf("  Remote deliveries:\n");
5939   while (p != NULL)
5940     {
5941     debug_printf("    %s\n", p->address);
5942     p = p->next;
5943     }
5944
5945   p = addr_failed;
5946   debug_printf("  Failed addresses:\n");
5947   while (p != NULL)
5948     {
5949     debug_printf("    %s\n", p->address);
5950     p = p->next;
5951     }
5952
5953   p = addr_defer;
5954   debug_printf("  Deferred addresses:\n");
5955   while (p != NULL)
5956     {
5957     debug_printf("    %s\n", p->address);
5958     p = p->next;
5959     }
5960   }
5961
5962 /* Free any resources that were cached during routing. */
5963
5964 search_tidyup();
5965 route_tidyup();
5966
5967 /* These two variables are set only during routing, after check_local_user.
5968 Ensure they are not set in transports. */
5969
5970 local_user_gid = (gid_t)(-1);
5971 local_user_uid = (uid_t)(-1);
5972
5973 /* Check for any duplicate addresses. This check is delayed until after
5974 routing, because the flexibility of the routing configuration means that
5975 identical addresses with different parentage may end up being redirected to
5976 different addresses. Checking for duplicates too early (as we previously used
5977 to) makes this kind of thing not work. */
5978
5979 do_duplicate_check(&addr_local);
5980 do_duplicate_check(&addr_remote);
5981
5982 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5983 remote transport. The check that they all end up in one transaction happens in
5984 the do_remote_deliveries() function. */
5985
5986 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5987                     addr_defer != NULL))
5988   {
5989   address_item *addr;
5990   uschar *which, *colon, *msg;
5991
5992   if (addr_local != NULL)
5993     {
5994     addr = addr_local;
5995     which = US"local";
5996     }
5997   else if (addr_defer != NULL)
5998     {
5999     addr = addr_defer;
6000     which = US"deferred";
6001     }
6002   else
6003     {
6004     addr = addr_failed;
6005     which = US"failed";
6006     }
6007
6008   while (addr->parent != NULL) addr = addr->parent;
6009
6010   if (addr->message != NULL)
6011     {
6012     colon = US": ";
6013     msg = addr->message;
6014     }
6015   else colon = msg = US"";
6016
6017   /* We don't need to log here for a forced failure as it will already
6018   have been logged. Defer will also have been logged, but as a defer, so we do
6019   need to do the failure logging. */
6020
6021   if (addr != addr_failed)
6022     log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6023       addr->address, which);
6024
6025   /* Always write an error to the caller */
6026
6027   fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6028     which, colon, msg);
6029
6030   final_yield = DELIVER_MUA_FAILED;
6031   addr_failed = addr_defer = NULL;   /* So that we remove the message */
6032   goto DELIVERY_TIDYUP;
6033   }
6034
6035
6036 /* If this is a run to continue deliveries to an external channel that is
6037 already set up, defer any local deliveries. */
6038
6039 if (continue_transport != NULL)
6040   {
6041   if (addr_defer == NULL) addr_defer = addr_local; else
6042     {
6043     address_item *addr = addr_defer;
6044     while (addr->next != NULL) addr = addr->next;
6045     addr->next = addr_local;
6046     }
6047   addr_local = NULL;
6048   }
6049
6050
6051 /* Because address rewriting can happen in the routers, we should not really do
6052 ANY deliveries until all addresses have been routed, so that all recipients of
6053 the message get the same headers. However, this is in practice not always
6054 possible, since sometimes remote addresses give DNS timeouts for days on end.
6055 The pragmatic approach is to deliver what we can now, saving any rewritten
6056 headers so that at least the next lot of recipients benefit from the rewriting
6057 that has already been done.
6058
6059 If any headers have been rewritten during routing, update the spool file to
6060 remember them for all subsequent deliveries. This can be delayed till later if
6061 there is only address to be delivered - if it succeeds the spool write need not
6062 happen. */
6063
6064 if (header_rewritten &&
6065     ((addr_local != NULL &&
6066        (addr_local->next != NULL || addr_remote != NULL)) ||
6067      (addr_remote != NULL && addr_remote->next != NULL)))
6068   {
6069   /* Panic-dies on error */
6070   (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6071   header_rewritten = FALSE;
6072   }
6073
6074
6075 /* If there are any deliveries to be done, open the journal file. This is used
6076 to record successful deliveries as soon as possible after each delivery is
6077 known to be complete. A file opened with O_APPEND is used so that several
6078 processes can run simultaneously.
6079
6080 The journal is just insurance against crashes. When the spool file is
6081 ultimately updated at the end of processing, the journal is deleted. If a
6082 journal is found to exist at the start of delivery, the addresses listed
6083 therein are added to the non-recipients. */
6084
6085 if (addr_local != NULL || addr_remote != NULL)
6086   {
6087   sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6088   journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6089
6090   if (journal_fd < 0)
6091     {
6092     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6093       spoolname, strerror(errno));
6094     return DELIVER_NOT_ATTEMPTED;
6095     }
6096
6097   /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6098   that the mode is correct - the group setting doesn't always seem to get
6099   set automatically. */
6100
6101   if(  fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6102     || fchown(journal_fd, exim_uid, exim_gid)
6103     || fchmod(journal_fd, SPOOL_MODE)
6104     )
6105     {
6106     int ret = Uunlink(spoolname);
6107     log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6108       spoolname, strerror(errno));
6109     if(ret  &&  errno != ENOENT)
6110       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6111         spoolname, strerror(errno));
6112     return DELIVER_NOT_ATTEMPTED;
6113     }
6114   }
6115
6116
6117
6118 /* Now we can get down to the business of actually doing deliveries. Local
6119 deliveries are done first, then remote ones. If ever the problems of how to
6120 handle fallback transports are figured out, this section can be put into a loop
6121 for handling fallbacks, though the uid switching will have to be revised. */
6122
6123 /* Precompile a regex that is used to recognize a parameter in response
6124 to an LHLO command, if is isn't already compiled. This may be used on both
6125 local and remote LMTP deliveries. */
6126
6127 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6128   regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6129
6130 /* Handle local deliveries */
6131
6132 if (addr_local != NULL)
6133   {
6134   DEBUG(D_deliver|D_transport)
6135     debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6136   do_local_deliveries();
6137   disable_logging = FALSE;
6138   }
6139
6140 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6141 so just queue them all. */
6142
6143 if (queue_run_local)
6144   {
6145   while (addr_remote != NULL)
6146     {
6147     address_item *addr = addr_remote;
6148     addr_remote = addr->next;
6149     addr->next = NULL;
6150     addr->basic_errno = ERRNO_LOCAL_ONLY;
6151     addr->message = US"remote deliveries suppressed";
6152     (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6153     }
6154   }
6155
6156 /* Handle remote deliveries */
6157
6158 if (addr_remote != NULL)
6159   {
6160   DEBUG(D_deliver|D_transport)
6161     debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6162
6163   /* Precompile some regex that are used to recognize parameters in response
6164   to an EHLO command, if they aren't already compiled. */
6165
6166   if (regex_PIPELINING == NULL) regex_PIPELINING =
6167     regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6168
6169   if (regex_SIZE == NULL) regex_SIZE =
6170     regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6171
6172   if (regex_AUTH == NULL) regex_AUTH =
6173     regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6174       FALSE, TRUE);
6175
6176   #ifdef SUPPORT_TLS
6177   if (regex_STARTTLS == NULL) regex_STARTTLS =
6178     regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6179   #endif
6180
6181   #ifdef EXPERIMENTAL_PRDR
6182   if (regex_PRDR == NULL) regex_PRDR =
6183     regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6184   #endif
6185
6186   /* Now sort the addresses if required, and do the deliveries. The yield of
6187   do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6188   cannot be delivered in one transaction. */
6189
6190   if (remote_sort_domains != NULL) sort_remote_deliveries();
6191   if (!do_remote_deliveries(FALSE))
6192     {
6193     log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6194       "be delivered in one transaction");
6195     fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6196
6197     final_yield = DELIVER_MUA_FAILED;
6198     addr_failed = addr_defer = NULL;   /* So that we remove the message */
6199     goto DELIVERY_TIDYUP;
6200     }
6201
6202   /* See if any of the addresses that failed got put on the queue for delivery
6203   to their fallback hosts. We do it this way because often the same fallback
6204   host is used for many domains, so all can be sent in a single transaction
6205   (if appropriately configured). */
6206
6207   if (addr_fallback != NULL && !mua_wrapper)
6208     {
6209     DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6210     addr_remote = addr_fallback;
6211     addr_fallback = NULL;
6212     if (remote_sort_domains != NULL) sort_remote_deliveries();
6213     do_remote_deliveries(TRUE);
6214     }
6215   disable_logging = FALSE;
6216   }
6217
6218
6219 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6220 phase, to minimize cases of half-done things. */
6221
6222 DEBUG(D_deliver)
6223   debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6224
6225 /* Root privilege is no longer needed */
6226
6227 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6228
6229 set_process_info("tidying up after delivering %s", message_id);
6230 signal(SIGTERM, SIG_IGN);
6231
6232 /* When we are acting as an MUA wrapper, the smtp transport will either have
6233 succeeded for all addresses, or failed them all in normal cases. However, there
6234 are some setup situations (e.g. when a named port does not exist) that cause an
6235 immediate exit with deferral of all addresses. Convert those into failures. We
6236 do not ever want to retry, nor do we want to send a bounce message. */
6237
6238 if (mua_wrapper)
6239   {
6240   if (addr_defer != NULL)
6241     {
6242     address_item *addr, *nextaddr;
6243     for (addr = addr_defer; addr != NULL; addr = nextaddr)
6244       {
6245       log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6246         "delivery", addr->address);
6247       nextaddr = addr->next;
6248       addr->next = addr_failed;
6249       addr_failed = addr;
6250       }
6251     addr_defer = NULL;
6252     }
6253
6254   /* Now all should either have succeeded or failed. */
6255
6256   if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6257     {
6258     uschar *s = (addr_failed->user_message != NULL)?
6259       addr_failed->user_message : addr_failed->message;
6260
6261     fprintf(stderr, "Delivery failed: ");
6262     if (addr_failed->basic_errno > 0)
6263       {
6264       fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6265       if (s != NULL) fprintf(stderr, ": ");
6266       }
6267     if (s == NULL)
6268       {
6269       if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6270       }
6271     else fprintf(stderr, "%s", CS s);
6272     fprintf(stderr, "\n");
6273
6274     final_yield = DELIVER_MUA_FAILED;
6275     addr_failed = NULL;
6276     }
6277   }
6278
6279 /* In a normal configuration, we now update the retry database. This is done in
6280 one fell swoop at the end in order not to keep opening and closing (and
6281 locking) the database. The code for handling retries is hived off into a
6282 separate module for convenience. We pass it the addresses of the various
6283 chains, because deferred addresses can get moved onto the failed chain if the
6284 retry cutoff time has expired for all alternative destinations. Bypass the
6285 updating of the database if the -N flag is set, which is a debugging thing that
6286 prevents actual delivery. */
6287
6288 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6289
6290 /* If any addresses failed, we must send a message to somebody, unless
6291 af_ignore_error is set, in which case no action is taken. It is possible for
6292 several messages to get sent if there are addresses with different
6293 requirements. */
6294
6295 while (addr_failed != NULL)
6296   {
6297   pid_t pid;
6298   int fd;
6299   uschar *logtod = tod_stamp(tod_log);
6300   address_item *addr;
6301   address_item *handled_addr = NULL;
6302   address_item **paddr;
6303   address_item *msgchain = NULL;
6304   address_item **pmsgchain = &msgchain;
6305
6306   /* There are weird cases when logging is disabled in the transport. However,
6307   there may not be a transport (address failed by a router). */
6308
6309   disable_logging = FALSE;
6310   if (addr_failed->transport != NULL)
6311     disable_logging = addr_failed->transport->disable_logging;
6312
6313   DEBUG(D_deliver)
6314     debug_printf("processing failed address %s\n", addr_failed->address);
6315
6316   /* There are only two ways an address in a bounce message can get here:
6317
6318   (1) When delivery was initially deferred, but has now timed out (in the call
6319       to retry_update() above). We can detect this by testing for
6320       af_retry_timedout. If the address does not have its own errors address,
6321       we arrange to ignore the error.
6322
6323   (2) If delivery failures for bounce messages are being ignored. We can detect
6324       this by testing for af_ignore_error. This will also be set if a bounce
6325       message has been autothawed and the ignore_bounce_errors_after time has
6326       passed. It might also be set if a router was explicitly configured to
6327       ignore errors (errors_to = "").
6328
6329   If neither of these cases obtains, something has gone wrong. Log the
6330   incident, but then ignore the error. */
6331
6332   if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6333     {
6334     if (!testflag(addr_failed, af_retry_timedout) &&
6335         !testflag(addr_failed, af_ignore_error))
6336       {
6337       log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6338         "failure is neither frozen nor ignored (it's been ignored)");
6339       }
6340     setflag(addr_failed, af_ignore_error);
6341     }
6342
6343   /* If the first address on the list has af_ignore_error set, just remove
6344   it from the list, throw away any saved message file, log it, and
6345   mark the recipient done. */
6346
6347   if (testflag(addr_failed, af_ignore_error))
6348     {
6349     addr = addr_failed;
6350     addr_failed = addr->next;
6351     if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6352
6353     log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6354       addr->address,
6355       (addr->parent == NULL)? US"" : US" <",
6356       (addr->parent == NULL)? US"" : addr->parent->address,
6357       (addr->parent == NULL)? US"" : US">");
6358
6359     address_done(addr, logtod);
6360     child_done(addr, logtod);
6361     /* Panic-dies on error */
6362     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6363     }
6364
6365   /* Otherwise, handle the sending of a message. Find the error address for
6366   the first address, then send a message that includes all failed addresses
6367   that have the same error address. Note the bounce_recipient is a global so
6368   that it can be accesssed by $bounce_recipient while creating a customized
6369   error message. */
6370
6371   else
6372     {
6373     bounce_recipient = (addr_failed->p.errors_address == NULL)?
6374       sender_address : addr_failed->p.errors_address;
6375
6376     /* Make a subprocess to send a message */
6377
6378     pid = child_open_exim(&fd);
6379
6380     /* Creation of child failed */
6381
6382     if (pid < 0)
6383       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6384         "create child process to send failure message: %s", getpid(),
6385         getppid(), strerror(errno));
6386
6387     /* Creation of child succeeded */
6388
6389     else
6390       {
6391       int ch, rc;
6392       int filecount = 0;
6393       int rcount = 0;
6394       uschar *bcc, *emf_text;
6395       FILE *f = fdopen(fd, "wb");
6396       FILE *emf = NULL;
6397       BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6398       int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6399         DELIVER_IN_BUFFER_SIZE;
6400
6401       DEBUG(D_deliver)
6402         debug_printf("sending error message to: %s\n", bounce_recipient);
6403
6404       /* Scan the addresses for all that have the same errors address, removing
6405       them from the addr_failed chain, and putting them on msgchain. */
6406
6407       paddr = &addr_failed;
6408       for (addr = addr_failed; addr != NULL; addr = *paddr)
6409         {
6410         if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6411               sender_address : addr->p.errors_address) != 0)
6412           {
6413           paddr = &(addr->next);      /* Not the same; skip */
6414           }
6415         else                          /* The same - dechain */
6416           {
6417           *paddr = addr->next;
6418           *pmsgchain = addr;
6419           addr->next = NULL;
6420           pmsgchain = &(addr->next);
6421           }
6422         }
6423
6424       /* Include X-Failed-Recipients: for automatic interpretation, but do
6425       not let any one header line get too long. We do this by starting a
6426       new header every 50 recipients. Omit any addresses for which the
6427       "hide_child" flag is set. */
6428
6429       for (addr = msgchain; addr != NULL; addr = addr->next)
6430         {
6431         if (testflag(addr, af_hide_child)) continue;
6432         if (rcount >= 50)
6433           {
6434           fprintf(f, "\n");
6435           rcount = 0;
6436           }
6437         fprintf(f, "%s%s",
6438           (rcount++ == 0)? "X-Failed-Recipients: " : ",\n  ",
6439           (testflag(addr, af_pfr) && addr->parent != NULL)?
6440             string_printing(addr->parent->address) :
6441             string_printing(addr->address));
6442         }
6443       if (rcount > 0) fprintf(f, "\n");
6444
6445       /* Output the standard headers */
6446
6447       if (errors_reply_to != NULL)
6448         fprintf(f, "Reply-To: %s\n", errors_reply_to);
6449       fprintf(f, "Auto-Submitted: auto-replied\n");
6450       moan_write_from(f);
6451       fprintf(f, "To: %s\n", bounce_recipient);
6452
6453       /* Open a template file if one is provided. Log failure to open, but
6454       carry on - default texts will be used. */
6455
6456       if (bounce_message_file != NULL)
6457         {
6458         emf = Ufopen(bounce_message_file, "rb");
6459         if (emf == NULL)
6460           log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6461             "message texts: %s", bounce_message_file, strerror(errno));
6462         }
6463
6464       /* Quietly copy to configured additional addresses if required. */
6465
6466       bcc = moan_check_errorcopy(bounce_recipient);
6467       if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6468
6469       /* The texts for the message can be read from a template file; if there
6470       isn't one, or if it is too short, built-in texts are used. The first
6471       emf text is a Subject: and any other headers. */
6472
6473       emf_text = next_emf(emf, US"header");
6474       if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6475         {
6476         fprintf(f, "Subject: Mail delivery failed%s\n\n",
6477           to_sender? ": returning message to sender" : "");
6478         }
6479
6480       emf_text = next_emf(emf, US"intro");
6481       if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6482         {
6483         fprintf(f,
6484 /* This message has been reworded several times. It seems to be confusing to
6485 somebody, however it is worded. I have retreated to the original, simple
6486 wording. */
6487 "This message was created automatically by mail delivery software.\n");
6488         if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6489         if (to_sender)
6490           {
6491           fprintf(f,
6492 "\nA message that you sent could not be delivered to one or more of its\n"
6493 "recipients. This is a permanent error. The following address(es) failed:\n");
6494           }
6495         else
6496           {
6497           fprintf(f,
6498 "\nA message sent by\n\n  <%s>\n\n"
6499 "could not be delivered to one or more of its recipients. The following\n"
6500 "address(es) failed:\n", sender_address);
6501           }
6502         }
6503       fprintf(f, "\n");
6504
6505       /* Process the addresses, leaving them on the msgchain if they have a
6506       file name for a return message. (There has already been a check in
6507       post_process_one() for the existence of data in the message file.) A TRUE
6508       return from print_address_information() means that the address is not
6509       hidden. */
6510
6511       paddr = &msgchain;
6512       for (addr = msgchain; addr != NULL; addr = *paddr)
6513         {
6514         if (print_address_information(addr, f, US"  ", US"\n    ", US""))
6515           print_address_error(addr, f, US"");
6516
6517         /* End the final line for the address */
6518
6519         fputc('\n', f);
6520
6521         /* Leave on msgchain if there's a return file. */
6522
6523         if (addr->return_file >= 0)
6524           {
6525           paddr = &(addr->next);
6526           filecount++;
6527           }
6528
6529         /* Else save so that we can tick off the recipient when the
6530         message is sent. */
6531
6532         else
6533           {
6534           *paddr = addr->next;
6535           addr->next = handled_addr;
6536           handled_addr = addr;
6537           }
6538         }
6539
6540       fprintf(f, "\n");
6541
6542       /* Get the next text, whether we need it or not, so as to be
6543       positioned for the one after. */
6544
6545       emf_text = next_emf(emf, US"generated text");
6546
6547       /* If there were any file messages passed by the local transports,
6548       include them in the message. Then put the address on the handled chain.
6549       In the case of a batch of addresses that were all sent to the same
6550       transport, the return_file field in all of them will contain the same
6551       fd, and the return_filename field in the *last* one will be set (to the
6552       name of the file). */
6553
6554       if (msgchain != NULL)
6555         {
6556         address_item *nextaddr;
6557
6558         if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6559           fprintf(f,
6560             "The following text was generated during the delivery "
6561             "attempt%s:\n", (filecount > 1)? "s" : "");
6562
6563         for (addr = msgchain; addr != NULL; addr = nextaddr)
6564           {
6565           FILE *fm;
6566           address_item *topaddr = addr;
6567
6568           /* List all the addresses that relate to this file */
6569
6570           fprintf(f, "\n");
6571           while(addr != NULL)                   /* Insurance */
6572             {
6573             print_address_information(addr, f, US"------ ",  US"\n       ",
6574               US" ------\n");
6575             if (addr->return_filename != NULL) break;
6576             addr = addr->next;
6577             }
6578           fprintf(f, "\n");
6579
6580           /* Now copy the file */
6581
6582           fm = Ufopen(addr->return_filename, "rb");
6583
6584           if (fm == NULL)
6585             fprintf(f, "    +++ Exim error... failed to open text file: %s\n",
6586               strerror(errno));
6587           else
6588             {
6589             while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6590             (void)fclose(fm);
6591             }
6592           Uunlink(addr->return_filename);
6593
6594           /* Can now add to handled chain, first fishing off the next
6595           address on the msgchain. */
6596
6597           nextaddr = addr->next;
6598           addr->next = handled_addr;
6599           handled_addr = topaddr;
6600           }
6601         fprintf(f, "\n");
6602         }
6603
6604       /* Now copy the message, trying to give an intelligible comment if
6605       it is too long for it all to be copied. The limit isn't strictly
6606       applied because of the buffering. There is, however, an option
6607       to suppress copying altogether. */
6608
6609       emf_text = next_emf(emf, US"copy");
6610
6611       if (bounce_return_message)
6612         {
6613         int topt = topt_add_return_path;
6614         if (!bounce_return_body) topt |= topt_no_body;
6615
6616         if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6617           {
6618           if (bounce_return_body) fprintf(f,
6619 "------ This is a copy of the message, including all the headers. ------\n");
6620           else fprintf(f,
6621 "------ This is a copy of the message's headers. ------\n");
6622           }
6623
6624         /* While reading the "truncated" message, set return_size_limit to
6625         the actual max testing value, rounded. We need to read the message
6626         whether we are going to use it or not. */
6627
6628           {
6629           int temp = bounce_return_size_limit;
6630           bounce_return_size_limit = (max/1000)*1000;
6631           emf_text = next_emf(emf, US"truncated");
6632           bounce_return_size_limit = temp;
6633           }
6634
6635         if (bounce_return_body && bounce_return_size_limit > 0)
6636           {
6637           struct stat statbuf;
6638           if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6639             {
6640             if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6641               {
6642               fprintf(f,
6643 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6644 "------ %d or so are included here.\n", statbuf.st_size, max);
6645               }
6646             }
6647           }
6648
6649         fprintf(f, "\n");
6650         fflush(f);
6651         transport_filter_argv = NULL;   /* Just in case */
6652         return_path = sender_address;   /* In case not previously set */
6653         transport_write_message(NULL, fileno(f), topt,
6654           bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6655         }
6656
6657       /* Write final text and close the template file if one is open */
6658
6659       if (emf != NULL)
6660         {
6661         emf_text = next_emf(emf, US"final");
6662         if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6663         (void)fclose(emf);
6664         }
6665
6666       /* Close the file, which should send an EOF to the child process
6667       that is receiving the message. Wait for it to finish. */
6668
6669       (void)fclose(f);
6670       rc = child_close(pid, 0);     /* Waits for child to close, no timeout */
6671
6672       /* In the test harness, let the child do it's thing first. */
6673
6674       if (running_in_test_harness) millisleep(500);
6675
6676       /* If the process failed, there was some disaster in setting up the
6677       error message. Unless the message is very old, ensure that addr_defer
6678       is non-null, which will have the effect of leaving the message on the
6679       spool. The failed addresses will get tried again next time. However, we
6680       don't really want this to happen too often, so freeze the message unless
6681       there are some genuine deferred addresses to try. To do this we have
6682       to call spool_write_header() here, because with no genuine deferred
6683       addresses the normal code below doesn't get run. */
6684
6685       if (rc != 0)
6686         {
6687         uschar *s = US"";
6688         if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6689           {
6690           addr_defer = (address_item *)(+1);
6691           deliver_freeze = TRUE;
6692           deliver_frozen_at = time(NULL);
6693           /* Panic-dies on error */
6694           (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6695           s = US" (frozen)";
6696           }
6697         deliver_msglog("Process failed (%d) when writing error message "
6698           "to %s%s", rc, bounce_recipient, s);
6699         log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6700           "to %s%s", rc, bounce_recipient, s);
6701         }
6702
6703       /* The message succeeded. Ensure that the recipients that failed are
6704       now marked finished with on the spool and their parents updated. */
6705
6706       else
6707         {
6708         for (addr = handled_addr; addr != NULL; addr = addr->next)
6709           {
6710           address_done(addr, logtod);
6711           child_done(addr, logtod);
6712           }
6713         /* Panic-dies on error */
6714         (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6715         }
6716       }
6717     }
6718   }
6719
6720 disable_logging = FALSE;  /* In case left set */
6721
6722 /* Come here from the mua_wrapper case if routing goes wrong */
6723
6724 DELIVERY_TIDYUP:
6725
6726 /* If there are now no deferred addresses, we are done. Preserve the
6727 message log if so configured, and we are using them. Otherwise, sling it.
6728 Then delete the message itself. */
6729
6730 if (addr_defer == NULL)
6731   {
6732   if (message_logs)
6733     {
6734     sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6735       id);
6736     if (preserve_message_logs)
6737       {
6738       int rc;
6739       sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6740       if ((rc = Urename(spoolname, big_buffer)) < 0)
6741         {
6742         (void)directory_make(spool_directory, US"msglog.OLD",
6743           MSGLOG_DIRECTORY_MODE, TRUE);
6744         rc = Urename(spoolname, big_buffer);
6745         }
6746       if (rc < 0)
6747         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6748           "msglog.OLD directory", spoolname);
6749       }
6750     else
6751       {
6752       if (Uunlink(spoolname) < 0)
6753         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6754                   spoolname, strerror(errno));
6755       }
6756     }
6757
6758   /* Remove the two message files. */
6759
6760   sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6761   if (Uunlink(spoolname) < 0)
6762     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6763       spoolname, strerror(errno));
6764   sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6765   if (Uunlink(spoolname) < 0)
6766     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6767       spoolname, strerror(errno));
6768
6769   /* Log the end of this message, with queue time if requested. */
6770
6771   if ((log_extra_selector & LX_queue_time_overall) != 0)
6772     log_write(0, LOG_MAIN, "Completed QT=%s",
6773       readconf_printtime(time(NULL) - received_time));
6774   else
6775     log_write(0, LOG_MAIN, "Completed");
6776
6777   /* Unset deliver_freeze so that we won't try to move the spool files further down */
6778   deliver_freeze = FALSE;
6779   }
6780
6781 /* If there are deferred addresses, we are keeping this message because it is
6782 not yet completed. Lose any temporary files that were catching output from
6783 pipes for any of the deferred addresses, handle one-time aliases, and see if
6784 the message has been on the queue for so long that it is time to send a warning
6785 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6786 have the same domain, we can set deliver_domain for the expansion of
6787 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6788 the parent's domain.
6789
6790 If all the deferred addresses have an error number that indicates "retry time
6791 not reached", skip sending the warning message, because it won't contain the
6792 reason for the delay. It will get sent at the next real delivery attempt.
6793 However, if at least one address has tried, we'd better include all of them in
6794 the message.
6795
6796 If we can't make a process to send the message, don't worry.
6797
6798 For mailing list expansions we want to send the warning message to the
6799 mailing list manager. We can't do a perfect job here, as some addresses may
6800 have different errors addresses, but if we take the errors address from
6801 each deferred address it will probably be right in most cases.
6802
6803 If addr_defer == +1, it means there was a problem sending an error message
6804 for failed addresses, and there were no "real" deferred addresses. The value
6805 was set just to keep the message on the spool, so there is nothing to do here.
6806 */
6807
6808 else if (addr_defer != (address_item *)(+1))
6809   {
6810   address_item *addr;
6811   uschar *recipients = US"";
6812   BOOL delivery_attempted = FALSE;
6813
6814   deliver_domain = testflag(addr_defer, af_pfr)?
6815     addr_defer->parent->domain : addr_defer->domain;
6816
6817   for (addr = addr_defer; addr != NULL; addr = addr->next)
6818     {
6819     address_item *otaddr;
6820
6821     if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6822
6823     if (deliver_domain != NULL)
6824       {
6825       uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6826
6827       /* The domain may be unset for an address that has never been routed
6828       because the system filter froze the message. */
6829
6830       if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6831       }
6832
6833     if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6834
6835     /* Handle the case of one-time aliases. If any address in the ancestry
6836     of this one is flagged, ensure it is in the recipients list, suitably
6837     flagged, and that its parent is marked delivered. */
6838
6839     for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6840       if (otaddr->onetime_parent != NULL) break;
6841
6842     if (otaddr != NULL)
6843       {
6844       int i;
6845       int t = recipients_count;
6846
6847       for (i = 0; i < recipients_count; i++)
6848         {
6849         uschar *r = recipients_list[i].address;
6850         if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6851         if (Ustrcmp(otaddr->address, r) == 0) break;
6852         }
6853
6854       /* Didn't find the address already in the list, and did find the
6855       ultimate parent's address in the list. After adding the recipient,
6856       update the errors address in the recipients list. */
6857
6858       if (i >= recipients_count && t < recipients_count)
6859         {
6860         DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6861           otaddr->address, otaddr->parent->address);
6862         receive_add_recipient(otaddr->address, t);
6863         recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6864         tree_add_nonrecipient(otaddr->parent->address);
6865         update_spool = TRUE;
6866         }
6867       }
6868
6869     /* Except for error messages, ensure that either the errors address for
6870     this deferred address or, if there is none, the sender address, is on the
6871     list of recipients for a warning message. */
6872
6873     if (sender_address[0] != 0)
6874       {
6875       if (addr->p.errors_address == NULL)
6876         {
6877         if (Ustrstr(recipients, sender_address) == NULL)
6878           recipients = string_sprintf("%s%s%s", recipients,
6879             (recipients[0] == 0)? "" : ",", sender_address);
6880         }
6881       else
6882         {
6883         if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6884           recipients = string_sprintf("%s%s%s", recipients,
6885             (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6886         }
6887       }
6888     }
6889
6890   /* Send a warning message if the conditions are right. If the condition check
6891   fails because of a lookup defer, there is nothing we can do. The warning
6892   is not sent. Another attempt will be made at the next delivery attempt (if
6893   it also defers). */
6894
6895   if (!queue_2stage && delivery_attempted &&
6896       delay_warning[1] > 0 && sender_address[0] != 0 &&
6897        (delay_warning_condition == NULL ||
6898           expand_check_condition(delay_warning_condition,
6899             US"delay_warning", US"option")))
6900     {
6901     int count;
6902     int show_time;
6903     int queue_time = time(NULL) - received_time;
6904
6905     /* When running in the test harness, there's an option that allows us to
6906     fudge this time so as to get repeatability of the tests. Take the first
6907     time off the list. In queue runs, the list pointer gets updated in the
6908     calling process. */
6909
6910     if (running_in_test_harness && fudged_queue_times[0] != 0)
6911       {
6912       int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6913       if (qt >= 0)
6914         {
6915         DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6916           fudged_queue_times);
6917         queue_time = qt;
6918         }
6919       }
6920
6921     /* See how many warnings we should have sent by now */
6922
6923     for (count = 0; count < delay_warning[1]; count++)
6924       if (queue_time < delay_warning[count+2]) break;
6925
6926     show_time = delay_warning[count+1];
6927
6928     if (count >= delay_warning[1])
6929       {
6930       int extra;
6931       int last_gap = show_time;
6932       if (count > 1) last_gap -= delay_warning[count];
6933       extra = (queue_time - delay_warning[count+1])/last_gap;
6934       show_time += last_gap * extra;
6935       count += extra;
6936       }
6937
6938     DEBUG(D_deliver)
6939       {
6940       debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6941       debug_printf("warning counts: required %d done %d\n", count,
6942         warning_count);
6943       }
6944
6945     /* We have computed the number of warnings there should have been by now.
6946     If there haven't been enough, send one, and up the count to what it should
6947     have been. */
6948
6949     if (warning_count < count)
6950       {
6951       header_line *h;
6952       int fd;
6953       pid_t pid = child_open_exim(&fd);
6954
6955       if (pid > 0)
6956         {
6957         uschar *wmf_text;
6958         FILE *wmf = NULL;
6959         FILE *f = fdopen(fd, "wb");
6960
6961         if (warn_message_file != NULL)
6962           {
6963           wmf = Ufopen(warn_message_file, "rb");
6964           if (wmf == NULL)
6965             log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6966               "message texts: %s", warn_message_file, strerror(errno));
6967           }
6968
6969         warnmsg_recipients = recipients;
6970         warnmsg_delay = (queue_time < 120*60)?
6971           string_sprintf("%d minutes", show_time/60):
6972           string_sprintf("%d hours", show_time/3600);
6973
6974         if (errors_reply_to != NULL)
6975           fprintf(f, "Reply-To: %s\n", errors_reply_to);
6976         fprintf(f, "Auto-Submitted: auto-replied\n");
6977         moan_write_from(f);
6978         fprintf(f, "To: %s\n", recipients);
6979
6980         wmf_text = next_emf(wmf, US"header");
6981         if (wmf_text != NULL)
6982           fprintf(f, "%s\n", wmf_text);
6983         else
6984           fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6985             message_id, warnmsg_delay);
6986
6987         wmf_text = next_emf(wmf, US"intro");
6988         if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6989           {
6990           fprintf(f,
6991 "This message was created automatically by mail delivery software.\n");
6992
6993           if (Ustrcmp(recipients, sender_address) == 0)
6994             fprintf(f,
6995 "A message that you sent has not yet been delivered to one or more of its\n"
6996 "recipients after more than ");
6997
6998           else fprintf(f,
6999 "A message sent by\n\n  <%s>\n\n"
7000 "has not yet been delivered to one or more of its recipients after more than \n",
7001           sender_address);
7002
7003           fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
7004             primary_hostname);
7005           fprintf(f, "The message identifier is:     %s\n", message_id);
7006
7007           for (h = header_list; h != NULL; h = h->next)
7008             {
7009             if (strncmpic(h->text, US"Subject:", 8) == 0)
7010               fprintf(f, "The subject of the message is: %s", h->text + 9);
7011             else if (strncmpic(h->text, US"Date:", 5) == 0)
7012               fprintf(f, "The date of the message is:    %s", h->text + 6);
7013             }
7014           fprintf(f, "\n");
7015
7016           fprintf(f, "The address%s to which the message has not yet been "
7017             "delivered %s:\n",
7018             (addr_defer->next == NULL)? "" : "es",
7019             (addr_defer->next == NULL)? "is": "are");
7020           }
7021
7022         /* List the addresses, with error information if allowed */
7023
7024         fprintf(f, "\n");
7025         while (addr_defer != NULL)
7026           {
7027           address_item *addr = addr_defer;
7028           addr_defer = addr->next;
7029           if (print_address_information(addr, f, US"  ", US"\n    ", US""))
7030             print_address_error(addr, f, US"Delay reason: ");
7031           fprintf(f, "\n");
7032           }
7033         fprintf(f, "\n");
7034
7035         /* Final text */
7036
7037         if (wmf != NULL)
7038           {
7039           wmf_text = next_emf(wmf, US"final");
7040           if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
7041           (void)fclose(wmf);
7042           }
7043         else
7044           {
7045           fprintf(f,
7046 "No action is required on your part. Delivery attempts will continue for\n"
7047 "some time, and this warning may be repeated at intervals if the message\n"
7048 "remains undelivered. Eventually the mail delivery software will give up,\n"
7049 "and when that happens, the message will be returned to you.\n");
7050           }
7051
7052         /* Close and wait for child process to complete, without a timeout.
7053         If there's an error, don't update the count. */
7054
7055         (void)fclose(f);
7056         if (child_close(pid, 0) == 0)
7057           {
7058           warning_count = count;
7059           update_spool = TRUE;    /* Ensure spool rewritten */
7060           }
7061         }
7062       }
7063     }
7064
7065   /* Clear deliver_domain */
7066
7067   deliver_domain = NULL;
7068
7069   /* If this was a first delivery attempt, unset the first time flag, and
7070   ensure that the spool gets updated. */
7071
7072   if (deliver_firsttime)
7073     {
7074     deliver_firsttime = FALSE;
7075     update_spool = TRUE;
7076     }
7077
7078   /* If delivery was frozen and freeze_tell is set, generate an appropriate
7079   message, unless the message is a local error message (to avoid loops). Then
7080   log the freezing. If the text in "frozen_info" came from a system filter,
7081   it has been escaped into printing characters so as not to mess up log lines.
7082   For the "tell" message, we turn \n back into newline. Also, insert a newline
7083   near the start instead of the ": " string. */
7084
7085   if (deliver_freeze)
7086     {
7087     if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7088       {
7089       uschar *s = string_copy(frozen_info);
7090       uschar *ss = Ustrstr(s, " by the system filter: ");
7091
7092       if (ss != NULL)
7093         {
7094         ss[21] = '.';
7095         ss[22] = '\n';
7096         }
7097
7098       ss = s;
7099       while (*ss != 0)
7100         {
7101         if (*ss == '\\' && ss[1] == 'n')
7102           {
7103           *ss++ = ' ';
7104           *ss++ = '\n';
7105           }
7106         else ss++;
7107         }
7108       moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7109         "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7110         s, sender_address);
7111       }
7112
7113     /* Log freezing just before we update the -H file, to minimize the chance
7114     of a race problem. */
7115
7116     deliver_msglog("*** Frozen%s\n", frozen_info);
7117     log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7118     }
7119
7120   /* If there have been any updates to the non-recipients list, or other things
7121   that get written to the spool, we must now update the spool header file so
7122   that it has the right information for the next delivery attempt. If there
7123   was more than one address being delivered, the header_change update is done
7124   earlier, in case one succeeds and then something crashes. */
7125
7126   DEBUG(D_deliver)
7127     debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7128       update_spool, header_rewritten);
7129
7130   if (update_spool || header_rewritten)
7131     /* Panic-dies on error */
7132     (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7133   }
7134
7135 /* Finished with the message log. If the message is complete, it will have
7136 been unlinked or renamed above. */
7137
7138 if (message_logs) (void)fclose(message_log);
7139
7140 /* Now we can close and remove the journal file. Its only purpose is to record
7141 successfully completed deliveries asap so that this information doesn't get
7142 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7143 not serious, as trying it again is not harmful. The journal might not be open
7144 if all addresses were deferred at routing or directing. Nevertheless, we must
7145 remove it if it exists (may have been lying around from a crash during the
7146 previous delivery attempt). We don't remove the journal if a delivery
7147 subprocess failed to pass back delivery information; this is controlled by
7148 the remove_journal flag. When the journal is left, we also don't move the
7149 message off the main spool if frozen and the option is set. It should get moved
7150 at the next attempt, after the journal has been inspected. */
7151
7152 if (journal_fd >= 0) (void)close(journal_fd);
7153
7154 if (remove_journal)
7155   {
7156   sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7157   if (Uunlink(spoolname) < 0 && errno != ENOENT)
7158     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7159       strerror(errno));
7160
7161   /* Move the message off the spool if reqested */
7162
7163   #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7164   if (deliver_freeze && move_frozen_messages)
7165     (void)spool_move_message(id, message_subdir, US"", US"F");
7166   #endif
7167   }
7168
7169 /* Closing the data file frees the lock; if the file has been unlinked it
7170 will go away. Otherwise the message becomes available for another process
7171 to try delivery. */
7172
7173 (void)close(deliver_datafile);
7174 deliver_datafile = -1;
7175 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7176
7177 /* It is unlikely that there will be any cached resources, since they are
7178 released after routing, and in the delivery subprocesses. However, it's
7179 possible for an expansion for something afterwards (for example,
7180 expand_check_condition) to do a lookup. We must therefore be sure everything is
7181 released. */
7182
7183 search_tidyup();
7184 acl_where = ACL_WHERE_UNKNOWN;
7185 return final_yield;
7186 }
7187
7188 /* vi: aw ai sw=2
7189 */
7190 /* End of deliver.c */