SupplyChain.py 13.6 KB
Newer Older
Romain Courteaud's avatar
Romain Courteaud committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Romain Courteaud <romain@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 AccessControl import ClassSecurityInfo
30
from Products.ERP5Type import Permissions, PropertySheet
Romain Courteaud's avatar
Romain Courteaud committed
31 32 33
from Products.ERP5Type.XMLObject import XMLObject
from Products.ERP5.Document.Path import Path

34 35
class SupplyChainError(Exception): pass

Romain Courteaud's avatar
Romain Courteaud committed
36 37 38 39 40 41 42 43 44 45
class SupplyChain(Path, XMLObject):
  """
    SupplyChain defines the route used to produced a resource.
  """
  # CMF Type Definition
  meta_type = 'ERP5 Supply Chain'
  portal_type = 'Supply Chain'

  # Declarative security
  security = ClassSecurityInfo()
46
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Romain Courteaud's avatar
Romain Courteaud committed
47 48 49 50 51 52 53 54

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Task
                    , PropertySheet.Arrow
55 56
                    , PropertySheet.Reference
                    , PropertySheet.Comment
Romain Courteaud's avatar
Romain Courteaud committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
                    , PropertySheet.Movement
                    , PropertySheet.Delivery
                    , PropertySheet.Path
                    , PropertySheet.FlowCapacity
                    )

  # Class variable
  supply_link_portal_type="Supply Link"

  security.declareProtected(Permissions.View, 'getLastLink')
  def getLastLink(self):
    """
      Return the SupplyLink representing the last ridge of the 
      SupplyChain (if this one is correctly defined...).
    """
    # Result value
    result = None
    # Get all lines.
    supply_link_list = self.objectValues(
                               portal_type=self.supply_link_portal_type)
    # Last line is defined by deliverable=1
    last_supply_link_list = [x for x in supply_link_list if\
                              x.getDeliverable()]
    # Check if user did not define multiple last links
    last_list_len = len(last_supply_link_list)
    if (last_list_len == 1):
      result = last_supply_link_list[0]
    else:
85
      raise SupplyChainError,\
Romain Courteaud's avatar
Romain Courteaud committed
86 87 88 89
            "Unable to get the last link of SupplyChain %s" %\
            str(self.getRelativeUrl())
    return result

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
  security.declareProtected(Permissions.View,
                            'getNextSupplyLinkList')
  def getNextSupplyLinkList(self, current_supply_link):
    """
      Return the previous SupplyLink  list.
    """
    supply_link_list = self.objectValues(
                                 portal_type=self.supply_link_portal_type)
    # Search next link
    next_node_value = current_supply_link.getNextNodeValue()
    next_supply_link_list = [x for x in supply_link_list if \
                             x.getCurrentNodeValue() == next_node_value]
    # Prevent infinite loop
    if current_supply_link in next_supply_link_list:
      next_supply_link_list.remove(current_supply_link)
    # Get only production node in the list, or return the entire list
    next_production_list = [x for x in next_supply_link_list \
                                if x.isProductionSupplyLink()]
    if next_production_list != []:
      next_supply_link_list = next_production_list 
    return next_supply_link_list

  security.declareProtected(Permissions.View,
                            'getNextProductionSupplyLinkList')
  def getNextProductionSupplyLinkList(self, current_supply_link):
    """
      Return the next SupplyLink which represents a production,
      if there is one.
      No recursion is done.
    """
    next_supply_link_list = self.getNextSupplyLinkList(current_supply_link)
    return [x for x in next_supply_link_list if x.isProductionSupplyLink()]
    
  security.declareProtected(Permissions.View,
                            'getNextProductionIndustrialPhaseList')
  def getNextProductionIndustrialPhaseList(self, current_supply_link):
    """
      Return all next industrial phase representing a production.
    """
    ind_phase_dict = {}
    for link in self.getNextProductionSupplyLinkList(current_supply_link):
      for ind_phase in link.getIndustrialPhaseValueList():
        ind_phase_dict[ind_phase] = 1
    # Remove None value, and generate the list
    ind_phase_dict.pop(None, None)
    return ind_phase_dict.keys()

  security.declareProtected(Permissions.View,
                            'getPreviousSupplyLinkList')
Romain Courteaud's avatar
Romain Courteaud committed
139 140 141 142 143 144 145 146 147 148 149 150
  def getPreviousSupplyLinkList(self, current_supply_link):
    """
      Return the previous SupplyLink  list.
    """
    if current_supply_link is not None:
      # Get all SupplyLink in the SupplyChain
      supply_link_list = self.objectValues(
                                 portal_type=self.supply_link_portal_type)
      # Destination of valid link must be the source of the current link.
      current_node_value = current_supply_link.getCurrentNodeValue()
      previous_supply_link_list = [
                                 x for x in supply_link_list if\
151
                                 x.getNextNodeValue() == current_node_value]
Romain Courteaud's avatar
Romain Courteaud committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
      # Prevent infinite loop
      if current_supply_link in previous_supply_link_list:
        previous_supply_link_list.remove(current_supply_link)
      # Get only production node in the list, or return the entire list
      previous_production_list = [x for x in previous_supply_link_list\
                                  if x.isProductionSupplyLink()]
      if previous_production_list != []:
        previous_supply_link_list = previous_production_list
    else:
      # No current_supply_link defined, we need to return the last SupplyLink
      previous_supply_link_list = [self.getLastLink()]
    # Return result
    return previous_supply_link_list

  security.declareProtected(Permissions.View,
                            'getPreviousProductionSupplyLinkList')
  def getPreviousProductionSupplyLinkList(self, current_supply_link, 
169
                                          recursive=False, all=False,
Romain Courteaud's avatar
Romain Courteaud committed
170 171 172
                                          checked_link_list=None):
    """
      Return the previous SupplyLink which represents a production.
173
      If recursive, browse the SupplyChain until a valid link is found.
Romain Courteaud's avatar
Romain Courteaud committed
174 175
      checked_link_list is used to prevent infinite loop.
    """
Nicolas Dumazet's avatar
Nicolas Dumazet committed
176 177
    # XXX document "all" parameter if you can

Romain Courteaud's avatar
Romain Courteaud committed
178 179 180 181 182 183
    # Initialize checked_link_list parameter...
    if checked_link_list is None:
      checked_link_list = []
    # Checked if we already tested this link 
    # to prevent infinite loop
    if current_supply_link in checked_link_list:
184
      raise SupplyChainError,\
Romain Courteaud's avatar
Romain Courteaud committed
185 186 187 188 189 190 191 192
            "SupplyLink %r is in a loop." % current_supply_link
    else:
      transformation_link_list = []
      checked_link_list.append(current_supply_link)
      # Get the previous link list
      previous_link_list = self.getPreviousSupplyLinkList(current_supply_link)
      # Test each link
      for previous_link in previous_link_list:
193 194 195 196 197 198
        if not previous_link.isProductionSupplyLink():
          # current is invalid
          if not recursive:
            continue
        else:
          # Great, we found a valid one
Romain Courteaud's avatar
Romain Courteaud committed
199 200 201
          transformation_link_list.append(previous_link)
          # Prevent infinite loop when 2 production_link have the same
          # destination
Romain Courteaud's avatar
Romain Courteaud committed
202 203
          if (current_supply_link is not None) and \
             (current_supply_link.isProductionSupplyLink()):
204
            raise SupplyChainError,\
Romain Courteaud's avatar
Romain Courteaud committed
205 206 207
                  "Those SupplyLinks are in conflict: %r and %r" %\
                  (current_supply_link.getRelativeUrl(),\
                   previous_link.getRelativeUrl())
208 209 210 211 212 213 214 215 216
          if not recursive and not all:
            continue

        # Browse the previous link
        transformation_link_list.extend(
          self.getPreviousProductionSupplyLinkList(
                                       previous_link, 
                                       recursive=recursive, all=all,
                                       checked_link_list=checked_link_list))
Romain Courteaud's avatar
Romain Courteaud committed
217 218 219 220 221 222
      # Return result
      return transformation_link_list

  security.declareProtected(Permissions.View,
                            'getPreviousPackingListSupplyLinkList')
  def getPreviousPackingListSupplyLinkList(self, current_supply_link, 
223
                                           recursive=0, all=0,
Romain Courteaud's avatar
Romain Courteaud committed
224 225 226 227 228 229 230 231 232 233 234 235 236
                                           checked_link_list=None,
                                           movement=None):
    """
      Return the previous SupplyLink which represents a production.
      If recursive=1, browse the SupplyChain until a valid link is found.
      checked_link_list is used to prevent infinite loop.
    """
    # Initialize checked_link_list parameter...
    if checked_link_list is None:
      checked_link_list = []
    # Checked if we already tested this link 
    # to prevent infinite loop
    if current_supply_link in checked_link_list:
237
      raise SupplyChainError,\
Romain Courteaud's avatar
Romain Courteaud committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
            "SupplyLink %r is in a loop." % current_supply_link
    else:
      packing_list_link_list = []
      checked_link_list.append(current_supply_link)
      # Get the previous link list
      previous_link_list = self.getPreviousSupplyLinkList(current_supply_link)
      # Test each link
      for previous_link in previous_link_list:
        concurrent_list = previous_link_list[:]
        concurrent_list.remove(previous_link)
        # Great, we find a valid one
        if previous_link.isPackingListSupplyLink():
          if (movement is None) or\
             (previous_link.test(movement, concurrent_list)):
            packing_list_link_list.append(previous_link)
          # Browse the previous link
          if (recursive==1):
            packing_list_link_list.extend(
              self.getPreviousPackingListSupplyLinkList(
                                         previous_link, 
                                         recursive=recursive,
                                         checked_link_list=checked_link_list))
      # Return result
      return packing_list_link_list

  def getPreviousIndustrialPhaseList(self, current_supply_link, method_id,
264
                                     include_current=0, all=0):
Romain Courteaud's avatar
Romain Courteaud committed
265 266 267 268
    """
      Return recursively all previous industrial phase.
    """
    method = getattr(self, method_id)
269 270
    previous_supply_link_list = method(current_supply_link, recursive=1,
                                       all=all)
Romain Courteaud's avatar
Romain Courteaud committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
    # Add the current industrial phase
    if (include_current == 1):
      previous_supply_link_list.append(current_supply_link)
    # Generate the industrial phase list, and remove double
    ind_phase_dict = {}
    for supply_link in previous_supply_link_list:
      ind_phase_value_list = supply_link.getIndustrialPhaseValueList()
      for ind_phase in ind_phase_value_list:
        ind_phase_dict[ind_phase] = 1
    # Remove None value, and generate the list
    ind_phase_dict.pop(None, None)
    ind_phase_list = ind_phase_dict.keys()
    return ind_phase_list

  security.declareProtected(Permissions.View,
                            'getPreviousProductionIndustrialPhaseList')
287 288
  def getPreviousProductionIndustrialPhaseList(self, current_supply_link,
                                               all=0):
Romain Courteaud's avatar
Romain Courteaud committed
289 290 291 292 293 294
    """
      Return recursively all previous industrial phase representing 
      a production.
    """
    return self.getPreviousIndustrialPhaseList(
                                   current_supply_link,
295 296
                                   "getPreviousProductionSupplyLinkList",
                                   all=all)
Romain Courteaud's avatar
Romain Courteaud committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

  security.declareProtected(Permissions.View,
                            'getPreviousPackingListIndustrialPhaseList')
  def getPreviousPackingListIndustrialPhaseList(self, current_supply_link):
    """
      Return recursively all previous industrial phase representing 
      a packing list.
    """
    return self.getPreviousIndustrialPhaseList(
                                   current_supply_link,
                                   "getPreviousPackingListSupplyLinkList",
                                   include_current=1)

  security.declareProtected(Permissions.View,
                            'test')
  def test(self, current_supply_link, movement):
    """
      Test if the resource on the movement can be delivered by 
      the previous supply link of the current one.
    """
    result = 0
    previous_packing_link_list = self.\
                   getPreviousPackingListSupplyLinkList(current_supply_link)
    for previous_supply_link in previous_packing_link_list:
      concurrent_list = previous_packing_link_list[:]
      concurrent_list.remove(previous_supply_link)
      if previous_supply_link.test(movement, concurrent_list):
        result = 1
        break
    return result