Remove attempts to quieten compiler static-checking
[exim.git] / src / src / transports / appendfile.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9
10 #include "../exim.h"
11 #include "appendfile.h"
12
13 #ifdef SUPPORT_MAILDIR
14 #include "tf_maildir.h"
15 #endif
16
17
18 /* Options specific to the appendfile transport. They must be in alphabetic
19 order (note that "_" comes before the lower case letters). Some of them are
20 stored in the publicly visible instance block - these are flagged with the
21 opt_public flag. */
22 #define LOFF(field) OPT_OFF(appendfile_transport_options_block, field)
23
24 optionlist appendfile_transport_options[] = {
25 #ifdef SUPPORT_MAILDIR
26   { "*expand_maildir_use_size_file", opt_stringptr, LOFF(expand_maildir_use_size_file) },
27 #endif
28   { "*set_use_fcntl_lock",opt_bool | opt_hidden, LOFF(set_use_fcntl) },
29   { "*set_use_flock_lock",opt_bool | opt_hidden, LOFF(set_use_flock) },
30   { "*set_use_lockfile", opt_bool | opt_hidden, LOFF(set_use_lockfile) },
31 #ifdef SUPPORT_MBX
32   { "*set_use_mbx_lock", opt_bool | opt_hidden, LOFF(set_use_mbx_lock) },
33 #endif
34   { "allow_fifo",        opt_bool,      LOFF(allow_fifo) },
35   { "allow_symlink",     opt_bool,      LOFF(allow_symlink) },
36   { "batch_id",          opt_stringptr | opt_public, OPT_OFF(transport_instance, batch_id) },
37   { "batch_max",         opt_int | opt_public, OPT_OFF(transport_instance, batch_max) },
38   { "check_group",       opt_bool,      LOFF(check_group) },
39   { "check_owner",       opt_bool,      LOFF(check_owner) },
40   { "check_string",      opt_stringptr, LOFF(check_string) },
41   { "create_directory",  opt_bool,      LOFF(create_directory) },
42   { "create_file",       opt_stringptr, LOFF(create_file_string) },
43   { "directory",         opt_stringptr, LOFF(dirname) },
44   { "directory_file",    opt_stringptr, LOFF(dirfilename) },
45   { "directory_mode",    opt_octint,    LOFF(dirmode) },
46   { "escape_string",     opt_stringptr, LOFF(escape_string) },
47   { "file",              opt_stringptr, LOFF(filename) },
48   { "file_format",       opt_stringptr, LOFF(file_format) },
49   { "file_must_exist",   opt_bool,      LOFF(file_must_exist) },
50   { "lock_fcntl_timeout", opt_time,     LOFF(lock_fcntl_timeout) },
51   { "lock_flock_timeout", opt_time,     LOFF(lock_flock_timeout) },
52   { "lock_interval",     opt_time,      LOFF(lock_interval) },
53   { "lock_retries",      opt_int,       LOFF(lock_retries) },
54   { "lockfile_mode",     opt_octint,    LOFF(lockfile_mode) },
55   { "lockfile_timeout",  opt_time,      LOFF(lockfile_timeout) },
56   { "mailbox_filecount", opt_stringptr, LOFF(mailbox_filecount_string) },
57   { "mailbox_size",      opt_stringptr, LOFF(mailbox_size_string) },
58 #ifdef SUPPORT_MAILDIR
59   { "maildir_format",    opt_bool,      LOFF(maildir_format ) } ,
60   { "maildir_quota_directory_regex", opt_stringptr, LOFF(maildir_dir_regex) },
61   { "maildir_retries",   opt_int,       LOFF(maildir_retries) },
62   { "maildir_tag",       opt_stringptr, LOFF(maildir_tag) },
63   { "maildir_use_size_file", opt_expand_bool, LOFF(maildir_use_size_file ) } ,
64   { "maildirfolder_create_regex", opt_stringptr, LOFF(maildirfolder_create_regex ) },
65 #endif  /* SUPPORT_MAILDIR */
66 #ifdef SUPPORT_MAILSTORE
67   { "mailstore_format",  opt_bool,      LOFF(mailstore_format ) },
68   { "mailstore_prefix",  opt_stringptr, LOFF(mailstore_prefix ) },
69   { "mailstore_suffix",  opt_stringptr, LOFF(mailstore_suffix ) },
70 #endif  /* SUPPORT_MAILSTORE */
71 #ifdef SUPPORT_MBX
72   { "mbx_format",        opt_bool,      LOFF(mbx_format ) } ,
73 #endif  /* SUPPORT_MBX */
74   { "message_prefix",    opt_stringptr, LOFF(message_prefix) },
75   { "message_suffix",    opt_stringptr, LOFF(message_suffix) },
76   { "mode",              opt_octint,    LOFF(mode) },
77   { "mode_fail_narrower",opt_bool,      LOFF(mode_fail_narrower) },
78   { "notify_comsat",     opt_bool,      LOFF(notify_comsat) },
79   { "quota",             opt_stringptr, LOFF(quota) },
80   { "quota_directory",   opt_stringptr, LOFF(quota_directory) },
81   { "quota_filecount",   opt_stringptr, LOFF(quota_filecount) },
82   { "quota_is_inclusive", opt_bool,     LOFF(quota_is_inclusive) },
83   { "quota_size_regex",   opt_stringptr, LOFF(quota_size_regex) },
84   { "quota_warn_message", opt_stringptr | opt_public, OPT_OFF(transport_instance, warn_message) },
85   { "quota_warn_threshold", opt_stringptr, LOFF(quota_warn_threshold) },
86   { "use_bsmtp",         opt_bool,      LOFF(use_bsmtp) },
87   { "use_crlf",          opt_bool,      LOFF(use_crlf) },
88   { "use_fcntl_lock",    opt_bool_set,  LOFF(use_fcntl) },
89   { "use_flock_lock",    opt_bool_set,  LOFF(use_flock) },
90   { "use_lockfile",      opt_bool_set,  LOFF(use_lockfile) },
91 #ifdef SUPPORT_MBX
92   { "use_mbx_lock",      opt_bool_set,  LOFF(use_mbx_lock) },
93 #endif  /* SUPPORT_MBX */
94 };
95
96 /* Size of the options list. An extern variable has to be used so that its
97 address can appear in the tables drtables.c. */
98
99 int appendfile_transport_options_count =
100   sizeof(appendfile_transport_options)/sizeof(optionlist);
101
102
103 #ifdef MACRO_PREDEF
104
105 /* Dummy values */
106 appendfile_transport_options_block appendfile_transport_option_defaults = {0};
107 void appendfile_transport_init(transport_instance *tblock) {}
108 BOOL appendfile_transport_entry(transport_instance *tblock, address_item *addr) {return FALSE;}
109
110 #else   /*!MACRO_PREDEF*/
111
112 /* Default private options block for the appendfile transport. */
113
114 appendfile_transport_options_block appendfile_transport_option_defaults = {
115   NULL,           /* filename */
116   NULL,           /* dirname */
117   US"q${base62:$tod_epoch}-$inode", /* dirfilename */
118   NULL,           /* message_prefix (default reset in init if not bsmtp) */
119   NULL,           /* message_suffix (ditto) */
120   US"anywhere",   /* create_file_string (string value for create_file) */
121   NULL,           /* quota */
122   NULL,           /* quota_directory */
123   NULL,           /* quota_filecount */
124   NULL,           /* quota_size_regex */
125   NULL,           /* quota_warn_threshold */
126   NULL,           /* mailbox_size_string */
127   NULL,           /* mailbox_filecount_string */
128   NULL,           /* expand_maildir_use_size_file */
129   US"^(?:cur|new|\\..*)$",  /* maildir_dir_regex */
130   NULL,           /* maildir_tag */
131   NULL,           /* maildirfolder_create_regex */
132   NULL,           /* mailstore_prefix */
133   NULL,           /* mailstore_suffix */
134   NULL,           /* check_string (default changed for non-bsmtp file)*/
135   NULL,           /* escape_string (ditto) */
136   NULL,           /* file_format */
137   0,              /* quota_value */
138   0,              /* quota_warn_threshold_value */
139   -1,             /* mailbox_size_value */
140   -1,             /* mailbox_filecount_value */
141   0,              /* quota_filecount_value */
142   APPENDFILE_MODE,           /* mode */
143   APPENDFILE_DIRECTORY_MODE, /* dirmode */
144   APPENDFILE_LOCKFILE_MODE,  /* lockfile_mode */
145   30*60,          /* lockfile_timeout */
146   0,              /* lock_fcntl_timeout */
147   0,              /* lock_flock_timeout */
148   10,             /* lock_retries */
149    3,             /* lock_interval */
150   10,             /* maildir_retries */
151   create_anywhere,/* create_file */
152   0,              /* options */
153   FALSE,          /* allow_fifo */
154   FALSE,          /* allow_symlink */
155   FALSE,          /* check_group */
156   TRUE,           /* check_owner */
157   TRUE,           /* create_directory */
158   FALSE,          /* notify_comsat */
159   TRUE,           /* use_lockfile */
160   FALSE,          /* set_use_lockfile */
161   TRUE,           /* use_fcntl */
162   FALSE,          /* set_use_fcntl */
163   FALSE,          /* use_flock */
164   FALSE,          /* set_use_flock */
165   FALSE,          /* use_mbx_lock */
166   FALSE,          /* set_use_mbx_lock */
167   FALSE,          /* use_bsmtp */
168   FALSE,          /* use_crlf */
169   FALSE,          /* file_must_exist */
170   TRUE,           /* mode_fail_narrower */
171   FALSE,          /* maildir_format */
172   FALSE,          /* maildir_use_size_file */
173   FALSE,          /* mailstore_format */
174   FALSE,          /* mbx_format */
175   FALSE,          /* quota_warn_threshold_is_percent */
176   TRUE,           /* quota_is_inclusive */
177   FALSE,          /* quota_no_check */
178   FALSE           /* quota_filecount_no_check */
179 };
180
181
182 /* Encodings for mailbox formats, and their names. MBX format is actually
183 supported only if SUPPORT_MBX is set. */
184
185 enum { mbf_unix, mbf_mbx, mbf_smail, mbf_maildir, mbf_mailstore };
186
187 static const char *mailbox_formats[] = {
188   "unix", "mbx", "smail", "maildir", "mailstore" };
189
190
191 /* Check warn threshold only if quota size set or not a percentage threshold
192    percentage check should only be done if quota > 0 */
193
194 #define THRESHOLD_CHECK  (ob->quota_warn_threshold_value > 0 && \
195   (!ob->quota_warn_threshold_is_percent || ob->quota_value > 0))
196
197
198
199 /*************************************************
200 *              Setup entry point                 *
201 *************************************************/
202
203 /* Called for each delivery in the privileged state, just before the uid/gid
204 are changed and the main entry point is called. We use this function to
205 expand any quota settings, so that it can access files that may not be readable
206 by the user. It is also used to pick up external mailbox size information, if
207 set.
208
209 Arguments:
210   tblock     points to the transport instance
211   addrlist   addresses about to be delivered (not used)
212   dummy      not used (doesn't pass back data)
213   uid        the uid that will be set (not used)
214   gid        the gid that will be set (not used)
215   errmsg     where to put an error message
216
217 Returns:     OK, FAIL, or DEFER
218 */
219
220 static int
221 appendfile_transport_setup(transport_instance *tblock, address_item *addrlist,
222   transport_feedback *dummy, uid_t uid, gid_t gid, uschar **errmsg)
223 {
224 appendfile_transport_options_block *ob =
225   (appendfile_transport_options_block *)(tblock->options_block);
226 uschar *q = ob->quota;
227 double default_value = 0.0;
228
229 if (ob->expand_maildir_use_size_file)
230         ob->maildir_use_size_file = expand_check_condition(ob->expand_maildir_use_size_file,
231                 US"`maildir_use_size_file` in transport", tblock->name);
232
233 /* Loop for quota, quota_filecount, quota_warn_threshold, mailbox_size,
234 mailbox_filecount */
235
236 for (int i = 0; i < 5; i++)
237   {
238   double d;
239   int no_check = 0;
240   uschar *which = NULL;
241
242   if (q == NULL) d = default_value;
243   else
244     {
245     uschar *rest;
246     uschar *s = expand_string(q);
247
248     if (!s)
249       {
250       *errmsg = string_sprintf("Expansion of \"%s\" in %s transport failed: "
251         "%s", q, tblock->name, expand_string_message);
252       return f.search_find_defer ? DEFER : FAIL;
253       }
254
255     d = Ustrtod(s, &rest);
256
257     /* Handle following characters K, M, G, %, the latter being permitted
258     for quota_warn_threshold only. A threshold with no quota setting is
259     just ignored. */
260
261     if (tolower(*rest) == 'k') { d *= 1024.0; rest++; }
262     else if (tolower(*rest) == 'm') { d *= 1024.0*1024.0; rest++; }
263     else if (tolower(*rest) == 'g') { d *= 1024.0*1024.0*1024.0; rest++; }
264     else if (*rest == '%' && i == 2)
265       {
266       if (ob->quota_value <= 0 && !ob->maildir_use_size_file)
267         d = 0;
268       else if ((int)d < 0 || (int)d > 100)
269         {
270         *errmsg = string_sprintf("Invalid quota_warn_threshold percentage (%d)"
271           " for %s transport", (int)d, tblock->name);
272         return FAIL;
273         }
274       ob->quota_warn_threshold_is_percent = TRUE;
275       rest++;
276       }
277
278
279     /* For quota and quota_filecount there may be options
280     appended. Currently only "no_check", so we can be lazy parsing it */
281     if (i < 2 && Ustrstr(rest, "/no_check") == rest)
282       {
283        no_check = 1;
284        rest += sizeof("/no_check") - 1;
285       }
286
287     Uskip_whitespace(&rest);
288
289     if (*rest)
290       {
291       *errmsg = string_sprintf("Malformed value \"%s\" (expansion of \"%s\") "
292         "in %s transport", s, q, tblock->name);
293       return FAIL;
294       }
295     }
296
297   /* Set each value, checking for possible overflow. */
298
299   switch (i)
300     {
301     case 0:
302       if (d >= 2.0*1024.0*1024.0*1024.0 && sizeof(off_t) <= 4)
303         which = US"quota";
304       ob->quota_value = (off_t)d;
305       ob->quota_no_check = no_check;
306       q = ob->quota_filecount;
307       break;
308
309     case 1:
310       if (d >= 2.0*1024.0*1024.0*1024.0)
311         which = US"quota_filecount";
312       ob->quota_filecount_value = (int)d;
313       ob->quota_filecount_no_check = no_check;
314       q = ob->quota_warn_threshold;
315       break;
316
317     case 2:
318     if (d >= 2.0*1024.0*1024.0*1024.0 && sizeof(off_t) <= 4)
319         which = US"quota_warn_threshold";
320       ob->quota_warn_threshold_value = (off_t)d;
321       q = ob->mailbox_size_string;
322       default_value = -1.0;
323       break;
324
325     case 3:
326       if (d >= 2.0*1024.0*1024.0*1024.0 && sizeof(off_t) <= 4)
327         which = US"mailbox_size";;
328       ob->mailbox_size_value = (off_t)d;
329       q = ob->mailbox_filecount_string;
330       break;
331
332     case 4:
333       if (d >= 2.0*1024.0*1024.0*1024.0)
334         which = US"mailbox_filecount";
335       ob->mailbox_filecount_value = (int)d;
336       break;
337     }
338
339   if (which)
340     {
341     *errmsg = string_sprintf("%s value %.10g is too large (overflow) in "
342       "%s transport", which, d, tblock->name);
343     return FAIL;
344     }
345   }
346
347 return OK;
348 }
349
350
351
352 /*************************************************
353 *          Initialization entry point            *
354 *************************************************/
355
356 /* Called for each instance, after its options have been read, to
357 enable consistency checks to be done, or anything else that needs
358 to be set up. */
359
360 void
361 appendfile_transport_init(transport_instance *tblock)
362 {
363 appendfile_transport_options_block *ob =
364   (appendfile_transport_options_block *)(tblock->options_block);
365
366 /* Set up the setup entry point, to be called in the privileged state */
367
368 tblock->setup = appendfile_transport_setup;
369
370 /* Lock_retries must be greater than zero */
371
372 if (ob->lock_retries == 0) ob->lock_retries = 1;
373
374 /* Only one of a file name or directory name must be given. */
375
376 if (ob->filename && ob->dirname)
377   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
378   "only one of \"file\" or \"directory\" can be specified", tblock->name);
379
380 /* If a file name was specified, neither quota_filecount nor quota_directory
381 must be given. */
382
383 if (ob->filename)
384   {
385   if (ob->quota_filecount)
386     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
387       "quota_filecount must not be set without \"directory\"", tblock->name);
388   if (ob->quota_directory)
389     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
390       "quota_directory must not be set without \"directory\"", tblock->name);
391   }
392
393 /* The default locking depends on whether MBX is set or not. Change the
394 built-in default if none of the lock options has been explicitly set. At least
395 one form of locking is required in all cases, but mbx locking changes the
396 meaning of fcntl and flock locking. */
397
398 /* Not all operating systems provide flock(). For those that do, if flock is
399 requested, the default for fcntl is FALSE. */
400
401 if (ob->use_flock)
402   {
403   #ifdef NO_FLOCK
404   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
405     "flock() support was not available in the operating system when this "
406     "binary was built", tblock->name);
407   #endif  /* NO_FLOCK */
408   if (!ob->set_use_fcntl) ob->use_fcntl = FALSE;
409   }
410
411 #ifdef SUPPORT_MBX
412 if (ob->mbx_format)
413   if (!ob->set_use_lockfile && !ob->set_use_fcntl && !ob->set_use_flock &&
414       !ob->set_use_mbx_lock)
415     {
416     ob->use_lockfile = ob->use_flock = FALSE;
417     ob->use_mbx_lock = ob->use_fcntl = TRUE;
418     }
419   else if (ob->use_mbx_lock)
420     {
421     if (!ob->set_use_lockfile) ob->use_lockfile = FALSE;
422     if (!ob->set_use_fcntl) ob->use_fcntl = FALSE;
423     if (!ob->set_use_flock) ob->use_flock = FALSE;
424     if (!ob->use_fcntl && !ob->use_flock) ob->use_fcntl = TRUE;
425     }
426 #endif  /* SUPPORT_MBX */
427
428 if (!ob->use_fcntl && !ob->use_flock && !ob->use_lockfile && !ob->use_mbx_lock)
429   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
430     "no locking configured", tblock->name);
431
432 /* Unset timeouts for non-used locking types */
433
434 if (!ob->use_fcntl) ob->lock_fcntl_timeout = 0;
435 if (!ob->use_flock) ob->lock_flock_timeout = 0;
436
437 /* If a directory name was specified, only one of maildir or mailstore may be
438 specified, and if quota_filecount or quota_directory is given, quota must
439 be set. */
440
441 if (ob->dirname)
442   {
443   if (ob->maildir_format && ob->mailstore_format)
444     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
445       "only one of maildir and mailstore may be specified", tblock->name);
446   if (ob->quota_filecount != NULL && ob->quota == NULL)
447     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
448       "quota must be set if quota_filecount is set", tblock->name);
449   if (ob->quota_directory != NULL && ob->quota == NULL)
450     log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s transport:\n  "
451       "quota must be set if quota_directory is set", tblock->name);
452   }
453
454 /* If a fixed uid field is set, then a gid field must also be set. */
455
456 if (tblock->uid_set && !tblock->gid_set && !tblock->expand_gid)
457   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
458     "user set without group for the %s transport", tblock->name);
459
460 /* If "create_file" is set, check that a valid option is given, and set the
461 integer variable. */
462
463 if (ob->create_file_string)
464   {
465   int value = 0;
466   if (Ustrcmp(ob->create_file_string, "anywhere") == 0)
467     value = create_anywhere;
468   else if (Ustrcmp(ob->create_file_string, "belowhome") == 0)
469     value = create_belowhome;
470   else if (Ustrcmp(ob->create_file_string, "inhome") == 0)
471     value = create_inhome;
472   else
473     log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
474       "invalid value given for \"file_create\" for the %s transport: %s",
475         tblock->name, ob->create_file_string);
476   ob->create_file = value;
477   }
478
479 /* If quota_warn_threshold is set, set up default for warn_message. It may
480 not be used if the actual threshold for a given delivery ends up as zero,
481 of if it's given as a percentage and there's no quota setting. */
482
483 if (ob->quota_warn_threshold)
484   {
485   if (!tblock->warn_message) tblock->warn_message = US
486     "To: $local_part@$domain\n"
487     "Subject: Your mailbox\n\n"
488     "This message is automatically created by mail delivery software (Exim).\n\n"
489     "The size of your mailbox has exceeded a warning threshold that is\n"
490     "set by the system administrator.\n";
491   }
492
493 /* If batch SMTP is set, force the check and escape strings, and arrange that
494 headers are also escaped. */
495
496 if (ob->use_bsmtp)
497   {
498   ob->check_string = US".";
499   ob->escape_string = US"..";
500   ob->options |= topt_escape_headers;
501   }
502
503 /* If not batch SMTP, not maildir, not mailstore, and directory is not set,
504 insert default values for for the affixes and the check/escape strings. */
505
506 else if (!ob->dirname && !ob->maildir_format && !ob->mailstore_format)
507   {
508   if (!ob->message_prefix) ob->message_prefix =
509     US"From ${if def:return_path{$return_path}{MAILER-DAEMON}} ${tod_bsdinbox}\n";
510   if (!ob->message_suffix) ob->message_suffix = US"\n";
511   if (!ob->check_string) ob->check_string = US"From ";
512   if (!ob->escape_string) ob->escape_string = US">From ";
513
514   }
515
516 /* Set up the bitwise options for transport_write_message from the various
517 driver options. Only one of body_only and headers_only can be set. */
518
519 ob->options |=
520   (tblock->body_only ? topt_no_headers : 0) |
521   (tblock->headers_only ? topt_no_body : 0) |
522   (tblock->return_path_add ? topt_add_return_path : 0) |
523   (tblock->delivery_date_add ? topt_add_delivery_date : 0) |
524   (tblock->envelope_to_add ? topt_add_envelope_to : 0) |
525   ((ob->use_crlf || ob->mbx_format) ? topt_use_crlf : 0);
526 }
527
528
529
530 /*************************************************
531 *                  Notify comsat                 *
532 *************************************************/
533
534 /* The comsat daemon is the thing that provides asynchronous notification of
535 the arrival of local messages, if requested by the user by "biff y". It is a
536 BSD thing that uses a TCP/IP protocol for communication. A message consisting
537 of the text "user@offset" must be sent, where offset is the place in the
538 mailbox where new mail starts. There is no scope for telling it which file to
539 look at, which makes it a less than useful if mail is being delivered into a
540 non-standard place such as the user's home directory. In fact, it doesn't seem
541 to pay much attention to the offset.
542
543 Arguments:
544   user       user name
545   offset     offset in mailbox
546
547 Returns:     nothing
548 */
549
550 static void
551 notify_comsat(uschar *user, off_t offset)
552 {
553 struct servent *sp;
554 host_item host;
555 uschar * s;
556
557 DEBUG(D_transport) debug_printf("notify_comsat called\n");
558
559 s = string_sprintf("%.200s@" OFF_T_FMT "\n", user, offset);
560
561 if ((sp = getservbyname("biff", "udp")) == NULL)
562   {
563   DEBUG(D_transport) debug_printf("biff/udp is an unknown service");
564   return;
565   }
566
567 host.name = US"localhost";
568 host.next = NULL;
569
570
571 /* This code is all set up to look up "localhost" and use all its addresses
572 until one succeeds. However, it appears that at least on some systems, comsat
573 doesn't listen on the ::1 address. So for the moment, just force the address to
574 be 127.0.0.1. At some future stage, when IPv6 really is superseding IPv4, this
575 can be changed. (But actually, comsat is probably dying out anyway.) */
576
577 /******
578 if (host_find_byname(&host, NULL, 0, NULL, FALSE) == HOST_FIND_FAILED)
579   {
580   DEBUG(D_transport) debug_printf("\"localhost\" unknown\n");
581   return;
582   }
583 ******/
584
585 host.address = US"127.0.0.1";
586
587
588 for (host_item * h = &host; h; h = h->next)
589   {
590   int sock, rc;
591   int host_af = Ustrchr(h->address, ':') != NULL ? AF_INET6 : AF_INET;
592
593   DEBUG(D_transport) debug_printf("calling comsat on %s\n", h->address);
594
595   if ((sock = ip_socket(SOCK_DGRAM, host_af)) < 0) continue;
596
597   /* Connect never fails for a UDP socket, so don't set a timeout. */
598
599   (void)ip_connect(sock, host_af, h->address, ntohs(sp->s_port), 0, NULL);
600   rc = send(sock, s, Ustrlen(s) + 1, 0);
601   (void)close(sock);
602
603   if (rc >= 0) break;
604   DEBUG(D_transport)
605     debug_printf("send to comsat failed for %s: %s\n", strerror(errno),
606       h->address);
607   }
608 }
609
610
611
612 /*************************************************
613 *     Check the format of a file                 *
614 *************************************************/
615
616 /* This function is called when file_format is set, to check that an existing
617 file has the right format. The format string contains text/transport pairs. The
618 string matching is literal. we just read big_buffer_size bytes, because this is
619 all about the first few bytes of a file.
620
621 Arguments:
622   cfd          the open file
623   tblock       the transport block
624   addr         the address block - for inserting error data
625
626 Returns:       pointer to the required transport, or NULL
627 */
628
629 transport_instance *
630 check_file_format(int cfd, transport_instance *tblock, address_item *addr)
631 {
632 const uschar *format =
633   ((appendfile_transport_options_block *)(tblock->options_block))->file_format;
634 uschar data[256];
635 int len = read(cfd, data, sizeof(data));
636 int sep = 0;
637 uschar *s;
638
639 DEBUG(D_transport) debug_printf("checking file format\n");
640
641 /* An empty file matches the current transport */
642
643 if (len == 0) return tblock;
644
645 /* Search the formats for a match */
646
647 while ((s = string_nextinlist(&format,&sep,big_buffer,big_buffer_size)))
648   {
649   int slen = Ustrlen(s);
650   BOOL match = len >= slen && Ustrncmp(data, s, slen) == 0;
651   uschar *tp = string_nextinlist(&format, &sep, big_buffer, big_buffer_size);
652
653   if (match && tp)
654     {
655     for (transport_instance * tt = transports; tt; tt = tt->next)
656       if (Ustrcmp(tp, tt->name) == 0)
657         {
658         DEBUG(D_transport)
659           debug_printf("file format -> %s transport\n", tt->name);
660         return tt;
661         }
662     addr->basic_errno = ERRNO_BADTRANSPORT;
663     addr->message = string_sprintf("%s transport (for %.*s format) not found",
664       tp, slen, data);
665     return NULL;
666     }
667   }
668
669 /* Failed to find a match */
670
671 addr->basic_errno = ERRNO_FORMATUNKNOWN;
672 addr->message = US"mailbox file format unrecognized";
673 return NULL;
674 }
675
676
677
678
679 /*************************************************
680 *       Check directory's files for quota        *
681 *************************************************/
682
683 /* This function is called if quota is set for one of the delivery modes that
684 delivers into a specific directory. It scans the directory and stats all the
685 files in order to get a total size and count. This is an expensive thing to do,
686 but some people are prepared to bear the cost. Alternatively, if size_regex is
687 set, it is used as a regex to try to extract the size from the file name, a
688 strategy that some people use on maildir files on systems where the users have
689 no shell access.
690
691 The function is global, because it is also called from tf_maildir.c for maildir
692 folders (which should contain only regular files).
693
694 Note: Any problems can be written to debugging output, but cannot be written to
695 the log, because we are running as an unprivileged user here.
696
697 Arguments:
698   dirname       the name of the directory
699   countptr      where to add the file count (because this function recurses)
700   regex         a compiled regex to get the size from a name
701
702 Returns:        the sum of the sizes of the stattable files
703                 zero if the directory cannot be opened
704 */
705
706 off_t
707 check_dir_size(const uschar * dirname, int *countptr, const pcre *regex)
708 {
709 DIR *dir;
710 off_t sum = 0;
711 int count = *countptr;
712
713 if (!(dir = exim_opendir(dirname))) return 0;
714
715 for (struct dirent *ent; ent = readdir(dir); )
716   {
717   uschar * path, * name = US ent->d_name;
718   struct stat statbuf;
719
720   if (Ustrcmp(name, ".") == 0 || Ustrcmp(name, "..") == 0) continue;
721
722   count++;
723
724   /* If there's a regex, try to find the size using it */
725
726   if (regex)
727     {
728     int ovector[6];
729     if (pcre_exec(regex, NULL, CS name, Ustrlen(name), 0, 0, ovector,6) >= 2)
730       {
731       uschar *endptr;
732       off_t size = (off_t)Ustrtod(name + ovector[2], &endptr);
733       if (endptr == name + ovector[3])
734         {
735         sum += size;
736         DEBUG(D_transport)
737           debug_printf("check_dir_size: size from %s is " OFF_T_FMT "\n", name,
738             size);
739         continue;
740         }
741       }
742     DEBUG(D_transport)
743       debug_printf("check_dir_size: regex did not match %s\n", name);
744     }
745
746   /* No regex or no match for the regex, or captured non-digits */
747
748   path = string_sprintf("%s/%s", dirname, name);
749
750   if (Ustat(path, &statbuf) < 0)
751     {
752     DEBUG(D_transport)
753       debug_printf("check_dir_size: stat error %d for %s: %s\n", errno, path,
754         strerror(errno));
755     }
756   else
757     if ((statbuf.st_mode & S_IFMT) == S_IFREG)
758       sum += statbuf.st_size / statbuf.st_nlink;
759     else if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
760       sum += check_dir_size(path, &count, regex);
761   }
762
763 closedir(dir);
764 DEBUG(D_transport)
765   debug_printf("check_dir_size: dir=%s sum=" OFF_T_FMT " count=%d\n", dirname,
766     sum, count);
767
768 *countptr = count;
769 return sum;
770 }
771
772
773
774
775 /*************************************************
776 *         Apply a lock to a file descriptor      *
777 *************************************************/
778
779 /* This function applies a lock to a file descriptor, using a blocking or
780 non-blocking lock, depending on the timeout value. It can apply either or
781 both of a fcntl() and a flock() lock. However, not all OS support flock();
782 for those that don't, the use_flock option cannot be set.
783
784 Arguments:
785   fd          the file descriptor
786   fcntltype   type of lock, specified as F_WRLCK or F_RDLCK (that is, in
787                 fcntl() format); the flock() type is deduced if needed
788   dofcntl     do fcntl() locking
789   fcntltime   non-zero to use blocking fcntl()
790   doflock     do flock() locking
791   flocktime   non-zero to use blocking flock()
792
793 Returns:      yield of the fcntl() or flock() call, with errno preserved;
794               sigalrm_seen set if there has been a timeout
795 */
796
797 static int
798 apply_lock(int fd, int fcntltype, BOOL dofcntl, int fcntltime, BOOL doflock,
799     int flocktime)
800 {
801 int yield = 0;
802 int save_errno;
803 struct flock lock_data;
804 lock_data.l_type = fcntltype;
805 lock_data.l_whence = lock_data.l_start = lock_data.l_len = 0;
806
807 sigalrm_seen = FALSE;
808
809 if (dofcntl)
810   {
811   if (fcntltime > 0)
812     {
813     ALARM(fcntltime);
814     yield = fcntl(fd, F_SETLKW, &lock_data);
815     save_errno = errno;
816     ALARM_CLR(0);
817     errno = save_errno;
818     }
819   else yield = fcntl(fd, F_SETLK, &lock_data);
820   }
821
822 #ifndef NO_FLOCK
823 if (doflock && (yield >= 0))
824   {
825   int flocktype = (fcntltype == F_WRLCK) ? LOCK_EX : LOCK_SH;
826   if (flocktime > 0)
827     {
828     ALARM(flocktime);
829     yield = flock(fd, flocktype);
830     save_errno = errno;
831     ALARM_CLR(0);
832     errno = save_errno;
833     }
834   else yield = flock(fd, flocktype | LOCK_NB);
835   }
836 #endif  /* NO_FLOCK */
837
838 return yield;
839 }
840
841
842
843
844 #ifdef SUPPORT_MBX
845 /*************************************************
846 *         Copy message into MBX mailbox          *
847 *************************************************/
848
849 /* This function is called when a message intended for a MBX mailbox has been
850 written to a temporary file. We can now get the size of the message and then
851 copy it in MBX format to the mailbox.
852
853 Arguments:
854   to_fd        fd to write to (the real mailbox)
855   from_fd      fd to read from (the temporary file)
856   saved_size   current size of mailbox
857
858 Returns:       OK if all went well, DEFER otherwise, with errno preserved
859                the number of bytes written are added to transport_count
860                  by virtue of calling transport_write_block()
861 */
862
863 /* Values taken from c-client */
864
865 #define MBX_HDRSIZE            2048
866 #define MBX_NUSERFLAGS           30
867
868 static int
869 copy_mbx_message(int to_fd, int from_fd, off_t saved_size)
870 {
871 int used;
872 off_t size;
873 struct stat statbuf;
874 transport_ctx tctx = { .u={.fd = to_fd}, .options = topt_not_socket };
875
876 /* If the current mailbox size is zero, write a header block */
877
878 if (saved_size == 0)
879   {
880   uschar *s;
881   memset (deliver_out_buffer, '\0', MBX_HDRSIZE);
882   sprintf(CS(s = deliver_out_buffer), "*mbx*\015\012%08lx00000000\015\012",
883     (long int)time(NULL));
884   for (int i = 0; i < MBX_NUSERFLAGS; i++)
885     sprintf (CS(s += Ustrlen(s)), "\015\012");
886   if (!transport_write_block (&tctx, deliver_out_buffer, MBX_HDRSIZE, FALSE))
887     return DEFER;
888   }
889
890 DEBUG(D_transport) debug_printf("copying MBX message from temporary file\n");
891
892 /* Now construct the message's header from the time and the RFC822 file
893 size, including CRLFs, which is the size of the input (temporary) file. */
894
895 if (fstat(from_fd, &statbuf) < 0) return DEFER;
896 size = statbuf.st_size;
897
898 sprintf (CS deliver_out_buffer, "%s," OFF_T_FMT ";%08lx%04x-%08x\015\012",
899   tod_stamp(tod_mbx), size, 0L, 0, 0);
900 used = Ustrlen(deliver_out_buffer);
901
902 /* Rewind the temporary file, and copy it over in chunks. */
903
904 if (lseek(from_fd, 0 , SEEK_SET) < 0) return DEFER;
905
906 while (size > 0)
907   {
908   int len = read(from_fd, deliver_out_buffer + used,
909     DELIVER_OUT_BUFFER_SIZE - used);
910   if (len <= 0)
911     {
912     if (len == 0) errno = ERRNO_MBXLENGTH;
913     return DEFER;
914     }
915   if (!transport_write_block(&tctx, deliver_out_buffer, used + len, FALSE))
916     return DEFER;
917   size -= len;
918   used = 0;
919   }
920
921 return OK;
922 }
923 #endif  /* SUPPORT_MBX */
924
925
926
927 /*************************************************
928 *            Check creation is permitted         *
929 *************************************************/
930
931 /* This function checks whether a given file name is permitted to be created,
932 as controlled by the create_file option. If no home directory is set, however,
933 we can't do any tests.
934
935 Arguments:
936   filename     the file name
937   create_file  the ob->create_file option
938
939 Returns:       TRUE if creation is permitted
940 */
941
942 static BOOL
943 check_creation(uschar *filename, int create_file)
944 {
945 BOOL yield = TRUE;
946
947 if (deliver_home  &&  create_file != create_anywhere)
948   {
949   int len = Ustrlen(deliver_home);
950   uschar *file = filename;
951
952   while (file[0] == '/' && file[1] == '/') file++;
953   if (Ustrncmp(file, deliver_home, len) != 0 || file[len] != '/' ||
954        ( Ustrchr(file+len+2, '/') != NULL &&
955          (
956          create_file != create_belowhome ||
957          Ustrstr(file+len, "/../") != NULL
958          )
959        )
960      ) yield = FALSE;
961
962   /* If yield is TRUE, the file name starts with the home directory, and does
963   not contain any instances of "/../" in the "belowhome" case. However, it may
964   still contain symbolic links. We can check for this by making use of
965   realpath(), which most Unixes seem to have (but make it possible to cut this
966   out). We can't just use realpath() on the whole file name, because we know
967   the file itself doesn't exist, and intermediate directories may also not
968   exist. What we want to know is the real path of the longest existing part of
969   the path. That must match the home directory's beginning, whichever is the
970   shorter. */
971
972   #ifndef NO_REALPATH
973   if (yield && create_file == create_belowhome)
974     {
975     uschar *next;
976     uschar *rp = NULL;
977     for (uschar * slash = Ustrrchr(file, '/');  /* There is known to be one */
978          !rp && slash > file;                   /* Stop if reached beginning */
979          slash = next)
980       {
981       *slash = 0;
982       rp = US realpath(CS file, CS big_buffer);
983       next = Ustrrchr(file, '/');
984       *slash = '/';
985       }
986
987     /* If rp == NULL it means that none of the relevant directories exist.
988     This is not a problem here - it means that no symbolic links can exist,
989     which is all we are worried about. Otherwise, we must compare it
990     against the start of the home directory. However, that may itself
991     contain symbolic links, so we have to "realpath" it as well, if
992     possible. */
993
994     if (rp)
995       {
996       uschar hdbuffer[PATH_MAX+1];
997       uschar *rph = deliver_home;
998       int rlen = Ustrlen(big_buffer);
999
1000       if ((rp = US realpath(CS deliver_home, CS hdbuffer)))
1001         {
1002         rph = hdbuffer;
1003         len = Ustrlen(rph);
1004         }
1005
1006       if (rlen > len) rlen = len;
1007       if (Ustrncmp(rph, big_buffer, rlen) != 0)
1008         {
1009         yield = FALSE;
1010         DEBUG(D_transport) debug_printf("Real path \"%s\" does not match \"%s\"\n",
1011           big_buffer, deliver_home);
1012         }
1013       }
1014     }
1015   #endif  /* NO_REALPATH */
1016   }
1017
1018 return yield;
1019 }
1020
1021
1022
1023 /*************************************************
1024 *              Main entry point                  *
1025 *************************************************/
1026
1027 /* See local README for general interface details. This transport always
1028 returns FALSE, indicating that the status which has been placed in the first
1029 address should be copied to any other addresses in a batch.
1030
1031 Appendfile delivery is tricky and has led to various security problems in other
1032 mailers. The logic used here is therefore laid out in some detail. When this
1033 function is called, we are running in a subprocess which has had its gid and
1034 uid set to the appropriate values. Therefore, we cannot write directly to the
1035 exim logs. Any errors must be handled by setting appropriate return codes.
1036 Note that the default setting for addr->transport_return is DEFER, so it need
1037 not be set unless some other value is required.
1038
1039 The code below calls geteuid() rather than getuid() to get the current uid
1040 because in weird configurations not running setuid root there may be a
1041 difference. In the standard configuration, where setuid() has been used in the
1042 delivery process, there will be no difference between the uid and the euid.
1043
1044 (1)  If the af_file flag is set, this is a delivery to a file after .forward or
1045      alias expansion. Otherwise, there must be a configured file name or
1046      directory name.
1047
1048 The following items apply in the case when a file name (as opposed to a
1049 directory name) is given, that is, when appending to a single file:
1050
1051 (2f) Expand the file name.
1052
1053 (3f) If the file name is /dev/null, return success (optimization).
1054
1055 (4f) If the file_format options is set, open the file for reading, and check
1056      that the bytes at the start of the file match one of the given strings.
1057      If the check indicates a transport other than the current one should be
1058      used, pass control to that other transport. Otherwise continue. An empty
1059      or non-existent file matches the current transport. The file is closed
1060      after the check.
1061
1062 (5f) If a lock file is required, create it (see extensive separate comments
1063      below about the algorithm for doing this). It is important to do this
1064      before opening the mailbox if NFS is in use.
1065
1066 (6f) Stat the file, using lstat() rather than stat(), in order to pick up
1067      details of any symbolic link.
1068
1069 (7f) If the file already exists:
1070
1071      Check the owner and group if necessary, and defer if they are wrong.
1072
1073      If it is a symbolic link AND the allow_symlink option is set (NOT the
1074      default), go back to (6f) but this time use stat() instead of lstat().
1075
1076      If it's not a regular file (or FIFO when permitted), defer delivery.
1077
1078      Check permissions. If the required permissions are *less* than the
1079      existing ones, or supplied by the address (often by the user via filter),
1080      chmod() the file. Otherwise, defer.
1081
1082      Save the inode number.
1083
1084      Open with O_RDRW + O_APPEND, thus failing if the file has vanished.
1085
1086      If open fails because the file does not exist, go to (6f); on any other
1087      failure, defer.
1088
1089      Check the inode number hasn't changed - I realize this isn't perfect (an
1090      inode can be reused) but it's cheap and will catch some of the races.
1091
1092      Check it's still a regular file (or FIFO if permitted).
1093
1094      Check that the owner and permissions haven't changed.
1095
1096      If file_format is set, check that the file still matches the format for
1097      the current transport. If not, defer delivery.
1098
1099 (8f) If file does not exist initially:
1100
1101      Open with O_WRONLY + O_EXCL + O_CREAT with configured mode, unless we know
1102      this is via a symbolic link (only possible if allow_symlinks is set), in
1103      which case don't use O_EXCL, as it doesn't work.
1104
1105      If open fails because the file already exists, go to (6f). To avoid
1106      looping for ever in a situation where the file is continuously being
1107      created and deleted, all of this happens inside a loop that operates
1108      lock_retries times and includes the fcntl and flock locking. If the
1109      loop completes without the file getting opened, defer and request
1110      freezing, because something really weird is happening.
1111
1112      If open fails for any other reason, defer for subsequent delivery except
1113      when this is a file delivery resulting from an alias or forward expansion
1114      and the error is EPERM or ENOENT or EACCES, in which case FAIL as this is
1115      most likely a user rather than a configuration error.
1116
1117 (9f) We now have the file checked and open for writing. If so configured, lock
1118      it using fcntl, flock, or MBX locking rules. If this fails, close the file
1119      and goto (6f), up to lock_retries times, after sleeping for a while. If it
1120      still fails, give up and defer delivery.
1121
1122 (10f)Save the access time (for subsequent restoration) and the size of the
1123      file, for comsat and for re-setting if delivery fails in the middle -
1124      e.g. for quota exceeded.
1125
1126 The following items apply in the case when a directory name is given:
1127
1128 (2d) Create a new file in the directory using a temporary name, by opening for
1129      writing and with O_CREAT. If maildir format is being used, the file
1130      is created in a temporary subdirectory with a prescribed name. If
1131      mailstore format is being used, the envelope file is first created with a
1132      temporary name, then the data file.
1133
1134 The following items apply in all cases:
1135
1136 (11) We now have the file open for writing, and locked if it was given as a
1137      file name. Write the message and flush the file, unless there is a setting
1138      of the local quota option, in which case we can check for its excession
1139      without doing any writing.
1140
1141      In the case of MBX format mailboxes, the message is first written to a
1142      temporary file, in order to get its correct length. This is then copied to
1143      the real file, preceded by an MBX header.
1144
1145      If there is a quota error on writing, defer the address. Timeout logic
1146      will determine for how long retries are attempted. We restore the mailbox
1147      to its original length if it's a single file. There doesn't seem to be a
1148      uniform error code for quota excession (it even differs between SunOS4
1149      and some versions of SunOS5) so a system-dependent macro called
1150      ERRNO_QUOTA is used for it, and the value gets put into errno_quota at
1151      compile time.
1152
1153      For any other error (most commonly disk full), do the same.
1154
1155 The following applies after appending to a file:
1156
1157 (12f)Restore the atime; notify_comsat if required; close the file (which
1158      unlocks it if it was locked). Delete the lock file if it exists.
1159
1160 The following applies after writing a unique file in a directory:
1161
1162 (12d)For maildir format, rename the file into the new directory. For mailstore
1163      format, rename the envelope file to its correct name. Otherwise, generate
1164      a unique name from the directory_file option, and rename to that, possibly
1165      trying a few times if the file exists and re-expanding the name gives a
1166      different string.
1167
1168 This transport yields FAIL only when a file name is generated by an alias or
1169 forwarding operation and attempting to open it gives EPERM, ENOENT, or EACCES.
1170 All other failures return DEFER (in addr->transport_return). */
1171
1172
1173 BOOL
1174 appendfile_transport_entry(
1175   transport_instance *tblock,      /* data for this instantiation */
1176   address_item *addr)              /* address we are working on */
1177 {
1178 appendfile_transport_options_block *ob =
1179   (appendfile_transport_options_block *)(tblock->options_block);
1180 struct stat statbuf;
1181 uschar *fdname = NULL;
1182 uschar *filename = NULL;
1183 uschar *hitchname = NULL;
1184 uschar *dataname = NULL;
1185 uschar *lockname = NULL;
1186 uschar *newname = NULL;
1187 uschar *nametag = NULL;
1188 uschar *cr = US"";
1189 uschar *filecount_msg = US"";
1190 uschar *path;
1191 struct utimbuf times;
1192 struct timeval msg_tv;
1193 BOOL disable_quota = FALSE;
1194 BOOL isdirectory = FALSE;
1195 BOOL isfifo = FALSE;
1196 BOOL wait_for_tick = FALSE;
1197 uid_t uid = geteuid();     /* See note above */
1198 gid_t gid = getegid();
1199 int mbformat;
1200 int mode = (addr->mode > 0) ? addr->mode : ob->mode;
1201 off_t saved_size = -1;
1202 off_t mailbox_size = ob->mailbox_size_value;
1203 int mailbox_filecount = ob->mailbox_filecount_value;
1204 int hd = -1;
1205 int fd = -1;
1206 int yield = FAIL;
1207 int i;
1208
1209 #ifdef SUPPORT_MBX
1210 int save_fd = 0;
1211 int mbx_lockfd = -1;
1212 uschar mbx_lockname[40];
1213 FILE *temp_file = NULL;
1214 #endif  /* SUPPORT_MBX */
1215
1216 #ifdef SUPPORT_MAILDIR
1217 int maildirsize_fd = -1;      /* fd for maildirsize file */
1218 int maildir_save_errno;
1219 #endif
1220
1221
1222 DEBUG(D_transport) debug_printf("appendfile transport entered\n");
1223
1224 /* An "address_file" or "address_directory" transport is used to deliver to
1225 files specified via .forward or an alias file. Prior to release 4.20, the
1226 "file" and "directory" options were ignored in this case. This has been changed
1227 to allow the redirection data to specify what is in effect a folder, whose
1228 location is determined by the options on the transport.
1229
1230 Compatibility with the case when neither option is set is retained by forcing a
1231 value for the file or directory name. A directory delivery is assumed if the
1232 last character of the path from the router is '/'.
1233
1234 The file path is in the local part of the address, but not in the $local_part
1235 variable (that holds the parent local part). It is, however, in the
1236 $address_file variable. Below, we update the local part in the address if it
1237 changes by expansion, so that the final path ends up in the log. */
1238
1239 if (testflag(addr, af_file) && !ob->filename && !ob->dirname)
1240   {
1241   fdname = US"$address_file";
1242   if (address_file[Ustrlen(address_file)-1] == '/' ||
1243       ob->maildir_format ||
1244       ob->mailstore_format)
1245     isdirectory = TRUE;
1246   }
1247
1248 /* Handle (a) an "address file" delivery where "file" or "directory" is
1249 explicitly set and (b) a non-address_file delivery, where one of "file" or
1250 "directory" must be set; initialization ensures that they are not both set. */
1251
1252 if (!fdname)
1253   {
1254   if (!(fdname = ob->filename))
1255     {
1256     fdname = ob->dirname;
1257     isdirectory = TRUE;
1258     }
1259   if (!fdname)
1260     {
1261     addr->message = string_sprintf("Mandatory file or directory option "
1262       "missing from %s transport", tblock->name);
1263     goto ret_panic;
1264     }
1265   }
1266
1267 /* Maildir and mailstore require a directory */
1268
1269 if ((ob->maildir_format || ob->mailstore_format) && !isdirectory)
1270   {
1271   addr->message = string_sprintf("mail%s_format requires \"directory\" "
1272     "to be specified for the %s transport",
1273     ob->maildir_format ? "dir" : "store", tblock->name);
1274   goto ret_panic;
1275   }
1276
1277 if (!(path = expand_string(fdname)))
1278   {
1279   addr->message = string_sprintf("Expansion of \"%s\" (file or directory "
1280     "name for %s transport) failed: %s", fdname, tblock->name,
1281     expand_string_message);
1282   goto ret_panic;
1283   }
1284 if (is_tainted(path))
1285   {
1286   addr->message = string_sprintf("Tainted '%s' (file or directory "
1287     "name for %s transport) not permitted", path, tblock->name);
1288   goto ret_panic;
1289   }
1290
1291 if (path[0] != '/')
1292   {
1293   addr->message = string_sprintf("appendfile: file or directory name "
1294     "\"%s\" is not absolute", path);
1295   addr->basic_errno = ERRNO_NOTABSOLUTE;
1296   return FALSE;
1297   }
1298
1299 /* For a file delivery, make sure the local part in the address(es) is updated
1300 to the true local part. */
1301
1302 if (testflag(addr, af_file))
1303   for (address_item * addr2 = addr; addr2; addr2 = addr2->next)
1304     addr2->local_part = string_copy(path);
1305
1306 /* The available mailbox formats depend on whether it is a directory or a file
1307 delivery. */
1308
1309 if (isdirectory)
1310   {
1311   mbformat =
1312   #ifdef SUPPORT_MAILDIR
1313     ob->maildir_format ? mbf_maildir :
1314   #endif
1315   #ifdef SUPPORT_MAILSTORE
1316     ob->mailstore_format ? mbf_mailstore :
1317   #endif
1318     mbf_smail;
1319   }
1320 else
1321   {
1322   mbformat =
1323   #ifdef SUPPORT_MBX
1324     ob->mbx_format ? mbf_mbx :
1325   #endif
1326     mbf_unix;
1327   }
1328
1329 DEBUG(D_transport)
1330   {
1331   debug_printf("appendfile: mode=%o notify_comsat=%d quota=" OFF_T_FMT
1332     "%s%s"
1333     " warning=" OFF_T_FMT "%s\n"
1334     "  %s=%s format=%s\n  message_prefix=%s\n  message_suffix=%s\n  "
1335     "maildir_use_size_file=%s\n",
1336     mode, ob->notify_comsat, ob->quota_value,
1337     ob->quota_no_check ? " (no_check)" : "",
1338     ob->quota_filecount_no_check ? " (no_check_filecount)" : "",
1339     ob->quota_warn_threshold_value,
1340     ob->quota_warn_threshold_is_percent ? "%" : "",
1341     isdirectory ? "directory" : "file",
1342     path, mailbox_formats[mbformat],
1343     !ob->message_prefix ? US"null" : string_printing(ob->message_prefix),
1344     !ob->message_suffix ? US"null" : string_printing(ob->message_suffix),
1345     ob->maildir_use_size_file ? "yes" : "no");
1346
1347   if (!isdirectory) debug_printf("  locking by %s%s%s%s%s\n",
1348     ob->use_lockfile ? "lockfile " : "",
1349     ob->use_mbx_lock ? "mbx locking (" : "",
1350     ob->use_fcntl ? "fcntl " : "",
1351     ob->use_flock ? "flock" : "",
1352     ob->use_mbx_lock ? ")" : "");
1353   }
1354
1355 /* If the -N option is set, can't do any more. */
1356
1357 if (f.dont_deliver)
1358   {
1359   DEBUG(D_transport)
1360     debug_printf("*** delivery by %s transport bypassed by -N option\n",
1361       tblock->name);
1362   addr->transport_return = OK;
1363   return FALSE;
1364   }
1365
1366 /* Handle the case of a file name. If the file name is /dev/null, we can save
1367 ourselves some effort and just give a success return right away. */
1368
1369 if (!isdirectory)
1370   {
1371   BOOL use_lstat = TRUE;
1372   BOOL file_opened = FALSE;
1373   BOOL allow_creation_here = TRUE;
1374
1375   if (Ustrcmp(path, "/dev/null") == 0)
1376     {
1377     addr->transport_return = OK;
1378     return FALSE;
1379     }
1380
1381   /* Set the name of the file to be opened, and the file to which the data
1382   is written, and find out if we are permitted to create a non-existent file. */
1383
1384   dataname = filename = path;
1385   allow_creation_here = check_creation(filename, ob->create_file);
1386
1387   /* If ob->create_directory is set, attempt to create the directories in
1388   which this mailbox lives, but only if we are permitted to create the file
1389   itself. We know we are dealing with an absolute path, because this was
1390   checked above. */
1391
1392   if (ob->create_directory && allow_creation_here)
1393     {
1394     uschar *p = Ustrrchr(path, '/');
1395     *p = '\0';
1396     if (!directory_make(NULL, path, ob->dirmode, FALSE))
1397       {
1398       addr->basic_errno = errno;
1399       addr->message =
1400         string_sprintf("failed to create directories for %s: %s", path,
1401           strerror(errno));
1402       DEBUG(D_transport) debug_printf("%s transport: %s\n", tblock->name, path);
1403       return FALSE;
1404       }
1405     *p = '/';
1406     }
1407
1408   /* If file_format is set we must check that any existing file matches one of
1409   the configured formats by checking the bytes it starts with. A match then
1410   indicates a specific transport - if it is not this one, pass control to it.
1411   Otherwise carry on here. An empty or non-existent file matches the current
1412   transport. We don't need to distinguish between non-existence and other open
1413   failures because if an existing file fails to open here, it will also fail
1414   again later when O_RDWR is used. */
1415
1416   if (ob->file_format)
1417     {
1418     int cfd = Uopen(path, O_RDONLY, 0);
1419     if (cfd >= 0)
1420       {
1421       transport_instance *tt = check_file_format(cfd, tblock, addr);
1422       (void)close(cfd);
1423
1424       /* If another transport is indicated, call it and return; if no transport
1425       was found, just return - the error data will have been set up.*/
1426
1427       if (tt != tblock)
1428         {
1429         if (tt)
1430           {
1431           set_process_info("delivering %s to %s using %s", message_id,
1432             addr->local_part, tt->name);
1433           debug_print_string(tt->debug_string);
1434           addr->transport = tt;
1435           (tt->info->code)(tt, addr);
1436           }
1437         return FALSE;
1438         }
1439       }
1440     }
1441
1442   /* The locking of mailbox files is worse than the naming of cats, which is
1443   known to be "a difficult matter" (T.S. Eliot) and just as cats must have
1444   three different names, so several different styles of locking are used.
1445
1446   Research in other programs that lock mailboxes shows that there is no
1447   universally standard method. Having mailboxes NFS-mounted on the system that
1448   is delivering mail is not the best thing, but people do run like this,
1449   and so the code must do its best to cope.
1450
1451   Three different locking mechanisms are supported. The initialization function
1452   checks that at least one is configured.
1453
1454   LOCK FILES
1455
1456   Unless no_use_lockfile is set, we attempt to build a lock file in a way that
1457   will work over NFS. Only after that is done do we actually open the mailbox
1458   and apply locks to it (if configured).
1459
1460   Originally, Exim got the file opened before doing anything about locking.
1461   However, a very occasional problem was observed on Solaris 2 when delivering
1462   over NFS. It is seems that when a file is opened with O_APPEND, the file size
1463   gets remembered at open time. If another process on another host (that's
1464   important) has the file open and locked and writes to it and then releases
1465   the lock while the first process is waiting to get the lock, the first
1466   process may fail to write at the new end point of the file - despite the very
1467   definite statement about O_APPEND in the man page for write(). Experiments
1468   have reproduced this problem, but I do not know any way of forcing a host to
1469   update its attribute cache for an open NFS file. It would be nice if it did
1470   so when a lock was taken out, but this does not seem to happen. Anyway, to
1471   reduce the risk of this problem happening, we now create the lock file
1472   (if configured) *before* opening the mailbox. That will prevent two different
1473   Exims opening the file simultaneously. It may not prevent clashes with MUAs,
1474   however, but Pine at least seems to operate in the same way.
1475
1476   Lockfiles should normally be used when NFS is involved, because of the above
1477   problem.
1478
1479   The logic for creating the lock file is:
1480
1481   . The name of the lock file is <mailbox-name>.lock
1482
1483   . First, create a "hitching post" name by adding the primary host name,
1484     current time and pid to the lock file name. This should be unique.
1485
1486   . Create the hitching post file using WRONLY + CREAT + EXCL.
1487
1488   . If that fails EACCES, we assume it means that the user is unable to create
1489     files in the mail spool directory. Some installations might operate in this
1490     manner, so there is a configuration option to allow this state not to be an
1491     error - we proceed to lock using fcntl only, after the file is open.
1492
1493   . Otherwise, an error causes a deferment of the address.
1494
1495   . Hard link the hitching post to the lock file name.
1496
1497   . If the link succeeds, we have successfully created the lock file. Simply
1498     close and unlink the hitching post file.
1499
1500   . If the link does not succeed, proceed as follows:
1501
1502     o Fstat the hitching post file, and then close and unlink it.
1503
1504     o Now examine the stat data. If the number of links to the file is exactly
1505       2, the linking succeeded but for some reason, e.g. an NFS server crash,
1506       the return never made it back, so the link() function gave a failure
1507       return.
1508
1509   . This method allows for the lock file to be created by some other process
1510     right up to the moment of the attempt to hard link it, and is also robust
1511     against NFS server crash-reboots, which would probably result in timeouts
1512     in the middle of link().
1513
1514   . System crashes may cause lock files to get left lying around, and some means
1515     of flushing them is required. The approach of writing a pid (used by smail
1516     and by elm) into the file isn't useful when NFS may be in use. Pine uses a
1517     timeout, which seems a better approach. Since any program that writes to a
1518     mailbox using a lock file should complete its task very quickly, Pine
1519     removes lock files that are older than 5 minutes. We allow the value to be
1520     configurable on the transport.
1521
1522   FCNTL LOCKING
1523
1524   If use_fcntl_lock is set, then Exim gets an exclusive fcntl() lock on the
1525   mailbox once it is open. This is done by default with a non-blocking lock.
1526   Failures to lock cause retries after a sleep, but only for a certain number
1527   of tries. A blocking lock is deliberately not used so that we don't hold the
1528   mailbox open. This minimizes the possibility of the NFS problem described
1529   under LOCK FILES above, if for some reason NFS deliveries are happening
1530   without lock files. However, the use of a non-blocking lock and sleep, though
1531   the safest approach, does not give the best performance on very busy systems.
1532   A blocking lock plus timeout does better. Therefore Exim has an option to
1533   allow it to work this way. If lock_fcntl_timeout is set greater than zero, it
1534   enables the use of blocking fcntl() calls.
1535
1536   FLOCK LOCKING
1537
1538   If use_flock_lock is set, then Exim gets an exclusive flock() lock in the
1539   same manner as for fcntl locking above. No-blocking/timeout is also set as
1540   above in lock_flock_timeout. Not all operating systems provide or support
1541   flock(). For those that don't (as determined by the definition of LOCK_SH in
1542   /usr/include/sys/file.h), use_flock_lock may not be set. For some OS, flock()
1543   is implemented (not precisely) on top of fcntl(), which means there's no
1544   point in actually using it.
1545
1546   MBX LOCKING
1547
1548   If use_mbx_lock is set (this is supported only if SUPPORT_MBX is defined)
1549   then the rules used for locking in c-client are used. Exim takes out a shared
1550   lock on the mailbox file, and an exclusive lock on the file whose name is
1551   /tmp/.<device-number>.<inode-number>. The shared lock on the mailbox stops
1552   any other MBX client from getting an exclusive lock on it and expunging it.
1553   It also stops any other MBX client from unlinking the /tmp lock when it has
1554   finished with it.
1555
1556   The exclusive lock on the /tmp file prevents any other MBX client from
1557   updating the mailbox in any way. When writing is finished, if an exclusive
1558   lock on the mailbox can be obtained, indicating there are no current sharers,
1559   the /tmp file is unlinked.
1560
1561   MBX locking can use either fcntl() or flock() locking. If neither
1562   use_fcntl_lock or use_flock_lock is set, it defaults to using fcntl() only.
1563   The calls for getting these locks are by default non-blocking, as for non-mbx
1564   locking, but can be made blocking by setting lock_fcntl_timeout and/or
1565   lock_flock_timeout as appropriate.  As MBX delivery doesn't work over NFS, it
1566   probably makes sense to set timeouts for any MBX deliveries. */
1567
1568
1569   /* Build a lock file if configured to do so - the existence of a lock
1570   file is subsequently checked by looking for a non-negative value of the
1571   file descriptor hd - even though the file is no longer open. */
1572
1573   if (ob->use_lockfile)
1574     {
1575     /* cf. exim_lock.c */
1576     lockname = string_sprintf("%s.lock", filename);
1577     hitchname = string_sprintf( "%s.%s.%08x.%08x", lockname, primary_hostname,
1578       (unsigned int)(time(NULL)), (unsigned int)getpid());
1579
1580     DEBUG(D_transport) debug_printf("lock name: %s\nhitch name: %s\n", lockname,
1581       hitchname);
1582
1583     /* Lock file creation retry loop */
1584
1585     for (i = 0; i < ob->lock_retries; sleep(ob->lock_interval), i++)
1586       {
1587       int rc;
1588
1589       hd = Uopen(hitchname, O_WRONLY | O_CREAT | O_EXCL, ob->lockfile_mode);
1590       if (hd < 0)
1591         {
1592         addr->basic_errno = errno;
1593         addr->message =
1594           string_sprintf("creating lock file hitching post %s "
1595             "(euid=%ld egid=%ld)", hitchname, (long int)geteuid(),
1596             (long int)getegid());
1597         return FALSE;
1598         }
1599
1600       /* Attempt to hitch the hitching post to the lock file. If link()
1601       succeeds (the common case, we hope) all is well. Otherwise, fstat the
1602       file, and get rid of the hitching post. If the number of links was 2,
1603       the link was created, despite the failure of link(). If the hitch was
1604       not successful, try again, having unlinked the lock file if it is too
1605       old.
1606
1607       There's a version of Linux (2.0.27) which doesn't update its local cache
1608       of the inode after link() by default - which many think is a bug - but
1609       if the link succeeds, this code will be OK. It just won't work in the
1610       case when link() fails after having actually created the link. The Linux
1611       NFS person is fixing this; a temporary patch is available if anyone is
1612       sufficiently worried. */
1613
1614       if ((rc = Ulink(hitchname, lockname)) != 0) fstat(hd, &statbuf);
1615       (void)close(hd);
1616       Uunlink(hitchname);
1617       if (rc != 0 && statbuf.st_nlink != 2)
1618         {
1619         if (ob->lockfile_timeout > 0 && Ustat(lockname, &statbuf) == 0 &&
1620             time(NULL) - statbuf.st_ctime > ob->lockfile_timeout)
1621           {
1622           DEBUG(D_transport) debug_printf("unlinking timed-out lock file\n");
1623           Uunlink(lockname);
1624           }
1625         DEBUG(D_transport) debug_printf("link of hitching post failed - retrying\n");
1626         continue;
1627         }
1628
1629       DEBUG(D_transport) debug_printf("lock file created\n");
1630       break;
1631       }
1632
1633     /* Check for too many tries at creating the lock file */
1634
1635     if (i >= ob->lock_retries)
1636       {
1637       addr->basic_errno = ERRNO_LOCKFAILED;
1638       addr->message = string_sprintf("failed to lock mailbox %s (lock file)",
1639         filename);
1640       return FALSE;
1641       }
1642     }
1643
1644
1645   /* We now have to get the file open. First, stat() it and act on existence or
1646   non-existence. This is in a loop to handle the case of a file's being created
1647   or deleted as we watch, and also to handle retries when the locking fails.
1648   Rather than holding the file open while waiting for the fcntl() and/or
1649   flock() lock, we close and do the whole thing again. This should be safer,
1650   especially for NFS files, which might get altered from other hosts, making
1651   their cached sizes incorrect.
1652
1653   With the default settings, no symlinks are permitted, but there is an option
1654   to permit symlinks for those sysadmins that know what they are doing.
1655   Shudder. However, insist that the initial symlink is owned by the right user.
1656   Thus lstat() is used initially; if a symlink is discovered, the loop is
1657   repeated such that stat() is used, to look at the end file. */
1658
1659   for (i = 0; i < ob->lock_retries; i++)
1660     {
1661     int sleep_before_retry = TRUE;
1662     file_opened = FALSE;
1663
1664     if ((use_lstat ? Ulstat(filename, &statbuf) : Ustat(filename, &statbuf)) != 0)
1665       {
1666       /* Let's hope that failure to stat (other than non-existence) is a
1667       rare event. */
1668
1669       if (errno != ENOENT)
1670         {
1671         addr->basic_errno = errno;
1672         addr->message = string_sprintf("attempting to stat mailbox %s",
1673           filename);
1674         goto RETURN;
1675         }
1676
1677       /* File does not exist. If it is required to pre-exist this state is an
1678       error. */
1679
1680       if (ob->file_must_exist)
1681         {
1682         addr->basic_errno = errno;
1683         addr->message = string_sprintf("mailbox %s does not exist, "
1684           "but file_must_exist is set", filename);
1685         goto RETURN;
1686         }
1687
1688       /* If not permitted to create this file because it isn't in or below
1689       the home directory, generate an error. */
1690
1691       if (!allow_creation_here)
1692         {
1693         addr->basic_errno = ERRNO_BADCREATE;
1694         addr->message = string_sprintf("mailbox %s does not exist, "
1695           "but creation outside the home directory is not permitted",
1696           filename);
1697         goto RETURN;
1698         }
1699
1700       /* Attempt to create and open the file. If open fails because of
1701       pre-existence, go round the loop again. For any other error, defer the
1702       address, except for an alias or forward generated file name with EPERM,
1703       ENOENT, or EACCES, as those are most likely to be user errors rather
1704       than Exim config errors. When a symbolic link is permitted and points
1705       to a non-existent file, we get here with use_lstat = FALSE. In this case
1706       we mustn't use O_EXCL, since it doesn't work. The file is opened RDRW for
1707       consistency and because MBX locking requires it in order to be able to
1708       get a shared lock. */
1709
1710       fd = Uopen(filename, O_RDWR | O_APPEND | O_CREAT |
1711         (use_lstat ? O_EXCL : 0), mode);
1712       if (fd < 0)
1713         {
1714         if (errno == EEXIST) continue;
1715         addr->basic_errno = errno;
1716         addr->message = string_sprintf("while creating mailbox %s",
1717           filename);
1718         if (testflag(addr, af_file) &&
1719             (errno == EPERM || errno == ENOENT || errno == EACCES))
1720           addr->transport_return = FAIL;
1721         goto RETURN;
1722         }
1723
1724       /* We have successfully created and opened the file. Ensure that the group
1725       and the mode are correct. */
1726
1727       if (exim_chown(filename, uid, gid) || Uchmod(filename, mode))
1728         {
1729         addr->basic_errno = errno;
1730         addr->message = string_sprintf("while setting perms on mailbox %s",
1731           filename);
1732         addr->transport_return = FAIL;
1733         goto RETURN;
1734         }
1735       }
1736
1737
1738     /* The file already exists. Test its type, ownership, and permissions, and
1739     save the inode for checking later. If symlinks are permitted (not the
1740     default or recommended state) it may be a symlink that already exists.
1741     Check its ownership and then look for the file at the end of the link(s).
1742     This at least prevents one user creating a symlink for another user in
1743     a sticky directory. */
1744
1745     else
1746       {
1747       int oldmode = (int)statbuf.st_mode;
1748       ino_t inode = statbuf.st_ino;
1749       BOOL islink = (oldmode & S_IFMT) == S_IFLNK;
1750
1751       isfifo = FALSE;        /* In case things are changing */
1752
1753       /* Check owner if required - the default. */
1754
1755       if (ob->check_owner && statbuf.st_uid != uid)
1756         {
1757         addr->basic_errno = ERRNO_BADUGID;
1758         addr->message = string_sprintf("mailbox %s%s has wrong uid "
1759           "(%ld != %ld)", filename,
1760           islink ? " (symlink)" : "",
1761           (long int)(statbuf.st_uid), (long int)uid);
1762         goto RETURN;
1763         }
1764
1765       /* Group is checked only if check_group is set. */
1766
1767       if (ob->check_group && statbuf.st_gid != gid)
1768         {
1769         addr->basic_errno = ERRNO_BADUGID;
1770         addr->message = string_sprintf("mailbox %s%s has wrong gid (%d != %d)",
1771           filename, islink ? " (symlink)" : "", statbuf.st_gid, gid);
1772         goto RETURN;
1773         }
1774
1775       /* Just in case this is a sticky-bit mail directory, we don't want
1776       users to be able to create hard links to other users' files. */
1777
1778       if (statbuf.st_nlink != 1)
1779         {
1780         addr->basic_errno = ERRNO_NOTREGULAR;
1781         addr->message = string_sprintf("mailbox %s%s has too many links (%d)",
1782           filename, islink ? " (symlink)" : "", statbuf.st_nlink);
1783         goto RETURN;
1784
1785         }
1786
1787       /* If symlinks are permitted (not recommended), the lstat() above will
1788       have found the symlink. Its ownership has just been checked; go round
1789       the loop again, using stat() instead of lstat(). That will never yield a
1790       mode of S_IFLNK. */
1791
1792       if (islink && ob->allow_symlink)
1793         {
1794         use_lstat = FALSE;
1795         i--;                   /* Don't count this time round */
1796         continue;
1797         }
1798
1799       /* An actual file exists. Check that it is a regular file, or FIFO
1800       if permitted. */
1801
1802       if (ob->allow_fifo && (oldmode & S_IFMT) == S_IFIFO) isfifo = TRUE;
1803
1804       else if ((oldmode & S_IFMT) != S_IFREG)
1805         {
1806         addr->basic_errno = ERRNO_NOTREGULAR;
1807         addr->message = string_sprintf("mailbox %s is not a regular file%s",
1808           filename, ob->allow_fifo ? " or named pipe" : "");
1809         goto RETURN;
1810         }
1811
1812       /* If the mode is not what it would be for a newly created file, change
1813       the permissions if the mode is supplied for the address. Otherwise,
1814       reduce but do not extend the permissions. If the newly created
1815       permissions are greater than the existing permissions, don't change
1816       things when the mode is not from the address. */
1817
1818       if ((oldmode &= 07777) != mode)
1819         {
1820         int diffs = oldmode ^ mode;
1821         if (addr->mode > 0 || (diffs & oldmode) == diffs)
1822           {
1823           DEBUG(D_transport) debug_printf("chmod %o %s\n", mode, filename);
1824           if (Uchmod(filename, mode) < 0)
1825             {
1826             addr->basic_errno = errno;
1827             addr->message = string_sprintf("attempting to chmod mailbox %s",
1828               filename);
1829             goto RETURN;
1830             }
1831           oldmode = mode;
1832           }
1833
1834         /* Mode not from address, and newly-created permissions are greater
1835         than existing permissions. Default is to complain, but it can be
1836         configured to go ahead and try to deliver anyway if that's what
1837         the administration wants. */
1838
1839         else if (ob->mode_fail_narrower)
1840           {
1841           addr->basic_errno = ERRNO_BADMODE;
1842           addr->message = string_sprintf("mailbox %s has the wrong mode %o "
1843             "(%o expected)", filename, oldmode, mode);
1844           goto RETURN;
1845           }
1846         }
1847
1848       /* We are happy with the existing file. Open it, and then do further
1849       tests to ensure that it is the same file that we were just looking at.
1850       If the file does not now exist, restart this loop, going back to using
1851       lstat again. For an NFS error, just defer; other opening errors are
1852       more serious. The file is opened RDWR so that its format can be checked,
1853       and also MBX locking requires the use of a shared (read) lock. However,
1854       a FIFO is opened WRONLY + NDELAY so that it fails if there is no process
1855       reading the pipe. */
1856
1857       fd = Uopen(filename, isfifo ? (O_WRONLY|O_NDELAY) : (O_RDWR|O_APPEND),
1858         mode);
1859       if (fd < 0)
1860         {
1861         if (errno == ENOENT)
1862           {
1863           use_lstat = TRUE;
1864           continue;
1865           }
1866         addr->basic_errno = errno;
1867         if (isfifo)
1868           addr->message = string_sprintf("while opening named pipe %s "
1869             "(could mean no process is reading it)", filename);
1870         else if (errno != EWOULDBLOCK)
1871           addr->message = string_sprintf("while opening mailbox %s", filename);
1872         goto RETURN;
1873         }
1874
1875       /* This fstat really shouldn't fail, as we have an open file! There's a
1876       dilemma here. We use fstat in order to be sure we are peering at the file
1877       we have got open. However, that won't tell us if the file was reached
1878       via a symbolic link. We checked this above, but there is a race exposure
1879       if the link was created between the previous lstat and the open. However,
1880       it would have to be created with the same inode in order to pass the
1881       check below. If ob->allow_symlink is set, causing the use of stat rather
1882       than lstat above, symbolic links may be there anyway, and the checking is
1883       weaker. */
1884
1885       if (fstat(fd, &statbuf) < 0)
1886         {
1887         addr->basic_errno = errno;
1888         addr->message = string_sprintf("attempting to stat open mailbox %s",
1889           filename);
1890         goto RETURN;
1891         }
1892
1893       /* Check the inode; this is isn't a perfect check, but gives some
1894       confidence. */
1895
1896       if (inode != statbuf.st_ino)
1897         {
1898         addr->basic_errno = ERRNO_INODECHANGED;
1899         addr->message = string_sprintf("opened mailbox %s inode number changed "
1900           "from " INO_T_FMT " to " INO_T_FMT, filename, inode, statbuf.st_ino);
1901         addr->special_action = SPECIAL_FREEZE;
1902         goto RETURN;
1903         }
1904
1905       /* Check it's still a regular file or FIFO, and the uid, gid, and
1906       permissions have not changed. */
1907
1908       if ((!isfifo && (statbuf.st_mode & S_IFMT) != S_IFREG) ||
1909           (isfifo && (statbuf.st_mode & S_IFMT) != S_IFIFO))
1910         {
1911         addr->basic_errno = ERRNO_NOTREGULAR;
1912         addr->message =
1913           string_sprintf("opened mailbox %s is no longer a %s", filename,
1914             isfifo ? "named pipe" : "regular file");
1915         addr->special_action = SPECIAL_FREEZE;
1916         goto RETURN;
1917         }
1918
1919       if ((ob->check_owner && statbuf.st_uid != uid) ||
1920           (ob->check_group && statbuf.st_gid != gid))
1921         {
1922         addr->basic_errno = ERRNO_BADUGID;
1923         addr->message =
1924           string_sprintf("opened mailbox %s has wrong uid or gid", filename);
1925         addr->special_action = SPECIAL_FREEZE;
1926         goto RETURN;
1927         }
1928
1929       if ((statbuf.st_mode & 07777) != oldmode)
1930         {
1931         addr->basic_errno = ERRNO_BADMODE;
1932         addr->message = string_sprintf("opened mailbox %s has wrong mode %o "
1933           "(%o expected)", filename, statbuf.st_mode & 07777, mode);
1934         addr->special_action = SPECIAL_FREEZE;
1935         goto RETURN;
1936         }
1937
1938       /* If file_format is set, check that the format of the file has not
1939       changed. Error data is set by the testing function. */
1940
1941       if (ob->file_format  &&  check_file_format(fd, tblock, addr) != tblock)
1942         {
1943         addr->message = US"open mailbox has changed format";
1944         goto RETURN;
1945         }
1946
1947       /* The file is OK. Carry on to do the locking. */
1948       }
1949
1950     /* We now have an open file, and must lock it using fcntl(), flock() or MBX
1951     locking rules if configured to do so. If a lock file is also required, it
1952     was created above and hd was left >= 0. At least one form of locking is
1953     required by the initialization function. If locking fails here, close the
1954     file and go round the loop all over again, after waiting for a bit, unless
1955     blocking locking was used. */
1956
1957     file_opened = TRUE;
1958     if ((ob->lock_fcntl_timeout > 0) || (ob->lock_flock_timeout > 0))
1959       sleep_before_retry = FALSE;
1960
1961     /* Simple fcntl() and/or flock() locking */
1962
1963     if (!ob->use_mbx_lock && (ob->use_fcntl || ob->use_flock))
1964       {
1965       if (apply_lock(fd, F_WRLCK, ob->use_fcntl, ob->lock_fcntl_timeout,
1966          ob->use_flock, ob->lock_flock_timeout) >= 0) break;
1967       }
1968
1969     /* MBX locking rules */
1970
1971     #ifdef SUPPORT_MBX
1972     else if (ob->use_mbx_lock)
1973       {
1974       int mbx_tmp_oflags;
1975       struct stat lstatbuf, statbuf2;
1976       if (apply_lock(fd, F_RDLCK, ob->use_fcntl, ob->lock_fcntl_timeout,
1977            ob->use_flock, ob->lock_flock_timeout) >= 0 &&
1978            fstat(fd, &statbuf) >= 0)
1979         {
1980         sprintf(CS mbx_lockname, "/tmp/.%lx.%lx", (long)statbuf.st_dev,
1981           (long)statbuf.st_ino);
1982
1983         /*
1984          * 2010-05-29: SECURITY
1985          * Dan Rosenberg reported the presence of a race-condition in the
1986          * original code here.  Beware that many systems still allow symlinks
1987          * to be followed in /tmp so an attacker can create a symlink pointing
1988          * elsewhere between a stat and an open, which we should avoid
1989          * following.
1990          *
1991          * It's unfortunate that we can't just use all the heavily debugged
1992          * locking from above.
1993          *
1994          * Also: remember to mirror changes into exim_lock.c */
1995
1996         /* first leave the old pre-check in place, it provides better
1997          * diagnostics for common cases */
1998         if (Ulstat(mbx_lockname, &statbuf) >= 0)
1999           {
2000           if ((statbuf.st_mode & S_IFMT) == S_IFLNK)
2001             {
2002             addr->basic_errno = ERRNO_LOCKFAILED;
2003             addr->message = string_sprintf("symbolic link on MBX lock file %s",
2004               mbx_lockname);
2005             goto RETURN;
2006             }
2007           if (statbuf.st_nlink > 1)
2008             {
2009             addr->basic_errno = ERRNO_LOCKFAILED;
2010             addr->message = string_sprintf("hard link to MBX lock file %s",
2011               mbx_lockname);
2012             goto RETURN;
2013             }
2014           }
2015
2016         /* If we could just declare "we must be the ones who create this
2017          * file" then a hitching post in a subdir would work, since a
2018          * subdir directly in /tmp/ which we create wouldn't follow links
2019          * but this isn't our locking logic, so we can't safely change the
2020          * file existence rules. */
2021
2022         /* On systems which support O_NOFOLLOW, it's the easiest and most
2023          * obviously correct security fix */
2024         mbx_tmp_oflags = O_RDWR | O_CREAT;
2025 #ifdef O_NOFOLLOW
2026         mbx_tmp_oflags |= O_NOFOLLOW;
2027 #endif
2028         mbx_lockfd = Uopen(mbx_lockname, mbx_tmp_oflags, ob->lockfile_mode);
2029         if (mbx_lockfd < 0)
2030           {
2031           addr->basic_errno = ERRNO_LOCKFAILED;
2032           addr->message = string_sprintf("failed to open MBX lock file %s :%s",
2033             mbx_lockname, strerror(errno));
2034           goto RETURN;
2035           }
2036
2037         if (Ulstat(mbx_lockname, &lstatbuf) < 0)
2038           {
2039           addr->basic_errno = ERRNO_LOCKFAILED;
2040           addr->message = string_sprintf("attempting to lstat open MBX "
2041              "lock file %s: %s", mbx_lockname, strerror(errno));
2042           goto RETURN;
2043           }
2044         if (fstat(mbx_lockfd, &statbuf2) < 0)
2045           {
2046           addr->basic_errno = ERRNO_LOCKFAILED;
2047           addr->message = string_sprintf("attempting to stat fd of open MBX "
2048               "lock file %s: %s", mbx_lockname, strerror(errno));
2049           goto RETURN;
2050           }
2051
2052         /*
2053          * At this point:
2054          *  statbuf: if exists, is file which existed prior to opening the
2055          *           lockfile, might have been replaced since then
2056          *  statbuf2: result of stat'ing the open fd, is what was actually
2057          *            opened
2058          *  lstatbuf: result of lstat'ing the filename immediately after
2059          *            the open but there's a race condition again between
2060          *            those two steps: before open, symlink to foo, after
2061          *            open but before lstat have one of:
2062          *             * was no symlink, so is the opened file
2063          *               (we created it, no messing possible after that point)
2064          *             * hardlink to foo
2065          *             * symlink elsewhere
2066          *             * hardlink elsewhere
2067          *             * new file/other
2068          * Don't want to compare to device of /tmp because some modern systems
2069          * have regressed to having /tmp be the safe actual filesystem as
2070          * valuable data, so is mostly worthless, unless we assume that *only*
2071          * Linux systems do this and that all Linux has O_NOFOLLOW.  Something
2072          * for further consideration.
2073          * No point in doing a readlink on the lockfile as that will always be
2074          * at a different point in time from when we open it, so tells us
2075          * nothing; attempts to clean up and delete after ourselves would risk
2076          * deleting a *third* filename.
2077          */
2078         if ((statbuf2.st_nlink > 1) ||
2079             (lstatbuf.st_nlink > 1) ||
2080             (!S_ISREG(lstatbuf.st_mode)) ||
2081             (lstatbuf.st_dev != statbuf2.st_dev) ||
2082             (lstatbuf.st_ino != statbuf2.st_ino))
2083           {
2084           addr->basic_errno = ERRNO_LOCKFAILED;
2085           addr->message = string_sprintf("RACE CONDITION detected: "
2086               "mismatch post-initial-checks between \"%s\" and opened "
2087               "fd lead us to abort!", mbx_lockname);
2088           goto RETURN;
2089           }
2090
2091         (void)Uchmod(mbx_lockname, ob->lockfile_mode);
2092
2093         if (apply_lock(mbx_lockfd, F_WRLCK, ob->use_fcntl,
2094             ob->lock_fcntl_timeout, ob->use_flock, ob->lock_flock_timeout) >= 0)
2095           {
2096           struct stat ostatbuf;
2097
2098           /* This tests for a specific race condition. Ensure that we still
2099           have the same file. */
2100
2101           if (Ulstat(mbx_lockname, &statbuf) == 0 &&
2102               fstat(mbx_lockfd, &ostatbuf) == 0 &&
2103               statbuf.st_dev == ostatbuf.st_dev &&
2104               statbuf.st_ino == ostatbuf.st_ino)
2105             break;
2106           DEBUG(D_transport) debug_printf("MBX lockfile %s changed "
2107             "between creation and locking\n", mbx_lockname);
2108           }
2109
2110         DEBUG(D_transport) debug_printf("failed to lock %s: %s\n", mbx_lockname,
2111           strerror(errno));
2112         (void)close(mbx_lockfd);
2113         mbx_lockfd = -1;
2114         }
2115       else
2116         {
2117         DEBUG(D_transport) debug_printf("failed to fstat or get read lock on %s: %s\n",
2118           filename, strerror(errno));
2119         }
2120       }
2121     #endif  /* SUPPORT_MBX */
2122
2123     else break;   /* No on-file locking required; break the open/lock loop */
2124
2125     DEBUG(D_transport)
2126       debug_printf("fcntl(), flock(), or MBX locking failed - retrying\n");
2127
2128     (void)close(fd);
2129     fd = -1;
2130     use_lstat = TRUE;             /* Reset to use lstat first */
2131
2132
2133     /* If a blocking call timed out, break the retry loop if the total time
2134     so far is not less than than retries * interval. Use the larger of the
2135     flock() and fcntl() timeouts. */
2136
2137     if (sigalrm_seen &&
2138         (i+1) * ((ob->lock_fcntl_timeout > ob->lock_flock_timeout)?
2139           ob->lock_fcntl_timeout : ob->lock_flock_timeout) >=
2140           ob->lock_retries * ob->lock_interval)
2141       i = ob->lock_retries;
2142
2143     /* Wait a bit before retrying, except when it was a blocked fcntl() or
2144     flock() that caused the problem. */
2145
2146     if (i < ob->lock_retries && sleep_before_retry) sleep(ob->lock_interval);
2147     }
2148
2149   /* Test for exceeding the maximum number of tries. Either the file remains
2150   locked, or, if we haven't got it open, something is terribly wrong... */
2151
2152   if (i >= ob->lock_retries)
2153     {
2154     if (!file_opened)
2155       {
2156       addr->basic_errno = ERRNO_EXISTRACE;
2157       addr->message = string_sprintf("mailbox %s: existence unclear", filename);
2158       addr->special_action = SPECIAL_FREEZE;
2159       }
2160     else
2161       {
2162       addr->basic_errno = ERRNO_LOCKFAILED;
2163       addr->message = string_sprintf("failed to lock mailbox %s (fcntl/flock)",
2164         filename);
2165       }
2166     goto RETURN;
2167     }
2168
2169   DEBUG(D_transport) debug_printf("mailbox %s is locked\n", filename);
2170
2171   /* Save access time (for subsequent restoration), modification time (for
2172   restoration if updating fails), size of file (for comsat and for re-setting if
2173   delivery fails in the middle - e.g. for quota exceeded). */
2174
2175   if (fstat(fd, &statbuf) < 0)
2176     {
2177     addr->basic_errno = errno;
2178     addr->message = string_sprintf("while fstatting opened mailbox %s",
2179       filename);
2180     goto RETURN;
2181     }
2182
2183   times.actime = statbuf.st_atime;
2184   times.modtime = statbuf.st_mtime;
2185   saved_size = statbuf.st_size;
2186   if (mailbox_size < 0) mailbox_size = saved_size;
2187   mailbox_filecount = 0;  /* Not actually relevant for single-file mailbox */
2188   }
2189
2190 /* Prepare for writing to a new file (as opposed to appending to an old one).
2191 There are several different formats, but there is preliminary stuff concerned
2192 with quotas that applies to all of them. Finding the current size by directory
2193 scanning is expensive; for maildirs some fudges have been invented:
2194
2195   (1) A regex can be used to extract a file size from its name;
2196   (2) If maildir_use_size is set, a maildirsize file is used to cache the
2197       mailbox size.
2198 */
2199
2200 else
2201   {
2202   uschar *check_path = path;    /* Default quota check path */
2203   const pcre *regex = NULL;     /* Regex for file size from file name */
2204
2205   if (!check_creation(string_sprintf("%s/any", path), ob->create_file))
2206     {
2207     addr->basic_errno = ERRNO_BADCREATE;
2208     addr->message = string_sprintf("tried to create file in %s, but "
2209       "file creation outside the home directory is not permitted", path);
2210     goto RETURN;
2211     }
2212
2213   #ifdef SUPPORT_MAILDIR
2214   /* For a maildir delivery, ensure that all the relevant directories exist,
2215   and a maildirfolder file if necessary. */
2216
2217   if (mbformat == mbf_maildir && !maildir_ensure_directories(path, addr,
2218     ob->create_directory, ob->dirmode, ob->maildirfolder_create_regex))
2219       return FALSE;
2220   #endif  /* SUPPORT_MAILDIR */
2221
2222   /* If we are going to do a quota check, of if maildir_use_size_file is set
2223   for a maildir delivery, compile the regular expression if there is one. We
2224   may also need to adjust the path that is used. We need to do this for
2225   maildir_use_size_file even if the quota is unset, because we still want to
2226   create the file. When maildir support is not compiled,
2227   ob->maildir_use_size_file is always FALSE. */
2228
2229   if (ob->quota_value > 0 || THRESHOLD_CHECK || ob->maildir_use_size_file)
2230     {
2231     const uschar *error;
2232     int offset;
2233
2234     /* Compile the regex if there is one. */
2235
2236     if (ob->quota_size_regex)
2237       {
2238       if (!(regex = pcre_compile(CS ob->quota_size_regex, PCRE_COPT,
2239           CCSS &error, &offset, NULL)))
2240         {
2241         addr->message = string_sprintf("appendfile: regular expression "
2242           "error: %s at offset %d while compiling %s", error, offset,
2243           ob->quota_size_regex);
2244         return FALSE;
2245         }
2246       DEBUG(D_transport) debug_printf("using regex for file sizes: %s\n",
2247         ob->quota_size_regex);
2248       }
2249
2250     /* Use an explicitly configured directory if set */
2251
2252     if (ob->quota_directory)
2253       {
2254       if (!(check_path = expand_string(ob->quota_directory)))
2255         {
2256         addr->message = string_sprintf("Expansion of \"%s\" (quota_directory "
2257          "name for %s transport) failed: %s", ob->quota_directory,
2258           tblock->name, expand_string_message);
2259         goto ret_panic;
2260         }
2261
2262       if (check_path[0] != '/')
2263         {
2264         addr->message = string_sprintf("appendfile: quota_directory name "
2265           "\"%s\" is not absolute", check_path);
2266         addr->basic_errno = ERRNO_NOTABSOLUTE;
2267         return FALSE;
2268         }
2269       }
2270
2271     #ifdef SUPPORT_MAILDIR
2272     /* Otherwise, if we are handling a maildir delivery, and the directory
2273     contains a file called maildirfolder, this is a maildir++ feature telling
2274     us that this is a sub-directory of the real inbox. We should therefore do
2275     the quota check on the parent directory. Beware of the special case when
2276     the directory name itself ends in a slash. */
2277
2278     else if (mbformat == mbf_maildir)
2279       {
2280       struct stat statbuf;
2281       if (Ustat(string_sprintf("%s/maildirfolder", path), &statbuf) >= 0)
2282         {
2283         uschar *new_check_path = string_copy(check_path);
2284         uschar *slash = Ustrrchr(new_check_path, '/');
2285         if (slash)
2286           {
2287           if (!slash[1])
2288             {
2289             *slash = 0;
2290             slash = Ustrrchr(new_check_path, '/');
2291             }
2292           if (slash)
2293             {
2294             *slash = 0;
2295             check_path = new_check_path;
2296             DEBUG(D_transport) debug_printf("maildirfolder file exists: "
2297               "quota check directory changed to %s\n", check_path);
2298             }
2299           }
2300         }
2301       }
2302     #endif  /* SUPPORT_MAILDIR */
2303     }
2304
2305   /* If we are using maildirsize files, we need to ensure that such a file
2306   exists and, if necessary, recalculate its contents. As a byproduct of this,
2307   we obtain the current size of the maildir. If no quota is to be enforced
2308   (ob->quota_value == 0), we still need the size if a threshold check will
2309   happen later.
2310
2311   Another regular expression is used to determine which directories inside the
2312   maildir are going to be counted. */
2313
2314   #ifdef SUPPORT_MAILDIR
2315   if (ob->maildir_use_size_file)
2316     {
2317     const pcre *dir_regex = NULL;
2318     const uschar *error;
2319     int offset;
2320
2321     if (ob->maildir_dir_regex)
2322       {
2323       int check_path_len = Ustrlen(check_path);
2324
2325       if (!(dir_regex = pcre_compile(CS ob->maildir_dir_regex, PCRE_COPT,
2326           CCSS &error, &offset, NULL)))
2327         {
2328         addr->message = string_sprintf("appendfile: regular expression "
2329           "error: %s at offset %d while compiling %s", error, offset,
2330           ob->maildir_dir_regex);
2331         return FALSE;
2332         }
2333
2334       DEBUG(D_transport)
2335         debug_printf("using regex for maildir directory selection: %s\n",
2336           ob->maildir_dir_regex);
2337
2338       /* Check to see if we are delivering into an ignored directory, that is,
2339       if the delivery path starts with the quota check path, and the rest
2340       of the deliver path matches the regex; if so, set a flag to disable quota
2341       checking and maildirsize updating. */
2342
2343       if (Ustrncmp(path, check_path, check_path_len) == 0)
2344         {
2345         uschar *s = path + check_path_len;
2346         while (*s == '/') s++;
2347         s = *s ? string_sprintf("%s/new", s) : US"new";
2348         if (pcre_exec(dir_regex, NULL, CS s, Ustrlen(s), 0, 0, NULL, 0) < 0)
2349           {
2350           disable_quota = TRUE;
2351           DEBUG(D_transport) debug_printf("delivery directory does not match "
2352             "maildir_quota_directory_regex: disabling quota\n");
2353           }
2354         }
2355       }
2356
2357     /* Quota enforcement; create and check the file. There is some discussion
2358     about whether this should happen if the quota is unset. At present, Exim
2359     always creates the file. If we ever want to change this, uncomment
2360     appropriate lines below, possibly doing a check on some option. */
2361
2362 /*  if (???? || ob->quota_value > 0) */
2363
2364     if (!disable_quota)
2365       {
2366       off_t size;
2367       int filecount;
2368
2369       if ((maildirsize_fd = maildir_ensure_sizefile(check_path, ob, regex, dir_regex,
2370           &size, &filecount)) == -1)
2371         {
2372         addr->basic_errno = errno;
2373         addr->message = string_sprintf("while opening or reading "
2374           "%s/maildirsize", check_path);
2375         return FALSE;
2376         }
2377       /* can also return -2, which means that the file was removed because of
2378       raciness; but in this case, the size & filecount will still have been
2379       updated. */
2380
2381       if (mailbox_size < 0) mailbox_size = size;
2382       if (mailbox_filecount < 0) mailbox_filecount = filecount;
2383       }
2384
2385     /* No quota enforcement; ensure file does *not* exist; calculate size if
2386     needed. */
2387
2388 /*  else
2389  *    {
2390  *    time_t old_latest;
2391  *    (void)unlink(CS string_sprintf("%s/maildirsize", check_path));
2392  *    if (THRESHOLD_CHECK)
2393  *      mailbox_size = maildir_compute_size(check_path, &mailbox_filecount, &old_latest,
2394  *        regex, dir_regex, FALSE);
2395  *    }
2396 */
2397
2398     }
2399   #endif  /* SUPPORT_MAILDIR */
2400
2401   /* Otherwise if we are going to do a quota check later on, and the mailbox
2402   size is not set, find the current size of the mailbox. Ditto for the file
2403   count. Note that ob->quota_filecount_value cannot be set without
2404   ob->quota_value being set. */
2405
2406   if (  !disable_quota
2407      && (ob->quota_value > 0 || THRESHOLD_CHECK)
2408      && (  mailbox_size < 0
2409         || mailbox_filecount < 0 && ob->quota_filecount_value > 0
2410     )   )
2411     {
2412     off_t size;
2413     int filecount = 0;
2414     DEBUG(D_transport)
2415       debug_printf("quota checks on directory %s\n", check_path);
2416     size = check_dir_size(check_path, &filecount, regex);
2417     if (mailbox_size < 0) mailbox_size = size;
2418     if (mailbox_filecount < 0) mailbox_filecount = filecount;
2419     }
2420
2421   /* Handle the case of creating a unique file in a given directory (not in
2422   maildir or mailstore format - this is how smail did it). A temporary name is
2423   used to create the file. Later, when it is written, the name is changed to a
2424   unique one. There is no need to lock the file. An attempt is made to create
2425   the directory if it does not exist. */
2426
2427   if (mbformat == mbf_smail)
2428     {
2429     DEBUG(D_transport)
2430       debug_printf("delivering to new file in %s\n", path);
2431     filename = dataname =
2432       string_sprintf("%s/temp.%d.%s", path, (int)getpid(), primary_hostname);
2433     fd = Uopen(filename, O_WRONLY|O_CREAT, mode);
2434     if (fd < 0 &&                                 /* failed to open, and */
2435         (errno != ENOENT ||                       /* either not non-exist */
2436          !ob->create_directory ||                 /* or not allowed to make */
2437          !directory_make(NULL, path, ob->dirmode, FALSE) ||  /* or failed to create dir */
2438          (fd = Uopen(filename, O_WRONLY|O_CREAT|O_EXCL, mode)) < 0)) /* or then failed to open */
2439       {
2440       addr->basic_errno = errno;
2441       addr->message = string_sprintf("while creating file %s", filename);
2442       return FALSE;
2443       }
2444     }
2445
2446   #ifdef SUPPORT_MAILDIR
2447
2448   /* Handle the case of a unique file in maildir format. The file is written to
2449   the tmp subdirectory, with a prescribed form of name. */
2450
2451   else if (mbformat == mbf_maildir)
2452     {
2453     DEBUG(D_transport)
2454       debug_printf("delivering in maildir format in %s\n", path);
2455
2456     nametag = ob->maildir_tag;
2457
2458     /* Check that nametag expands successfully; a hard failure causes a panic
2459     return. The actual expansion for use happens again later, when
2460     $message_size is accurately known. */
2461
2462     if (nametag && !expand_string(nametag) && !f.expand_string_forcedfail)
2463       {
2464       addr->message = string_sprintf("Expansion of \"%s\" (maildir_tag "
2465         "for %s transport) failed: %s", nametag, tblock->name,
2466         expand_string_message);
2467       goto ret_panic;
2468       }
2469
2470     /* We ensured the existence of all the relevant directories above. Attempt
2471     to open the temporary file a limited number of times. I think this rather
2472     scary-looking for statement is actually OK. If open succeeds, the loop is
2473     broken; if not, there is a test on the value of i. Get the time again
2474     afresh each time round the loop. Its value goes into a variable that is
2475     checked at the end, to make sure we don't release this process until the
2476     clock has ticked. */
2477
2478     for (int i = 1;; i++)
2479       {
2480       uschar *basename;
2481
2482       (void)gettimeofday(&msg_tv, NULL);
2483       basename = string_sprintf(TIME_T_FMT ".M%luP" PID_T_FMT ".%s",
2484         msg_tv.tv_sec, msg_tv.tv_usec, getpid(), primary_hostname);
2485
2486       filename = dataname = string_sprintf("tmp/%s", basename);
2487       newname = string_sprintf("new/%s", basename);
2488
2489       if (Ustat(filename, &statbuf) == 0)
2490         errno = EEXIST;
2491       else if (errno == ENOENT)
2492         {
2493         if ((fd = Uopen(filename, O_WRONLY | O_CREAT | O_EXCL, mode)) >= 0)
2494           break;
2495         DEBUG (D_transport) debug_printf ("open failed for %s: %s\n",
2496           filename, strerror(errno));
2497         }
2498
2499       /* Too many retries - give up */
2500
2501       if (i >= ob->maildir_retries)
2502         {
2503         addr->message = string_sprintf ("failed to open %s (%d tr%s)",
2504           filename, i, (i == 1) ? "y" : "ies");
2505         addr->basic_errno = errno;
2506         if (errno == errno_quota || errno == ENOSPC)
2507           addr->user_message = US"mailbox is full";
2508         return FALSE;
2509         }
2510
2511       /* Open or stat failed but we haven't tried too many times yet. */
2512
2513       sleep(2);
2514       }
2515
2516     /* Note that we have to ensure the clock has ticked before leaving */
2517
2518     wait_for_tick = TRUE;
2519
2520     /* Why are these here? Put in because they are present in the non-maildir
2521     directory case above. */
2522
2523     if (exim_chown(filename, uid, gid) || Uchmod(filename, mode))
2524       {
2525       addr->basic_errno = errno;
2526       addr->message = string_sprintf("while setting perms on maildir %s",
2527         filename);
2528       return FALSE;
2529       }
2530     }
2531
2532   #endif  /* SUPPORT_MAILDIR */
2533
2534   #ifdef SUPPORT_MAILSTORE
2535
2536   /* Handle the case of a unique file in mailstore format. First write the
2537   envelope to a temporary file, then open the main file. The unique base name
2538   for the files consists of the message id plus the pid of this delivery
2539   process. */
2540
2541   else
2542     {
2543     FILE *env_file;
2544     mailstore_basename = string_sprintf("%s/%s-%s", path, message_id,
2545       string_base62((long int)getpid()));
2546
2547     DEBUG(D_transport)
2548       debug_printf("delivering in mailstore format in %s\n", path);
2549
2550     filename = string_sprintf("%s.tmp", mailstore_basename);
2551     newname  = string_sprintf("%s.env", mailstore_basename);
2552     dataname = string_sprintf("%s.msg", mailstore_basename);
2553
2554     fd = Uopen(filename, O_WRONLY|O_CREAT|O_EXCL, mode);
2555     if (  fd < 0                                /* failed to open, and */
2556        && (   errno != ENOENT                   /* either not non-exist */
2557           || !ob->create_directory              /* or not allowed to make */
2558           || !directory_make(NULL, path, ob->dirmode, FALSE)  /* or failed to create dir */
2559           || (fd = Uopen(filename, O_WRONLY|O_CREAT|O_EXCL, mode)) < 0 /* or then failed to open */
2560        )  )
2561       {
2562       addr->basic_errno = errno;
2563       addr->message = string_sprintf("while creating file %s", filename);
2564       return FALSE;
2565       }
2566
2567     /* Why are these here? Put in because they are present in the non-maildir
2568     directory case above. */
2569
2570     if (exim_chown(filename, uid, gid) || Uchmod(filename, mode))
2571       {
2572       addr->basic_errno = errno;
2573       addr->message = string_sprintf("while setting perms on file %s",
2574         filename);
2575       return FALSE;
2576       }
2577
2578     /* Built a C stream from the open file descriptor. */
2579
2580     if (!(env_file = fdopen(fd, "wb")))
2581       {
2582       addr->basic_errno = errno;
2583       addr->message = string_sprintf("fdopen of %s ("
2584         "for %s transport) failed", filename, tblock->name);
2585       (void)close(fd);
2586       Uunlink(filename);
2587       goto ret_panic;
2588       }
2589
2590     /* Write the envelope file, then close it. */
2591
2592     if (ob->mailstore_prefix)
2593       {
2594       uschar *s = expand_string(ob->mailstore_prefix);
2595       if (!s)
2596         {
2597         if (!f.expand_string_forcedfail)
2598           {
2599           addr->message = string_sprintf("Expansion of \"%s\" (mailstore "
2600             "prefix for %s transport) failed: %s", ob->mailstore_prefix,
2601             tblock->name, expand_string_message);
2602           (void)fclose(env_file);
2603           Uunlink(filename);
2604           goto ret_panic;
2605           }
2606         }
2607       else
2608         {
2609         int n = Ustrlen(s);
2610         fprintf(env_file, "%s", CS s);
2611         if (n == 0 || s[n-1] != '\n') fprintf(env_file, "\n");
2612         }
2613       }
2614
2615     fprintf(env_file, "%s\n", sender_address);
2616
2617     for (address_item * taddr = addr; taddr; taddr = taddr->next)
2618       fprintf(env_file, "%s@%s\n", taddr->local_part, taddr->domain);
2619
2620     if (ob->mailstore_suffix)
2621       {
2622       uschar *s = expand_string(ob->mailstore_suffix);
2623       if (!s)
2624         {
2625         if (!f.expand_string_forcedfail)
2626           {
2627           addr->message = string_sprintf("Expansion of \"%s\" (mailstore "
2628             "suffix for %s transport) failed: %s", ob->mailstore_suffix,
2629             tblock->name, expand_string_message);
2630           (void)fclose(env_file);
2631           Uunlink(filename);
2632           goto ret_panic;
2633           }
2634         }
2635       else
2636         {
2637         int n = Ustrlen(s);
2638         fprintf(env_file, "%s", CS s);
2639         if (n == 0 || s[n-1] != '\n') fprintf(env_file, "\n");
2640         }
2641       }
2642
2643     if (fclose(env_file) != 0)
2644       {
2645       addr->basic_errno = errno;
2646       addr->message = string_sprintf("while closing %s", filename);
2647       Uunlink(filename);
2648       return FALSE;
2649       }
2650
2651     DEBUG(D_transport) debug_printf("Envelope file %s written\n", filename);
2652
2653     /* Now open the data file, and ensure that it has the correct ownership and
2654     mode. */
2655
2656     if ((fd = Uopen(dataname, O_WRONLY|O_CREAT|O_EXCL, mode)) < 0)
2657       {
2658       addr->basic_errno = errno;
2659       addr->message = string_sprintf("while creating file %s", dataname);
2660       Uunlink(filename);
2661       return FALSE;
2662       }
2663     if (exim_chown(dataname, uid, gid) || Uchmod(dataname, mode))
2664       {
2665       addr->basic_errno = errno;
2666       addr->message = string_sprintf("while setting perms on file %s",
2667         dataname);
2668       return FALSE;
2669       }
2670     }
2671
2672   #endif  /* SUPPORT_MAILSTORE */
2673
2674
2675   /* In all cases of writing to a new file, ensure that the file which is
2676   going to be renamed has the correct ownership and mode. */
2677
2678   if (exim_chown(filename, uid, gid) || Uchmod(filename, mode))
2679     {
2680     addr->basic_errno = errno;
2681     addr->message = string_sprintf("while setting perms on file %s",
2682       filename);
2683     return FALSE;
2684     }
2685   }
2686
2687
2688 /* At last we can write the message to the file, preceded by any configured
2689 prefix line, and followed by any configured suffix line. If there are any
2690 writing errors, we must defer. */
2691
2692 DEBUG(D_transport) debug_printf("writing to file %s\n", dataname);
2693
2694 yield = OK;
2695 errno = 0;
2696
2697 /* If there is a local quota setting, check that we are not going to exceed it
2698 with this message if quota_is_inclusive is set; if it is not set, the check
2699 is for the mailbox already being over quota (i.e. the current message is not
2700 included in the check). */
2701
2702 if (!disable_quota && ob->quota_value > 0)
2703   {
2704   DEBUG(D_transport)
2705     {
2706     debug_printf("Exim quota = " OFF_T_FMT " old size = " OFF_T_FMT
2707       " this message = %d (%sincluded)\n",
2708       ob->quota_value, mailbox_size, message_size,
2709       ob->quota_is_inclusive ? "" : "not ");
2710     debug_printf("  file count quota = %d count = %d\n",
2711       ob->quota_filecount_value, mailbox_filecount);
2712     }
2713
2714   if (mailbox_size + (ob->quota_is_inclusive ? message_size:0) > ob->quota_value)
2715     if (!ob->quota_no_check)
2716       {
2717       DEBUG(D_transport) debug_printf("mailbox quota exceeded\n");
2718       yield = DEFER;
2719       errno = ERRNO_EXIMQUOTA;
2720       }
2721     else
2722       DEBUG(D_transport) debug_printf("mailbox quota exceeded but ignored\n");
2723
2724   if (ob->quota_filecount_value > 0
2725            && mailbox_filecount + (ob->quota_is_inclusive ? 1:0) >
2726               ob->quota_filecount_value)
2727     if (!ob->quota_filecount_no_check)
2728       {
2729       DEBUG(D_transport) debug_printf("mailbox file count quota exceeded\n");
2730       yield = DEFER;
2731       errno = ERRNO_EXIMQUOTA;
2732       filecount_msg = US" filecount";
2733       }
2734     else DEBUG(D_transport) if (ob->quota_filecount_no_check)
2735       debug_printf("mailbox file count quota exceeded but ignored\n");
2736
2737   }
2738
2739 if (verify_mode)
2740   {
2741   addr->basic_errno = errno;
2742   addr->message = US"Over quota";
2743   addr->transport_return = yield;
2744   DEBUG(D_transport)
2745     debug_printf("appendfile (verify) yields %d with errno=%d more_errno=%d\n",
2746       yield, addr->basic_errno, addr->more_errno);
2747
2748   goto RETURN;
2749   }
2750
2751 /* If we are writing in MBX format, what we actually do is to write the message
2752 to a temporary file, and then copy it to the real file once we know its size.
2753 This is the most straightforward way of getting the correct length in the
2754 separator line. So, what we do here is to save the real file descriptor, and
2755 replace it with one for a temporary file. The temporary file gets unlinked once
2756 opened, so that it goes away on closure. */
2757
2758 #ifdef SUPPORT_MBX
2759 if (yield == OK && ob->mbx_format)
2760   {
2761   if (!(temp_file = tmpfile()))
2762     {
2763     addr->basic_errno = errno;
2764     addr->message = US"while setting up temporary file";
2765     yield = DEFER;
2766     goto RETURN;
2767     }
2768   save_fd = fd;
2769   fd = fileno(temp_file);
2770   DEBUG(D_transport) debug_printf("writing to temporary file\n");
2771   }
2772 #endif  /* SUPPORT_MBX */
2773
2774 /* Zero the count of bytes written. It is incremented by the transport_xxx()
2775 functions. */
2776
2777 transport_count = 0;
2778 transport_newlines = 0;
2779
2780 /* Write any configured prefix text first */
2781
2782 if (yield == OK && ob->message_prefix && *ob->message_prefix)
2783   {
2784   uschar *prefix = expand_string(ob->message_prefix);
2785   if (!prefix)
2786     {
2787     errno = ERRNO_EXPANDFAIL;
2788     addr->transport_return = PANIC;
2789     addr->message = string_sprintf("Expansion of \"%s\" (prefix for %s "
2790       "transport) failed", ob->message_prefix, tblock->name);
2791     yield = DEFER;
2792     }
2793   else if (!transport_write_string(fd, "%s", prefix)) yield = DEFER;
2794   }
2795
2796 /* If the use_bsmtp option is on, we need to write SMTP prefix information. The
2797 various different values for batching are handled outside; if there is more
2798 than one address available here, all must be included. If any address is a
2799 file, use its parent in the RCPT TO. */
2800
2801 if (yield == OK && ob->use_bsmtp)
2802   {
2803   transport_count = 0;
2804   transport_newlines = 0;
2805   if (ob->use_crlf) cr = US"\r";
2806   if (!transport_write_string(fd, "MAIL FROM:<%s>%s\n", return_path, cr))
2807     yield = DEFER;
2808   else
2809     {
2810     transport_newlines++;
2811     for (address_item * a = addr; a; a = a->next)
2812       {
2813       address_item * b = testflag(a, af_pfr) ? a->parent : a;
2814       if (!transport_write_string(fd, "RCPT TO:<%s>%s\n",
2815         transport_rcpt_address(b, tblock->rcpt_include_affixes), cr))
2816           { yield = DEFER; break; }
2817       transport_newlines++;
2818       }
2819     if (yield == OK && !transport_write_string(fd, "DATA%s\n", cr))
2820       yield = DEFER;
2821     else
2822       transport_newlines++;
2823     }
2824   }
2825
2826 /* Now the message itself. The options for transport_write_message were set up
2827 at initialization time. */
2828
2829 if (yield == OK)
2830   {
2831   transport_ctx tctx = {
2832     .u = {.fd=fd},
2833     .tblock = tblock,
2834     .addr = addr,
2835     .check_string = ob->check_string,
2836     .escape_string = ob->escape_string,
2837     .options =  ob->options | topt_not_socket
2838   };
2839   if (!transport_write_message(&tctx, 0))
2840     yield = DEFER;
2841   }
2842
2843 /* Now a configured suffix. */
2844
2845 if (yield == OK && ob->message_suffix && *ob->message_suffix)
2846   {
2847   uschar *suffix = expand_string(ob->message_suffix);
2848   if (!suffix)
2849     {
2850     errno = ERRNO_EXPANDFAIL;
2851     addr->transport_return = PANIC;
2852     addr->message = string_sprintf("Expansion of \"%s\" (suffix for %s "
2853       "transport) failed", ob->message_suffix, tblock->name);
2854     yield = DEFER;
2855     }
2856   else if (!transport_write_string(fd, "%s", suffix)) yield = DEFER;
2857   }
2858
2859 /* If batch smtp, write the terminating dot. */
2860
2861 if (yield == OK && ob->use_bsmtp)
2862   if (!transport_write_string(fd, ".%s\n", cr)) yield = DEFER;
2863   else transport_newlines++;
2864
2865 /* If MBX format is being used, all that writing was to the temporary file.
2866 However, if there was an earlier failure (Exim quota exceeded, for example),
2867 the temporary file won't have got opened - and no writing will have been done.
2868 If writing was OK, we restore the fd, and call a function that copies the
2869 message in MBX format into the real file. Otherwise use the temporary name in
2870 any messages. */
2871
2872 #ifdef SUPPORT_MBX
2873 if (temp_file && ob->mbx_format)
2874   {
2875   int mbx_save_errno;
2876   fd = save_fd;
2877
2878   if (yield == OK)
2879     {
2880     transport_count = 0;   /* Reset transport count for actual write */
2881     /* No need to reset transport_newlines as we're just using a block copy
2882      * routine so the number won't be affected */
2883     yield = copy_mbx_message(fd, fileno(temp_file), saved_size);
2884     }
2885   else if (errno >= 0) dataname = US"temporary file";
2886
2887   /* Preserve errno while closing the temporary file. */
2888
2889   mbx_save_errno = errno;
2890   (void)fclose(temp_file);
2891   errno = mbx_save_errno;
2892   }
2893 #endif  /* SUPPORT_MBX */
2894
2895 /* Force out the remaining data to check for any errors; some OS don't allow
2896 fsync() to be called for a FIFO. */
2897
2898 if (yield == OK && !isfifo && EXIMfsync(fd) < 0) yield = DEFER;
2899
2900 /* Update message_size and message_linecount to the accurate count of bytes
2901 written, including added headers. Note; we subtract 1 from message_linecount as
2902 this variable doesn't count the new line between the header and the body of the
2903 message. */
2904
2905 message_size = transport_count;
2906 message_linecount = transport_newlines - 1;
2907
2908 /* If using a maildir++ quota file, add this message's size to it, and
2909 close the file descriptor, except when the quota has been disabled because we
2910 are delivering into an uncounted folder. */
2911
2912 #ifdef SUPPORT_MAILDIR
2913 if (!disable_quota)
2914   {
2915   if (yield == OK && maildirsize_fd >= 0)
2916     maildir_record_length(maildirsize_fd, message_size);
2917   maildir_save_errno = errno;    /* Preserve errno while closing the file */
2918   if (maildirsize_fd >= 0)
2919     (void)close(maildirsize_fd);
2920   errno = maildir_save_errno;
2921   }
2922 #endif  /* SUPPORT_MAILDIR */
2923
2924 /* If there is a quota warning threshold and we are have crossed it with this
2925 message, set the SPECIAL_WARN flag in the address, to cause a warning message
2926 to be sent. */
2927
2928 if (!disable_quota && THRESHOLD_CHECK)
2929   {
2930   off_t threshold = ob->quota_warn_threshold_value;
2931   if (ob->quota_warn_threshold_is_percent)
2932     threshold = (off_t)(((double)ob->quota_value * threshold) / 100);
2933   DEBUG(D_transport)
2934     debug_printf("quota = " OFF_T_FMT
2935       " threshold = " OFF_T_FMT
2936       " old size = " OFF_T_FMT
2937       " message size = %d\n",
2938       ob->quota_value, threshold, mailbox_size,
2939       message_size);
2940   if (mailbox_size <= threshold && mailbox_size + message_size > threshold)
2941     addr->special_action = SPECIAL_WARN;
2942
2943   /******* You might think that the test ought to be this:
2944   *
2945   * if (ob->quota_value > 0 && threshold > 0 && mailbox_size > 0 &&
2946   *     mailbox_size <= threshold && mailbox_size + message_size > threshold)
2947   *
2948   * (indeed, I was sent a patch with that in). However, it is possible to
2949   * have a warning threshold without actually imposing a quota, and I have
2950   * therefore kept Exim backwards compatible.
2951   ********/
2952
2953   }
2954
2955 /* Handle error while writing the file. Control should come here directly after
2956 the error, with the reason in errno. In the case of expansion failure in prefix
2957 or suffix, it will be ERRNO_EXPANDFAIL. */
2958
2959 if (yield != OK)
2960   {
2961   addr->special_action = SPECIAL_NONE;     /* Cancel any quota warning */
2962
2963   /* Save the error number. If positive, it will ultimately cause a strerror()
2964   call to generate some text. */
2965
2966   addr->basic_errno = errno;
2967
2968   /* For system or Exim quota excession, or disk full, set more_errno to the
2969   time since the file was last read. If delivery was into a directory, the
2970   time since last read logic is not relevant, in general. However, for maildir
2971   deliveries we can approximate it by looking at the last modified time of the
2972   "new" subdirectory. Since Exim won't be adding new messages, a change to the
2973   "new" subdirectory implies that an MUA has moved a message from there to the
2974   "cur" directory. */
2975
2976   if (errno == errno_quota || errno == ERRNO_EXIMQUOTA || errno == ENOSPC)
2977     {
2978     addr->more_errno = 0;
2979     if (!isdirectory) addr->more_errno = (int)(time(NULL) - times.actime);
2980
2981     #ifdef SUPPORT_MAILDIR
2982     else if (mbformat == mbf_maildir)
2983       {
2984       struct stat statbuf;
2985       if (Ustat("new", &statbuf) < 0)
2986         {
2987         DEBUG(D_transport) debug_printf("maildir quota exceeded: "
2988           "stat error %d for \"new\": %s\n", errno, strerror(errno));
2989         }
2990       else   /* Want a repeatable time when in test harness */
2991         addr->more_errno = f.running_in_test_harness ? 10 :
2992           (int)time(NULL) - statbuf.st_mtime;
2993
2994       DEBUG(D_transport)
2995         debug_printf("maildir: time since \"new\" directory modified = %s\n",
2996         readconf_printtime(addr->more_errno));
2997       }
2998     #endif /* SUPPORT_MAILDIR */
2999     }
3000
3001   /* Handle system quota excession. Add an explanatory phrase for the error
3002   message, since some systems don't have special quota-excession errors,
3003   and on those that do, "quota" doesn't always mean anything to the user. */
3004
3005   if (errno == errno_quota)
3006     {
3007     #ifndef EDQUOT
3008     addr->message = string_sprintf("mailbox is full "
3009       "(quota exceeded while writing to file %s)", filename);
3010     #else
3011     addr->message = US"mailbox is full";
3012     #endif  /* EDQUOT */
3013     addr->user_message = US"mailbox is full";
3014     DEBUG(D_transport) debug_printf("System quota exceeded for %s%s%s\n",
3015       dataname,
3016       isdirectory ? US"" : US": time since file read = ",
3017       isdirectory ? US"" : readconf_printtime(addr->more_errno));
3018     }
3019
3020   /* Handle Exim's own quota-imposition */
3021
3022   else if (errno == ERRNO_EXIMQUOTA)
3023     {
3024     addr->message = string_sprintf("mailbox is full "
3025       "(MTA-imposed%s quota exceeded while writing to %s)", filecount_msg,
3026         dataname);
3027     addr->user_message = US"mailbox is full";
3028     DEBUG(D_transport) debug_printf("Exim%s quota exceeded for %s%s%s\n",
3029       filecount_msg, dataname,
3030       isdirectory ? US"" : US": time since file read = ",
3031       isdirectory ? US"" : readconf_printtime(addr->more_errno));
3032     }
3033
3034   /* Handle a process failure while writing via a filter; the return
3035   from child_close() is in more_errno. */
3036
3037   else if (errno == ERRNO_FILTER_FAIL)
3038     {
3039     yield = PANIC;
3040     addr->message = string_sprintf("transport filter process failed (%d) "
3041       "while writing to %s%s", addr->more_errno, dataname,
3042       (addr->more_errno == EX_EXECFAILED) ? ": unable to execute command" : "");
3043     }
3044
3045   /* Handle failure to expand header changes */
3046
3047   else if (errno == ERRNO_CHHEADER_FAIL)
3048     {
3049     yield = PANIC;
3050     addr->message =
3051       string_sprintf("failed to expand headers_add or headers_remove while "
3052         "writing to %s: %s", dataname, expand_string_message);
3053     }
3054
3055   /* Handle failure to complete writing of a data block */
3056
3057   else if (errno == ERRNO_WRITEINCOMPLETE)
3058     addr->message = string_sprintf("failed to write data block while "
3059       "writing to %s", dataname);
3060
3061   /* Handle length mismatch on MBX copying */
3062
3063   #ifdef SUPPORT_MBX
3064   else if (errno == ERRNO_MBXLENGTH)
3065     addr->message = string_sprintf("length mismatch while copying MBX "
3066       "temporary file to %s", dataname);
3067   #endif  /* SUPPORT_MBX */
3068
3069   /* For other errors, a general-purpose explanation, if the message is
3070   not already set. */
3071
3072   else if (addr->message == NULL)
3073     addr->message = string_sprintf("error while writing to %s", dataname);
3074
3075   /* For a file, reset the file size to what it was before we started, leaving
3076   the last modification time unchanged, so it will get reset also. All systems
3077   investigated so far have ftruncate(), whereas not all have the F_FREESP
3078   fcntl() call (BSDI & FreeBSD do not). */
3079
3080   if (!isdirectory && ftruncate(fd, saved_size))
3081     DEBUG(D_transport) debug_printf("Error resetting file size\n");
3082   }
3083
3084 /* Handle successful writing - we want the modification time to be now for
3085 appended files. Remove the default backstop error number. For a directory, now
3086 is the time to rename the file with a unique name. As soon as such a name
3087 appears it may get used by another process, so we close the file first and
3088 check that all is well. */
3089
3090 else
3091   {
3092   times.modtime = time(NULL);
3093   addr->basic_errno = 0;
3094
3095   /* Handle the case of writing to a new file in a directory. This applies
3096   to all single-file formats - maildir, mailstore, and "smail format". */
3097
3098   if (isdirectory)
3099     {
3100     if (fstat(fd, &statbuf) < 0)
3101       {
3102       addr->basic_errno = errno;
3103       addr->message = string_sprintf("while fstatting opened message file %s",
3104         filename);
3105       yield = DEFER;
3106       }
3107
3108     else if (close(fd) < 0)
3109       {
3110       addr->basic_errno = errno;
3111       addr->message = string_sprintf("close() error for %s",
3112         (ob->mailstore_format) ? dataname : filename);
3113       yield = DEFER;
3114       }
3115
3116     /* File is successfully written and closed. Arrange to rename it. For the
3117     different kinds of single-file delivery, some games can be played with the
3118     name. The message size is by this time set to the accurate value so that
3119     its value can be used in expansions. */
3120
3121     else
3122       {
3123       uschar *renamename = newname;
3124       fd = -1;
3125
3126       DEBUG(D_transport) debug_printf("renaming temporary file\n");
3127
3128       /* If there is no rename name set, we are in a non-maildir, non-mailstore
3129       situation. The name is built by expanding the directory_file option, and
3130       we make the inode number available for use in this. The expansion was
3131       checked for syntactic validity above, before we wrote the file.
3132
3133       We have to be careful here, in case the file name exists. (In the other
3134       cases, the names used are constructed to be unique.) The rename()
3135       function just replaces an existing file - we don't want that! So instead
3136       of calling rename(), we must use link() and unlink().
3137
3138       In this case, if the link fails because of an existing file, we wait
3139       for one second and try the expansion again, to see if it produces a
3140       different value. Do this up to 5 times unless the name stops changing.
3141       This makes it possible to build values that are based on the time, and
3142       still cope with races from multiple simultaneous deliveries. */
3143
3144       if (!newname)
3145         {
3146         uschar *renameleaf;
3147         uschar *old_renameleaf = US"";
3148
3149         for (int i = 0; ; sleep(1), i++)
3150           {
3151           deliver_inode = statbuf.st_ino;
3152           renameleaf = expand_string(ob->dirfilename);
3153           deliver_inode = 0;
3154
3155           if (!renameleaf)
3156             {
3157             addr->transport_return = PANIC;
3158             addr->message = string_sprintf("Expansion of \"%s\" "
3159               "(directory_file for %s transport) failed: %s",
3160               ob->dirfilename, tblock->name, expand_string_message);
3161             goto RETURN;
3162             }
3163
3164           renamename = string_sprintf("%s/%s", path, renameleaf);
3165           if (Ulink(filename, renamename) < 0)
3166             {
3167             DEBUG(D_transport) debug_printf("link failed: %s\n",
3168               strerror(errno));
3169             if (errno != EEXIST || i >= 4 ||
3170                 Ustrcmp(renameleaf, old_renameleaf) == 0)
3171               {
3172               addr->basic_errno = errno;
3173               addr->message = string_sprintf("while renaming %s as %s",
3174                 filename, renamename);
3175               yield = DEFER;
3176               break;
3177               }
3178             old_renameleaf = renameleaf;
3179             DEBUG(D_transport) debug_printf("%s exists - trying again\n",
3180               renamename);
3181             }
3182           else
3183             {
3184             Uunlink(filename);
3185             filename = NULL;
3186             break;
3187             }
3188           }        /* re-expand loop */
3189         }          /* not mailstore or maildir */
3190
3191       /* For maildir and mailstore formats, the new name was created earlier,
3192       except that for maildir, there is the possibility of adding a "tag" on
3193       the end of the name by expanding the value of nametag. This usually
3194       includes a reference to the message size. The expansion of nametag was
3195       checked above, before the file was opened. It either succeeded, or
3196       provoked a soft failure. So any failure here can be treated as soft.
3197       Ignore non-printing characters and / and put a colon at the start if the
3198       first character is alphanumeric. */
3199
3200       else
3201         {
3202         if (nametag)
3203           {
3204           uschar *iptr = expand_string(nametag);
3205           if (iptr)
3206             {
3207             uschar *etag = store_get(Ustrlen(iptr) + 2, is_tainted(iptr));
3208             uschar *optr = etag;
3209             for ( ; *iptr; iptr++)
3210               if (mac_isgraph(*iptr) && *iptr != '/')
3211                 {
3212                 if (optr == etag && isalnum(*iptr)) *optr++ = ':';
3213                 *optr++ = *iptr;
3214                 }
3215             *optr = 0;
3216             renamename = string_sprintf("%s%s", newname, etag);
3217             }
3218           }
3219
3220         /* Do the rename. If the name is too long and a tag exists, try again
3221         without the tag. */
3222
3223         if (Urename(filename, renamename) < 0 &&
3224                (nametag == NULL || errno != ENAMETOOLONG ||
3225                (renamename = newname, Urename(filename, renamename) < 0)))
3226           {
3227           addr->basic_errno = errno;
3228           addr->message = string_sprintf("while renaming %s as %s",
3229             filename, renamename);
3230           yield = DEFER;
3231           }
3232
3233         /* Rename succeeded */
3234
3235         else
3236           {
3237           DEBUG(D_transport) debug_printf("renamed %s as %s\n", filename,
3238             renamename);
3239           filename = dataname = NULL;   /* Prevents attempt to unlink at end */
3240           }
3241         }        /* maildir or mailstore */
3242       }          /* successful write + close */
3243     }            /* isdirectory */
3244   }              /* write success */
3245
3246
3247 /* For a file, restore the last access time (atime), and set the modification
3248 time as required - changed if write succeeded, unchanged if not. */
3249
3250 if (!isdirectory) utime(CS filename, &times);
3251
3252 /* Notify comsat if configured to do so. It only makes sense if the configured
3253 file is the one that the comsat daemon knows about. */
3254
3255 if (ob->notify_comsat && yield == OK && deliver_localpart)
3256   notify_comsat(deliver_localpart, saved_size);
3257
3258 /* Pass back the final return code in the address structure */
3259
3260 DEBUG(D_transport)
3261   debug_printf("appendfile yields %d with errno=%d more_errno=%d\n",
3262     yield, addr->basic_errno, addr->more_errno);
3263
3264 addr->transport_return = yield;
3265
3266 /* Close the file, which will release the fcntl lock. For a directory write it
3267 is closed above, except in cases of error which goto RETURN, when we also need
3268 to remove the original file(s). For MBX locking, if all has gone well, before
3269 closing the file, see if we can get an exclusive lock on it, in which case we
3270 can unlink the /tmp lock file before closing it. This is always a non-blocking
3271 lock; there's no need to wait if we can't get it. If everything has gone right
3272 but close fails, defer the message. Then unlink the lock file, if present. This
3273 point in the code is jumped to from a number of places when errors are
3274 detected, in order to get the file closed and the lock file tidied away. */
3275
3276 RETURN:
3277
3278 #ifdef SUPPORT_MBX
3279 if (mbx_lockfd >= 0)
3280   {
3281   if (yield == OK && apply_lock(fd, F_WRLCK, ob->use_fcntl, 0,
3282       ob->use_flock, 0) >= 0)
3283     {
3284     DEBUG(D_transport)
3285       debug_printf("unlinking MBX lock file %s\n", mbx_lockname);
3286     Uunlink(mbx_lockname);
3287     }
3288   (void)close(mbx_lockfd);
3289   }
3290 #endif  /* SUPPORT_MBX */
3291
3292 if (fd >= 0 && close(fd) < 0 && yield == OK)
3293   {
3294   addr->basic_errno = errno;
3295   addr->message = string_sprintf("while closing %s", filename);
3296   addr->transport_return = DEFER;
3297   }
3298
3299 if (hd >= 0) Uunlink(lockname);
3300
3301 /* We get here with isdirectory and filename set only in error situations. */
3302
3303 if (isdirectory && filename)
3304   {
3305   Uunlink(filename);
3306   if (dataname != filename) Uunlink(dataname);
3307   }
3308
3309 /* If wait_for_tick is TRUE, we have done a delivery where the uniqueness of a
3310 file name relies on time + pid. We must not allow the process to finish until
3311 the clock has move on by at least one microsecond. Usually we expect this
3312 already to be the case, but machines keep getting faster... */
3313
3314 if (wait_for_tick) exim_wait_tick(&msg_tv, 1);
3315
3316 /* A return of FALSE means that if there was an error, a common error was
3317 put in the first address of a batch. */
3318
3319 return FALSE;
3320
3321 ret_panic:
3322   addr->transport_return = PANIC;
3323   return FALSE;
3324 }
3325
3326 #endif  /*!MACRO_PREDEF*/
3327 /* End of transport/appendfile.c */