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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Bug feed (syndication) views."""
__metaclass__ = type
__all__ = [
'BugFeed',
'BugTargetBugsFeed',
'PersonBugsFeed',
'SearchBugsFeed',
]
from z3c.ptcompat import ViewPageTemplateFile
from zope.component import getUtility
from canonical.config import config
from canonical.launchpad.webapp import (
canonical_url,
urlparse,
)
from canonical.launchpad.webapp.authorization import check_permission
from canonical.launchpad.webapp.interfaces import ILaunchpadRoot
from canonical.launchpad.webapp.publisher import LaunchpadView
from canonical.lazr.feed import (
FeedBase,
FeedEntry,
FeedPerson,
FeedTypedData,
MINUTES,
)
from lp.bugs.browser.bugtask import (
BugsBugTaskSearchListingView,
BugTargetView,
)
from lp.bugs.interfaces.bug import (
IBug,
IBugSet,
)
from lp.bugs.interfaces.bugtarget import IHasBugs
from lp.bugs.interfaces.bugtask import IBugTaskSet
from lp.bugs.interfaces.malone import IMaloneApplication
from lp.registry.browser.person import PersonRelatedBugTaskSearchListingView
from lp.registry.interfaces.person import IPerson
class BugFeedContentView(LaunchpadView):
"""View for a bug feed contents."""
def __init__(self, context, request, feed):
super(BugFeedContentView, self).__init__(context, request)
self.feed = feed
def render(self):
"""Render the view."""
return ViewPageTemplateFile('templates/bug.pt')(self)
class BugsFeedBase(FeedBase):
"""Abstract class for bug feeds."""
# max_age is in seconds
max_age = config.launchpad.max_bug_feed_cache_minutes * MINUTES
rootsite = "bugs"
def initialize(self):
"""See `LaunchpadView`."""
super(BugsFeedBase, self).initialize()
self.setupColumns()
def setupColumns(self):
"""Set up the columns to be displayed in the feed.
This method may need to be overridden to customize the display for
different feeds.
"""
self.show_column = dict(
id = True,
title = True,
bugtargetdisplayname = True,
importance = True,
status = True)
@property
def logo(self):
"""See `IFeed`."""
return "%s/@@/bug" % self.site_url
def _sortByDateCreated(self, bugs):
return sorted(bugs,
key=lambda bug: (bug.datecreated, bug.id),
reverse=True)
def _getRawItems(self):
"""Get the raw set of items for the feed."""
raise NotImplementedError
def getPublicRawItems(self):
"""Private bugs are not to be shown in feeds.
The list of bugs is screened to ensure no private bugs are returned.
"""
# XXX: BradCrittenden 2008-03-26 bug=206811: The screening of private
# bugs should be done in the database query.
bugs = self._getRawItems()
for bug in bugs:
assert not bug.private, (
"Private bugs should not be retrieved for feeds.")
return self._sortByDateCreated(bugs)
def _getItemsWorker(self):
"""Create the list of items.
Called by getItems which may cache the results.
"""
bugs = self.getPublicRawItems()
# Convert the bugs into their feed entry representation.
bugs = [self.itemToFeedEntry(bug) for bug in bugs]
return bugs
def itemToFeedEntry(self, bug):
"""Convert the items to FeedEntries."""
title = FeedTypedData('[%s] %s' % (bug.id, bug.title))
url = canonical_url(bug, rootsite=self.rootsite)
content_view = BugFeedContentView(bug, self.request, self)
entry = FeedEntry(title=title,
link_alternate=url,
date_created=bug.datecreated,
date_updated=bug.date_last_updated,
date_published=bug.datecreated,
authors=[FeedPerson(bug.owner, self.rootsite)],
content=FeedTypedData(content_view.render(),
content_type="html"))
return entry
def renderHTML(self):
"""See `IFeed`."""
return ViewPageTemplateFile('templates/bug-html.pt')(self)
def getBugsFromBugTasks(self, tasks):
"""Given a list of BugTasks return the list of associated bugs.
Since a Bug can have multiple BugTasks, we only select bugs that have
not yet been seen.
"""
bug_ids = []
for task in tasks:
if task.bugID in bug_ids:
continue
bug_ids.append(task.bugID)
if len(bug_ids) >= self.quantity:
break
# XXX: BradCrittenden 2008-03-26 bug=TBD:
# For database efficiency we want to do something like the following:
# bugs = self.context.select("id in %s" % sqlvalues(bug_ids))
# Should this be a new method on BugSet?
bugset = getUtility(IBugSet)
bugs = [bugset.get(bug_id) for bug_id in bug_ids]
return bugs
class BugFeed(BugsFeedBase):
"""Bug feeds for single bug."""
usedfor = IBug
feedname = "bug"
def initialize(self):
"""See `IFeed`."""
# For a `BugFeed` we must ensure that the bug is not private.
super(BugFeed, self).initialize()
if self.context.private:
if check_permission("launchpad.View", self.context):
message_prefix = "This bug is private."
redirect_url = canonical_url(self.context)
else:
# Bug cannot be seen so redirect to the bugs index page.
message_prefix = "The requested bug is private."
root = getUtility(ILaunchpadRoot)
redirect_url = canonical_url(root, rootsite='bugs')
self.request.response.addErrorNotification(
message_prefix + " Feeds do not serve private bugs.")
self.request.response.redirect(redirect_url)
@property
def title(self):
"""See `IFeed`."""
return "Bug %s" % self.context.id
@property
def feed_id(self):
"""See `IFeed`."""
datecreated = self.context.datecreated.date().isoformat()
url_path = urlparse(self.link_alternate)[2]
id_ = 'tag:launchpad.net,%s:%s' % (
datecreated,
url_path)
return id_
def _getRawItems(self):
"""The list of bugs for this feed only has the single bug."""
return [self.context]
class BugTargetBugsFeed(BugsFeedBase):
"""Bug feeds for projects and products."""
usedfor = IHasBugs
feedname = "latest-bugs"
def setupColumns(self):
"""See `BugsFeedBase`.
Since this feed is for a specific IHasBugs it is redundant to
include the name in the output.
"""
super(BugTargetBugsFeed, self).setupColumns()
if 'bugtargetdisplayname' in self.show_column:
del self.show_column['bugtargetdisplayname']
@property
def title(self):
"""See `IFeed`."""
return "Bugs in %s" % self.context.displayname
@property
def feed_id(self):
"""See `IFeed`."""
# Get the creation date, if available.
if hasattr(self.context, 'date_created'):
datecreated = self.context.date_created.date().isoformat()
elif hasattr(self.context, 'datecreated'):
datecreated = self.context.datecreated.date().isoformat()
else:
datecreated = '2008'
url_path = urlparse(self.link_alternate)[2]
id_ = 'tag:launchpad.net,%s:/%s%s' % (
datecreated,
self.rootsite,
url_path)
return id_
def _getRawItems(self):
"""Get the raw set of items for the feed."""
delegate_view = BugTargetView(self.context, self.request)
# XXX: BradCrittenden 2008-03-25 bug=206811:
# The feed should have `self.quantity` entries, each representing a
# bug. Our query returns bugtasks, not bugs. We then work backward
# to find the bugs associated with the bugtasks. In order to get
# `self.quantity` bugs we need to fetch more than that number of
# bugtasks. As a hack, we're just getting 2 times the number and
# hoping it is sufficient. The correct action would be to get a
# batched result and work through the batches until a suffient number
# of bugs are found.
bugtasks = delegate_view.latestBugTasks(quantity=self.quantity * 2)
return self.getBugsFromBugTasks(bugtasks)
class PersonBugsFeed(BugsFeedBase):
"""Bug feeds for a person."""
usedfor = IPerson
feedname = "latest-bugs"
@property
def title(self):
"""See `IFeed`."""
return "Bugs for %s" % self.context.displayname
def _getRawItems(self):
"""Perform the search."""
delegate_view = PersonRelatedBugTaskSearchListingView(
self.context, self.request)
# Since the delegate_view derives from LaunchpadFormView the view must
# be initialized to setup the widgets.
delegate_view.initialize()
batch_navigator = delegate_view.search(
extra_params=dict(orderby='-datecreated'))
items = batch_navigator.batch.list[:self.quantity * 2]
return self.getBugsFromBugTasks(items)
class SearchBugsFeed(BugsFeedBase):
"""Bug feeds for a generic search.
Searches are of the form produced by an advanced bug search, e.g.
http://bugs.launchpad.dev/bugs/+bugs.atom?field.searchtext=&
search=Search+Bug+Reports&field.scope=all&field.scope.target=
"""
usedfor = IBugTaskSet
feedname = "+bugs"
def _getRawItems(self):
"""Perform the search."""
search_context = getUtility(IMaloneApplication)
delegate_view = BugsBugTaskSearchListingView(self.context,
self.request)
# Since the delegate_view derives from LaunchpadFormView the view must
# be initialized to setup the widgets.
delegate_view.initialize()
batch_navigator = delegate_view.search(searchtext=None,
context=search_context,
extra_params=None)
# XXX: BradCrittenden 2008-03-25 bug=206811:
# See description above.
items = batch_navigator.batch.list[:self.quantity * 2]
return self.getBugsFromBugTasks(items)
@property
def title(self):
"""See `IFeed`."""
return "Bugs from custom search"
@property
def link_self(self):
"""See `IFeed`."""
return "%s?%s" % (self.request.getURL(),
self.request.get('QUERY_STRING'))
@property
def link_alternate(self):
"""See `IFeed`."""
return "%s/bugs/%s?%s" % (self.site_url, self.feedname,
self.request.get('QUERY_STRING'))
@property
def feed_id(self):
"""See `IFeed`."""
# We don't track the creation date for any given search query so we'll
# just use a fixed, abbreviated date, which is allowed by the RFC.
datecreated = "2008"
full_path = self.link_self[self.link_self.find('/+bugs'):]
id_ = 'tag:launchpad.net,%s:%s' % (
datecreated,
full_path)
return id_
|