forgot

getnikola · Apr 15, 2018 · 2d30008 · 2d30008
1 parent a3d1529
commit 2d30008
Show file tree

Hide file tree

Showing 2 changed files with 179 additions and 0 deletions.
diff --git a/nikola/plugins/shortcode/post_list.plugin b/nikola/plugins/shortcode/post_list.plugin
@@ -0,0 +1,13 @@
+[Core]
+name = post_list
+module = post_list
+
+[Nikola]
+PluginCategory = Shortcode
+
+[Documentation]
+author = Udo Spallek
+version = 0.2
+website = https://getnikola.com/
+description = Includes a list of posts with tag and slice based filters.
+
diff --git a/nikola/plugins/shortcode/post_list.py b/nikola/plugins/shortcode/post_list.py
@@ -0,0 +1,166 @@
+# -*- coding: utf-8 -*-
+
+# Copyright © 2013-2018 Udo Spallek, Roberto Alsina and others.
+
+# Permission is hereby granted, free of charge, to any
+# person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the
+# Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice
+# shall be included in all copies or substantial portions of
+# the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+"""Post list directive for reStructuredText."""
+
+
+import operator
+import os
+import uuid
+
+import natsort
+from docutils import nodes
+from docutils.parsers.rst import Directive, directives
+
+from nikola import utils
+from nikola.packages.datecond import date_in_range
+from nikola.plugin_categories import ShortcodePlugin
+
+
+class Plugin(ShortcodePlugin):
+    """Plugin for post-list shortcode."""
+
+    name = "post_list"
+
+    def handler(self, start=None, stop=None, reverse=False, tags=None, require_all_tags=False, categories=None,
+                    sections=None, slugs=None, post_type='post', type=False,
+                    lang=None, template='post_list_directive.tmpl', sort=None,
+                    id=None, data=None, state=None, site=None, date=None, filename=None, post=None):
+        if lang is None:
+            lang = utils.LocaleBorg().current_lang
+        if site.invariant:  # for testing purposes
+            post_list_id = id or 'post_list_' + 'fixedvaluethatisnotauuid'
+        else:
+            post_list_id = id or 'post_list_' + uuid.uuid4().hex
+
+        # Get post from filename if available
+        if filename:
+            self_post = site.post_per_input_file.get(filename)
+        else:
+            self_post = None
+
+        if self_post:
+            self_post.register_depfile("####MAGIC####TIMELINE", lang=lang)
+
+        # If we get strings for start/stop, make them integers
+        if start is not None:
+            start = int(start)
+        if stop is not None:
+            stop = int(stop)
+
+        # Parse tags/categories/sections/slugs (input is strings)
+        categories = [c.strip().lower() for c in categories.split(',')] if categories else []
+        sections = [s.strip().lower() for s in sections.split(',')] if sections else []
+        slugs = [s.strip() for s in slugs.split(',')] if slugs else []
+
+        filtered_timeline = []
+        posts = []
+        step = -1 if reverse is None else None
+
+        if type is not False:
+            post_type = type
+
+        if post_type == 'page' or post_type == 'pages':
+            timeline = [p for p in site.timeline if not p.use_in_feeds]
+        elif post_type == 'all':
+            timeline = [p for p in site.timeline]
+        else:  # post
+            timeline = [p for p in site.timeline if p.use_in_feeds]
+
+        # self_post should be removed from timeline because this is redundant
+        timeline = [p for p in timeline if p.source_path != filename]
+
+        if categories:
+            timeline = [p for p in timeline if p.meta('category', lang=lang).lower() in categories]
+
+        if sections:
+            timeline = [p for p in timeline if p.section_name(lang).lower() in sections]
+
+        if tags:
+            tags = {t.strip().lower() for t in tags.split(',')}
+            if require_all_tags:
+                compare = set.issubset
+            else:
+                compare = operator.and_
+            for post in timeline:
+                post_tags = {t.lower() for t in post.tags}
+                if compare(tags, post_tags):
+                    filtered_timeline.append(post)
+        else:
+            filtered_timeline = timeline
+
+        if sort:
+            filtered_timeline = natsort.natsorted(filtered_timeline, key=lambda post: post.meta[lang][sort], alg=natsort.ns.F | natsort.ns.IC)
+
+        if date:
+            _now = utils.current_time()
+            filtered_timeline = [p for p in filtered_timeline if date_in_range(utils.html_unescape(date), p.date, now=_now)]
+
+        for post in filtered_timeline[start:stop:step]:
+            if slugs:
+                cont = True
+                for slug in slugs:
+                    if slug == post.meta('slug'):
+                        cont = False
+
+                if cont:
+                    continue
+
+            bp = post.translated_base_path(lang)
+            if os.path.exists(bp) and state:
+                state.document.settings.record_dependencies.add(bp)
+            elif os.path.exists(bp) and self_post:
+                self_post.register_depfile(bp, lang=lang)
+
+            posts += [post]
+
+        if not posts:
+            return '', []
+
+        template_deps = site.template_system.template_deps(template)
+        if state:
+            # Register template as a dependency (Issue #2391)
+            for d in template_deps:
+                state.document.settings.record_dependencies.add(d)
+        elif self_post:
+            for d in template_deps:
+                self_post.register_depfile(d, lang=lang)
+
+        template_data = {
+            'lang': lang,
+            'posts': posts,
+            # Need to provide str, not TranslatableSetting (Issue #2104)
+            'date_format': site.GLOBAL_CONTEXT.get('date_format')[lang],
+            'post_list_id': post_list_id,
+            'messages': site.MESSAGES,
+            '_link': site.link,
+        }
+        output = site.template_system.render_template(
+            template, None, template_data)
+        return output, template_deps
+
+# Request file name from shortcode (Issue #2412)
+Plugin.handler.nikola_shortcode_pass_filename = True