Changeset - 55f2f2b4c462
Parent rev.
Child rev.
[Not reviewed]
default
0 4 0
Mads Kiilerich - 11 years ago 2014-07-18 19:22:01
madski@unity3d.com
notifications: improve Email subjects
4 files changed with 57 insertions and 27 deletions:
kallithea/model/comment.py
13
9
kallithea/model/notification.py
30
9
kallithea/model/pull_request.py
10
4
kallithea/model/user.py
4
5
0 comments (0 inline, 0 general)
kallithea/model/comment.py
➞
Show inline comments
 
@@ -90,14 +90,12 @@ class ChangesetCommentsModel(BaseModel):
 
            )
 
            subj = safe_unicode(
 
                h.link_to('Re changeset: %(desc)s %(line)s' % \
 
                          {'desc': desc, 'line': line},
 
                          _url)
 
            )
 
            email_subject = '%s commented on changeset %s' % \
 
                (user.username, h.short_id(revision))
 
            # get the current participants of this changeset
 
            recipients = ChangesetComment.get_users(revision=revision)
 
            # add changeset author if it's in kallithea system
 
            cs_author = User.get_from_cs_author(cs.author)
 
            if not cs_author:
 
                #use repo owner if we cannot extract the author correctly
 
@@ -107,18 +105,23 @@ class ChangesetCommentsModel(BaseModel):
 
                'status_change': status_change,
 
                'cs_comment_user': h.person(user),
 
                'cs_target_repo': h.url('summary_home', repo_name=repo.repo_name,
 
                                        qualified=True),
 
                'cs_comment_url': _url,
 
                'raw_id': revision,
 
                'message': cs.message
 
                'message': cs.message,
 
                'repo_name': repo.repo_name,
 
                'short_id': h.short_id(revision),
 
                'branch': cs.branch,
 
                'comment_username': user.username,
 
            }
 
        #pull request
 
        elif pull_request:
 
            notification_type = Notification.TYPE_PULL_REQUEST_COMMENT
 
            desc = comment.pull_request.title
 
            _org_ref_type, org_ref_name, _org_rev = comment.pull_request.org_ref.split(':')
 
            _url = h.url('pullrequest_show',
 
                repo_name=pull_request.other_repo.repo_name,
 
                pull_request_id=pull_request.pull_request_id,
 
                anchor='comment-%s' % comment.comment_id,
 
                qualified=True,
 
            )
 
@@ -126,14 +129,12 @@ class ChangesetCommentsModel(BaseModel):
 
                h.link_to('Re pull request #%(pr_id)s: %(desc)s %(line)s' % \
 
                          {'desc': desc,
 
                           'pr_id': comment.pull_request.pull_request_id,
 
                           'line': line},
 
                          _url)
 
            )
 
            email_subject = '%s commented on pull request #%s' % \
 
                    (user.username, comment.pull_request.pull_request_id)
 
            # get the current participants of this pull request
 
            recipients = ChangesetComment.get_users(pull_request_id=
 
                                                pull_request.pull_request_id)
 
            # add pull request author
 
            recipients += [pull_request.author]
 

			




	
	
		
 
@@ -147,16 +148,19 @@ class ChangesetCommentsModel(BaseModel):

			




	
	
	
		
 
                'status_change': status_change,

			




	
	
	
		
 
                'closing_pr': closing_pr,

			




	
	
	
		
 
                'pr_comment_url': _url,

			




	
	
	
		
 
                'pr_comment_user': h.person(user),

			




	
	
	
		
 
                'pr_target_repo': h.url('summary_home',

			




	
	
	
		
 
                                   repo_name=pull_request.other_repo.repo_name,

			




	
	
	
		
 
                                   qualified=True)

			




	
	
	
		
 
                                   qualified=True),

			




	
	
	
		
 
                'repo_name': pull_request.other_repo.repo_name,

			




	
	
	
		
 
                'ref': org_ref_name,

			




	
	
	
		
 
                'comment_username': user.username,

			




	
	
	
		
 
            }

			




	
	
	
		
 

			




	
	
	
		
 
        return subj, body, recipients, notification_type, email_kwargs, email_subject

			




	
	
	
		
 
        return subj, body, recipients, notification_type, email_kwargs

			




	
	
	
		
 

			




	
	
	
		
 
    def create(self, text, repo, user, revision=None, pull_request=None,

			




	
	
	
		
 
               f_path=None, line_no=None, status_change=None, closing_pr=False,

			




	
	
	
		
 
               send_email=True):

			




	
	
	
		
 
        """

			




	
	
	
		
 
        Creates new comment for changeset or pull request.

			




	
	
		
 
@@ -197,25 +201,25 @@ class ChangesetCommentsModel(BaseModel):

			




	
	
	
		
 

			




	
	
	
		
 
        Session().add(comment)

			




	
	
	
		
 
        Session().flush()

			




	
	
	
		
 

			




	
	
	
		
 
        if send_email:

			




	
	
	
		
 
            (subj, body, recipients, notification_type,

			




	
	
	
		
 
             email_kwargs, email_subject) = self._get_notification_data(

			




	
	
	
		
 
             email_kwargs) = self._get_notification_data(

			




	
	
	
		
 
                                repo, comment, user,

			




	
	
	
		
 
                                comment_text=text,

			




	
	
	
		
 
                                line_no=line_no,

			




	
	
	
		
 
                                revision=revision,

			




	
	
	
		
 
                                pull_request=pull_request,

			




	
	
	
		
 
                                status_change=status_change,

			




	
	
	
		
 
                                closing_pr=closing_pr)

			




	
	
	
		
 
            # create notification objects, and emails

			




	
	
	
		
 
            NotificationModel().create(

			




	
	
	
		
 
                created_by=user, subject=subj, body=body,

			




	
	
	
		
 
                recipients=recipients, type_=notification_type,

			




	
	
	
		
 
                email_kwargs=email_kwargs, email_subject=email_subject

			




	
	
	
		
 
                email_kwargs=email_kwargs,

			




	
	
	
		
 
            )

			




	
	
	
		
 

			




	
	
	
		
 
            mention_recipients = set(self._extract_mentions(body))\

			




	
	
	
		
 
                                    .difference(recipients)

			




	
	
	
		
 
            if mention_recipients:

			




	
	
	
		
 
                email_kwargs.update({'pr_mention': True})

			




        

    


    
    

    

        

                

                    kallithea/model/notification.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -56,13 +56,13 @@ class NotificationModel(BaseModel):

			




	
	
	
		
 
            if notification:

			




	
	
	
		
 
                raise Exception('notification must be int, long or Instance'

			




	
	
	
		
 
                                ' of Notification got %s' % type(notification))

			




	
	
	
		
 

			




	
	
	
		
 
    def create(self, created_by, subject, body, recipients=None,

			




	
	
	
		
 
               type_=Notification.TYPE_MESSAGE, with_email=True,

			




	
	
	
		
 
               email_kwargs={}, email_subject=None):

			




	
	
	
		
 
               email_kwargs={}):

			




	
	
	
		
 
        """

			




	
	
	
		
 

			




	
	
	
		
 
        Creates notification of given type

			




	
	
	
		
 

			




	
	
	
		
 
        :param created_by: int, str or User instance. User who created this

			




	
	
	
		
 
            notification

			




	
	
		
 
@@ -70,13 +70,12 @@ class NotificationModel(BaseModel):

			




	
	
	
		
 
        :param body:

			




	
	
	
		
 
        :param recipients: list of int, str or User objects, when None

			




	
	
	
		
 
            is given send to all admins

			




	
	
	
		
 
        :param type_: type of notification

			




	
	
	
		
 
        :param with_email: send email with this notification

			




	
	
	
		
 
        :param email_kwargs: additional dict to pass as args to email template

			




	
	
	
		
 
        :param email_subject: use given subject as email subject

			




	
	
	
		
 
        """

			




	
	
	
		
 
        from kallithea.lib.celerylib import tasks, run_task

			




	
	
	
		
 

			




	
	
	
		
 
        if recipients and not getattr(recipients, '__iter__', False):

			




	
	
	
		
 
            raise Exception('recipients must be a list or iterable')

			




	
	
	
		
 

			




	
	
		
 
@@ -114,20 +113,23 @@ class NotificationModel(BaseModel):

			




	
	
	
		
 

			




	
	
	
		
 
        #don't send email to person who created this comment

			




	
	
	
		
 
        rec_objs = set(recipients_objs).difference(set([created_by_obj]))

			




	
	
	
		
 

			




	
	
	
		
 
        # send email with notification to all other participants

			




	
	
	
		
 
        for rec in rec_objs:

			




	
	
	
		
 
            if not email_subject:

			




	
	
	
		
 
                email_subject = NotificationModel()\

			




	
	
	
		
 
                                    .make_description(notif, show_age=False)

			




	
	
	
		
 
            type_ = type_

			




	
	
	
		
 
            email_body = None  # we set body to none, we just send HTML emails

			




	
	
	
		
 
            ## this is passed into template

			




	
	
	
		
 
            kwargs = {'subject': subject, 'body': h.rst_w_mentions(body)}

			




	
	
	
		
 
            kwargs = {'subject': subject,

			




	
	
	
		
 
                      'body': h.rst_w_mentions(body),

			




	
	
	
		
 
                      'when': h.fmt_date(notif.created_on),

			




	
	
	
		
 
                      'user': notif.created_by_user.username,

			




	
	
	
		
 
                      }

			




	
	
	
		
 

			




	
	
	
		
 
            kwargs.update(email_kwargs)

			




	
	
	
		
 
            email_subject = EmailNotificationModel()\

			




	
	
	
		
 
                                .get_email_description(type_, **kwargs)

			




	
	
	
		
 
            email_body_html = EmailNotificationModel()\

			




	
	
	
		
 
                                .get_email_tmpl(type_, **kwargs)

			




	
	
	
		
 

			




	
	
	
		
 
            run_task(tasks.send_email, [rec.email], email_subject, email_body,

			




	
	
	
		
 
                     email_body_html)

			




	
	
	
		
 

			




	
	
		
 
@@ -250,12 +252,14 @@ class NotificationModel(BaseModel):

			




	
	
	
		
 
            )

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
class EmailNotificationModel(BaseModel):

			




	
	
	
		
 

			




	
	
	
		
 
    TYPE_CHANGESET_COMMENT = Notification.TYPE_CHANGESET_COMMENT

			




	
	
	
		
 
    TYPE_MESSAGE = Notification.TYPE_MESSAGE # only used for testing

			




	
	
	
		
 
    # Notification.TYPE_MENTION is not used

			




	
	
	
		
 
    TYPE_PASSWORD_RESET = 'password_link'

			




	
	
	
		
 
    TYPE_REGISTRATION = Notification.TYPE_REGISTRATION

			




	
	
	
		
 
    TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST

			




	
	
	
		
 
    TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT

			




	
	
	
		
 
    TYPE_DEFAULT = 'default'

			




	
	
	
		
 

			




	
	
		
 
@@ -268,19 +272,36 @@ class EmailNotificationModel(BaseModel):

			




	
	
	
		
 
            self.TYPE_PASSWORD_RESET: 'email_templates/password_reset.html',

			




	
	
	
		
 
            self.TYPE_REGISTRATION: 'email_templates/registration.html',

			




	
	
	
		
 
            self.TYPE_DEFAULT: 'email_templates/default.html',

			




	
	
	
		
 
            self.TYPE_PULL_REQUEST: 'email_templates/pull_request.html',

			




	
	
	
		
 
            self.TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.html',

			




	
	
	
		
 
        }

			




	
	
	
		
 
        self._subj_map = {

			




	
	
	
		
 
            self.TYPE_CHANGESET_COMMENT: _('Comment on %(repo_name)s changeset %(short_id)s on %(branch)s by %(comment_username)s'),

			




	
	
	
		
 
            self.TYPE_MESSAGE: 'Test Message',

			




	
	
	
		
 
            # self.TYPE_PASSWORD_RESET

			




	
	
	
		
 
            self.TYPE_REGISTRATION: _('New user %(new_username)s registered'),

			




	
	
	
		
 
            # self.TYPE_DEFAULT

			




	
	
	
		
 
            self.TYPE_PULL_REQUEST: _('Review request on %(repo_name)s pull request #%(pr_id)s from %(ref)s by %(pr_username)s'),

			




	
	
	
		
 
            self.TYPE_PULL_REQUEST_COMMENT: _('Comment on %(repo_name)s pull request #%(pr_id)s from %(ref)s by %(comment_username)s'),

			




	
	
	
		
 
        }

			




	
	
	
		
 

			




	
	
	
		
 
    def get_email_description(self, type_, **kwargs):

			




	
	
	
		
 
        """

			




	
	
	
		
 
        return subject for email based on given type

			




	
	
	
		
 
        """

			




	
	
	
		
 
        tmpl = self._subj_map[type_]

			




	
	
	
		
 
        try:

			




	
	
	
		
 
            return tmpl % kwargs

			




	
	
	
		
 
        except KeyError, e:

			




	
	
	
		
 
            log.error('error generating email subject for %r from %s: %s', type_, ','.join(self._subj_map.keys()), e)

			




	
	
	
		
 
            raise

			




	
	
	
		
 

			




	
	
	
		
 
    def get_email_tmpl(self, type_, **kwargs):

			




	
	
	
		
 
        """

			




	
	
	
		
 
        return generated template for email based on given type

			




	
	
	
		
 

			




	
	
	
		
 
        :param type_:

			




	
	
	
		
 
        """

			




	
	
	
		
 

			




	
	
	
		
 
        base = self.email_types.get(type_, self.email_types[self.TYPE_DEFAULT])

			




	
	
	
		
 
        email_template = self._tmpl_lookup.get_template(base)

			




	
	
	
		
 
        # translator and helpers inject

			




	
	
	
		
 
        _kwargs = {'_': _,

			




        

    


    
    

    

        

                

                    kallithea/model/pull_request.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -129,23 +129,29 @@ class PullRequestModel(BaseModel):

			




	
	
	
		
 
                {'user': pr.author.username,

			




	
	
	
		
 
                 'pr_title': pr.title,

			




	
	
	
		
 
                 'pr_id': pr.pull_request_id},

			




	
	
	
		
 
                pr_url)

			




	
	
	
		
 
            )

			




	
	
	
		
 
        body = pr.description

			




	
	
	
		
 
        kwargs = {

			




	
	
	
		
 
        _org_ref_type, org_ref_name, _org_rev = pr.org_ref.split(':')

			




	
	
	
		
 
        email_kwargs = {

			




	
	
	
		
 
            'pr_title': pr.title,

			




	
	
	
		
 
            'pr_user_created': h.person(pr.author),

			




	
	
	
		
 
            'pr_repo_url': h.url('summary_home', repo_name=pr.other_repo.repo_name,

			




	
	
	
		
 
                                 qualified=True,),

			




	
	
	
		
 
            'pr_url': pr_url,

			




	
	
	
		
 
            'pr_revisions': revision_data}

			




	
	
	
		
 

			




	
	
	
		
 
            'pr_revisions': revision_data,

			




	
	
	
		
 
            'repo_name': pr.other_repo.repo_name,

			




	
	
	
		
 
            'pr_id': pr.pull_request_id,

			




	
	
	
		
 
            'ref': org_ref_name,

			




	
	
	
		
 
            'pr_username': pr.author.username,

			




	
	
	
		
 
            }

			




	
	
	
		
 
        NotificationModel().create(created_by=pr.author, subject=subject, body=body,

			




	
	
	
		
 
                                   recipients=reviewers,

			




	
	
	
		
 
                                   type_=Notification.TYPE_PULL_REQUEST, email_kwargs=kwargs)

			




	
	
	
		
 
                                   type_=Notification.TYPE_PULL_REQUEST,

			




	
	
	
		
 
                                   email_kwargs=email_kwargs)

			




	
	
	
		
 

			




	
	
	
		
 
    def update_reviewers(self, pull_request, reviewers_ids):

			




	
	
	
		
 
        reviewers_ids = set(reviewers_ids)

			




	
	
	
		
 
        pull_request = self.__get_pull_request(pull_request)

			




	
	
	
		
 
        current_reviewers = PullRequestReviewers.query()\

			




	
	
	
		
 
                            .filter(PullRequestReviewers.pull_request==

			




        

    


    
    

    

        

                

                    kallithea/model/user.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -200,18 +200,17 @@ class UserModel(BaseModel):

			




	
	
	
		
 
                    '---------------------\n'

			




	
	
	
		
 
                    '- Username: %s\n'

			




	
	
	
		
 
                    '- Full Name: %s\n'

			




	
	
	
		
 
                    '- Email: %s\n')

			




	
	
	
		
 
            body = body % (new_user.username, new_user.full_name, new_user.email)

			




	
	
	
		
 
            edit_url = url('edit_user', id=new_user.user_id, qualified=True)

			




	
	
	
		
 
            kw = {'registered_user_url': edit_url}

			




	
	
	
		
 
            email_kwargs = {'registered_user_url': edit_url, 'new_username': new_user.username}

			




	
	
	
		
 
            NotificationModel().create(created_by=new_user, subject=subject,

			




	
	
	
		
 
                                       body=body, recipients=None,

			




	
	
	
		
 
                                       type_=Notification.TYPE_REGISTRATION,

			




	
	
	
		
 
                                       email_kwargs=kw)

			




	
	
	
		
 

			




	
	
	
		
 
                                       email_kwargs=email_kwargs)

			




	
	
	
		
 
        except Exception:

			




	
	
	
		
 
            log.error(traceback.format_exc())

			




	
	
	
		
 
            raise

			




	
	
	
		
 

			




	
	
	
		
 
    def update(self, user_id, form_data, skip_attrs=[]):

			




	
	
	
		
 
        from kallithea.lib.auth import get_crypt_password

			




	
	
		
 
@@ -294,14 +293,14 @@ class UserModel(BaseModel):

			




	
	
	
		
 
            if user:

			




	
	
	
		
 
                log.debug('password reset user found %s' % user)

			




	
	
	
		
 
                link = url('reset_password_confirmation', key=user.api_key,

			




	
	
	
		
 
                           qualified=True)

			




	
	
	
		
 
                reg_type = EmailNotificationModel.TYPE_PASSWORD_RESET

			




	
	
	
		
 
                body = EmailNotificationModel().get_email_tmpl(reg_type,

			




	
	
	
		
 
                                                    **{'user': user.short_contact,

			




	
	
	
		
 
                                                       'reset_url': link})

			




	
	
	
		
 
                                                               user=user.short_contact,

			




	
	
	
		
 
                                                               reset_url=link)

			




	
	
	
		
 
                log.debug('sending email')

			




	
	
	
		
 
                run_task(tasks.send_email, [user_email],

			




	
	
	
		
 
                         _("Password reset link"), body, body)

			




	
	
	
		
 
                log.info('send new password mail to %s' % user_email)

			




	
	
	
		
 
            else:

			




	
	
	
		
 
                log.debug("password reset email %s not found" % user_email)

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.