tfa_module::create_page() - Code Metrics - Inspection of "Validation" - paul999/phpbb_2fa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#27)

by Paul

created 2020-09-14 09:27 UTC

tfa_module::create_page() B

↳ Parent: tfa_module

Complexity

Conditions	9
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	69
rs	7.1208
c	0
b	0
f	0
cc	9
nc	16
nop	0

How to fix Long Method

<?php
/**
 *
 * 2FA extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015 Paul Sohier
 * @license       GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace paul999\tfa\ucp;

use paul999\tfa\helper\session_helper;
use phpbb\request\request_interface;
use phpbb\template\template;
use phpbb\user;

class tfa_module
{
	/**
	 * @var string
	 */
	public $u_action;

	/**
	 * @var  string
	 */
	public $page_title;

	/**
	 * @var string
	 */
	public $tpl_name;

	/**
	 * @var user
	 */
	private $user;

	/**
	 * @var template
	 */
	private $template;

	/**
	 * @var request_interface
	 */
	private $request;

	/**
	 * @var session_helper
	 */
	private $session_helper;

	/**
	 * @param user              $user
	 * @param template          $template
	 * @param request_interface $request
	 * @param session_helper    $session_helper
	 */
	private function setup(user $user, template $template, request_interface $request, session_helper $session_helper)
	{
		$this->user = $user;
		$this->template = $template;
		$this->request = $request;
		$this->session_helper = $session_helper;
	}

	/**
	 * @param $id
	 * @param $mode
	 */
	public function main($id, $mode)

	{
		global $user, $template;
		global $request, $phpbb_container;

		$user->add_lang('posting');
		$user->add_lang_ext('paul999/tfa', array('common', 'ucp_tfa'));

		$this->setup($user, $template, $request, $phpbb_container->get('paul999.tfa.session_helper'));

		$this->create_page();
	}

	/**
	 * return array
	 */
	private function register_security_key()
	{
		try
		{
			$error = array();
			$class = $this->request->variable('class', '');
			$module = $this->session_helper->find_module($class);
			$submit = $this->request->variable('register', false, false, request_interface::POST);

			if ($module != null)
			{
				if ($submit)
				{
					$module->register();
					meta_refresh(3, $this->u_action);
					$message = $this->user->lang('TFA_KEY_ADDED') . '<br /><br />' . $this->user->lang('RETURN_UCP', '<a href="' . $this->u_action . '">', '</a>');
					trigger_error($message);
				}
				if ($module->can_register())
				{
					$this->template->assign_vars(array(
						'S_HIDDEN_FIELDS' => build_hidden_fields(array('class' => $class)),
						'S_UCP_ACTION'    => $this->u_action,
					));
					$this->tpl_name = $module->register_start();
				}
				else
				{
					$error[] = 'TFA_MODULE_NO_REGISTER';
				}
			}
			else
			{
				$error[] = $this->user->lang('TFA_MODULE_NOT_FOUND', $class);
			}
		}
		catch (\Exception $e)
		{
			$error[] = $e->getMessage();
		}

		return $error;
	}

	/**
	 *
	 */
	private function create_page()
	{
		$error = array();
		$s_hidden_fields = '';

		add_form_key('ucp_tfa_keys');

		$module_row = $this->request->variable('md', '', true, request_interface::POST);

		// Set desired template
		$this->tpl_name = 'ucp_tfa';
		$this->page_title = 'UCP_TFA';

		if (!empty($module_row))
		{
			switch ($module_row)
			{
				case $this->user->lang('DELETE_MARKED'):
					if (!check_form_key('ucp_tfa_keys'))
					{
						$error[] = 'FORM_INVALID';
					}
					else
					{
							$this->delete_keys();
					}
					break;

				case $this->user->lang('TFA_NEW'):
					$error = array_merge($this->register_security_key(), $error);

					if (!sizeof($error))
					{
						return; // register_security_key has its own template stuff, so we return here.
					}
					break;

			}
		}

		// Replace "error" strings with their real, localised form
		$error = array_map(array(
			$this->user,
			'lang',
		), $error);

		/**
		 * @var $module_row \paul999\tfa\modules\module_interface
		 */
		foreach ($this->session_helper->get_modules() as $module_row)
		{
			$module_row->show_ucp();

			if ($module_row->can_register())
			{
				$this->template->assign_block_vars('new_keys', array(
					'CLASS' => $module_row->get_name(),
					'NAME'	=> $this->user->lang($module_row->get_translatable_name()),
				));
			}
		}

		$this->template->assign_vars(array(
			'ERROR'           => (sizeof($error)) ? implode('<br />', $error) : '',
			'L_TITLE'         => $this->user->lang('UCP_TFA'),
			'S_HIDDEN_FIELDS' => $s_hidden_fields,
			'S_UCP_ACTION'    => $this->u_action,
		));
	}

	/**
	 *
	 */
	private function delete_keys()
	{
		$keys = $this->request->variable('keys', array(''));
		if (!empty($keys))
		{
			foreach ($keys as $row)
			{
				$row = explode('-', $row); // 0 is class, 1 is ID
				if (isset($row[0]))
				{
					$module = $this->session_helper->find_module($row[0]);
					if ($module != null)
					{
						$module->delete(intval($row[1]));
					}
				}
			}
		}
		meta_refresh(3, $this->u_action);
		$message = $this->user->lang('TFA_KEYS_DELETED') . '<br /><br />' . $this->user->lang('RETURN_UCP', '<a href="' . $this->u_action . '">', '</a>');
		trigger_error($message);
	}
}


1			<?php
2			/**
3			*
4			* 2FA extension for the phpBB Forum Software package.
5			*
6			* @copyright (c) 2015 Paul Sohier
7			* @license GNU General Public License, version 2 (GPL-2.0)
8			*
9			*/
10
11			namespace paul999\tfa\ucp;
12
13			use paul999\tfa\helper\session_helper;
14			use phpbb\request\request_interface;
15			use phpbb\template\template;
16			use phpbb\user;
17
18			class tfa_module
19			{
20			/**
21			* @var string
22			*/
23			public $u_action;
24
25			/**
26			* @var string
27			*/
28			public $page_title;
29
30			/**
31			* @var string
32			*/
33			public $tpl_name;
34
35			/**
36			* @var user
37			*/
38			private $user;
39
40			/**
41			* @var template
42			*/
43			private $template;
44
45			/**
46			* @var request_interface
47			*/
48			private $request;
49
50			/**
51			* @var session_helper
52			*/
53			private $session_helper;
54
55			/**
56			* @param user $user
57			* @param template $template
58			* @param request_interface $request
59			* @param session_helper $session_helper
60			*/
61			private function setup(user $user, template $template, request_interface $request, session_helper $session_helper)
62			{
63			$this->user = $user;
64			$this->template = $template;
65			$this->request = $request;
66			$this->session_helper = $session_helper;
67			}
68
69			/**
70			* @param $id
71			* @param $mode
72			*/
73			public function main($id, $mode)
			0 ignored issues – show Unused Code introduced 2018-03-24 13:08 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-03-24 13:08 UTC by Report Bug Copy Issue Report The parameter `$mode` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
74			{
75			global $user, $template;
76			global $request, $phpbb_container;
77
78			$user->add_lang('posting');
79			$user->add_lang_ext('paul999/tfa', array('common', 'ucp_tfa'));
80
81			$this->setup($user, $template, $request, $phpbb_container->get('paul999.tfa.session_helper'));
82
83			$this->create_page();
84			}
85
86			/**
87			* return array
88			*/
89			private function register_security_key()
90			{
91			try
92			{
93			$error = array();
94			$class = $this->request->variable('class', '');
95			$module = $this->session_helper->find_module($class);
96			$submit = $this->request->variable('register', false, false, request_interface::POST);
97
98			if ($module != null)
99			{
100			if ($submit)
101			{
102			$module->register();
103			meta_refresh(3, $this->u_action);
104			$message = $this->user->lang('TFA_KEY_ADDED') . '<br /><br />' . $this->user->lang('RETURN_UCP', '<a href="' . $this->u_action . '">', '</a>');
105			trigger_error($message);
106			}
107			if ($module->can_register())
108			{
109			$this->template->assign_vars(array(
110			'S_HIDDEN_FIELDS' => build_hidden_fields(array('class' => $class)),
111			'S_UCP_ACTION' => $this->u_action,
112			));
113			$this->tpl_name = $module->register_start();
114			}
115			else
116			{
117			$error[] = 'TFA_MODULE_NO_REGISTER';
118			}
119			}
120			else
121			{
122			$error[] = $this->user->lang('TFA_MODULE_NOT_FOUND', $class);
123			}
124			}
125			catch (\Exception $e)
126			{
127			$error[] = $e->getMessage();
128			}
129
130			return $error;
131			}
132
133			/**
134			*
135			*/
136			private function create_page()
137			{
138			$error = array();
139			$s_hidden_fields = '';
140
141			add_form_key('ucp_tfa_keys');
142
143			$module_row = $this->request->variable('md', '', true, request_interface::POST);
144
145			// Set desired template
146			$this->tpl_name = 'ucp_tfa';
147			$this->page_title = 'UCP_TFA';
148
149			if (!empty($module_row))
150			{
151			switch ($module_row)
152			{
153			case $this->user->lang('DELETE_MARKED'):
154			if (!check_form_key('ucp_tfa_keys'))
155			{
156			$error[] = 'FORM_INVALID';
157			}
158			else
159			{
160			$this->delete_keys();
161			}
162			break;
163
164			case $this->user->lang('TFA_NEW'):
165			$error = array_merge($this->register_security_key(), $error);
166
167			if (!sizeof($error))
168			{
169			return; // register_security_key has its own template stuff, so we return here.
170			}
171			break;
172
173			}
174			}
175
176			// Replace "error" strings with their real, localised form
177			$error = array_map(array(
178			$this->user,
179			'lang',
180			), $error);
181
182			/**
183			* @var $module_row \paul999\tfa\modules\module_interface
184			*/
185			foreach ($this->session_helper->get_modules() as $module_row)
186			{
187			$module_row->show_ucp();
188
189			if ($module_row->can_register())
190			{
191			$this->template->assign_block_vars('new_keys', array(
192			'CLASS' => $module_row->get_name(),
193			'NAME' => $this->user->lang($module_row->get_translatable_name()),
194			));
195			}
196			}
197
198			$this->template->assign_vars(array(
199			'ERROR' => (sizeof($error)) ? implode('<br />', $error) : '',
200			'L_TITLE' => $this->user->lang('UCP_TFA'),
201			'S_HIDDEN_FIELDS' => $s_hidden_fields,
202			'S_UCP_ACTION' => $this->u_action,
203			));
204			}
205
206			/**
207			*
208			*/
209			private function delete_keys()
210			{
211			$keys = $this->request->variable('keys', array(''));
212			if (!empty($keys))
213			{
214			foreach ($keys as $row)
215			{
216			$row = explode('-', $row); // 0 is class, 1 is ID
217			if (isset($row[0]))
218			{
219			$module = $this->session_helper->find_module($row[0]);
220			if ($module != null)
221			{
222			$module->delete(intval($row[1]));
223			}
224			}
225			}
226			}
227			meta_refresh(3, $this->u_action);
228			$message = $this->user->lang('TFA_KEYS_DELETED') . '<br /><br />' . $this->user->lang('RETURN_UCP', '<a href="' . $this->u_action . '">', '</a>');
229			trigger_error($message);
230			}
231			}
232

paul999 / phpbb_2fa

Pull Request — master (#27)

tfa_module::create_page() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like