]> sjero.net Git - wget/blob - src/utils.c
[svn] Rewrite with_thousand_seps to be size-agnostic. Remove printing of separators
[wget] / src / utils.c
1 /* Various utility functions.
2    Copyright (C) 2005 Free Software Foundation, Inc.
3
4 This file is part of GNU Wget.
5
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables.  You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL".  If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so.  If you do not wish to do
28 so, delete this exception statement from your version.  */
29
30 #include <config.h>
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <time.h>
36 #ifdef HAVE_SYS_TIME_H
37 # include <sys/time.h>
38 #endif
39 #ifdef HAVE_UNISTD_H
40 # include <unistd.h>
41 #endif
42 #ifdef HAVE_MMAP
43 # include <sys/mman.h>
44 #endif
45 #ifdef HAVE_PWD_H
46 # include <pwd.h>
47 #endif
48 #ifdef HAVE_UTIME_H
49 # include <utime.h>
50 #endif
51 #ifdef HAVE_SYS_UTIME_H
52 # include <sys/utime.h>
53 #endif
54 #include <errno.h>
55 #ifdef NeXT
56 # include <libc.h>              /* for access() */
57 #endif
58 #include <fcntl.h>
59 #include <assert.h>
60 #include <stdarg.h>
61 #ifdef HAVE_LOCALE_H
62 # include <locale.h>
63 #endif
64
65 /* For TIOCGWINSZ and friends: */
66 #ifdef HAVE_SYS_IOCTL_H
67 # include <sys/ioctl.h>
68 #endif
69 #ifdef HAVE_TERMIOS_H
70 # include <termios.h>
71 #endif
72
73 /* Needed for run_with_timeout. */
74 #include <signal.h>
75 #ifdef HAVE_SETJMP_H
76 # include <setjmp.h>
77 #endif
78
79 #ifndef HAVE_SIGSETJMP
80 /* If sigsetjmp is a macro, configure won't pick it up. */
81 # ifdef sigsetjmp
82 #  define HAVE_SIGSETJMP
83 # endif
84 #endif
85
86 #undef USE_SIGNAL_TIMEOUT
87 #if defined(HAVE_SIGSETJMP) || defined(HAVE_SIGBLOCK)
88 # define USE_SIGNAL_TIMEOUT
89 #endif
90
91 #include "wget.h"
92 #include "utils.h"
93 #include "hash.h"
94
95 /* Utility function: like xstrdup(), but also lowercases S.  */
96
97 char *
98 xstrdup_lower (const char *s)
99 {
100   char *copy = xstrdup (s);
101   char *p = copy;
102   for (; *p; p++)
103     *p = TOLOWER (*p);
104   return copy;
105 }
106
107 /* Copy the string formed by two pointers (one on the beginning, other
108    on the char after the last char) to a new, malloc-ed location.
109    0-terminate it.  */
110 char *
111 strdupdelim (const char *beg, const char *end)
112 {
113   char *res = xmalloc (end - beg + 1);
114   memcpy (res, beg, end - beg);
115   res[end - beg] = '\0';
116   return res;
117 }
118
119 /* Parse a string containing comma-separated elements, and return a
120    vector of char pointers with the elements.  Spaces following the
121    commas are ignored.  */
122 char **
123 sepstring (const char *s)
124 {
125   char **res;
126   const char *p;
127   int i = 0;
128
129   if (!s || !*s)
130     return NULL;
131   res = NULL;
132   p = s;
133   while (*s)
134     {
135       if (*s == ',')
136         {
137           res = xrealloc (res, (i + 2) * sizeof (char *));
138           res[i] = strdupdelim (p, s);
139           res[++i] = NULL;
140           ++s;
141           /* Skip the blanks following the ','.  */
142           while (ISSPACE (*s))
143             ++s;
144           p = s;
145         }
146       else
147         ++s;
148     }
149   res = xrealloc (res, (i + 2) * sizeof (char *));
150   res[i] = strdupdelim (p, s);
151   res[i + 1] = NULL;
152   return res;
153 }
154 \f
155 /* Like sprintf, but allocates a string of sufficient size with malloc
156    and returns it.  GNU libc has a similar function named asprintf,
157    which requires the pointer to the string to be passed.  */
158
159 char *
160 aprintf (const char *fmt, ...)
161 {
162   /* This function is implemented using vsnprintf, which we provide
163      for the systems that don't have it.  Therefore, it should be 100%
164      portable.  */
165
166   int size = 32;
167   char *str = xmalloc (size);
168
169   while (1)
170     {
171       int n;
172       va_list args;
173
174       /* See log_vprintf_internal for explanation why it's OK to rely
175          on the return value of vsnprintf.  */
176
177       va_start (args, fmt);
178       n = vsnprintf (str, size, fmt, args);
179       va_end (args);
180
181       /* If the printing worked, return the string. */
182       if (n > -1 && n < size)
183         return str;
184
185       /* Else try again with a larger buffer. */
186       if (n > -1)               /* C99 */
187         size = n + 1;           /* precisely what is needed */
188       else
189         size <<= 1;             /* twice the old size */
190       str = xrealloc (str, size);
191     }
192 }
193
194 /* Concatenate the NULL-terminated list of string arguments into
195    freshly allocated space.  */
196
197 char *
198 concat_strings (const char *str0, ...)
199 {
200   va_list args;
201   int saved_lengths[5];         /* inspired by Apache's apr_pstrcat */
202   char *ret, *p;
203
204   const char *next_str;
205   int total_length = 0;
206   int argcount;
207
208   /* Calculate the length of and allocate the resulting string. */
209
210   argcount = 0;
211   va_start (args, str0);
212   for (next_str = str0; next_str != NULL; next_str = va_arg (args, char *))
213     {
214       int len = strlen (next_str);
215       if (argcount < countof (saved_lengths))
216         saved_lengths[argcount++] = len;
217       total_length += len;
218     }
219   va_end (args);
220   p = ret = xmalloc (total_length + 1);
221
222   /* Copy the strings into the allocated space. */
223
224   argcount = 0;
225   va_start (args, str0);
226   for (next_str = str0; next_str != NULL; next_str = va_arg (args, char *))
227     {
228       int len;
229       if (argcount < countof (saved_lengths))
230         len = saved_lengths[argcount++];
231       else
232         len = strlen (next_str);
233       memcpy (p, next_str, len);
234       p += len;
235     }
236   va_end (args);
237   *p = '\0';
238
239   return ret;
240 }
241 \f
242 /* Return pointer to a static char[] buffer in which zero-terminated
243    string-representation of TM (in form hh:mm:ss) is printed.
244
245    If TM is NULL, the current time will be used.  */
246
247 char *
248 time_str (time_t *tm)
249 {
250   static char output[15];
251   struct tm *ptm;
252   time_t secs = tm ? *tm : time (NULL);
253
254   if (secs == -1)
255     {
256       /* In case of error, return the empty string.  Maybe we should
257          just abort if this happens?  */
258       *output = '\0';
259       return output;
260     }
261   ptm = localtime (&secs);
262   sprintf (output, "%02d:%02d:%02d", ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
263   return output;
264 }
265
266 /* Like the above, but include the date: YYYY-MM-DD hh:mm:ss.  */
267
268 char *
269 datetime_str (time_t *tm)
270 {
271   static char output[20];       /* "YYYY-MM-DD hh:mm:ss" + \0 */
272   struct tm *ptm;
273   time_t secs = tm ? *tm : time (NULL);
274
275   if (secs == -1)
276     {
277       /* In case of error, return the empty string.  Maybe we should
278          just abort if this happens?  */
279       *output = '\0';
280       return output;
281     }
282   ptm = localtime (&secs);
283   sprintf (output, "%04d-%02d-%02d %02d:%02d:%02d",
284            ptm->tm_year + 1900, ptm->tm_mon + 1, ptm->tm_mday,
285            ptm->tm_hour, ptm->tm_min, ptm->tm_sec);
286   return output;
287 }
288 \f
289 /* The Windows versions of the following two functions are defined in
290    mswindows.c.  */
291
292 #ifndef WINDOWS
293 void
294 fork_to_background (void)
295 {
296   pid_t pid;
297   /* Whether we arrange our own version of opt.lfilename here.  */
298   bool logfile_changed = false;
299
300   if (!opt.lfilename)
301     {
302       /* We must create the file immediately to avoid either a race
303          condition (which arises from using unique_name and failing to
304          use fopen_excl) or lying to the user about the log file name
305          (which arises from using unique_name, printing the name, and
306          using fopen_excl later on.)  */
307       FILE *new_log_fp = unique_create (DEFAULT_LOGFILE, false, &opt.lfilename);
308       if (new_log_fp)
309         {
310           logfile_changed = true;
311           fclose (new_log_fp);
312         }
313     }
314   pid = fork ();
315   if (pid < 0)
316     {
317       /* parent, error */
318       perror ("fork");
319       exit (1);
320     }
321   else if (pid != 0)
322     {
323       /* parent, no error */
324       printf (_("Continuing in background, pid %d.\n"), (int) pid);
325       if (logfile_changed)
326         printf (_("Output will be written to `%s'.\n"), opt.lfilename);
327       exit (0);                 /* #### should we use _exit()? */
328     }
329
330   /* child: give up the privileges and keep running. */
331   setsid ();
332   freopen ("/dev/null", "r", stdin);
333   freopen ("/dev/null", "w", stdout);
334   freopen ("/dev/null", "w", stderr);
335 }
336 #endif /* not WINDOWS */
337 \f
338 /* "Touch" FILE, i.e. make its mtime ("modified time") equal the time
339    specified with TM.  The atime ("access time") is set to the current
340    time.  */
341
342 void
343 touch (const char *file, time_t tm)
344 {
345 #ifdef HAVE_STRUCT_UTIMBUF
346   struct utimbuf times;
347 #else
348   struct {
349     time_t actime;
350     time_t modtime;
351   } times;
352 #endif
353   times.modtime = tm;
354   times.actime = time (NULL);
355   if (utime (file, &times) == -1)
356     logprintf (LOG_NOTQUIET, "utime(%s): %s\n", file, strerror (errno));
357 }
358
359 /* Checks if FILE is a symbolic link, and removes it if it is.  Does
360    nothing under MS-Windows.  */
361 int
362 remove_link (const char *file)
363 {
364   int err = 0;
365   struct_stat st;
366
367   if (lstat (file, &st) == 0 && S_ISLNK (st.st_mode))
368     {
369       DEBUGP (("Unlinking %s (symlink).\n", file));
370       err = unlink (file);
371       if (err != 0)
372         logprintf (LOG_VERBOSE, _("Failed to unlink symlink `%s': %s\n"),
373                    file, strerror (errno));
374     }
375   return err;
376 }
377
378 /* Does FILENAME exist?  This is quite a lousy implementation, since
379    it supplies no error codes -- only a yes-or-no answer.  Thus it
380    will return that a file does not exist if, e.g., the directory is
381    unreadable.  I don't mind it too much currently, though.  The
382    proper way should, of course, be to have a third, error state,
383    other than true/false, but that would introduce uncalled-for
384    additional complexity to the callers.  */
385 bool
386 file_exists_p (const char *filename)
387 {
388 #ifdef HAVE_ACCESS
389   return access (filename, F_OK) >= 0;
390 #else
391   struct_stat buf;
392   return stat (filename, &buf) >= 0;
393 #endif
394 }
395
396 /* Returns 0 if PATH is a directory, 1 otherwise (any kind of file).
397    Returns 0 on error.  */
398 bool
399 file_non_directory_p (const char *path)
400 {
401   struct_stat buf;
402   /* Use lstat() rather than stat() so that symbolic links pointing to
403      directories can be identified correctly.  */
404   if (lstat (path, &buf) != 0)
405     return false;
406   return S_ISDIR (buf.st_mode) ? false : true;
407 }
408
409 /* Return the size of file named by FILENAME, or -1 if it cannot be
410    opened or seeked into. */
411 wgint
412 file_size (const char *filename)
413 {
414 #if defined(HAVE_FSEEKO) && defined(HAVE_FTELLO)
415   wgint size;
416   /* We use fseek rather than stat to determine the file size because
417      that way we can also verify that the file is readable without
418      explicitly checking for permissions.  Inspired by the POST patch
419      by Arnaud Wylie.  */
420   FILE *fp = fopen (filename, "rb");
421   if (!fp)
422     return -1;
423   fseeko (fp, 0, SEEK_END);
424   size = ftello (fp);
425   fclose (fp);
426   return size;
427 #else
428   struct_stat st;
429   if (stat (filename, &st) < 0)
430     return -1;
431   return st.st_size;
432 #endif
433 }
434
435 /* stat file names named PREFIX.1, PREFIX.2, etc., until one that
436    doesn't exist is found.  Return a freshly allocated copy of the
437    unused file name.  */
438
439 static char *
440 unique_name_1 (const char *prefix)
441 {
442   int count = 1;
443   int plen = strlen (prefix);
444   char *template = (char *)alloca (plen + 1 + 24);
445   char *template_tail = template + plen;
446
447   memcpy (template, prefix, plen);
448   *template_tail++ = '.';
449
450   do
451     number_to_string (template_tail, count++);
452   while (file_exists_p (template));
453
454   return xstrdup (template);
455 }
456
457 /* Return a unique file name, based on FILE.
458
459    More precisely, if FILE doesn't exist, it is returned unmodified.
460    If not, FILE.1 is tried, then FILE.2, etc.  The first FILE.<number>
461    file name that doesn't exist is returned.
462
463    The resulting file is not created, only verified that it didn't
464    exist at the point in time when the function was called.
465    Therefore, where security matters, don't rely that the file created
466    by this function exists until you open it with O_EXCL or
467    equivalent.
468
469    If ALLOW_PASSTHROUGH is 0, it always returns a freshly allocated
470    string.  Otherwise, it may return FILE if the file doesn't exist
471    (and therefore doesn't need changing).  */
472
473 char *
474 unique_name (const char *file, bool allow_passthrough)
475 {
476   /* If the FILE itself doesn't exist, return it without
477      modification. */
478   if (!file_exists_p (file))
479     return allow_passthrough ? (char *)file : xstrdup (file);
480
481   /* Otherwise, find a numeric suffix that results in unused file name
482      and return it.  */
483   return unique_name_1 (file);
484 }
485
486 /* Create a file based on NAME, except without overwriting an existing
487    file with that name.  Providing O_EXCL is correctly implemented,
488    this function does not have the race condition associated with
489    opening the file returned by unique_name.  */
490
491 FILE *
492 unique_create (const char *name, bool binary, char **opened_name)
493 {
494   /* unique file name, based on NAME */
495   char *uname = unique_name (name, false);
496   FILE *fp;
497   while ((fp = fopen_excl (uname, binary)) == NULL && errno == EEXIST)
498     {
499       xfree (uname);
500       uname = unique_name (name, false);
501     }
502   if (opened_name && fp != NULL)
503     {
504       if (fp)
505         *opened_name = uname;
506       else
507         {
508           *opened_name = NULL;
509           xfree (uname);
510         }
511     }
512   else
513     xfree (uname);
514   return fp;
515 }
516
517 /* Open the file for writing, with the addition that the file is
518    opened "exclusively".  This means that, if the file already exists,
519    this function will *fail* and errno will be set to EEXIST.  If
520    BINARY is set, the file will be opened in binary mode, equivalent
521    to fopen's "wb".
522
523    If opening the file fails for any reason, including the file having
524    previously existed, this function returns NULL and sets errno
525    appropriately.  */
526    
527 FILE *
528 fopen_excl (const char *fname, bool binary)
529 {
530   int fd;
531 #ifdef O_EXCL
532   int flags = O_WRONLY | O_CREAT | O_EXCL;
533 # ifdef O_BINARY
534   if (binary)
535     flags |= O_BINARY;
536 # endif
537   fd = open (fname, flags, 0666);
538   if (fd < 0)
539     return NULL;
540   return fdopen (fd, binary ? "wb" : "w");
541 #else  /* not O_EXCL */
542   /* Manually check whether the file exists.  This is prone to race
543      conditions, but systems without O_EXCL haven't deserved
544      better.  */
545   if (file_exists_p (fname))
546     {
547       errno = EEXIST;
548       return NULL;
549     }
550   return fopen (fname, binary ? "wb" : "w");
551 #endif /* not O_EXCL */
552 }
553 \f
554 /* Create DIRECTORY.  If some of the pathname components of DIRECTORY
555    are missing, create them first.  In case any mkdir() call fails,
556    return its error status.  Returns 0 on successful completion.
557
558    The behaviour of this function should be identical to the behaviour
559    of `mkdir -p' on systems where mkdir supports the `-p' option.  */
560 int
561 make_directory (const char *directory)
562 {
563   int i, ret, quit = 0;
564   char *dir;
565
566   /* Make a copy of dir, to be able to write to it.  Otherwise, the
567      function is unsafe if called with a read-only char *argument.  */
568   STRDUP_ALLOCA (dir, directory);
569
570   /* If the first character of dir is '/', skip it (and thus enable
571      creation of absolute-pathname directories.  */
572   for (i = (*dir == '/'); 1; ++i)
573     {
574       for (; dir[i] && dir[i] != '/'; i++)
575         ;
576       if (!dir[i])
577         quit = 1;
578       dir[i] = '\0';
579       /* Check whether the directory already exists.  Allow creation of
580          of intermediate directories to fail, as the initial path components
581          are not necessarily directories!  */
582       if (!file_exists_p (dir))
583         ret = mkdir (dir, 0777);
584       else
585         ret = 0;
586       if (quit)
587         break;
588       else
589         dir[i] = '/';
590     }
591   return ret;
592 }
593
594 /* Merge BASE with FILE.  BASE can be a directory or a file name, FILE
595    should be a file name.
596
597    file_merge("/foo/bar", "baz")  => "/foo/baz"
598    file_merge("/foo/bar/", "baz") => "/foo/bar/baz"
599    file_merge("foo", "bar")       => "bar"
600
601    In other words, it's a simpler and gentler version of uri_merge_1.  */
602
603 char *
604 file_merge (const char *base, const char *file)
605 {
606   char *result;
607   const char *cut = (const char *)strrchr (base, '/');
608
609   if (!cut)
610     return xstrdup (file);
611
612   result = xmalloc (cut - base + 1 + strlen (file) + 1);
613   memcpy (result, base, cut - base);
614   result[cut - base] = '/';
615   strcpy (result + (cut - base) + 1, file);
616
617   return result;
618 }
619 \f
620 static bool in_acclist (const char *const *, const char *, bool);
621
622 /* Determine whether a file is acceptable to be followed, according to
623    lists of patterns to accept/reject.  */
624 bool
625 acceptable (const char *s)
626 {
627   int l = strlen (s);
628
629   while (l && s[l] != '/')
630     --l;
631   if (s[l] == '/')
632     s += (l + 1);
633   if (opt.accepts)
634     {
635       if (opt.rejects)
636         return (in_acclist ((const char *const *)opt.accepts, s, true)
637                 && !in_acclist ((const char *const *)opt.rejects, s, true));
638       else
639         return in_acclist ((const char *const *)opt.accepts, s, true);
640     }
641   else if (opt.rejects)
642     return !in_acclist ((const char *const *)opt.rejects, s, true);
643   return true;
644 }
645
646 /* Compare S1 and S2 frontally; S2 must begin with S1.  E.g. if S1 is
647    `/something', frontcmp() will return 1 only if S2 begins with
648    `/something'.  Otherwise, 0 is returned.  */
649 bool
650 frontcmp (const char *s1, const char *s2)
651 {
652   for (; *s1 && *s2 && (*s1 == *s2); ++s1, ++s2);
653   return *s1 == '\0';
654 }
655
656 /* Iterate through STRLIST, and return the first element that matches
657    S, through wildcards or front comparison (as appropriate).  */
658 static char *
659 proclist (char **strlist, const char *s, enum accd flags)
660 {
661   char **x;
662   for (x = strlist; *x; x++)
663     {
664       /* Remove leading '/' if ALLABS */
665       char *p = *x + ((flags & ALLABS) && (**x == '/'));
666       if (has_wildcards_p (p))
667         {
668           if (fnmatch (p, s, FNM_PATHNAME) == 0)
669             break;
670         }
671       else
672         {
673           if (frontcmp (p, s))
674             break;
675         }
676     }
677   return *x;
678 }
679
680 /* Returns whether DIRECTORY is acceptable for download, wrt the
681    include/exclude lists.
682
683    If FLAGS is ALLABS, the leading `/' is ignored in paths; relative
684    and absolute paths may be freely intermixed.  */
685 bool
686 accdir (const char *directory, enum accd flags)
687 {
688   /* Remove starting '/'.  */
689   if (flags & ALLABS && *directory == '/')
690     ++directory;
691   if (opt.includes)
692     {
693       if (!proclist (opt.includes, directory, flags))
694         return false;
695     }
696   if (opt.excludes)
697     {
698       if (proclist (opt.excludes, directory, flags))
699         return false;
700     }
701   return true;
702 }
703
704 /* Return true if STRING ends with TAIL.  For instance:
705
706    match_tail ("abc", "bc", false)  -> 1
707    match_tail ("abc", "ab", false)  -> 0
708    match_tail ("abc", "abc", false) -> 1
709
710    If FOLD_CASE is true, the comparison will be case-insensitive.  */
711
712 bool
713 match_tail (const char *string, const char *tail, bool fold_case)
714 {
715   int i, j;
716
717   /* We want this to be fast, so we code two loops, one with
718      case-folding, one without. */
719
720   if (!fold_case)
721     {
722       for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
723         if (string[i] != tail[j])
724           break;
725     }
726   else
727     {
728       for (i = strlen (string), j = strlen (tail); i >= 0 && j >= 0; i--, j--)
729         if (TOLOWER (string[i]) != TOLOWER (tail[j]))
730           break;
731     }
732
733   /* If the tail was exhausted, the match was succesful.  */
734   if (j == -1)
735     return true;
736   else
737     return false;
738 }
739
740 /* Checks whether string S matches each element of ACCEPTS.  A list
741    element are matched either with fnmatch() or match_tail(),
742    according to whether the element contains wildcards or not.
743
744    If the BACKWARD is false, don't do backward comparison -- just compare
745    them normally.  */
746 static bool
747 in_acclist (const char *const *accepts, const char *s, bool backward)
748 {
749   for (; *accepts; accepts++)
750     {
751       if (has_wildcards_p (*accepts))
752         {
753           /* fnmatch returns 0 if the pattern *does* match the
754              string.  */
755           if (fnmatch (*accepts, s, 0) == 0)
756             return true;
757         }
758       else
759         {
760           if (backward)
761             {
762               if (match_tail (s, *accepts, 0))
763                 return true;
764             }
765           else
766             {
767               if (!strcmp (s, *accepts))
768                 return true;
769             }
770         }
771     }
772   return false;
773 }
774
775 /* Return the location of STR's suffix (file extension).  Examples:
776    suffix ("foo.bar")       -> "bar"
777    suffix ("foo.bar.baz")   -> "baz"
778    suffix ("/foo/bar")      -> NULL
779    suffix ("/foo.bar/baz")  -> NULL  */
780 char *
781 suffix (const char *str)
782 {
783   int i;
784
785   for (i = strlen (str); i && str[i] != '/' && str[i] != '.'; i--)
786     ;
787
788   if (str[i++] == '.')
789     return (char *)str + i;
790   else
791     return NULL;
792 }
793
794 /* Return true if S contains globbing wildcards (`*', `?', `[' or
795    `]').  */
796
797 bool
798 has_wildcards_p (const char *s)
799 {
800   for (; *s; s++)
801     if (*s == '*' || *s == '?' || *s == '[' || *s == ']')
802       return true;
803   return false;
804 }
805
806 /* Return true if FNAME ends with a typical HTML suffix.  The
807    following (case-insensitive) suffixes are presumed to be HTML
808    files:
809    
810      html
811      htm
812      ?html (`?' matches one character)
813
814    #### CAVEAT.  This is not necessarily a good indication that FNAME
815    refers to a file that contains HTML!  */
816 bool
817 has_html_suffix_p (const char *fname)
818 {
819   char *suf;
820
821   if ((suf = suffix (fname)) == NULL)
822     return false;
823   if (!strcasecmp (suf, "html"))
824     return true;
825   if (!strcasecmp (suf, "htm"))
826     return true;
827   if (suf[0] && !strcasecmp (suf + 1, "html"))
828     return true;
829   return false;
830 }
831
832 /* Read a line from FP and return the pointer to freshly allocated
833    storage.  The storage space is obtained through malloc() and should
834    be freed with free() when it is no longer needed.
835
836    The length of the line is not limited, except by available memory.
837    The newline character at the end of line is retained.  The line is
838    terminated with a zero character.
839
840    After end-of-file is encountered without anything being read, NULL
841    is returned.  NULL is also returned on error.  To distinguish
842    between these two cases, use the stdio function ferror().  */
843
844 char *
845 read_whole_line (FILE *fp)
846 {
847   int length = 0;
848   int bufsize = 82;
849   char *line = xmalloc (bufsize);
850
851   while (fgets (line + length, bufsize - length, fp))
852     {
853       length += strlen (line + length);
854       if (length == 0)
855         /* Possible for example when reading from a binary file where
856            a line begins with \0.  */
857         continue;
858
859       if (line[length - 1] == '\n')
860         break;
861
862       /* fgets() guarantees to read the whole line, or to use up the
863          space we've given it.  We can double the buffer
864          unconditionally.  */
865       bufsize <<= 1;
866       line = xrealloc (line, bufsize);
867     }
868   if (length == 0 || ferror (fp))
869     {
870       xfree (line);
871       return NULL;
872     }
873   if (length + 1 < bufsize)
874     /* Relieve the memory from our exponential greediness.  We say
875        `length + 1' because the terminating \0 is not included in
876        LENGTH.  We don't need to zero-terminate the string ourselves,
877        though, because fgets() does that.  */
878     line = xrealloc (line, length + 1);
879   return line;
880 }
881 \f
882 /* Read FILE into memory.  A pointer to `struct file_memory' are
883    returned; use struct element `content' to access file contents, and
884    the element `length' to know the file length.  `content' is *not*
885    zero-terminated, and you should *not* read or write beyond the [0,
886    length) range of characters.
887
888    After you are done with the file contents, call read_file_free to
889    release the memory.
890
891    Depending on the operating system and the type of file that is
892    being read, read_file() either mmap's the file into memory, or
893    reads the file into the core using read().
894
895    If file is named "-", fileno(stdin) is used for reading instead.
896    If you want to read from a real file named "-", use "./-" instead.  */
897
898 struct file_memory *
899 read_file (const char *file)
900 {
901   int fd;
902   struct file_memory *fm;
903   long size;
904   bool inhibit_close = false;
905
906   /* Some magic in the finest tradition of Perl and its kin: if FILE
907      is "-", just use stdin.  */
908   if (HYPHENP (file))
909     {
910       fd = fileno (stdin);
911       inhibit_close = true;
912       /* Note that we don't inhibit mmap() in this case.  If stdin is
913          redirected from a regular file, mmap() will still work.  */
914     }
915   else
916     fd = open (file, O_RDONLY);
917   if (fd < 0)
918     return NULL;
919   fm = xnew (struct file_memory);
920
921 #ifdef HAVE_MMAP
922   {
923     struct_fstat buf;
924     if (fstat (fd, &buf) < 0)
925       goto mmap_lose;
926     fm->length = buf.st_size;
927     /* NOTE: As far as I know, the callers of this function never
928        modify the file text.  Relying on this would enable us to
929        specify PROT_READ and MAP_SHARED for a marginal gain in
930        efficiency, but at some cost to generality.  */
931     fm->content = mmap (NULL, fm->length, PROT_READ | PROT_WRITE,
932                         MAP_PRIVATE, fd, 0);
933     if (fm->content == (char *)MAP_FAILED)
934       goto mmap_lose;
935     if (!inhibit_close)
936       close (fd);
937
938     fm->mmap_p = 1;
939     return fm;
940   }
941
942  mmap_lose:
943   /* The most common reason why mmap() fails is that FD does not point
944      to a plain file.  However, it's also possible that mmap() doesn't
945      work for a particular type of file.  Therefore, whenever mmap()
946      fails, we just fall back to the regular method.  */
947 #endif /* HAVE_MMAP */
948
949   fm->length = 0;
950   size = 512;                   /* number of bytes fm->contents can
951                                    hold at any given time. */
952   fm->content = xmalloc (size);
953   while (1)
954     {
955       wgint nread;
956       if (fm->length > size / 2)
957         {
958           /* #### I'm not sure whether the whole exponential-growth
959              thing makes sense with kernel read.  On Linux at least,
960              read() refuses to read more than 4K from a file at a
961              single chunk anyway.  But other Unixes might optimize it
962              better, and it doesn't *hurt* anything, so I'm leaving
963              it.  */
964
965           /* Normally, we grow SIZE exponentially to make the number
966              of calls to read() and realloc() logarithmic in relation
967              to file size.  However, read() can read an amount of data
968              smaller than requested, and it would be unreasonable to
969              double SIZE every time *something* was read.  Therefore,
970              we double SIZE only when the length exceeds half of the
971              entire allocated size.  */
972           size <<= 1;
973           fm->content = xrealloc (fm->content, size);
974         }
975       nread = read (fd, fm->content + fm->length, size - fm->length);
976       if (nread > 0)
977         /* Successful read. */
978         fm->length += nread;
979       else if (nread < 0)
980         /* Error. */
981         goto lose;
982       else
983         /* EOF */
984         break;
985     }
986   if (!inhibit_close)
987     close (fd);
988   if (size > fm->length && fm->length != 0)
989     /* Due to exponential growth of fm->content, the allocated region
990        might be much larger than what is actually needed.  */
991     fm->content = xrealloc (fm->content, fm->length);
992   fm->mmap_p = 0;
993   return fm;
994
995  lose:
996   if (!inhibit_close)
997     close (fd);
998   xfree (fm->content);
999   xfree (fm);
1000   return NULL;
1001 }
1002
1003 /* Release the resources held by FM.  Specifically, this calls
1004    munmap() or xfree() on fm->content, depending whether mmap or
1005    malloc/read were used to read in the file.  It also frees the
1006    memory needed to hold the FM structure itself.  */
1007
1008 void
1009 read_file_free (struct file_memory *fm)
1010 {
1011 #ifdef HAVE_MMAP
1012   if (fm->mmap_p)
1013     {
1014       munmap (fm->content, fm->length);
1015     }
1016   else
1017 #endif
1018     {
1019       xfree (fm->content);
1020     }
1021   xfree (fm);
1022 }
1023 \f
1024 /* Free the pointers in a NULL-terminated vector of pointers, then
1025    free the pointer itself.  */
1026 void
1027 free_vec (char **vec)
1028 {
1029   if (vec)
1030     {
1031       char **p = vec;
1032       while (*p)
1033         xfree (*p++);
1034       xfree (vec);
1035     }
1036 }
1037
1038 /* Append vector V2 to vector V1.  The function frees V2 and
1039    reallocates V1 (thus you may not use the contents of neither
1040    pointer after the call).  If V1 is NULL, V2 is returned.  */
1041 char **
1042 merge_vecs (char **v1, char **v2)
1043 {
1044   int i, j;
1045
1046   if (!v1)
1047     return v2;
1048   if (!v2)
1049     return v1;
1050   if (!*v2)
1051     {
1052       /* To avoid j == 0 */
1053       xfree (v2);
1054       return v1;
1055     }
1056   /* Count v1.  */
1057   for (i = 0; v1[i]; i++);
1058   /* Count v2.  */
1059   for (j = 0; v2[j]; j++);
1060   /* Reallocate v1.  */
1061   v1 = xrealloc (v1, (i + j + 1) * sizeof (char **));
1062   memcpy (v1 + i, v2, (j + 1) * sizeof (char *));
1063   xfree (v2);
1064   return v1;
1065 }
1066
1067 /* Append a freshly allocated copy of STR to VEC.  If VEC is NULL, it
1068    is allocated as needed.  Return the new value of the vector. */
1069
1070 char **
1071 vec_append (char **vec, const char *str)
1072 {
1073   int cnt;                      /* count of vector elements, including
1074                                    the one we're about to append */
1075   if (vec != NULL)
1076     {
1077       for (cnt = 0; vec[cnt]; cnt++)
1078         ;
1079       ++cnt;
1080     }
1081   else
1082     cnt = 1;
1083   /* Reallocate the array to fit the new element and the NULL. */
1084   vec = xrealloc (vec, (cnt + 1) * sizeof (char *));
1085   /* Append a copy of STR to the vector. */
1086   vec[cnt - 1] = xstrdup (str);
1087   vec[cnt] = NULL;
1088   return vec;
1089 }
1090 \f
1091 /* Sometimes it's useful to create "sets" of strings, i.e. special
1092    hash tables where you want to store strings as keys and merely
1093    query for their existence.  Here is a set of utility routines that
1094    makes that transparent.  */
1095
1096 void
1097 string_set_add (struct hash_table *ht, const char *s)
1098 {
1099   /* First check whether the set element already exists.  If it does,
1100      do nothing so that we don't have to free() the old element and
1101      then strdup() a new one.  */
1102   if (hash_table_contains (ht, s))
1103     return;
1104
1105   /* We use "1" as value.  It provides us a useful and clear arbitrary
1106      value, and it consumes no memory -- the pointers to the same
1107      string "1" will be shared by all the key-value pairs in all `set'
1108      hash tables.  */
1109   hash_table_put (ht, xstrdup (s), "1");
1110 }
1111
1112 /* Synonym for hash_table_contains... */
1113
1114 int
1115 string_set_contains (struct hash_table *ht, const char *s)
1116 {
1117   return hash_table_contains (ht, s);
1118 }
1119
1120 static int
1121 string_set_to_array_mapper (void *key, void *value_ignored, void *arg)
1122 {
1123   char ***arrayptr = (char ***) arg;
1124   *(*arrayptr)++ = (char *) key;
1125   return 0;
1126 }
1127
1128 /* Convert the specified string set to array.  ARRAY should be large
1129    enough to hold hash_table_count(ht) char pointers.  */
1130
1131 void string_set_to_array (struct hash_table *ht, char **array)
1132 {
1133   hash_table_map (ht, string_set_to_array_mapper, &array);
1134 }
1135
1136 static int
1137 string_set_free_mapper (void *key, void *value_ignored, void *arg_ignored)
1138 {
1139   xfree (key);
1140   return 0;
1141 }
1142
1143 void
1144 string_set_free (struct hash_table *ht)
1145 {
1146   hash_table_map (ht, string_set_free_mapper, NULL);
1147   hash_table_destroy (ht);
1148 }
1149
1150 static int
1151 free_keys_and_values_mapper (void *key, void *value, void *arg_ignored)
1152 {
1153   xfree (key);
1154   xfree (value);
1155   return 0;
1156 }
1157
1158 /* Another utility function: call free() on all keys and values of HT.  */
1159
1160 void
1161 free_keys_and_values (struct hash_table *ht)
1162 {
1163   hash_table_map (ht, free_keys_and_values_mapper, NULL);
1164 }
1165
1166 \f
1167 /* Return a printed representation of N with thousand separators.
1168    This should respect locale settings, with the exception of the "C"
1169    locale which mandates no separator, but we use one anyway.
1170
1171    Unfortunately, we cannot use %'d (in fact it would be %'j) to get
1172    the separators because it's too non-portable, and it's hard to test
1173    for this feature at configure time.  Besides, it wouldn't work in
1174    the "C" locale, which many Unix users still work in.  */
1175
1176 const char *
1177 with_thousand_seps (wgint n)
1178 {
1179   static char outbuf[48];
1180
1181   static char loc_sepchar;
1182   static const char *loc_grouping;
1183
1184   int i = 0, groupsize;
1185   char *p;
1186   const char *atgroup;
1187
1188   if (!loc_sepchar)
1189     {
1190 #ifdef LC_NUMERIC
1191       /* Get the grouping character from the locale. */
1192       struct lconv *lconv;
1193       const char *oldlocale = setlocale (LC_NUMERIC, "");
1194       lconv = localeconv ();
1195       loc_sepchar = *lconv->thousands_sep;
1196       loc_grouping = xstrdup (lconv->grouping);
1197       /* Restore the C locale semantics of printing and reading numbers */
1198       setlocale (LC_NUMERIC, oldlocale);
1199       if (!loc_sepchar)
1200 #endif
1201         /* defaults for C locale or no locale */
1202         loc_sepchar = ',', loc_grouping = "\x03";
1203     }
1204   atgroup = loc_grouping;
1205
1206   p = outbuf + sizeof outbuf;
1207   *--p = '\0';
1208   groupsize = *atgroup++;
1209
1210   while (1)
1211     {
1212       *--p = n % 10 + '0';
1213       n /= 10;
1214       if (n == 0)
1215         break;
1216       /* Insert the separator on every groupsize'd digit, and get the
1217          new groupsize.  */
1218       if (++i == groupsize)
1219         {
1220           *--p = loc_sepchar;
1221           i = 0;
1222           if (*atgroup)
1223             groupsize = *atgroup++;
1224         }
1225     }
1226   return p;
1227 }
1228
1229 /* N, a byte quantity, is converted to a human-readable abberviated
1230    form a la sizes printed by `ls -lh'.  The result is written to a
1231    static buffer, a pointer to which is returned.
1232
1233    Unlike `with_thousand_seps', this approximates to the nearest unit.
1234    Quoting GNU libit: "Most people visually process strings of 3-4
1235    digits effectively, but longer strings of digits are more prone to
1236    misinterpretation.  Hence, converting to an abbreviated form
1237    usually improves readability."
1238
1239    This intentionally uses kilobyte (KB), megabyte (MB), etc. in their
1240    original computer-related meaning of "powers of 1024".  Powers of
1241    1000 would be useless since Wget already displays sizes with
1242    thousand separators.  We don't use the "*bibyte" names invented in
1243    1998, and seldom used in practice.  Wikipedia's entry on kilobyte
1244    discusses this in some detail.  */
1245
1246 char *
1247 human_readable (HR_NUMTYPE n)
1248 {
1249   /* These suffixes are compatible with those of GNU `ls -lh'. */
1250   static char powers[] =
1251     {
1252       'K',                      /* kilobyte, 2^10 bytes */
1253       'M',                      /* megabyte, 2^20 bytes */
1254       'G',                      /* gigabyte, 2^30 bytes */
1255       'T',                      /* terabyte, 2^40 bytes */
1256       'P',                      /* petabyte, 2^50 bytes */
1257       'E',                      /* exabyte,  2^60 bytes */
1258     };
1259   static char buf[8];
1260   int i;
1261
1262   /* If the quantity is smaller than 1K, just print it. */
1263   if (n < 1024)
1264     {
1265       snprintf (buf, sizeof (buf), "%d", (int) n);
1266       return buf;
1267     }
1268
1269   /* Loop over powers, dividing N with 1024 in each iteration.  This
1270      works unchanged for all sizes of wgint, while still avoiding
1271      non-portable `long double' arithmetic.  */
1272   for (i = 0; i < countof (powers); i++)
1273     {
1274       /* At each iteration N is greater than the *subsequent* power.
1275          That way N/1024.0 produces a decimal number in the units of
1276          *this* power.  */
1277       if ((n / 1024) < 1024 || i == countof (powers) - 1)
1278         {
1279           /* Must cast to long first because MS VC can't directly cast
1280              __int64 to double.  (This is safe because N is known to
1281              be < 1024^2, so always fits into long.)  */
1282           double val = (double) (long) n / 1024.0;
1283           /* Print values smaller than 10 with one decimal digits, and
1284              others without any decimals.  */
1285           snprintf (buf, sizeof (buf), "%.*f%c",
1286                     val < 10 ? 1 : 0, val, powers[i]);
1287           return buf;
1288         }
1289       n /= 1024;
1290     }
1291   return NULL;                  /* unreached */
1292 }
1293
1294 /* Count the digits in the provided number.  Used to allocate space
1295    when printing numbers.  */
1296
1297 int
1298 numdigit (wgint number)
1299 {
1300   int cnt = 1;
1301   if (number < 0)
1302     ++cnt;                      /* accomodate '-' */
1303   while ((number /= 10) != 0)
1304     ++cnt;
1305   return cnt;
1306 }
1307
1308 #define PR(mask) *p++ = n / (mask) + '0'
1309
1310 /* DIGITS_<D> is used to print a D-digit number and should be called
1311    with mask==10^(D-1).  It prints n/mask (the first digit), reducing
1312    n to n%mask (the remaining digits), and calling DIGITS_<D-1>.
1313    Recursively this continues until DIGITS_1 is invoked.  */
1314
1315 #define DIGITS_1(mask) PR (mask)
1316 #define DIGITS_2(mask) PR (mask), n %= (mask), DIGITS_1 ((mask) / 10)
1317 #define DIGITS_3(mask) PR (mask), n %= (mask), DIGITS_2 ((mask) / 10)
1318 #define DIGITS_4(mask) PR (mask), n %= (mask), DIGITS_3 ((mask) / 10)
1319 #define DIGITS_5(mask) PR (mask), n %= (mask), DIGITS_4 ((mask) / 10)
1320 #define DIGITS_6(mask) PR (mask), n %= (mask), DIGITS_5 ((mask) / 10)
1321 #define DIGITS_7(mask) PR (mask), n %= (mask), DIGITS_6 ((mask) / 10)
1322 #define DIGITS_8(mask) PR (mask), n %= (mask), DIGITS_7 ((mask) / 10)
1323 #define DIGITS_9(mask) PR (mask), n %= (mask), DIGITS_8 ((mask) / 10)
1324 #define DIGITS_10(mask) PR (mask), n %= (mask), DIGITS_9 ((mask) / 10)
1325
1326 /* DIGITS_<11-20> are only used on machines with 64-bit wgints. */
1327
1328 #define DIGITS_11(mask) PR (mask), n %= (mask), DIGITS_10 ((mask) / 10)
1329 #define DIGITS_12(mask) PR (mask), n %= (mask), DIGITS_11 ((mask) / 10)
1330 #define DIGITS_13(mask) PR (mask), n %= (mask), DIGITS_12 ((mask) / 10)
1331 #define DIGITS_14(mask) PR (mask), n %= (mask), DIGITS_13 ((mask) / 10)
1332 #define DIGITS_15(mask) PR (mask), n %= (mask), DIGITS_14 ((mask) / 10)
1333 #define DIGITS_16(mask) PR (mask), n %= (mask), DIGITS_15 ((mask) / 10)
1334 #define DIGITS_17(mask) PR (mask), n %= (mask), DIGITS_16 ((mask) / 10)
1335 #define DIGITS_18(mask) PR (mask), n %= (mask), DIGITS_17 ((mask) / 10)
1336 #define DIGITS_19(mask) PR (mask), n %= (mask), DIGITS_18 ((mask) / 10)
1337
1338 /* SPRINTF_WGINT is used by number_to_string to handle pathological
1339    cases and to portably support strange sizes of wgint.  Ideally this
1340    would just use "%j" and intmax_t, but many systems don't support
1341    it, so it's used only if nothing else works.  */
1342 #if SIZEOF_LONG >= SIZEOF_WGINT
1343 # define SPRINTF_WGINT(buf, n) sprintf (buf, "%ld", (long) (n))
1344 #elif SIZEOF_LONG_LONG >= SIZEOF_WGINT
1345 # define SPRINTF_WGINT(buf, n) sprintf (buf, "%lld", (long long) (n))
1346 #elif defined(WINDOWS)
1347 # define SPRINTF_WGINT(buf, n) sprintf (buf, "%I64d", (__int64) (n))
1348 #else
1349 # define SPRINTF_WGINT(buf, n) sprintf (buf, "%j", (intmax_t) (n))
1350 #endif
1351
1352 /* Shorthand for casting to wgint. */
1353 #define W wgint
1354
1355 /* Print NUMBER to BUFFER in base 10.  This is equivalent to
1356    `sprintf(buffer, "%lld", (long long) number)', only typically much
1357    faster and portable to machines without long long.
1358
1359    The speedup may make a difference in programs that frequently
1360    convert numbers to strings.  Some implementations of sprintf,
1361    particularly the one in GNU libc, have been known to be extremely
1362    slow when converting integers to strings.
1363
1364    Return the pointer to the location where the terminating zero was
1365    printed.  (Equivalent to calling buffer+strlen(buffer) after the
1366    function is done.)
1367
1368    BUFFER should be big enough to accept as many bytes as you expect
1369    the number to take up.  On machines with 64-bit longs the maximum
1370    needed size is 24 bytes.  That includes the digits needed for the
1371    largest 64-bit number, the `-' sign in case it's negative, and the
1372    terminating '\0'.  */
1373
1374 char *
1375 number_to_string (char *buffer, wgint number)
1376 {
1377   char *p = buffer;
1378   wgint n = number;
1379
1380 #if (SIZEOF_WGINT != 4) && (SIZEOF_WGINT != 8)
1381   /* We are running in a strange or misconfigured environment.  Let
1382      sprintf cope with it.  */
1383   SPRINTF_WGINT (buffer, n);
1384   p += strlen (buffer);
1385 #else  /* (SIZEOF_WGINT == 4) || (SIZEOF_WGINT == 8) */
1386
1387   if (n < 0)
1388     {
1389       if (n < -WGINT_MAX)
1390         {
1391           /* -n would overflow.  Have sprintf deal with this.  */
1392           SPRINTF_WGINT (buffer, n);
1393           p += strlen (buffer);
1394           return p;
1395         }
1396
1397       *p++ = '-';
1398       n = -n;
1399     }
1400
1401   /* Use the DIGITS_ macro appropriate for N's number of digits.  That
1402      way printing any N is fully open-coded without a loop or jump.
1403      (Also see description of DIGITS_*.)  */
1404
1405   if      (n < 10)                       DIGITS_1 (1);
1406   else if (n < 100)                      DIGITS_2 (10);
1407   else if (n < 1000)                     DIGITS_3 (100);
1408   else if (n < 10000)                    DIGITS_4 (1000);
1409   else if (n < 100000)                   DIGITS_5 (10000);
1410   else if (n < 1000000)                  DIGITS_6 (100000);
1411   else if (n < 10000000)                 DIGITS_7 (1000000);
1412   else if (n < 100000000)                DIGITS_8 (10000000);
1413   else if (n < 1000000000)               DIGITS_9 (100000000);
1414 #if SIZEOF_WGINT == 4
1415   /* wgint is 32 bits wide: no number has more than 10 digits. */
1416   else                                   DIGITS_10 (1000000000);
1417 #else
1418   /* wgint is 64 bits wide: handle numbers with 9-19 decimal digits.
1419      Constants are constructed by compile-time multiplication to avoid
1420      dealing with different notations for 64-bit constants
1421      (nL/nLL/nI64, depending on the compiler and architecture).  */
1422   else if (n < 10*(W)1000000000)         DIGITS_10 (1000000000);
1423   else if (n < 100*(W)1000000000)        DIGITS_11 (10*(W)1000000000);
1424   else if (n < 1000*(W)1000000000)       DIGITS_12 (100*(W)1000000000);
1425   else if (n < 10000*(W)1000000000)      DIGITS_13 (1000*(W)1000000000);
1426   else if (n < 100000*(W)1000000000)     DIGITS_14 (10000*(W)1000000000);
1427   else if (n < 1000000*(W)1000000000)    DIGITS_15 (100000*(W)1000000000);
1428   else if (n < 10000000*(W)1000000000)   DIGITS_16 (1000000*(W)1000000000);
1429   else if (n < 100000000*(W)1000000000)  DIGITS_17 (10000000*(W)1000000000);
1430   else if (n < 1000000000*(W)1000000000) DIGITS_18 (100000000*(W)1000000000);
1431   else                                   DIGITS_19 (1000000000*(W)1000000000);
1432 #endif
1433
1434   *p = '\0';
1435 #endif /* (SIZEOF_WGINT == 4) || (SIZEOF_WGINT == 8) */
1436
1437   return p;
1438 }
1439
1440 #undef PR
1441 #undef W
1442 #undef DIGITS_1
1443 #undef DIGITS_2
1444 #undef DIGITS_3
1445 #undef DIGITS_4
1446 #undef DIGITS_5
1447 #undef DIGITS_6
1448 #undef DIGITS_7
1449 #undef DIGITS_8
1450 #undef DIGITS_9
1451 #undef DIGITS_10
1452 #undef DIGITS_11
1453 #undef DIGITS_12
1454 #undef DIGITS_13
1455 #undef DIGITS_14
1456 #undef DIGITS_15
1457 #undef DIGITS_16
1458 #undef DIGITS_17
1459 #undef DIGITS_18
1460 #undef DIGITS_19
1461
1462 #define RING_SIZE 3
1463
1464 /* Print NUMBER to a statically allocated string and return a pointer
1465    to the printed representation.
1466
1467    This function is intended to be used in conjunction with printf.
1468    It is hard to portably print wgint values:
1469     a) you cannot use printf("%ld", number) because wgint can be long
1470        long on 32-bit machines with LFS.
1471     b) you cannot use printf("%lld", number) because NUMBER could be
1472        long on 32-bit machines without LFS, or on 64-bit machines,
1473        which do not require LFS.  Also, Windows doesn't support %lld.
1474     c) you cannot use printf("%j", (int_max_t) number) because not all
1475        versions of printf support "%j", the most notable being the one
1476        on Windows.
1477     d) you cannot #define WGINT_FMT to the appropriate format and use
1478        printf(WGINT_FMT, number) because that would break translations
1479        for user-visible messages, such as printf("Downloaded: %d
1480        bytes\n", number).
1481
1482    What you should use instead is printf("%s", number_to_static_string
1483    (number)).
1484
1485    CAVEAT: since the function returns pointers to static data, you
1486    must be careful to copy its result before calling it again.
1487    However, to make it more useful with printf, the function maintains
1488    an internal ring of static buffers to return.  That way things like
1489    printf("%s %s", number_to_static_string (num1),
1490    number_to_static_string (num2)) work as expected.  Three buffers
1491    are currently used, which means that "%s %s %s" will work, but "%s
1492    %s %s %s" won't.  If you need to print more than three wgints,
1493    bump the RING_SIZE (or rethink your message.)  */
1494
1495 char *
1496 number_to_static_string (wgint number)
1497 {
1498   static char ring[RING_SIZE][24];
1499   static int ringpos;
1500   char *buf = ring[ringpos];
1501   number_to_string (buf, number);
1502   ringpos = (ringpos + 1) % RING_SIZE;
1503   return buf;
1504 }
1505 \f
1506 /* Determine the width of the terminal we're running on.  If that's
1507    not possible, return 0.  */
1508
1509 int
1510 determine_screen_width (void)
1511 {
1512   /* If there's a way to get the terminal size using POSIX
1513      tcgetattr(), somebody please tell me.  */
1514 #ifdef TIOCGWINSZ
1515   int fd;
1516   struct winsize wsz;
1517
1518   if (opt.lfilename != NULL)
1519     return 0;
1520
1521   fd = fileno (stderr);
1522   if (ioctl (fd, TIOCGWINSZ, &wsz) < 0)
1523     return 0;                   /* most likely ENOTTY */
1524
1525   return wsz.ws_col;
1526 #elif defined(WINDOWS)
1527   CONSOLE_SCREEN_BUFFER_INFO csbi;
1528   if (!GetConsoleScreenBufferInfo (GetStdHandle (STD_ERROR_HANDLE), &csbi))
1529     return 0;
1530   return csbi.dwSize.X;
1531 #else  /* neither TIOCGWINSZ nor WINDOWS */
1532   return 0;
1533 #endif /* neither TIOCGWINSZ nor WINDOWS */
1534 }
1535
1536 /* Return a random number between 0 and MAX-1, inclusive.
1537
1538    If MAX is greater than the value of RAND_MAX+1 on the system, the
1539    returned value will be in the range [0, RAND_MAX].  This may be
1540    fixed in a future release.
1541
1542    The random number generator is seeded automatically the first time
1543    it is called.
1544
1545    This uses rand() for portability.  It has been suggested that
1546    random() offers better randomness, but this is not required for
1547    Wget, so I chose to go for simplicity and use rand
1548    unconditionally.
1549
1550    DO NOT use this for cryptographic purposes.  It is only meant to be
1551    used in situations where quality of the random numbers returned
1552    doesn't really matter.  */
1553
1554 int
1555 random_number (int max)
1556 {
1557   static int seeded;
1558   double bounded;
1559   int rnd;
1560
1561   if (!seeded)
1562     {
1563       srand (time (NULL));
1564       seeded = 1;
1565     }
1566   rnd = rand ();
1567
1568   /* On systems that don't define RAND_MAX, assume it to be 2**15 - 1,
1569      and enforce that assumption by masking other bits.  */
1570 #ifndef RAND_MAX
1571 # define RAND_MAX 32767
1572   rnd &= RAND_MAX;
1573 #endif
1574
1575   /* This is equivalent to rand() % max, but uses the high-order bits
1576      for better randomness on architecture where rand() is implemented
1577      using a simple congruential generator.  */
1578
1579   bounded = (double)max * rnd / (RAND_MAX + 1.0);
1580   return (int)bounded;
1581 }
1582
1583 /* Return a random uniformly distributed floating point number in the
1584    [0, 1) range.  The precision of returned numbers is 9 digits.
1585
1586    Modify this to use erand48() where available!  */
1587
1588 double
1589 random_float (void)
1590 {
1591   /* We can't rely on any specific value of RAND_MAX, but I'm pretty
1592      sure it's greater than 1000.  */
1593   int rnd1 = random_number (1000);
1594   int rnd2 = random_number (1000);
1595   int rnd3 = random_number (1000);
1596   return rnd1 / 1000.0 + rnd2 / 1000000.0 + rnd3 / 1000000000.0;
1597 }
1598 \f
1599 /* Implementation of run_with_timeout, a generic timeout-forcing
1600    routine for systems with Unix-like signal handling.  */
1601
1602 #ifdef USE_SIGNAL_TIMEOUT
1603 # ifdef HAVE_SIGSETJMP
1604 #  define SETJMP(env) sigsetjmp (env, 1)
1605
1606 static sigjmp_buf run_with_timeout_env;
1607
1608 static void
1609 abort_run_with_timeout (int sig)
1610 {
1611   assert (sig == SIGALRM);
1612   siglongjmp (run_with_timeout_env, -1);
1613 }
1614 # else /* not HAVE_SIGSETJMP */
1615 #  define SETJMP(env) setjmp (env)
1616
1617 static jmp_buf run_with_timeout_env;
1618
1619 static void
1620 abort_run_with_timeout (int sig)
1621 {
1622   assert (sig == SIGALRM);
1623   /* We don't have siglongjmp to preserve the set of blocked signals;
1624      if we longjumped out of the handler at this point, SIGALRM would
1625      remain blocked.  We must unblock it manually. */
1626   int mask = siggetmask ();
1627   mask &= ~sigmask (SIGALRM);
1628   sigsetmask (mask);
1629
1630   /* Now it's safe to longjump. */
1631   longjmp (run_with_timeout_env, -1);
1632 }
1633 # endif /* not HAVE_SIGSETJMP */
1634
1635 /* Arrange for SIGALRM to be delivered in TIMEOUT seconds.  This uses
1636    setitimer where available, alarm otherwise.
1637
1638    TIMEOUT should be non-zero.  If the timeout value is so small that
1639    it would be rounded to zero, it is rounded to the least legal value
1640    instead (1us for setitimer, 1s for alarm).  That ensures that
1641    SIGALRM will be delivered in all cases.  */
1642
1643 static void
1644 alarm_set (double timeout)
1645 {
1646 #ifdef ITIMER_REAL
1647   /* Use the modern itimer interface. */
1648   struct itimerval itv;
1649   xzero (itv);
1650   itv.it_value.tv_sec = (long) timeout;
1651   itv.it_value.tv_usec = 1000000 * (timeout - (long)timeout);
1652   if (itv.it_value.tv_sec == 0 && itv.it_value.tv_usec == 0)
1653     /* Ensure that we wait for at least the minimum interval.
1654        Specifying zero would mean "wait forever".  */
1655     itv.it_value.tv_usec = 1;
1656   setitimer (ITIMER_REAL, &itv, NULL);
1657 #else  /* not ITIMER_REAL */
1658   /* Use the old alarm() interface. */
1659   int secs = (int) timeout;
1660   if (secs == 0)
1661     /* Round TIMEOUTs smaller than 1 to 1, not to zero.  This is
1662        because alarm(0) means "never deliver the alarm", i.e. "wait
1663        forever", which is not what someone who specifies a 0.5s
1664        timeout would expect.  */
1665     secs = 1;
1666   alarm (secs);
1667 #endif /* not ITIMER_REAL */
1668 }
1669
1670 /* Cancel the alarm set with alarm_set. */
1671
1672 static void
1673 alarm_cancel (void)
1674 {
1675 #ifdef ITIMER_REAL
1676   struct itimerval disable;
1677   xzero (disable);
1678   setitimer (ITIMER_REAL, &disable, NULL);
1679 #else  /* not ITIMER_REAL */
1680   alarm (0);
1681 #endif /* not ITIMER_REAL */
1682 }
1683
1684 /* Call FUN(ARG), but don't allow it to run for more than TIMEOUT
1685    seconds.  Returns true if the function was interrupted with a
1686    timeout, false otherwise.
1687
1688    This works by setting up SIGALRM to be delivered in TIMEOUT seconds
1689    using setitimer() or alarm().  The timeout is enforced by
1690    longjumping out of the SIGALRM handler.  This has several
1691    advantages compared to the traditional approach of relying on
1692    signals causing system calls to exit with EINTR:
1693
1694      * The callback function is *forcibly* interrupted after the
1695        timeout expires, (almost) regardless of what it was doing and
1696        whether it was in a syscall.  For example, a calculation that
1697        takes a long time is interrupted as reliably as an IO
1698        operation.
1699
1700      * It works with both SYSV and BSD signals because it doesn't
1701        depend on the default setting of SA_RESTART.
1702
1703      * It doesn't require special handler setup beyond a simple call
1704        to signal().  (It does use sigsetjmp/siglongjmp, but they're
1705        optional.)
1706
1707    The only downside is that, if FUN allocates internal resources that
1708    are normally freed prior to exit from the functions, they will be
1709    lost in case of timeout.  */
1710
1711 bool
1712 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
1713 {
1714   int saved_errno;
1715
1716   if (timeout == 0)
1717     {
1718       fun (arg);
1719       return false;
1720     }
1721
1722   signal (SIGALRM, abort_run_with_timeout);
1723   if (SETJMP (run_with_timeout_env) != 0)
1724     {
1725       /* Longjumped out of FUN with a timeout. */
1726       signal (SIGALRM, SIG_DFL);
1727       return true;
1728     }
1729   alarm_set (timeout);
1730   fun (arg);
1731
1732   /* Preserve errno in case alarm() or signal() modifies it. */
1733   saved_errno = errno;
1734   alarm_cancel ();
1735   signal (SIGALRM, SIG_DFL);
1736   errno = saved_errno;
1737
1738   return false;
1739 }
1740
1741 #else  /* not USE_SIGNAL_TIMEOUT */
1742
1743 #ifndef WINDOWS
1744 /* A stub version of run_with_timeout that just calls FUN(ARG).  Don't
1745    define it under Windows, because Windows has its own version of
1746    run_with_timeout that uses threads.  */
1747
1748 int
1749 run_with_timeout (double timeout, void (*fun) (void *), void *arg)
1750 {
1751   fun (arg);
1752   return false;
1753 }
1754 #endif /* not WINDOWS */
1755 #endif /* not USE_SIGNAL_TIMEOUT */
1756 \f
1757 #ifndef WINDOWS
1758
1759 /* Sleep the specified amount of seconds.  On machines without
1760    nanosleep(), this may sleep shorter if interrupted by signals.  */
1761
1762 void
1763 xsleep (double seconds)
1764 {
1765 #ifdef HAVE_NANOSLEEP
1766   /* nanosleep is the preferred interface because it offers high
1767      accuracy and, more importantly, because it allows us to reliably
1768      restart receiving a signal such as SIGWINCH.  (There was an
1769      actual Debian bug report about --limit-rate malfunctioning while
1770      the terminal was being resized.)  */
1771   struct timespec sleep, remaining;
1772   sleep.tv_sec = (long) seconds;
1773   sleep.tv_nsec = 1000000000 * (seconds - (long) seconds);
1774   while (nanosleep (&sleep, &remaining) < 0 && errno == EINTR)
1775     /* If nanosleep has been interrupted by a signal, adjust the
1776        sleeping period and return to sleep.  */
1777     sleep = remaining;
1778 #elif defined(HAVE_USLEEP)
1779   /* If usleep is available, use it in preference to select.  */
1780   if (seconds >= 1)
1781     {
1782       /* On some systems, usleep cannot handle values larger than
1783          1,000,000.  If the period is larger than that, use sleep
1784          first, then add usleep for subsecond accuracy.  */
1785       sleep (seconds);
1786       seconds -= (long) seconds;
1787     }
1788   usleep (seconds * 1000000);
1789 #else /* fall back select */
1790   /* Note that, although Windows supports select, it can't be used to
1791      implement sleeping because Winsock's select doesn't implement
1792      timeout when it is passed NULL pointers for all fd sets.  (But it
1793      does under Cygwin, which implements Unix-compatible select.)  */
1794   struct timeval sleep;
1795   sleep.tv_sec = (long) seconds;
1796   sleep.tv_usec = 1000000 * (seconds - (long) seconds);
1797   select (0, NULL, NULL, NULL, &sleep);
1798   /* If select returns -1 and errno is EINTR, it means we were
1799      interrupted by a signal.  But without knowing how long we've
1800      actually slept, we can't return to sleep.  Using gettimeofday to
1801      track sleeps is slow and unreliable due to clock skew.  */
1802 #endif
1803 }
1804
1805 #endif /* not WINDOWS */
1806
1807 /* Encode the string STR of length LENGTH to base64 format and place it
1808    to B64STORE.  The output will be \0-terminated, and must point to a
1809    writable buffer of at least 1+BASE64_LENGTH(length) bytes.  It
1810    returns the length of the resulting base64 data, not counting the
1811    terminating zero.
1812
1813    This implementation will not emit newlines after 76 characters of
1814    base64 data.  */
1815
1816 int
1817 base64_encode (const char *str, int length, char *b64store)
1818 {
1819   /* Conversion table.  */
1820   static char tbl[64] = {
1821     'A','B','C','D','E','F','G','H',
1822     'I','J','K','L','M','N','O','P',
1823     'Q','R','S','T','U','V','W','X',
1824     'Y','Z','a','b','c','d','e','f',
1825     'g','h','i','j','k','l','m','n',
1826     'o','p','q','r','s','t','u','v',
1827     'w','x','y','z','0','1','2','3',
1828     '4','5','6','7','8','9','+','/'
1829   };
1830   int i;
1831   const unsigned char *s = (const unsigned char *) str;
1832   char *p = b64store;
1833
1834   /* Transform the 3x8 bits to 4x6 bits, as required by base64.  */
1835   for (i = 0; i < length; i += 3)
1836     {
1837       *p++ = tbl[s[0] >> 2];
1838       *p++ = tbl[((s[0] & 3) << 4) + (s[1] >> 4)];
1839       *p++ = tbl[((s[1] & 0xf) << 2) + (s[2] >> 6)];
1840       *p++ = tbl[s[2] & 0x3f];
1841       s += 3;
1842     }
1843
1844   /* Pad the result if necessary...  */
1845   if (i == length + 1)
1846     *(p - 1) = '=';
1847   else if (i == length + 2)
1848     *(p - 1) = *(p - 2) = '=';
1849
1850   /* ...and zero-terminate it.  */
1851   *p = '\0';
1852
1853   return p - b64store;
1854 }
1855
1856 #define IS_ASCII(c) (((c) & 0x80) == 0)
1857 #define IS_BASE64(c) ((IS_ASCII (c) && base64_char_to_value[c] >= 0) || c == '=')
1858
1859 /* Get next character from the string, except that non-base64
1860    characters are ignored, as mandated by rfc2045.  */
1861 #define NEXT_BASE64_CHAR(c, p) do {                     \
1862   c = *p++;                                             \
1863 } while (c != '\0' && !IS_BASE64 (c))
1864
1865 /* Decode data from BASE64 (assumed to be encoded as base64) into
1866    memory pointed to by TO.  TO should be large enough to accomodate
1867    the decoded data, which is guaranteed to be less than
1868    strlen(base64).
1869
1870    Since TO is assumed to contain binary data, it is not
1871    NUL-terminated.  The function returns the length of the data
1872    written to TO.  -1 is returned in case of error caused by malformed
1873    base64 input.  */
1874
1875 int
1876 base64_decode (const char *base64, char *to)
1877 {
1878   /* Table of base64 values for first 128 characters.  Note that this
1879      assumes ASCII (but so does Wget in other places).  */
1880   static short base64_char_to_value[128] =
1881     {
1882       -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  /*   0-  9 */
1883       -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  /*  10- 19 */
1884       -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  /*  20- 29 */
1885       -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  /*  30- 39 */
1886       -1,  -1,  -1,  62,  -1,  -1,  -1,  63,  52,  53,  /*  40- 49 */
1887       54,  55,  56,  57,  58,  59,  60,  61,  -1,  -1,  /*  50- 59 */
1888       -1,  -1,  -1,  -1,  -1,  0,   1,   2,   3,   4,   /*  60- 69 */
1889       5,   6,   7,   8,   9,   10,  11,  12,  13,  14,  /*  70- 79 */
1890       15,  16,  17,  18,  19,  20,  21,  22,  23,  24,  /*  80- 89 */
1891       25,  -1,  -1,  -1,  -1,  -1,  -1,  26,  27,  28,  /*  90- 99 */
1892       29,  30,  31,  32,  33,  34,  35,  36,  37,  38,  /* 100-109 */
1893       39,  40,  41,  42,  43,  44,  45,  46,  47,  48,  /* 110-119 */
1894       49,  50,  51,  -1,  -1,  -1,  -1,  -1             /* 120-127 */
1895     };
1896
1897   const char *p = base64;
1898   char *q = to;
1899
1900   while (1)
1901     {
1902       unsigned char c;
1903       unsigned long value;
1904
1905       /* Process first byte of a quadruplet.  */
1906       NEXT_BASE64_CHAR (c, p);
1907       if (!c)
1908         break;
1909       if (c == '=')
1910         return -1;              /* illegal '=' while decoding base64 */
1911       value = base64_char_to_value[c] << 18;
1912
1913       /* Process scond byte of a quadruplet.  */
1914       NEXT_BASE64_CHAR (c, p);
1915       if (!c)
1916         return -1;              /* premature EOF while decoding base64 */
1917       if (c == '=')
1918         return -1;              /* illegal `=' while decoding base64 */
1919       value |= base64_char_to_value[c] << 12;
1920       *q++ = value >> 16;
1921
1922       /* Process third byte of a quadruplet.  */
1923       NEXT_BASE64_CHAR (c, p);
1924       if (!c)
1925         return -1;              /* premature EOF while decoding base64 */
1926
1927       if (c == '=')
1928         {
1929           NEXT_BASE64_CHAR (c, p);
1930           if (!c)
1931             return -1;          /* premature EOF while decoding base64 */
1932           if (c != '=')
1933             return -1;          /* padding `=' expected but not found */
1934           continue;
1935         }
1936
1937       value |= base64_char_to_value[c] << 6;
1938       *q++ = 0xff & value >> 8;
1939
1940       /* Process fourth byte of a quadruplet.  */
1941       NEXT_BASE64_CHAR (c, p);
1942       if (!c)
1943         return -1;              /* premature EOF while decoding base64 */
1944       if (c == '=')
1945         continue;
1946
1947       value |= base64_char_to_value[c];
1948       *q++ = 0xff & value;
1949     }
1950
1951   return q - to;
1952 }
1953
1954 #undef IS_ASCII
1955 #undef IS_BASE64
1956 #undef NEXT_BASE64_CHAR
1957 \f
1958 /* Simple merge sort for use by stable_sort.  Implementation courtesy
1959    Zeljko Vrba with additional debugging by Nenad Barbutov.  */
1960
1961 static void
1962 mergesort_internal (void *base, void *temp, size_t size, size_t from, size_t to,
1963                     int (*cmpfun) (const void *, const void *))
1964 {
1965 #define ELT(array, pos) ((char *)(array) + (pos) * size)
1966   if (from < to)
1967     {
1968       size_t i, j, k;
1969       size_t mid = (to + from) / 2;
1970       mergesort_internal (base, temp, size, from, mid, cmpfun);
1971       mergesort_internal (base, temp, size, mid + 1, to, cmpfun);
1972       i = from;
1973       j = mid + 1;
1974       for (k = from; (i <= mid) && (j <= to); k++)
1975         if (cmpfun (ELT (base, i), ELT (base, j)) <= 0)
1976           memcpy (ELT (temp, k), ELT (base, i++), size);
1977         else
1978           memcpy (ELT (temp, k), ELT (base, j++), size);
1979       while (i <= mid)
1980         memcpy (ELT (temp, k++), ELT (base, i++), size);
1981       while (j <= to)
1982         memcpy (ELT (temp, k++), ELT (base, j++), size);
1983       for (k = from; k <= to; k++)
1984         memcpy (ELT (base, k), ELT (temp, k), size);
1985     }
1986 #undef ELT
1987 }
1988
1989 /* Stable sort with interface exactly like standard library's qsort.
1990    Uses mergesort internally, allocating temporary storage with
1991    alloca.  */
1992
1993 void
1994 stable_sort (void *base, size_t nmemb, size_t size,
1995              int (*cmpfun) (const void *, const void *))
1996 {
1997   if (size > 1)
1998     {
1999       void *temp = alloca (nmemb * size * sizeof (void *));
2000       mergesort_internal (base, temp, size, 0, nmemb - 1, cmpfun);
2001     }
2002 }