nystudio107 / craft-retour

src/controllers/FileController.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\MissingComponentException;
use craft\helpers\ArrayHelper;
use craft\helpers\UrlHelper;
use craft\web\Controller;
use League\Csv\AbstractCsv;
use League\Csv\Exception;
use League\Csv\Reader;
use League\Csv\Statement;
use League\Csv\Writer;
use nystudio107\retour\assetbundles\retour\RetourImportAsset;
use nystudio107\retour\helpers\FileLog;
use nystudio107\retour\helpers\MultiSite as MultiSiteHelper;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use nystudio107\retour\helpers\Version as VersionHelper;
use nystudio107\retour\Retour;
use SplTempFileObject;
use yii\base\InvalidConfigException;
use yii\web\BadRequestHttpException;
use yii\web\ForbiddenHttpException;
use yii\web\MethodNotAllowedHttpException;
use yii\web\NotFoundHttpException;
use yii\web\Response;
use yii\web\UploadedFile;

/**

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

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

    public const LOG_FILE_NAME = 'retour-csv-import-errors';

    protected const EXPORT_REDIRECTS_CSV_FIELDS = [
        'redirectSrcUrl' => 'Legacy URL Pattern',
        'redirectDestUrl' => 'Redirect To',
        'redirectMatchType' => 'Match Type',
        'redirectHttpCode' => 'HTTP Status',
        'siteId' => 'Site ID',
        'redirectSrcMatch' => 'Legacy URL Match Type',
        'hitCount' => 'Hits',
        'associatedElementId' => 'Short Link Element ID',
        'hitLastTime' => 'Last Hit',
        'priority' => 'Priority',
    ];

    protected const EXPORT_STATISTICS_CSV_FIELDS = [
        'redirectSrcUrl' => '404 File Not Found URL',
        'referrerUrl' => 'Last Referrer URL',
        'remoteIp' => 'Remote IP',
        'hitCount' => 'Hits',
        'hitLastTime' => 'Last Hit',
        'handledByRetour' => 'Handled',
        'siteId' => 'Site ID',
    ];

    protected const IMPORT_REDIRECTS_CSV_FIELDS = [
        'redirectSrcUrl',
        'redirectDestUrl',
        'redirectMatchType',
        'redirectHttpCode',
        'siteId',
        'redirectSrcMatch',
        'hitCount',
        'associatedElementId',
        'priority',
    ];

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

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

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

    /**

Missing short description in doc comment

     * @throws BadRequestHttpException
     * @throws Exception
     * @throws ForbiddenHttpException
     * @throws MissingComponentException
     * @throws MethodNotAllowedHttpException
     */

Missing @return tag in function comment

    public function actionImportCsvColumns(): void
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        // If your CSV document was created or is read on a Macintosh computer,
        // add the following lines before using the library to help PHP detect line ending in Mac OS X
        if (!ini_get('auto_detect_line_endings')) {
            ini_set('auto_detect_line_endings', '1');
        }
        $csv = null;

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

        $this->requirePostRequest();
        $filename = Craft::$app->getRequest()->getRequiredBodyParam('filename');
        $columns = Craft::$app->getRequest()->getRequiredBodyParam('columns');
        $headers = null;
        // Log the import
        Filelog::delete(self::LOG_FILE_NAME);
        FileLog::create(self::LOG_FILE_NAME, 'nystudio107\retour\*');
        try {
            $csv = Reader::createFromPath($filename);
            $csv->setDelimiter(Retour::$settings->csvColumnDelimiter ?? ',');
            $headers = array_flip($csv->fetchOne(0));

The function League\Csv\Reader::fetchOne() has been deprecated: since version 9.9.0

        } catch (\Exception $e) {
            // If this throws an exception, try to read the CSV file from the data cache
            // This can happen on load balancer setups where the Craft temp directory isn't shared
            $cache = Craft::$app->getCache();
            $cachedFile = $cache->get($filename);
            if ($cachedFile !== false) {
                $csv = Reader::createFromString($cachedFile);
                try {
                    $csv->setDelimiter(Retour::$settings->csvColumnDelimiter ?? ',');
                } catch (Exception $e) {
                    Craft::error($e, __METHOD__);
                }
                $headers = array_flip($csv->fetchOne(0));

The function League\Csv\Reader::fetchOne() has been deprecated: since version 9.9.0

                $cache->delete($filename);
            } else {
                Craft::error("Could not import ${$filename} from the file system, or the cache.", __METHOD__);
            }
        }
        $hasErrors = false;
        // If we have headers, then we have a file, so parse it
        if ($csv && $headers) {
            switch (VersionHelper::getLeagueCsvVersion()) {
                case 8:

Line indented incorrectly; expected 12 spaces, found 16

                    $hasErrors = $this->importCsvApi8($csv, $columns, $headers);
                    break;
                case 9:

Line indented incorrectly; expected 12 spaces, found 16

                    $hasErrors = $this->importCsvApi9($csv, $columns, $headers);
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    Craft::$app->getSession()->setNotice(Craft::t('retour', 'Unknown league/csv package API version'));
                    break;
            }
            @unlink($filename);

It seems like you do not handle an error condition for unlink(). This can introduce security issues, and is generally not recommended.

            Retour::$plugin->clearAllCaches();

The method clearAllCaches() does not exist on null.

            Craft::$app->getSession()->setNotice(Craft::t('retour', 'Redirects imported from CSV file.'));
        } else {
            Craft::$app->getSession()->setError(Craft::t('retour', 'Redirects could not be imported.'));
        }
        if ($hasErrors) {
            $this->redirect(UrlHelper::actionUrl('retour/file/display-errors'));
        } else {
            $this->redirect('retour/redirects');
        }
    }

    /**

Missing short description in doc comment

     * @param string|null $siteHandle

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     * @throws NotFoundHttpException
     */
    public function actionImportCsv(string $siteHandle = null): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        // If your CSV document was created or is read on a Macintosh computer,
        // add the following lines before using the library to help PHP detect line ending in Mac OS X
        if (!ini_get('auto_detect_line_endings')) {
            ini_set('auto_detect_line_endings', '1');
        }
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'Import CSV File');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourImportAsset::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'] = 'file';

        // Basic variables
        $variables['fullPageForm'] = true;
        $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' => 'Redirects',
                'url' => UrlHelper::cpUrl('retour/redirects' . $siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - Redirects - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'redirects';

        // The CSV file
        $file = UploadedFile::getInstanceByName('file');
        if ($file !== null) {
            $filename = uniqid($file->name, true);
            $filePath = Craft::$app->getPath()->getTempPath() . DIRECTORY_SEPARATOR . $filename;
            $file->saveAs($filePath, false);
            // Also save the file to the cache as a backup way to access it
            $fileContents = @file_get_contents($filePath);
            if ($fileContents) {
                Craft::$app->getCache()->set($filePath, $fileContents);
            }
            // Read in the headers
            $csv = Reader::createFromPath($file->tempName);
            try {
                $csv->setDelimiter(Retour::$settings->csvColumnDelimiter ?? ',');
            } catch (Exception $e) {
                Craft::error($e, __METHOD__);
            }
            $headers = $csv->fetchOne(0);

The function League\Csv\Reader::fetchOne() has been deprecated: since version 9.9.0

            Craft::info(print_r($headers, true), __METHOD__);

It seems like print_r($headers, true) can also be of type true; however, parameter $message of yii\BaseYii::info() does only seem to accept array|string, maybe add an additional type check?

            $variables['headers'] = $headers;
            $variables['filename'] = $filePath;
        }

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

    /**
     * Display the error log if something went wrong
     *
     * @return Response
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionDisplayErrors(): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'CSV File Import Errors');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourImportAsset::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.

        );
        // 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'),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - Redirects - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'redirects';
        // The error log
        $variables['errorLogContents'] = FileLog::getContents(self::LOG_FILE_NAME);

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

    /**
     * Export the statistics table as a CSV file
     *
     * @throws ForbiddenHttpException
     */

Missing @return tag in function comment

    public function actionExportStatistics(): void
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        //Allow the fields to be localized
        $fields = self::EXPORT_STATISTICS_CSV_FIELDS;
        foreach ($fields as $key => $field) {
            $fields[$key] = Craft::t('retour', $field);
        }
        $this->exportCsvFile('retour-statistics', '{{%retour_stats}}', $fields);
    }

    /**
     * Export the redirects table as a CSV file
     *
     * @throws ForbiddenHttpException
     */

Missing @return tag in function comment

    public function actionExportRedirects(): void
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        //Allow the fields to be localized
        $fields = self::EXPORT_REDIRECTS_CSV_FIELDS;
        foreach ($fields as $key => $field) {
            $fields[$key] = Craft::t('retour', $field);
        }
        $this->exportCsvFile('retour-redirects', '{{%retour_static_redirects}}', $fields);
    }


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

    /**

Missing short description in doc comment

     * @param AbstractCsv $csv

Missing parameter comment

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

     * @param array $columns

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

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

     * @param array $headers

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

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

     * @return bool whether the import has any errors

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

     */
    protected function importCsvApi8(AbstractCsv $csv, array $columns, array $headers): bool
    {
        $hasErrors = false;
        /** @phpstan-ignore-next-line */

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

        $csv->setOffset(1);

The method setOffset() does not exist on League\Csv\AbstractCsv.

        $columns = ArrayHelper::filterEmptyStringsFromArray($columns);
        $rowIndex = 1;
        /** @phpstan-ignore-next-line */

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

        $csv->each(function($row) use ($headers, $columns, &$rowIndex, &$hasErrors) {

The method each() does not exist on League\Csv\AbstractCsv. It seems like you code against a sub-type of League\Csv\AbstractCsv such as League\Csv\Reader.

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

Expected 1 space after FUNCTION keyword; 0 found

            $redirectConfig = [
                'id' => 0,
            ];
            $index = 0;
            foreach (self::IMPORT_REDIRECTS_CSV_FIELDS as $importField) {
                if (isset($columns[$index], $headers[$columns[$index]])) {
                    $redirectConfig[$importField] = empty($row[$headers[$columns[$index]]])
                        ? null
                        : $row[$headers[$columns[$index]]];
                }
                $index++;
            }
            $redirectDump = print_r($redirectConfig, true);
            Craft::debug("-> ROW #$rowIndex contents: " . $redirectDump, __METHOD__);

Are you sure $redirectDump of type string|true can be used in concatenation?

            if (!Retour::$plugin->redirects->saveRedirect($redirectConfig)) {

The method saveRedirect() does not exist on null.

                Craft::info("-> ROW #$rowIndex contents: " . $redirectDump, __METHOD__);
                $hasErrors = true;
            }
            $rowIndex++;

            return true;
        });

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

        return $hasErrors;
    }

    /**

Missing short description in doc comment

     * @param Reader $csv

Missing parameter comment

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

     * @param array $columns

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @param array $headers

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @return bool whether the import has any errors

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

     * @throws Exception

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

     */
    protected function importCsvApi9(Reader $csv, array $columns, array $headers): bool
    {
        $hasErrors = false;
        $stmt = (new Statement())
            ->offset(1);
        $rows = $stmt->process($csv);
        $columns = ArrayHelper::filterEmptyStringsFromArray($columns);
        $rowIndex = 1;
        foreach ($rows as $row) {
            $redirectConfig = [
                'id' => 0,
            ];
            $index = 0;
            foreach (self::IMPORT_REDIRECTS_CSV_FIELDS as $importField) {
                if (isset($columns[$index], $headers[$columns[$index]])) {
                    $redirectConfig[$importField] = empty($row[$headers[$columns[$index]]])
                        ? null
                        : $row[$headers[$columns[$index]]];
                }
                $index++;
            }
            $redirectDump = print_r($redirectConfig, true);
            Craft::debug("-> ROW #$rowIndex contents: " . $redirectDump, __METHOD__);

Are you sure $redirectDump of type string|true can be used in concatenation?

            if (!Retour::$plugin->redirects->saveRedirect($redirectConfig)) {
                Craft::info("-> ROW #$rowIndex contents: " . $redirectDump, __METHOD__);
                $hasErrors = true;
            }
            $rowIndex++;
        }

        return $hasErrors;
    }

    /**

Missing short description in doc comment

     * @param string $filename

Missing parameter comment

     * @param string $table

Missing parameter comment

     * @param array $columns

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    protected function exportCsvFile(string $filename, string $table, array $columns): void
    {
        // If your CSV document was created or is read on a Macintosh computer,
        // add the following lines before using the library to help PHP detect line ending in Mac OS X
        if (!ini_get('auto_detect_line_endings')) {
            ini_set('auto_detect_line_endings', '1');
        }
        // Query the db table
        $data = (new Query())
            ->from([$table])
            ->select(array_keys($columns))
            ->orderBy('hitCount DESC')
            ->all();
        // Create our CSV file writer
        $csv = Writer::createFromFileObject(new SplTempFileObject());
        try {
            $csv->setDelimiter(Retour::$settings->csvColumnDelimiter ?? ',');
        } catch (Exception $e) {
            Craft::error($e, __METHOD__);
        }
        $csv->insertOne(array_values($columns));
        $csv->insertAll($data);
        $csv->output($filename . '.csv');

The function League\Csv\AbstractCsv::output() has been deprecated: since version 9.18.0

        exit(0);

Using exit here is not recommended.

    }
}