forkcms / forkcms

src/Backend/Modules/Profiles/Actions/Import.php

<?php

namespace Backend\Modules\Profiles\Actions;

use Backend\Core\Engine\Base\ActionAdd as BackendBaseActionAdd;
use Backend\Core\Engine\Form as BackendForm;
use Backend\Core\Language\Language as BL;
use Backend\Core\Engine\Model as BackendModel;
use Backend\Modules\Profiles\Engine\Model as BackendProfilesModel;
use ForkCMS\Utility\Csv\Reader;
use ForkCMS\Utility\PhpSpreadsheet\Reader\Filter\ColumnsFilter;
use PhpOffice\PhpSpreadsheet\IOFactory;

/**
 * This is the add-action, it will display a form to add a new profile.
 */
class Import extends BackendBaseActionAdd
{
    public function execute(): void
    {
        parent::execute();
        $this->loadForm();
        $this->validateForm();
        $this->parse();
        $this->display();
    }

    private function loadForm(): void
    {
        // get group values for dropdown
        $ddmValues = BackendProfilesModel::getGroupsForDropDown(0);

        // create form and elements
        $this->form = new BackendForm('import');
        $this->form->addDropdown('group', $ddmValues);
        $this->form->addFile('file');
        $this->form->addCheckbox('overwrite_existing');
    }

    private function validateForm(): void
    {
        if (!$this->form->isSubmitted()) {
            return;
        }
        $this->form->cleanupFields();

        // get fields
        $ddmGroup = $this->form->getField('group');
        $fileFile = $this->form->getField('file');

        // validate input
        $ddmGroup->isFilled(BL::getError('FieldIsRequired'));
        if ($fileFile->isFilled(BL::err('FieldIsRequired'))) {
            if ($fileFile->isAllowedExtension(['csv'], sprintf(BL::getError('ExtensionNotAllowed'), 'csv'))) {
                $indexes = $this->get(Reader::class)->findColumnIndexes(
                    $fileFile->getTempFileName(),
                    ['email', 'display_name', 'password']
                );
                if (in_array(null, $indexes)) {
                    $fileFile->addError(BL::getError('InvalidCSV'));
                }
            }
        }

        if (!$this->form->isCorrect()) {
            return;
        }

        // import the profiles
        $overwrite = $this->form->getField('overwrite_existing')->isChecked();

        $csvData = $this->convertFileToArray($fileFile->getTempFileName(), array_flip($indexes));

The variable $indexes does not seem to be defined for all execution paths leading up to this point.

        $statistics = BackendProfilesModel::importFromArray(
            $csvData,
            $ddmGroup->getValue(),
            $overwrite
        );

        // build redirect url with the right message
        $redirectUrl = BackendModel::createUrlForAction('index') . '&report=';
        $redirectUrl .= $overwrite ?
            'profiles-imported-and-updated' :
            'profiles-imported';
        $redirectUrl .= '&var[]=' . $statistics['count']['inserted'];
        $redirectUrl .= '&var[]=' . $statistics['count']['exists'];

        // everything is saved, so redirect to the overview
        $this->redirect($redirectUrl);
    }

    private function convertFileToArray(string $path, array $mapping): array
    {
        $dataToImport = [];

        $reader = IOFactory::createReader('Csv');
        $reader->setReadDataOnly(true);
        $reader->setReadFilter(new ColumnsFilter(array_keys($mapping)));
        $spreadSheet = $reader->load($path);

        foreach ($spreadSheet->getActiveSheet()->getRowIterator() as $row) {
            // skip the first row as it contains the headers
            if ($row->getRowIndex() === 1) {
                continue;
            }

            $dataToImport[] = $this->get(Reader::class)->convertRowIntoMappedArray(
                $row,
                $mapping
            );
        }

        return $dataToImport;
    }
}