from typing import * import royalnet.constellation.api as rca import royalnet.utils as ru from royalnet.backpack.tables import * from ..tables import * import datetime class ApiWikiStar(rca.ApiStar): path = "/api/wiki/v2" tags = ["wiki"] methods = ["GET", "POST", "PUT", "DELETE"] parameters = { "get": { "page_id": "The id of the wiki page to get the details of." }, "post": { "category": "The category of the page.", "title": "The title of the page.", "contents": "The contents of the page.", "format": "(Optional) The format of the page. Default is 'gfm' for GitHub Flavored Markdown.", "role_to_view": "(Optional) The role required to view this page. Be careful to not lock yourself out!", "role_to_edit": "(Optional) The role required to edit this page. Be careful to not lock yourself out!", }, "put": { "page_id": "The id of the wiki page to create a new revision of.", "category": "The category of the page.", "title": "The title of the page.", "contents": "The contents of the page.", "format": "The format of the page. Default is 'gfm' for GitHub Flavored Markdown.", "role_to_view": "The role required to view this page. Be careful to not lock yourself out!", "role_to_edit": "The role required to edit this page. Be careful to not lock yourself out!", }, "delete": { "page_id": "The id of the wiki page to delete.", }, } @property def default_view_role(self) -> str: return self.config["wikipack"]["roles"]["view"] async def can_view(self, user: User, page: WikiPage) -> bool: lr = page.latest_revision if lr.role_to_view == "": return True if lr.role_to_view: if lr.role_to_view in user.roles or self.admin_role in user.roles: return True return False return True @property def default_edit_role(self) -> str: return self.config["wikipack"]["roles"]["edit"] async def can_edit(self, user: User, page: WikiPage) -> bool: lr = page.latest_revision if lr.role_to_edit == "": return True if lr.role_to_edit: if lr.role_to_edit in user.roles or self.admin_role in user.roles: return True return False return True @property def create_role(self) -> str: return self.config["wikipack"]["roles"]["create"] async def can_create(self, user: User) -> bool: if self.create_role in user.roles or self.admin_role in user.roles: return True return False @property def delete_role(self) -> str: return self.config["wikipack"]["roles"]["delete"] async def can_delete(self, user: User) -> bool: if self.delete_role == "": return True if self.delete_role in user.roles or self.admin_role in user.roles: return True return False @property def admin_role(self) -> str: return self.config["wikipack"]["roles"]["admin"] async def find_page(self, data: rca.ApiData) -> Tuple[WikiPage, WikiRevision]: WikiPageT = self.alchemy.get(WikiPage) page_id = data.int("page_id") page: WikiPage = await ru.asyncify( data.session.query(WikiPageT).filter_by(page_id=page_id).one_or_none ) if page is None: raise rca.NotFoundError(f"No page found with the id `{page_id}`.") return page, page.latest_revision async def get(self, data: rca.ApiData) -> ru.JSON: """Get the details of a specific Wiki page.""" page, lr = await self.find_page(data) user = await data.user() if not self.can_view(user, page): raise rca.ForbiddenError(f"Viewing this page requires the `{lr.role_to_view}` role.") return lr.json() async def post(self, data: rca.ApiData) -> ru.JSON: """Create a new Wiki page.""" WikiRevisionT = self.alchemy.get(WikiRevision) user = await data.user() if not self.can_create(user): raise rca.ForbiddenError(f"Creating a new page requires the `{self.create_role}` role.") category = data.str("category", optional=False) title = data.str("title", optional=False) contents = data.str("contents", optional=False) format_ = data.str("format", optional=True) role_to_view = data.str("role_to_view", optional=True) role_to_edit = data.str("role_to_edit", optional=True) page = WikiPage() data.session.add(page) data.session.flush() nr: WikiRevision = WikiRevisionT( page_id=page.page_id, category=category, title=title, contents=contents, format=format_ or "gfm", author=user, timestamp=datetime.datetime.now(), role_to_view=role_to_view or self.default_view_role, role_to_edit=role_to_edit or self.default_edit_role, ) data.session.add(nr) await data.session.commit() return nr.json() async def put(self, data: rca.ApiData) -> ru.JSON: """Edit a specific Wiki page, creating a new revision.""" WikiRevisionT = self.alchemy.get(WikiRevision) page, lr = await self.find_page(data) user = await data.user() if not self.can_edit(user, page): raise rca.ForbiddenError(f"Editing this page requires the `{lr.role_to_edit}` role.") category = data.str("category", optional=True) title = data.str("title", optional=True) contents = data.str("contents", optional=True) format_ = data.str("format", optional=True) role_to_view = data.str("role_to_view", optional=True) role_to_edit = data.str("role_to_edit", optional=True) nr: WikiRevision = WikiRevisionT( page_id=page.page_id, category=category or lr.category, title=title or lr.title, contents=contents or lr.contents, format=format_ or lr.format, author=user, timestamp=datetime.datetime.now(), role_to_view=role_to_view or lr.role_to_view, role_to_edit=role_to_edit or lr.role_to_edit, ) data.session.add(nr) await data.session.commit() return nr.json() async def delete(self, data: rca.ApiData) -> ru.JSON: """Delete a specific Wiki page and all its revisions.""" WikiDeletionT = self.alchemy.get(WikiDeletion) page, lr = await self.find_page(data) user = await data.user() if not self.can_delete(user): raise rca.ForbiddenError(f"Deleting pages requires the `{self.delete_role}` role.") deletion = WikiDeletionT( page_id=page.page_id, deleted_by=user, timestamp=datetime.datetime.now(), ) data.session.delete(page) data.session.add(deletion) await data.session.commit() return deletion.json()