Closes #186: Radicale show deleted/disabled workspaces calendar

tracim/development.ini.base

@@ -204,7 +204,7 @@ email.processing_mode = sync
 # radicale.server.host = 0.0.0.0
 # radicale.server.port = 5232
 # radicale.server.ssl = false
-# radicale.server.filesystem.folder = ~/.config/radicale/collections
+# radicale.server.filesystem.folder = ./radicale/collections
 # radicale.server.allow_origin = *
 # radicale.server.realm_message = Tracim Calendar - Password Required
 ## url can be extended like http://127.0.0.1:5232/calendar

tracim/tracim/config/app_cfg.py

@@ -272,7 +272,7 @@ class CFG(object):
         self.RADICALE_SERVER_SSL = asbool(tg.config.get('radicale.server.ssl', False))
         self.RADICALE_SERVER_FILE_SYSTEM_FOLDER = tg.config.get(
             'radicale.server.filesystem.folder',
-            '~/.config/radicale/collections'
+            './radicale/collections',
         )
         self.RADICALE_SERVER_ALLOW_ORIGIN = tg.config.get(
             'radicale.server.allow_origin',

tracim/tracim/controllers/admin/workspace.py

@@ -239,6 +239,8 @@ class WorkspaceRestController(TIMRestController, BaseController):
 
         if calendar_enabled:
             workspace_api_controller.ensure_calendar_exist(workspace)
+        else:
+            workspace_api_controller.disable_calendar(workspace)
 
         tg.flash(_('{} workspace updated.').format(workspace.label), CST.STATUS_OK)
         tg.redirect(self.url(workspace.workspace_id))

tracim/tracim/lib/calendar.py

@@ -391,3 +391,99 @@ END:VCALENDAR
         except PutError:
             pass  # TODO BS 20161128: Radicale is down. Record this event ?
 
+    def get_enabled_calendar_file_path(
+            self,
+            calendar_class,
+            related_object_id,
+    ) -> str:
+        from tracim.config.app_cfg import CFG
+        cfg = CFG.get_instance()
+
+        calendar_file_name = '{}.ics'.format(related_object_id)
+
+        if calendar_class == WorkspaceCalendar:
+            calendar_type_folder = 'workspace'
+        elif calendar_class == UserCalendar:
+            calendar_type_folder = 'user'
+        else:
+            raise NotImplementedError()
+
+        current_calendar_file_path = os.path.join(
+            cfg.RADICALE_SERVER_FILE_SYSTEM_FOLDER,
+            calendar_type_folder,
+            calendar_file_name,
+        )
+
+        return current_calendar_file_path
+
+    def get_deleted_calendar_file_path(
+            self,
+            calendar_class,
+            related_object_id,
+    ) -> str:
+        from tracim.config.app_cfg import CFG
+        cfg = CFG.get_instance()
+
+        calendar_file_name = '{}.ics'.format(related_object_id)
+
+        if calendar_class == WorkspaceCalendar:
+            calendar_type_folder = 'workspace'
+        elif calendar_class == UserCalendar:
+            calendar_type_folder = 'user'
+        else:
+            raise NotImplementedError()
+
+        deleted_calendar_file_path = os.path.join(
+            cfg.RADICALE_SERVER_FILE_SYSTEM_FOLDER,
+            calendar_type_folder,
+            'deleted',
+            calendar_file_name,
+        )
+
+        return deleted_calendar_file_path
+
+    def disable_calendar_file(
+            self,
+            calendar_class,
+            related_object_id: int,
+            raise_: bool=False,
+    ) -> None:
+        enabled_calendar_file_path = self.get_enabled_calendar_file_path(
+            calendar_class,
+            related_object_id,
+        )
+        deleted_calendar_file_path = self.get_deleted_calendar_file_path(
+            calendar_class,
+            related_object_id,
+        )
+
+        deleted_folder = os.path.dirname(deleted_calendar_file_path)
+        if not os.path.exists(deleted_folder):
+            os.makedirs(deleted_folder)
+
+        try:
+            os.rename(enabled_calendar_file_path, deleted_calendar_file_path)
+        except FileNotFoundError:
+            if raise_:
+                raise
+
+    def enable_calendar_file(
+            self,
+            calendar_class,
+            related_object_id: int,
+            raise_: bool=False,
+    ) -> None:
+        enabled_calendar_file_path = self.get_enabled_calendar_file_path(
+            calendar_class,
+            related_object_id,
+        )
+        deleted_calendar_file_path = self.get_deleted_calendar_file_path(
+            calendar_class,
+            related_object_id,
+        )
+
+        try:
+            os.rename(deleted_calendar_file_path, enabled_calendar_file_path)
+        except FileNotFoundError:
+            if raise_:
+                raise

tracim/tracim/lib/workspace.py

@@ -64,7 +64,9 @@ class WorkspaceApi(object):
             DBSession.flush()
 
         if calendar_enabled:
-            self.execute_created_workspace_actions(workspace)
+            self.ensure_calendar_exist(workspace)
+        else:
+            self.disable_calendar(workspace)
 
         return workspace
 
@@ -145,19 +147,39 @@ class WorkspaceApi(object):
         from tracim.lib.calendar import CalendarManager
         from tracim.model.organisational import WorkspaceCalendar
 
-        if workspace.calendar_enabled:
+        calendar_manager = CalendarManager(self._user)
+
+        try:
+            calendar_manager.enable_calendar_file(
+                calendar_class=WorkspaceCalendar,
+                related_object_id=workspace.workspace_id,
+                raise_=True,
+            )
+        # If previous calendar file no exist, calendar must be created
+        except FileNotFoundError:
             self._user.ensure_auth_token()
 
             # Ensure database is up-to-date
             DBSession.flush()
             transaction.commit()
 
-            calendar_manager = CalendarManager(self._user)
             calendar_manager.create_then_remove_fake_event(
                 calendar_class=WorkspaceCalendar,
                 related_object_id=workspace.workspace_id,
             )
 
+    def disable_calendar(self, workspace: Workspace) -> None:
+        # Note: Cyclic imports
+        from tracim.lib.calendar import CalendarManager
+        from tracim.model.organisational import WorkspaceCalendar
+
+        calendar_manager = CalendarManager(self._user)
+        calendar_manager.disable_calendar_file(
+            calendar_class=WorkspaceCalendar,
+            related_object_id=workspace.workspace_id,
+            raise_=False,
+        )
+
     def get_base_query(self) -> Query:
         return self._base_query()
 

tracim/tracim/tests/functional/test_calendar.py

@@ -312,3 +312,158 @@ END:VCALENDAR
             workspace_calendar_exist,
             'Workspace calendar should be created',
         )
+
+    def unit_test__disable_workspace_disable_file__ok__nominal_case(self):
+        self._connect_user(
+            'admin@admin.admin',
+            'admin@admin.admin',
+        )
+        radicale_workspaces_folder = '{0}/workspace'.format(
+            config.get('radicale.server.filesystem.folder'),
+        )
+        delete_radicale_workspaces_folder = '{0}/workspace/deleted'.format(
+            config.get('radicale.server.filesystem.folder'),
+        )
+
+        # Core after assume "test_created_workspace_radicale_calendar" is ok
+        self.app.post(
+            '/admin/workspaces',
+            OrderedDict([
+                ('name', 'WTESTCAL2'),
+                ('description', 'WTESTCAL2DESCR'),
+                ('calendar_enabled', 'on'),
+            ])
+        )
+        created_workspace = DBSession.query(Workspace)\
+            .filter(Workspace.label == 'WTESTCAL2')\
+            .one()
+        disable_response = self.app.put(
+            '/admin/workspaces/{}?_method=PUT'.format(
+                created_workspace.workspace_id,
+            ),
+            OrderedDict([
+                ('name', 'WTESTCAL2'),
+                ('description', 'WTESTCAL2DESCR'),
+                ('calendar_enabled', 'off'),
+            ])
+        )
+        eq_(disable_response.status_code, 302,
+            "Code should be 302, but is %d" % disable_response.status_code)
+        workspaces_calendars = [
+            name for name in
+            os.listdir(radicale_workspaces_folder)
+            if name.endswith('.ics')
+        ]
+        deleted_workspaces_calendars = [
+            name for name in
+            os.listdir(delete_radicale_workspaces_folder)
+            if name.endswith('.ics')
+        ]
+
+        eq_(
+            0,
+            len(workspaces_calendars),
+            msg='No workspace ics file should exist, but {} found'.format(
+                len(workspaces_calendars),
+            ),
+        )
+        eq_(
+            1,
+            len(deleted_workspaces_calendars),
+            msg='1 deleted workspace ics file should exist, but {} found'
+                .format(
+                    len(deleted_workspaces_calendars),
+                ),
+        )
+        workspace_ics_file_name = '{}.ics'.format(
+                created_workspace.workspace_id
+        )
+        ok_(
+            workspace_ics_file_name in deleted_workspaces_calendars,
+            '{} should be in deleted workspace calendar folder'.format(
+                workspace_ics_file_name
+            ),
+        )
+
+    def unit_test__re_enable_workspace_re_enable_file__ok__nominal_case(self):
+        self._connect_user(
+            'admin@admin.admin',
+            'admin@admin.admin',
+        )
+        radicale_workspaces_folder = '{0}/workspace'.format(
+            config.get('radicale.server.filesystem.folder'),
+        )
+        delete_radicale_workspaces_folder = '{0}/workspace/deleted'.format(
+            config.get('radicale.server.filesystem.folder'),
+        )
+
+        # Core after assume
+        # "unit_test__disable_workspace_disable_file__ok__nominal_case" is ok
+        self.app.post(
+            '/admin/workspaces',
+            OrderedDict([
+                ('name', 'WTESTCAL2'),
+                ('description', 'WTESTCAL2DESCR'),
+                ('calendar_enabled', 'on'),
+            ])
+        )
+        created_workspace = DBSession.query(Workspace) \
+            .filter(Workspace.label == 'WTESTCAL2') \
+            .one()
+        self.app.put(
+            '/admin/workspaces/{}?_method=PUT'.format(
+                created_workspace.workspace_id,
+            ),
+            OrderedDict([
+                ('name', 'WTESTCAL2'),
+                ('description', 'WTESTCAL2DESCR'),
+                ('calendar_enabled', 'off'),
+            ])
+        )
+        re_enable_response = self.app.put(
+            '/admin/workspaces/{}?_method=PUT'.format(
+                created_workspace.workspace_id,
+            ),
+            OrderedDict([
+                ('name', 'WTESTCAL2'),
+                ('description', 'WTESTCAL2DESCR'),
+                ('calendar_enabled', 'on'),
+            ])
+        )
+        eq_(re_enable_response.status_code, 302,
+            "Code should be 302, but is %d" % re_enable_response.status_code)
+        workspaces_calendars = [
+            name for name in
+            os.listdir(radicale_workspaces_folder)
+            if name.endswith('.ics')
+            ]
+        deleted_workspaces_calendars = [
+            name for name in
+            os.listdir(delete_radicale_workspaces_folder)
+            if name.endswith('.ics')
+            ]
+
+        eq_(
+            1,
+            len(workspaces_calendars),
+            msg='1 workspace ics file should exist, but {} found'.format(
+                len(workspaces_calendars),
+            ),
+        )
+        eq_(
+            0,
+            len(deleted_workspaces_calendars),
+            msg='0 deleted workspace ics file should exist, but {} found'
+                .format(
+                len(deleted_workspaces_calendars),
+            ),
+        )
+        workspace_ics_file_name = '{}.ics'.format(
+            created_workspace.workspace_id
+        )
+        ok_(
+            workspace_ics_file_name in workspaces_calendars,
+            '{} should be in workspace calendar folder'.format(
+                workspace_ics_file_name
+            ),
+        )