nystudio107\retour\controllers\FileController

Complexity

Total Complexity

27

Size/Duplication

Total Lines	292
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	8
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	importCsvApi8()	0	21	4
A	importCsvApi9()	0	22	5
A	actionExportStatistics()	0	4	1
B	actionImportCsv()	0	73	7
A	exportCsvFile()	0	19	2
B	actionImportCsvColumns()	0	49	7
A	actionExportRedirects()	0	4	1

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

use nystudio107\retour\Retour;
use nystudio107\retour\assetbundles\retour\RetourImportAsset;
use nystudio107\retour\helpers\MultiSite as MultiSiteHelper;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use nystudio107\retour\helpers\Version as VersionHelper;

use Craft;
use craft\db\Query;
use craft\helpers\ArrayHelper;
use craft\helpers\UrlHelper;
use craft\web\Controller;

use yii\base\InvalidConfigException;
use yii\web\Response;
use yii\web\UploadedFile;

use League\Csv\AbstractCsv;
use League\Csv\Reader;
use League\Csv\Statement;

The type League\Csv\Statement was not found. Maybe you did not declare it correctly or list all dependencies?

use League\Csv\Writer;

/**

Missing short description in doc comment

 * @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

The tag in position 3 should be the @author tag

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

 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class FileController extends Controller
{
    // Constants
    // =========================================================================

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

    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',
        'hitLastTime' => 'Last Hit',
    ];

    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',
    ];

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

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

    protected $allowAnonymous = [];

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

    /**

Missing short description in doc comment

     * @throws \yii\web\BadRequestHttpException
     * @throws \yii\web\ForbiddenHttpException
     * @throws \craft\errors\MissingComponentException
     */

Missing @return tag in function comment

    public function actionImportCsvColumns()
    {
        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');
        }
        $this->requirePostRequest();
        $filename = Craft::$app->getRequest()->getRequiredBodyParam('filename');
        $columns = Craft::$app->getRequest()->getRequiredBodyParam('columns');
        $headers = null;

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

        $csv = Reader::createFromPath($filename);
        try {
            $headers = array_flip($csv->fetchOne(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);
                $headers = array_flip($csv->fetchOne(0));
                $cache->delete($filename);
            } else {
                Craft::error("Could not import ${$filename} from the file system, or the cache.", __METHOD__);
            }
        }
        // If we have headers, then we have a file, so parse it
        if ($headers !== null) {
            switch (VersionHelper::getLeagueCsvVersion()) {
                case 8:

Line indented incorrectly; expected 12 spaces, found 16

                    $this->importCsvApi8($csv, $columns, $headers);

It seems like $columns can also be of type null and string; however, parameter $columns of nystudio107\retour\controllers\FileController::importCsvApi8() does only seem to accept array, maybe add an additional type check?

                    break;
                case 9:

Line indented incorrectly; expected 12 spaces, found 16

                    $this->importCsvApi9($csv, $columns, $headers);

It seems like $columns can also be of type null and string; however, parameter $columns of nystudio107\retour\controllers\FileController::importCsvApi9() does only seem to accept array, maybe add an additional type check?

                    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 $filename can also be of type array and null; however, parameter $filename of unlink() does only seem to accept string, maybe add an additional type check?

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();
            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.'));
        }

        $this->redirect('retour/redirects');
    }

    /**

Missing short description in doc comment

     * @param string|null $siteHandle

Missing parameter comment

     *
     * @return Response
     * @throws \yii\web\ForbiddenHttpException
     * @throws \yii\web\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/assetbundles/retour/dist',
            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
            $cache = Craft::$app->getCache();
            $fileHandle = fopen($filePath, 'r');
            if ($fileHandle) {

$fileHandle is of type resource, thus it always evaluated to false.

                $fileContents = fgets($fileHandle);
                if ($fileContents) {
                    $cache->set($filePath, $fileContents);
                }
                fclose($fileHandle);
            }
            // Read in the headers
            $csv = Reader::createFromPath($file->tempName);
            $headers = $csv->fetchOne(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);
    }

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

Missing @return tag in function comment

    public function actionExportStatistics()
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $this->exportCsvFile('retour-statistics', '{{%retour_stats}}', self::EXPORT_STATISTICS_CSV_FIELDS);
    }

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

Missing @return tag in function comment

    public function actionExportRedirects()
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $this->exportCsvFile('retour-redirects', '{{%retour_static_redirects}}', self::EXPORT_REDIRECTS_CSV_FIELDS);
    }

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

    /**

Missing short description in doc comment

     * @param string $filename

Missing parameter comment

     * @param string $table

Missing parameter comment

     * @param array  $columns

Missing parameter comment

     */

Missing @return tag in function comment

    protected function exportCsvFile(string $filename, string $table, array $columns)
    {
        // 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());
        $csv->insertOne(array_values($columns));
        $csv->insertAll($data);
        $csv->output($filename.'.csv');
        exit(0);

Using exit here is not recommended.

    }

    /**

Missing short description in doc comment

     * @param AbstractCsv $csv

Missing parameter comment

     * @param array $columns

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $headers

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     */

Missing @return tag in function comment

    protected function importCsvApi8(AbstractCsv $csv, array $columns, array $headers)
    {
        $csv->setOffset(1);
        $columns = ArrayHelper::filterEmptyStringsFromArray($columns);
        $csv->each(function ($row) use ($headers, $columns) {

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

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.

            $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++;
            }
            Craft::debug('Importing row: ' . print_r($redirectConfig, true), __METHOD__);

Are you sure print_r($redirectConfig, true) of type string|true can be used in concatenation?

            Retour::$plugin->redirects->saveRedirect($redirectConfig);

            return true;
        });

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

    }

    /**

Missing short description in doc comment

     * @param AbstractCsv $csv

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

Missing parameter comment

     * @param array $columns

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

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $headers

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

Expected 7 spaces after parameter type; 1 found

Missing parameter comment

     * @throws \League\Csv\Exception

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

     */

Missing @return tag in function comment

    protected function importCsvApi9(AbstractCsv $csv, array $columns, array $headers)
    {
        $stmt = (new Statement())
            ->offset(1)

Space after closing parenthesis of function call prohibited

        ;
        $rows = $stmt->process($csv);
        $columns = ArrayHelper::filterEmptyStringsFromArray($columns);
        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++;
            }
            Craft::debug('Importing row: ' . print_r($redirectConfig, true), __METHOD__);

Are you sure print_r($redirectConfig, true) of type string|true can be used in concatenation?

            Retour::$plugin->redirects->saveRedirect($redirectConfig);
        }
    }
}