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

   1 /* Handling of recursive HTTP retrieving.
   2    Copyright (C) 1996-2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Wget.
   5
   6 GNU Wget is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9  (at your option) any later version.
  10
  11 GNU Wget is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Wget; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 In addition, as a special exception, the Free Software Foundation
  21 gives permission to link the code of its release of Wget with the
  22 OpenSSL project's "OpenSSL" library (or with modified versions of it
  23 that use the same license as the "OpenSSL" library), and distribute
  24 the linked executables.  You must obey the GNU General Public License
  25 in all respects for all of the code used other than "OpenSSL".  If you
  26 modify this file, you may extend this exception to your version of the
  27 file, but you are not obligated to do so.  If you do not wish to do
  28 so, delete this exception statement from your version.  */
  29
  30 #include <config.h>
  31
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35 #ifdef HAVE_UNISTD_H
  36 # include <unistd.h>
  37 #endif /* HAVE_UNISTD_H */
  38 #include <errno.h>
  39 #include <assert.h>
  40
  41 #include "wget.h"
  42 #include "url.h"
  43 #include "recur.h"
  44 #include "utils.h"
  45 #include "retr.h"
  46 #include "ftp.h"
  47 #include "host.h"
  48 #include "hash.h"
  49 #include "res.h"
  50 #include "convert.h"
  51 \f
  52 /* Functions for maintaining the URL queue.  */
  53
  54 struct queue_element {
  55   const char *url;              /* the URL to download */
  56   const char *referer;          /* the referring document */
  57   int depth;                    /* the depth */
  58   bool html_allowed;            /* whether the document is allowed to
  59                                    be treated as HTML. */
  60
  61   struct queue_element *next;   /* next element in queue */
  62 };
  63
  64 struct url_queue {
  65   struct queue_element *head;
  66   struct queue_element *tail;
  67   int count, maxcount;
  68 };
  69
  70 /* Create a URL queue. */
  71
  72 static struct url_queue *
  73 url_queue_new (void)
  74 {
  75   struct url_queue *queue = xnew0 (struct url_queue);
  76   return queue;
  77 }
  78
  79 /* Delete a URL queue. */
  80
  81 static void
  82 url_queue_delete (struct url_queue *queue)
  83 {
  84   xfree (queue);
  85 }
  86
  87 /* Enqueue a URL in the queue.  The queue is FIFO: the items will be
  88    retrieved ("dequeued") from the queue in the order they were placed
  89    into it.  */
  90
  91 static void
  92 url_enqueue (struct url_queue *queue,
  93              const char *url, const char *referer, int depth, bool html_allowed)
  94 {
  95   struct queue_element *qel = xnew (struct queue_element);
  96   qel->url = url;
  97   qel->referer = referer;
  98   qel->depth = depth;
  99   qel->html_allowed = html_allowed;
 100   qel->next = NULL;
 101
 102   ++queue->count;
 103   if (queue->count > queue->maxcount)
 104     queue->maxcount = queue->count;
 105
 106   DEBUGP (("Enqueuing %s at depth %d\n", url, depth));
 107   DEBUGP (("Queue count %d, maxcount %d.\n", queue->count, queue->maxcount));
 108
 109   if (queue->tail)
 110     queue->tail->next = qel;
 111   queue->tail = qel;
 112
 113   if (!queue->head)
 114     queue->head = queue->tail;
 115 }
 116
 117 /* Take a URL out of the queue.  Return true if this operation
 118    succeeded, or false if the queue is empty.  */
 119
 120 static bool
 121 url_dequeue (struct url_queue *queue,
 122              const char **url, const char **referer, int *depth,
 123              bool *html_allowed)
 124 {
 125   struct queue_element *qel = queue->head;
 126
 127   if (!qel)
 128     return false;
 129
 130   queue->head = queue->head->next;
 131   if (!queue->head)
 132     queue->tail = NULL;
 133
 134   *url = qel->url;
 135   *referer = qel->referer;
 136   *depth = qel->depth;
 137   *html_allowed = qel->html_allowed;
 138
 139   --queue->count;
 140
 141   DEBUGP (("Dequeuing %s at depth %d\n", qel->url, qel->depth));
 142   DEBUGP (("Queue count %d, maxcount %d.\n", queue->count, queue->maxcount));
 143
 144   xfree (qel);
 145   return true;
 146 }
 147 \f
 148 static bool download_child_p (const struct urlpos *, struct url *, int,
 149                               struct url *, struct hash_table *);
 150 static bool descend_redirect_p (const char *, const char *, int,
 151                                 struct url *, struct hash_table *);
 152
 153
 154 /* Retrieve a part of the web beginning with START_URL.  This used to
 155    be called "recursive retrieval", because the old function was
 156    recursive and implemented depth-first search.  retrieve_tree on the
 157    other hand implements breadth-search traversal of the tree, which
 158    results in much nicer ordering of downloads.
 159
 160    The algorithm this function uses is simple:
 161
 162    1. put START_URL in the queue.
 163    2. while there are URLs in the queue:
 164
 165      3. get next URL from the queue.
 166      4. download it.
 167      5. if the URL is HTML and its depth does not exceed maximum depth,
 168         get the list of URLs embedded therein.
 169      6. for each of those URLs do the following:
 170
 171        7. if the URL is not one of those downloaded before, and if it
 172           satisfies the criteria specified by the various command-line
 173           options, add it to the queue. */
 174
 175 uerr_t
 176 retrieve_tree (const char *start_url)
 177 {
 178   uerr_t status = RETROK;
 179
 180   /* The queue of URLs we need to load. */
 181   struct url_queue *queue;
 182
 183   /* The URLs we do not wish to enqueue, because they are already in
 184      the queue, but haven't been downloaded yet.  */
 185   struct hash_table *blacklist;
 186
 187   int up_error_code;
 188   struct url *start_url_parsed = url_parse (start_url, &up_error_code);
 189
 190   if (!start_url_parsed)
 191     {
 192       logprintf (LOG_NOTQUIET, "%s: %s.\n", start_url,
 193                  url_error (up_error_code));
 194       return URLERROR;
 195     }
 196
 197   queue = url_queue_new ();
 198   blacklist = make_string_hash_table (0);
 199
 200   /* Enqueue the starting URL.  Use start_url_parsed->url rather than
 201      just URL so we enqueue the canonical form of the URL.  */
 202   url_enqueue (queue, xstrdup (start_url_parsed->url), NULL, 0, true);
 203   string_set_add (blacklist, start_url_parsed->url);
 204
 205   while (1)
 206     {
 207       bool descend = false;
 208       char *url, *referer, *file = NULL;
 209       int depth;
 210       bool html_allowed;
 211       bool dash_p_leaf_HTML = false;
 212
 213       if (opt.quota && total_downloaded_bytes > opt.quota)
 214         break;
 215       if (status == FWRITEERR)
 216         break;
 217
 218       /* Get the next URL from the queue... */
 219
 220       if (!url_dequeue (queue,
 221                         (const char **)&url, (const char **)&referer,
 222                         &depth, &html_allowed))
 223         break;
 224
 225       /* ...and download it.  Note that this download is in most cases
 226          unconditional, as download_child_p already makes sure a file
 227          doesn't get enqueued twice -- and yet this check is here, and
 228          not in download_child_p.  This is so that if you run `wget -r
 229          URL1 URL2', and a random URL is encountered once under URL1
 230          and again under URL2, but at a different (possibly smaller)
 231          depth, we want the URL's children to be taken into account
 232          the second time.  */
 233       if (dl_url_file_map && hash_table_contains (dl_url_file_map, url))
 234         {
 235           file = xstrdup (hash_table_get (dl_url_file_map, url));
 236
 237           DEBUGP (("Already downloaded \"%s\", reusing it from \"%s\".\n",
 238                    url, file));
 239
 240           if (html_allowed
 241               && downloaded_html_set
 242               && string_set_contains (downloaded_html_set, file))
 243             descend = true;
 244         }
 245       else
 246         {
 247           int dt = 0;
 248           char *redirected = NULL;
 249           bool oldrec = opt.recursive;
 250
 251           opt.recursive = false;
 252           status = retrieve_url (url, &file, &redirected, referer, &dt);
 253           opt.recursive = oldrec;
 254
 255           if (html_allowed && file && status == RETROK
 256               && (dt & RETROKF) && (dt & TEXTHTML))
 257             descend = true;
 258
 259           if (redirected)
 260             {
 261               /* We have been redirected, possibly to another host, or
 262                  different path, or wherever.  Check whether we really
 263                  want to follow it.  */
 264               if (descend)
 265                 {
 266                   if (!descend_redirect_p (redirected, url, depth,
 267                                            start_url_parsed, blacklist))
 268                     descend = false;
 269                   else
 270                     /* Make sure that the old pre-redirect form gets
 271                        blacklisted. */
 272                     string_set_add (blacklist, url);
 273                 }
 274
 275               xfree (url);
 276               url = redirected;
 277             }
 278         }
 279
 280       if (descend
 281           && depth >= opt.reclevel && opt.reclevel != INFINITE_RECURSION)
 282         {
 283           if (opt.page_requisites
 284               && (depth == opt.reclevel || depth == opt.reclevel + 1))
 285             {
 286               /* When -p is specified, we are allowed to exceed the
 287                  maximum depth, but only for the "inline" links,
 288                  i.e. those that are needed to display the page.
 289                  Originally this could exceed the depth at most by
 290                  one, but we allow one more level so that the leaf
 291                  pages that contain frames can be loaded
 292                  correctly.  */
 293               dash_p_leaf_HTML = true;
 294             }
 295           else
 296             {
 297               /* Either -p wasn't specified or it was and we've
 298                  already spent the two extra (pseudo-)levels that it
 299                  affords us, so we need to bail out. */
 300               DEBUGP (("Not descending further; at depth %d, max. %d.\n",
 301                        depth, opt.reclevel));
 302               descend = false;
 303             }
 304         }
 305
 306       /* If the downloaded document was HTML, parse it and enqueue the
 307          links it contains. */
 308
 309       if (descend)
 310         {
 311           bool meta_disallow_follow = false;
 312           struct urlpos *children
 313             = get_urls_html (file, url, &meta_disallow_follow);
 314
 315           if (opt.use_robots && meta_disallow_follow)
 316             {
 317               free_urlpos (children);
 318               children = NULL;
 319             }
 320
 321           if (children)
 322             {
 323               struct urlpos *child = children;
 324               struct url *url_parsed = url_parsed = url_parse (url, NULL);
 325               assert (url_parsed != NULL);
 326
 327               for (; child; child = child->next)
 328                 {
 329                   if (child->ignore_when_downloading)
 330                     continue;
 331                   if (dash_p_leaf_HTML && !child->link_inline_p)
 332                     continue;
 333                   if (download_child_p (child, url_parsed, depth, start_url_parsed,
 334                                         blacklist))
 335                     {
 336                       url_enqueue (queue, xstrdup (child->url->url),
 337                                    xstrdup (url), depth + 1,
 338                                    child->link_expect_html);
 339                       /* We blacklist the URL we have enqueued, because we
 340                          don't want to enqueue (and hence download) the
 341                          same URL twice.  */
 342                       string_set_add (blacklist, child->url->url);
 343                     }
 344                 }
 345
 346               url_free (url_parsed);
 347               free_urlpos (children);
 348             }
 349         }
 350
 351       if (opt.delete_after || (file && !acceptable (file)))
 352         {
 353           /* Either --delete-after was specified, or we loaded this
 354              otherwise rejected (e.g. by -R) HTML file just so we
 355              could harvest its hyperlinks -- in either case, delete
 356              the local file. */
 357           DEBUGP (("Removing file due to %s in recursive_retrieve():\n",
 358                    opt.delete_after ? "--delete-after" :
 359                    "recursive rejection criteria"));
 360           logprintf (LOG_VERBOSE,
 361                      (opt.delete_after
 362                       ? _("Removing %s.\n")
 363                       : _("Removing %s since it should be rejected.\n")),
 364                      file);
 365           if (unlink (file))
 366             logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
 367           register_delete_file (file);
 368         }
 369
 370       xfree (url);
 371       xfree_null (referer);
 372       xfree_null (file);
 373     }
 374
 375   /* If anything is left of the queue due to a premature exit, free it
 376      now.  */
 377   {
 378     char *d1, *d2;
 379     int d3;
 380     bool d4;
 381     while (url_dequeue (queue,
 382                         (const char **)&d1, (const char **)&d2, &d3, &d4))
 383       {
 384         xfree (d1);
 385         xfree_null (d2);
 386       }
 387   }
 388   url_queue_delete (queue);
 389
 390   if (start_url_parsed)
 391     url_free (start_url_parsed);
 392   string_set_free (blacklist);
 393
 394   if (opt.quota && total_downloaded_bytes > opt.quota)
 395     return QUOTEXC;
 396   else if (status == FWRITEERR)
 397     return FWRITEERR;
 398   else
 399     return RETROK;
 400 }
 401
 402 /* Based on the context provided by retrieve_tree, decide whether a
 403    URL is to be descended to.  This is only ever called from
 404    retrieve_tree, but is in a separate function for clarity.
 405
 406    The most expensive checks (such as those for robots) are memoized
 407    by storing these URLs to BLACKLIST.  This may or may not help.  It
 408    will help if those URLs are encountered many times.  */
 409
 410 static bool
 411 download_child_p (const struct urlpos *upos, struct url *parent, int depth,
 412                   struct url *start_url_parsed, struct hash_table *blacklist)
 413 {
 414   struct url *u = upos->url;
 415   const char *url = u->url;
 416   bool u_scheme_like_http;
 417
 418   DEBUGP (("Deciding whether to enqueue \"%s\".\n", url));
 419
 420   if (string_set_contains (blacklist, url))
 421     {
 422       DEBUGP (("Already on the black list.\n"));
 423       goto out;
 424     }
 425
 426   /* Several things to check for:
 427      1. if scheme is not http, and we don't load it
 428      2. check for relative links (if relative_only is set)
 429      3. check for domain
 430      4. check for no-parent
 431      5. check for excludes && includes
 432      6. check for suffix
 433      7. check for same host (if spanhost is unset), with possible
 434      gethostbyname baggage
 435      8. check for robots.txt
 436
 437      Addendum: If the URL is FTP, and it is to be loaded, only the
 438      domain and suffix settings are "stronger".
 439
 440      Note that .html files will get loaded regardless of suffix rules
 441      (but that is remedied later with unlink) unless the depth equals
 442      the maximum depth.
 443
 444      More time- and memory- consuming tests should be put later on
 445      the list.  */
 446
 447   /* Determine whether URL under consideration has a HTTP-like scheme. */
 448   u_scheme_like_http = schemes_are_similar_p (u->scheme, SCHEME_HTTP);
 449
 450   /* 1. Schemes other than HTTP are normally not recursed into. */
 451   if (!u_scheme_like_http && !(u->scheme == SCHEME_FTP && opt.follow_ftp))
 452     {
 453       DEBUGP (("Not following non-HTTP schemes.\n"));
 454       goto out;
 455     }
 456
 457   /* 2. If it is an absolute link and they are not followed, throw it
 458      out.  */
 459   if (u_scheme_like_http)
 460     if (opt.relative_only && !upos->link_relative_p)
 461       {
 462         DEBUGP (("It doesn't really look like a relative link.\n"));
 463         goto out;
 464       }
 465
 466   /* 3. If its domain is not to be accepted/looked-up, chuck it
 467      out.  */
 468   if (!accept_domain (u))
 469     {
 470       DEBUGP (("The domain was not accepted.\n"));
 471       goto out;
 472     }
 473
 474   /* 4. Check for parent directory.
 475
 476      If we descended to a different host or changed the scheme, ignore
 477      opt.no_parent.  Also ignore it for documents needed to display
 478      the parent page when in -p mode.  */
 479   if (opt.no_parent
 480       && schemes_are_similar_p (u->scheme, start_url_parsed->scheme)
 481       && 0 == strcasecmp (u->host, start_url_parsed->host)
 482       && u->port == start_url_parsed->port
 483       && !(opt.page_requisites && upos->link_inline_p))
 484     {
 485       if (!subdir_p (start_url_parsed->dir, u->dir))
 486         {
 487           DEBUGP (("Going to \"%s\" would escape \"%s\" with no_parent on.\n",
 488                    u->dir, start_url_parsed->dir));
 489           goto out;
 490         }
 491     }
 492
 493   /* 5. If the file does not match the acceptance list, or is on the
 494      rejection list, chuck it out.  The same goes for the directory
 495      exclusion and inclusion lists.  */
 496   if (opt.includes || opt.excludes)
 497     {
 498       if (!accdir (u->dir))
 499         {
 500           DEBUGP (("%s (%s) is excluded/not-included.\n", url, u->dir));
 501           goto out;
 502         }
 503     }
 504
 505   /* 6. Check for acceptance/rejection rules.  We ignore these rules
 506      for directories (no file name to match) and for non-leaf HTMLs,
 507      which can lead to other files that do need to be downloaded.  (-p
 508      automatically implies non-leaf because with -p we can, if
 509      necesary, overstep the maximum depth to get the page requisites.)  */
 510   if (u->file[0] != '\0'
 511       && !(has_html_suffix_p (u->file)
 512            /* The exception only applies to non-leaf HTMLs (but -p
 513               always implies non-leaf because we can overstep the
 514               maximum depth to get the requisites): */
 515            && (/* non-leaf */
 516                opt.reclevel == INFINITE_RECURSION
 517                /* also non-leaf */
 518                || depth < opt.reclevel - 1
 519                /* -p, which implies non-leaf (see above) */
 520                || opt.page_requisites)))
 521     {
 522       if (!acceptable (u->file))
 523         {
 524           DEBUGP (("%s (%s) does not match acc/rej rules.\n",
 525                    url, u->file));
 526           goto out;
 527         }
 528     }
 529
 530   /* 7. */
 531   if (schemes_are_similar_p (u->scheme, parent->scheme))
 532     if (!opt.spanhost && 0 != strcasecmp (parent->host, u->host))
 533       {
 534         DEBUGP (("This is not the same hostname as the parent's (%s and %s).\n",
 535                  u->host, parent->host));
 536         goto out;
 537       }
 538
 539   /* 8. */
 540   if (opt.use_robots && u_scheme_like_http)
 541     {
 542       struct robot_specs *specs = res_get_specs (u->host, u->port);
 543       if (!specs)
 544         {
 545           char *rfile;
 546           if (res_retrieve_file (url, &rfile))
 547             {
 548               specs = res_parse_from_file (rfile);
 549               xfree (rfile);
 550             }
 551           else
 552             {
 553               /* If we cannot get real specs, at least produce
 554                  dummy ones so that we can register them and stop
 555                  trying to retrieve them.  */
 556               specs = res_parse ("", 0);
 557             }
 558           res_register_specs (u->host, u->port, specs);
 559         }
 560
 561       /* Now that we have (or don't have) robots.txt specs, we can
 562          check what they say.  */
 563       if (!res_match_path (specs, u->path))
 564         {
 565           DEBUGP (("Not following %s because robots.txt forbids it.\n", url));
 566           string_set_add (blacklist, url);
 567           goto out;
 568         }
 569     }
 570
 571   /* The URL has passed all the tests.  It can be placed in the
 572      download queue. */
 573   DEBUGP (("Decided to load it.\n"));
 574
 575   return true;
 576
 577  out:
 578   DEBUGP (("Decided NOT to load it.\n"));
 579
 580   return false;
 581 }
 582
 583 /* This function determines whether we will consider downloading the
 584    children of a URL whose download resulted in a redirection,
 585    possibly to another host, etc.  It is needed very rarely, and thus
 586    it is merely a simple-minded wrapper around download_child_p.  */
 587
 588 static bool
 589 descend_redirect_p (const char *redirected, const char *original, int depth,
 590                     struct url *start_url_parsed, struct hash_table *blacklist)
 591 {
 592   struct url *orig_parsed, *new_parsed;
 593   struct urlpos *upos;
 594   bool success;
 595
 596   orig_parsed = url_parse (original, NULL);
 597   assert (orig_parsed != NULL);
 598
 599   new_parsed = url_parse (redirected, NULL);
 600   assert (new_parsed != NULL);
 601
 602   upos = xnew0 (struct urlpos);
 603   upos->url = new_parsed;
 604
 605   success = download_child_p (upos, orig_parsed, depth,
 606                               start_url_parsed, blacklist);
 607
 608   url_free (orig_parsed);
 609   url_free (new_parsed);
 610   xfree (upos);
 611
 612   if (!success)
 613     DEBUGP (("Redirection \"%s\" failed the test.\n", redirected));
 614
 615   return success;
 616 }