Source code for univention.appcenter.actions.info

#!/usr/bin/python3
#
# Univention App Center
#  univention-app module showing information about the App Center
#
# SPDX-FileCopyrightText: 2015-2025 Univention GmbH
# SPDX-License-Identifier: AGPL-3.0-only
#

from json import dumps

from univention.appcenter.actions import UniventionAppAction, get_action
from univention.appcenter.app import LooseVersion
from univention.appcenter.app_cache import Apps
from univention.appcenter.ucr import ucr_get




[docs]
class Info(UniventionAppAction):
    """Shows information on the current state of the App Center itself."""

    help = 'Show general info'



[docs]
    def setup_parser(self, parser):
        parser.add_argument('--as-json', action='store_true', help='Output in a machine readable format')





[docs]
    def main(self, args):
        if args.as_json:
            self._as_json()
        else:
            self._output()



    def _as_json(self):
        installed = [str(app) for app in self.get_installed_apps()]
        upgradable = [app.id for app in self.get_upgradable_apps()]
        ret = {'ucs': self.get_ucs_version(), 'compat': self.get_compatibility(), 'installed': installed, 'upgradable': upgradable}
        self.log(dumps(ret))
        return ret

    def _output(self):
        self.log('UCS: %s' % self.get_ucs_version())
        self.log('Installed: %s' % ' '.join(str(app) for app in self.get_installed_apps()))
        self.log('Upgradable: %s' % ' '.join(app.id for app in self.get_upgradable_apps()))



[docs]
    @classmethod
    def get_ucs_version(cls):
        return '%s-%s errata%s' % (ucr_get('version/version'), ucr_get('version/patchlevel'), ucr_get('version/erratalevel'))





[docs]
    @classmethod
    def is_compatible(cls, other_version, function=None):
        if other_version is None:
            return False
        return LooseVersion(other_version) >= LooseVersion("5.0-0")





[docs]
    @classmethod
    def get_compatibility(cls):
        """
        Returns the version number of the App Center.
        As App Center within a domain may talk to each other it is necessary
        to ask whether they are compatible.
        The version number will rise whenever a change was made that may break compatibility.

        1: initial app center 12/12 (not assigned, appcenter/version was not supported)
        2: app center with remote installation 02/13 (not assigned, appcenter/version was not supported)
        3: app center with version and only_dry_run 03/13
        4: app center with docker support and new App class 11/15
        Starting with UCS 4.3 (03/18): The full UCS version
        """
        return cls.get_ucs_version()





[docs]
    def get_installed_apps(self):
        return Apps().get_all_locally_installed_apps()





[docs]
    def get_upgradable_apps(self):
        upgrade = get_action('upgrade')
        return list(upgrade.iter_upgradable_apps())