User::getCacheKey() - Code Metrics - Inspection of "Always user md5 hash of string, int and bool value..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( cc1620...8edd4f )

by MusikAnimal
created 2017-10-29 21:52 UTC
User::getCacheKey() A

↳ Parent: User
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php
/**
 * This file contains only the User class.
 */

namespace Xtools;

use Exception;
use DateTime;

/**
 * A User is a wiki user who has the same username across all projects in an XTools installation.
 */
class User extends Model
{

    /** @var int The user's ID. */
    protected $id;

    /** @var string The user's username. */
    protected $username;

    /** @var DateTime|bool Expiry of the current block of the user. */
    protected $blockExpiry;

    /** @var int Quick cache of edit counts, keyed by project domain. */
    protected $editCounts = [];

    /**
     * Create a new User given a username.
     * @param string $username
     */
    public function __construct($username)
    {
        $this->username = ucfirst(str_replace('_', ' ', trim($username)));
    }

    /**
     * Get the username.
     * @return string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Unique identifier for this User, to be used in cache keys.
     * Use of md5 ensures the cache key does not contain reserved characters.
     * You could also use the ID, but that may require an unnecessary DB query.
     * @see Repository::getCacheKey()
     * @return string
     */
    public function getCacheKey()
    {
        return md5($this->username);
    }

    /**
     * Get the user's ID on the given project.
     * @param Project $project
     * @return int
     */
    public function getId(Project $project)
    {
        return $this->getRepository()->getId($project->getDatabaseName(), $this->getUsername());
        return $this->getRepository()->/** @scrutinizer ignore-call */ getId($project->getDatabaseName(), $this->getUsername());
    }

    /**
     * Get the user's registration date on the given project.
     * @param Project $project
     * @return DateTime|false False if no registration date was found.
     */
    public function getRegistrationDate(Project $project)
    {
        $registrationDate = $this->getRepository()->getRegistrationDate(
        $registrationDate = $this->getRepository()->/** @scrutinizer ignore-call */ getRegistrationDate(
            $project->getDatabaseName(),
            $this->getUsername()
        );

        return DateTime::createFromFormat('YmdHis', $registrationDate);
    }

    /**
     * Get the user's (system) edit count.
     * @param Project $project
     * @return int
     */
    public function getEditCount(Project $project)
    {
        $domain = $project->getDomain();
        if (isset($this->editCounts[$domain])) {
            return $this->editCounts[$domain];
        }

        $this->editCounts[$domain] = (int) $this->getRepository()->getEditCount(
        $this->editCounts[$domain] = (int) $this->getRepository()->/** @scrutinizer ignore-call */ getEditCount(
            $project->getDatabaseName(),
            $this->getUsername()
        );

        return $this->editCounts[$domain];
    }

    /**
     * Maximum number of edits to process, based on configuration.
     * @return int
     */
    public function maxEdits()
    {
        return $this->getRepository()->maxEdits();
        return $this->getRepository()->/** @scrutinizer ignore-call */ maxEdits();
    }

    /**
     * Get a list of this user's groups on the given project.
     * @param Project $project The project.
     * @return string[]
     */
    public function getGroups(Project $project)
    {
        $groupsData = $this->getRepository()->getGroups($project, $this->getUsername());
        $groupsData = $this->getRepository()->/** @scrutinizer ignore-call */ getGroups($project, $this->getUsername());
        $groups = preg_grep('/\*/', $groupsData, PREG_GREP_INVERT);
        sort($groups);
        return $groups;
    }

    /**
     * Get a list of this user's groups on all projects.
     * @param Project $project A project to query; if not provided, the default will be used.
     */
    public function getGlobalGroups(Project $project = null)
    {
        return $this->getRepository()->getGlobalGroups($this->getUsername(), $project);
        return $this->getRepository()->/** @scrutinizer ignore-call */ getGlobalGroups($this->getUsername(), $project);
    }

    /**
     * Does this user exist on the given project.
     * @param Project $project
     * @return bool
     */
    public function existsOnProject(Project $project)
    {
        $id = $this->getId($project);
        return $id > 0;
    }

    /**
     * Is this user an Administrator on the given project?
     * @param Project $project The project.
     * @return bool
     */
    public function isAdmin(Project $project)
    {
        return (false !== array_search('sysop', $this->getGroups($project)));
    }

    /**
     * Is this user an anonymous user (IP)?
     * @return bool
     */
    public function isAnon()
    {
        return (bool) filter_var($this->username, FILTER_VALIDATE_IP);
    }

    /**
     * Get the expiry of the current block on the user
     * @param Project $project The project.
     * @return DateTime|bool Expiry as DateTime, true if indefinite,
     *                       or false if they are not blocked.
     */
    public function getBlockExpiry(Project $project)
    {
        if (isset($this->blockExpiry)) {
            return $this->blockExpiry;
        }

        $expiry = $this->getRepository()->getBlockExpiry(
        $expiry = $this->getRepository()->/** @scrutinizer ignore-call */ getBlockExpiry(
            $project->getDatabaseName(),
            $this->getId($project)
        );

        if ($expiry === 'infinity') {
            $this->blockExpiry = true;
        } elseif ($expiry === false) {
            $this->blockExpiry = false;
        } else {
            $this->blockExpiry = new DateTime($expiry);
        }

        return $this->blockExpiry;
    }

    /**
     * Is this user currently blocked on the given project?
     * @param Project $project The project.
     * @return bool
     */
    public function isBlocked(Project $project)
    {
        return $this->getBlockExpiry($project) !== false;
    }

    /**
     * Does the user have more edits than maximum amount allowed for processing?
     * @param Project $project
     * @return bool
     */
    public function hasTooManyEdits(Project $project)
    {
        $editCount = $this->getEditCount($project);
        return $this->maxEdits() > 0 && $editCount > $this->maxEdits();
    }

    /**
     * Get edit count within given timeframe and namespace
     * @param Project $project
     * @param int|string $namespace Namespace ID or 'all' for all namespaces
     * @param string $start Start date in a format accepted by strtotime()
     * @param string $end End date in a format accepted by strtotime()
     * @return int
     */
    public function countEdits(Project $project, $namespace = 'all', $start = '', $end = '')
    {
        return (int) $this->getRepository()->countEdits($project, $this, $namespace, $start, $end);
        return (int) $this->getRepository()->/** @scrutinizer ignore-call */ countEdits($project, $this, $namespace, $start, $end);
    }

    /**
     * Get the number of edits this user made using semi-automated tools.
     * @param Project $project
     * @param string|int $namespace Namespace ID or 'all'
     * @param string $start Start date in a format accepted by strtotime()
     * @param string $end End date in a format accepted by strtotime()
     * @return int Result of query, see below.
     */
    public function countAutomatedEdits(Project $project, $namespace = 'all', $start = '', $end = '')
    {
        return (int) $this->getRepository()->countAutomatedEdits($project, $this, $namespace, $start, $end);
        return (int) $this->getRepository()->/** @scrutinizer ignore-call */ countAutomatedEdits($project, $this, $namespace, $start, $end);
    }

    /**
     * Get non-automated contributions for this user.
     * @param Project $project
     * @param string|int $namespace Namespace ID or 'all'
     * @param string $start Start date in a format accepted by strtotime()
     * @param string $end End date in a format accepted by strtotime()
     * @param int $offset Used for pagination, offset results by N edits
     * @return array[] Result of query, with columns (string) 'full_page_title' including namespace,
     *   (string) 'page_title', (int) 'page_namespace', (int) 'rev_id', (DateTime) 'timestamp',
     *   (bool) 'minor', (int) 'length', (int) 'length_change', (string) 'comment'
     */
    public function getNonAutomatedEdits(
        Project $project,
        $namespace = 'all',
        $start = '',
        $end = '',
        $offset = 0
    ) {
        $revs = $this->getRepository()->getNonAutomatedEdits(
        $revs = $this->getRepository()->/** @scrutinizer ignore-call */ getNonAutomatedEdits(
            $project,
            $this,
            $namespace,
            $start,
            $end,
            $offset
        );

        $namespaces = $project->getNamespaces();

        return array_map(function ($rev) use ($namespaces) {
            $pageTitle = $rev['page_title'];
            $fullPageTitle = '';

            if ($rev['page_namespace'] !== '0') {
                $fullPageTitle = $namespaces[$rev['page_namespace']] . ":$pageTitle";
            } else {
                $fullPageTitle = $pageTitle;
            }

            return [
                'full_page_title' => $fullPageTitle,
                'page_title' => $pageTitle,
                'page_namespace' => (int) $rev['page_namespace'],
                'rev_id' => (int) $rev['rev_id'],
                'timestamp' => DateTime::createFromFormat('YmdHis', $rev['timestamp']),
                'minor' => (bool) $rev['minor'],
                'length' => (int) $rev['length'],
                'length_change' => (int) $rev['length_change'],
                'comment' => $rev['comment'],
            ];
        }, $revs);
    }

    /**
     * Get counts of known automated tools used by the given user.
     * @param Project $project
     * @param string|int $namespace Namespace ID or 'all'
     * @param string $start Start date in a format accepted by strtotime()
     * @param string $end End date in a format accepted by strtotime()
     * @return string[] Each tool that they used along with the count and link:
     *                  [
     *                      'Twinkle' => [
     *                          'count' => 50,
     *                          'link' => 'Wikipedia:Twinkle',
     *                      ],
     *                  ]
     */
    public function getAutomatedCounts(Project $project, $namespace = 'all', $start = '', $end = '')
    {
        return $this->getRepository()->getAutomatedCounts($project, $this, $namespace, $start, $end);
        return $this->getRepository()->/** @scrutinizer ignore-call */ getAutomatedCounts($project, $this, $namespace, $start, $end);
    }

    /**
     * Is this user the same as the current XTools user?
     * @return bool
     */
    public function isCurrentlyLoggedIn()
    {
        try {
            $ident = $this->getRepository()->getXtoolsUserInfo();
            $ident = $this->getRepository()->/** @scrutinizer ignore-call */ getXtoolsUserInfo();
        } catch (Exception $exception) {
            return false;
        }
        return isset($ident->username) && $ident->username === $this->getUsername();
    }
}

x-tools / xtools

Push — master ( cc1620...8edd4f )

User::getCacheKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
