EndAssessmentLaunchRequestBuilder.php

<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty 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.
 *
 * Copyright (c) 2021 (original work) Open Assessment Technologies SA;
 */

declare(strict_types=1);

namespace OAT\Library\Lti1p3Proctoring\Message\Launch\Builder;

use OAT\Library\Lti1p3Core\Exception\LtiException;
use OAT\Library\Lti1p3Core\Exception\LtiExceptionInterface;
use OAT\Library\Lti1p3Core\Message\Launch\Builder\PlatformOriginatingLaunchBuilder;
use OAT\Library\Lti1p3Core\Message\LtiMessageInterface;
use OAT\Library\Lti1p3Core\Message\Payload\LtiMessagePayloadInterface;
use OAT\Library\Lti1p3Core\Registration\RegistrationInterface;
use Throwable;

/**
 * @see https://www.imsglobal.org/spec/proctoring/v1p0#h.ooq616k28cwm
 */
class EndAssessmentLaunchRequestBuilder extends PlatformOriginatingLaunchBuilder
{
    /**
     * @throws LtiExceptionInterface
     */
    public function buildEndAssessmentLaunchRequest(
        RegistrationInterface $registration,
        string $loginHint,
        string $endAssessmentUrl = null,
        int $attemptNumber = 1,
        string $deploymentId = null,
        array $roles = ['http://purl.imsglobal.org/vocab/lis/v2/membership#Learner'],
        array $optionalClaims = []
    ): LtiMessageInterface {
        try {
            $this->builder
                ->reset()
                ->withClaim(LtiMessagePayloadInterface::CLAIM_LTI_PROCTORING_ATTEMPT_NUMBER, $attemptNumber);

            $launchUrl = $endAssessmentUrl ?? $registration->getTool()->getLaunchUrl();

            if (null === $launchUrl) {
                throw new LtiException('Neither end assessment url nor tool default url were presented');
            }

            return $this->buildPlatformOriginatingLaunch(
                $registration,
                LtiMessageInterface::LTI_MESSAGE_TYPE_END_ASSESSMENT,
                $launchUrl,
                $loginHint,
                $deploymentId,
                $roles,
                $optionalClaims
            );

        } catch (LtiExceptionInterface $exception) {
            throw $exception;
        } catch (Throwable $exception) {
            throw new LtiException(
                sprintf('Cannot create end assessment launch request: %s', $exception->getMessage()),
                $exception->getCode(),
                $exception
            );
        }
    }

    /**
     * @throws LtiExceptionInterface
     */
    public function buildEndAssessmentLaunchErrorRequest(
        RegistrationInterface $registration,
        string $loginHint,
        string $errorMessage,
        string $errorLog = null,
        string $endAssessmentUrl = null,
        int $attemptNumber = 1,
        string $deploymentId = null,
        array $roles = ['http://purl.imsglobal.org/vocab/lis/v2/membership#Learner'],
        array $optionalClaims = []
    ): LtiMessageInterface {
        return $this->buildEndAssessmentLaunchRequest(
            $registration,
            $loginHint,
            $endAssessmentUrl,
            $attemptNumber,
            $deploymentId,
            $roles,
            array_merge(
                $optionalClaims,
                [
                    LtiMessagePayloadInterface::CLAIM_LTI_PROCTORING_ERROR_MESSAGE => $errorMessage,
                    LtiMessagePayloadInterface::CLAIM_LTI_PROCTORING_ERROR_LOG => $errorLog ?? $errorMessage,
                ]
            )
        );
    }
}