Radicale: Storage override to create, update an delete tracim Event (Content)

install/requirements.txt

@@ -51,3 +51,4 @@ python-ldap-test==0.2.0
 who-ldap==3.1.0
 unicode-slugify==0.1.3
 Radicale==1.1.1
+icalendar==3.10

tracim/migration/versions/534c4594ed29_add_calendar_enabled_column_to_workspace.py

@@ -16,7 +16,7 @@ import sqlalchemy as sa
 
 def upgrade():
     ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('workspaces', sa.Column('calendar_enabled', sa.Boolean(), nullable=False))
+    op.add_column('workspaces', sa.Column('calendar_enabled', sa.Boolean(), nullable=False, server_default='0'))
     ### end Alembic commands ###
 
 

tracim/tracim/controllers/workspace.py

@@ -58,7 +58,9 @@ class UserWorkspaceRestController(TIMRestController):
         # ,
         #                      sub_items=Context(CTX.FOLDER_CONTENT_LIST).toDict(dictified_folders))
 
-        fake_api.sub_items = Context(CTX.FOLDER_CONTENT_LIST).toDict(workspace.get_valid_children())
+        fake_api.sub_items = Context(CTX.FOLDER_CONTENT_LIST).toDict(
+            workspace.get_valid_children(ContentApi.DISPLAYABLE_CONTENTS)
+        )
 
         dictified_workspace = Context(CTX.WORKSPACE).toDict(workspace, 'workspace')
 

tracim/tracim/lib/calendar.py

@@ -1,10 +1,19 @@
 import re
+import transaction
 
+from icalendar import Event as iCalendarEvent
+
+from tracim.lib.content import ContentApi
 from tracim.lib.exceptions import UnknownCalendarType
 from tracim.lib.exceptions import NotFound
 from tracim.lib.user import UserApi
-from tracim.lib.workspace import WorkspaceApi
+from tracim.lib.workspace import UnsafeWorkspaceApi
 from tracim.model import User
+from tracim.model import DBSession
+from tracim.model import new_revision
+from tracim.model.data import ActionDescription
+from tracim.model.data import Content
+from tracim.model.data import ContentType
 from tracim.model.organizational import Calendar
 from tracim.model.organizational import UserCalendar
 from tracim.model.organizational import WorkspaceCalendar
@@ -12,8 +21,8 @@ from tracim.model.organizational import WorkspaceCalendar
 CALENDAR_USER_PATH_RE = 'user\/([0-9]+)--([a-z-]*).ics'
 CALENDAR_WORKSPACE_PATH_RE = 'workspace\/([0-9]+)--([a-z0-9-]*).ics'
 
-CALENDAR_TYPE_USER = 'USER'
-CALENDAR_TYPE_WORKSPACE = 'WORKSPACE'
+CALENDAR_TYPE_USER = UserCalendar
+CALENDAR_TYPE_WORKSPACE = WorkspaceCalendar
 
 
 class CalendarManager(object):
@@ -84,7 +93,125 @@ class CalendarManager(object):
             return UserCalendar(user, path=path)
 
         if type == CALENDAR_TYPE_WORKSPACE:
-            workspace = WorkspaceApi(self._user).get_one(id)
+            workspace = UnsafeWorkspaceApi(self._user).get_one(id)
             return WorkspaceCalendar(workspace, path=path)
 
         raise UnknownCalendarType('Type "{0}" is not implemented'.format(type))
+
+    def add_event(
+            self,
+            calendar: Calendar,
+            event: iCalendarEvent,
+            event_name: str,
+            owner: User,
+    ) -> Content:
+        """
+        Create Content event type.
+        :param calendar: Event calendar owner
+        :param event: ICS event
+        :param event_name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param owner: Event Owner
+        :return: Created Content
+        """
+        if isinstance(calendar, WorkspaceCalendar):
+            content = ContentApi(owner).create(
+                content_type=ContentType.Event,
+                workspace=calendar.related_object,
+                label=event.get('summary'),
+                do_save=False
+            )
+            content.description = event.get('description')
+            content.properties = {
+                'name': event_name,
+                'raw': event.to_ical().decode("utf-8"),
+                'start': event.get('dtend').dt.strftime('%Y-%m-%d %H:%M:%S%z'),
+                'end': event.get('dtstart').dt.strftime('%Y-%m-%d %H:%M:%S%z'),
+            }
+            content.revision_type = ActionDescription.CREATION
+            DBSession.add(content)
+            DBSession.flush()
+            transaction.commit()
+            return content
+
+        if isinstance(calendar, UserCalendar):
+            # TODO - 20160531 - Bastien: UserCalendar currently not managed
+            raise NotImplementedError()
+
+        raise UnknownCalendarType('Type "{0}" is not implemented'
+                                  .format(type(calendar)))
+
+    def update_event(
+            self,
+            calendar: Calendar,
+            event: iCalendarEvent,
+            event_name: str,
+            current_user: User,
+    ) -> Content:
+        """
+        Update Content Event
+        :param calendar: Event calendar owner
+        :param event: ICS event
+        :param event_name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param current_user: Current modification asking user
+        :return: Updated Content
+        """
+        if isinstance(calendar, WorkspaceCalendar):
+            content_api = ContentApi(current_user, force_show_all_types=True)
+            content = content_api.find_one_by_unique_property(
+                property_name='name',
+                property_value=event_name,
+                workspace=calendar.related_object
+            )
+
+            with new_revision(content):
+                content.label = event.get('summary')
+                content.description = event.get('description')
+                content.properties = {
+                    'name': event_name,
+                    'raw': event.to_ical().decode("utf-8"),
+                    'start': event.get('dtend').dt.strftime(
+                        '%Y-%m-%d %H:%M:%S%z'
+                    ),
+                    'end': event.get('dtstart').dt.strftime(
+                        '%Y-%m-%d %H:%M:%S%z'
+                    ),
+                }
+                content.revision_type = ActionDescription.EDITION
+
+            DBSession.flush()
+            transaction.commit()
+
+            return content
+
+        if isinstance(calendar, UserCalendar):
+            # TODO - 20160531 - Bastien: UserCalendar currently not managed
+            raise NotImplementedError()
+
+        raise UnknownCalendarType('Type "{0}" is not implemented'
+                                  .format(type(calendar)))
+
+    def delete_event_with_name(self, event_name: str, current_user: User)\
+            -> Content:
+        """
+        Delete Content Event
+        :param event_name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param current_user: Current deletion asking user
+        :return: Deleted Content
+        """
+        content_api = ContentApi(current_user, force_show_all_types=True)
+        content = content_api.find_one_by_unique_property(
+            property_name='name',
+            property_value=event_name,
+            workspace=None
+        )
+
+        with new_revision(content):
+            content_api.delete(content)
+
+        DBSession.flush()
+        transaction.commit()
+
+        return content

tracim/tracim/lib/content.py

@@ -67,13 +67,28 @@ class ContentApi(object):
     SEARCH_SEPARATORS = ',| '
     SEARCH_DEFAULT_RESULT_NB = 50
 
-
-    def __init__(self, current_user: User, show_archived=False, show_deleted=False, all_content_in_treeview=True):
+    DISPLAYABLE_CONTENTS = (
+        ContentType.Folder,
+        ContentType.File,
+        ContentType.Comment,
+        ContentType.Thread,
+        ContentType.Page,
+    )
+
+    def __init__(
+            self,
+            current_user: User,
+            show_archived=False,
+            show_deleted=False,
+            all_content_in_treeview=True,
+            force_show_all_types=False,
+    ):
         self._user = current_user
         self._user_id = current_user.user_id if current_user else None
         self._show_archived = show_archived
         self._show_deleted = show_deleted
         self._show_all_type_of_contents_in_treeview = all_content_in_treeview
+        self._force_show_all_types = force_show_all_types
 
     @classmethod
     def get_revision_join(cls):
@@ -158,6 +173,10 @@ class ContentApi(object):
     def __real_base_query(self, workspace: Workspace=None):
         result = self.get_canonical_query()
 
+        # Exclude non displayable types
+        if not self._force_show_all_types:
+            result = result.filter(Content.type.in_(self.DISPLAYABLE_CONTENTS))
+
         if workspace:
             result = result.filter(Content.workspace_id==workspace.workspace_id)
 
@@ -184,6 +203,10 @@ class ContentApi(object):
     def __revisions_real_base_query(self, workspace: Workspace=None):
         result = DBSession.query(ContentRevisionRO)
 
+        # Exclude non displayable types
+        if not self._force_show_all_types:
+            result = result.filter(Content.type.in_(self.DISPLAYABLE_CONTENTS))
+
         if workspace:
             result = result.filter(ContentRevisionRO.workspace_id==workspace.workspace_id)
 
@@ -698,3 +721,31 @@ class ContentApi(object):
             if content.parent.parent:
                 return self.content_under_archived(content.parent)
         return False
+
+    def find_one_by_unique_property(
+            self,
+            property_name: str,
+            property_value: str,
+            workspace: Workspace=None,
+    ) -> Content:
+        """
+        Return Content who contains given property.
+        Raise sqlalchemy.orm.exc.MultipleResultsFound if more than one Content
+        contains this property value.
+        :param property_name: Name of property
+        :param property_value: Value of property
+        :param workspace: Workspace who contains Content
+        :return: Found Content
+        """
+        # TODO - 20160602 - Bastien: Should be JSON type query
+        # see https://www.compose.io/articles/using-json-extensions-in-\
+        # postgresql-from-python-2/
+        query = self._base_query(workspace=workspace).filter(
+            Content._properties.like(
+                '%"{property_name}": "{property_value}"%'.format(
+                    property_name=property_name,
+                    property_value=property_value,
+                )
+            )
+        )
+        return query.one()

tracim/tracim/lib/daemons.py

@@ -85,6 +85,7 @@ class RadicaleDaemon(Daemon):
     def _prepare_config(self):
         tracim_auth = 'tracim.lib.radicale.auth'
         tracim_rights = 'tracim.lib.radicale.rights'
+        tracim_storage = 'tracim.lib.radicale.storage'
 
         radicale_config.set('auth', 'type', 'custom')
         radicale_config.set('auth', 'custom_handler', tracim_auth)
@@ -92,6 +93,9 @@ class RadicaleDaemon(Daemon):
         radicale_config.set('rights', 'type', 'custom')
         radicale_config.set('rights', 'custom_handler', tracim_rights)
 
+        radicale_config.set('storage', 'type', 'custom')
+        radicale_config.set('storage', 'custom_handler', tracim_storage)
+
     def _get_server(self):
         from tracim.config.app_cfg import CFG
         cfg = CFG.get_instance()

tracim/tracim/lib/radicale/auth.py

@@ -1,13 +1,36 @@
 from tg import config
 
+from tracim.lib.user import UserApi
 
-def is_authenticated(user, password):
+
+class Auth(object):
+    """
+    This Auth class is designed to solve following problematic:
+    In tracim.lib.radicale.storage.Collection append, replace and delete
+    methods we don't know wich user is processing. So this Auth singleton
+    store last authenticated user.
+    """
+    current_user = None
+
+    @classmethod
+    def is_authenticated(cls, user, password) -> bool:
+        """
+        :param user: user email
+        :param password: user password
+        :return: True if auth success, False if not
+        """
+        email = config.get('sa_auth').authmetadata.authenticate({}, {
+            'login': user,
+            'password': password
+        })
+        if email:
+            cls.current_user = UserApi(None).get_one_by_email(email)
+
+        return bool(email)
+
+
+def is_authenticated(user: str, password: str) -> bool:
     """
-    :param user: user email
-    :param password: user password
-    :return: True if auth success, False if not
+    see tracim.lib.radicale.auth.Auth#is_authenticated
     """
-    return bool(config.get('sa_auth').authmetadata.authenticate({}, {
-        'login': user,
-        'password': password
-    }))
+    return Auth.is_authenticated(user, password)

tracim/tracim/lib/radicale/storage.py

@@ -1,6 +1,123 @@
+from contextlib import contextmanager
+
 from radicale.storage.filesystem import Collection as BaseCollection
+from icalendar import Event as iCalendarEvent
+from radicale.ical import Event as RadicaleEvent
+
+from tracim.lib.calendar import CalendarManager
+from tracim.lib.radicale.auth import Auth
+from tracim.model import Content
 
 
 class Collection(BaseCollection):
-    def __init__(self, path, principal=False):
+    """
+    Radicale use it's own storage system but this override create, update
+    and delete events in our database.
+    """
+
+    def __init__(self, path: str, principal: bool=False):
         super().__init__(path, principal)
+        self._replacing = False  # See ``replacing`` context manager
+        self._manager = CalendarManager(None)
+
+    @contextmanager
+    def replacing(self):
+        """
+        Radicale filesystem storage make a ``remove`` then an ``append`` to
+        update an item. So to know what we are in update context when
+        ``append`` and ``remove`` functions are called, use this context
+        manager in ``replace`` function.
+        """
+        try:
+            self._replacing = True
+            yield self
+        finally:
+            self._replacing = False
+
+    def replace(self, name: str, text: str) -> None:
+        """
+        Override of parent replace to manage event update action. See
+        ``replacing`` context manager for more informations.
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param text: ICS Event content
+        """
+        with self.replacing():
+            super().replace(name, text)
+        self._update_tracim_event(name, text)
+
+    def remove(self, name: str) -> None:
+        """
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        """
+        super().remove(name)
+        if not self._replacing:
+            self._remove_tracim_event(name)
+
+    def append(self, name: str, text: str) -> None:
+        """
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param text: ICS Event content
+        """
+        super().append(name, text)
+        if not self._replacing:
+            self._add_tracim_event(name, text)
+
+    def _add_tracim_event(self, name: str, text: str) -> Content:
+        """
+        Create tracim internal Event (Content) with Radicale given data.
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param text: ICS Event content
+        :return: Created Content
+        """
+        event = self._extract_event(name, text)
+        calendar = self._manager.find_calendar_with_path(self.path)
+        return self._manager.add_event(
+            calendar=calendar,
+            event=event,
+            event_name=name,
+            owner=Auth.current_user
+        )
+
+    def _update_tracim_event(self, name: str, text: str) -> Content:
+        """
+        Update tracim internal Event (Content) with Radicale given data.
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param text: ICS Event content
+        :return: Updated Content
+        """
+        event = self._extract_event(name, text)
+        calendar = self._manager.find_calendar_with_path(self.path)
+        return self._manager.update_event(
+            calendar=calendar,
+            event=event,
+            event_name=name,
+            current_user=Auth.current_user
+        )
+
+    def _remove_tracim_event(self, name: str) -> Content:
+        """
+        Delete internal tracim Event (Content) with given Event name.
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :return: Deleted Content
+        """
+        return self._manager.delete_event_with_name(name, Auth.current_user)
+
+    def _extract_event(self, name: str, text: str) -> iCalendarEvent:
+        """
+        Return a icalendar.cal.Event construct with given Radicale ICS data.
+        :param name: Event name (ID) like
+        20160602T083511Z-18100-1001-1-71_Bastien-20160602T083516Z.ics
+        :param text: ICS Event content
+        :return: ICS Event representation
+        """
+        radicale_items = self._parse(text, (RadicaleEvent,), name)
+        for item_name in radicale_items:
+            item = radicale_items[item_name]
+            if isinstance(item, RadicaleEvent):
+                return iCalendarEvent.from_ical(item.text)

tracim/tracim/lib/workspace.py

@@ -121,3 +121,8 @@ class WorkspaceApi(object):
             DBSession.flush()
 
         return workspace
+
+
+class UnsafeWorkspaceApi(WorkspaceApi):
+    def _base_query(self):
+        return DBSession.query(Workspace).filter(Workspace.is_deleted==False)

tracim/tracim/model/data.py

@@ -320,6 +320,7 @@ class ContentType(object):
     Comment = 'comment'
     Thread = 'thread'
     Page = 'page'
+    Event = 'event'
 
     # Fake types, used for breadcrumb only
     FAKE_Dashboard = 'dashboard'
@@ -335,6 +336,7 @@ class ContentType(object):
         'page': 'fa fa-file-text-o',
         'thread': 'fa fa-comments-o',
         'comment': 'fa fa-comment-o',
+        'event': 'fa fa-calendar-o',
     }
 
     _CSS_ICONS = {
@@ -344,7 +346,8 @@ class ContentType(object):
         'file': 'fa fa-paperclip',
         'page': 'fa fa-file-text-o',
         'thread': 'fa fa-comments-o',
-        'comment': 'fa fa-comment-o'
+        'comment': 'fa fa-comment-o',
+        'event': 'fa fa-calendar-o',
     }
 
     _CSS_COLORS = {
@@ -354,7 +357,8 @@ class ContentType(object):
         'file': 't-file-color',
         'page': 't-page-color',
         'thread': 't-thread-color',
-        'comment': 't-thread-color'
+        'comment': 't-thread-color',
+        'event': 't-event-color',
     }
 
     _ORDER_WEIGHT = {
@@ -363,6 +367,7 @@ class ContentType(object):
         'thread': 2,
         'file': 3,
         'comment': 4,
+        'event': 5,
     }
 
     _LABEL = {
@@ -373,6 +378,7 @@ class ContentType(object):
         'page': l_('page'),
         'thread': l_('thread'),
         'comment': l_('comment'),
+        'event': l_('event'),
     }
 
     _DELETE_LABEL = {
@@ -383,6 +389,7 @@ class ContentType(object):
         'page': l_('Delete this page'),
         'thread': l_('Delete this thread'),
         'comment': l_('Delete this comment'),
+        'event': l_('Delete this event'),
     }
 
     @classmethod
@@ -396,7 +403,8 @@ class ContentType(object):
 
     @classmethod
     def allowed_types(cls):
-        return [cls.Folder, cls.File, cls.Comment, cls.Thread, cls.Page]
+        return [cls.Folder, cls.File, cls.Comment, cls.Thread, cls.Page,
+                cls.Event]
 
     @classmethod
     def allowed_types_for_folding(cls):
@@ -473,7 +481,18 @@ class ContentChecker(object):
                 return False
             if 'threads' not in properties['allowed_content']:
                 return False
+            return True
 
+        if item.type == ContentType.Event:
+            properties = item.properties
+            if 'name' not in properties.keys():
+                return False
+            if 'raw' not in properties.keys():
+                return False
+            if 'start' not in properties.keys():
+                return False
+            if 'end' not in properties.keys():
+                return False
             return True
 
         raise NotImplementedError

tracim/tracim/model/organizational.py

@@ -11,6 +11,10 @@ class Calendar(object):
         self._related_object = related_object
         self._path = path
 
+    @property
+    def related_object(self):
+        return self._related_object
+
     def user_can_read(self, user: User) -> bool:
         raise NotImplementedError()