cfg_handler::decode_source_html() - Code Metrics - Inspection of "Use more descriptive icons for edit mode" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 60a459...efce96 )

by Daniel

created 2016-09-17 12:37 UTC

cfg_handler::decode_source_html() A

↳ Parent: cfg_handler

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.1481

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	4
cts	6
cp	0.6667
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1
crap	2.1481

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2015 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\services\blocks;

class cfg_handler extends cfg_fields
{
	/** @var \phpbb\request\request_interface */
	protected $request;

	/** @var \phpbb\template\template */
	protected $template;

	/** @var \phpbb\user */
	protected $user;

	/** @var \blitze\sitemaker\services\groups */
	protected $groups;

	/** @var string phpBB root path */
	protected $phpbb_root_path;

	/** @var string phpEx */
	protected $php_ext;

	/**
	 * Constructor
	 *
	 * @param \phpbb\request\request_interface		$request				Request object
	 * @param \phpbb\template\template				$template				Template object
	 * @param \phpbb\user							$user					User object
	 * @param \blitze\sitemaker\services\groups		$groups					Groups object
	 * @param string								$phpbb_root_path		phpBB root path
	 * @param string								$php_ext				phpEx
	 */
	public function __construct(\phpbb\request\request_interface $request, \phpbb\template\template $template, \phpbb\user $user, \blitze\sitemaker\services\groups $groups, $phpbb_root_path, $php_ext)
	{
		parent::__construct($user);

		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->groups = $groups;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * @param array $block_data
	 * @param array $default_settings
	 * @return string
	 */
	public function get_edit_form(array $block_data, array $default_settings)
	{
		global $module;

		if (!function_exists('build_cfg_template'))
		{
			include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext); // @codeCoverageIgnore
		}

		// We fake this class as it is needed by the build_cfg_template function
		$module = new \stdClass();
		$module->module = $this;

		$this->generate_config_fields($block_data['settings'], $default_settings);

		return $this->get_form($block_data);
	}

	/**
	 * @param array $default_settings
	 * @return array|void
	 */
	public function get_submitted_settings(array $default_settings)
	{
		// @codeCoverageIgnoreStart
		if (!function_exists('validate_config_vars'))
		{
			include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
		}
		// @codeCoverageIgnoreEnd

		$cfg_array = utf8_normalize_nfc($this->request->variable('config', array('' => ''), true));
		$cfg_array = $this->decode_source_html($cfg_array);

		$errors = array();
		validate_config_vars($default_settings, $cfg_array, $errors);

		if (sizeof($errors))
		{
			return array('errors' => join("\n", $errors));
		}

		$this->get_multi_select($cfg_array, $default_settings);

		return array_intersect_key($cfg_array, $default_settings);
	}

	/**
	 * As a workaround to prevent mod_security and similar from preventing us
	 * from posting html/script, we use encodeURI before submitting data.
	 * This decodes the data before submitting to the database
	 *
	 * @param array $cfg_array
	 * @return array
	 */
	private function decode_source_html(array $cfg_array)
	{
		if (isset($cfg_array['source']))
		{
			$cfg_array['source'] = urldecode($cfg_array['source']);
		}

		return $cfg_array;
	}

	/**
	 * Get the html form
	 *
	 * @param array $block_data
	 * @return string
	 */
	private function get_form(array $block_data)
	{
		$selected_groups = $this->ensure_array($block_data['permission']);

		$this->template->assign_vars(array(
			'S_ACTIVE'		=> $block_data['status'],
			'S_TYPE'		=> $block_data['type'],
			'S_NO_WRAP'		=> $block_data['no_wrap'],
			'S_HIDE_TITLE'	=> $block_data['hide_title'],
			'S_BLOCK_CLASS'	=> trim($block_data['class']),
			'S_GROUP_OPS'	=> $this->groups->get_options('all', $selected_groups),
		));

		$this->template->set_filenames(array(
			'block_settings' => 'block_settings.html',
		));

		return $this->template->assign_display('block_settings');
	}

	/**
	 * Generate block configuration fields
	 *
	 * @param array $db_settings
	 * @param array $default_settings
	 */
	private function generate_config_fields(array &$db_settings, array $default_settings)
	{
		foreach ($default_settings as $field => $vars)
		{
			if ($this->set_legend($field, $vars) || !is_array($vars))
			{
				continue;
			}

			$db_settings[$field] = $this->get_field_value($field, $vars['default'], $db_settings);
			$content = $this->get_field_template($field, $db_settings, $vars);

			$this->template->assign_block_vars('options', array(
				'KEY'			=> $field,
				'TITLE'			=> $this->user->lang($vars['lang']),
				'S_EXPLAIN'		=> $vars['explain'],
				'TITLE_EXPLAIN'	=> $vars['lang_explain'],
				'CONTENT'		=> $content,
			));
			unset($default_settings[$field]);
		}
	}

	/**
	 * Get the field html
	 *
	 * @param string $field
	 * @param array $db_settings
	 * @param array $vars
	 * @return string
	 */
	private function get_field_template($field, array &$db_settings, array &$vars)
	{
		$vars['lang_explain'] = $this->explain_field($vars);
		$vars['append'] = $this->append_field($vars);

		$type = explode(':', $vars['type']);
		$method = 'prep_' . $type[0] . '_field_for_display';

		if (is_callable(array($this, $method)))
		{
			$this->set_params($field, $vars, $db_settings);
			$this->$method($vars, $type, $field, $db_settings);
		}

		return build_cfg_template($type, $field, $db_settings, $field, $vars);
	}

	/**
	 * Set field legend
	 *
	 * @param string $field
	 * @param string|array $vars
	 * @return boolean
	 */
	private function set_legend($field, $vars)
	{
		if (strpos($field, 'legend') !== false)
		{
			$this->template->assign_block_vars('options', array(
				'S_LEGEND'	=> $field,
				'LEGEND'	=> $this->user->lang($vars)
			));

			return true;
		}

		return false;
	}

	/**
	 * Get field details
	 *
	 * @param array $vars
	 * @return mixed|string
	 */
	private function explain_field(array $vars)
	{
		$l_explain = '';
		if (!empty($vars['explain']))
		{
			$l_explain = (isset($vars['lang_explain'])) ? $this->user->lang($vars['lang_explain']) : $this->user->lang($vars['lang'] . '_EXPLAIN');
		}

		return $l_explain;
	}

	/**
	 * Add text after field
	 *
	 * @param array $vars
	 * @return mixed|string
	 */
	private function append_field(array $vars)
	{
		$append = '';
		if (!empty($vars['append']))
		{
			$append = $this->user->lang($vars['append']);
		}

		return $append;
	}

	/**
	 * Set field parameters
	 *
	 * @param string $field
	 * @param array $vars
	 * @param array $settings
	 */
	private function set_params($field, array &$vars, array $settings)
	{
		if (isset($vars['options']))
		{
			$vars['params'][] = $vars['options'];
			$vars['params'][] = $settings[$field];
		}
	}

	/**
	 * Get field value
	 *
	 * @param string $field
	 * @param mixed $default
	 * @param array $db_settings
	 * @return mixed
	 */
	private function get_field_value($field, $default, array $db_settings)
	{
		return (isset($db_settings[$field])) ? $db_settings[$field] : $default;
	}

	/**
	 * @param array $vars
	 */
	private function prep_select_field_for_display(array &$vars)
	{
		$this->add_lang_vars($vars['params'][0]);

		$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : 'build_select';
	}

	/**
	 * @param array $vars
	 * @param array $type
	 * @param string $field
	 */
	private function prep_checkbox_field_for_display(array &$vars, array &$type, $field)
	{
		$this->add_lang_vars($vars['params'][0]);

		$vars['method'] = 'build_checkbox';
		$vars['params'][] = $field;
		$type[0] = 'custom';
	}

	/**
	 * @param array $vars
	 * @param array $type
	 * @param string $field
	 */
	private function prep_radio_field_for_display(array &$vars, array &$type, $field)
	{
		if (!isset($type[1]))
		{
			$this->add_lang_vars($vars['params'][0]);

			$vars['method'] = 'build_radio';
			$vars['params'][] = $field;
			$type[0] = 'custom';
		}
	}

	/**
	 * @param array $vars
	 * @param array $type
	 * @param string $field
	 */
	private function prep_multi_select_field_for_display(array &$vars, array &$type, $field)
	{
		$this->prep_checkbox_field_for_display($vars, $type, $field);

		$vars['method'] ='build_multi_select';
	}

	/**
	 * @param array $vars
	 * @param array $type
	 */
	private function prep_hidden_field_for_display(array &$vars, array &$type)
	{
		$vars['method'] = 'build_hidden';
		$vars['explain'] = '';
		$vars['lang'] = '';
		$type[0] = 'custom';
	}

	/**
	 * @param array $vars
	 * @param array $type
	 */
	private function prep_custom_field_for_display(array &$vars, array &$type)
	{
		$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : '';
		$type[0] = 'custom';
	}

	/**
	 * this looks bad but its the only way without modifying phpbb code
	 * this is for select items that do not need to be translated
	 * @param array $options
	 */
	private function add_lang_vars(array $options)
	{
		foreach ($options as $title)
		{
			if (!isset($this->user->lang[$title]))
			{
				$this->user->lang[$title] = $title;
			}
		}
	}

	/**
	 * @param array $cfg_array
	 * @param array $df_settings
	 */
	private function get_multi_select(array &$cfg_array, array $df_settings)
	{
		$multi_select = utf8_normalize_nfc($this->request->variable('config', array('' => array('' => '')), true));
		$multi_select = array_filter($multi_select);

		foreach ($multi_select as $field => $settings)
		{
			$cfg_array[$field] = (!empty($settings)) ? $settings : $df_settings[$field]['default'];
		}
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2015 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\sitemaker\services\blocks;
11
12		class cfg_handler extends cfg_fields
13		{
14		/** @var \phpbb\request\request_interface */
15		protected $request;
16
17		/** @var \phpbb\template\template */
18		protected $template;
19
20		/** @var \phpbb\user */
21		protected $user;
22
23		/** @var \blitze\sitemaker\services\groups */
24		protected $groups;
25
26		/** @var string phpBB root path */
27		protected $phpbb_root_path;
28
29		/** @var string phpEx */
30		protected $php_ext;
31
32		/**
33		* Constructor
34		*
35		* @param \phpbb\request\request_interface $request Request object
36		* @param \phpbb\template\template $template Template object
37		* @param \phpbb\user $user User object
38		* @param \blitze\sitemaker\services\groups $groups Groups object
39		* @param string $phpbb_root_path phpBB root path
40		* @param string $php_ext phpEx
41		*/
42	51	public function __construct(\phpbb\request\request_interface $request, \phpbb\template\template $template, \phpbb\user $user, \blitze\sitemaker\services\groups $groups, $phpbb_root_path, $php_ext)
43		{
44	51	parent::__construct($user);
45
46	51	$this->request = $request;
47	51	$this->template = $template;
48	51	$this->user = $user;
49	51	$this->groups = $groups;
50	51	$this->phpbb_root_path = $phpbb_root_path;
51	51	$this->php_ext = $php_ext;
52	51	}
53
54		/**
55		* @param array $block_data
56		* @param array $default_settings
57		* @return string
58		*/
59	8	public function get_edit_form(array $block_data, array $default_settings)
60		{
61	8	global $module;
62
63	8	if (!function_exists('build_cfg_template'))
64	8	{
65		include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext); // @codeCoverageIgnore
66	1	}
67
68		// We fake this class as it is needed by the build_cfg_template function
69	8	$module = new \stdClass();
70	8	$module->module = $this;
71
72	8	$this->generate_config_fields($block_data['settings'], $default_settings);
73
74	8	return $this->get_form($block_data);
75		}
76
77		/**
78		* @param array $default_settings
79		* @return array\|void
80		*/
81	6	public function get_submitted_settings(array $default_settings)
82		{
83		// @codeCoverageIgnoreStart
84		if (!function_exists('validate_config_vars'))
85		{
86		include($this->phpbb_root_path . 'includes/functions_acp.' . $this->php_ext);
87		}
88		// @codeCoverageIgnoreEnd
89
90	6	$cfg_array = utf8_normalize_nfc($this->request->variable('config', array('' => ''), true));
91	6	$cfg_array = $this->decode_source_html($cfg_array);
92
93	6	$errors = array();
94	6	validate_config_vars($default_settings, $cfg_array, $errors);
95
96	6	if (sizeof($errors))
97	6	{
98	1	return array('errors' => join("\n", $errors));
99		}
100
101	5	$this->get_multi_select($cfg_array, $default_settings);
102
103	5	return array_intersect_key($cfg_array, $default_settings);
104		}
105
106		/**
107		* As a workaround to prevent mod_security and similar from preventing us
108		* from posting html/script, we use encodeURI before submitting data.
109		* This decodes the data before submitting to the database
110		*
111		* @param array $cfg_array
112		* @return array
113		*/
114	6	private function decode_source_html(array $cfg_array)
115		{
116	6	if (isset($cfg_array['source']))
117	6	{
118		$cfg_array['source'] = urldecode($cfg_array['source']);
119		}
120
121	6	return $cfg_array;
122		}
123
124		/**
125		* Get the html form
126		*
127		* @param array $block_data
128		* @return string
129		*/
130	8	private function get_form(array $block_data)
131		{
132	8	$selected_groups = $this->ensure_array($block_data['permission']);
133
134	8	$this->template->assign_vars(array(
135	8	'S_ACTIVE' => $block_data['status'],
136	8	'S_TYPE' => $block_data['type'],
137	8	'S_NO_WRAP' => $block_data['no_wrap'],
138	8	'S_HIDE_TITLE' => $block_data['hide_title'],
139	8	'S_BLOCK_CLASS' => trim($block_data['class']),
140	8	'S_GROUP_OPS' => $this->groups->get_options('all', $selected_groups),
141	8	));
142
143	8	$this->template->set_filenames(array(
144	8	'block_settings' => 'block_settings.html',
145	8	));
146
147	8	return $this->template->assign_display('block_settings');
148		}
149
150		/**
151		* Generate block configuration fields
152		*
153		* @param array $db_settings
154		* @param array $default_settings
155		*/
156	8	private function generate_config_fields(array &$db_settings, array $default_settings)
157		{
158	8	foreach ($default_settings as $field => $vars)
159		{
160	7	if ($this->set_legend($field, $vars) \|\| !is_array($vars))
161	7	{
162	7	continue;
163		}
164
165	7	$db_settings[$field] = $this->get_field_value($field, $vars['default'], $db_settings);
166	7	$content = $this->get_field_template($field, $db_settings, $vars);
167
168	7	$this->template->assign_block_vars('options', array(
169	7	'KEY' => $field,
170	7	'TITLE' => $this->user->lang($vars['lang']),
171	7	'S_EXPLAIN' => $vars['explain'],
172	7	'TITLE_EXPLAIN' => $vars['lang_explain'],
173	7	'CONTENT' => $content,
174	7	));
175	7	unset($default_settings[$field]);
176	8	}
177	8	}
178
179		/**
180		* Get the field html
181		*
182		* @param string $field
183		* @param array $db_settings
184		* @param array $vars
185		* @return string
186		*/
187	7	private function get_field_template($field, array &$db_settings, array &$vars)
188		{
189	7	$vars['lang_explain'] = $this->explain_field($vars);
190	7	$vars['append'] = $this->append_field($vars);
191
192	7	$type = explode(':', $vars['type']);
193	7	$method = 'prep_' . $type[0] . '_field_for_display';
194
195	7	if (is_callable(array($this, $method)))
196	7	{
197	7	$this->set_params($field, $vars, $db_settings);
198	7	$this->$method($vars, $type, $field, $db_settings);
199	7	}
200
201	7	return build_cfg_template($type, $field, $db_settings, $field, $vars);
202		}
203
204		/**
205		* Set field legend
206		*
207		* @param string $field
208		* @param string\|array $vars
209		* @return boolean
210		*/
211	7	private function set_legend($field, $vars)
212		{
213	7	if (strpos($field, 'legend') !== false)
214	7	{
215	7	$this->template->assign_block_vars('options', array(
216	7	'S_LEGEND' => $field,
217	7	'LEGEND' => $this->user->lang($vars)
218	7	));
219
220	7	return true;
221		}
222
223	7	return false;
224		}
225
226		/**
227		* Get field details
228		*
229		* @param array $vars
230		* @return mixed\|string
231		*/
232	7	private function explain_field(array $vars)
233		{
234	7	$l_explain = '';
235	7	if (!empty($vars['explain']))
236	7	{
237	2	$l_explain = (isset($vars['lang_explain'])) ? $this->user->lang($vars['lang_explain']) : $this->user->lang($vars['lang'] . '_EXPLAIN');
238	2	}
239
240	7	return $l_explain;
241		}
242
243		/**
244		* Add text after field
245		*
246		* @param array $vars
247		* @return mixed\|string
248		*/
249	7	private function append_field(array $vars)
250		{
251	7	$append = '';
252	7	if (!empty($vars['append']))
253	7	{
254	1	$append = $this->user->lang($vars['append']);
255	1	}
256
257	7	return $append;
258		}
259
260		/**
261		* Set field parameters
262		*
263		* @param string $field
264		* @param array $vars
265		* @param array $settings
266		*/
267	7	private function set_params($field, array &$vars, array $settings)
268		{
269	7	if (isset($vars['options']))
270	7	{
271	4	$vars['params'][] = $vars['options'];
272	4	$vars['params'][] = $settings[$field];
273	4	}
274	7	}
275
276		/**
277		* Get field value
278		*
279		* @param string $field
280		* @param mixed $default
281		* @param array $db_settings
282		* @return mixed
283		*/
284	7	private function get_field_value($field, $default, array $db_settings)
285		{
286	7	return (isset($db_settings[$field])) ? $db_settings[$field] : $default;
287		}
288
289		/**
290		* @param array $vars
291		*/
292	1	private function prep_select_field_for_display(array &$vars)
293		{
294	1	$this->add_lang_vars($vars['params'][0]);
295
296	1	$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : 'build_select';
297	1	}
298
299		/**
300		* @param array $vars
301		* @param array $type
302		* @param string $field
303		*/
304	2	private function prep_checkbox_field_for_display(array &$vars, array &$type, $field)
305		{
306	2	$this->add_lang_vars($vars['params'][0]);
307
308	2	$vars['method'] = 'build_checkbox';
309	2	$vars['params'][] = $field;
310	2	$type[0] = 'custom';
311	2	}
312
313		/**
314		* @param array $vars
315		* @param array $type
316		* @param string $field
317		*/
318	2	private function prep_radio_field_for_display(array &$vars, array &$type, $field)
319	1	{
320	2	if (!isset($type[1]))
321	2	{
322	1	$this->add_lang_vars($vars['params'][0]);
323
324	1	$vars['method'] = 'build_radio';
325	1	$vars['params'][] = $field;
326	1	$type[0] = 'custom';
327	1	}
328	2	}
329
330		/**
331		* @param array $vars
332		* @param array $type
333		* @param string $field
334		*/
335	1	private function prep_multi_select_field_for_display(array &$vars, array &$type, $field)
336		{
337	1	$this->prep_checkbox_field_for_display($vars, $type, $field);
338
339	1	$vars['method'] ='build_multi_select';
340	1	}
341
342		/**
343		* @param array $vars
344		* @param array $type
345		*/
346	1	private function prep_hidden_field_for_display(array &$vars, array &$type)
347		{
348	1	$vars['method'] = 'build_hidden';
349	1	$vars['explain'] = '';
350	1	$vars['lang'] = '';
351	1	$type[0] = 'custom';
352	1	}
353
354		/**
355		* @param array $vars
356		* @param array $type
357		*/
358	1	private function prep_custom_field_for_display(array &$vars, array &$type)
359		{
360	1	$vars['function'] = (!empty($vars['function'])) ? $vars['function'] : '';
361	1	$type[0] = 'custom';
362	1	}
363
364		/**
365		* this looks bad but its the only way without modifying phpbb code
366		* this is for select items that do not need to be translated
367		* @param array $options
368		*/
369	4	private function add_lang_vars(array $options)
370		{
371	4	foreach ($options as $title)
372		{
373	4	if (!isset($this->user->lang[$title]))
374	4	{
375	4	$this->user->lang[$title] = $title;
376	4	}
377	4	}
378	4	}
379
380		/**
381		* @param array $cfg_array
382		* @param array $df_settings
383		*/
384	5	private function get_multi_select(array &$cfg_array, array $df_settings)
385		{
386	5	$multi_select = utf8_normalize_nfc($this->request->variable('config', array('' => array('' => '')), true));
387	5	$multi_select = array_filter($multi_select);
388
389	5	foreach ($multi_select as $field => $settings)
390		{
391	1	$cfg_array[$field] = (!empty($settings)) ? $settings : $df_settings[$field]['default'];
392	5	}
393	5	}
394		}
395

blitze / phpBB-ext-sitemaker

Push — master ( 60a459...efce96 )

cfg_handler::decode_source_html() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like