1 /* Reading/parsing the initialization file.
2 Copyright (C) 2005 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
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.
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.
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.
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. */
51 #include "recur.h" /* for INFINITE_RECURSION */
52 #include "convert.h" /* for convert_cleanup */
53 #include "res.h" /* for res_cleanup */
55 /* We want tilde expansion enabled only when reading `.wgetrc' lines;
56 otherwise, it will be performed by the shell. This variable will
57 be set by the wgetrc-reading function. */
59 static bool enable_tilde_expansion;
62 #define CMD_DECLARE(func) static bool func (const char *, const char *, void *)
64 CMD_DECLARE (cmd_boolean);
65 CMD_DECLARE (cmd_bytes);
66 CMD_DECLARE (cmd_bytes_sum);
68 CMD_DECLARE (cmd_cert_type);
70 CMD_DECLARE (cmd_directory_vector);
71 CMD_DECLARE (cmd_number);
72 CMD_DECLARE (cmd_number_inf);
73 CMD_DECLARE (cmd_string);
74 CMD_DECLARE (cmd_file);
75 CMD_DECLARE (cmd_directory);
76 CMD_DECLARE (cmd_time);
77 CMD_DECLARE (cmd_vector);
79 CMD_DECLARE (cmd_spec_dirstruct);
80 CMD_DECLARE (cmd_spec_header);
81 CMD_DECLARE (cmd_spec_htmlify);
82 CMD_DECLARE (cmd_spec_mirror);
83 CMD_DECLARE (cmd_spec_prefer_family);
84 CMD_DECLARE (cmd_spec_progress);
85 CMD_DECLARE (cmd_spec_recursive);
86 CMD_DECLARE (cmd_spec_restrict_file_names);
88 CMD_DECLARE (cmd_spec_secure_protocol);
90 CMD_DECLARE (cmd_spec_timeout);
91 CMD_DECLARE (cmd_spec_useragent);
92 CMD_DECLARE (cmd_spec_verbose);
94 /* List of recognized commands, each consisting of name, place and
95 function. When adding a new command, simply add it to the list,
96 but be sure to keep the list sorted alphabetically, as
97 command_by_name depends on it. Also, be sure to add any entries
98 that allocate memory (e.g. cmd_string and cmd_vector) to the
99 cleanup() function below. */
104 bool (*action) (const char *, const char *, void *);
106 { "accept", &opt.accepts, cmd_vector },
107 { "addhostdir", &opt.add_hostdir, cmd_boolean },
108 { "alwaysrest", &opt.always_rest, cmd_boolean }, /* deprecated */
109 { "background", &opt.background, cmd_boolean },
110 { "backupconverted", &opt.backup_converted, cmd_boolean },
111 { "backups", &opt.backups, cmd_number },
112 { "base", &opt.base_href, cmd_string },
113 { "bindaddress", &opt.bind_address, cmd_string },
115 { "cacertificate", &opt.ca_cert, cmd_file },
117 { "cache", &opt.allow_cache, cmd_boolean },
119 { "cadirectory", &opt.ca_directory, cmd_directory },
120 { "certificate", &opt.cert_file, cmd_file },
121 { "certificatetype", &opt.cert_type, cmd_cert_type },
122 { "checkcertificate", &opt.check_cert, cmd_boolean },
124 { "connecttimeout", &opt.connect_timeout, cmd_time },
125 { "continue", &opt.always_rest, cmd_boolean },
126 { "convertlinks", &opt.convert_links, cmd_boolean },
127 { "cookies", &opt.cookies, cmd_boolean },
128 { "cutdirs", &opt.cut_dirs, cmd_number },
130 { "debug", &opt.debug, cmd_boolean },
132 { "deleteafter", &opt.delete_after, cmd_boolean },
133 { "dirprefix", &opt.dir_prefix, cmd_directory },
134 { "dirstruct", NULL, cmd_spec_dirstruct },
135 { "dnscache", &opt.dns_cache, cmd_boolean },
136 { "dnstimeout", &opt.dns_timeout, cmd_time },
137 { "domains", &opt.domains, cmd_vector },
138 { "dotbytes", &opt.dot_bytes, cmd_bytes },
139 { "dotsinline", &opt.dots_in_line, cmd_number },
140 { "dotspacing", &opt.dot_spacing, cmd_number },
141 { "dotstyle", &opt.dot_style, cmd_string },
143 { "egdfile", &opt.egd_file, cmd_file },
145 { "excludedirectories", &opt.excludes, cmd_directory_vector },
146 { "excludedomains", &opt.exclude_domains, cmd_vector },
147 { "followftp", &opt.follow_ftp, cmd_boolean },
148 { "followtags", &opt.follow_tags, cmd_vector },
149 { "forcehtml", &opt.force_html, cmd_boolean },
150 { "ftppasswd", &opt.ftp_passwd, cmd_string }, /* deprecated */
151 { "ftppassword", &opt.ftp_passwd, cmd_string },
152 { "ftpproxy", &opt.ftp_proxy, cmd_string },
153 { "ftpuser", &opt.ftp_user, cmd_string },
154 { "glob", &opt.ftp_glob, cmd_boolean },
155 { "header", NULL, cmd_spec_header },
156 { "htmlextension", &opt.html_extension, cmd_boolean },
157 { "htmlify", NULL, cmd_spec_htmlify },
158 { "httpkeepalive", &opt.http_keep_alive, cmd_boolean },
159 { "httppasswd", &opt.http_passwd, cmd_string }, /* deprecated */
160 { "httppassword", &opt.http_passwd, cmd_string },
161 { "httpproxy", &opt.http_proxy, cmd_string },
162 { "httpsproxy", &opt.https_proxy, cmd_string },
163 { "httpuser", &opt.http_user, cmd_string },
164 { "ignorelength", &opt.ignore_length, cmd_boolean },
165 { "ignoretags", &opt.ignore_tags, cmd_vector },
166 { "includedirectories", &opt.includes, cmd_directory_vector },
168 { "inet4only", &opt.ipv4_only, cmd_boolean },
169 { "inet6only", &opt.ipv6_only, cmd_boolean },
171 { "input", &opt.input_filename, cmd_file },
172 { "keepsessioncookies", &opt.keep_session_cookies, cmd_boolean },
173 { "killlonger", &opt.kill_longer, cmd_boolean },
174 { "limitrate", &opt.limit_rate, cmd_bytes },
175 { "loadcookies", &opt.cookies_input, cmd_file },
176 { "logfile", &opt.lfilename, cmd_file },
177 { "login", &opt.ftp_user, cmd_string },/* deprecated*/
178 { "mirror", NULL, cmd_spec_mirror },
179 { "netrc", &opt.netrc, cmd_boolean },
180 { "noclobber", &opt.noclobber, cmd_boolean },
181 { "noparent", &opt.no_parent, cmd_boolean },
182 { "noproxy", &opt.no_proxy, cmd_vector },
183 { "numtries", &opt.ntry, cmd_number_inf },/* deprecated*/
184 { "outputdocument", &opt.output_document, cmd_file },
185 { "pagerequisites", &opt.page_requisites, cmd_boolean },
186 { "passiveftp", &opt.ftp_pasv, cmd_boolean },
187 { "passwd", &opt.ftp_passwd, cmd_string },/* deprecated*/
188 { "password", &opt.passwd, cmd_string },
189 { "postdata", &opt.post_data, cmd_string },
190 { "postfile", &opt.post_file_name, cmd_file },
191 { "preferfamily", NULL, cmd_spec_prefer_family },
192 { "preservepermissions", &opt.preserve_perm, cmd_boolean },
194 { "privatekey", &opt.private_key, cmd_file },
195 { "privatekeytype", &opt.private_key_type, cmd_cert_type },
197 { "progress", &opt.progress_type, cmd_spec_progress },
198 { "protocoldirectories", &opt.protocol_directories, cmd_boolean },
199 { "proxypasswd", &opt.proxy_passwd, cmd_string }, /* deprecated */
200 { "proxypassword", &opt.proxy_passwd, cmd_string },
201 { "proxyuser", &opt.proxy_user, cmd_string },
202 { "quiet", &opt.quiet, cmd_boolean },
203 { "quota", &opt.quota, cmd_bytes_sum },
205 { "randomfile", &opt.random_file, cmd_file },
207 { "randomwait", &opt.random_wait, cmd_boolean },
208 { "readtimeout", &opt.read_timeout, cmd_time },
209 { "reclevel", &opt.reclevel, cmd_number_inf },
210 { "recursive", NULL, cmd_spec_recursive },
211 { "referer", &opt.referer, cmd_string },
212 { "reject", &opt.rejects, cmd_vector },
213 { "relativeonly", &opt.relative_only, cmd_boolean },
214 { "removelisting", &opt.remove_listing, cmd_boolean },
215 { "restrictfilenames", NULL, cmd_spec_restrict_file_names },
216 { "retrsymlinks", &opt.retr_symlinks, cmd_boolean },
217 { "retryconnrefused", &opt.retry_connrefused, cmd_boolean },
218 { "robots", &opt.use_robots, cmd_boolean },
219 { "savecookies", &opt.cookies_output, cmd_file },
220 { "saveheaders", &opt.save_headers, cmd_boolean },
222 { "secureprotocol", &opt.secure_protocol, cmd_spec_secure_protocol },
224 { "serverresponse", &opt.server_response, cmd_boolean },
225 { "spanhosts", &opt.spanhost, cmd_boolean },
226 { "spider", &opt.spider, cmd_boolean },
227 { "strictcomments", &opt.strict_comments, cmd_boolean },
228 { "timeout", NULL, cmd_spec_timeout },
229 { "timestamping", &opt.timestamping, cmd_boolean },
230 { "tries", &opt.ntry, cmd_number_inf },
231 { "useproxy", &opt.use_proxy, cmd_boolean },
232 { "user", &opt.user, cmd_string },
233 { "useragent", NULL, cmd_spec_useragent },
234 { "verbose", NULL, cmd_spec_verbose },
235 { "wait", &opt.wait, cmd_time },
236 { "waitretry", &opt.waitretry, cmd_time }
239 /* Look up CMDNAME in the commands[] and return its position in the
240 array. If CMDNAME is not found, return -1. */
243 command_by_name (const char *cmdname)
245 /* Use binary search for speed. Wget has ~100 commands, which
246 guarantees a worst case performance of 7 string comparisons. */
247 int lo = 0, hi = countof (commands) - 1;
251 int mid = (lo + hi) >> 1;
252 int cmp = strcasecmp (cmdname, commands[mid].name);
263 /* Reset the variables to default values. */
269 /* Most of the default values are 0 (and 0.0, NULL, and false).
270 Just reset everything, and fill in the non-zero values. Note
271 that initializing pointers to NULL this way is technically
272 illegal, but porting Wget to a machine where NULL is not all-zero
273 bit pattern will be the least of the implementors' worries. */
280 opt.add_hostdir = true;
284 opt.http_keep_alive = true;
285 opt.use_proxy = true;
286 tmp = getenv ("no_proxy");
288 opt.no_proxy = sepstring (tmp);
289 opt.allow_cache = true;
291 opt.read_timeout = 900;
292 opt.use_robots = true;
294 opt.remove_listing = true;
296 opt.dot_bytes = 1024;
297 opt.dot_spacing = 10;
298 opt.dots_in_line = 50;
300 opt.dns_cache = true;
304 opt.check_cert = true;
307 /* The default for file name restriction defaults to the OS type. */
308 #if !defined(WINDOWS) && !defined(__CYGWIN__)
309 opt.restrict_files_os = restrict_unix;
311 opt.restrict_files_os = restrict_windows;
313 opt.restrict_files_ctrl = true;
316 /* Return the user's home directory (strdup-ed), or NULL if none is
321 char *home = getenv ("HOME");
326 /* If HOME is not defined, try getting it from the password
328 struct passwd *pwd = getpwuid (getuid ());
329 if (!pwd || !pwd->pw_dir)
333 /* Under Windows, if $HOME isn't defined, use the directory where
334 `wget.exe' resides. */
339 return home ? xstrdup (home) : NULL;
342 /* Return the path to the user's .wgetrc. This is either the value of
343 `WGETRC' environment variable, or `$HOME/.wgetrc'.
345 If the `WGETRC' variable exists but the file does not exist, the
346 function will exit(). */
348 wgetrc_file_name (void)
353 /* Try the environment. */
354 env = getenv ("WGETRC");
357 if (!file_exists_p (env))
359 fprintf (stderr, _("%s: WGETRC points to %s, which doesn't exist.\n"),
363 return xstrdup (env);
366 /* If that failed, try $HOME/.wgetrc. */
369 file = aprintf ("%s/.wgetrc", home);
373 /* Under Windows, if we still haven't found .wgetrc, look for the file
374 `wget.ini' in the directory where `wget.exe' resides; we do this for
375 backward compatibility with previous versions of Wget.
376 SYSTEM_WGETRC should not be defined under WINDOWS. */
377 if (!file || !file_exists_p (file))
383 file = aprintf ("%s/wget.ini", home);
389 if (!file_exists_p (file))
397 /* Return values of parse_line. */
405 static enum parse_line parse_line (const char *, char **, char **, int *);
406 static bool setval_internal (int, const char *, const char *);
408 /* Initialize variables from a wgetrc file. Returns zero (failure) if
409 there were errors in the file. */
412 run_wgetrc (const char *file)
419 fp = fopen (file, "rb");
422 fprintf (stderr, _("%s: Cannot read %s (%s).\n"), exec_name,
423 file, strerror (errno));
424 return true; /* not a fatal error */
426 enable_tilde_expansion = true;
428 while ((line = read_whole_line (fp)) != NULL)
430 char *com = NULL, *val = NULL;
433 /* Parse the line. */
434 switch (parse_line (line, &com, &val, &comind))
437 /* If everything is OK, set the value. */
438 if (!setval_internal (comind, com, val))
440 fprintf (stderr, _("%s: Error in %s at line %d.\n"),
441 exec_name, file, ln);
445 case line_syntax_error:
446 fprintf (stderr, _("%s: Syntax error in %s at line %d.\n"),
447 exec_name, file, ln);
450 case line_unknown_command:
451 fprintf (stderr, _("%s: Unknown command `%s' in %s at line %d.\n"),
452 exec_name, com, file, ln);
465 enable_tilde_expansion = false;
471 /* Initialize the defaults and run the system wgetrc and user's own
479 /* Load the hard-coded defaults. */
482 /* If SYSTEM_WGETRC is defined, use it. */
484 if (file_exists_p (SYSTEM_WGETRC))
485 ok &= run_wgetrc (SYSTEM_WGETRC);
487 /* Override it with your own, if one exists. */
488 file = wgetrc_file_name ();
491 /* #### We should canonicalize `file' and SYSTEM_WGETRC with
492 something like realpath() before comparing them with `strcmp' */
494 if (!strcmp (file, SYSTEM_WGETRC))
496 fprintf (stderr, _("\
497 %s: Warning: Both system and user wgetrc point to `%s'.\n"),
502 ok &= run_wgetrc (file);
504 /* If there were errors processing either `.wgetrc', abort. */
512 /* Remove dashes and underscores from S, modifying S in the
518 char *t = s; /* t - tortoise */
519 char *h = s; /* h - hare */
521 if (*h == '_' || *h == '-')
528 /* Parse the line pointed by line, with the syntax:
529 <sp>* command <sp>* = <sp>* value <sp>*
530 Uses malloc to allocate space for command and value.
532 Returns one of line_ok, line_empty, line_syntax_error, or
533 line_unknown_command.
535 In case of line_ok, *COM and *VAL point to freshly allocated
536 strings, and *COMIND points to com's index. In case of error or
537 empty line, their values are unmodified. */
539 static enum parse_line
540 parse_line (const char *line, char **com, char **val, int *comind)
543 const char *end = line + strlen (line);
544 const char *cmdstart, *cmdend;
545 const char *valstart, *valend;
550 /* Skip leading and trailing whitespace. */
551 while (*line && ISSPACE (*line))
553 while (end > line && ISSPACE (end[-1]))
556 /* Skip empty lines and comments. */
557 if (!*line || *line == '#')
563 while (p < end && (ISALPHA (*p) || *p == '_' || *p == '-'))
567 /* Skip '=', as well as any space before or after it. */
568 while (p < end && ISSPACE (*p))
570 if (p == end || *p != '=')
571 return line_syntax_error;
573 while (p < end && ISSPACE (*p))
579 /* The syntax is valid (even though the command might not be). Fill
580 in the command name and value. */
581 *com = strdupdelim (cmdstart, cmdend);
582 *val = strdupdelim (valstart, valend);
584 /* The line now known to be syntactically correct. Check whether
585 the command is valid. */
586 BOUNDED_TO_ALLOCA (cmdstart, cmdend, cmdcopy);
588 ind = command_by_name (cmdcopy);
590 return line_unknown_command;
592 /* Report success to the caller. */
597 /* Run commands[comind].action. */
600 setval_internal (int comind, const char *com, const char *val)
602 assert (0 <= comind && comind < countof (commands));
603 DEBUGP (("Setting %s (%s) to %s\n", com, commands[comind].name, val));
604 return commands[comind].action (com, val, commands[comind].place);
607 /* Run command COM with value VAL. If running the command produces an
608 error, report the error and exit.
610 This is intended to be called from main() to modify Wget's behavior
611 through command-line switches. Since COM is hard-coded in main(),
612 it is not canonicalized, and this aborts when COM is not found.
614 If COMIND's are exported to init.h, this function will be changed
615 to accept COMIND directly. */
618 setoptval (const char *com, const char *val, const char *optname)
620 /* Prepend "--" to OPTNAME. */
621 char *dd_optname = (char *) alloca (2 + strlen (optname) + 1);
624 strcpy (dd_optname + 2, optname);
626 assert (val != NULL);
627 if (!setval_internal (command_by_name (com), dd_optname, val))
631 /* Parse OPT into command and value and run it. For example,
632 run_command("foo=bar") is equivalent to setoptval("foo", "bar").
633 This is used by the `--execute' flag in main.c. */
636 run_command (const char *opt)
640 switch (parse_line (opt, &com, &val, &comind))
643 if (!setval_internal (comind, com, val))
649 fprintf (stderr, _("%s: Invalid --execute command `%s'\n"),
655 /* Generic helper functions, for use with `commands'. */
657 /* Forward declarations: */
662 static bool decode_string (const char *, const struct decode_item *, int, int *);
663 static bool simple_atoi (const char *, const char *, int *);
664 static bool simple_atof (const char *, const char *, double *);
666 #define CMP1(p, c0) (TOLOWER((p)[0]) == (c0) && (p)[1] == '\0')
668 #define CMP2(p, c0, c1) (TOLOWER((p)[0]) == (c0) \
669 && TOLOWER((p)[1]) == (c1) \
672 #define CMP3(p, c0, c1, c2) (TOLOWER((p)[0]) == (c0) \
673 && TOLOWER((p)[1]) == (c1) \
674 && TOLOWER((p)[2]) == (c2) \
678 /* Store the boolean value from VAL to PLACE. COM is ignored,
679 except for error messages. */
681 cmd_boolean (const char *com, const char *val, void *place)
685 if (CMP2 (val, 'o', 'n') || CMP3 (val, 'y', 'e', 's') || CMP1 (val, '1'))
686 /* "on", "yes" and "1" mean true. */
688 else if (CMP3 (val, 'o', 'f', 'f') || CMP2 (val, 'n', 'o') || CMP1 (val, '0'))
689 /* "off", "no" and "0" mean false. */
694 _("%s: %s: Invalid boolean `%s'; use `on' or `off'.\n"),
695 exec_name, com, val);
699 *(bool *) place = value;
703 /* Set the non-negative integer value from VAL to PLACE. With
704 incorrect specification, the number remains unchanged. */
706 cmd_number (const char *com, const char *val, void *place)
708 if (!simple_atoi (val, val + strlen (val), place)
709 || *(int *) place < 0)
711 fprintf (stderr, _("%s: %s: Invalid number `%s'.\n"),
712 exec_name, com, val);
718 /* Similar to cmd_number(), only accepts `inf' as a synonym for 0. */
720 cmd_number_inf (const char *com, const char *val, void *place)
722 if (!strcasecmp (val, "inf"))
727 return cmd_number (com, val, place);
730 /* Copy (strdup) the string at COM to a new location and place a
731 pointer to *PLACE. */
733 cmd_string (const char *com, const char *val, void *place)
735 char **pstring = (char **)place;
737 xfree_null (*pstring);
738 *pstring = xstrdup (val);
743 # define ISSEP(c) ((c) == '/')
745 # define ISSEP(c) ((c) == '/' || (c) == '\\')
748 /* Like the above, but handles tilde-expansion when reading a user's
749 `.wgetrc'. In that case, and if VAL begins with `~', the tilde
750 gets expanded to the user's home directory. */
752 cmd_file (const char *com, const char *val, void *place)
754 char **pstring = (char **)place;
756 xfree_null (*pstring);
758 /* #### If VAL is empty, perhaps should set *PLACE to NULL. */
760 if (!enable_tilde_expansion || !(*val == '~' && ISSEP (val[1])))
763 *pstring = xstrdup (val);
768 char *home = home_dir ();
772 homelen = strlen (home);
773 while (homelen && ISSEP (home[homelen - 1]))
774 home[--homelen] = '\0';
776 /* Skip the leading "~/". */
777 for (++val; ISSEP (*val); val++)
780 *pstring = concat_strings (home, "/", val, (char *) 0);
784 /* Convert "\" to "/". */
787 for (s = *pstring; *s; s++)
795 /* Like cmd_file, but strips trailing '/' characters. */
797 cmd_directory (const char *com, const char *val, void *place)
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, place))
809 while (t > s && *--t == '/')
815 /* Split VAL by space to a vector of values, and append those values
816 to vector pointed to by the PLACE argument. If VAL is empty, the
817 PLACE vector is cleared instead. */
820 cmd_vector (const char *com, const char *val, void *place)
822 char ***pvec = (char ***)place;
825 *pvec = merge_vecs (*pvec, sepstring (val));
835 cmd_directory_vector (const char *com, const char *val, void *place)
837 char ***pvec = (char ***)place;
841 /* Strip the trailing slashes from directories. */
844 seps = sepstring (val);
845 for (t = seps; t && *t; t++)
847 int len = strlen (*t);
848 /* Skip degenerate case of root directory. */
851 if ((*t)[len - 1] == '/')
852 (*t)[len - 1] = '\0';
855 *pvec = merge_vecs (*pvec, seps);
865 /* Engine for cmd_bytes and cmd_bytes_sum: converts a string such as
866 "100k" or "2.5G" to a floating point number. */
869 parse_bytes_helper (const char *val, double *result)
872 const char *end = val + strlen (val);
874 /* Check for "inf". */
875 if (0 == strcmp (val, "inf"))
881 /* Strip trailing whitespace. */
882 while (val < end && ISSPACE (end[-1]))
887 switch (TOLOWER (end[-1]))
890 --end, mult = 1024.0;
893 --end, mult = 1048576.0;
896 --end, mult = 1073741824.0;
899 --end, mult = 1099511627776.0;
902 /* Not a recognized suffix: assume it's a digit. (If not,
903 simple_atof will raise an error.) */
907 /* Skip leading and trailing whitespace. */
908 while (val < end && ISSPACE (*val))
910 while (val < end && ISSPACE (end[-1]))
915 if (!simple_atof (val, end, &number) || number < 0)
918 *result = number * mult;
922 /* Parse VAL as a number and set its value to PLACE (which should
925 By default, the value is assumed to be in bytes. If "K", "M", or
926 "G" are appended, the value is multiplied with 1<<10, 1<<20, or
927 1<<30, respectively. Floating point values are allowed and are
928 cast to integer before use. The idea is to be able to use things
929 like 1.5k instead of "1536".
931 The string "inf" is returned as 0.
933 In case of error, false is returned and memory pointed to by PLACE
934 remains unmodified. */
937 cmd_bytes (const char *com, const char *val, void *place)
940 if (!parse_bytes_helper (val, &byte_value))
942 fprintf (stderr, _("%s: %s: Invalid byte value `%s'\n"),
943 exec_name, com, val);
946 *(wgint *)place = (wgint)byte_value;
950 /* Like cmd_bytes, but PLACE is interpreted as a pointer to
951 SIZE_SUM. It works by converting the string to double, therefore
952 working with values up to 2^53-1 without loss of precision. This
953 value (8192 TB) is large enough to serve for a while. */
956 cmd_bytes_sum (const char *com, const char *val, void *place)
959 if (!parse_bytes_helper (val, &byte_value))
961 fprintf (stderr, _("%s: %s: Invalid byte value `%s'\n"),
962 exec_name, com, val);
965 *(SUM_SIZE_INT *) place = (SUM_SIZE_INT) byte_value;
969 /* Store the value of VAL to *OUT. The value is a time period, by
970 default expressed in seconds, but also accepting suffixes "m", "h",
971 "d", and "w" for minutes, hours, days, and weeks respectively. */
974 cmd_time (const char *com, const char *val, void *place)
977 const char *end = val + strlen (val);
979 /* Strip trailing whitespace. */
980 while (val < end && ISSPACE (end[-1]))
986 fprintf (stderr, _("%s: %s: Invalid time period `%s'\n"),
987 exec_name, com, val);
991 switch (TOLOWER (end[-1]))
994 --end, mult = 1; /* seconds */
997 --end, mult = 60; /* minutes */
1000 --end, mult = 3600; /* hours */
1003 --end, mult = 86400.0; /* days */
1006 --end, mult = 604800.0; /* weeks */
1009 /* Not a recognized suffix: assume it belongs to the number.
1010 (If not, simple_atof will raise an error.) */
1014 /* Skip leading and trailing whitespace. */
1015 while (val < end && ISSPACE (*val))
1017 while (val < end && ISSPACE (end[-1]))
1022 if (!simple_atof (val, end, &number))
1025 *(double *)place = number * mult;
1031 cmd_cert_type (const char *com, const char *val, void *place)
1033 static const struct decode_item choices[] = {
1034 { "pem", keyfile_pem },
1035 { "der", keyfile_asn1 },
1036 { "asn1", keyfile_asn1 },
1038 int ok = decode_string (val, choices, countof (choices), place);
1040 fprintf (stderr, _("%s: %s: Invalid value `%s'.\n"), exec_name, com, val);
1045 /* Specialized helper functions, used by `commands' to handle some
1046 options specially. */
1048 static bool check_user_specified_header (const char *);
1051 cmd_spec_dirstruct (const char *com, const char *val, void *place_ignored)
1053 if (!cmd_boolean (com, val, &opt.dirstruct))
1055 /* Since dirstruct behaviour is explicitly changed, no_dirstruct
1056 must be affected inversely. */
1058 opt.no_dirstruct = false;
1060 opt.no_dirstruct = true;
1065 cmd_spec_header (const char *com, const char *val, void *place_ignored)
1067 /* Empty value means reset the list of headers. */
1070 free_vec (opt.user_headers);
1071 opt.user_headers = NULL;
1075 if (!check_user_specified_header (val))
1077 fprintf (stderr, _("%s: %s: Invalid header `%s'.\n"),
1078 exec_name, com, val);
1081 opt.user_headers = vec_append (opt.user_headers, val);
1086 cmd_spec_htmlify (const char *com, const char *val, void *place_ignored)
1088 int flag = cmd_boolean (com, val, &opt.htmlify);
1089 if (flag && !opt.htmlify)
1090 opt.remove_listing = false;
1094 /* Set the "mirror" mode. It means: recursive download, timestamping,
1095 no limit on max. recursion depth, and don't remove listings. */
1098 cmd_spec_mirror (const char *com, const char *val, void *place_ignored)
1102 if (!cmd_boolean (com, val, &mirror))
1106 opt.recursive = true;
1107 if (!opt.no_dirstruct)
1108 opt.dirstruct = true;
1109 opt.timestamping = true;
1110 opt.reclevel = INFINITE_RECURSION;
1111 opt.remove_listing = false;
1116 /* Validate --prefer-family and set the choice. Allowed values are
1117 "IPv4", "IPv6", and "none". */
1120 cmd_spec_prefer_family (const char *com, const char *val, void *place_ignored)
1122 static const struct decode_item choices[] = {
1123 { "IPv4", prefer_ipv4 },
1124 { "IPv6", prefer_ipv6 },
1125 { "none", prefer_none },
1127 int ok = decode_string (val, choices, countof (choices),
1128 (int *) &opt.prefer_family);
1130 fprintf (stderr, _("%s: %s: Invalid value `%s'.\n"), exec_name, com, val);
1134 /* Set progress.type to VAL, but verify that it's a valid progress
1135 implementation before that. */
1138 cmd_spec_progress (const char *com, const char *val, void *place_ignored)
1140 if (!valid_progress_implementation_p (val))
1142 fprintf (stderr, _("%s: %s: Invalid progress type `%s'.\n"),
1143 exec_name, com, val);
1146 xfree_null (opt.progress_type);
1148 /* Don't call set_progress_implementation here. It will be called
1149 in main() when it becomes clear what the log output is. */
1150 opt.progress_type = xstrdup (val);
1154 /* Set opt.recursive to VAL as with cmd_boolean. If opt.recursive is
1155 set to true, also set opt.dirstruct to true, unless opt.no_dirstruct
1159 cmd_spec_recursive (const char *com, const char *val, void *place_ignored)
1161 if (!cmd_boolean (com, val, &opt.recursive))
1165 if (opt.recursive && !opt.no_dirstruct)
1166 opt.dirstruct = true;
1172 cmd_spec_restrict_file_names (const char *com, const char *val, void *place_ignored)
1174 int restrict_os = opt.restrict_files_os;
1175 int restrict_ctrl = opt.restrict_files_ctrl;
1177 const char *end = strchr (val, ',');
1179 end = val + strlen (val);
1181 #define VAL_IS(string_literal) BOUNDED_EQUAL (val, end, string_literal)
1183 if (VAL_IS ("unix"))
1184 restrict_os = restrict_unix;
1185 else if (VAL_IS ("windows"))
1186 restrict_os = restrict_windows;
1187 else if (VAL_IS ("nocontrol"))
1193 _("%s: %s: Invalid restriction `%s', use `unix' or `windows'.\n"),
1194 exec_name, com, val);
1202 if (!strcmp (end + 1, "nocontrol"))
1203 restrict_ctrl = false;
1208 opt.restrict_files_os = restrict_os;
1209 opt.restrict_files_ctrl = restrict_ctrl;
1215 cmd_spec_secure_protocol (const char *com, const char *val, void *place)
1217 static const struct decode_item choices[] = {
1218 { "auto", secure_protocol_auto },
1219 { "sslv2", secure_protocol_sslv2 },
1220 { "sslv3", secure_protocol_sslv3 },
1221 { "tlsv1", secure_protocol_tlsv1 },
1223 int ok = decode_string (val, choices, countof (choices), place);
1225 fprintf (stderr, _("%s: %s: Invalid value `%s'.\n"), exec_name, com, val);
1230 /* Set all three timeout values. */
1233 cmd_spec_timeout (const char *com, const char *val, void *place_ignored)
1236 if (!cmd_time (com, val, &value))
1238 opt.read_timeout = value;
1239 opt.connect_timeout = value;
1240 opt.dns_timeout = value;
1245 cmd_spec_useragent (const char *com, const char *val, void *place_ignored)
1247 /* Disallow embedded newlines. */
1248 if (strchr (val, '\n'))
1250 fprintf (stderr, _("%s: %s: Invalid value `%s'.\n"),
1251 exec_name, com, val);
1254 xfree_null (opt.useragent);
1255 opt.useragent = xstrdup (val);
1259 /* The "verbose" option cannot be cmd_boolean because the variable is
1260 not bool -- it's of type int (-1 means uninitialized because of
1261 some random hackery for disallowing -q -v). */
1264 cmd_spec_verbose (const char *com, const char *val, void *place_ignored)
1267 if (cmd_boolean (com, val, &flag))
1275 /* Miscellaneous useful routines. */
1277 /* A very simple atoi clone, more useful than atoi because it works on
1278 delimited strings, and has error reportage. Returns true on success,
1279 false on failure. If successful, stores result to *DEST. */
1282 simple_atoi (const char *beg, const char *end, int *dest)
1285 bool negative = false;
1286 const char *p = beg;
1288 while (p < end && ISSPACE (*p))
1290 if (p < end && (*p == '-' || *p == '+'))
1292 negative = (*p == '-');
1298 /* Read negative numbers in a separate loop because the most
1299 negative integer cannot be represented as a positive number. */
1302 for (; p < end && ISDIGIT (*p); p++)
1304 int next = (10 * result) + (*p - '0');
1306 return false; /* overflow */
1310 for (; p < end && ISDIGIT (*p); p++)
1312 int next = (10 * result) - (*p - '0');
1314 return false; /* underflow */
1325 /* Trivial atof, with error reporting. Handles "<digits>[.<digits>]",
1326 doesn't handle exponential notation. Returns true on success,
1327 false on failure. In case of success, stores its result to
1331 simple_atof (const char *beg, const char *end, double *dest)
1335 bool negative = false;
1336 bool seen_dot = false;
1337 bool seen_digit = false;
1340 const char *p = beg;
1342 while (p < end && ISSPACE (*p))
1344 if (p < end && (*p == '-' || *p == '+'))
1346 negative = (*p == '-');
1350 for (; p < end; p++)
1356 result = (10 * result) + (ch - '0');
1358 result += (ch - '0') / (divider *= 10);
1380 /* Verify that the user-specified header in S is valid. It must
1381 contain a colon preceded by non-white-space characters and must not
1382 contain newlines. */
1385 check_user_specified_header (const char *s)
1389 for (p = s; *p && *p != ':' && !ISSPACE (*p); p++);
1390 /* The header MUST contain `:' preceded by at least one
1391 non-whitespace character. */
1392 if (*p != ':' || p == s)
1394 /* The header MUST NOT contain newlines. */
1395 if (strchr (s, '\n'))
1400 /* Decode VAL into a number, according to ITEMS. */
1403 decode_string (const char *val, const struct decode_item *items, int itemcount,
1407 for (i = 0; i < itemcount; i++)
1408 if (0 == strcasecmp (val, items[i].name))
1410 *place = items[i].code;
1417 void cleanup_html_url (void);
1418 void http_cleanup (void);
1421 /* Free the memory allocated by global variables. */
1425 /* Free external resources, close files, etc. */
1428 extern FILE *output_stream;
1430 fclose (output_stream);
1431 /* No need to check for error because Wget flushes its output (and
1432 checks for errors) after any data arrives. */
1435 /* We're exiting anyway so there's no real need to call free()
1436 hundreds of times. Skipping the frees will make Wget exit
1439 However, when detecting leaks, it's crucial to free() everything
1440 because then you can find the real leaks, i.e. the allocated
1441 memory which grows with the size of the program. */
1447 cleanup_html_url ();
1452 extern acc_t *netrc_list;
1453 free_netrc (netrc_list);
1455 xfree_null (opt.lfilename);
1456 xfree_null (opt.dir_prefix);
1457 xfree_null (opt.input_filename);
1458 xfree_null (opt.output_document);
1459 free_vec (opt.accepts);
1460 free_vec (opt.rejects);
1461 free_vec (opt.excludes);
1462 free_vec (opt.includes);
1463 free_vec (opt.domains);
1464 free_vec (opt.follow_tags);
1465 free_vec (opt.ignore_tags);
1466 xfree_null (opt.progress_type);
1467 xfree_null (opt.ftp_user);
1468 xfree_null (opt.ftp_passwd);
1469 xfree_null (opt.ftp_proxy);
1470 xfree_null (opt.https_proxy);
1471 xfree_null (opt.http_proxy);
1472 free_vec (opt.no_proxy);
1473 xfree_null (opt.useragent);
1474 xfree_null (opt.referer);
1475 xfree_null (opt.http_user);
1476 xfree_null (opt.http_passwd);
1477 free_vec (opt.user_headers);
1479 xfree_null (opt.cert_file);
1480 xfree_null (opt.private_key);
1481 xfree_null (opt.ca_directory);
1482 xfree_null (opt.ca_cert);
1483 xfree_null (opt.random_file);
1484 xfree_null (opt.egd_file);
1486 xfree_null (opt.bind_address);
1487 xfree_null (opt.cookies_input);
1488 xfree_null (opt.cookies_output);
1489 xfree_null (opt.user);
1490 xfree_null (opt.passwd);
1491 #endif /* DEBUG_MALLOC */