ConfirmationTokenChain

Complexity

Total Complexity

23

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	pushToken()	0	3	1
A	filteredTokens()	0	10	3
A	suppressionRequired()	0	3	1
A	suppressTokens()	0	5	2
A	reloadRequired()	0	9	3
A	reloadRequiredIfError()	0	9	3
A	params()	0	8	2
A	getRedirectUrlBase()	0	15	3
A	getRedirectUrlParams()	0	8	2
A	redirectURL()	0	4	1
A	reloadWithToken()	0	18	2

<?php

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.

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) {

The parameter $b is not used and could be removed.

			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;

The method reloadWithToken() contains an exit expression.

	}
}