Subversion Repositories SmartDukaan

'''

Created on 23-Mar-2010

@author: ashish

'''

from elixir import *

from pydoc import Helper

from shop2020.clients.HelperClient import HelperClient

from shop2020.clients.TransactionClient import TransactionClient

from shop2020.config.client.ConfigClient import ConfigClient

from shop2020.model.v1.catalog.impl import DataService

from shop2020.model.v1.catalog.impl.CategoryManager import CategoryManager

from shop2020.model.v1.catalog.impl.Convertors import to_t_item, \

    to_t_vendor_item_pricing, to_t_source

from shop2020.model.v1.catalog.impl.DataService import Item, Warehouse, \

    ItemInventoryHistory, CurrentInventorySnapshot, ItemInfo, ItemChangeLog, \

    Category, EntityIDGenerator, VendorItemPricing, VendorItemMapping, Vendor, \

    SimilarItems, ProductNotification, Source, SourceItemPricing, AuthorizationLog, \

    MissingItemKey

from shop2020.thriftpy.model.v1.catalog.ttypes import InventoryServiceException, \

    status, ItemShippingInfo

from shop2020.thriftpy.model.v1.order.ttypes import AlertType

from shop2020.utils.EmailAttachmentSender import mail

from shop2020.utils.Utils import log_entry, to_py_date, log_risky_flag

from sqlalchemy import desc, asc

from sqlalchemy.orm.exc import MultipleResultsFound, NoResultFound

from sqlalchemy.sql.expression import and_, or_, distinct, func

from string import Template

from urllib2 import HTTPBasicAuthHandler

import datetime

import sys

import urllib2

from shop2020.utils import EmailAttachmentSender

def initialize():

    DataService.initialize()

def get_all_items_by_status(status, offset=0, limit=None):

    query = Item.query

    if status is not None:

        query = query.filter_by(status=status)

    query = query.order_by(Item.product_group, Item.brand, Item.model_number, Item.model_name).offset(offset)

    if limit:

        query = query.limit(limit)

    items = query.all()

    return items

def get_all_items(is_active, offset=0, limit=None):

    if is_active:

        items = get_all_items_by_status(status.ACTIVE, offset, limit)

    else:

        items = get_all_items_by_status(None, offset, limit)

    return items

def get_item_count_by_status(use_status, status):

    if use_status:

        return Item.query.filter_by(status=status).count()

    else:

        return Item.query.count()

def get_item(item_id):

    item = Item.get_by(id=item_id)

    return item

def get_items_by_catalog_id(catalog_id):

    query = Item.query.filter_by(catalog_item_id=catalog_id)

    try:

        items = query.all()

        return get_thrift_item_list(items)

    except Exception as ex:

        print ex

        raise InventoryServiceException(109, "Item not found")

def is_active(item_id):

    t_item_shipping_info = ItemShippingInfo()

    try:

        item = get_item(item_id)

        t_item_shipping_info.isRisky = item.risky

        warehouse_ids = None

        if item.isWarehousePreferenceSticky :

            warehouse_ids = [item.preferredWarehouse]

        availability = __get_item_availability(item, warehouse_ids)

        if item.risky and availability <= 0 and item.status == status.ACTIVE:

            add_status_change_log(item, status.PAUSED_BY_RISK)

            item.status = status.PAUSED_BY_RISK

            item.status_description = "This item is currently out of stock"

            session.commit()

            __send_mail_for_oos_item(item)

            #This will clear cache from tomcat

            __clear_homepage_cache()

        t_item_shipping_info.isActive = (item.status == status.ACTIVE)

        t_item_shipping_info.quantity = availability

    except InventoryServiceException:

        print "[ERROR] Unexpected error:", sys.exc_info()[0]

    return t_item_shipping_info

def get_item_status_description(itemId):

    item = get_item(itemId)

    return item.status_description

def get_Warehouse(warehouse_id):

    return Warehouse.get_by(id=warehouse_id)

def get_Vendor(vendorId):

    return Vendor.get_by(id=vendorId)

def get_all_warehouses_by_status(status):

    if not status:

        warehouses = Warehouse.query.all()

    else:

        warehouses = Warehouse.query.filter_by(status=status).all()

    return warehouses

def get_all_warehouses_for_item(item_id):

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "Some unforeseen error while obtaining item")

    return item.get_all_warehouses

def get_all_items_for_warehouse(warehouse_id):

    warehouse = get_Warehouse(warehouse_id)

    if not warehouse:

        raise InventoryServiceException(108, "bad warehouse")

    return warehouse.all_items

def add_warehouse(warehouse):

    if not warehouse:

        raise InventoryServiceException(108, "Bad warehouse")

    if get_Warehouse(warehouse.id):

        #warehouse is already present.

        raise InventoryServiceException(101, "Warehouse already present")

    ds_warehouse = Warehouse()

    ds_warehouse.id = warehouse.id

    ds_warehouse.location = warehouse.location

    ds_warehouse.status = status.ACTIVE

    ds_warehouse.addedOn = datetime.datetime.now()

    ds_warehouse.lastCheckedOn = datetime.datetime.now()

    ds_warehouse.tinNumber = warehouse.tinNumber

    ds_warehouse.pincode = warehouse.pincode

    if warehouse.vendorString:

        ds_warehouse.vendorString = warehouse.vendorString

    session.commit()

    return ds_warehouse.id

def update_item(item):

    if not item:

        raise InventoryServiceException(108, "Bad item in request")

    if not item.id:

        raise InventoryServiceException(101, "Missing id for update")

    validate_item_prices(item)

    ds_item = get_item(item.id)

    if not ds_item:

        raise InventoryServiceException(101, "Item missing in our database")

    if item.productGroup:

        ds_item.product_group = item.productGroup 

    if item.brand:

        ds_item.brand = item.brand

    if item.modelNumber:

        ds_item.model_number = item.modelNumber

    ds_item.color = item.color

    ds_item.model_name = item.modelName

    ds_item.category = item.category

    ds_item.comments = item.comments

    ds_item.catalog_item_id = item.catalogItemId

    ds_item.mrp = item.mrp

    ds_item.sellingPrice = item.sellingPrice

    ds_item.weight = item.weight

    if ds_item.status != item.itemStatus:

        add_status_change_log(ds_item, item.itemStatus)

        ds_item.status = item.itemStatus

    if item.status_description:

        ds_item.status_description = item.status_description

    if item.startDate:

        ds_item.startDate = to_py_date(item.startDate)

    else:

        ds_item.startDate = None

    if item.retireDate:

        ds_item.retireDate = to_py_date(item.retireDate)

    else:

        ds_item.retireDate = None

    ds_item.feature_id = item.featureId

    ds_item.feature_description = item.featureDescription

    ds_item.bestDealText = item.bestDealText

    ds_item.bestDealValue = item.bestDealValue

    ds_item.bestSellingRank = item.bestSellingRank

    ds_item.defaultForEntity = item.defaultForEntity

    ds_item.risky = item.risky

    if item.expectedDelay is not None:

        ds_item.expectedDelay = item.expectedDelay

    if item.preferredWarehouse:

        ds_item.preferredWarehouse = item.preferredWarehouse

    if item.defaultWarehouse:

        ds_item.defaultWarehouse = item.defaultWarehouse

    if item.preferredVendor:

        ds_item.preferredVendor = item.preferredVendor

    ds_item.isWarehousePreferenceSticky = item.isWarehousePreferenceSticky

    ds_item.updatedOn = datetime.datetime.now()

    session.commit();

    return ds_item.id

def add_item(item):

    if not item:

        raise InventoryServiceException(108, "Bad item in request")

    if get_item(item.id):

        raise InventoryServiceException(101, "Item already exists")

    validate_item_prices(item)

    ds_item = Item()

    if item.productGroup:

        ds_item.product_group = item.productGroup

    if item.brand:

        ds_item.brand = item.brand

    if item.modelName:

        ds_item.model_name = item.modelName

    if item.modelNumber:

        ds_item.model_number = item.modelNumber

    if item.color:

        ds_item.color = item.color

    if item.category:

        ds_item.category = item.category

    if item.comments:

        ds_item.comments = item.comments

    ds_item.addedOn = datetime.datetime.now()

    ds_item.updatedOn = datetime.datetime.now()

    if item.startDate:

        ds_item.startDate = to_py_date(item.startDate)

    if item.retireDate:

        ds_item.retireDate = to_py_date(item.retireDate)

    if item.mrp:

        ds_item.mrp = item.mrp

    if item.sellingPrice:

        ds_item.sellingPrice = item.sellingPrice

    if item.weight:

        ds_item.weight = item.weight

    if item.featureId:

        ds_item.feature_id = item.featureId

    if item.featureDescription:

        ds_item.feature_description = item.featureDescription

    if item.otherInfo:

        for k,v in item.otherInfo.iteritems():

            info = ItemInfo()

            info.key = k

            info.value = v

            ds_item.iteminfo.append(info)

    #check if categories present. If yes, add them to system

    if item.bestDealValue:

        ds_item.bestDealValue = item.bestDealValue

    if item.bestDealText:

        ds_item.bestDealText = item.bestDealText

    if item.bestSellingRank:

        ds_item.bestSellingRank = item.bestSellingRank

    ds_item.defaultForEntity = item.defaultForEntity

    ds_item.risky = item.risky

    if item.expectedDelay is not None:

        ds_item.expectedDelay = item.expectedDelay

    else:

        ds_item.expectedDelay = 0

    if item.preferredWarehouse:

        ds_item.preferredWarehouse = item.preferredWarehouse

    # Check if a similar item already exists in our database

    similar_item = Item.query.filter_by(brand=item.brand, model_number=item.modelNumber, model_name=item.modelName).first()

    print "[SIMILAR ITEM FOUND:] FOR {0} {1} {2}".format(item.brand, item.modelNumber, item.modelName)

    if similar_item is None or similar_item.catalog_item_id is None:

        # If there is no similar item in the database from before,

        # use the entity_id_generator

        entity_id = EntityIDGenerator.query.first()

        ds_item.catalog_item_id = entity_id.id + 1

        ds_item.status = status.IN_PROCESS

        ds_item.status_description = "This item is in process."

        entity_id.id = entity_id.id  + 1

        if similar_item is not None and similar_item.catalog_item_id is None:

            similar_item.catalog_item_id = entity_id.id

    else:

        #If a similar item already exists for a product group, brand and model_number, set it as same.

        ds_item.catalog_item_id = similar_item.catalog_item_id

        ds_item.category = similar_item.category

        ds_item.product_group = similar_item.product_group

        ds_item.status = similar_item.status

        ds_item.status_description = similar_item.status_description

    session.commit();

    return ds_item.id

def update_inventory_history(warehouse_id, timestamp, availability):

    warehouse = get_Warehouse(warehouse_id)

    if not warehouse:

        raise InventoryServiceException(107, "Warehouse? Where?")

    vendors = get_vendors_for_warehouse(warehouse_id)

    if len(vendors) > 1:

        raise InventoryServiceException(110, "Multiple vendors found for warehouse !")

    vendor = vendors[0]

    time = datetime.datetime.now()

    for item_key, quantity in availability.iteritems():

        try:

            vendor_item_mapping = VendorItemMapping.query.filter_by(vendor=vendor, item_key=item_key).one();

            item = vendor_item_mapping.item

        except:

            continue  

        try:

            item_inventory_history = ItemInventoryHistory()

            item_inventory_history.warehouse = warehouse

            item_inventory_history.item = item

            item_inventory_history.timestamp = time

            item_inventory_history.availibility = quantity

        except:

            raise InventoryServiceException(108, "Some unforeseen error while updating inventory")

    session.commit()

def update_inventory(warehouse_id, timestamp, availability):

    warehouse = get_Warehouse(warehouse_id)

    if not warehouse:

        raise InventoryServiceException(107, "Warehouse? Where?")

    time = datetime.datetime.now()

    warehouse.lastCheckedOn = time

    warehouse.vendorString = timestamp

    vendors = get_vendors_for_warehouse(warehouse_id)

    if len(vendors) > 1:

        raise InventoryServiceException(110, "Multiple vendors found for warehouse !")

    vendor = vendors[0]

    session.commit()

    for item_key, quantity in availability.iteritems():

        try:

            vendor_item_mapping = VendorItemMapping.query.filter_by(vendor=vendor, item_key=item_key).one();

            item = vendor_item_mapping.item

        except:

            print 'Could not find item with key: ' + item_key

            __send_mail_for_missing_key(item_key, warehouse_id)

            continue

        try:

            current_inventory_snapshot = CurrentInventorySnapshot.get_by(item=item, warehouse=warehouse)

            if not current_inventory_snapshot:

                current_inventory_snapshot = CurrentInventorySnapshot()

                current_inventory_snapshot.item = item

                current_inventory_snapshot.warehouse = warehouse

                current_inventory_snapshot.availibility = 0

                current_inventory_snapshot.reserved = 0

            # added the difference in the current inventory    

            current_inventory_snapshot.availibility = current_inventory_snapshot.availibility + quantity

            try:

                if quantity > 0 and __get_item_reserved(item) > 0:

                    cl = TransactionClient().get_client()

                    #FIXME hardcoding for warehouse id 

                    cl.addAlert(AlertType.NEW_INVENTORY_ALERT, 5, "Inventory received for item " + item.brand + " " + item.model_name + " " + item.model_number + " " +  item.color)

            except:

                print "Not able to raise alert for incoming inventory" 

            if current_inventory_snapshot.availibility < 0:

                __send_alert_for_negative_availability(item, current_inventory_snapshot.availibility, warehouse)

        except:

            raise InventoryServiceException(108, "Some unforeseen error while updating inventory")

        session.commit() 

        check_risky_item(item)

def __send_alert_for_negative_reserved(item, reserved, warehouse):

    itemName = " ".join([str(item.brand), str(item.model_name), str(item.model_number), str(item.color)])

    EmailAttachmentSender.mail('cnc.center@shop2020.in', '5h0p2o2o', 'mandeep.dhir@shop2020.in', 'Negative Reserved count for ' + itemName + ' warehouse id: ' + str(warehouse.id), None)

def __send_alert_for_negative_availability(item, availability, warehouse):

    itemName = " ".join([str(item.brand), str(item.model_name), str(item.model_number), str(item.color)])

    EmailAttachmentSender.mail('cnc.center@shop2020.in', '5h0p2o2o', 'mandeep.dhir@shop2020.in', 'Negative Availability count for ' + itemName + ' warehouse id: ' + str(warehouse.id), None)

def __send_mail_for_missing_key(item_key, warehouse_id):

    if not MissingItemKey.get_by(itemKey = item_key):

        missingItemKey = MissingItemKey()

        missingItemKey.itemKey = item_key

        missingItemKey.warehouseId = warehouse_id

        EmailAttachmentSender.mail('cnc.center@shop2020.in', '5h0p2o2o', 'mandeep.dhir@shop2020.in', 'Item-key not found while inventory sync', item_key + ' warehouse id: ' + str(warehouse_id))

        session.commit()

def add_inventory(itemId, warehouseId, quantity):

    current_inventory_snapshot = CurrentInventorySnapshot.get_by(item_id=itemId, warehouse_id=warehouseId)

    if not current_inventory_snapshot:

        current_inventory_snapshot = CurrentInventorySnapshot()

        current_inventory_snapshot.item_id = itemId

        current_inventory_snapshot.warehouse_id = warehouseId

        current_inventory_snapshot.availibility = 0

        current_inventory_snapshot.reserved = 0

    # added the difference in the current inventory    

    current_inventory_snapshot.availibility = current_inventory_snapshot.availibility + quantity

    session.commit()

    if current_inventory_snapshot.availibility < 0:

        __send_alert_for_negative_availability(get_item(itemId), current_inventory_snapshot.availibility, get_Warehouse(warehouseId))

    check_risky_item(get_item(itemId)) 

'''

def get_item_inventoy(item_id):

    inventory = Item.get_by(id=item_id).currentInventory

    if not inventory:

        raise InventoryServiceException(108, "Some unforeseen error while updating inventory")

    return inventory

'''

def get_item_inventory_by_item_id(item_id):

    inventory = Item.get_by(id=item_id).currentInventory

    if not inventory:

        raise InventoryServiceException(108, "Some unforeseen error while updating inventory")

    return inventory

def retire_warehouse(warehouse_id):

    if not warehouse_id:

        raise InventoryServiceException(101, "Bad warehouse id")

    warehouse = get_Warehouse(warehouse_id)

    if not warehouse:

        raise InventoryServiceException(108, "warehouse id not present")

    warehouse.status = status.DELETED;

    session.commit()

def retire_item(item_id):

    if not item_id:

        raise InventoryServiceException(101, "bad item id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "item id not present")

    item.status = status.PHASED_OUT

    item.retireDate = datetime.datetime.now()

    session.commit()

#need to implement threads based solution here

def start_item_on(item_id, timestamp):

    if not item_id:

        raise InventoryServiceException(101, "bad item id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "item id not present")

    item.status = status.ACTIVE

    item.startDate = datetime.datetime.fromtimestamp(to_py_date(timestamp))

    add_status_change_log(item, status.ACTIVE)

    session.commit()

#need to implement threads here

def retire_item_on(item_id, timestamp):

    if not item_id:

        raise InventoryServiceException(101, "bad item id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "item id not present")

    item.status = status.PHASED_OUT

    item.retireDate = datetime.datetime.fromtimestamp(to_py_date(timestamp))

    add_status_change_log(item, status.PHASED_OUT)

    session.commit()

def add_status_change_log(item, new_status):

    item_change_log = ItemChangeLog()

    item_change_log.new_status = new_status

    item_change_log.old_status = item.status

    item_change_log.timestamp = datetime.datetime.now()

    item_change_log.item = item

    session.commit()

def change_item_status(item_id, new_status):

    if not item_id:

        raise InventoryServiceException(101, "bad item id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "item id not present")

    add_status_change_log(item, new_status)

    item.status = new_status

    if item.status == status.PHASED_OUT:

        item.status_description = "This item has been phased out"

    elif item.status == status.DELETED:

        item.status_description = "This item has been deleted"

    elif item.status == status.PAUSED:

        item.status_description = "This item is currently out of stock"      

    elif item.status == status.PAUSED_BY_RISK:

        item.status_description = "This item is currently out of stock"

        #This will clear cache from tomcat

        __clear_homepage_cache()  

    elif item.status == status.ACTIVE:

        item.status_description = "This item is active"

    elif item.status == status.IN_PROCESS:

        item.status_description = "This item is in process"

    elif item.status == status.CONTENT_COMPLETE:

        item.status_description = "This item is in process"

    session.commit()

def get_item_availability_for_warehouse(warehouse_id, item_id):

    if not warehouse_id:

        raise InventoryServiceException(101, "bad warehouse_id")

    if not item_id:

        raise InventoryServiceException(101, "bad item_id")

    warehouse = get_Warehouse(warehouse_id)

    if not warehouse:

        raise InventoryServiceException(108, "warehouse does not exist")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(108, "item does not exist")

    query = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id)

    query = query.filter_by(item_id = item.id)

    try:

        current_inventory_snapshot = query.one()

        return current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

    except:

        return 0

    """

    current_inventory_snapshot = CurrentInventorySnapshot.query.filter(CurrentInventorySnapshot.warehouse_id == warehouse_id, CurrentInventorySnapshot.item_id == item_id).one()

    if not current_inventory_snapshot:

        return 0

    else:

        return current_inventory_snapshot.availibility

    """

def check_risky_item(item):

    if not item.risky:

        return

    warehouse_ids = None

    if item.isWarehousePreferenceSticky :

        warehouse_ids = [item.preferredWarehouse]

    availability = __get_item_availability(item, warehouse_ids)

    if availability <= 0:

        if item.status == status.ACTIVE:

            change_item_status(item.id, status.PAUSED_BY_RISK)

            __send_mail_for_oos_item(item)

    else:

        if item.status == status.PAUSED_BY_RISK:

            change_item_status(item.id, status.ACTIVE)

    session.commit()

'''

This method returns quantity of a particular item across all warehouses whose ids is provided

if warehouse_ids is null it checks for inventory in all warehouses.

'''

def __get_item_availability(item, warehouse_ids):

    if warehouse_ids is None:

        all_inventory = CurrentInventorySnapshot.query.filter_by(item = item).all()

        availability = 0

        reserved = 0

        for currInv in all_inventory:

            availability = availability + currInv.availibility

            reserved = reserved + currInv.reserved

        return availability - reserved

    else:

        total_availability = 0

        for warehouse_id in warehouse_ids:

            try:

                current_inventory_snapshot = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id, item_id = item.id).one()

                availability = current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

            except Exception as e:

                print e

                availability = 0    

            total_availability = total_availability + availability

        return total_availability 

def __get_item_reserved(item):

    all_inventory = CurrentInventorySnapshot.query.filter_by(item = item).all()

    reserved = 0

    for currInv in all_inventory:

        reserved = reserved + currInv.reserved

    return reserved

def reserve_item_in_warehouse(item_id, warehouse_id, quantity):    

    if not warehouse_id:

        raise InventoryServiceException(101, "bad warehouse_id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(101, "bad item_id")

    query = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id, item_id = item_id)

    try:

        current_inventory_snapshot = query.one()

    except:

        current_inventory_snapshot = CurrentInventorySnapshot()

        current_inventory_snapshot.warehouse_id = warehouse_id

        current_inventory_snapshot.item_id = item_id

        current_inventory_snapshot.availibility = 0

        current_inventory_snapshot.reserved = 0

    current_inventory_snapshot.reserved = current_inventory_snapshot.reserved + quantity

    session.commit()

    check_risky_item(item)

    return True

def reduce_reservation_count(item_id, warehouse_id, quantity):

    if not warehouse_id:

        raise InventoryServiceException(101, "bad warehouse_id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(101, "bad item_id")

    query = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id, item_id = item_id)

    try:

        current_inventory_snapshot = query.one()

        current_inventory_snapshot.reserved = current_inventory_snapshot.reserved - quantity

        ##FIXME In case of our own warehouse reduce availability also

        if warehouse_id == 7:

            current_inventory_snapshot.availibility = current_inventory_snapshot.availibility - quantity

        session.commit()

        check_risky_item(item)

        if current_inventory_snapshot.reserved < 0:

            __send_alert_for_negative_reserved(get_item(item_id), current_inventory_snapshot.reserved, get_Warehouse(warehouse_id))

        return True

    except:

        print "Unexpected error:", sys.exc_info()[0]

        return False

def mark_item_as_content_complete(entity_id, category, brand, modelName, modelNumber):

    '''

    Get all the items for this entityID and update category, brand, modelName and modelNumber for all.

    Update Status for only IN_PROCESS items to CONTENT_COMPLETE

    '''

    content_complete_status = status.CONTENT_COMPLETE

    items = Item.query.filter_by(catalog_item_id=entity_id).all()

    current_timestamp = datetime.datetime.now()

    for item in items:

        if item.status == status.IN_PROCESS:

            item.status = content_complete_status

            item_change_log = ItemChangeLog()

            item_change_log.old_status = item.status

            item_change_log.new_status = content_complete_status

            item_change_log.timestamp = current_timestamp

            item_change_log.item = item

        category_object = get_category(category)

        if category_object is not None:

            item.category = category

            item.product_group = category_object.display_name

        item.brand = brand

        item.model_name = modelName

        item.model_number = modelNumber

        item.updatedOn = current_timestamp

    session.commit()

    return True

def get_item_availability_for_location(warehouse_loc, item_id):

    """

    Determines the warehouse that should be used to fulfil an order for the given item.

    It first checks whether the preferred warehouse for that item is set or not. If set 

    and preference is sticky then that warehouse is used for fulfilment.

    If preference is not sticky then we see if item is available in the preferred WH,

    in which case that warehouse is used otherwise we use that warehouse which has the max

    availability. And if there is no inventory for that item in any warehouses then we use

    default warehouse.

    If preference is not set in that case we just find the warehouse with max availability

    and in case of zero inventory we use default warehouse

    Returns an ordered list of size 4 with following elements in the given order:

    1. Logistics location of the warehouse which was finally picked up to ship the order.

    2. Id of the warehouse which was finally picked up.

    3. Inventory size in the selected warehouse.

    4. Expected delay added by the category manager.

    Parameters:

     - warehouse_loc

     - item_id

    """

    if warehouse_loc is None:

        raise InventoryServiceException(101, "Bad Warehouse Location")

    if not item_id:

        raise InventoryServiceException(101, "Bad Item id")

    item = Item.get_by(id=item_id)

    logisticsLocation = warehouse_loc

    warehouses = Warehouse.query.filter_by(logisticsLocation=logisticsLocation).all()

    warehouse_ids = [warehouse.id for warehouse in warehouses]

    warehouse_retid = -1

    total_availability = 0

    '''

    If warehouse preference is set and it is sticky then we should fulfil this order from this warehouse only.

    But we still need to calculate total availability across warehouses.

    '''

    if (item.isWarehousePreferenceSticky and item.preferredWarehouse is not None) :

        warehouse_retid = item.preferredWarehouse

        warehouse = Warehouse.get_by(id=warehouse_retid)

        logisticsLocation = warehouse.logisticsLocation

        total_availability = __get_item_availability(item, [warehouse_retid])

    #If preference is not sticky then this order should be fulfilled from preferred WH if inventory available

    #otherwise we should check for its availability elsewhere and fulfil this order from there, but if it is not available anywhere

    #then we should fulfil this order from its default warehouse.

    elif (not item.isWarehousePreferenceSticky and item.preferredWarehouse is not None) :

        try:

            current_inventory_snapshot = CurrentInventorySnapshot.query.filter_by(warehouse_id = item.preferredWarehouse, item_id = item_id).one()

            availability = current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

        except Exception as e:

            print e

            availability = 0    

        if availability > 0:

            warehouse_retid = item.preferredWarehouse

            total_availability = availability

        else :

            [logisticsLocation, warehouse_retid, total_availability] = \

                        __get_warehouse_with_max_availability(warehouse_loc = warehouse_loc, \

                                                            warehouse_ids = warehouse_ids, item = item)

    else :

        [logisticsLocation, warehouse_retid, total_availability] = \

                        __get_warehouse_with_max_availability(warehouse_loc = warehouse_loc, \

                                                            warehouse_ids = warehouse_ids, item = item)

    if item.expectedDelay is None:

        print 'expectedDelay field for this item was Null. Resetting it to 0'

        item.expectedDelay = 0

    ## FIXME Assign warehouse 5 (9D2) for all the hotspot products.

    #if warehouse_retid in [warehouse.id for warehouse in get_warehouses_for_vendor(1)]:

    if int(warehouse_retid) in [1,2,3,4,5]:

        warehouse_retid = 5

        warehouse = Warehouse.get_by(id=warehouse_retid)

        logisticsLocation = warehouse.logisticsLocation  

    return [logisticsLocation, int(warehouse_retid), total_availability, int(item.expectedDelay)]

def __get_warehouse_with_max_availability(warehouse_loc, warehouse_ids, item):

    warehouse_retid = -1

    max_availability = 0

    total_availability = 0

    for warehouse_id in warehouse_ids:

            try:

                current_inventory_snapshot = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id, item_id = item.id).one()

                availability = current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

            except Exception as e:

                print e

                availability = 0    

            if availability > max_availability:

                warehouse_retid = warehouse_id

                max_availability = availability

            total_availability = total_availability + availability

    #If no warehouse could be found, use the default warehouse for this item

    if warehouse_retid == -1:

        # This is the case when all warehouses have exhausted their

        # inventory of this item or no warehouse is available in this

        # location.

        warehouse_retid = int(item.defaultWarehouse)

        warehouse = Warehouse.get_by(id=warehouse_retid)

        warehouse_loc = warehouse.logisticsLocation

        try:

            current_inventory_snapshot = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_retid, item_id = item.id).one()

            max_availability = current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

        except Exception as e:

            print e

            max_availability = 0

        total_availability = max_availability

    return [warehouse_loc, warehouse_retid, total_availability]

'''    

def calculate_total_availability(warehouse_ids, item_id):

    total_availability = 0

    for warehouse_id in warehouse_ids:

            try:

                current_inventory_snapshot = CurrentInventorySnapshot.query.filter_by(warehouse_id = warehouse_id, item_id = item_id).one()

                availability = current_inventory_snapshot.availibility - current_inventory_snapshot.reserved

            except Exception as e:

                print e

                availability = 0    

            total_availability = total_availability + availability

    return total_availability

'''

def get_warehouses_for_item(item_id):

    if not item_id:

        raise InventoryServiceException(101, "bad item_id")

    item = get_item(item_id)

    if not item:

        raise InventoryServiceException(101, "bad item")

    warehouses = item.currentInventory.warehouse

    return warehouses

def get_child_categories(category):

    cm = CategoryManager()

    cat = cm.getCategory(category)

    return cat.children_category_ids if cat else None

def get_best_sellers(start_index, stop_index, category=-1):

    '''

    Returns the Best Sellers between the start and the stop index in the given category

    '''

    query = get_best_sellers_query(category, None)

    best_sellers = query.all()[start_index:stop_index]

    return get_thrift_item_list(best_sellers)

def get_best_sellers_count(category=-1):

    '''

    Returns the number of best sellers in the given category

    '''

    count = get_best_sellers_query(category, None).count()

    if count is None:

        count = 0

    return count

def get_best_sellers_catalog_ids(start_index, stop_index, brand, category=-1):

    '''

    Returns the Best sellers for the given brand and category between the start and the stop index.

    Ignores the category if it's passed as -1 and the brand if it's passed as None. 

    '''

    query = get_best_sellers_query(category, brand)

    best_sellers = query.all()[start_index:stop_index]

    return [item.catalog_item_id for item in best_sellers]

def get_best_sellers_query(category, brand):

    '''

    Returns the query to be used for getting Best Sellers.

    Ignores the category if it's passed as -1 and the brand if it's passed as None.

    '''

    query = Item.query.filter_by(status=status.ACTIVE).filter(Item.bestSellingRank != None)

    if category != -1:

        all_categories = [category]

        child_categories = get_child_categories(category)

        if child_categories is not None:

            all_categories = all_categories + child_categories 

        query = query.filter(Item.category.in_(all_categories))

    if brand is not None:

        query = query.filter_by(brand=brand)

    query = query.order_by(asc(Item.bestSellingRank))

    return query

def get_best_deals(category=-1):

    '''

    Returns the Best deals in the given category. Ignores the category if it's passed as -1.

    '''

    query = get_best_deals_query(Item, category, None)

    items = query.all()

    return get_thrift_item_list(items)

def get_best_deals_count(category=-1):

    '''

    Returns the count of best deals in the given category.

    Ignores the category if it's -1.

    '''

    count = get_best_deals_counting_query(func.count(distinct(Item.catalog_item_id)), category, None).scalar()

    if count is None:

        count = 0

    return count

def get_best_deals_catalog_ids(start_index, stop_index, brand, category=-1):

    '''

    Returns the catalog_item_ids of best deal items for the given brand and category.

    Ignores the category if it's passed as -1 and the brand if it's passed as None.

    '''

    query = get_best_deals_query(Item, category, brand)

    best_deal_items = query.all()[start_index:stop_index]

    return [item.catalog_item_id for item in best_deal_items]

def get_best_deals_counting_query(obj, category, brand):

    '''

    Returns the query to be used to select the best deals in the given brand and category.

    Ignores the category if it's passed as -1 and the brand if it's passed as None. 

    '''

    query = session.query(obj).filter_by(status=status.ACTIVE).filter(Item.bestDealValue != None)

    if category != -1:

        all_categories = [category]

        child_categories = get_child_categories(category)

        if child_categories is not None:

            all_categories = all_categories + child_categories 

        query = query.filter(Item.category.in_(all_categories))

    if brand is not None:

        query = query.filter_by(brand=brand)

    return query

def get_best_deals_query(obj, category, brand):

    '''

    Returns the query to be used to get the best deals in the given category and brand.

    Ignores the category if it's passed as -1 and the brand if it's passed as None.

    '''

    query = get_best_deals_counting_query(obj, category, brand)

    query = query.group_by(Item.catalog_item_id).order_by(desc(Item.bestDealValue))

    return query

def get_latest_arrivals(limit, category=-1):

    '''

    Returns up to limit number of Latest Arrivals in the given category.

    '''

    categories = []

    if category != -1:

        categories = [category]

    query = get_latest_arrivals_query(Item, categories, None)

    items = query.all()[0:limit]

    return get_thrift_item_list(items)

def get_latest_arrivals_count(limit, category=-1):

    '''

    Returns the number of latest arrivals which will be displayed on the website.

    To ignore the categories, pass the list as empty. To ignore brand, pass it as null.

    '''

    categories = []

    if category != -1:

        categories = [category]

    count = get_latest_arrivals_counting_query(func.count(distinct(Item.catalog_item_id)), categories, None).scalar()

    if count is None:

        count = 0

    count = min(count, limit)

    return count

def get_latest_arrivals_catalog_ids(start_index, stop_index, brand, categories=[]):

    '''

    Returns the catalog_item_ids of the latest arrivals between the start and the stop index

    To ignore the categories, pass the list as empty. To ignore brand, pass it as null.

    '''

    query = get_latest_arrivals_query(Item, categories, brand)

    latest_arrivals = query.all()[start_index:stop_index]

    return [item.catalog_item_id for item in latest_arrivals]

def get_latest_arrivals_counting_query(obj, categories, brand):

    '''

    Returns the query to be used to count Latest arrivals.

    To ignore the categories, pass the list as empty. To ignore brand, pass it as null.

    '''

    query = session.query(obj).filter_by(status=status.ACTIVE)

    all_categories = []

    for category in categories:

        all_categories.append(category)

        child_categories = get_child_categories(category)

        if child_categories:

            all_categories = all_categories + child_categories