Mercurial > piecrust2

annotate piecrust/generation/blogarchives.py @ 729:e35407c60e00

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
templating: Make blog archives generator expose more templating data. In addition to pagination data, also expose a non-paginating iterator that lists all posts in a source by chronological order.
author Ludovic Chabant <ludovic@chabant.com>
date Wed, 01 Jun 2016 22:09:21 -0700
parents 09115f0900f0
children 13ec290bfc13
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
729
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
3 from piecrust.chefutil import format_timed_scope
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
4 from piecrust.data.filters import PaginationFilter, IFilterClause
729
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
5 from piecrust.data.iterators import PageIterator
711
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 from piecrust.generation.base import PageGenerator
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
9 logger = logging.getLogger(__name__)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
10
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
11
711
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 class BlogArchivesPageGenerator(PageGenerator):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 GENERATOR_NAME = 'blog_archives'
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
15 def __init__(self, app, name, config):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
16 super(BlogArchivesPageGenerator, self).__init__(app, name, config)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
17
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
18 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
19 pass
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
21 def prepareRenderContext(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
22 ctx.pagination_source = self.source
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
23
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
24 year = ctx.page.route_metadata.get('year')
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
25 if year is None:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
26 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
27 "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
28 if type(year) is not int:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
29 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
30 "The route for generator '%s' should specify an integer "
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
31 "parameter for 'year'." % self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
32
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
33 flt = PaginationFilter()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
34 flt.addClause(IsFromYearFilterClause(year))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
35 ctx.pagination_filter = flt
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 ctx.custom_data['year'] = year
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
38
729
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
39 flt2 = PaginationFilter()
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
40 flt2.addClause(IsFromYearFilterClause(year))
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
41 it = PageIterator(self.source, pagination_filter=flt2,
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
42 sorter=_date_sorter)
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
43 ctx.custom_data['archives'] = it
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
44
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
45 def bake(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
46 if not self.page_ref.exists:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
47 logger.debug(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
48 "No page found at '%s', skipping %s archives." %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
49 (self.page_ref, self.source_name))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
50 return
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
51
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
52 logger.debug("Baking %s archives...", self.source_name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
53 with format_timed_scope(logger, 'gathered archive years',
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
54 level=logging.DEBUG, colored=False):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
55 all_years, dirty_years = self._buildDirtyYears(ctx)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
56
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
57 with format_timed_scope(logger, "baked %d %s archives." %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
58 (len(dirty_years), self.source_name)):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
59 self._bakeDirtyYears(ctx, all_years, dirty_years)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
60
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
61 def _buildDirtyYears(self, ctx):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
62 logger.debug("Gathering dirty post years.")
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
63 all_years = set()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
64 dirty_years = set()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
65 for _, cur_entry in ctx.getAllPageRecords():
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
66 if cur_entry.source_name == self.source_name:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
67 dt = datetime.datetime.fromtimestamp(cur_entry.timestamp)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
68 all_years.add(dt.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
69 if cur_entry.was_any_sub_baked:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
70 dirty_years.add(dt.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
71 return all_years, dirty_years
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
72
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
73 def _bakeDirtyYears(self, ctx, all_years, dirty_years):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
74 route = self.app.getGeneratorRoute(self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
75 if route is None:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
76 raise Exception(
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
77 "No routes have been defined for generator: %s" %
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
78 self.name)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
79
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
80 logger.debug("Using archive page: %s" % self.page_ref)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
81 fac = self.page_ref.getFactory()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
82
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
83 for y in dirty_years:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
84 extra_route_metadata = {'year': y}
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
85
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
86 logger.debug("Queuing: %s [%s]" % (fac.ref_spec, y))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
87 ctx.queueBakeJob(fac, route, extra_route_metadata, str(y))
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
88 ctx.runJobQueue()
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
89
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
90 # 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
91 # 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
92 # outputs and would delete those files.
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
93 for prev_entry, cur_entry in ctx.getAllPageRecords():
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
94 if prev_entry and not cur_entry:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
95 try:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
96 y = ctx.getSeedFromRecordExtraKey(prev_entry.extra_key)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
97 except InvalidRecordExtraKey:
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
98 continue
729
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
99 if y in all_years:
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
100 logger.debug("Creating unbaked entry for %d archive." % y)
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
101 ctx.collapseRecord(prev_entry)
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
102 else:
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
103 logger.debug("No page references year %d anymore." % y)
724
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
104
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
105
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
106 class IsFromYearFilterClause(IFilterClause):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
107 def __init__(self, year):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
108 self.year = year
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
109
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
110 def pageMatches(self, fil, page):
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
111 return (page.datetime.year == self.year)
09115f0900f0 bake: Add blog archives generator.
Ludovic Chabant <ludovic@chabant.com>
parents: 711
diff changeset
112
729
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
113
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
114 def _date_sorter(it):
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
115 return sorted(it, key=lambda x: x.datetime)
e35407c60e00 templating: Make blog archives generator expose more templating data.
Ludovic Chabant <ludovic@chabant.com>
parents: 724
diff changeset
116