diff options
Diffstat (limited to 'nikola/plugins/task/archive.py')
| -rw-r--r-- | nikola/plugins/task/archive.py | 167 |
1 files changed, 167 insertions, 0 deletions
diff --git a/nikola/plugins/task/archive.py b/nikola/plugins/task/archive.py new file mode 100644 index 0000000..3afbea1 --- /dev/null +++ b/nikola/plugins/task/archive.py @@ -0,0 +1,167 @@ +# -*- coding: utf-8 -*- + +# Copyright © 2012-2013 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. + +import os + +# for tearDown with _reload we cannot use 'import from' to access LocaleBorg +import nikola.utils +from nikola.plugin_categories import Task +from nikola.utils import config_changed + + +class Archive(Task): + """Render the post archives.""" + + name = "render_archive" + + def set_site(self, site): + site.register_path_handler('archive', self.archive_path) + return super(Archive, self).set_site(site) + + def gen_tasks(self): + kw = { + "messages": self.site.MESSAGES, + "translations": self.site.config['TRANSLATIONS'], + "output_folder": self.site.config['OUTPUT_FOLDER'], + "filters": self.site.config['FILTERS'], + "create_monthly_archive": self.site.config['CREATE_MONTHLY_ARCHIVE'], + "create_single_archive": self.site.config['CREATE_SINGLE_ARCHIVE'], + } + self.site.scan_posts() + yield self.group_task() + # TODO add next/prev links for years + if kw['create_monthly_archive'] and kw['create_single_archive']: + raise Exception('Cannot create monthly and single archives at the same time.') + for lang in kw["translations"]: + archdata = self.site.posts_per_year + # A bit of a hack. + if kw['create_single_archive']: + archdata = {None: self.site.posts} + + for year, posts in archdata.items(): + output_name = os.path.join( + kw['output_folder'], self.site.path("archive", year, lang)) + context = {} + context["lang"] = lang + if year: + context["title"] = kw["messages"][lang]["Posts for year %s"] % year + else: + context["title"] = kw["messages"][lang]["Archive"] + context["permalink"] = self.site.link("archive", year, lang) + if not kw["create_monthly_archive"]: + template_name = "list_post.tmpl" + post_list = [self.site.global_data[post] for post in posts] + post_list.sort(key=lambda a: a.date) + post_list.reverse() + context["posts"] = post_list + else: # Monthly archives, just list the months + months = set([m.split('/')[1] for m in self.site.posts_per_month.keys() if m.startswith(str(year))]) + months = sorted(list(months)) + months.reverse() + template_name = "list.tmpl" + context["items"] = [[nikola.utils.LocaleBorg().get_month_name(int(month), lang), month] for month in months] + post_list = [] + task = self.site.generic_post_list_renderer( + lang, + [], + output_name, + template_name, + kw['filters'], + context, + ) + task_cfg = {1: task['uptodate'][0].config, 2: kw} + task['uptodate'] = [config_changed(task_cfg)] + task['basename'] = self.name + yield task + + if not kw["create_monthly_archive"]: + continue # Just to avoid nesting the other loop in this if + template_name = "list_post.tmpl" + for yearmonth, posts in self.site.posts_per_month.items(): + output_name = os.path.join( + kw['output_folder'], self.site.path("archive", yearmonth, + lang)) + year, month = yearmonth.split('/') + post_list = [self.site.global_data[post] for post in posts] + post_list.sort(key=lambda a: a.date) + post_list.reverse() + context = {} + context["lang"] = lang + context["posts"] = post_list + context["permalink"] = self.site.link("archive", year, lang) + + context["title"] = kw["messages"][lang]["Posts for {month} {year}"].format( + year=year, month=nikola.utils.LocaleBorg().get_month_name(int(month), lang)) + task = self.site.generic_post_list_renderer( + lang, + post_list, + output_name, + template_name, + kw['filters'], + context, + ) + task_cfg = {1: task['uptodate'][0].config, 2: kw} + task['uptodate'] = [config_changed(task_cfg)] + task['basename'] = self.name + yield task + + if not kw['create_single_archive']: + # And an "all your years" page for yearly and monthly archives + years = list(self.site.posts_per_year.keys()) + years.sort(reverse=True) + template_name = "list.tmpl" + kw['years'] = years + for lang in kw["translations"]: + context = {} + output_name = os.path.join( + kw['output_folder'], self.site.path("archive", None, + lang)) + context["title"] = kw["messages"][lang]["Archive"] + context["items"] = [(year, self.site.link("archive", year, lang)) + for year in years] + context["permalink"] = self.site.link("archive", None, lang) + task = self.site.generic_post_list_renderer( + lang, + [], + output_name, + template_name, + kw['filters'], + context, + ) + task_cfg = {1: task['uptodate'][0].config, 2: kw} + task['uptodate'] = [config_changed(task_cfg)] + task['basename'] = self.name + yield task + + def archive_path(self, name, lang): + if name: + return [_f for _f in [self.site.config['TRANSLATIONS'][lang], + self.site.config['ARCHIVE_PATH'], name, + self.site.config['INDEX_FILE']] if _f] + else: + return [_f for _f in [self.site.config['TRANSLATIONS'][lang], + self.site.config['ARCHIVE_PATH'], + self.site.config['ARCHIVE_FILENAME']] if _f] |