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
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2014 Edgewall Software
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at http://trac.edgewall.com/license.html.
#
# This software consists of voluntary contributions made by many
# individuals. For the exact contribution history, see the revision
# history and logs, available at http://trac.edgewall.org/.
from pkg_resources import resource_listdir
from trac.config import ListOption, Option
from trac.core import Component, implements
from trac.resource import Resource, resource_exists
from trac.web.api import IRequestFilter
NOTICE_TEMPLATE = """\
{{{#!box note
This page documents the %(release)s (%(desc)s) release.%(alt_notice)s
}}}
"""
ALT_NOTICE_TEMPLATE = """
See [[%(alt_page)s]] if you need the %(alt_desc)s version.
"""
class HelpGuideVersionNotice(Component):
"""Adds a version notice to pages in the Help/Guide with a link to
the previous or current version of the page in the guide. The
WikiExtraPlugin needs to be installed for pretty rendering of the
notice using the `box` WikiProcessor.
"""
implements(IRequestFilter)
lts_release = Option('teo', 'lts_release', '0.12',
doc="Version of the LTS release of Trac.")
stable_release = Option('teo', 'stable_release', '1.0',
doc="Version of the stable release of Trac.")
dev_release = Option('teo', 'dev_release', '1.1',
doc="Version of the dev release of Trac.")
ignored_pages = ListOption('teo', 'ignored_pages',
'TitleIndex, SandBox, WikiStart',
doc="List of pages to ignore.")
def __init__(self):
self.default_pages = resource_listdir('trac.wiki', 'default-pages')
for page in self.ignored_pages:
self.default_pages.remove(page)
def pre_process_request(self, req, handler):
return handler
def post_process_request(self, req, template, data, content_type):
if data and 'page' in data and 'text' in data:
name = data['page'].name
notice = ""
release = desc = alt_rel_path = alt_id = alt_desc = None
if name in self.default_pages:
release = self.stable_release
desc = 'latest stable'
alt_id = self.lts_release + '/' + name
alt_rel_path = alt_id
alt_desc = 'previous'
elif name.startswith(self.lts_release) and \
name[len(self.lts_release)+1:] in self.default_pages:
release = self.lts_release
desc = 'maintenance'
alt_id = name[len(self.lts_release)+1:]
alt_rel_path = '../../' + alt_id
alt_desc = 'latest stable'
elif name.startswith(self.dev_release) and \
name[len(self.dev_release)+1:] in self.default_pages:
release = self.dev_release
desc = 'development'
alt_id = name[len(self.dev_release)+1:]
alt_rel_path = '../../' + alt_id
alt_desc = 'latest stable'
if alt_id:
resource = Resource('wiki', alt_id)
alt_notice = ALT_NOTICE_TEMPLATE % {'alt_page': alt_rel_path,
'alt_desc': alt_desc} \
if resource_exists(self.env, resource) \
else ""
notice = NOTICE_TEMPLATE % {'release': release,
'desc': desc,
'alt_notice': alt_notice}
data['text'] = notice + data['text']
return template, data, content_type
|
