ImportGeoNames.php 4.43 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\InventoryDistanceBasedSourceSelection\Model;

use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Io\File;
use Magento\Framework\HTTP\ClientInterface;
use Magento\InventoryDistanceBasedSourceSelection\Model\ResourceModel\UpdateGeoNames;

/**
 * Import geonames
 */
class ImportGeoNames
{
    /**
     * @var ClientInterface
     */
    private $client;

    /**
     * @var File
     */
    private $file;

    /**
     * @var Filesystem
     */
    private $filesystem;

    /**
     * @var UpdateGeoNames
     */
    private $updateGeoNames;

    /**
     * @var string
     */
    private $geoNamesBaseUrl;

    /**
     * ImportGeoNames constructor.
     *
     * @param ClientInterface $client
     * @param Filesystem $filesystem
     * @param File $file
     * @param UpdateGeoNames $updateGeoNames
     * @param string $geoNamesBaseUrl
     */
    public function __construct(
        ClientInterface $client,
        Filesystem $filesystem,
        File $file,
        UpdateGeoNames $updateGeoNames,
        string $geoNamesBaseUrl
    ) {
        $this->client = $client;
        $this->file = $file;
        $this->filesystem = $filesystem;
        $this->updateGeoNames = $updateGeoNames;
        $this->geoNamesBaseUrl = $geoNamesBaseUrl;
    }

    /**
     * Download a country
     *
     * @param string $countryCode
     * @return string
     * @throws \Magento\Framework\Exception\FileSystemException
     */
    private function downloadCountry(string $countryCode): string
    {
        $countryZipFile = $this->geoNamesBaseUrl . $countryCode. '.zip';
        $this->client->get($countryZipFile);

        $varDir = $this->filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);
        $exportPath = $varDir->getAbsolutePath('geonames');
        $this->file->mkdir($exportPath, 0770, true);

        $destinationFile = $exportPath . '/' . $countryCode. '.zip';
        $this->file->write($destinationFile, $this->client->getBody());

        return $destinationFile;
    }

    /**
     * In memory extract ZIP file to string
     *
     * @param string $zipFile
     * @param string $countryCode
     * @return string
     * @throws LocalizedException
     */
    private function unpackZipFile(string $zipFile, string $countryCode): string
    {
        $zipArchive = new \ZipArchive();
        $res = $zipArchive->open($zipFile);
        if ($res !== true) {
            throw new LocalizedException(__('Cannot download country'));
        }

        $resource = $zipArchive->getStream($countryCode . '.txt');

        $contents = '';
        while (!feof($resource)) {
            $contents .= fread($resource, 1024);
        }

        return $contents;
    }

    /**
     * Import TSV file
     *
     * @param string $tsvContent
     * @param string $countryCode
     * @return int
     */
    private function importTsv(string $tsvContent, string $countryCode): int
    {
        $lines = preg_split('/[\r\n]+/', $tsvContent);

        $geoNames = [];
        foreach ($lines as $line) {
            $parts = explode("\t", $line);
            if (count($parts) < 10) {
                continue;
            }

            $geoNames[] = [
                'country_code' => $countryCode,
                'postcode' => $parts[1],
                'city' => $parts[2],
                'region' => $parts[3],
                'province' => $parts[6],
                'latitude' => (float) $parts[9],
                'longitude' => (float) $parts[10],
            ];
        }

        $this->updateGeoNames->execute($geoNames, $countryCode);
        return count($geoNames);
    }

    /**
     * Import geonames and return the amount of items
     *
     * @param string $countryCode
     * @return int
     * @throws LocalizedException
     * @throws \Magento\Framework\Exception\FileSystemException
     */
    public function execute(string $countryCode): int
    {
        $countryCode = strtoupper(preg_replace('/\W/', '', $countryCode));
        if (!$countryCode) {
            throw new LocalizedException(__('Undefined country code'));
        }

        $zipFile = $this->downloadCountry($countryCode);
        $tsvFile = $this->unpackZipFile($zipFile, $countryCode);

        return $this->importTsv($tsvFile, $countryCode);
    }
}