My favorites | Sign in
Logo
             
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
from django.conf import settings
from django.contrib.auth.models import User
from django.core.urlresolvers import reverse
from django.utils.html import conditional_escape
from django.utils.translation import ugettext_lazy as _
from djblets.datagrid.grids import Column, DateTimeColumn, \
DateTimeSinceColumn, DataGrid
from djblets.util.templatetags.djblets_utils import ageid

from reviewboard.reviews.models import Group, ReviewRequest, ReviewRequestDraft
from reviewboard.reviews.templatetags.reviewtags import render_star


class StarColumn(Column):
"""
A column used to indicate whether the object is "starred" or watched.
The star is interactive, allowing the user to star or unstar the object.
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)
self.image_url = settings.MEDIA_URL + "rb/images/star_on.png"
self.image_width = 16
self.image_height = 15
self.image_alt = "Starred"
self.detailed_label = "Starred"
self.shrink = True

def render_data(self, obj):
return render_star(self.datagrid.request.user, obj)


class ShipItColumn(Column):
"""
A column used to indicate whether someone has marked this review request
as "Ship It!"
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)
self.image_url = settings.MEDIA_URL + "rb/images/shipit.png"
self.image_width = 16
self.image_height = 16
self.image_alt = "Ship It!"
self.detailed_label = "Ship It!"
self.db_field = "shipit_count"
self.sortable = True
self.shrink = True

def render_data(self, review_request):
if review_request.shipit_count > 0:
return '<span class="shipit-count">' \
'<img src="%srb/images/shipit_checkmark.png?%s" ' \
'width="9" height="8" alt="%s" /> %s' \
'</span>' % \
(settings.MEDIA_URL, settings.MEDIA_SERIAL,
self.image_alt, review_request.shipit_count)

return ""


class MyCommentsColumn(Column):
"""
A column meant to represent the status of the logged-in user's
comments on the review.
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)
self.image_url = settings.MEDIA_URL + "rb/images/comment-draft-small.png"
self.image_width = 16
self.image_height = 16
self.image_alt = _("My Comments")
self.detailed_label = _("My Comments")
self.shrink = True

# XXX It'd be nice to be able to sort on this, but datagrids currently
# can only sort based on stored (in the DB) values, not computed values.

def render_data(self, review_request):
user = self.datagrid.request.user

if user.is_anonymous():
return ""

reviews = review_request.reviews.filter(user=user)

if len(reviews) == 0:
return ""

image_url = None
image_alt = None
found_ship_it = False

# Priority is ranked in the following order:
#
# 1) Non-public (draft) reviews
# 2) Public reviews marked "Ship It"
# 3) Public reviews not marked "Ship It"
for review in reviews:
if not review.public:
image_url = self.image_url
image_alt = _("Comments drafted")
break

if review.ship_it:
found_ship_it = True

if not image_url:
if found_ship_it:
image_url = settings.MEDIA_URL + \
"rb/images/comment-shipit-small.png"
image_alt = _("Comments published. Ship it!")
else:
image_url = settings.MEDIA_URL + "rb/images/comment-small.png"
image_alt = _("Comments published")

return '<img src="%s?%s" width="%s" height="%s" alt="%s" />' % \
(image_url, settings.MEDIA_SERIAL, self.image_width,
self.image_height, image_alt)


class NewUpdatesColumn(Column):
"""
A column used to indicate whether the review request has any new updates
since the user last saw it.
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)
self.image_url = settings.MEDIA_URL + "rb/images/convo.png"
self.image_width = 18
self.image_height = 16
self.image_alt = "New Updates"
self.detailed_label = "New Updates"
self.shrink = True

def render_data(self, review_request):
user = self.datagrid.request.user
if review_request.new_review_count > 0:
return '<img src="%s" width="%s" height="%s" alt="%s" />' % \
(self.image_url, self.image_width, self.image_height,
self.image_alt)

return ""


class SummaryColumn(Column):
"""
A column used to display a summary of the review request, along with
labels indicating if it's a draft or if it's submitted.
"""
def __init__(self, label=_("Summary"), *args, **kwargs):
Column.__init__(self, label=label, *args, **kwargs)
self.sortable = True

def render_data(self, review_request):
summary = conditional_escape(review_request.summary)
if not summary:
summary = '&nbsp;<i>No Summary</i>'

if review_request.submitter == self.datagrid.request.user:
try:
draft = review_request.draft.get()
summary = conditional_escape(draft.summary)
return "<span class=\"draftlabel\">[Draft]</span> " + \
summary
except ReviewRequestDraft.DoesNotExist:
pass

if not review_request.public:
# XXX Do we want to say "Draft?"
return "<span class=\"draftlabel\">[Draft]</span> " + \
summary

if review_request.status == 'S':
return "<span class=\"draftlabel\">[Submitted]</span> " + \
summary

return summary


class PendingCountColumn(Column):
"""
A column used to show the pending number of review requests for a
group or user.
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)

def render_data(self, obj):
return str(getattr(obj, self.field_name).filter(public=True,
status='P').count())


class GroupMemberCountColumn(Column):
"""
A column used to show the number of users that registered for a group.
"""
def __init__(self, *args, **kwargs):
Column.__init__(self, *args, **kwargs)
self.link = True
self.link_func = self.link_to_object

def render_data(self, group):
return str(group.users.count())

def link_to_object(self, group, value):
return reverse('group_members', args=[group.name])


class ReviewCountColumn(Column):
"""
A column showing the number of reviews for a review request.
"""
def __init__(self, label=_("Reviews"),
detailed_label=_("Number of Reviews"),
*args, **kwargs):
Column.__init__(self, label=label, detailed_label=detailed_label,
*kwargs, **kwargs)
self.shrink = True
self.link = True
self.link_func = self.link_to_object

def render_data(self, review_request):
return str(review_request.get_public_reviews().count())

def link_to_object(self, review_request, value):
return "%s#last-review" % review_request.get_absolute_url()


class ReviewRequestDataGrid(DataGrid):
"""
A datagrid that displays a list of review requests.

This datagrid accepts the show_submitted parameter in the URL, allowing
submitted review requests to be filtered out or displayed.
"""
star = StarColumn()
ship_it = ShipItColumn()
summary = SummaryColumn(expand=True, link=True, css_class="summary")
submitter = Column(_("Submitter"), db_field="submitter__username",
shrink=True, sortable=True, link=True)

repository = Column(_("Repository"), db_field="repository__name",
shrink=True, sortable=True, link=False)
time_added = DateTimeColumn(_("Posted"),
detailed_label=_("Posted Time"),
format="F jS, Y, P", shrink=True,
css_class=lambda r: ageid(r.time_added))
last_updated = DateTimeColumn(_("Last Updated"),
format="F jS, Y, P", shrink=True,
db_field="last_updated",
field_name="last_updated",
css_class=lambda r: ageid(r.last_updated))
diff_updated = DateTimeColumn(_("Diff Updated"),
format="F jS, Y, P", shrink=True,
field_name="last_updated",
css_class=lambda r: ageid(r.last_updated))

time_added_since = DateTimeSinceColumn(_("Posted"),
detailed_label=_("Posted Time (Relative)"),
field_name="time_added", shrink=True,
css_class=lambda r: ageid(r.time_added))
last_updated_since = DateTimeSinceColumn(_("Last Updated"),
detailed_label=_("Last Updated (Relative)"), shrink=True,
db_field="last_updated",
field_name="last_updated",
css_class=lambda r: ageid(r.last_updated))
diff_updated_since = DateTimeSinceColumn(_("Diff Updated"),
detailed_label=_("Diff Updated (Relative)"),
field_name="last_updated", shrink=True,
css_class=lambda r: ageid(r.last_updated))

review_count = ReviewCountColumn()

review_id = Column(_("Review ID"), field_name="id", db_field="id",
shrink=True, sortable=True, link=True)

def __init__(self, *args, **kwargs):
DataGrid.__init__(self, *args, **kwargs)
self.listview_template = 'reviews/review_request_listview.html'
self.profile_sort_field = 'sort_review_request_columns'
self.profile_columns_field = 'review_request_columns'
self.show_submitted = True
self.submitter_url_name = "user"
self.default_sort = ["-last_updated"]
self.default_columns = [
"star", "summary", "submitter", "time_added", "last_updated_since"
]

def load_extra_state(self, profile):
if profile:
self.show_submitted = profile.show_submitted

self.show_submitted = \
int(self.request.GET.get('show_submitted',
self.show_submitted)) != 0

if self.show_submitted:
# There are only three states: Published, Submitted and Discarded.
# We want the first two, but it's faster to just search for not
# discarded.
self.queryset = self.queryset.exclude(status='D')
else:
self.queryset = self.queryset.filter(status='P')

if profile and self.show_submitted != profile.show_submitted:
profile.show_submitted = self.show_submitted
return True

return False

def post_process_queryset(self, queryset):
return queryset.with_counts(self.request.user)

def link_to_object(self, obj, value):
if value and isinstance(value, User):
return reverse("user", args=[value])

return obj.get_absolute_url()


class DashboardDataGrid(ReviewRequestDataGrid):
"""
A version of the ReviewRequestDataGrid that displays additional fields
useful in the dashboard. It also displays a different set of data
depending on the view that was passed.
"""
new_updates = NewUpdatesColumn()
my_comments = MyCommentsColumn()

def __init__(self, *args, **kwargs):
ReviewRequestDataGrid.__init__(self, *args, **kwargs)
self.listview_template = 'datagrid/listview.html'
self.profile_sort_field = 'sort_dashboard_columns'
self.profile_columns_field = 'dashboard_columns'
self.default_view = "incoming"
self.show_submitted = False
self.default_sort = ["-last_updated"]
self.default_columns = [
"new_updates", "star", "summary", "submitter",
"time_added", "last_updated_since"
]

group = self.request.GET.get('group', None)
view = self.request.GET.get('view', None)
extra_query = []

if view:
extra_query.append("view=%s" % view)

if group:
extra_query.append("group=%s" % group)

self.extra_context['extra_query'] = "&".join(extra_query)

def load_extra_state(self, profile):
group = self.request.GET.get('group', '')
view = self.request.GET.get('view', self.default_view)
user = self.request.user

if view == 'outgoing':
self.queryset = ReviewRequest.objects.from_user(user.username,
user,
with_counts=True)
self.title = _(u"All Outgoing Review Requests")
elif view == 'mine':
self.queryset = ReviewRequest.objects.from_user(user.username, user,
None,
with_counts=True)
self.title = _(u"All My Review Requests")
elif view == 'to-me':
self.queryset = \
ReviewRequest.objects.to_user_directly(user.username, user,
with_counts=True)
self.title = _(u"Incoming Review Requests to Me")
elif view == 'to-group':
if group != "":
self.queryset = ReviewRequest.objects.to_group(group, user,
with_counts=True)
self.title = _(u"Incoming Review Requests to %s") % group
else:
self.queryset = \
ReviewRequest.objects.to_user_groups(user.username, user,
with_counts=True)
self.title = _(u"All Incoming Review Requests to My Groups")
elif view == 'starred':
profile = user.get_profile()
self.queryset = \
profile.starred_review_requests.public(user, with_counts=True)
self.title = _(u"Starred Review Requests")
else: # "incoming" or invalid
self.queryset = ReviewRequest.objects.to_user(user.username, user,
with_counts=True)
self.title = _(u"All Incoming Review Requests")

return False


class SubmitterDataGrid(DataGrid):
"""
A datagrid showing a list of submitters.
"""
username = Column(_("Username"), link=True, sortable=True)
fullname = Column(_("Full Name"), field_name="get_full_name",
link=True, expand=True)
pending_count = PendingCountColumn(_("Pending Reviews"),
field_name="directed_review_requests",
shrink=True)

def __init__(self, request,
queryset=User.objects.filter(is_active=True),
title=_("All submitters")):
DataGrid.__init__(self, request, queryset, title)
self.default_sort = ["username"]
self.profile_sort_field = 'sort_submitter_columns'
self.profile_columns_field = 'submitter_columns'
self.default_columns = [
"username", "fullname", "pending_count"
]

@staticmethod
def link_to_object(obj, value):
return reverse("user", args=[obj.username])


class GroupDataGrid(DataGrid):
"""
A datagrid showing a list of review groups.
"""
star = StarColumn()
name = Column(_("Group ID"), link=True, sortable=True)
displayname = Column(_("Group Name"), field_name="display_name",
link=True, expand=True)
pending_count = PendingCountColumn(_("Pending Reviews"),
field_name="review_requests",
link=True,
shrink=True)
member_count = GroupMemberCountColumn(_("Members"),
field_name="members",
shrink=True)

def __init__(self, request, title=_("All groups"), *args, **kwargs):
DataGrid.__init__(self, request, queryset=Group.objects.all(),
title=title, *args, **kwargs)
self.profile_sort_field = 'sort_group_columns'
self.profile_columns_field = 'group_columns'
self.default_sort = ["name"]
self.default_columns = [
"star", "name", "displayname", "pending_count"
]

@staticmethod
def link_to_object(obj, value):
return reverse("group", args=[obj.name])


class WatchedGroupDataGrid(GroupDataGrid):
"""
A special version of GroupDataGrid that shows a list of watched groups,
linking to a dashboard view of them. This is meant for display in the
dashboard.
"""
def __init__(self, request, title=_("Watched groups"), *args, **kwargs):
GroupDataGrid.__init__(self, request, title=title, *args, **kwargs)
self.queryset = request.user.get_profile().starred_groups.all()

def link_to_object(self, group, value):
return ".?view=to-group&group=%s" % group.name
Show details Hide details

Change log

r1998 by chipx86 on Jun 10, 2009   Diff
Fix some unused import warnings from
pyflakes.
Go to: 

Older revisions

r1995 by chipx86 on Jun 07, 2009   Diff
Greatly improve database query speeds
in Review Board.

This change introduces a few major
things to increase database query
...
r1993 by chipx86 on Jun 02, 2009   Diff
Remove the last_activity_timestamp
query and use last_updated instead.

The last_activity_timestamp query
could get really slow on the All
...
r1947 by chipx86 on May 03, 2009   Diff
Fix some warnings and an error
reported by pyflakes.
All revisions of this file

File info

Size: 17726 bytes, 466 lines
Hosted by Google Code