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