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
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
# pylint: disable-msg=E0611,W0212
"""Bug notifications."""
__metaclass__ = type
__all__ = [
'BugNotification',
'BugNotificationFilter',
'BugNotificationRecipient',
'BugNotificationSet',
]
from datetime import (
datetime,
timedelta,
)
import pytz
from sqlobject import (
BoolCol,
ForeignKey,
StringCol,
)
from storm.expr import (
In,
Join,
LeftJoin,
)
from storm.locals import (
Int,
Reference,
)
from storm.store import Store
from zope.component import getUtility
from zope.interface import implements
from lp.bugs.enum import BugNotificationStatus
from lp.bugs.interfaces.bugnotification import (
IBugNotification,
IBugNotificationFilter,
IBugNotificationRecipient,
IBugNotificationSet,
)
from lp.bugs.model.bugactivity import BugActivity
from lp.bugs.model.bugsubscriptionfilter import (
BugSubscriptionFilter,
BugSubscriptionFilterMute,
)
from lp.bugs.model.structuralsubscription import StructuralSubscription
from lp.registry.interfaces.person import IPersonSet
from lp.services.config import config
from lp.services.database.datetimecol import UtcDateTimeCol
from lp.services.database.enumcol import EnumCol
from lp.services.database.lpstorm import IStore
from lp.services.database.sqlbase import (
SQLBase,
sqlvalues,
)
from lp.services.database.stormbase import StormBase
from lp.services.messages.model.message import Message
class BugNotification(SQLBase):
"""A textual representation about a bug change."""
implements(IBugNotification)
message = ForeignKey(dbName='message', notNull=True, foreignKey='Message')
activity = ForeignKey(
dbName='activity', notNull=False, foreignKey='BugActivity')
bug = ForeignKey(dbName='bug', notNull=True, foreignKey='Bug')
is_comment = BoolCol(notNull=True)
date_emailed = UtcDateTimeCol(notNull=False)
status = EnumCol(
dbName='status',
schema=BugNotificationStatus, default=BugNotificationStatus.PENDING,
notNull=True)
@property
def recipients(self):
"""See `IBugNotification`."""
return BugNotificationRecipient.selectBy(
bug_notification=self, orderBy='id')
@property
def bug_filters(self):
"""See `IStructuralSubscription`."""
return IStore(BugSubscriptionFilter).find(
BugSubscriptionFilter,
(BugSubscriptionFilter.id ==
BugNotificationFilter.bug_subscription_filter_id),
BugNotificationFilter.bug_notification == self)
class BugNotificationSet:
"""A set of bug notifications."""
implements(IBugNotificationSet)
def getNotificationsToSend(self):
"""See IBugNotificationSet."""
# We preload the bug activity and the message in order to
# try to reduce subsequent database calls: try to get direct
# dependencies at once. We then also pre-load the pertinent bugs,
# people (with their own dependencies), and message chunks before
# returning the notifications that should be processed.
# Sidestep circular reference.
from lp.bugs.model.bug import Bug
store = IStore(BugNotification)
source = store.using(BugNotification,
Join(Message,
BugNotification.message == Message.id),
LeftJoin(
BugActivity,
BugNotification.activity == BugActivity.id))
results = list(source.find(
(BugNotification, BugActivity, Message),
BugNotification.status == BugNotificationStatus.PENDING,
BugNotification.date_emailed == None).order_by(
'BugNotification.bug', '-BugNotification.id'))
interval = timedelta(
minutes=int(config.malone.bugnotification_interval))
time_limit = (
datetime.now(pytz.UTC) - interval)
last_omitted_notification = None
pending_notifications = []
people_ids = set()
bug_ids = set()
for notification, ignore, ignore in results:
if notification.message.datecreated > time_limit:
last_omitted_notification = notification
elif (last_omitted_notification is not None and
notification.message.ownerID ==
last_omitted_notification.message.ownerID and
notification.bugID == last_omitted_notification.bugID and
last_omitted_notification.message.datecreated -
notification.message.datecreated < interval):
last_omitted_notification = notification
if last_omitted_notification != notification:
last_omitted_notification = None
pending_notifications.append(notification)
people_ids.add(notification.message.ownerID)
bug_ids.add(notification.bugID)
# Now we do some calls that are purely for caching.
# Converting these into lists forces the queries to execute.
if pending_notifications:
list(
getUtility(IPersonSet).getPrecachedPersonsFromIDs(
list(people_ids),
need_validity=True,
need_preferred_email=True))
list(
IStore(Bug).find(Bug, In(Bug.id, list(bug_ids))))
pending_notifications.reverse()
return pending_notifications
def getDeferredNotifications(self):
"""See `IBugNoticationSet`."""
store = IStore(BugNotification)
results = store.find(
BugNotification,
BugNotification.date_emailed == None,
BugNotification.status == BugNotificationStatus.DEFERRED)
return results
def addNotification(self, bug, is_comment, message, recipients, activity,
deferred=False):
"""See `IBugNotificationSet`."""
if deferred:
status = BugNotificationStatus.DEFERRED
else:
if not recipients:
return
status = BugNotificationStatus.PENDING
bug_notification = BugNotification(
bug=bug, is_comment=is_comment,
message=message, date_emailed=None, activity=activity,
status=status)
store = Store.of(bug_notification)
# XXX jamesh 2008-05-21: these flushes are to fix ordering
# problems in the bugnotification-sending.txt tests.
store.flush()
sql_values = []
for recipient in recipients:
reason_body, reason_header = recipients.getReason(recipient)
sql_values.append('(%s, %s, %s, %s)' % sqlvalues(
bug_notification, recipient, reason_header, reason_body))
# We add all the recipients in a single SQL statement to make
# this a bit more efficient for bugs with many subscribers.
if len(sql_values) > 0:
store.execute("""
INSERT INTO BugNotificationRecipient
(bug_notification, person, reason_header, reason_body)
VALUES %s;""" % ', '.join(sql_values))
if len(recipients.subscription_filters) > 0:
filter_link_sql = [
"(%s, %s)" % sqlvalues(bug_notification, filter.id)
for filter in recipients.subscription_filters]
store.execute("""
INSERT INTO BugNotificationFilter
(bug_notification, bug_subscription_filter)
VALUES %s;""" % ", ".join(filter_link_sql))
return bug_notification
def getRecipientFilterData(self, bug, recipient_to_sources,
notifications):
"""See `IBugNotificationSet`."""
if not notifications or not recipient_to_sources:
# This is a shortcut that will remove some error conditions.
return {}
# Collect bug mute information.
from lp.bugs.model.bug import BugMute
store = IStore(BugMute)
muted_person_ids = set(list(
store.find(BugMute.person_id,
BugMute.bug == bug)))
# This makes two calls to the database to get all the
# information we need. The first call gets the filter ids and
# descriptions for each recipient, and then we divide up the
# information per recipient.
# First we get some intermediate data structures set up.
source_person_id_map = {}
recipient_id_map = {}
for recipient, sources in recipient_to_sources.items():
if recipient.id in muted_person_ids:
continue
source_person_ids = set()
recipient_id_map[recipient.id] = {
'principal': recipient,
'filters': {},
'source person ids': source_person_ids,
'sources': sources,
}
for source in sources:
person_id = source.person.id
source_person_ids.add(person_id)
data = source_person_id_map.get(person_id)
if data is None:
# The "filters" key is the only one we actually use. The
# rest are useful for debugging and introspecting.
data = {'sources': set(),
'person': source.person,
'filters': {}}
source_person_id_map[person_id] = data
data['sources'].add(source)
# Now we actually look for the filters.
store = IStore(BugSubscriptionFilter)
source = store.using(
BugSubscriptionFilter,
Join(BugNotificationFilter,
BugSubscriptionFilter.id ==
BugNotificationFilter.bug_subscription_filter_id),
Join(StructuralSubscription,
BugSubscriptionFilter.structural_subscription_id ==
StructuralSubscription.id))
if len(source_person_id_map) == 0:
filter_data = []
else:
filter_data = source.find(
(StructuralSubscription.subscriberID,
BugSubscriptionFilter.id,
BugSubscriptionFilter.description),
In(BugNotificationFilter.bug_notification_id,
[notification.id for notification in notifications]),
In(StructuralSubscription.subscriberID,
source_person_id_map.keys()))
filter_ids = []
# Record the filters for each source.
for source_person_id, filter_id, filter_description in filter_data:
source_person_id_map[source_person_id]['filters'][filter_id] = (
filter_description)
filter_ids.append(filter_id)
# This is only necessary while production and sample data have
# structural subscriptions without filters. Assign the filters to
# each recipient.
no_filter_marker = -1
for recipient_data in recipient_id_map.values():
for source_person_id in recipient_data['source person ids']:
recipient_data['filters'].update(
source_person_id_map[source_person_id]['filters']
or {no_filter_marker: None})
if filter_ids:
# Now we get the information about subscriptions that might be
# filtered and take that into account.
mute_data = store.find(
(BugSubscriptionFilterMute.person_id,
BugSubscriptionFilterMute.filter_id),
In(BugSubscriptionFilterMute.person_id,
recipient_id_map.keys()),
In(BugSubscriptionFilterMute.filter_id, filter_ids))
for person_id, filter_id in mute_data:
if filter_id in recipient_id_map[person_id]['filters']:
del recipient_id_map[person_id]['filters'][filter_id]
# This may look odd, but it's here to prevent members of
# a team with a contact address still getting direct
# email about a bug after they've muted the
# subscription.
if no_filter_marker in recipient_id_map[person_id]['filters']:
del recipient_id_map[
person_id]['filters'][no_filter_marker]
# Now recipient_id_map has all the information we need. Let's
# build the final result and return it.
result = {}
for recipient_data in recipient_id_map.values():
if recipient_data['filters']:
filter_descriptions = [
description for description
in recipient_data['filters'].values() if description]
filter_descriptions.sort() # This is good for tests.
result[recipient_data['principal']] = {
'sources': recipient_data['sources'],
'filter descriptions': filter_descriptions}
return result
class BugNotificationRecipient(SQLBase):
"""A recipient of a bug notification."""
implements(IBugNotificationRecipient)
bug_notification = ForeignKey(
dbName='bug_notification', notNull=True, foreignKey='BugNotification')
person = ForeignKey(
dbName='person', notNull=True, foreignKey='Person')
reason_header = StringCol(dbName='reason_header', notNull=True)
reason_body = StringCol(dbName='reason_body', notNull=True)
class BugNotificationFilter(StormBase):
"""See `IBugNotificationFilter`."""
implements(IBugNotificationFilter)
__storm_table__ = "BugNotificationFilter"
__storm_primary__ = "bug_notification_id", "bug_subscription_filter_id"
def __init__(self, bug_notification, bug_subscription_filter):
self.bug_notification = bug_notification
self.bug_subscription_filter = bug_subscription_filter
bug_notification_id = Int(
"bug_notification", allow_none=False)
bug_notification = Reference(
bug_notification_id, "BugNotification.id")
bug_subscription_filter_id = Int(
"bug_subscription_filter", allow_none=False)
bug_subscription_filter = Reference(
bug_subscription_filter_id, "BugSubscriptionFilter.id")
|