Add random article

xuxiaodong · Apr 20, 2016 · 7364bc6 · 7364bc6
1 parent eedfb76
commit 7364bc6
Show file tree

Hide file tree

Showing 9 changed files with 112 additions and 78 deletions.
diff --git a/pelicanconf.py b/pelicanconf.py
@@ -26,7 +26,7 @@
 
 #PAGE_ICONS = ['folder', 'book', 'support', 'mail', 'heart', 'exclamationCircle']
 #RSS_ICONS = ['rss']
-MENUITEMS_AFTER = (('Comments', '/pages/comments.html'), ('RSS', '/feeds/all.atom.xml'),)
+MENUITEMS_AFTER = (('Comments', '/pages/comments.html'), ('Random', '/random.html'), ('RSS', '/feeds/all.atom.xml'),)
 
 GITHUB_SOURCE = 'https://github.com/xuxiaodong/linuxtoy.org/blob/master/content'
 
@@ -47,10 +47,11 @@
 THEME = 'themes/itoy'
 
 PLUGIN_PATHS = ['plugins']
-PLUGINS = ['pelican-page-order', 'summary', 'neighbors', 'related_posts']
+PLUGINS = ['pelican-page-order', 'summary', 'neighbors', 'related_posts', 'random_article']
 
 CACHE_CONTENT = True
 LOAD_CONTENT_CACHE = True
 CHECK_MODIFIED_METHOD = 'mtime'
 
 RELATED_POSTS_MAX = 5
+RANDOM = 'random.html'
diff --git a/plugins/cjk-auto-spacing/README.md b/plugins/cjk-auto-spacing/README.md
diff --git a/plugins/cjk-auto-spacing/__init__.py b/plugins/cjk-auto-spacing/__init__.py
diff --git a/plugins/cjk-auto-spacing/cjk_auto_spacing.py b/plugins/cjk-auto-spacing/cjk_auto_spacing.py
diff --git a/plugins/cjk-auto-spacing/screenshot1.png b/plugins/cjk-auto-spacing/screenshot1.png
diff --git a/plugins/cjk-auto-spacing/screenshot2.png b/plugins/cjk-auto-spacing/screenshot2.png
diff --git a/plugins/random_article/Readme.md b/plugins/random_article/Readme.md
@@ -0,0 +1,19 @@
+Random Article Plugin For Pelican
+========================
+
+This plugin generates a html file which redirect to a random article
+using javascript's `window.location`. The generated html file is 
+saved at `SITEURL`.
+
+Only published articles are listed to redirect.
+
+Usage
+-----
+
+To use it you have to add in your config file the name of the file to use:
+
+    RANDOM = 'random.html'
+
+Then in some template you add:
+
+    <a href="{{ SITEURL }}/{{ RANDOM }}">random article</a>
diff --git a/plugins/random_article/__init__.py b/plugins/random_article/__init__.py
@@ -0,0 +1 @@
+from .random_article import *
diff --git a/plugins/random_article/random_article.py b/plugins/random_article/random_article.py
@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+"""
+Random Article Plugin For Pelican
+========================
+
+This plugin generates a html file which redirect to a random article
+using javascript's window.location. The generated html file is 
+saved at SITEURL.
+"""
+
+from __future__ import unicode_literals
+
+import os.path
+
+from logging import info
+from codecs import open
+
+from pelican import signals
+
+HTML_TOP = """
+<!DOCTYPE html>
+<head>
+    <title>random</title>
+    <script type="text/javascript">
+        function redirect(){
+            var urls = [
+"""
+
+HTML_BOTTOM = """
+        ""];
+
+        var index = Math.floor(Math.random() * (urls.length-1));
+        window.location = urls[index];
+    }
+</script>
+<body onload="redirect()">
+</body>
+</html>
+"""
+
+ARTICLE_URL = """ "{0}/{1}",
+"""
+
+
+class RandomArticleGenerator(object):
+    """
+        The structure is derived from sitemap plugin
+    """
+
+    def __init__(self, context, settings, path, theme, output_path, *null):
+
+        self.output_path = output_path
+        self.context = context
+        self.siteurl = settings.get('SITEURL')
+        self.randomurl = settings.get('RANDOM')
+
+    def write_url(self, article, fd):
+        if getattr(article, 'status', 'published') != 'published':
+            return
+
+        page_path = os.path.join(self.output_path, article.url)
+        if not os.path.exists(page_path):
+            return
+
+        fd.write(ARTICLE_URL.format(self.siteurl, article.url))
+
+
+    def generate_output(self, writer):
+        path = os.path.join(self.output_path, self.randomurl)
+        articles = self.context['articles']
+        info('writing {0}'.format(path))
+
+        if len(articles) == 0:
+            return
+
+        with open(path, 'w', encoding='utf-8') as fd:
+            fd.write(HTML_TOP)
+
+            for art in articles:
+                self.write_url(art, fd)
+
+            fd.write(HTML_BOTTOM)
+
+def get_generators(generators):
+    return RandomArticleGenerator
+
+
+def register():
+    signals.get_generators.connect(get_generators)