ltsecurityinc安防产品在线商城代码
This commit is contained in:
@@ -0,0 +1,17 @@
|
||||
Copyright © 2025-present
|
||||
|
||||
This file is part of Lts/Sales.
|
||||
|
||||
Lts/Sales is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
Please see LICENSE.txt for the full text of GNU General Public License
|
||||
@@ -0,0 +1,662 @@
|
||||
<?php
|
||||
/**
|
||||
* Copyright © All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Lts\Sales\Console\Command;
|
||||
|
||||
use JR\NetSuite\Lib\Restful\NetSuiteAPI;
|
||||
use JR\NetSuite\Logger\Logger;
|
||||
use Lts\Netterm\Model\Payment\Netterm;
|
||||
use Lts\Sales\Netsuite\ShippingMethodMapping;
|
||||
use Magento\Catalog\Api\ProductRepositoryInterface;
|
||||
use Magento\Customer\Api\CustomerRepositoryInterface;
|
||||
use Magento\Customer\Api\Data\CustomerInterface;
|
||||
use Magento\Framework\Api\SearchCriteriaBuilderFactory;
|
||||
use Magento\Framework\Exception\InvalidArgumentException;
|
||||
use Magento\Framework\Exception\LocalizedException;
|
||||
use Magento\Framework\Exception\NoSuchEntityException;
|
||||
use Magento\Inventory\Model\Source\Command\GetList;
|
||||
use Magento\InventoryApi\Api\Data\SourceItemInterface;
|
||||
use Magento\InventoryApi\Api\SourceItemRepositoryInterface;
|
||||
use Magento\InventoryDistanceBasedSourceSelection\Model\DistanceProvider\GetDistanceFromSourceToAddress;
|
||||
use Magento\InventoryInStorePickupSales\Model\Order\GetPickupLocationCode;
|
||||
use Magento\InventorySourceSelectionApi\Api\Data\AddressInterfaceFactory;
|
||||
use Magento\Quote\Api\CartRepositoryInterface;
|
||||
use Magento\Quote\Api\Data\CartInterface;
|
||||
use Magento\Sales\Api\Data\OrderInterface;
|
||||
use Magento\Sales\Api\Data\OrderItemInterface;
|
||||
use Magento\Sales\Api\OrderRepositoryInterface;
|
||||
use Magento\Sales\Model\ResourceModel\Order\Collection;
|
||||
use Magento\InventoryApi\Api\Data\SourceInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class OrderNetsuiteSync extends Command
|
||||
{
|
||||
private Logger $logger;
|
||||
private Collection $orderCollection;
|
||||
|
||||
private OrderInterface $order;
|
||||
private CartRepositoryInterface $cartRepository;
|
||||
private ?CartInterface $quote = null;
|
||||
private GetPickupLocationCode $getPickupLocationCode;
|
||||
|
||||
/**
|
||||
* @var SourceInterface[]
|
||||
*/
|
||||
private array $sources = [];
|
||||
private GetList $getList;
|
||||
private ProductRepositoryInterface $productRepository;
|
||||
private NetSuiteAPI $netSuiteAPI;
|
||||
|
||||
const HUB_REPOSITORY_CODE = ['CA-LA', 'TX', 'NJ-MountLaurel'];
|
||||
|
||||
const NETSUITE_CREDIT_CARD_PAYMENT_ID = '12';
|
||||
const NETSUITE_SALES_ORDER_SERVICE = 'record/v1/salesOrder';
|
||||
const NETSUITE_CUSTOMER_DEPOSIT_SERVICE = 'record/v1/customerDeposit';
|
||||
private OrderRepositoryInterface $orderRepository;
|
||||
|
||||
const DEFAULT_INVENTORY_SOURCE = 'default';
|
||||
private SourceItemRepositoryInterface $sourceItemRepository;
|
||||
private SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory;
|
||||
private AddressInterfaceFactory $addressInterfaceFactory;
|
||||
private GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress;
|
||||
private CustomerRepositoryInterface $customerRepository;
|
||||
private ?CustomerInterface $customer = null;
|
||||
private LoggerInterface $magentoLogger;
|
||||
|
||||
private InputInterface $input;
|
||||
private OutputInterface $output;
|
||||
/**
|
||||
* @param Logger $logger
|
||||
* @param Collection $orderCollection
|
||||
* @param CartRepositoryInterface $cartRepository
|
||||
* @param GetPickupLocationCode $getPickupLocationCode
|
||||
* @param GetList $getList
|
||||
* @param ProductRepositoryInterface $productRepository
|
||||
* @param NetSuiteAPI $netSuiteAPI
|
||||
* @param OrderRepositoryInterface $orderRepository
|
||||
* @param SourceItemRepositoryInterface $sourceItemRepository
|
||||
* @param SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory
|
||||
* @param GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress
|
||||
* @param AddressInterfaceFactory $addressInterfaceFactory
|
||||
*/
|
||||
public function __construct(
|
||||
Logger $logger,
|
||||
Collection $orderCollection,
|
||||
CartRepositoryInterface $cartRepository,
|
||||
GetPickupLocationCode $getPickupLocationCode,
|
||||
GetList $getList,
|
||||
ProductRepositoryInterface $productRepository,
|
||||
NetSuiteAPI $netSuiteAPI,
|
||||
OrderRepositoryInterface $orderRepository,
|
||||
SourceItemRepositoryInterface $sourceItemRepository,
|
||||
SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory,
|
||||
GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress,
|
||||
AddressInterfaceFactory $addressInterfaceFactory,
|
||||
CustomerRepositoryInterface $customerRepository,
|
||||
LoggerInterface $magentoLogger
|
||||
) {
|
||||
$this->logger = $logger;
|
||||
$this->orderCollection = $orderCollection;
|
||||
$this->cartRepository = $cartRepository;
|
||||
$this->getPickupLocationCode = $getPickupLocationCode;
|
||||
$this->getList = $getList;
|
||||
|
||||
$this->productRepository = $productRepository;
|
||||
$this->netSuiteAPI = $netSuiteAPI;
|
||||
$this->orderRepository = $orderRepository;
|
||||
$this->sourceItemRepository = $sourceItemRepository;
|
||||
$this->searchCriteriaBuilderFactory = $searchCriteriaBuilderFactory;
|
||||
$this->addressInterfaceFactory = $addressInterfaceFactory;
|
||||
$this->getDistanceFromSourceToAddress = $getDistanceFromSourceToAddress;
|
||||
$this->customerRepository = $customerRepository;
|
||||
$this->magentoLogger = $magentoLogger;
|
||||
$this->getInventorySources();
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure()
|
||||
{
|
||||
$this->setName('order:netsuite:sync');
|
||||
$this->setDescription('Sync order to netsuite manually, separate multiple order id with comma.');
|
||||
$this->addOption(
|
||||
'ordersId',
|
||||
'ordersId',
|
||||
InputOption::VALUE_REQUIRED,
|
||||
",\r\n
|
||||
ordersId is required\r\n"
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
protected function getInventorySources()
|
||||
{
|
||||
if (empty($this->sources)) {
|
||||
foreach ($this->getList->execute()->getItems() as $item) {
|
||||
$this->sources[$item->getSourceCode()] = $item;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->sources;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws LocalizedException
|
||||
*/
|
||||
protected function getCardInfo()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
$billingAddress = $this->order->getBillingAddress();
|
||||
$paymentMethod = $payment->getMethodInstance();
|
||||
if ($paymentMethod->isOffline()) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return $payment->getCcType().': '.$payment->getCcLast4().', '.
|
||||
$billingAddress->getFirstname().' '.$billingAddress->getLastname().': '.
|
||||
implode(' ', $billingAddress->getStreet()).', '.
|
||||
$billingAddress->getCity().', '.$billingAddress->getRegion() .', '.$billingAddress->getPostcode();
|
||||
|
||||
}
|
||||
|
||||
protected function getProductNetsuiteId(int $productId)
|
||||
{
|
||||
try {
|
||||
$product = $this->productRepository->getById($productId);
|
||||
return $product->getNetsuiteId();
|
||||
} catch (NoSuchEntityException $e) {
|
||||
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $pickupLocationCode
|
||||
* @return array
|
||||
*/
|
||||
protected function getNetsuiteOrderItems(string $pickupLocationCode)
|
||||
{
|
||||
$data = [];
|
||||
if (!empty($pickupLocationCode)) {
|
||||
foreach ($this->order->getAllVisibleItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
$data[$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $item->getQtyOrdered()*1.0
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* 拆单规则:
|
||||
* 在checkout的时候,如果客户选择ship out,我们首先看哪个hub有相对应的库存,如果每一个hub都有货,那我们就根据shipping address的
|
||||
* region来确定哪个hub出货。譬如旧金山下单了,三个hub都有货,那我们优先从西部的hub(洛杉矶)出货。假如说三个hub都没货,那我们就优先从
|
||||
* 有货的warehouse出,如果有多个仓库有货的话还是按照region来。
|
||||
*
|
||||
* 如果没有一个仓库能满足整张单的库存量的话,那我们就会拆单。具体的选择仓库或者hub的逻辑还是按照上面的那个来,哪个能fulfill的多的就从哪
|
||||
* 一个出,如果有多个的话就距离优先。如果可以的话,可以在M2就拆成两张单吗?税的话应该怎么拆都不会变,因为都是按照销售的物品来的。运费的话
|
||||
* 我们是这样子想的,如果拆成两张单,我们只会收客户两张单里面运费高的那一份运费,剩下的运费我们自己承担。
|
||||
*
|
||||
* hub的话是指我们三个大仓库,分别是LA,TX,NJ,
|
||||
*
|
||||
* 如果客户选择pickup的话,如果他选择的preferred warehouse里面有库存的话那就直接可以process;如果没有的话,我们就会提示客户说当前物
|
||||
* 品在你preferred warehouse没有库存,你可以选择配送或者把缺货商品从购物车里移除
|
||||
*
|
||||
* (1) 关于订单同步到netsuite时的拆单
|
||||
* (1.1)根据上述规则拆单
|
||||
* (1.2)运费可以放在其中一张单上
|
||||
* (1.3)订单金额根据拆单后的产品的金额计算
|
||||
* (1.4)税可以不用给
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getSyncOrders()
|
||||
{
|
||||
/* @var $info string | null */
|
||||
// $information = $this->order->getData('additional_information');
|
||||
// if ($information) {
|
||||
// $info = json_decode($information, true);
|
||||
// if (is_array($info) && !empty($info['syncOrders'])) {
|
||||
// return $info['syncOrders'];
|
||||
// }
|
||||
// }
|
||||
|
||||
$pickupLocationCode = $this->getPickupLocationCode->execute($this->order);
|
||||
if ($pickupLocationCode) {
|
||||
return [$pickupLocationCode => $this->getNetsuiteOrderItems($pickupLocationCode)];
|
||||
}
|
||||
|
||||
return $this->orderSplit();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|float $number
|
||||
* @return float
|
||||
*/
|
||||
protected function numberFormat(string | float $number)
|
||||
{
|
||||
return number_format($number*1.0, 2, '.', '')*1.0;
|
||||
}
|
||||
/**
|
||||
* order split
|
||||
* @return array
|
||||
*/
|
||||
protected function orderSplit()
|
||||
{
|
||||
$result = [];
|
||||
foreach ($this->order->getAllItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
if ($item->getProductType()===Configurable::TYPE_CODE){
|
||||
continue;
|
||||
}
|
||||
$inventorySourceFromProduct = $this->getInventorySourceFromProduct($item);
|
||||
|
||||
foreach ($inventorySourceFromProduct as $sourceCode =>$splitItem) {
|
||||
$result[$sourceCode][$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $splitItem[$item->getItemId()]*1.0
|
||||
];
|
||||
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return float[][]
|
||||
*/
|
||||
protected function getInventorySourceFromProduct(OrderItemInterface $orderItem)
|
||||
{
|
||||
$searchCriteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter(SourceItemInterface::SKU, $orderItem->getSku())
|
||||
->addFilter(SourceItemInterface::SOURCE_CODE, self::DEFAULT_INVENTORY_SOURCE, 'neq')
|
||||
->create();
|
||||
|
||||
$sourceItems = $this->sourceItemRepository->getList($searchCriteria)->getItems();
|
||||
$availableItems = [];
|
||||
|
||||
$distances = [];
|
||||
$oneSource = false;
|
||||
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$sourceAddress = $this->addressTransform($this->order->getShippingAddress());
|
||||
|
||||
$distances[$sourceItem->getSourceCode()] = $distance = $this->getDistanceFromSourceToAddress->execute(
|
||||
$this->sources[$sourceItem->getSourceCode()],
|
||||
$sourceAddress
|
||||
);
|
||||
|
||||
if ($sourceItem->getQuantity() >= $orderItem->getQtyOrdered()) {
|
||||
$oneSource = true;
|
||||
$availableItems[$distance] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
//one warehouse inventory is not enough for this order product
|
||||
if (empty($availableItems)) {
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$availableItems[$distances[$sourceItem->getSourceCode()]] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE)
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
ksort($availableItems);
|
||||
// $warehouseDistances = [];
|
||||
// foreach ($availableItems as $distance => $items) {
|
||||
// $warehouseDistances[] = [
|
||||
// 'product'=>$orderItem->getSku(),
|
||||
// 'warehouse code'=>$items['sourceItem']->getSourceCode(),
|
||||
// 'warehouse_stock' => $items['sourceItem']->getQuantity(),
|
||||
// 'distance'=>$distance,
|
||||
// 'isHub' => $items['isHub']
|
||||
// ];
|
||||
// }
|
||||
// $this->logger->debug('distance on warehouse: ', $warehouseDistances);
|
||||
return $this->getPreferredInventorySource($availableItems, $orderItem, $oneSource);
|
||||
}
|
||||
|
||||
/**
|
||||
* choose preferred warehouse for ordered product
|
||||
*/
|
||||
protected function getPreferredInventorySource(array $availableItems, OrderItemInterface $orderItem, bool $oneSource)
|
||||
{
|
||||
$hub = [];
|
||||
$other = [];
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
foreach ($availableItems as $availableItem) {
|
||||
if ($availableItem['isHub']) {
|
||||
$hub[] = $availableItem;
|
||||
} else {
|
||||
$other[] = $availableItem;
|
||||
}
|
||||
}
|
||||
|
||||
//if one warehouse stock is enough for this ordered product, then return
|
||||
if ($oneSource === true) {
|
||||
$source = !empty($hub)? current($hub):current($other);
|
||||
// $source['qty'] = $qty;
|
||||
return [$source['sourceItem']->getSourceCode() => [$orderItem->getItemId() => $qty]];
|
||||
}
|
||||
|
||||
$aggregation = [];
|
||||
$total = 0;
|
||||
foreach ($availableItems as $item) {
|
||||
if ($total < $qty) {
|
||||
$aggregation[$item['sourceItem']->getSourceCode()] = $item['sourceItem']->getQuantity();
|
||||
}
|
||||
$total += $item['sourceItem']->getQuantity();
|
||||
}
|
||||
|
||||
return $this->correctLastWarehouseQty($aggregation, $orderItem);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $availableItems
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return array
|
||||
*/
|
||||
protected function correctLastWarehouseQty(array $availableItems, OrderItemInterface $orderItem)
|
||||
{
|
||||
|
||||
$lastKey = array_key_last($availableItems);
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
$lastQty = $qty;
|
||||
$data = [];
|
||||
foreach ($availableItems as $sourceCode => $qty) {
|
||||
if ($sourceCode != $lastKey) {
|
||||
$lastQty -= $qty;
|
||||
} else {
|
||||
$availableItems[$lastKey] = $lastQty;
|
||||
}
|
||||
$data[$sourceCode][$orderItem->getItemId()] = $availableItems[$sourceCode];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* transform order address to the calculate distance address
|
||||
* @param \Magento\Sales\Api\Data\OrderAddressInterface $address
|
||||
* @return \Magento\InventorySourceSelectionApi\Api\Data\AddressInterface
|
||||
*/
|
||||
protected function addressTransform(\Magento\Sales\Api\Data\OrderAddressInterface $address) {
|
||||
if ($address->getStreet()) {
|
||||
$streets = implode(' ', $address->getStreet());
|
||||
}
|
||||
return $this->addressInterfaceFactory->create([
|
||||
'country' => $address->getCountryId() ?? '',
|
||||
'postcode' => $address->getPostcode() ?? '',
|
||||
'street' => $streets ?? '',
|
||||
'region' => $address->getRegion() ?? '',
|
||||
'city' => $address->getCity() ?? ''
|
||||
]);
|
||||
}
|
||||
|
||||
protected function getShippingAddress()
|
||||
{
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$streets = ['', ''];
|
||||
if ($shippingAddress->getStreet()) {
|
||||
$streets = $shippingAddress->getStreet();
|
||||
}
|
||||
return [
|
||||
'country' => ['id' => 'US'],
|
||||
'addr1' => $streets[0],
|
||||
'addr2' => $streets[1] ?? '',
|
||||
'city' => $shippingAddress->getCity(),
|
||||
'state' => $shippingAddress->getRegionCode(),
|
||||
'zip' => $shippingAddress->getPostcode(),
|
||||
'addressee' => $shippingAddress->getFirstname() . ' ' . $shippingAddress->getLastname(),
|
||||
'attention' => null,
|
||||
'addrPhone' => $shippingAddress->getTelephone(),
|
||||
'override' => false
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getTerms()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
if ($payment->getMethod() == NetTerm::PAYMENT_METHOD_NETTERM_CODE) {
|
||||
return $this->getQuote()->getNetsuitePaymentId();
|
||||
}
|
||||
|
||||
return self::NETSUITE_CREDIT_CARD_PAYMENT_ID;
|
||||
}
|
||||
|
||||
protected function getCustomer() {
|
||||
if ($this->customer) {
|
||||
return $this->customer;
|
||||
}
|
||||
if ($this->order->getCustomer()) {
|
||||
$this->customer = $this->order->getCustomer()->getDataModel();
|
||||
}
|
||||
|
||||
$this->customer = $this->customerRepository->getById($this->order->getCustomerId());
|
||||
|
||||
return $this->customer;
|
||||
}
|
||||
protected function getPostData(string $locationId, array $items, int $index)
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$shippingCost = 0;
|
||||
if ($index == 1) {
|
||||
$shippingCost = $this->numberFormat($this->order->getShippingAmount());
|
||||
}
|
||||
|
||||
foreach ($items as &$item) {
|
||||
unset($item['sku']);
|
||||
}
|
||||
|
||||
return [
|
||||
'externalId'=> 'Magento-'.$this->order->getEntityId().'-'.$index,
|
||||
'entity' => [
|
||||
'id'=>$dataCustomer->getCustomAttribute('netsuite_id')->getValue(),
|
||||
],
|
||||
|
||||
'terms' => ['id' => $this->getTerms()],
|
||||
'otherRefNum' => $this->getQuote()->getOtherRefNum(),
|
||||
'custbody_il_email' => $shippingAddress->getEmail(),
|
||||
'custbody_il_phone' => $shippingAddress->getTelephone(),
|
||||
'custbody_card_info' => $this->getCardInfo(),
|
||||
'custbody_ecommerce_order_no' => 'Magento-'.$this->order->getIncrementId().'-'.$index,
|
||||
'subsidiary' => ['id'=> 3],
|
||||
'cseg_ncg_rep_office' => ['id'=> 13],
|
||||
'location' => ['id'=> $locationId],
|
||||
'custbody_location_filter' => 'RMA',
|
||||
// 'discountItem' => ['id'=> -6],
|
||||
// 'discountRate' => 6.17,
|
||||
'shipMethod' => ['id'=> ShippingMethodMapping::getShippingMethodId($this->order->getShippingMethod())],
|
||||
'shippingCost' => $shippingCost,
|
||||
'shipAddressList' => ['id'=>-2],
|
||||
'shipIsResidential' => false,
|
||||
'shippingAddress' => $this->getShippingAddress(),
|
||||
'item' => ['items'=>$items],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CartInterface
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getQuote()
|
||||
{
|
||||
if (!$this->quote) {
|
||||
$this->quote = $this->cartRepository->get($this->order->getQuoteId());
|
||||
}
|
||||
|
||||
return $this->quote;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \Magento\Sales\Api\Data\OrderSearchResultInterface]
|
||||
*/
|
||||
protected function getWaitSyncOrders()
|
||||
{
|
||||
$ordersId = explode(',', $this->input->getOption('ordersId'));
|
||||
$this->output->writeln('received orders id: '.implode(',', $ordersId));
|
||||
$criteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter('is_netsuite_sync', 0)
|
||||
->addFilter('entity_id', $ordersId, 'in')
|
||||
->create();
|
||||
return $this->orderRepository->getList($criteria);
|
||||
}
|
||||
|
||||
protected function customerDepositBuild()
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
return [
|
||||
'externalId'=> 'CD-'.$this->order->getEntityId().'-1',
|
||||
'customer' => ['id' => $dataCustomer->getCustomAttribute('netsuite_id')?->getValue()],
|
||||
'salesOrder' => ['externalId' => 'Magento-'.$this->order->getEntityId().'-1'],
|
||||
'payment' => $this->numberFormat($this->order->getGrandTotal())
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderInterface $order
|
||||
* @return $this
|
||||
*/
|
||||
public function setOrder(OrderInterface $order)
|
||||
{
|
||||
$this->order = $order;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function customerDepositSync()
|
||||
{
|
||||
$res = [];
|
||||
try {
|
||||
$paymentMethod = $this->order->getPayment()->getMethodInstance();
|
||||
if (!$paymentMethod->isOffline()) {
|
||||
$postData = $this->customerDepositBuild();
|
||||
$response = $this->netSuiteAPI->postData(self::NETSUITE_CUSTOMER_DEPOSIT_SERVICE, $postData);
|
||||
if ($response['error'] == true){
|
||||
$message = sprintf('customer deposit %s sync to Netsuite fail', $this->order->getIncrementId());
|
||||
$this->output->writeln($message);
|
||||
$this->output->writeln(sprintf('customer deposit %s sync response: %s', $this->order->getIncrementId(), json_encode($response)));
|
||||
$this->output->writeln(sprintf('customer deposit %s sync postData: %s', $this->order->getIncrementId(), json_encode($postData)));
|
||||
}
|
||||
$res['response'] = $response;
|
||||
} else {
|
||||
$res['message'] = 'this order payment method is offline';
|
||||
}
|
||||
} catch (\Exception $exception) {
|
||||
$res['message'] = $message = sprintf('customer deposit %s sync to Netsuite exception: ', $this->order->getIncrementId(), $exception->getMessage());
|
||||
$this->output->writeln($message);
|
||||
}
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* look for netsuite order id from http response header Location
|
||||
* @param array $responseHeaders
|
||||
* @return string
|
||||
*/
|
||||
protected function getNetsuiteOrderId(array $responseHeaders)
|
||||
{
|
||||
if (!empty($responseHeaders['Location'])) {
|
||||
$isMatch = preg_match('/salesorder\/(\d+)/', $responseHeaders['Location'], $matches);
|
||||
if ($isMatch) {
|
||||
return $matches[1];
|
||||
}
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
public function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$this->input = $input;
|
||||
$this->output = $output;
|
||||
// $waitSyncOrders = $this->getWaitSyncOrders()->getItems();
|
||||
//
|
||||
// foreach ($waitSyncOrders as $order) {
|
||||
// $this->order = $order;
|
||||
// /* @var $order \Magento\Sales\Model\Order */
|
||||
// try {
|
||||
// $syncOrders = $this->getSyncOrders();
|
||||
//
|
||||
// $index = 1;
|
||||
// $orderSyncSuccess = true;
|
||||
// foreach ($syncOrders as $sourceCode => $syncOrder) {
|
||||
// $locationId = $this->sources[$sourceCode]->getNetsuiteId();
|
||||
// unset($syncOrder['increment_id']);
|
||||
// $postData = $this->getPostData($locationId, array_values($syncOrder), $index);
|
||||
//
|
||||
// $syncOrders[$sourceCode]['increment_id'] = $postData['externalId'];
|
||||
// $index++;
|
||||
//
|
||||
// try {
|
||||
// $response = $this->netSuiteAPI->postData(self::NETSUITE_SALES_ORDER_SERVICE, $postData);
|
||||
//
|
||||
// if ($response['error'] != true){
|
||||
// $syncOrders[$sourceCode]['netsuite_order_id'] = $this->getNetsuiteOrderId($this->netSuiteAPI->getResponseHeaders());
|
||||
// $this->order->setIsNetsuiteSync(1);
|
||||
// } else {
|
||||
// $orderSyncSuccess = false;
|
||||
// $message = sprintf('order %s sync to Netsuite fail', $postData['externalId']);
|
||||
// $this->output->writeln($message);
|
||||
// $this->output->writeln(sprintf('customer deposit %s sync response: %s', $this->order->getIncrementId(), json_encode($response)));
|
||||
// $this->output->writeln(sprintf('customer deposit %s sync postData: %s', $this->order->getIncrementId(), json_encode($postData)));
|
||||
// }
|
||||
// } catch (InvalidArgumentException $e) {
|
||||
// $message = sprintf('order %s sync to Netsuite crash fail: %s', $postData['externalId'], $e->getMessage());
|
||||
// $this->output->writeln($message);
|
||||
// }
|
||||
//
|
||||
// }
|
||||
// $additionalInformation = ['syncOrders' => $syncOrders];
|
||||
// if ($orderSyncSuccess) {
|
||||
// $response = $this->customerDepositSync();
|
||||
// $additionalInformation['depositSync'] = $response;
|
||||
// }
|
||||
//
|
||||
// $this->order->setData('additional_information', json_encode($additionalInformation));
|
||||
// $this->orderRepository->save($this->order);
|
||||
// } catch (\Exception $exception) {
|
||||
// $this->output->writeln('magento sync to netsuite exception: '.$exception->getMessage());
|
||||
// $this->output->writeln('sync exception: '.json_encode($exception->getTrace()));
|
||||
// }
|
||||
// }
|
||||
|
||||
$product = $this->productRepository->getById(3657);
|
||||
|
||||
var_dump($product->getExtensionAttributes()->getNetsuiteId(), $product->getNetsuiteId());
|
||||
return Command::SUCCESS;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,711 @@
|
||||
<?php
|
||||
/**
|
||||
* Copyright © All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Lts\Sales\Cron;
|
||||
|
||||
use JR\NetSuite\Lib\Restful\NetSuiteAPI;
|
||||
use JR\NetSuite\Logger\Logger;
|
||||
use Lts\Netterm\Model\Payment\Netterm;
|
||||
use Lts\Sales\Helper\CredisStorage;
|
||||
use Lts\Sales\Helper\Email;
|
||||
use Lts\Sales\Netsuite\ShippingMethodMapping;
|
||||
use Magento\Catalog\Api\ProductRepositoryInterface;
|
||||
use Magento\Customer\Api\CustomerRepositoryInterface;
|
||||
use Magento\Customer\Api\Data\CustomerInterface;
|
||||
use Magento\Framework\Api\SearchCriteriaBuilderFactory;
|
||||
use Magento\Framework\App\CacheInterface;
|
||||
use Magento\Framework\Exception\InvalidArgumentException;
|
||||
use Magento\Framework\Exception\LocalizedException;
|
||||
use Magento\Framework\Exception\MailException;
|
||||
use Magento\Framework\Exception\NoSuchEntityException;
|
||||
use Magento\Inventory\Model\Source\Command\GetList;
|
||||
use Magento\InventoryApi\Api\Data\SourceItemInterface;
|
||||
use Magento\InventoryApi\Api\SourceItemRepositoryInterface;
|
||||
use Magento\InventoryDistanceBasedSourceSelection\Model\DistanceProvider\GetDistanceFromSourceToAddress;
|
||||
use Magento\InventoryInStorePickupSales\Model\Order\GetPickupLocationCode;
|
||||
use Magento\InventorySourceSelectionApi\Api\Data\AddressInterfaceFactory;
|
||||
use Magento\Quote\Api\CartRepositoryInterface;
|
||||
use Magento\Quote\Api\Data\CartInterface;
|
||||
use Magento\Sales\Api\Data\OrderInterface;
|
||||
use Magento\Sales\Api\Data\OrderItemInterface;
|
||||
use Magento\Sales\Api\OrderRepositoryInterface;
|
||||
use Magento\Sales\Model\ResourceModel\Order\Collection;
|
||||
use Magento\InventoryApi\Api\Data\SourceInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
|
||||
|
||||
|
||||
class OrderNetsuiteSync
|
||||
{
|
||||
private Logger $logger;
|
||||
private Collection $orderCollection;
|
||||
|
||||
private OrderInterface $order;
|
||||
private CartRepositoryInterface $cartRepository;
|
||||
private ?CartInterface $quote = null;
|
||||
private GetPickupLocationCode $getPickupLocationCode;
|
||||
|
||||
/**
|
||||
* @var SourceInterface[]
|
||||
*/
|
||||
private array $sources = [];
|
||||
private GetList $getList;
|
||||
private ProductRepositoryInterface $productRepository;
|
||||
private NetSuiteAPI $netSuiteAPI;
|
||||
|
||||
const HUB_REPOSITORY_CODE = ['CA-LA', 'TX', 'NJ-MountLaurel'];
|
||||
|
||||
const NETSUITE_CREDIT_CARD_PAYMENT_ID = '12';
|
||||
const NETSUITE_SALES_ORDER_SERVICE = 'record/v1/salesOrder';
|
||||
const NETSUITE_CUSTOMER_DEPOSIT_SERVICE = 'record/v1/customerDeposit';
|
||||
private OrderRepositoryInterface $orderRepository;
|
||||
|
||||
const DEFAULT_INVENTORY_SOURCE = 'default';
|
||||
private SourceItemRepositoryInterface $sourceItemRepository;
|
||||
private SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory;
|
||||
private AddressInterfaceFactory $addressInterfaceFactory;
|
||||
private GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress;
|
||||
private CustomerRepositoryInterface $customerRepository;
|
||||
private ?CustomerInterface $customer = null;
|
||||
private LoggerInterface $magentoLogger;
|
||||
|
||||
const CACHE_IDENTIFIER = 'order_netsuite_sync_cache';
|
||||
|
||||
/**
|
||||
* @param Logger $logger
|
||||
* @param Collection $orderCollection
|
||||
* @param CartRepositoryInterface $cartRepository
|
||||
* @param GetPickupLocationCode $getPickupLocationCode
|
||||
* @param GetList $getList
|
||||
* @param ProductRepositoryInterface $productRepository
|
||||
* @param NetSuiteAPI $netSuiteAPI
|
||||
* @param OrderRepositoryInterface $orderRepository
|
||||
* @param SourceItemRepositoryInterface $sourceItemRepository
|
||||
* @param SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory
|
||||
* @param GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress
|
||||
* @param AddressInterfaceFactory $addressInterfaceFactory
|
||||
*/
|
||||
public function __construct(
|
||||
Logger $logger,
|
||||
Collection $orderCollection,
|
||||
CartRepositoryInterface $cartRepository,
|
||||
GetPickupLocationCode $getPickupLocationCode,
|
||||
GetList $getList,
|
||||
ProductRepositoryInterface $productRepository,
|
||||
NetSuiteAPI $netSuiteAPI,
|
||||
OrderRepositoryInterface $orderRepository,
|
||||
SourceItemRepositoryInterface $sourceItemRepository,
|
||||
SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory,
|
||||
GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress,
|
||||
AddressInterfaceFactory $addressInterfaceFactory,
|
||||
CustomerRepositoryInterface $customerRepository,
|
||||
LoggerInterface $magentoLogger,
|
||||
protected Email $email,
|
||||
protected CredisStorage $credis
|
||||
) {
|
||||
$this->logger = $logger;
|
||||
$this->orderCollection = $orderCollection;
|
||||
$this->cartRepository = $cartRepository;
|
||||
$this->getPickupLocationCode = $getPickupLocationCode;
|
||||
$this->getList = $getList;
|
||||
|
||||
$this->productRepository = $productRepository;
|
||||
$this->netSuiteAPI = $netSuiteAPI;
|
||||
$this->orderRepository = $orderRepository;
|
||||
$this->sourceItemRepository = $sourceItemRepository;
|
||||
$this->searchCriteriaBuilderFactory = $searchCriteriaBuilderFactory;
|
||||
$this->addressInterfaceFactory = $addressInterfaceFactory;
|
||||
$this->getDistanceFromSourceToAddress = $getDistanceFromSourceToAddress;
|
||||
$this->customerRepository = $customerRepository;
|
||||
$this->magentoLogger = $magentoLogger;
|
||||
$this->getInventorySources();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
protected function getInventorySources()
|
||||
{
|
||||
if (empty($this->sources)) {
|
||||
foreach ($this->getList->execute()->getItems() as $item) {
|
||||
$this->sources[$item->getSourceCode()] = $item;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->sources;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws LocalizedException
|
||||
*/
|
||||
protected function getCardInfo()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
$billingAddress = $this->order->getBillingAddress();
|
||||
$paymentMethod = $payment->getMethodInstance();
|
||||
if ($paymentMethod->isOffline()) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return $payment->getCcType().': '.$payment->getCcLast4().', '.
|
||||
$billingAddress->getFirstname().' '.$billingAddress->getLastname().': '.
|
||||
implode(' ', $billingAddress->getStreet()).', '.
|
||||
$billingAddress->getCity().', '.$billingAddress->getRegion() .', '.$billingAddress->getPostcode();
|
||||
|
||||
}
|
||||
|
||||
protected function getProductNetsuiteId(int $productId)
|
||||
{
|
||||
try {
|
||||
$product = $this->productRepository->getById($productId);
|
||||
return $product->getNetsuiteId();
|
||||
} catch (NoSuchEntityException $e) {
|
||||
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $pickupLocationCode
|
||||
* @return array
|
||||
*/
|
||||
protected function getNetsuiteOrderItems(string $pickupLocationCode)
|
||||
{
|
||||
$data = [];
|
||||
if (!empty($pickupLocationCode)) {
|
||||
foreach ($this->order->getAllVisibleItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
$data[$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $item->getQtyOrdered()*1.0
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* 拆单规则:
|
||||
* 在checkout的时候,如果客户选择ship out,我们首先看哪个hub有相对应的库存,如果每一个hub都有货,那我们就根据shipping address的
|
||||
* region来确定哪个hub出货。譬如旧金山下单了,三个hub都有货,那我们优先从西部的hub(洛杉矶)出货。假如说三个hub都没货,那我们就优先从
|
||||
* 有货的warehouse出,如果有多个仓库有货的话还是按照region来。
|
||||
*
|
||||
* 如果没有一个仓库能满足整张单的库存量的话,那我们就会拆单。具体的选择仓库或者hub的逻辑还是按照上面的那个来,哪个能fulfill的多的就从哪
|
||||
* 一个出,如果有多个的话就距离优先。如果可以的话,可以在M2就拆成两张单吗?税的话应该怎么拆都不会变,因为都是按照销售的物品来的。运费的话
|
||||
* 我们是这样子想的,如果拆成两张单,我们只会收客户两张单里面运费高的那一份运费,剩下的运费我们自己承担。
|
||||
*
|
||||
* hub的话是指我们三个大仓库,分别是LA,TX,NJ,
|
||||
*
|
||||
* 如果客户选择pickup的话,如果他选择的preferred warehouse里面有库存的话那就直接可以process;如果没有的话,我们就会提示客户说当前物
|
||||
* 品在你preferred warehouse没有库存,你可以选择配送或者把缺货商品从购物车里移除
|
||||
*
|
||||
* (1) 关于订单同步到netsuite时的拆单
|
||||
* (1.1)根据上述规则拆单
|
||||
* (1.2)运费可以放在其中一张单上
|
||||
* (1.3)订单金额根据拆单后的产品的金额计算
|
||||
* (1.4)税可以不用给
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getSyncOrders()
|
||||
{
|
||||
/* @var $info string | null */
|
||||
// $information = $this->order->getData('additional_information');
|
||||
// if ($information) {
|
||||
// $info = json_decode($information, true);
|
||||
// if (is_array($info) && !empty($info['syncOrders'])) {
|
||||
// return $info['syncOrders'];
|
||||
// }
|
||||
// }
|
||||
|
||||
$pickupLocationCode = $this->getPickupLocationCode->execute($this->order);
|
||||
if ($pickupLocationCode) {
|
||||
return [$pickupLocationCode => $this->getNetsuiteOrderItems($pickupLocationCode)];
|
||||
}
|
||||
|
||||
return $this->orderSplit();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|float $number
|
||||
* @return float
|
||||
*/
|
||||
protected function numberFormat(string | float $number)
|
||||
{
|
||||
return number_format($number*1.0, 2, '.', '')*1.0;
|
||||
}
|
||||
/**
|
||||
* order split
|
||||
* @return array
|
||||
*/
|
||||
protected function orderSplit()
|
||||
{
|
||||
$result = [];
|
||||
foreach ($this->order->getAllItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
if ($item->getProductType()===Configurable::TYPE_CODE){
|
||||
continue;
|
||||
}
|
||||
$inventorySourceFromProduct = $this->getInventorySourceFromProduct($item);
|
||||
|
||||
foreach ($inventorySourceFromProduct as $sourceCode =>$splitItem) {
|
||||
$result[$sourceCode][$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $splitItem[$item->getItemId()]*1.0
|
||||
];
|
||||
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return float[][]
|
||||
*/
|
||||
protected function getInventorySourceFromProduct(OrderItemInterface $orderItem)
|
||||
{
|
||||
$searchCriteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter(SourceItemInterface::SKU, $orderItem->getSku())
|
||||
->addFilter(SourceItemInterface::SOURCE_CODE, self::DEFAULT_INVENTORY_SOURCE, 'neq')
|
||||
->addFilter(SourceItemInterface::QUANTITY, 0, 'neq')
|
||||
->create();
|
||||
|
||||
$sourceItems = $this->sourceItemRepository->getList($searchCriteria)->getItems();
|
||||
$availableItems = [];
|
||||
|
||||
$distances = [];
|
||||
$oneSource = false;
|
||||
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$sourceAddress = $this->addressTransform($this->order->getShippingAddress());
|
||||
|
||||
$distances[$sourceItem->getSourceCode()] = $distance = $this->getDistanceFromSourceToAddress->execute(
|
||||
$this->sources[$sourceItem->getSourceCode()],
|
||||
$sourceAddress
|
||||
);
|
||||
|
||||
if ($sourceItem->getQuantity() >= $orderItem->getQtyOrdered()) {
|
||||
$oneSource = true;
|
||||
$availableItems[$distance] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
//one warehouse inventory is not enough for this order product
|
||||
if (empty($availableItems)) {
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$availableItems[$distances[$sourceItem->getSourceCode()]] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE)
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
ksort($availableItems);
|
||||
// $warehouseDistances = [];
|
||||
// foreach ($availableItems as $distance => $items) {
|
||||
// $warehouseDistances[] = [
|
||||
// 'product'=>$orderItem->getSku(),
|
||||
// 'warehouse code'=>$items['sourceItem']->getSourceCode(),
|
||||
// 'warehouse_stock' => $items['sourceItem']->getQuantity(),
|
||||
// 'distance'=>$distance,
|
||||
// 'isHub' => $items['isHub']
|
||||
// ];
|
||||
// }
|
||||
// $this->logger->debug('distance on warehouse: ', $warehouseDistances);
|
||||
return $this->getPreferredInventorySource($availableItems, $orderItem, $oneSource);
|
||||
}
|
||||
|
||||
/**
|
||||
* choose preferred warehouse for ordered product
|
||||
*/
|
||||
protected function getPreferredInventorySource(array $availableItems, OrderItemInterface $orderItem, bool $oneSource)
|
||||
{
|
||||
$hub = [];
|
||||
$other = [];
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
foreach ($availableItems as $availableItem) {
|
||||
if ($availableItem['isHub']) {
|
||||
$hub[] = $availableItem;
|
||||
} else {
|
||||
$other[] = $availableItem;
|
||||
}
|
||||
}
|
||||
|
||||
//if one warehouse stock is enough for this ordered product, then return
|
||||
if ($oneSource === true) {
|
||||
$source = !empty($hub)? current($hub):current($other);
|
||||
// $source['qty'] = $qty;
|
||||
return [$source['sourceItem']->getSourceCode() => [$orderItem->getItemId() => $qty]];
|
||||
}
|
||||
|
||||
$aggregation = [];
|
||||
$total = 0;
|
||||
foreach ($availableItems as $item) {
|
||||
if ($total < $qty) {
|
||||
$aggregation[$item['sourceItem']->getSourceCode()] = $item['sourceItem']->getQuantity();
|
||||
}
|
||||
$total += $item['sourceItem']->getQuantity();
|
||||
}
|
||||
|
||||
return $this->correctLastWarehouseQty($aggregation, $orderItem);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $availableItems
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return array
|
||||
*/
|
||||
protected function correctLastWarehouseQty(array $availableItems, OrderItemInterface $orderItem)
|
||||
{
|
||||
|
||||
$lastKey = array_key_last($availableItems);
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
$lastQty = $qty;
|
||||
$data = [];
|
||||
foreach ($availableItems as $sourceCode => $qty) {
|
||||
if ($sourceCode != $lastKey) {
|
||||
$lastQty -= $qty;
|
||||
} else {
|
||||
$availableItems[$lastKey] = $lastQty;
|
||||
}
|
||||
$data[$sourceCode][$orderItem->getItemId()] = $availableItems[$sourceCode];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* transform order address to the calculate distance address
|
||||
* @param \Magento\Sales\Api\Data\OrderAddressInterface $address
|
||||
* @return \Magento\InventorySourceSelectionApi\Api\Data\AddressInterface
|
||||
*/
|
||||
protected function addressTransform(\Magento\Sales\Api\Data\OrderAddressInterface $address) {
|
||||
if ($address->getStreet()) {
|
||||
$streets = implode(' ', $address->getStreet());
|
||||
}
|
||||
return $this->addressInterfaceFactory->create([
|
||||
'country' => $address->getCountryId() ?? '',
|
||||
'postcode' => $address->getPostcode() ?? '',
|
||||
'street' => $streets ?? '',
|
||||
'region' => $address->getRegion() ?? '',
|
||||
'city' => $address->getCity() ?? ''
|
||||
]);
|
||||
}
|
||||
|
||||
protected function getShippingAddress()
|
||||
{
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$streets = ['', ''];
|
||||
if ($shippingAddress->getStreet()) {
|
||||
$streets = $shippingAddress->getStreet();
|
||||
}
|
||||
return [
|
||||
'country' => ['id' => 'US'],
|
||||
'addr1' => $streets[0],
|
||||
'addr2' => $streets[1] ?? '',
|
||||
'city' => $shippingAddress->getCity(),
|
||||
'state' => $shippingAddress->getRegionCode(),
|
||||
'zip' => $shippingAddress->getPostcode(),
|
||||
'addressee' => $shippingAddress->getFirstname() . ' ' . $shippingAddress->getLastname(),
|
||||
'attention' => null,
|
||||
'addrPhone' => $shippingAddress->getTelephone(),
|
||||
'override' => false
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getTerms()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
if ($payment->getMethod() == NetTerm::PAYMENT_METHOD_NETTERM_CODE) {
|
||||
return $this->getQuote()->getNetsuitePaymentId();
|
||||
}
|
||||
|
||||
return self::NETSUITE_CREDIT_CARD_PAYMENT_ID;
|
||||
}
|
||||
|
||||
protected function getCustomer() {
|
||||
if ($this->customer) {
|
||||
return $this->customer;
|
||||
}
|
||||
if ($this->order->getCustomer()) {
|
||||
$this->customer = $this->order->getCustomer()->getDataModel();
|
||||
}
|
||||
|
||||
$this->customer = $this->customerRepository->getById($this->order->getCustomerId());
|
||||
|
||||
return $this->customer;
|
||||
}
|
||||
protected function getPostData(string $locationId, array $items, int $index)
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$shippingCost = 0;
|
||||
if ($index == 1) {
|
||||
$shippingCost = $this->numberFormat($this->order->getShippingAmount());
|
||||
}
|
||||
|
||||
if (isset($items['increment_id'])) {
|
||||
$parts = explode('-', $items['increment_id']);
|
||||
if (isset($parts[2])) {
|
||||
$index = $parts[2];
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($items as &$item) {
|
||||
unset($item['sku']);
|
||||
}
|
||||
|
||||
return [
|
||||
'externalId'=> 'Magento-'.$this->order->getEntityId().'-'.$index,
|
||||
'entity' => [
|
||||
'id'=>$dataCustomer->getCustomAttribute('netsuite_id')->getValue(),
|
||||
],
|
||||
|
||||
'terms' => ['id' => $this->getTerms()],
|
||||
'otherRefNum' => $this->getQuote()->getOtherRefNum(),
|
||||
'custbody_il_email' => $shippingAddress->getEmail(),
|
||||
'custbody_il_phone' => $shippingAddress->getTelephone(),
|
||||
'custbody_card_info' => $this->getCardInfo(),
|
||||
'custbody_ecommerce_order_no' => 'Magento-'.$this->order->getIncrementId().'-'.$index,
|
||||
'subsidiary' => ['id'=> 3],
|
||||
'cseg_ncg_rep_office' => ['id'=> $dataCustomer->getCustomAttribute('netsuite_cseg_ncg_rep_office')?->getValue()],
|
||||
'location' => ['id'=> $locationId],
|
||||
'custbody_location_filter' => 'RMA',
|
||||
// 'discountItem' => ['id'=> -6],
|
||||
// 'discountRate' => 6.17,
|
||||
'shipMethod' => ['id'=> ShippingMethodMapping::getShippingMethodId($this->order->getShippingMethod())],
|
||||
'shippingCost' => $shippingCost,
|
||||
'shipAddressList' => ['id'=>-2],
|
||||
'shipIsResidential' => false,
|
||||
'shippingAddress' => $this->getShippingAddress(),
|
||||
'item' => ['items'=>$items],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CartInterface
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getQuote()
|
||||
{
|
||||
if (!$this->quote) {
|
||||
$this->quote = $this->cartRepository->get($this->order->getQuoteId());
|
||||
}
|
||||
|
||||
return $this->quote;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \Magento\Sales\Api\Data\OrderSearchResultInterface
|
||||
*/
|
||||
protected function getWaitSyncOrders()
|
||||
{
|
||||
$criteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter('is_netsuite_sync', 0)
|
||||
// ->addFilter('entity_id', [17191], 'in')
|
||||
->create();
|
||||
return $this->orderRepository->getList($criteria);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
protected function customerDepositBuild()
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
return [
|
||||
'externalId'=> 'CD-'.$this->order->getEntityId().'-1',
|
||||
'customer' => ['id' => $dataCustomer->getCustomAttribute('netsuite_id')->getValue()],
|
||||
'salesOrder' => ['externalId' => 'Magento-'.$this->order->getEntityId().'-1'],
|
||||
'payment' => $this->numberFormat($this->order->getGrandTotal())
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderInterface $order
|
||||
* @return $this
|
||||
*/
|
||||
public function setOrder(OrderInterface $order)
|
||||
{
|
||||
$this->order = $order;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $index
|
||||
* @return array
|
||||
*/
|
||||
public function customerDepositSync()
|
||||
{
|
||||
$res = [];
|
||||
try {
|
||||
$paymentMethod = $this->order->getPayment()->getMethodInstance();
|
||||
if (!$paymentMethod->isOffline()) {
|
||||
$postData = $this->customerDepositBuild();
|
||||
$response = $this->netSuiteAPI->postData(self::NETSUITE_CUSTOMER_DEPOSIT_SERVICE, $postData);
|
||||
if ($response['error'] == true){
|
||||
$message = sprintf('customer deposit %s sync to Netsuite fail', $this->order->getIncrementId());
|
||||
$this->logger->debug($message, ['response' => $response, 'postData' => $postData]);
|
||||
}
|
||||
$res['response'] = $response;
|
||||
} else {
|
||||
$res['message'] = 'this order payment method is offline';
|
||||
}
|
||||
} catch (\Exception $exception) {
|
||||
$res['message'] = $message = sprintf('customer deposit %s sync to Netsuite exception: ', $this->order->getIncrementId(), $exception->getMessage());
|
||||
$this->logger->debug($message, ['trace' => $exception->getTrace()]);
|
||||
}
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* look for netsuite order id from http response header Location
|
||||
* @param array $responseHeaders
|
||||
* @return string
|
||||
*/
|
||||
protected function getNetsuiteOrderId(array $responseHeaders)
|
||||
{
|
||||
if (!empty($responseHeaders['Location'])) {
|
||||
$isMatch = preg_match('/salesorder\/(\d+)/', $responseHeaders['Location'], $matches);
|
||||
if ($isMatch) {
|
||||
return $matches[1];
|
||||
}
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取
|
||||
* @param OrderInterface $order
|
||||
* @return array
|
||||
*/
|
||||
public function getSuccessSubOrders(OrderInterface $order)
|
||||
{
|
||||
$information = $order->getData('additional_information');
|
||||
if ($information) {
|
||||
$info = json_decode($information, true);
|
||||
if (is_array($info) && !empty($info['success_sub_orders'])) {
|
||||
return $info['success_sub_orders'];
|
||||
}
|
||||
}
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* 防止同一批订单重复发送邮件
|
||||
* @param array $data
|
||||
* @param array $syncFailKeys
|
||||
* @return void
|
||||
*/
|
||||
protected function sendMail(array $data, array $syncFailKeys)
|
||||
{
|
||||
$member = md5(implode(':', $syncFailKeys));
|
||||
$this->logger->info('订单同步 $member', $syncFailKeys);
|
||||
$sentKeys = $this->credis->get(self::CACHE_IDENTIFIER);
|
||||
if (empty($sentKeys) || !in_array($member, $sentKeys)) {
|
||||
$orders = implode(', ', array_keys($data));
|
||||
try {
|
||||
$this->email->sendMail($orders, json_encode($data));
|
||||
$this->credis->set(self::CACHE_IDENTIFIER, [$member]);
|
||||
} catch (MailException | LocalizedException $e) {
|
||||
$this->logger->error(sprintf('订单%s 同步到netsuite的通知邮件发送失败,原因:%s', $orders, $e->getMessage()), $e->getTrace());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute the cron
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function execute(): void
|
||||
{
|
||||
$waitSyncOrders = $this->getWaitSyncOrders()->getItems();
|
||||
$this->logger->info('订单同步到netsuite');
|
||||
$syncFail = $syncFailKeys = [];
|
||||
foreach ($waitSyncOrders as $order) {
|
||||
$orderNetsuiteId = null;
|
||||
$syncLog = [];
|
||||
$this->order = $order;
|
||||
/* @var $order \Magento\Sales\Model\Order */
|
||||
try {
|
||||
$successSubOrder = $this->getSuccessSubOrders($order);
|
||||
$syncOrders = $this->getSyncOrders();
|
||||
|
||||
$index = 1;
|
||||
$orderSyncSuccess = true;
|
||||
if (!$syncOrders) {
|
||||
$orderSyncSuccess = false;
|
||||
}
|
||||
foreach ($syncOrders as $sourceCode => $syncOrder) {
|
||||
$locationId = $this->sources[$sourceCode]->getNetsuiteId();
|
||||
unset($syncOrder['increment_id']);
|
||||
$postData = $this->getPostData($locationId, array_values($syncOrder), $index);
|
||||
|
||||
$syncOrders[$sourceCode]['increment_id'] = $postData['externalId'];
|
||||
$index++;
|
||||
if (in_array($postData['externalId'], $successSubOrder)) {
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
$response = $this->netSuiteAPI->postData(self::NETSUITE_SALES_ORDER_SERVICE, $postData);
|
||||
|
||||
if ($response['error'] != true){
|
||||
$syncOrders[$sourceCode]['netsuite_order_id'] = $orderNetsuiteId = $this->getNetsuiteOrderId($this->netSuiteAPI->getResponseHeaders());
|
||||
$successSubOrder[] = $postData['externalId'];
|
||||
} else {
|
||||
$orderSyncSuccess = false;
|
||||
$message = sprintf('order %s sync to Netsuite fail', $postData['externalId']);
|
||||
$this->logger->debug($message, ['response' => $response, 'postData' => $postData]);
|
||||
$syncLog[$sourceCode]['syncFail'] = ['response' => $response, 'postData' => $postData];
|
||||
$syncFail[$order->getIncrementId()][] = $syncLog[$sourceCode]['syncFail'];
|
||||
$syncFailKeys[] = $postData['externalId'];
|
||||
}
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$message = sprintf('order %s sync to Netsuite crash fail: %s', $postData['externalId'], $e->getMessage());
|
||||
$this->logger->error($message, ['postData' => $postData, 'exception' => $e->getTrace()]);
|
||||
}
|
||||
|
||||
}
|
||||
$additionalInformation = ['syncOrders' => $syncOrders, 'syncLog' => $syncLog, 'success_sub_orders' => array_unique($successSubOrder)];
|
||||
if ($orderSyncSuccess) {
|
||||
$this->order->setIsNetsuiteSync(1);
|
||||
$response = $this->customerDepositSync();
|
||||
$additionalInformation['depositSync'] = $response;
|
||||
}
|
||||
|
||||
$this->order->setData('additional_information', json_encode($additionalInformation))
|
||||
->setData('netsuite_id', $orderNetsuiteId);
|
||||
|
||||
$this->orderRepository->save($this->order);
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->error('magento sync to netsuite exception: '.$exception->getMessage(), $exception->getTrace());
|
||||
}
|
||||
$this->quote = null;
|
||||
$this->customer = null;
|
||||
}
|
||||
// $this->logger->info('订单同步到netsuite的失败记录 $syncFail', $syncFail);
|
||||
if (!empty($syncFail)) {
|
||||
$this->sendMail($syncFail, $syncFailKeys);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,605 @@
|
||||
<?php
|
||||
/**
|
||||
* Copyright © All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Lts\Sales\Cron;
|
||||
|
||||
use JR\NetSuite\Lib\Restful\NetSuiteAPI;
|
||||
use JR\NetSuite\Logger\Logger;
|
||||
use Lts\Netterm\Model\Payment\Netterm;
|
||||
use Lts\Sales\Netsuite\ShippingMethodMapping;
|
||||
use Magento\Catalog\Api\ProductRepositoryInterface;
|
||||
use Magento\Customer\Api\CustomerRepositoryInterface;
|
||||
use Magento\Customer\Api\Data\CustomerInterface;
|
||||
use Magento\Framework\Api\SearchCriteriaBuilderFactory;
|
||||
use Magento\Framework\Exception\InvalidArgumentException;
|
||||
use Magento\Framework\Exception\LocalizedException;
|
||||
use Magento\Framework\Exception\NoSuchEntityException;
|
||||
use Magento\Inventory\Model\Source\Command\GetList;
|
||||
use Magento\InventoryApi\Api\Data\SourceItemInterface;
|
||||
use Magento\InventoryApi\Api\SourceItemRepositoryInterface;
|
||||
use Magento\InventoryDistanceBasedSourceSelection\Model\DistanceProvider\GetDistanceFromSourceToAddress;
|
||||
use Magento\InventoryInStorePickupSales\Model\Order\GetPickupLocationCode;
|
||||
use Magento\InventorySourceSelectionApi\Api\Data\AddressInterfaceFactory;
|
||||
use Magento\Quote\Api\CartRepositoryInterface;
|
||||
use Magento\Quote\Api\Data\CartInterface;
|
||||
use Magento\Sales\Api\Data\OrderInterface;
|
||||
use Magento\Sales\Api\Data\OrderItemInterface;
|
||||
use Magento\Sales\Api\OrderRepositoryInterface;
|
||||
use Magento\Sales\Model\ResourceModel\Order\Collection;
|
||||
use Magento\InventoryApi\Api\Data\SourceInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
class OrderNetsuiteSync1
|
||||
{
|
||||
private Logger $logger;
|
||||
private Collection $orderCollection;
|
||||
|
||||
private OrderInterface $order;
|
||||
private CartRepositoryInterface $cartRepository;
|
||||
private ?CartInterface $quote = null;
|
||||
private GetPickupLocationCode $getPickupLocationCode;
|
||||
|
||||
/**
|
||||
* @var SourceInterface[]
|
||||
*/
|
||||
private array $sources = [];
|
||||
private GetList $getList;
|
||||
private ProductRepositoryInterface $productRepository;
|
||||
private NetSuiteAPI $netSuiteAPI;
|
||||
|
||||
const HUB_REPOSITORY_CODE = ['CA-LA', 'TX', 'NJ-MountLaurel'];
|
||||
|
||||
const NETSUITE_CREDIT_CARD_PAYMENT_ID = '12';
|
||||
const NETSUITE_SALES_ORDER_SERVICE = 'record/v1/salesOrder';
|
||||
const NETSUITE_CUSTOMER_DEPOSIT_SERVICE = 'record/v1/customerDeposit';
|
||||
private OrderRepositoryInterface $orderRepository;
|
||||
|
||||
const DEFAULT_INVENTORY_SOURCE = 'default';
|
||||
private SourceItemRepositoryInterface $sourceItemRepository;
|
||||
private SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory;
|
||||
private AddressInterfaceFactory $addressInterfaceFactory;
|
||||
private GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress;
|
||||
private CustomerRepositoryInterface $customerRepository;
|
||||
private ?CustomerInterface $customer = null;
|
||||
private LoggerInterface $magentoLogger;
|
||||
|
||||
/**
|
||||
* @param Logger $logger
|
||||
* @param Collection $orderCollection
|
||||
* @param CartRepositoryInterface $cartRepository
|
||||
* @param GetPickupLocationCode $getPickupLocationCode
|
||||
* @param GetList $getList
|
||||
* @param ProductRepositoryInterface $productRepository
|
||||
* @param NetSuiteAPI $netSuiteAPI
|
||||
* @param OrderRepositoryInterface $orderRepository
|
||||
* @param SourceItemRepositoryInterface $sourceItemRepository
|
||||
* @param SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory
|
||||
* @param GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress
|
||||
* @param AddressInterfaceFactory $addressInterfaceFactory
|
||||
*/
|
||||
public function __construct(
|
||||
Logger $logger,
|
||||
Collection $orderCollection,
|
||||
CartRepositoryInterface $cartRepository,
|
||||
GetPickupLocationCode $getPickupLocationCode,
|
||||
GetList $getList,
|
||||
ProductRepositoryInterface $productRepository,
|
||||
NetSuiteAPI $netSuiteAPI,
|
||||
OrderRepositoryInterface $orderRepository,
|
||||
SourceItemRepositoryInterface $sourceItemRepository,
|
||||
SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory,
|
||||
GetDistanceFromSourceToAddress $getDistanceFromSourceToAddress,
|
||||
AddressInterfaceFactory $addressInterfaceFactory,
|
||||
CustomerRepositoryInterface $customerRepository,
|
||||
LoggerInterface $magentoLogger
|
||||
) {
|
||||
$this->logger = $logger;
|
||||
$this->orderCollection = $orderCollection;
|
||||
$this->cartRepository = $cartRepository;
|
||||
$this->getPickupLocationCode = $getPickupLocationCode;
|
||||
$this->getList = $getList;
|
||||
|
||||
$this->productRepository = $productRepository;
|
||||
$this->netSuiteAPI = $netSuiteAPI;
|
||||
$this->orderRepository = $orderRepository;
|
||||
$this->sourceItemRepository = $sourceItemRepository;
|
||||
$this->searchCriteriaBuilderFactory = $searchCriteriaBuilderFactory;
|
||||
$this->addressInterfaceFactory = $addressInterfaceFactory;
|
||||
$this->getDistanceFromSourceToAddress = $getDistanceFromSourceToAddress;
|
||||
$this->customerRepository = $customerRepository;
|
||||
$this->magentoLogger = $magentoLogger;
|
||||
$this->getInventorySources();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
protected function getInventorySources()
|
||||
{
|
||||
if (empty($this->sources)) {
|
||||
foreach ($this->getList->execute()->getItems() as $item) {
|
||||
$this->sources[$item->getSourceCode()] = $item;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->sources;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws LocalizedException
|
||||
*/
|
||||
protected function getCardInfo()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
$billingAddress = $this->order->getBillingAddress();
|
||||
$paymentMethod = $payment->getMethodInstance();
|
||||
if ($paymentMethod->isOffline()) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return $payment->getCcType().': '.$payment->getCcLast4().', '.
|
||||
$billingAddress->getFirstname().' '.$billingAddress->getLastname().': '.
|
||||
implode(' ', $billingAddress->getStreet()).', '.
|
||||
$billingAddress->getCity().', '.$billingAddress->getRegion() .', '.$billingAddress->getPostcode();
|
||||
|
||||
}
|
||||
|
||||
protected function getProductNetsuiteId(int $productId)
|
||||
{
|
||||
try {
|
||||
$product = $this->productRepository->getById($productId);
|
||||
return $product->getNetsuiteId();
|
||||
} catch (NoSuchEntityException $e) {
|
||||
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $pickupLocationCode
|
||||
* @return array
|
||||
*/
|
||||
protected function getNetsuiteOrderItems(string $pickupLocationCode)
|
||||
{
|
||||
$data = [];
|
||||
if (!empty($pickupLocationCode)) {
|
||||
foreach ($this->order->getAllVisibleItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
$data[$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $item->getQtyOrdered()*1.0
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* 拆单规则:
|
||||
* 在checkout的时候,如果客户选择ship out,我们首先看哪个hub有相对应的库存,如果每一个hub都有货,那我们就根据shipping address的
|
||||
* region来确定哪个hub出货。譬如旧金山下单了,三个hub都有货,那我们优先从西部的hub(洛杉矶)出货。假如说三个hub都没货,那我们就优先从
|
||||
* 有货的warehouse出,如果有多个仓库有货的话还是按照region来。
|
||||
*
|
||||
* 如果没有一个仓库能满足整张单的库存量的话,那我们就会拆单。具体的选择仓库或者hub的逻辑还是按照上面的那个来,哪个能fulfill的多的就从哪
|
||||
* 一个出,如果有多个的话就距离优先。如果可以的话,可以在M2就拆成两张单吗?税的话应该怎么拆都不会变,因为都是按照销售的物品来的。运费的话
|
||||
* 我们是这样子想的,如果拆成两张单,我们只会收客户两张单里面运费高的那一份运费,剩下的运费我们自己承担。
|
||||
*
|
||||
* hub的话是指我们三个大仓库,分别是LA,TX,NJ,
|
||||
*
|
||||
* 如果客户选择pickup的话,如果他选择的preferred warehouse里面有库存的话那就直接可以process;如果没有的话,我们就会提示客户说当前物
|
||||
* 品在你preferred warehouse没有库存,你可以选择配送或者把缺货商品从购物车里移除
|
||||
*
|
||||
* (1) 关于订单同步到netsuite时的拆单
|
||||
* (1.1)根据上述规则拆单
|
||||
* (1.2)运费可以放在其中一张单上
|
||||
* (1.3)订单金额根据拆单后的产品的金额计算
|
||||
* (1.4)税可以不用给
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getSyncOrders()
|
||||
{
|
||||
/* @var $info string | null */
|
||||
$information = $this->order->getData('additional_information');
|
||||
if ($information) {
|
||||
$info = json_decode($information, true);
|
||||
if (is_array($info) && isset($info['syncOrders'])) {
|
||||
return $info['syncOrders'];
|
||||
}
|
||||
}
|
||||
$pickupLocationCode = $this->getPickupLocationCode->execute($this->order);
|
||||
if ($pickupLocationCode) {
|
||||
return [$pickupLocationCode => $this->getNetsuiteOrderItems($pickupLocationCode)];
|
||||
}
|
||||
|
||||
return $this->orderSplit();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|float $number
|
||||
* @return float
|
||||
*/
|
||||
protected function numberFormat(string | float $number)
|
||||
{
|
||||
return number_format($number*1.0, 2, '.', '')*1.0;
|
||||
}
|
||||
/**
|
||||
* order split
|
||||
* @return array
|
||||
*/
|
||||
protected function orderSplit()
|
||||
{
|
||||
$result = [];
|
||||
foreach ($this->order->getAllVisibleItems() as $item) {
|
||||
/* @var $item OrderItemInterface */
|
||||
echo sprintf('order %s item id %d', $this->order->getIncrementId(), $item->getItemId());
|
||||
foreach ($this->getInventorySourceFromProduct($item) as $sourceCode =>$splitItem) {
|
||||
$result[$sourceCode][$item->getItemId()] = [
|
||||
'item' => ['id' => $this->getProductNetsuiteId((int)$item->getProductId())],
|
||||
'rate' => $this->numberFormat($item->getPrice()),
|
||||
'sku' => $item->getSku(),
|
||||
'quantity' => $splitItem[$item->getItemId()]*1.0
|
||||
];
|
||||
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return float[][]
|
||||
*/
|
||||
protected function getInventorySourceFromProduct(OrderItemInterface $orderItem)
|
||||
{
|
||||
$searchCriteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter(SourceItemInterface::SKU, $orderItem->getSku())
|
||||
->addFilter(SourceItemInterface::SOURCE_CODE, self::DEFAULT_INVENTORY_SOURCE, 'neq')
|
||||
->create();
|
||||
|
||||
$sourceItems = $this->sourceItemRepository->getList($searchCriteria)->getItems();
|
||||
$availableItems = [];
|
||||
|
||||
$distances = [];
|
||||
$oneSource = false;
|
||||
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$sourceAddress = $this->addressTransform($this->order->getShippingAddress());
|
||||
|
||||
$distances[$sourceItem->getSourceCode()] = $distance = $this->getDistanceFromSourceToAddress->execute(
|
||||
$this->sources[$sourceItem->getSourceCode()],
|
||||
$sourceAddress
|
||||
);
|
||||
|
||||
if ($sourceItem->getQuantity() >= $orderItem->getQtyOrdered()) {
|
||||
$oneSource = true;
|
||||
$availableItems[$distance] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
//one warehouse inventory is not enough for this order product
|
||||
if (empty($availableItems)) {
|
||||
foreach ($sourceItems as $sourceItem) {
|
||||
$availableItems[$distances[$sourceItem->getSourceCode()]] = [
|
||||
'sourceItem' => $sourceItem,
|
||||
'isHub' => in_array($sourceItem->getSourceCode(), self::HUB_REPOSITORY_CODE)
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
ksort($availableItems);
|
||||
// $warehouseDistances = [];
|
||||
// foreach ($availableItems as $distance => $items) {
|
||||
// $warehouseDistances[] = [
|
||||
// 'product'=>$orderItem->getSku(),
|
||||
// 'warehouse code'=>$items['sourceItem']->getSourceCode(),
|
||||
// 'warehouse_stock' => $items['sourceItem']->getQuantity(),
|
||||
// 'distance'=>$distance,
|
||||
// 'isHub' => $items['isHub']
|
||||
// ];
|
||||
// }
|
||||
// $this->logger->debug('distance on warehouse: ', $warehouseDistances);
|
||||
return $this->getPreferredInventorySource($availableItems, $orderItem, $oneSource);
|
||||
}
|
||||
|
||||
/**
|
||||
* choose preferred warehouse for ordered product
|
||||
*/
|
||||
protected function getPreferredInventorySource(array $availableItems, OrderItemInterface $orderItem, bool $oneSource)
|
||||
{
|
||||
$hub = [];
|
||||
$other = [];
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
foreach ($availableItems as $availableItem) {
|
||||
if ($availableItem['isHub']) {
|
||||
$hub[] = $availableItem;
|
||||
} else {
|
||||
$other[] = $availableItem;
|
||||
}
|
||||
}
|
||||
|
||||
//if one warehouse stock is enough for this ordered product, then return
|
||||
if ($oneSource === true) {
|
||||
$source = !empty($hub)? current($hub):current($other);
|
||||
// $source['qty'] = $qty;
|
||||
return [$source['sourceItem']->getSourceCode() => [$orderItem->getItemId() => $qty]];
|
||||
}
|
||||
|
||||
$aggregation = [];
|
||||
$total = 0;
|
||||
foreach ($availableItems as $item) {
|
||||
if ($total < $qty) {
|
||||
$aggregation[$item['sourceItem']->getSourceCode()] = $item['sourceItem']->getQuantity();
|
||||
}
|
||||
$total += $item['sourceItem']->getQuantity();
|
||||
}
|
||||
|
||||
return $this->correctLastWarehouseQty($aggregation, $orderItem);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $availableItems
|
||||
* @param OrderItemInterface $orderItem
|
||||
* @return array
|
||||
*/
|
||||
protected function correctLastWarehouseQty(array $availableItems, OrderItemInterface $orderItem)
|
||||
{
|
||||
|
||||
$lastKey = array_key_last($availableItems);
|
||||
$qty = $orderItem->getQtyOrdered();
|
||||
$lastQty = $qty;
|
||||
$data = [];
|
||||
foreach ($availableItems as $sourceCode => $qty) {
|
||||
if ($sourceCode != $lastKey) {
|
||||
$lastQty -= $qty;
|
||||
} else {
|
||||
$availableItems[$lastKey] = $lastQty;
|
||||
}
|
||||
$data[$sourceCode][$orderItem->getItemId()] = $availableItems[$sourceCode];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* transform order address to the calculate distance address
|
||||
* @param \Magento\Sales\Api\Data\OrderAddressInterface $address
|
||||
* @return \Magento\InventorySourceSelectionApi\Api\Data\AddressInterface
|
||||
*/
|
||||
protected function addressTransform(\Magento\Sales\Api\Data\OrderAddressInterface $address) {
|
||||
if ($address->getStreet()) {
|
||||
$streets = implode(' ', $address->getStreet());
|
||||
}
|
||||
return $this->addressInterfaceFactory->create([
|
||||
'country' => $address->getCountryId() ?? '',
|
||||
'postcode' => $address->getPostcode() ?? '',
|
||||
'street' => $streets ?? '',
|
||||
'region' => $address->getRegion() ?? '',
|
||||
'city' => $address->getCity() ?? ''
|
||||
]);
|
||||
}
|
||||
|
||||
protected function getShippingAddress()
|
||||
{
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$streets = ['', ''];
|
||||
if ($shippingAddress->getStreet()) {
|
||||
$streets = $shippingAddress->getStreet();
|
||||
}
|
||||
return [
|
||||
'country' => ['id' => 'US'],
|
||||
'addr1' => $streets[0],
|
||||
'addr2' => $streets[1] ?? '',
|
||||
'city' => $shippingAddress->getCity(),
|
||||
'state' => $shippingAddress->getRegionCode(),
|
||||
'zip' => $shippingAddress->getPostcode(),
|
||||
'addressee' => $shippingAddress->getFirstname() . ' ' . $shippingAddress->getLastname(),
|
||||
'attention' => null,
|
||||
'addrPhone' => $shippingAddress->getTelephone(),
|
||||
'override' => false
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getTerms()
|
||||
{
|
||||
$payment = $this->order->getPayment();
|
||||
if ($payment->getMethod() == NetTerm::PAYMENT_METHOD_NETTERM_CODE) {
|
||||
return $this->getQuote()->getNetsuitePaymentId();
|
||||
}
|
||||
|
||||
return self::NETSUITE_CREDIT_CARD_PAYMENT_ID;
|
||||
}
|
||||
|
||||
protected function getCustomer() {
|
||||
if ($this->customer) {
|
||||
return $this->customer;
|
||||
}
|
||||
if ($this->order->getCustomer()) {
|
||||
$this->customer = $this->order->getCustomer()->getDataModel();
|
||||
}
|
||||
|
||||
$this->customer = $this->customerRepository->getById($this->order->getCustomerId());
|
||||
|
||||
return $this->customer;
|
||||
}
|
||||
protected function getPostData(string $locationId, array $items, int $index)
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
|
||||
$shippingAddress = $this->order->getShippingAddress();
|
||||
$shippingCost = 0;
|
||||
if ($index == 1) {
|
||||
$shippingCost = $this->numberFormat($this->order->getShippingAmount());
|
||||
}
|
||||
|
||||
foreach ($items as &$item) {
|
||||
unset($item['sku']);
|
||||
}
|
||||
|
||||
return [
|
||||
'externalId'=> 'Magento-'.$this->order->getIncrementId().'-'.$index,
|
||||
'entity' => [
|
||||
'id'=>$dataCustomer->getCustomAttribute('netsuite_id')->getValue(),
|
||||
],
|
||||
|
||||
'terms' => ['id' => $this->getTerms()],
|
||||
'otherRefNum' => $this->getQuote()->getOtherRefNum(),
|
||||
'custbody_il_email' => $shippingAddress->getEmail(),
|
||||
'custbody_il_phone' => $shippingAddress->getTelephone(),
|
||||
'custbody_card_info' => $this->getCardInfo(),
|
||||
'custbody_ecommerce_order_no' => 'Magento-'.$this->order->getIncrementId().'-'.$index,
|
||||
'subsidiary' => ['id'=> 3],
|
||||
'cseg_ncg_rep_office' => ['id'=> 13],
|
||||
'location' => ['id'=> $locationId],
|
||||
'custbody_location_filter' => 'RMA',
|
||||
// 'discountItem' => ['id'=> -6],
|
||||
// 'discountRate' => 6.17,
|
||||
'shipMethod' => ['id'=> ShippingMethodMapping::getShippingMethodId($this->order->getShippingMethod())],
|
||||
'shippingCost' => $shippingCost,
|
||||
'shipAddressList' => ['id'=>-2],
|
||||
'shipIsResidential' => false,
|
||||
'shippingAddress' => $this->getShippingAddress(),
|
||||
'item' => ['items'=>$items],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CartInterface
|
||||
* @throws NoSuchEntityException
|
||||
*/
|
||||
protected function getQuote()
|
||||
{
|
||||
if (!$this->quote) {
|
||||
$this->quote = $this->cartRepository->get($this->order->getQuoteId());
|
||||
}
|
||||
|
||||
return $this->quote;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \Magento\Sales\Api\Data\OrderSearchResultInterface
|
||||
*/
|
||||
protected function getWaitSyncOrders()
|
||||
{
|
||||
$criteria = $this->searchCriteriaBuilderFactory->create()
|
||||
->addFilter('is_netsuite_sync', 0)
|
||||
->addFilter('entity_id', [17173], 'in')
|
||||
->create();
|
||||
return $this->orderRepository->getList($criteria);
|
||||
}
|
||||
|
||||
protected function customerDepositBuild()
|
||||
{
|
||||
$dataCustomer = $this->getCustomer();
|
||||
return [
|
||||
'externalId'=> 'CD-'.$this->order->getIncrementId().'-1',
|
||||
'customer' => ['id' => $dataCustomer->getCustomAttribute('netsuite_id')->getValue()],
|
||||
'salesOrder' => ['externalId' => 'Magento-'.$this->order->getIncrementId().'-1'],
|
||||
'payment' => $this->numberFormat($this->order->getGrandTotal())
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OrderInterface $order
|
||||
* @return $this
|
||||
*/
|
||||
public function setOrder(OrderInterface $order)
|
||||
{
|
||||
$this->order = $order;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function customerDepositSync()
|
||||
{
|
||||
$res = [];
|
||||
try {
|
||||
$paymentMethod = $this->order->getPayment()->getMethodInstance();
|
||||
if (!$paymentMethod->isOffline()) {
|
||||
$postData = $this->customerDepositBuild();
|
||||
$response = $this->netSuiteAPI->postData(self::NETSUITE_CUSTOMER_DEPOSIT_SERVICE, $postData);
|
||||
if ($response['error'] == true){
|
||||
$message = sprintf('customer deposit %s sync to Netsuite fail', $this->order->getIncrementId());
|
||||
$this->logger->debug($message, ['response' => $response, 'postData' => $postData]);
|
||||
}
|
||||
$res['response'] = $response;
|
||||
} else {
|
||||
$res['message'] = 'this order payment method is offline';
|
||||
}
|
||||
} catch (\Exception $exception) {
|
||||
$res['message'] = $message = sprintf('customer deposit %s sync to Netsuite exception: ', $this->order->getIncrementId(), $exception->getMessage());
|
||||
$this->logger->debug($message, ['trace' => $exception->getTrace()]);
|
||||
}
|
||||
|
||||
return $res;
|
||||
}
|
||||
/**
|
||||
* Execute the cron
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function execute(): void
|
||||
{
|
||||
$waitSyncOrders = $this->getWaitSyncOrders()->getItems();
|
||||
foreach ($waitSyncOrders as $order) {
|
||||
$this->order = $order;
|
||||
/* @var $order \Magento\Sales\Model\Order */
|
||||
try {
|
||||
$syncOrders = $this->getSyncOrders();
|
||||
echo '$syncOrders: '.json_encode($syncOrders, JSON_PRETTY_PRINT)."\n";
|
||||
$index = 1;
|
||||
$orderSyncSuccess = true;
|
||||
foreach ($syncOrders as $sourceCode => $syncOrder) {
|
||||
$locationId = $this->sources[$sourceCode]->getNetsuiteId();
|
||||
unset($syncOrder['increment_id']);
|
||||
$postData = $this->getPostData($locationId, array_values($syncOrder), $index);
|
||||
|
||||
$syncOrders[$sourceCode]['increment_id'] = $postData['externalId'];
|
||||
$index++;
|
||||
|
||||
try {
|
||||
$response = $this->netSuiteAPI->postData(self::NETSUITE_SALES_ORDER_SERVICE, $postData);
|
||||
$this->logger->debug('order sync to netsuite ', ['response' => $response, 'postData' => $postData]);
|
||||
if ($response['error'] != true){
|
||||
$this->order->setIsNetsuiteSync(1);
|
||||
} else {
|
||||
$orderSyncSuccess = false;
|
||||
$message = sprintf('order %s sync to Netsuite fail', $postData['externalId']);
|
||||
$this->logger->debug($message, ['response' => $response, 'postData' => $postData]);
|
||||
}
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$message = sprintf('order %s sync to Netsuite crash fail: %s', $postData['externalId'], $e->getMessage());
|
||||
$this->logger->error($message, ['postData' => $postData, 'exception' => $e->getTrace()]);
|
||||
}
|
||||
|
||||
}
|
||||
$additionalInformation = ['syncOrders' => $syncOrders];
|
||||
if ($orderSyncSuccess) {
|
||||
$response = $this->customerDepositSync();
|
||||
$additionalInformation['depositSync'] = $response;
|
||||
}
|
||||
|
||||
$this->order->setData('additional_information', json_encode($additionalInformation));
|
||||
$this->orderRepository->save($this->order);
|
||||
} catch (\Exception $exception) {
|
||||
$this->magentoLogger->error('magento sync to netsuite exception: '.$exception->getMessage(), $exception->getTrace());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,45 @@
|
||||
<?php
|
||||
|
||||
namespace Lts\Sales\Helper;
|
||||
|
||||
use Credis_Client;
|
||||
use Magento\Framework\App\DeploymentConfig;
|
||||
|
||||
class CredisStorage
|
||||
{
|
||||
private Credis_Client $redis;
|
||||
|
||||
public function __construct(DeploymentConfig $deploymentConfig)
|
||||
{
|
||||
$options = (array) $deploymentConfig->get(
|
||||
'cache/frontend/default/backend_options'
|
||||
);
|
||||
|
||||
$this->redis = new Credis_Client(
|
||||
$options['server'] ?? '127.0.0.1',
|
||||
(int)($options['port'] ?? 6379),
|
||||
(float)($options['timeout'] ?? 2.5),
|
||||
'',
|
||||
(int)($options['database'] ?? 0),
|
||||
$options['password'] ?? null
|
||||
);
|
||||
|
||||
if (!empty($options['key_prefix'])) {
|
||||
$this->redis->setPrefix($options['key_prefix']);
|
||||
}
|
||||
}
|
||||
|
||||
public function get(string $key)
|
||||
{
|
||||
return $this->redis->SMEMBERS($key);
|
||||
}
|
||||
|
||||
public function set(string $key, $value)
|
||||
{
|
||||
$this->redis->sAdd($key, $value);
|
||||
}
|
||||
|
||||
public function isExist(string $key, $value) {
|
||||
return $this->redis->sIsMember($key, $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,100 @@
|
||||
<?php
|
||||
|
||||
namespace Lts\Sales\Helper;
|
||||
|
||||
use Magento\Framework\App\Helper\AbstractHelper;
|
||||
use Magento\Framework\Exception\LocalizedException;
|
||||
use Magento\Store\Model\ScopeInterface;
|
||||
use Magento\Framework\App\Helper\Context;
|
||||
use Magento\Store\Model\StoreManagerInterface;
|
||||
use Magento\Framework\Exception\MailException;
|
||||
use Magento\Framework\Mail\Template\TransportBuilder;
|
||||
use Magento\Framework\Translate\Inline\StateInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Magento\Framework\App\Area;
|
||||
use JR\NetSuite\Logger\Logger;
|
||||
|
||||
class Email extends AbstractHelper
|
||||
{
|
||||
|
||||
public function __construct(
|
||||
protected Context $context,
|
||||
protected StoreManagerInterface $storeManager,
|
||||
protected TransportBuilder $transportBuilder,
|
||||
protected StateInterface $inlineTranslation,
|
||||
protected Logger $logger
|
||||
)
|
||||
{
|
||||
parent::__construct($context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Send Mail
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @throws LocalizedException
|
||||
* @throws MailException
|
||||
* @throws LocalizedException
|
||||
*/
|
||||
public function sendMail(string $orders, string $syncFailData)
|
||||
{
|
||||
$email = 'netsuite.admins@ltsecurityinc.com';
|
||||
// $email = 'fengliang2626@vip.qq.com';
|
||||
|
||||
$this->inlineTranslation->suspend();
|
||||
$storeId = $this->getStoreId();
|
||||
|
||||
/* email template */
|
||||
$template = 'sales_order_sync_nesuite';
|
||||
|
||||
$vars = [
|
||||
'syncFailData' => $syncFailData,
|
||||
'orders' => $orders,
|
||||
'store' => $this->getStore()
|
||||
];
|
||||
|
||||
|
||||
$transport = $this->transportBuilder->setTemplateIdentifier(
|
||||
$template
|
||||
)->setTemplateOptions(
|
||||
[
|
||||
'area' => Area::AREA_FRONTEND,
|
||||
'store' => $this->getStoreId()
|
||||
]
|
||||
)->setTemplateVars(
|
||||
$vars
|
||||
)->setFromByScope(
|
||||
'general'
|
||||
)->addTo(
|
||||
$email
|
||||
)->addBcc(
|
||||
['344531331@qq.com']
|
||||
)->getTransport();
|
||||
|
||||
try {
|
||||
$transport->sendMessage();
|
||||
} catch (\Exception $exception) {
|
||||
$this->logger->critical($exception->getMessage());
|
||||
}
|
||||
$this->inlineTranslation->resume();
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/*
|
||||
* get Current store id
|
||||
*/
|
||||
public function getStoreId()
|
||||
{
|
||||
return $this->storeManager->getStore()->getId();
|
||||
}
|
||||
|
||||
/*
|
||||
* get Current store Info
|
||||
*/
|
||||
public function getStore()
|
||||
{
|
||||
return $this->storeManager->getStore();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,619 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
namespace Lts\Sales\Netsuite;
|
||||
|
||||
enum ShippingMethodMapping : int
|
||||
{
|
||||
//magento shipping method code => netsuite shipping method id
|
||||
//In store pickup
|
||||
case instore_pickup = 911;
|
||||
|
||||
//UPS Ground
|
||||
case ups_03 = 1716;
|
||||
|
||||
//UPS Three-Day Select
|
||||
case ups_12 = 7076;
|
||||
|
||||
//UPS Second Day Air
|
||||
case ups_02 = 4622;
|
||||
|
||||
//UPS Next Day Air
|
||||
case ups_01 = 7077;
|
||||
|
||||
//UPS Next Day Air Early A.M.
|
||||
case ups_14 = 7074;
|
||||
|
||||
/**
|
||||
* @param string $code
|
||||
* @return int|null
|
||||
*/
|
||||
public static function getShippingMethodId(string $code)
|
||||
{
|
||||
foreach (self::cases() as $value) {
|
||||
|
||||
if (strtolower($value->name) === strtolower($code)) {
|
||||
return $value->value;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
namespace Lts\Sales\Observer;
|
||||
|
||||
use Magento\Framework\Event\Observer;
|
||||
use Magento\Framework\Event\ObserverInterface;
|
||||
use Magento\Sales\Api\Data\OrderInterface;
|
||||
use Magento\Sales\Api\OrderRepositoryInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
|
||||
class WaitForSyncToNetSuite implements ObserverInterface
|
||||
{
|
||||
/**
|
||||
* @var LoggerInterface
|
||||
*/
|
||||
protected $logger;
|
||||
private OrderRepositoryInterface $orderRepository;
|
||||
|
||||
|
||||
/**
|
||||
* @param LoggerInterface $logger
|
||||
*/
|
||||
public function __construct(
|
||||
LoggerInterface $logger,
|
||||
OrderRepositoryInterface $orderRepository,
|
||||
) {
|
||||
$this->logger = $logger;
|
||||
$this->orderRepository = $orderRepository;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Observer $observer
|
||||
* @return void
|
||||
*/
|
||||
public function execute(Observer $observer)
|
||||
{
|
||||
/** @var OrderInterface $order */
|
||||
$order = $observer->getEvent()->getOrder();
|
||||
|
||||
/* check whether the order comes from netsuite */
|
||||
if ($order->getNetsuiteNumber()) {
|
||||
return;
|
||||
}
|
||||
$order->getExtensionAttributes()?->setIsNetsuiteSync(false);
|
||||
$order->setIsNetsuiteSync(false);
|
||||
try {
|
||||
if ($order->getEntityId()) {
|
||||
$this->orderRepository->save($order);
|
||||
$this->logger->critical('WaitForSyncToNetSuite order id: ' . var_export($order->getEntityId(), true));
|
||||
} else {
|
||||
$this->logger->critical('WaitForSyncToNetSuite order not place now ');
|
||||
}
|
||||
|
||||
} catch (\Exception $e) {
|
||||
$this->logger->critical('WaitForSyncToNetSuite Exception: ' . $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
# Mage2 Module Lts Sales
|
||||
|
||||
``lts/module-sales``
|
||||
|
||||
- [Main Functionalities](#markdown-header-main-functionalities)
|
||||
- [Installation](#markdown-header-installation)
|
||||
- [Configuration](#markdown-header-configuration)
|
||||
- [Specifications](#markdown-header-specifications)
|
||||
- [Attributes](#markdown-header-attributes)
|
||||
|
||||
|
||||
## Main Functionalities
|
||||
Sales additional business logic
|
||||
|
||||
## Installation
|
||||
\* = in production please use the `--keep-generated` option
|
||||
|
||||
### Type 1: Zip file
|
||||
|
||||
- Unzip the zip file in `app/code/Lts`
|
||||
- Enable the module by running `php bin/magento module:enable Lts_Sales`
|
||||
- Apply database updates by running `php bin/magento setup:upgrade`\*
|
||||
- Flush the cache by running `php bin/magento cache:flush`
|
||||
|
||||
### Type 2: Composer
|
||||
|
||||
- Make the module available in a composer repository for example:
|
||||
- private repository `repo.magento.com`
|
||||
- public repository `packagist.org`
|
||||
- public github repository as vcs
|
||||
- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
|
||||
- Install the module composer by running `composer require lts/module-sales`
|
||||
- enable the module by running `php bin/magento module:enable Lts_Sales`
|
||||
- apply database updates by running `php bin/magento setup:upgrade`\*
|
||||
- Flush the cache by running `php bin/magento cache:flush`
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
|
||||
|
||||
## Specifications
|
||||
|
||||
- Cronjob
|
||||
- lts_sales_ordernetsuitesync
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
- Sales - isNetsuiteSync (is_netsuite_sync)
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "lts/module-sales",
|
||||
"description": "Sales additional business logic",
|
||||
"type": "magento2-module",
|
||||
"license": "GPL-3.0",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Liang Feng",
|
||||
"email": "liang.feng.antunnel@gmail.com"
|
||||
}
|
||||
],
|
||||
"minimum-stability": "dev",
|
||||
"require": {},
|
||||
"autoload": {
|
||||
"files": [
|
||||
"registration.php"
|
||||
],
|
||||
"psr-4": {
|
||||
"Lts\\Sales\\": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" ?>
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
|
||||
<group id="default">
|
||||
<job name="lts_sales_order_netsuite_sync" instance="Lts\Sales\Cron\OrderNetsuiteSync" method="execute">
|
||||
<schedule>*/5 * * * *</schedule>
|
||||
</job>
|
||||
</group>
|
||||
</config>
|
||||
@@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" ?>
|
||||
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema.xsd">
|
||||
<table name="sales_order">
|
||||
<column name="additional_information" nullable="true" xsi:type="text" comment="keep some order information in json"/>
|
||||
<column name="is_netsuite_sync" nullable="true" xsi:type="smallint" comment="is synced to Netsuite"/>
|
||||
</table>
|
||||
</schema>
|
||||
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" ?>
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
|
||||
<type name="Magento\Framework\Console\CommandList">
|
||||
<arguments>
|
||||
<argument name="commands" xsi:type="array">
|
||||
<item name="order_netsuite_sync" xsi:type="object">Lts\Sales\Console\Command\OrderNetsuiteSync</item>
|
||||
</argument>
|
||||
</arguments>
|
||||
</type>
|
||||
</config>
|
||||
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0"?>
|
||||
<!--
|
||||
/**
|
||||
* Copyright © Magento, Inc. All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
-->
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
|
||||
<template id="sales_order_sync_nesuite" label="Sales Order Sync Nesuite" file="sales_order_sync_nesuite.html" type="html" module="Lts_Sales" area="frontend"/>
|
||||
</config>
|
||||
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0"?>
|
||||
<!--
|
||||
/**
|
||||
* Copyright © Magento, Inc. All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
-->
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
|
||||
<event name="sales_model_service_quote_submit_success">
|
||||
<observer name="wait_to_sync_netsuite" instance="Lts\Sales\Observer\WaitForSyncToNetSuite"/>
|
||||
</event>
|
||||
</config>
|
||||
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0"?>
|
||||
<!--
|
||||
/**
|
||||
* Copyright © Magento, Inc. All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
-->
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
|
||||
<extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
|
||||
<attribute code="is_netsuite_sync" type="int" />
|
||||
</extension_attributes>
|
||||
</config>
|
||||
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" ?>
|
||||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
|
||||
<module name="Lts_Sales">
|
||||
<sequence>
|
||||
<module name="Magento_Sales"/>
|
||||
</sequence>
|
||||
</module>
|
||||
</config>
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
/**
|
||||
* Copyright © All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
declare(strict_types=1);
|
||||
|
||||
use Magento\Framework\Component\ComponentRegistrar;
|
||||
|
||||
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Lts_Sales', __DIR__);
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
<!--
|
||||
/**
|
||||
* Copyright © Magento, Inc. All rights reserved.
|
||||
* See COPYING.txt for license details.
|
||||
*/
|
||||
-->
|
||||
<!--@subject Order {{var orders}} sync to Netsuite fail @-->
|
||||
|
||||
|
||||
<p style="font-size: 16px">The following is detail data for sync fail order:</p>
|
||||
<pre style="font-size: 16px">
|
||||
{{var syncFailData}}
|
||||
</pre>
|
||||
|
||||
{{template config_path="design/email/footer_template"}}
|
||||
Reference in New Issue
Block a user