IndexController::isLoggedIn() - Code Metrics - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

IndexController::isLoggedIn() A
last analyzed 2020-04-29 13:34 UTC

↳ Parent: IndexController

Complexity

Conditions	4
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	0
cts	12
cp	0
rs	9.7666
c	0
b	0
f	0
cc	4
nc	5
nop	0
crap	20

<?php

/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\Controller;

use Owncloud\Updater\Utils\Checkpoint;
use Owncloud\Updater\Utils\ConfigReader;
use Pimple\Container;
use Owncloud\Updater\Formatter\HtmlOutputFormatter;
use Owncloud\Updater\Http\Request;
use League\Plates\Engine;
use League\Plates\Extension\Asset;
use League\Plates\Extension\URI;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Input\StringInput;

/**
 * Class IndexController
 *
 * @package Owncloud\Updater\Controller
 */
class IndexController {

	/** @var Container */
	protected $container;

	/** @var Request */
	protected $request;

	/** @var string $command */
	protected $command;

	/**
	 * @param Container $container
	 * @param Request|null $request
	 */
	public function __construct(Container $container,
								Request $request = null) {
		$this->container = $container;
		if (is_null($request)){
			$this->request = new Request(['post' => $_POST, 'headers' => $_SERVER]);
		} else {
			$this->request = $request;
		}

		$this->command = $this->request->postParameter('command');
	}

	/**
	 * @return string
	 */
	public function dispatch() {
		/** @var ConfigReader $configReader */
		$configReader = $this->container['utils.configReader'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		// strip index.php and query string (if any) to get a real base url
		$baseUrl = preg_replace('/(index\.php.*|\?.*)$/', '', $_SERVER['REQUEST_URI']);
		$templates = new Engine(CURRENT_DIR . '/src/Resources/views/');
		$templates->loadExtension(new Asset(CURRENT_DIR . '/pub/', false));
		$templates->loadExtension(new URI($baseUrl));
		
		// Check if the user is logged-in
		if(!$this->isLoggedIn()) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
			return $this->showLogin($templates);
		}
		
		try {
			$fullEndpoint = $this->getEndpoint();
			$this->container['application']->setEndpoint($fullEndpoint);
			$this->container['application']->setAuthToken($this->request->header('X_Updater_Auth'));
			$this->container['application']->initConfig();
			$this->container['application']->assertOwnCloudFound();
		} catch (\Exception $e){
			$content = $templates->render(
				'partials/error',
				[
					'title' => 'Updater',
					'version' => $this->container['application']->getVersion(),
					'error' => $e->getMessage()
				]
			);
			return $content;
		}
		
		if (is_null($this->command)){
			/** @var Checkpoint $checkpoint */
			$checkpoint = $this->container['utils.checkpoint'];
			$checkpoints = $checkpoint->getAll();
			$content = $templates->render(
					'partials/inner',
					[
						'title' => 'Updater',
						'version' => $this->container['application']->getVersion(),
						'checkpoints' => $checkpoints
					]
			);
		} else {
			header('Content-Type: application/json');
			$content = json_encode($this->ajaxAction(), JSON_UNESCAPED_SLASHES);
		}
		return $content;
	}

	/**
	 * @return bool
	 */
	protected function isLoggedIn() {
		/** @var ConfigReader $configReader */
		$locator = $this->container['utils.locator'];
		$storedSecret = $locator->getSecretFromConfig();
		if ($storedSecret === '') {
			die('updater.secret is undefined in config/config.php. Either browse the admin settings in your ownCloud and click "Open updater" or define a strong secret using <pre>php -r \'echo password_hash("MyStrongSecretDoUseYourOwn!", PASSWORD_DEFAULT)."\n";\'</pre> and set this in the config.php.');
		}
		$sentAuthHeader = ($this->request->header('X_Updater_Auth') !== null) ? $this->request->header('X_Updater_Auth') : '';

		if(password_verify($sentAuthHeader, $storedSecret)) {
			return true;
		}

		return false;
	}

	/**
	 * @param Engine $templates
	 * @return string
	 */
	public function showLogin(Engine $templates) {
		// If it is a request with invalid token just return "false" so that we can catch this
		$token = ($this->request->header('X_Updater_Auth') !== null) ? $this->request->header('X_Updater_Auth') : '';
		if($token !== '') {
			return 'false';
		}

		$content = $templates->render(
			'partials/login',
			[
				'title' => 'Login Required',
			]
		);
		return $content;
	}

	/**
	 * @return array
	 */
	public function ajaxAction() {
		$application = $this->container['application'];

		$input = new StringInput($this->command);
		$input->setInteractive(false);

		$output = new BufferedOutput();
		$formatter = $output->getFormatter();
		$formatter->setDecorated(true);
		$output->setFormatter(new HtmlOutputFormatter($formatter));

		$application->setAutoExit(false);

		// Some commands dump things out instead of returning a value
		ob_start();
		$errorCode = $application->run($input, $output);
		if (!$result = $output->fetch()){
			$result = ob_get_contents(); // If empty, replace it by the catched output
		}
		ob_end_clean();
		$result = nl2br($result);
		$result = preg_replace('|<br />\r.*<br />(\r.*?)<br />|', '$1<br />', $result);

		return [
			'input' => $this->command,
			'output' => $result,
			'environment' => '',
			'error_code' => $errorCode
		];
	}
	
	protected function getEndpoint(){
		$endpoint = preg_replace('/(updater\/|updater\/index.php)$/', '', $this->request->getRequestUri());
		$fullEndpoint = sprintf(
			'%s://%s%sindex.php/occ/',
			$this->request->getServerProtocol(),
			$this->request->getHost(),
			$endpoint !== '' ? $endpoint : '/'
		);
		
		return $fullEndpoint;
	}

}


1			<?php
2
3			/**
4			* @author Victor Dubiniuk <[email protected]>
5			*
6			* @copyright Copyright (c) 2015, ownCloud, Inc.
7			* @license AGPL-3.0
8			*
9			* This code is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License, version 3,
11			* as published by the Free Software Foundation.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU Affero General Public License for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public License, version 3,
19			* along with this program. If not, see <http://www.gnu.org/licenses/>
20			*
21			*/
22
23			namespace Owncloud\Updater\Controller;
24
25			use Owncloud\Updater\Utils\Checkpoint;
26			use Owncloud\Updater\Utils\ConfigReader;
27			use Pimple\Container;
28			use Owncloud\Updater\Formatter\HtmlOutputFormatter;
29			use Owncloud\Updater\Http\Request;
30			use League\Plates\Engine;
31			use League\Plates\Extension\Asset;
32			use League\Plates\Extension\URI;
33			use Symfony\Component\Console\Output\BufferedOutput;
34			use Symfony\Component\Console\Input\StringInput;
35
36			/**
37			* Class IndexController
38			*
39			* @package Owncloud\Updater\Controller
40			*/
41			class IndexController {
42
43			/** @var Container */
44			protected $container;
45
46			/** @var Request */
47			protected $request;
48
49			/** @var string $command */
50			protected $command;
51
52			/**
53			* @param Container $container
54			* @param Request\|null $request
55			*/
56			public function __construct(Container $container,
57			Request $request = null) {
58			$this->container = $container;
59			if (is_null($request)){
60			$this->request = new Request(['post' => $_POST, 'headers' => $_SERVER]);
61			} else {
62			$this->request = $request;
63			}
64
65			$this->command = $this->request->postParameter('command');
66			}
67
68			/**
69			* @return string
70			*/
71			public function dispatch() {
72			/** @var ConfigReader $configReader */
73			$configReader = $this->container['utils.configReader'];
			0 ignored issues – show Unused Code introduced 2016-10-19 17:35 UTC by Report Bug Copy Issue Report `$configReader` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
74
75			// strip index.php and query string (if any) to get a real base url
76			$baseUrl = preg_replace('/(index\.php.\|\?.)$/', '', $_SERVER['REQUEST_URI']);
77			$templates = new Engine(CURRENT_DIR . '/src/Resources/views/');
78			$templates->loadExtension(new Asset(CURRENT_DIR . '/pub/', false));
79			$templates->loadExtension(new URI($baseUrl));
80
81			// Check if the user is logged-in
82			if(!$this->isLoggedIn()) {
			0 ignored issues – show Bug Best Practice introduced 2016-02-09 16:55 UTC by Report Bug Copy Issue Report The expression `$this->isLoggedIn()` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
83			return $this->showLogin($templates);
84			}
85
86			try {
87			$fullEndpoint = $this->getEndpoint();
88			$this->container['application']->setEndpoint($fullEndpoint);
89			$this->container['application']->setAuthToken($this->request->header('X_Updater_Auth'));
90			$this->container['application']->initConfig();
91			$this->container['application']->assertOwnCloudFound();
92			} catch (\Exception $e){
93			$content = $templates->render(
94			'partials/error',
95			[
96			'title' => 'Updater',
97			'version' => $this->container['application']->getVersion(),
98			'error' => $e->getMessage()
99			]
100			);
101			return $content;
102			}
103
104			if (is_null($this->command)){
105			/** @var Checkpoint $checkpoint */
106			$checkpoint = $this->container['utils.checkpoint'];
107			$checkpoints = $checkpoint->getAll();
108			$content = $templates->render(
109			'partials/inner',
110			[
111			'title' => 'Updater',
112			'version' => $this->container['application']->getVersion(),
113			'checkpoints' => $checkpoints
114			]
115			);
116			} else {
117			header('Content-Type: application/json');
118			$content = json_encode($this->ajaxAction(), JSON_UNESCAPED_SLASHES);
119			}
120			return $content;
121			}
122
123			/**
124			* @return bool
125			*/
126			protected function isLoggedIn() {
127			/** @var ConfigReader $configReader */
128			$locator = $this->container['utils.locator'];
129			$storedSecret = $locator->getSecretFromConfig();
130			if ($storedSecret === '') {
131			die('updater.secret is undefined in config/config.php. Either browse the admin settings in your ownCloud and click "Open updater" or define a strong secret using <pre>php -r \'echo password_hash("MyStrongSecretDoUseYourOwn!", PASSWORD_DEFAULT)."\n";\'</pre> and set this in the config.php.');
132			}
133			$sentAuthHeader = ($this->request->header('X_Updater_Auth') !== null) ? $this->request->header('X_Updater_Auth') : '';
134
135			if(password_verify($sentAuthHeader, $storedSecret)) {
136			return true;
137			}
138
139			return false;
140			}
141
142			/**
143			* @param Engine $templates
144			* @return string
145			*/
146			public function showLogin(Engine $templates) {
147			// If it is a request with invalid token just return "false" so that we can catch this
148			$token = ($this->request->header('X_Updater_Auth') !== null) ? $this->request->header('X_Updater_Auth') : '';
149			if($token !== '') {
150			return 'false';
151			}
152
153			$content = $templates->render(
154			'partials/login',
155			[
156			'title' => 'Login Required',
157			]
158			);
159			return $content;
160			}
161
162			/**
163			* @return array
164			*/
165			public function ajaxAction() {
166			$application = $this->container['application'];
167
168			$input = new StringInput($this->command);
169			$input->setInteractive(false);
170
171			$output = new BufferedOutput();
172			$formatter = $output->getFormatter();
173			$formatter->setDecorated(true);
174			$output->setFormatter(new HtmlOutputFormatter($formatter));
175
176			$application->setAutoExit(false);
177
178			// Some commands dump things out instead of returning a value
179			ob_start();
180			$errorCode = $application->run($input, $output);
181			if (!$result = $output->fetch()){
182			$result = ob_get_contents(); // If empty, replace it by the catched output
183			}
184			ob_end_clean();
185			$result = nl2br($result);
186			$result = preg_replace('\|<br />\r.<br />(\r.?)<br />\|', '$1<br />', $result);
187
188			return [
189			'input' => $this->command,
190			'output' => $result,
191			'environment' => '',
192			'error_code' => $errorCode
193			];
194			}
195
196			protected function getEndpoint(){
197			$endpoint = preg_replace('/(updater\/\|updater\/index.php)$/', '', $this->request->getRequestUri());
198			$fullEndpoint = sprintf(
199			'%s://%s%sindex.php/occ/',
200			$this->request->getServerProtocol(),
201			$this->request->getHost(),
202			$endpoint !== '' ? $endpoint : '/'
203			);
204
205			return $fullEndpoint;
206			}
207
208			}
209

owncloud / updater

IndexController::isLoggedIn() A last analyzed 2020-04-29 13:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

IndexController::isLoggedIn() A
last analyzed 2020-04-29 13:34 UTC