LogRepository::failedOften() - Code Metrics - Inspection of "Logs folder must exist" - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3ff92e...9fb27f )

by Adrien

created 2019-04-02 05:15 UTC

LogRepository::failedOften() A

↳ Parent: LogRepository

Complexity

Conditions	4
Paths	6

Size

Total Lines	32
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	4.0119

Importance

Changes

Metric	Value
cc	4
eloc	22
nc	6
nop	2
dl	0
loc	32
ccs	20
cts	22
cp	0.9091
crap	4.0119
rs	9.568
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Application\Repository;

use Cake\Chronos\Chronos;
use Doctrine\DBAL\Connection;
use Zend\Log\Logger;

class LogRepository extends AbstractRepository
{
    /**
     * Log message to be used when user log in
     */
    const LOGIN = 'login';

    /**
     * Log message to be used when user cannot log in
     */
    const LOGIN_FAILED = 'login failed';

    /**
     * Log message to be used when user change his password
     */
    const UPDATE_PASSWORD = 'update password';

    /**
     * Log message to be used when user cannot change his password
     */
    const UPDATE_PASSWORD_FAILED = 'update password failed';

    /**
     * This should NOT be called directly, instead use `_log()` to log stuff
     *
     * @param array $event
     */
    public function log(array $event): void
    {
        $event['creation_date'] = Chronos::instance($event['creation_date'])->toIso8601String();
        $event['extra'] = json_encode($event['extra']);

        $this->getEntityManager()->getConnection()->insert('log', $event);
    }

    /**
     * Returns whether the current IP often failed to login
     *
     * @return bool
     */
    public function loginFailedOften(): bool
    {
        return $this->failedOften(self::LOGIN, self::LOGIN_FAILED);
    }

    public function updatePasswordFailedOften(): bool
    {
        return $this->failedOften(self::UPDATE_PASSWORD, self::UPDATE_PASSWORD_FAILED);
    }

    private function failedOften(string $success, string $failed): bool
    {
        if (PHP_SAPI === 'cli') {
            $ip = 'script';
        } else {
            $ip = $_SERVER['REMOTE_ADDR'] ?? '';
        }

        $select = $this->getEntityManager()->getConnection()->createQueryBuilder()
            ->select('message')
            ->from('log')
            ->andWhere('priority = :priority')
            ->setParameter('priority', Logger::INFO)
            ->andWhere('message IN (:message)')
            ->setParameter('message', [$success, $failed], Connection::PARAM_STR_ARRAY)
            ->andWhere('creation_date > DATE_SUB(NOW(), INTERVAL 30 MINUTE)')
            ->andWhere('ip = :ip')
            ->setParameter('ip', $ip)
            ->orderBy('id', 'DESC');

        $events = $select->execute()->fetchAll(\PDO::FETCH_COLUMN);

        // Goes from present to past and count failure, until the last time we succeeded logging in
        $failureCount = 0;
        foreach ($events as $event) {
            if ($event === $success) {
                break;
            }
            ++$failureCount;
        }

        return $failureCount > 5;
    }

    /**
     * Delete log entries which are errors/warnings and older than one month
     * We always keep Logger::INFO level because we use it for statistics
     *
     * @return int the count deleted logs
     */
    public function deleteOldLogs(): int
    {
        $connection = $this->getEntityManager()->getConnection();
        $query = $connection->createQueryBuilder()
            ->delete('log')
            ->andWhere('log.priority != :priority OR message = :message')
            ->setParameter('priority', Logger::INFO)
            ->setParameter('message', self::LOGIN_FAILED)
            ->andWhere('log.creation_date < DATE_SUB(NOW(), INTERVAL 1 MONTH)');

        $connection->query('LOCK TABLES `log` WRITE;');
        $count = $query->execute();
        $connection->query('UNLOCK TABLES;');

        return $count;

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Application\Repository;
6
7		use Cake\Chronos\Chronos;
8		use Doctrine\DBAL\Connection;
9		use Zend\Log\Logger;
10
11		class LogRepository extends AbstractRepository
12		{
13		/**
14		* Log message to be used when user log in
15		*/
16		const LOGIN = 'login';
17
18		/**
19		* Log message to be used when user cannot log in
20		*/
21		const LOGIN_FAILED = 'login failed';
22
23		/**
24		* Log message to be used when user change his password
25		*/
26		const UPDATE_PASSWORD = 'update password';
27
28		/**
29		* Log message to be used when user cannot change his password
30		*/
31		const UPDATE_PASSWORD_FAILED = 'update password failed';
32
33		/**
34		* This should NOT be called directly, instead use `_log()` to log stuff
35		*
36		* @param array $event
37		*/
38	5	public function log(array $event): void
39		{
40	5	$event['creation_date'] = Chronos::instance($event['creation_date'])->toIso8601String();
41	5	$event['extra'] = json_encode($event['extra']);
42
43	5	$this->getEntityManager()->getConnection()->insert('log', $event);
44	5	}
45
46		/**
47		* Returns whether the current IP often failed to login
48		*
49		* @return bool
50		*/
51	2	public function loginFailedOften(): bool
52		{
53	2	return $this->failedOften(self::LOGIN, self::LOGIN_FAILED);
54		}
55
56	3	public function updatePasswordFailedOften(): bool
57		{
58	3	return $this->failedOften(self::UPDATE_PASSWORD, self::UPDATE_PASSWORD_FAILED);
59		}
60
61	5	private function failedOften(string $success, string $failed): bool
62		{
63	5	if (PHP_SAPI === 'cli') {
64	5	$ip = 'script';
65		} else {
66		$ip = $_SERVER['REMOTE_ADDR'] ?? '';
67		}
68
69	5	$select = $this->getEntityManager()->getConnection()->createQueryBuilder()
70	5	->select('message')
71	5	->from('log')
72	5	->andWhere('priority = :priority')
73	5	->setParameter('priority', Logger::INFO)
74	5	->andWhere('message IN (:message)')
75	5	->setParameter('message', [$success, $failed], Connection::PARAM_STR_ARRAY)
76	5	->andWhere('creation_date > DATE_SUB(NOW(), INTERVAL 30 MINUTE)')
77	5	->andWhere('ip = :ip')
78	5	->setParameter('ip', $ip)
79	5	->orderBy('id', 'DESC');
80
81	5	$events = $select->execute()->fetchAll(\PDO::FETCH_COLUMN);
82
83		// Goes from present to past and count failure, until the last time we succeeded logging in
84	5	$failureCount = 0;
85	5	foreach ($events as $event) {
86	2	if ($event === $success) {
87		break;
88		}
89	2	++$failureCount;
90		}
91
92	5	return $failureCount > 5;
93		}
94
95		/**
96		* Delete log entries which are errors/warnings and older than one month
97		* We always keep Logger::INFO level because we use it for statistics
98		*
99		* @return int the count deleted logs
100		*/
101	1	public function deleteOldLogs(): int
102		{
103	1	$connection = $this->getEntityManager()->getConnection();
104	1	$query = $connection->createQueryBuilder()
105	1	->delete('log')
106	1	->andWhere('log.priority != :priority OR message = :message')
107	1	->setParameter('priority', Logger::INFO)
108	1	->setParameter('message', self::LOGIN_FAILED)
109	1	->andWhere('log.creation_date < DATE_SUB(NOW(), INTERVAL 1 MONTH)');
110
111	1	$connection->query('LOCK TABLES `log` WRITE;');
112	1	$count = $query->execute();
113	1	$connection->query('UNLOCK TABLES;');
114
115	1	return $count;
		1 ignored issue – show Bug Best Practice introduced 2019-04-01 08:35 UTC by Report Bug Copy Issue Report The expression `return $count` could return the type `Doctrine\DBAL\Driver\Statement` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
116		}
117		}
118

Ecodev / my-ichtus

Push — master ( 3ff92e...9fb27f )

LogRepository::failedOften() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like