Waca\DataObjects\Ban

Complexity

Total Complexity

26

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

17.71%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getType()	0	4	1
A	setType()	0	4	1
A	getTarget()	0	4	1
A	setTarget()	0	4	1
A	setReason()	0	4	1
A	getDate()	0	4	1
A	getDuration()	0	4	1
A	setDuration()	0	4	1
A	setActive()	0	4	2
B	getActiveBans()	0	26	3
A	getActiveId()	0	20	2
B	save()	0	50	5
A	getReason()	0	4	1
A	isActive()	0	4	1
A	getUser()	0	4	1
A	setUser()	0	4	1
A	getBanByTarget()	0	23	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\DataObjects;

use Exception;
use PDO;
use Waca\DataObject;
use Waca\Exceptions\OptimisticLockFailedException;
use Waca\PdoDatabase;

/**
 * Ban data object
 */
class Ban extends DataObject
{
    private $type;
    private $target;
    private $user;
    private $reason;
    private $date;
    private $duration;
    private $active;

    /**
     * Gets all active bans, filtered by the optional target.
     *
     * @param string|null $target
     * @param PdoDatabase $database
     *
     * @return Ban[]
     */
    public static function getActiveBans($target, PdoDatabase $database)
    {
        if ($target !== null) {
            $query = <<<SQL
SELECT * FROM ban WHERE target = :target AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
SQL;
            $statement = $database->prepare($query);
            $statement->bindValue(":target", $target);
        }
        else {
            $query = "SELECT * FROM ban WHERE (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;";
            $statement = $database->prepare($query);
        }

        $statement->execute();

        $result = array();

        /** @var Ban $v */
        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
            $v->setDatabase($database);
            $result[] = $v;
        }

        return $result;
    }

    /**
     * Gets a ban by it's ID if it's currently active.
     *
     * @param     integer $id
     * @param PdoDatabase $database
     *
     * @return Ban
     */
    public static function getActiveId($id, PdoDatabase $database)
    {
        $statement = $database->prepare(<<<SQL
SELECT *
FROM ban
WHERE id = :id  AND (duration > UNIX_TIMESTAMP() OR duration = -1) AND active = 1;
SQL
        );
        $statement->bindValue(":id", $id);

        $statement->execute();

        $resultObject = $statement->fetchObject(get_called_class());

        if ($resultObject != false) {
            $resultObject->setDatabase($database);
        }

        return $resultObject;
    }

    /**
     * Get all active bans for a target and type.
     *
     * @param string      $target
     * @param string      $type
     * @param PdoDatabase $database
     *
     * @return Ban
     */
    public static function getBanByTarget($target, $type, PdoDatabase $database)
    {
        $query = <<<SQL
SELECT * FROM ban
WHERE type = :type
	AND target = :target
	AND (duration > UNIX_TIMESTAMP() OR duration = -1)
	AND active = 1;
SQL;
        $statement = $database->prepare($query);
        $statement->bindValue(":target", $target);
        $statement->bindValue(":type", $type);

        $statement->execute();

        $resultObject = $statement->fetchObject(get_called_class());

        if ($resultObject != false) {
            $resultObject->setDatabase($database);
        }

        return $resultObject;
    }

    /**
     * @throws Exception
     */
    public function save()
    {
        if ($this->isNew()) {
            // insert
            $statement = $this->dbObject->prepare(<<<SQL
INSERT INTO `ban` (type, target, user, reason, date, duration, active)
VALUES (:type, :target, :user, :reason, CURRENT_TIMESTAMP(), :duration, :active);
SQL
            );
            $statement->bindValue(":type", $this->type);
            $statement->bindValue(":target", $this->target);
            $statement->bindValue(":user", $this->user);
            $statement->bindValue(":reason", $this->reason);
            $statement->bindValue(":duration", $this->duration);
            $statement->bindValue(":active", $this->active);

            if ($statement->execute()) {
                $this->id = (int)$this->dbObject->lastInsertId();
            }
            else {
                throw new Exception($statement->errorInfo());
            }
        }
        else {
            // update
            $statement = $this->dbObject->prepare(<<<SQL
UPDATE `ban`
SET duration = :duration, active = :active, user = :user, updateversion = updateversion + 1
WHERE id = :id AND updateversion = :updateversion
LIMIT 1;
SQL
            );
            $statement->bindValue(':id', $this->id);
            $statement->bindValue(':updateversion', $this->updateversion);

            $statement->bindValue(':duration', $this->duration);
            $statement->bindValue(':active', $this->active);
            $statement->bindValue(':user', $this->user);

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

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

            $this->updateversion++;
        }
    }

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

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

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

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

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

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

    /**
     * @return mixed
     */
    public function getDate()
    {
        return $this->date;
    }

    /**
     * @return mixed
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * @param mixed $duration
     */
    public function setDuration($duration)
    {
        $this->duration = $duration;
    }

    /**
     * @return bool
     */
    public function isActive()
    {
        return $this->active == 1;
    }

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

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

    /**
     * @param int $user UserID of user who is setting the ban
     *
     * @throws Exception
     */
    public function setUser($user)
    {
        $this->user = $user;
    }
}