parse_html/__init__.py

   1 """HTML Parsers
   2
   3 This file is a part of Bookmarks database and Internet robot.
   4 """
   5
   6 __version__ = "$Revision$"[11:-2]
   7 __revision__ = "$Id$"[5:-2]
   8 __date__ = "$Date$"[7:-2]
   9 __author__ = "Oleg Broytman <phd@phdru.name>"
  10 __copyright__ = "Copyright (C) 1997-2011 PhiloSoft Design"
  11 __license__ = "GNU GPL"
  12
  13 import codecs
  14
  15 universal_charset = "utf-8"
  16 DEFAULT_CHARSET = "cp1251" # Stupid default for Russian Cyrillic
  17
  18 parsers = []
  19
  20 try:
  21    from . import beautifulsoup
  22 except ImportError:
  23    pass
  24 else:
  25    beautifulsoup.DEFAULT_CHARSET = DEFAULT_CHARSET
  26    parsers.append(beautifulsoup.parse_html)
  27
  28 try:
  29    from .lxml import parse_html
  30 except ImportError:
  31    pass
  32 else:
  33     parsers.append(parse_html)
  34
  35 try:
  36    from .htmlparser import parse_html
  37 except ImportError:
  38    pass
  39 else:
  40     parsers.append(parse_html)
  41
  42 try:
  43    from . import html5
  44 except ImportError:
  45    pass
  46 else:
  47    parsers.append(html5.parse_html)
  48
  49 # ElementTidy often segfaults
  50 #try:
  51 #   from . import etreetidy
  52 #except ImportError:
  53 #   pass
  54 #else:
  55 #   parsers.append(etreetidy.parse_html)
  56
  57 import re
  58 from htmlentitydefs import name2codepoint
  59
  60 entity_re = re.compile("(&\w+;)")
  61 num_entity_re = re.compile("(&#[0-9]+;)")
  62
  63 def recode_entities(title, charset):
  64    output = []
  65    for part in entity_re.split(title):
  66       if part not in ("&amp;", "&lt;", "&gt;", "&quot;") and \
  67             entity_re.match(part):
  68          _part = name2codepoint.get(part[1:-1], None)
  69          if _part is not None:
  70              part = unichr(_part).encode(charset)
  71       output.append(part)
  72    title = ''.join(output)
  73
  74    output = []
  75    for part in num_entity_re.split(title):
  76       if num_entity_re.match(part):
  77          try:
  78             part = unichr(int(part[2:-1])).encode(charset)
  79          except UnicodeEncodeError:
  80             pass # Leave the entity as is
  81       output.append(part)
  82
  83    return ''.join(output)
  84
  85
  86 def parse_html(filename, charset=None, log=None):
  87    if not parsers:
  88        return None
  89
  90    if charset:
  91       try:
  92          codecs.lookup(charset) # In case of unknown charset...
  93       except (ValueError, LookupError):
  94          charset = None         # ...try charset from HTML
  95
  96    charsets = [universal_charset, DEFAULT_CHARSET]
  97    if charset:
  98       charset = charset.lower().replace("windows-", "cp")
  99       if charset in charsets:
 100          charsets.remove(charset)
 101       charsets.insert(0, charset)
 102
 103    for p in parsers:
 104       parser = None
 105       for c in charsets:
 106          try:
 107             parser = p(filename, c, log)
 108          except UnicodeEncodeError:
 109             pass
 110          else:
 111             break
 112       if parser:
 113          break
 114       else:
 115          if log: log("Parser %s.%s failed, trying next one." % (p.__module__, p.__name__))
 116
 117    if not parser:
 118        return None
 119
 120    converted_title = title = parser.title
 121    if title and (not parser.charset):
 122       try:
 123          unicode(title, "ascii")
 124       except UnicodeDecodeError:
 125          parser.charset = DEFAULT_CHARSET
 126
 127    if parser.charset:
 128       parser.charset = parser.charset.lower().replace("windows-", "cp")
 129
 130    if title and parser.charset and (
 131          (parser.charset <> universal_charset) or
 132          ((not charset) or (charset <> parser.charset))):
 133       try:
 134          if parser.meta_charset:
 135             if log: log("   META charset   : %s" % parser.charset)
 136          elif (not charset) or (charset <> parser.charset):
 137             if log: log("   guessed charset: %s" % parser.charset)
 138          if log: log("   current charset: %s" % universal_charset)
 139          if log: log("   title          : %s" % title)
 140          if parser.charset <> universal_charset:
 141             try:
 142                converted_title = unicode(title, parser.charset).encode(universal_charset)
 143             except UnicodeError:
 144                if log: log("   incorrect conversion from %s, converting from %s" % (parser.charset, DEFAULT_CHARSET))
 145                converted_title = unicode(title, DEFAULT_CHARSET, "replace").encode(universal_charset, "replace")
 146                parser.charset = DEFAULT_CHARSET
 147          if log and (converted_title <> title): log("   converted title: %s" % converted_title)
 148       except LookupError:
 149          if log: log("   unknown charset: '%s'" % parser.charset)
 150    else:
 151       if log: log("   title          : %s" % title)
 152
 153    if title:
 154       final_title = recode_entities(converted_title, universal_charset)
 155       parts = [s.strip() for s in final_title.replace('\r', '').split('\n')]
 156       final_title = ' '.join([s for s in parts if s])
 157       if log and (final_title <> converted_title): log("   final title    : %s" % final_title)
 158       parser.title = final_title
 159
 160    icon = parser.icon
 161    if isinstance(icon, unicode):
 162        try:
 163            parser.icon = icon.encode('ascii')
 164        except UnicodeEncodeError:
 165            if parser.charset:
 166                parser.icon = icon.encode(parser.charset)
 167    return parser
 168
 169
 170 def test():
 171    import sys
 172
 173    l = len(sys.argv)
 174    if l == 3:
 175       filename = sys.argv[1]
 176       charset = sys.argv[2]
 177    elif l == 2:
 178       filename = sys.argv[1]
 179       charset = universal_charset
 180    else:
 181       sys.exit("Usage: %s filename [charset]" % sys.argv[0])
 182
 183    parser = parse_html(filename, charset, log=lambda s: sys.stdout.write(s + '\n'))
 184    print "   refresh:", parser.refresh
 185    print "   icon   :", parser.icon