Your IP : 216.73.216.52
<?php
/**
* WebShopApps
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* WebShopApps MatrixRate
*
* @category WebShopApps
* @package WebShopApps_MatrixRate
* @copyright Copyright (c) 2014 Zowta LLC (http://www.WebShopApps.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* @author WebShopApps Team sales@webshopapps.com
*
*/
/**
* Copyright © 2015 Magento. All rights reserved.
* See COPYING.txt for license details.
*/
namespace WebShopApps\MatrixRate\Model\ResourceModel\Carrier;
use Magento\Framework\Filesystem\DirectoryList;
/**
* @SuppressWarnings(PHPMD.TooManyFields)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Matrixrate extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
{
/**
* Import table rates website ID
*
* @var int
*/
protected $importWebsiteId = 0;
/**
* Errors in import process
*
* @var array
*/
protected $importErrors = [];
/**
* Count of imported table rates
*
* @var int
*/
protected $importedRows = 0;
/**
* Array of unique table rate keys to protect from duplicates
*
* @var array
*/
protected $importUniqueHash = [];
/**
* Array of countries keyed by iso2 code
*
* @var array
*/
protected $importIso2Countries;
/**
* Array of countries keyed by iso3 code
*
* @var array
*/
protected $importIso3Countries;
/**
* Associative array of countries and regions
* [country_id][region_code] = region_id
*
* @var array
*/
protected $importRegions;
/**
* Import Table Rate condition name
*
* @var string
*/
protected $importConditionName;
/**
* Array of condition full names
*
* @var array
*/
protected $conditionFullNames = [];
/**
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
protected $coreConfig;
/**
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $storeManager;
/**
* @var \WebShopApps\MatrixRate\Model\Carrier\Matrixrate
*/
protected $carrierMatrixrate;
/**
* @var \Magento\Directory\Model\ResourceModel\Country\CollectionFactory
*/
protected $countryCollectionFactory;
/**
* @var \Magento\Directory\Model\ResourceModel\Region\CollectionFactory
*/
protected $regionCollectionFactory;
/**
* * @var \Magento\Framework\Filesystem\Directory\ReadFactory
*/
private $readFactory;
/**
* * @var \Magento\Framework\Filesystem
*/
protected $filesystem;
/**
* @param \Magento\Framework\Model\ResourceModel\Db\Context $context
* @param \Psr\Log\LoggerInterface $logger
* @param \Magento\Framework\App\Config\ScopeConfigInterface $coreConfig
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \WebShopApps\MatrixRate\Model\Carrier\Matrixrate $carrierMatrixrate
* @param \Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countryCollectionFactory
* @param \Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regionCollectionFactory
* @param \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory
* @param \Magento\Framework\Filesystem $filesystem
* @param string|null $resourcePrefix
*/
public function __construct(
\Magento\Framework\Model\ResourceModel\Db\Context $context,
\Psr\Log\LoggerInterface $logger,
\Magento\Framework\App\Config\ScopeConfigInterface $coreConfig,
\Magento\Store\Model\StoreManagerInterface $storeManager,
\WebShopApps\MatrixRate\Model\Carrier\Matrixrate $carrierMatrixrate,
\Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countryCollectionFactory,
\Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regionCollectionFactory,
\Magento\Framework\Filesystem\Directory\ReadFactory $readFactory,
\Magento\Framework\Filesystem $filesystem,
$resourcePrefix = null
) {
parent::__construct($context, $resourcePrefix);
$this->coreConfig = $coreConfig;
$this->logger = $logger;
$this->storeManager = $storeManager;
$this->carrierMatrixrate = $carrierMatrixrate;
$this->countryCollectionFactory = $countryCollectionFactory;
$this->regionCollectionFactory = $regionCollectionFactory;
$this->readFactory = $readFactory;
$this->filesystem = $filesystem;
}
/**
* Define main table and id field name
*
* @return void
*/
protected function _construct()
{
$this->_init('webshopapps_matrixrate', 'pk');
}
/**
* Return table rate array or false by rate request
*
* @param \Magento\Quote\Model\Quote\Address\RateRequest $request
* @param bool $zipRangeSet
*
* @return array|bool
* @throws \Magento\Framework\Exception\LocalizedException
* @throws \Zend_Db_Select_Exception
*/
public function getRate(\Magento\Quote\Model\Quote\Address\RateRequest $request, $zipRangeSet = false)
{
$adapter = $this->getConnection();
$shippingData=[];
$postcode = trim($request->getDestPostcode() ?? ""); //SHQ18-1978
if ($request->getDestCountryId() == 'BR') {
# Brazil can have a hyphen, let's remove it
$postcode = trim(str_replace("-","", $postcode));
}
if ($zipRangeSet && is_numeric($postcode)) {
# Want to search for postcodes within a range. SHQ18-98 Can't use bind. Will convert int to string
$zipSearchString = ' AND ' . (int)$postcode . ' BETWEEN dest_zip AND dest_zip_to ';
} else {
$zipSearchString = " AND :postcode LIKE dest_zip ";
}
for ($j=0; $j<8; $j++) {
$select = $adapter->select()->from(
$this->getMainTable()
)->where(
'website_id = :website_id'
)->order(
['dest_country_id DESC', 'dest_region_id DESC', 'dest_zip DESC', 'condition_from_value DESC']
);
$zoneWhere='';
$bind=[];
switch ($j) {
case 0: // country, region, city, postcode
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = :region_id AND STRCMP(LOWER(dest_city),LOWER(:city))= 0 " . $zipSearchString;
$bind = [
':country_id' => $request->getDestCountryId(),
':region_id' => (int)$request->getDestRegionId(),
':city' => $request->getDestCity(),
':postcode' => $postcode,
];
break;
case 1: // country, region, no city, postcode
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = :region_id AND dest_city='*' "
. $zipSearchString;
$bind = [
':country_id' => $request->getDestCountryId(),
':region_id' => (int)$request->getDestRegionId(),
':postcode' => $postcode,
];
break;
case 2: // country, state, city, no postcode
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = :region_id AND STRCMP(LOWER(dest_city),LOWER(:city))= 0 AND dest_zip ='*'";
$bind = [
':country_id' => $request->getDestCountryId(),
':region_id' => (int)$request->getDestRegionId(),
':city' => $request->getDestCity(),
];
break;
case 3: //country, city, no region, no postcode
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = '0' AND STRCMP(LOWER(dest_city),LOWER(:city))= 0 AND dest_zip ='*'";
$bind = [
':country_id' => $request->getDestCountryId(),
':city' => $request->getDestCity(),
];
break;
case 4: // country, postcode
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = '0' AND dest_city ='*' "
. $zipSearchString;
$bind = [
':country_id' => $request->getDestCountryId(),
':postcode' => $postcode,
];
break;
case 5: // country, region
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = :region_id AND dest_city ='*' AND dest_zip ='*'";
$bind = [
':country_id' => $request->getDestCountryId(),
':region_id' => (int)$request->getDestRegionId(),
];
break;
case 6: // country
$zoneWhere = "dest_country_id = :country_id AND dest_region_id = '0' AND dest_city ='*' AND dest_zip ='*'";
$bind = [
':country_id' => $request->getDestCountryId(),
];
break;
case 7: // nothing
$zoneWhere = "dest_country_id = '0' AND dest_region_id = '0' AND dest_city ='*' AND dest_zip ='*'";
break;
}
$select->where($zoneWhere);
$bind[':website_id'] = (int)$request->getWebsiteId();
$bind[':condition_name'] = $request->getConditionMRName();
//SHQ18-1978
$condition = $request->getData($request->getConditionMRName());
if ($condition == null || $condition == "") {
$condition = 0;
}
$bind[':condition_value'] = $condition;
$select->where('condition_name = :condition_name');
$select->where('condition_from_value < :condition_value');
$select->where('condition_to_value >= :condition_value');
$this->logger->debug('SQL Select: ', $select->getPart('where'));
$this->logger->debug('Bindings: ', $bind);
$results = $adapter->fetchAll($select, $bind);
if (!empty($results)) {
$this->logger->debug('SQL Results: ', $results);
foreach ($results as $data) {
$shippingData[]=$data;
}
break;
}
}
return $shippingData;
}
/**
* Upload table rate file and import data from it
*
* @param \Magento\Framework\DataObject $object
*
* @return \WebShopApps\MatrixRate\Model\ResourceModel\Carrier\Matrixrate
* @throws \Magento\Framework\Exception\LocalizedException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function uploadAndImport(\Magento\Framework\DataObject $object)
{
//M2-24
$importFieldData = $object->getFieldsetDataValue('import');
if (empty($importFieldData['tmp_name'])) {
return $this;
}
$website = $this->storeManager->getWebsite($object->getScopeId());
$csvFile = $importFieldData['tmp_name'];
$this->importWebsiteId = (int)$website->getId();
$this->importUniqueHash = [];
$this->importErrors = [];
$this->importedRows = 0;
//M2-20
$tmpDirectory = ini_get('upload_tmp_dir') ? $this->readFactory->create(ini_get('upload_tmp_dir'))
: $this->filesystem->getDirectoryRead(DirectoryList::SYS_TMP);
$path = $tmpDirectory->getRelativePath($csvFile);
$stream = $tmpDirectory->openFile($path);
// check and skip headers
$headers = $stream->readCsv();
if ($headers === false || count($headers) < 5) {
$stream->close();
throw new \Magento\Framework\Exception\LocalizedException(__('Please correct Matrix Rates File Format.'));
}
if ($object->getData('groups/matrixrate/fields/condition_name/inherit') == '1') {
$conditionName = (string)$this->coreConfig->getValue('carriers/matrixrate/condition_name', 'default');
} else {
$conditionName = $object->getData('groups/matrixrate/fields/condition_name/value');
}
$this->importConditionName = $conditionName;
$adapter = $this->getConnection();
$adapter->beginTransaction();
try {
$rowNumber = 1;
$importData = [];
$this->_loadDirectoryCountries();
$this->_loadDirectoryRegions();
// MNB-566 delete old data by website. Changed to delete all data for website.
// Thanks to https://github.com/JeroenVanLeusden for contribution
$adapter->delete($this->getMainTable(), ['website_id = ?' => $this->importWebsiteId]);
while (false !== ($csvLine = $stream->readCsv())) {
$rowNumber++;
if (empty($csvLine)) {
continue;
}
$row = $this->_getImportRow($csvLine, $rowNumber);
if ($row !== false) {
$importData[] = $row;
}
if (count($importData) == 5000) {
$this->_saveImportData($importData);
$importData = [];
}
}
$this->_saveImportData($importData);
$stream->close();
} catch (\Magento\Framework\Exception\LocalizedException $e) {
$adapter->rollback();
$stream->close();
throw new \Magento\Framework\Exception\LocalizedException(__($e->getMessage()));
} catch (\Exception $e) {
$adapter->rollback();
$stream->close();
$this->logger->critical($e);
throw new \Magento\Framework\Exception\LocalizedException(
__('Something went wrong while importing matrix rates.')
);
}
$adapter->commit();
if ($this->importErrors) {
$error = __(
'We couldn\'t import this file because of these errors: %1',
implode(" \n", $this->importErrors)
);
throw new \Magento\Framework\Exception\LocalizedException($error);
}
return $this;
}
/**
* Load directory countries
*
* @return \WebShopApps\MatrixRate\Model\ResourceModel\Carrier\Matrixrate
*/
protected function _loadDirectoryCountries()
{
if ($this->importIso2Countries !== null && $this->importIso3Countries !== null) {
return $this;
}
$this->importIso2Countries = [];
$this->importIso3Countries = [];
/** @var $collection \Magento\Directory\Model\ResourceModel\Country\Collection */
$collection = $this->countryCollectionFactory->create();
foreach ($collection->getData() as $row) {
$this->importIso2Countries[$row['iso2_code']] = $row['country_id'];
$this->importIso3Countries[$row['iso3_code']] = $row['country_id'];
}
return $this;
}
/**
* Load directory regions
*
* @return \WebShopApps\MatrixRate\Model\ResourceModel\Carrier\Matrixrate
*/
protected function _loadDirectoryRegions()
{
if ($this->importRegions !== null) {
return $this;
}
$this->importRegions = [];
/** @var $collection \Magento\Directory\Model\ResourceModel\Region\Collection */
$collection = $this->regionCollectionFactory->create();
foreach ($collection->getData() as $row) {
$this->importRegions[$row['country_id']][$row['code']] = (int)$row['region_id'];
}
return $this;
}
/**
* Return import condition full name by condition name code
*
* @param string $conditionName
* @return string
*/
protected function getConditionFullName($conditionName)
{
if (!isset($this->conditionFullNames[$conditionName])) {
$name = $this->carrierMatrixrate->getCode('condition_name_short', $conditionName);
$this->conditionFullNames[$conditionName] = $name;
}
return $this->conditionFullNames[$conditionName];
}
/**
* Validate row for import and return table rate array or false
* Error will be add to importErrors array
*
* @param array $row
* @param int $rowNumber
* @return array|false
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function _getImportRow($row, $rowNumber = 0)
{
// validate row
if (count($row) < 7) {
$this->importErrors[] =
__('Please correct Matrix Rates format in Row #%1. Invalid Number of Rows', $rowNumber);
return false;
}
// strip whitespace from the beginning and end of each row
foreach ($row as $k => $v) {
$row[$k] = trim($v ?? "");
}
// validate country
if (isset($this->importIso2Countries[$row[0]])) {
$countryId = $this->importIso2Countries[$row[0]];
} elseif (isset($this->importIso3Countries[$row[0]])) {
$countryId = $this->importIso3Countries[$row[0]];
} elseif ($row[0] == '*' || $row[0] == '') {
$countryId = '0';
} else {
$this->importErrors[] = __('Please correct Country "%1" in Row #%2.', $row[0], $rowNumber);
return false;
}
// validate region
if ($countryId != '0' && isset($this->importRegions[$countryId][$row[1]])) {
$regionId = $this->importRegions[$countryId][$row[1]];
} elseif ($row[1] == '*' || $row[1] == '') {
$regionId = 0;
} else {
$this->importErrors[] = __('Please correct Region/State "%1" in Row #%2.', $row[1], $rowNumber);
return false;
}
// detect city
if ($row[2] == '*' || $row[2] == '') {
$city = '*';
} else {
$city = $row[2];
}
// detect zip code
if ($row[3] == '*' || $row[3] == '') {
$zipCode = '*';
} else {
$zipCode = $row[3];
}
//zip to
if ($row[4] == '*' || $row[4] == '') {
$zip_to = '';
} else {
$zip_to = $row[4];
}
// validate condition from value
// MNB-472 Thanks to https://github.com/JeroenVanLeusden for the enhancement to accept -1
$valueFrom = $row[5] == '*' || $row[5] == -1 ? -1 : $this->_parseDecimalValue($row[5]);
if ($valueFrom === false) {
$this->importErrors[] = __(
'Please correct %1 From "%2" in Row #%3.',
$this->getConditionFullName($this->importConditionName),
$row[5],
$rowNumber
);
return false;
}
// validate conditionto to value
$valueTo = $row[6] == '*' ? 10000000 : $this->_parseDecimalValue($row[6]);
if ($valueTo === false) {
$this->importErrors[] = __(
'Please correct %1 To "%2" in Row #%3.',
$this->getConditionFullName($this->importConditionName),
$row[6],
$rowNumber
);
return false;
}
// validate price
$price = $this->_parseDecimalValue($row[7]);
if ($price === false) {
$this->importErrors[] = __('Please correct Shipping Price "%1" in Row #%2.', $row[7], $rowNumber);
return false;
}
// validate shipping method
if ($row[8] == '*' || $row[8] == '') {
$this->importErrors[] = __('Please correct Shipping Method "%1" in Row #%2.', $row[8], $rowNumber);
return false;
} else {
$shippingMethod = $row[8];
}
// protect from duplicate
$hash = sprintf(
"%s-%s-%s-%s-%F-%F-%s",
$countryId,
$city,
$regionId,
$zipCode,
$valueFrom,
$valueTo,
$shippingMethod
);
if (isset($this->importUniqueHash[$hash])) {
$this->importErrors[] = __(
'Duplicate Row #%1 (Country "%2", Region/State "%3", City "%4", Zip from "%5", Zip to "%6", From Value "%7", To Value "%8", and Shipping Method "%9")',
$rowNumber,
$row[0],
$row[1],
$city,
$zipCode,
$zip_to,
$valueFrom,
$valueTo,
$shippingMethod
);
return false;
}
$this->importUniqueHash[$hash] = true;
return [
$this->importWebsiteId, // website_id
$countryId, // dest_country_id
$regionId, // dest_region_id,
$city, // city,
$zipCode, // dest_zip
$zip_to, //zip to
$this->importConditionName,// condition_name,
$valueFrom, // condition_value From
$valueTo, // condition_value To
$price, // price
$shippingMethod
];
}
/**
* Save import data batch
*
* @param array $data
*
* @return \WebShopApps\MatrixRate\Model\ResourceModel\Carrier\Matrixrate
* @throws \Magento\Framework\Exception\LocalizedException
*/
protected function _saveImportData(array $data)
{
if (!empty($data)) {
$columns = [
'website_id',
'dest_country_id',
'dest_region_id',
'dest_city',
'dest_zip',
'dest_zip_to',
'condition_name',
'condition_from_value',
'condition_to_value',
'price',
'shipping_method',
];
$this->getConnection()->insertArray($this->getMainTable(), $columns, $data);
$this->importedRows += count($data);
}
return $this;
}
/**
* Parse and validate positive decimal value
* Return false if value is not decimal or is not positive
*
* @param string $value
* @return bool|float
*/
protected function _parseDecimalValue($value)
{
if (!is_numeric($value)) {
return false;
}
$value = (double)sprintf('%.4F', $value);
if ($value < 0.0000) {
return false;
}
return $value;
}
}