main_controller::__construct() - Code Metrics - Inspection of "Fix a few language related issues." - paul999/phpbb_2fa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Paul

created 2019-09-05 16:48 UTC

main_controller::__construct() A

↳ Parent: main_controller

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
cc	1
nc	1
nop	10

How to fix Many Parameters

<?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\controller;

use paul999\tfa\helper\session_helper_interface;
use phpbb\config\config;
use phpbb\controller\helper;
use phpbb\db\driver\driver_interface;
use phpbb\exception\http_exception;
use phpbb\request\request_interface;
use phpbb\template\template;
use phpbb\user;
use phpbb\log\log;

/**
 * Controller
 */
class main_controller
{
	/**
	 * @var helper
	 */
	private $controller_helper;

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

	/**
	 * @var driver_interface
	 */
	private $db;

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

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

	/**
	 * @var config
	 */
	private $config;

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

	/**
	 * @var string
	 */
	private $root_path;

	/**
	 * @var string
	 */
	private $php_ext;
    /**
     * @var phpbb\log\log
     */
    private $log;

    /**
     * Constructor
     *
     * @access public
     * @param helper $controller_helper
     * @param driver_interface $db
     * @param template $template
     * @param user $user
     * @param request_interface $request
     * @param config $config
     * @param log $log
     * @param session_helper_interface $session_helper
     * @param string $root_path
     * @param string $php_ext
     */
	public function __construct(helper $controller_helper, driver_interface $db, template $template, user $user, request_interface $request, config $config, log $log, session_helper_interface $session_helper, $root_path, $php_ext)
	{
		$this->controller_helper 	= $controller_helper;
		$this->template 			= $template;
		$this->db					= $db;
		$this->user					= $user;
		$this->request				= $request;
		$this->config				= $config;
		$this->session_helper		= $session_helper;
		$this->root_path			= $root_path;
		$this->php_ext				= $php_ext;
        $this->log                  = $log;

    }

	/**
	 * @param int  $user_id
	 * @param bool $admin
	 * @param bool $auto_login
	 * @param bool $viewonline
	 * @param string $class
	 * @return \Symfony\Component\HttpFoundation\Response
	 * @throws http_exception
	 */
	public function submit($user_id, $admin, $auto_login, $viewonline, $class)
	{
		$this->user->add_lang_ext('paul999/tfa', 'common');

		if (!check_form_key('tfa_login_page'))
		{
			throw new http_exception(403, 'FORM_INVALID');
		}

		if (empty($this->user->data['tfa_random']) || $user_id != $this->user->data['tfa_uid'])
		{
			throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
		}
		$random = $this->request->variable('random', '');

		if ($this->user->data['tfa_random'] !== $random || strlen($random) !== 40)
		{
			throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
		}
		$sql_ary = array(
			'tfa_random' => '',
			'tfa_uid'    => 0,
		);
		$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . "
			WHERE
				session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "' AND
				session_user_id = " . (int) $this->user->data['user_id'];
		$this->db->sql_query($sql);

		if (empty($class))
		{
			throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
		}

		$module = $this->session_helper->findModule($class);

		if ($module == null)
		{
			throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
		}

		$redirect = $this->request->variable('redirect', "{$this->root_path}/index.{$this->php_ext}");
		try
		{
			if (!$module->login($user_id))

			{
				$this->template->assign_var('S_ERROR', $this->user->lang('TFA_INCORRECT_KEY'));
				$this->session_helper->generate_page($user_id, $admin, $auto_login, $viewonline, $redirect);
			}
		}
		catch (http_exception $ex) // @TODO: Replace exception with own exception

		{

            $this->log->add('error', $this->user->data['user_id'], $this->user->ip, 'LOG_TFA_EXCEPTION', $ex->getMessage());

            if ($admin) {
                // Also log it to admin  log just to be sure.
                $this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_TFA_EXCEPTION', $ex->getMessage());
            }
			if ($ex->getStatusCode() == 400)

			{
				$this->template->assign_var('S_ERROR', $this->user->lang($ex->getMessage()));
				$this->session_helper->generate_page($user_id, $admin, $auto_login, $viewonline, $redirect);
			}
			else
			{
				throw $ex;
			}
		}

		$old_session_id = $this->user->session_id;

		if ($admin)
		{
			$cookie_expire = time() - 31536000;
			$this->user->set_cookie('u', '', $cookie_expire);
			$this->user->set_cookie('sid', '', $cookie_expire);
		}

		$result = $this->user->session_create($user_id, $admin, $auto_login, $viewonline);

		// Successful session creation
		if ($result === true)
		{
			// If admin re-authentication we remove the old session entry because a new one has been created...
			if ($admin)
			{
				// the login array is used because the user ids do not differ for re-authentication
				$sql = 'DELETE FROM ' . SESSIONS_TABLE . "
					WHERE session_id = '" . $this->db->sql_escape($old_session_id) . "'
					AND session_user_id = " . (int) $user_id;
				$this->db->sql_query($sql);

                $this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_ADMIN_AUTH_SUCCESS');

				redirect(append_sid("{$this->root_path}adm/index.{$this->php_ext}", false, true, $this->user->data['session_id']));
			}

			redirect(append_sid($redirect, false, true, $this->user->data['session_id']));
		}
		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
	}
}


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\controller;
12
13		use paul999\tfa\helper\session_helper_interface;
14		use phpbb\config\config;
15		use phpbb\controller\helper;
16		use phpbb\db\driver\driver_interface;
17		use phpbb\exception\http_exception;
18		use phpbb\request\request_interface;
19		use phpbb\template\template;
20		use phpbb\user;
21		use phpbb\log\log;
22
23		/**
24		* Controller
25		*/
26		class main_controller
27		{
28		/**
29		* @var helper
30		*/
31		private $controller_helper;
32
33		/**
34		* @var template
35		*/
36		private $template;
37
38		/**
39		* @var driver_interface
40		*/
41		private $db;
42
43		/**
44		* @var user
45		*/
46		private $user;
47
48		/**
49		* @var request_interface
50		*/
51		private $request;
52
53		/**
54		* @var config
55		*/
56		private $config;
57
58		/**
59		* @var session_helper_interface
60		*/
61		private $session_helper;
62
63		/**
64		* @var string
65		*/
66		private $root_path;
67
68		/**
69		* @var string
70		*/
71		private $php_ext;
72		/**
73		* @var phpbb\log\log
74		*/
75		private $log;
76
77		/**
78		* Constructor
79		*
80		* @access public
81		* @param helper $controller_helper
82		* @param driver_interface $db
83		* @param template $template
84		* @param user $user
85		* @param request_interface $request
86		* @param config $config
87		* @param log $log
88		* @param session_helper_interface $session_helper
89		* @param string $root_path
90		* @param string $php_ext
91		*/
92		public function __construct(helper $controller_helper, driver_interface $db, template $template, user $user, request_interface $request, config $config, log $log, session_helper_interface $session_helper, $root_path, $php_ext)
93		{
94		$this->controller_helper = $controller_helper;
95		$this->template = $template;
96		$this->db = $db;
97		$this->user = $user;
98		$this->request = $request;
99		$this->config = $config;
100		$this->session_helper = $session_helper;
101		$this->root_path = $root_path;
102		$this->php_ext = $php_ext;
103		$this->log = $log;
		0 ignored issues – show Documentation Bug introduced 2019-09-05 16:49 UTC by Report Bug Copy Issue Report It seems like `$log` of type `object<phpbb\log\log>` is incompatible with the declared type `object<paul999\tfa\controller\phpbb\log\log>` of property `$log`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
104		}
105
106		/**
107		* @param int $user_id
108		* @param bool $admin
109		* @param bool $auto_login
110		* @param bool $viewonline
111		* @param string $class
112		* @return \Symfony\Component\HttpFoundation\Response
113		* @throws http_exception
114		*/
115		public function submit($user_id, $admin, $auto_login, $viewonline, $class)
116		{
117		$this->user->add_lang_ext('paul999/tfa', 'common');
118
119		if (!check_form_key('tfa_login_page'))
120		{
121		throw new http_exception(403, 'FORM_INVALID');
122		}
123
124		if (empty($this->user->data['tfa_random']) \|\| $user_id != $this->user->data['tfa_uid'])
125		{
126		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
127		}
128		$random = $this->request->variable('random', '');
129
130		if ($this->user->data['tfa_random'] !== $random \|\| strlen($random) !== 40)
131		{
132		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
133		}
134		$sql_ary = array(
135		'tfa_random' => '',
136		'tfa_uid' => 0,
137		);
138		$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . "
139		WHERE
140		session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "' AND
141		session_user_id = " . (int) $this->user->data['user_id'];
142		$this->db->sql_query($sql);
143
144		if (empty($class))
145		{
146		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
147		}
148
149		$module = $this->session_helper->findModule($class);
150
151		if ($module == null)
152		{
153		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
154		}
155
156		$redirect = $this->request->variable('redirect', "{$this->root_path}/index.{$this->php_ext}");
157		try
158		{
159	View Code Duplication	if (!$module->login($user_id))
		0 ignored issues – show Duplication introduced 2016-08-06 18:22 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
160		{
161		$this->template->assign_var('S_ERROR', $this->user->lang('TFA_INCORRECT_KEY'));
162		$this->session_helper->generate_page($user_id, $admin, $auto_login, $viewonline, $redirect);
163		}
164		}
165		catch (http_exception $ex) // @TODO: Replace exception with own exception
		0 ignored issues – show Bug introduced 2018-03-24 13:13 UTC by Report Bug Copy Issue Report The class `phpbb\exception\http_exception` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
166		{
167
168		$this->log->add('error', $this->user->data['user_id'], $this->user->ip, 'LOG_TFA_EXCEPTION', $ex->getMessage());
169
170		if ($admin) {
171		// Also log it to admin log just to be sure.
172		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_TFA_EXCEPTION', $ex->getMessage());
173		}
174	View Code Duplication	if ($ex->getStatusCode() == 400)
		0 ignored issues – show Duplication introduced 2019-09-05 16:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
175		{
176		$this->template->assign_var('S_ERROR', $this->user->lang($ex->getMessage()));
177		$this->session_helper->generate_page($user_id, $admin, $auto_login, $viewonline, $redirect);
178		}
179		else
180		{
181		throw $ex;
182		}
183		}
184
185		$old_session_id = $this->user->session_id;
186
187		if ($admin)
188		{
189		$cookie_expire = time() - 31536000;
190		$this->user->set_cookie('u', '', $cookie_expire);
191		$this->user->set_cookie('sid', '', $cookie_expire);
192		}
193
194		$result = $this->user->session_create($user_id, $admin, $auto_login, $viewonline);
195
196		// Successful session creation
197		if ($result === true)
198		{
199		// If admin re-authentication we remove the old session entry because a new one has been created...
200		if ($admin)
201		{
202		// the login array is used because the user ids do not differ for re-authentication
203		$sql = 'DELETE FROM ' . SESSIONS_TABLE . "
204		WHERE session_id = '" . $this->db->sql_escape($old_session_id) . "'
205		AND session_user_id = " . (int) $user_id;
206		$this->db->sql_query($sql);
207
208		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_ADMIN_AUTH_SUCCESS');
209
210		redirect(append_sid("{$this->root_path}adm/index.{$this->php_ext}", false, true, $this->user->data['session_id']));
211		}
212
213		redirect(append_sid($redirect, false, true, $this->user->data['session_id']));
214		}
215		throw new http_exception(400, 'TFA_SOMETHING_WENT_WRONG');
216		}
217		}
218

paul999 / phpbb_2fa

Pull Request — master (#17)

main_controller::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like