Documentation for randint. Better randomness defaults. Fixes: #722
[exim.git] / src / src / spool_in.c
CommitLineData
9e5d6b55 1/* $Cambridge: exim/src/src/spool_in.c,v 1.25 2009/10/15 08:06:23 tom Exp $ */
059ec3d9
PH
2
3/*************************************************
4* Exim - an Internet mail transport agent *
5*************************************************/
6
184e8823 7/* Copyright (c) University of Cambridge 1995 - 2007 */
059ec3d9
PH
8/* See the file NOTICE for conditions of use and distribution. */
9
10/* Functions for reading spool files. When compiling for a utility (eximon),
11not all are needed, and some functionality can be cut out. */
12
13
14#include "exim.h"
15
16
17
18#ifndef COMPILE_UTILITY
19/*************************************************
20* Open and lock data file *
21*************************************************/
22
23/* The data file is the one that is used for locking, because the header file
24can get replaced during delivery because of header rewriting. The file has
25to opened with write access so that we can get an exclusive lock, but in
26fact it won't be written to. Just in case there's a major disaster (e.g.
27overwriting some other file descriptor with the value of this one), open it
28with append.
29
30Argument: the id of the message
31Returns: TRUE if file successfully opened and locked
32
33Side effect: deliver_datafile is set to the fd of the open file.
34*/
35
36BOOL
37spool_open_datafile(uschar *id)
38{
39int i;
40struct stat statbuf;
41flock_t lock_data;
42uschar spoolname[256];
43
44/* If split_spool_directory is set, first look for the file in the appropriate
45sub-directory of the input directory. If it is not found there, try the input
46directory itself, to pick up leftovers from before the splitting. If split_
47spool_directory is not set, first look in the main input directory. If it is
48not found there, try the split sub-directory, in case it is left over from a
49splitting state. */
50
51for (i = 0; i < 2; i++)
52 {
53 int save_errno;
54 message_subdir[0] = (split_spool_directory == (i == 0))? id[5] : 0;
55 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
56 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
57 if (deliver_datafile >= 0) break;
58 save_errno = errno;
59 if (errno == ENOENT)
60 {
61 if (i == 0) continue;
62 if (!queue_running)
63 log_write(0, LOG_MAIN, "Spool file %s-D not found", id);
64 }
65 else log_write(0, LOG_MAIN, "Spool error for %s: %s", spoolname,
66 strerror(errno));
67 errno = save_errno;
68 return FALSE;
69 }
70
71/* File is open and message_subdir is set. Set the close-on-exec flag, and lock
72the file. We lock only the first line of the file (containing the message ID)
73because this apparently is needed for running Exim under Cygwin. If the entire
74file is locked in one process, a sub-process cannot access it, even when passed
75an open file descriptor (at least, I think that's the Cygwin story). On real
76Unix systems it doesn't make any difference as long as Exim is consistent in
77what it locks. */
78
ff790e47 79(void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
059ec3d9
PH
80 FD_CLOEXEC);
81
82lock_data.l_type = F_WRLCK;
83lock_data.l_whence = SEEK_SET;
84lock_data.l_start = 0;
85lock_data.l_len = SPOOL_DATA_START_OFFSET;
86
87if (fcntl(deliver_datafile, F_SETLK, &lock_data) < 0)
88 {
89 log_write(L_skip_delivery,
90 LOG_MAIN,
91 "Spool file is locked (another process is handling this message)");
f1e894f3 92 (void)close(deliver_datafile);
059ec3d9
PH
93 deliver_datafile = -1;
94 errno = 0;
95 return FALSE;
96 }
97
98/* Get the size of the data; don't include the leading filename line
99in the count, but add one for the newline before the data. */
100
101if (fstat(deliver_datafile, &statbuf) == 0)
102 {
103 message_body_size = statbuf.st_size - SPOOL_DATA_START_OFFSET;
104 message_size = message_body_size + 1;
105 }
106
107return TRUE;
108}
109#endif /* COMPILE_UTILITY */
110
111
112
113/*************************************************
114* Read non-recipients tree from spool file *
115*************************************************/
116
117/* The tree of non-recipients is written to the spool file in a form that
118makes it easy to read back into a tree. The format is as follows:
119
120 . Each node is preceded by two letter(Y/N) indicating whether it has left
121 or right children. There's one space after the two flags, before the name.
122
123 . The left subtree (if any) then follows, then the right subtree (if any).
124
125This function is entered with the next input line in the buffer. Note we must
126save the right flag before recursing with the same buffer.
127
128Once the tree is read, we re-construct the balance fields by scanning the tree.
129I forgot to write them out originally, and the compatible fix is to do it this
130way. This initial local recursing function does the necessary.
131
132Arguments:
133 node tree node
134
135Returns: maximum depth below the node, including the node itself
136*/
137
138static int
139count_below(tree_node *node)
140{
141int nleft, nright;
142if (node == NULL) return 0;
143nleft = count_below(node->left);
144nright = count_below(node->right);
145node->balance = (nleft > nright)? 1 : ((nright > nleft)? 2 : 0);
146return 1 + ((nleft > nright)? nleft : nright);
147}
148
149/* This is the real function...
150
151Arguments:
152 connect pointer to the root of the tree
153 f FILE to read data from
154 buffer contains next input line; further lines read into it
155 buffer_size size of the buffer
156
157Returns: FALSE on format error
158*/
159
160static BOOL
161read_nonrecipients_tree(tree_node **connect, FILE *f, uschar *buffer,
162 int buffer_size)
163{
164tree_node *node;
165int n = Ustrlen(buffer);
166BOOL right = buffer[1] == 'Y';
167
168if (n < 5) return FALSE; /* malformed line */
169buffer[n-1] = 0; /* Remove \n */
170node = store_get(sizeof(tree_node) + n - 3);
171*connect = node;
172Ustrcpy(node->name, buffer + 3);
173node->data.ptr = NULL;
174
175if (buffer[0] == 'Y')
176 {
177 if (Ufgets(buffer, buffer_size, f) == NULL ||
178 !read_nonrecipients_tree(&node->left, f, buffer, buffer_size))
179 return FALSE;
180 }
181else node->left = NULL;
182
183if (right)
184 {
185 if (Ufgets(buffer, buffer_size, f) == NULL ||
186 !read_nonrecipients_tree(&node->right, f, buffer, buffer_size))
187 return FALSE;
188 }
189else node->right = NULL;
190
191(void) count_below(*connect);
192return TRUE;
193}
194
195
196
197
198/*************************************************
199* Read spool header file *
200*************************************************/
201
202/* This function reads a spool header file and places the data into the
203appropriate global variables. The header portion is always read, but header
204structures are built only if read_headers is set true. It isn't, for example,
205while generating -bp output.
206
207It may be possible for blocks of nulls (binary zeroes) to get written on the
208end of a file if there is a system crash during writing. It was observed on an
209earlier version of Exim that omitted to fsync() the files - this is thought to
210have been the cause of that incident, but in any case, this code must be robust
211against such an event, and if such a file is encountered, it must be treated as
212malformed.
213
214Arguments:
215 name name of the header file, including the -H
216 read_headers TRUE if in-store header structures are to be built
217 subdir_set TRUE is message_subdir is already set
218
219Returns: spool_read_OK success
220 spool_read_notopen open failed
221 spool_read_enverror error in the envelope portion
222 spool_read_hdrdrror error in the header portion
223*/
224
225int
226spool_read_header(uschar *name, BOOL read_headers, BOOL subdir_set)
227{
228FILE *f = NULL;
229int n;
230int rcount = 0;
231long int uid, gid;
232BOOL inheader = FALSE;
1e70f85b 233uschar *p;
059ec3d9
PH
234
235/* Reset all the global variables to their default values. However, there is
236one exception. DO NOT change the default value of dont_deliver, because it may
237be forced by an external setting. */
238
38a0a95f 239acl_var_c = acl_var_m = NULL;
059ec3d9
PH
240authenticated_id = NULL;
241authenticated_sender = NULL;
242allow_unqualified_recipient = FALSE;
243allow_unqualified_sender = FALSE;
244body_linecount = 0;
245body_zerocount = 0;
246deliver_firsttime = FALSE;
247deliver_freeze = FALSE;
248deliver_frozen_at = 0;
249deliver_manual_thaw = FALSE;
250/* dont_deliver must NOT be reset */
251header_list = header_last = NULL;
b08b24c8 252host_lookup_deferred = FALSE;
059ec3d9
PH
253host_lookup_failed = FALSE;
254interface_address = NULL;
255interface_port = 0;
256local_error_message = FALSE;
257local_scan_data = NULL;
d677b2f2 258max_received_linelength = 0;
059ec3d9
PH
259message_linecount = 0;
260received_protocol = NULL;
261received_count = 0;
262recipients_list = NULL;
263sender_address = NULL;
264sender_fullhost = NULL;
265sender_helo_name = NULL;
266sender_host_address = NULL;
267sender_host_name = NULL;
268sender_host_port = 0;
269sender_host_authenticated = NULL;
270sender_ident = NULL;
271sender_local = FALSE;
272sender_set_untrusted = FALSE;
1f5b4c3d 273smtp_active_hostname = primary_hostname;
059ec3d9
PH
274tree_nonrecipients = NULL;
275
8523533c
TK
276#ifdef EXPERIMENTAL_BRIGHTMAIL
277bmi_run = 0;
278bmi_verdicts = NULL;
279#endif
280
80a47a2c 281#ifndef DISABLE_DKIM
9e5d6b55 282dkim_signers = NULL;
80a47a2c
TK
283dkim_disable_verify = FALSE;
284dkim_collect_input = FALSE;
f7572e5a
TK
285#endif
286
059ec3d9
PH
287#ifdef SUPPORT_TLS
288tls_certificate_verified = FALSE;
289tls_cipher = NULL;
290tls_peerdn = NULL;
291#endif
292
8523533c 293#ifdef WITH_CONTENT_SCAN
8523533c
TK
294spam_score_int = NULL;
295#endif
296
059ec3d9
PH
297/* Generate the full name and open the file. If message_subdir is already
298set, just look in the given directory. Otherwise, look in both the split
299and unsplit directories, as for the data file above. */
300
301for (n = 0; n < 2; n++)
302 {
303 if (!subdir_set)
304 message_subdir[0] = (split_spool_directory == (n == 0))? name[5] : 0;
305 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
306 name);
307 f = Ufopen(big_buffer, "rb");
308 if (f != NULL) break;
309 if (n != 0 || subdir_set || errno != ENOENT) return spool_read_notopen;
310 }
311
312errno = 0;
313
314#ifndef COMPILE_UTILITY
315DEBUG(D_deliver) debug_printf("reading spool file %s\n", name);
316#endif /* COMPILE_UTILITY */
317
318/* The first line of a spool file contains the message id followed by -H (i.e.
319the file name), in order to make the file self-identifying. */
320
321if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
322if (Ustrlen(big_buffer) != MESSAGE_ID_LENGTH + 3 ||
323 Ustrncmp(big_buffer, name, MESSAGE_ID_LENGTH + 2) != 0)
324 goto SPOOL_FORMAT_ERROR;
325
326/* The next three lines in the header file are in a fixed format. The first
327contains the login, uid, and gid of the user who caused the file to be written.
ebb6e6d5
PH
328There are known cases where a negative gid is used, so we allow for both
329negative uids and gids. The second contains the mail address of the message's
330sender, enclosed in <>. The third contains the time the message was received,
331and the number of warning messages for delivery delays that have been sent. */
059ec3d9
PH
332
333if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
334
1e70f85b
PH
335p = big_buffer + Ustrlen(big_buffer);
336while (p > big_buffer && isspace(p[-1])) p--;
337*p = 0;
338if (!isdigit(p[-1])) goto SPOOL_FORMAT_ERROR;
ebb6e6d5 339while (p > big_buffer && (isdigit(p[-1]) || '-' == p[-1])) p--;
1e70f85b
PH
340gid = Uatoi(p);
341if (p <= big_buffer || *(--p) != ' ') goto SPOOL_FORMAT_ERROR;
342*p = 0;
343if (!isdigit(p[-1])) goto SPOOL_FORMAT_ERROR;
ebb6e6d5 344while (p > big_buffer && (isdigit(p[-1]) || '-' == p[-1])) p--;
1e70f85b
PH
345uid = Uatoi(p);
346if (p <= big_buffer || *(--p) != ' ') goto SPOOL_FORMAT_ERROR;
347*p = 0;
8e669ac1 348
1e70f85b 349originator_login = string_copy(big_buffer);
059ec3d9
PH
350originator_uid = (uid_t)uid;
351originator_gid = (gid_t)gid;
352
353if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
354n = Ustrlen(big_buffer);
355if (n < 3 || big_buffer[0] != '<' || big_buffer[n-2] != '>')
356 goto SPOOL_FORMAT_ERROR;
357
358sender_address = store_get(n-2);
359Ustrncpy(sender_address, big_buffer+1, n-3);
360sender_address[n-3] = 0;
361
362if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
363if (sscanf(CS big_buffer, "%d %d", &received_time, &warning_count) != 2)
364 goto SPOOL_FORMAT_ERROR;
365
366message_age = time(NULL) - received_time;
367
368#ifndef COMPILE_UTILITY
369DEBUG(D_deliver) debug_printf("user=%s uid=%ld gid=%ld sender=%s\n",
370 originator_login, (long int)originator_uid, (long int)originator_gid,
371 sender_address);
372#endif /* COMPILE_UTILITY */
373
08955dd3
PH
374/* Now there may be a number of optional lines, each starting with "-". If you
375add a new setting here, make sure you set the default above.
059ec3d9 376
08955dd3
PH
377Because there are now quite a number of different possibilities, we use a
378switch on the first character to avoid too many failing tests. Thanks to Nico
379Erfurth for the patch that implemented this. I have made it even more efficient
380by not re-scanning the first two characters.
381
382To allow new versions of Exim that add additional flags to interwork with older
383versions that do not understand them, just ignore any lines starting with "-"
384that we don't recognize. Otherwise it wouldn't be possible to back off a new
385version that left new-style flags written on the spool. */
386
387p = big_buffer + 2;
059ec3d9
PH
388for (;;)
389 {
390 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
391 if (big_buffer[0] != '-') break;
059ec3d9 392 big_buffer[Ustrlen(big_buffer) - 1] = 0;
47ca6d6c 393
08955dd3 394 switch(big_buffer[1])
059ec3d9 395 {
08955dd3
PH
396 case 'a':
397
398 /* Nowadays we use "-aclc" and "-aclm" for the different types of ACL
399 variable, because Exim allows any number of them, with arbitrary names.
400 The line in the spool file is "-acl[cm] <name> <length>". The name excludes
401 the c or m. */
402
403 if (Ustrncmp(p, "clc ", 4) == 0 ||
404 Ustrncmp(p, "clm ", 4) == 0)
405 {
406 uschar *name, *endptr;
407 int count;
408 tree_node *node;
409 endptr = Ustrchr(big_buffer + 6, ' ');
410 if (endptr == NULL) goto SPOOL_FORMAT_ERROR;
411 name = string_sprintf("%c%.*s", big_buffer[4], endptr - big_buffer - 6,
412 big_buffer + 6);
413 if (sscanf(CS endptr, " %d", &count) != 1) goto SPOOL_FORMAT_ERROR;
414 node = acl_var_create(name);
415 node->data.ptr = store_get(count + 1);
416 if (fread(node->data.ptr, 1, count+1, f) < count) goto SPOOL_READ_ERROR;
417 ((uschar*)node->data.ptr)[count] = 0;
418 }
419
420 else if (Ustrcmp(p, "llow_unqualified_recipient") == 0)
421 allow_unqualified_recipient = TRUE;
422 else if (Ustrcmp(p, "llow_unqualified_sender") == 0)
423 allow_unqualified_sender = TRUE;
424
425 else if (Ustrncmp(p, "uth_id", 6) == 0)
426 authenticated_id = string_copy(big_buffer + 9);
427 else if (Ustrncmp(p, "uth_sender", 10) == 0)
428 authenticated_sender = string_copy(big_buffer + 13);
429 else if (Ustrncmp(p, "ctive_hostname", 14) == 0)
430 smtp_active_hostname = string_copy(big_buffer + 17);
431
432 /* For long-term backward compatibility, we recognize "-acl", which was
433 used before the number of ACL variables changed from 10 to 20. This was
434 before the subsequent change to an arbitrary number of named variables.
435 This code is retained so that upgrades from very old versions can still
436 handle old-format spool files. The value given after "-acl" is a number
437 that is 0-9 for connection variables, and 10-19 for message variables. */
438
439 else if (Ustrncmp(p, "cl ", 3) == 0)
440 {
441 int index, count;
8dce1a6f 442 uschar name[20]; /* Need plenty of space for %d format */
08955dd3
PH
443 tree_node *node;
444 if (sscanf(CS big_buffer + 5, "%d %d", &index, &count) != 2)
445 goto SPOOL_FORMAT_ERROR;
8dce1a6f
PH
446 if (index < 10)
447 (void) string_format(name, sizeof(name), "%c%d", 'c', index);
448 else if (index < 20) /* ignore out-of-range index */
449 (void) string_format(name, sizeof(name), "%c%d", 'm', index - 10);
08955dd3
PH
450 node = acl_var_create(name);
451 node->data.ptr = store_get(count + 1);
452 if (fread(node->data.ptr, 1, count+1, f) < count) goto SPOOL_READ_ERROR;
453 ((uschar*)node->data.ptr)[count] = 0;
454 }
455 break;
456
457 case 'b':
458 if (Ustrncmp(p, "ody_linecount", 13) == 0)
459 body_linecount = Uatoi(big_buffer + 15);
460 else if (Ustrncmp(p, "ody_zerocount", 13) == 0)
461 body_zerocount = Uatoi(big_buffer + 15);
462 #ifdef EXPERIMENTAL_BRIGHTMAIL
463 else if (Ustrncmp(p, "mi_verdicts ", 12) == 0)
464 bmi_verdicts = string_copy(big_buffer + 14);
465 #endif
466 break;
467
468 case 'd':
469 if (Ustrcmp(p, "eliver_firsttime") == 0)
470 deliver_firsttime = TRUE;
471 break;
472
473 case 'f':
474 if (Ustrncmp(p, "rozen", 5) == 0)
475 {
476 deliver_freeze = TRUE;
477 deliver_frozen_at = Uatoi(big_buffer + 7);
478 }
479 break;
480
481 case 'h':
482 if (Ustrcmp(p, "ost_lookup_deferred") == 0)
483 host_lookup_deferred = TRUE;
484 else if (Ustrcmp(p, "ost_lookup_failed") == 0)
485 host_lookup_failed = TRUE;
486 else if (Ustrncmp(p, "ost_auth", 8) == 0)
487 sender_host_authenticated = string_copy(big_buffer + 11);
488 else if (Ustrncmp(p, "ost_name", 8) == 0)
489 sender_host_name = string_copy(big_buffer + 11);
490 else if (Ustrncmp(p, "elo_name", 8) == 0)
491 sender_helo_name = string_copy(big_buffer + 11);
492
493 /* We now record the port number after the address, separated by a
494 dot. For compatibility during upgrading, do nothing if there
495 isn't a value (it gets left at zero). */
496
497 else if (Ustrncmp(p, "ost_address", 11) == 0)
498 {
499 sender_host_port = host_address_extract_port(big_buffer + 14);
500 sender_host_address = string_copy(big_buffer + 14);
501 }
502 break;
503
504 case 'i':
505 if (Ustrncmp(p, "nterface_address", 16) == 0)
506 {
507 interface_port = host_address_extract_port(big_buffer + 19);
508 interface_address = string_copy(big_buffer + 19);
509 }
510 else if (Ustrncmp(p, "dent", 4) == 0)
511 sender_ident = string_copy(big_buffer + 7);
512 break;
513
514 case 'l':
515 if (Ustrcmp(p, "ocal") == 0) sender_local = TRUE;
516 else if (Ustrcmp(big_buffer, "-localerror") == 0)
517 local_error_message = TRUE;
518 else if (Ustrncmp(p, "ocal_scan ", 10) == 0)
519 local_scan_data = string_copy(big_buffer + 12);
520 break;
521
522 case 'm':
523 if (Ustrcmp(p, "anual_thaw") == 0) deliver_manual_thaw = TRUE;
d677b2f2
PH
524 else if (Ustrncmp(p, "ax_received_linelength", 22) == 0)
525 max_received_linelength = Uatoi(big_buffer + 24);
08955dd3
PH
526 break;
527
528 case 'N':
529 if (*p == 0) dont_deliver = TRUE; /* -N */
530 break;
531
532 case 'r':
533 if (Ustrncmp(p, "eceived_protocol", 16) == 0)
534 received_protocol = string_copy(big_buffer + 19);
535 break;
536
537 case 's':
538 if (Ustrncmp(p, "ender_set_untrusted", 19) == 0)
539 sender_set_untrusted = TRUE;
540 #ifdef WITH_CONTENT_SCAN
541 else if (Ustrncmp(p, "pam_score_int ", 14) == 0)
542 spam_score_int = string_copy(big_buffer + 16);
543 #endif
544 break;
545
546 #ifdef SUPPORT_TLS
547 case 't':
548 if (Ustrncmp(p, "ls_certificate_verified", 23) == 0)
549 tls_certificate_verified = TRUE;
550 else if (Ustrncmp(p, "ls_cipher", 9) == 0)
551 tls_cipher = string_copy(big_buffer + 12);
552 else if (Ustrncmp(p, "ls_peerdn", 9) == 0)
553 tls_peerdn = string_copy(big_buffer + 12);
554 break;
555 #endif
556
557 default: /* Present because some compilers complain if all */
558 break; /* possibilities are not covered. */
059ec3d9 559 }
059ec3d9
PH
560 }
561
562/* Build sender_fullhost if required */
563
564#ifndef COMPILE_UTILITY
565host_build_sender_fullhost();
566#endif /* COMPILE_UTILITY */
567
568#ifndef COMPILE_UTILITY
569DEBUG(D_deliver)
570 debug_printf("sender_local=%d ident=%s\n", sender_local,
571 (sender_ident == NULL)? US"unset" : sender_ident);
572#endif /* COMPILE_UTILITY */
573
574/* We now have the tree of addresses NOT to deliver to, or a line
575containing "XX", indicating no tree. */
576
577if (Ustrncmp(big_buffer, "XX\n", 3) != 0 &&
578 !read_nonrecipients_tree(&tree_nonrecipients, f, big_buffer, big_buffer_size))
579 goto SPOOL_FORMAT_ERROR;
580
581#ifndef COMPILE_UTILITY
582DEBUG(D_deliver)
583 {
584 debug_printf("Non-recipients:\n");
585 debug_print_tree(tree_nonrecipients);
586 }
587#endif /* COMPILE_UTILITY */
588
589/* After reading the tree, the next line has not yet been read into the
590buffer. It contains the count of recipients which follow on separate lines. */
591
592if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
593if (sscanf(CS big_buffer, "%d", &rcount) != 1) goto SPOOL_FORMAT_ERROR;
594
595#ifndef COMPILE_UTILITY
596DEBUG(D_deliver) debug_printf("recipients_count=%d\n", rcount);
597#endif /* COMPILE_UTILITY */
598
599recipients_list_max = rcount;
600recipients_list = store_get(rcount * sizeof(recipient_item));
601
602for (recipients_count = 0; recipients_count < rcount; recipients_count++)
603 {
604 int nn;
605 int pno = -1;
606 uschar *errors_to = NULL;
607 uschar *p;
608
609 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
610 nn = Ustrlen(big_buffer);
611 if (nn < 2) goto SPOOL_FORMAT_ERROR;
612
613 /* Remove the newline; this terminates the address if there is no additional
614 data on the line. */
615
616 p = big_buffer + nn - 1;
617 *p-- = 0;
618
619 /* Look back from the end of the line for digits and special terminators.
620 Since an address must end with a domain, we can tell that extra data is
621 present by the presence of the terminator, which is always some character
622 that cannot exist in a domain. (If I'd thought of the need for additional
623 data early on, I'd have put it at the start, with the address at the end. As
624 it is, we have to operate backwards. Addresses are permitted to contain
625 spaces, you see.)
626
627 This code has to cope with various versions of this data that have evolved
628 over time. In all cases, the line might just contain an address, with no
629 additional data. Otherwise, the possibilities are as follows:
630
631 Exim 3 type: <address><space><digits>,<digits>,<digits>
632
633 The second set of digits is the parent number for one_time addresses. The
634 other values were remnants of earlier experiments that were abandoned.
635
636 Exim 4 first type: <address><space><digits>
637
638 The digits are the parent number for one_time addresses.
639
640 Exim 4 new type: <address><space><data>#<type bits>
641
642 The type bits indicate what the contents of the data are.
643
644 Bit 01 indicates that, reading from right to left, the data
645 ends with <errors_to address><space><len>,<pno> where pno is
646 the parent number for one_time addresses, and len is the length
647 of the errors_to address (zero meaning none).
648 */
649
650 while (isdigit(*p)) p--;
651
652 /* Handle Exim 3 spool files */
653
654 if (*p == ',')
655 {
656 int dummy;
657 while (isdigit(*(--p)) || *p == ',');
658 if (*p == ' ')
659 {
660 *p++ = 0;
ff790e47 661 (void)sscanf(CS p, "%d,%d", &dummy, &pno);
059ec3d9
PH
662 }
663 }
664
665 /* Handle early Exim 4 spool files */
666
667 else if (*p == ' ')
668 {
669 *p++ = 0;
ff790e47 670 (void)sscanf(CS p, "%d", &pno);
059ec3d9
PH
671 }
672
673 /* Handle current format Exim 4 spool files */
674
675 else if (*p == '#')
676 {
677 int flags;
ff790e47 678 (void)sscanf(CS p+1, "%d", &flags);
059ec3d9
PH
679
680 if ((flags & 0x01) != 0) /* one_time data exists */
681 {
682 int len;
683 while (isdigit(*(--p)) || *p == ',' || *p == '-');
ff790e47 684 (void)sscanf(CS p+1, "%d,%d", &len, &pno);
059ec3d9
PH
685 *p = 0;
686 if (len > 0)
687 {
688 p -= len;
689 errors_to = string_copy(p);
690 }
691 }
692
693 *(--p) = 0; /* Terminate address */
694 }
695
696 recipients_list[recipients_count].address = string_copy(big_buffer);
697 recipients_list[recipients_count].pno = pno;
698 recipients_list[recipients_count].errors_to = errors_to;
699 }
700
701/* The remainder of the spool header file contains the headers for the message,
702separated off from the previous data by a blank line. Each header is preceded
703by a count of its length and either a certain letter (for various identified
704headers), space (for a miscellaneous live header) or an asterisk (for a header
705that has been rewritten). Count the Received: headers. We read the headers
706always, in order to check on the format of the file, but only create a header
707list if requested to do so. */
708
709inheader = TRUE;
710if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
711if (big_buffer[0] != '\n') goto SPOOL_FORMAT_ERROR;
712
713while ((n = fgetc(f)) != EOF)
714 {
715 header_line *h;
716 uschar flag[4];
717 int i;
718
719 if (!isdigit(n)) goto SPOOL_FORMAT_ERROR;
ff790e47
PH
720 (void)ungetc(n, f);
721 (void)fscanf(f, "%d%c ", &n, flag);
059ec3d9
PH
722 if (flag[0] != '*') message_size += n; /* Omit non-transmitted headers */
723
724 if (read_headers)
725 {
726 h = store_get(sizeof(header_line));
727 h->next = NULL;
728 h->type = flag[0];
729 h->slen = n;
730 h->text = store_get(n+1);
731
732 if (h->type == htype_received) received_count++;
733
734 if (header_list == NULL) header_list = h;
735 else header_last->next = h;
736 header_last = h;
737
738 for (i = 0; i < n; i++)
739 {
740 int c = fgetc(f);
741 if (c == 0 || c == EOF) goto SPOOL_FORMAT_ERROR;
742 if (c == '\n' && h->type != htype_old) message_linecount++;
743 h->text[i] = c;
744 }
745 h->text[i] = 0;
746 }
747
748 /* Not requiring header data, just skip through the bytes */
749
750 else for (i = 0; i < n; i++)
751 {
752 int c = fgetc(f);
753 if (c == 0 || c == EOF) goto SPOOL_FORMAT_ERROR;
754 }
755 }
756
757/* We have successfully read the data in the header file. Update the message
758line count by adding the body linecount to the header linecount. Close the file
759and give a positive response. */
760
761#ifndef COMPILE_UTILITY
762DEBUG(D_deliver) debug_printf("body_linecount=%d message_linecount=%d\n",
763 body_linecount, message_linecount);
764#endif /* COMPILE_UTILITY */
765
766message_linecount += body_linecount;
767
768fclose(f);
769return spool_read_OK;
770
771
772/* There was an error reading the spool or there was missing data,
773or there was a format error. A "read error" with no errno means an
774unexpected EOF, which we treat as a format error. */
775
776SPOOL_READ_ERROR:
777if (errno != 0)
778 {
779 n = errno;
780
781 #ifndef COMPILE_UTILITY
782 DEBUG(D_any) debug_printf("Error while reading spool file %s\n", name);
783 #endif /* COMPILE_UTILITY */
784
785 fclose(f);
786 errno = n;
787 return inheader? spool_read_hdrerror : spool_read_enverror;
788 }
789
790SPOOL_FORMAT_ERROR:
791
792#ifndef COMPILE_UTILITY
793DEBUG(D_any) debug_printf("Format error in spool file %s\n", name);
794#endif /* COMPILE_UTILITY */
795
796fclose(f);
797errno = ERRNO_SPOOLFORMAT;
798return inheader? spool_read_hdrerror : spool_read_enverror;
799}
800
801/* End of spool_in.c */