integrations: add email integration, fixes #4159

rhodecode/integrations/types/email.py

@@ -0,0 +1,127 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2012-2016  RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+from __future__ import unicode_literals
+
+import deform
+import logging
+import colander
+
+from mako.template import Template
+
+from rhodecode import events
+from rhodecode.translation import _, lazy_ugettext
+from rhodecode.lib.celerylib import run_task
+from rhodecode.lib.celerylib import tasks
+from rhodecode.integrations.types.base import IntegrationTypeBase
+from rhodecode.integrations.schema import IntegrationSettingsSchemaBase
+
+
+log = logging.getLogger()
+
+
+
+class EmailSettingsSchema(IntegrationSettingsSchemaBase):
+    @colander.instantiate(validator=colander.Length(min=1))
+    class recipients(colander.SequenceSchema):
+        title = lazy_ugettext('Recipients')
+        description = lazy_ugettext('Email addresses to send push events to')
+        widget = deform.widget.SequenceWidget(min_len=1)
+
+        recipient = colander.SchemaNode(
+            colander.String(),
+            title=lazy_ugettext('Email address'),
+            description=lazy_ugettext('Email address'),
+            default='',
+            validator=colander.Email(),
+            widget=deform.widget.TextInputWidget(
+                placeholder='[e-mail]',
+            ),
+        )
+
+
+class EmailIntegrationType(IntegrationTypeBase):
+    key = 'email'
+    display_name = lazy_ugettext('Email')
+    SettingsSchema = EmailSettingsSchema
+
+    def settings_schema(self):
+        schema = EmailSettingsSchema()
+        return schema
+
+    def send_event(self, event):
+        data = event.as_dict()
+        log.debug('got event: %r', event)
+
+        if isinstance(event, events.RepoPushEvent):
+            repo_push_handler(data, self.settings)
+        else:
+            log.debug('ignoring event: %r', event)
+
+
+def repo_push_handler(data, settings):
+    for commit in data['push']['commits']:
+        email_body_plaintext = repo_push_template_plaintext.render(
+            data=data,
+            commit=commit,
+            commit_msg=commit['message'],
+        )
+        email_body_html = repo_push_template_html.render(
+            data=data,
+            commit=commit,
+            commit_msg=commit['message_html'],
+        )
+
+        subject = '[%(repo_name)s] %(commit_id)s: %(commit_msg)s' % {
+            'repo_name': data['repo']['repo_name'],
+            'commit_id': commit['short_id'],
+            'commit_msg': commit['message'].split('\n')[0][:150]
+        }
+        for email_address in settings['recipients']:
+            task = run_task(
+                tasks.send_email, email_address, subject,
+                email_body_plaintext, email_body_html)
+
+
+# TODO: dan: add changed files, make html pretty
+repo_push_template_plaintext = Template('''
+User: ${data['actor']['username']}
+Branches: ${', '.join(branch['name'] for branch in data['push']['branches'])}
+Repository: ${data['repo']['url']}
+Commit: ${commit['raw_id']}
+URL: ${commit['url']}
+Author: ${commit['author']}
+Date:   ${commit['date']}
+Commit Message:
+
+${commit_msg}
+''')
+
+repo_push_template_html = Template('''
+User: ${data['actor']['username']}<br>
+Branches: ${', '.join(branch['name'] for branch in data['push']['branches'])}<br>
+Repository: ${data['repo']['url']}<br>
+Commit: ${commit['raw_id']}<br>
+URL: ${commit['url']}<br>
+Author: ${commit['author']}<br>
+Date:   ${commit['date']}<br>
+Commit Message:<br>
+<p>${commit_msg}</p>
+''')

rhodecode/integrations/__init__.py

@@ -1,60 +1,62 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2012-2016  RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import logging
 
 from rhodecode.integrations.registry import IntegrationTypeRegistry
-from rhodecode.integrations.types import webhook, slack, hipchat
+from rhodecode.integrations.types import webhook, slack, hipchat, email
 
 log = logging.getLogger(__name__)
 
 
 # TODO: dan: This is currently global until we figure out what to do about
 # VCS's not having a pyramid context - move it to pyramid app configuration
 # includeme level later to allow per instance integration setup
 integration_type_registry = IntegrationTypeRegistry()
 
 integration_type_registry.register_integration_type(
     webhook.WebhookIntegrationType)
 integration_type_registry.register_integration_type(
     slack.SlackIntegrationType)
 integration_type_registry.register_integration_type(
     hipchat.HipchatIntegrationType)
+integration_type_registry.register_integration_type(
+    email.EmailIntegrationType)
 
 
 def integrations_event_handler(event):
     """
     Takes an event and passes it to all enabled integrations
     """
     from rhodecode.model.integration import IntegrationModel
 
     integration_model = IntegrationModel()
     integrations = integration_model.get_for_event(event)
     for integration in integrations:
         try:
             integration_model.send_event(integration, event)
         except Exception:
             log.exception(
                 'failure occured when sending event %s to integration %s' % (
                     event, integration))
 
 
 def includeme(config):
     config.include('rhodecode.integrations.routes')

rhodecode/lib/celerylib/tasks.py

@@ -1,284 +1,284 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2012-2016  RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 """
 RhodeCode task modules, containing all task that suppose to be run
 by celery daemon
 """
 
 
 import os
 import logging
 
 from celery.task import task
 from pylons import config
 
 import rhodecode
 from rhodecode.lib.celerylib import (
     run_task, dbsession, __get_lockkey, LockHeld, DaemonLock,
     get_session, vcsconnection, RhodecodeCeleryTask)
 from rhodecode.lib.hooks_base import log_create_repository
 from rhodecode.lib.rcmail.smtp_mailer import SmtpMailer
 from rhodecode.lib.utils import add_cache, action_logger
 from rhodecode.lib.utils2 import safe_int, str2bool
 from rhodecode.model.db import Repository, User
 
 
 add_cache(config)  # pragma: no cover
 
 
 def get_logger(cls):
     if rhodecode.CELERY_ENABLED:
         try:
             log = cls.get_logger()
         except Exception:
             log = logging.getLogger(__name__)
     else:
         log = logging.getLogger(__name__)
 
     return log
 
 
 @task(ignore_result=True, base=RhodecodeCeleryTask)
 @dbsession
 def send_email(recipients, subject, body='', html_body='', email_config=None):
     """
     Sends an email with defined parameters from the .ini files.
 
     :param recipients: list of recipients, it this is empty the defined email
         address from field 'email_to' is used instead
     :param subject: subject of the mail
     :param body: body of the mail
     :param html_body: html version of body
     """
     log = get_logger(send_email)
 
-    email_config = email_config or config
+    email_config = email_config or rhodecode.CONFIG
     subject = "%s %s" % (email_config.get('email_prefix', ''), subject)
     if not recipients:
         # if recipients are not defined we send to email_config + all admins
         admins = [
             u.email for u in User.query().filter(User.admin == True).all()]
         recipients = [email_config.get('email_to')] + admins
 
     mail_server = email_config.get('smtp_server') or None
     if mail_server is None:
         log.error("SMTP server information missing. Sending email failed. "
                   "Make sure that `smtp_server` variable is configured "
                   "inside the .ini file")
         return False
 
     mail_from = email_config.get('app_email_from', 'RhodeCode')
     user = email_config.get('smtp_username')
     passwd = email_config.get('smtp_password')
     mail_port = email_config.get('smtp_port')
     tls = str2bool(email_config.get('smtp_use_tls'))
     ssl = str2bool(email_config.get('smtp_use_ssl'))
     debug = str2bool(email_config.get('debug'))
     smtp_auth = email_config.get('smtp_auth')
 
     try:
         m = SmtpMailer(mail_from, user, passwd, mail_server, smtp_auth,
                        mail_port, ssl, tls, debug=debug)
         m.send(recipients, subject, body, html_body)
     except Exception:
         log.exception('Mail sending failed')
         return False
     return True
 
 
 @task(ignore_result=True, base=RhodecodeCeleryTask)
 @dbsession
 @vcsconnection
 def create_repo(form_data, cur_user):
     from rhodecode.model.repo import RepoModel
     from rhodecode.model.user import UserModel
     from rhodecode.model.settings import SettingsModel
 
     log = get_logger(create_repo)
     DBS = get_session()
 
     cur_user = UserModel(DBS)._get_user(cur_user)
     owner = cur_user
 
     repo_name = form_data['repo_name']
     repo_name_full = form_data['repo_name_full']
     repo_type = form_data['repo_type']
     description = form_data['repo_description']
     private = form_data['repo_private']
     clone_uri = form_data.get('clone_uri')
     repo_group = safe_int(form_data['repo_group'])
     landing_rev = form_data['repo_landing_rev']
     copy_fork_permissions = form_data.get('copy_permissions')
     copy_group_permissions = form_data.get('repo_copy_permissions')
     fork_of = form_data.get('fork_parent_id')
     state = form_data.get('repo_state', Repository.STATE_PENDING)
 
     # repo creation defaults, private and repo_type are filled in form
     defs = SettingsModel().get_default_repo_settings(strip_prefix=True)
     enable_statistics = form_data.get(
         'enable_statistics', defs.get('repo_enable_statistics'))
     enable_locking = form_data.get(
         'enable_locking', defs.get('repo_enable_locking'))
     enable_downloads = form_data.get(
         'enable_downloads', defs.get('repo_enable_downloads'))
 
     try:
         RepoModel(DBS)._create_repo(
             repo_name=repo_name_full,
             repo_type=repo_type,
             description=description,
             owner=owner,
             private=private,
             clone_uri=clone_uri,
             repo_group=repo_group,
             landing_rev=landing_rev,
             fork_of=fork_of,
             copy_fork_permissions=copy_fork_permissions,
             copy_group_permissions=copy_group_permissions,
             enable_statistics=enable_statistics,
             enable_locking=enable_locking,
             enable_downloads=enable_downloads,
             state=state
         )
 
         action_logger(cur_user, 'user_created_repo',
                       repo_name_full, '', DBS)
         DBS.commit()
 
         # now create this repo on Filesystem
         RepoModel(DBS)._create_filesystem_repo(
             repo_name=repo_name,
             repo_type=repo_type,
             repo_group=RepoModel(DBS)._get_repo_group(repo_group),
             clone_uri=clone_uri,
         )
         repo = Repository.get_by_repo_name(repo_name_full)
         log_create_repository(created_by=owner.username, **repo.get_dict())
 
         # update repo commit caches initially
         repo.update_commit_cache()
 
         # set new created state
         repo.set_state(Repository.STATE_CREATED)
         DBS.commit()
     except Exception as e:
         log.warning('Exception %s occurred when creating repository, '
                     'doing cleanup...', e)
         # rollback things manually !
         repo = Repository.get_by_repo_name(repo_name_full)
         if repo:
             Repository.delete(repo.repo_id)
             DBS.commit()
             RepoModel(DBS)._delete_filesystem_repo(repo)
         raise
 
     # it's an odd fix to make celery fail task when exception occurs
     def on_failure(self, *args, **kwargs):
         pass
 
     return True
 
 
 @task(ignore_result=True, base=RhodecodeCeleryTask)
 @dbsession
 @vcsconnection
 def create_repo_fork(form_data, cur_user):
     """
     Creates a fork of repository using internal VCS methods
 
     :param form_data:
     :param cur_user:
     """
     from rhodecode.model.repo import RepoModel
     from rhodecode.model.user import UserModel
 
     log = get_logger(create_repo_fork)
     DBS = get_session()
 
     cur_user = UserModel(DBS)._get_user(cur_user)
     owner = cur_user
 
     repo_name = form_data['repo_name']  # fork in this case
     repo_name_full = form_data['repo_name_full']
     repo_type = form_data['repo_type']
     description = form_data['description']
     private = form_data['private']
     clone_uri = form_data.get('clone_uri')
     repo_group = safe_int(form_data['repo_group'])
     landing_rev = form_data['landing_rev']
     copy_fork_permissions = form_data.get('copy_permissions')
     fork_id = safe_int(form_data.get('fork_parent_id'))
 
     try:
         fork_of = RepoModel(DBS)._get_repo(fork_id)
         RepoModel(DBS)._create_repo(
             repo_name=repo_name_full,
             repo_type=repo_type,
             description=description,
             owner=owner,
             private=private,
             clone_uri=clone_uri,
             repo_group=repo_group,
             landing_rev=landing_rev,
             fork_of=fork_of,
             copy_fork_permissions=copy_fork_permissions
         )
         action_logger(cur_user, 'user_forked_repo:%s' % repo_name_full,
                       fork_of.repo_name, '', DBS)
         DBS.commit()
 
         base_path = Repository.base_path()
         source_repo_path = os.path.join(base_path, fork_of.repo_name)
 
         # now create this repo on Filesystem
         RepoModel(DBS)._create_filesystem_repo(
             repo_name=repo_name,
             repo_type=repo_type,
             repo_group=RepoModel(DBS)._get_repo_group(repo_group),
             clone_uri=source_repo_path,
         )
         repo = Repository.get_by_repo_name(repo_name_full)
         log_create_repository(created_by=owner.username, **repo.get_dict())
 
         # update repo commit caches initially
         config = repo._config
         config.set('extensions', 'largefiles', '')
         repo.update_commit_cache(config=config)
 
         # set new created state
         repo.set_state(Repository.STATE_CREATED)
         DBS.commit()
     except Exception as e:
         log.warning('Exception %s occurred when forking repository, '
                     'doing cleanup...', e)
         # rollback things manually !
         repo = Repository.get_by_repo_name(repo_name_full)
         if repo:
             Repository.delete(repo.repo_id)
             DBS.commit()
             RepoModel(DBS)._delete_filesystem_repo(repo)
         raise
 
     # it's an odd fix to make celery fail task when exception occurs
     def on_failure(self, *args, **kwargs):
         pass
 
     return True

rhodecode/templates/forms/sequence_item.pt

@@ -1,35 +1,35 b''
 <div tal:omit-tag="field.widget.hidden"
      tal:define="hidden hidden|field.widget.hidden;
                  error_class error_class|field.widget.error_class;
                  description description|field.description;
                  title title|field.title;
                  oid oid|field.oid"
      class="form-group row deform-seq-item ${field.error and error_class or ''} ${field.widget.item_css_class or ''}"
      i18n:domain="deform">
   <div class="deform-seq-item-group">
     <span tal:replace="structure field.serialize(cstruct)"/>
     <tal:errors condition="field.error and not hidden"
                 define="errstr 'error-%s' % oid"
                 repeat="msg field.error.messages()">
       <p tal:condition="msg"
          id="${errstr if repeat.msg.index==0 else '%s-%s' % (errstr, repeat.msg.index)}"
-         class="${error_class} help-block"
+         class="${error_class} help-block error-block"
          i18n:translate="">${msg}</p>
     </tal:errors>
   </div>
   <div class="deform-seq-item-handle" style="padding:0">
     <!-- sequence_item -->
     <span class="deform-order-button close glyphicon glyphicon-resize-vertical"
           id="${oid}-order"
           tal:condition="not hidden"
           title="Reorder (via drag and drop)"
           i18n:attributes="title"></span>
     <a class="deform-close-button close"
        id="${oid}-close"
        tal:condition="not field.widget.hidden"
        title="Remove"
        i18n:attributes="title"
        onclick="javascript:deform.removeSequenceItem(this);">&times;</a>
   </div>
   <!-- /sequence_item -->
 </div>