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
|
# -*- coding: utf-8 -*-
# Copyright © 2012-2015 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 copy
import os
# for tearDown with _reload we cannot use 'import from' to access LocaleBorg
import nikola.utils
import datetime
from nikola.plugin_categories import Task
from nikola.utils import config_changed, adjust_name_for_index_path, adjust_name_for_index_link
class Archive(Task):
"""Render the post archives."""
name = "render_archive"
def set_site(self, site):
site.register_path_handler('archive', self.archive_path)
site.register_path_handler('archive_atom', self.archive_atom_path)
return super(Archive, self).set_site(site)
def _prepare_task(self, kw, name, lang, posts, items, template_name,
title, deps_translatable=None):
# name: used to build permalink and destination
# posts, items: posts or items; only one of them should be used,
# the other be None
# template_name: name of the template to use
# title: the (translated) title for the generated page
# deps_translatable: dependencies (None if not added)
assert posts is not None or items is not None
context = {}
context["lang"] = lang
context["title"] = title
context["permalink"] = self.site.link("archive", name, lang)
if posts is not None:
context["posts"] = posts
n = len(posts)
else:
context["items"] = items
n = len(items)
task = self.site.generic_post_list_renderer(
lang,
[],
os.path.join(kw['output_folder'], self.site.path("archive", name, lang)),
template_name,
kw['filters'],
context,
)
task_cfg = {1: copy.copy(kw), 2: n}
if deps_translatable is not None:
task_cfg[3] = deps_translatable
task['uptodate'] = task['uptodate'] + [config_changed(task_cfg, 'nikola.plugins.task.archive')]
task['basename'] = self.name
return task
def _generate_posts_task(self, kw, name, lang, posts, title, deps_translatable=None):
posts = sorted(posts, key=lambda a: a.date)
posts.reverse()
if kw['archives_are_indexes']:
def page_link(i, displayed_i, num_pages, force_addition, extension=None):
feed = "_atom" if extension == ".atom" else ""
return adjust_name_for_index_link(self.site.link("archive" + feed, name, lang), i, displayed_i,
lang, self.site, force_addition, extension)
def page_path(i, displayed_i, num_pages, force_addition, extension=None):
feed = "_atom" if extension == ".atom" else ""
return adjust_name_for_index_path(self.site.path("archive" + feed, name, lang), i, displayed_i,
lang, self.site, force_addition, extension)
uptodate = []
if deps_translatable is not None:
uptodate += [config_changed(deps_translatable, 'nikola.plugins.task.archive')]
yield self.site.generic_index_renderer(
lang,
posts,
title,
"archiveindex.tmpl",
{"archive_name": name,
"is_feed_stale": kw["is_feed_stale"]},
kw,
str(self.name),
page_link,
page_path,
uptodate)
else:
yield self._prepare_task(kw, name, lang, posts, None, "list_post.tmpl", title, deps_translatable)
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'],
"archives_are_indexes": self.site.config['ARCHIVES_ARE_INDEXES'],
"create_monthly_archive": self.site.config['CREATE_MONTHLY_ARCHIVE'],
"create_single_archive": self.site.config['CREATE_SINGLE_ARCHIVE'],
"show_untranslated_posts": self.site.config['SHOW_UNTRANSLATED_POSTS'],
"create_full_archives": self.site.config['CREATE_FULL_ARCHIVES'],
"create_daily_archive": self.site.config['CREATE_DAILY_ARCHIVE'],
"pretty_urls": self.site.config['PRETTY_URLS'],
"strip_indexes": self.site.config['STRIP_INDEXES'],
"index_file": self.site.config['INDEX_FILE'],
"generate_atom": self.site.config["GENERATE_ATOM"],
}
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']) and not kw['create_full_archives']:
raise Exception('Cannot create monthly and single archives at the same time.')
for lang in kw["translations"]:
if kw['create_single_archive'] and not kw['create_full_archives']:
# if we are creating one single archive
archdata = {}
else:
# if we are not creating one single archive, start with all years
archdata = self.site.posts_per_year.copy()
if kw['create_single_archive'] or kw['create_full_archives']:
# if we are creating one single archive, or full archives
archdata[None] = self.site.posts # for create_single_archive
for year, posts in archdata.items():
# Filter untranslated posts (Issue #1360)
if not kw["show_untranslated_posts"]:
posts = [p for p in posts if lang in p.translated_to]
# Add archive per year or total archive
if year:
title = kw["messages"][lang]["Posts for year %s"] % year
kw["is_feed_stale"] = (datetime.datetime.utcnow().strftime("%Y") != year)
else:
title = kw["messages"][lang]["Archive"]
kw["is_feed_stale"] = False
deps_translatable = {}
for k in self.site._GLOBAL_CONTEXT_TRANSLATABLE:
deps_translatable[k] = self.site.GLOBAL_CONTEXT[k](lang)
if not kw["create_monthly_archive"] or kw["create_full_archives"]:
yield self._generate_posts_task(kw, year, lang, posts, title, deps_translatable)
else:
months = set([(m.split('/')[1], self.site.link("archive", m, lang)) for m in self.site.posts_per_month.keys() if m.startswith(str(year))])
months = sorted(list(months))
months.reverse()
items = [[nikola.utils.LocaleBorg().get_month_name(int(month), lang), link] for month, link in months]
yield self._prepare_task(kw, year, lang, None, items, "list.tmpl", title, deps_translatable)
if not kw["create_monthly_archive"] and not kw["create_full_archives"] and not kw["create_daily_archive"]:
continue # Just to avoid nesting the other loop in this if
for yearmonth, posts in self.site.posts_per_month.items():
# Add archive per month
year, month = yearmonth.split('/')
kw["is_feed_stale"] = (datetime.datetime.utcnow().strftime("%Y/%m") != yearmonth)
# Filter untranslated posts (via Issue #1360)
if not kw["show_untranslated_posts"]:
posts = [p for p in posts if lang in p.translated_to]
if kw["create_monthly_archive"] or kw["create_full_archives"]:
title = kw["messages"][lang]["Posts for {month} {year}"].format(
year=year, month=nikola.utils.LocaleBorg().get_month_name(int(month), lang))
yield self._generate_posts_task(kw, yearmonth, lang, posts, title)
if not kw["create_full_archives"] and not kw["create_daily_archive"]:
continue # Just to avoid nesting the other loop in this if
# Add archive per day
days = dict()
for p in posts:
if p.date.day not in days:
days[p.date.day] = list()
days[p.date.day].append(p)
for day, posts in days.items():
title = kw["messages"][lang]["Posts for {month} {day}, {year}"].format(
year=year, month=nikola.utils.LocaleBorg().get_month_name(int(month), lang), day=day)
yield self._generate_posts_task(kw, yearmonth + '/{0:02d}'.format(day), lang, posts, title)
if not kw['create_single_archive'] and not kw['create_full_archives']:
# And an "all your years" page for yearly and monthly archives
if "is_feed_stale" in kw:
del kw["is_feed_stale"]
years = list(self.site.posts_per_year.keys())
years.sort(reverse=True)
kw['years'] = years
for lang in kw["translations"]:
items = [(y, self.site.link("archive", y, lang)) for y in years]
yield self._prepare_task(kw, None, lang, None, items, "list.tmpl", kw["messages"][lang]["Archive"])
def archive_path(self, name, lang, is_feed=False):
if is_feed:
extension = ".atom"
archive_file = os.path.splitext(self.site.config['ARCHIVE_FILENAME'])[0] + extension
index_file = os.path.splitext(self.site.config['INDEX_FILE'])[0] + extension
else:
archive_file = self.site.config['ARCHIVE_FILENAME']
index_file = self.site.config['INDEX_FILE']
if name:
return [_f for _f in [self.site.config['TRANSLATIONS'][lang],
self.site.config['ARCHIVE_PATH'], name,
index_file] if _f]
else:
return [_f for _f in [self.site.config['TRANSLATIONS'][lang],
self.site.config['ARCHIVE_PATH'],
archive_file] if _f]
def archive_atom_path(self, name, lang):
return self.archive_path(name, lang, is_feed=True)
|
