FileController::actionImportCsvColumns() - Code Metrics - Inspection of "Add siteId to import/export" - nystudio107/craft-retour - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( 23cbea...ae6640 )

by Andrew
created 2018-12-15 18:20 UTC
FileController::actionImportCsvColumns() A

↳ Parent: FileController
Complexity

Conditions	5
Paths	2
Size

Total Lines	39
Code Lines	27
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	27
dl	0
loc	39
rs	9.1768
c	0
b	0
f	0
cc	5
nc	2
nop	0
<?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/
 * @copyright Copyright (c) 2018 nystudio107
 */

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 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\Reader;
use League\Csv\Writer;

/**
 * @author    nystudio107
 * @package   Retour
 * @since     3.0.0
 */
class FileController extends Controller
{
    // Constants
    // =========================================================================

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

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

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

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

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

    protected $allowAnonymous = [];

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

    /**
     * @throws \yii\web\BadRequestHttpException
     * @throws \yii\web\ForbiddenHttpException
     * @throws \craft\errors\MissingComponentException
     */
    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');
        $csv = Reader::createFromPath($filename);
        $headers = array_flip($csv->fetchOne(0));
        $csv->setOffset(1);
        $columns = ArrayHelper::filterEmptyStringsFromArray($columns);
        $columns = ArrayHelper::filterEmptyStringsFromArray(/** @scrutinizer ignore-type */ $columns);
        $csv->each(function ($row) use ($headers, $columns) {
            $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__);
            Retour::$plugin->redirects->saveRedirect($redirectConfig);

            return true;
        });

        @unlink($filename);
        /** @scrutinizer ignore-unhandled */ @unlink($filename);
        Retour::$plugin->clearAllCaches();
        Craft::$app->getSession()->setNotice(Craft::t('retour', 'Redirects imported from CSV file.'));

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

    /**
     * @param string|null $siteHandle
     *
     * @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;
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('retour'),
            ],
            [
                'label' => 'Redirects',
                'url' => UrlHelper::cpUrl('retour/redirects'),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - Redirects - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'redirects';

        // The CSV file
        $file = UploadedFile::getInstanceByName('file');
        if ($file !== null) {
            $filename = Craft::$app->getPath()->getTempPath().DIRECTORY_SEPARATOR.uniqid($file->name, true);
            $file->saveAs($filename, false);
            $csv = Reader::createFromPath($file->tempName);
            $headers = $csv->fetchOne(0);
            Craft::info(print_r($headers, true), __METHOD__);
            $variables['headers'] = $headers;
            $variables['filename'] = $filename;
        }

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

    /**
     * Export the statistics table as a CSV file
     *
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionExportStatistics()
    {
        PermissionHelper::controllerPermissionCheck('retour:statistics');
        $this->exportCsvFile('retour-statistics', '{{%retour_stats}}', self::EXPORT_STATISTICS_CSV_FIELDS);
    }

    /**
     * Export the statistics table as a CSV file
     *
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionExportRedirects()
    {
        PermissionHelper::controllerPermissionCheck('retour:redirects');
        $this->exportCsvFile('retour-redirects', '{{%retour_static_redirects}}', self::EXPORT_REDIRECTS_CSV_FIELDS);
    }

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

    /**
     * @param string $filename
     * @param string $table
     * @param array  $columns
     */
    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);

    }
}

nystudio107 / craft-retour

Push — develop ( 23cbea...ae6640 )

FileController::actionImportCsvColumns() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
