Merge pull request #599 from mvdbos/feature/specific-http-exceptions

Replace generic HttpExceptions with more specific subclasses

Author: lsmith77

EventListener/FormatListener.php

@@ -12,10 +12,9 @@
 namespace FOS\RestBundle\EventListener;
 
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
-use FOS\RestBundle\Util\Codes;
 use FOS\RestBundle\Util\FormatNegotiatorInterface;
 use FOS\RestBundle\Util\MediaTypeNegotiatorInterface;
 
@@ -46,7 +45,7 @@ public function __construct(FormatNegotiatorInterface $formatNegotiator)
      *
      * @param GetResponseEvent $event The event
      *
-     * @throws HttpException
+     * @throws NotAcceptableHttpException
      */
     public function onKernelRequest(GetResponseEvent $event)
     {
@@ -65,7 +64,7 @@ public function onKernelRequest(GetResponseEvent $event)
 
         if (null === $format) {
             if ($event->getRequestType() === HttpKernelInterface::MASTER_REQUEST) {
-                throw new HttpException(Codes::HTTP_NOT_ACCEPTABLE, "No matching accepted Response format could be determined");
+                throw new NotAcceptableHttpException("No matching accepted Response format could be determined");
             }
 
             return;

Request/ParamFetcher.php

@@ -11,13 +11,12 @@
 
 namespace FOS\RestBundle\Request;
 
-use FOS\RestBundle\Util\Codes;
 use FOS\RestBundle\Controller\Annotations\QueryParam;
 use FOS\RestBundle\Controller\Annotations\Param;
 use FOS\RestBundle\Controller\Annotations\RequestParam;
 use Doctrine\Common\Util\ClassUtils;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
 /**
  * Helper to validate parameters of the active request.
@@ -113,7 +112,7 @@ public function get($name, $strict = null)
 
             if (null !== $failMessage) {
                 if ($strict) {
-                    throw new HttpException(Codes::HTTP_BAD_REQUEST, $failMessage);
+                    throw new BadRequestHttpException($failMessage);
                 }
 
                 return $default;
@@ -133,8 +132,9 @@ public function get($name, $strict = null)
                     $paramType = $config instanceof QueryParam ? 'Query' : 'Request';
                     $problem = empty($param) ? 'empty' : 'not a scalar';
 
-                    throw new HttpException(Codes::HTTP_BAD_REQUEST,
-                        sprintf('%s parameter "%s" is %s', $paramType, $name, $problem));
+                    throw new BadRequestHttpException(
+                        sprintf('%s parameter "%s" is %s', $paramType, $name, $problem)
+                    );
                 }
 
                 return $this->cleanParamWithRequirements($config, $param, $strict);
@@ -151,7 +151,7 @@ public function get($name, $strict = null)
      * @param string  $param  param to clean
      * @param boolean $strict is strict
      *
-     * @throws \RuntimeException
+     * @throws BadRequestHttpException
      * @return string
      */
     public function cleanParamWithRequirements(Param $config, $param, $strict)
@@ -165,7 +165,9 @@ public function cleanParamWithRequirements(Param $config, $param, $strict)
             if ($strict) {
                 $paramType = $config instanceof QueryParam ? 'Query' : 'Request';
 
-                throw new HttpException(Codes::HTTP_BAD_REQUEST, $paramType . " parameter value '$param', does not match requirements '{$config->requirements}'");
+                throw new BadRequestHttpException(
+                    $paramType . " parameter value '$param', does not match requirements '{$config->requirements}'"
+                );
             }
 
             return null === $default ? '' : $default;

Request/RequestBodyParamConverter.php

@@ -12,7 +12,8 @@
 namespace FOS\RestBundle\Request;
 
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Serializer\Exception\Exception as SymfonySerializerException;
 use Symfony\Component\Serializer\SerializerInterface as SymfonySerializerInterface;
@@ -23,7 +24,6 @@
 use JMS\Serializer\Exception\Exception as JMSSerializerException;
 use JMS\Serializer\DeserializationContext;
 use JMS\Serializer\SerializerInterface;
-use FOS\RestBundle\Util\Codes;
 
 /**
  * @author Tyler Stroud <[email protected]>
@@ -108,11 +108,11 @@ public function apply(Request $request, ConfigurationInterface $configuration)
                 $context
             );
         } catch (UnsupportedFormatException $e) {
-            throw new HttpException(Codes::HTTP_UNSUPPORTED_MEDIA_TYPE, $e->getMessage());
+            throw new UnsupportedMediaTypeHttpException($e->getMessage());
         } catch (JMSSerializerException $e) {
-            throw new HttpException(Codes::HTTP_BAD_REQUEST, $e->getMessage());
+            throw new BadRequestHttpException($e->getMessage());
         } catch (SymfonySerializerException $e) {
-            throw new HttpException(Codes::HTTP_BAD_REQUEST, $e->getMessage());
+            throw new BadRequestHttpException($e->getMessage());
         }
 
         $request->attributes->set($configuration->getName(), $object);

View/JsonpHandler.php

@@ -13,9 +13,7 @@
 
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Exception\HttpException;
-
-use FOS\RestBundle\Util\Codes;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
 /**
  * Implements a custom handler for JSONP leveraging the ViewHandler
@@ -39,7 +37,7 @@ protected function getCallback(Request $request)
 
         if ($this->callbackFilter && !preg_match($this->callbackFilter, $callback)) {
             $msg = "Callback '$callback' does not match '{$this->callbackFilter}'";
-            throw new HttpException(Codes::HTTP_BAD_REQUEST, $msg);
+            throw new BadRequestHttpException($msg);
         }
 
         return $callback;

View/ViewHandler.php

@@ -17,7 +17,7 @@
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
 use Symfony\Component\DependencyInjection\ContainerAware;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
@@ -278,6 +278,8 @@ protected function getTemplating()
      * @param Request $request Request object
      *
      * @return Response
+     *
+     * @throws UnsupportedMediaTypeHttpException
      */
     public function handle(View $view, Request $request = null)
     {
@@ -289,7 +291,7 @@ public function handle(View $view, Request $request = null)
 
         if (!$this->supports($format)) {
             $msg = "Format '$format' not supported, handler must be implemented";
-            throw new HttpException(Codes::HTTP_UNSUPPORTED_MEDIA_TYPE, $msg);
+            throw new UnsupportedMediaTypeHttpException($msg);
         }
 
         if (isset($this->customHandlers[$format])) {