##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program 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 2
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Globals import InitializeClass, PersistentMapping
from AccessControl import ClassSecurityInfo

from Products.ERP5.Document.Resource import Resource
from Products.ERP5.Document.Item import Item as ERP5Item
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface

from zLOG import LOG

class Item(ERP5Item):
    """
      Un item....
    """

    meta_type = 'CORAMY Item'
    portal_type = 'Item'
    add_permission = Permissions.AddPortalContent
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.View)

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.Price
                      , PropertySheet.Resource
                      , PropertySheet.Reference
                      , PropertySheet.Item
                      , PropertySheet.Amount
                      , PropertySheet.CoramyItem
                      , PropertySheet.Comment
                      )

    # Factory Type Information
    factory_type_information = \
      {    'id'             : portal_type
         , 'meta_type'      : meta_type
         , 'description'    : """\
Un item sert a assurer la tracabilite des choses dans ERP5."""
         , 'icon'           : 'item_icon.gif'
         , 'product'        : 'Coramy'
         , 'factory'        : 'addItem'
         , 'immediate_view' : 'item_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': ('Item',
                                      )
         , 'filter_content_types' : 1
         , 'global_allow'   : 1
         , 'actions'        :
        ( { 'id'            : 'view'
          , 'name'          : 'View'
          , 'category'      : 'object_view'
          , 'action'        : 'item_view'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'list'
          , 'name'          : 'Object Contents'
          , 'category'      : 'object_action'
          , 'action'        : 'folder_contents'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'print'
          , 'name'          : 'Print'
          , 'category'      : 'object_print'
          , 'action'        : 'item_print'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'metadata'
          , 'name'          : 'Metadata'
          , 'category'      : 'object_view'
          , 'action'        : 'metadata_edit'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'translate'
          , 'name'          : 'Translate'
          , 'category'      : 'object_action'
          , 'action'        : 'translation_template_view'
          , 'permissions'   : (
              Permissions.TranslateContent, )
          }
        )
      }

    def _setTitle(self, value):
      """
        Here we see that we must define an notion
        of priority in the way fields are updated
      """
      if value != self.getTitle():
        self.title = value

    security.declareProtected(Permissions.View, 'getTitle')
    def getTitle(self):
      """
        Returns the title if it exists or a combination of
        first name and last name
      """
      if self.title == '':
        return self.getId()
      else:
        return self.title
    Title = getTitle

    security.declareProtected(Permissions.ModifyPortalContent, 'setTitle')
    def setTitle(self, value):
      """
        Updates the title if necessary
      """
      self._setTitle(value)
      self.reindexObject()

    security.declareProtected(Permissions.ModifyPortalContent, 'getRemainingQuantity')
    def getRemainingQuantity(self):
      """
        Computes the quantity of an item minus quantity of all sub_items
      """
      sub_item_list = self.contentValues(filter={'portal_type':'Piece Tissu'})
      sub_quantity = 0
      for sub_item in sub_item_list :
        sub_quantity += sub_item.getQuantity()
      return self.getQuantity() - sub_quantity
      
    security.declareProtected(Permissions.ModifyPortalContent, 'getLastLocationTitle')
    def getLastLocationTitle(self):
      """
        Returns the last location of this item or empty string
      """
      related_movement_list = self.PieceTissu_zGetAggregateRelatedMovementList()
      if len(related_movement_list) > 0 :
        last_movement = related_movement_list[0]
        quantity = last_movement.quantity
        inventory = last_movement.inventory
        if inventory is not None :
          last_location_title = last_movement.destination_title
        elif quantity >= 0 :
          last_location_title = last_movement.destination_title
        else :
          last_location_title = ''
        return last_location_title
      else :
        return ''
