class.ilLTILoginGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilLTILoginGUI implements ilCtrlBaseClassInterface, ilCtrlSecurityInterface
{
    public const string CMD_AUTHENTICATE = 'doLTIAuthentication';
 
    private readonly ilCtrlInterface $ctrl;
    private readonly ilGlobalTemplateInterface $main_tpl;
    private readonly ilAuthSession $auth_session;
    private readonly ilLanguage $lng;
    private readonly ilLogger $logger;
 
    public function __construct()
    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->auth_session = $DIC['ilAuthSession'];
        $this->lng = $DIC->language();
        $this->logger = $DIC->logger()->forComponent('lti');
    }
 
    public function getUnsafeGetCommands(): array
    {
        return [];
    }
 
    public function getSafePostCommands(): array
    {
        return [self::CMD_AUTHENTICATE];
    }
 
    public function executeCommand(): void
    {
        if ($this->ctrl->getCmd() === self::CMD_AUTHENTICATE) {
            $this->authenticate();
        }
 
        $this->ctrl->redirectByClass(ilStartUpGUI::class, 'showLoginPage');
    }
 
    private function authenticate(): void
    {
        $this->logger->debug('Trying lti authentication');
 
        $credentials = new ilAuthFrontendCredentialsLTI();
        $credentials->initFromRequest();
 
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_PROVIDER_LTI);
 
        $status = ilAuthStatus::getInstance();
 
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->auth_session,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();
 
        $lti_target = ilLTIViewGUI::getLaunchTarget();
        if ($lti_target !== '') {
            ilSession::set('orig_request_target', $lti_target);
        }
 
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLTISessionCookie::allowCrossSite();
                // the user of a launch goes to the object the platform launched
                if ($lti_target !== '') {
                    $this->ctrl->redirectToURL($lti_target);
                }
                $this->logger->debug('Authentication successful; Redirecting to starting page.');
                ilInitialisation::redirectToStartingPage();
 
                // no break
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirectByClass(ilStartUpGUI::class, 'showAccountMigration');
 
                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->main_tpl->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirectByClass(ilStartUpGUI::class, 'showLoginPage');
        }
 
        $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'), true);
    }
}