|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +# Copyright © 2016 Felix Fontein and Nikola contributors |
| 4 | + |
| 5 | +# Permission is hereby granted, free of charge, to any |
| 6 | +# person obtaining a copy of this software and associated |
| 7 | +# documentation files (the "Software"), to deal in the |
| 8 | +# Software without restriction, including without limitation |
| 9 | +# the rights to use, copy, modify, merge, publish, |
| 10 | +# distribute, sublicense, and/or sell copies of the |
| 11 | +# Software, and to permit persons to whom the Software is |
| 12 | +# furnished to do so, subject to the following conditions: |
| 13 | +# |
| 14 | +# The above copyright notice and this permission notice |
| 15 | +# shall be included in all copies or substantial portions of |
| 16 | +# the Software. |
| 17 | +# |
| 18 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY |
| 19 | +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE |
| 20 | +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
| 21 | +# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS |
| 22 | +# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 23 | +# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR |
| 24 | +# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 25 | +# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 26 | + |
| 27 | +"""The default post scanner.""" |
| 28 | + |
| 29 | +from __future__ import unicode_literals, print_function |
| 30 | +import glob |
| 31 | +import os |
| 32 | +import sys |
| 33 | + |
| 34 | +from nikola.plugin_categories import PostScanner |
| 35 | +from nikola import utils |
| 36 | +from nikola.post import Post |
| 37 | + |
| 38 | +LOGGER = utils.get_logger('hierarchical_pages', utils.STDERR_HANDLER) |
| 39 | + |
| 40 | + |
| 41 | +def _spread(input, translations, default_language): |
| 42 | + if isinstance(input, dict): |
| 43 | + if default_language in input: |
| 44 | + def_value = input[default_language] |
| 45 | + else: |
| 46 | + def_value = input[list(input.keys())[0]] |
| 47 | + return {lang: input[lang] if lang in input else def_value for lang in translations.keys()} |
| 48 | + else: |
| 49 | + return {lang: input for lang in translations.keys()} |
| 50 | + |
| 51 | + |
| 52 | +class Node(object): |
| 53 | + def __init__(self, name=None, slugs=None): |
| 54 | + self.name = name |
| 55 | + self.children = {} |
| 56 | + self.slugs = slugs |
| 57 | + self.post_source = None |
| 58 | + |
| 59 | + def __repr__(self): |
| 60 | + return "Node({}; {}; {})".format(self.post_source, self.slugs, self.children) |
| 61 | + |
| 62 | + |
| 63 | +class HierarchicalPages(PostScanner): |
| 64 | + """Scan posts in the site.""" |
| 65 | + |
| 66 | + name = "hierarchical_pages" |
| 67 | + |
| 68 | + def scan(self): |
| 69 | + """Create list of posts from HIERARCHICAL_PAGES options.""" |
| 70 | + seen = set([]) |
| 71 | + if not self.site.quiet: |
| 72 | + print("Scanning hierarchical pages", end='', file=sys.stderr) |
| 73 | + |
| 74 | + timeline = [] |
| 75 | + |
| 76 | + for wildcard, destination, template_name in self.site.config.get('HIERARCHICAL_PAGES', []): |
| 77 | + if not self.site.quiet: |
| 78 | + print(".", end='', file=sys.stderr) |
| 79 | + root = Node(slugs=_spread(destination, self.site.config['TRANSLATIONS'], self.site.config['DEFAULT_LANG'])) |
| 80 | + dirname = os.path.dirname(wildcard) |
| 81 | + for dirpath, _, _ in os.walk(dirname, followlinks=True): |
| 82 | + # Get all the untranslated paths |
| 83 | + dir_glob = os.path.join(dirpath, os.path.basename(wildcard)) # posts/foo/*.rst |
| 84 | + untranslated = glob.glob(dir_glob) |
| 85 | + # And now get all the translated paths |
| 86 | + translated = set([]) |
| 87 | + for lang in self.site.config['TRANSLATIONS'].keys(): |
| 88 | + if lang == self.site.config['DEFAULT_LANG']: |
| 89 | + continue |
| 90 | + lang_glob = utils.get_translation_candidate(self.site.config, dir_glob, lang) # posts/foo/*.LANG.rst |
| 91 | + translated = translated.union(set(glob.glob(lang_glob))) |
| 92 | + # untranslated globs like *.rst often match translated paths too, so remove them |
| 93 | + # and ensure x.rst is not in the translated set |
| 94 | + untranslated = set(untranslated) - translated |
| 95 | + |
| 96 | + # also remove from translated paths that are translations of |
| 97 | + # paths in untranslated_list, so x.es.rst is not in the untranslated set |
| 98 | + for p in untranslated: |
| 99 | + translated = translated - set([utils.get_translation_candidate(self.site.config, p, l) for l in self.site.config['TRANSLATIONS'].keys()]) |
| 100 | + |
| 101 | + full_list = list(translated) + list(untranslated) |
| 102 | + # We eliminate from the list the files inside any .ipynb folder |
| 103 | + full_list = [p for p in full_list |
| 104 | + if not any([x.startswith('.') |
| 105 | + for x in p.split(os.sep)])] |
| 106 | + |
| 107 | + for base_path in full_list: |
| 108 | + if base_path in seen: |
| 109 | + continue |
| 110 | + else: |
| 111 | + seen.add(base_path) |
| 112 | + # Extract path |
| 113 | + path = utils.os_path_split(os.path.relpath(base_path, dirname)) |
| 114 | + path[-1] = os.path.splitext(path[-1])[0] |
| 115 | + if path[-1] == 'index': |
| 116 | + path = path[:-1] |
| 117 | + # Find node |
| 118 | + node = root |
| 119 | + for path_elt in path: |
| 120 | + if path_elt not in node.children: |
| 121 | + node.children[path_elt] = Node(path_elt) |
| 122 | + node = node.children[path_elt] |
| 123 | + node.post_source = base_path |
| 124 | + |
| 125 | + # Add posts |
| 126 | + def crawl(node, destinations_so_far, root=True): |
| 127 | + if node.post_source is not None: |
| 128 | + try: |
| 129 | + post = Post( |
| 130 | + node.post_source, |
| 131 | + self.site.config, |
| 132 | + '', |
| 133 | + False, |
| 134 | + self.site.MESSAGES, |
| 135 | + template_name, |
| 136 | + self.site.get_compiler(node.post_source), |
| 137 | + destination_base=utils.TranslatableSetting('destinations', destinations_so_far, self.site.config['TRANSLATIONS']), |
| 138 | + metadata_extractors_by=self.site.metadata_extractors_by |
| 139 | + ) |
| 140 | + timeline.append(post) |
| 141 | + except Exception as err: |
| 142 | + LOGGER.error('Error reading post {}'.format(base_path)) |
| 143 | + raise err |
| 144 | + # Compute slugs |
| 145 | + slugs = {} |
| 146 | + for lang in self.site.config['TRANSLATIONS']: |
| 147 | + slug = post.meta('slug', lang=lang) |
| 148 | + if slug: |
| 149 | + slugs[lang] = slug |
| 150 | + if not slugs: |
| 151 | + slugs[self.site.config['DEFAULT_LANG']] = node.name |
| 152 | + node.slugs = _spread(slugs, self.site.config['TRANSLATIONS'], self.site.config['DEFAULT_LANG']) |
| 153 | + # Update destinations_so_far |
| 154 | + if not root: |
| 155 | + if node.slugs is not None: |
| 156 | + destinations_so_far = {lang: os.path.join(dest, node.slugs[lang]) for lang, dest in destinations_so_far.items()} |
| 157 | + else: |
| 158 | + destinations_so_far = {lang: os.path.join(dest, node.name) for lang, dest in destinations_so_far.items()} |
| 159 | + for p, n in node.children.items(): |
| 160 | + crawl(n, destinations_so_far, root=False) |
| 161 | + |
| 162 | + crawl(root, root.slugs) |
| 163 | + |
| 164 | + return timeline |
| 165 | + |
| 166 | + def supported_extensions(self): |
| 167 | + """Return a list of supported file extensions, or None if such a list isn't known beforehand.""" |
| 168 | + return list({os.path.splitext(x[0])[1] for x in self.site.config.get('HIERARCHICAL_PAGES', [])}) |
0 commit comments