TablesController::actionRedirects() - Code Metrics - nystudio107/craft-retour - Measure and Improve Code Quality continuously with Scrutinizer

TablesController::actionRedirects() F
last analyzed 2025-01-09 03:26 UTC

↳ Parent: TablesController
Complexity

Conditions	16
Paths	1335
Size

Total Lines	96
Code Lines	63
Duplication

Lines	0
Ratio	0 %
Importance

Changes	4
Bugs	2	Features	0
Metric	Value
eloc	63
dl	0
loc	96
rs	1.4
c	4
b	2
f	0
cc	16
nc	1335
nop	6
How to fix Long Method Complexity

<?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/

 * @copyright Copyright (c) 2018 nystudio107

 */


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;

/**

 * @author    nystudio107

 * @package   Retour

 * @since     3.0.0

 */

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
    // =========================================================================

    /**

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

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

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

     * @param int $page

     * @param int $per_page

     * @param string $filter

     * @param int $siteId

     * @param string|null $handled

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

               $siteId = 0,

               $handled = 'all',

    ): 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', [

                        'defaultUrl' => $encodedUrl,
                        'siteId' => $statSiteId,
                    ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis 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);
    }

    /**

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

     * @param int $page

     * @param int $per_page

     * @param string $filter

     * @param int $siteId

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

               $siteId = 0,

               $shortLinks = false,

    ): 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);
                        $element = /** @scrutinizer ignore-deprecated */ ElementHelper::rootElement($element);
                        $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
    // =========================================================================
}

nystudio107 / craft-retour

TablesController::actionRedirects() F last analyzed 2025-01-09 03:26 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

TablesController::actionRedirects() F
last analyzed 2025-01-09 03:26 UTC
