sjero.net Git - wget/blob - src/init.c

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