nystudio107 / craft-retour

src/Retour.php

<?php
/**
 * Retour plugin for Craft CMS 3.x
 *
 * 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;

use craft\events\RegisterGqlSchemaComponentsEvent;
use nystudio107\retour\assetbundles\retour\RetourAsset;
use nystudio107\retour\gql\interfaces\RetourInterface;
use nystudio107\retour\gql\queries\RetourQuery;
use nystudio107\retour\listeners\GetCraftQLSchema;
use nystudio107\retour\models\Settings;
use nystudio107\retour\services\Redirects;
use nystudio107\retour\services\Statistics;
use nystudio107\retour\variables\RetourVariable;
use nystudio107\retour\widgets\RetourWidget;

use nystudio107\pluginmanifest\services\ManifestService;

use Craft;
use craft\base\Element;
use craft\base\Plugin;
use craft\events\ElementEvent;
use craft\events\ExceptionEvent;
use craft\events\PluginEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\events\RegisterComponentTypesEvent;
use craft\events\RegisterGqlQueriesEvent;
use craft\events\RegisterGqlTypesEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\events\RegisterUserPermissionsEvent;
use craft\helpers\ElementHelper;
use craft\helpers\UrlHelper;
use craft\services\Elements;
use craft\services\Dashboard;
use craft\services\Gql;
use craft\services\Plugins;
use craft\services\UserPermissions;
use craft\utilities\ClearCaches;
use craft\web\ErrorHandler;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;

use yii\base\Event;
use yii\base\Exception;
use yii\web\HttpException;

use markhuot\CraftQL\Builders\Schema;

The type markhuot\CraftQL\Builders\Schema was not found. Maybe you did not declare it correctly or list all dependencies?

use markhuot\CraftQL\CraftQL;

The type markhuot\CraftQL\CraftQL was not found. Maybe you did not declare it correctly or list all dependencies?

use markhuot\CraftQL\Events\AlterSchemaFields;

The type markhuot\CraftQL\Events\AlterSchemaFields was not found. Maybe you did not declare it correctly or list all dependencies?

/** @noinspection MissingPropertyAnnotationsInspection */

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

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

Missing short description in doc comment

/**
 * Class Retour
 *
 * @author    nystudio107

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

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

The tag in position 1 should be the @package tag

 * @package   Retour

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

 * @since     3.0.0

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

The tag in position 3 should be the @author tag

 *
 * @property Redirects          $redirects
 * @property Statistics         $statistics
 * @property ManifestService    $manifest
 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class Retour extends Plugin
{
    // Constants
    // =========================================================================

    const DEVMODE_CACHE_DURATION = 30;

    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var Retour
     */
    public static $plugin;

    /**

Missing short description in doc comment

     * @var Settings
     */
    public static $settings;

    /**

Missing short description in doc comment

     * @var int
     */
    public static $cacheDuration;

    /**

Missing short description in doc comment

     * @var HttpException
     */
    public static $currentException;

    /**

Missing short description in doc comment

     * @var bool
     */
    public static $craft31 = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public static $craft32 = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public static $craft33 = false;

    // Static Methods
    // =========================================================================

    /**

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

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

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

Missing short description in doc comment

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        $config['components'] = [
            'redirects' => Redirects::class,
            'statistics' => Statistics::class,
            // Register the manifest service
            'manifest' => [
                'class' => ManifestService::class,
                'assetClass' => RetourAsset::class,
                'devServerManifestPath' => 'http://craft-retour-buildchain:8080/',
                'devServerPublicPath' => 'http://craft-retour-buildchain:8080/',
            ]
        ];

        parent::__construct($id, $parent, $config);
    }

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string
     */
    public $schemaVersion = '3.0.10';

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSection = true;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSettings = true;

    /**

Missing short description in doc comment

     * @var array The URIs for the element before it was saved
     */
    public $oldElementUris = [];

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;
        // Initialize properties
        self::$settings = $this->getSettings();
        self::$craft31 = version_compare(Craft::$app->getVersion(), '3.1', '>=');

It seems like version_compare(Craft::app->getVersion(), '3.1', '>=') can also be of type integer. However, the property $craft31 is declared as type boolean. Maybe add an additional type check?

        self::$craft32 = version_compare(Craft::$app->getVersion(), '3.2', '>=');

It seems like version_compare(Craft::app->getVersion(), '3.2', '>=') can also be of type integer. However, the property $craft32 is declared as type boolean. Maybe add an additional type check?

        self::$craft33 = version_compare(Craft::$app->getVersion(), '3.3', '>=');

It seems like version_compare(Craft::app->getVersion(), '3.3', '>=') can also be of type integer. However, the property $craft33 is declared as type boolean. Maybe add an additional type check?

        $this->name = self::$settings->pluginName;
        self::$cacheDuration = Craft::$app->getConfig()->getGeneral()->devMode
            ? $this::DEVMODE_CACHE_DURATION
            : null;
        // Handle any console commands
        $request = Craft::$app->getRequest();
        if ($request->getIsConsoleRequest()) {
            $this->controllerNamespace = 'nystudio107\retour\console\controllers';
        }
        // Install our event listeners
        $this->installEventListeners();
        // Log that Retour has been loaded
        Craft::info(
            Craft::t(
                'retour',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsResponse()
    {
        // Just redirect to the plugin settings page
        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('retour/settings'));
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getCpNavItem()
    {
        $subNavs = [];
        $navItem = parent::getCpNavItem();
        $currentUser = Craft::$app->getUser()->getIdentity();
        // Only show sub-navs the user has permission to view
        if ($currentUser->can('retour:dashboard')) {

The method can() does not exist on yii\web\IdentityInterface. It seems like you code against a sub-type of yii\web\IdentityInterface such as craft\elements\User.

            $subNavs['dashboard'] = [
                'label' => 'Dashboard',
                'url' => 'retour/dashboard',
            ];
        }
        if ($currentUser->can('retour:redirects')) {
            $subNavs['redirects'] = [
                'label' => 'Redirects',
                'url' => 'retour/redirects',
            ];
        }
        $editableSettings = true;
        $general = Craft::$app->getConfig()->getGeneral();
        if (self::$craft31 && !$general->allowAdminChanges) {
            $editableSettings = false;
        }
        if ($currentUser->can('retour:settings') && $editableSettings) {
            $subNavs['settings'] = [
                'label' => 'Settings',
                'url' => 'retour/settings',
            ];
        }
        // Retour doesn't really have an index page, so if the user can't access any sub nav items, we probably shouldn't show the main sub nav item either
        if (empty($subNavs)) {
            return null;
        }
        // A single sub nav item is redundant
        if (count($subNavs) === 1) {
            $subNavs = [];
        }
        $navItem = array_merge($navItem, [

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

            'subnav' => $subNavs,
        ]);

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

        return $navItem;
    }

    /**
     * Clear all the caches!
     */

Missing @return tag in function comment

    public function clearAllCaches()
    {
        // Clear all of Retour's caches
        self::$plugin->redirects->invalidateCaches();
    }

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

    /**
     * Determine whether our table schema exists or not; this is needed because
     * migrations such as the install migration and base_install migration may
     * not have been run by the time our init() method has been called
     *
     * @return bool
     */
    protected function tableSchemaExists(): bool
    {
        return (Craft::$app->db->schema->getTableSchema('{{%retour_redirects}}') !== null);
    }

    /**
     * Install our event listeners.
     */

Missing @return tag in function comment

    protected function installEventListeners()
    {
        // Install our event listeners only if our table schema exists
        if ($this->tableSchemaExists()) {
            $request = Craft::$app->getRequest();
            // Add in our event listeners that are needed for every request
            $this->installGlobalEventListeners();
            // Install only for non-console site requests
            if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
                $this->installSiteEventListeners();
            }
            // Install only for non-console Control Panel requests
            if ($request->getIsCpRequest() && !$request->getIsConsoleRequest()) {
                $this->installCpEventListeners();
            }
        }
        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            function (RegisterCacheOptionsEvent $event) {
                Craft::debug(
                    'ClearCaches::EVENT_REGISTER_CACHE_OPTIONS',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->options = array_merge(
                    $event->options,
                    $this->customAdminCpCacheOptions()
                );
            }
        );
        // Handler: EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function (PluginEvent $event) {
                if ($event->plugin === $this) {
                    // Invalidate our caches after we've been installed
                    $this->clearAllCaches();
                    // Send them to our welcome screen
                    $request = Craft::$app->getRequest();
                    if ($request->isCpRequest) {
                        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl(

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

                            'retour/dashboard',
                            [
                                'showWelcome' => true,
                            ]
                        ))->send();

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

                    }
                }
            }
        );
    }

    /**
     * Install global event listeners for all request types
     */

Missing @return tag in function comment

    protected function installGlobalEventListeners()
    {
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */

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

Missing short description in doc comment

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

                $variable = $event->sender;
                $variable->set('retour', [

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

                    'class' => RetourVariable::class,
                    'manifestService' => $this->manifest,
                ]);

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

            }
        );
        // Handler: Elements::EVENT_BEFORE_SAVE_ELEMENT
        Event::on(
            Elements::class,
            Elements::EVENT_BEFORE_SAVE_ELEMENT,
            function (ElementEvent $event) {
                Craft::debug(
                    'Elements::EVENT_BEFORE_SAVE_ELEMENT',
                    __METHOD__
                );
                /** @var Element $element */

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

                $element = $event->element;
                if ($element !== null && !$event->isNew && $element->getUrl() !== null && !$element->propagating) {
                    $checkElementSlug = true;
                    // If we're running Craft 3.2 or later, also check that isn't not a draft or revision
                    if (Retour::$craft32 && (
                            ElementHelper::isDraftOrRevision($element)

Each line in a multi-line IF statement must begin with a boolean operator

Multi-line IF statement not indented correctly; expected 24 spaces but found 28

                        )) {

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                        $checkElementSlug = false;
                    }
                    // Only do this for elements that aren't new, pass $checkElementSlug, and the user
                    // has turned on the setting
                    if (self::$settings->createUriChangeRedirects && $checkElementSlug) {
                        // Make sure this isn't a transitioning temporary draft/revision and that it's
                        // not propagating to other sites
                        if (strpos($element->uri, '__temp_') === false && !$element->propagating) {

It seems like $element->uri can also be of type null; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

                            // Stash the old URLs by element id, and do so only once,
                            // in case we are called more than once per request
                            if (empty($this->oldElementUris[$element->id])) {
                                $this->oldElementUris[$element->id] = $this->getAllElementUris($element);
                            }
                        }
                    }
                }
            }
        );
        // Handler: Elements::EVENT_AFTER_SAVE_ELEMENT
        Event::on(
            Elements::class,
            Elements::EVENT_AFTER_SAVE_ELEMENT,
            function (ElementEvent $event) {
                Craft::debug(
                    'Elements::EVENT_AFTER_SAVE_ELEMENT',
                    __METHOD__
                );
                /** @var Element $element */

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

                $element = $event->element;
                if ($element !== null && !$event->isNew && $element->getUrl() !== null) {
                    $checkElementSlug = true;
                    if (Retour::$craft32 && ElementHelper::isDraftOrRevision($element)) {
                        $checkElementSlug = false;
                    }
                    if (self::$settings->createUriChangeRedirects && $checkElementSlug) {
                        $this->handleElementUriChange($element);
                    }
                }
            }
        );
        // Handler: Plugins::EVENT_AFTER_LOAD_PLUGINS
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_LOAD_PLUGINS,
            function () {
                // Install these only after all other plugins have loaded
                $request = Craft::$app->getRequest();
                // Only respond to non-console site requests
                if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
                    $this->handleSiteRequest();
                }
                // Respond to Control Panel requests
                if ($request->getIsCpRequest() && !$request->getIsConsoleRequest()) {
                    $this->handleAdminCpRequest();
                }
            }
        );
        if (self::$craft33) {
            // Handler: Gql::EVENT_REGISTER_GQL_TYPES
            Event::on(
                Gql::class,
                Gql::EVENT_REGISTER_GQL_TYPES,
                function (RegisterGqlTypesEvent $event) {
                    Craft::debug(
                        'Gql::EVENT_REGISTER_GQL_TYPES',
                        __METHOD__
                    );
                    $event->types[] = RetourInterface::class;
                }
            );
            // Handler: Gql::EVENT_REGISTER_GQL_QUERIES
            Event::on(
                Gql::class,
                Gql::EVENT_REGISTER_GQL_QUERIES,
                function (RegisterGqlQueriesEvent $event) {
                    Craft::debug(
                        'Gql::EVENT_REGISTER_GQL_QUERIES',
                        __METHOD__
                    );
                    $queries = RetourQuery::getQueries();
                    foreach ($queries as $key => $value) {
                        $event->queries[$key] = $value;
                    }
                }
            );
            // Handler: Gql::EVENT_REGISTER_SCHEMA_COMPONENTS
            Event::on(
                Gql::class,
                Gql::EVENT_REGISTER_GQL_SCHEMA_COMPONENTS,
                function (RegisterGqlSchemaComponentsEvent $event) {
                    Craft::debug(
                        'Gql::EVENT_REGISTER_GQL_SCHEMA_COMPONENTS',
                        __METHOD__
                    );
                    $label = Craft::t('retour', 'Retour');
                    $event->queries[$label]['retour.all:read'] = ['label' => Craft::t('retour', 'Query Retour data')];
                }
            );
        }
        // CraftQL Support
        if (class_exists(CraftQL::class)) {
            Event::on(
                Schema::class,
                AlterSchemaFields::EVENT,
                [GetCraftQLSchema::class, 'handle']
            );
        }
    }

    /**
     * Install site event listeners for site requests only
     */

Missing @return tag in function comment

    protected function installSiteEventListeners()
    {
        // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                Craft::debug(
                    'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->rules = array_merge(
                    $event->rules,
                    $this->customFrontendRoutes()
                );
            }
        );
    }

    /**
     * Install site event listeners for Control Panel requests only
     */

Missing @return tag in function comment

    protected function installCpEventListeners()
    {
        // Handler: Dashboard::EVENT_REGISTER_WIDGET_TYPES
        Event::on(
            Dashboard::class,
            Dashboard::EVENT_REGISTER_WIDGET_TYPES,
            function (RegisterComponentTypesEvent $event) {
                $event->types[] = RetourWidget::class;
            }
        );
        // Handler: UrlManager::EVENT_REGISTER_CP_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_CP_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                Craft::debug(
                    'UrlManager::EVENT_REGISTER_CP_URL_RULES',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->rules = array_merge(
                    $event->rules,
                    $this->customAdminCpRoutes()
                );
            }
        );
        // Handler: UserPermissions::EVENT_REGISTER_PERMISSIONS
        Event::on(
            UserPermissions::class,
            UserPermissions::EVENT_REGISTER_PERMISSIONS,
            function (RegisterUserPermissionsEvent $event) {
                Craft::debug(
                    'UserPermissions::EVENT_REGISTER_PERMISSIONS',
                    __METHOD__
                );
                // Register our custom permissions
                $event->permissions[Craft::t('retour', 'Retour')] = $this->customAdminCpPermissions();
            }
        );
    }

    /**
     * Handle site requests.  We do it only after we receive the event
     * EVENT_AFTER_LOAD_PLUGINS so that any pending db migrations can be run
     * before our event listeners kick in
     */

Missing @return tag in function comment

    protected function handleSiteRequest()
    {
        // Handler: ErrorHandler::EVENT_BEFORE_HANDLE_EXCEPTION
        Event::on(
            ErrorHandler::class,
            ErrorHandler::EVENT_BEFORE_HANDLE_EXCEPTION,
            function (ExceptionEvent $event) {
                Craft::debug(
                    'ErrorHandler::EVENT_BEFORE_HANDLE_EXCEPTION',
                    __METHOD__
                );
                $exception = $event->exception;
                // If this is a Twig Runtime exception, use the previous one instead
                if ($exception instanceof \Twig\Error\RuntimeError &&
                    ($previousException = $exception->getPrevious()) !== null) {

Closing parenthesis of a multi-line IF statement must be on a new line

Each line in a multi-line IF statement must begin with a boolean operator

                    $exception = $previousException;
                }
                // If this is a 404 error, see if we can handle it
                if ($exception instanceof HttpException && $exception->statusCode === 404) {
                    self::$currentException = $exception;
                    Retour::$plugin->redirects->handle404();
                }
            }
        );
    }

    /**
     * Handle Control Panel requests. We do it only after we receive the event
     * EVENT_AFTER_LOAD_PLUGINS so that any pending db migrations can be run
     * before our event listeners kick in
     */

Missing @return tag in function comment

    protected function handleAdminCpRequest()
    {
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel()
    {
        return new Settings();
    }

    /**

Missing short description in doc comment

     * @param Element $element

Missing parameter comment

     */

Missing @return tag in function comment

    protected function handleElementUriChange(Element $element)
    {
        $uris = $this->getAllElementUris($element);
        if (!empty($this->oldElementUris[$element->id])) {
            $oldElementUris = $this->oldElementUris[$element->id];
            foreach ($uris as $siteId => $newUri) {
                if (!empty($oldElementUris[$siteId])) {
                    $oldUri = $oldElementUris[$siteId];
                    Craft::debug(
                        Craft::t(
                            'retour',
                            'Comparing old: {oldUri} to new: {newUri}',
                            ['oldUri' => print_r($oldUri, true), 'newUri' => print_r($newUri, true)]
                        ),
                        __METHOD__
                    );
                    // Handle the siteId
                    $redirectSiteId = null;
                    if (Craft::$app->getIsMultiSite()) {
                        $redirectSiteId = $siteId;
                    }
                    // Make sure the URIs are not the same
                    if (strcmp($oldUri, $newUri) !== 0) {
                        // Handle trailing slash config setting
                        if (Craft::$app->config->general->addTrailingSlashesToUrls) {
                            $oldUri = rtrim($oldUri, '/') . '/';
                            $newUri = rtrim($newUri, '/') . '/';
                        }
                        // Handle the URL match type
                        if (self::$settings->uriChangeRedirectSrcMatch === 'fullurl') {
                            try {
                                if ($redirectSiteId !== null) {
                                    $redirectSiteId = (int)$redirectSiteId;
                                }
                                $oldUri = UrlHelper::siteUrl($oldUri, null, null, $redirectSiteId);
                                $newUri = UrlHelper::siteUrl($newUri, null, null, $redirectSiteId);
                            } catch (Exception $e) {
                                // That's fine
                            }
                        }
                        $redirectConfig = [
                            'id' => 0,
                            'redirectMatchType' => 'exactmatch',
                            'redirectHttpCode' => 301,
                            'redirectSrcMatch' => self::$settings->uriChangeRedirectSrcMatch,
                            'redirectSrcUrl' => $oldUri,
                            'redirectDestUrl' => $newUri,
                            'siteId' => $redirectSiteId,
                        ];
                        Retour::$plugin->redirects->saveRedirect($redirectConfig);
                    }
                }
            }
        }
    }

    /**
     * Get the URIs for each site for the element
     *
     * @param Element $element

Missing parameter comment

     *
     * @return array
     */
    protected function getAllElementUris(Element $element): array
    {
        $uris = [];
        if (!self::$craft32 || !ElementHelper::isDraftOrRevision($element)) {
            $sites = Craft::$app->getSites()->getAllSites();
            foreach ($sites as $site) {
                $uri = Craft::$app->getElements()->getElementUriForSite($element->id, $site->id);
                if ($uri !== null) {
                    $uris[$site->id] = $uri;
                }
            }
        }

        Craft::debug(
            Craft::t(
                'retour',
                'Getting Element URIs: {uris}',
                ['uris' => print_r($uris, true)]
            ),
            __METHOD__
        );

        return $uris;
    }

    /**
     * Return the custom Control Panel routes
     *
     * @return array
     */
    protected function customAdminCpRoutes(): array
    {
        return [
            'retour' => '',

            'retour/redirects' => 'retour/redirects/redirects',
            'retour/redirects/<siteHandle:{handle}>' => 'retour/redirects/redirects',

            'retour/edit-redirect/<redirectId:\d+>' => 'retour/redirects/edit-redirect',

            'retour/add-redirect' => 'retour/redirects/edit-redirect',
            'retour/add-redirect/<siteId:\d+>' => 'retour/redirects/edit-redirect',

            'retour/dashboard' => 'retour/statistics/dashboard',
            'retour/dashboard/<siteHandle:{handle}>' => 'retour/statistics/dashboard',

            'retour/settings' => 'retour/settings/plugin-settings',
        ];
    }

    /**
     * Return the custom frontend routes
     *
     * @return array
     */
    protected function customFrontendRoutes(): array
    {
        return [
        ];
    }

    /**
     * Returns the custom Control Panel cache options.
     *
     * @return array
     */
    protected function customAdminCpCacheOptions(): array
    {
        return [
            [
                'key' => 'retour-redirect-caches',
                'label' => Craft::t('retour', 'Retour redirect caches'),
                'action' => [self::$plugin->redirects, 'invalidateCaches'],
            ],
        ];
    }

    /**
     * Returns the custom Control Panel user permissions.
     *
     * @return array
     */
    protected function customAdminCpPermissions(): array
    {
        return [
            'retour:dashboard' => [
                'label' => Craft::t('retour', 'Dashboard'),
            ],
            'retour:redirects' => [
                'label' => Craft::t('retour', 'Redirects'),
            ],
            'retour:settings' => [
                'label' => Craft::t('retour', 'Settings'),
            ],
        ];
    }
}