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

   1 /* Handling of recursive HTTP retrieving.
   2    Copyright (C) 1996-2006 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 3 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, see <http://www.gnu.org/licenses/>.
  18
  19 In addition, as a special exception, the Free Software Foundation
  20 gives permission to link the code of its release of Wget with the
  21 OpenSSL project's "OpenSSL" library (or with modified versions of it
  22 that use the same license as the "OpenSSL" library), and distribute
  23 the linked executables.  You must obey the GNU General Public License
  24 in all respects for all of the code used other than "OpenSSL".  If you
  25 modify this file, you may extend this exception to your version of the
  26 file, but you are not obligated to do so.  If you do not wish to do
  27 so, delete this exception statement from your version.  */
  28
  29 #include <config.h>
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #ifdef HAVE_UNISTD_H
  35 # include <unistd.h>
  36 #endif /* HAVE_UNISTD_H */
  37 #include <errno.h>
  38 #include <assert.h>
  39
  40 #include "wget.h"
  41 #include "url.h"
  42 #include "recur.h"
  43 #include "utils.h"
  44 #include "retr.h"
  45 #include "ftp.h"
  46 #include "host.h"
  47 #include "hash.h"
  48 #include "res.h"
  49 #include "convert.h"
  50 #include "spider.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
 250           status = retrieve_url (url, &file, &redirected, referer, &dt, false);
 251
 252           if (html_allowed && file && status == RETROK
 253               && (dt & RETROKF) && (dt & TEXTHTML))
 254             descend = true;
 255
 256           if (redirected)
 257             {
 258               /* We have been redirected, possibly to another host, or
 259                  different path, or wherever.  Check whether we really
 260                  want to follow it.  */
 261               if (descend)
 262                 {
 263                   if (!descend_redirect_p (redirected, url, depth,
 264                                            start_url_parsed, blacklist))
 265                     descend = false;
 266                   else
 267                     /* Make sure that the old pre-redirect form gets
 268                        blacklisted. */
 269                     string_set_add (blacklist, url);
 270                 }
 271
 272               xfree (url);
 273               url = redirected;
 274             }
 275         }
 276
 277       if (opt.spider)
 278         {
 279           visited_url (url, referer);
 280         }
 281
 282       if (descend
 283           && depth >= opt.reclevel && opt.reclevel != INFINITE_RECURSION)
 284         {
 285           if (opt.page_requisites
 286               && (depth == opt.reclevel || depth == opt.reclevel + 1))
 287             {
 288               /* When -p is specified, we are allowed to exceed the
 289                  maximum depth, but only for the "inline" links,
 290                  i.e. those that are needed to display the page.
 291                  Originally this could exceed the depth at most by
 292                  one, but we allow one more level so that the leaf
 293                  pages that contain frames can be loaded
 294                  correctly.  */
 295               dash_p_leaf_HTML = true;
 296             }
 297           else
 298             {
 299               /* Either -p wasn't specified or it was and we've
 300                  already spent the two extra (pseudo-)levels that it
 301                  affords us, so we need to bail out. */
 302               DEBUGP (("Not descending further; at depth %d, max. %d.\n",
 303                        depth, opt.reclevel));
 304               descend = false;
 305             }
 306         }
 307
 308       /* If the downloaded document was HTML, parse it and enqueue the
 309          links it contains. */
 310
 311       if (descend)
 312         {
 313           bool meta_disallow_follow = false;
 314           struct urlpos *children
 315             = get_urls_html (file, url, &meta_disallow_follow);
 316
 317           if (opt.use_robots && meta_disallow_follow)
 318             {
 319               free_urlpos (children);
 320               children = NULL;
 321             }
 322
 323           if (children)
 324             {
 325               struct urlpos *child = children;
 326               struct url *url_parsed = url_parsed = url_parse (url, NULL);
 327               char *referer_url = url;
 328               bool strip_auth = url_parsed->user;
 329               assert (url_parsed != NULL);
 330
 331               /* Strip auth info if present */
 332               if (strip_auth)
 333                 referer_url = url_string (url_parsed, URL_AUTH_HIDE);
 334
 335               for (; child; child = child->next)
 336                 {
 337                   if (child->ignore_when_downloading)
 338                     continue;
 339                   if (dash_p_leaf_HTML && !child->link_inline_p)
 340                     continue;
 341                   if (download_child_p (child, url_parsed, depth, start_url_parsed,
 342                                         blacklist))
 343                     {
 344                       url_enqueue (queue, xstrdup (child->url->url),
 345                                    xstrdup (referer_url), depth + 1,
 346                                    child->link_expect_html);
 347                       /* We blacklist the URL we have enqueued, because we
 348                          don't want to enqueue (and hence download) the
 349                          same URL twice.  */
 350                       string_set_add (blacklist, child->url->url);
 351                     }
 352                 }
 353
 354               if (strip_auth)
 355                 xfree (referer_url);
 356               url_free (url_parsed);
 357               free_urlpos (children);
 358             }
 359         }
 360
 361       if (file
 362           && (opt.delete_after
 363               || opt.spider /* opt.recursive is implicitely true */
 364               || !acceptable (file)))
 365         {
 366           /* Either --delete-after was specified, or we loaded this
 367              (otherwise unneeded because of --spider or rejected by -R)
 368              HTML file just to harvest its hyperlinks -- in either case,
 369              delete the local file. */
 370           DEBUGP (("Removing file due to %s in recursive_retrieve():\n",
 371                    opt.delete_after ? "--delete-after" :
 372                    (opt.spider ? "--spider" :
 373                     "recursive rejection criteria")));
 374           logprintf (LOG_VERBOSE,
 375                      (opt.delete_after || opt.spider
 376                       ? _("Removing %s.\n")
 377                       : _("Removing %s since it should be rejected.\n")),
 378                      file);
 379           if (unlink (file))
 380             logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
 381           logputs (LOG_VERBOSE, "\n");
 382           register_delete_file (file);
 383         }
 384
 385       xfree (url);
 386       xfree_null (referer);
 387       xfree_null (file);
 388     }
 389
 390   /* If anything is left of the queue due to a premature exit, free it
 391      now.  */
 392   {
 393     char *d1, *d2;
 394     int d3;
 395     bool d4;
 396     while (url_dequeue (queue,
 397                         (const char **)&d1, (const char **)&d2, &d3, &d4))
 398       {
 399         xfree (d1);
 400         xfree_null (d2);
 401       }
 402   }
 403   url_queue_delete (queue);
 404
 405   if (start_url_parsed)
 406     url_free (start_url_parsed);
 407   string_set_free (blacklist);
 408
 409   if (opt.quota && total_downloaded_bytes > opt.quota)
 410     return QUOTEXC;
 411   else if (status == FWRITEERR)
 412     return FWRITEERR;
 413   else
 414     return RETROK;
 415 }
 416
 417 /* Based on the context provided by retrieve_tree, decide whether a
 418    URL is to be descended to.  This is only ever called from
 419    retrieve_tree, but is in a separate function for clarity.
 420
 421    The most expensive checks (such as those for robots) are memoized
 422    by storing these URLs to BLACKLIST.  This may or may not help.  It
 423    will help if those URLs are encountered many times.  */
 424
 425 static bool
 426 download_child_p (const struct urlpos *upos, struct url *parent, int depth,
 427                   struct url *start_url_parsed, struct hash_table *blacklist)
 428 {
 429   struct url *u = upos->url;
 430   const char *url = u->url;
 431   bool u_scheme_like_http;
 432
 433   DEBUGP (("Deciding whether to enqueue \"%s\".\n", url));
 434
 435   if (string_set_contains (blacklist, url))
 436     {
 437       if (opt.spider)
 438         {
 439           char *referrer = url_string (parent, URL_AUTH_HIDE_PASSWD);
 440           DEBUGP (("download_child_p: parent->url is: `%s'\n", parent->url));
 441           visited_url (url, referrer);
 442           xfree (referrer);
 443         }
 444       DEBUGP (("Already on the black list.\n"));
 445       goto out;
 446     }
 447
 448   /* Several things to check for:
 449      1. if scheme is not http, and we don't load it
 450      2. check for relative links (if relative_only is set)
 451      3. check for domain
 452      4. check for no-parent
 453      5. check for excludes && includes
 454      6. check for suffix
 455      7. check for same host (if spanhost is unset), with possible
 456      gethostbyname baggage
 457      8. check for robots.txt
 458
 459      Addendum: If the URL is FTP, and it is to be loaded, only the
 460      domain and suffix settings are "stronger".
 461
 462      Note that .html files will get loaded regardless of suffix rules
 463      (but that is remedied later with unlink) unless the depth equals
 464      the maximum depth.
 465
 466      More time- and memory- consuming tests should be put later on
 467      the list.  */
 468
 469   /* Determine whether URL under consideration has a HTTP-like scheme. */
 470   u_scheme_like_http = schemes_are_similar_p (u->scheme, SCHEME_HTTP);
 471
 472   /* 1. Schemes other than HTTP are normally not recursed into. */
 473   if (!u_scheme_like_http && !(u->scheme == SCHEME_FTP && opt.follow_ftp))
 474     {
 475       DEBUGP (("Not following non-HTTP schemes.\n"));
 476       goto out;
 477     }
 478
 479   /* 2. If it is an absolute link and they are not followed, throw it
 480      out.  */
 481   if (u_scheme_like_http)
 482     if (opt.relative_only && !upos->link_relative_p)
 483       {
 484         DEBUGP (("It doesn't really look like a relative link.\n"));
 485         goto out;
 486       }
 487
 488   /* 3. If its domain is not to be accepted/looked-up, chuck it
 489      out.  */
 490   if (!accept_domain (u))
 491     {
 492       DEBUGP (("The domain was not accepted.\n"));
 493       goto out;
 494     }
 495
 496   /* 4. Check for parent directory.
 497
 498      If we descended to a different host or changed the scheme, ignore
 499      opt.no_parent.  Also ignore it for documents needed to display
 500      the parent page when in -p mode.  */
 501   if (opt.no_parent
 502       && schemes_are_similar_p (u->scheme, start_url_parsed->scheme)
 503       && 0 == strcasecmp (u->host, start_url_parsed->host)
 504       && u->port == start_url_parsed->port
 505       && !(opt.page_requisites && upos->link_inline_p))
 506     {
 507       if (!subdir_p (start_url_parsed->dir, u->dir))
 508         {
 509           DEBUGP (("Going to \"%s\" would escape \"%s\" with no_parent on.\n",
 510                    u->dir, start_url_parsed->dir));
 511           goto out;
 512         }
 513     }
 514
 515   /* 5. If the file does not match the acceptance list, or is on the
 516      rejection list, chuck it out.  The same goes for the directory
 517      exclusion and inclusion lists.  */
 518   if (opt.includes || opt.excludes)
 519     {
 520       if (!accdir (u->dir))
 521         {
 522           DEBUGP (("%s (%s) is excluded/not-included.\n", url, u->dir));
 523           goto out;
 524         }
 525     }
 526
 527   /* 6. Check for acceptance/rejection rules.  We ignore these rules
 528      for directories (no file name to match) and for non-leaf HTMLs,
 529      which can lead to other files that do need to be downloaded.  (-p
 530      automatically implies non-leaf because with -p we can, if
 531      necesary, overstep the maximum depth to get the page requisites.)  */
 532   if (u->file[0] != '\0'
 533       && !(has_html_suffix_p (u->file)
 534            /* The exception only applies to non-leaf HTMLs (but -p
 535               always implies non-leaf because we can overstep the
 536               maximum depth to get the requisites): */
 537            && (/* non-leaf */
 538                opt.reclevel == INFINITE_RECURSION
 539                /* also non-leaf */
 540                || depth < opt.reclevel - 1
 541                /* -p, which implies non-leaf (see above) */
 542                || opt.page_requisites)))
 543     {
 544       if (!acceptable (u->file))
 545         {
 546           DEBUGP (("%s (%s) does not match acc/rej rules.\n",
 547                    url, u->file));
 548           goto out;
 549         }
 550     }
 551
 552   /* 7. */
 553   if (schemes_are_similar_p (u->scheme, parent->scheme))
 554     if (!opt.spanhost && 0 != strcasecmp (parent->host, u->host))
 555       {
 556         DEBUGP (("This is not the same hostname as the parent's (%s and %s).\n",
 557                  u->host, parent->host));
 558         goto out;
 559       }
 560
 561   /* 8. */
 562   if (opt.use_robots && u_scheme_like_http)
 563     {
 564       struct robot_specs *specs = res_get_specs (u->host, u->port);
 565       if (!specs)
 566         {
 567           char *rfile;
 568           if (res_retrieve_file (url, &rfile))
 569             {
 570               specs = res_parse_from_file (rfile);
 571               xfree (rfile);
 572             }
 573           else
 574             {
 575               /* If we cannot get real specs, at least produce
 576                  dummy ones so that we can register them and stop
 577                  trying to retrieve them.  */
 578               specs = res_parse ("", 0);
 579             }
 580           res_register_specs (u->host, u->port, specs);
 581         }
 582
 583       /* Now that we have (or don't have) robots.txt specs, we can
 584          check what they say.  */
 585       if (!res_match_path (specs, u->path))
 586         {
 587           DEBUGP (("Not following %s because robots.txt forbids it.\n", url));
 588           string_set_add (blacklist, url);
 589           goto out;
 590         }
 591     }
 592
 593   /* The URL has passed all the tests.  It can be placed in the
 594      download queue. */
 595   DEBUGP (("Decided to load it.\n"));
 596
 597   return true;
 598
 599  out:
 600   DEBUGP (("Decided NOT to load it.\n"));
 601
 602   return false;
 603 }
 604
 605 /* This function determines whether we will consider downloading the
 606    children of a URL whose download resulted in a redirection,
 607    possibly to another host, etc.  It is needed very rarely, and thus
 608    it is merely a simple-minded wrapper around download_child_p.  */
 609
 610 static bool
 611 descend_redirect_p (const char *redirected, const char *original, int depth,
 612                     struct url *start_url_parsed, struct hash_table *blacklist)
 613 {
 614   struct url *orig_parsed, *new_parsed;
 615   struct urlpos *upos;
 616   bool success;
 617
 618   orig_parsed = url_parse (original, NULL);
 619   assert (orig_parsed != NULL);
 620
 621   new_parsed = url_parse (redirected, NULL);
 622   assert (new_parsed != NULL);
 623
 624   upos = xnew0 (struct urlpos);
 625   upos->url = new_parsed;
 626
 627   success = download_child_p (upos, orig_parsed, depth,
 628                               start_url_parsed, blacklist);
 629
 630   url_free (orig_parsed);
 631   url_free (new_parsed);
 632   xfree (upos);
 633
 634   if (!success)
 635     DEBUGP (("Redirection \"%s\" failed the test.\n", redirected));
 636
 637   return success;
 638 }
 639
 640 /* vim:set sts=2 sw=2 cino+={s: */