gplcart\modules\import\controllers\Import

Complexity

Total Complexity

19

Size/Duplication

Total Lines	191
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	4
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	submitImport()	0	6	3
A	doImport()	0	16	1
A	setTitleDoImport()	0	4	1
A	setBreadcrumbDoImport()	0	9	1
A	outputDoImport()	0	4	1
A	downloadErrorsImport()	0	8	3
A	validateImport()	0	8	1
A	validateFileImport()	0	22	3
A	validateHeaderImport()	0	18	3
B	setJobImport()	0	26	1

<?php

/**
 * @package Importer
 * @author Iurii Makukh
 * @copyright Copyright (c) 2017, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\import\controllers;

use gplcart\core\controllers\backend\Controller;
use gplcart\core\models\FileTransfer;
use gplcart\modules\import\helpers\Csv;

/**
 * Handles incoming requests and outputs data related to Import module
 */
class Import extends Controller
{

    /**
     * File transfer model class instance
     * @var \gplcart\core\models\FileTransfer $file_transfer
     */
    protected $file_transfer;

    /**
     * CSV helper class
     * @var \gplcart\modules\import\helpers\Csv $csv
     */
    protected $csv;

    /**
     * @param FileTransfer $file_transfer
     * @param Csv $csv
     */
    public function __construct(FileTransfer $file_transfer, Csv $csv)
    {
        parent::__construct();

        $this->csv = $csv;
        $this->file_transfer = $file_transfer;
    }

    /**
     * Displays the import page
     */
    public function doImport()
    {
        $this->downloadErrorsImport();

        $settings = $this->module->getSettings('import');
        $this->setData('settings', $settings);

        unset($settings['header']['product_id']);
        $this->setData('columns', $settings['header']);

        $this->submitImport();
        $this->setTitleDoImport();
        $this->setBreadcrumbDoImport();

        $this->outputDoImport();
    }

    /**
     * Sets titles on the import page
     */
    protected function setTitleDoImport()
    {
        $this->setTitle($this->text('Import'));
    }

    /**
     * Sets breadcrumbs on the import page
     */
    protected function setBreadcrumbDoImport()
    {
        $breadcrumb = array(
            'text' => $this->text('Dashboard'),
            'url' => $this->url('admin')
        );

        $this->setBreadcrumb($breadcrumb);
    }

    /**
     * Renders the import page
     */
    protected function outputDoImport()
    {
        $this->output('import|import');
    }

    /**
     * Downloads an error log file
     */
    protected function downloadErrorsImport()
    {
        $file = gplcart_file_private_temp('import_module_errors.csv');

        if ($this->isQuery('download_errors') && is_file($file)) {
            $this->download($file);
        }
    }

    /**
     * Start import
     */
    protected function submitImport()
    {
        if ($this->isPosted('import') && $this->validateImport()) {
            $this->setJobImport();
        }
    }

    /**
     * Validates submitted import data
     * @return boolean
     */
    protected function validateImport()
    {
        $this->setSubmitted('settings');
        $this->validateFileImport();
        $this->validateHeaderImport();

        return !$this->hasErrors();
    }

    /**
     * Validate uploaded CSV file
     * @return boolean
     */
    protected function validateFileImport()
    {
        $file = $this->request->file('file');

        if (empty($file)) {
            $this->setError('file', $this->text('File is required'));
            return false;
        }

        $result = $this->file_transfer->upload($file, 'csv', gplcart_file_private_module('import'));

        if ($result !== true) {
            $this->setError('file', $result);
            return false;
        }

        $uploaded = $this->file_transfer->getTransferred();

        $this->setSubmitted('filepath', $uploaded);
        $this->setSubmitted('filesize', filesize($uploaded));
        return true;
    }

    /**
     * Validates CSV header
     */
    public function validateHeaderImport()
    {
        if (!$this->isError()) {

            $header = $this->module->getSettings('import', 'header');
            $delimiter = $this->module->getSettings('import', 'delimiter');

            $real_header = $this->csv->open($this->getSubmitted('filepath'))
                ->setHeader($header)
                ->setDelimiter($delimiter)
                ->getHeader();

            if ($header != $real_header) {
                $error = $this->text('Wrong header. Required columns: @format', array('@format' => implode(' | ', $header)));
                $this->setError('file', $error);
            }
        }
    }

    /**
     * Sets up import
     */
    protected function setJobImport()
    {
        $submitted = $this->getSubmitted();

        $settings = $this->module->getSettings('import');
        $settings['mode'] = $submitted['mode'];
        $settings['update'] = $submitted['update'];

        $this->module->setSettings('import', $settings);

        $job = array(
            'id' => 'import_product',
            'total' => $submitted['filesize'],
            'data' => array_merge($settings, $submitted),
            'redirect_message' => array(
                'finish' => 'Success. Inserted: %inserted, updated: %updated',
                'errors' => $this->text('Inserted: %inserted, updated: %updated, errors: %errors. <a href="@url">See error log</a>', array(
                    '@url' => $this->url('', array('download_errors' => true))))
            ),
            'log' => array(
                'errors' => gplcart_file_private_temp('import_module_errors.csv')
            )
        );

        $this->job->submit($job);
    }

}