# Copyright 2020 Karlsruhe Institute of Technology
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
from flask import current_app
from flask import json
from kadi.lib.plugins.core import run_hook
from .models import License
[docs]def get_builtin_licenses():
"""Get all built-in licenses.
:return: The licenses as dictionary, mapping the unique name of each license to
another dictionary, containing the title (``"title"``) and url (``"url"``) of
each license.
"""
resources_path = current_app.config["RESOURCES_PATH"]
with open(
os.path.join(resources_path, "opendefinition.json"), encoding="utf-8"
) as f:
return json.loads(f.read())
[docs]def initialize_builtin_licenses():
"""Initialize all built-in licenses.
Will create database objects of the licenses returned by
:func:`get_builtin_licenses`.
:return: ``True`` if at least one license was created, ``False`` otherwise.
"""
license_created = False
for name, license_meta in get_builtin_licenses().items():
if License.query.filter_by(name=name).first() is None:
License.create(
name=name, title=license_meta["title"], url=license_meta["url"]
)
license_created = True
return license_created
[docs]def get_plugin_licenses():
"""Get all licenses added via plugins.
Uses the :func:`kadi.plugins.spec.kadi_get_licenses` plugin hook to collect the
licenses. Invalid licenses will be ignored.
:return: The licenses as dictionary, in the same format as returned via
:func:`get_builtin_licenses`.
"""
plugin_licenses = {}
try:
license_data = run_hook("kadi_get_licenses")
except Exception as e:
current_app.logger.exception(e)
return plugin_licenses
for licenses in license_data:
if not isinstance(licenses, dict):
current_app.logger.error("Invalid license data format.")
continue
for name, license_meta in licenses.items():
if not isinstance(license_meta, dict) or not "title" in license_meta:
current_app.logger.error(f"Invalid license metadata for '{name}'.")
continue
plugin_licenses[name] = {
"title": license_meta["title"],
"url": license_meta.get("url"),
}
return plugin_licenses