Mercurial > kallithea

annotate rhodecode/model/notification.py @ 3423:043d3827cd88 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added template context into Notification templates
author Marcin Kuzminski <marcin@python-works.com>
date Sat, 02 Mar 2013 16:27:56 +0100
parents 81397bd3e77f
children bbe21df7ad48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2 """
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
3 rhodecode.model.notification
1839
9da24750f563 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1824
diff changeset
4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6 Model for notifications
1800
6c86c987cf93 pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1791
diff changeset
7
6c86c987cf93 pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1791
diff changeset
8
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9 :created_on: Nov 20, 2011
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
10 :author: marcink
1824
89efedac4e6c 2012 copyrights
Marcin Kuzminski <marcin@python-works.com>
parents: 1818
diff changeset
11 :copyright: (C) 2010-2012 Marcin Kuzminski <marcin@python-works.com>
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
12 :license: GPLv3, see COPYING for more details.
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
13 """
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
14 # This program is free software: you can redistribute it and/or modify
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15 # it under the terms of the GNU General Public License as published by
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
16 # the Free Software Foundation, either version 3 of the License, or
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
17 # (at your option) any later version.
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
18 #
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
19 # This program is distributed in the hope that it will be useful,
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
22 # GNU General Public License for more details.
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
23 #
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24 # You should have received a copy of the GNU General Public License
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25 # along with this program. If not, see <http://www.gnu.org/licenses/>.
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
26
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
27 import os
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
28 import logging
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
29 import traceback
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30
3423
043d3827cd88 added template context into Notification templates
Marcin Kuzminski <marcin@python-works.com>
parents: 3270
diff changeset
31 from pylons import tmpl_context as c
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32 from pylons.i18n.translation import _
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
33
1723
64e91067b996 - refactoring to overcome poor usage of global pylons config
Marcin Kuzminski <marcin@python-works.com>
parents: 1722
diff changeset
34 import rhodecode
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
35 from rhodecode.lib import helpers as h
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
36 from rhodecode.model import BaseModel
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37 from rhodecode.model.db import Notification, User, UserNotification
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
38
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
39 log = logging.getLogger(__name__)
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40
1716
7d1fc253549e notification to commit author + gardening
Marcin Kuzminski <marcin@python-works.com>
parents: 1713
diff changeset
41
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
42 class NotificationModel(BaseModel):
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
43
2522
17893d61792a Added associated classes into child models
Marcin Kuzminski <marcin@python-works.com>
parents: 2503
diff changeset
44 cls = Notification
17893d61792a Added associated classes into child models
Marcin Kuzminski <marcin@python-works.com>
parents: 2503
diff changeset
45
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
46 def __get_notification(self, notification):
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
47 if isinstance(notification, Notification):
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
48 return notification
2149
50aa7cb78cfe Mysql fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 2109
diff changeset
49 elif isinstance(notification, (int, long)):
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
50 return Notification.get(notification)
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
51 else:
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
52 if notification:
2149
50aa7cb78cfe Mysql fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 2109
diff changeset
53 raise Exception('notification must be int, long or Instance'
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
54 ' of Notification got %s' % type(notification))
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
55
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
56 def create(self, created_by, subject, body, recipients=None,
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
57 type_=Notification.TYPE_MESSAGE, with_email=True,
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
58 email_kwargs={}):
1703
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
59 """
1800
6c86c987cf93 pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1791
diff changeset
60
1703
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
61 Creates notification of given type
1800
6c86c987cf93 pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1791
diff changeset
62
1703
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
63 :param created_by: int, str or User instance. User who created this
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
64 notification
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
65 :param subject:
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
66 :param body:
1818
cf51bbfb120e auto white-space removal
Marcin Kuzminski <marcin@python-works.com>
parents: 1800
diff changeset
67 :param recipients: list of int, str or User objects, when None
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
68 is given send to all admins
1703
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
69 :param type_: type of notification
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
70 :param with_email: send email with this notification
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
71 :param email_kwargs: additional dict to pass as args to email template
1703
f23828b00b21 notification fixes and improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1702
diff changeset
72 """
1722
e7eef7a1db6a #235 forking page repo group selection
Marcin Kuzminski <marcin@python-works.com>
parents: 1717
diff changeset
73 from rhodecode.lib.celerylib import tasks, run_task
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
74
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
75 if recipients and not getattr(recipients, '__iter__', False):
3270
81397bd3e77f fix a couple of typos
Mads Kiilerich <madski@unity3d.com>
parents: 3255
diff changeset
76 raise Exception('recipients must be a list or iterable')
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
77
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
78 created_by_obj = self._get_user(created_by)
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
79
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
80 if recipients:
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
81 recipients_objs = []
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
82 for u in recipients:
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
83 obj = self._get_user(u)
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
84 if obj:
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
85 recipients_objs.append(obj)
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
86 recipients_objs = set(recipients_objs)
2077
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
87 log.debug('sending notifications %s to %s' % (
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
88 type_, recipients_objs)
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
89 )
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
90 else:
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
91 # empty recipients means to all admins
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
92 recipients_objs = User.query().filter(User.admin == True).all()
2077
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
93 log.debug('sending notifications %s to admins: %s' % (
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
94 type_, recipients_objs)
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
95 )
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
96 notif = Notification.create(
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
97 created_by=created_by_obj, subject=subject,
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
98 body=body, recipients=recipients_objs, type_=type_
179604334d98 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
99 )
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
100
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
101 if with_email is False:
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
102 return notif
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
103
2387
7d517a35b6c9 Don't send emails to person who comment on changeset
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
104 #don't send email to person who created this comment
7d517a35b6c9 Don't send emails to person who comment on changeset
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
105 rec_objs = set(recipients_objs).difference(set([created_by_obj]))
7d517a35b6c9 Don't send emails to person who comment on changeset
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
106
7d517a35b6c9 Don't send emails to person who comment on changeset
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
107 # send email with notification to all other participants
7d517a35b6c9 Don't send emails to person who comment on changeset
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
108 for rec in rec_objs:
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
109 email_subject = NotificationModel().make_description(notif, False)
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
110 type_ = type_
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
111 email_body = body
2296
e5c0f201ca0b Add changeset status change into emails
Marcin Kuzminski <marcin@python-works.com>
parents: 2217
diff changeset
112 ## this is passed into template
1800
6c86c987cf93 pep8ify
Marcin Kuzminski <marcin@python-works.com>
parents: 1791
diff changeset
113 kwargs = {'subject': subject, 'body': h.rst_w_mentions(body)}
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
114 kwargs.update(email_kwargs)
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
115 email_body_html = EmailNotificationModel()\
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
116 .get_email_tmpl(type_, **kwargs)
2156
a27e4d44237e Use __unicode__ instead of __repr__ in models.
Marcin Kuzminski <marcin@python-works.com>
parents: 2149
diff changeset
117
1722
e7eef7a1db6a #235 forking page repo group selection
Marcin Kuzminski <marcin@python-works.com>
parents: 1717
diff changeset
118 run_task(tasks.send_email, rec.email, email_subject, email_body,
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
119 email_body_html)
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
120
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
121 return notif
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
122
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
123 def delete(self, user, notification):
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
124 # we don't want to remove actual notification just the assignment
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
125 try:
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
126 notification = self.__get_notification(notification)
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
127 user = self._get_user(user)
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
128 if notification and user:
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
129 obj = UserNotification.query()\
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
130 .filter(UserNotification.user == user)\
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
131 .filter(UserNotification.notification
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
132 == notification)\
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
133 .one()
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
134 self.sa.delete(obj)
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
135 return True
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
136 except Exception:
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
137 log.error(traceback.format_exc())
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
138 raise
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
139
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
140 def get_for_user(self, user, filter_=None):
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
141 """
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
142 Get mentions for given user, filter them if filter dict is given
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
143
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
144 :param user:
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
145 :type user:
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
146 :param filter:
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
147 """
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
148 user = self._get_user(user)
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
149
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
150 q = UserNotification.query()\
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
151 .filter(UserNotification.user == user)\
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
152 .join((Notification, UserNotification.notification_id ==
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
153 Notification.notification_id))
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
154
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
155 if filter_:
2503
d04243e932cc Added filtering on inbox by comments
Marcin Kuzminski <marcin@python-works.com>
parents: 2447
diff changeset
156 q = q.filter(Notification.type_.in_(filter_))
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
157
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
158 return q.all()
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
159
2610
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
160 def mark_read(self, user, notification):
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
161 try:
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
162 notification = self.__get_notification(notification)
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
163 user = self._get_user(user)
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
164 if notification and user:
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
165 obj = UserNotification.query()\
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
166 .filter(UserNotification.user == user)\
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
167 .filter(UserNotification.notification
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
168 == notification)\
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
169 .one()
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
170 obj.read = True
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
171 self.sa.add(obj)
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
172 return True
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
173 except Exception:
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
174 log.error(traceback.format_exc())
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
175 raise
3fdf7c3be2c9 added mark as read for single notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 2522
diff changeset
176
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
177 def mark_all_read_for_user(self, user, filter_=None):
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
178 user = self._get_user(user)
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
179 q = UserNotification.query()\
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
180 .filter(UserNotification.user == user)\
2217
76947224bf27 Implemented initial code-review status of changesets
Marcin Kuzminski <marcin@python-works.com>
parents: 2156
diff changeset
181 .filter(UserNotification.read == False)\
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
182 .join((Notification, UserNotification.notification_id ==
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
183 Notification.notification_id))
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
184 if filter_:
2503
d04243e932cc Added filtering on inbox by comments
Marcin Kuzminski <marcin@python-works.com>
parents: 2447
diff changeset
185 q = q.filter(Notification.type_.in_(filter_))
2433
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
186
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
187 # this is a little inefficient but sqlalchemy doesn't support
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
188 # update on joined tables :(
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
189 for obj in q.all():
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
190 obj.read = True
74f2910f7ad9 Added pull requests filter into notification inbox.
Marcin Kuzminski <marcin@python-works.com>
parents: 2432
diff changeset
191 self.sa.add(obj)
1791
2aee0dc1784e mark all read button for notifications
Marcin Kuzminski <marcin@python-works.com>
parents: 1769
diff changeset
192
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
193 def get_unread_cnt_for_user(self, user):
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
194 user = self._get_user(user)
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
195 return UserNotification.query()\
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
196 .filter(UserNotification.read == False)\
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
197 .filter(UserNotification.user == user).count()
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
198
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
199 def get_unread_for_user(self, user):
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
200 user = self._get_user(user)
1702
8cb7f5c4d494 #302 - basic notification system, models+tests
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
201 return [x.notification for x in UserNotification.query()\
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
202 .filter(UserNotification.read == False)\
1713
54687aa00724 Tests updates, Session refactoring
Marcin Kuzminski <marcin@python-works.com>
parents: 1712
diff changeset
203 .filter(UserNotification.user == user).all()]
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
204
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
205 def get_user_notification(self, user, notification):
2432
d3ac7491a5c8 Share common getter functions in base model, and remove duplicated functions from other models
Marcin Kuzminski <marcin@python-works.com>
parents: 2391
diff changeset
206 user = self._get_user(user)
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
207 notification = self.__get_notification(notification)
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
208
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
209 return UserNotification.query()\
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
210 .filter(UserNotification.notification == notification)\
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
211 .filter(UserNotification.user == user).scalar()
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
212
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
213 def make_description(self, notification, show_age=True):
1712
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
214 """
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
215 Creates a human readable description based on properties
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
216 of notification object
cac5109ac3b6 Notification system improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 1703
diff changeset
217 """
2443
fd0a822481ec - added commenting to pull requests
Marcin Kuzminski <marcin@python-works.com>
parents: 2434
diff changeset
218 #alias
fd0a822481ec - added commenting to pull requests
Marcin Kuzminski <marcin@python-works.com>
parents: 2434
diff changeset
219 _n = notification
2082
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
220 _map = {
2993
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
221 _n.TYPE_CHANGESET_COMMENT: _('commented on commit at %(when)s'),
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
222 _n.TYPE_MESSAGE: _('sent message at %(when)s'),
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
223 _n.TYPE_MENTION: _('mentioned you at %(when)s'),
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
224 _n.TYPE_REGISTRATION: _('registered in RhodeCode at %(when)s'),
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
225 _n.TYPE_PULL_REQUEST: _('opened new pull request at %(when)s'),
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
226 _n.TYPE_PULL_REQUEST_COMMENT: _('commented on pull request at %(when)s')
2082
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
227 }
1731
31e6eb2fb4b2 implements #222 registration feedback
Marcin Kuzminski <marcin@python-works.com>
parents: 1723
diff changeset
228
2445
9b623dcddb02 Format datetime in notifications according to unified function
Marcin Kuzminski <marcin@python-works.com>
parents: 2387
diff changeset
229 # action == _map string
2993
716550e1e4fa fixed way of creating notification template for better translations
Marcin Kuzminski <marcin@python-works.com>
parents: 2802
diff changeset
230 tmpl = "%(user)s %(action)s "
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
231 if show_age:
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
232 when = h.age(notification.created_on)
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
233 else:
2445
9b623dcddb02 Format datetime in notifications according to unified function
Marcin Kuzminski <marcin@python-works.com>
parents: 2387
diff changeset
234 when = h.fmt_date(notification.created_on)
2156
a27e4d44237e Use __unicode__ instead of __repr__ in models.
Marcin Kuzminski <marcin@python-works.com>
parents: 2149
diff changeset
235
2082
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
236 data = dict(
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
237 user=notification.created_by_user.username,
3255
09757b15ce7c notification: don't expand %(when)s in usernames
Mads Kiilerich <madski@unity3d.com>
parents: 3121
diff changeset
238 action=_map[notification.type_] % {'when': when},
2082
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
239 )
3255
09757b15ce7c notification: don't expand %(when)s in usernames
Mads Kiilerich <madski@unity3d.com>
parents: 3121
diff changeset
240 return tmpl % data
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
241
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
242
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
243 class EmailNotificationModel(BaseModel):
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
244
1732
8321b3d19b1f test fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1731
diff changeset
245 TYPE_CHANGESET_COMMENT = Notification.TYPE_CHANGESET_COMMENT
3270
81397bd3e77f fix a couple of typos
Mads Kiilerich <madski@unity3d.com>
parents: 3255
diff changeset
246 TYPE_PASSWORD_RESET = 'password_link'
1732
8321b3d19b1f test fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1731
diff changeset
247 TYPE_REGISTRATION = Notification.TYPE_REGISTRATION
2434
f29469677319 Added basic models for saving open pull requests
Marcin Kuzminski <marcin@python-works.com>
parents: 2433
diff changeset
248 TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST
2802
0a623ec24b62 part2 of pull-request notification improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 2799
diff changeset
249 TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
250 TYPE_DEFAULT = 'default'
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
251
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
252 def __init__(self):
1723
64e91067b996 - refactoring to overcome poor usage of global pylons config
Marcin Kuzminski <marcin@python-works.com>
parents: 1722
diff changeset
253 self._template_root = rhodecode.CONFIG['pylons.paths']['templates'][0]
64e91067b996 - refactoring to overcome poor usage of global pylons config
Marcin Kuzminski <marcin@python-works.com>
parents: 1722
diff changeset
254 self._tmpl_lookup = rhodecode.CONFIG['pylons.app_globals'].mako_lookup
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
255
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
256 self.email_types = {
2082
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
257 self.TYPE_CHANGESET_COMMENT: 'email_templates/changeset_comment.html',
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
258 self.TYPE_PASSWORD_RESET: 'email_templates/password_reset.html',
0e27da019f84 code garden
Marcin Kuzminski <marcin@python-works.com>
parents: 2077
diff changeset
259 self.TYPE_REGISTRATION: 'email_templates/registration.html',
2799
493646d3146f Nicer email notifications about pull-request
Marcin Kuzminski <marcin@python-works.com>
parents: 2610
diff changeset
260 self.TYPE_DEFAULT: 'email_templates/default.html',
493646d3146f Nicer email notifications about pull-request
Marcin Kuzminski <marcin@python-works.com>
parents: 2610
diff changeset
261 self.TYPE_PULL_REQUEST: 'email_templates/pull_request.html',
2802
0a623ec24b62 part2 of pull-request notification improvements
Marcin Kuzminski <marcin@python-works.com>
parents: 2799
diff changeset
262 self.TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.html',
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
263 }
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
264
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
265 def get_email_tmpl(self, type_, **kwargs):
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
266 """
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
267 return generated template for email based on given type
1818
cf51bbfb120e auto white-space removal
Marcin Kuzminski <marcin@python-works.com>
parents: 1800
diff changeset
268
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
269 :param type_:
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
270 """
1723
64e91067b996 - refactoring to overcome poor usage of global pylons config
Marcin Kuzminski <marcin@python-works.com>
parents: 1722
diff changeset
271
1732
8321b3d19b1f test fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1731
diff changeset
272 base = self.email_types.get(type_, self.email_types[self.TYPE_DEFAULT])
1723
64e91067b996 - refactoring to overcome poor usage of global pylons config
Marcin Kuzminski <marcin@python-works.com>
parents: 1722
diff changeset
273 email_template = self._tmpl_lookup.get_template(base)
3121
3274ba9f1489 fixes #691: Notifications for pull requests: move link to pull request to the top
Marcin Kuzminski <marcin@python-works.com>
parents: 2993
diff changeset
274 # translator and helpers inject
3274ba9f1489 fixes #691: Notifications for pull requests: move link to pull request to the top
Marcin Kuzminski <marcin@python-works.com>
parents: 2993
diff changeset
275 _kwargs = {'_': _,
3423
043d3827cd88 added template context into Notification templates
Marcin Kuzminski <marcin@python-works.com>
parents: 3270
diff changeset
276 'h': h,
043d3827cd88 added template context into Notification templates
Marcin Kuzminski <marcin@python-works.com>
parents: 3270
diff changeset
277 'c': c}
1717
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
278 _kwargs.update(kwargs)
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
279 log.debug('rendering tmpl %s with kwargs %s' % (base, _kwargs))
7ff304d3028f Notification fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1716
diff changeset
280 return email_template.render(**_kwargs)