<?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) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2002-2008 (update and modification) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
 *               2013-2014 (update and modification) Open Assessment Technologies SA
 */

namespace oat\taoTestTaker\actions;

use common_ext_ExtensionException;
use common_ext_ExtensionsManager;
use core_kernel_classes_Class;
use core_kernel_classes_Property;
use core_kernel_classes_Resource;
use core_kernel_users_Service;
use oat\oatbox\validator\ValidatorInterface;
use oat\generis\Helper\UserHashForEncryption;
use oat\generis\model\GenerisRdf;
use oat\generis\model\OntologyAwareTrait;
use oat\oatbox\event\EventManager;
use oat\tao\model\resources\ResourceWatcher;
use oat\tao\model\routing\AnnotationReader\security;
use oat\taoTestTaker\actions\form\Search;
use oat\taoTestTaker\actions\form\TestTaker as TestTakerForm;
use oat\taoGroups\helpers\TestTakerForm as GroupForm;
use oat\taoTestTaker\models\events\TestTakerUpdatedEvent;
use oat\taoTestTaker\models\TestTakerService;
use tao_actions_SaSModule;
use tao_helpers_Uri;
use tao_models_classes_UserService;
use tao_helpers_form_FormContainer as FormContainer;
use oat\tao\model\Lists\Business\Validation\DependsOnPropertyValidator;

/**
 * Subjects Controller provide actions performed from url resolution
 *
 * @author Bertrand Chevrier, <taosupport@tudor.lu>
 * @package taoTestTaker
 * @license GPLv2 http://www.opensource.org/licenses/gpl-2.0.php
 */
class TestTaker extends tao_actions_SaSModule
{
    use OntologyAwareTrait;

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

    /**
     * @throws common_ext_ExtensionException
     * @security("hide")
     */
    public function __construct()
    {
        parent::__construct();

        $this->defaultData();
    }

    /**
     * overwrite the parent getOntologyData to add the requiresRight only in TestTakers
     * @see tao_actions_TaoModule::getOntologyData()
     * @requiresRight classUri READ
     */
    public function getOntologyData()
    {
        return parent::getOntologyData();
    }

    /**
     * (non-PHPdoc)
     * @see tao_actions_RdfController::getClassService()
     * @return TestTakerService
     */
    protected function getClassService()
    {
        if (is_null($this->service)) {
            $this->service = TestTakerService::singleton();
        }

        return $this->service;
    }

    /**
     *
     * @author Lionel Lecaque, lionel@taotesting.com
     * @param core_kernel_classes_Class $clazz
     * @return tao_actions_form_Search
     */
    protected function getSearchForm($clazz)
    {
        return new Search($clazz, null, [
            'recursive' => true
        ]);
    }

    /**
     * edit an subject instance
     *
     * @requiresRight id READ
     *
     * @throws \InterruptedActionException
     * @throws \common_exception_Error
     * @throws \core_kernel_persistence_Exception
     * @throws \oat\generis\model\user\PasswordConstraintsException
     * @throws \oat\tao\model\security\SecurityException
     * @throws \tao_models_classes_MissingRequestParameterException
     * @throws \tao_models_classes_dataBinding_GenerisFormDataBindingException
     */
    public function editSubject()
    {
        $clazz = $this->getCurrentClass();

        // get the subject to edit
        $subject = $this->getCurrentInstance();

        $addMode = false;
        $login = (string) $subject->getOnePropertyValue(new core_kernel_classes_Property(GenerisRdf::PROPERTY_USER_LOGIN));
        if (empty($login)) {
            $addMode = true;
            $this->setData('loginUri', tao_helpers_Uri::encode(GenerisRdf::PROPERTY_USER_LOGIN));
        }

        if ($this->hasRequestParameter('reload')) {
            $this->setData('reload', true);
        }

        $myFormContainer = new TestTakerForm(
            $clazz,
            $subject,
            $addMode,
            [
                FormContainer::CSRF_PROTECTION_OPTION => true,
                FormContainer::ATTRIBUTE_VALIDATORS => [
                    'data-depends-on-property' => [
                        $this->getDependsOnPropertyValidator(),
                    ],
                ],
            ]
        );
        $myForm = $myFormContainer->getForm();

        $subjectUri = $subject->getUri();

        if ($myForm->isSubmited() && $myForm->isValid()) {
            $this->validateInstanceRoot($subjectUri);
            $this->setData('reload', false);

            $values = $myForm->getValues();

            if ($addMode) {
                $plainPassword = $values['password1'];
                $values[GenerisRdf::PROPERTY_USER_PASSWORD] =
                    core_kernel_users_Service::getPasswordHash()->encrypt($values['password1']);
                unset($values['password1'], $values['password2']);
            } else {
                if (! empty($values['password2'])) {
                    $plainPassword = $values['password2'];
                    $values[GenerisRdf::PROPERTY_USER_PASSWORD] =
                        core_kernel_users_Service::getPasswordHash()->encrypt($values['password2']);
                }
                unset($values['password2'], $values['password3']);
            }

            $binder = new \tao_models_classes_dataBinding_GenerisFormDataBinder($subject);
            $subject = $binder->bind($values);

            $data = [];
            if (isset($plainPassword)) {
                $data = ['hashForKey' => UserHashForEncryption::hash($plainPassword)];
            }

            if ($addMode) {
                // force default subject roles to be the Delivery Role:
                $this->getClassService()->setTestTakerRole($subject);
            }

            // force the data language to be the same as the gui language
            $userService = tao_models_classes_UserService::singleton();
            $lang = new core_kernel_classes_Resource($values[GenerisRdf::PROPERTY_USER_UILG]);
            $userService->bindProperties($subject, [
                GenerisRdf::PROPERTY_USER_DEFLG => $lang->getUri()
            ]);

            $this->getEventManager()->trigger(
                new TestTakerUpdatedEvent($subjectUri, array_merge($values, $data))
            );

            $message = __('Test taker saved');

            if ($addMode) {
                $params = [
                    'id' => $subjectUri,
                    'uri' => tao_helpers_Uri::encode($subjectUri),
                    'classUri' => tao_helpers_Uri::encode($clazz->getUri()),
                    'reload' => true,
                    'message' => $message
                ];
                $this->redirect(_url('editSubject', null, null, $params));
            }

            $this->setData('selectNode', tao_helpers_Uri::encode($subjectUri));
            $this->setData('message', $message);
            $this->setData('reload', true);
        }

        if (common_ext_ExtensionsManager::singleton()->isEnabled('taoGroups')) {
            $groupForm = GroupForm::returnGroupTreeFormObject($subject);

            $groupForm->setData('saveUrl', _url('setValues', 'TestTakerGenerisTree', 'taoTestTaker'));

            $this->setData('groupForm', $groupForm->render());
        }
        $updatedAt = $this->getServiceManager()->get(ResourceWatcher::SERVICE_ID)->getUpdatedAt($subject);
        $this->setData('updatedAt', $updatedAt);
        $this->setData('checkLogin', $addMode);
        $this->setData('formTitle', __('Edit subject'));
        $this->setData('myForm', $myForm->render());
        $this->setView('form_subjects.tpl');
    }

    /**
     * overwrite the parent moveAllInstances to add the requiresRight only in TestTakers
     * @see tao_actions_TaoModule::moveAll()
     * @requiresRight ids WRITE
     */
    public function moveAll()
    {
        return parent::moveAll();
    }

    /**
     * overwrite the parent cloneInstance to add the requiresRight only in TestTakers
     * @see tao_actions_TaoModule::cloneInstance()
     * @requiresRight uri READ
     * @requiresRight classUri WRITE
     */
    public function cloneInstance()
    {
        return parent::cloneInstance();
    }

    /**
     * overwrite the parent moveInstance to add the requiresRight only in TestTakers
     * @see tao_actions_TaoModule::moveInstance()
     * @requiresRight uri WRITE
     * @requiresRight destinationClassUri WRITE
     */
    public function moveInstance()
    {
        return parent::moveInstance();
    }

    /**
     * Move class to another location
     * @requiresRight classUri WRITE
     */
    public function moveClass()
    {
        return parent::moveResource();
    }

    private function getDependsOnPropertyValidator(): ValidatorInterface
    {
        return $this->getPsrContainer()->get(DependsOnPropertyValidator::class);
    }
}