nystudio107\retour\services\Redirects

Complexity

Total Complexity

145

Size/Duplication

Total Lines	1330
Duplicated Lines	0 %

Importance

Changes	27
Bugs	8	Features	1

27 Methods

Rating	Name	Duplication	Size	Complexity
A	getRedirectFromCache()	0	15	1
A	enableElementRedirect()	0	20	3
A	getRedirectsByMatchType()	0	24	4
D	saveRedirect()	0	117	15
A	removeElementRedirect()	0	15	6
A	getAllExactMatchRedirects()	0	3	1
A	deleteShortlinkById()	0	20	4
A	getRedirectByRedirectSrcUrl()	0	17	2
A	setShortLinkFieldValue()	0	24	5
A	getMatchesList()	0	16	3
F	doRedirect()	0	107	23
F	resolveRedirect()	0	155	20
A	getAllRegExRedirects()	0	3	1
A	getRedirectsByElementId()	0	11	2
A	saveRedirectToCache()	0	26	2
A	isPreview()	0	6	2
B	findRedirectMatch()	0	45	7
A	deleteRedirectById()	0	33	3
A	updateAssociatedElementShortLink()	0	19	4
A	getAllStaticRedirects()	0	15	3
A	invalidateCaches()	0	15	2
A	resolveEventRedirect()	0	21	4
A	excludeUri()	0	30	6
A	incrementRedirectHitCount()	0	29	3
B	handle404()	0	57	10
A	getRedirectById()	0	9	1
B	getStaticRedirect()	0	100	8

<?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\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Plugin;
use craft\db\Query;
use craft\errors\ElementNotFoundException;
use craft\errors\SiteNotFoundException;
use craft\helpers\Db;
use craft\helpers\StringHelper;
use craft\web\Response as WebResponse;
use DateTime;
use nystudio107\retour\events\RedirectEvent;
use nystudio107\retour\events\RedirectResolvedEvent;
use nystudio107\retour\events\ResolveRedirectEvent;
use nystudio107\retour\fields\ShortLink;
use nystudio107\retour\helpers\Text as TextHelper;
use nystudio107\retour\helpers\UrlHelper;
use nystudio107\retour\models\StaticRedirects as StaticRedirectsModel;
use nystudio107\retour\Retour;
use Throwable;
use yii\base\ExitException;
use yii\base\InvalidConfigException;
use yii\base\InvalidRouteException;
use yii\caching\TagDependency;
use yii\db\Exception;
use function call_user_func_array;

/** @noinspection MissingPropertyAnnotationsInspection */

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

/**

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 Redirects extends Component
{
    // Constants
    // =========================================================================

    public const CACHE_KEY = 'retour_redirect_';

    public const GLOBAL_REDIRECTS_CACHE_TAG = 'retour_redirects';

    public const EVENT_REDIRECT_ID = 0;

    /**

Missing short description in doc comment

     * @event RedirectEvent The event that is triggered before the redirect is saved
     * You may set [[RedirectEvent::isValid]] to `false` to prevent the redirect from getting saved.
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\RedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_BEFORE_SAVE_REDIRECT,
     *     function(RedirectEvent $event) {
     *         // potentially set $event->isValid;
     *     }
     * );
     * ```
     */
    public const EVENT_BEFORE_SAVE_REDIRECT = 'beforeSaveRedirect';

    /**

Missing short description in doc comment

     * @event RedirectEvent The event that is triggered after the redirect is saved
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\RedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_AFTER_SAVE_REDIRECT,
     *     function(RedirectEvent $event) {
     *         // the redirect was saved
     *     }
     * );
     * ```
     */
    public const EVENT_AFTER_SAVE_REDIRECT = 'afterSaveRedirect';

    /**

Missing short description in doc comment

     * @event RedirectEvent The event that is triggered before the redirect is deleted
     * You may set [[RedirectEvent::isValid]] to `false` to prevent the redirect from getting deleted.
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\RedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_BEFORE_DELETE_REDIRECT,
     *     function(RedirectEvent $event) {
     *         // potentially set $event->isValid;
     *     }
     * );
     * ```
     */
    public const EVENT_BEFORE_DELETE_REDIRECT = 'beforeDeleteRedirect';

    /**

Missing short description in doc comment

     * @event RedirectEvent The event that is triggered after the redirect is deleted
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\RedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_AFTER_DELETE_REDIRECT,
     *     function(RedirectEvent $event) {
     *         // the redirect was deleted
     *     }
     * );
     * ```
     */
    public const EVENT_AFTER_DELETE_REDIRECT = 'afterDeleteRedirect';

    /**

Missing short description in doc comment

     * @event ResolveRedirectEvent The event that is triggered before Retour has attempted
     *        to resolve redirects. You may set [[ResolveRedirectEvent::redirectDestUrl]] to
     *        to the URL that it should redirect to, or null if no redirect should happen
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\ResolveRedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_AFTER_SAVE_REDIRECT,
     *     function(ResolveRedirectEvent $event) {
     *         // potentially set $event->redirectDestUrl;
     *     }
     * );
     * ```
     */
    public const EVENT_BEFORE_RESOLVE_REDIRECT = 'beforeResolveRedirect';

    /**

Missing short description in doc comment

     * @event ResolveRedirectEvent The event that is triggered after Retour has attempted
     *        to resolve redirects. You may set [[ResolveRedirectEvent::redirectDestUrl]] to
     *        to the URL that it should redirect to, or null if no redirect should happen
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\ResolveRedirectEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_AFTER_RESOLVE_REDIRECT,
     *     function(ResolveRedirectEvent $event) {
     *         // potentially set $event->redirectDestUrl;
     *     }
     * );
     * ```
     */
    public const EVENT_AFTER_RESOLVE_REDIRECT = 'afterResolveRedirect';

    /**

Missing short description in doc comment

     * @event RedirectResolvedEvent The event that is triggered once Retour has resolved
     *        a redirect. [[RedirectResolvedEvent::redirect]] will be set to the redirect
     *        that was resolved. You may set [[RedirectResolvedEvent::redirectDestUrl]] to
     *        to a different URL that it should redirect to, or leave it null if the
     *        redirect should happen as resolved.
     *
     * ```php
     * use nystudio107\retour\services\Redirects;
     * use nystudio107\retour\events\RedirectResolvedEvent;
     *
     * Event::on(Redirects::class,
     *     Redirects::EVENT_REDIRECT_RESOLVED,
     *     function(RedirectResolvedEvent $event) {
     *         // potentially set $event->redirectDestUrl;
     *     }
     * );
     * ```
     */
    public const EVENT_REDIRECT_RESOLVED = 'redirectResolved';

    /**

Missing short description in doc comment

     * @var array A list of all the element ids for which the short links have been purged.
     */
    protected static array $purgedShortLinkElementIds = [];


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

    /**
     * Handle 404s by looking for redirects
     */

Missing @return tag in function comment

    public function handle404(): void
    {
        Craft::info(
            Craft::t(
                'retour',
                'A 404 exception occurred'
            ),
            __METHOD__
        );
        $request = Craft::$app->getRequest();
        // We only want site requests that are not live preview or console requests
        if ($request->getIsSiteRequest() && !$this->isPreview($request) && !$request->getIsConsoleRequest()) {
            // See if we should redirect
            try {
                $fullUrl = urldecode($request->getAbsoluteUrl());
                $pathOnly = urldecode($request->getUrl());
            } catch (InvalidConfigException $e) {
                Craft::error(
                    $e->getMessage(),
                    __METHOD__
                );
                $pathOnly = '';
                $fullUrl = '';
            }
            // Stash the $pathOnly for use when incrementing the statistics
            $originalPathOnly = $pathOnly;
            // Strip the query string if `alwaysStripQueryString` is set
            if (Retour::$settings->alwaysStripQueryString) {
                $fullUrl = UrlHelper::stripQueryString($fullUrl);
                $pathOnly = UrlHelper::stripQueryString($pathOnly);
            }
            Craft::info(
                Craft::t(
                    'retour',
                    '404 full URL: {fullUrl}, 404 path only: {pathOnly}',
                    ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
                ),
                __METHOD__
            );
            if (!$this->excludeUri($pathOnly)) {
                // Redirect if we find a match, otherwise let Craft handle it
                $redirect = $this->findRedirectMatch($fullUrl, $pathOnly);
                // If the redirect wasn't found, look for it without the Site-defined prefix
                if ($redirect === null) {
                    // Strip out any site-defined baseUrl path prefixes
                    $pathOnly = UrlHelper::stripSitePathPrefix($pathOnly);
                    $redirect = $this->findRedirectMatch($fullUrl, $pathOnly);
                }
                if (!$this->doRedirect($fullUrl, $pathOnly, $redirect) && !Retour::$settings->alwaysStripQueryString) {
                    // Try it again without the query string
                    $fullUrl = UrlHelper::stripQueryString($fullUrl);
                    $pathOnly = UrlHelper::stripQueryString($pathOnly);
                    $redirect = $this->findRedirectMatch($fullUrl, $pathOnly);
                    $this->doRedirect($fullUrl, $pathOnly, $redirect);
                }
                // Increment the stats
                Retour::$plugin->statistics->incrementStatistics($originalPathOnly, false);

The method incrementStatistics() does not exist on null.

            }
        }
    }

    /**
     * Return whether this is a preview request of any kind
     *
     * @param $request

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return bool

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function isPreview($request): bool
    {
        $isPreview = $request->getIsPreview();
        $isLivePreview = $request->getIsLivePreview();

        return ($isPreview || $isLivePreview);
    }

    /**

Missing short description in doc comment

     * @param $uri

Missing parameter comment

     *
     * @return bool
     */
    public function excludeUri($uri): bool
    {
        $uri = '/' . ltrim($uri, '/');
        if (!empty(Retour::$settings->excludePatterns)) {
            foreach (Retour::$settings->excludePatterns as $excludePattern) {
                if (empty($excludePattern['pattern'])) {
                    continue;
                }
                $pattern = '`' . $excludePattern['pattern'] . '`i';
                try {
                    if (preg_match($pattern, $uri) === 1) {
                        Craft::info(
                            Craft::t(
                                'retour',
                                'Excluded URI: {uri} due to match of pattern: {pattern}',
                                ['uri' => $uri, 'pathOnly' => $pattern]
                            ),
                            __METHOD__
                        );

                        return true;
                    }
                } catch (\Exception $e) {
                    // That's fine
                    Craft::error('Invalid exclude URI Regex: ' . $pattern, __METHOD__);
                }
            }
        }

        return false;
    }

    /**

Missing short description in doc comment

     * @param string $fullUrl

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string $pathOnly

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param int|null $siteId

Missing parameter comment

     *
     * @return bool|array|null
     */
    public function findRedirectMatch(string $fullUrl, string $pathOnly, $siteId = null): bool|array|null
    {
        // Get the current site
        if ($siteId === null) {
            $currentSite = Craft::$app->getSites()->currentSite;
            if ($currentSite) {
                $siteId = $currentSite->id;
            } else {
                $primarySite = Craft::$app->getSites()->primarySite;
                $siteId = $primarySite->id;
            }
        }
        // Try getting the full URL redirect from the cache
        $redirect = $this->getRedirectFromCache($fullUrl, $siteId);
        if ($redirect) {
            $this->incrementRedirectHitCount($redirect);
            $this->saveRedirectToCache($fullUrl, $redirect);

            return $redirect;
        }
        // Try getting the path only redirect from the cache
        $redirect = $this->getRedirectFromCache($pathOnly, $siteId);
        if ($redirect) {
            $this->incrementRedirectHitCount($redirect);
            $this->saveRedirectToCache($pathOnly, $redirect);

            return $redirect;
        }

        $redirect = $this->getStaticRedirect($fullUrl, $pathOnly, $siteId, true);
        if ($redirect) {
            $this->incrementRedirectHitCount($redirect);
            $this->saveRedirectToCache($pathOnly, $redirect);

            return $redirect;
        }

        // Resolve static redirects
        $redirects = $this->getAllRegExRedirects(null, $siteId, true);
        $redirect = $this->resolveRedirect($fullUrl, $pathOnly, $redirects, $siteId);
        if ($redirect) {
            return $redirect;
        }

        return null;
    }

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

     * @param int $siteId

Expected 4 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return bool|array
     */
    public function getRedirectFromCache(string $url, int $siteId = 0): bool|array
    {
        $cache = Craft::$app->getCache();
        $cacheKey = $this::CACHE_KEY . md5($url) . $siteId;
        $redirect = $cache->get($cacheKey);
        Craft::info(
            Craft::t(
                'retour',
                'Cached redirect hit for {url}',
                ['url' => $url]
            ),
            __METHOD__
        );

        return $redirect;
    }

    /**
     * Increment the retour_static_redirects record
     *
     * @param $redirectConfig

Missing parameter comment

     */

Missing @return tag in function comment

    public function incrementRedirectHitCount(&$redirectConfig): void
    {
        if ($redirectConfig !== null) {
            $db = Craft::$app->getDb();
            $redirectConfig['hitCount']++;
            $redirectConfig['hitLastTime'] = Db::prepareDateForDb(new DateTime());
            Craft::debug(
                Craft::t(
                    'retour',
                    'Incrementing statistics for: {redirect}',
                    ['redirect' => print_r($redirectConfig, true)]
                ),
                __METHOD__
            );
            // Update the existing record
            try {
                $rowsAffected = $db->createCommand()->update(
                    '{{%retour_static_redirects}}',
                    [
                        'hitCount' => $redirectConfig['hitCount'],
                        'hitLastTime' => $redirectConfig['hitLastTime'],
                    ],
                    [
                        'id' => $redirectConfig['id'],
                    ]
                )->execute();
                Craft::debug('Rows affected: ' . $rowsAffected, __METHOD__);
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
    }

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

     * @param array $redirect

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function saveRedirectToCache(string $url, array $redirect): void
    {
        $cache = Craft::$app->getCache();
        // Get the current site id
        $sites = Craft::$app->getSites();
        try {
            $siteId = $sites->getCurrentSite()->id;
        } catch (SiteNotFoundException $e) {
            $siteId = 1;
        }
        $cacheKey = $this::CACHE_KEY . md5($url) . $siteId;
        // Create the dependency tags
        $dependency = new TagDependency([

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

            'tags' => [
                $this::GLOBAL_REDIRECTS_CACHE_TAG,
                $this::GLOBAL_REDIRECTS_CACHE_TAG . $siteId,
            ],
        ]);

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

        $cache->set($cacheKey, $redirect, Retour::$cacheDuration, $dependency);
        Craft::info(
            Craft::t(
                'retour',
                'Cached redirect saved for {url}',
                ['url' => $url]
            ),
            __METHOD__
        );
    }

    /**

Missing short description in doc comment

Parameter $enabledOnly should have a doc-comment as per coding-style.

     * @param string $fullUrl

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $pathOnly

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $siteId

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed|null

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getStaticRedirect(string $fullUrl, string $pathOnly, $siteId, bool $enabledOnly = false)
    {
        $result = null;

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

        // Throw the Redirects::EVENT_BEFORE_RESOLVE_REDIRECT event
        $event = new ResolveRedirectEvent([

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

            'fullUrl' => $fullUrl,
            'pathOnly' => $pathOnly,
            'redirectDestUrl' => null,
            'redirectHttpCode' => 301,
            'siteId' => $siteId,
        ]);

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

        $this->trigger(self::EVENT_BEFORE_RESOLVE_REDIRECT, $event);
        if ($event->redirectDestUrl !== null) {
            return $this->resolveEventRedirect($event);
        }
        // Query for the static redirect
        $staticCondition = ['redirectMatchType' => 'exactmatch'];
        $siteCondition = [
            'or',
            ['siteId' => $siteId],
            ['siteId' => null],
        ];
        $pathCondition = [
            'or',
            ['and',
                ['redirectSrcMatch' => 'pathonly'],
                ['redirectSrcUrlParsed' => TextHelper::cleanupText($pathOnly)],
            ],
            ['and',
                ['redirectSrcMatch' => 'fullurl'],
                ['redirectSrcUrlParsed' => TextHelper::cleanupText($fullUrl)],
            ],
        ];

        $query = (new Query())
            ->from('{{%retour_static_redirects}}')
            ->where(['and',

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

                $staticCondition,
                $pathCondition,
                $siteCondition,
            ])

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

            ->limit(1);

        if ($enabledOnly) {
            $query->andWhere(['enabled' => 1]);
        }
        $result = $query->one();
        if ($result) {
            // Figure out what type of source matching to do
            $redirectSrcMatch = $result['redirectSrcMatch'] ?? 'pathonly';
            switch ($redirectSrcMatch) {
                case 'pathonly':

Line indented incorrectly; expected 12 spaces, found 16

                    $url = $pathOnly;
                    break;
                case 'fullurl':

Line indented incorrectly; expected 12 spaces, found 16

                    $url = $fullUrl;
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $url = $pathOnly;
                    break;
            }
            // Throw the Redirects::EVENT_REDIRECT_RESOLVED event
            $event = new RedirectResolvedEvent([

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

                'fullUrl' => $fullUrl,
                'pathOnly' => $pathOnly,
                'redirectDestUrl' => null,
                'redirectHttpCode' => 301,
                'redirect' => $result,
                'siteId' => $siteId,
            ]);

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

            $this->trigger(self::EVENT_REDIRECT_RESOLVED, $event);
            if ($event->redirectDestUrl !== null) {
                return $this->resolveEventRedirect($event, $url, $result);
            }

            return $result;
        }

        // Throw the Redirects::EVENT_AFTER_RESOLVE_REDIRECT event
        $event = new ResolveRedirectEvent([

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

            'fullUrl' => $fullUrl,
            'pathOnly' => $pathOnly,
            'redirectDestUrl' => null,
            'redirectHttpCode' => 301,
            'siteId' => $siteId,
        ]);

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

        $this->trigger(self::EVENT_AFTER_RESOLVE_REDIRECT, $event);
        if ($event->redirectDestUrl !== null) {
            return $this->resolveEventRedirect($event);
        }
        Craft::info(
            Craft::t(
                'retour',
                'Not handled-> full URL: {fullUrl}, path only: {pathOnly}',
                ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
            ),
            __METHOD__
        );

        return $result;
    }

    /**

Missing short description in doc comment

Parameter $enabledOnly should have a doc-comment as per coding-style.

     * @param null|int $limit

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @return array All of the regex match redirects
     */
    public function getAllRegExRedirects(int $limit = null, int $siteId = null, bool $enabledOnly = false): array
    {
        return $this->getRedirectsByMatchType($limit, $siteId, 'regexmatch', $enabledOnly);
    }

    /**

Missing short description in doc comment

Parameter $enabledOnly should have a doc-comment as per coding-style.

     * @param null|int $limit

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @return array All of the regex match redirects
     */
    public function getAllExactMatchRedirects(int $limit = null, int $siteId = null, bool $enabledOnly = false): array
    {
        return $this->getRedirectsByMatchType($limit, $siteId, 'exactmatch', $enabledOnly);
    }

    /**

Missing short description in doc comment

     * @param int|null $limit

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @return array All of the statistics
     */
    public function getAllStaticRedirects(int $limit = null, int $siteId = null): array
    {
        // Query the db table
        $query = (new Query())
            ->from(['{{%retour_static_redirects}}'])
            ->orderBy('redirectMatchType ASC, priority ASC');
        if ($siteId) {

The expression $siteId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $query
                ->where(['siteId' => $siteId])
                ->orWhere(['siteId' => null]);
        }
        if ($limit) {

The expression $limit of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $query->limit($limit);
        }
        return $query->all();
    }

    /**

Missing short description in doc comment

     * @param string $fullUrl

Missing parameter comment

     * @param string $pathOnly

Missing parameter comment

     * @param array $redirects