nystudio107 / craft-retour

src/controllers/TablesController.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\controllers;

use Craft;
use craft\db\Query;
use craft\errors\SiteNotFoundException;
use craft\helpers\ElementHelper;
use craft\web\Controller;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use nystudio107\retour\helpers\UrlHelper;
use yii\web\BadRequestHttpException;
use yii\web\ForbiddenHttpException;
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 TablesController extends Controller
{
    // Constants
    // =========================================================================

    protected const HANDLED_MAP = [
        'handled' => 1,
        'nothandled' => 0,
    ];

    protected const SORT_MAP = [
        'DESC' => SORT_DESC,
        'ASC' => SORT_ASC,
    ];

    protected const ALLOWED_STATS_SORT_FIELDS = [
        'redirectSrcUrl',
        'referrerUrl',
        'remoteIp',
        'hitCount',
        'hitLastTime',
        'handledByRetour',
    ];

    protected const ALLOWED_REDIRECTS_SORT_FIELDS = [
        'redirectSrcUrl',
        'redirectDestUrl',
        'redirectMatchType',
        'siteId',
        'redirectHttpCode',
        'priority',
        'hitCount',
        'hitLastTime',
    ];

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    protected array|bool|int $allowAnonymous = [
    ];

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

    /**
     * Handle requests for the dashboard statistics table
     *
     * @param string $sort

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param int $page

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     * @param int $per_page

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     * @param string $filter

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param int $siteId

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     * @param string|null $handled

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     * @throws BadRequestHttpException
     */
    public function actionDashboard(
        string $sort = 'hitCount|desc',
        int    $page = 1,
        int    $per_page = 20,
               $filter = '',

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

               $siteId = 0,

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

               $handled = 'all',

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

    ): Response {
        PermissionHelper::controllerPermissionCheck('retour:dashboard');
        $data = [];
        $sortField = 'hitCount';
        $sortType = 'DESC';
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        $sortType = strtoupper($sortType);
        $sortType = self::SORT_MAP[$sortType] ?? self::SORT_MAP['DESC'];
        // Validate untrusted data
        if (!in_array($sortField, self::ALLOWED_STATS_SORT_FIELDS, true)) {
            throw new BadRequestHttpException(Craft::t('retour', 'Invalid sort field specified.'));
        }
        // Query the db table
        $offset = ($page - 1) * $per_page;
        $query = (new Query())
            ->from(['{{%retour_stats}}'])
            ->offset($offset)
            ->limit($per_page)
            ->orderBy([$sortField => $sortType])
            ->filterWhere(['like', 'redirectSrcUrl', $filter])
            ->orFilterWhere(['like', 'referrerUrl', $filter]);
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }
        if ($handled !== 'all') {
            $query->andWhere(['handledByRetour' => self::HANDLED_MAP[$handled]]);
        }
        $stats = $query->all();
        if ($stats) {
            // Add in the `addLink` field
            foreach ($stats as &$stat) {
                // Normalize the `redirectSrcUrl` to point to a valid frontend site URL
                $stat['redirectSrcUrlFull'] = $stat['redirectSrcUrl'];
                if (!UrlHelper::isAbsoluteUrl($stat['redirectSrcUrlFull'])) {
                    $sites = Craft::$app->getSites();
                    $site = $sites->getSiteById($stat['siteId'], true);
                    if ($site) {
                        $stat['redirectSrcUrlFull'] = UrlHelper::mergeUrlWithPath($site->baseUrl, $stat['redirectSrcUrlFull']);
                    }
                }
                $stat['addLink'] = '';
                if (!$stat['handledByRetour']) {
                    $encodedUrl = urlencode('/' . ltrim($stat['redirectSrcUrl'], '/'));
                    // Add the siteId to the URL, but keep the current behavior of passing in siteId=0 for "all"
                    $statSiteId = $stat['siteId'] ?? 0;
                    try {
                        $primarySite = Craft::$app->getSites()->getPrimarySite();
                    } catch (SiteNotFoundException $e) {
                        $primarySite = null;
                    }
                    if ($primarySite !== null && $statSiteId == (int)$primarySite->id) {
                        $statSiteId = 0;
                    }
                    $stat['addLink'] = UrlHelper::cpUrl('retour/add-redirect', [

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

                        'defaultUrl' => $encodedUrl,
                        'siteId' => $statSiteId,
                    ]);

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

                }
            }
            // Format the data for the API
            $data['data'] = $stats;
            $count = $query->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

        return $this->asJson($data);
    }

    /**

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

     * Handle requests for the dashboard redirects table
     *
     * @param string $sort

Missing parameter comment

     * @param int $page

Expected 4 spaces after parameter type; 1 found

Missing parameter comment

     * @param int $per_page

Expected 4 spaces after parameter type; 1 found

Missing parameter comment

     * @param string $filter

Missing parameter comment

     * @param int $siteId

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return Response
     * @throws ForbiddenHttpException
     * @throws BadRequestHttpException
     */
    public function actionRedirects(
        string $sort = 'hitCount|desc',
        int    $page = 1,
        int    $per_page = 20,
               $filter = '',

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

               $siteId = 0,

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

               $shortLinks = false,

Multi-line function declaration not indented correctly; expected 8 spaces but found 15

    ): Response {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $data = [];
        $sortField = 'hitCount';
        $sortType = 'DESC';
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        $sortType = strtoupper($sortType);
        $sortType = self::SORT_MAP[$sortType] ?? self::SORT_MAP['DESC'];
        // Validate untrusted data
        if (!in_array($sortField, self::ALLOWED_REDIRECTS_SORT_FIELDS, true)) {
            throw new BadRequestHttpException(Craft::t('retour', 'Invalid sort field specified.'));
        }
        // Query the db table
        $offset = ($page - 1) * $per_page;
        $query = (new Query())
            ->from(['{{%retour_static_redirects}}'])
            ->offset($offset)
            ->limit($per_page)
            ->orderBy([$sortField => $sortType])
            ->filterWhere(['like', 'redirectSrcUrl', $filter])
            ->orFilterWhere(['like', 'redirectDestUrl', $filter]);
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }
        if ($shortLinks) {
            $query->andWhere(['not', ['associatedElementId' => 0]]);
        } else {
            $query->andWhere(['associatedElementId' => 0]);
        }
        $redirects = $query->all();
        // Add in the `deleteLink` field and clean up the redirects
        foreach ($redirects as &$redirect) {
            // Handle short links by adding the element's title and CP URL
            if ($shortLinks) {
                $redirect['elementTitle'] = '';
                $redirect['elementCpUrl'] = '';
                $elementId = $redirect['associatedElementId'] ?? null;
                $elementSiteId = $redirect['siteId'] ?? null;
                if (!empty($elementId)) {
                    $element = Craft::$app->getElements()->getElementById($elementId, null, $elementSiteId);
                    if ($element) {
                        $element = ElementHelper::rootElement($element);

The function craft\helpers\ElementHelper::rootElement() has been deprecated: in 5.4.0. Use [[ElementInterface::getRootOwner()]] instead.

                        $redirect['elementTitle'] = $element->title;
                        $redirect['elementCpUrl'] = $element->getCpEditUrl();
                    }
                }
            }
            // Make sure the destination URL is not a regex
            if ($redirect['redirectMatchType'] !== 'exactmatch') {
                if (preg_match("/\$\d+/", $redirect['redirectDestUrl'])) {
                    $redirect['redirectDestUrl'] = '';
                }
            }
            // Handle extracting the site name
            $redirect['siteName'] = Craft::t('retour', 'All Sites');
            if ($redirect['siteId']) {
                $sites = Craft::$app->getSites();
                $site = $sites->getSiteById($redirect['siteId']);
                if ($site) {
                    $redirect['siteName'] = $site->name;
                }
            }

            $redirect['editLink'] = UrlHelper::cpUrl('retour/edit-redirect/' . $redirect['id']);
        }
        // Format the data for the API
        if ($redirects) {
            $data['data'] = $redirects;
            $count = $query->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

        return $this->asJson($data);
    }

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