data-sourcerer 0.1.0__py3-none-any.whl

sourcerer/presentation/screens/main/main.py

@@ -0,0 +1,469 @@
+import traceback
+from pathlib import Path
+
+from textual import work, on
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.containers import Horizontal
+from textual.reactive import reactive
+from textual.widgets import Footer
+
+from sourcerer.infrastructure.access_credentials.services import CredentialsService
+from sourcerer.infrastructure.storage_provider.exceptions import (
+    ListStorageItemsException,
+)
+from sourcerer.infrastructure.utils import generate_uuid
+from sourcerer.presentation.screens.critical_error.main import CriticalErrorScreen
+from sourcerer.presentation.screens.file_system_finder.main import (
+    FileSystemNavigationModal,
+)
+from sourcerer.presentation.screens.main.messages.delete_request import DeleteRequest
+from sourcerer.presentation.screens.main.messages.download_request import (
+    DownloadRequest,
+)
+from sourcerer.presentation.screens.main.messages.preview_request import PreviewRequest
+from sourcerer.presentation.screens.main.messages.select_storage_item import (
+    SelectStorageItem,
+)
+from sourcerer.presentation.screens.main.messages.uncheck_files_request import (
+    UncheckFilesRequest,
+)
+from sourcerer.presentation.screens.main.messages.upload_request import UploadRequest
+from sourcerer.presentation.screens.main.mixins.resize_containers_watcher_mixin import (
+    ResizeContainersWatcherMixin,
+)
+from sourcerer.presentation.screens.main.widgets.resizing_rule import ResizingRule
+from sourcerer.presentation.screens.main.widgets.storage_content import (
+    StorageContentContainer,
+)
+from sourcerer.presentation.screens.main.widgets.storage_list_sidebar import (
+    StorageListSidebar,
+)
+from sourcerer.presentation.screens.preview_content.main import PreviewContentScreen
+from sourcerer.presentation.screens.provider_creds_list.main import (
+    ProviderCredsListScreen,
+)
+from sourcerer.presentation.screens.storage_action_progress.main import (
+    StorageActionProgressScreen,
+    UploadKey,
+    DownloadKey,
+    DeleteKey,
+)
+from sourcerer.presentation.themes.github_dark import github_dark_theme
+from sourcerer.presentation.utils import (
+    get_provider_service_by_access_uuid,
+    get_provider_service_by_access_credentials,
+)
+
+
+class Sourcerer(App, ResizeContainersWatcherMixin):
+    """
+    A Textual application for managing cloud storage credentials and content.
+
+    This application provides a user interface to list and manage cloud storage
+    credentials, view storage content, and handle storage item selection. It
+    integrates with various cloud storage providers and supports asynchronous
+    operations for fetching and displaying storage data.
+
+    Attributes:
+        CSS_PATH (str): Path to the CSS file for styling the application.
+        BINDINGS (list): Key bindings for application actions.
+        is_storage_list_loading (reactive): Reactive attribute indicating if the
+            storage list is currently loading.
+
+    Methods:
+        compose() -> ComposeResult: Composes the UI layout with storage list and
+            content areas.
+        on_mount(): Initializes the application theme and storage list on mount.
+        action_credentials_list(): Opens the credentials list screen and refreshes
+            storages.
+        refresh_storages(*args, **kwargs): Refreshes the storage list by clearing
+            and reinitializing it.
+        init_storages_list() -> None: Asynchronously initializes the storage list
+            by fetching and displaying storages.
+        on_select_storage_item(event: SelectStorageItem): Handles storage item
+            selection and updates storage content.
+    """
+
+    CSS_PATH = "styles.tcss"
+    BINDINGS = [Binding("ctrl+r", "registrations", "Registrations list")]
+    is_storage_list_loading = reactive(False, recompose=True)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.credentials_service = CredentialsService()
+        self.storage_list_sidebar = StorageListSidebar(id="storage_list_sidebar")
+        self.storage_content = StorageContentContainer(id="storage_content_container")
+        self.load_percentage = 0
+        self.active_resizing_rule: ResizingRule | None = None
+
+    def compose(self) -> ComposeResult:
+        with Horizontal(id="main"):
+            yield self.storage_list_sidebar
+            yield ResizingRule(
+                id="storage_list_sidebar_container",
+                orientation="vertical",
+                classes="resize-handle",
+                prev_component_id=self.storage_list_sidebar.id,
+                next_component_id=self.storage_content.id,
+            )
+            yield self.storage_content
+        yield Footer()
+
+    def _handle_exception(self, error: Exception) -> None:
+        self.push_screen(CriticalErrorScreen(str(error), traceback.format_exc()))
+
+    def on_mount(self):
+        """
+        Initializes the application theme and storage list on mount.
+        """
+
+        self.register_theme(github_dark_theme)  # pyright: ignore [reportArgumentType]
+
+        self.theme = "github-dark"
+        self.init_storages_list()
+
+    def action_registrations(self):
+        """
+        Opens the provider credentials list screen and refreshes the storage list.
+        This method is triggered by the key binding "ctrl+r" and allows the user
+        to manage their cloud storage credentials. It pushes the
+        ProviderCredsListScreen to the application stack and sets a callback
+        to refresh the storage list after the screen is closed.
+        This method is typically used to allow users to add their
+        cloud storage credentials, which will then be reflected in the storage
+        """
+        self.app.push_screen(ProviderCredsListScreen(), callback=self.refresh_storages)
+
+    def refresh_storages(self, *args, **kwargs):
+        """
+        Refreshes the storage list by clearing the current storages and
+        reinitializing the storages list. This method is typically used
+        to update the storage list after changes in credentials or storage
+        configurations.
+        """
+        self.storage_list_sidebar.storages = {}
+        self.init_storages_list()
+
+    @work(thread=True)
+    async def init_storages_list(self) -> None:
+        """
+        Initializes the list of storages by fetching active access credentials
+        and retrieving storages for each credential. Updates the storage list
+        sidebar with the retrieved storages. Notifies the user in case of errors.
+
+        This method is asynchronous and should be awaited.
+
+        Flow:
+            1. Fetch active access credentials using self.credentials_service.list.
+            2. If no credentials are found, exit the method.
+            3. For each credential, retrieve the corresponding provider service.
+            4. Attempt to list storages using the provider service.
+            5. Update the storage_list_sidebar with the retrieved storages.
+            6. Handle exceptions by printing an error message and notifying the user.
+        """
+        self.reset_storage_content()
+        access_credentials = self.credentials_service.list(active_only=True)
+
+        if not access_credentials:
+            return
+
+        for credentials in access_credentials:
+            provider_service = get_provider_service_by_access_credentials(credentials)
+            if not provider_service:
+                self.notify(
+                    f"Could not get storages list for {credentials.name}!",
+                    severity="error",
+                )
+                continue
+            try:
+                storages = provider_service.list_storages()
+                self.storage_list_sidebar.storages = {
+                    credentials.uuid: storages,
+                    **self.storage_list_sidebar.storages,
+                }
+            except Exception:
+                self.notify(
+                    f"Could not get storages list for {credentials.name}!",
+                    severity="error",
+                )
+
+    @on(SelectStorageItem)
+    def on_select_storage_item(self, event: SelectStorageItem):
+        """
+        Handles the selection of a storage item by updating the storage content
+        with the selected item's details and retrieving its contents.
+
+        Args:
+            event (SelectStorageItem): The event containing details of the selected storage item.
+
+        Flow:
+            1. Update storage_content with the path, storage name, and access credentials UUID from the event.
+            2. Retrieve the provider service using the access credentials UUID.
+            3. If the provider service is available, attempt to list storage items.
+            4. Update storage_content with the retrieved storage items.
+            5. Notify the user if an error occurs during the retrieval process.
+        """
+        self.refresh_storage_content(
+            event.access_credentials_uuid, event.name, event.path, event.prefix
+        )
+
+    @on(UploadRequest)
+    def on_upload_request(self, event: UploadRequest):
+        """
+        Handles file upload requests by opening a file system navigation modal.
+
+        This method is triggered when an UploadRequest event is received. It opens
+        a file system navigation modal to allow the user to select a file or directory
+        to upload, then calls the _upload_file method with the selected source path.
+
+        Args:
+            event (UploadRequest): The upload request event containing storage details
+        """
+        self.push_screen(
+            FileSystemNavigationModal(),
+            callback=lambda src: self._upload_file(
+                event.access_credentials_uuid, event.storage, event.path, src  # type: ignore
+            ),
+        )
+
+    @on(DownloadRequest)
+    def on_download_request(self, event: DownloadRequest):
+        """
+        Handles file download requests by opening a storage action progress screen.
+
+        This method is triggered when a DownloadRequest event is received. It creates
+        a StorageActionProgressScreen to track and display the progress of the download
+        operation for the selected files.
+
+        Args:
+            event (DownloadRequest): The download request event containing file details
+        """
+        self.push_screen(
+            StorageActionProgressScreen(
+                storage_name=event.storage_name,
+                provider_service=get_provider_service_by_access_uuid(
+                    event.access_credentials_uuid, self.credentials_service
+                ),
+                path=event.path,
+                keys=[
+                    DownloadKey(display_name=key, uuid=generate_uuid(), path=key)  # type: ignore
+                    for key in event.keys
+                ],
+                action="download",
+            ),
+            callback=lambda x: self.after_bulk_operation_callback(
+                event.access_credentials_uuid, event.storage_name, event.path
+            ),
+        )
+
+    @on(DeleteRequest)
+    def on_delete_request(self, event: DeleteRequest):
+        """
+        Handles file deletion requests by opening a storage action progress screen.
+
+        This method is triggered when a DeleteRequest event is received. It creates
+        a StorageActionProgressScreen to track and display the progress of the delete
+        operation for the selected files.
+
+        Args:
+            event (DeleteRequest): The delete request event containing file details
+        """
+        self.push_screen(
+            StorageActionProgressScreen(
+                storage_name=event.storage_name,
+                provider_service=get_provider_service_by_access_uuid(
+                    event.access_credentials_uuid, self.credentials_service
+                ),
+                path=event.path,
+                keys=[
+                    DeleteKey(display_name=key, uuid=generate_uuid(), path=key) for key in event.keys  # type: ignore
+                ],
+                action="delete",
+            ),
+            callback=lambda x: self.after_bulk_operation_callback(
+                event.access_credentials_uuid, event.storage_name, event.path
+            ),
+        )
+
+    def after_bulk_operation_callback(
+        self, access_credentials_uuid, storage_name, path
+    ):
+        """
+        Callback method executed after bulk operations (download, upload, delete) complete.
+
+        This method resets the storage content display and refreshes it with the latest
+        content from the specified storage path after a bulk operation completes.
+
+        Args:
+            access_credentials_uuid (str): UUID of the access credentials to use
+            storage_name (str): Name of the storage to display
+            path (str): Path within the storage to display
+        """
+        self.reset_storage_content()
+        self.refresh_storage_content(access_credentials_uuid, storage_name, path)
+
+    @on(UncheckFilesRequest)
+    def uncheck_files_request(self, event: UncheckFilesRequest):
+        """
+        Handles requests to uncheck selected files in the storage content view.
+
+        This method is triggered when an UncheckFilesRequest event is received.
+        It unchecks all files specified in the event and clears the selected files
+        tracking in the storage content widget.
+
+        Args:
+            event (UncheckFilesRequest): The uncheck request event containing file keys
+        """
+        for key_uuid in event.keys:
+            file_item = self.query_one(f"#{key_uuid}")
+            file_item.uncheck()  # type: ignore
+        self.storage_content.selected_files = set()
+        self.storage_content.selected_files_n = 0
+
+    @on(PreviewRequest)
+    def on_preview_request(self, event: PreviewRequest):
+        """
+        Handles requests to preview file content.
+
+        This method is triggered when a PreviewRequest event is received. It attempts
+        to read the content of the specified file using the provider service and
+        displays it in a PreviewContentScreen if successful.
+
+        Args:
+            event (PreviewRequest): The preview request event containing file details
+
+        Note:
+            If an error occurs while reading the file content, a notification is shown
+            to the user and the preview is not displayed.
+        """
+        self.push_screen(
+            PreviewContentScreen(
+                storage_name=event.storage_name,
+                key=event.path,
+                access_credentials_uuid=event.access_credentials_uuid,
+            )
+        )
+
+    def reset_storage_content(self):
+        """
+        Resets the storage content attributes to their default state.
+
+        This method clears the current storage path, storage name, search prefix,
+        storage content, and access credentials UUID, effectively resetting the
+        storage content to an uninitialized state.
+        """
+        self.storage_content.path = None
+        self.storage_content.storage = None
+        self.storage_content.search_prefix = None
+        self.storage_content.storage_content = None
+        self.storage_content.access_credentials_uuid = ""
+        self.storage_content.selected_files = set()
+        self.storage_content.selected_files_n = 0
+        self.uncheck_files_request(UncheckFilesRequest(keys=[]))
+
+    def refresh_storage_content(
+        self, access_credentials_uuid, storage_name, path, prefix=None
+    ):
+        """
+        Refreshes the storage content display with items from the specified storage path.
+
+        This method updates the storage content widget with items from the specified
+        storage path and provider. It handles retrieving the storage items using the
+        provider service and updating the UI accordingly.
+
+        Args:
+            access_credentials_uuid (str): UUID of the access credentials to use
+            storage_name (str): Name of the storage to display
+            path (str): Path within the storage to display
+            prefix (str, optional): Filter prefix for storage items. Defaults to None.
+
+        Note:
+            If an error occurs while retrieving storage items, a notification is shown
+            to the user and the storage content remains unchanged.
+        """
+        self.storage_content.path = path.strip("/") if path else path
+        self.storage_content.storage = storage_name
+        self.storage_content.access_credentials_uuid = access_credentials_uuid
+        self.storage_content.search_prefix = prefix or ""
+
+        provider_service = get_provider_service_by_access_uuid(
+            access_credentials_uuid, self.credentials_service
+        )
+
+        if not provider_service:
+            self.notify("Could not extract storage content", severity="error")
+            return
+        params = {"storage": storage_name, "path": path or "", "prefix": prefix or ""}
+        try:
+            self.storage_content.storage_content = provider_service.list_storage_items(**params)  # type: ignore
+        except ListStorageItemsException as e:
+            self.notify(
+                f"""Could not extract storage content 
+{str(e)}""",
+                severity="error",
+            )
+
+    def _upload_file(
+        self,
+        access_credentials_uuid: str,
+        storage_name: str,
+        path: str,
+        source_path: Path,
+    ) -> None:
+        """
+        Uploads a file to the specified storage.
+
+        This method handles the upload of a file to a cloud storage provider.
+        It creates an upload key, gets the provider service, and pushes a
+        progress screen to handle the upload operation.
+
+        Args:
+            access_credentials_uuid (str): The UUID of the access credentials used for authentication.
+            storage_name (str): The name of the storage where the file will be uploaded.
+            path (str): The destination path within the storage.
+            source_path (Path): The local path of the file to be uploaded.
+            file_system_service (FileSystemService, optional): Service for file system operations.
+                Defaults to Provide[DiContainer.file_system_service].
+
+        Returns:
+            None
+
+        Note:
+            If the source_path is None or the provider service is not available,
+            the method will return early without performing any upload.
+        """
+        # Validate input parameters
+        if not source_path:
+            self.notify("No file selected for upload", severity="error")
+            return
+
+        # Get the provider service
+        provider_service = get_provider_service_by_access_uuid(
+            access_credentials_uuid, self.credentials_service
+        )
+        if not provider_service:
+            self.notify("Could not get provider service for upload", severity="error")
+            return
+
+        # Create upload key
+        upload_key = UploadKey(
+            display_name=source_path.name,
+            uuid=generate_uuid(),
+            path=source_path,
+            dest_path=str(source_path.name),
+        )
+
+        # Push the upload progress screen
+        self.push_screen(
+            StorageActionProgressScreen(
+                storage_name=storage_name,
+                provider_service=provider_service,
+                path=path,
+                keys=[upload_key],
+                action="upload",
+            ),
+            callback=lambda x: self.after_bulk_operation_callback(
+                access_credentials_uuid, storage_name, path
+            ),
+        )

sourcerer/presentation/screens/main/messages/delete_request.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from typing import List
+
+from textual.message import Message
+
+
+@dataclass
+class DeleteRequest(Message):
+    storage_name: str
+    access_credentials_uuid: str
+    path: str
+    keys: List[str]

sourcerer/presentation/screens/main/messages/download_request.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from typing import List
+
+from textual.message import Message
+
+
+@dataclass
+class DownloadRequest(Message):
+    storage_name: str
+    access_credentials_uuid: str
+    path: str
+    keys: List[str]

sourcerer/presentation/screens/main/messages/preview_request.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from textual.message import Message
+
+
+@dataclass
+class PreviewRequest(Message):
+    storage_name: str
+    access_credentials_uuid: str
+    path: str

sourcerer/presentation/screens/main/messages/resizing_rule.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+
+from textual.message import Message
+
+
+@dataclass
+class ResizingRuleMove(Message):
+    orientation: str
+    delta: int
+    previous_component_id: str
+    next_component_id: str
+
+
+@dataclass
+class ResizingRuleSelect(Message):
+    id: str
+
+
+@dataclass
+class ResizingRuleRelease(Message):
+    id: str

sourcerer/presentation/screens/main/messages/select_storage_item.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+
+from textual.message import Message
+
+
+@dataclass
+class SelectStorageItem(Message):
+    name: str
+    path: str | None = None
+    access_credentials_uuid: str | None = None
+    prefix: str | None = None

sourcerer/presentation/screens/main/messages/uncheck_files_request.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+from textual.message import Message
+
+
+@dataclass
+class UncheckFilesRequest(Message):
+    keys: list[str]

sourcerer/presentation/screens/main/messages/upload_request.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from textual.message import Message
+
+
+@dataclass
+class UploadRequest(Message):
+    access_credentials_uuid: str
+    storage: str
+    path: str | None