ConfirmationTokenChain::params() - Code Metrics - Inspection of "Merge branch '3.6' into 3.7" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.7 ( 8061e7...a7d511 )

unknown

created 2018-11-06 22:36 UTC

ConfirmationTokenChain::params() A

↳ Parent: ConfirmationTokenChain

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php


require_once(dirname(dirname(dirname(__FILE__))).'/view/TemplateGlobalProvider.php');
require_once(dirname(dirname(dirname(__FILE__))).'/control/Director.php');

/**
 * A chain of confirmation tokens to be validated on each request. This allows the application to
 * check multiple tokens at once without having to potentially redirect the user for each of them
 *
 * @internal This class is designed specifically for use pre-startup and may change without warning
 */
class ConfirmationTokenChain
{
	/**
	 * @var array
	 */
	protected $tokens = array();

	/**
	 * @param AbstractConfirmationToken $token
	 */
	public function pushToken(AbstractConfirmationToken $token) {
		$this->tokens[] = $token;
	}

	/**
	 * Collect all tokens that require a redirect
	 *
	 * @return array
	 */
	protected function filteredTokens() {
		$result = array();
		foreach ($this->tokens as $token) {
			if ($token->reloadRequired()) {
				$result[] = $token;
			}
		}

		return $result;
	}

	/**
	 * @return bool
	 */
	public function suppressionRequired() {
		return (count($this->filteredTokens()) !== 0);
	}

	/**
	 * Suppress URLs & GET vars from tokens that require a redirect
	 */
	public function suppressTokens() {
		foreach ($this->filteredTokens() as $token) {
			$token->suppress();
		}
	}

	/**
	 * @return bool
	 */
	public function reloadRequired() {
		foreach ($this->tokens as $token) {
			if ($token->reloadRequired()) {
				return true;
			}
		}

		return false;
	}

	/**
	 * @return bool
	 */
	public function reloadRequiredIfError() {
		foreach ($this->tokens as $token) {
			if ($token->reloadRequiredIfError()) {
				return true;
			}
		}

		return false;
	}

	/**
	 * @param bool $includeToken
	 * @return array
	 */
	public function params($includeToken = true) {
		$params = array();
		foreach ($this->tokens as $token) {
			$params = array_merge($params, $token->params($includeToken));
		}

		return $params;
	}

	/**
	 * Fetch the URL we want to redirect to, excluding query string parameters. This may
	 * be the same URL (with a token to be added outside this method), or to a different
	 * URL if the current one has been suppressed
	 *
	 * @return string
	 */
	public function getRedirectUrlBase() {
		// URLConfirmationTokens may alter the URL to suppress the URL they're protecting,
		// so we need to ensure they're inspected last and therefore take priority
		$tokens = $this->filteredTokens();
		usort($tokens, function ($a, $b) {

			return ($a instanceof URLConfirmationToken) ? 1 : 0;
		});

		$urlBase = Director::baseURL();
		foreach ($tokens as $token) {
			$urlBase = $token->getRedirectUrlBase();
		}

		return $urlBase;
	}

	/**
	 * Collate GET vars from all token providers that need to apply a token
	 *
	 * @return array
	 */
	public function getRedirectUrlParams() {
		$params = array();
		foreach ($this->filteredTokens() as $token) {
			$params = array_merge($params, $token->getRedirectUrlParams());
		}

		return $params;
	}

	/**
	 * @return string
	 */
	protected function redirectURL() {
		$params = http_build_query($this->getRedirectUrlParams());
		return $this->getRedirectUrlBase() . '?' . $params;
	}

	/**
	 * Forces a reload of the request with the applicable tokens included
	 */
	public function reloadWithToken() {
		require_once(dirname(dirname(__FILE__)).'/Convert.php');
		$location = $this->redirectURL();
		$locationJS = Convert::raw2js($location);
		$locationATT = Convert::raw2att($location);

		if (headers_sent()) {
			echo "
<script>location.href='{$locationJS}';</script>
<noscript><meta http-equiv='refresh' content='0; url={$locationATT}'></noscript>
You are being redirected. If you are not redirected soon, <a href='{$locationATT}'>click here to continue</a>
";
		} else {
			header("location: {$location}", true, 302);
		}

		die;

	}
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 12 and the first side effect is on line 3. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			require_once(dirname(dirname(dirname(__FILE__))).'/view/TemplateGlobalProvider.php');
4			require_once(dirname(dirname(dirname(__FILE__))).'/control/Director.php');
5
6			/**
7			* A chain of confirmation tokens to be validated on each request. This allows the application to
8			* check multiple tokens at once without having to potentially redirect the user for each of them
9			*
10			* @internal This class is designed specifically for use pre-startup and may change without warning
11			*/
12			class ConfirmationTokenChain
13			{
14			/**
15			* @var array
16			*/
17			protected $tokens = array();
18
19			/**
20			* @param AbstractConfirmationToken $token
21			*/
22			public function pushToken(AbstractConfirmationToken $token) {
23			$this->tokens[] = $token;
24			}
25
26			/**
27			* Collect all tokens that require a redirect
28			*
29			* @return array
30			*/
31			protected function filteredTokens() {
32			$result = array();
33			foreach ($this->tokens as $token) {
34			if ($token->reloadRequired()) {
35			$result[] = $token;
36			}
37			}
38
39			return $result;
40			}
41
42			/**
43			* @return bool
44			*/
45			public function suppressionRequired() {
46			return (count($this->filteredTokens()) !== 0);
47			}
48
49			/**
50			* Suppress URLs & GET vars from tokens that require a redirect
51			*/
52			public function suppressTokens() {
53			foreach ($this->filteredTokens() as $token) {
54			$token->suppress();
55			}
56			}
57
58			/**
59			* @return bool
60			*/
61			public function reloadRequired() {
62			foreach ($this->tokens as $token) {
63			if ($token->reloadRequired()) {
64			return true;
65			}
66			}
67
68			return false;
69			}
70
71			/**
72			* @return bool
73			*/
74			public function reloadRequiredIfError() {
75			foreach ($this->tokens as $token) {
76			if ($token->reloadRequiredIfError()) {
77			return true;
78			}
79			}
80
81			return false;
82			}
83
84			/**
85			* @param bool $includeToken
86			* @return array
87			*/
88			public function params($includeToken = true) {
89			$params = array();
90			foreach ($this->tokens as $token) {
91			$params = array_merge($params, $token->params($includeToken));
92			}
93
94			return $params;
95			}
96
97			/**
98			* Fetch the URL we want to redirect to, excluding query string parameters. This may
99			* be the same URL (with a token to be added outside this method), or to a different
100			* URL if the current one has been suppressed
101			*
102			* @return string
103			*/
104			public function getRedirectUrlBase() {
105			// URLConfirmationTokens may alter the URL to suppress the URL they're protecting,
106			// so we need to ensure they're inspected last and therefore take priority
107			$tokens = $this->filteredTokens();
108			usort($tokens, function ($a, $b) {
			0 ignored issues – show Unused Code introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report The parameter `$b` 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...
109			return ($a instanceof URLConfirmationToken) ? 1 : 0;
110			});
111
112			$urlBase = Director::baseURL();
113			foreach ($tokens as $token) {
114			$urlBase = $token->getRedirectUrlBase();
115			}
116
117			return $urlBase;
118			}
119
120			/**
121			* Collate GET vars from all token providers that need to apply a token
122			*
123			* @return array
124			*/
125			public function getRedirectUrlParams() {
126			$params = array();
127			foreach ($this->filteredTokens() as $token) {
128			$params = array_merge($params, $token->getRedirectUrlParams());
129			}
130
131			return $params;
132			}
133
134			/**
135			* @return string
136			*/
137			protected function redirectURL() {
138			$params = http_build_query($this->getRedirectUrlParams());
139			return $this->getRedirectUrlBase() . '?' . $params;
140			}
141
142			/**
143			* Forces a reload of the request with the applicable tokens included
144			*/
145			public function reloadWithToken() {
146			require_once(dirname(dirname(__FILE__)).'/Convert.php');
147			$location = $this->redirectURL();
148			$locationJS = Convert::raw2js($location);
149			$locationATT = Convert::raw2att($location);
150
151			if (headers_sent()) {
152			echo "
153			<script>location.href='{$locationJS}';</script>
154			<noscript><meta http-equiv='refresh' content='0; url={$locationATT}'></noscript>
155			You are being redirected. If you are not redirected soon, <a href='{$locationATT}'>click here to continue</a>
156			";
157			} else {
158			header("location: {$location}", true, 302);
159			}
160
161			die;
			0 ignored issues – show Coding Style Compatibility introduced 2016-11-01 00:55 UTC by Report Bug Copy Issue Report The method `reloadWithToken()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
162			}
163			}
164

silverstripe / silverstripe-framework

Push — 3.7 ( 8061e7...a7d511 )

ConfirmationTokenChain::params() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like