linkchecker/linkcheck/htmlutil/linkparse.py
2009-01-08 14:18:03 +00:00

222 lines
8.1 KiB
Python

# -*- coding: iso-8859-1 -*-
# Copyright (C) 2001-2009 Bastian Kleineidam
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
"""
Find link tags in HTML text.
"""
import re
from .. import strformat, log, LOG_CHECK, url as urlutil
from . import linkname
MAX_NAMELEN = 256
unquote = strformat.unquote
# ripped mainly from HTML::Tagset.pm
LinkTags = {
'a': [u'href'],
'applet': [u'archive', u'src'],
'area': [u'href'],
'bgsound': [u'src'],
'blockquote': [u'cite'],
'body': [u'background'],
'del': [u'cite'],
'embed': [u'pluginspage', u'src'],
'form': [u'action'],
'frame': [u'src', u'longdesc'],
'head': [u'profile'],
'iframe': [u'src', u'longdesc'],
'ilayer': [u'background'],
'img': [u'src', u'lowsrc', u'longdesc', u'usemap'],
'input': [u'src', u'usemap'],
'ins': [u'cite'],
'isindex': [u'action'],
'layer': [u'background', u'src'],
'link': [u'href'],
'meta': [u'content', u'href'],
'object': [u'classid', u'data', u'archive', u'usemap'],
'q': [u'cite'],
'script': [u'src'],
'table': [u'background'],
'td': [u'background'],
'th': [u'background'],
'tr': [u'background'],
'xmp': [u'href'],
None: [u'style'],
}
# matcher for <meta http-equiv=refresh> tags
refresh_re = re.compile(ur"(?i)^\d+;\s*url=(?P<url>.+)$")
_quoted_pat = ur"('[^']+'|\"[^\"]+\"|[^\)\s]+)"
css_url_re = re.compile(ur"url\(\s*(?P<url>%s)\s*\)" % _quoted_pat)
swf_url_re = re.compile("(?i)%s" % urlutil.safe_url_pattern)
c_comment_re = re.compile(ur"/\*.*?\*/", re.DOTALL)
def strip_c_comments (text):
"""Remove C/CSS-style comments from text. Note that this method also
deliberately removes comments inside of strings."""
return c_comment_re.sub('', text)
class TagFinder (object):
"""Base class storing HTML parse messages in a list.
TagFinder instances are to be used as HtmlParser handlers."""
def __init__ (self):
"""Initialize local variables."""
super(TagFinder, self).__init__()
# parser object will be initialized when it is used as
# a handler object
self.parser = None
def start_element (self, tag, attrs):
"""Does nothing, override in a subclass."""
pass
def start_end_element (self, tag, attrs):
"""Delegate a combined start/end element (eg. <br/>) to
the start_element method. Ignore the end element part."""
self.start_element(tag, attrs)
class MetaRobotsFinder (TagFinder):
"""Class for finding robots.txt meta values in HTML."""
def __init__ (self):
"""Initialize flags."""
super(MetaRobotsFinder, self).__init__()
self.follow = True
self.index = True
log.debug(LOG_CHECK, "meta robots finder")
def start_element (self, tag, attrs):
"""Search for meta robots.txt "nofollow" and "noindex" flags."""
if tag == 'meta':
if attrs.get('name') == 'robots':
val = attrs.get_true('content', u'').lower().split(u',')
self.follow = u'nofollow' not in val
self.index = u'noindex' not in val
def is_meta_url (attr, attrs):
"""Check if the meta attributes contain a URL."""
res = False
if attr == "content":
equiv = attrs.get_true('http-equiv', u'').lower()
scheme = attrs.get_true('scheme', u'').lower()
res = equiv in (u'refresh',) or scheme in (u'dcterms.uri',)
if attr == "href":
rel = attrs.get_true('rel', u'').lower()
res = rel in (u'shortcut icon', u'icon')
return res
class LinkFinder (TagFinder):
"""Find a list of links. After parsing, self.urls
will be a list of parsed links entries with the format
(url, lineno, column, name, codebase)."""
def __init__ (self, content, tags=None):
"""Store content in buffer and initialize URL list."""
super(LinkFinder, self).__init__()
self.content = content
if tags is None:
self.tags = LinkTags
else:
self.tags = tags
self.urls = []
self.base_ref = u''
log.debug(LOG_CHECK, "link finder")
def start_element (self, tag, attrs):
"""Search for links and store found URLs in a list."""
log.debug(LOG_CHECK, "LinkFinder tag %s attrs %s", tag, attrs)
log.debug(LOG_CHECK, "line %d col %d old line %d old col %d",
self.parser.lineno(), self.parser.column(),
self.parser.last_lineno(), self.parser.last_column())
if tag == "base" and not self.base_ref:
self.base_ref = attrs.get_true("href", u'')
tagattrs = self.tags.get(tag, [])
tagattrs.extend(self.tags.get(None, []))
# eliminate duplicate tag attrs
tagattrs = set(tagattrs)
for attr in tagattrs:
if attr not in attrs:
continue
if tag == "meta" and not is_meta_url(attr, attrs):
continue
# name of this link
name = self.get_link_name(tag, attrs, attr)
# possible codebase
if tag in ('applet', 'object'):
codebase = unquote(attrs.get_true('codebase', u''))
else:
codebase = u''
# note: value can be None
value = unquote(attrs.get(attr))
# add link to url list
self.add_link(tag, attr, value, name, codebase)
log.debug(LOG_CHECK, "LinkFinder finished tag %s", tag)
def get_link_name (self, tag, attrs, attr):
"""Parse attrs for link name. Return name of link."""
if tag == 'a' and attr == 'href':
name = unquote(attrs.get_true('title', u''))
if not name:
pos = self.parser.pos()
# Look for name only up to MAX_NAMELEN characters from current
# position, to limit the amount of data to encode.
data = self.content[pos:pos+MAX_NAMELEN]
data = data.decode(self.parser.encoding, "ignore")
name = linkname.href_name(data)
elif tag == 'img':
name = unquote(attrs.get_true('alt', u''))
if not name:
name = unquote(attrs.get_true('title', u''))
else:
name = u""
return name
def add_link (self, tag, attr, url, name, base):
"""Add given url data to url list."""
assert isinstance(tag, unicode), repr(tag)
assert isinstance(attr, unicode), repr(attr)
assert isinstance(name, unicode), repr(name)
assert isinstance(base, unicode), repr(base)
assert isinstance(url, unicode) or url is None, repr(url)
urls = []
# look for meta refresh
if tag == u'meta' and url:
mo = refresh_re.match(url)
if mo:
urls.append(mo.group("url"))
elif attr != 'content':
urls.append(url)
elif attr == u'style' and url:
for mo in css_url_re.finditer(url):
u = mo.group("url")
urls.append(unquote(u, matching=True))
else:
urls.append(url)
if not urls:
# no url found
return
for u in urls:
assert isinstance(u, unicode) or u is None, repr(u)
log.debug(LOG_CHECK,
u"LinkParser add link %r %r %r %r %r", tag, attr, u, name, base)
self.urls.append((u, self.parser.last_lineno(),
self.parser.last_column(), name, base))