##// END OF EJS Templates
docs: fixed docstring
marcink -
r500:672398c9 default
parent child Browse files
Show More
@@ -1,366 +1,366 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2
2
3 # Copyright (C) 2011-2016 RhodeCode GmbH
3 # Copyright (C) 2011-2016 RhodeCode GmbH
4 #
4 #
5 # This program is free software: you can redistribute it and/or modify
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
7 # (only), as published by the Free Software Foundation.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU Affero General Public License
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
16 #
17 # This program is dual-licensed. If you wish to learn more about the
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20
20
21
21
22 """
22 """
23 Model for notifications
23 Model for notifications
24 """
24 """
25
25
26
26
27 import logging
27 import logging
28 import traceback
28 import traceback
29
29
30 from pylons import tmpl_context as c
30 from pylons import tmpl_context as c
31 from pylons.i18n.translation import _, ungettext
31 from pylons.i18n.translation import _, ungettext
32 from sqlalchemy.sql.expression import false, true
32 from sqlalchemy.sql.expression import false, true
33 from mako import exceptions
33 from mako import exceptions
34
34
35 import rhodecode
35 import rhodecode
36 from rhodecode.lib import helpers as h
36 from rhodecode.lib import helpers as h
37 from rhodecode.lib.utils import PartialRenderer
37 from rhodecode.lib.utils import PartialRenderer
38 from rhodecode.model import BaseModel
38 from rhodecode.model import BaseModel
39 from rhodecode.model.db import Notification, User, UserNotification
39 from rhodecode.model.db import Notification, User, UserNotification
40 from rhodecode.model.meta import Session
40 from rhodecode.model.meta import Session
41 from rhodecode.model.settings import SettingsModel
41 from rhodecode.model.settings import SettingsModel
42
42
43 log = logging.getLogger(__name__)
43 log = logging.getLogger(__name__)
44
44
45
45
46 class NotificationModel(BaseModel):
46 class NotificationModel(BaseModel):
47
47
48 cls = Notification
48 cls = Notification
49
49
50 def __get_notification(self, notification):
50 def __get_notification(self, notification):
51 if isinstance(notification, Notification):
51 if isinstance(notification, Notification):
52 return notification
52 return notification
53 elif isinstance(notification, (int, long)):
53 elif isinstance(notification, (int, long)):
54 return Notification.get(notification)
54 return Notification.get(notification)
55 else:
55 else:
56 if notification:
56 if notification:
57 raise Exception('notification must be int, long or Instance'
57 raise Exception('notification must be int, long or Instance'
58 ' of Notification got %s' % type(notification))
58 ' of Notification got %s' % type(notification))
59
59
60 def create(
60 def create(
61 self, created_by, notification_subject, notification_body,
61 self, created_by, notification_subject, notification_body,
62 notification_type=Notification.TYPE_MESSAGE, recipients=None,
62 notification_type=Notification.TYPE_MESSAGE, recipients=None,
63 mention_recipients=None, with_email=True, email_kwargs=None):
63 mention_recipients=None, with_email=True, email_kwargs=None):
64 """
64 """
65
65
66 Creates notification of given type
66 Creates notification of given type
67
67
68 :param created_by: int, str or User instance. User who created this
68 :param created_by: int, str or User instance. User who created this
69 notification
69 notification
70 :param notification_subject: subject of notification itself
70 :param notification_subject: subject of notification itself
71 :param notification_body: body of notification text
71 :param notification_body: body of notification text
72 :param notification_type: type of notification, based on that we
72 :param notification_type: type of notification, based on that we
73 pick templates
73 pick templates
74
74
75 :param recipients: list of int, str or User objects, when None
75 :param recipients: list of int, str or User objects, when None
76 is given send to all admins
76 is given send to all admins
77 :param mention_recipients: list of int, str or User objects,
77 :param mention_recipients: list of int, str or User objects,
78 that were mentioned
78 that were mentioned
79 :param with_email: send email with this notification
79 :param with_email: send email with this notification
80 :param email_kwargs: dict with arguments to generate email
80 :param email_kwargs: dict with arguments to generate email
81 """
81 """
82
82
83 from rhodecode.lib.celerylib import tasks, run_task
83 from rhodecode.lib.celerylib import tasks, run_task
84
84
85 if recipients and not getattr(recipients, '__iter__', False):
85 if recipients and not getattr(recipients, '__iter__', False):
86 raise Exception('recipients must be an iterable object')
86 raise Exception('recipients must be an iterable object')
87
87
88 created_by_obj = self._get_user(created_by)
88 created_by_obj = self._get_user(created_by)
89 # default MAIN body if not given
89 # default MAIN body if not given
90 email_kwargs = email_kwargs or {'body': notification_body}
90 email_kwargs = email_kwargs or {'body': notification_body}
91 mention_recipients = mention_recipients or set()
91 mention_recipients = mention_recipients or set()
92
92
93 if not created_by_obj:
93 if not created_by_obj:
94 raise Exception('unknown user %s' % created_by)
94 raise Exception('unknown user %s' % created_by)
95
95
96 if recipients is None:
96 if recipients is None:
97 # recipients is None means to all admins
97 # recipients is None means to all admins
98 recipients_objs = User.query().filter(User.admin == true()).all()
98 recipients_objs = User.query().filter(User.admin == true()).all()
99 log.debug('sending notifications %s to admins: %s',
99 log.debug('sending notifications %s to admins: %s',
100 notification_type, recipients_objs)
100 notification_type, recipients_objs)
101 else:
101 else:
102 recipients_objs = []
102 recipients_objs = []
103 for u in recipients:
103 for u in recipients:
104 obj = self._get_user(u)
104 obj = self._get_user(u)
105 if obj:
105 if obj:
106 recipients_objs.append(obj)
106 recipients_objs.append(obj)
107 else: # we didn't find this user, log the error and carry on
107 else: # we didn't find this user, log the error and carry on
108 log.error('cannot notify unknown user %r', u)
108 log.error('cannot notify unknown user %r', u)
109
109
110 recipients_objs = set(recipients_objs)
110 recipients_objs = set(recipients_objs)
111 if not recipients_objs:
111 if not recipients_objs:
112 raise Exception('no valid recipients specified')
112 raise Exception('no valid recipients specified')
113
113
114 log.debug('sending notifications %s to %s',
114 log.debug('sending notifications %s to %s',
115 notification_type, recipients_objs)
115 notification_type, recipients_objs)
116
116
117 # add mentioned users into recipients
117 # add mentioned users into recipients
118 final_recipients = set(recipients_objs).union(mention_recipients)
118 final_recipients = set(recipients_objs).union(mention_recipients)
119 notification = Notification.create(
119 notification = Notification.create(
120 created_by=created_by_obj, subject=notification_subject,
120 created_by=created_by_obj, subject=notification_subject,
121 body=notification_body, recipients=final_recipients,
121 body=notification_body, recipients=final_recipients,
122 type_=notification_type
122 type_=notification_type
123 )
123 )
124
124
125 if not with_email: # skip sending email, and just create notification
125 if not with_email: # skip sending email, and just create notification
126 return notification
126 return notification
127
127
128 # don't send email to person who created this comment
128 # don't send email to person who created this comment
129 rec_objs = set(recipients_objs).difference(set([created_by_obj]))
129 rec_objs = set(recipients_objs).difference(set([created_by_obj]))
130
130
131 # now notify all recipients in question
131 # now notify all recipients in question
132
132
133 for recipient in rec_objs.union(mention_recipients):
133 for recipient in rec_objs.union(mention_recipients):
134 # inject current recipient
134 # inject current recipient
135 email_kwargs['recipient'] = recipient
135 email_kwargs['recipient'] = recipient
136 email_kwargs['mention'] = recipient in mention_recipients
136 email_kwargs['mention'] = recipient in mention_recipients
137 (subject, headers, email_body,
137 (subject, headers, email_body,
138 email_body_plaintext) = EmailNotificationModel().render_email(
138 email_body_plaintext) = EmailNotificationModel().render_email(
139 notification_type, **email_kwargs)
139 notification_type, **email_kwargs)
140
140
141 log.debug(
141 log.debug(
142 'Creating notification email task for user:`%s`', recipient)
142 'Creating notification email task for user:`%s`', recipient)
143 task = run_task(
143 task = run_task(
144 tasks.send_email, recipient.email, subject,
144 tasks.send_email, recipient.email, subject,
145 email_body_plaintext, email_body)
145 email_body_plaintext, email_body)
146 log.debug('Created email task: %s', task)
146 log.debug('Created email task: %s', task)
147
147
148 return notification
148 return notification
149
149
150 def delete(self, user, notification):
150 def delete(self, user, notification):
151 # we don't want to remove actual notification just the assignment
151 # we don't want to remove actual notification just the assignment
152 try:
152 try:
153 notification = self.__get_notification(notification)
153 notification = self.__get_notification(notification)
154 user = self._get_user(user)
154 user = self._get_user(user)
155 if notification and user:
155 if notification and user:
156 obj = UserNotification.query()\
156 obj = UserNotification.query()\
157 .filter(UserNotification.user == user)\
157 .filter(UserNotification.user == user)\
158 .filter(UserNotification.notification == notification)\
158 .filter(UserNotification.notification == notification)\
159 .one()
159 .one()
160 Session().delete(obj)
160 Session().delete(obj)
161 return True
161 return True
162 except Exception:
162 except Exception:
163 log.error(traceback.format_exc())
163 log.error(traceback.format_exc())
164 raise
164 raise
165
165
166 def get_for_user(self, user, filter_=None):
166 def get_for_user(self, user, filter_=None):
167 """
167 """
168 Get mentions for given user, filter them if filter dict is given
168 Get mentions for given user, filter them if filter dict is given
169
169
170 :param user:
170 :param user:
171 :param filter:
171 :param filter:
172 """
172 """
173 user = self._get_user(user)
173 user = self._get_user(user)
174
174
175 q = UserNotification.query()\
175 q = UserNotification.query()\
176 .filter(UserNotification.user == user)\
176 .filter(UserNotification.user == user)\
177 .join((
177 .join((
178 Notification, UserNotification.notification_id ==
178 Notification, UserNotification.notification_id ==
179 Notification.notification_id))
179 Notification.notification_id))
180
180
181 if filter_:
181 if filter_:
182 q = q.filter(Notification.type_.in_(filter_))
182 q = q.filter(Notification.type_.in_(filter_))
183
183
184 return q.all()
184 return q.all()
185
185
186 def mark_read(self, user, notification):
186 def mark_read(self, user, notification):
187 try:
187 try:
188 notification = self.__get_notification(notification)
188 notification = self.__get_notification(notification)
189 user = self._get_user(user)
189 user = self._get_user(user)
190 if notification and user:
190 if notification and user:
191 obj = UserNotification.query()\
191 obj = UserNotification.query()\
192 .filter(UserNotification.user == user)\
192 .filter(UserNotification.user == user)\
193 .filter(UserNotification.notification == notification)\
193 .filter(UserNotification.notification == notification)\
194 .one()
194 .one()
195 obj.read = True
195 obj.read = True
196 Session().add(obj)
196 Session().add(obj)
197 return True
197 return True
198 except Exception:
198 except Exception:
199 log.error(traceback.format_exc())
199 log.error(traceback.format_exc())
200 raise
200 raise
201
201
202 def mark_all_read_for_user(self, user, filter_=None):
202 def mark_all_read_for_user(self, user, filter_=None):
203 user = self._get_user(user)
203 user = self._get_user(user)
204 q = UserNotification.query()\
204 q = UserNotification.query()\
205 .filter(UserNotification.user == user)\
205 .filter(UserNotification.user == user)\
206 .filter(UserNotification.read == false())\
206 .filter(UserNotification.read == false())\
207 .join((
207 .join((
208 Notification, UserNotification.notification_id ==
208 Notification, UserNotification.notification_id ==
209 Notification.notification_id))
209 Notification.notification_id))
210 if filter_:
210 if filter_:
211 q = q.filter(Notification.type_.in_(filter_))
211 q = q.filter(Notification.type_.in_(filter_))
212
212
213 # this is a little inefficient but sqlalchemy doesn't support
213 # this is a little inefficient but sqlalchemy doesn't support
214 # update on joined tables :(
214 # update on joined tables :(
215 for obj in q.all():
215 for obj in q.all():
216 obj.read = True
216 obj.read = True
217 Session().add(obj)
217 Session().add(obj)
218
218
219 def get_unread_cnt_for_user(self, user):
219 def get_unread_cnt_for_user(self, user):
220 user = self._get_user(user)
220 user = self._get_user(user)
221 return UserNotification.query()\
221 return UserNotification.query()\
222 .filter(UserNotification.read == false())\
222 .filter(UserNotification.read == false())\
223 .filter(UserNotification.user == user).count()
223 .filter(UserNotification.user == user).count()
224
224
225 def get_unread_for_user(self, user):
225 def get_unread_for_user(self, user):
226 user = self._get_user(user)
226 user = self._get_user(user)
227 return [x.notification for x in UserNotification.query()
227 return [x.notification for x in UserNotification.query()
228 .filter(UserNotification.read == false())
228 .filter(UserNotification.read == false())
229 .filter(UserNotification.user == user).all()]
229 .filter(UserNotification.user == user).all()]
230
230
231 def get_user_notification(self, user, notification):
231 def get_user_notification(self, user, notification):
232 user = self._get_user(user)
232 user = self._get_user(user)
233 notification = self.__get_notification(notification)
233 notification = self.__get_notification(notification)
234
234
235 return UserNotification.query()\
235 return UserNotification.query()\
236 .filter(UserNotification.notification == notification)\
236 .filter(UserNotification.notification == notification)\
237 .filter(UserNotification.user == user).scalar()
237 .filter(UserNotification.user == user).scalar()
238
238
239 def make_description(self, notification, show_age=True):
239 def make_description(self, notification, show_age=True):
240 """
240 """
241 Creates a human readable description based on properties
241 Creates a human readable description based on properties
242 of notification object
242 of notification object
243 """
243 """
244
244
245 _map = {
245 _map = {
246 notification.TYPE_CHANGESET_COMMENT: [
246 notification.TYPE_CHANGESET_COMMENT: [
247 _('%(user)s commented on commit %(date_or_age)s'),
247 _('%(user)s commented on commit %(date_or_age)s'),
248 _('%(user)s commented on commit at %(date_or_age)s'),
248 _('%(user)s commented on commit at %(date_or_age)s'),
249 ],
249 ],
250 notification.TYPE_MESSAGE: [
250 notification.TYPE_MESSAGE: [
251 _('%(user)s sent message %(date_or_age)s'),
251 _('%(user)s sent message %(date_or_age)s'),
252 _('%(user)s sent message at %(date_or_age)s'),
252 _('%(user)s sent message at %(date_or_age)s'),
253 ],
253 ],
254 notification.TYPE_MENTION: [
254 notification.TYPE_MENTION: [
255 _('%(user)s mentioned you %(date_or_age)s'),
255 _('%(user)s mentioned you %(date_or_age)s'),
256 _('%(user)s mentioned you at %(date_or_age)s'),
256 _('%(user)s mentioned you at %(date_or_age)s'),
257 ],
257 ],
258 notification.TYPE_REGISTRATION: [
258 notification.TYPE_REGISTRATION: [
259 _('%(user)s registered in RhodeCode %(date_or_age)s'),
259 _('%(user)s registered in RhodeCode %(date_or_age)s'),
260 _('%(user)s registered in RhodeCode at %(date_or_age)s'),
260 _('%(user)s registered in RhodeCode at %(date_or_age)s'),
261 ],
261 ],
262 notification.TYPE_PULL_REQUEST: [
262 notification.TYPE_PULL_REQUEST: [
263 _('%(user)s opened new pull request %(date_or_age)s'),
263 _('%(user)s opened new pull request %(date_or_age)s'),
264 _('%(user)s opened new pull request at %(date_or_age)s'),
264 _('%(user)s opened new pull request at %(date_or_age)s'),
265 ],
265 ],
266 notification.TYPE_PULL_REQUEST_COMMENT: [
266 notification.TYPE_PULL_REQUEST_COMMENT: [
267 _('%(user)s commented on pull request %(date_or_age)s'),
267 _('%(user)s commented on pull request %(date_or_age)s'),
268 _('%(user)s commented on pull request at %(date_or_age)s'),
268 _('%(user)s commented on pull request at %(date_or_age)s'),
269 ],
269 ],
270 }
270 }
271
271
272 templates = _map[notification.type_]
272 templates = _map[notification.type_]
273
273
274 if show_age:
274 if show_age:
275 template = templates[0]
275 template = templates[0]
276 date_or_age = h.age(notification.created_on)
276 date_or_age = h.age(notification.created_on)
277 else:
277 else:
278 template = templates[1]
278 template = templates[1]
279 date_or_age = h.format_date(notification.created_on)
279 date_or_age = h.format_date(notification.created_on)
280
280
281 return template % {
281 return template % {
282 'user': notification.created_by_user.username,
282 'user': notification.created_by_user.username,
283 'date_or_age': date_or_age,
283 'date_or_age': date_or_age,
284 }
284 }
285
285
286
286
287 class EmailNotificationModel(BaseModel):
287 class EmailNotificationModel(BaseModel):
288 TYPE_COMMIT_COMMENT = Notification.TYPE_CHANGESET_COMMENT
288 TYPE_COMMIT_COMMENT = Notification.TYPE_CHANGESET_COMMENT
289 TYPE_REGISTRATION = Notification.TYPE_REGISTRATION
289 TYPE_REGISTRATION = Notification.TYPE_REGISTRATION
290 TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST
290 TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST
291 TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT
291 TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT
292 TYPE_MAIN = Notification.TYPE_MESSAGE
292 TYPE_MAIN = Notification.TYPE_MESSAGE
293
293
294 TYPE_PASSWORD_RESET = 'password_reset'
294 TYPE_PASSWORD_RESET = 'password_reset'
295 TYPE_PASSWORD_RESET_CONFIRMATION = 'password_reset_confirmation'
295 TYPE_PASSWORD_RESET_CONFIRMATION = 'password_reset_confirmation'
296 TYPE_EMAIL_TEST = 'email_test'
296 TYPE_EMAIL_TEST = 'email_test'
297 TYPE_TEST = 'test'
297 TYPE_TEST = 'test'
298
298
299 email_types = {
299 email_types = {
300 TYPE_MAIN: 'email_templates/main.mako',
300 TYPE_MAIN: 'email_templates/main.mako',
301 TYPE_TEST: 'email_templates/test.mako',
301 TYPE_TEST: 'email_templates/test.mako',
302 TYPE_EMAIL_TEST: 'email_templates/email_test.mako',
302 TYPE_EMAIL_TEST: 'email_templates/email_test.mako',
303 TYPE_REGISTRATION: 'email_templates/user_registration.mako',
303 TYPE_REGISTRATION: 'email_templates/user_registration.mako',
304 TYPE_PASSWORD_RESET: 'email_templates/password_reset.mako',
304 TYPE_PASSWORD_RESET: 'email_templates/password_reset.mako',
305 TYPE_PASSWORD_RESET_CONFIRMATION: 'email_templates/password_reset_confirmation.mako',
305 TYPE_PASSWORD_RESET_CONFIRMATION: 'email_templates/password_reset_confirmation.mako',
306 TYPE_COMMIT_COMMENT: 'email_templates/commit_comment.mako',
306 TYPE_COMMIT_COMMENT: 'email_templates/commit_comment.mako',
307 TYPE_PULL_REQUEST: 'email_templates/pull_request_review.mako',
307 TYPE_PULL_REQUEST: 'email_templates/pull_request_review.mako',
308 TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.mako',
308 TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.mako',
309 }
309 }
310
310
311 def __init__(self):
311 def __init__(self):
312 """
312 """
313 Example usage::
313 Example usage::
314
314
315 (subject, headers, email_body,
315 (subject, headers, email_body,
316 email_body_plaintext) = EmailNotificationModel().render_email(
316 email_body_plaintext) = EmailNotificationModel().render_email(
317 EmailNotificationModel.TYPE_TEST, **email_kwargs)
317 EmailNotificationModel.TYPE_TEST, **email_kwargs)
318
318
319 """
319 """
320 super(EmailNotificationModel, self).__init__()
320 super(EmailNotificationModel, self).__init__()
321
321
322 def _update_kwargs_for_render(self, kwargs):
322 def _update_kwargs_for_render(self, kwargs):
323 """
323 """
324 Inject params required for Mako rendering
324 Inject params required for Mako rendering
325
325
326 :param kwargs:
326 :param kwargs:
327 :return:
327 :return:
328 """
328 """
329 _kwargs = {
329 _kwargs = {
330 'instance_url': h.url('home', qualified=True)
330 'instance_url': h.url('home', qualified=True)
331 }
331 }
332 _kwargs.update(kwargs)
332 _kwargs.update(kwargs)
333 return _kwargs
333 return _kwargs
334
334
335 def get_renderer(self, type_):
335 def get_renderer(self, type_):
336 template_name = self.email_types[type_]
336 template_name = self.email_types[type_]
337 return PartialRenderer(template_name)
337 return PartialRenderer(template_name)
338
338
339 def render_email(self, type_, **kwargs):
339 def render_email(self, type_, **kwargs):
340 """
340 """
341 renders template for email, and returns a tuple of
341 renders template for email, and returns a tuple of
342 (subject, email_headers, email_body)
342 (subject, email_headers, email_html_body, email_plaintext_body)
343 """
343 """
344 # translator and helpers inject
344 # translator and helpers inject
345 _kwargs = self._update_kwargs_for_render(kwargs)
345 _kwargs = self._update_kwargs_for_render(kwargs)
346
346
347 email_template = self.get_renderer(type_)
347 email_template = self.get_renderer(type_)
348
348
349 subject = email_template.render('subject', **_kwargs)
349 subject = email_template.render('subject', **_kwargs)
350
350
351 try:
351 try:
352 headers = email_template.render('headers', **_kwargs)
352 headers = email_template.render('headers', **_kwargs)
353 except AttributeError:
353 except AttributeError:
354 # it's not defined in template, ok we can skip it
354 # it's not defined in template, ok we can skip it
355 headers = ''
355 headers = ''
356
356
357 try:
357 try:
358 body_plaintext = email_template.render('body_plaintext', **_kwargs)
358 body_plaintext = email_template.render('body_plaintext', **_kwargs)
359 except AttributeError:
359 except AttributeError:
360 # it's not defined in template, ok we can skip it
360 # it's not defined in template, ok we can skip it
361 body_plaintext = ''
361 body_plaintext = ''
362
362
363 # render WHOLE template
363 # render WHOLE template
364 body = email_template.render(None, **_kwargs)
364 body = email_template.render(None, **_kwargs)
365
365
366 return subject, headers, body, body_plaintext
366 return subject, headers, body, body_plaintext
General Comments 0
You need to be logged in to leave comments. Login now