annotate rhodecode/controllers/feed.py @ 1212:50e41777675d beta

pep8ify
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 05 Apr 2011 13:12:38 +0200
parents a671db5bdd58
children 11548cc19c8f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
1 # -*- coding: utf-8 -*-
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
2 """
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
3 rhodecode.controllers.feed
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
4 ~~~~~~~~~~~~~~~~~~~~~~~~~~
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
5
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
6 Feed controller for rhodecode
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1162
diff changeset
7
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
8 :created_on: Apr 23, 2010
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
9 :author: marcink
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1162
diff changeset
10 :copyright: (C) 2009-2011 Marcin Kuzminski <marcin@python-works.com>
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
11 :license: GPLv3, see COPYING for more details.
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
12 """
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
13 # This program is free software: you can redistribute it and/or modify
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
14 # it under the terms of the GNU General Public License as published by
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
15 # the Free Software Foundation, either version 3 of the License, or
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
16 # (at your option) any later version.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1162
diff changeset
17 #
252
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 245
diff changeset
18 # This program is distributed in the hope that it will be useful,
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 245
diff changeset
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 245
diff changeset
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 245
diff changeset
21 # GNU General Public License for more details.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1162
diff changeset
22 #
252
3782a6d698af licensing updates, code cleanups
Marcin Kuzminski <marcin@python-works.com>
parents: 245
diff changeset
23 # You should have received a copy of the GNU General Public License
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
24 # along with this program. If not, see <http://www.gnu.org/licenses/>.
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
25
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
26 import logging
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
27
1045
3fc9183e05dd another major codes rewrite:
Marcin Kuzminski <marcin@python-works.com>
parents: 1038
diff changeset
28 from pylons import url, response, tmpl_context as c
1038
5554aa9c2480 another major code rafactor, reimplemented (almost from scratch)
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
29 from pylons.i18n.translation import _
862
4bdd0bf1b1f4 security bugfix: protected feeds, from unauthorized access, even without this, the feeds would crash and were unreadable, But proper way of securing it is with the secure decarators.
Marcin Kuzminski <marcin@python-works.com>
parents: 861
diff changeset
30
4bdd0bf1b1f4 security bugfix: protected feeds, from unauthorized access, even without this, the feeds would crash and were unreadable, But proper way of securing it is with the secure decarators.
Marcin Kuzminski <marcin@python-works.com>
parents: 861
diff changeset
31 from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAnyDecorator
1045
3fc9183e05dd another major codes rewrite:
Marcin Kuzminski <marcin@python-works.com>
parents: 1038
diff changeset
32 from rhodecode.lib.base import BaseRepoController
862
4bdd0bf1b1f4 security bugfix: protected feeds, from unauthorized access, even without this, the feeds would crash and were unreadable, But proper way of securing it is with the secure decarators.
Marcin Kuzminski <marcin@python-works.com>
parents: 861
diff changeset
33
245
a83a1799480c Reimplemented way of caching repos list, hg model now get's repos objects right from cached dict, this way we skipp creating instances of MercurialRepository and gain performance. Some import cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 207
diff changeset
34 from webhelpers.feedgenerator import Atom1Feed, Rss201rev2Feed
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
35
205
66b20f525750 Added feed controllers, urls,and changed index page to use them.
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
36 log = logging.getLogger(__name__)
66b20f525750 Added feed controllers, urls,and changed index page to use them.
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37
1212
50e41777675d pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
38
1045
3fc9183e05dd another major codes rewrite:
Marcin Kuzminski <marcin@python-works.com>
parents: 1038
diff changeset
39 class FeedController(BaseRepoController):
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
40
1120
a8d759613d8f fixed some bugs in api key auth, added access by api key into rss/atom feeds in global journal
Marcin Kuzminski <marcin@python-works.com>
parents: 1088
diff changeset
41 @LoginRequired(api_access=True)
862
4bdd0bf1b1f4 security bugfix: protected feeds, from unauthorized access, even without this, the feeds would crash and were unreadable, But proper way of securing it is with the secure decarators.
Marcin Kuzminski <marcin@python-works.com>
parents: 861
diff changeset
42 @HasRepoPermissionAnyDecorator('repository.read', 'repository.write',
4bdd0bf1b1f4 security bugfix: protected feeds, from unauthorized access, even without this, the feeds would crash and were unreadable, But proper way of securing it is with the secure decarators.
Marcin Kuzminski <marcin@python-works.com>
parents: 861
diff changeset
43 'repository.admin')
205
66b20f525750 Added feed controllers, urls,and changed index page to use them.
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
44 def __before__(self):
66b20f525750 Added feed controllers, urls,and changed index page to use them.
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
45 super(FeedController, self).__before__()
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
46 #common values for feeds
1038
5554aa9c2480 another major code rafactor, reimplemented (almost from scratch)
Marcin Kuzminski <marcin@python-works.com>
parents: 902
diff changeset
47 self.description = _('Changes on %s repository')
1088
fee472613dfa made simple global rss and atom feed
Marcin Kuzminski <marcin@python-works.com>
parents: 1045
diff changeset
48 self.title = self.title = _('%s %s feed') % (c.rhodecode_name, '%s')
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
49 self.language = 'en-us'
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
50 self.ttl = "5"
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
51 self.feed_nr = 10
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
52
1162
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
53 def __changes(self, cs):
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
54 changes = ''
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
55
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
56 a = [n.path for n in cs.added]
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
57 if a:
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
58 changes += '\nA ' + '\nA '.join(a)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
59
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
60 m = [n.path for n in cs.changed]
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
61 if m:
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
62 changes += '\nM ' + '\nM '.join(m)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
63
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
64 d = [n.path for n in cs.removed]
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
65 if d:
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
66 changes += '\nD ' + '\nD '.join(d)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
67
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
68 changes += '</pre>'
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
69
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
70 return changes
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
71
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
72 def atom(self, repo_name):
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
73 """Produce an atom-1.0 feed via feedgenerator module"""
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
74 feed = Atom1Feed(title=self.title % repo_name,
1212
50e41777675d pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
75 link=url('summary_home', repo_name=repo_name,
50e41777675d pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
76 qualified=True),
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
77 description=self.description % repo_name,
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
78 language=self.language,
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
79 ttl=self.ttl)
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
80
1162
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
81 for cs in reversed(list(c.rhodecode_repo[-self.feed_nr:])):
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
82 desc = '%s - %s<br/><pre>' % (cs.author, cs.date)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
83 desc += self.__changes(cs)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
84
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
85 feed.add_item(title=cs.message,
245
a83a1799480c Reimplemented way of caching repos list, hg model now get's repos objects right from cached dict, this way we skipp creating instances of MercurialRepository and gain performance. Some import cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 207
diff changeset
86 link=url('changeset_home', repo_name=repo_name,
636
ffd07396d315 Fixes for raw_id, needed for git
Marcin Kuzminski <marcin@python-works.com>
parents: 629
diff changeset
87 revision=cs.raw_id, qualified=True),
1162
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
88 author_name=cs.author,
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
89 description=desc)
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
90
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
91 response.content_type = feed.mime_type
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
92 return feed.writeString('utf-8')
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
93
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
94 def rss(self, repo_name):
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
95 """Produce an rss2 feed via feedgenerator module"""
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
96 feed = Rss201rev2Feed(title=self.title % repo_name,
1212
50e41777675d pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
97 link=url('summary_home', repo_name=repo_name,
50e41777675d pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
98 qualified=True),
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
99 description=self.description % repo_name,
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
100 language=self.language,
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
101 ttl=self.ttl)
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
102
1162
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
103 for cs in reversed(list(c.rhodecode_repo[-self.feed_nr:])):
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
104 desc = '%s - %s<br/><pre>' % (cs.author, cs.date)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
105 desc += self.__changes(cs)
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
106
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
107 feed.add_item(title=cs.message,
507
f420e86db893 drastic speed improvment in feed generation (was using old method)
Marcin Kuzminski <marcin@python-works.com>
parents: 252
diff changeset
108 link=url('changeset_home', repo_name=repo_name,
636
ffd07396d315 Fixes for raw_id, needed for git
Marcin Kuzminski <marcin@python-works.com>
parents: 629
diff changeset
109 revision=cs.raw_id, qualified=True),
1162
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
110 author_name=cs.author,
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
111 description=desc,
76c5b69c1b27 fixed wrong order of changes in feeds
Marcin Kuzminski <marcin@python-works.com>
parents: 1120
diff changeset
112 )
861
fd2ea6ceadc8 updated docs on every controller
Marcin Kuzminski <marcin@python-works.com>
parents: 691
diff changeset
113
207
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
114 response.content_type = feed.mime_type
8bdec09436cb bumped version to 0.7.1 added atom and rss feeds. Moved https Fixud middleware before error middleware to proper generate debug page (static imports)
Marcin Kuzminski <marcin@python-works.com>
parents: 205
diff changeset
115 return feed.writeString('utf-8')