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