Closes #173: Update code to permit notifications email in wsgidav context

install/requirements.txt

@@ -64,3 +64,4 @@ zope.interface==4.1.3
 zope.sqlalchemy==0.7.6
 PyYAML
 redis==2.10.5
+typing==3.5.3.0

tracim/tracim/config/app_cfg.py

@@ -25,7 +25,7 @@ from tgext.asyncjob.trackers.redisdb import RedisProgressTracker
 from tgext.pluggable import plug
 from tgext.pluggable import replace_template
 
-from tg.i18n import lazy_ugettext as l_
+from tracim.lib.utils import lazy_ugettext as l_
 
 import tracim
 from tracim import model

tracim/tracim/controllers/__init__.py

@@ -4,6 +4,7 @@ from sqlalchemy.orm.exc import NoResultFound
 from tg import abort
 from tracim.lib.integrity import PathValidationManager
 from tracim.lib.integrity import render_invalid_integrity_chosen_path
+from tracim.lib.user import CurrentUserGetterApi
 from tracim.lib.workspace import WorkspaceApi
 
 import tg
@@ -28,7 +29,6 @@ from tracim.model.data import ContentType
 from tracim.model.data import Workspace
 
 from tracim.lib.content import ContentApi
-from tracim.lib.user import UserStaticApi
 from tracim.lib.utils import SameValueError
 
 from tracim.model.serializers import Context
@@ -38,7 +38,7 @@ class TIMRestPathContextSetup(object):
 
     @classmethod
     def current_user(cls) -> User:
-        user = UserStaticApi.get_current_user()
+        user = CurrentUserGetterApi.get_current_user()
         tmpl_context.current_user_id = user.user_id if user else None
         tmpl_context.current_user = user if user else None
         return user

tracim/tracim/controllers/admin/user.py

@@ -11,7 +11,7 @@ from tw2 import forms as tw2f
 import tg
 from tg import predicates
 from tg import tmpl_context
-from tg.i18n import ugettext as _, lazy_ugettext as l_
+from tg.i18n import ugettext as _
 
 from sprox.widgets import PropertyMultipleSelectField
 from sprox._compat import unicode_text
@@ -28,7 +28,6 @@ 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
 from tracim.lib.userworkspace import RoleApi
 from tracim.lib.workspace import WorkspaceApi
 

tracim/tracim/controllers/root.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-
+import tg
 from tg import expose
 from tg import flash
 from tg import lurl
@@ -15,7 +15,7 @@ from tracim.controllers.api import APIController
 
 from tracim.lib import CST
 from tracim.lib.base import logger
-from tracim.lib.user import UserStaticApi
+from tracim.lib.user import CurrentUserGetterApi
 from tracim.lib.content import ContentApi
 
 from tracim.controllers import StandardController
@@ -115,7 +115,7 @@ class RootController(StandardController):
             redirect(url('/login'),
                 params=dict(came_from=came_from, __logins=login_counter))
 
-        user = UserStaticApi.get_current_user()
+        user = CurrentUserGetterApi.get_current_user()
 
         flash(_('Welcome back, %s!') % user.get_display_name())
         redirect(came_from)

tracim/tracim/lib/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from tg.i18n import lazy_ugettext as l_
+
 
 class NotFoundError(Exception):
     pass

tracim/tracim/lib/app_globals.py

@@ -3,7 +3,7 @@
 from markupsafe import escape_silent as escape
 
 import tg
-from tg.i18n import ugettext as _, lazy_ugettext as l_
+from tracim.lib.utils import lazy_ugettext as l_
 from tg.flash import TGFlash
 
 """The application's Globals object"""

tracim/tracim/lib/notifications.py

@@ -8,15 +8,12 @@ from lxml.html.diff import htmldiff
 
 from mako.template import Template
 
-from tg.i18n import lazy_ugettext as l_
-from tg.i18n import ugettext as _
-
 from tracim.lib.base import logger
 from tracim.lib.email import SmtpConfiguration
 from tracim.lib.email import EmailSender
 from tracim.lib.user import UserApi
 from tracim.lib.workspace import WorkspaceApi
-
+from tracim.lib.utils import lazy_ugettext as l_
 from tracim.model.serializers import Context
 from tracim.model.serializers import CTX
 from tracim.model.serializers import DictLikeClass
@@ -319,72 +316,72 @@ class EmailNotifier(object):
 
         action = content.get_last_action().id
         if ActionDescription.COMMENT == action:
-            content_intro = _('<span id="content-intro-username">{}</span> added a comment:').format(actor.display_name)
+            content_intro = l_('<span id="content-intro-username">{}</span> added a comment:').format(actor.display_name)
             content_text = content.description
-            call_to_action_text = _('Answer')
+            call_to_action_text = l_('Answer')
 
         elif ActionDescription.CREATION == action:
 
             # Default values (if not overriden)
             content_text = content.description
-            call_to_action_text = _('View online')
+            call_to_action_text = l_('View online')
 
             if ContentType.Thread == content.type:
-                call_to_action_text = _('Answer')
-                content_intro = _('<span id="content-intro-username">{}</span> started a thread entitled:').format(actor.display_name)
+                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 = _('<span id="content-intro-username">{}</span> added a file entitled:').format(actor.display_name)
+                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 = _('<span id="content-intro-username">{}</span> added a page entitled:').format(actor.display_name)
+                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 = _('View online')
+            call_to_action_text = l_('View online')
 
             if ContentType.File == content.type:
-                content_intro = _('<span id="content-intro-username">{}</span> uploaded a new revision.').format(actor.display_name)
+                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 = _('<span id="content-intro-username">{}</span> updated this page.').format(actor.display_name)
+                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 = _('<p id="content-body-intro">Here is an overview of the changes:</p>')+ \
+                content_text = 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 = _('<span id="content-intro-username">{}</span> updated the thread description.').format(actor.display_name)
+                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 = _('<p id="content-body-intro">Here is an overview of the changes:</p>')+ \
+                content_text = 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 = _('<span id="content-intro-username">{}</span> updated this page.').format(actor.display_name)
+            #     content_intro = l_('<span id="content-intro-username">{}</span> updated this page.').format(actor.display_name)
             #     previous_revision = content.get_previous_revision()
-            #     content_text = _('<p id="content-body-intro">Here is an overview of the changes:</p>')+ \
+            #     content_text = l_('<p id="content-body-intro">Here is an overview of the changes:</p>')+ \
             #         htmldiff(previous_revision.description, content.description)
 
         elif ActionDescription.EDITION == action:
-            call_to_action_text = _('View online')
+            call_to_action_text = l_('View online')
 
             if ContentType.File == content.type:
-                content_intro = _('<span id="content-intro-username">{}</span> updated the file description.').format(actor.display_name)
+                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
 
@@ -404,7 +401,7 @@ class EmailNotifier(object):
         from tracim.config.app_cfg import CFG
         body_content = template.render(
             base_url=self._global_config.WEBSITE_BASE_URL,
-            _=_,
+            _=l_,
             h=helpers,
             user_display_name=role.user.display_name,
             user_role_label=role.role_as_label(),

tracim/tracim/lib/predicates.py

@@ -3,7 +3,7 @@
 from tg import abort
 from tg import request
 from tg import tmpl_context
-from tg.i18n import lazy_ugettext as l_
+from tracim.lib.utils import lazy_ugettext as l_
 from tg.i18n import ugettext as _
 from tg.predicates import Predicate
 

tracim/tracim/lib/user.py

@@ -1,14 +1,16 @@
 # -*- coding: utf-8 -*-
-import transaction
+import threading
 
+import cherrypy
+import transaction
 import tg
+import typing as typing
 
 from tracim.model.auth import User
-
-from tracim.model import auth as pbma
 from tracim.model import DBSession
 
-__author__ = 'damien'
+CURRENT_USER_WEB = 'WEB'
+CURRENT_USER_WSGIDAV = 'WSGIDAV'
 
 
 class UserApi(object):
@@ -103,25 +105,61 @@ class UserApi(object):
         )
 
 
-class UserStaticApi(object):
+class CurrentUserGetterInterface(object):
+    def get_current_user(self) -> typing.Union[None, User]:
+        raise NotImplementedError()
 
-    @classmethod
-    def get_current_user(cls) -> User:
+
+class BaseCurrentUserGetter(CurrentUserGetterInterface):
+    def __init__(self) -> None:
+        self.api = UserApi(None)
+
+
+class WebCurrentUserGetter(BaseCurrentUserGetter):
+    def get_current_user(self) -> typing.Union[None, User]:
         # HACK - D.A. - 2015-09-02
         # In tests, the tg.request.identity may not be set
         # (this is a buggy case, but for now this is how the software is;)
-        if tg.request != None:
+        if tg.request is not None:
             if hasattr(tg.request, 'identity'):
-                if tg.request.identity != None:
-                    return cls._get_user(tg.request.identity['repoze.who.userid'])
+                if tg.request.identity is not None:
+                    return self.api.get_one_by_email(
+                        tg.request.identity['repoze.who.userid'],
+                    )
+
+        return None
+
+
+class WsgidavCurrentUserGetter(BaseCurrentUserGetter):
+    def get_current_user(self) -> typing.Union[None, User]:
+        if hasattr(cherrypy.request, 'current_user_email'):
+            return self.api.get_one_by_email(
+                cherrypy.request.current_user_email,
+            )
 
         return None
 
+
+class CurrentUserGetterApi(object):
+    thread_local = threading.local()
+    matches = {
+        CURRENT_USER_WEB: WebCurrentUserGetter,
+        CURRENT_USER_WSGIDAV: WsgidavCurrentUserGetter,
+    }
+    default = CURRENT_USER_WEB
+
     @classmethod
-    def _get_user(cls, email) -> User:
-        """
-        Do not use directly in your code.
-        :param email:
-        :return:
-        """
-        return pbma.User.by_email_address(email)
+    def get_current_user(cls) -> User:
+        try:
+            return cls.thread_local.getter.get_current_user()
+        except AttributeError:
+            return cls.factory(cls.default).get_current_user()
+
+    @classmethod
+    def set_thread_local_getter(cls, name) -> None:
+        if not hasattr(cls.thread_local, 'getter'):
+            cls.thread_local.getter = cls.factory(name)
+
+    @classmethod
+    def factory(cls, name: str) -> CurrentUserGetterInterface:
+        return cls.matches[name]()

tracim/tracim/lib/utils.py

@@ -9,6 +9,10 @@ from tg import response
 from tg.controllers.util import abort
 from tg.appwrappers.errorpage import ErrorPageApplicationWrapper \
     as BaseErrorPageApplicationWrapper
+from tg.i18n import ugettext
+from tg.support.registry import StackedObjectProxy
+from tg.util import LazyString as BaseLazyString
+from tg.util import lazify
 
 from tracim.lib.base import logger
 from webob import Response
@@ -145,3 +149,25 @@ def str_as_bool(string: str) -> bool:
     if string == '0':
         return False
     return bool(string)
+
+
+class LazyString(BaseLazyString):
+    pass
+
+
+def _lazy_ugettext(text: str):
+    """
+    This function test if application context is available
+    :param text: String to traduce
+    :return: lazyfied string or string
+    """
+    try:
+        # Test if context is available,
+        # cf. https://github.com/tracim/tracim/issues/173
+        context = StackedObjectProxy(name="context")
+        context.translator
+        return ugettext(text)
+    except TypeError:
+        return text
+
+lazy_ugettext = lazify(_lazy_ugettext)

tracim/tracim/lib/webdav/tracim_http_authenticator.py

@@ -1,6 +1,12 @@
+import os
+import re
+
 from wsgidav.http_authenticator import HTTPAuthenticator
 from wsgidav import util
-import re
+import cherrypy
+
+from tracim.lib.user import CurrentUserGetterApi
+from tracim.lib.user import CURRENT_USER_WSGIDAV
 
 _logger = util.getModuleLogger(__name__, True)
 HOTFIX_WINXP_AcceptRootShareLogin = True
@@ -131,6 +137,11 @@ class TracimHTTPAuthenticator(HTTPAuthenticator):
 
         environ["http_authenticator.realm"] = realmname
         environ["http_authenticator.username"] = req_username
+
+        # Set request current user email to be able to recognise him later
+        cherrypy.request.current_user_email = req_username
+        CurrentUserGetterApi.set_thread_local_getter(CURRENT_USER_WSGIDAV)
+
         return self._application(environ, start_response)
 
     def tracim_compute_digest_response(self, left_digest_response_hash, method, uri, nonce, cnonce, qop, nc):

tracim/tracim/model/auth.py

@@ -15,7 +15,7 @@ from datetime import datetime
 import time
 from hashlib import sha256
 from sqlalchemy.ext.hybrid import hybrid_property
-from tg.i18n import lazy_ugettext as l_
+from tracim.lib.utils import lazy_ugettext as l_
 from hashlib import md5
 
 __all__ = ['User', 'Group', 'Permission']

tracim/tracim/model/data.py

@@ -8,7 +8,6 @@ from datetime import datetime
 import tg
 from babel.dates import format_timedelta
 from bs4 import BeautifulSoup
-from slugify import slugify
 from sqlalchemy import Column, inspect, Index
 from sqlalchemy import ForeignKey
 from sqlalchemy import Sequence
@@ -25,8 +24,8 @@ from sqlalchemy.types import Integer
 from sqlalchemy.types import LargeBinary
 from sqlalchemy.types import Text
 from sqlalchemy.types import Unicode
-from tg.i18n import lazy_ugettext as l_, ugettext as _
 
+from tracim.lib.utils import lazy_ugettext as l_
 from tracim.lib.exception import ContentRevisionUpdateError
 from tracim.model import DeclarativeBase, RevisionsIntegrity
 from tracim.model.auth import User

tracim/tracim/model/serializers.py

@@ -1,4 +1,7 @@
 # -*- coding: utf-8 -*-
+import cherrypy
+import os
+
 import types
 
 from bs4 import BeautifulSoup
@@ -10,8 +13,7 @@ import tg
 from tg.i18n import ugettext as _
 from tg.util import LazyString
 from tracim.lib.base import logger
-from tracim.lib.user import UserStaticApi
-from tracim.lib.utils import exec_time_monitor
+from tracim.lib.user import CurrentUserGetterApi
 from tracim.model.auth import Profile
 from tracim.model.auth import User
 from tracim.model.data import BreadcrumbItem, ActionDescription
@@ -154,12 +156,17 @@ class Context(object):
         self.context_string = context_string
         self._current_user = current_user  # Allow to define the current user if any
         if not current_user:
-            self._current_user = UserStaticApi.get_current_user()
+            self._current_user = CurrentUserGetterApi.get_current_user()
 
         self._base_url = base_url # real root url like http://mydomain.com:8080
 
     def url(self, base_url='/', params=None, qualified=False) -> str:
-        url = tg.url(base_url, params)
+        # HACK (REF WSGIDAV.CONTEXT.TG.URL) This is a temporary hack who
+        # permit to know we are in WSGIDAV context.
+        if not hasattr(cherrypy.request, 'current_user_email'):
+            url = tg.url(base_url, params)
+        else:
+            url = base_url
 
         if self._base_url:
             url = '{}{}'.format(self._base_url, url)