PhpMyAdmin\Plugins\Import\ImportShp::doImport()

Complexity

Conditions	38
Paths	> 20000

Size

Total Lines	215
Code Lines	116

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	76
CRAP Score	97.1928

Importance

Changes

0

<?php
    public function doImport(File|null $importHandle = null): array
    {
        ImportSettings::$finished = false;

        if ($importHandle === null || $this->zipExtension === null) {
            return [];
        }

        self::$importHandle = $importHandle;

        $compression = $importHandle->getCompression();

        $shp = new ShapeFileImport(ShapeType::Point);
        // If the zip archive has more than one file,
        // get the correct content to the buffer from .shp file.
        if (
            $compression === 'application/zip'
            && $this->zipExtension->getNumberOfFiles(ImportSettings::$importFile) > 1
        ) {
            if ($importHandle->openZip('/^.*\.shp$/i') === false) {
                Current::$message = Message::error(
                    __('There was an error importing the ESRI shape file: "%s".'),
                );
                Current::$message->addParam($importHandle->getError());

                return [];
            }
        }

        $tempDbfFile = false;
        // We need dbase extension to handle .dbf file
        if (extension_loaded('dbase')) {
            $config = Config::getInstance();

The function PhpMyAdmin\Config::getInstance() has been deprecated: Use dependency injection instead.

            $temp = $config->getTempDir('shp');
            // If we can extract the zip archive to 'TempDir'
            // and use the files in it for import
            if ($compression === 'application/zip' && $temp !== null) {
                $dbfFileName = $this->zipExtension->findFile(ImportSettings::$importFile, '/^.*\.dbf$/i');
                // If the corresponding .dbf file is in the zip archive
                if ($dbfFileName !== false) {
                    // Extract the .dbf file and point to it.
                    $extracted = $this->zipExtension->extract(ImportSettings::$importFile, $dbfFileName);
                    if ($extracted !== false) {
                        // remove filename extension, e.g.
                        // dresden_osm.shp/gis.osm_transport_a_v06.dbf
                        // to
                        // dresden_osm.shp/gis.osm_transport_a_v06
                        $pathParts = pathinfo($dbfFileName);
                        $dbfFileName = $pathParts['dirname'] . '/' . $pathParts['filename'];

                        // sanitize filename
                        $dbfFileName = Sanitize::sanitizeFilename($dbfFileName, true);

                        // concat correct filename and extension
                        $dbfFilePath = $temp . '/' . $dbfFileName . '.dbf';

                        if (file_put_contents($dbfFilePath, $extracted, LOCK_EX) !== false) {
                            $tempDbfFile = true;

                            // Replace the .dbf with .*, as required by the bsShapeFiles library.
                            $shp->fileName = substr($dbfFilePath, 0, -4) . '.*';
                        }
                    }
                }
            } elseif (
                ImportSettings::$localImportFile !== ''
                && ! empty($config->settings['UploadDir'])
                && $compression === 'none'
            ) {
                // If file is in UploadDir, use .dbf file in the same UploadDir
                // to load extra data.
                // Replace the .shp with .*,
                // so the bsShapeFiles library correctly locates .dbf file.
                $shp->fileName = mb_substr(ImportSettings::$importFile, 0, -4) . '.*';
            }
        }

        // It should load data before file being deleted
        $shp->loadFromFile('');

        // Delete the .dbf file extracted to 'TempDir'
        if ($tempDbfFile && isset($dbfFilePath) && @file_exists($dbfFilePath)) {
            unlink($dbfFilePath);
        }

        if ($shp->lastError != '') {
            Import::$hasError = true;
            Current::$message = Message::error(
                __('There was an error importing the ESRI shape file: "%s".'),
            );
            Current::$message->addParam($shp->lastError);

            return [];
        }

        switch ($shp->shapeType) {
            case ShapeType::Null:
                break;
            case ShapeType::Point:
                $gisType = 'point';
                break;
            case ShapeType::PolyLine:
                $gisType = 'multilinestring';
                break;
            case ShapeType::Polygon:
                $gisType = 'multipolygon';
                break;
            case ShapeType::MultiPoint:
                $gisType = 'multipoint';
                break;
            default:
                Import::$hasError = true;
                Current::$message = Message::error(
                    __('MySQL Spatial Extension does not support ESRI type "%s".'),
                );
                Current::$message->addParam($shp->getShapeName());

                return [];
        }

        if (isset($gisType)) {
            /** @var GisMultiLineString|GisMultiPoint|GisPoint|GisPolygon $gisObj */
            $gisObj = GisFactory::fromType($gisType);
        } else {
            $gisObj = null;
        }

        // If .dbf file is loaded, the number of extra data columns
        $numDataCols = $shp->getDBFHeader() !== null ? count($shp->getDBFHeader()) : 0;

        $rows = [];
        $colNames = [];
        foreach ($shp->records as $record) {
            $tempRow = [];
            if ($gisObj == null || ! method_exists($gisObj, 'getShape')) {
                $tempRow[] = null;
            } else {
                $tempRow[] = "GeomFromText('" . $gisObj->getShape($record->shpData) . "')";
            }

            if ($shp->getDBFHeader() !== null) {
                foreach ($shp->getDBFHeader() as $c) {
                    $cell = trim((string) $record->dbfData[$c[0]]);

                    if ($cell === '') {
                        $cell = 'NULL';
                    }

                    $tempRow[] = $cell;
                }
            }

            $rows[] = $tempRow;
        }

        if ($rows === []) {
            Import::$hasError = true;
            Current::$message = Message::error(
                __('The imported file does not contain any data!'),
            );

            return [];
        }

        // Column names for spatial column and the rest of the columns,
        // if they are available
        $colNames[] = 'SPATIAL';
        $dbfHeader = $shp->getDBFHeader();
        for ($n = 0; $n < $numDataCols; $n++) {
            if ($dbfHeader === null) {
                continue;
            }

            $colNames[] = $dbfHeader[$n][0];
        }

        // Set table name based on the number of tables
        if (Current::$database !== '') {
            $tableName = $this->import->getNextAvailableTableName(
                Current::$database,
                pathinfo(ImportSettings::$importFileName, PATHINFO_FILENAME),

It seems like pathinfo(PhpMyAdmin\Import\ImportSettings::importFileName, PATHINFO_FILENAME) can also be of type array; however, parameter $proposedTableName of PhpMyAdmin\Import\Import::getNextAvailableTableName() does only seem to accept string, maybe add an additional type check?

            );
        } else {
            $tableName = 'TBL_NAME';
        }

        $table = new ImportTable($tableName, $colNames, $rows);

        // Use data from shape file to chose best-fit MySQL types for each column
        $analysis = $this->import->analyzeTable($table);

        // The first column is the SPATIAL column defined earlier
        // This column contains SQL functions and should not be formatted by buildSql()
        $analysis[0]->type = ColumnType::Geometry;
        $analysis[0]->isFullyFormattedSql = true;

        // Set database name to the currently selected one, if applicable
        $dbName = Current::$database !== '' ? Current::$database : 'SHP_DB';
        $createDb = Current::$database === '';

        // Created and execute necessary SQL statements from data
        $sqlStatements = [];
        if ($createDb) {
            $sqlStatements = $this->import->createDatabase($dbName, 'utf8', 'utf8_general_ci', []);
        }

        $this->import->buildSql($dbName, [$table], [$analysis], sqlData: $sqlStatements);

        ImportSettings::$finished = true;
        Import::$hasError = false;

        // Commit any possible data in buffers
        $this->import->runQuery('', $sqlStatements);

        return $sqlStatements;
    }