Waca\Validation\RequestValidationHelper

Complexity

Total Complexity

33

Size/Duplication

Total Lines	295
Duplicated Lines	8.14 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

40.77%

Importance

Changes	6
Bugs	1	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	23	1
C	validateName()	3	54	9
C	validateEmail()	9	38	7
B	validateOther()	0	30	3
A	checkAntiSpoof()	0	13	3
A	checkTitleBlacklist()	0	23	3
A	userExists()	0	19	3
A	userSulExists()	0	23	2
A	nameRequestExists()	12	12	2

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Validation;

use Exception;
use Waca\DataObjects\Request;
use Waca\Helpers\HttpHelper;
use Waca\Helpers\Interfaces\IBanHelper;
use Waca\PdoDatabase;
use Waca\Providers\Interfaces\IAntiSpoofProvider;
use Waca\Providers\Interfaces\IXffTrustProvider;
use Waca\Providers\TorExitProvider;

/**
 * Performs the validation of an incoming request.
 */
class RequestValidationHelper
{
	/** @var IBanHelper */
	private $banHelper;
	/** @var Request */
	private $request;
	private $emailConfirmation;
	/** @var PdoDatabase */
	private $database;
	/** @var IAntiSpoofProvider */
	private $antiSpoofProvider;
	/** @var IXffTrustProvider */
	private $xffTrustProvider;
	/** @var HttpHelper */
	private $httpHelper;
	/**
	 * @var string
	 */
	private $mediawikiApiEndpoint;
	private $titleBlacklistEnabled;
	/**
	 * @var TorExitProvider
	 */
	private $torExitProvider;

	/**
	 * Summary of __construct
	 *
	 * @param IBanHelper         $banHelper
	 * @param Request            $request
	 * @param string             $emailConfirmation
	 * @param PdoDatabase        $database
	 * @param IAntiSpoofProvider $antiSpoofProvider
	 * @param IXffTrustProvider  $xffTrustProvider
	 * @param HttpHelper         $httpHelper
	 * @param string             $mediawikiApiEndpoint
	 * @param boolean            $titleBlacklistEnabled
	 * @param TorExitProvider    $torExitProvider
	 */
	public function __construct(
		IBanHelper $banHelper,
		Request $request,
		$emailConfirmation,
		PdoDatabase $database,
		IAntiSpoofProvider $antiSpoofProvider,
		IXffTrustProvider $xffTrustProvider,
		HttpHelper $httpHelper,
		$mediawikiApiEndpoint,
		$titleBlacklistEnabled,
		TorExitProvider $torExitProvider
	) {
		$this->banHelper = $banHelper;
		$this->request = $request;
		$this->emailConfirmation = $emailConfirmation;
		$this->database = $database;
		$this->antiSpoofProvider = $antiSpoofProvider;
		$this->xffTrustProvider = $xffTrustProvider;
		$this->httpHelper = $httpHelper;
		$this->mediawikiApiEndpoint = $mediawikiApiEndpoint;
		$this->titleBlacklistEnabled = $titleBlacklistEnabled;
		$this->torExitProvider = $torExitProvider;
	}

	/**
	 * Summary of validateName
	 * @return ValidationError[]
	 */
	public function validateName()
	{
		$errorList = array();

		// ERRORS
		// name is empty
		if (trim($this->request->getName()) == "") {
			$errorList[ValidationError::NAME_EMPTY] = new ValidationError(ValidationError::NAME_EMPTY);
		}

		// name is banned
		$ban = $this->banHelper->nameIsBanned($this->request->getName());
		if ($ban != false) {
			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
		}

		// username already exists
		// TODO: implement

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		if ($this->userExists()) {
			$errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS);
		}

		// username part of SUL account
		// TODO: implement

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		if ($this->userSulExists()) {
			// using same error slot as name exists - it's the same sort of error, and we probably only want to show one.
			$errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS_SUL);
		}

		// username is numbers
		if (preg_match("/^[0-9]+$/", $this->request->getName()) === 1) {

This code seems to be duplicated across your project.

			$errorList[ValidationError::NAME_NUMONLY] = new ValidationError(ValidationError::NAME_NUMONLY);
		}

		// username can't contain #@/<>[]|{}
		if (preg_match("/[" . preg_quote("#@/<>[]|{}", "/") . "]/", $this->request->getName()) === 1) {
			$errorList[ValidationError::NAME_INVALIDCHAR] = new ValidationError(ValidationError::NAME_INVALIDCHAR);
		}

		// existing non-closed request for this name
		// TODO: implement

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		if ($this->nameRequestExists()) {
			$errorList[ValidationError::OPEN_REQUEST_NAME] = new ValidationError(ValidationError::OPEN_REQUEST_NAME);
		}

		// WARNINGS
		// name has to be sanitised
		// TODO: implement

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		if (false) {

Avoid IF statements that are always true or false

			$errorList[ValidationError::NAME_SANITISED] = new ValidationError(ValidationError::NAME_SANITISED, false);
		}

		return $errorList;
	}

	/**
	 * Summary of validateEmail
	 * @return ValidationError[]
	 */
	public function validateEmail()
	{
		$errorList = array();

		// ERRORS

		// Email is banned
		$ban = $this->banHelper->emailIsBanned($this->request->getEmail());
		if ($ban != false) {
			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
		}

		// email addresses must match
		if ($this->request->getEmail() != $this->emailConfirmation) {
			$errorList[ValidationError::EMAIL_MISMATCH] = new ValidationError(ValidationError::EMAIL_MISMATCH);
		}

		// email address must be validly formed
		if (trim($this->request->getEmail()) == "") {

This code seems to be duplicated across your project.

			$errorList[ValidationError::EMAIL_EMPTY] = new ValidationError(ValidationError::EMAIL_EMPTY);
		}

		// email address must be validly formed
		if (!filter_var($this->request->getEmail(), FILTER_VALIDATE_EMAIL)) {
			if (trim($this->request->getEmail()) != "") {

This code seems to be duplicated across your project.

				$errorList[ValidationError::EMAIL_INVALID] = new ValidationError(ValidationError::EMAIL_INVALID);
			}
		}

		// email address can't be wikimedia/wikipedia .com/org
		if (preg_match('/.*@.*wiki(m.dia|p.dia)\.(org|com)/i', $this->request->getEmail()) === 1) {

This code seems to be duplicated across your project.

			$errorList[ValidationError::EMAIL_WIKIMEDIA] = new ValidationError(ValidationError::EMAIL_WIKIMEDIA);
		}

		// WARNINGS

		return $errorList;
	}

	/**
	 * Summary of validateOther
	 * @return ValidationError[]
	 */
	public function validateOther()
	{
		$errorList = array();

		$trustedIp = $this->xffTrustProvider->getTrustedClientIp($this->request->getIp(),
			$this->request->getForwardedIp());

		// ERRORS

		// TOR nodes
		if ($this->torExitProvider->isTorExit($trustedIp)) {
			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED_TOR);
		}

		// IP banned
		$ban = $this->banHelper->ipIsBanned($trustedIp);
		if ($ban != false) {
			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
		}

		// WARNINGS

		// Antispoof check
		$this->checkAntiSpoof();

		// Blacklist check
		$this->checkTitleBlacklist();

		return $errorList;
	}

	private function checkAntiSpoof()
	{
		try {
			if (count($this->antiSpoofProvider->getSpoofs($this->request->getName())) > 0) {
				// If there were spoofs an Admin should handle the request.
				$this->request->setStatus("Flagged users");
			}
		}
		catch (Exception $ex) {
			// hrm.
			// TODO: log this?

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		}
	}

	private function checkTitleBlacklist()
	{
		if ($this->titleBlacklistEnabled == 1) {
			$apiResult = $this->httpHelper->get(
				$this->mediawikiApiEndpoint,
				array(
					'action'       => 'titleblacklist',
					'tbtitle'      => $this->request->getName(),
					'tbaction'     => 'new-account',
					'tbnooverride' => true,
					'format'       => 'php',
				)
			);

			$data = unserialize($apiResult);

			$requestIsOk = $data['titleblacklist']['result'] == "ok";

			if (!$requestIsOk) {
				$this->request->setStatus("Flagged users");
			}
		}
	}

	private function userExists()
	{
		$userexist = $this->httpHelper->get(
			$this->mediawikiApiEndpoint,
			array(
				'action'  => 'query',
				'list'    => 'users',
				'ususers' => $this->request->getName(),
				'format'  => 'php',
			)
		);

		$ue = unserialize($userexist);
		if (!isset ($ue['query']['users']['0']['missing']) && isset ($ue['query']['users']['0']['userid'])) {

This if statement, and the following return statement can be replaced with return !isset($ue['query']['users']['0']['missing']) && isset($ue['query']['users']['0']['userid']);.

			return true;
		}

		return false;
	}

	private function userSulExists()
	{
		// @todo is this really necessary?!

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		// $reqname = str_replace("_", " ", $this->request->getName());

60% of this comment could be valid code. Did you maybe forget this after debugging?

		$reqname = $this->request->getName();

		$userexist = $this->httpHelper->get(
			$this->mediawikiApiEndpoint,
			array(
				'action'  => 'query',
				'meta'    => 'globaluserinfo',
				'guiuser' => $reqname,
				'format'  => 'php',
			)
		);

		$ue = unserialize($userexist);
		if (isset ($ue['query']['globaluserinfo']['id'])) {

This if statement, and the following return statement can be replaced with return isset($ue['query']['globaluserinfo']['id']);.

			return true;
		}

		return false;
	}

	private function nameRequestExists()

This method seems to be duplicated in your project.

	{
		$query = "SELECT COUNT(id) FROM request WHERE status != 'Closed' AND name = :name;";
		$statement = $this->database->prepare($query);
		$statement->execute(array(':name' => $this->request->getName()));

		if (!$statement) {
			return false;
		}

		return $statement->fetchColumn() > 0;
	}
}