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