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