tao-test/app/taoQtiTest/models/classes/runner/RunnerParamParserTrait.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) 2017 (original work) Open Assessment Technologies SA ;
 */

namespace oat\taoQtiTest\models\runner;

use oat\taoQtiTest\models\runner\map\QtiRunnerMap;
use taoQtiTest_helpers_TestRunnerUtils as TestRunnerUtils;

trait RunnerParamParserTrait
{
    /**
     * @var QtiRunnerServiceContext
     */
    protected $serviceContext;

    /**
     * Check if the parameter associated to $name exists
     *
     * @param $name
     * @return mixed
     */
    abstract public function hasRequestParameter($name);

    /**
     * Get the parameter associated to $name
     *
     * @param $name
     * @return mixed
     */
    abstract public function getRequestParameter($name);

    /**
     * Get the Service Locator
     *
     * @return mixed
     */
    abstract public function getServiceLocator();

    /**
     * Initialize and verify the current service context
     * useful when the context was opened but not checked.
     *
     * @return boolean true if initialized
     * @throws \common_Exception
     */
    protected function initServiceContext()
    {
        $serviceContext = $this->getServiceContext();
        $this->getRunnerService()->check($serviceContext);
        return $serviceContext->init();
    }

    /**
     * @return QtiRunnerService
     */
    protected function getRunnerService()
    {
        return $this->getServiceLocator()->get(QtiRunnerService::SERVICE_ID);
    }

    /**
     * Get the Service Context
     * WARNING, there is not CSRF token check
     *
     * @return QtiRunnerServiceContext
     * @throws \common_Exception
     */
    protected function getServiceContext()
    {
        if (!$this->serviceContext) {
            $testExecution = $this->getRequestParameter('serviceCallId');
            $testDefinition  = $this->getRequestParameter('testDefinition');
            $testCompilation = $this->getRequestParameter('testCompilation');

            $this->serviceContext = $this->getRunnerService()->getServiceContext(
                $testDefinition,
                $testCompilation,
                $testExecution
            );
        }

        return $this->serviceContext;
    }

    /**
     * @param QtiRunnerServiceContext $serviceContext
     */
    public function setServiceContext($serviceContext)
    {
        $this->serviceContext = $serviceContext;
    }


    /**
     * End the item timer to QtiTimeLine

     * @param null $timestamp The start of action, optional
     * @return bool
     */
    protected function endItemTimer($timestamp = null)
    {
        if ($this->hasRequestParameter('itemDuration')) {
            $serviceContext    = $this->getServiceContext();
            $itemDuration      = $this->getRequestParameter('itemDuration');
            return $this->getRunnerService()->endTimer($serviceContext, $itemDuration, $timestamp);
        }
        return false;
    }

    /**
     * Save the actual item state.
     * Requires params itemDefinition and itemState
     *
     * @return boolean true if saved
     * @throws \common_Exception
     */
    protected function saveItemState()
    {
        if ($this->getRequestParameter('itemDefinition') && $this->getRequestParameter('itemState')) {
            $serviceContext = $this->getServiceContext();
            $itemIdentifier = $this->getRequestParameter('itemDefinition');
            $state = $this->getRequestParameter('itemState') ? json_decode($this->getRequestParameter('itemState'), true) : new \stdClass();

            return $this->getRunnerService()->setItemState($serviceContext, $itemIdentifier, $state);
        }

        return false;
    }

    /**
     * Save the item responses
     * Requires params itemDuration and optionally consumedExtraTime
     *
     * @param boolean $emptyAllowed if we allow empty responses
     * @return boolean true if saved
     * @throws \common_Exception
     * @throws QtiRunnerEmptyResponsesException if responses are empty, emptyAllowed is false and no allowSkipping
     */
    protected function saveItemResponses($emptyAllowed = true)
    {
        if ($this->getRequestParameter('itemDefinition') && $this->getRequestParameter('itemResponse')) {
            $itemDefinition = $this->getRequestParameter('itemDefinition');
            $serviceContext = $this->getServiceContext();
            $itemResponse = $this->getRequestParameter('itemResponse')
                ? json_decode($this->getRequestParameter('itemResponse'), true)
                : null;

            $currentAssessmentItemRef = $serviceContext->getCurrentAssessmentItemRef();
            if ($currentAssessmentItemRef && $serviceContext->getCurrentAssessmentItemRef()->getIdentifier() !== $itemDefinition) {
                throw new QtiRunnerItemResponseException(__('Item response identifier does not match current item'));
            }

            if (!is_null($itemResponse) && !empty($itemDefinition)) {
                $responses = $this
                    ->getRunnerService()
                    ->parsesItemResponse($serviceContext, $itemDefinition, $itemResponse);

                //still verify allowSkipping & empty responses
                if (
                    !$emptyAllowed
                    && $this->getRunnerService()->getTestConfig()->getConfigValue('enableAllowSkipping')
                    && !TestRunnerUtils::doesAllowSkipping($serviceContext->getTestSession())
                ) {
                    if ($this->getRunnerService()->emptyResponse($serviceContext, $responses)) {
                        throw new QtiRunnerEmptyResponsesException();
                    }
                }

                return $this->getRunnerService()->storeItemResponse($serviceContext, $itemDefinition, $responses);
            }
        }
        return false;
    }

    /**
     * Gets the item reference for the current itemRef
     *
     * @param string $itemIdentifier the item id
     * @return string the state id
     */
    protected function getItemRef($itemIdentifier)
    {
        $serviceContext = $this->getServiceContext();
        /** @var QtiRunnerMap $mapService */
        $mapService = $this->getServiceLocator()->get(QtiRunnerMap::SERVICE_ID);
        return $mapService->getItemHref($serviceContext, $itemIdentifier);
    }
}