configure-edusharing.py

#!/usr/bin/env python

import subprocess

import requests

from utils import error, call_edusharing_api, get_current_lti_tool_ids, \
        get_current_editor_id, info
from wait import wait_for_edusharing_and_serlo

def main():
    wait_for_edusharing_and_serlo()

    info("Set `allowed_authentication_types` to `lti`")
    set_allowed_authentication_types()

    info("Delete all LTI tools in edu-sharing")
    delete_all_current_lti_tools()

    info("Register serlo editor")
    register_new_serlo_editor()

    info("Set `ltitool_customcontent_option` to `true`")
    tool_ids = get_current_lti_tool_ids()
    assert len(tool_ids) == 1
    add_ltitool_customcontent_option(tool_ids[0])

    info("Serlo Editor registered. ID: %s" % get_current_editor_id())

    info("Update 'Cluster-Override'")
    update_cluster_override()

    info("Remove app-editor2.properties.xml")
    remove_properties_file_of_editor()

    info("Register Serlo editor as platform")
    register_serlo_editor_as_platform()

    info("Erstelle einen Test-User")
    register_test_user()

def delete_all_current_lti_tools():
    for tool_id in get_current_lti_tool_ids():
        delete_lti_tool(tool_id)

def delete_lti_tool(tool_id):
    call_edusharing_api("/admin/v1/applications/" + tool_id, method="DELETE")

def register_new_serlo_editor():
    response = call_edusharing_api(
        "/ltiplatform/v13/manual-registration",
        method="POST",
        json={
            "toolName": "Serlo Editor",
            "toolUrl": "http://localhost:3000/lti",
            "toolDescription": "Serlo Editor",
            "keysetUrl": "http://host.docker.internal:3000/lti/keys",
            "loginInitiationUrl": "http://localhost:3000/lti/login",
            "redirectionUrls": [ "http://localhost:3000/lti" ],
            "customParameters": [],
            "logoUrl": "https://de.serlo.org/_assets/apple-touch-icon.png",
            "targetLinkUri": "http://localhost:3000/lti",
            "targetLinkUriDeepLink": "http://localhost:3000/lti",
            "clientName": "Serlo Editor"
        }
    )

    if not response.ok:
        error(response.text)

def add_ltitool_customcontent_option(tool_id):
    update_properties(f"app-{tool_id}",
                      { "ltitool_customcontent_option": "true" })

def update_cluster_override():
    call_edusharing_api(
        "/admin/v1/configFile?filename=edu-sharing.override.conf&pathPrefix=CLUSTER",
        method="PUT",
        data='angular.headers.X-Frame-Options: "allow-from http://localhost:3000"'
    )

def set_allowed_authentication_types():
    update_properties(
        "homeApplication",
        { "allowed_authentication_types": "lti" }
    )

def remove_properties_file_of_editor():
    subprocess.run(["./docker-compose.sh", "exec", "repository-service", "rm", "-f",
        "/usr/local/tomcat/shared/classes/config/cluster/applications/app-editor2.properties.xml"])

def register_serlo_editor_as_platform():
    response = call_edusharing_api(
        "/lti/v13/registration/static",
        method="POST",
        params={
            "platformId": "http://localhost:3000/",
            "client_id": "editor",
            "deployment_id": "2",
            "authentication_request_url": "http://localhost:3000/platform/login",
            "keyset_url": "http://host.docker.internal:3000/platform/keys",
            "key_id": "42",
            "auth_token_url": "http://localhost:3000/platform/login"
        }
    )

    if not response.ok:
        # TODO: Wait until bug is fixed
        info("Editor seems already be registered")

def register_test_user():
    call_edusharing_api(
        "/iam/v1/people/-home-/test/?password=test",
        method = "POST",
        json = {
            "firstName": "test",
            "lastName": "test",
            "email": "test",
            "sizeQuota": 104857600
        }
    )

def update_properties(name, new_values):
    properties_path = f"/admin/v1/applications/{name}.properties.xml"
    properties = call_edusharing_api(properties_path).json()
    properties |= new_values

    call_edusharing_api(properties_path, json=properties, method="PUT")

if __name__ == "__main__":
    main()