Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.liferay.commerce.initializer.util.CommerceShipmentGenerator Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.commerce.initializer.util;
import com.liferay.commerce.constants.CommerceShipmentConstants;
import com.liferay.commerce.inventory.model.CommerceInventoryWarehouse;
import com.liferay.commerce.inventory.service.CommerceInventoryWarehouseLocalService;
import com.liferay.commerce.model.CommerceOrder;
import com.liferay.commerce.model.CommerceOrderItem;
import com.liferay.commerce.model.CommerceShipment;
import com.liferay.commerce.product.model.CPInstanceUnitOfMeasure;
import com.liferay.commerce.product.service.CPInstanceUnitOfMeasureLocalService;
import com.liferay.commerce.product.service.CommerceChannelLocalService;
import com.liferay.commerce.service.CommerceOrderItemService;
import com.liferay.commerce.service.CommerceOrderService;
import com.liferay.commerce.service.CommerceShipmentItemLocalService;
import com.liferay.commerce.service.CommerceShipmentLocalService;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Company;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Role;
import com.liferay.portal.kernel.model.RoleConstants;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.security.auth.PrincipalThreadLocal;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.security.permission.PermissionCheckerFactory;
import com.liferay.portal.kernel.security.permission.PermissionThreadLocal;
import com.liferay.portal.kernel.service.CompanyLocalService;
import com.liferay.portal.kernel.service.GroupLocalService;
import com.liferay.portal.kernel.service.RoleLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.service.UserLocalService;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.TransactionConfig;
import com.liferay.portal.kernel.transaction.TransactionInvokerUtil;
import com.liferay.portal.kernel.util.BigDecimalUtil;
import com.liferay.portal.kernel.util.CalendarFactoryUtil;
import java.math.BigDecimal;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import java.util.Random;
import java.util.concurrent.Callable;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
/**
* @author Alessio Antonio Rendina
*/
@Component(service = CommerceShipmentGenerator.class)
public class CommerceShipmentGenerator {
public void generate(long groupId, int shipmentsCount) {
Callable generateShipmentsCallable =
new GenerateShipmentsCallable(groupId, shipmentsCount);
try {
TransactionInvokerUtil.invoke(
_transactionConfig, generateShipmentsCallable);
}
catch (Throwable throwable) {
_log.error(throwable, throwable);
}
}
private Calendar _convertDateToCalendar(Date date, int days) {
if (date == null) {
date = new Date();
}
Calendar calendar = CalendarFactoryUtil.getCalendar();
calendar.setTime(date);
calendar.add(Calendar.DAY_OF_YEAR, days);
return calendar;
}
private void _generateCommerceShipment(
CommerceOrder commerceOrder,
List commerceInventoryWarehouses)
throws Exception {
// Commerce order items
List commerceOrderItems =
_commerceOrderItemService.getAvailableForShipmentCommerceOrderItems(
commerceOrder.getCommerceOrderId());
if (commerceOrderItems == null) {
_log.error(
"There are no items ready to be shipped for order " +
commerceOrder.getCommerceOrderId());
return;
}
// Add commerce shipment
ServiceContext serviceContext = _getServiceContext(commerceOrder);
CommerceShipment commerceShipment =
_commerceShipmentLocalService.addCommerceShipment(
commerceOrder.getCommerceOrderId(), serviceContext);
// Commerce shipment items
_generateCommerceShipmentItems(
commerceShipment.getCommerceShipmentId(), commerceOrderItems,
commerceInventoryWarehouses, serviceContext);
// Update commerce shipment
Calendar shippingDateCalendar = _convertDateToCalendar(
commerceShipment.getShippingDate(), 0);
Calendar expectedDateCalendar = _convertDateToCalendar(
commerceShipment.getExpectedDate(), _randomInt(3, 10));
_commerceShipmentLocalService.updateCommerceShipment(
commerceShipment.getCommerceShipmentId(),
commerceShipment.getCommerceShippingMethodId(),
commerceShipment.getCarrier(),
expectedDateCalendar.get(Calendar.MONTH),
expectedDateCalendar.get(Calendar.DAY_OF_MONTH),
expectedDateCalendar.get(Calendar.YEAR),
expectedDateCalendar.get(Calendar.HOUR),
expectedDateCalendar.get(Calendar.MINUTE),
shippingDateCalendar.get(Calendar.MONTH),
shippingDateCalendar.get(Calendar.DAY_OF_MONTH),
shippingDateCalendar.get(Calendar.YEAR),
shippingDateCalendar.get(Calendar.HOUR),
shippingDateCalendar.get(Calendar.MINUTE),
commerceShipment.getTrackingNumber(),
commerceShipment.getTrackingURL(),
_getRandomCommerceShipmentStatus(), serviceContext);
}
private void _generateCommerceShipmentItems(
long commerceShipmentId, List commerceOrderItems,
List commerceInventoryWarehouses,
ServiceContext serviceContext)
throws Exception {
for (CommerceOrderItem commerceOrderItem : commerceOrderItems) {
CommerceInventoryWarehouse commerceInventoryWarehouse =
_getRandomCommerceInventoryWarehouse(
commerceInventoryWarehouses);
BigDecimal commerceOrderItemQuantity =
commerceOrderItem.getQuantity();
BigDecimal quantity = commerceOrderItemQuantity.subtract(
commerceOrderItem.getShippedQuantity());
BigDecimal commerceInventoryWarehouseItemQuantity =
_getRandomCommerceInventoryWarehouseItemQuantity(
commerceOrderItem, commerceInventoryWarehouse, quantity);
if (BigDecimalUtil.lte(
commerceInventoryWarehouseItemQuantity, BigDecimal.ZERO)) {
continue;
}
_commerceShipmentItemLocalService.addCommerceShipmentItem(
null, commerceShipmentId,
commerceOrderItem.getCommerceOrderItemId(),
commerceInventoryWarehouse.getCommerceInventoryWarehouseId(),
commerceInventoryWarehouseItemQuantity, null, true,
serviceContext);
}
}
private void _generateCommerceShipments(long groupId, int shipmentsCount)
throws Exception {
// Initialize permission checker
_setPermissionChecker(groupId);
// Commerce warehouses
List commerceInventoryWarehouses =
_getCommerceInventoryWarehouses(groupId);
if (commerceInventoryWarehouses.isEmpty()) {
_log.error("There are no active warehouses");
return;
}
// Commerce orders
long commerceChannelGroupId =
_commerceChannelLocalService.getCommerceChannelGroupIdBySiteGroupId(
groupId);
List commerceOrders =
_commerceOrderService.getCommerceOrders(
commerceChannelGroupId,
CommerceShipmentConstants.ALLOWED_ORDER_STATUSES, 0,
shipmentsCount - 1);
if (commerceOrders.isEmpty()) {
_log.error("There are no commerceOrders ready to be shipped");
return;
}
// Commerce Shipments
for (CommerceOrder commerceOrder : commerceOrders) {
_generateCommerceShipment(
commerceOrder, commerceInventoryWarehouses);
}
}
private List _getCommerceInventoryWarehouses(
long groupId)
throws Exception {
Group group = _groupLocalService.getGroup(groupId);
return _commerceInventoryWarehouseLocalService.
getCommerceInventoryWarehouses(group.getCompanyId());
}
private CommerceInventoryWarehouse _getRandomCommerceInventoryWarehouse(
List commerceInventoryWarehouses) {
return commerceInventoryWarehouses.get(
_randomInt(0, commerceInventoryWarehouses.size() - 1));
}
private BigDecimal _getRandomCommerceInventoryWarehouseItemQuantity(
CommerceOrderItem commerceOrderItem,
CommerceInventoryWarehouse commerceInventoryWarehouse,
BigDecimal quantity)
throws Exception {
BigDecimal commerceInventoryWarehouseItemQuantity =
_commerceOrderItemService.getCommerceInventoryWarehouseItemQuantity(
commerceOrderItem.getCommerceOrderItemId(),
commerceInventoryWarehouse.getCommerceInventoryWarehouseId());
if (BigDecimalUtil.lt(
quantity, commerceInventoryWarehouseItemQuantity)) {
commerceInventoryWarehouseItemQuantity = quantity;
}
if (BigDecimalUtil.lte(
commerceInventoryWarehouseItemQuantity, BigDecimal.ZERO)) {
return commerceInventoryWarehouseItemQuantity;
}
List cpInstanceUnitOfMeasures =
_cpInstanceUnitOfMeasureLocalService.getCPInstanceUnitOfMeasures(
commerceOrderItem.getCompanyId(), commerceOrderItem.getSku());
return _randomQuantity(
BigDecimal.ONE, commerceInventoryWarehouseItemQuantity,
(cpInstanceUnitOfMeasures == null) ? null :
cpInstanceUnitOfMeasures.get(0));
}
private int _getRandomCommerceShipmentStatus() {
int i = _randomInt(
0, CommerceShipmentConstants.SHIPMENT_STATUSES.length - 1);
return CommerceShipmentConstants.SHIPMENT_STATUSES[i];
}
private ServiceContext _getServiceContext(CommerceOrder commerceOrder) {
ServiceContext serviceContext = new ServiceContext();
serviceContext.setCompanyId(commerceOrder.getCompanyId());
serviceContext.setScopeGroupId(commerceOrder.getGroupId());
serviceContext.setUserId(commerceOrder.getUserId());
return serviceContext;
}
private int _randomInt(int min, int max) {
if (max < min) {
throw new IllegalArgumentException(
"Max value must be greater than or equal to the min value");
}
int value = _random.nextInt();
int range = max + 1 - min;
if (range == 0) {
return value;
}
return (value % range) + min;
}
private BigDecimal _randomQuantity(
BigDecimal min, BigDecimal max,
CPInstanceUnitOfMeasure cpInstanceUnitOfMeasure) {
if (BigDecimalUtil.lt(max, min)) {
throw new IllegalArgumentException(
"Max value must be greater than or equal to the min value");
}
int randomInt = _random.nextInt();
if (cpInstanceUnitOfMeasure == null) {
int range = max.intValue() + 1 - min.intValue();
return BigDecimal.valueOf(
Math.floorMod(randomInt, range) + min.intValue());
}
BigDecimal incrementalOrderQuantity =
cpInstanceUnitOfMeasure.getIncrementalOrderQuantity();
return max.min(
incrementalOrderQuantity.multiply(BigDecimal.valueOf(randomInt)));
}
private void _setPermissionChecker(long groupId) throws Exception {
Group group = _groupLocalService.getGroup(groupId);
Company company = _companyLocalService.getCompanyById(
group.getCompanyId());
Role role = _roleLocalService.fetchRole(
company.getCompanyId(), RoleConstants.ADMINISTRATOR);
List roleUsers = _userLocalService.getRoleUsers(role.getRoleId());
User user = roleUsers.get(0);
PermissionChecker permissionChecker = _permissionCheckerFactory.create(
user);
PrincipalThreadLocal.setName(user.getUserId());
PermissionThreadLocal.setPermissionChecker(permissionChecker);
}
private static final Log _log = LogFactoryUtil.getLog(
CommerceShipmentGenerator.class);
private static final TransactionConfig _transactionConfig =
TransactionConfig.Factory.create(
Propagation.REQUIRED, new Class[] {Exception.class});
@Reference
private CommerceChannelLocalService _commerceChannelLocalService;
@Reference
private CommerceInventoryWarehouseLocalService
_commerceInventoryWarehouseLocalService;
@Reference
private CommerceOrderItemService _commerceOrderItemService;
@Reference
private CommerceOrderService _commerceOrderService;
@Reference
private CommerceShipmentItemLocalService _commerceShipmentItemLocalService;
@Reference
private CommerceShipmentLocalService _commerceShipmentLocalService;
@Reference
private CompanyLocalService _companyLocalService;
@Reference
private CPInstanceUnitOfMeasureLocalService
_cpInstanceUnitOfMeasureLocalService;
@Reference
private GroupLocalService _groupLocalService;
@Reference
private PermissionCheckerFactory _permissionCheckerFactory;
private final Random _random = new Random();
@Reference
private RoleLocalService _roleLocalService;
@Reference
private UserLocalService _userLocalService;
private class GenerateShipmentsCallable implements Callable {
@Override
public Object call() throws Exception {
_generateCommerceShipments(_groupId, _shipmentsCount);
return null;
}
private GenerateShipmentsCallable(long groupId, int shipmentsCount) {
_groupId = groupId;
_shipmentsCount = shipmentsCount;
}
private final long _groupId;
private final int _shipmentsCount;
}
}
