<?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) 2018 (original work) Open Assessment Technologies SA;
 *
 */

namespace oat\tao\model\session\restSessionFactory;

use common_exception_InconsistentData;
use common_ext_ManifestNotFoundException;
use oat\oatbox\service\ConfigurableService;
use oat\oatbox\user\LoginFailedException;
use oat\tao\model\action\RestControllerInterface;
use oat\tao\model\routing\Resolver;
use ResolverException;

/**
 * Class RestSessionFactory
 *
 * A factory to build rest session based on configured adapters
 *
 * @package oat\tao\model\session\restSessionFactory
 */
class RestSessionFactory extends ConfigurableService
{
    const SERVICE_ID = 'tao/restSessionFactory';

    const OPTION_BUILDERS = 'builders';

    /**
     * Create a rest session based on builders.
     *
     * Give the request and resolver to builder to know if it is applicable
     * If yes, create and start the session from it
     *
     * @param $request
     * @param $resolver
     * @return bool
     * @throws LoginFailedException
     */
    public function createSessionFromRequest($request, $resolver)
    {
        if (!$this->isRestController($resolver)) {
            return false;
        }
        /** @var SessionBuilder $builder */
        foreach ($this->getSessionBuilders() as $builder) {
            if ($builder->isApplicable($request)) {
                return $this->startSession($builder->getSession($request));
            }
        }
        throw new LoginFailedException(['Request cannot be authenticated.']);
    }

    /**
     * Start a session through SessionManager
     *
     * @param $session
     * @return bool
     */
    protected function startSession($session)
    {
        return \common_session_SessionManager::startSession($session);
    }

    /**
     * Fetch rest session builder from the config
     *
     * @return SessionBuilder[]
     */
    protected function getSessionBuilders()
    {
        $adapters = is_array($this->getOption(self::OPTION_BUILDERS)) ? $this->getOption(self::OPTION_BUILDERS) : [];
        foreach ($adapters as $key => $adapter) {
            if (!is_a($adapter, SessionBuilder::class, true)) {
                throw new \LogicException('Session adapter must implement interface "SessionBuilder".');
            }
            $adapters[$key] = $this->propagate(new $adapter());
        }
        return $adapters;
    }

    /**
     * Check if the requested controller is a RestController
     *
     * @param Resolver $resolver
     *
     * @return bool
     * @throws ResolverException
     * @throws common_exception_InconsistentData
     * @throws common_ext_ManifestNotFoundException
     */
    protected function isRestController(Resolver $resolver): bool
    {
        return is_subclass_of($resolver->getControllerClass(), RestControllerInterface::class, true);
    }
}