]> sjero.net Git - wget/blob - src/init.c
[svn] Added (currently no-op) -4 and -6.
[wget] / src / init.c
1 /* Reading/parsing the initialization file.
2    Copyright (C) 1995, 1996, 1997, 1998, 2000, 2001, 2003
3    Free Software Foundation, Inc.
4
5 This file is part of GNU Wget.
6
7 GNU Wget is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 GNU Wget is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Wget; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21 In addition, as a special exception, the Free Software Foundation
22 gives permission to link the code of its release of Wget with the
23 OpenSSL project's "OpenSSL" library (or with modified versions of it
24 that use the same license as the "OpenSSL" library), and distribute
25 the linked executables.  You must obey the GNU General Public License
26 in all respects for all of the code used other than "OpenSSL".  If you
27 modify this file, you may extend this exception to your version of the
28 file, but you are not obligated to do so.  If you do not wish to do
29 so, delete this exception statement from your version.  */
30
31 #include <config.h>
32
33 #include <stdio.h>
34 #include <sys/types.h>
35 #include <stdlib.h>
36 #ifdef HAVE_UNISTD_H
37 # include <unistd.h>
38 #endif
39 #ifdef HAVE_STRING_H
40 # include <string.h>
41 #else
42 # include <strings.h>
43 #endif
44 #include <errno.h>
45
46 #ifdef WINDOWS
47 # include <winsock.h>
48 #else
49 # include <sys/socket.h>
50 # include <netinet/in.h>
51 #ifndef __BEOS__
52 # include <arpa/inet.h>
53 #endif
54 #endif
55
56 #ifdef HAVE_PWD_H
57 # include <pwd.h>
58 #endif
59 #include <assert.h>
60
61 #include "wget.h"
62 #include "utils.h"
63 #include "init.h"
64 #include "host.h"
65 #include "netrc.h"
66 #include "cookies.h"            /* for cookie_jar_delete */
67 #include "progress.h"
68 #include "recur.h"              /* for INFINITE_RECURSION */
69
70 #ifndef errno
71 extern int errno;
72 #endif
73
74 extern struct cookie_jar *wget_cookie_jar;
75
76 /* We want tilde expansion enabled only when reading `.wgetrc' lines;
77    otherwise, it will be performed by the shell.  This variable will
78    be set by the wgetrc-reading function.  */
79
80 static int enable_tilde_expansion;
81
82
83 #define CMD_DECLARE(func) static int func \
84   PARAMS ((const char *, const char *, void *))
85
86 CMD_DECLARE (cmd_boolean);
87 CMD_DECLARE (cmd_bytes);
88 CMD_DECLARE (cmd_bytes_large);
89 CMD_DECLARE (cmd_directory_vector);
90 CMD_DECLARE (cmd_lockable_boolean);
91 CMD_DECLARE (cmd_number);
92 CMD_DECLARE (cmd_number_inf);
93 CMD_DECLARE (cmd_string);
94 CMD_DECLARE (cmd_file);
95 CMD_DECLARE (cmd_directory);
96 CMD_DECLARE (cmd_time);
97 CMD_DECLARE (cmd_vector);
98
99 CMD_DECLARE (cmd_spec_dirstruct);
100 CMD_DECLARE (cmd_spec_header);
101 CMD_DECLARE (cmd_spec_htmlify);
102 CMD_DECLARE (cmd_spec_mirror);
103 CMD_DECLARE (cmd_spec_progress);
104 CMD_DECLARE (cmd_spec_recursive);
105 CMD_DECLARE (cmd_spec_restrict_file_names);
106 CMD_DECLARE (cmd_spec_timeout);
107 CMD_DECLARE (cmd_spec_useragent);
108
109 /* List of recognized commands, each consisting of name, closure and
110    function.  When adding a new command, simply add it to the list,
111    but be sure to keep the list sorted alphabetically, as
112    command_by_name depends on it.  Also, be sure to add any entries
113    that allocate memory (e.g. cmd_string and cmd_vector guys) to the
114    cleanup() function below. */
115
116 static struct {
117   char *name;
118   void *closure;
119   int (*action) PARAMS ((const char *, const char *, void *));
120 } commands[] = {
121   { "accept",           &opt.accepts,           cmd_vector },
122   { "addhostdir",       &opt.add_hostdir,       cmd_boolean },
123   { "alwaysrest",       &opt.always_rest,       cmd_boolean }, /* deprecated */
124   { "background",       &opt.background,        cmd_boolean },
125   { "backupconverted",  &opt.backup_converted,  cmd_boolean },
126   { "backups",          &opt.backups,           cmd_number },
127   { "base",             &opt.base_href,         cmd_string },
128   { "bindaddress",      &opt.bind_address,      cmd_string },
129   { "cache",            &opt.allow_cache,       cmd_boolean },
130   { "connecttimeout",   &opt.connect_timeout,   cmd_time },
131   { "continue",         &opt.always_rest,       cmd_boolean },
132   { "convertlinks",     &opt.convert_links,     cmd_boolean },
133   { "cookies",          &opt.cookies,           cmd_boolean },
134   { "cutdirs",          &opt.cut_dirs,          cmd_number },
135 #ifdef ENABLE_DEBUG
136   { "debug",            &opt.debug,             cmd_boolean },
137 #endif
138   { "deleteafter",      &opt.delete_after,      cmd_boolean },
139   { "dirprefix",        &opt.dir_prefix,        cmd_directory },
140   { "dirstruct",        NULL,                   cmd_spec_dirstruct },
141   { "dnscache",         &opt.dns_cache,         cmd_boolean },
142   { "dnstimeout",       &opt.dns_timeout,       cmd_time },
143   { "domains",          &opt.domains,           cmd_vector },
144   { "dotbytes",         &opt.dot_bytes,         cmd_bytes },
145   { "dotsinline",       &opt.dots_in_line,      cmd_number },
146   { "dotspacing",       &opt.dot_spacing,       cmd_number },
147   { "dotstyle",         &opt.dot_style,         cmd_string },
148 #ifdef HAVE_SSL
149   { "egdfile",          &opt.sslegdsock,        cmd_file },
150 #endif
151   { "excludedirectories", &opt.excludes,        cmd_directory_vector },
152   { "excludedomains",   &opt.exclude_domains,   cmd_vector },
153   { "followftp",        &opt.follow_ftp,        cmd_boolean },
154   { "followtags",       &opt.follow_tags,       cmd_vector },
155   { "forcehtml",        &opt.force_html,        cmd_boolean },
156   { "ftpproxy",         &opt.ftp_proxy,         cmd_string },
157   { "glob",             &opt.ftp_glob,          cmd_boolean },
158   { "header",           NULL,                   cmd_spec_header },
159   { "htmlextension",    &opt.html_extension,    cmd_boolean },
160   { "htmlify",          NULL,                   cmd_spec_htmlify },
161   { "httpkeepalive",    &opt.http_keep_alive,   cmd_boolean },
162   { "httppasswd",       &opt.http_passwd,       cmd_string },
163   { "httpproxy",        &opt.http_proxy,        cmd_string },
164   { "httpsproxy",       &opt.https_proxy,       cmd_string },
165   { "httpuser",         &opt.http_user,         cmd_string },
166   { "ignorelength",     &opt.ignore_length,     cmd_boolean },
167   { "ignoretags",       &opt.ignore_tags,       cmd_vector },
168   { "includedirectories", &opt.includes,        cmd_directory_vector },
169   { "input",            &opt.input_filename,    cmd_file },
170 #ifdef ENABLE_IPV6
171   { "inet4only",        &opt.ipv4_only,         cmd_boolean },
172   { "inet6only",        &opt.ipv6_only,         cmd_boolean },
173 #endif
174   { "keepsessioncookies", &opt.keep_session_cookies, cmd_boolean },
175   { "killlonger",       &opt.kill_longer,       cmd_boolean },
176   { "limitrate",        &opt.limit_rate,        cmd_bytes },
177   { "loadcookies",      &opt.cookies_input,     cmd_file },
178   { "logfile",          &opt.lfilename,         cmd_file },
179   { "login",            &opt.ftp_acc,           cmd_string },
180   { "mirror",           NULL,                   cmd_spec_mirror },
181   { "netrc",            &opt.netrc,             cmd_boolean },
182   { "noclobber",        &opt.noclobber,         cmd_boolean },
183   { "noparent",         &opt.no_parent,         cmd_boolean },
184   { "noproxy",          &opt.no_proxy,          cmd_vector },
185   { "numtries",         &opt.ntry,              cmd_number_inf },/* deprecated*/
186   { "outputdocument",   &opt.output_document,   cmd_file },
187   { "pagerequisites",   &opt.page_requisites,   cmd_boolean },
188   { "passiveftp",       &opt.ftp_pasv,          cmd_lockable_boolean },
189   { "passwd",           &opt.ftp_pass,          cmd_string },
190   { "postdata",         &opt.post_data,         cmd_string },
191   { "postfile",         &opt.post_file_name,    cmd_file },
192   { "preservepermissions", &opt.preserve_perm,     cmd_boolean },
193   { "progress",         &opt.progress_type,     cmd_spec_progress },
194   { "proxypasswd",      &opt.proxy_passwd,      cmd_string },
195   { "proxyuser",        &opt.proxy_user,        cmd_string },
196   { "quiet",            &opt.quiet,             cmd_boolean },
197   { "quota",            &opt.quota,             cmd_bytes_large },
198   { "randomwait",       &opt.random_wait,       cmd_boolean },
199   { "readtimeout",      &opt.read_timeout,      cmd_time },
200   { "reclevel",         &opt.reclevel,          cmd_number_inf },
201   { "recursive",        NULL,                   cmd_spec_recursive },
202   { "referer",          &opt.referer,           cmd_string },
203   { "reject",           &opt.rejects,           cmd_vector },
204   { "relativeonly",     &opt.relative_only,     cmd_boolean },
205   { "removelisting",    &opt.remove_listing,    cmd_boolean },
206   { "restrictfilenames", NULL,                  cmd_spec_restrict_file_names },
207   { "retrsymlinks",     &opt.retr_symlinks,     cmd_boolean },
208   { "retryconnrefused", &opt.retry_connrefused, cmd_boolean },
209   { "robots",           &opt.use_robots,        cmd_boolean },
210   { "savecookies",      &opt.cookies_output,    cmd_file },
211   { "saveheaders",      &opt.save_headers,      cmd_boolean },
212   { "serverresponse",   &opt.server_response,   cmd_boolean },
213   { "spanhosts",        &opt.spanhost,          cmd_boolean },
214   { "spider",           &opt.spider,            cmd_boolean },
215 #ifdef HAVE_SSL
216   { "sslcadir",         &opt.sslcadir,          cmd_directory },
217   { "sslcafile",        &opt.sslcafile,         cmd_file },
218   { "sslcertfile",      &opt.sslcertfile,       cmd_file },
219   { "sslcertkey",       &opt.sslcertkey,        cmd_file },
220   { "sslcerttype",      &opt.sslcerttype,       cmd_number },
221   { "sslcheckcert",     &opt.sslcheckcert,      cmd_number },
222   { "sslprotocol",      &opt.sslprotocol,       cmd_number },
223 #endif /* HAVE_SSL */
224   { "strictcomments",   &opt.strict_comments,   cmd_boolean },
225   { "timeout",          NULL,                   cmd_spec_timeout },
226   { "timestamping",     &opt.timestamping,      cmd_boolean },
227   { "tries",            &opt.ntry,              cmd_number_inf },
228   { "useproxy",         &opt.use_proxy,         cmd_boolean },
229   { "useragent",        NULL,                   cmd_spec_useragent },
230   { "verbose",          &opt.verbose,           cmd_boolean },
231   { "wait",             &opt.wait,              cmd_time },
232   { "waitretry",        &opt.waitretry,         cmd_time }
233 };
234
235 /* Look up CMDNAME in the commands[] and return its position in the
236    array.  If CMDNAME is not found, return -1.  */
237
238 static int
239 command_by_name (const char *cmdname)
240 {
241   /* Use binary search for speed.  Wget has ~100 commands, which
242      guarantees a worst case performance of 7 string comparisons.  */
243   int lo = 0, hi = countof (commands) - 1;
244
245   while (lo <= hi)
246     {
247       int mid = (lo + hi) >> 1;
248       int cmp = strcasecmp (cmdname, commands[mid].name);
249       if (cmp < 0)
250         hi = mid - 1;
251       else if (cmp > 0)
252         lo = mid + 1;
253       else
254         return mid;
255     }
256   return -1;
257 }
258 \f
259 /* Reset the variables to default values.  */
260 static void
261 defaults (void)
262 {
263   char *tmp;
264
265   /* Most of the default values are 0.  Just reset everything, and
266      fill in the non-zero values.  Note that initializing pointers to
267      NULL this way is technically illegal, but porting Wget to a
268      machine where NULL is not all-zero bit pattern will be the least
269      of the implementors' worries.  */
270   xzero (opt);
271
272   opt.cookies = 1;
273   opt.verbose = -1;
274   opt.ntry = 20;
275   opt.reclevel = 5;
276   opt.add_hostdir = 1;
277   opt.ftp_acc  = xstrdup ("anonymous");
278   opt.ftp_pass = xstrdup ("-wget@");
279   opt.netrc = 1;
280   opt.ftp_glob = 1;
281   opt.htmlify = 1;
282   opt.http_keep_alive = 1;
283   opt.use_proxy = 1;
284   tmp = getenv ("no_proxy");
285   if (tmp)
286     opt.no_proxy = sepstring (tmp);
287   opt.allow_cache = 1;
288
289   opt.read_timeout = 900;
290   opt.use_robots = 1;
291
292   opt.remove_listing = 1;
293
294   opt.dot_bytes = 1024;
295   opt.dot_spacing = 10;
296   opt.dots_in_line = 50;
297
298   opt.dns_cache = 1;
299
300   /* The default for file name restriction defaults to the OS type. */
301 #if !defined(WINDOWS) && !defined(__CYGWIN__)
302   opt.restrict_files_os = restrict_unix;
303 #else
304   opt.restrict_files_os = restrict_windows;
305 #endif
306   opt.restrict_files_ctrl = 1;
307 }
308 \f
309 /* Return the user's home directory (strdup-ed), or NULL if none is
310    found.  */
311 char *
312 home_dir (void)
313 {
314   char *home = getenv ("HOME");
315
316   if (!home)
317     {
318 #ifndef WINDOWS
319       /* If HOME is not defined, try getting it from the password
320          file.  */
321       struct passwd *pwd = getpwuid (getuid ());
322       if (!pwd || !pwd->pw_dir)
323         return NULL;
324       home = pwd->pw_dir;
325 #else  /* WINDOWS */
326       home = "C:\\";
327       /* #### Maybe I should grab home_dir from registry, but the best
328          that I could get from there is user's Start menu.  It sucks!  */
329 #endif /* WINDOWS */
330     }
331
332   return home ? xstrdup (home) : NULL;
333 }
334
335 /* Return the path to the user's .wgetrc.  This is either the value of
336    `WGETRC' environment variable, or `$HOME/.wgetrc'.
337
338    If the `WGETRC' variable exists but the file does not exist, the
339    function will exit().  */
340 static char *
341 wgetrc_file_name (void)
342 {
343   char *env, *home;
344   char *file = NULL;
345
346   /* Try the environment.  */
347   env = getenv ("WGETRC");
348   if (env && *env)
349     {
350       if (!file_exists_p (env))
351         {
352           fprintf (stderr, _("%s: WGETRC points to %s, which doesn't exist.\n"),
353                    exec_name, env);
354           exit (1);
355         }
356       return xstrdup (env);
357     }
358
359 #ifndef WINDOWS
360   /* If that failed, try $HOME/.wgetrc.  */
361   home = home_dir ();
362   if (home)
363     {
364       file = (char *)xmalloc (strlen (home) + 1 + strlen (".wgetrc") + 1);
365       sprintf (file, "%s/.wgetrc", home);
366     }
367   xfree_null (home);
368 #else  /* WINDOWS */
369   /* Under Windows, "home" is (for the purposes of this function) the
370      directory where `wget.exe' resides, and `wget.ini' will be used
371      as file name.  SYSTEM_WGETRC should not be defined under WINDOWS.
372
373      It is not as trivial as I assumed, because on 95 argv[0] is full
374      path, but on NT you get what you typed in command line.  --dbudor */
375   home = ws_mypath ();
376   if (home)
377     {
378       file = (char *)xmalloc (strlen (home) + strlen ("wget.ini") + 1);
379       sprintf (file, "%swget.ini", home);
380     }
381 #endif /* WINDOWS */
382
383   if (!file)
384     return NULL;
385   if (!file_exists_p (file))
386     {
387       xfree (file);
388       return NULL;
389     }
390   return file;
391 }
392
393 static int parse_line PARAMS ((const char *, char **, char **, int *));
394 static int setval_internal PARAMS ((int, const char *, const char *));
395
396 /* Initialize variables from a wgetrc file.  */
397
398 static void
399 run_wgetrc (const char *file)
400 {
401   FILE *fp;
402   char *line;
403   int ln;
404
405   fp = fopen (file, "rb");
406   if (!fp)
407     {
408       fprintf (stderr, _("%s: Cannot read %s (%s).\n"), exec_name,
409                file, strerror (errno));
410       return;
411     }
412   enable_tilde_expansion = 1;
413   ln = 1;
414   while ((line = read_whole_line (fp)))
415     {
416       char *com, *val;
417       int comind, status;
418
419       /* Parse the line.  */
420       status = parse_line (line, &com, &val, &comind);
421       xfree (line);
422       /* If everything is OK, set the value.  */
423       if (status == 1)
424         {
425           if (!setval_internal (comind, com, val))
426             fprintf (stderr, _("%s: Error in %s at line %d.\n"), exec_name,
427                      file, ln);
428           xfree (com);
429           xfree (val);
430         }
431       else if (status == 0)
432         fprintf (stderr, _("%s: Error in %s at line %d.\n"), exec_name,
433                  file, ln);
434       ++ln;
435     }
436   enable_tilde_expansion = 0;
437   fclose (fp);
438 }
439
440 /* Initialize the defaults and run the system wgetrc and user's own
441    wgetrc.  */
442 void
443 initialize (void)
444 {
445   char *file;
446
447   /* Load the hard-coded defaults.  */
448   defaults ();
449
450   /* If SYSTEM_WGETRC is defined, use it.  */
451 #ifdef SYSTEM_WGETRC
452   if (file_exists_p (SYSTEM_WGETRC))
453     run_wgetrc (SYSTEM_WGETRC);
454 #endif
455   /* Override it with your own, if one exists.  */
456   file = wgetrc_file_name ();
457   if (!file)
458     return;
459   /* #### We should canonicalize `file' and SYSTEM_WGETRC with
460      something like realpath() before comparing them with `strcmp'  */
461 #ifdef SYSTEM_WGETRC
462   if (!strcmp (file, SYSTEM_WGETRC))
463     {
464       fprintf (stderr, _("\
465 %s: Warning: Both system and user wgetrc point to `%s'.\n"),
466                exec_name, file);
467     }
468   else
469 #endif
470     run_wgetrc (file);
471   xfree (file);
472   return;
473 }
474 \f
475 /* Remove dashes and underscores from S, modifying S in the
476    process. */
477
478 static void
479 dehyphen (char *s)
480 {
481   char *t = s;                  /* t - tortoise */
482   char *h = s;                  /* h - hare     */
483   while (*h)
484     if (*h == '_' || *h == '-')
485       ++h;
486     else
487       *t++ = *h++;
488   *t = '\0';
489 }
490
491 /* Parse the line pointed by line, with the syntax:
492    <sp>* command <sp>* = <sp>* value <sp>*
493    Uses malloc to allocate space for command and value.
494    If the line is invalid, data is freed and 0 is returned.
495
496    Return values:
497     1 - success
498     0 - error
499    -1 - empty
500
501    In case of success, *COM and *VAL point to freshly allocated
502    strings, and *COMIND points to com's index.  In case of error or
503    empty line, those values are unaffected.  */
504
505 static int
506 parse_line (const char *line, char **com, char **val, int *comind)
507 {
508   const char *p;
509   const char *end = line + strlen (line);
510   const char *cmdstart, *cmdend;
511   const char *valstart, *valend;
512
513   char *cmdcopy;
514   int ind;
515
516   /* Skip leading and trailing whitespace.  */
517   while (*line && ISSPACE (*line))
518     ++line;
519   while (end > line && ISSPACE (end[-1]))
520     --end;
521
522   /* Skip empty lines and comments.  */
523   if (!*line || *line == '#')
524     return -1;
525
526   p = line;
527
528   cmdstart = p;
529   while (p < end && (ISALPHA (*p) || *p == '_' || *p == '-'))
530     ++p;
531   cmdend = p;
532
533   /* Skip '=', as well as any space before or after it. */
534   while (p < end && ISSPACE (*p))
535     ++p;
536   if (p == end || *p != '=')
537     return 0;
538   ++p;
539   while (p < end && ISSPACE (*p))
540     ++p;
541
542   valstart = p;
543   valend   = end;
544
545   /* The line now known to be syntactically correct.  Check whether
546      the command is valid.  */
547   BOUNDED_TO_ALLOCA (cmdstart, cmdend, cmdcopy);
548   dehyphen (cmdcopy);
549   ind = command_by_name (cmdcopy);
550   if (ind == -1)
551     return 0;
552
553   /* The command is valid.  Now fill in the values and report success
554      to the caller.  */
555   *comind = ind;
556   *com = strdupdelim (cmdstart, cmdend);
557   *val = strdupdelim (valstart, valend);
558   return 1;
559 }
560
561 /* Run commands[comind].action. */
562
563 static int
564 setval_internal (int comind, const char *com, const char *val)
565 {
566   assert (0 <= comind && comind < countof (commands));
567   DEBUGP (("Setting %s (%d) to %s\n", com, comind, val));
568   return ((*commands[comind].action) (com, val, commands[comind].closure));
569 }
570
571 /* Run command COM with value VAL.  If running the command produces an
572    error, report the error and exit.
573
574    This is intended to be called from main() to modify Wget's behavior
575    through command-line switches.  Since COM is hard-coded in main(),
576    it is not canonicalized, and this aborts when COM is not found.
577
578    If COMIND's are exported to init.h, this function will be changed
579    to accept COMIND directly.  */
580
581 void
582 setoptval (const char *com, const char *val)
583 {
584   assert (val != NULL);
585   if (!setval_internal (command_by_name (com), com, val))
586     exit (2);
587 }
588
589 /* Parse OPT into command and value and run it.  For example,
590    run_command("foo=bar") is equivalent to setoptval("foo", "bar").
591    This is used by the `--execute' flag in main.c.  */
592
593 void
594 run_command (const char *opt)
595 {
596   char *com, *val;
597   int comind;
598   int status = parse_line (opt, &com, &val, &comind);
599   if (status == 1)
600     {
601       if (!setval_internal (comind, com, val))
602         exit (2);
603       xfree (com);
604       xfree (val);
605     }
606   else if (status == 0)
607     {
608       fprintf (stderr, _("%s: Invalid --execute command `%s'\n"),
609                exec_name, opt);
610       exit (2);
611     }
612 }
613 \f
614 /* Generic helper functions, for use with `commands'. */
615
616 #define CMP1(p, c0) (TOLOWER((p)[0]) == (c0) && (p)[1] == '\0')
617
618 #define CMP2(p, c0, c1) (TOLOWER((p)[0]) == (c0)        \
619                          && TOLOWER((p)[1]) == (c1)     \
620                          && (p)[2] == '\0')
621
622 #define CMP3(p, c0, c1, c2) (TOLOWER((p)[0]) == (c0)    \
623                      && TOLOWER((p)[1]) == (c1)         \
624                      && TOLOWER((p)[2]) == (c2)         \
625                      && (p)[3] == '\0')
626
627
628 /* Store the boolean value from VAL to CLOSURE.  COM is ignored,
629    except for error messages.  */
630 static int
631 cmd_boolean (const char *com, const char *val, void *closure)
632 {
633   int bool_value;
634
635   if (CMP2 (val, 'o', 'n') || CMP3 (val, 'y', 'e', 's') || CMP1 (val, '1'))
636     /* "on", "yes" and "1" mean true. */
637     bool_value = 1;
638   else if (CMP3 (val, 'o', 'f', 'f') || CMP2 (val, 'n', 'o') || CMP1 (val, '0'))
639     /* "off", "no" and "0" mean false. */
640     bool_value = 0;
641   else
642     {
643       fprintf (stderr,
644                _("%s: %s: Invalid boolean `%s', use `on' or `off'.\n"),
645                exec_name, com, val);
646       return 0;
647     }
648
649   *(int *)closure = bool_value;
650   return 1;
651 }
652
653 /* Store the lockable_boolean {2, 1, 0, -1} value from VAL to CLOSURE.
654    COM is ignored, except for error messages.  Values 2 and -1
655    indicate that once defined, the value may not be changed by
656    successive wgetrc files or command-line arguments.
657
658    Values: 2 - Enable a particular option for good ("always")
659            1 - Enable an option ("on")
660            0 - Disable an option ("off")
661           -1 - Disable an option for good ("never") */
662 static int
663 cmd_lockable_boolean (const char *com, const char *val, void *closure)
664 {
665   int lockable_boolean_value;
666
667   int oldval = *(int *)closure;
668
669   /*
670    * If a config file said "always" or "never", don't allow command line
671    * arguments to override the config file.
672    */
673   if (oldval == -1 || oldval == 2)
674     return 1;
675
676   if (0 == strcasecmp (val, "always") || CMP1 (val, '2'))
677     lockable_boolean_value = 2;
678   else if (CMP2 (val, 'o', 'n') || CMP3 (val, 'y', 'e', 's') || CMP1 (val, '1'))
679     lockable_boolean_value = 1;
680   else if (CMP3 (val, 'o', 'f', 'f') || CMP2 (val, 'n', 'o') || CMP1 (val, '0'))
681     lockable_boolean_value = 0;
682   else if (0 == strcasecmp (val, "never") || CMP2 (val, '-', '1'))
683     lockable_boolean_value = -1;
684   else
685     {
686       fprintf (stderr,
687                _("%s: %s: Invalid boolean `%s', use always, on, off, or never.\n"),
688                exec_name, com, val);
689       return 0;
690     }
691
692   *(int *)closure = lockable_boolean_value;
693   return 1;
694 }
695
696 static int simple_atoi PARAMS ((const char *, const char *, int *));
697
698 /* Set the non-negative integer value from VAL to CLOSURE.  With
699    incorrect specification, the number remains unchanged.  */
700 static int
701 cmd_number (const char *com, const char *val, void *closure)
702 {
703   if (!simple_atoi (val, val + strlen (val), closure))
704     {
705       fprintf (stderr, _("%s: %s: Invalid number `%s'.\n"),
706                exec_name, com, val);
707       return 0;
708     }
709   return 1;
710 }
711
712 /* Similar to cmd_number(), only accepts `inf' as a synonym for 0.  */
713 static int
714 cmd_number_inf (const char *com, const char *val, void *closure)
715 {
716   if (!strcasecmp (val, "inf"))
717     {
718       *(int *)closure = 0;
719       return 1;
720     }
721   return cmd_number (com, val, closure);
722 }
723
724 /* Copy (strdup) the string at COM to a new location and place a
725    pointer to *CLOSURE.  */
726 static int
727 cmd_string (const char *com, const char *val, void *closure)
728 {
729   char **pstring = (char **)closure;
730
731   xfree_null (*pstring);
732   *pstring = xstrdup (val);
733   return 1;
734 }
735
736 #ifndef WINDOWS
737 # define ISSEP(c) ((c) == '/')
738 #else
739 # define ISSEP(c) ((c) == '/' || (c) == '\\')
740 #endif
741
742 /* Like the above, but handles tilde-expansion when reading a user's
743    `.wgetrc'.  In that case, and if VAL begins with `~', the tilde
744    gets expanded to the user's home directory.  */
745 static int
746 cmd_file (const char *com, const char *val, void *closure)
747 {
748   char **pstring = (char **)closure;
749
750   xfree_null (*pstring);
751
752   /* #### If VAL is empty, perhaps should set *CLOSURE to NULL.  */
753
754   if (!enable_tilde_expansion || !(*val == '~' && ISSEP (val[1])))
755     {
756     noexpand:
757       *pstring = xstrdup (val);
758     }
759   else
760     {
761       char *result;
762       int homelen;
763       char *home = home_dir ();
764       if (!home)
765         goto noexpand;
766
767       homelen = strlen (home);
768       while (homelen && ISSEP (home[homelen - 1]))
769         home[--homelen] = '\0';
770
771       /* Skip the leading "~/". */
772       for (++val; ISSEP (*val); val++)
773         ;
774
775       result = xmalloc (homelen + 1 + strlen (val) + 1);
776       memcpy (result, home, homelen);
777       result[homelen] = '/';
778       strcpy (result + homelen + 1, val);
779
780       *pstring = result;
781     }
782
783 #ifdef WINDOWS
784   /* Convert "\" to "/". */
785   {
786     char *s;
787     for (s = *pstring; *s; s++)
788       if (*s == '\\')
789         *s = '/';
790   }
791 #endif
792   return 1;
793 }
794
795 /* Like cmd_file, but strips trailing '/' characters.  */
796 static int
797 cmd_directory (const char *com, const char *val, void *closure)
798 {
799   char *s, *t;
800
801   /* Call cmd_file() for tilde expansion and separator
802      canonicalization (backslash -> slash under Windows).  These
803      things should perhaps be in a separate function.  */
804   if (!cmd_file (com, val, closure))
805     return 0;
806
807   s = *(char **)closure;
808   t = s + strlen (s);
809   while (t > s && *--t == '/')
810     *t = '\0';
811
812   return 1;
813 }
814
815 /* Split VAL by space to a vector of values, and append those values
816    to vector pointed to by the CLOSURE argument.  If VAL is empty, the
817    CLOSURE vector is cleared instead.  */
818
819 static int
820 cmd_vector (const char *com, const char *val, void *closure)
821 {
822   char ***pvec = (char ***)closure;
823
824   if (*val)
825     *pvec = merge_vecs (*pvec, sepstring (val));
826   else
827     {
828       free_vec (*pvec);
829       *pvec = NULL;
830     }
831   return 1;
832 }
833
834 static int
835 cmd_directory_vector (const char *com, const char *val, void *closure)
836 {
837   char ***pvec = (char ***)closure;
838
839   if (*val)
840     {
841       /* Strip the trailing slashes from directories.  */
842       char **t, **seps;
843
844       seps = sepstring (val);
845       for (t = seps; t && *t; t++)
846         {
847           int len = strlen (*t);
848           /* Skip degenerate case of root directory.  */
849           if (len > 1)
850             {
851               if ((*t)[len - 1] == '/')
852                 (*t)[len - 1] = '\0';
853             }
854         }
855       *pvec = merge_vecs (*pvec, seps);
856     }
857   else
858     {
859       free_vec (*pvec);
860       *pvec = NULL;
861     }
862   return 1;
863 }
864
865 static int simple_atof PARAMS ((const char *, const char *, double *));
866
867 /* Enginge for cmd_bytes and cmd_bytes_large: converts a string such
868    as "100k" or "2.5G" to a floating point number.  */
869
870 static int
871 parse_bytes_helper (const char *val, double *result)
872 {
873   double number, mult;
874   const char *end = val + strlen (val);
875
876   /* Check for "inf".  */
877   if (0 == strcmp (val, "inf"))
878     {
879       *result = 0;
880       return 1;
881     }
882
883   /* Strip trailing whitespace.  */
884   while (val < end && ISSPACE (end[-1]))
885     --end;
886   if (val == end)
887     return 0;
888
889   switch (TOLOWER (end[-1]))
890     {
891     case 'k':
892       --end, mult = 1024.0;
893       break;
894     case 'm':
895       --end, mult = 1048576.0;
896       break;
897     case 'g':
898       --end, mult = 1073741824.0;
899       break;
900     case 't':
901       --end, mult = 1099511627776.0;
902       break;
903     default:
904       /* Not a recognized suffix: assume it's a digit.  (If not,
905          simple_atof will raise an error.)  */
906       mult = 1;
907     }
908
909   /* Skip leading and trailing whitespace. */
910   while (val < end && ISSPACE (*val))
911     ++val;
912   while (val < end && ISSPACE (end[-1]))
913     --end;
914   if (val == end)
915     return 0;
916
917   if (!simple_atof (val, end, &number))
918     return 0;
919
920   *result = number * mult;
921   return 1;
922 }
923
924 /* Parse VAL as a number and set its value to CLOSURE (which should
925    point to a long int).
926
927    By default, the value is assumed to be in bytes.  If "K", "M", or
928    "G" are appended, the value is multiplied with 1<<10, 1<<20, or
929    1<<30, respectively.  Floating point values are allowed and are
930    cast to integer before use.  The idea is to be able to use things
931    like 1.5k instead of "1536".
932
933    The string "inf" is returned as 0.
934
935    In case of error, 0 is returned and memory pointed to by CLOSURE
936    remains unmodified.  */
937
938 static int
939 cmd_bytes (const char *com, const char *val, void *closure)
940 {
941   double byte_value;
942   if (!parse_bytes_helper (val, &byte_value))
943     {
944       fprintf (stderr, _("%s: %s: Invalid byte value `%s'\n"),
945                exec_name, com, val);
946       return 0;
947     }
948   *(long *)closure = (long)byte_value;
949   return 1;
950 }
951
952 /* Like cmd_bytes, but CLOSURE is interpreted as a pointer to
953    LARGE_INT.  It works by converting the string to double, therefore
954    working with values up to 2^53-1 without loss of precision.  This
955    value (8192 TB) is large enough to serve for a while.  */
956
957 static int
958 cmd_bytes_large (const char *com, const char *val, void *closure)
959 {
960   double byte_value;
961   if (!parse_bytes_helper (val, &byte_value))
962     {
963       fprintf (stderr, _("%s: %s: Invalid byte value `%s'\n"),
964                exec_name, com, val);
965       return 0;
966     }
967   *(LARGE_INT *)closure = (LARGE_INT)byte_value;
968   return 1;
969 }
970
971 /* Store the value of VAL to *OUT.  The value is a time period, by
972    default expressed in seconds, but also accepting suffixes "m", "h",
973    "d", and "w" for minutes, hours, days, and weeks respectively.  */
974
975 static int
976 cmd_time (const char *com, const char *val, void *closure)
977 {
978   double number, mult;
979   const char *end = val + strlen (val);
980
981   /* Strip trailing whitespace.  */
982   while (val < end && ISSPACE (end[-1]))
983     --end;
984
985   if (val == end)
986     {
987     err:
988       fprintf (stderr, _("%s: %s: Invalid time period `%s'\n"),
989                exec_name, com, val);
990       return 0;
991     }
992
993   switch (TOLOWER (end[-1]))
994     {
995     case 's':
996       --end, mult = 1;          /* seconds */
997       break;
998     case 'm':
999       --end, mult = 60;         /* minutes */
1000       break;
1001     case 'h':
1002       --end, mult = 3600;       /* hours */
1003       break;
1004     case 'd':
1005       --end, mult = 86400.0;    /* days */
1006       break;
1007     case 'w':
1008       --end, mult = 604800.0;   /* weeks */
1009       break;
1010     default:
1011       /* Not a recognized suffix: assume it belongs to the number.
1012          (If not, atof simple_atof will raise an error.)  */
1013       mult = 1;
1014     }
1015
1016   /* Skip leading and trailing whitespace. */
1017   while (val < end && ISSPACE (*val))
1018     ++val;
1019   while (val < end && ISSPACE (end[-1]))
1020     --end;
1021   if (val == end)
1022     goto err;
1023
1024   if (!simple_atof (val, end, &number))
1025     goto err;
1026
1027   *(double *)closure = number * mult;
1028   return 1;
1029 }
1030 \f
1031 /* Specialized helper functions, used by `commands' to handle some
1032    options specially.  */
1033
1034 static int check_user_specified_header PARAMS ((const char *));
1035
1036 static int
1037 cmd_spec_dirstruct (const char *com, const char *val, void *closure)
1038 {
1039   if (!cmd_boolean (com, val, &opt.dirstruct))
1040     return 0;
1041   /* Since dirstruct behaviour is explicitly changed, no_dirstruct
1042      must be affected inversely.  */
1043   if (opt.dirstruct)
1044     opt.no_dirstruct = 0;
1045   else
1046     opt.no_dirstruct = 1;
1047   return 1;
1048 }
1049
1050 static int
1051 cmd_spec_header (const char *com, const char *val, void *closure)
1052 {
1053   if (!*val)
1054     {
1055       /* Empty header means reset headers.  */
1056       xfree_null (opt.user_header);
1057       opt.user_header = NULL;
1058     }
1059   else
1060     {
1061       int i;
1062
1063       if (!check_user_specified_header (val))
1064         {
1065           fprintf (stderr, _("%s: %s: Invalid header `%s'.\n"),
1066                    exec_name, com, val);
1067           return 0;
1068         }
1069       i = opt.user_header ? strlen (opt.user_header) : 0;
1070       opt.user_header = (char *)xrealloc (opt.user_header, i + strlen (val)
1071                                           + 2 + 1);
1072       strcpy (opt.user_header + i, val);
1073       i += strlen (val);
1074       opt.user_header[i++] = '\r';
1075       opt.user_header[i++] = '\n';
1076       opt.user_header[i] = '\0';
1077     }
1078   return 1;
1079 }
1080
1081 static int
1082 cmd_spec_htmlify (const char *com, const char *val, void *closure)
1083 {
1084   int flag = cmd_boolean (com, val, &opt.htmlify);
1085   if (flag && !opt.htmlify)
1086     opt.remove_listing = 0;
1087   return flag;
1088 }
1089
1090 /* Set the "mirror" mode.  It means: recursive download, timestamping,
1091    no limit on max. recursion depth, and don't remove listings.  */
1092
1093 static int
1094 cmd_spec_mirror (const char *com, const char *val, void *closure)
1095 {
1096   int mirror;
1097
1098   if (!cmd_boolean (com, val, &mirror))
1099     return 0;
1100   if (mirror)
1101     {
1102       opt.recursive = 1;
1103       if (!opt.no_dirstruct)
1104         opt.dirstruct = 1;
1105       opt.timestamping = 1;
1106       opt.reclevel = INFINITE_RECURSION;
1107       opt.remove_listing = 0;
1108     }
1109   return 1;
1110 }
1111
1112 /* Set progress.type to VAL, but verify that it's a valid progress
1113    implementation before that.  */
1114
1115 static int
1116 cmd_spec_progress (const char *com, const char *val, void *closure)
1117 {
1118   if (!valid_progress_implementation_p (val))
1119     {
1120       fprintf (stderr, _("%s: %s: Invalid progress type `%s'.\n"),
1121                exec_name, com, val);
1122       return 0;
1123     }
1124   xfree_null (opt.progress_type);
1125
1126   /* Don't call set_progress_implementation here.  It will be called
1127      in main() when it becomes clear what the log output is.  */
1128   opt.progress_type = xstrdup (val);
1129   return 1;
1130 }
1131
1132 /* Set opt.recursive to VAL as with cmd_boolean.  If opt.recursive is
1133    set to true, also set opt.dirstruct to 1, unless opt.no_dirstruct
1134    is specified.  */
1135
1136 static int
1137 cmd_spec_recursive (const char *com, const char *val, void *closure)
1138 {
1139   if (!cmd_boolean (com, val, &opt.recursive))
1140     return 0;
1141   else
1142     {
1143       if (opt.recursive && !opt.no_dirstruct)
1144         opt.dirstruct = 1;
1145     }
1146   return 1;
1147 }
1148
1149 static int
1150 cmd_spec_restrict_file_names (const char *com, const char *val, void *closure)
1151 {
1152   int restrict_os = opt.restrict_files_os;
1153   int restrict_ctrl = opt.restrict_files_ctrl;
1154
1155   const char *end = strchr (val, ',');
1156   if (!end)
1157     end = val + strlen (val);
1158
1159 #define VAL_IS(string_literal) BOUNDED_EQUAL (val, end, string_literal)
1160
1161   if (VAL_IS ("unix"))
1162     restrict_os = restrict_unix;
1163   else if (VAL_IS ("windows"))
1164     restrict_os = restrict_windows;
1165   else if (VAL_IS ("nocontrol"))
1166     restrict_ctrl = 0;
1167   else
1168     {
1169     err:
1170       fprintf (stderr,
1171                _("%s: %s: Invalid restriction `%s', use `unix' or `windows'.\n"),
1172                exec_name, com, val);
1173       return 0;
1174     }
1175
1176 #undef VAL_IS
1177
1178   if (*end)
1179     {
1180       if (!strcmp (end + 1, "nocontrol"))
1181         restrict_ctrl = 0;
1182       else
1183         goto err;
1184     }
1185
1186   opt.restrict_files_os = restrict_os;
1187   opt.restrict_files_ctrl = restrict_ctrl;
1188   return 1;
1189 }
1190
1191 /* Set all three timeout values. */
1192
1193 static int
1194 cmd_spec_timeout (const char *com, const char *val, void *closure)
1195 {
1196   double value;
1197   if (!cmd_time (com, val, &value))
1198     return 0;
1199   opt.read_timeout = value;
1200   opt.connect_timeout = value;
1201   opt.dns_timeout = value;
1202   return 1;
1203 }
1204
1205 static int
1206 cmd_spec_useragent (const char *com, const char *val, void *closure)
1207 {
1208   /* Just check for empty string and newline, so we don't throw total
1209      junk to the server.  */
1210   if (!*val || strchr (val, '\n'))
1211     {
1212       fprintf (stderr, _("%s: %s: Invalid value `%s'.\n"),
1213                exec_name, com, val);
1214       return 0;
1215     }
1216   opt.useragent = xstrdup (val);
1217   return 1;
1218 }
1219 \f
1220 /* Miscellaneous useful routines.  */
1221
1222 /* A very simple atoi clone, more portable than strtol and friends,
1223    but reports errors, unlike atoi.  Returns 1 on success, 0 on
1224    failure.  In case of success, stores result to *DEST.  */
1225
1226 static int
1227 simple_atoi (const char *beg, const char *end, int *dest)
1228 {
1229   int result = 0;
1230   const char *p;
1231
1232   if (beg == end)
1233     return 0;
1234
1235   for (p = beg; p < end && ISDIGIT (*p); p++)
1236     result = (10 * result) + (*p - '0');
1237
1238   if (p != end)
1239     return 0;
1240
1241   *dest = result;
1242   return 1;
1243 }
1244
1245 /* Trivial atof, with error reporting.  Handles "<digits>[.<digits>]",
1246    doesn't handle exponential notation.  Returns 1 on success, 0 on
1247    failure.  In case of success, stores its result to *DEST.  */
1248
1249 static int
1250 simple_atof (const char *beg, const char *end, double *dest)
1251 {
1252   double result = 0;
1253
1254   int seen_dot = 0;
1255   int seen_digit = 0;
1256   double divider = 1;
1257
1258   const char *p;
1259
1260   for (p = beg; p < end; p++)
1261     {
1262       char ch = *p;
1263       if (ISDIGIT (ch))
1264         {
1265           if (!seen_dot)
1266             result = (10 * result) + (ch - '0');
1267           else
1268             result += (ch - '0') / (divider *= 10);
1269           seen_digit = 1;
1270         }
1271       else if (ch == '.')
1272         {
1273           if (!seen_dot)
1274             seen_dot = 1;
1275           else
1276             return 0;
1277         }
1278       else
1279         return 0;
1280     }
1281   if (!seen_digit)
1282     return 0;
1283
1284   *dest = result;
1285   return 1;
1286 }
1287
1288 static int
1289 check_user_specified_header (const char *s)
1290 {
1291   const char *p;
1292
1293   for (p = s; *p && *p != ':' && !ISSPACE (*p); p++);
1294   /* The header MUST contain `:' preceded by at least one
1295      non-whitespace character.  */
1296   if (*p != ':' || p == s)
1297     return 0;
1298   /* The header MUST NOT contain newlines.  */
1299   if (strchr (s, '\n'))
1300     return 0;
1301   return 1;
1302 }
1303 \f
1304 void cleanup_html_url PARAMS ((void));
1305 void res_cleanup PARAMS ((void));
1306 void downloaded_files_free PARAMS ((void));
1307 void http_cleanup PARAMS ((void));
1308
1309
1310 /* Free the memory allocated by global variables.  */
1311 void
1312 cleanup (void)
1313 {
1314   /* Free external resources, close files, etc. */
1315
1316   if (opt.dfp)
1317     fclose (opt.dfp);
1318
1319   /* We're exiting anyway so there's no real need to call free()
1320      hundreds of times.  Skipping the frees will make Wget exit
1321      faster.
1322
1323      However, when detecting leaks, it's crucial to free() everything
1324      because then you can find the real leaks, i.e. the allocated
1325      memory which grows with the size of the program.  */
1326
1327 #ifdef DEBUG_MALLOC
1328   convert_cleanup ();
1329   res_cleanup ();
1330   http_cleanup ();
1331   cleanup_html_url ();
1332   downloaded_files_free ();
1333   host_cleanup ();
1334   if (wget_cookie_jar)
1335     cookie_jar_delete (wget_cookie_jar);
1336
1337   {
1338     extern acc_t *netrc_list;
1339     free_netrc (netrc_list);
1340   }
1341   xfree_null (opt.lfilename);
1342   xfree_null (opt.dir_prefix);
1343   xfree_null (opt.input_filename);
1344   xfree_null (opt.output_document);
1345   free_vec (opt.accepts);
1346   free_vec (opt.rejects);
1347   free_vec (opt.excludes);
1348   free_vec (opt.includes);
1349   free_vec (opt.domains);
1350   free_vec (opt.follow_tags);
1351   free_vec (opt.ignore_tags);
1352   xfree_null (opt.progress_type);
1353   xfree (opt.ftp_acc);
1354   xfree_null (opt.ftp_pass);
1355   xfree_null (opt.ftp_proxy);
1356   xfree_null (opt.https_proxy);
1357   xfree_null (opt.http_proxy);
1358   free_vec (opt.no_proxy);
1359   xfree_null (opt.useragent);
1360   xfree_null (opt.referer);
1361   xfree_null (opt.http_user);
1362   xfree_null (opt.http_passwd);
1363   xfree_null (opt.user_header);
1364 #ifdef HAVE_SSL
1365   xfree_null (opt.sslcertkey);
1366   xfree_null (opt.sslcertfile);
1367 #endif /* HAVE_SSL */
1368   xfree_null (opt.bind_address);
1369   xfree_null (opt.cookies_input);
1370   xfree_null (opt.cookies_output);
1371 #endif
1372 }