28d5780150e90bfe6318d5df2767b876a951d7e9
[users/jgh/exim.git] / src / src / string.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 /* Miscellaneous string-handling functions. Some are not required for
9 utilities and tests, and are cut out by the COMPILE_UTILITY macro. */
10
11
12 #include "exim.h"
13
14
15 #ifndef COMPILE_UTILITY
16 /*************************************************
17 *            Test for IP address                 *
18 *************************************************/
19
20 /* This used just to be a regular expression, but with IPv6 things are a bit
21 more complicated. If the address contains a colon, it is assumed to be a v6
22 address (assuming HAVE_IPV6 is set). If a mask is permitted and one is present,
23 and maskptr is not NULL, its offset is placed there.
24
25 Arguments:
26   s         a string
27   maskptr   NULL if no mask is permitted to follow
28             otherwise, points to an int where the offset of '/' is placed
29             if there is no / followed by trailing digits, *maskptr is set 0
30
31 Returns:    0 if the string is not a textual representation of an IP address
32             4 if it is an IPv4 address
33             6 if it is an IPv6 address
34 */
35
36 int
37 string_is_ip_address(const uschar *s, int *maskptr)
38 {
39 int i;
40 int yield = 4;
41
42 /* If an optional mask is permitted, check for it. If found, pass back the
43 offset. */
44
45 if (maskptr != NULL)
46   {
47   const uschar *ss = s + Ustrlen(s);
48   *maskptr = 0;
49   if (s != ss && isdigit(*(--ss)))
50     {
51     while (ss > s && isdigit(ss[-1])) ss--;
52     if (ss > s && *(--ss) == '/') *maskptr = ss - s;
53     }
54   }
55
56 /* A colon anywhere in the string => IPv6 address */
57
58 if (Ustrchr(s, ':') != NULL)
59   {
60   BOOL had_double_colon = FALSE;
61   BOOL v4end = FALSE;
62   int count = 0;
63
64   yield = 6;
65
66   /* An IPv6 address must start with hex digit or double colon. A single
67   colon is invalid. */
68
69   if (*s == ':' && *(++s) != ':') return 0;
70
71   /* Now read up to 8 components consisting of up to 4 hex digits each. There
72   may be one and only one appearance of double colon, which implies any number
73   of binary zero bits. The number of preceding components is held in count. */
74
75   for (count = 0; count < 8; count++)
76     {
77     /* If the end of the string is reached before reading 8 components, the
78     address is valid provided a double colon has been read. This also applies
79     if we hit the / that introduces a mask or the % that introduces the
80     interface specifier (scope id) of a link-local address. */
81
82     if (*s == 0 || *s == '%' || *s == '/') return had_double_colon? yield : 0;
83
84     /* If a component starts with an additional colon, we have hit a double
85     colon. This is permitted to appear once only, and counts as at least
86     one component. The final component may be of this form. */
87
88     if (*s == ':')
89       {
90       if (had_double_colon) return 0;
91       had_double_colon = TRUE;
92       s++;
93       continue;
94       }
95
96     /* If the remainder of the string contains a dot but no colons, we
97     can expect a trailing IPv4 address. This is valid if either there has
98     been no double-colon and this is the 7th component (with the IPv4 address
99     being the 7th & 8th components), OR if there has been a double-colon
100     and fewer than 6 components. */
101
102     if (Ustrchr(s, ':') == NULL && Ustrchr(s, '.') != NULL)
103       {
104       if ((!had_double_colon && count != 6) ||
105           (had_double_colon && count > 6)) return 0;
106       v4end = TRUE;
107       yield = 6;
108       break;
109       }
110
111     /* Check for at least one and not more than 4 hex digits for this
112     component. */
113
114     if (!isxdigit(*s++)) return 0;
115     if (isxdigit(*s) && isxdigit(*(++s)) && isxdigit(*(++s))) s++;
116
117     /* If the component is terminated by colon and there is more to
118     follow, skip over the colon. If there is no more to follow the address is
119     invalid. */
120
121     if (*s == ':' && *(++s) == 0) return 0;
122     }
123
124   /* If about to handle a trailing IPv4 address, drop through. Otherwise
125   all is well if we are at the end of the string or at the mask or at a percent
126   sign, which introduces the interface specifier (scope id) of a link local
127   address. */
128
129   if (!v4end)
130     return (*s == 0 || *s == '%' ||
131            (*s == '/' && maskptr != NULL && *maskptr != 0))? yield : 0;
132   }
133
134 /* Test for IPv4 address, which may be the tail-end of an IPv6 address. */
135
136 for (i = 0; i < 4; i++)
137   {
138   if (i != 0 && *s++ != '.') return 0;
139   if (!isdigit(*s++)) return 0;
140   if (isdigit(*s) && isdigit(*(++s))) s++;
141   }
142
143 return (*s == 0 || (*s == '/' && maskptr != NULL && *maskptr != 0))?
144   yield : 0;
145 }
146 #endif  /* COMPILE_UTILITY */
147
148
149 /*************************************************
150 *              Format message size               *
151 *************************************************/
152
153 /* Convert a message size in bytes to printing form, rounding
154 according to the magnitude of the number. A value of zero causes
155 a string of spaces to be returned.
156
157 Arguments:
158   size        the message size in bytes
159   buffer      where to put the answer
160
161 Returns:      pointer to the buffer
162               a string of exactly 5 characters is normally returned
163 */
164
165 uschar *
166 string_format_size(int size, uschar *buffer)
167 {
168 if (size == 0) Ustrcpy(buffer, "     ");
169 else if (size < 1024) sprintf(CS buffer, "%5d", size);
170 else if (size < 10*1024)
171   sprintf(CS buffer, "%4.1fK", (double)size / 1024.0);
172 else if (size < 1024*1024)
173   sprintf(CS buffer, "%4dK", (size + 512)/1024);
174 else if (size < 10*1024*1024)
175   sprintf(CS buffer, "%4.1fM", (double)size / (1024.0 * 1024.0));
176 else
177   sprintf(CS buffer, "%4dM", (size + 512 * 1024)/(1024*1024));
178 return buffer;
179 }
180
181
182
183 #ifndef COMPILE_UTILITY
184 /*************************************************
185 *       Convert a number to base 62 format       *
186 *************************************************/
187
188 /* Convert a long integer into an ASCII base 62 string. For Cygwin the value of
189 BASE_62 is actually 36. Always return exactly 6 characters plus zero, in a
190 static area.
191
192 Argument: a long integer
193 Returns:  pointer to base 62 string
194 */
195
196 uschar *
197 string_base62(unsigned long int value)
198 {
199 static uschar yield[7];
200 uschar *p = yield + sizeof(yield) - 1;
201 *p = 0;
202 while (p > yield)
203   {
204   *(--p) = base62_chars[value % BASE_62];
205   value /= BASE_62;
206   }
207 return yield;
208 }
209 #endif  /* COMPILE_UTILITY */
210
211
212
213 /*************************************************
214 *          Interpret escape sequence             *
215 *************************************************/
216
217 /* This function is called from several places where escape sequences are to be
218 interpreted in strings.
219
220 Arguments:
221   pp       points a pointer to the initiating "\" in the string;
222            the pointer gets updated to point to the final character
223 Returns:   the value of the character escape
224 */
225
226 int
227 string_interpret_escape(const uschar **pp)
228 {
229 #ifdef COMPILE_UTILITY
230 const uschar *hex_digits= CUS"0123456789abcdef";
231 #endif
232 int ch;
233 const uschar *p = *pp;
234 ch = *(++p);
235 if (isdigit(ch) && ch != '8' && ch != '9')
236   {
237   ch -= '0';
238   if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
239     {
240     ch = ch * 8 + *(++p) - '0';
241     if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
242       ch = ch * 8 + *(++p) - '0';
243     }
244   }
245 else switch(ch)
246   {
247   case 'b':  ch = '\b'; break;
248   case 'f':  ch = '\f'; break;
249   case 'n':  ch = '\n'; break;
250   case 'r':  ch = '\r'; break;
251   case 't':  ch = '\t'; break;
252   case 'v':  ch = '\v'; break;
253   case 'x':
254   ch = 0;
255   if (isxdigit(p[1]))
256     {
257     ch = ch * 16 +
258       Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
259     if (isxdigit(p[1])) ch = ch * 16 +
260       Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
261     }
262   break;
263   }
264 *pp = p;
265 return ch;
266 }
267
268
269
270 #ifndef COMPILE_UTILITY
271 /*************************************************
272 *          Ensure string is printable            *
273 *************************************************/
274
275 /* This function is called for critical strings. It checks for any
276 non-printing characters, and if any are found, it makes a new copy
277 of the string with suitable escape sequences. It is most often called by the
278 macro string_printing(), which sets allow_tab TRUE.
279
280 Arguments:
281   s             the input string
282   allow_tab     TRUE to allow tab as a printing character
283
284 Returns:        string with non-printers encoded as printing sequences
285 */
286
287 const uschar *
288 string_printing2(const uschar *s, BOOL allow_tab)
289 {
290 int nonprintcount = 0;
291 int length = 0;
292 const uschar *t = s;
293 uschar *ss, *tt;
294
295 while (*t != 0)
296   {
297   int c = *t++;
298   if (!mac_isprint(c) || (!allow_tab && c == '\t')) nonprintcount++;
299   length++;
300   }
301
302 if (nonprintcount == 0) return s;
303
304 /* Get a new block of store guaranteed big enough to hold the
305 expanded string. */
306
307 ss = store_get(length + nonprintcount * 3 + 1);
308
309 /* Copy everying, escaping non printers. */
310
311 t = s;
312 tt = ss;
313
314 while (*t != 0)
315   {
316   int c = *t;
317   if (mac_isprint(c) && (allow_tab || c != '\t')) *tt++ = *t++; else
318     {
319     *tt++ = '\\';
320     switch (*t)
321       {
322       case '\n': *tt++ = 'n'; break;
323       case '\r': *tt++ = 'r'; break;
324       case '\b': *tt++ = 'b'; break;
325       case '\v': *tt++ = 'v'; break;
326       case '\f': *tt++ = 'f'; break;
327       case '\t': *tt++ = 't'; break;
328       default: sprintf(CS tt, "%03o", *t); tt += 3; break;
329       }
330     t++;
331     }
332   }
333 *tt = 0;
334 return ss;
335 }
336 #endif  /* COMPILE_UTILITY */
337
338 /*************************************************
339 *        Undo printing escapes in string         *
340 *************************************************/
341
342 /* This function is the reverse of string_printing2.  It searches for
343 backslash characters and if any are found, it makes a new copy of the
344 string with escape sequences parsed.  Otherwise it returns the original
345 string.
346
347 Arguments:
348   s             the input string
349
350 Returns:        string with printing escapes parsed back
351 */
352
353 uschar *
354 string_unprinting(uschar *s)
355 {
356 uschar *p, *q, *r, *ss;
357 int len, off;
358
359 p = Ustrchr(s, '\\');
360 if (!p) return s;
361
362 len = Ustrlen(s) + 1;
363 ss = store_get(len);
364
365 q = ss;
366 off = p - s;
367 if (off)
368   {
369   memcpy(q, s, off);
370   q += off;
371   }
372
373 while (*p)
374   {
375   if (*p == '\\')
376     {
377     *q++ = string_interpret_escape((const uschar **)&p);
378     p++;
379     }
380   else
381     {
382     r = Ustrchr(p, '\\');
383     if (!r)
384       {
385       off = Ustrlen(p);
386       memcpy(q, p, off);
387       p += off;
388       q += off;
389       break;
390       }
391     else
392       {
393       off = r - p;
394       memcpy(q, p, off);
395       q += off;
396       p = r;
397       }
398     }
399   }
400 *q = '\0';
401
402 return ss;
403 }
404
405
406
407
408 /*************************************************
409 *            Copy and save string                *
410 *************************************************/
411
412 /* This function assumes that memcpy() is faster than strcpy().
413
414 Argument: string to copy
415 Returns:  copy of string in new store
416 */
417
418 uschar *
419 string_copy(const uschar *s)
420 {
421 int len = Ustrlen(s) + 1;
422 uschar *ss = store_get(len);
423 memcpy(ss, s, len);
424 return ss;
425 }
426
427
428
429 /*************************************************
430 *     Copy and save string in malloc'd store     *
431 *************************************************/
432
433 /* This function assumes that memcpy() is faster than strcpy().
434
435 Argument: string to copy
436 Returns:  copy of string in new store
437 */
438
439 uschar *
440 string_copy_malloc(const uschar *s)
441 {
442 int len = Ustrlen(s) + 1;
443 uschar *ss = store_malloc(len);
444 memcpy(ss, s, len);
445 return ss;
446 }
447
448
449
450 /*************************************************
451 *       Copy, lowercase and save string          *
452 *************************************************/
453
454 /*
455 Argument: string to copy
456 Returns:  copy of string in new store, with letters lowercased
457 */
458
459 uschar *
460 string_copylc(const uschar *s)
461 {
462 uschar *ss = store_get(Ustrlen(s) + 1);
463 uschar *p = ss;
464 while (*s != 0) *p++ = tolower(*s++);
465 *p = 0;
466 return ss;
467 }
468
469
470
471 /*************************************************
472 *       Copy and save string, given length       *
473 *************************************************/
474
475 /* It is assumed the data contains no zeros. A zero is added
476 onto the end.
477
478 Arguments:
479   s         string to copy
480   n         number of characters
481
482 Returns:    copy of string in new store
483 */
484
485 uschar *
486 string_copyn(const uschar *s, int n)
487 {
488 uschar *ss = store_get(n + 1);
489 Ustrncpy(ss, s, n);
490 ss[n] = 0;
491 return ss;
492 }
493
494
495 /*************************************************
496 * Copy, lowercase, and save string, given length *
497 *************************************************/
498
499 /* It is assumed the data contains no zeros. A zero is added
500 onto the end.
501
502 Arguments:
503   s         string to copy
504   n         number of characters
505
506 Returns:    copy of string in new store, with letters lowercased
507 */
508
509 uschar *
510 string_copynlc(uschar *s, int n)
511 {
512 uschar *ss = store_get(n + 1);
513 uschar *p = ss;
514 while (n-- > 0) *p++ = tolower(*s++);
515 *p = 0;
516 return ss;
517 }
518
519
520
521 /*************************************************
522 *    Copy string if long, inserting newlines     *
523 *************************************************/
524
525 /* If the given string is longer than 75 characters, it is copied, and within
526 the copy, certain space characters are converted into newlines.
527
528 Argument:  pointer to the string
529 Returns:   pointer to the possibly altered string
530 */
531
532 uschar *
533 string_split_message(uschar *msg)
534 {
535 uschar *s, *ss;
536
537 if (msg == NULL || Ustrlen(msg) <= 75) return msg;
538 s = ss = msg = string_copy(msg);
539
540 for (;;)
541   {
542   int i = 0;
543   while (i < 75 && *ss != 0 && *ss != '\n') ss++, i++;
544   if (*ss == 0) break;
545   if (*ss == '\n')
546     s = ++ss;
547   else
548     {
549     uschar *t = ss + 1;
550     uschar *tt = NULL;
551     while (--t > s + 35)
552       {
553       if (*t == ' ')
554         {
555         if (t[-1] == ':') { tt = t; break; }
556         if (tt == NULL) tt = t;
557         }
558       }
559
560     if (tt == NULL)          /* Can't split behind - try ahead */
561       {
562       t = ss + 1;
563       while (*t != 0)
564         {
565         if (*t == ' ' || *t == '\n')
566           { tt = t; break; }
567         t++;
568         }
569       }
570
571     if (tt == NULL) break;   /* Can't find anywhere to split */
572     *tt = '\n';
573     s = ss = tt+1;
574     }
575   }
576
577 return msg;
578 }
579
580
581
582 /*************************************************
583 *   Copy returned DNS domain name, de-escaping   *
584 *************************************************/
585
586 /* If a domain name contains top-bit characters, some resolvers return
587 the fully qualified name with those characters turned into escapes. The
588 convention is a backslash followed by _decimal_ digits. We convert these
589 back into the original binary values. This will be relevant when
590 allow_utf8_domains is set true and UTF-8 characters are used in domain
591 names. Backslash can also be used to escape other characters, though we
592 shouldn't come across them in domain names.
593
594 Argument:   the domain name string
595 Returns:    copy of string in new store, de-escaped
596 */
597
598 uschar *
599 string_copy_dnsdomain(uschar *s)
600 {
601 uschar *yield;
602 uschar *ss = yield = store_get(Ustrlen(s) + 1);
603
604 while (*s != 0)
605   {
606   if (*s != '\\')
607     {
608     *ss++ = *s++;
609     }
610   else if (isdigit(s[1]))
611     {
612     *ss++ = (s[1] - '0')*100 + (s[2] - '0')*10 + s[3] - '0';
613     s += 4;
614     }
615   else if (*(++s) != 0)
616     {
617     *ss++ = *s++;
618     }
619   }
620
621 *ss = 0;
622 return yield;
623 }
624
625
626 #ifndef COMPILE_UTILITY
627 /*************************************************
628 *     Copy space-terminated or quoted string     *
629 *************************************************/
630
631 /* This function copies from a string until its end, or until whitespace is
632 encountered, unless the string begins with a double quote, in which case the
633 terminating quote is sought, and escaping within the string is done. The length
634 of a de-quoted string can be no longer than the original, since escaping always
635 turns n characters into 1 character.
636
637 Argument:  pointer to the pointer to the first character, which gets updated
638 Returns:   the new string
639 */
640
641 uschar *
642 string_dequote(const uschar **sptr)
643 {
644 const uschar *s = *sptr;
645 uschar *t, *yield;
646
647 /* First find the end of the string */
648
649 if (*s != '\"')
650   {
651   while (*s != 0 && !isspace(*s)) s++;
652   }
653 else
654   {
655   s++;
656   while (*s != 0 && *s != '\"')
657     {
658     if (*s == '\\') (void)string_interpret_escape(&s);
659     s++;
660     }
661   if (*s != 0) s++;
662   }
663
664 /* Get enough store to copy into */
665
666 t = yield = store_get(s - *sptr + 1);
667 s = *sptr;
668
669 /* Do the copy */
670
671 if (*s != '\"')
672   {
673   while (*s != 0 && !isspace(*s)) *t++ = *s++;
674   }
675 else
676   {
677   s++;
678   while (*s != 0 && *s != '\"')
679     {
680     if (*s == '\\') *t++ = string_interpret_escape(&s);
681       else *t++ = *s;
682     s++;
683     }
684   if (*s != 0) s++;
685   }
686
687 /* Update the pointer and return the terminated copy */
688
689 *sptr = s;
690 *t = 0;
691 return yield;
692 }
693 #endif  /* COMPILE_UTILITY */
694
695
696
697 /*************************************************
698 *          Format a string and save it           *
699 *************************************************/
700
701 /* The formatting is done by string_format, which checks the length of
702 everything.
703
704 Arguments:
705   format    a printf() format - deliberately char * rather than uschar *
706               because it will most usually be a literal string
707   ...       arguments for format
708
709 Returns:    pointer to fresh piece of store containing sprintf'ed string
710 */
711
712 uschar *
713 string_sprintf(const char *format, ...)
714 {
715 va_list ap;
716 uschar buffer[STRING_SPRINTF_BUFFER_SIZE];
717 va_start(ap, format);
718 if (!string_vformat(buffer, sizeof(buffer), format, ap))
719   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
720     "string_sprintf expansion was longer than " SIZE_T_FMT
721     "; format string was (%s)\nexpansion started '%.32s'",
722     sizeof(buffer), format, buffer);
723 va_end(ap);
724 return string_copy(buffer);
725 }
726
727
728
729 /*************************************************
730 *         Case-independent strncmp() function    *
731 *************************************************/
732
733 /*
734 Arguments:
735   s         first string
736   t         second string
737   n         number of characters to compare
738
739 Returns:    < 0, = 0, or > 0, according to the comparison
740 */
741
742 int
743 strncmpic(const uschar *s, const uschar *t, int n)
744 {
745 while (n--)
746   {
747   int c = tolower(*s++) - tolower(*t++);
748   if (c) return c;
749   }
750 return 0;
751 }
752
753
754 /*************************************************
755 *         Case-independent strcmp() function     *
756 *************************************************/
757
758 /*
759 Arguments:
760   s         first string
761   t         second string
762
763 Returns:    < 0, = 0, or > 0, according to the comparison
764 */
765
766 int
767 strcmpic(const uschar *s, const uschar *t)
768 {
769 while (*s != 0)
770   {
771   int c = tolower(*s++) - tolower(*t++);
772   if (c != 0) return c;
773   }
774 return *t;
775 }
776
777
778 /*************************************************
779 *         Case-independent strstr() function     *
780 *************************************************/
781
782 /* The third argument specifies whether whitespace is required
783 to follow the matched string.
784
785 Arguments:
786   s              string to search
787   t              substring to search for
788   space_follows  if TRUE, match only if whitespace follows
789
790 Returns:         pointer to substring in string, or NULL if not found
791 */
792
793 uschar *
794 strstric(uschar *s, uschar *t, BOOL space_follows)
795 {
796 uschar *p = t;
797 uschar *yield = NULL;
798 int cl = tolower(*p);
799 int cu = toupper(*p);
800
801 while (*s)
802   {
803   if (*s == cl || *s == cu)
804     {
805     if (yield == NULL) yield = s;
806     if (*(++p) == 0)
807       {
808       if (!space_follows || s[1] == ' ' || s[1] == '\n' ) return yield;
809       yield = NULL;
810       p = t;
811       }
812     cl = tolower(*p);
813     cu = toupper(*p);
814     s++;
815     }
816   else if (yield != NULL)
817     {
818     yield = NULL;
819     p = t;
820     cl = tolower(*p);
821     cu = toupper(*p);
822     }
823   else s++;
824   }
825 return NULL;
826 }
827
828
829
830 #ifndef COMPILE_UTILITY
831 /*************************************************
832 *       Get next string from separated list      *
833 *************************************************/
834
835 /* Leading and trailing space is removed from each item. The separator in the
836 list is controlled by the int pointed to by the separator argument as follows:
837
838   If the value is > 0 it is used as the separator. This is typically used for
839   sublists such as slash-separated options. The value is always a printing
840   character.
841
842     (If the value is actually > UCHAR_MAX there is only one item in the list.
843     This is used for some cases when called via functions that sometimes
844     plough through lists, and sometimes are given single items.)
845
846   If the value is <= 0, the string is inspected for a leading <x, where x is an
847   ispunct() or an iscntrl() character. If found, x is used as the separator. If
848   not found:
849
850       (a) if separator == 0, ':' is used
851       (b) if separator <0, -separator is used
852
853   In all cases the value of the separator that is used is written back to the
854   int so that it is used on subsequent calls as we progress through the list.
855
856 A literal ispunct() separator can be represented in an item by doubling, but
857 there is no way to include an iscntrl() separator as part of the data.
858
859 Arguments:
860   listptr    points to a pointer to the current start of the list; the
861              pointer gets updated to point after the end of the next item
862   separator  a pointer to the separator character in an int (see above)
863   buffer     where to put a copy of the next string in the list; or
864                NULL if the next string is returned in new memory
865   buflen     when buffer is not NULL, the size of buffer; otherwise ignored
866
867 Returns:     pointer to buffer, containing the next substring,
868              or NULL if no more substrings
869 */
870
871 uschar *
872 string_nextinlist(const uschar **listptr, int *separator, uschar *buffer, int buflen)
873 {
874 int sep = *separator;
875 const uschar *s = *listptr;
876 BOOL sep_is_special;
877
878 if (s == NULL) return NULL;
879
880 /* This allows for a fixed specified separator to be an iscntrl() character,
881 but at the time of implementation, this is never the case. However, it's best
882 to be conservative. */
883
884 while (isspace(*s) && *s != sep) s++;
885
886 /* A change of separator is permitted, so look for a leading '<' followed by an
887 allowed character. */
888
889 if (sep <= 0)
890   {
891   if (*s == '<' && (ispunct(s[1]) || iscntrl(s[1])))
892     {
893     sep = s[1];
894     s += 2;
895     while (isspace(*s) && *s != sep) s++;
896     }
897   else
898     {
899     sep = (sep == 0)? ':' : -sep;
900     }
901   *separator = sep;
902   }
903
904 /* An empty string has no list elements */
905
906 if (*s == 0) return NULL;
907
908 /* Note whether whether or not the separator is an iscntrl() character. */
909
910 sep_is_special = iscntrl(sep);
911
912 /* Handle the case when a buffer is provided. */
913
914 if (buffer != NULL)
915   {
916   int p = 0;
917   for (; *s != 0; s++)
918     {
919     if (*s == sep && (*(++s) != sep || sep_is_special)) break;
920     if (p < buflen - 1) buffer[p++] = *s;
921     }
922   while (p > 0 && isspace(buffer[p-1])) p--;
923   buffer[p] = 0;
924   }
925
926 /* Handle the case when a buffer is not provided. */
927
928 else
929   {
930   int size = 0;
931   int ptr = 0;
932   const uschar *ss;
933
934   /* We know that *s != 0 at this point. However, it might be pointing to a
935   separator, which could indicate an empty string, or (if an ispunct()
936   character) could be doubled to indicate a separator character as data at the
937   start of a string. Avoid getting working memory for an empty item. */
938
939   if (*s == sep)
940     {
941     s++;
942     if (*s != sep || sep_is_special)
943       {
944       *listptr = s;
945       return string_copy(US"");
946       }
947     }
948
949   /* Not an empty string; the first character is guaranteed to be a data
950   character. */
951
952   for (;;)
953     {
954     for (ss = s + 1; *ss != 0 && *ss != sep; ss++);
955     buffer = string_cat(buffer, &size, &ptr, s, ss-s);
956     s = ss;
957     if (*s == 0 || *(++s) != sep || sep_is_special) break;
958     }
959   while (ptr > 0 && isspace(buffer[ptr-1])) ptr--;
960   buffer[ptr] = 0;
961   }
962
963 /* Update the current pointer and return the new string */
964
965 *listptr = s;
966 return buffer;
967 }
968 #endif  /* COMPILE_UTILITY */
969
970
971 #ifndef COMPILE_UTILITY
972 /************************************************
973 *       Add element to separated list           *
974 ************************************************/
975 /* This function is used to build a list, returning
976 an allocated null-terminated growable string. The
977 given element has any embedded seperator characters
978 doubled.
979
980 Arguments:
981   list  points to the start of the list that is being built, or NULL
982         if this is a new list that has no contents yet
983   sep   list seperator charactoer
984   ele   new lement to be appended to the list
985
986 Returns:  pointer to the start of the list, changed if copied for expansion.
987 */
988
989 uschar *
990 string_append_listele(uschar * list, uschar sep, const uschar * ele)
991 {
992 uschar * new = NULL;
993 int sz = 0, off = 0;
994 uschar * sp;
995
996 if (list)
997   {
998   new = string_cat(new, &sz, &off, list, Ustrlen(list));
999   new = string_cat(new, &sz, &off, &sep, 1);
1000   }
1001
1002 while((sp = Ustrchr(ele, sep)))
1003   {
1004   new = string_cat(new, &sz, &off, ele, sp-ele+1);
1005   new = string_cat(new, &sz, &off, &sep, 1);
1006   ele = sp+1;
1007   }
1008 new = string_cat(new, &sz, &off, ele, Ustrlen(ele));
1009 new[off] = '\0';
1010 return new;
1011 }
1012
1013
1014 static const uschar *
1015 Ustrnchr(const uschar * s, int c, unsigned * len)
1016 {
1017 unsigned siz = *len;
1018 while (siz)
1019   {
1020   if (!*s) return NULL;
1021   if (*s == c)
1022     {
1023     *len = siz;
1024     return s;
1025     }
1026   s++;
1027   siz--;
1028   }
1029 return NULL;
1030 }
1031
1032 uschar *
1033 string_append_listele_n(uschar * list, uschar sep, const uschar * ele,
1034   unsigned len)
1035 {
1036 uschar * new = NULL;
1037 int sz = 0, off = 0;
1038 const uschar * sp;
1039
1040 if (list)
1041   {
1042   new = string_cat(new, &sz, &off, list, Ustrlen(list));
1043   new = string_cat(new, &sz, &off, &sep, 1);
1044   }
1045
1046 while((sp = Ustrnchr(ele, sep, &len)))
1047   {
1048   new = string_cat(new, &sz, &off, ele, sp-ele+1);
1049   new = string_cat(new, &sz, &off, &sep, 1);
1050   ele = sp+1;
1051   len--;
1052   }
1053 new = string_cat(new, &sz, &off, ele, len);
1054 new[off] = '\0';
1055 return new;
1056 }
1057 #endif  /* COMPILE_UTILITY */
1058
1059
1060
1061 #ifndef COMPILE_UTILITY
1062 /*************************************************
1063 *             Add chars to string                *
1064 *************************************************/
1065
1066 /* This function is used when building up strings of unknown length. Room is
1067 always left for a terminating zero to be added to the string that is being
1068 built. This function does not require the string that is being added to be NUL
1069 terminated, because the number of characters to add is given explicitly. It is
1070 sometimes called to extract parts of other strings.
1071
1072 Arguments:
1073   string   points to the start of the string that is being built, or NULL
1074              if this is a new string that has no contents yet
1075   size     points to a variable that holds the current capacity of the memory
1076              block (updated if changed)
1077   ptr      points to a variable that holds the offset at which to add
1078              characters, updated to the new offset
1079   s        points to characters to add
1080   count    count of characters to add; must not exceed the length of s, if s
1081              is a C string
1082
1083 If string is given as NULL, *size and *ptr should both be zero.
1084
1085 Returns:   pointer to the start of the string, changed if copied for expansion.
1086            Note that a NUL is not added, though space is left for one. This is
1087            because string_cat() is often called multiple times to build up a
1088            string - there's no point adding the NUL till the end.
1089 */
1090
1091 uschar *
1092 string_cat(uschar *string, int *size, int *ptr, const uschar *s, int count)
1093 {
1094 int p = *ptr;
1095
1096 if (p + count >= *size)
1097   {
1098   int oldsize = *size;
1099
1100   /* Mostly, string_cat() is used to build small strings of a few hundred
1101   characters at most. There are times, however, when the strings are very much
1102   longer (for example, a lookup that returns a vast number of alias addresses).
1103   To try to keep things reasonable, we use increments whose size depends on the
1104   existing length of the string. */
1105
1106   int inc = (oldsize < 4096)? 100 : 1024;
1107   while (*size <= p + count) *size += inc;
1108
1109   /* New string */
1110
1111   if (string == NULL) string = store_get(*size);
1112
1113   /* Try to extend an existing allocation. If the result of calling
1114   store_extend() is false, either there isn't room in the current memory block,
1115   or this string is not the top item on the dynamic store stack. We then have
1116   to get a new chunk of store and copy the old string. When building large
1117   strings, it is helpful to call store_release() on the old string, to release
1118   memory blocks that have become empty. (The block will be freed if the string
1119   is at its start.) However, we can do this only if we know that the old string
1120   was the last item on the dynamic memory stack. This is the case if it matches
1121   store_last_get. */
1122
1123   else if (!store_extend(string, oldsize, *size))
1124     {
1125     BOOL release_ok = store_last_get[store_pool] == string;
1126     uschar *newstring = store_get(*size);
1127     memcpy(newstring, string, p);
1128     if (release_ok) store_release(string);
1129     string = newstring;
1130     }
1131   }
1132
1133 /* Because we always specify the exact number of characters to copy, we can
1134 use memcpy(), which is likely to be more efficient than strncopy() because the
1135 latter has to check for zero bytes. */
1136
1137 memcpy(string + p, s, count);
1138 *ptr = p + count;
1139 return string;
1140 }
1141 #endif  /* COMPILE_UTILITY */
1142
1143
1144
1145 #ifndef COMPILE_UTILITY
1146 /*************************************************
1147 *        Append strings to another string        *
1148 *************************************************/
1149
1150 /* This function can be used to build a string from many other strings.
1151 It calls string_cat() to do the dirty work.
1152
1153 Arguments:
1154   string   points to the start of the string that is being built, or NULL
1155              if this is a new string that has no contents yet
1156   size     points to a variable that holds the current capacity of the memory
1157              block (updated if changed)
1158   ptr      points to a variable that holds the offset at which to add
1159              characters, updated to the new offset
1160   count    the number of strings to append
1161   ...      "count" uschar* arguments, which must be valid zero-terminated
1162              C strings
1163
1164 Returns:   pointer to the start of the string, changed if copied for expansion.
1165            The string is not zero-terminated - see string_cat() above.
1166 */
1167
1168 uschar *
1169 string_append(uschar *string, int *size, int *ptr, int count, ...)
1170 {
1171 va_list ap;
1172 int i;
1173
1174 va_start(ap, count);
1175 for (i = 0; i < count; i++)
1176   {
1177   uschar *t = va_arg(ap, uschar *);
1178   string = string_cat(string, size, ptr, t, Ustrlen(t));
1179   }
1180 va_end(ap);
1181
1182 return string;
1183 }
1184 #endif
1185
1186
1187
1188 /*************************************************
1189 *        Format a string with length checks      *
1190 *************************************************/
1191
1192 /* This function is used to format a string with checking of the length of the
1193 output for all conversions. It protects Exim from absent-mindedness when
1194 calling functions like debug_printf and string_sprintf, and elsewhere. There
1195 are two different entry points to what is actually the same function, depending
1196 on whether the variable length list of data arguments are given explicitly or
1197 as a va_list item.
1198
1199 The formats are the usual printf() ones, with some omissions (never used) and
1200 two additions for strings: %S forces lower case, and %#s or %#S prints nothing
1201 for a NULL string. Without the # "NULL" is printed (useful in debugging). There
1202 is also the addition of %D and %M, which insert the date in the form used for
1203 datestamped log files.
1204
1205 Arguments:
1206   buffer       a buffer in which to put the formatted string
1207   buflen       the length of the buffer
1208   format       the format string - deliberately char * and not uschar *
1209   ... or ap    variable list of supplementary arguments
1210
1211 Returns:       TRUE if the result fitted in the buffer
1212 */
1213
1214 BOOL
1215 string_format(uschar *buffer, int buflen, const char *format, ...)
1216 {
1217 BOOL yield;
1218 va_list ap;
1219 va_start(ap, format);
1220 yield = string_vformat(buffer, buflen, format, ap);
1221 va_end(ap);
1222 return yield;
1223 }
1224
1225
1226 BOOL
1227 string_vformat(uschar *buffer, int buflen, const char *format, va_list ap)
1228 {
1229 /* We assume numbered ascending order, C does not guarantee that */
1230 enum { L_NORMAL=1, L_SHORT=2, L_LONG=3, L_LONGLONG=4, L_LONGDOUBLE=5, L_SIZE=6 };
1231
1232 BOOL yield = TRUE;
1233 int width, precision;
1234 const char *fp = format;       /* Deliberately not unsigned */
1235 uschar *p = buffer;
1236 uschar *last = buffer + buflen - 1;
1237
1238 string_datestamp_offset = -1;  /* Datestamp not inserted */
1239 string_datestamp_length = 0;   /* Datestamp not inserted */
1240 string_datestamp_type = 0;     /* Datestamp not inserted */
1241
1242 /* Scan the format and handle the insertions */
1243
1244 while (*fp != 0)
1245   {
1246   int length = L_NORMAL;
1247   int *nptr;
1248   int slen;
1249   const char *null = "NULL";   /* ) These variables */
1250   const char *item_start, *s;  /* ) are deliberately */
1251   char newformat[16];          /* ) not unsigned */
1252
1253   /* Non-% characters just get copied verbatim */
1254
1255   if (*fp != '%')
1256     {
1257     if (p >= last) { yield = FALSE; break; }
1258     *p++ = (uschar)*fp++;
1259     continue;
1260     }
1261
1262   /* Deal with % characters. Pick off the width and precision, for checking
1263   strings, skipping over the flag and modifier characters. */
1264
1265   item_start = fp;
1266   width = precision = -1;
1267
1268   if (strchr("-+ #0", *(++fp)) != NULL)
1269     {
1270     if (*fp == '#') null = "";
1271     fp++;
1272     }
1273
1274   if (isdigit((uschar)*fp))
1275     {
1276     width = *fp++ - '0';
1277     while (isdigit((uschar)*fp)) width = width * 10 + *fp++ - '0';
1278     }
1279   else if (*fp == '*')
1280     {
1281     width = va_arg(ap, int);
1282     fp++;
1283     }
1284
1285   if (*fp == '.')
1286     {
1287     if (*(++fp) == '*')
1288       {
1289       precision = va_arg(ap, int);
1290       fp++;
1291       }
1292     else
1293       {
1294       precision = 0;
1295       while (isdigit((uschar)*fp))
1296         precision = precision*10 + *fp++ - '0';
1297       }
1298     }
1299
1300   /* Skip over 'h', 'L', 'l', 'll' and 'z', remembering the item length */
1301
1302   if (*fp == 'h')
1303     { fp++; length = L_SHORT; }
1304   else if (*fp == 'L')
1305     { fp++; length = L_LONGDOUBLE; }
1306   else if (*fp == 'l')
1307     {
1308     if (fp[1] == 'l')
1309       {
1310       fp += 2;
1311       length = L_LONGLONG;
1312       }
1313     else
1314       {
1315       fp++;
1316       length = L_LONG;
1317       }
1318     }
1319   else if (*fp == 'z')
1320     { fp++; length = L_SIZE; }
1321
1322   /* Handle each specific format type. */
1323
1324   switch (*fp++)
1325     {
1326     case 'n':
1327     nptr = va_arg(ap, int *);
1328     *nptr = p - buffer;
1329     break;
1330
1331     case 'd':
1332     case 'o':
1333     case 'u':
1334     case 'x':
1335     case 'X':
1336     if (p >= last - ((length > L_LONG)? 24 : 12))
1337       { yield = FALSE; goto END_FORMAT; }
1338     strncpy(newformat, item_start, fp - item_start);
1339     newformat[fp - item_start] = 0;
1340
1341     /* Short int is promoted to int when passing through ..., so we must use
1342     int for va_arg(). */
1343
1344     switch(length)
1345       {
1346       case L_SHORT:
1347       case L_NORMAL:   sprintf(CS p, newformat, va_arg(ap, int)); break;
1348       case L_LONG:     sprintf(CS p, newformat, va_arg(ap, long int)); break;
1349       case L_LONGLONG: sprintf(CS p, newformat, va_arg(ap, LONGLONG_T)); break;
1350       case L_SIZE:     sprintf(CS p, newformat, va_arg(ap, size_t)); break;
1351       }
1352     while (*p) p++;
1353     break;
1354
1355     case 'p':
1356     if (p >= last - 24) { yield = FALSE; goto END_FORMAT; }
1357     strncpy(newformat, item_start, fp - item_start);
1358     newformat[fp - item_start] = 0;
1359     sprintf(CS p, newformat, va_arg(ap, void *));
1360     while (*p) p++;
1361     break;
1362
1363     /* %f format is inherently insecure if the numbers that it may be
1364     handed are unknown (e.g. 1e300). However, in Exim, %f is used for
1365     printing load averages, and these are actually stored as integers
1366     (load average * 1000) so the size of the numbers is constrained.
1367     It is also used for formatting sending rates, where the simplicity
1368     of the format prevents overflow. */
1369
1370     case 'f':
1371     case 'e':
1372     case 'E':
1373     case 'g':
1374     case 'G':
1375     if (precision < 0) precision = 6;
1376     if (p >= last - precision - 8) { yield = FALSE; goto END_FORMAT; }
1377     strncpy(newformat, item_start, fp - item_start);
1378     newformat[fp-item_start] = 0;
1379     if (length == L_LONGDOUBLE)
1380       sprintf(CS p, newformat, va_arg(ap, long double));
1381     else
1382       sprintf(CS p, newformat, va_arg(ap, double));
1383     while (*p) p++;
1384     break;
1385
1386     /* String types */
1387
1388     case '%':
1389     if (p >= last) { yield = FALSE; goto END_FORMAT; }
1390     *p++ = '%';
1391     break;
1392
1393     case 'c':
1394     if (p >= last) { yield = FALSE; goto END_FORMAT; }
1395     *p++ = va_arg(ap, int);
1396     break;
1397
1398     case 'D':                   /* Insert daily datestamp for log file names */
1399     s = CS tod_stamp(tod_log_datestamp_daily);
1400     string_datestamp_offset = p - buffer;   /* Passed back via global */
1401     string_datestamp_length = Ustrlen(s);   /* Passed back via global */
1402     string_datestamp_type = tod_log_datestamp_daily;
1403     slen = string_datestamp_length;
1404     goto INSERT_STRING;
1405
1406     case 'M':                   /* Insert monthly datestamp for log file names */
1407     s = CS tod_stamp(tod_log_datestamp_monthly);
1408     string_datestamp_offset = p - buffer;   /* Passed back via global */
1409     string_datestamp_length = Ustrlen(s);   /* Passed back via global */
1410     string_datestamp_type = tod_log_datestamp_monthly;
1411     slen = string_datestamp_length;
1412     goto INSERT_STRING;
1413
1414     case 's':
1415     case 'S':                   /* Forces *lower* case */
1416     s = va_arg(ap, char *);
1417
1418     if (s == NULL) s = null;
1419     slen = Ustrlen(s);
1420
1421     INSERT_STRING:              /* Come to from %D or %M above */
1422
1423     /* If the width is specified, check that there is a precision
1424     set; if not, set it to the width to prevent overruns of long
1425     strings. */
1426
1427     if (width >= 0)
1428       {
1429       if (precision < 0) precision = width;
1430       }
1431
1432     /* If a width is not specified and the precision is specified, set
1433     the width to the precision, or the string length if shorted. */
1434
1435     else if (precision >= 0)
1436       {
1437       width = (precision < slen)? precision : slen;
1438       }
1439
1440     /* If neither are specified, set them both to the string length. */
1441
1442     else width = precision = slen;
1443
1444     /* Check string space, and add the string to the buffer if ok. If
1445     not OK, add part of the string (debugging uses this to show as
1446     much as possible). */
1447
1448     if (p == last)
1449       {
1450       yield = FALSE;
1451       goto END_FORMAT;
1452       }
1453     if (p >= last - width)
1454       {
1455       yield = FALSE;
1456       width = precision = last - p - 1;
1457       if (width < 0) width = 0;
1458       if (precision < 0) precision = 0;
1459       }
1460     sprintf(CS p, "%*.*s", width, precision, s);
1461     if (fp[-1] == 'S')
1462       while (*p) { *p = tolower(*p); p++; }
1463     else
1464       while (*p) p++;
1465     if (!yield) goto END_FORMAT;
1466     break;
1467
1468     /* Some things are never used in Exim; also catches junk. */
1469
1470     default:
1471     strncpy(newformat, item_start, fp - item_start);
1472     newformat[fp-item_start] = 0;
1473     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "string_format: unsupported type "
1474       "in \"%s\" in \"%s\"", newformat, format);
1475     break;
1476     }
1477   }
1478
1479 /* Ensure string is complete; return TRUE if got to the end of the format */
1480
1481 END_FORMAT:
1482
1483 *p = 0;
1484 return yield;
1485 }
1486
1487
1488
1489 #ifndef COMPILE_UTILITY
1490 /*************************************************
1491 *       Generate an "open failed" message        *
1492 *************************************************/
1493
1494 /* This function creates a message after failure to open a file. It includes a
1495 string supplied as data, adds the strerror() text, and if the failure was
1496 "Permission denied", reads and includes the euid and egid.
1497
1498 Arguments:
1499   eno           the value of errno after the failure
1500   format        a text format string - deliberately not uschar *
1501   ...           arguments for the format string
1502
1503 Returns:        a message, in dynamic store
1504 */
1505
1506 uschar *
1507 string_open_failed(int eno, const char *format, ...)
1508 {
1509 va_list ap;
1510 uschar buffer[1024];
1511
1512 Ustrcpy(buffer, "failed to open ");
1513 va_start(ap, format);
1514
1515 /* Use the checked formatting routine to ensure that the buffer
1516 does not overflow. It should not, since this is called only for internally
1517 specified messages. If it does, the message just gets truncated, and there
1518 doesn't seem much we can do about that. */
1519
1520 (void)string_vformat(buffer+15, sizeof(buffer) - 15, format, ap);
1521 va_end(ap);
1522
1523 return (eno == EACCES)?
1524   string_sprintf("%s: %s (euid=%ld egid=%ld)", buffer, strerror(eno),
1525     (long int)geteuid(), (long int)getegid()) :
1526   string_sprintf("%s: %s", buffer, strerror(eno));
1527 }
1528 #endif  /* COMPILE_UTILITY */
1529
1530
1531
1532 #ifndef COMPILE_UTILITY
1533 /*************************************************
1534 *        Generate local prt for logging          *
1535 *************************************************/
1536
1537 /* This function is a subroutine for use in string_log_address() below.
1538
1539 Arguments:
1540   addr        the address being logged
1541   yield       the current dynamic buffer pointer
1542   sizeptr     points to current size
1543   ptrptr      points to current insert pointer
1544
1545 Returns:      the new value of the buffer pointer
1546 */
1547
1548 static uschar *
1549 string_get_localpart(address_item *addr, uschar *yield, int *sizeptr,
1550   int *ptrptr)
1551 {
1552 uschar * s;
1553
1554 s = addr->prefix;
1555 if (testflag(addr, af_include_affixes) && s)
1556   {
1557 #ifdef SUPPORT_I18N
1558   if (testflag(addr, af_utf8_downcvt))
1559     s = string_localpart_utf8_to_alabel(s, NULL);
1560 #endif
1561   yield = string_cat(yield, sizeptr, ptrptr, s, Ustrlen(s));
1562   }
1563
1564 s = addr->local_part;
1565 #ifdef SUPPORT_I18N
1566 if (testflag(addr, af_utf8_downcvt))
1567   s = string_localpart_utf8_to_alabel(s, NULL);
1568 #endif
1569 yield = string_cat(yield, sizeptr, ptrptr, s, Ustrlen(s));
1570
1571 s = addr->suffix;
1572 if (testflag(addr, af_include_affixes) && s)
1573   {
1574 #ifdef SUPPORT_I18N
1575   if (testflag(addr, af_utf8_downcvt))
1576     s = string_localpart_utf8_to_alabel(s, NULL);
1577 #endif
1578   yield = string_cat(yield, sizeptr, ptrptr, s, Ustrlen(s));
1579   }
1580
1581 return yield;
1582 }
1583
1584
1585 /*************************************************
1586 *          Generate log address list             *
1587 *************************************************/
1588
1589 /* This function generates a list consisting of an address and its parents, for
1590 use in logging lines. For saved onetime aliased addresses, the onetime parent
1591 field is used. If the address was delivered by a transport with rcpt_include_
1592 affixes set, the af_include_affixes bit will be set in the address. In that
1593 case, we include the affixes here too.
1594
1595 Arguments:
1596   addr          bottom (ultimate) address
1597   all_parents   if TRUE, include all parents
1598   success       TRUE for successful delivery
1599
1600 Returns:        a string in dynamic store
1601 */
1602
1603 uschar *
1604 string_log_address(address_item *addr, BOOL all_parents, BOOL success)
1605 {
1606 int size = 64;
1607 int ptr = 0;
1608 BOOL add_topaddr = TRUE;
1609 uschar *yield = store_get(size);
1610 address_item *topaddr;
1611
1612 /* Find the ultimate parent */
1613
1614 for (topaddr = addr; topaddr->parent != NULL; topaddr = topaddr->parent);
1615
1616 /* We start with just the local part for pipe, file, and reply deliveries, and
1617 for successful local deliveries from routers that have the log_as_local flag
1618 set. File deliveries from filters can be specified as non-absolute paths in
1619 cases where the transport is goin to complete the path. If there is an error
1620 before this happens (expansion failure) the local part will not be updated, and
1621 so won't necessarily look like a path. Add extra text for this case. */
1622
1623 if (testflag(addr, af_pfr) ||
1624       (success &&
1625        addr->router != NULL && addr->router->log_as_local &&
1626        addr->transport != NULL && addr->transport->info->local))
1627   {
1628   if (testflag(addr, af_file) && addr->local_part[0] != '/')
1629     yield = string_cat(yield, &size, &ptr, CUS"save ", 5);
1630   yield = string_get_localpart(addr, yield, &size, &ptr);
1631   }
1632
1633 /* Other deliveries start with the full address. It we have split it into local
1634 part and domain, use those fields. Some early failures can happen before the
1635 splitting is done; in those cases use the original field. */
1636
1637 else
1638   {
1639   if (addr->local_part != NULL)
1640     {
1641     const uschar * s;
1642     yield = string_get_localpart(addr, yield, &size, &ptr);
1643     yield = string_cat(yield, &size, &ptr, US"@", 1);
1644     s = addr->domain;
1645 #ifdef SUPPORT_I18N
1646     if (testflag(addr, af_utf8_downcvt))
1647       s = string_localpart_utf8_to_alabel(s, NULL);
1648 #endif
1649     yield = string_cat(yield, &size, &ptr, s, Ustrlen(s) );
1650     }
1651   else
1652     {
1653     yield = string_cat(yield, &size, &ptr, addr->address, Ustrlen(addr->address));
1654     }
1655   yield[ptr] = 0;
1656
1657   /* If the address we are going to print is the same as the top address,
1658   and all parents are not being included, don't add on the top address. First
1659   of all, do a caseless comparison; if this succeeds, do a caseful comparison
1660   on the local parts. */
1661
1662   if (strcmpic(yield, topaddr->address) == 0 &&
1663       Ustrncmp(yield, topaddr->address, Ustrchr(yield, '@') - yield) == 0 &&
1664       addr->onetime_parent == NULL &&
1665       (!all_parents || addr->parent == NULL || addr->parent == topaddr))
1666     add_topaddr = FALSE;
1667   }
1668
1669 /* If all parents are requested, or this is a local pipe/file/reply, and
1670 there is at least one intermediate parent, show it in brackets, and continue
1671 with all of them if all are wanted. */
1672
1673 if ((all_parents || testflag(addr, af_pfr)) &&
1674     addr->parent != NULL &&
1675     addr->parent != topaddr)
1676   {
1677   uschar *s = US" (";
1678   address_item *addr2;
1679   for (addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1680     {
1681     yield = string_cat(yield, &size, &ptr, s, 2);
1682     yield = string_cat(yield, &size, &ptr, addr2->address, Ustrlen(addr2->address));
1683     if (!all_parents) break;
1684     s = US", ";
1685     }
1686   yield = string_cat(yield, &size, &ptr, US")", 1);
1687   }
1688
1689 /* Add the top address if it is required */
1690
1691 if (add_topaddr)
1692   {
1693   yield = string_cat(yield, &size, &ptr, US" <", 2);
1694
1695   if (addr->onetime_parent == NULL)
1696     yield = string_cat(yield, &size, &ptr, topaddr->address,
1697       Ustrlen(topaddr->address));
1698   else
1699     yield = string_cat(yield, &size, &ptr, addr->onetime_parent,
1700       Ustrlen(addr->onetime_parent));
1701
1702   yield = string_cat(yield, &size, &ptr, US">", 1);
1703   }
1704
1705 yield[ptr] = 0;  /* string_cat() leaves space */
1706 return yield;
1707 }
1708 #endif  /* COMPILE_UTILITY */
1709
1710
1711 #ifndef COMPILE_UTILITY
1712 /* qsort(3), currently used to sort the environment variables
1713 for -bP environment output, needs a function to compare two pointers to string
1714 pointers. Here it is. */
1715
1716 int
1717 string_compare_by_pointer(const void *a, const void *b)
1718 {
1719 return Ustrcmp(* CUSS a, * CUSS b);
1720 }
1721 #endif /* COMPILE_UTILITY */
1722
1723
1724
1725 /*************************************************
1726 **************************************************
1727 *             Stand-alone test program           *
1728 **************************************************
1729 *************************************************/
1730
1731 #ifdef STAND_ALONE
1732 int main(void)
1733 {
1734 uschar buffer[256];
1735
1736 printf("Testing is_ip_address\n");
1737
1738 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1739   {
1740   int offset;
1741   buffer[Ustrlen(buffer) - 1] = 0;
1742   printf("%d\n", string_is_ip_address(buffer, NULL));
1743   printf("%d %d %s\n", string_is_ip_address(buffer, &offset), offset, buffer);
1744   }
1745
1746 printf("Testing string_nextinlist\n");
1747
1748 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1749   {
1750   uschar *list = buffer;
1751   uschar *lp1, *lp2;
1752   uschar item[256];
1753   int sep1 = 0;
1754   int sep2 = 0;
1755
1756   if (*list == '<')
1757     {
1758     sep1 = sep2 = list[1];
1759     list += 2;
1760     }
1761
1762   lp1 = lp2 = list;
1763   for (;;)
1764     {
1765     uschar *item1 = string_nextinlist(&lp1, &sep1, item, sizeof(item));
1766     uschar *item2 = string_nextinlist(&lp2, &sep2, NULL, 0);
1767
1768     if (item1 == NULL && item2 == NULL) break;
1769     if (item == NULL || item2 == NULL || Ustrcmp(item1, item2) != 0)
1770       {
1771       printf("***ERROR\nitem1=\"%s\"\nitem2=\"%s\"\n",
1772         (item1 == NULL)? "NULL" : CS item1,
1773         (item2 == NULL)? "NULL" : CS item2);
1774       break;
1775       }
1776     else printf("  \"%s\"\n", CS item1);
1777     }
1778   }
1779
1780 /* This is a horrible lash-up, but it serves its purpose. */
1781
1782 printf("Testing string_format\n");
1783
1784 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1785   {
1786   void *args[3];
1787   long long llargs[3];
1788   double dargs[3];
1789   int dflag = 0;
1790   int llflag = 0;
1791   int n = 0;
1792   int count;
1793   int countset = 0;
1794   uschar format[256];
1795   uschar outbuf[256];
1796   uschar *s;
1797   buffer[Ustrlen(buffer) - 1] = 0;
1798
1799   s = Ustrchr(buffer, ',');
1800   if (s == NULL) s = buffer + Ustrlen(buffer);
1801
1802   Ustrncpy(format, buffer, s - buffer);
1803   format[s-buffer] = 0;
1804
1805   if (*s == ',') s++;
1806
1807   while (*s != 0)
1808     {
1809     uschar *ss = s;
1810     s = Ustrchr(ss, ',');
1811     if (s == NULL) s = ss + Ustrlen(ss);
1812
1813     if (isdigit(*ss))
1814       {
1815       Ustrncpy(outbuf, ss, s-ss);
1816       if (Ustrchr(outbuf, '.') != NULL)
1817         {
1818         dflag = 1;
1819         dargs[n++] = Ustrtod(outbuf, NULL);
1820         }
1821       else if (Ustrstr(outbuf, "ll") != NULL)
1822         {
1823         llflag = 1;
1824         llargs[n++] = strtoull(CS outbuf, NULL, 10);
1825         }
1826       else
1827         {
1828         args[n++] = (void *)Uatoi(outbuf);
1829         }
1830       }
1831
1832     else if (Ustrcmp(ss, "*") == 0)
1833       {
1834       args[n++] = (void *)(&count);
1835       countset = 1;
1836       }
1837
1838     else
1839       {
1840       uschar *sss = malloc(s - ss + 1);
1841       Ustrncpy(sss, ss, s-ss);
1842       args[n++] = sss;
1843       }
1844
1845     if (*s == ',') s++;
1846     }
1847
1848   if (!dflag && !llflag)
1849     printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1850       args[0], args[1], args[2])? "True" : "False");
1851
1852   else if (dflag)
1853     printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1854       dargs[0], dargs[1], dargs[2])? "True" : "False");
1855
1856   else printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1857     llargs[0], llargs[1], llargs[2])? "True" : "False");
1858
1859   printf("%s\n", CS outbuf);
1860   if (countset) printf("count=%d\n", count);
1861   }
1862
1863 return 0;
1864 }
1865 #endif
1866
1867 /* End of string.c */