Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	33.33% covered (danger)	33.33%	2 / 6	CRAP	71.79% covered (warning)	71.79%	28 / 39
FormAjaxSubscriber	0.00% covered (danger)	0.00%	0 / 1	42.86% covered (danger)	42.86%	3 / 7	18.40	71.79% covered (warning)	71.79%	28 / 39
__construct				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 3
onView				0.00% covered (danger)	0.00%	0 / 1	6	0.00% covered (danger)	0.00%	0 / 4
onException				100.00% covered (success)	100.00%	1 / 1	5	100.00% covered (success)	100.00%	21 / 21
getFormAjaxException				100.00% covered (success)	100.00%	1 / 1	3	100.00% covered (success)	100.00%	7 / 7
formatSize				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 1
getSubscribedEvents				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 3
drupalSetMessage				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Form\EventSubscriber\FormAjaxSubscriber.
6	*/
7
8	namespace Drupal\Core\Form\EventSubscriber;
9
10	use Drupal\Core\Ajax\AjaxResponse;
11	use Drupal\Core\Ajax\ReplaceCommand;
12	use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
13	use Drupal\Core\Form\Exception\BrokenPostRequestException;
14	use Drupal\Core\Form\FormAjaxException;
15	use Drupal\Core\Form\FormAjaxResponseBuilderInterface;
16	use Drupal\Core\Form\FormBuilderInterface;
17	use Drupal\Core\StringTranslation\StringTranslationTrait;
18	use Drupal\Core\StringTranslation\TranslationInterface;
19	use Symfony\Component\EventDispatcher\EventSubscriberInterface;
20	use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
21	use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
22	use Symfony\Component\HttpKernel\KernelEvents;
23
24	/**
25	* Wraps AJAX form submissions that are triggered via an exception.
26	*/
27	class FormAjaxSubscriber implements EventSubscriberInterface {
28
29	use StringTranslationTrait;
30
31	/**
32	* The form AJAX response builder.
33	*
34	* @var \Drupal\Core\Form\FormAjaxResponseBuilderInterface
35	*/
36	protected $formAjaxResponseBuilder;
37
38	/**
39	* Constructs a new FormAjaxSubscriber.
40	*
41	* @param \Drupal\Core\Form\FormAjaxResponseBuilderInterface $form_ajax_response_builder
42	* The form AJAX response builder.
43	* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
44	* The string translation.
45	*/
46	public function __construct(FormAjaxResponseBuilderInterface $form_ajax_response_builder, TranslationInterface $string_translation) {
47	$this->formAjaxResponseBuilder = $form_ajax_response_builder;
48	$this->stringTranslation = $string_translation;
49	}
50
51	/**
52	* Alters the wrapper format if this is an AJAX form request.
53	*
54	* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
55	* The event to process.
56	*/
57	public function onView(GetResponseForControllerResultEvent $event) {
58	// To support an AJAX form submission of a form within a block, make the
59	// later VIEW subscribers process the controller result as though for
60	// HTML display (i.e., add blocks). During that block building, when the
61	// submitted form gets processed, an exception gets thrown by
62	// \Drupal\Core\Form\FormBuilderInterface::buildForm(), allowing
63	// self::onException() to return an AJAX response instead of an HTML one.
64	$request = $event->getRequest();
65	if ($request->query->has(FormBuilderInterface::AJAX_FORM_REQUEST)) {
66	$request->query->set(MainContentViewSubscriber::WRAPPER_FORMAT, 'html');
67	}
68	}
69
70	/**
71	* Catches a form AJAX exception and build a response from it.
72	*
73	* @param \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent $event
74	* The event to process.
75	*/
76	public function onException(GetResponseForExceptionEvent $event) {
77	$exception = $event->getException();
78	$request = $event->getRequest();
79
80	// Render a nice error message in case we have a file upload which exceeds
81	// the configured upload limit.
82	if ($exception instanceof BrokenPostRequestException && $request->query->has(FormBuilderInterface::AJAX_FORM_REQUEST)) {
83	$this->drupalSetMessage($this->t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', ['@size' => $this->formatSize($exception->getSize())]), 'error');
84	$response = new AjaxResponse();
85	$status_messages = ['#type' => 'status_messages'];
86	$response->addCommand(new ReplaceCommand(NULL, $status_messages));
87	$response->headers->set('X-Status-Code', 200);
88	$event->setResponse($response);
89	return;
90	}
91
92	// Extract the form AJAX exception (it may have been passed to another
93	// exception before reaching here).
94	if ($exception = $this->getFormAjaxException($exception)) {
95	$request = $event->getRequest();
96	$form = $exception->getForm();
97	$form_state = $exception->getFormState();
98
99	// Set the build ID from the request as the old build ID on the form.
100	$form['#build_id_old'] = $request->get('form_build_id');
101
102	try {
103	$response = $this->formAjaxResponseBuilder->buildResponse($request, $form, $form_state, []);
104
105	// Since this response is being set in place of an exception, explicitly
106	// mark this as a 200 status.
107	$response->headers->set('X-Status-Code', 200);
108	$event->setResponse($response);
109	}
110	catch (\Exception $e) {
111	// Otherwise, replace the existing exception with the new one.
112	$event->setException($e);
113	}
114	}
115	}
116
117	/**
118	* Extracts a form AJAX exception.
119	*
120	* @param \Exception $e
121	* A generic exception that might contain a form AJAX exception.
122	*
123	* @return \Drupal\Core\Form\FormAjaxException\|null
124	* Either the form AJAX exception, or NULL if none could be found.
125	*/
126	protected function getFormAjaxException(\Exception $e) {
127	$exception = NULL;
128	while ($e) {
129	if ($e instanceof FormAjaxException) {
130	$exception = $e;
131	break;
132	}
133
134	$e = $e->getPrevious();
135	}
136	return $exception;
137	}
138
139	/**
140	* Wraps format_size()
141	*
142	* @return string
143	* The formatted size.
144	*/
145	protected function formatSize($size) {
146	return format_size($size);
147	}
148
149	/**
150	* {@inheritdoc}
151	*/
152	public static function getSubscribedEvents() {
153	// Run before exception.logger.
154	$events[KernelEvents::EXCEPTION] = ['onException', 51];
155	// Run before main_content_view_subscriber.
156	$events[KernelEvents::VIEW][] = ['onView', 1];
157
158	return $events;
159	}
160
161	/**
162	* Wraps drupal_set_message().
163	*
164	* @codeCoverageIgnore
165	*/
166	protected function drupalSetMessage($message = NULL, $type = 'status', $repeat = FALSE) {
167	drupal_set_message($message, $type, $repeat);
168	}
169
170	}