parse_html/bkmk_parse_html.py

   1 """HTML Parsers
   2
   3 This file is a part of Bookmarks database and Internet robot.
   4
   5 """
   6
   7 __author__ = "Oleg Broytman <phd@phdru.name>"
   8 __copyright__ = "Copyright (C) 1997-2024 PhiloSoft Design"
   9 __license__ = "GNU GPL"
  10
  11 __all__ = ['parse_html', 'parse_filename', 'universal_charset']
  12
  13
  14 import codecs
  15 import os
  16 import re
  17 from html.entities import name2codepoint
  18
  19 DEFAULT_CHARSET = "cp1251"  # Stupid default for Russian Cyrillic
  20 parsers = []
  21
  22 try:
  23     from . import bkmk_ph_beautifulsoup
  24 except ImportError:
  25     pass
  26 else:
  27     bkmk_ph_beautifulsoup.DEFAULT_CHARSET = DEFAULT_CHARSET
  28     parsers.append(bkmk_ph_beautifulsoup.parse_html)
  29
  30 try:
  31     from . import bkmk_ph_beautifulsoup4
  32 except ImportError:
  33     pass
  34 else:
  35     bkmk_ph_beautifulsoup4.DEFAULT_CHARSET = DEFAULT_CHARSET
  36     parsers.append(bkmk_ph_beautifulsoup4.parse_html)
  37
  38 try:
  39     from . import bkmk_ph_htmlparser
  40 except ImportError:
  41     pass
  42 else:
  43     parsers.append(bkmk_ph_htmlparser.parse_html)
  44
  45 try:
  46     from . import bkmk_ph_lxml
  47 except ImportError:
  48     pass
  49 else:
  50     parsers.append(bkmk_ph_lxml.parse_html)
  51
  52 universal_charset = "utf-8"
  53 entity_re = re.compile("(&\\w+;)")
  54 num_entity_re = re.compile("(&#[0-9]+;)")
  55
  56
  57 def recode_entities(title, charset):
  58     output = []
  59     for part in entity_re.split(title):
  60         if part not in ("&amp;", "&lt;", "&gt;", "&quot;") and \
  61               entity_re.match(part):
  62             _part = name2codepoint.get(part[1:-1], None)
  63             if _part is not None:
  64                 part = chr(_part)
  65         output.append(part)
  66     title = ''.join(output)
  67
  68     output = []
  69     for part in num_entity_re.split(title):
  70         if num_entity_re.match(part):
  71             try:
  72                 part = chr(int(part[2:-1]))
  73             except UnicodeEncodeError:
  74                 pass  # Leave the entity as is
  75         output.append(part)
  76
  77     return ''.join(output)
  78
  79
  80 BKMK_DEBUG_HTML_PARSERS = os.environ.get("BKMK_DEBUG_HTML_PARSERS")
  81
  82
  83 def parse_html(html_text, charset=None, log=None):
  84     if not html_text or not parsers:
  85         return None
  86
  87     if charset:
  88         try:
  89             codecs.lookup(charset)  # In case of unknown charset...
  90         except (ValueError, LookupError):
  91             charset = None         # ...try charset from HTML
  92
  93     charsets = [universal_charset, DEFAULT_CHARSET]
  94     if charset:
  95         charset = charset.lower().replace("windows-", "cp")
  96         if charset in charsets:
  97             charsets.remove(charset)
  98         charsets.insert(0, charset)
  99
 100     if BKMK_DEBUG_HTML_PARSERS:
 101         _parsers = []
 102     for p in parsers:
 103         parser = None
 104         for c in charsets:
 105             try:
 106                 parser = p(html_text, c, log)
 107             except UnicodeError:
 108                 pass
 109             else:
 110                 if parser:
 111                     if BKMK_DEBUG_HTML_PARSERS:
 112                         if log: log("   Parser %s: ok" % p.__module__)
 113                         _parsers.append((p, parser))
 114                     break
 115         else:
 116             if log: log("   Parser %s: fail" % p.__module__)
 117         if not BKMK_DEBUG_HTML_PARSERS and parser:
 118             break
 119
 120     if BKMK_DEBUG_HTML_PARSERS:
 121         if not _parsers:
 122             if log: log("   All parsers have failed")
 123             return None
 124     elif not parser:
 125         if log: log("   All parsers have failed")
 126         return None
 127
 128     if BKMK_DEBUG_HTML_PARSERS:
 129         p, parser = _parsers[0]
 130     if log: log("   Using %s" % p.__module__)
 131
 132     converted_title = title = parser.title
 133     if title and isinstance(title, bytes) and (not parser.charset):
 134         try:
 135             title.decode("ascii")
 136         except UnicodeDecodeError:
 137             parser.charset = DEFAULT_CHARSET
 138
 139     if parser.charset:
 140         parser.charset = parser.charset.lower().replace("windows-", "cp")
 141
 142     if title and parser.charset and (
 143           (parser.charset != universal_charset) or
 144           ((not charset) or (charset != parser.charset))):
 145         try:
 146             if parser.meta_charset:
 147                 if log: log("   META charset   : %s" % parser.charset)
 148             elif (not charset) or (charset != parser.charset):
 149                 if log: log("   guessed charset: %s" % parser.charset)
 150             if log: log("   title          : %s" % title)
 151         except LookupError:
 152             if log: log("   unknown charset: '%s'" % parser.charset)
 153     else:
 154         if log: log("   title          : %s" % title)
 155
 156     if title:
 157         final_title = recode_entities(converted_title, universal_charset)
 158         parts = [s.strip() for s in final_title.replace('\r', '').split('\n')]
 159         final_title = ' '.join([s for s in parts if s])
 160         if log and (final_title != converted_title):
 161             log("   final title    : %s" % final_title)
 162         parser.title = final_title
 163
 164     return parser
 165
 166
 167 def parse_filename(filename, charset=None, log=None):
 168     fp = open(filename, 'rt', encoding=charset)
 169     try:
 170         parser = parse_html(fp.read(), charset=charset, log=log)
 171     finally:
 172         fp.close()
 173     return parser