Waca\DataObjects\Request

Complexity

Total Complexity

39

Size/Duplication

Total Lines	400
Duplicated Lines	5.25 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	13
Bugs	2	Features	1

28 Methods

Rating	Name	Duplication	Size	Complexity
B	save()	6	66	5
A	getIp()	0	4	1
A	setIp()	0	4	1
A	getName()	0	4	1
A	setName()	0	4	1
A	getComment()	0	4	1
A	setComment()	0	4	1
A	getStatus()	0	4	1
A	setStatus()	0	4	1
A	getDate()	0	4	1
A	getEmailSent()	0	4	1
A	setEmailSent()	0	4	2
A	getReserved()	0	4	1
A	setReserved()	0	9	2
A	getUserAgent()	0	4	1
A	setUserAgent()	0	4	1
A	getForwardedIp()	0	4	1
A	setForwardedIp()	0	4	1
A	hasComments()	0	23	3
A	getEmailConfirm()	0	4	1
A	setEmailConfirm()	0	4	1
A	generateEmailConfirmationHash()	0	4	1
A	getEmail()	0	4	1
A	setEmail()	0	4	1
B	getClosureReason()	0	24	2
B	getWasCreated()	0	30	3
A	getClosureDate()	15	15	1
A	getRevealHash()	0	11	1

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

use DateTime;
use DateTimeImmutable;
use Exception;
use Waca\DataObject;
use Waca\Exceptions\OptimisticLockFailedException;

/**
 * Request data object
 *
 * This data object is the main request object.
 */
class Request extends DataObject
{
	private $email;
	private $ip;
	private $name;
	/** @var string|null */
	private $comment;
	private $status = "Open";
	private $date;
	private $emailsent = 0;
	private $emailconfirm;
	private $reserved = 0;
	private $useragent;
	private $forwardedip;
	private $hasComments = false;
	private $hasCommentsResolved = false;

	/**
	 * @throws Exception
	 */
	public function save()
	{
		if ($this->isNew()) {
			// insert
			// @todo drop the checksum column

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

			$statement = $this->dbObject->prepare(<<<SQL
INSERT INTO `request` (
	email, ip, name, comment, status, date, emailsent,
	emailconfirm, reserved, useragent, forwardedip, checksum
) VALUES (
	:email, :ip, :name, :comment, :status, CURRENT_TIMESTAMP(), :emailsent,
	:emailconfirm, :reserved, :useragent, :forwardedip, ''
);
SQL
			);
			$statement->bindValue(":email", $this->email);
			$statement->bindValue(":ip", $this->ip);
			$statement->bindValue(":name", $this->name);
			$statement->bindValue(":comment", $this->comment);
			$statement->bindValue(":status", $this->status);
			$statement->bindValue(":emailsent", $this->emailsent);
			$statement->bindValue(":emailconfirm", $this->emailconfirm);
			$statement->bindValue(":reserved", $this->reserved);
			$statement->bindValue(":useragent", $this->useragent);
			$statement->bindValue(":forwardedip", $this->forwardedip);

			if ($statement->execute()) {

This code seems to be duplicated across your project.

				$this->id = (int)$this->dbObject->lastInsertId();
			}
			else {
				throw new Exception($statement->errorInfo());
			}
		}
		else {
			// update
			$statement = $this->dbObject->prepare(<<<SQL
UPDATE `request` SET
	status = :status,
	emailsent = :emailsent,
	emailconfirm = :emailconfirm,
	reserved = :reserved,
	updateversion = updateversion + 1
WHERE id = :id AND updateversion = :updateversion
LIMIT 1;
SQL
			);

			$statement->bindValue(':id', $this->id);
			$statement->bindValue(':updateversion', $this->updateversion);

			$statement->bindValue(':status', $this->status);
			$statement->bindValue(':emailsent', $this->emailsent);
			$statement->bindValue(':emailconfirm', $this->emailconfirm);
			$statement->bindValue(':reserved', $this->reserved);

			if (!$statement->execute()) {
				throw new Exception($statement->errorInfo());
			}

			if ($statement->rowCount() !== 1) {
				throw new OptimisticLockFailedException();
			}

			$this->updateversion++;
		}
	}

	/**
	 * @return string
	 */
	public function getIp()
	{
		return $this->ip;
	}

	/**
	 * @param string $ip
	 */
	public function setIp($ip)
	{
		$this->ip = $ip;
	}

	/**
	 * @return string
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * @param string $name
	 */
	public function setName($name)
	{
		$this->name = $name;
	}

	/**
	 * @return string|null
	 */
	public function getComment()
	{
		return $this->comment;
	}

	/**
	 * @param string $comment
	 */
	public function setComment($comment)
	{
		$this->comment = $comment;
	}

	/**
	 * @return string
	 */
	public function getStatus()
	{
		return $this->status;
	}

	/**
	 * @param string $status
	 */
	public function setStatus($status)
	{
		$this->status = $status;
	}

	/**
	 * Returns the time the request was first submitted
	 *
	 * @return DateTimeImmutable
	 */
	public function getDate()
	{
		return new DateTimeImmutable($this->date);
	}

	/**
	 * @return bool
	 */
	public function getEmailSent()
	{
		return $this->emailsent == "1";
	}

	/**
	 * @param bool $emailSent
	 */
	public function setEmailSent($emailSent)
	{
		$this->emailsent = $emailSent ? 1 : 0;
	}

	/**
	 * @todo allow this to return null instead

Comment refers to a TODO task

	 * @return int
	 */
	public function getReserved()
	{
		return $this->reserved;
	}

	/**
	 * @param int|null $reserved
	 */
	public function setReserved($reserved)
	{
		if ($reserved === null) {
			// @todo this shouldn't be needed!

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

			$reserved = 0;
		}

		$this->reserved = $reserved;
	}

	/**
	 * @return string
	 */
	public function getUserAgent()
	{
		return $this->useragent;
	}

	/**
	 * @param string $useragent
	 */
	public function setUserAgent($useragent)
	{
		$this->useragent = $useragent;
	}

	/**
	 * @return string|null
	 */
	public function getForwardedIp()
	{
		return $this->forwardedip;
	}

	/**
	 * @param string|null $forwardedip
	 */
	public function setForwardedIp($forwardedip)
	{
		$this->forwardedip = $forwardedip;
	}

	/**
	 * @return bool
	 */
	public function hasComments()
	{
		if ($this->hasCommentsResolved) {
			return $this->hasComments;
		}

		if ($this->comment != "") {
			$this->hasComments = true;
			$this->hasCommentsResolved = true;

			return true;
		}

		$commentsQuery = $this->dbObject->prepare("SELECT COUNT(*) AS num FROM comment WHERE request = :id;");
		$commentsQuery->bindValue(":id", $this->id);

		$commentsQuery->execute();

		$this->hasComments = ($commentsQuery->fetchColumn() != 0);
		$this->hasCommentsResolved = true;

		return $this->hasComments;
	}

	/**
	 * @return string
	 */
	public function getEmailConfirm()
	{
		return $this->emailconfirm;
	}

	/**
	 * @param string $emailconfirm
	 */
	public function setEmailConfirm($emailconfirm)
	{
		$this->emailconfirm = $emailconfirm;
	}

	public function generateEmailConfirmationHash()
	{
		$this->emailconfirm = bin2hex(openssl_random_pseudo_bytes(16));
	}

	/**
	 * @return string|null
	 */
	public function getEmail()
	{
		return $this->email;
	}

	/**
	 * @param string|null $email
	 */
	public function setEmail($email)
	{
		$this->email = $email;
	}

	/**
	 * @return string
	 * @throws Exception
	 */
	public function getClosureReason()
	{
		if ($this->status != 'Closed') {
			throw new Exception("Can't get closure reason for open request.");
		}

		$statement = $this->dbObject->prepare(<<<SQL
SELECT closes.mail_desc
FROM log
INNER JOIN closes ON log.action = closes.closes
WHERE log.objecttype = 'Request'
AND log.objectid = :requestId
AND log.action LIKE 'Closed%'
ORDER BY log.timestamp DESC
LIMIT 1;
SQL
		);

		$statement->bindValue(":requestId", $this->id);
		$statement->execute();
		$reason = $statement->fetchColumn();

		return $reason;
	}

	/**
	 * Gets a value indicating whether the request was closed as created or not.
	 */
	public function getWasCreated()
	{
		if ($this->status != 'Closed') {
			throw new Exception("Can't get closure reason for open request.");
		}

		$statement = $this->dbObject->prepare(<<<SQL
SELECT emailtemplate.oncreated, log.action
FROM log
LEFT JOIN emailtemplate ON CONCAT('Closed ', emailtemplate.id) = log.action
WHERE log.objecttype = 'Request'
AND log.objectid = :requestId
AND log.action LIKE 'Closed%'
ORDER BY log.timestamp DESC
LIMIT 1;
SQL
		);

		$statement->bindValue(":requestId", $this->id);
		$statement->execute();
		$onCreated = $statement->fetchColumn(0);
		$logAction = $statement->fetchColumn(1);
		$statement->closeCursor();

		if ($onCreated === null) {
			return $logAction === "Closed custom-y";
		}

		return (bool)$onCreated;
	}

	/**
	 * @return DateTime
	 */
	public function getClosureDate()

This method seems to be duplicated in your project.

	{
		$logQuery = $this->dbObject->prepare(<<<SQL
SELECT timestamp FROM log
WHERE objectid = :request AND objecttype = 'Request' AND action LIKE 'Closed%'
ORDER BY timestamp DESC LIMIT 1;
SQL
		);
		$logQuery->bindValue(":request", $this->getId());
		$logQuery->execute();
		$logTime = $logQuery->fetchColumn();
		$logQuery->closeCursor();

		return new DateTime($logTime);
	}

	/**
	 * Returns a hash based on data within this request which can be generated easily from the data to be used to reveal
	 * data to unauthorised* users.
	 *
	 * *:Not tool admins, check users, or the reserving user.
	 *
	 * @return string
	 *
	 * @todo future work to make invalidation better. Possibly move to the database and invalidate on relevant events?

Comment refers to a TODO task

	 *       Maybe depend on the last logged action timestamp?
	 */
	public function getRevealHash()
	{
		$data = $this->id         // unique per request
			. '|' . $this->ip           // }
			. '|' . $this->forwardedip  // } private data not known to those without access
			. '|' . $this->useragent    // }
			. '|' . $this->email        // }
			. '|' . $this->status;      // to rudimentarily invalidate the token on status change

		return hash('sha256', $data);
	}
}