nystudio107\retour\controllers\RedirectsController

Complexity

Total Complexity

36

Size/Duplication

Total Lines	388
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	actionRedirects()	0	44	3
B	actionEditRedirect()	0	89	9
B	actionSaveRedirect()	0	57	7
A	actionDeleteRedirects()	0	22	4
A	addSlashToSiteUrls()	0	18	6
A	actionShortlinks()	0	44	3
A	actionDeleteShortlinks()	0	22	4

<?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\controllers;

use Craft;
use craft\errors\ElementNotFoundException;
use craft\errors\MissingComponentException;
use craft\helpers\UrlHelper;
use craft\web\Controller;
use craft\web\UrlManager;
use nystudio107\retour\assetbundles\retour\RetourAsset;
use nystudio107\retour\assetbundles\retour\RetourRedirectsAsset;
use nystudio107\retour\helpers\MultiSite as MultiSiteHelper;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use nystudio107\retour\models\StaticRedirects as StaticRedirectsModel;
use nystudio107\retour\Retour;
use yii\base\Exception;
use yii\base\InvalidConfigException;
use yii\web\BadRequestHttpException;
use yii\web\ForbiddenHttpException;
use yii\web\MethodNotAllowedHttpException;
use yii\web\NotFoundHttpException;
use yii\web\Response;

/**

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 RedirectsController extends Controller
{
    // Constants
    // =========================================================================

    protected const DOCUMENTATION_URL = 'https://github.com/nystudio107/craft-retour/';

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

    protected array|bool|int $allowAnonymous = [];

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

    /**
     * Show the redirects table
     *
     * @param string|null $siteHandle

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     * @throws NotFoundHttpException
     */
    public function actionRedirects(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'Redirects');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourRedirectsAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/retour/web/assets/dist',
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'redirects';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/' . $siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('retour'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('retour/redirects' . $siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'redirects';

        // Render the template
        return $this->renderTemplate('retour/redirects/index', $variables);
    }

    /**
     * Edit the redirect
     *
     * @param int $redirectId

Missing parameter comment

Expected 23 spaces after parameter type; 1 found

     * @param string $defaultUrl

Missing parameter comment

Expected 20 spaces after parameter type; 1 found

     * @param int $siteId

Missing parameter comment

Expected 23 spaces after parameter type; 1 found

     * @param null|StaticRedirectsModel $redirect

Missing parameter comment

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws ForbiddenHttpException
     */
    public function actionEditRedirect(
        int                  $redirectId = 0,
        string               $defaultUrl = '',
        int                  $siteId = 0,
        StaticRedirectsModel $redirect = null,
    ): Response {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:redirects');

        // Load in the redirect
        if ($redirectId === 0) {
            $redirect = new StaticRedirectsModel([

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

                'id' => 0,
                'siteId' => $siteId,
                'redirectSrcUrl' => urldecode($defaultUrl),
            ]);

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

        }
        if ($redirect === null) {
            $redirectConfig = Retour::$plugin->redirects->getRedirectById($redirectId);

The method getRedirectById() does not exist on null.

            if ($redirectConfig === null) {
                $redirectConfig = [];
                Craft::error(
                    Craft::t(
                        'retour',
                        "Couldn't load redirect id {id}",
                        ['id' => $redirectId]
                    ),
                    __METHOD__
                );
            }
            $redirect = new StaticRedirectsModel($redirectConfig);
        }
        $redirect->validate();
        // Ensure the user has permissions to edit this redirect
        $sites = Craft::$app->getSites();
        if ($redirect->siteId) {

The expression $redirect->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.

            $site = $sites->getSiteById($redirect->siteId);
            if ($site) {
                MultiSiteHelper::requirePermission('editSite:' . $site->uid);
            }
        }
        if ($siteId) {
            $site = $sites->getSiteById($siteId);
            if ($site) {
                MultiSiteHelper::requirePermission('editSite:' . $site->uid);
            }
        }
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'Edit Redirect');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/retour/web/assets/dist',
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        // Sites menu
        MultiSiteHelper::setSitesMenuVariables($variables);
        $variables['controllerHandle'] = 'redirects';

        // Basic variables
        $variables['fullPageForm'] = true;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('retour'),
            ],
            [
                'label' => 'Redirects',
                'url' => UrlHelper::cpUrl('retour/redirects'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('retour/edit-redirect/' . $redirectId),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - Redirects - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'redirects';
        $variables['redirect'] = $redirect;

        // Render the template
        return $this->renderTemplate('retour/redirects/_edit', $variables);
    }

    /**

Missing short description in doc comment

     * @return ?Response
     * @throws MissingComponentException
     * @throws ForbiddenHttpException
     * @throws BadRequestHttpException
     */
    public function actionDeleteRedirects(): ?Response
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $request = Craft::$app->getRequest();
        $redirectIds = $request->getRequiredBodyParam('redirectIds');
        $stickyError = false;
        foreach ($redirectIds as $redirectId) {
            if (Retour::$plugin->redirects->deleteRedirectById($redirectId) === 0) {
                $stickyError = true;
            }
        }
        Retour::$plugin->clearAllCaches();

The method clearAllCaches() does not exist on null.

        // Handle any cumulative errors
        if (!$stickyError) {
            // Clear the caches and continue on
            Craft::$app->getSession()->setNotice(Craft::t('retour', 'Retour redirects deleted.'));

            return $this->redirect('retour/redirects');
        }
        Craft::$app->getSession()->setError(Craft::t('retour', "Couldn't delete redirect."));

        return null;
    }

    /**
     * Save the redirect
     *
     * @return null|Response
     * @throws MissingComponentException
     * @throws BadRequestHttpException
     * @throws ForbiddenHttpException
     * @throws NotFoundHttpException
     * @throws MethodNotAllowedHttpException
     */
    public function actionSaveRedirect(): ?Response
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $this->requirePostRequest();
        $redirectConfig = Craft::$app->getRequest()->getRequiredBodyParam('redirectConfig');
        if ($redirectConfig === null) {
            throw new NotFoundHttpException('Redirect not found');
        }
        $redirectConfig['id'] = (int)$redirectConfig['id'];
        // Handle enforcing trailing slashes
        $generalConfig = Craft::$app->getConfig()->getGeneral();
        if ($generalConfig->addTrailingSlashesToUrls && $redirectConfig['redirectMatchType'] === 'exactmatch') {
            $destUrl = $redirectConfig['redirectDestUrl'] ?? '';
            $redirectConfig['redirectDestUrl'] = $this->addSlashToSiteUrls($destUrl);
        }
        // Handle URL encoded URLs by decoding them before saving them
        if ($redirectConfig['redirectMatchType'] === 'exactmatch') {
            $redirectConfig['redirectSrcUrl'] = urldecode($redirectConfig['redirectSrcUrl'] ?? '');
            $redirectConfig['redirectSrcUrlParsed'] = urldecode($redirectConfig['redirectSrcUrlParsed'] ?? '');
        }
        $redirect = new StaticRedirectsModel($redirectConfig);
        // Make sure the redirect validates
        if (!$redirect->validate()) {
            Craft::$app->getSession()->setError(Craft::t('app', "Couldn't save redirect settings."));
            // Send the redirect back to the template
            /** @var UrlManager $urlManager */

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

            $urlManager = Craft::$app->getUrlManager();
            $urlManager->setRouteParams([

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

                'redirect' => $redirect,
            ]);

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

            return null;
        }
        // Save the redirect
        $redirectConfig = $redirect->getAttributes();
        Retour::$plugin->redirects->saveRedirect($redirectConfig);
        // Handle the case where the redirect wasn't saved because it'd create a redirect loop
        $testRedirectConfig = Retour::$plugin->redirects->getRedirectByRedirectSrcUrl(
            $redirectConfig['redirectSrcUrl'],
            $redirectConfig['siteId']
        );
        if ($testRedirectConfig === null) {
            Craft::$app->getSession()->setError(Craft::t('app', "Couldn't save redirect settings because it'd create a redirect loop."));
            // Send the redirect back to the template
            /** @var UrlManager $urlManager */

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

            $urlManager = Craft::$app->getUrlManager();
            $urlManager->setRouteParams([

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

                'redirect' => $redirect,
            ]);

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

            return null;
        }
        // Clear the caches and continue on
        Retour::$plugin->clearAllCaches();
        Craft::$app->getSession()->setNotice(Craft::t('retour', 'Redirect settings saved.'));

        return $this->redirectToPostedUrl();
    }

    /**
     * Show the short links table
     *
     * @param string|null $siteHandle

Missing parameter comment

     *
     * @return Response
     * @throws \yii\web\ForbiddenHttpException
     * @throws \yii\web\NotFoundHttpException
     */
    public function actionShortlinks(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:shortlinks');
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'Short Links');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourRedirectsAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/retour/web/assets/dist',
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'shortlinks';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/' . $siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('retour'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('retour/shortlinks' . $siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'shortlinks';

        // Render the template
        return $this->renderTemplate('retour/shortlinks/index', $variables);
    }

    /**

Missing short description in doc comment

     * @return Response|void
     * @throws BadRequestHttpException
     * @throws ForbiddenHttpException
     * @throws MissingComponentException
     * @throws \Throwable
     * @throws ElementNotFoundException
     * @throws Exception
     */
    public function actionDeleteShortlinks()
    {
        PermissionHelper::controllerPermissionCheck('retour:shortlinks');
        $request = Craft::$app->getRequest();
        $redirectIds = $request->getRequiredBodyParam('redirectIds');
        $stickyError = false;
        foreach ($redirectIds as $redirectId) {
            if (Retour::$plugin->redirects->deleteShortlinkById($redirectId)) {
                $stickyError = true;
            }
        }
        Retour::$plugin->clearAllCaches();
        // Handle any cumulative errors
        if (!$stickyError) {
            // Clear the caches and continue on
            Craft::$app->getSession()->setNotice(Craft::t('retour', 'Retour Short Links deleted.'));

            return $this->redirect('retour/shortlinks');
        }
        Craft::$app->getSession()->setError(Craft::t('retour', "Couldn't delete Short Link."));

        return;
    }

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

    /**
     * If the $url appears to be a site URL, add a slash to the end of it
     *
     * @param string $url

Missing parameter comment

     *
     * @return string
     */
    protected function addSlashToSiteUrls(string $url): string
    {
        // Make sure the URL doesn't end with a file extension, e.g.: .jpg or have a query string
        if (!preg_match('/\.[^\/]+$/', $url) && strpos($url, '?') === false) {
            // If it's a root relative URL, assume it's a site URL
            if (UrlHelper::isRootRelativeUrl($url)) {
                return rtrim($url, '/') . '/';
            }
            // If the URL matches any of the site's base URLs, assume it's a site URL
            $sites = Craft::$app->getSites()->getAllSites();
            foreach ($sites as $site) {
                if (strpos($url, $site->getBaseUrl()) === 0) {
                    return rtrim($url, '/') . '/';
                }
            }
        }

        return $url;
    }
}