Ban::addBan() - Code Metrics - Inspection of "Fix some warnings generated by static code analysi..." - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c26f0f...c7af1e )

by Konstantinos

created 2016-08-28 14:36 UTC

Ban::addBan() B

↳ Parent: Ban

Complexity

Conditions	6
Paths	8

Size

Total Lines	34
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	22
CRAP Score	6.0208

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	34
ccs	22
cts	24
cp	0.9167
rs	8.439
cc	6
eloc	22
nc	8
nop	7
crap	6.0208

<?php
/**
 * This file contains functionality relating to the banned league players
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A ban imposed by an admin on a player
 * @package BZiON\Models
 */
class Ban extends UrlModel implements NamedModel
{
    /**
     * The id of the banned player
     * @var int
     */
    protected $player;

    /**
     * The ban expiration date
     * @var TimeDate
     */
    protected $expiration;

    /**
     * The message that will appear when a player is denied connecting to a game server
     * @var string
     */
    protected $srvmsg;

    /**
     * The ban reason
     * @var string
     */
    protected $reason;

    /**
     * Whether or not a player is allowed to join a server when they are banned
     * @var bool
     */
    protected $allowServerJoin;

    /**
     * The ban creation date
     * @var TimeDate
     */
    protected $created;

    /**
     * The date the ban was last updated
     * @var TimeDate
     */
    protected $updated;

    /**
     * The id of the ban author
     * @var int
     */
    protected $author;

    /**
     * The IP of the banned player if the league would like to implement a global ban list
     * @var string[]
     */
    protected $ipAddresses;

    /**
     * The ban's status
     * @var string
     */
    protected $status;

    /**
     * The name of the database table used for queries
     */
    const TABLE = "bans";

    const CREATE_PERMISSION = Permission::ADD_BAN;
    const EDIT_PERMISSION = Permission::EDIT_BAN;
    const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_BAN;
    const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_BAN;

    /**
     * {@inheritdoc}
     */
    protected function assignResult($ban)
    {
        $this->player = $ban['player'];
        $this->expiration = ($ban['expiration'] === null)
                          ? null
                          : TimeDate::fromMysql($ban['expiration']);
        $this->srvmsg = $ban['server_message'];
        $this->reason = $ban['reason'];
        $this->allowServerJoin = $ban['allow_server_join'];
        $this->created = TimeDate::fromMysql($ban['created']);
        $this->updated = TimeDate::fromMysql($ban['updated']);
        $this->author = $ban['author'];
        $this->status = $ban['status'];
    }

    /**
     * {@inheritdoc}
     */
    protected function assignLazyResult($result)
    {
        $this->ipAddresses = self::fetchIds("WHERE ban_id = ?", array($this->getId()), "banned_ips", "ip_address");

    }

    /**
     * Add an IP to the ban
     *
     * @param string $ipAddress The IP to add to a ban
     */
    public function addIP($ipAddress)

    {
        $this->lazyLoad();

        $this->ipAddresses[] = $ipAddress;
        $this->db->execute("INSERT IGNORE INTO banned_ips (id, ban_id, ip_address) VALUES (NULL, ?, ?)", array($this->getId(), $ipAddress));
    }

    /**
     * Remove an IP from the ban
     *
     * @param string $ipAddress The IP to remove from the ban
     */
    public function removeIP($ipAddress)

    {
        $this->lazyLoad();

        // Remove $ipAddress from $this->ipAddresses
        $this->ipAddresses = array_diff($this->ipAddresses, array($ipAddress));
        $this->db->execute("DELETE FROM banned_ips WHERE ban_id = ? AND ip_address = ?", array($this->getId(), $ipAddress));
    }

    /**
     * Set the IP addresses of the ban
     *
     * @todo   Is it worth making this faster?
     * @param  string[] $ipAddresses The new IP addresses of the ban
     * @return self
     */
    public function setIPs($ipAddresses)
    {
        $this->lazyLoad();

        $oldIPs = $this->ipAddresses;
        $this->ipAddresses = $ipAddresses;

        $newIPs     = array_diff($ipAddresses, $oldIPs);
        $removedIPs = array_diff($oldIPs, $ipAddresses);

        foreach ($newIPs as $ip) {
            $this->addIP($ip);
        }

        foreach ($removedIPs as $ip) {
            $this->removeIP($ip);
        }

        return $this;
    }

    /**
     * Check whether or not a player is allowed to join a server when they've been banned
     * @return bool Whether or not a player is allowed to join
     */
    public function allowedServerJoin()
    {
        return $this->allowServerJoin;
    }

    /**
     * Get the user who imposed the ban
     * @return Player The banner
     */
    public function getAuthor()
    {
        return Player::get($this->author);
    }

    /**
     * Get the creation time of the ban
     * @return TimeDate The creation time
     */
    public function getCreated()
    {
        return $this->created->copy();
    }

    /**
     * Get the expiration time of the ban
     * @return TimeDate
     */
    public function getExpiration()
    {
        return $this->expiration->copy();
    }

    /**
     * Get the ban's description
     * @return string
     */
    public function getReason()
    {
        return $this->reason;
    }

    /**
     * Get the ban summary that will appear when a player is denied access to a league server on join
     * @return string The ban summary
     */
    public function getServerMessage()
    {
        if ($this->allowedServerJoin()) {
            return '';
        }

        return $this->srvmsg;
    }

    /**
     * Get the IP address of the banned player
     * @return string[]
     */
    public function getIpAddresses()
    {
        $this->lazyLoad();

        return $this->ipAddresses;
    }

    /**
     * Get the time when the ban was last updated
     * @return TimeDate
     */
    public function getUpdated()
    {
        return $this->updated->copy();
    }

    /**
     * Get the player who was banned
     * @return Player The banned player
     */
    public function getVictim()
    {
        return Player::get($this->player);
    }

    /**
     * Get the ID of the player who was banned
     * @return int The ID of the victim of the ban
     */
    public function getVictimID()
    {
        return $this->player;
    }

    /**
     * Calculate whether a ban has expired or not.
     *
     * @return bool True if the ban's expiration time has already passed
     */
    public function isExpired()
    {
        if ($this->expiration === null) {
            return false;
        }

        return TimeDate::now()->gte($this->expiration);
    }

    /**
     * Check whether the ban will expire automatically
     *
     * @return bool
     */
    public function willExpire()
    {
        return $this->expiration !== null;
    }

    /**
     * Mark the ban as expired
     *
     * @return self
     */
    public function expire()
    {
        $this->setExpiration(TimeDate::now());
        $this->getVictim()->markAsUnbanned();

        return $this;
    }

    /**
     * Set the expiration date of the ban
     * @param  TimeDate $expiration The expiration
     * @return self
     */
    public function setExpiration($expiration)
    {
        if ($expiration !== null) {
            $expiration = TimeDate::from($expiration);
        }

        return $this->updateProperty($this->expiration, 'expiration', $expiration);
    }

    /**
     * Set the server message of the ban
     * @param  string $message The new server message
     * @return self
     */
    public function setServerMessage($message)
    {
        return $this->updateProperty($this->srvmsg, 'server_message', $message);
    }

    /**
     * Set the reason of the ban
     * @param  string $reason The new ban reason
     * @return self
     */
    public function setReason($reason)
    {
        return $this->updateProperty($this->reason, 'reason', $reason);
    }

    /**
     * Update the last edit timestamp
     * @return self
     */
    public function updateEditTimestamp()
    {
        return $this->updateProperty($this->updated, "updated", TimeDate::now());
    }

    /**
     * Set whether the ban's victim is allowed to enter a match server
     * @param  bool $allowServerJoin
     * @return self
     */
    public function setAllowServerJoin($allowServerJoin)
    {
        return $this->updateProperty($this->allowServerJoin, 'allow_server_join', (bool) $allowServerJoin);
    }

    /**
     * Add a new ban
     *
     * @param int         $playerID        The ID of the victim of the ban
     * @param int         $authorID        The ID of the player responsible for the ban
     * @param mixed|null $expiration      The expiration of the ban (set to NULL so that it never expires)
     * @param string      $reason          The full reason for the ban
     * @param string      $srvmsg          A summary of the ban to be displayed on server banlists (max 150 characters)
     * @param string[]    $ipAddresses     An array of IPs that have been banned
     * @param bool        $allowServerJoin Whether or not the player is allowed to join match servers
     *
     * @return Ban An object representing the ban that was just entered or false if the ban was not created
     */
    public static function addBan($playerID, $authorID, $expiration, $reason, $srvmsg = "", $ipAddresses = array(), $allowServerJoin = false)
    {
        $player = Player::get($playerID);

        if ($expiration !== null) {
            $expiration = TimeDate::from($expiration)->toMysql();
        } else {
            $player->markAsBanned();
        }

        // If there are no IPs to banned or no server ban message, then we'll allow the players to join as observers
        if (empty($srvmsg) || empty($ipAddresses)) {
            $allowServerJoin = true;
        }

        $ban = self::create(array(
            'player'            => $playerID,
            'expiration'        => $expiration,
            'server_message'    => $srvmsg,
            'reason'            => $reason,
            'allow_server_join' => $allowServerJoin,
            'author'            => $authorID,
        ), array('created', 'updated'));

        if (is_array($ipAddresses)) {
            foreach ($ipAddresses as $ip) {
                $ban->addIP($ip);
            }
        } else {
            $ban->addIP($ipAddresses);
        }

        return $ban;
    }

    /**
     * Get a query builder for news
     * @return QueryBuilder
     */
    public static function getQueryBuilder()
    {
        return new QueryBuilder('Ban', array(
            'columns' => array(
                'status'  => 'status',
                'updated' => 'updated'
            ),
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'Ban against ' . $this->getVictim()->getUsername();
    }

    /**
     * {@inheritdoc}
     */
    public function delete()
    {
        $this->getVictim()->markAsUnbanned();
        parent::delete();
    }

    /**
     * {@inheritdoc}
     */
    public static function getActiveStatuses()
    {
        return array('public');
    }

    /**
     * {@inheritdoc}
     */
    public static function getLazyColumns()
    {
        return null;
    }

    /**
     * Get all the bans in the database that aren't disabled or deleted
     * @return Ban[] An array of ban objects
     */
    public static function getBans()
    {
        return self::arrayIdToModel(self::fetchIds("ORDER BY updated DESC"));
    }

    /**
     * Get an active ban for the player
     * @param  int      $playerId The player's ID
     * @return Ban|null null if the player isn't currently banned
     */
    public static function getBan($playerId)
    {
        $bans = self::fetchIdsFrom('player', array($playerId), false, "AND (expiration IS NULL OR expiration > UTC_TIMESTAMP())");

        if (empty($bans)) {
            return null;
        }

        return self::get($bans[0]);
    }
}


1			<?php
2			/**
3			* This file contains functionality relating to the banned league players
4			*
5			* @package BZiON\Models
6			* @license https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
7			*/
8
9			/**
10			* A ban imposed by an admin on a player
11			* @package BZiON\Models
12			*/
13			class Ban extends UrlModel implements NamedModel
14			{
15			/**
16			* The id of the banned player
17			* @var int
18			*/
19			protected $player;
20
21			/**
22			* The ban expiration date
23			* @var TimeDate
24			*/
25			protected $expiration;
26
27			/**
28			* The message that will appear when a player is denied connecting to a game server
29			* @var string
30			*/
31			protected $srvmsg;
32
33			/**
34			* The ban reason
35			* @var string
36			*/
37			protected $reason;
38
39			/**
40			* Whether or not a player is allowed to join a server when they are banned
41			* @var bool
42			*/
43			protected $allowServerJoin;
44
45			/**
46			* The ban creation date
47			* @var TimeDate
48			*/
49			protected $created;
50
51			/**
52			* The date the ban was last updated
53			* @var TimeDate
54			*/
55			protected $updated;
56
57			/**
58			* The id of the ban author
59			* @var int
60			*/
61			protected $author;
62
63			/**
64			* The IP of the banned player if the league would like to implement a global ban list
65			* @var string[]
66			*/
67			protected $ipAddresses;
68
69			/**
70			* The ban's status
71			* @var string
72			*/
73			protected $status;
74
75			/**
76			* The name of the database table used for queries
77			*/
78			const TABLE = "bans";
79
80			const CREATE_PERMISSION = Permission::ADD_BAN;
81			const EDIT_PERMISSION = Permission::EDIT_BAN;
82			const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_BAN;
83			const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_BAN;
84
85			/**
86			* {@inheritdoc}
87			*/
88	2		protected function assignResult($ban)
89			{
90	2		$this->player = $ban['player'];
91	2		$this->expiration = ($ban['expiration'] === null)
92	2		? null
93	2		: TimeDate::fromMysql($ban['expiration']);
94	2		$this->srvmsg = $ban['server_message'];
95	2		$this->reason = $ban['reason'];
96	2		$this->allowServerJoin = $ban['allow_server_join'];
97	2		$this->created = TimeDate::fromMysql($ban['created']);
98	2		$this->updated = TimeDate::fromMysql($ban['updated']);
99	2		$this->author = $ban['author'];
100	2		$this->status = $ban['status'];
101	2		}
102
103			/**
104			* {@inheritdoc}
105			*/
106			protected function assignLazyResult($result)
107			{
108			$this->ipAddresses = self::fetchIds("WHERE ban_id = ?", array($this->getId()), "banned_ips", "ip_address");
			0 ignored issues – show Documentation Bug introduced 2016-08-28 14:54 UTC by Report Bug Copy Issue Report It seems like `self::fetchIds('WHERE ba...ned_ips', 'ip_address')` of type `array<integer,integer>` is incompatible with the declared type `array<integer,string>` of property `$ipAddresses`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
109			}
110
111			/**
112			* Add an IP to the ban
113			*
114			* @param string $ipAddress The IP to add to a ban
115			*/
116		View Code Duplication	public function addIP($ipAddress)
			0 ignored issues – show Duplication introduced 2015-12-02 06:58 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117			{
118			$this->lazyLoad();
119
120			$this->ipAddresses[] = $ipAddress;
121			$this->db->execute("INSERT IGNORE INTO banned_ips (id, ban_id, ip_address) VALUES (NULL, ?, ?)", array($this->getId(), $ipAddress));
122			}
123
124			/**
125			* Remove an IP from the ban
126			*
127			* @param string $ipAddress The IP to remove from the ban
128			*/
129		View Code Duplication	public function removeIP($ipAddress)
			0 ignored issues – show Duplication introduced 2015-12-02 06:58 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
130			{
131			$this->lazyLoad();
132
133			// Remove $ipAddress from $this->ipAddresses
134			$this->ipAddresses = array_diff($this->ipAddresses, array($ipAddress));
135			$this->db->execute("DELETE FROM banned_ips WHERE ban_id = ? AND ip_address = ?", array($this->getId(), $ipAddress));
136			}
137
138			/**
139			* Set the IP addresses of the ban
140			*
141			* @todo Is it worth making this faster?
142			* @param string[] $ipAddresses The new IP addresses of the ban
143			* @return self
144			*/
145			public function setIPs($ipAddresses)
146			{
147			$this->lazyLoad();
148
149			$oldIPs = $this->ipAddresses;
150			$this->ipAddresses = $ipAddresses;
151
152			$newIPs = array_diff($ipAddresses, $oldIPs);
153			$removedIPs = array_diff($oldIPs, $ipAddresses);
154
155			foreach ($newIPs as $ip) {
156			$this->addIP($ip);
157			}
158
159			foreach ($removedIPs as $ip) {
160			$this->removeIP($ip);
161			}
162
163			return $this;
164			}
165
166			/**
167			* Check whether or not a player is allowed to join a server when they've been banned
168			* @return bool Whether or not a player is allowed to join
169			*/
170			public function allowedServerJoin()
171			{
172			return $this->allowServerJoin;
173			}
174
175			/**
176			* Get the user who imposed the ban
177			* @return Player The banner
178			*/
179			public function getAuthor()
180			{
181			return Player::get($this->author);
182			}
183
184			/**
185			* Get the creation time of the ban
186			* @return TimeDate The creation time
187			*/
188			public function getCreated()
189			{
190			return $this->created->copy();
191			}
192
193			/**
194			* Get the expiration time of the ban
195			* @return TimeDate
196			*/
197			public function getExpiration()
198			{
199			return $this->expiration->copy();
200			}
201
202			/**
203			* Get the ban's description
204			* @return string
205			*/
206			public function getReason()
207			{
208			return $this->reason;
209			}
210
211			/**
212			* Get the ban summary that will appear when a player is denied access to a league server on join
213			* @return string The ban summary
214			*/
215			public function getServerMessage()
216			{
217			if ($this->allowedServerJoin()) {
218			return '';
219			}
220
221			return $this->srvmsg;
222			}
223
224			/**
225			* Get the IP address of the banned player
226			* @return string[]
227			*/
228			public function getIpAddresses()
229			{
230			$this->lazyLoad();
231
232			return $this->ipAddresses;
233			}
234
235			/**
236			* Get the time when the ban was last updated
237			* @return TimeDate
238			*/
239			public function getUpdated()
240			{
241			return $this->updated->copy();
242			}
243
244			/**
245			* Get the player who was banned
246			* @return Player The banned player
247			*/
248			public function getVictim()
249			{
250			return Player::get($this->player);
251			}
252
253			/**
254			* Get the ID of the player who was banned
255			* @return int The ID of the victim of the ban
256			*/
257			public function getVictimID()
258			{
259			return $this->player;
260			}
261
262			/**
263			* Calculate whether a ban has expired or not.
264			*
265			* @return bool True if the ban's expiration time has already passed
266			*/
267			public function isExpired()
268			{
269			if ($this->expiration === null) {
270			return false;
271			}
272
273			return TimeDate::now()->gte($this->expiration);
274			}
275
276			/**
277			* Check whether the ban will expire automatically
278			*
279			* @return bool
280			*/
281			public function willExpire()
282			{
283			return $this->expiration !== null;
284			}
285
286			/**
287			* Mark the ban as expired
288			*
289			* @return self
290			*/
291			public function expire()
292			{
293			$this->setExpiration(TimeDate::now());
294			$this->getVictim()->markAsUnbanned();
295
296			return $this;
297			}
298
299			/**
300			* Set the expiration date of the ban
301			* @param TimeDate $expiration The expiration
302			* @return self
303			*/
304	1		public function setExpiration($expiration)
305			{
306	1		if ($expiration !== null) {
307	1		$expiration = TimeDate::from($expiration);
308	1		}
309
310	1		return $this->updateProperty($this->expiration, 'expiration', $expiration);
311			}
312
313			/**
314			* Set the server message of the ban
315			* @param string $message The new server message
316			* @return self
317			*/
318			public function setServerMessage($message)
319			{
320			return $this->updateProperty($this->srvmsg, 'server_message', $message);
321			}
322
323			/**
324			* Set the reason of the ban
325			* @param string $reason The new ban reason
326			* @return self
327			*/
328			public function setReason($reason)
329			{
330			return $this->updateProperty($this->reason, 'reason', $reason);
331			}
332
333			/**
334			* Update the last edit timestamp
335			* @return self
336			*/
337			public function updateEditTimestamp()
338			{
339			return $this->updateProperty($this->updated, "updated", TimeDate::now());
340			}
341
342			/**
343			* Set whether the ban's victim is allowed to enter a match server
344			* @param bool $allowServerJoin
345			* @return self
346			*/
347			public function setAllowServerJoin($allowServerJoin)
348			{
349			return $this->updateProperty($this->allowServerJoin, 'allow_server_join', (bool) $allowServerJoin);
350			}
351
352			/**
353			* Add a new ban
354			*
355			* @param int $playerID The ID of the victim of the ban
356			* @param int $authorID The ID of the player responsible for the ban
357			* @param mixed\|null $expiration The expiration of the ban (set to NULL so that it never expires)
358			* @param string $reason The full reason for the ban
359			* @param string $srvmsg A summary of the ban to be displayed on server banlists (max 150 characters)
360			* @param string[] $ipAddresses An array of IPs that have been banned
361			* @param bool $allowServerJoin Whether or not the player is allowed to join match servers
362			*
363			* @return Ban An object representing the ban that was just entered or false if the ban was not created
364			*/
365	2		public static function addBan($playerID, $authorID, $expiration, $reason, $srvmsg = "", $ipAddresses = array(), $allowServerJoin = false)
366			{
367	2		$player = Player::get($playerID);
368
369	2		if ($expiration !== null) {
370	1		$expiration = TimeDate::from($expiration)->toMysql();
371	1		} else {
372	1		$player->markAsBanned();
373			}
374
375			// If there are no IPs to banned or no server ban message, then we'll allow the players to join as observers
376	2		if (empty($srvmsg) \|\| empty($ipAddresses)) {
377	2		$allowServerJoin = true;
378	2		}
379
380	2		$ban = self::create(array(
381	2		'player' => $playerID,
382	2		'expiration' => $expiration,
383	2		'server_message' => $srvmsg,
384	2		'reason' => $reason,
385	2		'allow_server_join' => $allowServerJoin,
386	2		'author' => $authorID,
387	2		), array('created', 'updated'));
388
389	2		if (is_array($ipAddresses)) {
390	2		foreach ($ipAddresses as $ip) {
391			$ban->addIP($ip);
392	2		}
393	2		} else {
394			$ban->addIP($ipAddresses);
395			}
396
397	2		return $ban;
398			}
399
400			/**
401			* Get a query builder for news
402			* @return QueryBuilder
403			*/
404			public static function getQueryBuilder()
405			{
406			return new QueryBuilder('Ban', array(
407			'columns' => array(
408			'status' => 'status',
409			'updated' => 'updated'
410			),
411			));
412			}
413
414			/**
415			* {@inheritdoc}
416			*/
417			public function getName()
418			{
419			return 'Ban against ' . $this->getVictim()->getUsername();
420			}
421
422			/**
423			* {@inheritdoc}
424			*/
425			public function delete()
426			{
427			$this->getVictim()->markAsUnbanned();
428			parent::delete();
429			}
430
431			/**
432			* {@inheritdoc}
433			*/
434			public static function getActiveStatuses()
435			{
436			return array('public');
437			}
438
439			/**
440			* {@inheritdoc}
441			*/
442			public static function getLazyColumns()
443			{
444			return null;
445			}
446
447			/**
448			* Get all the bans in the database that aren't disabled or deleted
449			* @return Ban[] An array of ban objects
450			*/
451			public static function getBans()
452			{
453			return self::arrayIdToModel(self::fetchIds("ORDER BY updated DESC"));
454			}
455
456			/**
457			* Get an active ban for the player
458			* @param int $playerId The player's ID
459			* @return Ban\|null null if the player isn't currently banned
460			*/
461	38		public static function getBan($playerId)
462			{
463	38		$bans = self::fetchIdsFrom('player', array($playerId), false, "AND (expiration IS NULL OR expiration > UTC_TIMESTAMP())");
464
465	38		if (empty($bans)) {
466	38		return null;
467			}
468
469	2		return self::get($bans[0]);
470			}
471			}
472

allejo / bzion

Push — master ( c26f0f...c7af1e )

Ban::addBan() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like