]> git.phdru.name Git - bookmarks_db.git/blob - Robots/parse_html.py
Try parser in order until the first one finds a title.
[bookmarks_db.git] / Robots / parse_html.py
1 #! /usr/bin/env python
2 """
3    HTML Parsers wrapper
4
5    Written by Broytman. Copyright (C) 1997-2010 PhiloSoft Design
6 """
7
8 import codecs
9
10 universal_charset = "utf-8"
11 DEFAULT_CHARSET = "cp1251" # Stupid default for Russian Cyrillic
12
13 parsers = []
14
15 try:
16    import parse_html_beautifulsoup
17    parse_html_beautifulsoup.DEFAULT_CHARSET = DEFAULT_CHARSET
18 except ImportError:
19    pass
20 else:
21    parsers.append(parse_html_beautifulsoup.parse_html)
22
23 try:
24    from parse_html_htmlparser import parse_html
25 except ImportError:
26    pass
27 else:
28     parsers.append(parse_html)
29
30 try:
31    import parse_html_html5
32 except ImportError:
33    pass
34 else:
35    parsers.append(parse_html_html5.parse_html)
36
37
38 import re
39 from htmlentitydefs import name2codepoint
40
41 entity_re = re.compile("(&\w+;)")
42 num_entity_re = re.compile("(&#[0-9]+;)")
43
44 def recode_entities(title, charset):
45    output = []
46    for part in entity_re.split(title):
47       if part not in ("&", "<", ">", """) and \
48             entity_re.match(part):
49          _part = name2codepoint.get(part[1:-1], None)
50          if _part is not None:
51              part = unichr(_part).encode(charset)
52       output.append(part)
53    title = ''.join(output)
54
55    output = []
56    for part in num_entity_re.split(title):
57       if num_entity_re.match(part):
58          try:
59             part = unichr(int(part[2:-1])).encode(charset)
60          except UnicodeEncodeError:
61             pass # Leave the entity as is
62       output.append(part)
63
64    return ''.join(output)
65
66
67 def parse_html(filename, charset=None, log=None):
68    if not parsers:
69        return None
70
71    if charset:
72       try:
73          codecs.lookup(charset) # In case of unknown charset...
74       except (ValueError, LookupError):
75          charset = None         # ...try charset from HTML
76
77    charsets = [universal_charset, DEFAULT_CHARSET]
78    if charset:
79       charset = charset.lower().replace("windows-", "cp")
80       if charset in charsets:
81          charsets.remove(charset)
82       charsets.insert(0, charset)
83
84    for p in parsers:
85       parser = None
86       for c in charsets:
87          try:
88             parser = p(filename, c, log)
89             break
90          except UnicodeEncodeError:
91             pass
92       if parser:
93          break
94       else:
95          if log: log("Parser %s.%s failed, trying next one." % (p.__module__, p.__name__))
96
97    if not parser:
98        return None
99
100    converted_title = title = parser.title
101    if title and (not parser.charset):
102       try:
103          unicode(title, "ascii")
104       except UnicodeDecodeError:
105          parser.charset = DEFAULT_CHARSET
106
107    if parser.charset:
108       parser.charset = parser.charset.lower().replace("windows-", "cp")
109
110    if title and parser.charset and (
111          (parser.charset <> universal_charset) or
112          ((not charset) or (charset <> parser.charset))):
113       try:
114          if parser.meta_charset:
115             if log: log("   META charset   : %s" % parser.charset)
116          elif (not charset) or (charset <> parser.charset):
117             if log: log("   guessed charset: %s" % parser.charset)
118          if log: log("   current charset: %s" % universal_charset)
119          if log: log("   title          : %s" % title)
120          if parser.charset <> universal_charset:
121             try:
122                converted_title = unicode(title, parser.charset).encode(universal_charset)
123             except UnicodeError:
124                if log: log("   incorrect conversion from %s, converting from %s" % (parser.charset, DEFAULT_CHARSET))
125                converted_title = unicode(title, DEFAULT_CHARSET, "replace").encode(universal_charset, "replace")
126                parser.charset = DEFAULT_CHARSET
127          if log and (converted_title <> title): log("   converted title: %s" % converted_title)
128       except LookupError:
129          if log: log("   unknown charset: '%s'" % parser.charset)
130    else:
131       if log: log("   title          : %s" % title)
132
133    if title:
134       final_title = recode_entities(converted_title, universal_charset)
135       parts = [s.strip() for s in final_title.replace('\r', '').split('\n')]
136       final_title = ' '.join([s for s in parts if s])
137       if log and (final_title <> converted_title): log("   final title    : %s" % final_title)
138       parser.title = final_title
139    return parser
140
141
142 if __name__ == '__main__':
143    import sys
144
145    l = len(sys.argv)
146    if l == 3:
147       filename = sys.argv[1]
148       charset = sys.argv[2]
149    elif l == 2:
150       filename = sys.argv[1]
151       charset = universal_charset
152    else:
153       sys.exit("Usage: %s filename [charset]" % sys.argv[0])
154
155    parser = parse_html(filename, charset, log=lambda s: sys.stdout.write(s + '\n'))
156    print "   refresh:", parser.refresh
157    print "   icon   :", parser.icon