Container.py 7.92 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
Romain Courteaud's avatar
Romain Courteaud committed
3
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Romain Courteaud's avatar
Romain Courteaud committed
5
#                    Romain Courteaud <romain@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
#
# 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 AccessControl import ClassSecurityInfo

32
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34 35 36 37 38
from Products.ERP5Type.XMLObject import XMLObject

from Products.ERP5.Document.Movement import Movement

class Container(Movement, XMLObject):
    """
Jérome Perrin's avatar
Jérome Perrin committed
39 40 41 42 43 44
      Container is equivalent to a movement with qty 1.0 and resource =
      to the kind of packaging Container may point to item (ex.
      Container serial No or Parcel Serial No if tracing required)
      Container may eventually usa optional property sheet to store
      parcel No information (we use Item property sheet for that). Some
      acquisition may be required...
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45 46 47
      
      A Container which does not point to an Item can act itself as an Item
      for traceability. 
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48

Jérome Perrin's avatar
Jérome Perrin committed
49 50
      Container Line / Container Cell is used to store quantities (never
      accounted)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53 54 55 56 57 58
      Container Line / Countainer Cell may point to Item
    """

    meta_type = 'ERP5 Container'
    portal_type = 'Container'

    # Declarative security
    security = ClassSecurityInfo()
59
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.Price
                      , PropertySheet.VariationRange
                      , PropertySheet.ItemAggregation
                      , PropertySheet.Item
                      , PropertySheet.Container
                      , PropertySheet.SortIndex
                      )

Jérome Perrin's avatar
Jérome Perrin committed
77 78
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getQuantity')
79
    def getQuantity(self, default=1.0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
80 81 82 83 84
      """
        Returns 1 because only one container is shipped
      """
      return 1.0

Jérome Perrin's avatar
Jérome Perrin committed
85 86
    security.declareProtected(Permissions.AccessContentsInformation,
                              'isAccountable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87 88 89 90 91 92 93 94 95
    def isAccountable(self):
      """
        Returns 1 if this needs to be accounted
        Only account movements which are not associated to a delivery
        Whenever delivery is there, delivery has priority
      """
      # Always accountable - to account the containers which we use
      return 1

Jérome Perrin's avatar
Jérome Perrin committed
96 97
    security.declareProtected( Permissions.ModifyPortalContent,
                              'hasCellContent' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98 99 100 101 102 103
    def hasCellContent(self, base_id='movement'):
      """
          This method can be overriden
      """
      return 0

104
    security.declareProtected(Permissions.AccessContentsInformation, 'isDivergent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
    def isDivergent(self):
      """
        Returns 1 if the target is not met according to the current information
        After and edit, the isOutOfTarget will be checked. If it is 1,
        a message is emitted

        emit targetUnreachable !
      """
      return 0

    def getContainerText(self):
      """
        Creates a unique string which allows to compare/hash two containers
      """
      result = ""
      container_line_list = list(self.objectValues())
121
      container_line_list.sort(key=lambda x: x.getResource())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
122 123 124
      for container_line in container_line_list:
        if container_line.hasCellContent():
          container_cell_list = list(container_line.objectValues())
125
          container_cell_list.sort(key=lambda x: x.getVariationText())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
126
          for container_cell in container_cell_list:
Romain Courteaud's avatar
Romain Courteaud committed
127 128 129
            result += "%s %s %s\n" % (container_cell.getResource(), 
                                      container_cell.getQuantity(), 
                                      '|'.join(container_cell.getVariationText().split('\n')))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130
        else:
Romain Courteaud's avatar
Romain Courteaud committed
131
          result += "%s %s\n" % (container_line.getResource(), container_line.getQuantity())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
132
      container_list = list(self.objectValues(spec = self.meta_type))
133
      container_list.sort(key=lambda x: x.getContainerText())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134 135 136 137 138
      more_result = ""
      for container in container_list:
        more_result += container.getContainerText()
      result = result + '\n'.join(map(lambda x: " %s" % x, more_result.split('\n')))
      return result
139 140

    # Used for optimization - requires reindexing using container_uid 
Jérome Perrin's avatar
Jérome Perrin committed
141 142
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getContainerUid')
143 144 145
    def getContainerUid(self):
      return self.getUid()

Jérome Perrin's avatar
Jérome Perrin committed
146 147
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getContainerValue')
148 149 150
    def getContainerValue(self):
      return self

Jérome Perrin's avatar
Jérome Perrin committed
151 152
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getContainer')
153 154 155
    def getContainer(self):
      return self.getRelativeUrl()

156
    # Quantity methods
Jérome Perrin's avatar
Jérome Perrin committed
157 158
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getContainedTotalQuantity')
159 160 161 162 163
    def getContainedTotalQuantity(self, recursive = 0):
      """
        The sum of quantities of contained lines
      """
      result = 0.0
Jérome Perrin's avatar
Jérome Perrin committed
164 165
      for o in self.contentValues(filter =
                    {'portal_type': self.getPortalContainerLineTypeList()}):
166 167
        result += o.getTotalQuantity()
      if recursive:
Jérome Perrin's avatar
Jérome Perrin committed
168 169 170 171
        for o in self.contentValues(filter =
                    {'portal_type': self.getPortalContainerTypeList()}):
          result += o.getContainedTotalQuantity()
      return result
172
    
Jérome Perrin's avatar
Jérome Perrin committed
173 174
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getContainedTotalPrice')
175 176 177 178 179
    def getContainedTotalPrice(self, recursive = 0):
      """
        The sum of price of contained lines
      """
      result = 0.0
Jérome Perrin's avatar
Jérome Perrin committed
180 181
      for o in self.contentValues(filter =
                    {'portal_type': self.getPortalContainerLineTypeList()}):
182 183
        result += o.getTotalPrice()
      if recursive:
Jérome Perrin's avatar
Jérome Perrin committed
184 185 186 187
        for o in self.contentValues(filter =
                    {'portal_type': self.getPortalContainerTypeList()}):
          result += o.getContainedTotalPrice()
      return result
188
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
189
    # Item Access
Jérome Perrin's avatar
Jérome Perrin committed
190 191
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTrackedItemUidList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193 194 195 196 197 198 199 200 201
    def getTrackedItemUidList(self):
      """
        Return a list of uid for related items.
        If this container is related to no item, it is treated as an Item
      """
      ### XXX We should filter by portal type here
      item_uid_list = self.getAggregateUidList()
      if len(item_uid_list): return item_uid_list
      return (self.getUid(),)