#
# Base object of all payload sources.
#
# Copyright (C) 2019 Red Hat, Inc.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# the GNU General Public License v.2, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY expressed or implied, including the implied warranties 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, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA. Any Red Hat trademarks that are incorporated in the
# source code or documentation are not subject to the GNU General Public
# License and may only be used or replicated with the express permission of
# Red Hat, Inc.
#
from abc import ABCMeta
from dasbus.server.interface import dbus_interface
from dasbus.server.property import emits_properties_changed
from dasbus.typing import * # pylint: disable=wildcard-import
from pyanaconda.modules.common.base.base_template import ModuleInterfaceTemplate
from pyanaconda.modules.common.constants.interfaces import (
PAYLOAD_SOURCE,
PAYLOAD_SOURCE_REPOSITORY,
)
from pyanaconda.modules.common.structures.payload import RepoConfigurationData
__all__ = [
"PayloadSourceBaseInterface",
"RepositorySourceInterface",
]
@dbus_interface(PAYLOAD_SOURCE.interface_name)
[docs]
class PayloadSourceBaseInterface(ModuleInterfaceTemplate, metaclass=ABCMeta):
"""Base class for all the payload source module interfaces.
This object contains API shared by all the sources. Everything in this object has
to be implemented by a source to be used.
"""
@property
[docs]
def Type(self) -> Str:
"""The type of this source."""
return self.implementation.type.value
@property
[docs]
def Description(self) -> Str:
"""The description of this source."""
return self.implementation.description
@dbus_interface(PAYLOAD_SOURCE_REPOSITORY.interface_name)
[docs]
class RepositorySourceInterface(PayloadSourceBaseInterface, metaclass=ABCMeta):
"""DBus interface for sources that provide access to a repository."""
[docs]
def connect_signals(self):
"""Connect the signals."""
super().connect_signals()
self.watch_property("Configuration", self.implementation.configuration_changed)
@property
[docs]
def Configuration(self) -> Structure:
"""The source configuration.
This configuration will be used to set up the source
and generate a configuration of the available repository.
:return: a structure of the type RepoConfigurationData
"""
return RepoConfigurationData.to_structure(
self.implementation.configuration
)
@Configuration.setter
@emits_properties_changed
def Configuration(self, configuration: Structure):
"""Set the source configuration.
:param configuration: a structure of the type RepoConfigurationData
"""
self.implementation.set_configuration(
RepoConfigurationData.from_structure(configuration)
)