4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpKernel\EventListener;
14 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
15 use Symfony\Component\HttpFoundation\Request;
16 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
17 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
18 use Symfony\Component\HttpKernel\KernelEvents;
19 use Symfony\Component\HttpKernel\UriSigner;
22 * Handles content fragments represented by special URIs.
24 * All URL paths starting with /_fragment are handled as
25 * content fragments by this listener.
27 * If throws an AccessDeniedHttpException exception if the request
28 * is not signed or if it is not an internal sub-request.
30 * @author Fabien Potencier <fabien@symfony.com>
32 class FragmentListener implements EventSubscriberInterface
35 private $fragmentPath;
38 * @param UriSigner $signer A UriSigner instance
39 * @param string $fragmentPath The path that triggers this listener
41 public function __construct(UriSigner $signer, $fragmentPath = '/_fragment')
43 $this->signer = $signer;
44 $this->fragmentPath = $fragmentPath;
48 * Fixes request attributes when the path is '/_fragment'.
50 * @throws AccessDeniedHttpException if the request does not come from a trusted IP
52 public function onKernelRequest(GetResponseEvent $event)
54 $request = $event->getRequest();
56 if ($this->fragmentPath !== rawurldecode($request->getPathInfo())) {
60 if ($request->attributes->has('_controller')) {
61 // Is a sub-request: no need to parse _path but it should still be removed from query parameters as below.
62 $request->query->remove('_path');
67 if ($event->isMasterRequest()) {
68 $this->validateRequest($request);
71 parse_str($request->query->get('_path', ''), $attributes);
72 $request->attributes->add($attributes);
73 $request->attributes->set('_route_params', array_replace($request->attributes->get('_route_params', array()), $attributes));
74 $request->query->remove('_path');
77 protected function validateRequest(Request $request)
79 // is the Request safe?
80 if (!$request->isMethodSafe(false)) {
81 throw new AccessDeniedHttpException();
84 // is the Request signed?
85 // we cannot use $request->getUri() here as we want to work with the original URI (no query string reordering)
86 if ($this->signer->check($request->getSchemeAndHttpHost().$request->getBaseUrl().$request->getPathInfo().(null !== ($qs = $request->server->get('QUERY_STRING')) ? '?'.$qs : ''))) {
90 throw new AccessDeniedHttpException();
93 public static function getSubscribedEvents()
96 KernelEvents::REQUEST => array(array('onKernelRequest', 48)),