Waca\DataObjects\Request

Complexity

Total Complexity

49

Size/Duplication

Total Lines	477
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	setOriginForm()	0	3	1
A	getWasCreated()	0	29	3
A	getQueueObject()	0	6	2
A	getEmailConfirm()	0	3	1
A	getClosureDate()	0	14	1
A	setEmail()	0	3	1
A	getStatus()	0	3	1
A	generateEmailConfirmationHash()	0	3	1
A	setUserAgent()	0	3	1
A	getForwardedIp()	0	3	1
A	getRevealHash()	0	10	1
A	setReserved()	0	3	1
A	getLastUpdated()	0	21	1
A	getEmailSent()	0	3	1
A	getDate()	0	3	1
A	setQueue()	0	3	1
A	getReserved()	0	3	1
A	getIp()	0	3	1
A	getQueue()	0	3	1
A	getUserAgent()	0	3	1
A	setDomain()	0	3	1
A	setEmailConfirm()	0	3	1
A	setStatus()	0	3	1
A	getEmail()	0	3	1
A	getOriginForm()	0	3	1
A	hasComments()	0	15	2
A	getOriginFormObject()	0	10	3
B	save()	0	68	5
A	setForwardedIp()	0	14	3
A	setName()	0	3	1
A	setIp()	0	3	1
A	getClosureReason()	0	23	2
A	getDomain()	0	3	1
A	setEmailSent()	0	3	2
A	getName()	0	3	1

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\DataObjects;

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

/**
 * 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 $status = RequestStatus::OPEN;
    private $queue;
    private $date;
    private $emailsent = 0;
    private $emailconfirm;
    /** @var int|null */
    private $reserved = null;
    private $useragent;
    private $forwardedip;
    private $hasComments = false;
    private $hasCommentsResolved = false;
    private $originform;
    /** @var int */
    private $domain;

    /**
     * @throws Exception
     * @throws OptimisticLockFailedException
     */
    public function save()
    {
        if ($this->isNew()) {
            // insert
            $statement = $this->dbObject->prepare(<<<SQL
INSERT INTO `request` (
	email, ip, name, status, date, emailsent,
	emailconfirm, reserved, useragent, forwardedip,
    queue, originform, domain
) VALUES (
	:email, :ip, :name, :status, CURRENT_TIMESTAMP(), :emailsent,
	:emailconfirm, :reserved, :useragent, :forwardedip,
    :queue, :originform, :domain
);
SQL
            );
            $statement->bindValue(':email', $this->email);
            $statement->bindValue(':ip', $this->ip);
            $statement->bindValue(':name', $this->name);
            $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);
            $statement->bindValue(':queue', $this->queue);
            $statement->bindValue(':originform', $this->originform);
            $statement->bindValue(':domain', $this->domain);

            if ($statement->execute()) {
                $this->id = (int)$this->dbObject->lastInsertId();
            }
            else {
                throw new Exception($statement->errorInfo());

$statement->errorInfo() of type array is incompatible with the type string expected by parameter $message of Exception::__construct().

            }
        }
        else {
            // update
            $statement = $this->dbObject->prepare(<<<SQL
UPDATE `request` SET
	status = :status,
	emailsent = :emailsent,
	emailconfirm = :emailconfirm,
	reserved = :reserved,
    queue = :queue,
	updateversion = updateversion + 1
WHERE id = :id AND updateversion = :updateversion;
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);
            $statement->bindValue(':queue', $this->queue);

            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
     */
    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;
    }

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

    /**
     * @param int|null $reserved
     */
    public function setReserved($reserved)
    {
        $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)
    {
        // Verify that the XFF chain only contains valid IP addresses, and silently discard anything that isn't.
        
        $xff = explode(',', $forwardedip);

It seems like $forwardedip can also be of type null; however, parameter $string of explode() does only seem to accept string, maybe add an additional type check?

        $valid = array();
        
        foreach ($xff as $ip) {
            $ip = trim($ip);
            if (filter_var($ip, FILTER_VALIDATE_IP)) {
                $valid[] = $ip;
            }
        }
        $this->forwardedip = implode(", ", $valid);
    }

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

        $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.defaultaction, 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();
        $defaultAction = $statement->fetchColumn(0);
        $logAction = $statement->fetchColumn(1);
        $statement->closeCursor();

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

        return $defaultAction === EmailTemplate::ACTION_CREATED;
    }

    /**
     * @return DateTime
     */
    public function getClosureDate()
    {
        $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);
    }

    public function getLastUpdated()
    {
        $logQuery = $this->dbObject->prepare(<<<SQL
SELECT max(d.ts) FROM (
    SELECT r.date AS ts FROM request r WHERE r.id = :requestr
    UNION ALL
    SELECT l.timestamp AS ts FROM log l WHERE l.objectid = :requestl AND l.objecttype = 'Request'
    UNION ALL
    SELECT c.time AS ts FROM comment c WHERE c.request = :requestc
) d
SQL
        );

        $logQuery->bindValue(":requestr", $this->getId());
        $logQuery->bindValue(":requestl", $this->getId());
        $logQuery->bindValue(":requestc", $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?
     *       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);
    }

    /**
     * @return int|null
     */
    public function getQueue() : ?int
    {
        return $this->queue;
    }

    /**
     * @return RequestQueue|null
     */
    public function getQueueObject(): ?RequestQueue
    {
        /** @var RequestQueue $queue */
        $queue = RequestQueue::getById($this->queue, $this->getDatabase());

        return $queue === false ? null : $queue;

The condition $queue === false is always false.

    }

    /**
     * @param int|null $queue
     */
    public function setQueue(?int $queue): void
    {
        $this->queue = $queue;
    }

    /**
     * @return int|null
     */
    public function getOriginForm(): ?int
    {
        return $this->originform;
    }

    public function getOriginFormObject(): ?RequestForm
    {
        if ($this->originform === null) {
            return null;
        }

        /** @var RequestForm|bool $form */
        $form = RequestForm::getById($this->originform, $this->getDatabase());

        return $form === false ? null : $form;

The condition $form === false is always false.

    }

    /**
     * @param int|null $originForm
     */
    public function setOriginForm(?int $originForm): void
    {
        $this->originform = $originForm;
    }

    public function getDomain(): int
    {
        return $this->domain;
    }

    public function setDomain(int $domain): void
    {
        $this->domain = $domain;
    }
}