Restore-mail-notifier WIP

setup.py

@@ -34,6 +34,11 @@ requires = [
     # others
     'filedepot',
     'babel',
+    # mail-notifier
+    'mako',
+    'lxml',
+    'redis',
+    'rq',
 ]
 
 tests_require = [

tracim/command/user.py

@@ -115,7 +115,7 @@ class UserCommand(AppContextCommand):
             password = ''
 
         try:
-            user = self._user_api.create_user(email=login)
+            user = self._user_api.create_minimal_user(email=login)
             user.password = password
             self._user_api.save(user)
             # TODO - G.M - 04-04-2018 - [Caldav] Check this code

tracim/config.py

@@ -4,6 +4,8 @@ from paste.deploy.converters import asbool
 from tracim.lib.utils.logger import logger
 from depot.manager import DepotManager
 
+from tracim.models.data import ActionDescription, ContentType
+
 
 class CFG(object):
     """Object used for easy access to config file parameters."""
@@ -131,87 +133,87 @@ class CFG(object):
         # TODO - G.M - 27-03-2018 - [Email] Restore email config
         ###
         # EMAIL related stuff (notification, reply)
-        ###
-        #
-        # self.EMAIL_NOTIFICATION_NOTIFIED_EVENTS = [
-        #     # ActionDescription.COMMENT,
-        #     # ActionDescription.CREATION,
-        #     # ActionDescription.EDITION,
-        #     # ActionDescription.REVISION,
-        #     # ActionDescription.STATUS_UPDATE
-        # ]
-        #
-        # self.EMAIL_NOTIFICATION_NOTIFIED_CONTENTS = [
-        #     # ContentType.Page,
-        #     # ContentType.Thread,
-        #     # ContentType.File,
-        #     # ContentType.Comment,
-        #     # ContentType.Folder -- Folder is skipped
-        # ]
-        # if settings.get('email.notification.from'):
-        #     raise Exception(
-        #         'email.notification.from configuration is deprecated. '
-        #         'Use instead email.notification.from.email and '
-        #         'email.notification.from.default_label.'
-        #     )
-        #
-        # self.EMAIL_NOTIFICATION_FROM_EMAIL = settings.get(
-        #     'email.notification.from.email',
-        # )
-        # self.EMAIL_NOTIFICATION_FROM_DEFAULT_LABEL = settings.get(
-        #     'email.notification.from.default_label'
-        # )
-        # self.EMAIL_NOTIFICATION_REPLY_TO_EMAIL = settings.get(
-        #     'email.notification.reply_to.email',
-        # )
-        # self.EMAIL_NOTIFICATION_REFERENCES_EMAIL = settings.get(
-        #     'email.notification.references.email'
-        # )
-        # self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_HTML = settings.get(
-        #     'email.notification.content_update.template.html',
-        # )
-        # self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_TEXT = settings.get(
-        #     'email.notification.content_update.template.text',
-        # )
-        # self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML = settings.get(
-        #     'email.notification.created_account.template.html',
-        #     './tracim/templates/mail/created_account_body_html.mak',
-        # )
-        # self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT = settings.get(
-        #     'email.notification.created_account.template.text',
-        #     './tracim/templates/mail/created_account_body_text.mak',
-        # )
-        # self.EMAIL_NOTIFICATION_CONTENT_UPDATE_SUBJECT = settings.get(
-        #     'email.notification.content_update.subject',
-        # )
-        # self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_SUBJECT = settings.get(
-        #     'email.notification.created_account.subject',
-        #     '[{website_title}] Created account',
-        # )
-        # self.EMAIL_NOTIFICATION_PROCESSING_MODE = settings.get(
-        #     'email.notification.processing_mode',
-        # )
-        #
+        ##
+
+        self.EMAIL_NOTIFICATION_NOTIFIED_EVENTS = [
+            ActionDescription.COMMENT,
+            ActionDescription.CREATION,
+            ActionDescription.EDITION,
+            ActionDescription.REVISION,
+            ActionDescription.STATUS_UPDATE
+        ]
+
+        self.EMAIL_NOTIFICATION_NOTIFIED_CONTENTS = [
+            ContentType.Page,
+            ContentType.Thread,
+            ContentType.File,
+            ContentType.Comment,
+            # ContentType.Folder -- Folder is skipped
+        ]
+        if settings.get('email.notification.from'):
+            raise Exception(
+                'email.notification.from configuration is deprecated. '
+                'Use instead email.notification.from.email and '
+                'email.notification.from.default_label.'
+            )
+
+        self.EMAIL_NOTIFICATION_FROM_EMAIL = settings.get(
+            'email.notification.from.email',
+        )
+        self.EMAIL_NOTIFICATION_FROM_DEFAULT_LABEL = settings.get(
+            'email.notification.from.default_label'
+        )
+        self.EMAIL_NOTIFICATION_REPLY_TO_EMAIL = settings.get(
+            'email.notification.reply_to.email',
+        )
+        self.EMAIL_NOTIFICATION_REFERENCES_EMAIL = settings.get(
+            'email.notification.references.email'
+        )
+        self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_HTML = settings.get(
+            'email.notification.content_update.template.html',
+        )
+        self.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_TEXT = settings.get(
+            'email.notification.content_update.template.text',
+        )
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML = settings.get(
+            'email.notification.created_account.template.html',
+            './tracim/templates/mail/created_account_body_html.mak',
+        )
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT = settings.get(
+            'email.notification.created_account.template.text',
+            './tracim/templates/mail/created_account_body_text.mak',
+        )
+        self.EMAIL_NOTIFICATION_CONTENT_UPDATE_SUBJECT = settings.get(
+            'email.notification.content_update.subject',
+        )
+        self.EMAIL_NOTIFICATION_CREATED_ACCOUNT_SUBJECT = settings.get(
+            'email.notification.created_account.subject',
+            '[{website_title}] Created account',
+        )
+        self.EMAIL_NOTIFICATION_PROCESSING_MODE = settings.get(
+            'email.notification.processing_mode',
+        )
+
         self.EMAIL_NOTIFICATION_ACTIVATED = asbool(settings.get(
             'email.notification.activated',
         ))
-        # self.EMAIL_NOTIFICATION_SMTP_SERVER = settings.get(
-        #     'email.notification.smtp.server',
-        # )
-        # self.EMAIL_NOTIFICATION_SMTP_PORT = settings.get(
-        #     'email.notification.smtp.port',
-        # )
-        # self.EMAIL_NOTIFICATION_SMTP_USER = settings.get(
-        #     'email.notification.smtp.user',
-        # )
-        # self.EMAIL_NOTIFICATION_SMTP_PASSWORD = settings.get(
-        #     'email.notification.smtp.password',
-        # )
-        # self.EMAIL_NOTIFICATION_LOG_FILE_PATH = settings.get(
-        #     'email.notification.log_file_path',
-        #     None,
-        # )
-        #
+        self.EMAIL_NOTIFICATION_SMTP_SERVER = settings.get(
+            'email.notification.smtp.server',
+        )
+        self.EMAIL_NOTIFICATION_SMTP_PORT = settings.get(
+            'email.notification.smtp.port',
+        )
+        self.EMAIL_NOTIFICATION_SMTP_USER = settings.get(
+            'email.notification.smtp.user',
+        )
+        self.EMAIL_NOTIFICATION_SMTP_PASSWORD = settings.get(
+            'email.notification.smtp.password',
+        )
+        self.EMAIL_NOTIFICATION_LOG_FILE_PATH = settings.get(
+            'email.notification.log_file_path',
+            None,
+        )
+
         # self.EMAIL_REPLY_ACTIVATED = asbool(settings.get(
         #     'email.reply.activated',
         #     False,
@@ -267,36 +269,36 @@ class CFG(object):
         #         mandatory_msg.format('email.reply.lockfile_path')
         #     )
         #
-        # self.EMAIL_PROCESSING_MODE = settings.get(
-        #     'email.processing_mode',
-        #     'sync',
-        # ).upper()
-        #
-        # if self.EMAIL_PROCESSING_MODE not in (
-        #         self.CST.ASYNC,
-        #         self.CST.SYNC,
-        # ):
-        #     raise Exception(
-        #         'email.processing_mode '
-        #         'can ''be "{}" or "{}", not "{}"'.format(
-        #             self.CST.ASYNC,
-        #             self.CST.SYNC,
-        #             self.EMAIL_PROCESSING_MODE,
-        #         )
-        #     )
-        #
-        # self.EMAIL_SENDER_REDIS_HOST = settings.get(
-        #     'email.async.redis.host',
-        #     'localhost',
-        # )
-        # self.EMAIL_SENDER_REDIS_PORT = int(settings.get(
-        #     'email.async.redis.port',
-        #     6379,
-        # ))
-        # self.EMAIL_SENDER_REDIS_DB = int(settings.get(
-        #     'email.async.redis.db',
-        #     0,
-        # ))
+        self.EMAIL_PROCESSING_MODE = settings.get(
+            'email.processing_mode',
+            'sync',
+        ).upper()
+
+        if self.EMAIL_PROCESSING_MODE not in (
+                self.CST.ASYNC,
+                self.CST.SYNC,
+        ):
+            raise Exception(
+                'email.processing_mode '
+                'can ''be "{}" or "{}", not "{}"'.format(
+                    self.CST.ASYNC,
+                    self.CST.SYNC,
+                    self.EMAIL_PROCESSING_MODE,
+                )
+            )
+
+        self.EMAIL_SENDER_REDIS_HOST = settings.get(
+            'email.async.redis.host',
+            'localhost',
+        )
+        self.EMAIL_SENDER_REDIS_PORT = int(settings.get(
+            'email.async.redis.port',
+            6379,
+        ))
+        self.EMAIL_SENDER_REDIS_DB = int(settings.get(
+            'email.async.redis.db',
+            0,
+        ))
 
         ###
         # WSGIDAV (Webdav server)

tracim/lib/core/content.py

@@ -376,7 +376,7 @@ class ContentApi(object):
 
         return result
 
-    def create(self, content_type: str, workspace: Workspace, parent: Content=None, label:str ='', do_save=False, is_temporary: bool=False) -> Content:
+    def create(self, content_type: str, workspace: Workspace, parent: Content=None, label:str ='', do_save=False, is_temporary: bool=False, do_notify=False) -> Content:
         assert content_type in ContentType.allowed_types()
 
         if content_type == ContentType.Folder and not label:
@@ -399,7 +399,7 @@ class ContentApi(object):
 
         if do_save:
             self._session.add(content)
-            self.save(content, ActionDescription.CREATION)
+            self.save(content, ActionDescription.CREATION, do_notify=do_notify)
         return content
 
 
@@ -1127,8 +1127,9 @@ class ContentApi(object):
         :return:
         """
         NotifierFactory.create(
-            self._config,
-            self._user
+            config=self._config,
+            current_user=self._user,
+            session=self._session,
         ).notify_content_update(content)
 
     def get_keywords(self, search_string, search_string_separators=None) -> [str]:

tracim/lib/core/notifications.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
+from sqlalchemy.orm import Session
 
+from tracim import CFG
 from tracim.lib.utils.logger import logger
 from tracim.models.auth import User
 from tracim.models.data import Content
@@ -9,7 +11,11 @@ class INotifier(object):
     """
     Interface for Notifier instances
     """
-    def __init__(self, config, current_user: User=None):
+    def __init__(self,
+                 config: CFG,
+                 session: Session,
+                 current_user: User=None,
+    ) -> None:
         pass
 
     def notify_content_update(self, content: Content):
@@ -19,17 +25,28 @@ class INotifier(object):
 class NotifierFactory(object):
 
     @classmethod
-    def create(cls, config, current_user: User=None) -> INotifier:
+    def create(cls, config, session, current_user: User=None) -> INotifier:
         if not config.EMAIL_NOTIFICATION_ACTIVATED:
-            return DummyNotifier(config, current_user)
-        return EmailNotifier(config, current_user)
+            return DummyNotifier(config, session, current_user)
+        from tracim.lib.mail_notifier.notifier import EmailNotifier
+        return EmailNotifier(config, session, current_user)
 
 
 class DummyNotifier(INotifier):
     send_count = 0
 
-    def __init__(self, config, current_user: User=None):
-        INotifier.__init__(config, current_user)
+    def __init__(
+            self,
+            config: CFG,
+            session: Session,
+            current_user: User=None
+    ) -> None:
+        INotifier.__init__(
+            self,
+            config,
+            session,
+            current_user,
+        )
         logger.info(self, 'Instantiating Dummy Notifier')
 
     def notify_content_update(self, content: Content):
@@ -38,8 +55,3 @@ class DummyNotifier(INotifier):
             self,
             'Fake notifier, do not send notification for update of content {}'.format(content.content_id)  # nopep8
         )
-
-
-class EmailNotifier(INotifier):
-    # TODO - G.M [emailNotif] move and restore Email Notifier in another file.
-    pass

tracim/lib/core/user.py

@@ -4,6 +4,7 @@ import threading
 import transaction
 import typing as typing
 
+from tracim.lib.mail_notifier.notifier import get_email_manager
 from tracim.models.auth import User
 
 
@@ -34,8 +35,9 @@ class UserApi(object):
             user: User,
             name: str=None,
             email: str=None,
-            do_save=True,
+            password: str=None,
             timezone: str='',
+            do_save=True,
     ):
         if name is not None:
             user.display_name = name
@@ -43,6 +45,9 @@ class UserApi(object):
         if email is not None:
             user.email = email
 
+        if password is not None:
+            user.password = password
+
         user.timezone = timezone
 
         if do_save:
@@ -56,7 +61,40 @@ class UserApi(object):
         except:
             return False
 
-    def create_user(self, email=None, groups=[], save_now=False) -> User:
+    def create_user(
+        self,
+        email: str = None,
+        password: str = None,
+        name: str = None,
+        timezone: str = '',
+        groups=[],
+        do_save: bool=True,
+        do_notify: bool=True,
+    ) -> User:
+        new_user = self.create_minimal_user(email, groups, save_now=False)
+        self.update(
+            user=new_user,
+            name=name,
+            email=email,
+            password=password,
+            timezone=timezone,
+            do_save=do_save,
+        )
+        if do_notify:
+            email_manager = get_email_manager(self._config, self._session)
+            email_manager.notify_created_account(
+                new_user,
+                password=password
+            )
+        return new_user
+
+    def create_minimal_user(
+            self,
+            email=None,
+            groups=[],
+            save_now=False
+    ) -> User:
+        """Previous create_user method"""
         user = User()
 
         if email:

tracim/lib/mail_notifier/daemon.py

@@ -0,0 +1,61 @@
+from sqlalchemy.orm import collections
+
+from tracim.lib.utils.logger import logger
+from tracim.lib.utils.utils import get_rq_queue
+from tracim.lib.utils.utils import get_redis_connection
+from rq.dummy import do_nothing
+from rq.worker import StopRequested
+from rq import Connection as RQConnection
+from rq import Worker as BaseRQWorker
+
+
+class FakeDaemon(object):
+    """
+    Temporary class for transition between tracim 1 and tracim 2
+    """
+    def __init__(self, config, *args, **kwargs):
+        pass
+
+
+class MailSenderDaemon(FakeDaemon):
+    # NOTE: use *args and **kwargs because parent __init__ use strange
+    # * parameter
+    def __init__(self, config, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.config = config
+        self.worker = None  # type: RQWorker
+
+    def append_thread_callback(self, callback: collections.Callable) -> None:
+        logger.warning('MailSenderDaemon not implement append_thread_callback')
+        pass
+
+    def stop(self) -> None:
+        # When _stop_requested at False, tracim.lib.daemons.RQWorker
+        # will raise StopRequested exception in worker thread after receive a
+        # job.
+        self.worker._stop_requested = True
+        redis_connection = get_redis_connection(self.config)
+        queue = get_rq_queue(redis_connection, 'mail_sender')
+        queue.enqueue(do_nothing)
+
+    def run(self) -> None:
+
+        with RQConnection(get_redis_connection(self.config)):
+            self.worker = RQWorker(['mail_sender'])
+            self.worker.work()
+
+
+class RQWorker(BaseRQWorker):
+    def _install_signal_handlers(self):
+        # RQ Worker is designed to work in main thread
+        # So we have to disable these signals (we implement server stop in
+        # MailSenderDaemon.stop method).
+        pass
+
+    def dequeue_job_and_maintain_ttl(self, timeout):
+        # RQ Worker is designed to work in main thread, so we add behaviour
+        # here: if _stop_requested has been set to True, raise the standard way
+        # StopRequested exception to stop worker.
+        if self._stop_requested:
+            raise StopRequested()
+        return super().dequeue_job_and_maintain_ttl(timeout)

tracim/lib/mail_notifier/notifier.py

@@ -0,0 +1,556 @@
+# -*- coding: utf-8 -*-
+import datetime
+import typing
+
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import formataddr
+
+from lxml.html.diff import htmldiff
+from mako.template import Template
+from sqlalchemy.orm import Session
+
+from tracim import CFG
+from tracim.lib.core.notifications import INotifier
+from tracim.lib.mail_notifier.sender import EmailSender
+from tracim.lib.mail_notifier.utils import SmtpConfiguration, EST
+from tracim.lib.mail_notifier.sender import send_email_through
+from tracim.lib.core.workspace import WorkspaceApi
+from tracim.lib.utils.logger import logger
+from tracim.models import User
+from tracim.models.auth import User
+from tracim.models.data import ActionDescription
+from tracim.models.data import Content
+from tracim.models.data import ContentType
+from tracim.models.data import UserRoleInWorkspace
+from tracim.lib.utils.translation import fake_translator as l_, \
+    fake_translator as _
+
+
+class EmailNotifier(INotifier):
+    """
+    EmailNotifier, this class will decide how to notify by mail
+    in order to let a EmailManager create email
+    """
+
+    def __init__(
+            self,
+            config: CFG,
+            session: Session,
+            current_user: User=None
+    ):
+        """
+        :param current_user: the user that has triggered the notification
+        :return:
+        """
+        INotifier.__init__(self, config, session, current_user)
+        logger.info(self, 'Instantiating Email Notifier')
+
+        self._user = current_user
+        self.session = session
+        self.config = config
+        self._smtp_config = SmtpConfiguration(
+            self.config.EMAIL_NOTIFICATION_SMTP_SERVER,
+            self.config.EMAIL_NOTIFICATION_SMTP_PORT,
+            self.config.EMAIL_NOTIFICATION_SMTP_USER,
+            self.config.EMAIL_NOTIFICATION_SMTP_PASSWORD
+        )
+
+    def notify_content_update(self, content: Content):
+
+        if content.get_last_action().id not \
+                in self.config.EMAIL_NOTIFICATION_NOTIFIED_EVENTS:
+            logger.info(
+                self,
+                'Skip email notification for update of content {}'
+                'by user {} (the action is {})'.format(
+                    content.content_id,
+                    # below: 0 means "no user"
+                    self._user.user_id if self._user else 0,
+                    content.get_last_action().id
+                )
+            )
+            return
+
+        logger.info(self,
+                    'About to email-notify update'
+                    'of content {} by user {}'.format(
+                        content.content_id,
+                        # Below: 0 means "no user"
+                        self._user.user_id if self._user else 0
+                    )
+        )
+
+        if content.type not \
+                in self.config.EMAIL_NOTIFICATION_NOTIFIED_CONTENTS:
+            logger.info(
+                self,
+                'Skip email notification for update of content {}'
+                'by user {} (the content type is {})'.format(
+                    content.type,
+                    # below: 0 means "no user"
+                    self._user.user_id if self._user else 0,
+                    content.get_last_action().id
+                )
+            )
+            return
+
+        logger.info(self,
+                    'About to email-notify update'
+                    'of content {} by user {}'.format(
+                        content.content_id,
+                        # Below: 0 means "no user"
+                        self._user.user_id if self._user else 0
+                    )
+        )
+
+        ####
+        #
+        # INFO - D.A. - 2014-11-05 - Emails are sent through asynchronous jobs.
+        # For that reason, we do not give SQLAlchemy objects but ids only
+        # (SQLA objects are related to a given thread/session)
+        #
+        try:
+            if self.config.EMAIL_NOTIFICATION_PROCESSING_MODE.lower() == self.config.CST.ASYNC.lower():
+                logger.info(self, 'Sending email in ASYNC mode')
+                # TODO - D.A - 2014-11-06
+                # This feature must be implemented in order to be able to scale to large communities
+                raise NotImplementedError('Sending emails through ASYNC mode is not working yet')
+            else:
+                logger.info(self, 'Sending email in SYNC mode')
+                EmailManager(
+                    self._smtp_config,
+                    self.config,
+                    self.session,
+                ).notify_content_update(self._user.user_id, content.content_id)
+        except TypeError as e:
+            logger.error(self, 'Exception catched during email notification: {}'.format(e.__str__()))
+
+
+class EmailManager(object):
+    """
+    Compared to Notifier, this class is independant from the HTTP request thread
+    This class will build Email and send it for both created account and content
+    update
+    """
+
+    def __init__(
+            self,
+            smtp_config: SmtpConfiguration,
+            config: CFG,
+            session: Session
+    ) -> None:
+        self._smtp_config = smtp_config
+        self.config = config
+        self.session = session
+        # FIXME - G.M - We need to have a session for the emailNotifier
+
+        # if not self.session:
+        #     engine = get_engine(settings)
+        #     session_factory = get_session_factory(engine)
+        #     app_config = CFG(settings)
+
+    def _get_sender(self, user: User=None) -> str:
+        """
+        Return sender string like "Bob Dylan
+            (via Tracim) <notification@mail.com>"
+        :param user: user to extract display name
+        :return: sender string
+        """
+
+        email_template = self.config.EMAIL_NOTIFICATION_FROM_EMAIL
+        mail_sender_name = self.config.EMAIL_NOTIFICATION_FROM_DEFAULT_LABEL  # nopep8
+        if user:
+            mail_sender_name = '{name} via Tracim'.format(name=user.display_name)
+            email_address = email_template.replace('{user_id}', str(user.user_id))
+            # INFO - D.A. - 2017-08-04
+            # We use email_template.replace() instead of .format() because this
+            # method is more robust to errors in config file.
+            #
+            # For example, if the email is info+{userid}@tracim.fr
+            # email.format(user_id='bob') will raise an exception
+            # email.replace('{user_id}', 'bob') will just ignore {userid}
+        else:
+            email_address = email_template.replace('{user_id}', '0')
+
+        return formataddr((mail_sender_name, email_address))
+
+    # Content Notification
+
+    @staticmethod
+    def log_notification(
+            config: CFG,
+            action: str,
+            recipient: typing.Optional[str],
+            subject: typing.Optional[str],
+    ) -> None:
+        """Log notification metadata."""
+        log_path = config.EMAIL_NOTIFICATION_LOG_FILE_PATH
+        if log_path:
+            # TODO - A.P - 2017-09-06 - file logging inefficiency
+            # Updating a document with 100 users to notify will leads to open
+            # and close the file 100 times.
+            with open(log_path, 'a') as log_file:
+                print(
+                    datetime.datetime.now(),
+                    action,
+                    recipient,
+                    subject,
+                    sep='|',
+                    file=log_file,
+                )
+
+    def notify_content_update(
+            self,
+            event_actor_id: int,
+            event_content_id: int
+    ) -> None:
+        """
+        Look for all users to be notified about the new content and send them an
+        individual email
+        :param event_actor_id: id of the user that has triggered the event
+        :param event_content_id: related content_id
+        :return:
+        """
+        # FIXME - D.A. - 2014-11-05
+        # Dirty import. It's here in order to avoid circular import
+        from tracim.lib.core.content import ContentApi
+        from tracim.lib.core.user import UserApi
+        user = UserApi(
+            None,
+            config=self.config,
+            session=self.session,
+            ).get_one(event_actor_id)
+        logger.debug(self, 'Content: {}'.format(event_content_id))
+        content_api = ContentApi(
+            current_user=user,
+            session=self.session,
+            config=self.config,
+            )
+        content = ContentApi(
+            session=self.session,
+            current_user=user, # TODO - use a system user instead of the user that has triggered the event
+            config=self.config,
+            show_archived=True,
+            show_deleted=True,
+        ).get_one(event_content_id, ContentType.Any)
+        main_content = content.parent if content.type == ContentType.Comment else content
+        notifiable_roles = WorkspaceApi(
+            current_user=user,
+            session=self.session,
+        ).get_notifiable_roles(content.workspace)
+
+        if len(notifiable_roles) <= 0:
+            logger.info(self, 'Skipping notification as nobody subscribed to in workspace {}'.format(content.workspace.label))
+            return
+
+
+        logger.info(self, 'Sending asynchronous emails to {} user(s)'.format(len(notifiable_roles)))
+        # INFO - D.A. - 2014-11-06
+        # The following email sender will send emails in the async task queue
+        # This allow to build all mails through current thread but really send them (including SMTP connection)
+        # In the other thread.
+        #
+        # This way, the webserver will return sooner (actually before notification emails are sent
+        async_email_sender = EmailSender(
+            self.config,
+            self._smtp_config,
+            self.config.EMAIL_NOTIFICATION_ACTIVATED
+        )
+        for role in notifiable_roles:
+            logger.info(self, 'Sending email to {}'.format(role.user.email))
+            to_addr = formataddr((role.user.display_name, role.user.email))
+            #
+            # INFO - G.M - 2017-11-15 - set content_id in header to permit reply
+            # references can have multiple values, but only one in this case.
+            replyto_addr = self.config.EMAIL_NOTIFICATION_REPLY_TO_EMAIL.replace( # nopep8
+                '{content_id}',str(content.content_id)
+            )
+
+            reference_addr = self.config.EMAIL_NOTIFICATION_REFERENCES_EMAIL.replace( #nopep8
+                '{content_id}',str(content.content_id)
+             )
+            #
+            #  INFO - D.A. - 2014-11-06
+            # We do not use .format() here because the subject defined in the .ini file
+            # may not include all required labels. In order to avoid partial format() (which result in an exception)
+            # we do use replace and force the use of .__str__() in order to process LazyString objects
+            #
+            subject = self.config.EMAIL_NOTIFICATION_CONTENT_UPDATE_SUBJECT
+            subject = subject.replace(EST.WEBSITE_TITLE, self.config.WEBSITE_TITLE.__str__())
+            subject = subject.replace(EST.WORKSPACE_LABEL, main_content.workspace.label.__str__())
+            subject = subject.replace(EST.CONTENT_LABEL, main_content.label.__str__())
+            subject = subject.replace(EST.CONTENT_STATUS_LABEL, main_content.get_status().label.__str__())
+            reply_to_label = l_('{username} & all members of {workspace}').format(
+                username=user.display_name,
+                workspace=main_content.workspace.label)
+
+            message = MIMEMultipart('alternative')
+            message['Subject'] = subject
+            message['From'] = self._get_sender(user)
+            message['To'] = to_addr
+            message['Reply-to'] = formataddr((reply_to_label, replyto_addr))
+            # INFO - G.M - 2017-11-15
+            # References can theorically have label, but in pratice, references
+            # contains only message_id from parents post in thread.
+            # To link this email to a content we create a virtual parent
+            # in reference who contain the content_id.
+            message['References'] = formataddr(('',reference_addr))
+            body_text = self._build_email_body_for_content(self.config.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_TEXT, role, content, user)
+            body_html = self._build_email_body_for_content(self.config.EMAIL_NOTIFICATION_CONTENT_UPDATE_TEMPLATE_HTML, role, content, user)
+
+            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)
+
+            self.log_notification(
+                action='CREATED',
+                recipient=message['To'],
+                subject=message['Subject'],
+                config=self.config,
+            )
+
+            send_email_through(
+                self.config,
+                async_email_sender.send_mail,
+                message
+            )
+
+    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
+        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.config,
+            self._smtp_config,
+            self.config.EMAIL_NOTIFICATION_ACTIVATED
+        )
+
+        subject = \
+            self.config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_SUBJECT \
+            .replace(
+                EST.WEBSITE_TITLE,
+                self.config.WEBSITE_TITLE.__str__()
+            )
+        message = MIMEMultipart('alternative')
+        message['Subject'] = subject
+        message['From'] = self._get_sender()
+        message['To'] = formataddr((user.get_display_name(), user.email))
+
+        text_template_file_path = self.config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_TEXT  # nopep8
+        html_template_file_path = self.config.EMAIL_NOTIFICATION_CREATED_ACCOUNT_TEMPLATE_HTML  # nopep8
+
+        body_text = self._render_template(
+            mako_template_filepath=text_template_file_path,
+            context={
+                'user': user,
+                'password': password,
+                'login_url': self.config.WEBSITE_BASE_URL,
+            }
+        )
+
+        body_html = self._render_template(
+            mako_template_filepath=html_template_file_path,
+            context={
+                'user': user,
+                'password': password,
+                'login_url': self.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)
+
+        send_email_through(
+            config=self.config,
+            sendmail_callable=async_email_sender.send_mail,
+            message=message
+        )
+
+    def _render_template(
+            self,
+            mako_template_filepath: str,
+            context: dict
+    ) -> str:
+        """
+        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
+        """
+
+        template = Template(filename=mako_template_filepath)
+        return template.render(
+            _=_,
+            config=self.config,
+            **context
+        )
+
+    def _build_email_body_for_content(
+            self,
+            mako_template_filepath: str,
+            role: UserRoleInWorkspace,
+            content: Content,
+            actor: User
+    ) -> str:
+        """
+        Build an email body and return it as a string
+        :param mako_template_filepath: the absolute path to the mako template to be used for email body building
+        :param role: the role related to user to whom the email must be sent. The role is required (and not the user only) in order to show in the mail why the user receive the notification
+        :param content: the content item related to the notification
+        :param actor: the user at the origin of the action / notification (for example the one who wrote a comment
+        :param config: the global configuration
+        :return: the built email body as string. In case of multipart email, this method must be called one time for text and one time for html
+        """
+        logger.debug(self, 'Building email content from MAKO template {}'.format(mako_template_filepath))
+
+        main_title = content.label
+        content_intro = ''
+        content_text = ''
+        call_to_action_text = ''
+
+        action = content.get_last_action().id
+        if ActionDescription.COMMENT == action:
+            content_intro = l_('<span id="content-intro-username">{}</span> added a comment:').format(actor.display_name)
+            content_text = content.description
+            call_to_action_text = l_('Answer')
+
+        elif ActionDescription.CREATION == action:
+
+            # Default values (if not overriden)
+            content_text = content.description
+            call_to_action_text = l_('View online')
+
+            if ContentType.Thread == content.type:
+                call_to_action_text = l_('Answer')
+                content_intro = l_('<span id="content-intro-username">{}</span> started a thread entitled:').format(actor.display_name)
+                content_text = '<p id="content-body-intro">{}</p>'.format(content.label) + \
+                               content.get_last_comment_from(actor).description
+
+            elif ContentType.File == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> added a file entitled:').format(actor.display_name)
+                if content.description:
+                    content_text = content.description
+                else:
+                    content_text = '<span id="content-body-only-title">{}</span>'.format(content.label)
+
+            elif ContentType.Page == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> added a page entitled:').format(actor.display_name)
+                content_text = '<span id="content-body-only-title">{}</span>'.format(content.label)
+
+        elif ActionDescription.REVISION == action:
+            content_text = content.description
+            call_to_action_text = l_('View online')
+
+            if ContentType.File == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> uploaded a new revision.').format(actor.display_name)
+                content_text = ''
+
+            elif ContentType.Page == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> updated this page.').format(actor.display_name)
+                previous_revision = content.get_previous_revision()
+                title_diff = ''
+                if previous_revision.label != content.label:
+                    title_diff = htmldiff(previous_revision.label, content.label)
+                content_text = str(l_('<p id="content-body-intro">Here is an overview of the changes:</p>'))+ \
+                    title_diff + \
+                    htmldiff(previous_revision.description, content.description)
+
+            elif ContentType.Thread == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> updated the thread description.').format(actor.display_name)
+                previous_revision = content.get_previous_revision()
+                title_diff = ''
+                if previous_revision.label != content.label:
+                    title_diff = htmldiff(previous_revision.label, content.label)
+                content_text = str(l_('<p id="content-body-intro">Here is an overview of the changes:</p>'))+ \
+                    title_diff + \
+                    htmldiff(previous_revision.description, content.description)
+
+        elif ActionDescription.EDITION == action:
+            call_to_action_text = l_('View online')
+
+            if ContentType.File == content.type:
+                content_intro = l_('<span id="content-intro-username">{}</span> updated the file description.').format(actor.display_name)
+                content_text = '<p id="content-body-intro">{}</p>'.format(content.get_label()) + \
+                    content.description
+
+        elif ActionDescription.STATUS_UPDATE == action:
+            call_to_action_text = l_('View online')
+            intro_user_msg = l_(
+                '<span id="content-intro-username">{}</span> '
+                'updated the following status:'
+            )
+            content_intro = intro_user_msg.format(actor.display_name)
+            intro_body_msg = '<p id="content-body-intro">{}: {}</p>'
+            content_text = intro_body_msg.format(
+                content.get_label(),
+                content.get_status().label,
+            )
+
+        if '' == content_intro and content_text == '':
+            # Skip notification, but it's not normal
+            logger.error(
+                self, 'A notification is being sent but no content. '
+                      'Here are some debug informations: [content_id: {cid}]'
+                      '[action: {act}][author: {actor}]'.format(
+                    cid=content.content_id, act=action, actor=actor
+                )
+            )
+            raise ValueError('Unexpected empty notification')
+
+        user = role.user
+        workspace = role.workspace
+        body_content = self._render_template(
+            mako_template_filepath=mako_template_filepath,
+            context={
+                'user': role.user,
+                'workspace': role.workspace,
+                'main_title': main_title,
+                'status': content.get_status().label,
+                'role': role.role_as_label(),
+                'content_intro': content_intro,
+                'content_text': content_text,
+                'call_to_action_text': call_to_action_text,
+            }
+        )
+        return body_content
+
+
+def get_email_manager(config: CFG, session: Session):
+    """
+    :return: EmailManager instance
+    """
+    #  TODO: Find a way to import properly without cyclic import
+
+    smtp_config = SmtpConfiguration(
+        config.EMAIL_NOTIFICATION_SMTP_SERVER,
+        config.EMAIL_NOTIFICATION_SMTP_PORT,
+        config.EMAIL_NOTIFICATION_SMTP_USER,
+        config.EMAIL_NOTIFICATION_SMTP_PASSWORD
+    )
+
+    return EmailManager(config=config, smtp_config=smtp_config, session=session)

tracim/lib/mail_notifier/sender.py

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+import smtplib
+import typing
+from email.message import Message
+from email.mime.multipart import MIMEMultipart
+
+from tracim.config import CFG
+from tracim.lib.utils.logger import logger
+from tracim.lib.utils.utils import get_rq_queue
+from tracim.lib.utils.utils import get_redis_connection
+from tracim.lib.mail_notifier.utils import SmtpConfiguration
+
+def send_email_through(
+        config: CFG,
+        sendmail_callable: typing.Callable[[Message], None],
+        message: Message,
+) -> None:
+    """
+    Send mail encapsulation to send it in async or sync mode.
+
+    TODO BS 20170126: A global mail/sender management should be a good
+                      thing. Actually, this method is an fast solution.
+    :param config: system configuration
+    :param sendmail_callable: A callable who get message on first parameter
+    :param message: The message who have to be sent
+    """
+
+    if config.EMAIL_PROCESSING_MODE == config.CST.SYNC:
+        sendmail_callable(message)
+    elif config.EMAIL_PROCESSING_MODE == config.CST.ASYNC:
+        redis_connection = get_redis_connection(config)
+        queue = get_rq_queue(redis_connection, 'mail_sender')
+        queue.enqueue(sendmail_callable, message)
+    else:
+        raise NotImplementedError(
+            'Mail sender processing mode {} is not implemented'.format(
+                config.EMAIL_PROCESSING_MODE,
+            )
+        )
+
+
+class EmailSender(object):
+    """
+    Independent email sender class.
+
+    To allow its use in any thread, as an asyncjob_perform() call for
+    example, it has no dependencies on SQLAlchemy nor tg HTTP request.
+    """
+
+    def __init__(
+            self,
+            config: CFG,
+            smtp_config: SmtpConfiguration,
+            really_send_messages
+    ) -> None:
+        self._smtp_config = smtp_config
+        self.config = config
+        self._smtp_connection = None
+        self._is_active = really_send_messages
+
+    def connect(self):
+        if not self._smtp_connection:
+            log = 'Connecting from SMTP server {}'
+            logger.info(self, log.format(self._smtp_config.server))
+            self._smtp_connection = smtplib.SMTP(
+                self._smtp_config.server,
+                self._smtp_config.port
+            )
+            self._smtp_connection.ehlo()
+
+            if self._smtp_config.login:
+                try:
+                    starttls_result = self._smtp_connection.starttls()
+                    log = 'SMTP start TLS result: {}'
+                    logger.debug(self, log.format(starttls_result))
+                except Exception as e:
+                    log = 'SMTP start TLS error: {}'
+                    logger.debug(self, log.format(e.__str__()))
+
+            if self._smtp_config.login:
+                try:
+                    login_res = self._smtp_connection.login(
+                        self._smtp_config.login,
+                        self._smtp_config.password
+                    )
+                    log = 'SMTP login result: {}'
+                    logger.debug(self, log.format(login_res))
+                except Exception as e:
+                    log = 'SMTP login error: {}'
+                    logger.debug(self, log.format(e.__str__()))
+            logger.info(self, 'Connection OK')
+
+    def disconnect(self):
+        if self._smtp_connection:
+            log = 'Disconnecting from SMTP server {}'
+            logger.info(self, log.format(self._smtp_config.server))
+            self._smtp_connection.quit()
+            logger.info(self, 'Connection closed.')
+
+    def send_mail(self, message: MIMEMultipart):
+        if not self._is_active:
+            log = 'Not sending email to {} (service disabled)'
+            logger.info(self, log.format(message['To']))
+        else:
+            self.connect()  # Actually, this connects to SMTP only if required
+            logger.info(self, 'Sending email to {}'.format(message['To']))
+            self._smtp_connection.send_message(message)
+            from tracim.lib.mail_notifier.notifier import EmailManager
+            EmailManager.log_notification(
+                action='   SENT',
+                recipient=message['To'],
+                subject=message['Subject'],
+                config=self.config,
+            )

tracim/lib/mail_notifier/utils.py

@@ -0,0 +1,33 @@
+class SmtpConfiguration(object):
+    """Container class for SMTP configuration used in Tracim."""
+
+    def __init__(self, server: str, port: int, login: str, password: str):
+        self.server = server
+        self.port = port
+        self.login = login
+        self.password = password
+
+
+class EST(object):
+    """
+    EST = Email Subject Tags - this is a convenient class - no business logic
+    here
+    This class is intended to agregate all dynamic content that may be included
+    in email subjects
+    """
+
+    WEBSITE_TITLE = '{website_title}'
+    WORKSPACE_LABEL = '{workspace_label}'
+    CONTENT_LABEL = '{content_label}'
+    CONTENT_STATUS_LABEL = '{content_status_label}'
+
+    @classmethod
+    def all(cls):
+        return [
+            cls.CONTENT_LABEL,
+            cls.CONTENT_STATUS_LABEL,
+            cls.WEBSITE_TITLE,
+            cls.WORKSPACE_LABEL
+        ]
+
+

tracim/lib/utils/utils.py

@@ -1,10 +1,35 @@
 # -*- coding: utf-8 -*-
 import datetime
+from redis import Redis
+from rq import Queue
+
+from tracim.config import CFG
 
 DEFAULT_WEBDAV_CONFIG_FILE = "wsgidav.conf"
 DEFAULT_TRACIM_CONFIG_FILE = "development.ini"
 
 
+def get_redis_connection(config: CFG) -> Redis:
+    """
+    :param config: current app_config
+    :return: redis connection
+    """
+    return Redis(
+        host=config.EMAIL_SENDER_REDIS_HOST,
+        port=config.EMAIL_SENDER_REDIS_PORT,
+        db=config.EMAIL_SENDER_REDIS_DB,
+    )
+
+
+def get_rq_queue(redis_connection: Redis, queue_name: str ='default') -> Queue:
+    """
+    :param queue_name: name of queue
+    :return: wanted queue
+    """
+
+    return Queue(name=queue_name, connection=redis_connection)
+
+
 def cmp_to_key(mycmp):
     """
     List sort related function

tracim/models/data.py

@@ -131,12 +131,12 @@ class UserRoleInWorkspace(DeclarativeBase):
     WORKSPACE_MANAGER = 8
 
     # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
-    # LABEL = dict()
-    # LABEL[0] = l_('N/A')
-    # LABEL[1] = l_('Reader')
-    # LABEL[2] = l_('Contributor')
-    # LABEL[4] = l_('Content Manager')
-    # LABEL[8] = l_('Workspace Manager')
+    LABEL = dict()
+    LABEL[0] = l_('N/A')
+    LABEL[1] = l_('Reader')
+    LABEL[2] = l_('Contributor')
+    LABEL[4] = l_('Content Manager')
+    LABEL[8] = l_('Workspace Manager')
     #
     # STYLE = dict()
     # STYLE[0] = ''
@@ -161,8 +161,9 @@ class UserRoleInWorkspace(DeclarativeBase):
     # def style(self):
     #     return UserRoleInWorkspace.STYLE[self.role]
     #
-    # def role_as_label(self):
-    #     return UserRoleInWorkspace.LABEL[self.role]
+
+    def role_as_label(self):
+        return UserRoleInWorkspace.LABEL[self.role]
 
     @classmethod
     def get_all_role_values(self):
@@ -318,6 +319,7 @@ class ContentStatus(object):
                  # type=''
     ):
         self.id = id
+        self.label = self.id
         # TODO - G.M - 10-04-2018 - [Cleanup] Drop this
         # self.icon = ContentStatus._ICONS[id]
         # self.css = ContentStatus._CSS[id]

tracim/templates/mail/content_update_body_html.mak

@@ -0,0 +1,72 @@
+## -*- 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;">
+            FIXME restore logo
+        </td>
+        <td style="padding: 0.5em; background-color: #666; text-align: left;">
+          <span style="font-size: 1.3em; color: #FFF; font-weight: bold;">
+            ${main_title}
+            &mdash;&nbsp;<span style="font-weight: bold; color: #999; font-weight: bold;">
+              ${status|n}
+              FIXME restore icon
+            </span>
+        </td>
+      </tr>
+    </table>
+
+    <p id="content-intro">${content_intro|n}</p>
+    <div id="content-body">
+        <div>${content_text|n}</div>
+        <div href="FIXME url" id="call-to-action-container">
+        </div>
+    </div>
+    
+    <div id="footer">
+        <p>
+            ${_('{user_display_name}, you receive this email because you are registered on <i>{website_title}</i> and you are <i>{user_role_label}</i> in the workspace <a href="{workspace_url}">{workspace_label}</a>.').format(user_display_name=user.display_name, user_role_label=role, workspace_url='FIXME url', workspace_label=workspace.label, website_title=config.WEBSITE_TITLE)|n}
+        </p>
+        <hr/>
+        <p>
+            ${_('This email was automatically 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/templates/mail/content_update_body_text.mak

@@ -0,0 +1,32 @@
+## -*- coding: utf-8 -*-
+
+Dear ${user.display_name},
+
+This email is intended to be read as HTML content.
+Please configure your email client to get the best of Tracim notifications.
+
+We understand that Email was originally intended to carry raw text only.
+And you probably understand on your own that we are a decades after email
+was created ;)
+
+Hope you'll switch your mail client configuration and enjoy Tracim :)
+
+
+--------------------------------------------------------------------------------
+
+
+You receive this email because you are registered on /${config.WEBSITE_TITLE}/
+and you are /${role}/ in the workspace /${workspace.label}/
+
+----
+
+This email was automatically sent by *Tracim*,
+a collaborative software developped by Algoo.
+
+FIXME ADDR
+**Algoo SAS**
+9 rue du rocher de Lorzier
+38430 Moirans
+France
+http://algoo.fr
+

tracim/templates/mail/created_account_body_html.mak

@@ -0,0 +1,89 @@
+## -*- 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;">
+            FIXME restore logo
+        </td>
+        <td style="padding: 0.5em; background-color: #666; text-align: left;">
+          <span style="font-size: 1.3em; color: #FFF; font-weight: bold;">
+
+            ${config.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=config.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=config.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/>
+            FIXME ADDR
+            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/templates/mail/created_account_body_text.mak

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

tracim/tests/library/test_content_api.py

@@ -112,8 +112,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
         workspace = WorkspaceApi(
             current_user=user,
             session=self.session
@@ -189,8 +189,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
         workspace_api = WorkspaceApi(current_user=user, session=self.session)
         workspace = workspace_api.create_workspace(
             'test workspace',
@@ -274,7 +274,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(
+        user = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
@@ -331,8 +331,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
         workspace = WorkspaceApi(
             current_user=user,
             session=self.session
@@ -400,8 +400,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,
@@ -438,8 +438,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,
@@ -480,8 +480,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,
@@ -522,12 +522,12 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(
+        user = uapi.create_minimal_user(
             email='user1@user',
             groups=groups,
             save_now=True
         )
-        user2 = uapi.create_user(
+        user2 = uapi.create_minimal_user(
             email='user2@user',
             groups=groups,
             save_now=True
@@ -634,12 +634,12 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(
+        user = uapi.create_minimal_user(
             email='user1@user',
             groups=groups,
             save_now=True
         )
-        user2 = uapi.create_user(
+        user2 = uapi.create_minimal_user(
             email='user2@user',
             groups=groups,
             save_now=True
@@ -744,12 +744,12 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(
+        user = uapi.create_minimal_user(
             email='user1@user',
             groups=groups,
             save_now=True,
         )
-        user2 = uapi.create_user(
+        user2 = uapi.create_minimal_user(
             email='user2@user',
             groups=groups,
             save_now=True
@@ -843,10 +843,10 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user_a = uapi.create_user(email='this.is@user',
-                                  groups=groups, save_now=True)
-        user_b = uapi.create_user(email='this.is@another.user',
-                                  groups=groups, save_now=True)
+        user_a = uapi.create_minimal_user(email='this.is@user',
+                                          groups=groups, save_now=True)
+        user_b = uapi.create_minimal_user(email='this.is@another.user',
+                                          groups=groups, save_now=True)
 
         wapi = WorkspaceApi(
             current_user=user_a,
@@ -946,12 +946,12 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user_a = uapi.create_user(
+        user_a = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
         )
-        user_b = uapi.create_user(
+        user_b = uapi.create_minimal_user(
             email='this.is@another.user',
             groups=groups,
             save_now=True
@@ -1009,12 +1009,12 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user_a = uapi.create_user(
+        user_a = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
         )
-        user_b = uapi.create_user(
+        user_b = uapi.create_minimal_user(
             email='this.is@another.user',
             groups=groups,
             save_now=True
@@ -1102,7 +1102,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
@@ -1116,7 +1116,7 @@ class TestContentApi(DefaultTest):
         
         wid = workspace.workspace_id
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1223,7 +1223,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True,
@@ -1237,7 +1237,7 @@ class TestContentApi(DefaultTest):
             save_now=True
         )
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1301,7 +1301,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
@@ -1314,7 +1314,7 @@ class TestContentApi(DefaultTest):
         )
         wid = workspace.workspace_id
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1415,7 +1415,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True,
@@ -1427,7 +1427,7 @@ class TestContentApi(DefaultTest):
             save_now=True
         )
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1494,7 +1494,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
@@ -1508,7 +1508,7 @@ class TestContentApi(DefaultTest):
         )
         wid = workspace.workspace_id
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1643,7 +1643,7 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user1 = uapi.create_user(
+        user1 = uapi.create_minimal_user(
             email='this.is@user',
             groups=groups,
             save_now=True
@@ -1657,7 +1657,7 @@ class TestContentApi(DefaultTest):
         )
         wid = workspace.workspace_id
 
-        user2 = uapi.create_user()
+        user2 = uapi.create_minimal_user()
         user2.email = 'this.is@another.user'
         uapi.save(user2)
 
@@ -1793,8 +1793,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,
@@ -1848,8 +1848,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,
@@ -1899,8 +1899,8 @@ class TestContentApi(DefaultTest):
                   group_api.get_one(Group.TIM_MANAGER),
                   group_api.get_one(Group.TIM_ADMIN)]
 
-        user = uapi.create_user(email='this.is@user',
-                                groups=groups, save_now=True)
+        user = uapi.create_minimal_user(email='this.is@user',
+                                        groups=groups, save_now=True)
 
         workspace = WorkspaceApi(
             current_user=user,

tracim/tests/library/test_notification.py

@@ -4,18 +4,20 @@ import re
 
 
 from tracim.lib.core.notifications import DummyNotifier
-from tracim.lib.core.notifications import EmailNotifier
+
 from tracim.lib.core.notifications import NotifierFactory
+from tracim.lib.mail_notifier.notifier import EmailNotifier
 from tracim.models.auth import User
 from tracim.models.data import Content
 from tracim.tests import DefaultTest
 from tracim.tests import eq_
 
+
 class TestDummyNotifier(DefaultTest):
 
     def test_dummy_notifier__notify_content_update(self):
         c = Content()
-        notifier = DummyNotifier(self.app_config)
+        notifier = DummyNotifier(self.app_config, self.session)
         notifier.notify_content_update(c)
         # INFO - D.A. - 2014-12-09 -
         # Old notification_content_update raised an exception

tracim/tests/library/test_user_api.py

@@ -17,7 +17,7 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        u = api.create_user()
+        u = api.create_minimal_user()
         api.update(u, 'bob', 'bob@bob', True)
 
         nu = api.get_one_by_email('bob@bob')
@@ -31,7 +31,7 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        u = api.create_user()
+        u = api.create_minimal_user()
         api.update(u, 'bibi', 'bibi@bibi', True)
         transaction.commit()
 
@@ -44,7 +44,8 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        u = api.create_user()
+        u = api.create_minimal_user()
+        self.session.flush()
         api.update(u, 'bibi', 'bibi@bibi', True)
         uid = u.user_id
         transaction.commit()
@@ -67,8 +68,8 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        # u1 = api.create_user(True)
-        # u2 = api.create_user(True)
+        # u1 = api.create_minimal_user(True)
+        # u2 = api.create_minimal_user(True)
 
         # users = api.get_all()
         # ok_(2==len(users))
@@ -79,7 +80,7 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        u = api.create_user()
+        u = api.create_minimal_user()
         api.update(u, 'titi', 'titi@titi', True)
         one = api.get_one(u.user_id)
         eq_(u.user_id, one.user_id)

tracim/tests/library/test_workspace.py

@@ -52,7 +52,7 @@ class TestThread(DefaultTest):
             current_user=admin,
             config=self.config
         )
-        u = uapi.create_user(email='u.u@u.u', save_now=True)
+        u = uapi.create_minimal_user(email='u.u@u.u', save_now=True)
         eq_([], wapi.get_notifiable_roles(workspace=w))
         rapi = RoleApi(
             session=self.session,
@@ -88,7 +88,7 @@ class TestThread(DefaultTest):
             session=self.session,
             current_user=None,
         )
-        u = uapi.create_user('u.s@e.r', [gapi.get_one(Group.TIM_USER)], True)
+        u = uapi.create_minimal_user('u.s@e.r', [gapi.get_one(Group.TIM_USER)], True)
         wapi = WorkspaceApi(
             session=self.session,
             current_user=u

tracim/views/core_api/session_controller.py

@@ -1,6 +1,14 @@
 # coding=utf-8
 from pyramid.config import Configurator
 from sqlalchemy.orm.exc import NoResultFound
+
+from tracim.lib.core.content import ContentApi
+from tracim.lib.core.group import GroupApi
+from tracim.lib.core.userworkspace import RoleApi
+from tracim.lib.core.workspace import WorkspaceApi
+from tracim.models import Group
+from tracim.models.data import ContentType
+
 try:  # Python 3.5+
     from http import HTTPStatus
 except ImportError:
@@ -86,6 +94,99 @@ class SessionController(Controller):
             config=app_config,
         )
 
+    @hapic.with_api_doc()
+    @hapic.output_body(
+        UserSchema(),
+    )
+    def create_user(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Return current logged in user or 401
+        """
+        app_config = request.registry.settings['CFG']
+        uapi = UserApi(
+            None,
+            session=request.dbsession,
+            config=app_config,
+        )
+        group_api = GroupApi(current_user=None, session=request.dbsession)
+        groups = [group_api.get_one(Group.TIM_USER),
+                  group_api.get_one(Group.TIM_MANAGER),
+                  group_api.get_one(Group.TIM_ADMIN)]
+        user = uapi.create_user(
+            email='dev.tracim.testuser@algoo.fr',
+            password='toto',
+            name='toto',
+            groups=groups,
+            timezone="lapin",
+            do_save=True,
+            do_notify=True,
+        )
+        wapi = WorkspaceApi(
+            current_user=user,
+            session=request.dbsession,
+        )
+        workspace = wapi.get_one_by_label('w1')
+        rapi = RoleApi(
+            session=request.dbsession,
+            current_user=user,
+        )
+        rapi.create_one(
+            user=user,
+            workspace=workspace,
+            role_level=8,
+            with_notif=True,
+            flush=True,
+        )
+        return UserInContext(
+            user=user,
+            dbsession=request.dbsession,
+            config=app_config,
+        )
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(
+        NotAuthentificated,
+        http_code=HTTPStatus.UNAUTHORIZED
+    )
+    @hapic.output_body(
+        NoContentSchema()
+    )
+    def add_content(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Return current logged in user or 401
+        """
+        app_config = request.registry.settings['CFG']
+        uapi = UserApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        workspace = WorkspaceApi(
+            current_user=request.current_user,
+            session=request.dbsession
+        ).get_one_by_label('w1')
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        item = api.create(
+            ContentType.Folder,
+            workspace,
+            None,
+            'parent',
+            do_save=True,
+        )
+        item2 = api.create(
+            ContentType.File,
+            workspace,
+            item,
+            'file1',
+            do_save=True,
+            do_notify=True,
+        )
+        return
+
     def bind(self, configurator: Configurator):
 
         # Login
@@ -99,3 +200,9 @@ class SessionController(Controller):
         # Whoami
         configurator.add_route('whoami', '/sessions/whoami', request_method='GET')  # nopep8
         configurator.add_view(self.whoami, route_name='whoami',)
+
+        configurator.add_route('create_user_test', '/create_user', request_method='POST')  # nopep8
+        configurator.add_view(self.create_user, route_name='create_user_test',)
+
+        configurator.add_route('add_content', '/add_content', request_method='POST')  # nopep8
+        configurator.add_view(self.add_content, route_name='add_content',)