view libervia/backend/plugins/plugin_misc_app_manager/models.py @ 4247:4aa62767f501

plugin app manager: various improvements: - Generated password must now be named and are stored, so they are re-used on following restarts. Password size can now be specified. - New `not` filter for `!libervia_param` to inverse a boolean value. - Former `front_url` field has been renamed to `web_url_path` as it is the URL path used for web frontend. All Web frontend related field are prefixed with `web_`. - `front_url` is now used to specify a whole front URL (notably useful if an app uses its own domain). A list can be used to retrieve a key, like for `url_prefix`, and `https` scheme is added if no scheme is specified. - An abstract class is now used for App Managers. - Last application start time is stored in persistent data.
author Goffi <goffi@goffi.org>
date Fri, 31 May 2024 11:08:14 +0200
parents
children 0d7bb4df2343
line wrap: on
line source

#!/usr/bin/env python3

# Libervia plugin for Jingle (XEP-0166)
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


import abc
from pathlib import Path

from libervia.backend.core.i18n import _


class AppManagerBackend(abc.ABC):
    """Abstract class for App Manager."""

    name: str
    discover_path: Path|None = None

    def __init__(self, host) -> None:
        """Initialize the App Manager.

        @param host: The host object.
        """
        self.host = host
        self._am = host.plugins["APP_MANAGER"]
        self._am.register(self)

    @abc.abstractmethod
    async def start(self, app_data: dict) -> None:
        """Start the app.

        @param app_data: A dictionary containing app data.
        """
        pass

    @abc.abstractmethod
    async def stop(self, app_data: dict) -> None:
        """Stop the app.

        @param app_data: A dictionary containing app data.
        """
        pass

    @abc.abstractmethod
    async def compute_expose(self, app_data: dict) -> None:
        """Compute exposed data for the app.

        @param app_data: A dictionary containing app data.
        """
        pass