add endpoint for previews

tracim/models/context_models.py

@@ -53,6 +53,29 @@ class WorkspaceAndContentRevisionPath(object):
         self.workspace_id = workspace_id
 
 
+class ContentPreviewSizedPath(object):
+    """
+    Paths params with workspace id and content_id, width, heigth
+    """
+    def __init__(self, workspace_id: int, content_id: int, width: int, height: int) -> None:  # nopep8
+        self.content_id = content_id
+        self.workspace_id = workspace_id
+        self.width = width
+        self.height = height
+
+
+class RevisionPreviewSizedPath(object):
+    """
+    Paths params with workspace id and content_id, revision_id width, heigth
+    """
+    def __init__(self, workspace_id: int, content_id: int, revision_id: int, width: int, height: int) -> None:  # nopep8
+        self.content_id = content_id
+        self.revision_id = revision_id
+        self.workspace_id = workspace_id
+        self.width = width
+        self.height = height
+
+
 class CommentPath(object):
     """
     Paths params with workspace id and content_id and comment_id model
@@ -68,6 +91,17 @@ class CommentPath(object):
         self.comment_id = comment_id
 
 
+class PageQuery(object):
+    """
+    Page query model
+    """
+    def __init__(
+            self,
+            page: int = 0
+    ):
+        self.page = page
+
+
 class ContentFilter(object):
     """
     Content filter model

tracim/views/contents_api/file_controller.py

@@ -20,6 +20,9 @@ from tracim.extensions import hapic
 from tracim.lib.core.content import ContentApi
 from tracim.views.controllers import Controller
 from tracim.views.core_api.schemas import FileContentSchema
+from tracim.views.core_api.schemas import ContentPreviewSizedPathSchema
+from tracim.views.core_api.schemas import RevisionPreviewSizedPathSchema
+from tracim.views.core_api.schemas import PageQuerySchema
 from tracim.views.core_api.schemas import WorkspaceAndContentRevisionIdPathSchema  # nopep8
 from tracim.views.core_api.schemas import FileRevisionSchema
 from tracim.views.core_api.schemas import SetContentStatusSchema
@@ -126,45 +129,177 @@ class FileController(Controller):
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_query(PageQuerySchema())
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
     @hapic.output_file([])
     def preview_pdf(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        file_path = api.get_one_revision_filepath(content.revision_id)
+        if hapic_data.query.page >= preview_manager.get_page_nb(file_path):
+            raise Exception('page {page} of content {content_id} does not exist'.format(
+                page=hapic_data.query.page,
+                content_id=content.content_id),
+            )
+        pdf_preview_path = preview_manager.get_pdf_preview(file_path, page=hapic_data.query.page)  # nopep8
+        return FileResponse(pdf_preview_path)
 
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
     @hapic.output_file([])
     def preview_pdf_full(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        file_path = api.get_one_revision_filepath(content.revision_id)
+        pdf_preview_path = preview_manager.get_pdf_preview(file_path)
+        return FileResponse(pdf_preview_path)
 
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_path(WorkspaceAndContentRevisionIdPathSchema())
+    @hapic.input_query(PageQuerySchema())
     @hapic.output_file([])
     def preview_pdf_revision(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        revision = api.get_one_revision(
+            revision_id=hapic_data.path.revision_id,
+            content=content
+        )
+        file_path = api.get_one_revision_filepath(revision.revision_id)
+        if hapic_data.query.page >= preview_manager.get_page_nb(file_path):
+            raise Exception('page {page} of content {content_id} does not exist'.format(
+                page=hapic_data.query.page,
+                content_id=content.content_id),
+            )
+        pdf_preview_path = preview_manager.get_pdf_preview(file_path, page=hapic_data.query.page)  # nopep8
+        return FileResponse(pdf_preview_path)
 
     # jpg
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_path(WorkspaceAndContentIdPathSchema())
+    @hapic.input_query(PageQuerySchema())
     @hapic.output_file([])
     def preview_jpg(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        file_path = api.get_one_revision_filepath(content.revision_id)
+        if hapic_data.query.page >= preview_manager.get_page_nb(file_path):
+            raise Exception('page {page} of content {content_id} does not exist'.format(
+                page=hapic_data.query.page,
+                content_id=content.content_id),
+            )
+        jpg_preview_path = preview_manager.get_jpeg_preview(file_path, page=hapic_data.query.page)  # nopep8
+        return FileResponse(jpg_preview_path)
 
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_query(PageQuerySchema())
+    @hapic.input_path(ContentPreviewSizedPathSchema())
     @hapic.output_file([])
     def sized_preview_jpg(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        file_path = api.get_one_revision_filepath(content.revision_id)
+        if hapic_data.query.page >= preview_manager.get_page_nb(file_path):
+            raise Exception('page {page} of content {content_id} does not exist'.format(
+                page=hapic_data.query.page,
+                content_id=content.content_id),
+            )
+        jpg_preview_path = preview_manager.get_jpeg_preview(
+            file_path,
+            page=hapic_data.query.page,
+            width=hapic_data.path.width,
+            height=hapic_data.path.height,
+        )
+        return FileResponse(jpg_preview_path)
 
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
+    @hapic.input_path(RevisionPreviewSizedPathSchema())
+    @hapic.input_query(PageQuerySchema())
     @hapic.output_file([])
     def sized_preview_jpg_revision(self, context, request: TracimRequest, hapic_data=None):
-        raise NotImplemented()
+        app_config = request.registry.settings['CFG']
+        preview_manager = PreviewManager(app_config.PREVIEW_CACHE_DIR, create_folder=True)  # nopep8
+        api = ContentApi(
+            current_user=request.current_user,
+            session=request.dbsession,
+            config=app_config,
+        )
+        content = api.get_one(
+            hapic_data.path.content_id,
+            content_type=ContentType.Any
+        )
+        revision = api.get_one_revision(
+            revision_id=hapic_data.path.revision_id,
+            content=content
+        )
+        file_path = api.get_one_revision_filepath(revision.revision_id)
+        if hapic_data.query.page >= preview_manager.get_page_nb(file_path):
+            raise Exception('page {page} of content {content_id} does not exist'.format(
+                page=hapic_data.query.page,
+                content_id=content.content_id),
+            )
+        jpg_preview_path = preview_manager.get_jpeg_preview(
+            file_path,
+            page=hapic_data.query.page,
+            width=hapic_data.path.width,
+            height=hapic_data.path.height,
+        )
+        return FileResponse(jpg_preview_path)
 
     @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
     @require_workspace_role(UserRoleInWorkspace.READER)

tracim/views/core_api/schemas.py

@@ -1,7 +1,7 @@
 # coding=utf-8
 import marshmallow
 from marshmallow import post_load
-from marshmallow.validate import OneOf
+from marshmallow.validate import OneOf, Range
 
 from tracim.lib.utils.utils import DATETIME_FORMAT
 from tracim.models.auth import Profile
@@ -10,6 +10,9 @@ from tracim.models.contents import open_status
 from tracim.models.contents import ContentTypeLegacy as ContentType
 from tracim.models.contents import ContentStatusLegacy as ContentStatus
 from tracim.models.context_models import ContentCreation
+from tracim.models.context_models import ContentPreviewSizedPath
+from tracim.models.context_models import RevisionPreviewSizedPath
+from tracim.models.context_models import PageQuery
 from tracim.models.context_models import WorkspaceAndContentRevisionPath
 from tracim.models.context_models import CommentCreation
 from tracim.models.context_models import TextBasedContentUpdate
@@ -90,6 +93,7 @@ class WorkspaceIdPathSchema(marshmallow.Schema):
 class ContentIdPathSchema(marshmallow.Schema):
     content_id = marshmallow.fields.Int(example=6, required=True)
 
+
 class RevisionIdPathSchema(marshmallow.Schema):
     revision_id = marshmallow.fields.Int(example=6, required=True)
 
@@ -103,6 +107,11 @@ class WorkspaceAndContentIdPathSchema(
         return WorkspaceAndContentPath(**data)
 
 
+class WidthAndHeightPathSchema(marshmallow.Schema):
+    width = marshmallow.fields.Int(example=256)
+    height = marshmallow.fields.Int(example=256)
+
+
 class WorkspaceAndContentRevisionIdPathSchema(
     WorkspaceIdPathSchema,
     ContentIdPathSchema,
@@ -113,6 +122,24 @@ class WorkspaceAndContentRevisionIdPathSchema(
         return WorkspaceAndContentRevisionPath(**data)
 
 
+class ContentPreviewSizedPathSchema(
+    WorkspaceAndContentIdPathSchema,
+    WidthAndHeightPathSchema
+):
+    @post_load
+    def make_path_object(self, data):
+        return ContentPreviewSizedPath(**data)
+
+
+class RevisionPreviewSizedPathSchema(
+    WorkspaceAndContentRevisionIdPathSchema,
+    WidthAndHeightPathSchema
+):
+    @post_load
+    def make_path_object(self, data):
+        return RevisionPreviewSizedPath(**data)
+
+
 class CommentsPathSchema(WorkspaceAndContentIdPathSchema):
     comment_id = marshmallow.fields.Int(
         example=6,
@@ -124,6 +151,19 @@ class CommentsPathSchema(WorkspaceAndContentIdPathSchema):
         return CommentPath(**data)
 
 
+class PageQuerySchema(marshmallow.Schema):
+    page = marshmallow.fields.Int(
+        example=2,
+        default=0,
+        description='allow to show a specific page of a pdf file',
+        validate=Range(min=0, error="Value must be positive or 0"),
+    )
+
+    @post_load
+    def make_page_query(self, data):
+        return PageQuery(**data)
+
+
 class FilterContentQuerySchema(marshmallow.Schema):
     parent_id = marshmallow.fields.Int(
         example=2,