Merge pull request #67 from buxx/66/dev/radicale_client_url

tracim/development.ini.base

@@ -169,6 +169,8 @@ website.treeview.content = all
 # The following base_url is used for links and icons
 # integrated in the email notifcations
 website.base_url = http://127.0.0.1:8080
+# If config not provided, it will be extracted from website.base_url
+website.server_name = 127.0.0.1
     
 email.notification.activated = False
 email.notification.from = Tracim Notification <noreply@trac.im>
@@ -188,10 +190,9 @@ email.notification.smtp.password = your_smtp_password
 # radicale.server.port = 5232
 # radicale.server.ssl = false
 # radicale.server.filesystem.folder = ~/.config/radicale/collections
-## If '', current host will be used
-# radicale.client.host = ''
-# radicale.client.port = 5232
-# radicale.client.ssl = false
+## url can be extended like http://127.0.0.1:5232/calendar
+## in this case, you have to create your own proxy behind this url.
+# radicale.client.base_url = http://127.0.0.1:5232
 
 #####
 #

tracim/tracim/config/app_cfg.py

@@ -12,6 +12,7 @@ convert them into boolean, for example, you should use the
     setting = asbool(global_conf.get('the_setting'))
  
 """
+from urllib.parse import urlparse
 
 import tg
 from paste.deploy.converters import asbool
@@ -177,6 +178,16 @@ class CFG(object):
         self.WEBSITE_HOME_IMAGE_URL = tg.lurl('/assets/img/home_illustration.jpg')
         self.WEBSITE_HOME_BACKGROUND_IMAGE_URL = tg.lurl('/assets/img/bg.jpg')
         self.WEBSITE_BASE_URL = tg.config.get('website.base_url', '')
+        self.WEBSITE_SERVER_NAME = tg.config.get('website.server_name', None)
+
+        if not self.WEBSITE_SERVER_NAME:
+            self.WEBSITE_SERVER_NAME = urlparse(self.WEBSITE_BASE_URL).hostname
+            logger.warning(
+                self,
+                'NOTE: Generated website.server_name parameter from '
+                'website.base_url parameter -> {0}'
+                .format(self.WEBSITE_SERVER_NAME)
+            )
 
         self.WEBSITE_HOME_TAG_LINE = tg.config.get('website.home.tag_line', '')
         self.WEBSITE_SUBTITLE = tg.config.get('website.home.subtitle', '')
@@ -227,11 +238,22 @@ class CFG(object):
             '~/.config/radicale/collections'
         )
 
-        # If None, current host will be used
-        self.RADICALE_CLIENT_HOST = tg.config.get('radicale.client.host', None)
-        self.RADICALE_CLIENT_PORT = tg.config.get('radicale.client.port', 5232)
-        self.RADICALE_CLIENT_SSL = asbool(tg.config.get('radicale.client.ssl', False))
-
+        self.RADICALE_CLIENT_BASE_URL_TEMPLATE = \
+            tg.config.get('radicale.client.base_url', None)
+
+        if not self.RADICALE_CLIENT_BASE_URL_TEMPLATE:
+            self.RADICALE_CLIENT_BASE_URL_TEMPLATE = \
+                'http://{0}:{1}'.format(
+                    self.WEBSITE_SERVER_NAME,
+                    self.RADICALE_SERVER_PORT,
+                )
+            logger.warning(
+                self,
+                'NOTE: Generated radicale.client.base_url parameter with '
+                'followings parameters: website.server_name, '
+                'radicale.server.port -> {0}'
+                .format(self.RADICALE_CLIENT_BASE_URL_TEMPLATE)
+            )
 
     def get_tracker_js_content(self, js_tracker_file_path = None):
         js_tracker_file_path = tg.config.get('js_tracker_path', None)

tracim/tracim/lib/calendar.py

@@ -1,3 +1,5 @@
+import os
+
 import re
 import transaction
 
@@ -24,50 +26,28 @@ CALENDAR_WORKSPACE_PATH_RE = 'workspace\/([0-9]+).ics'
 CALENDAR_TYPE_USER = UserCalendar
 CALENDAR_TYPE_WORKSPACE = WorkspaceCalendar
 
-CALENDAR_BASE_URL_TEMPLATE = '{proto}://{domain}:{port}'
-CALENDAR_USER_URL_TEMPLATE = \
-    CALENDAR_BASE_URL_TEMPLATE + '/user/{id}.ics{extra}/'
-CALENDAR_WORKSPACE_URL_TEMPLATE = \
-    CALENDAR_BASE_URL_TEMPLATE + '/workspace/{id}.ics{extra}/'
+CALENDAR_USER_URL_TEMPLATE = 'user/{id}.ics/'
+CALENDAR_WORKSPACE_URL_TEMPLATE = 'workspace/{id}.ics/'
 
 
 class CalendarManager(object):
-    @staticmethod
-    def get_base_url():
-        from tracim.config.app_cfg import CFG
-        cfg = CFG.get_instance()
-
-        return CALENDAR_BASE_URL_TEMPLATE.format(
-            proto='https' if cfg.RADICALE_CLIENT_SSL else 'http',
-            domain=cfg.RADICALE_CLIENT_HOST or '127.0.0.1',
-            port=str(cfg.RADICALE_CLIENT_PORT)
-        )
-
-    @staticmethod
-    def get_user_calendar_url(user_id: int, extra: str=''):
+    @classmethod
+    def get_base_url(cls):
         from tracim.config.app_cfg import CFG
         cfg = CFG.get_instance()
+        return cfg.RADICALE_CLIENT_BASE_URL_TEMPLATE
 
-        return CALENDAR_USER_URL_TEMPLATE.format(
-            proto='https' if cfg.RADICALE_CLIENT_SSL else 'http',
-            domain=cfg.RADICALE_CLIENT_HOST or '127.0.0.1',
-            port=str(cfg.RADICALE_CLIENT_PORT),
-            id=str(user_id),
-            extra=extra,
-        )
-
-    @staticmethod
-    def get_workspace_calendar_url(workspace_id: int, extra: str=''):
-        from tracim.config.app_cfg import CFG
-        cfg = CFG.get_instance()
+    @classmethod
+    def get_user_calendar_url(cls, user_id: int):
+        user_path = CALENDAR_USER_URL_TEMPLATE.format(id=str(user_id))
+        return os.path.join(cls.get_base_url(), user_path)
 
-        return CALENDAR_WORKSPACE_URL_TEMPLATE.format(
-            proto='https' if cfg.RADICALE_CLIENT_SSL else 'http',
-            domain=cfg.RADICALE_CLIENT_HOST or '127.0.0.1',
-            port=str(cfg.RADICALE_CLIENT_PORT),
-            id=str(workspace_id),
-            extra=extra,
+    @classmethod
+    def get_workspace_calendar_url(cls, workspace_id: int):
+        workspace_path = CALENDAR_WORKSPACE_URL_TEMPLATE.format(
+            id=str(workspace_id)
         )
+        return os.path.join(cls.get_base_url(), workspace_path)
 
     def __init__(self, user: User):
         self._user = user

tracim/tracim/model/auth.py

@@ -151,18 +151,10 @@ class User(DeclarativeBase):
     @property
     def calendar_url(self) -> str:
         # TODO - 20160531 - Bastien: Cyclic import if import in top of file
-        from tracim.config.app_cfg import CFG
-        from tracim.lib.calendar import CALENDAR_USER_URL_TEMPLATE
-        cfg = CFG.get_instance()
-        return CALENDAR_USER_URL_TEMPLATE.format(
-            proto='https' if cfg.RADICALE_CLIENT_SSL else 'http',
-            domain=cfg.RADICALE_CLIENT_HOST or request.domain,
-            port=cfg.RADICALE_CLIENT_PORT,
-            id=self.user_id,
-            extra='#' + slugify(self.get_display_name(
-                remove_email_part=True
-            ), only_ascii=True)
-        )
+        from tracim.lib.calendar import CalendarManager
+        calendar_manager = CalendarManager(None)
+
+        return calendar_manager.get_user_calendar_url(self.user_id)
 
     @classmethod
     def by_email_address(cls, email):

tracim/tracim/model/data.py

@@ -70,16 +70,10 @@ class Workspace(DeclarativeBase):
     @property
     def calendar_url(self) -> str:
         # TODO - 20160531 - Bastien: Cyclic import if import in top of file
-        from tracim.config.app_cfg import CFG
-        from tracim.lib.calendar import CALENDAR_WORKSPACE_URL_TEMPLATE
-        cfg = CFG.get_instance()
-        return CALENDAR_WORKSPACE_URL_TEMPLATE.format(
-            proto='https' if cfg.RADICALE_CLIENT_SSL else 'http',
-            domain=cfg.RADICALE_CLIENT_HOST or tg.request.domain,
-            port=cfg.RADICALE_CLIENT_PORT,
-            id=self.workspace_id,
-            extra='#' + slugify(self.label),
-        )
+        from tracim.lib.calendar import CalendarManager
+        calendar_manager = CalendarManager(None)
+
+        return calendar_manager.get_workspace_calendar_url(self.workspace_id)
 
     def get_user_role(self, user: User) -> int:
         for role in user.roles: