Merge pull request #96 from tracim/fix/621_add_worskpace_filter_by_content_type

tracim/lib/core/content.py

@@ -726,13 +726,15 @@ class ContentApi(object):
 
     def get_all(self, parent_id: int=None, content_type: str=ContentType.Any, workspace: Workspace=None) -> typing.List[Content]:
         assert parent_id is None or isinstance(parent_id, int) # DYN_REMOVE
-        assert content_type is not None# DYN_REMOVE
-        assert isinstance(content_type, str) # DYN_REMOVE
-
+        if not content_type:
+            content_type = ContentType.Any
         resultset = self._base_query(workspace)
 
         if content_type!=ContentType.Any:
-            resultset = resultset.filter(Content.type==content_type)
+            # INFO - G.M - 2018-07-05 - convert with
+            #  content type object to support legacy slug
+            content_type_object = ContentType(content_type)
+            resultset = resultset.filter(Content.type.in_(content_type_object.get_slug_aliases()))
 
         if parent_id:
             resultset = resultset.filter(Content.parent_id==parent_id)

tracim/models/contents.py

@@ -251,6 +251,19 @@ class ContentTypeLegacy(NewContentType):
                 return
         raise ContentTypeNotExist()
 
+    def get_slug_aliases(self) -> typing.List[str]:
+        """
+        Get all slug aliases of a content,
+        useful for legacy code convertion
+        """
+        # TODO - G.M - 2018-07-05 - Remove this legacy compat code
+        # when possible.
+        page_alias = [self.Page, self.PageLegacy]
+        if self.slug in page_alias:
+            return page_alias
+        else:
+            return [self.slug]
+
     @classmethod
     def all(cls) -> typing.List[str]:
         return cls.allowed_types()
@@ -261,6 +274,15 @@ class ContentTypeLegacy(NewContentType):
         return contents_types
 
     @classmethod
+    def allowed_type_values(cls) -> typing.List[str]:
+        """
+        All content type slug + special values like any
+        """
+        content_types = cls.allowed_types()
+        content_types.append(ContentTypeLegacy.Any)
+        return content_types
+
+    @classmethod
     def allowed_types_for_folding(cls):
         # This method is used for showing only "main"
         # types in the left-side treeview

tracim/models/context_models.py

@@ -68,11 +68,13 @@ class ContentFilter(object):
             show_archived: int = 0,
             show_deleted: int = 0,
             show_active: int = 1,
+            content_type: str = None,
     ) -> None:
         self.parent_id = parent_id
         self.show_archived = bool(show_archived)
         self.show_deleted = bool(show_deleted)
         self.show_active = bool(show_active)
+        self.content_type = content_type
 
 
 class ContentCreation(object):

tracim/tests/functional/test_workspaces.py

@@ -2,6 +2,15 @@
 """
 Tests for /api/v2/workspaces subpath endpoints.
 """
+
+import transaction
+from depot.io.utils import FileIntent
+
+from tracim import models
+from tracim.lib.core.content import ContentApi
+from tracim.lib.core.workspace import WorkspaceApi
+from tracim.models import get_tm_session
+from tracim.models.data import ContentType
 from tracim.tests import FunctionalTest
 from tracim.tests import set_html_document_slug_to_legacy
 from tracim.fixtures.content import Content as ContentFixtures
@@ -241,6 +250,7 @@ class TestWorkspaceContents(FunctionalTest):
         assert len(res) == 3
         content = res[0]
         assert content['content_id'] == 1
+        assert content['content_type'] == 'folder'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Tools'
@@ -252,6 +262,7 @@ class TestWorkspaceContents(FunctionalTest):
         assert content['workspace_id'] == 1
         content = res[1]
         assert content['content_id'] == 2
+        assert content['content_type'] == 'folder'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Menus'
@@ -263,6 +274,37 @@ class TestWorkspaceContents(FunctionalTest):
         assert content['workspace_id'] == 1
         content = res[2]
         assert content['content_id'] == 11
+        assert content['content_type'] == 'html-documents'
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Current Menu'
+        assert content['parent_id'] == 2
+        assert content['show_in_ui'] is True
+        assert content['slug'] == 'current-menu'
+        assert content['status'] == 'open'
+        assert set(content['sub_content_types']) == {'thread', 'html-documents', 'folder', 'file'}  # nopep8
+        assert content['workspace_id'] == 1
+
+    def test_api__get_workspace_content__ok_200__get_default_html_documents(self):
+        """
+        Check obtain workspace contents with defaults filters + content_filter
+        """
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        params = {
+            'content_type': 'html-documents',
+        }
+        res = self.testapp.get('/api/v2/workspaces/1/contents', status=200, params=params).json_body   # nopep8
+        assert len(res) == 1
+        content = res[0]
+        assert content
+        assert content['content_id'] == 11
+        assert content['content_type'] == 'html-documents'
         assert content['is_archived'] is False
         assert content['is_deleted'] is False
         assert content['label'] == 'Current Menu'
@@ -539,6 +581,210 @@ class TestWorkspaceContents(FunctionalTest):
         assert res == []
 
     # Folder related
+    def test_api__get_workspace_content__ok_200__get_all_filter_content_thread(self):
+        # prepare data
+        dbsession = get_tm_session(self.session_factory, transaction.manager)
+        admin = dbsession.query(models.User) \
+            .filter(models.User.email == 'admin@admin.admin') \
+            .one()
+        workspace_api = WorkspaceApi(
+            current_user=admin,
+            session=dbsession,
+            config=self.app_config
+        )
+        business_workspace = workspace_api.get_one(1)
+        content_api = ContentApi(
+            current_user=admin,
+            session=dbsession,
+            config=self.app_config
+        )
+        tool_folder = content_api.get_one(1, content_type=ContentType.Any)
+        test_thread = content_api.create(
+            content_type=ContentType.Thread,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='Test Thread',
+            do_save=False,
+            do_notify=False,
+        )
+        test_thread.description = 'Thread description'
+        dbsession.add(test_thread)
+        test_file = content_api.create(
+            content_type=ContentType.File,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='Test file',
+            do_save=False,
+            do_notify=False,
+        )
+        test_file.file_extension = '.txt'
+        test_file.depot_file = FileIntent(
+            b'Test file',
+            'Test_file.txt',
+            'text/plain',
+        )
+        test_page_legacy = content_api.create(
+            content_type=ContentType.Page,
+            workspace=business_workspace,
+            label='test_page',
+            do_save=False,
+            do_notify=False,
+        )
+        test_page_legacy.type = ContentType.PageLegacy
+        content_api.update_content(test_page_legacy, 'test_page', '<p>PAGE</p>')
+        test_html_document = content_api.create(
+            content_type=ContentType.Page,
+            workspace=business_workspace,
+            label='test_html_page',
+            do_save=False,
+            do_notify=False,
+        )
+        content_api.update_content(test_html_document, 'test_page', '<p>HTML_DOCUMENT</p>')  # nopep8
+        dbsession.flush()
+        transaction.commit()
+        # test-itself
+        params = {
+            'parent_id': 1,
+            'show_archived': 1,
+            'show_deleted': 1,
+            'show_active': 1,
+            'content_type': 'thread',
+        }
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.get(
+            '/api/v2/workspaces/1/contents',
+            status=200,
+            params=params,
+        ).json_body
+        assert len(res) == 1
+        content = res[0]
+        assert content['content_type'] == 'thread'
+        assert content['content_id']
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'Test Thread'
+        assert content['parent_id'] == 1
+        assert content['show_in_ui'] is True
+        assert content['slug'] == 'test-thread'
+        assert content['status'] == 'open'
+        assert set(content['sub_content_types']) == {'thread', 'html-documents', 'folder', 'file'}  # nopep8
+        assert content['workspace_id'] == 1
+
+    def test_api__get_workspace_content__ok_200__get_all_filter_content_html_and_legacy_page(self):  # nopep8
+        # prepare data
+        dbsession = get_tm_session(self.session_factory, transaction.manager)
+        admin = dbsession.query(models.User) \
+            .filter(models.User.email == 'admin@admin.admin') \
+            .one()
+        workspace_api = WorkspaceApi(
+            current_user=admin,
+            session=dbsession,
+            config=self.app_config
+        )
+        business_workspace = workspace_api.get_one(1)
+        content_api = ContentApi(
+            current_user=admin,
+            session=dbsession,
+            config=self.app_config
+        )
+        tool_folder = content_api.get_one(1, content_type=ContentType.Any)
+        test_thread = content_api.create(
+            content_type=ContentType.Thread,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='Test Thread',
+            do_save=False,
+            do_notify=False,
+        )
+        test_thread.description = 'Thread description'
+        dbsession.add(test_thread)
+        test_file = content_api.create(
+            content_type=ContentType.File,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='Test file',
+            do_save=False,
+            do_notify=False,
+        )
+        test_file.file_extension = '.txt'
+        test_file.depot_file = FileIntent(
+            b'Test file',
+            'Test_file.txt',
+            'text/plain',
+        )
+        test_page_legacy = content_api.create(
+            content_type=ContentType.Page,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='test_page',
+            do_save=False,
+            do_notify=False,
+        )
+        test_page_legacy.type = ContentType.PageLegacy
+        content_api.update_content(test_page_legacy, 'test_page', '<p>PAGE</p>')
+        test_html_document = content_api.create(
+            content_type=ContentType.Page,
+            workspace=business_workspace,
+            parent=tool_folder,
+            label='test_html_page',
+            do_save=False,
+            do_notify=False,
+        )
+        content_api.update_content(test_html_document, 'test_html_page', '<p>HTML_DOCUMENT</p>')  # nopep8
+        dbsession.flush()
+        transaction.commit()
+        # test-itself
+        params = {
+            'parent_id': 1,
+            'show_archived': 1,
+            'show_deleted': 1,
+            'show_active': 1,
+            'content_type': 'html-documents',
+        }
+        self.testapp.authorization = (
+            'Basic',
+            (
+                'admin@admin.admin',
+                'admin@admin.admin'
+            )
+        )
+        res = self.testapp.get(
+            '/api/v2/workspaces/1/contents',
+            status=200,
+            params=params,
+        ).json_body
+        assert len(res) == 2
+        content = res[0]
+        assert content['content_type'] == 'html-documents'
+        assert content['content_id']
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'test_page'
+        assert content['parent_id'] == 1
+        assert content['show_in_ui'] is True
+        assert content['slug'] == 'test-page'
+        assert content['status'] == 'open'
+        assert set(content['sub_content_types']) == {'thread', 'html-documents', 'folder', 'file'}  # nopep8
+        assert content['workspace_id'] == 1
+        content = res[1]
+        assert content['content_type'] == 'html-documents'
+        assert content['content_id']
+        assert content['is_archived'] is False
+        assert content['is_deleted'] is False
+        assert content['label'] == 'test_html_page'
+        assert content['parent_id'] == 1
+        assert content['show_in_ui'] is True
+        assert content['slug'] == 'test-html-page'
+        assert content['status'] == 'open'
+        assert set(content['sub_content_types']) == {'thread', 'html-documents', 'folder', 'file'}  # nopep8
+        assert content['workspace_id'] == 1
+        assert res[0]['content_id'] != res[1]['content_id']
 
     def test_api__get_workspace_content__ok_200__get_all_folder_content(self):
         """
@@ -549,6 +795,7 @@ class TestWorkspaceContents(FunctionalTest):
             'show_archived': 1,
             'show_deleted': 1,
             'show_active': 1,
+            'content_type': 'any'
         }
         self.testapp.authorization = (
             'Basic',

tracim/views/core_api/schemas.py

@@ -164,6 +164,11 @@ class FilterContentQuerySchema(marshmallow.Schema):
                     'to allow to show only archived documents',
         validate=Range(min=0, max=1, error="Value must be 0 or 1"),
     )
+    content_type = marshmallow.fields.String(
+        example=ContentType.Any,
+        default=ContentType.Any,
+        validate=OneOf(ContentType.allowed_type_values())
+    )
 
     @post_load
     def make_content_filter(self, data):

tracim/views/core_api/workspace_controller.py

@@ -109,6 +109,7 @@ class WorkspaceController(Controller):
         contents = api.get_all(
             parent_id=content_filter.parent_id,
             workspace=request.current_workspace,
+            content_type=content_filter.content_type,
         )
         contents = [
             api.get_content_in_context(content) for content in contents