nystudio107 / craft-retour

src/services/Statistics.php

<?php
/**
 * Retour plugin for Craft CMS
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\retour\services;

use Craft;
use craft\base\Component;
use craft\db\Query;
use craft\helpers\Db;
use craft\helpers\UrlHelper;
use DateTime;
use nystudio107\retour\helpers\Text as TextHelper;
use nystudio107\retour\models\Stats as StatsModel;
use nystudio107\retour\Retour;
use yii\db\Exception;

/** @noinspection MissingPropertyAnnotationsInspection */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

Missing short description in doc comment

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Retour

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     3.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Statistics extends Component
{
    // Constants
    // =========================================================================

    public const LAST_STATISTICS_TRIM_CACHE_KEY = 'retour-last-statistics-trim';

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var null|array
     */
    protected ?array $cachedStatistics;

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @return array All of the statistics
     */
    public function getAllStatistics(): array
    {
        // Cache it in our class; no need to fetch it more than once
        if ($this->cachedStatistics !== null) {
            return $this->cachedStatistics;
        }
        // Query the db table
        $stats = (new Query())
            ->from(['{{%retour_stats}}'])
            ->orderBy('hitCount DESC')
            ->limit(Retour::$settings->statsDisplayLimit)
            ->all();
        // Cache for future accesses
        $this->cachedStatistics = $stats;

        return $stats;
    }

    /**

Missing short description in doc comment

     * @param int $days The number of days to get

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     * @param bool $handled

Missing parameter comment

     *
     * @return array Recent statistics
     */
    public function getRecentStatistics(int $days = 1, bool $handled = false): array
    {
        // Ensure is an int
        $handledInt = (int)$handled;
        $stats = [];
        $db = Craft::$app->getDb();
        if ($db->getIsMysql()) {
            // Query the db table
            $stats = (new Query())
                ->from(['{{%retour_stats}}'])
                ->where("hitLastTime >= ( CURDATE() - INTERVAL '{$days}' DAY )")
                ->andWhere("handledByRetour = {$handledInt}")
                ->orderBy('hitLastTime DESC')
                ->all();
        }
        if ($db->getIsPgsql()) {
            // Query the db table
            $stats = (new Query())
                ->from(['{{%retour_stats}}'])
                ->where("\"hitLastTime\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )")
                ->andWhere(['handledByRetour' => $handledInt])
                ->orderBy('hitLastTime DESC')
                ->all();
        }

        return $stats;
    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function clearStatistics(): int
    {
        $db = Craft::$app->getDb();
        try {
            $result = $db->createCommand()
                ->truncateTable('{{%retour_stats}}')
                ->execute();
        } catch (Exception $e) {
            $result = -1;
            Craft::error($e->getMessage(), __METHOD__);
        }

        return $result;
    }

    /**
     * Delete a statistic by id
     *
     * @param int $id

Missing parameter comment

     *
     * @return int The result
     */
    public function deleteStatisticById(int $id): int
    {
        $db = Craft::$app->getDb();
        // Delete a row from the db table
        try {
            $result = $db->createCommand()->delete(
                '{{%retour_stats}}',
                [
                    'id' => $id,
                ]
            )->execute();
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

    /**
     * Increment the retour_stats record
     *
     * @param string $url The 404 url

Expected 5 spaces after parameter name; 1 found

     * @param bool $handled

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param null $siteId

Are you sure the doc-type for parameter $siteId is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function incrementStatistics(string $url, bool $handled = false, $siteId = null): void
    {
        if (Retour::$settings->enableStatistics === false) {
            return;
        }

        $referrer = $remoteIp = null;
        $request = Craft::$app->getRequest();
        if ($siteId === null) {

The condition $siteId === null is always true.

            $siteId = Craft::$app->getSites()->currentSite->id;
        }
        if (!$request->isConsoleRequest) {
            $referrer = $request->getReferrer();
            if (Retour::$settings->recordRemoteIp) {
                $remoteIp = $request->getUserIP();
            }
            $userAgent = $request->getUserAgent();
            if (Retour::$currentException !== null) {
                $exceptionMessage = Retour::$currentException->getMessage();
                $exceptionFilePath = Retour::$currentException->getFile();
                $exceptionFileLine = Retour::$currentException->getLine();
            }
        }
        $referrer = $referrer ?? '';
        $remoteIp = $remoteIp ?? '';
        $userAgent = $userAgent ?? '';
        $exceptionMessage = $exceptionMessage ?? '';
        $exceptionFilePath = $exceptionFilePath ?? '';
        $exceptionFileLine = $exceptionFileLine ?? 0;
        // Strip the query string if `stripQueryStringFromStats` is set
        if (Retour::$settings->stripQueryStringFromStats) {
            $url = UrlHelper::stripQueryString($url);
            $referrer = UrlHelper::stripQueryString($referrer);

It seems like $referrer can also be of type null; however, parameter $url of craft\helpers\UrlHelper::stripQueryString() does only seem to accept string, maybe add an additional type check?

        }
        // Normalize the $url via the validator
        $stats = new StatsModel([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'redirectSrcUrl' => TextHelper::cleanupText($url),
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $stats->validate();
        // Find any existing retour_stats record
        $statsConfig = (new Query())
            ->from(['{{%retour_stats}}'])
            ->where(['redirectSrcUrl' => $stats->redirectSrcUrl])
            ->one();
        // If no record is found, initialize some values
        if ($statsConfig === null) {
            $stats->id = 0;
            $stats->hitCount = 0;
        } else {
            $stats->id = $statsConfig['id'];
            $stats->hitCount = $statsConfig['hitCount'];
        }
        // Merge in the updated info
        $stats->siteId = $siteId;
        $stats->referrerUrl = $referrer;
        $stats->remoteIp = $remoteIp;
        $stats->userAgent = $userAgent;
        $stats->exceptionMessage = $exceptionMessage;
        $stats->exceptionFilePath = $exceptionFilePath;
        $stats->exceptionFileLine = (int)$exceptionFileLine;
        $stats->hitLastTime = Db::prepareDateForDb(new DateTime());
        $stats->handledByRetour = (int)$handled;
        $stats->hitCount++;
        $statsConfig = $stats->getAttributes();
        // Record the updated statistics
        $this->saveStatistics($statsConfig);
        // After incrementing a statistic, trim the retour_stats db table
        if (Retour::$settings->automaticallyTrimStatistics && !$this->rateLimited()) {
            $this->trimStatistics();
        }
    }

    /**

Missing short description in doc comment

     * @param array $statsConfig

Missing parameter comment

     */

Missing @return tag in function comment

    public function saveStatistics(array $statsConfig): void
    {
        // Validate the model before saving it to the db
        $stats = new StatsModel($statsConfig);
        if ($stats->validate() === false) {
            Craft::error(
                Craft::t(
                    'retour',
                    'Error validating statistics {id}: {errors}',
                    ['id' => $stats->id, 'errors' => print_r($stats->getErrors(), true)]
                ),
                __METHOD__
            );

            return;
        }
        // Get the validated model attributes and save them to the db
        $statsConfig = $stats->getAttributes();
        $db = Craft::$app->getDb();
        if ($statsConfig['id'] !== 0) {
            // Update the existing record
            try {
                $result = $db->createCommand()->update(

The assignment to $result is dead and can be removed.

                    '{{%retour_stats}}',
                    $statsConfig,
                    [
                        'id' => $statsConfig['id'],
                    ]
                )->execute();
            } catch (Exception $e) {
                // We don't log this error on purpose, because it's just a stats
                // update, and deadlock errors can potentially occur
                // Craft::error($e->getMessage(), __METHOD__);
            }
        } else {
            unset($statsConfig['id']);
            // Create a new record
            try {
                $db->createCommand()->insert(
                    '{{%retour_stats}}',
                    $statsConfig
                )->execute();
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
    }

    /**
     * Trim the retour_stats db table based on the statsStoredLimit config.php
     * setting
     *
     * @param int|null $limit

Missing parameter comment

     *
     * @return int
     */
    public function trimStatistics(int $limit = null): int
    {
        $affectedRows = 0;
        $db = Craft::$app->getDb();
        $quotedTable = $db->quoteTableName('{{%retour_stats}}');
        $limit = $limit ?? Retour::$settings->statsStoredLimit;

        if ($limit !== null) {

The condition $limit !== null is always true.

            //  https://stackoverflow.com/questions/578867/sql-query-delete-all-records-from-the-table-except-latest-n
            try {
                if ($db->getIsMysql()) {
                    // Handle MySQL
                    $affectedRows = $db->createCommand(/** @lang mysql */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        "
                        DELETE FROM {$quotedTable}
                        WHERE id NOT IN (
                          SELECT id
                          FROM (
                            SELECT id
                            FROM {$quotedTable}
                            ORDER BY hitLastTime DESC
                            LIMIT {$limit}
                          ) foo
                        )
                        "
                    )->execute();
                }
                if ($db->getIsPgsql()) {
                    // Handle Postgres
                    $affectedRows = $db->createCommand(/** @lang mysql */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        "
                        DELETE FROM {$quotedTable}
                        WHERE id NOT IN (
                          SELECT id
                          FROM (
                            SELECT id
                            FROM {$quotedTable}
                            ORDER BY \"hitLastTime\" DESC
                            LIMIT {$limit}
                          ) foo
                        )
                        "
                    )->execute();
                }
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
            Craft::info(
                Craft::t(
                    'retour',
                    'Trimmed {rows} from retour_stats table',
                    ['rows' => $affectedRows]
                ),
                __METHOD__
            );
        }

        return $affectedRows;
    }

    // Protected Methods
    // =========================================================================

    /**
     * Don't trim more than a given interval, so that performance is not affected
     *
     * @return bool
     */
    protected function rateLimited(): bool
    {
        $limited = false;
        $now = round(microtime(true) * 1000);
        $cache = Craft::$app->getCache();
        $then = $cache->get(self::LAST_STATISTICS_TRIM_CACHE_KEY);
        if (($then !== false) && ($now - (int)$then < Retour::$settings->statisticsRateLimitMs)) {
            $limited = true;
        }
        $cache->set(self::LAST_STATISTICS_TRIM_CACHE_KEY, $now, 0);

        return $limited;
    }
}