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