sjero.net Git - wget/blob - src/html-url.c

   1 /* Collect URLs from HTML source.
   2    Copyright (C) 1998, 2000 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 #ifdef HAVE_STRING_H
  24 # include <string.h>
  25 #else
  26 # include <strings.h>
  27 #endif
  28 #include <stdlib.h>
  29 #include <errno.h>
  30 #include <assert.h>
  31
  32 #include "wget.h"
  33 #include "html-parse.h"
  34 #include "url.h"
  35 #include "utils.h"
  36
  37 #ifndef errno
  38 extern int errno;
  39 #endif
  40
  41 enum tag_category { TC_LINK, TC_SPEC };
  42
  43 /* Here we try to categorize the known tags.  Each tag has its ID and
  44    cetegory.  Category TC_LINK means that one or more of its
  45    attributes contain links that should be retrieved.  TC_SPEC means
  46    that the tag is specific in some way, and has to be handled
  47    specially. */
  48 static struct {
  49   const char *name;
  50   enum tag_category category;
  51 } known_tags[] = {
  52 #define TAG_A           0
  53   { "a",        TC_LINK },
  54 #define TAG_APPLET      1
  55   { "applet",   TC_LINK },
  56 #define TAG_AREA        2
  57   { "area",     TC_LINK },
  58 #define TAG_BASE        3
  59   { "base",     TC_SPEC },
  60 #define TAG_BGSOUND     4
  61   { "bgsound",  TC_LINK },
  62 #define TAG_BODY        5
  63   { "body",     TC_LINK },
  64 #define TAG_EMBED       6
  65   { "embed",    TC_LINK },
  66 #define TAG_FIG         7
  67   { "fig",      TC_LINK },
  68 #define TAG_FRAME       8
  69   { "frame",    TC_LINK },
  70 #define TAG_IFRAME      9
  71   { "iframe",   TC_LINK },
  72 #define TAG_IMG         10
  73   { "img",      TC_LINK },
  74 #define TAG_INPUT       11
  75   { "input",    TC_LINK },
  76 #define TAG_LAYER       12
  77   { "layer",    TC_LINK },
  78 #define TAG_LINK        13
  79   { "link",     TC_SPEC },
  80 #define TAG_META        14
  81   { "meta",     TC_SPEC },
  82 #define TAG_OVERLAY     15
  83   { "overlay",  TC_LINK },
  84 #define TAG_SCRIPT      16
  85   { "script",   TC_LINK },
  86 #define TAG_TABLE       17
  87   { "table",    TC_LINK },
  88 #define TAG_TD          18
  89   { "td",       TC_LINK },
  90 #define TAG_TH          19
  91   { "th",       TC_LINK }
  92 };
  93
  94
  95 /* Flags for specific url-attr pairs handled through TC_LINK: */
  96
  97 /* This tag points to an external document not necessary for rendering this
  98    document (i.e. it's not an inlined image, stylesheet, etc.). */
  99 #define AF_EXTERNAL 1
 100
 101
 102 /* For tags handled by TC_LINK: attributes that contain URLs to
 103    download. */
 104 static struct {
 105   int tagid;
 106   const char *attr_name;
 107   int flags;
 108 } url_tag_attr_map[] = {
 109   { TAG_A,              "href",         AF_EXTERNAL },
 110   { TAG_APPLET,         "code",         0 },
 111   { TAG_AREA,           "href",         AF_EXTERNAL },
 112   { TAG_BGSOUND,        "src",          0 },
 113   { TAG_BODY,           "background",   0 },
 114   { TAG_EMBED,          "src",          0 },
 115   { TAG_FIG,            "src",          0 },
 116   { TAG_FRAME,          "src",          0 },
 117   { TAG_IFRAME,         "src",          0 },
 118   { TAG_IMG,            "href",         0 },
 119   { TAG_IMG,            "lowsrc",       0 },
 120   { TAG_IMG,            "src",          0 },
 121   { TAG_INPUT,          "src",          0 },
 122   { TAG_LAYER,          "src",          0 },
 123   { TAG_OVERLAY,        "src",          0 },
 124   { TAG_SCRIPT,         "src",          0 },
 125   { TAG_TABLE,          "background",   0 },
 126   { TAG_TD,             "background",   0 },
 127   { TAG_TH,             "background",   0 }
 128 };
 129
 130 /* The lists of interesting tags and attributes are built dynamically,
 131    from the information above.  However, some places in the code refer
 132    to the attributes not mentioned here.  We add them manually.  */
 133 static const char *additional_attributes[] = {
 134   "rel",                        /* for TAG_LINK */
 135   "http-equiv",                 /* for TAG_META */
 136   "name",                       /* for TAG_META */
 137   "content"                     /* for TAG_META */
 138 };
 139
 140 static const char **interesting_tags;
 141 static const char **interesting_attributes;
 142
 143 void
 144 init_interesting (void)
 145 {
 146   /* Init the variables interesting_tags and interesting_attributes
 147      that are used by the HTML parser to know which tags and
 148      attributes we're interested in.  We initialize this only once,
 149      for performance reasons.
 150
 151      Here we also make sure that what we put in interesting_tags
 152      matches the user's preferences as specified through --ignore-tags
 153      and --follow-tags.  */
 154
 155   {
 156     int i, ind = 0;
 157     int size = ARRAY_SIZE (known_tags);
 158     interesting_tags = (const char **)xmalloc ((size + 1) * sizeof (char *));
 159
 160     for (i = 0; i < size; i++)
 161       {
 162         const char *name = known_tags[i].name;
 163
 164         /* Normally here we could say:
 165            interesting_tags[i] = name;
 166            But we need to respect the settings of --ignore-tags and
 167            --follow-tags, so the code gets a bit hairier.  */
 168
 169         if (opt.ignore_tags)
 170           {
 171             /* --ignore-tags was specified.  Do not match these
 172                specific tags.  --ignore-tags takes precedence over
 173                --follow-tags, so we process --ignore first and fall
 174                through if there's no match. */
 175             int j, lose = 0;
 176             for (j = 0; opt.ignore_tags[j] != NULL; j++)
 177               /* Loop through all the tags this user doesn't care about. */
 178               if (strcasecmp(opt.ignore_tags[j], name) == EQ)
 179                 {
 180                   lose = 1;
 181                   break;
 182                 }
 183             if (lose)
 184               continue;
 185           }
 186
 187         if (opt.follow_tags)
 188           {
 189             /* --follow-tags was specified.  Only match these specific tags, so
 190                continue back to top of for if we don't match one of them. */
 191             int j, win = 0;
 192             for (j = 0; opt.follow_tags[j] != NULL; j++)
 193               /* Loop through all the tags this user cares about. */
 194               if (strcasecmp(opt.follow_tags[j], name) == EQ)
 195                 {
 196                   win = 1;
 197                   break;
 198                 }
 199             if (!win)
 200               continue;  /* wasn't one of the explicitly desired tags */
 201           }
 202
 203         /* If we get to here, --follow-tags isn't being used or the
 204            tag is among the ones that are followed, and --ignore-tags,
 205            if specified, didn't include this tag, so it's an
 206            "interesting" one. */
 207         interesting_tags[ind++] = name;
 208       }
 209     interesting_tags[ind] = NULL;
 210   }
 211
 212   /* The same for attributes, except we loop through url_tag_attr_map.
 213      Here we also need to make sure that the list of attributes is
 214      unique, and to include the attributes from additional_attributes.  */
 215   {
 216     int i, ind;
 217     const char **att = xmalloc ((ARRAY_SIZE (additional_attributes) + 1)
 218                                 * sizeof (char *));
 219     /* First copy the "additional" attributes. */
 220     for (i = 0; i < ARRAY_SIZE (additional_attributes); i++)
 221       att[i] = additional_attributes[i];
 222     ind = i;
 223     att[ind] = NULL;
 224     for (i = 0; i < ARRAY_SIZE (url_tag_attr_map); i++)
 225       {
 226         int j, seen = 0;
 227         const char *look_for = url_tag_attr_map[i].attr_name;
 228         for (j = 0; j < ind - 1; j++)
 229           if (!strcmp (att[j], look_for))
 230             {
 231               seen = 1;
 232               break;
 233             }
 234         if (!seen)
 235           {
 236             att = xrealloc (att, (ind + 2) * sizeof (*att));
 237             att[ind++] = look_for;
 238             att[ind] = NULL;
 239           }
 240       }
 241     interesting_attributes = att;
 242   }
 243 }
 244
 245 static int
 246 find_tag (const char *tag_name)
 247 {
 248   int i;
 249
 250   /* This is linear search; if the number of tags grow, we can switch
 251      to binary search.  */
 252
 253   for (i = 0; i < ARRAY_SIZE (known_tags); i++)
 254     {
 255       int cmp = strcasecmp (known_tags[i].name, tag_name);
 256       /* known_tags are sorted alphabetically, so we can
 257          micro-optimize.  */
 258       if (cmp > 0)
 259         break;
 260       else if (cmp == 0)
 261         return i;
 262     }
 263   return -1;
 264 }
 265
 266 /* Find the value of attribute named NAME in the taginfo TAG.  If the
 267    attribute is not present, return NULL.  If ATTRID is non-NULL, the
 268    exact identity of the attribute will be returned.  */
 269 static char *
 270 find_attr (struct taginfo *tag, const char *name, int *attrid)
 271 {
 272   int i;
 273   for (i = 0; i < tag->nattrs; i++)
 274     if (!strcasecmp (tag->attrs[i].name, name))
 275       {
 276         if (attrid)
 277           *attrid = i;
 278         return tag->attrs[i].value;
 279       }
 280   return NULL;
 281 }
 282
 283 struct collect_urls_closure {
 284   char *text;                   /* HTML text. */
 285   char *base;                   /* Base URI of the document, possibly
 286                                    changed through <base href=...>. */
 287   struct urlpos *head, *tail;   /* List of URLs */
 288   const char *parent_base;      /* Base of the current document. */
 289   const char *document_file;    /* File name of this document. */
 290   int dash_p_leaf_HTML;         /* Whether -p is specified, and this
 291                                    document is the "leaf" node of the
 292                                    HTML tree. */
 293   int nofollow;                 /* whether NOFOLLOW was specified in a
 294                                    <meta name=robots> tag. */
 295 };
 296
 297 /* Resolve LINK_URI and append it to closure->tail.  TAG and ATTRID
 298    are the necessary context to store the position and size.  */
 299
 300 static void
 301 handle_link (struct collect_urls_closure *closure, const char *link_uri,
 302              struct taginfo *tag, int attrid)
 303 {
 304   int link_has_scheme = url_has_scheme (link_uri);
 305   struct urlpos *newel;
 306   const char *base = closure->base ? closure->base : closure->parent_base;
 307   struct url *url;
 308
 309   if (!base)
 310     {
 311       DEBUGP (("%s: no base, merge will use \"%s\".\n",
 312                closure->document_file, link_uri));
 313
 314       if (!link_has_scheme)
 315         {
 316           /* We have no base, and the link does not have a host
 317              attached to it.  Nothing we can do.  */
 318           /* #### Should we print a warning here?  Wget 1.5.x used to.  */
 319           return;
 320         }
 321
 322       url = url_parse (link_uri, NULL);
 323       if (!url)
 324         {
 325           DEBUGP (("%s: link \"%s\" doesn't parse.\n",
 326                    closure->document_file, link_uri));
 327           return;
 328         }
 329     }
 330   else
 331     {
 332       /* Merge BASE with LINK_URI, but also make sure the result is
 333          canonicalized, i.e. that "../" have been resolved.
 334          (parse_url will do that for us.) */
 335
 336       char *complete_uri = uri_merge (base, link_uri);
 337
 338       DEBUGP (("%s: merge(\"%s\", \"%s\") -> %s\n",
 339                closure->document_file, base, link_uri, complete_uri));
 340
 341       url = url_parse (complete_uri, NULL);
 342       if (!url)
 343         {
 344           DEBUGP (("%s: merged link \"%s\" doesn't parse.\n",
 345                    closure->document_file, complete_uri));
 346           xfree (complete_uri);
 347           return;
 348         }
 349       xfree (complete_uri);
 350     }
 351
 352   newel = (struct urlpos *)xmalloc (sizeof (struct urlpos));
 353
 354   memset (newel, 0, sizeof (*newel));
 355   newel->next = NULL;
 356   newel->url = url;
 357   newel->pos = tag->attrs[attrid].value_raw_beginning - closure->text;
 358   newel->size = tag->attrs[attrid].value_raw_size;
 359
 360   /* A URL is relative if the host is not named, and the name does not
 361      start with `/'.  */
 362   if (!link_has_scheme && *link_uri != '/')
 363     newel->link_relative_p = 1;
 364   else if (link_has_scheme)
 365     newel->link_complete_p = 1;
 366
 367   if (closure->tail)
 368     {
 369       closure->tail->next = newel;
 370       closure->tail = newel;
 371     }
 372   else
 373     closure->tail = closure->head = newel;
 374 }
 375
 376 /* Examine name and attributes of TAG and take appropriate action.
 377    What will be done depends on TAG's category and attribute values.
 378    Tags of TC_LINK category have attributes that contain links to
 379    follow; tags of TC_SPEC category need to be handled specially.
 380
 381    #### It would be nice to split this into several functions.  */
 382
 383 static void
 384 collect_tags_mapper (struct taginfo *tag, void *arg)
 385 {
 386   struct collect_urls_closure *closure = (struct collect_urls_closure *)arg;
 387   int tagid = find_tag (tag->name);
 388   assert (tagid != -1);
 389
 390   switch (known_tags[tagid].category)
 391     {
 392     case TC_LINK:
 393       {
 394         int i, id, first;
 395         int size = ARRAY_SIZE (url_tag_attr_map);
 396         for (i = 0; i < size; i++)
 397           if (url_tag_attr_map[i].tagid == tagid)
 398             break;
 399         /* We've found the index of url_tag_attr_map where the
 400            attributes of our tags begin.  Now, look for every one of
 401            them, and handle it.  */
 402         /* Need to process the attributes in the order they appear in
 403            the tag, as this is required if we convert links.  */
 404         first = i;
 405         for (id = 0; id < tag->nattrs; id++)
 406           {
 407             /* This nested loop may seem inefficient (O(n^2)), but it's
 408                not, since the number of attributes (n) we loop over is
 409                extremely small.  In the worst case of IMG with all its
 410                possible attributes, n^2 will be only 9.  */
 411             for (i = first; (i < size && url_tag_attr_map[i].tagid == tagid);
 412                  i++)
 413               {
 414                 char *attr_value;
 415                 if (closure->dash_p_leaf_HTML
 416                     && (url_tag_attr_map[i].flags & AF_EXTERNAL))
 417                   /* If we're at a -p leaf node, we don't want to retrieve
 418                      links to references we know are external to this document,
 419                      such as <a href=...>.  */
 420                   continue;
 421
 422                 if (!strcasecmp (tag->attrs[id].name,
 423                                  url_tag_attr_map[i].attr_name))
 424                   {
 425                     attr_value = tag->attrs[id].value;
 426                     if (attr_value)
 427                       handle_link (closure, attr_value, tag, id);
 428                   }
 429               }
 430           }
 431       }
 432       break;
 433     case TC_SPEC:
 434       switch (tagid)
 435         {
 436         case TAG_BASE:
 437           {
 438             char *newbase = find_attr (tag, "href", NULL);
 439             if (!newbase)
 440               break;
 441             if (closure->base)
 442               xfree (closure->base);
 443             if (closure->parent_base)
 444               closure->base = uri_merge (closure->parent_base, newbase);
 445             else
 446               closure->base = xstrdup (newbase);
 447           }
 448           break;
 449         case TAG_LINK:
 450           {
 451             int id;
 452             char *rel  = find_attr (tag, "rel", NULL);
 453             char *href = find_attr (tag, "href", &id);
 454             if (href)
 455               {
 456                 /* In the normal case, all <link href=...> tags are
 457                    fair game.
 458
 459                    In the special case of when -p is active, however,
 460                    and we're at a leaf node (relative to the -l
 461                    max. depth) in the HTML document tree, the only
 462                    <LINK> tag we'll follow is a <LINK REL=
 463                    "stylesheet">, as it'll be necessary for displaying
 464                    this document properly.  We won't follow other
 465                    <LINK> tags, like <LINK REL="home">, for instance,
 466                    as they refer to external documents.  */
 467                 if (!closure->dash_p_leaf_HTML
 468                     || (rel && !strcasecmp (rel, "stylesheet")))
 469                   handle_link (closure, href, tag, id);
 470               }
 471           }
 472           break;
 473         case TAG_META:
 474           /* Some pages use a META tag to specify that the page be
 475              refreshed by a new page after a given number of seconds.
 476              The general format for this is:
 477
 478              <meta http-equiv=Refresh content="NUMBER; URL=index2.html">
 479
 480              So we just need to skip past the "NUMBER; URL=" garbage
 481              to get to the URL.  */
 482           {
 483             int id;
 484             char *name = find_attr (tag, "name", NULL);
 485             char *http_equiv = find_attr (tag, "http-equiv", &id);
 486             if (http_equiv && !strcasecmp (http_equiv, "refresh"))
 487               {
 488                 char *refresh = find_attr (tag, "content", NULL);
 489                 char *p = refresh;
 490                 int offset;
 491                 while (ISDIGIT (*p))
 492                   ++p;
 493                 if (*p++ != ';')
 494                   return;
 495                 while (ISSPACE (*p))
 496                   ++p;
 497                 if (!(TOUPPER (*p) == 'U'
 498                       && TOUPPER (*(p + 1)) == 'R'
 499                       && TOUPPER (*(p + 2)) == 'L'
 500                       && *(p + 3) == '='))
 501                   return;
 502                 p += 4;
 503                 while (ISSPACE (*p))
 504                   ++p;
 505                 offset = p - refresh;
 506                 tag->attrs[id].value_raw_beginning += offset;
 507                 tag->attrs[id].value_raw_size -= offset;
 508                 handle_link (closure, p, tag, id);
 509               }
 510             else if (name && !strcasecmp (name, "robots"))
 511               {
 512                 /* Handle stuff like:
 513                    <meta name="robots" content="index,nofollow"> */
 514                 char *content = find_attr (tag, "content", NULL);
 515                 if (!content)
 516                   return;
 517                 if (!strcasecmp (content, "none"))
 518                   closure->nofollow = 1;
 519                 else
 520                   {
 521                     while (*content)
 522                       {
 523                         /* Find the next occurrence of ',' or the end of
 524                            the string.  */
 525                         char *end = strchr (content, ',');
 526                         if (end)
 527                           ++end;
 528                         else
 529                           end = content + strlen (content);
 530                         if (!strncasecmp (content, "nofollow", end - content))
 531                           closure->nofollow = 1;
 532                         content = end;
 533                       }
 534                   }
 535               }
 536           }
 537           break;
 538         default:
 539           /* Category is TC_SPEC, but tag name is unhandled.  This
 540              must not be.  */
 541           abort ();
 542         }
 543       break;
 544     }
 545 }
 546
 547 /* Analyze HTML tags FILE and construct a list of URLs referenced from
 548    it.  It merges relative links in FILE with THIS_URL.  It is aware
 549    of <base href=...> and does the right thing.
 550
 551    If dash_p_leaf_HTML is non-zero, only the elements needed to render
 552    FILE ("non-external" links) will be returned.  */
 553 struct urlpos *
 554 get_urls_html (const char *file, const char *this_url, int dash_p_leaf_HTML,
 555                int *meta_disallow_follow)
 556 {
 557   struct file_memory *fm;
 558   struct collect_urls_closure closure;
 559
 560   /* Load the file. */
 561   fm = read_file (file);
 562   if (!fm)
 563     {
 564       logprintf (LOG_NOTQUIET, "%s: %s\n", file, strerror (errno));
 565       return NULL;
 566     }
 567   DEBUGP (("Loaded %s (size %ld).\n", file, fm->length));
 568
 569   closure.text = fm->content;
 570   closure.head = closure.tail = NULL;
 571   closure.base = NULL;
 572   closure.parent_base = this_url ? this_url : opt.base_href;
 573   closure.document_file = file;
 574   closure.dash_p_leaf_HTML = dash_p_leaf_HTML;
 575   closure.nofollow = 0;
 576
 577   if (!interesting_tags)
 578     init_interesting ();
 579
 580   map_html_tags (fm->content, fm->length, interesting_tags,
 581                  interesting_attributes, collect_tags_mapper, &closure);
 582
 583   DEBUGP (("no-follow in %s: %d\n", file, closure.nofollow));
 584   if (meta_disallow_follow)
 585     *meta_disallow_follow = closure.nofollow;
 586
 587   FREE_MAYBE (closure.base);
 588   read_file_free (fm);
 589   return closure.head;
 590 }
 591
 592 void
 593 cleanup_html_url (void)
 594 {
 595   FREE_MAYBE (interesting_tags);
 596   FREE_MAYBE (interesting_attributes);
 597 }