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
|
# Copyright 2009-2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Email notifications related to branches."""
__metaclass__ = type
from zope.security.proxy import removeSecurityProxy
from canonical.launchpad.webapp import canonical_url
from lp.code.adapters.branch import BranchDelta
from lp.code.enums import (
BranchSubscriptionDiffSize,
BranchSubscriptionNotificationLevel,
CodeReviewNotificationLevel,
)
from lp.registry.interfaces.person import IPerson
from lp.services.mail import basemailer
from lp.services.mail.basemailer import BaseMailer
from lp.services.mail.sendmail import format_address
def send_branch_modified_notifications(branch, event):
"""Notify the related people that a branch has been modifed."""
user = IPerson(event.user)
branch_delta = BranchDelta.construct(
event.object_before_modification, branch, user)
if branch_delta is None:
return
mailer = BranchMailer.forBranchModified(branch, user, branch_delta)
mailer.sendAll()
class RecipientReason(basemailer.RecipientReason):
def __init__(self, subscriber, recipient, branch, mail_header,
reason_template, merge_proposal=None,
max_diff_lines=BranchSubscriptionDiffSize.WHOLEDIFF,
branch_identity_cache=None,
review_level=CodeReviewNotificationLevel.FULL):
super(RecipientReason, self).__init__(subscriber, recipient,
mail_header, reason_template)
self.branch = branch
self.merge_proposal = merge_proposal
self.max_diff_lines = max_diff_lines
if branch_identity_cache is None:
branch_identity_cache = {}
self.branch_identity_cache = branch_identity_cache
self.review_level = review_level
def _getBranchIdentity(self, branch):
"""Get the branch identity out of the cache, or generate it."""
try:
return self.branch_identity_cache[branch]
except KeyError:
# Don't bother trying to remember the cache, as the cache only
# makes sense across multiple instances of this type of object.
return branch.bzr_identity
@classmethod
def forBranchSubscriber(
cls, subscription, recipient, rationale, merge_proposal=None,
branch_identity_cache=None):
"""Construct RecipientReason for a branch subscriber."""
return cls(
subscription.person, recipient, subscription.branch, rationale,
'%(entity_is)s subscribed to branch %(branch_name)s.',
merge_proposal, subscription.max_diff_lines,
branch_identity_cache=branch_identity_cache,
review_level=subscription.review_level)
@classmethod
def forReviewer(cls, branch_merge_proposal, pending_review, reviewer,
branch_identity_cache=None):
"""Construct RecipientReason for a reviewer.
The reviewer will be the sole recipient.
"""
branch = branch_merge_proposal.source_branch
if pending_review:
reason_template = (
'%(entity_is)s requested to review %(merge_proposal)s.')
else:
reason_template = (
'%(entity_is)s reviewing %(merge_proposal)s.')
return cls(reviewer, reviewer, branch,
cls.makeRationale('Reviewer', reviewer),
reason_template, branch_merge_proposal,
branch_identity_cache=branch_identity_cache)
@classmethod
def forRegistrant(cls, merge_proposal, branch_identity_cache=None):
"""Construct RecipientReason for a proposal registrant.
The registrant will be the sole recipient.
"""
reason_template = 'You proposed %(branch_name)s for merging.'
return cls(merge_proposal.registrant, merge_proposal.registrant,
merge_proposal.source_branch,
'Registrant', reason_template, merge_proposal,
branch_identity_cache=branch_identity_cache)
@classmethod
def forSourceOwner(cls, merge_proposal, branch_identity_cache=None):
"""Construct RecipientReason for the source branch owner.
The owner of the source branch will be the sole recipient. If the
source branch owner is a team, None is returned.
"""
branch = merge_proposal.source_branch
owner = branch.owner
if owner.is_team:
return None
reason_template = 'You are the owner of %(branch_name)s.'
return cls(owner, owner, branch, 'Owner', reason_template,
merge_proposal,
branch_identity_cache=branch_identity_cache)
@classmethod
def forBranchOwner(cls, branch, recipient,
branch_identity_cache=None):
"""Construct RecipientReason for a branch owner.
The owner will be the sole recipient.
"""
return cls(branch.owner, recipient, branch,
cls.makeRationale('Owner', branch.owner),
'You are getting this email as %(lc_entity_is)s the'
' owner of the branch and someone has edited the'
' details.',
branch_identity_cache=branch_identity_cache)
def _getTemplateValues(self):
template_values = super(RecipientReason, self)._getTemplateValues()
template_values['branch_name'] = self._getBranchIdentity(self.branch)
if self.merge_proposal is not None:
source = self._getBranchIdentity(
self.merge_proposal.source_branch)
target = self._getBranchIdentity(
self.merge_proposal.target_branch)
template_values['merge_proposal'] = (
'the proposed merge of %s into %s' % (source, target))
return template_values
class BranchMailer(BaseMailer):
"""Send email notifications about a branch."""
def __init__(self, subject, template_name, recipients, from_address,
delta=None, contents=None, diff=None, message_id=None,
revno=None, notification_type=None, **kwargs):
BaseMailer.__init__(self, subject, template_name, recipients,
from_address, delta, message_id,
notification_type)
self.contents = contents
self.diff = diff
if diff is None:
self.diff_size = 0
else:
self.diff_size = self.diff.count('\n') + 1
self.revno = revno
self.extra_template_params = kwargs
@classmethod
def forBranchModified(cls, branch, user, delta):
"""Construct a BranchMailer for mail about a branch modification.
:param branch: The branch that was modified.
:param user: The user making the change.
:param delta: an IBranchDelta representing the modification.
:return: a BranchMailer.
"""
recipients = branch.getNotificationRecipients()
interested_levels = (
BranchSubscriptionNotificationLevel.ATTRIBUTEONLY,
BranchSubscriptionNotificationLevel.FULL)
actual_recipients = {}
# If the person editing the branch isn't in the team of the owner
# then notify the branch owner of the changes as well.
if not user.inTeam(branch.owner):
# Existing rationales are kept.
recipients.add(branch.owner, None, None)
for recipient in recipients:
subscription, rationale = recipients.getReason(recipient)
if (subscription is not None and
subscription.notification_level not in interested_levels):
continue
if subscription is None:
actual_recipients[recipient] = RecipientReason.forBranchOwner(
branch, recipient)
else:
actual_recipients[recipient] = \
RecipientReason.forBranchSubscriber(
subscription, recipient, rationale)
from_address = format_address(
user.displayname, removeSecurityProxy(user).preferredemail.email)
return cls(
'[Branch %(unique_name)s]', 'branch-modified.txt',
actual_recipients, from_address, delta=delta,
notification_type='branch-updated')
@classmethod
def forRevision(cls, db_branch, revno, from_address, contents, diff,
subject):
"""Construct a BranchMailer for mail about branch revisions.
:param branch: The db_branch that was modified.
:param revno: The revno of the revision this message is about.
:param from_address: The email address this message should come from.
:param contents: The contents of the message.
:param subject: The subject of the message
:param diff: The diff of this revision versus its parent, as text.
:return: a BranchMailer.
"""
recipients = db_branch.getNotificationRecipients()
interested_levels = (
BranchSubscriptionNotificationLevel.DIFFSONLY,
BranchSubscriptionNotificationLevel.FULL)
recipient_dict = {}
for recipient in recipients:
subscription, rationale = recipients.getReason(recipient)
if subscription.notification_level in interested_levels:
subscriber_reason = RecipientReason.forBranchSubscriber(
subscription, recipient, rationale)
recipient_dict[recipient] = subscriber_reason
return cls('%(full_subject)s', 'branch-modified.txt', recipient_dict,
from_address, contents=contents, diff=diff, revno=revno,
notification_type='branch-revision', full_subject=subject)
def _getHeaders(self, email):
headers = BaseMailer._getHeaders(self, email)
reason, rationale = self._recipients.getReason(email)
headers['X-Launchpad-Branch'] = reason.branch.unique_name
if reason.branch.product is not None:
headers['X-Launchpad-Project'] = reason.branch.product.name
if self.revno is not None:
headers['X-Launchpad-Branch-Revision-Number'] = str(self.revno)
return headers
def _getTemplateParams(self, email, recipient):
params = BaseMailer._getTemplateParams(self, email, recipient)
reason, rationale = self._recipients.getReason(email)
branch = reason.branch
params['unique_name'] = branch.unique_name
params['branch_identity'] = branch.bzr_identity
params['branch_url'] = canonical_url(branch)
if reason.recipient in branch.subscribers:
# Give subscribers a link to unsubscribe.
params['unsubscribe'] = (
"\nTo unsubscribe from this branch go to "
"%s/+edit-subscription" % canonical_url(branch))
else:
params['unsubscribe'] = ''
params['diff'] = self.contents or ''
if not self._includeDiff(email):
params['diff'] += self._explainNotPresentDiff(email)
params.setdefault('delta', '')
params.update(self.extra_template_params)
return params
def _includeDiff(self, email):
"""Determine whether to include a diff, and explanation.
Explanation is provided if the diff is wanted and present, but is
too large.
"""
if self.diff_size == 0:
return False
reason, rationale = self._recipients.getReason(email)
if reason.max_diff_lines == BranchSubscriptionDiffSize.NODIFF:
return False
if (reason.max_diff_lines != BranchSubscriptionDiffSize.WHOLEDIFF and
self.diff_size > reason.max_diff_lines.value):
return False
return True, ''
def _explainNotPresentDiff(self, email):
"""Provide an explanation why the diff is not being included.
No explanation is provided where the diff is empty or where the
user has requested to never have diffs sent.
"""
if self.diff_size == 0:
return ''
reason, rationale = self._recipients.getReason(email)
if reason.max_diff_lines == BranchSubscriptionDiffSize.NODIFF:
return ''
return (
'The size of the diff (%d lines) is larger than your '
'specified limit of %d lines' % (
self.diff_size, reason.max_diff_lines.value))
def _addAttachments(self, ctrl, email):
"""Attach the diff, if present and not too large.
:param ctrl: The MailController to attach the diff to.
:param email: Email address of the recipient.
"""
if not self._includeDiff(email):
return
# Using .txt as a file extension makes Gmail display it inline.
ctrl.addAttachment(
self.diff, content_type='text/x-diff', inline=True,
filename='revision-diff.txt', charset='utf-8')
@staticmethod
def _format_user_address(user):
naked_email = removeSecurityProxy(user).preferredemail.email
return format_address(user.displayname, naked_email)
|