/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License") you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
*/
package org.apache.ofbiz.product.shipment

import java.math.RoundingMode
import java.sql.Timestamp

import org.apache.ofbiz.base.util.UtilDateTime
import org.apache.ofbiz.base.util.UtilProperties
import org.apache.ofbiz.entity.GenericValue
import org.apache.ofbiz.entity.condition.EntityCondition

/**
 * Create a ShipmentReceipt
 */
Map createShipmentReceipt() {
    Map result = success()
    GenericValue newEntity = makeValue('ShipmentReceipt')
    newEntity.setNonPKFields(parameters)

    String receiptId = delegator.getNextSeqId('ShipmentReceipt')
    newEntity.receiptId = receiptId
    result.receiptId = receiptId

    newEntity.datetimeReceived = newEntity.datetimeReceived ?: UtilDateTime.nowTimestamp()
    newEntity.receivedByUserLoginId = userLogin.userLoginId
    newEntity.create()

    if (parameters.inventoryItemDetailSeqId) {
        GenericValue invDet = from('InventoryItemDetail')
                .where(inventoryItemDetailSeqId: parameters.inventoryItemDetailSeqId, inventoryItemId: parameters.inventoryItemId)
                .queryOne()
        invDet.receiptId = receiptId
        invDet.store()
    }
    Boolean affectAccounting = true

    GenericValue product = from('Product').where(parameters).queryOne()
    if (product.productTypeId == 'SERVICE_PRODUCT'
            || product.productTypeId == 'ASSET_USAGE_OUT_IN'
            || product.productTypeId == 'AGGREGATEDSERV_CONF') {
        affectAccounting = false
    }
    result.affectAccounting = affectAccounting
    return result
}

/**
 * Receive Inventory in new Inventory Item(s)
 * @return success, inventoryItemId, successMessageList
 */
Map receiveInventoryProduct () {
    /*
     * NOTES
     *
     * - for serialized items with a serial number passed in: the quantityAccepted _should_ always be 1
     * - if the type is SERIALIZED_INV_ITEM but there is not serial number (which is weird...) we'll create a bunch of individual InventoryItems
     * - DEJ20070822: something to consider for the future:
     *  maybe instead of this funny looping maybe for serialized items we should only allow a quantity of 1, ie return an error if it is not 1
     */
    Map result = success()
    List successMessageList = []
    String currentInventoryItemId
    BigDecimal loops = 1.0
    if (parameters.inventoryItemTypeId == 'SERIALIZED_INV_ITEM') {
        // if we are serialized and either a serialNumber or inventoyItemId is passed in and the quantityAccepted is greater than 1 then complain
        if ((parameters.serialNumber || parameters.currentInventoryItemId) && (parameters.quantityAccepted > (BigDecimal.ONE))) {
            Map errorLog = [parameters: parameters]
            return error(UtilProperties.getMessage('ProductUiLabels', 'FacilityReceiveInventoryProduct', errorLog,  parameters.locale))
            // before getting going, see if there are any validation issues so far
        }
        loops = parameters.quantityAccepted
        parameters.quantityAccepted = BigDecimal.ONE
    }
    parameters.quantityOnHandDiff = parameters.quantityAccepted
    parameters.availableToPromiseDiff = parameters.quantityAccepted

    //Status for Non serialized and Serialized inventory are different, lets make sure correct status is stored in database
    if (parameters.inventoryItemTypeId == 'NON_SERIAL_INV_ITEM') {
        switch (parameters.statusId) {
            case 'INV_DEFECTIVE':
                // This status may come from the Receive Return Screen
                parameters.statusId = 'INV_NS_DEFECTIVE'
                break
            case 'INV_ON_HOLD':
                parameters.statusId = 'INV_NS_ON_HOLD'
                break
            case 'INV_RETURNED':
                parameters.statusId = 'INV_NS_RETURNED'
                break
            default:
                // Any other status should be just set to null, if it is not a valid status for Non Serialized inventory
                parameters.statusId = null
                break
        }
    }

    for (BigDecimal currentLoop = 0; currentLoop < loops; currentLoop++) {
        logInfo("receiveInventoryProduct Looping and creating inventory info - ${currentLoop}")

        // if there is an inventoryItemId, update it (this will happen when receiving serialized inventory already in the system, like for returns);
        // if not create one
        Map serviceInMap = [:]
        currentInventoryItemId = null

        // Set supplier partyId, if inventory received by purchase order
        if (parameters.orderId) {
            GenericValue orderRole = from('OrderRole')
                    .where(orderId: parameters.orderId, roleTypeId: 'SUPPLIER_AGENT')
                    .queryFirst()
            if (orderRole) {
                parameters.partyId = orderRole.partyId
            }
        }
        if (parameters.currentInventoryItemId) {
            if (parameters.currentInventoryItemId) {
                parameters.inventoryItemId = parameters.currentInventoryItemId
            }
            run service: 'updateInventoryItem', with: parameters
            currentInventoryItemId = parameters.currentInventoryItemId
        } else {
            Map serviceResult = run service: 'createInventoryItem', with: parameters
            currentInventoryItemId = serviceResult.inventoryItemId
        }

        // do this only for non-serialized inventory
        if (parameters.inventoryItemTypeId != 'SERIALIZED_INV_ITEM') {
            serviceInMap = [:]
            serviceInMap = parameters
            serviceInMap.inventoryItemId = currentInventoryItemId
            Map serviceCIID = run service: 'createInventoryItemDetail', with: serviceInMap
            parameters.inventoryItemDetailSeqId = serviceCIID.inventoryItemDetailSeqId
        }
        serviceInMap = [:]
        serviceInMap = parameters
        serviceInMap.inventoryItemId = currentInventoryItemId
        run service: 'createShipmentReceipt', with: serviceInMap

        //update serialized items to AVAILABLE (only if this is not a return), which then triggers other SECA chains
        if (parameters.inventoryItemTypeId == 'SERIALIZED_INV_ITEM' && !parameters.returnId) {
            // Retrieve the new inventoryItem
            GenericValue inventoryItem = from('InventoryItem').where(inventoryItemId: currentInventoryItemId).queryOne()

            // Don't reset the status if it's already set to INV_PROMISED or INV_ON_HOLD
            if (inventoryItem.statusId != 'INV_PROMISED' && inventoryItem.statusId != 'INV_ON_HOLD') {
                serviceInMap = [:]
                serviceInMap.inventoryItemId = currentInventoryItemId
                serviceInMap.statusId = 'INV_AVAILABLE' // XXX set to returned instead
                run service: 'updateInventoryItem', with: serviceInMap
            }
        }
        serviceInMap = [:]
        serviceInMap = parameters
        serviceInMap.inventoryItemId = currentInventoryItemId
        run service: 'balanceInventoryItems', with: serviceInMap

        successMessageList << "Received ${parameters.quantityAccepted} of ${parameters.productId}"
                .concat(" in inventory item ${currentInventoryItemId}.") as String
    }
    // return the last inventory item received
    result.inventoryItemId = currentInventoryItemId
    result.successMessageList = successMessageList

    return result
}

/**
 * Quick Receive Entire Return
 */
Map quickReceiveReturn() {
    Map result = success()
    GenericValue returnHeader = from('ReturnHeader').where(returnId: parameters.returnId).queryOne()
    if (returnHeader.needsInventoryReceive == 'Y') {
        // before receiving inventory, check to see if there is inventory information in this database
        Long iiCount = from('InventoryItem').where(facilityId: returnHeader.destinationFacilityId).queryCount()

        if (iiCount > (Integer) 0) {
            // create a return shipment for this return
            Map shipmentCtx = [returnId: parameters.returnId]
            Map serviceCSFR = run service: 'createShipmentForReturn', with: shipmentCtx
            String shipmentId = serviceCSFR.shipmentId
            logInfo("Created new shipment ${shipmentId}")

            List returnItems = from('ReturnItem').where(returnId: returnHeader.returnId).queryList()

            // if no inventory item type specified, get default from facility
            if (!parameters.inventoryItemTypeId) {
                GenericValue facility = delegator.getRelatedOne('Facility', returnHeader, false)
                parameters.inventoryItemTypeId = facility.defaultInventoryItemTypeId ?: 'NON_SERIAL_INV_ITEM'
            }
            Timestamp nowTimestamp = UtilDateTime.nowTimestamp()

            Long nonProductItems =  (Long) 0

            for (GenericValue returnItem : returnItems) {
                // record this return item on the return shipment as well.  not sure if this is actually necessary...
                Map shipItemCtx = [shipmentId: shipmentId, productId: returnItem.productId, quantity: returnItem.returnQuantity]
                logInfo("calling create shipment item with ${shipItemCtx}")
                run service: 'createShipmentItem', with: shipItemCtx
            }
            for (GenericValue returnItem : returnItems) {
                Map receiveCtx = [:]
                returnItem.expectedItemStatus = returnItem.expectedItemStatus ?: 'INV_RETURNED'
                GenericValue orderItem = delegator.getRelatedOne('OrderItem', returnItem, false)
                if (orderItem?.productId) {
                    Map costCtx = [returnItemSeqId: returnItem.returnItemSeqId, returnId: returnItem.returnId]
                    Map serviceGRIIC = run service: 'getReturnItemInitialCost', with: costCtx
                    receiveCtx.unitCost = serviceGRIIC.initialItemCost

                    // check if the items already have SERIALIZED inventory. If so, it still puts them back as SERIALIZED with status "Accepted."
                    Long serializedItemCount = from('InventoryItem')
                            .where(productId: returnItem.productId, facilityId: returnHeader.destinationFacilityId,
                                    inventoryItemTypeId: 'SERIALIZED_INV_ITEM')
                            .queryCount()
                    Boolean setNonSerial = false
                    if (parameters.inventoryItemTypeId == 'NON_SERIAL_INV_ITEM') {
                        if (serializedItemCount == 0) {
                            parameters.inventoryItemTypeId = 'NON_SERIAL_INV_ITEM'
                            setNonSerial = true
                        }
                    }
                    if (!setNonSerial) {
                        parameters.inventoryItemTypeId = 'SERIALIZED_INV_ITEM'
                        returnItem.returnQuantity = BigDecimal.ONE
                    }
                    receiveCtx = [inventoryItemTypeId: parameters.inventoryItemTypeId,
                                  statusId: returnItem.expectedItemStatus,
                                  productId: returnItem.productId,
                                  returnItemSeqId: returnItem.returnItemSeqId,
                                  returnId: returnItem.returnId,
                                  quantityAccepted: returnItem.returnQuantity,
                                  facilityId: returnHeader.destinationFacilityId,
                                  shipmentId: shipmentId, // important: associate ShipmentReceipt with return shipment created
                                  comments: "Returned Item RA# ${returnItem.returnId}",
                                  datetimeReceived: nowTimestamp,
                                  quantityRejected: BigDecimal.ZERO
                    ]
                    Map serviceResult = run service: 'receiveInventoryProduct', with: receiveCtx
                    result.successMessageList = serviceResult.successMessageList
                } else {
                    nonProductItems += (Long) 1
                }
            }
            // now that the receive is done; set the need flag to N
            returnHeader.refresh()
            returnHeader.needsInventoryReceive = 'N'
            returnHeader.store()

            // always check/update the ReturnHeader status, even though it might have been from the receiving above, just make sure
            if (returnHeader.statusId != 'RETURN_RECEIVED') {
                Map retStCtx = [returnId: returnHeader.returnId, statusId: 'RETURN_RECEIVED']
                run service: 'updateReturnHeader', with: retStCtx
            }
        } else {
            logInfo("Not receiving inventory for returnId ${returnHeader.returnId}, no inventory information available.")
        }
    }
    return result
}

/**
 * Issues order item quantity specified to the shipment, then receives inventory for that item and quantity
 */
Map issueOrderItemToShipmentAndReceiveAgainstPO() {
    Map result = success()
    String shipmentItemSeqId
    GenericValue shipmentItem
    // get orderItem
    GenericValue orderItem = from('OrderItem').where(parameters).queryOne()
    // get orderItemShipGroupAssoc
    GenericValue orderItemShipGroupAssoc = from('OrderItemShipGroupAssoc').where(parameters).queryOne()
    // get shipment
    GenericValue shipment = from('Shipment').where(parameters).queryOne()

    // try to find an existing shipmentItem and attach to it, if none found create a new shipmentItem
    // if there is NO productId on the orderItem, ALWAYS create a new shipmentItem
    if (orderItem?.productId) {
        EntityCondition condition = EntityCondition.makeCondition([
            EntityCondition.makeCondition(productId: orderItem.productId),
            EntityCondition.makeCondition(shipmentId: shipment.shipmentId)
        ])
        if (parameters.shipmentItemSeqId) {
            condition = EntityCondition.makeCondition([
                EntityCondition.makeCondition(shipmentItemSeqId: parameters.shipmentItemSeqId),
                condition
            ])
        }
        shipmentItem = from('ShipmentItem')
                .where(condition)
                .orderBy('shipmentItemSeqId')
                .queryFirst()
    }
    if (shipmentItem) {
        Map inputMap = parameters
        inputMap.orderItem = orderItem
        Map serviceResult = run service: 'getTotalIssuedQuantityForOrderItem', with: inputMap
        BigDecimal totalIssuedQuantity = serviceResult.totalIssuedQuantity
        BigDecimal receivedQuantity = getReceivedQuantityForOrderItem(orderItem)
        receivedQuantity += parameters.quantity
        GenericValue orderShipment = from('OrderShipment')
                .where(orderId: orderItem.orderId,
                        orderItemSeqId: orderItem.orderItemSeqId,
                        shipmentId: shipmentItem.shipmentId,
                        shipmentItemSeqId: shipmentItem.shipmentItemSeqId,
                        shipGroupSeqId: orderItemShipGroupAssoc.shipGroupSeqId)
                .queryFirst()
        if (totalIssuedQuantity < receivedQuantity) {
            BigDecimal quantityToAdd = receivedQuantity - totalIssuedQuantity
            shipmentItem.quantity += quantityToAdd
            shipmentItem.store()
            shipmentItemSeqId = shipmentItem.shipmentItemSeqId

            orderShipment.quantity = orderShipment.quantity + quantityToAdd
            orderShipment.store()
        }
    } else {
        Map shipmentItemCreate = [productId: orderItem.productId, shipmentId: parameters.shipmentId, quantity: parameters.quantity]
        Map serviceResult = run service: 'createShipmentItem', with: shipmentItemCreate
        Map shipmentItemLookupPk = [shipmentItemSeqId: serviceResult.shipmentItemSeqId, shipmentId: parameters.shipmentId]
        shipmentItem = from('ShipmentItem').where(shipmentItemLookupPk).queryOne()

        // Create OrderShipment for this ShipmentItem
        Map orderShipmentCreate = [quantity: parameters.quantity,
                                   shipmentId: shipmentItem.shipmentId,
                                   shipmentItemSeqId: shipmentItem.shipmentItemSeqId,
                                   orderId: orderItem.orderId,
                                   orderItemSeqId: orderItem.orderItemSeqId]
        if (orderItemShipGroupAssoc) {
            // If we have a ShipGroup Assoc for this Item to focus on, set that; this is mostly the case for purchase orders and such
            orderShipmentCreate.shipGroupSeqId = orderItemShipGroupAssoc.shipGroupSeqId
        }
        run service: 'createOrderShipment', with: orderShipmentCreate
    }
    // TODO: if we want to record the role of the facility operation we have to re-implement this using ShipmentReceiptRole
    // <call-simple-method method-name="associateIssueRoles" xml-resource="component://product/minilang/shipment/issuance/IssuanceServices.xml"/>

    Map receiveInventoryProductCtx = parameters
    receiveInventoryProductCtx.shipmentItemSeqId = shipmentItemSeqId
    Map serviceResult = run service: 'receiveInventoryProduct', with: receiveInventoryProductCtx
    result.inventoryItemId = serviceResult.inventoryItemId
    result.successMessageList = serviceResult.successMessageList

    return result
}

/**
 * Computes the till now received quantity from all ShipmentReceipts
 */
BigDecimal getReceivedQuantityForOrderItem (GenericValue orderItem) {
    BigDecimal receivedQuantity = 0
    List shipmentReceipts = from('ShipmentReceipt').where(orderId: orderItem.orderId, orderItemSeqId: orderItem.orderItemSeqId).queryList()
    for (GenericValue shipmentReceipt : shipmentReceipts) {
        receivedQuantity +=  shipmentReceipt.quantityAccepted
    }
    return receivedQuantity
}

/**
 * Update issuance, shipment and order items if quantity received is higher than quantity on purchase order
 */
Map updateIssuanceShipmentAndPoOnReceiveInventory() {
    GenericValue orderItem = from('OrderItem').where(parameters).queryOne()
    if (parameters.orderCurrencyUnitPrice) {
        if (parameters.orderCurrencyUnitPrice != orderItem.unitPrice) {
            orderItem.unitPrice = new BigDecimal (parameters.orderCurrencyUnitPrice)
            orderItem.store()
        }
    } else {
        if (parameters.unitCost != orderItem.unitPrice) {
            orderItem.unitPrice = parameters.unitCost
            orderItem.store()
        }
    }
    BigDecimal receivedQuantity = getReceivedQuantityForOrderItem(orderItem)
    if (orderItem.quantity < receivedQuantity) {
        GenericValue orderItemShipGroupAssoc = from('OrderItemShipGroupAssoc')
                .where(orderId: orderItem.orderId, orderItemSeqId: orderItem.orderItemSeqId)
                .queryFirst()
        BigDecimal quantityVariance = (receivedQuantity - orderItem.quantity).setScale(2, RoundingMode.HALF_UP)
        BigDecimal oisgaQuantity = (orderItemShipGroupAssoc.quantity + quantityVariance).setScale(2, RoundingMode.HALF_UP)
        orderItemShipGroupAssoc.quantity = oisgaQuantity
        orderItem.quantity = receivedQuantity
        orderItemShipGroupAssoc.store()
        orderItem.store()
    }
    if (parameters.shipmentId) {
        if (orderItem.productId) {
            Map inputMap = parameters
            inputMap.orderItem = orderItem
            Map serviceResult = run service: 'getTotalIssuedQuantityForOrderItem', with: inputMap
            BigDecimal totalIssuedQuantity = serviceResult.totalIssuedQuantity
            if (totalIssuedQuantity < receivedQuantity) {
                BigDecimal quantityToAdd = receivedQuantity - totalIssuedQuantity
                EntityCondition condition = EntityCondition.makeCondition([
                    EntityCondition.makeCondition(productId: orderItem.productId),
                    EntityCondition.makeCondition(shipmentId: parameters.shipmentId)
                ])
                if (parameters.shipmentItemSeqId) {
                    condition = EntityCondition.makeCondition([
                        EntityCondition.makeCondition(shipmentItemSeqId: parameters.shipmentItemSeqId),
                        condition
                    ])
                }
                GenericValue shipmentItem = from('ShipmentItem').where(condition).orderBy('shipmentItemSeqId').queryFirst()
                if (shipmentItem) {
                    shipmentItem.quantity += quantityToAdd
                    shipmentItem.store()
                    GenericValue orderShipment = from('OrderShipment')
                            .where(orderId: parameters.orderId, orderItemSeqId: parameters.orderItemSeqId,
                                shipmentId: parameters.shipmentId, shipmentItemSeqId: shipmentItem.shipmentItemSeqId)
                            .queryFirst()
                    if (orderShipment) {
                        orderShipment.quantity += quantityToAdd
                        orderShipment.store()
                    }
                }

                // TODO: if we want to record the role of the facility operation we have to re-implement this using ShipmentReceiptRole
                // <set field="itemIssuanceId" from-field="itemIssuance.itemIssuanceId"/>
                // <call-simple-method method-name="associateIssueRoles"
                // xml-resource="component://product/minilang/shipment/issuance/IssuanceServices.xml"/>
            }
        }
    }
    return success()
}

/**
 * Cancel Received Items against a purchase order if received something incorrectly
 */
Map cancelReceivedItems() {
    // TODO: When items are received against a Purchase Order, service listed below changes certain things in the system. Changes done by these
    // services also need to be reverted and missing logic can be added later.
    // 1. addProductsBackToCategory
    // 2. setUnitPriceAsLastPrice
    // 3. createAcctgTransForShipmentReceipt
    // 4. updateProductIfAvailableFromShipment

    // update the accepted and received quantity to zero in ShipmentReceipt entity
    GenericValue shipmentReceipt = from('ShipmentReceipt').where(parameters).queryOne()
    shipmentReceipt.quantityAccepted = 0.0
    shipmentReceipt.quantityRejected = 0.0
    shipmentReceipt.store()

    // create record for InventoryItemDetail entity
    GenericValue inventoryItem = delegator.getRelatedOne('InventoryItem', shipmentReceipt, false)
    Map inventoryItemDetailMap = [inventoryItemId: inventoryItem.inventoryItemId]
    inventoryItemDetailMap.quantityOnHandDiff = inventoryItem.quantityOnHandTotal * (-1)
    inventoryItemDetailMap.availableToPromiseDiff = inventoryItem.availableToPromiseTotal * (-1)
    run service: 'createInventoryItemDetail', with: inventoryItemDetailMap

    // Balance the inventory item
    Map balanceInventoryItemMap = [inventoryItemId: inventoryItem.inventoryItemId,
                                   priorityOrderId: shipmentReceipt.orderId, priorityOrderItemSeqId: shipmentReceipt.orderItemSeqId]
    run service: 'balanceInventoryItems', with: balanceInventoryItemMap

    // update the shipment status, if shipment was received
    GenericValue shipment = delegator.getRelatedOne('Shipment', shipmentReceipt, false)
    if (shipment?.statusId == 'PURCH_SHIP_RECEIVED') {
        Map shipmentStatusMap = [shipmentId: shipment.shipmentId, statusId: 'PURCH_SHIP_SHIPPED']
        run service: 'updateShipment', with: shipmentStatusMap
    }
    // change order item and order status
    GenericValue orderItem = delegator.getRelatedOne('OrderItem', shipmentReceipt, false)
    if (orderItem?.statusId == 'ITEM_COMPLETED') {
        // update the order item status
        orderItem.statusId = 'ITEM_APPROVED'
        Map orderItemCtx = [:]
        orderItemCtx << orderItem
        orderItemCtx.fromStatusId = 'ITEM_COMPLETED'
        run service: 'changeOrderItemStatus', with: orderItemCtx
        delegator.getRelatedOne('OrderHeader', orderItem, false)
        // cancel the invoice
        GenericValue orderItemBilling = from('OrderItemBilling').where(orderId: orderItem.orderId).queryFirst()
        if (orderItemBilling) {
            Map invoiceStatusMap = [invoiceId: orderItemBilling.invoiceId, statusId: 'INVOICE_CANCELLED']
            run service: 'setInvoiceStatus', with: invoiceStatusMap
        }
    }
    return success()
}
