class FolderController(Controller):
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_FOLDER_ENDPOINTS])
@require_workspace_role(UserRoleInWorkspace.READER)
@require_content_types([FOLDER_TYPE])
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedContentSchema())
def get_folder(self, context, request: TracimRequest, hapic_data=None) -> ContentInContext: # nopep8
"""
Get folder info
"""
app_config = request.registry.settings['CFG']
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(
hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG
)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_FOLDER_ENDPOINTS])
@hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
@hapic.handle_exception(ContentFilenameAlreadyUsedInFolder, HTTPStatus.BAD_REQUEST)
@require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
@require_content_types([FOLDER_TYPE])
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(FolderContentModifySchema())
@hapic.output_body(TextBasedContentSchema())
def update_folder(self, context, request: TracimRequest, hapic_data=None) -> ContentInContext: # nopep8
"""
update folder
"""
app_config = request.registry.settings['CFG']
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(
hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG
)
with new_revision(
session=request.dbsession,
tm=transaction.manager,
content=content
):
api.update_content(
item=content,
new_label=hapic_data.body.label,
new_content=hapic_data.body.raw_content,
)
api.set_allowed_content(
content=content,
allowed_content_type_slug_list=hapic_data.body.sub_content_types # nopep8
)
api.save(content)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_FOLDER_ENDPOINTS])
@require_workspace_role(UserRoleInWorkspace.READER)
@require_content_types([FOLDER_TYPE])
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedRevisionSchema(many=True))
def get_folder_revisions(
self,
context,
request: TracimRequest,
hapic_data=None
) -> typing.List[RevisionInContext]:
"""
get folder revisions
"""
app_config = request.registry.settings['CFG']
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(
hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG
)
revisions = content.revisions
return [
api.get_revision_in_context(revision)
for revision in revisions
]
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_FOLDER_ENDPOINTS])
@require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
@require_content_types([FOLDER_TYPE])
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(SetContentStatusSchema())
@hapic.output_body(NoContentSchema(), default_http_code=HTTPStatus.NO_CONTENT) # nopep8
def set_folder_status(self, context, request: TracimRequest, hapic_data=None) -> None: # nopep8
"""
set folder status
"""
app_config = request.registry.settings['CFG']
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(
hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG
)
with new_revision(
session=request.dbsession,
tm=transaction.manager,
content=content
):
api.set_status(
content,
hapic_data.body.status,
)
api.save(content)
return
def bind(self, configurator: Configurator) -> None:
# Get folder
configurator.add_route(
'folder',
'/workspaces/{workspace_id}/folders/{content_id}',
request_method='GET'
)
configurator.add_view(self.get_folder, route_name='folder') # nopep8
# update folder
configurator.add_route(
'update_folder',
'/workspaces/{workspace_id}/folders/{content_id}',
request_method='PUT'
) # nopep8
configurator.add_view(self.update_folder, route_name='update_folder') # nopep8
# get folder revisions
configurator.add_route(
'folder_revisions',
'/workspaces/{workspace_id}/folders/{content_id}/revisions', # nopep8
request_method='GET'
)
configurator.add_view(self.get_folder_revisions, route_name='folder_revisions') # nopep8
# get folder revisions
configurator.add_route(
'set_folder_status',
'/workspaces/{workspace_id}/folders/{content_id}/status', # nopep8
request_method='PUT'
)
configurator.add_view(self.set_folder_status, route_name='set_folder_status') # nopep8
class ThreadController(Controller):
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_THREAD_ENDPOINTS])
@check_right(is_reader)
@check_right(is_thread_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedContentSchema())
def get_thread(self,
context,
request: TracimRequest,
hapic_data=None) -> ContentInContext:
"""
Get thread content
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_THREAD_ENDPOINTS])
@hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
@hapic.handle_exception(ContentFilenameAlreadyUsedInFolder,
HTTPStatus.BAD_REQUEST)
@check_right(is_contributor)
@check_right(is_thread_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(TextBasedContentModifySchema())
@hapic.output_body(TextBasedContentSchema())
def update_thread(self,
context,
request: TracimRequest,
hapic_data=None) -> ContentInContext:
"""
update thread
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG)
with new_revision(session=request.dbsession,
tm=transaction.manager,
content=content):
api.update_content(
item=content,
new_label=hapic_data.body.label,
new_content=hapic_data.body.raw_content,
)
api.save(content)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_THREAD_ENDPOINTS])
@check_right(is_reader)
@check_right(is_thread_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedRevisionSchema(many=True))
def get_thread_revisions(
self,
context,
request: TracimRequest,
hapic_data=None) -> typing.List[RevisionInContext]:
"""
get thread revisions
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG)
revisions = content.revisions
return [
api.get_revision_in_context(revision) for revision in revisions
]
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_THREAD_ENDPOINTS])
@check_right(is_contributor)
@check_right(is_thread_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(SetContentStatusSchema())
@hapic.output_body(NoContentSchema(),
default_http_code=HTTPStatus.NO_CONTENT)
@hapic.handle_exception(ContentStatusException, HTTPStatus.BAD_REQUEST)
def set_thread_status(self,
context,
request: TracimRequest,
hapic_data=None) -> None:
"""
set thread status
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id,
content_type=content_type_list.Any_SLUG)
if content.status == request.json_body.get("status"):
raise ContentStatusException(
"Content id {} already have status {}".format(
content.content_id, content.status))
with new_revision(session=request.dbsession,
tm=transaction.manager,
content=content):
api.set_status(content, hapic_data.body.status)
api.save(content)
return
def bind(self, configurator: Configurator) -> None:
# Get thread
configurator.add_route(
"thread",
"/workspaces/{workspace_id}/threads/{content_id}",
request_method="GET")
configurator.add_view(self.get_thread, route_name="thread")
# update thread
configurator.add_route(
"update_thread",
"/workspaces/{workspace_id}/threads/{content_id}",
request_method="PUT")
configurator.add_view(self.update_thread, route_name="update_thread")
# get thread revisions
configurator.add_route(
"thread_revisions",
"/workspaces/{workspace_id}/threads/{content_id}/revisions",
request_method="GET",
)
configurator.add_view(self.get_thread_revisions,
route_name="thread_revisions")
# get thread revisions
configurator.add_route(
"set_thread_status",
"/workspaces/{workspace_id}/threads/{content_id}/status",
request_method="PUT",
)
configurator.add_view(self.set_thread_status,
route_name="set_thread_status")
class HTMLDocumentController(Controller):
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_HTML_DOCUMENT_ENDPOINTS])
@check_right(is_reader)
@check_right(is_html_document_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedContentSchema())
def get_html_document(
self, context, request: TracimRequest, hapic_data=None
) -> ContentInContext:
"""
Get html document content
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id, content_type=content_type_list.Any_SLUG)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_HTML_DOCUMENT_ENDPOINTS])
@check_right(is_reader)
@check_right(is_html_document_content)
@hapic.input_query(FileQuerySchema())
@hapic.input_path(FilePathSchema())
@hapic.output_file([])
def get_html_document_preview(
self, context, request: TracimRequest, hapic_data=None
) -> HapicFile:
"""
Download preview of html document
Good pratice for filename is filename is `{label}{file_extension}` or `{filename}`.
Default filename value is 'raw' (without file extension) or nothing.
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id, content_type=content_type_list.Any_SLUG)
file = BytesIO()
byte_size = file.write(content.description.encode("utf-8"))
file.seek(0)
filename = hapic_data.path.filename
# INFO - G.M - 2019-08-08 - use given filename in all case but none or
# "raw", where filename returned will be original file one.
if not filename or filename == "raw":
filename = content.file_name
return HapicFile(
file_object=file,
mimetype=CONTENT_TYPE_TEXT_HTML,
filename=filename,
as_attachment=hapic_data.query.force_download,
content_length=byte_size,
last_modified=content.updated,
)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_HTML_DOCUMENT_ENDPOINTS])
@hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
@hapic.handle_exception(ContentFilenameAlreadyUsedInFolder, HTTPStatus.BAD_REQUEST)
@hapic.handle_exception(UserNotMemberOfWorkspace, HTTPStatus.BAD_REQUEST)
@check_right(is_contributor)
@check_right(is_html_document_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(TextBasedContentModifySchema())
@hapic.output_body(TextBasedContentSchema())
def update_html_document(
self, context, request: TracimRequest, hapic_data=None
) -> ContentInContext:
"""
update_html_document
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id, content_type=content_type_list.Any_SLUG)
with new_revision(session=request.dbsession, tm=transaction.manager, content=content):
api.update_content(
item=content,
new_label=hapic_data.body.label,
new_content=hapic_data.body.raw_content,
)
api.save(content)
api.execute_update_content_actions(content)
return api.get_content_in_context(content)
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_HTML_DOCUMENT_ENDPOINTS])
@check_right(is_reader)
@check_right(is_html_document_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.output_body(TextBasedRevisionSchema(many=True))
def get_html_document_revisions(
self, context, request: TracimRequest, hapic_data=None
) -> typing.List[RevisionInContext]:
"""
get html_document revisions
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id, content_type=content_type_list.Any_SLUG)
revisions = content.revisions
return [api.get_revision_in_context(revision) for revision in revisions]
@hapic.with_api_doc(tags=[SWAGGER_TAG__CONTENT_HTML_DOCUMENT_ENDPOINTS])
@check_right(is_contributor)
@check_right(is_html_document_content)
@hapic.input_path(WorkspaceAndContentIdPathSchema())
@hapic.input_body(SetContentStatusSchema())
@hapic.output_body(NoContentSchema(), default_http_code=HTTPStatus.NO_CONTENT)
@hapic.handle_exception(ContentStatusException, HTTPStatus.BAD_REQUEST)
def set_html_document_status(self, context, request: TracimRequest, hapic_data=None) -> None:
"""
set html_document status
"""
app_config = request.registry.settings["CFG"] # type: CFG
api = ContentApi(
show_archived=True,
show_deleted=True,
current_user=request.current_user,
session=request.dbsession,
config=app_config,
)
content = api.get_one(hapic_data.path.content_id, content_type=content_type_list.Any_SLUG)
if content.status == request.json_body.get("status"):
raise ContentStatusException(
"Content id {} already have status {}".format(content.content_id, content.status)
)
with new_revision(session=request.dbsession, tm=transaction.manager, content=content):
api.set_status(content, hapic_data.body.status)
api.save(content)
api.execute_update_content_actions(content)
return
def bind(self, configurator: Configurator) -> None:
# Get html-document
configurator.add_route(
"html_document",
"/workspaces/{workspace_id}/html-documents/{content_id}",
request_method="GET",
)
configurator.add_view(self.get_html_document, route_name="html_document")
# get html-document preview
configurator.add_route(
"preview_html",
"/workspaces/{workspace_id}/html-documents/{content_id}/preview/html/{filename:[^/]*}",
request_method="GET",
)
configurator.add_view(self.get_html_document_preview, route_name="preview_html")
# update html-document
configurator.add_route(
"update_html_document",
"/workspaces/{workspace_id}/html-documents/{content_id}",
request_method="PUT",
)
configurator.add_view(self.update_html_document, route_name="update_html_document")
# get html document revisions
configurator.add_route(
"html_document_revisions",
"/workspaces/{workspace_id}/html-documents/{content_id}/revisions",
request_method="GET",
)
configurator.add_view(
self.get_html_document_revisions, route_name="html_document_revisions"
)
# get html document revisions
configurator.add_route(
"set_html_document_status",
"/workspaces/{workspace_id}/html-documents/{content_id}/status",
request_method="PUT",
)
configurator.add_view(self.set_html_document_status, route_name="set_html_document_status")