Template::convertHtmlToAjaxXml() - Code Metrics - Inspection of "Merge pull request #1509 from hemberger/unused-var..." - smrealms/smr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — main ( 10f5c7...a0aba6 )

by Dan

created 2023-01-09 04:36 UTC

Template::convertHtmlToAjaxXml() F

↳ Parent: Template

Complexity

Conditions	23
Paths	779

Size

Total Lines	90
Code Lines	53

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	23
eloc	53
nc	779
nop	2
dl	0
loc	90
rs	0.3069
c	1
b	0
f	0

How to fix Long Method Complexity

<?php declare(strict_types=1);

namespace Smr;

use DOMDocument;
use DOMElement;
use DOMNode;
use DOMXPath;
use Exception;
use Smr\Container\DiContainer;

class Template {

	/** @var array<string, mixed> */
	private array $data = [];
	private int $nestedIncludes = 0;
	/** @var array<string, mixed> */
	private array $ajaxJS = [];
	/** @var array<string> */
	protected array $jsAlerts = [];
	/** @var array<string> */
	protected array $jsSources = [];

	/**
	 * Defines a listjs_include.js function to call at the end of the HTML body.
	 */
	public ?string $listjsInclude = null;

	/**
	 * Return the Smr\Template in the DI container.
	 * If one does not exist yet, it will be created.
	 * This is the intended way to construct this class.
	 */
	public static function getInstance(): self {
		return DiContainer::get(self::class);
	}

	public function hasTemplateVar(string $var): bool {
		return isset($this->data[$var]);
	}

	public function assign(string $var, mixed $value): void {
		if (!isset($this->data[$var])) {
			$this->data[$var] = $value;
		} else {
			// We insist that template variables not change once they are set
			throw new Exception("Cannot re-assign template variable '$var'!");
		}
	}

	public function unassign(string $var): void {
		unset($this->data[$var]);
	}

	/**
	 * Displays the template HTML. Stores any ajax-enabled elements for future
	 * comparison, and outputs modified elements in XML for ajax if requested.
	 */
	public function display(string $templateName, bool $outputXml = false): void {
		// If we already started output buffering before calling `display`,
		// we may have unwanted content in the buffer that we need to remove
		// before we send the Content-Type headers below.
		// Skip this for debug builds to help discover offending output.
		if (!ENABLE_DEBUG) {
			if (ob_get_length() > 0) {
				ob_clean();
			}
		}
		ob_start();
		$this->includeTemplate($templateName);
		$output = ob_get_clean();
		if ($output === false) {
			throw new Exception('Output buffering is not active!');
		}

		$ajaxEnabled = ($this->data['AJAX_ENABLE_REFRESH'] ?? false) !== false;
		if ($ajaxEnabled) {
			$ajaxXml = $this->convertHtmlToAjaxXml($output, $outputXml);
			if ($outputXml) {
				/* Left out for size: <?xml version="1.0" encoding="ISO-8859-1"?>*/
				$output = '<all>' . $ajaxXml . '</all>';
			}
			$session = Session::getInstance();
			$session->saveAjaxReturns();
		}

		// Now that we are completely done processing, we can output
		if ($outputXml) {
			header('Content-Type: text/xml; charset=utf-8');
		} else {
			header('Content-Type: text/html; charset=utf-8');
		}
		echo $output;
	}


	protected function getTemplateLocation(string $templateName): string {
		if (isset($this->data['ThisAccount'])) {
			$templateDir = $this->data['ThisAccount']->getTemplate() . '/';
		} else {
			$templateDir = 'Default/';
		}
		$templateDirs = array_unique([$templateDir, 'Default/']);

		foreach ($templateDirs as $templateDir) {
			$filePath = TEMPLATES . $templateDir . 'engine/Default/' . $templateName;
			if (is_file($filePath)) {
				return $filePath;
			}
		}
		foreach ($templateDirs as $templateDir) {
			$filePath = TEMPLATES . $templateDir . $templateName;
			if (is_file($filePath)) {
				return $filePath;
			}
		}
		throw new Exception('No template found for ' . $templateName);
	}

	/**
	 * @param array<string, mixed> $assignVars
	 */
	protected function includeTemplate(string $templateName, array $assignVars = null): void {
		if ($this->nestedIncludes > 15) {
			throw new Exception('Nested more than 15 template includes, is something wrong?');
		}
		extract($this->data);
		if ($assignVars !== null) {
			extract($assignVars);
		}
		$this->nestedIncludes++;
		require($this->getTemplateLocation($templateName));
		$this->nestedIncludes--;
	}

	/**
	 * Check if the HTML includes input elements where the user is able to
	 * input data (i.e. we don't want to AJAX update a form that they may
	 * have already started filling out).
	 */
	protected function checkDisableAJAX(string $html): bool {
		return preg_match('/<input (?![^>]*(submit|hidden|image))/i', $html) != 0;
	}

	protected function doDamageTypeReductionDisplay(int &$damageTypes): void {
		if ($damageTypes == 3) {
			echo ', ';
		} elseif ($damageTypes == 2) {
			echo ' and ';
		}
		$damageTypes--;
	}

	protected function doAn(string $wordAfter): string {
		$char = strtoupper($wordAfter[0]);
		return str_contains('AEIOU', $char) ? 'an' : 'a';
	}

	/*
	 * EVAL is special (well, will be when needed and implemented in the javascript).
	 */
	public function addJavascriptForAjax(string $varName, mixed $obj): string {
		if ($varName == 'EVAL') {
			if (!isset($this->ajaxJS['EVAL'])) {
				return $this->ajaxJS['EVAL'] = $obj;
			}
			return $this->ajaxJS['EVAL'] .= ';' . $obj;
		}

		if (isset($this->ajaxJS[$varName])) {
			throw new Exception('Trying to set javascript val twice: ' . $varName);
		}
		$json = json_encode($obj);
		if ($json === false) {
			throw new Exception('Failed to encode to json: ' . $varName);
		}
		return $this->ajaxJS[$varName] = $json;
	}

	protected function addJavascriptAlert(string $string): void {
		$session = Session::getInstance();
		if (!$session->addAjaxReturns('ALERT:' . $string, $string)) {
			$this->jsAlerts[] = $string;
		}
	}

	/**
	 * Registers a JS target for inclusion at the end of the HTML body.
	 */
	protected function addJavascriptSource(string $src): void {
		$this->jsSources[] = $src;
	}

	protected function convertHtmlToAjaxXml(string $str, bool $returnXml): string {
		if (empty($str)) {
			return '';
		}

		$session = Session::getInstance();

		$getInnerHTML = function(DOMNode $node): string {
			$innerHTML = '';
			foreach ($node->childNodes as $child) {
				$innerHTML .= $child->ownerDocument->saveHTML($child);
			}
			return $innerHTML;
		};

		// Helper function to canonicalize making an XML element,
		// with its inner content properly escaped.
		$xmlify = function(string $id, string $str): string {
			return '<' . $id . '>' . htmlspecialchars($str, ENT_XML1, 'utf-8') . '</' . $id . '>';
		};

		$xml = '';
		$dom = new DOMDocument();
		$dom->loadHTML($str);
		$xpath = new DOMXPath($dom);

		// Use relative xpath selectors so that they can be reused when we
		// pass the middle panel as the xpath query's context node.
		$ajaxSelectors = ['.//span[@id]', './/*[contains(@class,"ajax")]'];

		foreach ($ajaxSelectors as $selector) {
			$matchNodes = $xpath->query($selector);
			if ($matchNodes === false) {
				throw new Exception('XPath query failed for selector: ' . $selector);
			}
			foreach ($matchNodes as $node) {
				if (!($node instanceof DOMElement)) {
					throw new Exception('XPath query returned unexpected DOMNode type: ' . $node->nodeType);
				}
				$id = $node->getAttribute('id');
				$inner = $getInnerHTML($node);
				if (!$session->addAjaxReturns($id, $inner) && $returnXml) {
					$xml .= $xmlify($id, $inner);
				}
			}
		}

		// Determine if we should do ajax updates on the middle panel div
		$mid = $dom->getElementById('middle_panel');
		$doAjaxMiddle = true;
		if ($mid === null) {
			// Skip if there is no middle_panel.
			$doAjaxMiddle = false;
		} else {
			// Skip if middle_panel has ajax-enabled children.
			foreach ($ajaxSelectors as $selector) {
				$matchNodes = $xpath->query($selector, $mid);
				if ($matchNodes === false) {
					throw new Exception('XPath query failed for selector: ' . $selector);
				}
				if (count($matchNodes) > 0) {
					$doAjaxMiddle = false;
					break;
				}
			}
		}

		if ($doAjaxMiddle) {
			$inner = $getInnerHTML($mid);
			if (!$this->checkDisableAJAX($inner)) {
				$id = $mid->getAttribute('id');
				if (!$session->addAjaxReturns($id, $inner) && $returnXml) {
					$xml .= $xmlify($id, $inner);
				}
			}
		}

		$js = '';
		foreach ($this->ajaxJS as $varName => $JSON) {
			if (!$session->addAjaxReturns('JS:' . $varName, $JSON) && $returnXml) {
				$js .= $xmlify($varName, $JSON);
			}
		}
		if ($returnXml && count($this->jsAlerts) > 0) {
			$js = '<ALERT>' . json_encode($this->jsAlerts) . '</ALERT>';
		}
		if (strlen($js) > 0) {
			$xml .= '<JS>' . $js . '</JS>';
		}
		return $xml;
	}

}


1			<?php declare(strict_types=1);
2
3			namespace Smr;
4
5			use DOMDocument;
6			use DOMElement;
7			use DOMNode;
8			use DOMXPath;
9			use Exception;
10			use Smr\Container\DiContainer;
11
12			class Template {
13
14			/** @var array<string, mixed> */
15			private array $data = [];
16			private int $nestedIncludes = 0;
17			/** @var array<string, mixed> */
18			private array $ajaxJS = [];
19			/** @var array<string> */
20			protected array $jsAlerts = [];
21			/** @var array<string> */
22			protected array $jsSources = [];
23
24			/**
25			* Defines a listjs_include.js function to call at the end of the HTML body.
26			*/
27			public ?string $listjsInclude = null;
28
29			/**
30			* Return the Smr\Template in the DI container.
31			* If one does not exist yet, it will be created.
32			* This is the intended way to construct this class.
33			*/
34			public static function getInstance(): self {
35			return DiContainer::get(self::class);
36			}
37
38			public function hasTemplateVar(string $var): bool {
39			return isset($this->data[$var]);
40			}
41
42			public function assign(string $var, mixed $value): void {
43			if (!isset($this->data[$var])) {
44			$this->data[$var] = $value;
45			} else {
46			// We insist that template variables not change once they are set
47			throw new Exception("Cannot re-assign template variable '$var'!");
48			}
49			}
50
51			public function unassign(string $var): void {
52			unset($this->data[$var]);
53			}
54
55			/**
56			* Displays the template HTML. Stores any ajax-enabled elements for future
57			* comparison, and outputs modified elements in XML for ajax if requested.
58			*/
59			public function display(string $templateName, bool $outputXml = false): void {
60			// If we already started output buffering before calling `display`,
61			// we may have unwanted content in the buffer that we need to remove
62			// before we send the Content-Type headers below.
63			// Skip this for debug builds to help discover offending output.
64			if (!ENABLE_DEBUG) {
65			if (ob_get_length() > 0) {
66			ob_clean();
67			}
68			}
69			ob_start();
70			$this->includeTemplate($templateName);
71			$output = ob_get_clean();
72			if ($output === false) {
73			throw new Exception('Output buffering is not active!');
74			}
75
76			$ajaxEnabled = ($this->data['AJAX_ENABLE_REFRESH'] ?? false) !== false;
77			if ($ajaxEnabled) {
78			$ajaxXml = $this->convertHtmlToAjaxXml($output, $outputXml);
79			if ($outputXml) {
80			/* Left out for size: <?xml version="1.0" encoding="ISO-8859-1"?>*/
81			$output = '<all>' . $ajaxXml . '</all>';
82			}
83			$session = Session::getInstance();
84			$session->saveAjaxReturns();
85			}
86
87			// Now that we are completely done processing, we can output
88			if ($outputXml) {
89			header('Content-Type: text/xml; charset=utf-8');
90			} else {
91			header('Content-Type: text/html; charset=utf-8');
92			}
93			echo $output;
94			}
95
96
97			protected function getTemplateLocation(string $templateName): string {
98			if (isset($this->data['ThisAccount'])) {
99			$templateDir = $this->data['ThisAccount']->getTemplate() . '/';
100			} else {
101			$templateDir = 'Default/';
102			}
103			$templateDirs = array_unique([$templateDir, 'Default/']);
104
105			foreach ($templateDirs as $templateDir) {
106			$filePath = TEMPLATES . $templateDir . 'engine/Default/' . $templateName;
107			if (is_file($filePath)) {
108			return $filePath;
109			}
110			}
111			foreach ($templateDirs as $templateDir) {
112			$filePath = TEMPLATES . $templateDir . $templateName;
113			if (is_file($filePath)) {
114			return $filePath;
115			}
116			}
117			throw new Exception('No template found for ' . $templateName);
118			}
119
120			/**
121			* @param array<string, mixed> $assignVars
122			*/
123			protected function includeTemplate(string $templateName, array $assignVars = null): void {
124			if ($this->nestedIncludes > 15) {
125			throw new Exception('Nested more than 15 template includes, is something wrong?');
126			}
127			extract($this->data);
128			if ($assignVars !== null) {
129			extract($assignVars);
130			}
131			$this->nestedIncludes++;
132			require($this->getTemplateLocation($templateName));
133			$this->nestedIncludes--;
134			}
135
136			/**
137			* Check if the HTML includes input elements where the user is able to
138			* input data (i.e. we don't want to AJAX update a form that they may
139			* have already started filling out).
140			*/
141			protected function checkDisableAJAX(string $html): bool {
142			return preg_match('/<input (?![^>]*(submit\|hidden\|image))/i', $html) != 0;
143			}
144
145			protected function doDamageTypeReductionDisplay(int &$damageTypes): void {
146			if ($damageTypes == 3) {
147			echo ', ';
148			} elseif ($damageTypes == 2) {
149			echo ' and ';
150			}
151			$damageTypes--;
152			}
153
154			protected function doAn(string $wordAfter): string {
155			$char = strtoupper($wordAfter[0]);
156			return str_contains('AEIOU', $char) ? 'an' : 'a';
157			}
158
159			/*
160			* EVAL is special (well, will be when needed and implemented in the javascript).
161			*/
162			public function addJavascriptForAjax(string $varName, mixed $obj): string {
163			if ($varName == 'EVAL') {
164			if (!isset($this->ajaxJS['EVAL'])) {
165			return $this->ajaxJS['EVAL'] = $obj;
166			}
167			return $this->ajaxJS['EVAL'] .= ';' . $obj;
168			}
169
170			if (isset($this->ajaxJS[$varName])) {
171			throw new Exception('Trying to set javascript val twice: ' . $varName);
172			}
173			$json = json_encode($obj);
174			if ($json === false) {
175			throw new Exception('Failed to encode to json: ' . $varName);
176			}
177			return $this->ajaxJS[$varName] = $json;
178			}
179
180			protected function addJavascriptAlert(string $string): void {
181			$session = Session::getInstance();
182			if (!$session->addAjaxReturns('ALERT:' . $string, $string)) {
183			$this->jsAlerts[] = $string;
184			}
185			}
186
187			/**
188			* Registers a JS target for inclusion at the end of the HTML body.
189			*/
190			protected function addJavascriptSource(string $src): void {
191			$this->jsSources[] = $src;
192			}
193
194			protected function convertHtmlToAjaxXml(string $str, bool $returnXml): string {
195			if (empty($str)) {
196			return '';
197			}
198
199			$session = Session::getInstance();
200
201			$getInnerHTML = function(DOMNode $node): string {
202			$innerHTML = '';
203			foreach ($node->childNodes as $child) {
204			$innerHTML .= $child->ownerDocument->saveHTML($child);
205			}
206			return $innerHTML;
207			};
208
209			// Helper function to canonicalize making an XML element,
210			// with its inner content properly escaped.
211			$xmlify = function(string $id, string $str): string {
212			return '<' . $id . '>' . htmlspecialchars($str, ENT_XML1, 'utf-8') . '</' . $id . '>';
213			};
214
215			$xml = '';
216			$dom = new DOMDocument();
217			$dom->loadHTML($str);
218			$xpath = new DOMXPath($dom);
219
220			// Use relative xpath selectors so that they can be reused when we
221			// pass the middle panel as the xpath query's context node.
222			$ajaxSelectors = ['.//span[@id]', './/*[contains(@class,"ajax")]'];
223
224			foreach ($ajaxSelectors as $selector) {
225			$matchNodes = $xpath->query($selector);
226			if ($matchNodes === false) {
227			throw new Exception('XPath query failed for selector: ' . $selector);
228			}
229			foreach ($matchNodes as $node) {
230			if (!($node instanceof DOMElement)) {
231			throw new Exception('XPath query returned unexpected DOMNode type: ' . $node->nodeType);
232			}
233			$id = $node->getAttribute('id');
234			$inner = $getInnerHTML($node);
235			if (!$session->addAjaxReturns($id, $inner) && $returnXml) {
236			$xml .= $xmlify($id, $inner);
237			}
238			}
239			}
240
241			// Determine if we should do ajax updates on the middle panel div
242			$mid = $dom->getElementById('middle_panel');
243			$doAjaxMiddle = true;
244			if ($mid === null) {
245			// Skip if there is no middle_panel.
246			$doAjaxMiddle = false;
247			} else {
248			// Skip if middle_panel has ajax-enabled children.
249			foreach ($ajaxSelectors as $selector) {
250			$matchNodes = $xpath->query($selector, $mid);
251			if ($matchNodes === false) {
252			throw new Exception('XPath query failed for selector: ' . $selector);
253			}
254			if (count($matchNodes) > 0) {
255			$doAjaxMiddle = false;
256			break;
257			}
258			}
259			}
260
261			if ($doAjaxMiddle) {
262			$inner = $getInnerHTML($mid);
263			if (!$this->checkDisableAJAX($inner)) {
264			$id = $mid->getAttribute('id');
265			if (!$session->addAjaxReturns($id, $inner) && $returnXml) {
266			$xml .= $xmlify($id, $inner);
267			}
268			}
269			}
270
271			$js = '';
272			foreach ($this->ajaxJS as $varName => $JSON) {
273			if (!$session->addAjaxReturns('JS:' . $varName, $JSON) && $returnXml) {
274			$js .= $xmlify($varName, $JSON);
275			}
276			}
277			if ($returnXml && count($this->jsAlerts) > 0) {
278			$js = '<ALERT>' . json_encode($this->jsAlerts) . '</ALERT>';
279			}
280			if (strlen($js) > 0) {
281			$xml .= '<JS>' . $js . '</JS>';
282			}
283			return $xml;
284			}
285
286			}
287

smrealms / smr

Scrutinizer GitHub App not installed

Push — main ( 10f5c7...a0aba6 )

Template::convertHtmlToAjaxXml() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like