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