]> sjero.net Git - wget/blob - src/recur.c
[svn] Indentation change.
[wget] / src / recur.c
1 /* Handling of recursive HTTP retrieving.
2    Copyright (C) 1995, 1996, 1997, 2000, 2001 Free Software Foundation, Inc.
3
4 This file is part of GNU Wget.
5
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
19
20 #include <config.h>
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #ifdef HAVE_STRING_H
25 # include <string.h>
26 #else
27 # include <strings.h>
28 #endif /* HAVE_STRING_H */
29 #ifdef HAVE_UNISTD_H
30 # include <unistd.h>
31 #endif /* HAVE_UNISTD_H */
32 #include <errno.h>
33 #include <assert.h>
34 #include <sys/types.h>
35
36 #include "wget.h"
37 #include "url.h"
38 #include "recur.h"
39 #include "utils.h"
40 #include "retr.h"
41 #include "ftp.h"
42 #include "fnmatch.h"
43 #include "host.h"
44 #include "hash.h"
45 #include "res.h"
46
47 #ifndef errno
48 extern int errno;
49 #endif
50
51 extern char *version_string;
52
53 static struct hash_table *dl_file_url_map;
54 static struct hash_table *dl_url_file_map;
55
56 /* List of HTML files downloaded in this Wget run, used for link
57    conversion after Wget is done.  The list and the set contain the
58    same information, except the list maintains the order.  Perhaps I
59    should get rid of the list, it's there for historical reasons.  */
60 static slist *downloaded_html_list;
61 static struct hash_table *downloaded_html_set;
62
63 static void register_delete_file PARAMS ((const char *));
64 \f
65 /* Functions for maintaining the URL queue.  */
66
67 struct queue_element {
68   const char *url;
69   const char *referer;
70   int depth;
71   struct queue_element *next;
72 };
73
74 struct url_queue {
75   struct queue_element *head;
76   struct queue_element *tail;
77   int count, maxcount;
78 };
79
80 /* Create a URL queue. */
81
82 static struct url_queue *
83 url_queue_new (void)
84 {
85   struct url_queue *queue = xmalloc (sizeof (*queue));
86   memset (queue, '\0', sizeof (*queue));
87   return queue;
88 }
89
90 /* Delete a URL queue. */
91
92 static void
93 url_queue_delete (struct url_queue *queue)
94 {
95   xfree (queue);
96 }
97
98 /* Enqueue a URL in the queue.  The queue is FIFO: the items will be
99    retrieved ("dequeued") from the queue in the order they were placed
100    into it.  */
101
102 static void
103 url_enqueue (struct url_queue *queue,
104              const char *url, const char *referer, int depth)
105 {
106   struct queue_element *qel = xmalloc (sizeof (*qel));
107   qel->url = url;
108   qel->referer = referer;
109   qel->depth = depth;
110   qel->next = NULL;
111
112   ++queue->count;
113   if (queue->count > queue->maxcount)
114     queue->maxcount = queue->count;
115
116   DEBUGP (("Enqueuing %s at depth %d\n", url, depth));
117   DEBUGP (("Queue count %d, maxcount %d.\n", queue->count, queue->maxcount));
118
119   if (queue->tail)
120     queue->tail->next = qel;
121   queue->tail = qel;
122
123   if (!queue->head)
124     queue->head = queue->tail;
125 }
126
127 /* Take a URL out of the queue.  Return 1 if this operation succeeded,
128    or 0 if the queue is empty.  */
129
130 static int
131 url_dequeue (struct url_queue *queue,
132              const char **url, const char **referer, int *depth)
133 {
134   struct queue_element *qel = queue->head;
135
136   if (!qel)
137     return 0;
138
139   queue->head = queue->head->next;
140   if (!queue->head)
141     queue->tail = NULL;
142
143   *url = qel->url;
144   *referer = qel->referer;
145   *depth = qel->depth;
146
147   --queue->count;
148
149   DEBUGP (("Dequeuing %s at depth %d\n", qel->url, qel->depth));
150   DEBUGP (("Queue count %d, maxcount %d.\n", queue->count, queue->maxcount));
151
152   xfree (qel);
153   return 1;
154 }
155 \f
156 static int download_child_p PARAMS ((const struct urlpos *, struct url *, int,
157                                      struct url *, struct hash_table *));
158 static int descend_redirect_p PARAMS ((const char *, const char *, int,
159                                        struct url *, struct hash_table *));
160
161
162 /* Retrieve a part of the web beginning with START_URL.  This used to
163    be called "recursive retrieval", because the old function was
164    recursive and implemented depth-first search.  retrieve_tree on the
165    other hand implements breadth-search traversal of the tree, which
166    results in much nicer ordering of downloads.
167
168    The algorithm this function uses is simple:
169
170    1. put START_URL in the queue.
171    2. while there are URLs in the queue:
172
173      3. get next URL from the queue.
174      4. download it.
175      5. if the URL is HTML and its depth does not exceed maximum depth,
176         get the list of URLs embedded therein.
177      6. for each of those URLs do the following:
178
179        7. if the URL is not one of those downloaded before, and if it
180           satisfies the criteria specified by the various command-line
181           options, add it to the queue. */
182
183 uerr_t
184 retrieve_tree (const char *start_url)
185 {
186   uerr_t status = RETROK;
187
188   /* The queue of URLs we need to load. */
189   struct url_queue *queue;
190
191   /* The URLs we do not wish to enqueue, because they are already in
192      the queue, but haven't been downloaded yet.  */
193   struct hash_table *blacklist;
194
195   int up_error_code;
196   struct url *start_url_parsed = url_parse (start_url, &up_error_code);
197
198   if (!start_url_parsed)
199     {
200       logprintf (LOG_NOTQUIET, "%s: %s.\n", start_url,
201                  url_error (up_error_code));
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);
211   string_set_add (blacklist, start_url_parsed->url);
212
213   while (1)
214     {
215       int descend = 0;
216       char *url, *referer, *file = NULL;
217       int depth;
218       boolean dash_p_leaf_HTML = FALSE;
219
220       if (downloaded_exceeds_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))
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           if (string_set_contains (downloaded_html_set, file))
248             descend = 1;
249         }
250       else
251         {
252           int dt = 0;
253           char *redirected = NULL;
254           int oldrec = opt.recursive;
255
256           opt.recursive = 0;
257           status = retrieve_url (url, &file, &redirected, referer, &dt);
258           opt.recursive = oldrec;
259
260           if (file && status == RETROK
261               && (dt & RETROKF) && (dt & TEXTHTML))
262             descend = 1;
263
264           if (redirected)
265             {
266               /* We have been redirected, possibly to another host, or
267                  different path, or wherever.  Check whether we really
268                  want to follow it.  */
269               if (descend)
270                 {
271                   if (!descend_redirect_p (redirected, url, depth,
272                                            start_url_parsed, blacklist))
273                     descend = 0;
274                   else
275                     /* Make sure that the old pre-redirect form gets
276                        blacklisted. */
277                     string_set_add (blacklist, url);
278                 }
279
280               xfree (url);
281               url = redirected;
282             }
283         }
284
285       if (descend
286           && depth >= opt.reclevel && opt.reclevel != INFINITE_RECURSION)
287         {
288           if (opt.page_requisites
289               && (depth == opt.reclevel || depth == opt.reclevel + 1))
290             {
291               /* When -p is specified, we are allowed to exceed the
292                  maximum depth, but only for the "inline" links,
293                  i.e. those that are needed to display the page.
294                  Originally this could exceed the depth at most by
295                  one, but we allow one more level so that the leaf
296                  pages that contain frames can be loaded
297                  correctly.  */
298               dash_p_leaf_HTML = TRUE;
299             }
300           else
301             {
302               /* Either -p wasn't specified or it was and we've
303                  already spent the two extra (pseudo-)levels that it
304                  affords us, so we need to bail out. */
305               DEBUGP (("Not descending further; at depth %d, max. %d.\n",
306                        depth, opt.reclevel));
307               descend = 0;
308             }
309         }
310
311       /* If the downloaded document was HTML, parse it and enqueue the
312          links it contains. */
313
314       if (descend)
315         {
316           int meta_disallow_follow = 0;
317           struct urlpos *children
318             = get_urls_html (file, url, &meta_disallow_follow);
319
320           if (opt.use_robots && meta_disallow_follow)
321             {
322               free_urlpos (children);
323               children = NULL;
324             }
325
326           if (children)
327             {
328               struct urlpos *child = children;
329               struct url *url_parsed = url_parsed = url_parse (url, NULL);
330               assert (url_parsed != NULL);
331
332               for (; child; child = child->next)
333                 {
334                   if (child->ignore_when_downloading)
335                     continue;
336                   if (dash_p_leaf_HTML && !child->link_inline_p)
337                     continue;
338                   if (download_child_p (child, url_parsed, depth, start_url_parsed,
339                                         blacklist))
340                     {
341                       url_enqueue (queue, xstrdup (child->url->url),
342                                    xstrdup (url), depth + 1);
343                       /* We blacklist the URL we have enqueued, because we
344                          don't want to enqueue (and hence download) the
345                          same URL twice.  */
346                       string_set_add (blacklist, child->url->url);
347                     }
348                 }
349
350               url_free (url_parsed);
351               free_urlpos (children);
352             }
353         }
354
355       if (opt.delete_after || (file && !acceptable (file)))
356         {
357           /* Either --delete-after was specified, or we loaded this
358              otherwise rejected (e.g. by -R) HTML file just so we
359              could harvest its hyperlinks -- in either case, delete
360              the local file. */
361           DEBUGP (("Removing file due to %s in recursive_retrieve():\n",
362                    opt.delete_after ? "--delete-after" :
363                    "recursive rejection criteria"));
364           logprintf (LOG_VERBOSE,
365                      (opt.delete_after
366                       ? _("Removing %s.\n")
367                       : _("Removing %s since it should be rejected.\n")),
368                      file);
369           if (unlink (file))
370             logprintf (LOG_NOTQUIET, "unlink: %s\n", strerror (errno));
371           register_delete_file (file);
372         }
373
374       xfree (url);
375       FREE_MAYBE (referer);
376       FREE_MAYBE (file);
377     }
378
379   /* If anything is left of the queue due to a premature exit, free it
380      now.  */
381   {
382     char *d1, *d2;
383     int d3;
384     while (url_dequeue (queue, (const char **)&d1, (const char **)&d2, &d3))
385       {
386         xfree (d1);
387         FREE_MAYBE (d2);
388       }
389   }
390   url_queue_delete (queue);
391
392   if (start_url_parsed)
393     url_free (start_url_parsed);
394   string_set_free (blacklist);
395
396   if (downloaded_exceeds_quota ())
397     return QUOTEXC;
398   else if (status == FWRITEERR)
399     return FWRITEERR;
400   else
401     return RETROK;
402 }
403
404 /* Based on the context provided by retrieve_tree, decide whether a
405    URL is to be descended to.  This is only ever called from
406    retrieve_tree, but is in a separate function for clarity.
407
408    The most expensive checks (such as those for robots) are memoized
409    by storing these URLs to BLACKLIST.  This may or may not help.  It
410    will help if those URLs are encountered many times.  */
411
412 static int
413 download_child_p (const struct urlpos *upos, struct url *parent, int depth,
414                   struct url *start_url_parsed, struct hash_table *blacklist)
415 {
416   struct url *u = upos->url;
417   const char *url = u->url;
418
419   DEBUGP (("Deciding whether to enqueue \"%s\".\n", url));
420
421   if (string_set_contains (blacklist, url))
422     {
423       DEBUGP (("Already on the black list.\n"));
424       goto out;
425     }
426
427   /* Several things to check for:
428      1. if scheme is not http, and we don't load it
429      2. check for relative links (if relative_only is set)
430      3. check for domain
431      4. check for no-parent
432      5. check for excludes && includes
433      6. check for suffix
434      7. check for same host (if spanhost is unset), with possible
435      gethostbyname baggage
436      8. check for robots.txt
437
438      Addendum: If the URL is FTP, and it is to be loaded, only the
439      domain and suffix settings are "stronger".
440
441      Note that .html files will get loaded regardless of suffix rules
442      (but that is remedied later with unlink) unless the depth equals
443      the maximum depth.
444
445      More time- and memory- consuming tests should be put later on
446      the list.  */
447
448   /* 1. Schemes other than HTTP are normally not recursed into. */
449   if (u->scheme != SCHEME_HTTP
450 #ifdef HAVE_SSL
451       && u->scheme != SCHEME_HTTPS
452 #endif
453       && !(u->scheme == SCHEME_FTP && opt.follow_ftp))
454     {
455       DEBUGP (("Not following non-HTTP schemes.\n"));
456       goto out;
457     }
458
459   /* 2. If it is an absolute link and they are not followed, throw it
460      out.  */
461   if (u->scheme == SCHEME_HTTP
462 #ifdef HAVE_SSL
463       || u->scheme == SCHEME_HTTPS
464 #endif
465       )
466     if (opt.relative_only && !upos->link_relative_p)
467       {
468         DEBUGP (("It doesn't really look like a relative link.\n"));
469         goto out;
470       }
471
472   /* 3. If its domain is not to be accepted/looked-up, chuck it
473      out.  */
474   if (!accept_domain (u))
475     {
476       DEBUGP (("The domain was not accepted.\n"));
477       goto out;
478     }
479
480   /* 4. Check for parent directory.
481
482      If we descended to a different host or changed the scheme, ignore
483      opt.no_parent.  Also ignore it for documents needed to display
484      the parent page when in -p mode.  */
485   if (opt.no_parent
486       && u->scheme == start_url_parsed->scheme
487       && 0 == strcasecmp (u->host, start_url_parsed->host)
488       && u->port == start_url_parsed->port
489       && !(opt.page_requisites && upos->link_inline_p))
490     {
491       if (!frontcmp (start_url_parsed->dir, u->dir))
492         {
493           DEBUGP (("Going to \"%s\" would escape \"%s\" with no_parent on.\n",
494                    u->dir, start_url_parsed->dir));
495           goto out;
496         }
497     }
498
499   /* 5. If the file does not match the acceptance list, or is on the
500      rejection list, chuck it out.  The same goes for the directory
501      exclusion and inclusion lists.  */
502   if (opt.includes || opt.excludes)
503     {
504       if (!accdir (u->dir, ALLABS))
505         {
506           DEBUGP (("%s (%s) is excluded/not-included.\n", url, u->dir));
507           goto out;
508         }
509     }
510
511   /* 6. Check for acceptance/rejection rules.  We ignore these rules
512      for directories (no file name to match) and for HTML documents,
513      which might lead to other files that do need to be downloaded.
514      That is, unless we've exhausted the recursion depth anyway.  */
515   if (u->file[0] != '\0'
516       && !(has_html_suffix_p (u->file)
517            && depth != INFINITE_RECURSION
518            && depth < opt.reclevel - 1))
519     {
520       if (!acceptable (u->file))
521         {
522           DEBUGP (("%s (%s) does not match acc/rej rules.\n",
523                    url, u->file));
524           goto out;
525         }
526     }
527
528   /* 7. */
529   if (u->scheme == parent->scheme)
530     if (!opt.spanhost && 0 != strcasecmp (parent->host, u->host))
531       {
532         DEBUGP (("This is not the same hostname as the parent's (%s and %s).\n",
533                  u->host, parent->host));
534         goto out;
535       }
536
537   /* 8. */
538   if (opt.use_robots
539       && (u->scheme == SCHEME_HTTP
540 #ifdef HAVE_SSL
541           || u->scheme == SCHEME_HTTPS
542 #endif
543           )
544       )
545     {
546       struct robot_specs *specs = res_get_specs (u->host, u->port);
547       if (!specs)
548         {
549           char *rfile;
550           if (res_retrieve_file (url, &rfile))
551             {
552               specs = res_parse_from_file (rfile);
553               xfree (rfile);
554             }
555           else
556             {
557               /* If we cannot get real specs, at least produce
558                  dummy ones so that we can register them and stop
559                  trying to retrieve them.  */
560               specs = res_parse ("", 0);
561             }
562           res_register_specs (u->host, u->port, specs);
563         }
564
565       /* Now that we have (or don't have) robots.txt specs, we can
566          check what they say.  */
567       if (!res_match_path (specs, u->path))
568         {
569           DEBUGP (("Not following %s because robots.txt forbids it.\n", url));
570           string_set_add (blacklist, url);
571           goto out;
572         }
573     }
574
575   /* The URL has passed all the tests.  It can be placed in the
576      download queue. */
577   DEBUGP (("Decided to load it.\n"));
578
579   return 1;
580
581  out:
582   DEBUGP (("Decided NOT to load it.\n"));
583
584   return 0;
585 }
586
587 /* This function determines whether we will consider downloading the
588    children of a URL whose download resulted in a redirection,
589    possibly to another host, etc.  It is needed very rarely, and thus
590    it is merely a simple-minded wrapper around download_child_p.  */
591
592 static int
593 descend_redirect_p (const char *redirected, const char *original, int depth,
594                     struct url *start_url_parsed, struct hash_table *blacklist)
595 {
596   struct url *orig_parsed, *new_parsed;
597   struct urlpos *upos;
598   int success;
599
600   orig_parsed = url_parse (original, NULL);
601   assert (orig_parsed != NULL);
602
603   new_parsed = url_parse (redirected, NULL);
604   assert (new_parsed != NULL);
605
606   upos = xmalloc (sizeof (struct urlpos));
607   memset (upos, 0, sizeof (*upos));
608   upos->url = new_parsed;
609
610   success = download_child_p (upos, orig_parsed, depth,
611                               start_url_parsed, blacklist);
612
613   url_free (orig_parsed);
614   url_free (new_parsed);
615   xfree (upos);
616
617   if (!success)
618     DEBUGP (("Redirection \"%s\" failed the test.\n", redirected));
619
620   return success;
621 }
622
623 \f
624 #define ENSURE_TABLES_EXIST do {                        \
625   if (!dl_file_url_map)                                 \
626     dl_file_url_map = make_string_hash_table (0);       \
627   if (!dl_url_file_map)                                 \
628     dl_url_file_map = make_string_hash_table (0);       \
629 } while (0)
630
631 /* Return 1 if S1 and S2 are the same, except for "/index.html".  The
632    three cases in which it returns one are (substitute any substring
633    for "foo"):
634
635    m("foo/index.html", "foo/")  ==> 1
636    m("foo/", "foo/index.html")  ==> 1
637    m("foo", "foo/index.html")   ==> 1
638    m("foo", "foo/"              ==> 1
639    m("foo", "foo")              ==> 1  */
640
641 static int
642 match_except_index (const char *s1, const char *s2)
643 {
644   int i;
645   const char *lng;
646
647   /* Skip common substring. */
648   for (i = 0; *s1 && *s2 && *s1 == *s2; s1++, s2++, i++)
649     ;
650   if (i == 0)
651     /* Strings differ at the very beginning -- bail out.  We need to
652        check this explicitly to avoid `lng - 1' reading outside the
653        array.  */
654     return 0;
655
656   if (!*s1 && !*s2)
657     /* Both strings hit EOF -- strings are equal. */
658     return 1;
659   else if (*s1 && *s2)
660     /* Strings are randomly different, e.g. "/foo/bar" and "/foo/qux". */
661     return 0;
662   else if (*s1)
663     /* S1 is the longer one. */
664     lng = s1;
665   else
666     /* S2 is the longer one. */
667     lng = s2;
668
669   /* foo            */            /* foo/           */
670   /* foo/index.html */  /* or */  /* foo/index.html */
671   /*    ^           */            /*     ^          */
672
673   if (*lng != '/')
674     /* The right-hand case. */
675     --lng;
676
677   if (*lng == '/' && *(lng + 1) == '\0')
678     /* foo  */
679     /* foo/ */
680     return 1;
681
682   return 0 == strcmp (lng, "/index.html");
683 }
684
685 static int
686 dissociate_urls_from_file_mapper (void *key, void *value, void *arg)
687 {
688   char *mapping_url = (char *)key;
689   char *mapping_file = (char *)value;
690   char *file = (char *)arg;
691
692   if (0 == strcmp (mapping_file, file))
693     {
694       hash_table_remove (dl_url_file_map, mapping_url);
695       xfree (mapping_url);
696       xfree (mapping_file);
697     }
698
699   /* Continue mapping. */
700   return 0;
701 }
702
703 /* Remove all associations from various URLs to FILE from dl_url_file_map. */
704
705 static void
706 dissociate_urls_from_file (const char *file)
707 {
708   hash_table_map (dl_url_file_map, dissociate_urls_from_file_mapper,
709                   (char *)file);
710 }
711
712 /* Register that URL has been successfully downloaded to FILE.  This
713    is used by the link conversion code to convert references to URLs
714    to references to local files.  It is also being used to check if a
715    URL has already been downloaded.  */
716
717 void
718 register_download (const char *url, const char *file)
719 {
720   char *old_file, *old_url;
721
722   ENSURE_TABLES_EXIST;
723
724   /* With some forms of retrieval, it is possible, although not likely
725      or particularly desirable.  If both are downloaded, the second
726      download will override the first one.  When that happens,
727      dissociate the old file name from the URL.  */
728
729   if (hash_table_get_pair (dl_file_url_map, file, &old_file, &old_url))
730     {
731       if (0 == strcmp (url, old_url))
732         /* We have somehow managed to download the same URL twice.
733            Nothing to do.  */
734         return;
735
736       if (match_except_index (url, old_url)
737           && !hash_table_contains (dl_url_file_map, url))
738         /* The two URLs differ only in the "index.html" ending.  For
739            example, one is "http://www.server.com/", and the other is
740            "http://www.server.com/index.html".  Don't remove the old
741            one, just add the new one as a non-canonical entry.  */
742         goto url_only;
743
744       hash_table_remove (dl_file_url_map, file);
745       xfree (old_file);
746       xfree (old_url);
747
748       /* Remove all the URLs that point to this file.  Yes, there can
749          be more than one such URL, because we store redirections as
750          multiple entries in dl_url_file_map.  For example, if URL1
751          redirects to URL2 which gets downloaded to FILE, we map both
752          URL1 and URL2 to FILE in dl_url_file_map.  (dl_file_url_map
753          only points to URL2.)  When another URL gets loaded to FILE,
754          we want both URL1 and URL2 dissociated from it.
755
756          This is a relatively expensive operation because it performs
757          a linear search of the whole hash table, but it should be
758          called very rarely, only when two URLs resolve to the same
759          file name, *and* the "<file>.1" extensions are turned off.
760          In other words, almost never.  */
761       dissociate_urls_from_file (file);
762     }
763
764   hash_table_put (dl_file_url_map, xstrdup (file), xstrdup (url));
765
766  url_only:
767   /* A URL->FILE mapping is not possible without a FILE->URL mapping.
768      If the latter were present, it should have been removed by the
769      above `if'.  So we could write:
770
771          assert (!hash_table_contains (dl_url_file_map, url));
772
773      The above is correct when running in recursive mode where the
774      same URL always resolves to the same file.  But if you do
775      something like:
776
777          wget URL URL
778
779      then the first URL will resolve to "FILE", and the other to
780      "FILE.1".  In that case, FILE.1 will not be found in
781      dl_file_url_map, but URL will still point to FILE in
782      dl_url_file_map.  */
783   if (hash_table_get_pair (dl_url_file_map, url, &old_url, &old_file))
784     {
785       hash_table_remove (dl_url_file_map, url);
786       xfree (old_url);
787       xfree (old_file);
788     }
789
790   hash_table_put (dl_url_file_map, xstrdup (url), xstrdup (file));
791 }
792
793 /* Register that FROM has been redirected to TO.  This assumes that TO
794    is successfully downloaded and already registered using
795    register_download() above.  */
796
797 void
798 register_redirection (const char *from, const char *to)
799 {
800   char *file;
801
802   ENSURE_TABLES_EXIST;
803
804   file = hash_table_get (dl_url_file_map, to);
805   assert (file != NULL);
806   if (!hash_table_contains (dl_url_file_map, from))
807     hash_table_put (dl_url_file_map, xstrdup (from), xstrdup (file));
808 }
809
810 /* Register that the file has been deleted. */
811
812 static void
813 register_delete_file (const char *file)
814 {
815   char *old_url, *old_file;
816
817   ENSURE_TABLES_EXIST;
818
819   if (!hash_table_get_pair (dl_file_url_map, file, &old_file, &old_url))
820     return;
821
822   hash_table_remove (dl_file_url_map, file);
823   xfree (old_file);
824   xfree (old_url);
825   dissociate_urls_from_file (file);
826 }
827
828 /* Register that FILE is an HTML file that has been downloaded. */
829
830 void
831 register_html (const char *url, const char *file)
832 {
833   if (!downloaded_html_set)
834     downloaded_html_set = make_string_hash_table (0);
835   else if (hash_table_contains (downloaded_html_set, file))
836     return;
837
838   /* The set and the list should use the same copy of FILE, but the
839      slist interface insists on strduping the string it gets.  Oh
840      well. */
841   string_set_add (downloaded_html_set, file);
842   downloaded_html_list = slist_prepend (downloaded_html_list, file);
843 }
844
845 /* This function is called when the retrieval is done to convert the
846    links that have been downloaded.  It has to be called at the end of
847    the retrieval, because only then does Wget know conclusively which
848    URLs have been downloaded, and which not, so it can tell which
849    direction to convert to.
850
851    The "direction" means that the URLs to the files that have been
852    downloaded get converted to the relative URL which will point to
853    that file.  And the other URLs get converted to the remote URL on
854    the server.
855
856    All the downloaded HTMLs are kept in downloaded_html_files, and
857    downloaded URLs in urls_downloaded.  All the information is
858    extracted from these two lists.  */
859
860 void
861 convert_all_links (void)
862 {
863   slist *html;
864   long msecs;
865   int file_count = 0;
866
867   struct wget_timer *timer = wtimer_new ();
868
869   /* Destructively reverse downloaded_html_files to get it in the right order.
870      recursive_retrieve() used slist_prepend() consistently.  */
871   downloaded_html_list = slist_nreverse (downloaded_html_list);
872
873   for (html = downloaded_html_list; html; html = html->next)
874     {
875       struct urlpos *urls, *cur_url;
876       char *url;
877       char *file = html->string;
878
879       /* Determine the URL of the HTML file.  get_urls_html will need
880          it.  */
881       url = hash_table_get (dl_file_url_map, file);
882       if (!url)
883         {
884           DEBUGP (("Apparently %s has been removed.\n", file));
885           continue;
886         }
887
888       DEBUGP (("Scanning %s (from %s)\n", file, url));
889
890       /* Parse the HTML file...  */
891       urls = get_urls_html (file, url, NULL);
892
893       /* We don't respect meta_disallow_follow here because, even if
894          the file is not followed, we might still want to convert the
895          links that have been followed from other files.  */
896
897       for (cur_url = urls; cur_url; cur_url = cur_url->next)
898         {
899           char *local_name;
900           struct url *u = cur_url->url;
901
902           if (cur_url->link_base_p)
903             {
904               /* Base references have been resolved by our parser, so
905                  we turn the base URL into an empty string.  (Perhaps
906                  we should remove the tag entirely?)  */
907               cur_url->convert = CO_NULLIFY_BASE;
908               continue;
909             }
910
911           /* We decide the direction of conversion according to whether
912              a URL was downloaded.  Downloaded URLs will be converted
913              ABS2REL, whereas non-downloaded will be converted REL2ABS.  */
914           local_name = hash_table_get (dl_url_file_map, u->url);
915
916           /* Decide on the conversion type.  */
917           if (local_name)
918             {
919               /* We've downloaded this URL.  Convert it to relative
920                  form.  We do this even if the URL already is in
921                  relative form, because our directory structure may
922                  not be identical to that on the server (think `-nd',
923                  `--cut-dirs', etc.)  */
924               cur_url->convert = CO_CONVERT_TO_RELATIVE;
925               cur_url->local_name = xstrdup (local_name);
926               DEBUGP (("will convert url %s to local %s\n", u->url, local_name));
927             }
928           else
929             {
930               /* We haven't downloaded this URL.  If it's not already
931                  complete (including a full host name), convert it to
932                  that form, so it can be reached while browsing this
933                  HTML locally.  */
934               if (!cur_url->link_complete_p)
935                 cur_url->convert = CO_CONVERT_TO_COMPLETE;
936               cur_url->local_name = NULL;
937               DEBUGP (("will convert url %s to complete\n", u->url));
938             }
939         }
940
941       /* Convert the links in the file.  */
942       convert_links (file, urls);
943       ++file_count;
944
945       /* Free the data.  */
946       free_urlpos (urls);
947     }
948
949   msecs = wtimer_elapsed (timer);
950   wtimer_delete (timer);
951   logprintf (LOG_VERBOSE, _("Converted %d files in %.2f seconds.\n"),
952              file_count, (double)msecs / 1000);
953 }
954
955 /* Cleanup the data structures associated with recursive retrieving
956    (the variables above).  */
957 void
958 recursive_cleanup (void)
959 {
960   if (dl_file_url_map)
961     {
962       free_keys_and_values (dl_file_url_map);
963       hash_table_destroy (dl_file_url_map);
964       dl_file_url_map = NULL;
965     }
966   if (dl_url_file_map)
967     {
968       free_keys_and_values (dl_url_file_map);
969       hash_table_destroy (dl_url_file_map);
970       dl_url_file_map = NULL;
971     }
972   if (downloaded_html_set)
973     string_set_free (downloaded_html_set);
974   slist_free (downloaded_html_list);
975   downloaded_html_list = NULL;
976 }