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