Mercurial > piecrust2

annotate piecrust/generation/blogarchives.py @ 724:09115f0900f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bake: Add blog archives generator.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 29 May 2016 20:20:19 -0700
parents ab5c6a8ae90a
children e35407c60e00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
1 import logging
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
2 import datetime
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
3 from piecrust.data.filters import PaginationFilter, IFilterClause
711
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 from piecrust.generation.base import PageGenerator
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
7 logger = logging.getLogger(__name__)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
8
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
9
711
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 class BlogArchivesPageGenerator(PageGenerator):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 GENERATOR_NAME = 'blog_archives'
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
13 def __init__(self, app, name, config):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
14 super(BlogArchivesPageGenerator, self).__init__(app, name, config)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
15
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
16 def onRouteFunctionUsed(self, route, route_metadata):
711
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 pass
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
19 def prepareRenderContext(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
20 ctx.pagination_source = self.source
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
21
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
22 year = ctx.page.route_metadata.get('year')
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
23 if year is None:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
24 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
25 "Can't find the archive year in the route metadata")
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
26 if type(year) is not int:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
27 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
28 "The route for generator '%s' should specify an integer "
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
29 "parameter for 'year'." % self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
30
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
31 flt = PaginationFilter()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
32 flt.addClause(IsFromYearFilterClause(year))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
33 ctx.pagination_filter = flt
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
34
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
35 ctx.custom_data['year'] = year
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
36
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
37 def bake(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
38 if not self.page_ref.exists:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
39 logger.debug(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
40 "No page found at '%s', skipping %s archives." %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
41 (self.page_ref, self.source_name))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
42 return
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
43
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
44 logger.debug("Baking %s archives...", self.source_name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
45 with format_timed_scope(logger, 'gathered archive years',
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
46 level=logging.DEBUG, colored=False):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
47 all_years, dirty_years = self._buildDirtyYears(ctx)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
48
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
49 with format_timed_scope(logger, "baked %d %s archives." %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
50 (len(dirty_years), self.source_name)):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
51 self._bakeDirtyYears(ctx, all_years, dirty_years)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
52
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
53 def _buildDirtyYears(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
54 logger.debug("Gathering dirty post years.")
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
55 all_years = set()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
56 dirty_years = set()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
57 for _, cur_entry in ctx.getAllPageRecords():
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
58 if cur_entry.source_name == self.source_name:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
59 dt = datetime.datetime.fromtimestamp(cur_entry.timestamp)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
60 all_years.add(dt.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
61 if cur_entry.was_any_sub_baked:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
62 dirty_years.add(dt.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
63 return all_years, dirty_years
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
64
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
65 def _bakeDirtyYears(self, ctx, all_years, dirty_years):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
66 route = self.app.getGeneratorRoute(self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
67 if route is None:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
68 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
69 "No routes have been defined for generator: %s" %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
70 self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
71
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
72 logger.debug("Using archive page: %s" % self.page_ref)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
73 fac = self.page_ref.getFactory()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
74
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
75 for y in dirty_years:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
76 extra_route_metadata = {'year': y}
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
77
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
78 logger.debug("Queuing: %s [%s]" % (fac.ref_spec, y))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
79 ctx.queueBakeJob(fac, route, extra_route_metadata, str(y))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
80 ctx.runJobQueue()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
81
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
82 # Create bake entries for the years that were *not* dirty.
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
83 # Otherwise, when checking for deleted pages, we would not find any
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
84 # outputs and would delete those files.
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
85 for prev_entry, cur_entry in ctx.getAllPageRecords():
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
86 if prev_entry and not cur_entry:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
87 try:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
88 y = ctx.getSeedFromRecordExtraKey(prev_entry.extra_key)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
89 except InvalidRecordExtraKey:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
90 continue
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
91 if y in all_years:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
92 logger.debug("Creating unbaked entry for %d archive." % y)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
93 ctx.collapseRecord(prev_entry)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
94 else:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
95 logger.debug("No page references year %d anymore." % y)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
96
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
97
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
98 class IsFromYearFilterClause(IFilterClause):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
99 def __init__(self, year):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
100 self.year = year
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
101
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
102 def pageMatches(self, fil, page):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
103 return (page.datetime.year == self.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
104