Backend\Modules\Extensions\Actions\UploadModule::uploadModuleFromZip()

Complexity

Conditions	20
Paths	152

Size

Total Lines	128
Code Lines	59

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	420

Importance

Changes

0

<?php
    private function uploadModuleFromZip(): ?string
    {
        // list of validated files (these files will actually be unpacked)
        $files = [];

        // shorten field variables
        /** @var $fileFile \SpoonFormFile */
        $fileFile = $this->form->getField('file');

        // create \ziparchive instance
        $zip = new \ZipArchive();

        // try and open it
        if ($zip->open($fileFile->getTempFileName()) !== true) {
            $fileFile->addError(BL::getError('CorruptedFile'));
        }

        // zip file needs to contain some files
        if ($zip->numFiles == 0) {
            $fileFile->addError(BL::getError('FileIsEmpty'));

            return null;
        }

        // directories we are allowed to upload to
        $allowedDirectories = [
            'src/Backend/Modules/',
            'src/Frontend/Modules/',
        ];

        // name of the module we are trying to upload
        $moduleName = null;

        // has the module zip one level of folders too much?
        $prefix = '';

        // check every file in the zip
        for ($i = 0; $i < $zip->numFiles; ++$i) {
            // get the file name
            $file = $zip->statIndex($i);
            $fileName = $file['name'];

            if ($i === 0) {
                $prefix = $this->extractPrefix($file['name']);
            }

            // check if the file is in one of the valid directories
            foreach ($allowedDirectories as $directory) {
                // yay, in a valid directory
                if (mb_stripos($fileName, $prefix . $directory) === 0) {
                    // extract the module name from the url
                    $tmpName = trim(str_ireplace($prefix . $directory, '', $fileName), '/');

It seems like str_ireplace($prefix . $directory, '', $fileName) can also be of type array; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

                    if ($tmpName == '') {
                        break;
                    }
                    $chunks = explode('/', $tmpName);
                    $tmpName = $chunks[0];

                    // ignore hidden files
                    if (mb_substr(basename($fileName), 0, 1) == '.') {
                        break;
                    } elseif ($moduleName === null) {
                        // first module we find, store the name
                        $moduleName = $tmpName;
                    } elseif ($moduleName !== $tmpName) {
                        // the name does not match the previous module we found, skip the file
                        break;
                    }

                    // passed all our tests, store it for extraction
                    $files[] = $fileName;

                    // go to next file
                    break;
                }
            }
        }

        // after filtering no files left (nothing useful found)
        if (count($files) == 0) {
            $fileFile->addError(BL::getError('FileContentsIsUseless'));

            return null;
        }

        // module already exists on the filesystem
        if (BackendExtensionsModel::existsModule($moduleName)) {

$moduleName of type null is incompatible with the type string expected by parameter $module of Backend\Modules\Extensions\Engine\Model::existsModule().

            $fileFile->addError(sprintf(BL::getError('ModuleAlreadyExists'), $moduleName));

            return null;
        }

        // installer in array?
        if (!in_array($prefix . 'src/Backend/Modules/' . $moduleName . '/Installer/Installer.php', $files)) {
            $fileFile->addError(sprintf(BL::getError('NoInstallerFile'), $moduleName));

            return null;
        }

        // unpack module files
        $zip->extractTo($this->getContainer()->getParameter('site.path_www'), $files);

It seems like $this->getContainer()->getParameter('site.path_www') can also be of type array; however, parameter $destination of ZipArchive::extractTo() does only seem to accept string, maybe add an additional type check?

        // place all the items in the prefixed folders in the right folders
        if (!empty($prefix)) {
            $filesystem = new Filesystem();
            foreach ($files as &$file) {
                $fullPath = $this->getContainer()->getParameter('site.path_www') . '/' . $file;
                $newPath = str_replace(
                    $this->getContainer()->getParameter('site.path_www') . '/' . $prefix,
                    $this->getContainer()->getParameter('site.path_www') . '/',
                    $fullPath
                );

                if ($filesystem->exists($fullPath) && is_dir($fullPath)) {
                    $filesystem->mkdir($newPath);
                } elseif ($filesystem->exists($fullPath) && is_file($fullPath)) {
                    $filesystem->copy(
                        $fullPath,
                        $newPath
                    );
                }
            }

            $filesystem->remove($this->getContainer()->getParameter('site.path_www') . '/' . $prefix);
        }

        // return the files
        return $moduleName;
    }