assetmodel.py

# vim: set fileencoding=utf-8 :
###############################################################################
#                                                                             #
# Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.editor module of the BEAT platform.           #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform 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.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################

import os

from enum import Enum, unique

from PyQt5.QtCore import pyqtSignal
from PyQt5.QtCore import pyqtSlot
from PyQt5.QtCore import pyqtProperty
from PyQt5.QtCore import QStringListModel

from beat.core.schema import validate
from beat.cmdline import common

from ..utils import dataformat_basetypes


@unique
class AssetType(Enum):
    """All possible assets available on the BEAT platform"""

    (
        UNKNOWN,
        ALGORITHM,
        DATABASE,
        DATAFORMAT,
        EXPERIMENT,
        LIBRARY,
        PLOTTER,
        PLOTTERPARAMETER,
        PROTOCOLTEMPLATE,
        TOOLCHAIN,
    ) = range(10)

    @classmethod
    def path(cls, type_):
        path = "unknown"
        if type_ == cls.ALGORITHM:
            path = "algorithms"
        elif type_ == cls.DATABASE:
            path = "databases"
        elif type_ == cls.DATAFORMAT:
            path = "dataformats"
        elif type_ == cls.EXPERIMENT:
            path = "experiments"
        elif type_ == cls.LIBRARY:
            path = "libraries"
        elif type_ == cls.PLOTTER:
            path = "plotters"
        elif type_ == cls.PLOTTERPARAMETER:
            path = "plotterparameters"
        elif type_ == cls.PROTOCOLTEMPLATE:
            path = "protocoltemplates"
        elif type_ == cls.TOOLCHAIN:
            path = "toolchains"

        return path

    @classmethod
    def from_path(cls, path):
        if path == "algorithms":
            return cls.ALGORITHM
        elif path == "databases":
            return cls.DATABASE
        elif path == "dataformats":
            return cls.DATAFORMAT
        elif path == "experiments":
            return cls.EXPERIMENT
        elif path == "libraries":
            return cls.LIBRARY
        elif path == "plotters":
            return cls.PLOTTER
        elif path == "plotterparameters":
            return cls.PLOTTERPARAMETER
        elif path == "protocoltemplates":
            return cls.PROTOCOLTEMPLATE
        elif path == "toolchains":
            return cls.TOOLCHAIN
        else:
            raise RuntimeError("Unknown asset path {}".format(path))

    def can_create(self):
        """Returns whether a new asset can be created from scratch"""

        return self not in [self.UNKNOWN, self.EXPERIMENT]

    def can_fork(self):
        """Returns whether a new asset can be forked"""

        return self not in [self.UNKNOWN, self.DATABASE, self.PROTOCOLTEMPLATE]

    def split_count(self):
        """Returns the number of "/" that should be part of its name"""

        if self == self.UNKNOWN:
            return 0
        elif self == self.EXPERIMENT:
            return 5
        elif self not in [self.DATABASE, self.PROTOCOLTEMPLATE]:
            return 2
        else:
            return 1

    def validate(self, data):
        """Runs the schema validation and returns whether an asset is valid

        :param data str: asset content
        """

        if self == self.UNKNOWN:
            raise RuntimeError("Trying to validate unknown type")
        return validate(self.name.lower(), data)

    def create_new(self, prefix, name):
        """Create a new asset from a prototype

        :param prefix str: Path to the prefix
        :param name str: name of the asset
        """

        if self == self.UNKNOWN:
            raise RuntimeError("Trying to create an asset of unknown type")
        success = common.create(prefix, self.name.lower(), [name])
        return success == 0

    def create_new_version(self, prefix, name):
        """Create a new version of the asset

        :param prefix str: Path to the prefix
        :param name str: name of the asset
        """

        if self == self.UNKNOWN:
            raise RuntimeError(
                "Trying to create a new version of an asset of unknown type"
            )
        success = common.new_version(prefix, self.name.lower(), name)
        return success == 0

    def fork(self, prefix, source, destination):
        """Fork an asset

        :param prefix str: Path to the prefix
        :param source str: name of the original asset
        :param destination str: name of the new asset
        """

        if self == self.UNKNOWN:
            raise RuntimeError("Trying to fork an asset of unknown type")
        success = common.fork(prefix, self.name.lower(), source, destination)
        return success == 0


class AssetModel(QStringListModel):
    """The asset model present a list of available asset from a given type"""

    assetTypeChanged = pyqtSignal(AssetType)
    prefixPathChanged = pyqtSignal(str)

    def __init__(self, parent=None):
        """Constructor"""

        super(QStringListModel, self).__init__(parent)

        self.__prefix_path = None
        self.__asset_type = AssetType.UNKNOWN

    @pyqtSlot()
    def reload(self):
        """Loads the content regarding the asset property from the prefix"""

        if not self.__prefix_path or self.__asset_type == AssetType.UNKNOWN:
            return

        def _find_json_files(path):
            """Return all json files from folder sorted"""

            asset_items = os.scandir(path)
            json_files = sorted(
                [
                    item.name
                    for item in asset_items
                    if item.is_file() and item.name.endswith("json")
                ]
            )
            return json_files

        latest_assets_list = []

        if self.asset_type in [AssetType.DATABASE, AssetType.PROTOCOLTEMPLATE]:
            # These assets have no user associated with them
            for asset_folder in os.scandir(self.asset_folder):
                json_files = _find_json_files(asset_folder)
                if json_files:
                    latest_assets_list.append(
                        "{name}/{version}".format(
                            name=asset_folder.name, version=json_files[-1].split(".")[0]
                        )
                    )
        else:
            # Assets belonging to a user
            asset_users = os.scandir(self.asset_folder)

            for asset_user in asset_users:
                for asset_folder in os.scandir(asset_user):
                    if self.asset_type == AssetType.EXPERIMENT:
                        for root, dirs, files in os.walk(asset_folder, topdown=False):
                            if dirs:
                                continue
                            anchor = "experiments/"
                            position = root.index(anchor) + len(anchor)
                            experiment_path = root[position:]
                            for json_file in [
                                file for file in files if file.endswith("json")
                            ]:
                                latest_assets_list.append(
                                    "{experiment_path}/{name}".format(
                                        experiment_path=experiment_path,
                                        name=json_file.split(".")[0],
                                    )
                                )
                    else:
                        json_files = _find_json_files(asset_folder)
                        if json_files:
                            latest_assets_list.append(
                                "{user}/{name}/{version}".format(
                                    user=asset_user.name,
                                    name=asset_folder.name,
                                    version=json_files[-1].split(".")[0],
                                )
                            )

        latest_assets_list = sorted(latest_assets_list)
        if self.asset_type == AssetType.DATAFORMAT:
            latest_assets_list = dataformat_basetypes() + latest_assets_list

        self.setStringList(latest_assets_list)

    def assetType(self):
        """Returns the asset type of this model

        :return: Asset type of this model
        """

        return self.__asset_type

    def setAssetType(self, type_):
        """Set the asset type of this model

        :param AssetType type_: Asset type this model should show
        """

        if self.__asset_type == type_:
            return

        self.__asset_type = type_
        self.reload()
        self.assetTypeChanged.emit(type_)

    asset_type = pyqtProperty(
        AssetType, fget=assetType, fset=setAssetType, notify=assetTypeChanged
    )

    def prefixPath(self):
        """Returns the prefix path use by this model

        :return: the prefix path used
        """

        return self.__prefix_path

    def setPrefixPath(self, path):
        """Set the prefix path use by this model

        :param str path: Path to prefix
        """

        if self.__prefix_path == path:
            return

        self.__prefix_path = path
        self.reload()
        self.prefixPathChanged.emit(path)

    prefix_path = pyqtProperty(
        str, fget=prefixPath, fset=setPrefixPath, notify=prefixPathChanged
    )

    @property
    def asset_folder(self):
        """Returns the folder matching this model asset type"""

        return os.path.join(self.prefix_path, AssetType.path(self.asset_type))

    def json_path(self, asset_name):
        """Returns the full path to the json file matching the asset given

        :param asset_name str: fully qualified asset name
        """

        asset_path = os.path.join(self.asset_folder, "{}.json".format(asset_name))
        if not os.path.exists(asset_path):
            raise RuntimeError("Invalid asset {}".format(asset_name))
        return asset_path