1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
# coding: utf-8
from __future__ import unicode_literals
import os
import re
import json
import logging
import subprocess
from mkdocs import utils
try: # pragma: no cover
from html.parser import HTMLParser # noqa
except ImportError: # pragma: no cover
from HTMLParser import HTMLParser # noqa
log = logging.getLogger(__name__)
class SearchIndex(object):
"""
Search index is a collection of pages and sections (heading
tags and their following content are sections).
"""
def __init__(self, **config):
self._entries = []
self.config = config
def _find_toc_by_id(self, toc, id_):
"""
Given a table of contents and HTML ID, iterate through
and return the matched item in the TOC.
"""
for toc_item in toc:
if toc_item.url[1:] == id_:
return toc_item
toc_item_r = self._find_toc_by_id(toc_item.children, id_)
if toc_item_r is not None:
return toc_item_r
def _add_entry(self, title, text, loc):
"""
A simple wrapper to add an entry and ensure the contents
is UTF8 encoded.
"""
text = text.replace('\u00a0', ' ')
text = re.sub(r'[ \t\n\r\f\v]+', ' ', text.strip())
self._entries.append({
'title': title,
'text': utils.text_type(text.encode('utf-8'), encoding='utf-8'),
'location': loc
})
def add_entry_from_context(self, page):
"""
Create a set of entries in the index for a page. One for
the page itself and then one for each of its' heading
tags.
"""
# Create the content parser and feed in the HTML for the
# full page. This handles all the parsing and prepares
# us to iterate through it.
parser = ContentParser()
parser.feed(page.content)
parser.close()
# Get the absolute URL for the page, this is then
# prepended to the urls of the sections
url = page.url
# Create an entry for the full page.
self._add_entry(
title=page.title,
text=self.strip_tags(page.content).rstrip('\n'),
loc=url
)
for section in parser.data:
self.create_entry_for_section(section, page.toc, url)
def create_entry_for_section(self, section, toc, abs_url):
"""
Given a section on the page, the table of contents and
the absolute url for the page create an entry in the
index
"""
toc_item = self._find_toc_by_id(toc, section.id)
if toc_item is not None:
self._add_entry(
title=toc_item.title,
text=u" ".join(section.text),
loc=abs_url + toc_item.url
)
def generate_search_index(self):
"""python to json conversion"""
page_dicts = {
'docs': self._entries,
'config': self.config
}
data = json.dumps(page_dicts, sort_keys=True, separators=(',', ':'))
if self.config['prebuild_index']:
try:
script_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'prebuild-index.js')
p = subprocess.Popen(
['node', script_path],
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
)
idx, err = p.communicate(data.encode('utf-8'))
if not err:
idx = idx.decode('utf-8') if hasattr(idx, 'decode') else idx
page_dicts['index'] = json.loads(idx)
data = json.dumps(page_dicts, sort_keys=True, separators=(',', ':'))
log.debug('Pre-built search index created successfully.')
else:
log.warning('Failed to pre-build search index. Error: {}'.format(err))
except (OSError, IOError, ValueError) as e:
log.warning('Failed to pre-build search index. Error: {}'.format(e))
return data
def strip_tags(self, html):
"""strip html tags from data"""
s = HTMLStripper()
s.feed(html)
return s.get_data()
class HTMLStripper(HTMLParser):
"""
A simple HTML parser that stores all of the data within tags
but ignores the tags themselves and thus strips them from the
content.
"""
def __init__(self, *args, **kwargs):
# HTMLParser is a old-style class in Python 2, so
# super() wont work here.
HTMLParser.__init__(self, *args, **kwargs)
self.data = []
def handle_data(self, d):
"""
Called for the text contents of each tag.
"""
self.data.append(d)
def get_data(self):
return '\n'.join(self.data)
class ContentSection(object):
"""
Used by the ContentParser class to capture the information we
need when it is parsing the HMTL.
"""
def __init__(self, text=None, id_=None, title=None):
self.text = text or []
self.id = id_
self.title = title
def __eq__(self, other):
return all([
self.text == other.text,
self.id == other.id,
self.title == other.title
])
class ContentParser(HTMLParser):
"""
Given a block of HTML, group the content under the preceding
heading tags which can then be used for creating an index
for that section.
"""
def __init__(self, *args, **kwargs):
# HTMLParser is a old-style class in Python 2, so
# super() wont work here.
HTMLParser.__init__(self, *args, **kwargs)
self.data = []
self.section = None
self.is_header_tag = False
def handle_starttag(self, tag, attrs):
"""Called at the start of every HTML tag."""
# We only care about the opening tag for headings.
if tag not in (["h%d" % x for x in range(1, 7)]):
return
# We are dealing with a new header, create a new section
# for it and assign the ID if it has one.
self.is_header_tag = True
self.section = ContentSection()
self.data.append(self.section)
for attr in attrs:
if attr[0] == "id":
self.section.id = attr[1]
def handle_endtag(self, tag):
"""Called at the end of every HTML tag."""
# We only care about the opening tag for headings.
if tag not in (["h%d" % x for x in range(1, 7)]):
return
self.is_header_tag = False
def handle_data(self, data):
"""
Called for the text contents of each tag.
"""
if self.section is None:
# This means we have some content at the start of the
# HTML before we reach a heading tag. We don't actually
# care about that content as it will be added to the
# overall page entry in the search. So just skip it.
return
# If this is a header, then the data is the title.
# Otherwise it is content of something under that header
# section.
if self.is_header_tag:
self.section.title = data
else:
self.section.text.append(data.rstrip('\n'))
|