Surfnet\StepupBundle\Controller\ExceptionController

Complexity

Total Complexity

12

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	showAction()	0	32	2
A	getStatusCode()	0	17	4
B	getPageTitleAndDescription()	0	33	5
A	getTranslator()	0	4	1

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupBundle\Controller;

use DateTime;
use Exception;
use Surfnet\StepupBundle\EventListener\RequestIdRequestResponseListener;
use Surfnet\StepupBundle\Exception\Art;
use Surfnet\StepupBundle\Exception\UserErrorProviderInterface;
use Surfnet\StepupBundle\Exception\UserMessageException;
use Symfony\Bundle\FrameworkBundle\Controller\Controller as FrameworkController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Translation\TranslatorInterface;

class ExceptionController extends FrameworkController
{
    public function showAction(Request $request, Exception $exception)
    {
        $statusCode = $this->getStatusCode($exception);

        if ($statusCode == 404) {
            $template = 'SurfnetStepupBundle:Exception:error404.html.twig';
        } else {
            $template = 'SurfnetStepupBundle:Exception:error.html.twig';
        }

        $response = new Response('', $statusCode);

        $timestamp = (new DateTime)->format(DateTime::ISO8601);
        $hostname  = $request->getHost();
        $requestId = $request->headers->get(RequestIdRequestResponseListener::HEADER_NAME, '-');
        $errorCode = Art::forException($exception);
        $userAgent = $request->headers->get('User-Agent');
        $ipAddress = $request->getClientIp();

        return $this->render(
            $template,
            [
                'timestamp'   => $timestamp,
                'hostname'    => $hostname,
                'request_id'  => $requestId,
                'error_code'  => $errorCode,
                'user_agent'  => $userAgent,
                'ip_address'  => $ipAddress,
            ] + $this->getPageTitleAndDescription($exception),
            $response
        );
    }

    /**
     * @param Exception $exception
     * @return int HTTP status code
     */
    private function getStatusCode(Exception $exception)
    {
        if ($exception instanceof AuthenticationException) {
            return Response::HTTP_UNAUTHORIZED;
        }

        if ($exception instanceof AccessDeniedException) {
            return Response::HTTP_FORBIDDEN;
        }

        if ($exception instanceof HttpExceptionInterface) {
            return $exception->getStatusCode();
        }

        // Unknown exceptions are server errors!
        return 500;
    }

    /**
     * @param Exception $exception
     * @return array View parameters 'title' and 'description'
     */
    protected function getPageTitleAndDescription(Exception $exception)
    {
        $translator = $this->getTranslator();
        $parameters = [];

        // If the exception wraps a UserErrorProviderInterface, base the error
        // page on the wrapped exception. This happens when symfony converts
        // AccessDeniedException objects into AccessDeniedHttpException
        // objects.
        if (!$exception instanceof UserErrorProviderInterface &&
            $exception->getPrevious() instanceof UserErrorProviderInterface) {
            $exception = $exception->getPrevious();
        }

        if ($exception instanceof UserErrorProviderInterface) {
            $parameters['title'] = $translator->trans(
                $exception->getErrorPageTitleMessageId()
            );

            $parameters['description'] = $translator->trans(
                $exception->getErrorPageDescriptionMessageId(),
                $exception->getErrorPageDescriptionArguments()
            );
        } elseif ($exception instanceof AuthenticationException) {
            $parameters['title'] = $translator->trans('stepup.error.authentication_error.title');
            $parameters['description'] = $translator->trans('stepup.error.authentication_error.description');
        } else {
            $parameters['title'] = $translator->trans('stepup.error.generic_error.title');
            $parameters['description'] = $translator->trans('stepup.error.generic_error.description');
        }

        return $parameters;
    }

    /**
     * @return TranslatorInterface
     */
    protected function getTranslator()
    {
        return $this->get('translator');
    }
}