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