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

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