<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

namespace PrestaShopBundle\Routing\Linter;

use Doctrine\Common\Annotations\Reader;
use InvalidArgumentException;
use PrestaShopBundle\Routing\Linter\Exception\LinterException;
use PrestaShopBundle\Security\Annotation\AdminSecurity;
use ReflectionMethod;
use Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser;
use Symfony\Component\Routing\Route;

/**
 * Checks if SecurityAnnotation is configured for route's controller action
 */
final class SecurityAnnotationLinter implements RouteLinterInterface
{
    /**
     * @var Reader
     */
    private $annotationReader;

    /**
     * @var ControllerNameParser
     */
    private $controllerNameParser;

    /**
     * @param Reader $annotationReader
     * @param ControllerNameParser $controllerNameParser
     */
    public function __construct(Reader $annotationReader, ControllerNameParser $controllerNameParser)
    {
        $this->annotationReader = $annotationReader;
        $this->controllerNameParser = $controllerNameParser;
    }

    /**
     * @param string $routeName
     * @param Route $route
     *
     * @return AdminSecurity
     *
     * @throws \ReflectionException
     * @throws LinterException
     */
    public function getRouteSecurityAnnotation($routeName, Route $route)
    {
        $controllerAndMethod = $this->extractControllerAndMethodNamesFromRoute($route);

        if ($controllerAndMethod === null) {
            throw new LinterException(sprintf('"%s" cannot be parsed', $route->getDefault('_controller')));
        }

        $reflection = new ReflectionMethod(
            $controllerAndMethod['controller'],
            $controllerAndMethod['method']
        );

        $annotation = $this->annotationReader->getMethodAnnotation($reflection, AdminSecurity::class);

        if (null === $annotation) {
            throw new LinterException(sprintf('"%s:%s" does not have AdminSecurity annotation configured', $controllerAndMethod['controller'], $controllerAndMethod['method']));
        }

        return $annotation;
    }

    /**
     * {@inheritdoc}
     */
    public function lint($routeName, Route $route)
    {
        $this->getRouteSecurityAnnotation($routeName, $route);
    }

    /**
     * @param Route $route
     *
     * @return array|null
     */
    private function extractControllerAndMethodNamesFromRoute(Route $route)
    {
        $controller = $route->getDefault('_controller');

        if (strpos($controller, '::') === false) {
            // we need to support controllers defined as services & defined using short notation
            try {
                $controller = $this->controllerNameParser->parse($controller);
            } catch (InvalidArgumentException $e) {
                return null;
            }
        }

        list($controller, $method) = explode('::', $controller, 2);

        return [
            'controller' => $controller,
            'method' => $method,
        ];
    }
}