Closes #69: Send email on account creation

tracim/development.ini.base

@@ -174,8 +174,11 @@ email.notification.activated = False
 email.notification.from = Tracim Notification <noreply@trac.im>
 email.notification.content_update.template.html = ./tracim/templates/mail/content_update_body_html.mak
 email.notification.content_update.template.text = ./tracim/templates/mail/content_update_body_text.mak
+email.notification.created_account.template.html = ./tracim/templates/mail/created_account_body_html.mak
+email.notification.created_account.template.text = ./tracim/templates/mail/created_account_body_text.mak
 # Note: items between { and } are variable names. Do not remove / rename them
 email.notification.content_update.subject = [{website_title}] [{workspace_label}] {content_label} ({content_status_label})
+email.notification.created_account.subject = [{website_title}] Created account
 # processing_mode may be sync or async
 email.notification.processing_mode = sync
 email.notification.smtp.server = your_smtp_server

tracim/tracim/command/user.py

@@ -5,6 +5,7 @@ from tg import config
 
 from tracim.command import AppContextCommand, Extender
 from tracim.lib.auth.ldap import LDAPAuth
+from tracim.lib.email import get_email_manager
 from tracim.lib.exception import AlreadyExistError, CommandAbortedError
 from tracim.lib.group import GroupApi
 from tracim.lib.user import UserApi
@@ -68,6 +69,15 @@ class UserCommand(AppContextCommand):
             default=[],
         )
 
+        parser.add_argument(
+            "--send-email",
+            help='Send mail to user',
+            dest='send_email',
+            required=False,
+            action='store_true',
+            default=False,
+        )
+
         return parser
 
     def _user_exist(self, login):
@@ -126,6 +136,13 @@ class UserCommand(AppContextCommand):
                 user = self._create_user(login=parsed_args.login, password=parsed_args.password)
             except AlreadyExistError:
                 raise CommandAbortedError("Error: User already exist (use `user update` command instead)")
+            if parsed_args.send_email:
+                email_manager = get_email_manager()
+                email_manager.notify_created_account(
+                    user=user,
+                    password=parsed_args.password,
+                )
+
         else:
             if parsed_args.password:
                 self._update_password_for_login(login=parsed_args.login, password=parsed_args.password)

tracim/tracim/config/app_cfg.py

@@ -186,7 +186,19 @@ class CFG(object):
         self.EMAIL_NOTIFICATION_FROM = tg.config.get('email.notification.from')
         self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_HTML = tg.config.get('email.notification.content_update.template.html')
         self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_TEXT = tg.config.get('email.notification.content_update.template.text')
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML = tg.config.get(
+            'email.notification.created_account.template.html',
+            './tracim/templates/mail/created_account_body_html.mak',
+        )
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT = tg.config.get(
+            'email.notification.created_account.template.text',
+            './tracim/templates/mail/created_account_body_text.mak',
+        )
         self.EMAIL_NOTIFICATION_CONTENT_UPDATE_SUBJECT = tg.config.get('email.notification.content_update.subject')
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_SUBJECT = tg.config.get(
+            'email.notification.created_account.subject',
+            '[{website_title}] Created account',
+        )
         self.EMAIL_NOTIFICATION_PROCESSING_MODE = tg.config.get('email.notification.processing_mode')
 
 

tracim/tracim/controllers/admin/user.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import uuid
 
 from tracim import model  as pm
 
@@ -23,6 +24,7 @@ from tracim.controllers.user import UserWorkspaceRestController
 from tracim.lib import CST
 from tracim.lib import helpers as h
 from tracim.lib.base import logger
+from tracim.lib.email import get_email_manager
 from tracim.lib.user import UserApi
 from tracim.lib.group import GroupApi
 from tracim.lib.user import UserStaticApi
@@ -291,9 +293,18 @@ class UserRestController(TIMRestController):
 
     @tg.require(predicates.in_group(Group.TIM_MANAGER_GROUPNAME))
     @tg.expose()
-    def post(self, name, email, password, is_tracim_manager='off', is_tracim_admin='off'):
+    def post(
+            self,
+            name: str,
+            email: str,
+            password: str,
+            is_tracim_manager: str='off',
+            is_tracim_admin: str='off',
+            send_email: str='off',
+    ):
         is_tracim_manager = h.on_off_to_boolean(is_tracim_manager)
         is_tracim_admin = h.on_off_to_boolean(is_tracim_admin)
+        send_email = h.on_off_to_boolean(send_email)
         current_user = tmpl_context.current_user
 
         if current_user.profile.id < Group.TIM_ADMIN:
@@ -313,6 +324,10 @@ class UserRestController(TIMRestController):
         user.display_name = name
         if password:
             user.password = password
+        elif send_email:
+            # Setup a random password to send email at user
+            password = str(uuid.uuid4())
+            user.password = password
         api.save(user)
 
         # Now add the user to related groups
@@ -325,6 +340,10 @@ class UserRestController(TIMRestController):
 
         api.save(user)
 
+        if send_email:
+            email_manager = get_email_manager()
+            email_manager.notify_created_account(user, password=password)
+
         tg.flash(_('User {} created.').format(user.get_display_name()), CST.STATUS_OK)
         tg.redirect(self.url())
 

tracim/tracim/lib/email.py

@@ -2,8 +2,14 @@
 
 from email.mime.multipart import MIMEMultipart
 import smtplib
+from email.mime.text import MIMEText
+
+from mako.template import Template
+from tgext.asyncjob import asyncjob_perform
+from tg.i18n import ugettext as _
 
 from tracim.lib.base import logger
+from tracim.model import User
 
 
 class SmtpConfiguration(object):
@@ -59,3 +65,118 @@ class EmailSender(object):
             self.connect() # Acutally, this connects to SMTP only if required
             logger.info(self, 'Sending email to {}'.format(message['To']))
             self._smtp_connection.send_message(message)
+
+
+class EmailManager(object):
+    def __init__(self, smtp_config: SmtpConfiguration, global_config):
+        self._smtp_config = smtp_config
+        self._global_config = global_config
+
+    def notify_created_account(
+            self,
+            user: User,
+            password: str,
+    ) -> None:
+        """
+        Send created account email to given user
+        :param password: choosed password
+        :param user: user to notify
+        """
+        # TODO BS 20160712: Cyclic import
+        from tracim.lib.notifications import EST
+
+        logger.debug(self, 'user: {}'.format(user.user_id))
+        logger.info(self, 'Sending asynchronous email to 1 user ({0})'.format(
+            user.email,
+        ))
+
+        async_email_sender = EmailSender(
+            self._smtp_config,
+            self._global_config.EMAIL_NOTIFICATION_ACTIVATED
+        )
+
+        subject = \
+            self._global_config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_SUBJECT \
+            .replace(
+                EST.WEBSITE_TITLE,
+                self._global_config.WEBSITE_TITLE.__str__()
+            )
+        message = MIMEMultipart('alternative')
+        message['Subject'] = subject
+        message['From'] = self._global_config.EMAIL_NOTIFICATION_FROM
+        message['To'] = user.email
+
+        text_template_file_path = self._global_config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT  # nopep8
+        html_template_file_path = self._global_config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML  # nopep8
+
+        body_text = self._render(
+            mako_template_filepath=text_template_file_path,
+            context={
+                'user': user,
+                'password': password,
+                'login_url': self._global_config.WEBSITE_BASE_URL,
+            }
+        )
+
+        body_html = self._render(
+            mako_template_filepath=html_template_file_path,
+            context={
+                'user': user,
+                'password': password,
+                'login_url': self._global_config.WEBSITE_BASE_URL,
+            }
+        )
+
+        part1 = MIMEText(body_text, 'plain', 'utf-8')
+        part2 = MIMEText(body_html, 'html', 'utf-8')
+
+        # Attach parts into message container.
+        # According to RFC 2046, the last part of a multipart message,
+        # in this case the HTML message, is best and preferred.
+        message.attach(part1)
+        message.attach(part2)
+
+        asyncjob_perform(async_email_sender.send_mail, message)
+
+        # Note: The following action allow to close the SMTP connection.
+        # This will work only if the async jobs are done in the right order
+        asyncjob_perform(async_email_sender.disconnect)
+
+    def _render(self, mako_template_filepath: str, context: dict):
+        """
+        Render mako template with all needed current variables
+        :param mako_template_filepath: file path of mako template
+        :param context: dict with template context
+        :return: template rendered string
+        """
+        # TODO - D.A. - 2014-11-06 - move this
+        # Import is here for circular import problem
+        import tracim.lib.helpers as helpers
+        from tracim.config.app_cfg import CFG
+
+        template = Template(filename=mako_template_filepath)
+        return template.render(
+            base_url=self._global_config.WEBSITE_BASE_URL,
+            _=_,
+            h=helpers,
+            CFG=CFG.get_instance(),
+            **context
+        )
+
+
+def get_email_manager():
+    """
+    :return: EmailManager instance
+    """
+    #  TODO: Find a way to import properly without cyclic import
+    from tracim.config.app_cfg import CFG
+
+    global_config = CFG.get_instance()
+    smtp_config = SmtpConfiguration(
+        global_config.EMAIL_NOTIFICATION_SMTP_SERVER,
+        global_config.EMAIL_NOTIFICATION_SMTP_PORT,
+        global_config.EMAIL_NOTIFICATION_SMTP_USER,
+        global_config.EMAIL_NOTIFICATION_SMTP_PASSWORD
+    )
+
+    return EmailManager(global_config=global_config, smtp_config=smtp_config)

tracim/tracim/templates/admin/user_getall.mak

@@ -61,6 +61,11 @@
                                         <input type="checkbox" class="checkbox" disabled name="is_tracim_admin" id="is-tracim-admin"> ${_('This user is an administrator')}
                                       </label>
                                     </div>
+                                    <div class="checkbox">
+                                      <label>
+                                        <input type="checkbox" class="checkbox" checked name="send_email" id="send-email"> ${_('Send email to user')}
+                                      </label>
+                                    </div>
                                         
                                     <span class="pull-right" style="margin-top: 0.5em;">
                                         <button type="submit" class="btn btn-small btn-success" title="Add first comment"><i class=" fa fa-check"></i> ${_('Validate')}</button>

tracim/tracim/templates/mail/created_account_body_html.mak

@@ -0,0 +1,88 @@
+## -*- coding: utf-8 -*-
+<html>
+  <head>
+    <style>
+      a { color: #3465af;}
+      a.call-to-action {
+        background: #3465af;
+        padding: 3px 4px 5px 4px;
+        border: 1px solid #12438d;
+        font-weight: bold;
+        color: #FFF;
+        text-decoration: none;
+        margin-left: 5px;
+      }
+      a.call-to-action img { vertical-align: middle;}
+      th { vertical-align: top;}
+      
+      #content-intro-username { font-size: 1.5em; color: #666; font-weight: bold; }
+      #content-intro { margin: 0; border: 1em solid #DDD; border-width: 0 0 0 0em; padding: 1em 1em 1em 1em; }
+      #content-body { margin: 0em; border: 2em solid #DDD; border-width: 0 0 0 4em; padding: 0.5em 2em 1em 1em; }
+      #content-body-intro { font-size: 2em; color: #666; }
+      #content-body-only-title { font-size: 1.5em; }
+
+      #content-body ins { background-color: #AFA; }
+      #content-body del { background-color: #FAA; }
+
+
+      #call-to-action-button { background-color: #5CB85C; border: 1px solid #4CAE4C; color: #FFF; text-decoration: none; font-weight: bold; border-radius: 3px; font-size: 2em; padding: 4px 0.3em;}
+      #call-to-action-container { text-align: right; margin-top: 2em; }
+
+      #footer hr { border: 0px solid #CCC; border-top-width: 1px; width: 8em; max-width:25%; margin-left: 0;}
+      #footer { color: #999; margin: 4em auto auto 0.5em; }
+      #footer a { color: #999; }
+    </style>
+  </head>
+  <body style="font-family: Arial; font-size: 12px; max-width: 600px; margin: 0; padding: 0;">
+
+    <table style="width: 100%; cell-padding: 0; border-collapse: collapse; margin: 0">
+      <tr style="background-color: F5F5F5; border-bottom: 1px solid #CCC;" >
+        <td style="background-color: #666;">
+          <img src="${base_url+'/assets/img/logo.png'}" style="vertical-align: middle;" alt=""/>
+        </td>
+        <td style="padding: 0.5em; background-color: #666; text-align: left;">
+          <span style="font-size: 1.3em; color: #FFF; font-weight: bold;">
+
+            ${CFG.WEBSITE_TITLE}: ${_('Created account')}
+
+          </span>
+        </td>
+      </tr>
+    </table>
+
+    <div id="content-body">
+        <div>
+            ${_('An administrator just create account for you on {website_title}'.format(
+                website_title=CFG.WEBSITE_TITLE
+            ))}
+
+            <ul>
+                <li>
+                    <b>${_('Login')}</b>: ${user.email}
+                </li>
+                <li>
+                    <b>${_('Password')}</b>: ${password}
+                </li>
+            </ul>
+
+        </div>
+        <div id="call-to-action-container">
+
+            ${_('To go to {website_title}, please click on following link'.format(
+                website_title=CFG.WEBSITE_TITLE
+            ))}
+
+            <span style="">
+                <a href="${login_url}" id='call-to-action-button'>${login_url}</a>
+            </span>
+        </div>
+    </div>
+    
+    <div id="footer">
+        <p>
+            ${_('This email was sent by <i>Tracim</i>, a collaborative software developped by Algoo.')}<br/>
+            Algoo SAS &mdash; 9 rue du rocher de Lorzier, 38430 Moirans, France &mdash; <a style="text-decoration: none;" href="http://algoo.fr">www.algoo.fr</a>
+        </p>
+    </div>
+  </body>
+</html>

tracim/tracim/templates/mail/created_account_body_text.mak

@@ -0,0 +1,25 @@
+## -*- coding: utf-8 -*-
+
+${_('An administrator just create account for you on {website_title}'.format(
+    website_title=CFG.WEBSITE_TITLE
+))}
+
+* ${_('Login')}: ${user.email}
+* ${_('Password')}: ${password}
+
+${_('To go to {website_title}, please click on following link'.format(
+    website_title=CFG.WEBSITE_TITLE
+))}
+
+${login_url}
+
+--------------------------------------------------------------------------------
+
+This email was sent by *Tracim*,
+a collaborative software developped by Algoo.
+
+**Algoo SAS**
+9 rue du rocher de Lorzier
+38430 Moirans
+France
+http://algoo.fr