From 7fc6312d6df526b8eb49288aecf88d04668e7c45 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Mon, 29 Aug 2022 13:05:35 +0200 Subject: [proxy] make it possible to also view and install/uninstall libraries (resources) through the web UI --- src/hydrilla/item_infos.py | 42 ++ src/hydrilla/proxy/state.py | 51 ++- src/hydrilla/proxy/state_impl/concrete_state.py | 24 +- src/hydrilla/proxy/state_impl/items.py | 423 +++++++++++++++++++++ src/hydrilla/proxy/state_impl/mappings.py | 286 -------------- src/hydrilla/proxy/web_ui/items.py | 275 ++++++++++++++ src/hydrilla/proxy/web_ui/packages.py | 203 ---------- src/hydrilla/proxy/web_ui/root.py | 4 +- .../proxy/web_ui/templates/base.html.jinja | 9 +- .../web_ui/templates/libraries/index.html.jinja | 39 ++ .../templates/libraries/index.html.jinja.license | 7 + .../templates/libraries/show_single.html.jinja | 76 ++++ .../libraries/show_single.html.jinja.license | 7 + .../libraries/show_single_version.html.jinja | 94 +++++ .../show_single_version.html.jinja.license | 7 + .../web_ui/templates/packages/index.html.jinja | 10 +- .../templates/packages/show_single.html.jinja | 2 +- .../packages/show_single_version.html.jinja | 8 +- 18 files changed, 1036 insertions(+), 531 deletions(-) create mode 100644 src/hydrilla/proxy/state_impl/items.py delete mode 100644 src/hydrilla/proxy/state_impl/mappings.py create mode 100644 src/hydrilla/proxy/web_ui/items.py delete mode 100644 src/hydrilla/proxy/web_ui/packages.py create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/index.html.jinja create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/index.html.jinja.license create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/show_single.html.jinja create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/show_single.html.jinja.license create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/show_single_version.html.jinja create mode 100644 src/hydrilla/proxy/web_ui/templates/libraries/show_single_version.html.jinja.license diff --git a/src/hydrilla/item_infos.py b/src/hydrilla/item_infos.py index 2b89600..ddd1d80 100644 --- a/src/hydrilla/item_infos.py +++ b/src/hydrilla/item_infos.py @@ -38,6 +38,7 @@ if sys.version_info >= (3, 8): else: from typing_extensions import Protocol +import enum import typing as t import dataclasses as dc @@ -51,6 +52,7 @@ from .url_patterns import parse_pattern, ParsedUrl, ParsedPattern from .exceptions import HaketiloException from .translations import smart_gettext as _ + @dc.dataclass(frozen=True, unsafe_hash=True) class ItemSpecifier: """....""" @@ -274,6 +276,21 @@ class ResourceInfo(ItemInfoBase): repo_iteration ) + def __lt__(self, other: 'ResourceInfo') -> bool: + """....""" + return ( + self.identifier, + other.version, + other.revision, + self.repo, + other.repo_iteration + ) < ( + other.identifier, + self.version, + self.revision, + other.repo, + self.repo_iteration + ) def make_payloads(payloads_obj: t.Mapping[str, t.Any]) \ -> t.Mapping[ParsedPattern, ItemSpecifier]: @@ -346,6 +363,31 @@ class MappingInfo(ItemInfoBase): AnyInfo = t.Union[ResourceInfo, MappingInfo] +class ItemType(enum.Enum): + RESOURCE = 'resource' + MAPPING = 'mapping' + + @property + def info_class(self) -> t.Type[AnyInfo]: + if self == ItemType.RESOURCE: + return ResourceInfo + else: + return MappingInfo + + @property + def alt_name(self) -> str: + if self == ItemType.RESOURCE: + return 'library' + else: + return 'package' + + @property + def alt_name_plural(self) -> str: + if self == ItemType.RESOURCE: + return 'libraries' + else: + return 'packages' + LoadedType = t.TypeVar('LoadedType', ResourceInfo, MappingInfo) diff --git a/src/hydrilla/proxy/state.py b/src/hydrilla/proxy/state.py index 803e727..e8d8b15 100644 --- a/src/hydrilla/proxy/state.py +++ b/src/hydrilla/proxy/state.py @@ -227,10 +227,8 @@ class MappingStore(Store[MappingRef]): def get_display_infos(self) -> t.Sequence[MappingDisplayInfo]: ... - @dc.dataclass(frozen=True, unsafe_hash=True) # type: ignore[misc] class MappingVersionRef(Ref): - """....""" @abstractmethod def install(self) -> None: ... @@ -248,15 +246,49 @@ class MappingVersionStore(Store[MappingVersionRef]): pass +@dc.dataclass(frozen=True) +class ResourceDisplayInfo: + ref: 'ResourceRef' + identifier: str + +@dc.dataclass(frozen=True) +class ResourceVersionDisplayInfo: + ref: 'ResourceVersionRef' + info: item_infos.ResourceInfo + installed: InstalledStatus + active: ActiveStatus + is_orphan: bool + is_local: bool + @dc.dataclass(frozen=True, unsafe_hash=True) # type: ignore[misc] class ResourceRef(Ref): - """....""" - pass + @abstractmethod + def get_version_display_infos(self) \ + -> t.Sequence[ResourceVersionDisplayInfo]: + ... + +class ResourceStore(Store[ResourceRef]): + @abstractmethod + def get_display_infos(self) -> t.Sequence[ResourceDisplayInfo]: + ... @dc.dataclass(frozen=True, unsafe_hash=True) # type: ignore[misc] class ResourceVersionRef(Ref): - """....""" + @abstractmethod + def install(self) -> None: + ... + + @abstractmethod + def uninstall(self) -> t.Optional['ResourceVersionRef']: + ... + + @abstractmethod + def get_all_version_display_infos(self) \ + -> t.Sequence[ResourceVersionDisplayInfo]: + ... + +class ResourceVersionStore(Store[ResourceVersionRef]): pass @@ -360,23 +392,18 @@ class HaketiloState(ABC): @abstractmethod def mapping_store(self) -> MappingStore: - """....""" ... @abstractmethod def mapping_version_store(self) -> MappingVersionStore: - """....""" ... @abstractmethod - def get_resource(self, resource_id: str) -> ResourceRef: - """....""" + def resource_store(self) -> ResourceStore: ... @abstractmethod - def get_resource_version(self, resource_version_id: str) \ - -> ResourceVersionRef: - """....""" + def resource_version_store(self) -> ResourceVersionStore: ... @abstractmethod diff --git a/src/hydrilla/proxy/state_impl/concrete_state.py b/src/hydrilla/proxy/state_impl/concrete_state.py index f180ec6..6bc6404 100644 --- a/src/hydrilla/proxy/state_impl/concrete_state.py +++ b/src/hydrilla/proxy/state_impl/concrete_state.py @@ -47,7 +47,7 @@ from .. import state as st from .. import policies from .. import simple_dependency_satisfying as sds from . import base -from . import mappings +from . import items from . import repos from . import payloads from . import _operations @@ -61,15 +61,6 @@ class ConcreteRepoIterationRef(st.RepoIterationRef): pass -@dc.dataclass(frozen=True, unsafe_hash=True) -class ConcreteResourceRef(st.ResourceRef): - pass - - -@dc.dataclass(frozen=True, unsafe_hash=True) -class ConcreteResourceVersionRef(st.ResourceVersionRef): - pass - @dc.dataclass class ConcreteHaketiloState(base.HaketiloStateWithFields): def __post_init__(self) -> None: @@ -243,17 +234,16 @@ class ConcreteHaketiloState(base.HaketiloStateWithFields): return ConcreteRepoIterationRef(repo_iteration_id) def mapping_store(self) -> st.MappingStore: - return mappings.ConcreteMappingStore(self) + return items.ConcreteMappingStore(self) def mapping_version_store(self) -> st.MappingVersionStore: - return mappings.ConcreteMappingVersionStore(self) + return items.ConcreteMappingVersionStore(self) - def get_resource(self, resource_id: str) -> st.ResourceRef: - return ConcreteResourceRef(resource_id) + def resource_store(self) -> st.ResourceStore: + return items.ConcreteResourceStore(self) - def get_resource_version(self, resource_version_id: str) \ - -> st.ResourceVersionRef: - return ConcreteResourceVersionRef(resource_version_id) + def resource_version_store(self) -> st.ResourceVersionStore: + return items.ConcreteResourceVersionStore(self) def get_payload(self, payload_id: str) -> st.PayloadRef: raise NotImplementedError() diff --git a/src/hydrilla/proxy/state_impl/items.py b/src/hydrilla/proxy/state_impl/items.py new file mode 100644 index 0000000..b538dc5 --- /dev/null +++ b/src/hydrilla/proxy/state_impl/items.py @@ -0,0 +1,423 @@ +# SPDX-License-Identifier: GPL-3.0-or-later + +# Haketilo proxy data and configuration (ResourceStore and MappingStore +# implementations). +# +# This file is part of Hydrilla&Haketilo. +# +# Copyright (C) 2022 Wojtek Kosior +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# +# I, Wojtek Kosior, thereby promise not to sue for violation of this +# file's license. Although I request that you do not make use this code +# in a proprietary program, I am not going to enforce this in court. + +""" +This module provides an interface to interact with mappings, and resources +inside Haketilo. +""" + +# Enable using with Python 3.7. +from __future__ import annotations + +import sqlite3 +import typing as t +import dataclasses as dc + +from ... import item_infos +from .. import state as st +from . import base + +def _set_installed_status(cursor: sqlite3.Cursor, id: str, new_status: str) \ + -> None: + cursor.execute( + 'UPDATE item_versions SET installed = ? WHERE item_version_id = ?;', + (new_status, id) + ) + +def _get_statuses(cursor: sqlite3.Cursor, id: str) -> t.Tuple[str, str]: + cursor.execute( + ''' + SELECT + installed, active + FROM + item_versions + WHERE + item_version_id = ?; + ''', + (id,) + ) + + rows = cursor.fetchall() + + if rows == []: + raise st.MissingItemError() + + (installed_status, active_status), = rows + + return installed_status, active_status + +VersionRefVar = t.TypeVar( + 'VersionRefVar', + 'ConcreteResourceVersionRef', + 'ConcreteMappingVersionRef' +) + +def _install_version(ref: VersionRefVar) -> None: + with ref.state.cursor(transaction=True) as cursor: + installed_status, _ = _get_statuses(cursor, ref.id) + + if installed_status == 'I': + return + + _set_installed_status(cursor, ref.id, 'I') + + ref.state.pull_missing_files() + +def _uninstall_version(ref: VersionRefVar) -> t.Optional[VersionRefVar]: + with ref.state.cursor(transaction=True) as cursor: + installed_status, active_status = _get_statuses(cursor, ref.id) + + if installed_status == 'N': + return ref + + _set_installed_status(cursor, ref.id, 'N') + + ref.state.prune_orphans() + + if active_status == 'R': + ref.state.recompute_dependencies() + + cursor.execute( + 'SELECT COUNT(*) FROM item_versions WHERE item_version_id = ?;', + (ref.id,) + ) + + (version_still_present,), = cursor.fetchall() + return ref if version_still_present else None + + +@dc.dataclass(frozen=True, unsafe_hash=True) +class ConcreteMappingRef(st.MappingRef): + state: base.HaketiloStateWithFields = dc.field(hash=False, compare=False) + + def get_version_display_infos(self) \ + -> t.Sequence[st.MappingVersionDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + ''' + SELECT + ive.item_version_id, + ive.definition, + ive.repo, + ive.repo_iteration, + ive.installed, + ive.active, + ive.is_orphan, + ive.is_local, + ms.enabled + FROM + item_versions_extra AS ive + JOIN mapping_statuses AS ms USING (item_id) + WHERE + ive.item_id = ?; + ''', + (self.id,) + ) + + rows = cursor.fetchall() + + if rows == []: + raise st.MissingItemError() + + result = [] + + for (item_version_id, definition, repo, repo_iteration, + installed_status, active_status, is_orphan, is_local, + enabled_status) in rows: + ref = ConcreteMappingVersionRef(str(item_version_id), self.state) + + item_info = item_infos.MappingInfo.load( + definition, + repo, + repo_iteration + ) + + display_info = st.MappingVersionDisplayInfo( + ref = ref, + info = item_info, + installed = st.InstalledStatus(installed_status), + active = st.ActiveStatus(active_status), + is_orphan = is_orphan, + is_local = is_local, + mapping_enabled = st.EnabledStatus(enabled_status) + ) + result.append(display_info) + + return sorted(result, key=(lambda di: di.info)) + + +@dc.dataclass(frozen=True) +class ConcreteMappingStore(st.MappingStore): + state: base.HaketiloStateWithFields + + def get(self, id: str) -> st.MappingRef: + return ConcreteMappingRef(str(int(id)), self.state) + + def get_display_infos(self) -> t.Sequence[st.MappingDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + ''' + WITH available_item_ids AS ( + SELECT DISTINCT item_id FROM item_versions + ) + SELECT + i.item_id, + i.identifier, + ive.item_version_id, + ive.definition, + ive.repo, + ive.repo_iteration, + ive.installed, + ive.active, + ive.is_orphan, + ive.is_local, + ms.enabled + FROM + items AS i + JOIN mapping_statuses AS ms + USING (item_id) + LEFT JOIN item_versions_extra AS ive + ON ms.active_version_id = ive.item_version_id + WHERE + i.item_id IN available_item_ids; + ''' + ) + + rows = cursor.fetchall() + + result = [] + + for (item_id, identifier, item_version_id, definition, repo, + repo_iteration, installed_status, active_status, is_orphan, + is_local, enabled_status) in rows: + ref = ConcreteMappingRef(str(item_id), self.state) + + active_version: t.Optional[st.MappingVersionDisplayInfo] = None + + if item_version_id is not None: + active_version_ref = ConcreteMappingVersionRef( + id = str(item_version_id), + state = self.state + ) + + active_version_info = item_infos.MappingInfo.load( + definition, + repo, + repo_iteration + ) + + active_version = st.MappingVersionDisplayInfo( + ref = active_version_ref, + info = active_version_info, + installed = st.InstalledStatus(installed_status), + active = st.ActiveStatus(active_status), + is_orphan = is_orphan, + is_local = is_local, + mapping_enabled = st.EnabledStatus(enabled_status) + ) + + + display_info = st.MappingDisplayInfo( + ref = ref, + identifier = identifier, + enabled = st.EnabledStatus(enabled_status), + active_version = active_version + ) + + result.append(display_info) + + return sorted(result, key=(lambda di: di.identifier)) + + +@dc.dataclass(frozen=True, unsafe_hash=True) +class ConcreteMappingVersionRef(st.MappingVersionRef): + state: base.HaketiloStateWithFields + + def install(self) -> None: + return _install_version(self) + + def uninstall(self) -> t.Optional['ConcreteMappingVersionRef']: + return _uninstall_version(self) + + def get_all_version_display_infos(self) \ + -> t.Sequence[st.MappingVersionDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + ''' + SELECT + item_id + FROM + item_versions + WHERE + item_version_id = ?; + ''', + (self.id,) + ) + + rows = cursor.fetchall() + if rows == []: + raise st.MissingItemError() + + (mapping_id,), = rows + + mapping_ref = ConcreteMappingRef(str(mapping_id), self.state) + + return mapping_ref.get_version_display_infos() + + +@dc.dataclass(frozen=True) +class ConcreteMappingVersionStore(st.MappingVersionStore): + state: base.HaketiloStateWithFields + + def get(self, id: str) -> st.MappingVersionRef: + return ConcreteMappingVersionRef(str(int(id)), self.state) + + +@dc.dataclass(frozen=True, unsafe_hash=True) +class ConcreteResourceRef(st.ResourceRef): + state: base.HaketiloStateWithFields = dc.field(hash=False, compare=False) + + def get_version_display_infos(self) \ + -> t.Sequence[st.ResourceVersionDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + ''' + SELECT + ive.item_version_id, + ive.definition, + ive.repo, + ive.repo_iteration, + ive.installed, + ive.active, + ive.is_orphan, + ive.is_local + FROM + item_versions_extra AS ive + JOIN items AS i USING (item_id) + WHERE + i.type = 'R' AND ive.item_id = ?; + ''', + (self.id,) + ) + + rows = cursor.fetchall() + + if rows == []: + raise st.MissingItemError() + + result = [] + + for (item_version_id, definition, repo, repo_iteration, + installed_status, active_status, is_orphan, is_local) in rows: + ref = ConcreteResourceVersionRef(str(item_version_id), self.state) + + item_info = item_infos.ResourceInfo.load( + definition, + repo, + repo_iteration + ) + + display_info = st.ResourceVersionDisplayInfo( + ref = ref, + info = item_info, + installed = st.InstalledStatus(installed_status), + active = st.ActiveStatus(active_status), + is_orphan = is_orphan, + is_local = is_local + ) + result.append(display_info) + + return sorted(result, key=(lambda di: di.info)) + + +@dc.dataclass(frozen=True) +class ConcreteResourceStore(st.ResourceStore): + state: base.HaketiloStateWithFields + + def get(self, id: str) -> st.ResourceRef: + return ConcreteResourceRef(str(int(id)), self.state) + + def get_display_infos(self) -> t.Sequence[st.ResourceDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + "SELECT item_id, identifier FROM items WHERE type = 'R';" + ) + + rows = cursor.fetchall() + + result = [] + + for item_id, identifier in rows: + ref = ConcreteResourceRef(str(item_id), self.state) + + result.append(st.ResourceDisplayInfo(ref, identifier)) + + return sorted(result, key=(lambda di: di.identifier)) + + +@dc.dataclass(frozen=True, unsafe_hash=True) +class ConcreteResourceVersionRef(st.ResourceVersionRef): + state: base.HaketiloStateWithFields + + def install(self) -> None: + return _install_version(self) + + def uninstall(self) -> t.Optional['ConcreteResourceVersionRef']: + return _uninstall_version(self) + + def get_all_version_display_infos(self) \ + -> t.Sequence[st.ResourceVersionDisplayInfo]: + with self.state.cursor() as cursor: + cursor.execute( + ''' + SELECT + item_id + FROM + item_versions + WHERE + item_version_id = ?; + ''', + (self.id,) + ) + + rows = cursor.fetchall() + if rows == []: + raise st.MissingItemError() + + (resource_id,), = rows + + resource_ref = ConcreteResourceRef(str(resource_id), self.state) + + return resource_ref.get_version_display_infos() + + +@dc.dataclass(frozen=True) +class ConcreteResourceVersionStore(st.ResourceVersionStore): + state: base.HaketiloStateWithFields + + def get(self, id: str) -> st.ResourceVersionRef: + return ConcreteResourceVersionRef(str(int(id)), self.state) diff --git a/src/hydrilla/proxy/state_impl/mappings.py b/src/hydrilla/proxy/state_impl/mappings.py deleted file mode 100644 index eb8b4d2..0000000 --- a/src/hydrilla/proxy/state_impl/mappings.py +++ /dev/null @@ -1,286 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# Haketilo proxy data and configuration (MappingRef and MappingStore subtypes). -# -# This file is part of Hydrilla&Haketilo. -# -# Copyright (C) 2022 Wojtek Kosior -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -# -# I, Wojtek Kosior, thereby promise not to sue for violation of this -# file's license. Although I request that you do not make use this code -# in a proprietary program, I am not going to enforce this in court. - -""" -This module provides an interface to interact with mappings inside Haketilo. -""" - -# Enable using with Python 3.7. -from __future__ import annotations - -import sqlite3 -import typing as t -import dataclasses as dc - -from ... import item_infos -from .. import state as st -from . import base - - -@dc.dataclass(frozen=True, unsafe_hash=True) -class ConcreteMappingRef(st.MappingRef): - state: base.HaketiloStateWithFields = dc.field(hash=False, compare=False) - - def get_version_display_infos(self) \ - -> t.Sequence[st.MappingVersionDisplayInfo]: - with self.state.cursor() as cursor: - cursor.execute( - ''' - SELECT - ive.item_version_id, - ive.definition, - ive.repo, - ive.repo_iteration, - ive.installed, - ive.active, - ive.is_orphan, - ive.is_local, - ms.enabled - FROM - item_versions_extra AS ive - JOIN mapping_statuses AS ms USING (item_id) - WHERE - ive.item_id = ?; - ''', - (self.id,) - ) - - rows = cursor.fetchall() - - if rows == []: - raise st.MissingItemError() - - result = [] - - for (item_version_id, definition, repo, repo_iteration, - installed_status, active_status, is_orphan, is_local, - enabled_status) in rows: - ref = ConcreteMappingVersionRef(str(item_version_id), self.state) - - item_info = item_infos.MappingInfo.load( - definition, - repo, - repo_iteration - ) - - display_info = st.MappingVersionDisplayInfo( - ref = ref, - info = item_info, - installed = st.InstalledStatus(installed_status), - active = st.ActiveStatus(active_status), - is_orphan = is_orphan, - is_local = is_local, - mapping_enabled = st.EnabledStatus(enabled_status) - ) - result.append(display_info) - - return sorted(result, key=(lambda di: di.info)) - - -@dc.dataclass(frozen=True) -class ConcreteMappingStore(st.MappingStore): - state: base.HaketiloStateWithFields - - def get(self, id: str) -> st.MappingRef: - return ConcreteMappingRef(str(int(id)), self.state) - - def get_display_infos(self) -> t.Sequence[st.MappingDisplayInfo]: - with self.state.cursor() as cursor: - cursor.execute( - ''' - SELECT - i.item_id, - i.identifier, - ive.item_version_id, - ive.definition, - ive.repo, - ive.repo_iteration, - ive.installed, - ive.active, - ive.is_orphan, - ive.is_local, - ms.enabled - FROM - items AS i - JOIN mapping_statuses AS ms - USING (item_id) - LEFT JOIN item_versions_extra AS ive - ON ms.active_version_id = ive.item_version_id AND - ive.active IN ('R', 'A'); - ''' - ) - - rows = cursor.fetchall() - - result = [] - - for (item_id, identifier, item_version_id, definition, repo, - repo_iteration, installed_status, active_status, is_orphan, - is_local, enabled_status) in rows: - ref = ConcreteMappingRef(str(item_id), self.state) - - active_version: t.Optional[st.MappingVersionDisplayInfo] = None - - if item_version_id is not None: - active_version_ref = ConcreteMappingVersionRef( - id = str(item_version_id), - state = self.state - ) - - active_version_info = item_infos.MappingInfo.load( - definition, - repo, - repo_iteration - ) - - active_version = st.MappingVersionDisplayInfo( - ref = active_version_ref, - info = active_version_info, - installed = st.InstalledStatus(installed_status), - active = st.ActiveStatus(active_status), - is_orphan = is_orphan, - is_local = is_local, - mapping_enabled = st.EnabledStatus(enabled_status) - ) - - - display_info = st.MappingDisplayInfo( - ref = ref, - identifier = identifier, - enabled = st.EnabledStatus(enabled_status), - active_version = active_version - ) - - result.append(display_info) - - return sorted(result, key=(lambda di: di.identifier)) - - -@dc.dataclass(frozen=True, unsafe_hash=True) -class ConcreteMappingVersionRef(st.MappingVersionRef): - state: base.HaketiloStateWithFields = dc.field(hash=False, compare=False) - - def _set_installed_status(self, cursor: sqlite3.Cursor, new_status: str) \ - -> None: - cursor.execute( - ''' - UPDATE - item_versions - SET - installed = ? - WHERE - item_version_id = ?; - ''', - (new_status, self.id,) - ) - - def _get_statuses(self, cursor: sqlite3.Cursor) -> t.Tuple[str, str]: - cursor.execute( - ''' - SELECT - installed, active - FROM - item_versions - WHERE - item_version_id = ?; - ''', - (self.id,) - ) - - rows = cursor.fetchall() - - if rows == []: - raise st.MissingItemError() - - (installed_status, active_status), = rows - - return installed_status, active_status - - def install(self) -> None: - with self.state.cursor(transaction=True) as cursor: - installed_status, _ = self._get_statuses(cursor) - - if installed_status == 'I': - return - - self._set_installed_status(cursor, 'I') - - self.state.pull_missing_files() - - def uninstall(self) -> None: - with self.state.cursor(transaction=True) as cursor: - installed_status, active_status = self._get_statuses(cursor) - - if installed_status == 'N': - return - - self._set_installed_status(cursor, 'N') - - self.state.prune_orphans() - - if active_status == 'R': - self.state.recompute_dependencies() - - cursor.execute( - 'SELECT COUNT(*) FROM item_versions WHERE item_version_id = ?;', - (self.id,) - ) - - (version_still_present,), = cursor.fetchall() - return self if version_still_present else None - - def get_all_version_display_infos(self) \ - -> t.Sequence[st.MappingVersionDisplayInfo]: - with self.state.cursor() as cursor: - cursor.execute( - ''' - SELECT - item_id - FROM - item_versions - WHERE - item_version_id = ?; - ''', - (self.id,) - ) - - rows = cursor.fetchall() - if rows == []: - raise st.MissingItemError() - - (mapping_id,), = rows - - mapping_ref = ConcreteMappingRef(str(mapping_id), self.state) - - return mapping_ref.get_version_display_infos() - - -@dc.dataclass(frozen=True) -class ConcreteMappingVersionStore(st.MappingVersionStore): - state: base.HaketiloStateWithFields - - def get(self, id: str) -> st.MappingVersionRef: - return ConcreteMappingVersionRef(str(int(id)), self.state) diff --git a/src/hydrilla/proxy/web_ui/items.py b/src/hydrilla/proxy/web_ui/items.py new file mode 100644 index 0000000..03f2f2d --- /dev/null +++ b/src/hydrilla/proxy/web_ui/items.py @@ -0,0 +1,275 @@ +# SPDX-License-Identifier: GPL-3.0-or-later + +# Proxy web UI packages loading. +# +# This file is part of Hydrilla&Haketilo. +# +# Copyright (C) 2022 Wojtek Kosior +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# +# I, Wojtek Kosior, thereby promise not to sue for violation of this +# file's license. Although I request that you do not make use this code +# in a proprietary program, I am not going to enforce this in court. + +""" +..... +""" + +# Enable using with Python 3.7. +from __future__ import annotations + +import tempfile +import zipfile +import typing as t + +from pathlib import Path + +import flask +import werkzeug + +from ...exceptions import HaketiloException +from ...translations import smart_gettext as _ +from ... import item_infos +from .. import state as st +from . import _app + + +class InvalidUploadedMalcontent(HaketiloException): + def __init__(self): + super().__init__(_('err.proxy.uploaded_malcontent_invalid')) + + +bp = flask.Blueprint('items', __package__) + +@bp.route('/packages/load_from_disk', methods=['GET']) +def load_from_disk() -> werkzeug.Response: + html = flask.render_template('packages/load_from_disk.html.jinja') + return flask.make_response(html, 200) + +@bp.route('/packages/load_from_disk', methods=['POST']) +def load_from_disk_post() -> werkzeug.Response: + zip_file_storage = flask.request.files.get('packages_zipfile') + if zip_file_storage is None: + return load_from_disk() + + with tempfile.TemporaryDirectory() as tmpdir_str: + tmpdir = Path(tmpdir_str) + tmpdir_child = tmpdir / 'childdir' + tmpdir_child.mkdir() + + try: + with zipfile.ZipFile(zip_file_storage) as zip_file: + zip_file.extractall(tmpdir_child) + except: + raise HaketiloException(_('err.proxy.uploaded_file_not_zip')) + + extracted_top_level_files = tuple(tmpdir_child.iterdir()) + if extracted_top_level_files == (): + raise InvalidUploadedMalcontent() + + if len(extracted_top_level_files) == 1 and \ + extracted_top_level_files[0].is_dir(): + malcontent_dir_path = extracted_top_level_files[0] + else: + malcontent_dir_path = tmpdir_child + + try: + _app.get_haketilo_state().import_items(malcontent_dir_path) + except: + raise InvalidUploadedMalcontent() + + return flask.redirect(flask.url_for('.packages')) + +@bp.route('/packages') +def packages() -> werkzeug.Response: + store = _app.get_haketilo_state().mapping_store() + + html = flask.render_template( + 'packages/index.html.jinja', + display_infos = store.get_display_infos() + ) + return flask.make_response(html, 200) + +@bp.route('/libraries') +def libraries() -> werkzeug.Response: + store = _app.get_haketilo_state().resource_store() + + html = flask.render_template( + 'libraries/index.html.jinja', + display_infos = store.get_display_infos() + ) + return flask.make_response(html, 200) + +def item_store(state: st.HaketiloState, item_type: item_infos.ItemType) \ + -> t.Union[st.MappingStore, st.ResourceStore]: + if item_type == item_infos.ItemType.RESOURCE: + return state.resource_store() + else: + return state.mapping_store() + +def show_item(item_id: str, item_type: item_infos.ItemType) \ + -> werkzeug.Response: + try: + store = item_store(_app.get_haketilo_state(), item_type) + item_ref = store.get(str(item_id)) + version_display_infos = item_ref.get_version_display_infos() + + display_info: t.Union[st.MappingDisplayInfo, st.ResourceDisplayInfo] + + if isinstance(item_ref, st.ResourceRef): + display_info = st.ResourceDisplayInfo( + ref = item_ref, + identifier = version_display_infos[0].info.identifier + ) + else: + version_display_infos = t.cast( + t.Sequence[st.MappingVersionDisplayInfo], + version_display_infos + ) + + active_version: t.Optional[st.MappingVersionDisplayInfo] = None + + for info in version_display_infos: + if info.active != st.ActiveStatus.NOT_ACTIVE: + active_version = info + + display_info = st.MappingDisplayInfo( + ref = item_ref, + identifier = version_display_infos[0].info.identifier, + enabled = version_display_infos[0].mapping_enabled, + active_version = active_version + ) + + html = flask.render_template( + f'{item_type.alt_name_plural}/show_single.html.jinja', + display_info = display_info, + version_display_infos = version_display_infos + ) + return flask.make_response(html, 200) + except st.MissingItemError: + flask.abort(404) + + +@bp.route('/libraries/view/') +def show_library(item_id: str) -> werkzeug.Response: + return show_item(item_id, item_infos.ItemType.RESOURCE) + +@bp.route('/packages/view/') +def show_package(item_id: str) -> werkzeug.Response: + return show_item(item_id, item_infos.ItemType.MAPPING) + +ItemVersionDisplayInfo = t.Union[ + st.MappingVersionDisplayInfo, + st.ResourceVersionDisplayInfo +] + +def item_version_store( + state: st.HaketiloState, + item_type: item_infos.ItemType +) -> t.Union[st.MappingVersionStore, st.ResourceVersionStore]: + if item_type == item_infos.ItemType.RESOURCE: + return state.resource_version_store() + else: + return state.mapping_version_store() + +def show_item_version( + item_version_id: str, + item_type: item_infos.ItemType, + errors: t.Mapping[str, bool] = {} +) -> werkzeug.Response: + try: + store = item_version_store(_app.get_haketilo_state(), item_type) + version_ref = store.get(item_version_id) + display_infos = version_ref.get_all_version_display_infos() + + other_infos: list[ItemVersionDisplayInfo] = [] + this_info: t.Optional[ItemVersionDisplayInfo] = None + + for info in display_infos: + if info.ref == version_ref: + this_info = info + else: + other_infos.append(info) + + assert this_info is not None + + html = flask.render_template( + f'{item_type.alt_name_plural}/show_single_version.html.jinja', + display_info = this_info, + version_display_infos = other_infos, + **errors + ) + return flask.make_response(html, 200) + except st.MissingItemError: + flask.abort(404) + +@bp.route('/libraries/viewversion/') +def show_library_version(item_version_id: str) -> werkzeug.Response: + return show_item_version(item_version_id, item_infos.ItemType.RESOURCE) + +@bp.route('/packages/viewversion/') +def show_package_version(item_version_id: str) -> werkzeug.Response: + return show_item_version(item_version_id, item_infos.ItemType.MAPPING) + +def alter_item_version(item_version_id: str, item_type: item_infos.ItemType) \ + -> werkzeug.Response: + form_data = flask.request.form + action = form_data['action'] + + try: + store = item_version_store(_app.get_haketilo_state(), item_type) + item_version_ref = store.get(item_version_id) + + if action == 'install_item_version': + item_version_ref.install() + elif action == 'uninstall_item_version': + item_version_ref_after = item_version_ref.uninstall() + if item_version_ref_after is None: + url = flask.url_for(f'.{item_type.alt_name_plural}') + return flask.redirect(url) + else: + return show_item_version(item_version_id, item_type) + else: + raise ValueError() + except st.FileInstallationError: + return show_item_version( + item_version_id = item_version_id, + item_type = item_type, + errors = {'file_installation_error': True} + ) + except st.ImpossibleSituation: + return show_item_version( + item_version_id = item_version_id, + item_type = item_type, + errors = {'uninstall_disallowed': True} + ) + except st.MissingItemError: + flask.abort(404) + + return flask.redirect( + flask.url_for( + f'.show_{item_type.alt_name}_version', + item_version_id = item_version_id + ) + ) + +@bp.route('/libraries/viewversion/', methods=['POST']) +def alter_library_version(item_version_id: str) -> werkzeug.Response: + return alter_item_version(item_version_id, item_infos.ItemType.RESOURCE) + +@bp.route('/packages/viewversion/', methods=['POST']) +def alter_package_version(item_version_id: str) -> werkzeug.Response: + return alter_item_version(item_version_id, item_infos.ItemType.MAPPING) diff --git a/src/hydrilla/proxy/web_ui/packages.py b/src/hydrilla/proxy/web_ui/packages.py deleted file mode 100644 index 31d3dbb..0000000 --- a/src/hydrilla/proxy/web_ui/packages.py +++ /dev/null @@ -1,203 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# Proxy web UI packages loading. -# -# This file is part of Hydrilla&Haketilo. -# -# Copyright (C) 2022 Wojtek Kosior -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -# -# I, Wojtek Kosior, thereby promise not to sue for violation of this -# file's license. Although I request that you do not make use this code -# in a proprietary program, I am not going to enforce this in court. - -""" -..... -""" - -# Enable using with Python 3.7. -from __future__ import annotations - -import tempfile -import zipfile -import typing as t - -from pathlib import Path - -import flask -import werkzeug - -from ...exceptions import HaketiloException -from ...translations import smart_gettext as _ -from ... import item_infos -from .. import state as st -from . import _app - - -class InvalidUploadedMalcontent(HaketiloException): - def __init__(self): - super().__init__(_('err.proxy.uploaded_malcontent_invalid')) - - -bp = flask.Blueprint('packages', __package__) - -@bp.route('/packages/load_from_disk', methods=['GET']) -def load_from_disk() -> werkzeug.Response: - html = flask.render_template('packages/load_from_disk.html.jinja') - return flask.make_response(html, 200) - -@bp.route('/packages/load_from_disk', methods=['POST']) -def load_from_disk_post() -> werkzeug.Response: - zip_file_storage = flask.request.files.get('packages_zipfile') - if zip_file_storage is None: - return load_from_disk() - - with tempfile.TemporaryDirectory() as tmpdir_str: - tmpdir = Path(tmpdir_str) - tmpdir_child = tmpdir / 'childdir' - tmpdir_child.mkdir() - - try: - with zipfile.ZipFile(zip_file_storage) as zip_file: - zip_file.extractall(tmpdir_child) - except: - raise HaketiloException(_('err.proxy.uploaded_file_not_zip')) - - extracted_top_level_files = tuple(tmpdir_child.iterdir()) - if extracted_top_level_files == (): - raise InvalidUploadedMalcontent() - - if len(extracted_top_level_files) == 1 and \ - extracted_top_level_files[0].is_dir(): - malcontent_dir_path = extracted_top_level_files[0] - else: - malcontent_dir_path = tmpdir_child - - try: - _app.get_haketilo_state().import_items(malcontent_dir_path) - except: - raise InvalidUploadedMalcontent() - - return flask.redirect(flask.url_for('.packages')) - -@bp.route('/packages') -def packages() -> werkzeug.Response: - store = _app.get_haketilo_state().mapping_store() - - html = flask.render_template( - 'packages/index.html.jinja', - display_infos = store.get_display_infos() - ) - return flask.make_response(html, 200) - -@bp.route('/packages/view/') -def show_package(mapping_id: str) -> werkzeug.Response: - try: - store = _app.get_haketilo_state().mapping_store() - mapping_ref = store.get(str(mapping_id)) - version_display_infos = mapping_ref.get_version_display_infos() - - active_version: t.Optional[st.MappingVersionDisplayInfo] = None - - for info in version_display_infos: - if info.active != st.ActiveStatus.NOT_ACTIVE: - active_version = info - - display_info = st.MappingDisplayInfo( - ref = mapping_ref, - identifier = version_display_infos[0].info.identifier, - enabled = version_display_infos[0].mapping_enabled, - active_version = active_version - ) - - html = flask.render_template( - 'packages/show_single.html.jinja', - display_info = display_info, - version_display_infos = version_display_infos - ) - return flask.make_response(html, 200) - except st.MissingItemError: - flask.abort(404) - -@bp.route('/packages/viewversion/') -def show_package_version( - mapping_version_id: str, - errors: t.Mapping[str, bool] = {} -) -> werkzeug.Response: - try: - store = _app.get_haketilo_state().mapping_version_store() - version_ref = store.get(mapping_version_id) - display_infos = version_ref.get_all_version_display_infos() - - other_infos: list[st.MappingVersionDisplayInfo] = [] - this_info: t.Optional[st.MappingVersionDisplayInfo] = None - - for info in display_infos: - if info.ref == version_ref: - this_info = info - else: - other_infos.append(info) - - assert this_info is not None - - html = flask.render_template( - 'packages/show_single_version.html.jinja', - display_info = this_info, - version_display_infos = other_infos, - **errors - ) - return flask.make_response(html, 200) - except st.MissingItemError: - flask.abort(404) - -@bp.route('/packages/viewversion/', methods=['POST']) -def alter_package_version(mapping_version_id: str) -> werkzeug.Response: - form_data = flask.request.form - action = form_data['action'] - - try: - store = _app.get_haketilo_state().mapping_version_store() - mapping_version_ref = store.get(mapping_version_id) - - if action == 'install_package': - mapping_version_ref.install() - elif action == 'uninstall_package': - mapping_version_ref = mapping_version_ref.uninstall() - if mapping_version_ref is None: - return flask.redirect(flask.url_for('.packages')) - else: - return show_package_version(mapping_version_id) - else: - raise ValueError() - except st.FileInstallationError: - return show_package_version( - mapping_version_id, - {'file_installation_error': True} - ) - except st.ImpossibleSituation: - return show_package_version( - mapping_version_id, - {'uninstall_disallowed': True} - ) - except st.MissingItemError: - flask.abort(404) - - return flask.redirect( - flask.url_for( - '.show_package_version', - mapping_version_id = mapping_version_id - ) - ) diff --git a/src/hydrilla/proxy/web_ui/root.py b/src/hydrilla/proxy/web_ui/root.py index 28d7262..ab4e09b 100644 --- a/src/hydrilla/proxy/web_ui/root.py +++ b/src/hydrilla/proxy/web_ui/root.py @@ -45,7 +45,7 @@ from ... import versions from .. import state as st from .. import http_messages from . import repos -from . import packages +from . import items from . import _app @@ -90,7 +90,7 @@ class WebUIAppImpl(_app.WebUIApp): self.before_request(authenticate_by_referrer) - for blueprint in [repos.bp, packages.bp]: + for blueprint in [repos.bp, items.bp]: self.register_blueprint(blueprint) # Flask app is not thread-safe and has to be accompanied by an ugly lock. This diff --git a/src/hydrilla/proxy/web_ui/templates/base.html.jinja b/src/hydrilla/proxy/web_ui/templates/base.html.jinja index 4d1eca2..acc696e 100644 --- a/src/hydrilla/proxy/web_ui/templates/base.html.jinja +++ b/src/hydrilla/proxy/web_ui/templates/base.html.jinja @@ -119,10 +119,11 @@ in a proprietary work, I am not going to enforce this in court. {% set active_endpoint = get_current_endpoint() %} {% set navigation_bar = [ - ('home', _('web_ui.base.nav.home')), - ('packages.packages', _('web_ui.base.nav.packages')), - ('repos.repos', _('web_ui.base.nav.repos')), - ('packages.load_from_disk', _('web_ui.base.nav.load')) + ('home', _('web_ui.base.nav.home')), + ('items.packages', _('web_ui.base.nav.packages')), + ('items.libraries', _('web_ui.base.nav.libraries')), + ('repos.repos', _('web_ui.base.nav.repos')), + ('items.load_from_disk', _('web_ui.base.nav.load')) ] %}