Order.py 13.8 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 30 31 32 33 34
#
# 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
from Products.CMFCore.WorkflowCore import WorkflowMethod
from Products.CMFCore.utils import getToolByName
from Products.CMFCore.WorkflowCore import WorkflowMethod
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Base import Base
35
from Products.ERP5.ERP5Globals import movement_type_list, draft_order_state, planned_order_state
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36

37
from Products.ERP5.Document.Delivery import Delivery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38 39 40 41 42 43 44

from zLOG import LOG

class Order(Delivery):
    # CMF Type Definition
    meta_type = 'ERP5 Order'
    portal_type = 'Order'
45
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48 49 50 51 52 53 54 55 56 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 85 86 87 88 89 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
    isPortalContent = 1
    isRADContent = 1

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

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Reference
                      , PropertySheet.TradeCondition
                      )

    # CMF Factory Type Information
    factory_type_information = \
      {    'id'             : portal_type
         , 'meta_type'      : meta_type
         , 'description'    : """\
An order..."""
         , 'icon'           : 'order_icon.gif'
         , 'product'        : 'ERP5'
         , 'factory'        : 'addOrder'
         , 'immediate_view' : 'order_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': ('Movement', 'Order Line',
                                      )
         , 'filter_content_types' : 1
         , 'global_allow'   : 1
         , 'actions'        :
        ( { 'id'            : 'view'
          , 'name'          : 'View'
          , 'category'      : 'object_view'
          , 'action'        : 'order_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'        : 'order_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, )
          }
        )
      }

    security.declarePrivate( '_edit' )
    def _edit(self, REQUEST=None, force_update = 0, **kw):
      Delivery._edit(self, REQUEST=REQUEST, force_update = force_update, **kw)
121 122 123
      # We must expand our applied rule only if not confirmed
      if self.getSimulationState() in planned_order_state:
        self.updateAppliedRule() # This should be implemented with the interaction tool rather than with this hard coding
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124 125 126 127 128 129

    def updateAppliedRule(self):
      if self.getSimulationState() not in draft_order_state:
        # Nothing to do
        self._createOrderRule()

Yoshinori Okuji's avatar
Yoshinori Okuji committed
130
    security.declareProtected(Permissions.AccessContentsInformation, 'getSimulationState')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    def getSimulationState(self, id_only=1):
      """
        Returns the current state in simulation
      """
      portal_workflow = getToolByName(self, 'portal_workflow')
      wf = portal_workflow.getWorkflowById('order_workflow')
      return wf._getWorkflowStateOf(self, id_only=id_only )

    security.declareProtected(Permissions.AccessContentsInformation, 'isAccountable')
    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
      """
      return 0

    def _createOrderRule(self):
      # Return if draft or cancelled simulation_state
      if self.getSimulationState() in ('cancelled',):
        # The applied rule should be cleaned up ie. empty all movements which have
        # no confirmed children
        return
      # Otherwise, expand
      # Look up if existing applied rule
      my_applied_rule_list = self.getCausalityRelatedValueList(portal_type='Applied Rule')
      if len(my_applied_rule_list) == 0:
        # Create a new applied order rule (portal_rules.order_rule)
        portal_rules = getToolByName(self, 'portal_rules')
        portal_simulation = getToolByName(self, 'portal_simulation')
        my_applied_rule = portal_rules.default_order_rule.constructNewAppliedRule(portal_simulation)
        # Set causality
        my_applied_rule.setCausalityValue(self)
        my_applied_rule.flushActivity(invoke = 1) # We must make sure this rule is indexed
                                                  # now in order not to create another one later
      elif len(my_applied_rule_list) == 1:
        # Re expand the rule if possible
        my_applied_rule = my_applied_rule_list[0]
      else:
        # Delete first rules and re expand if possible
        for my_applied_rule in my_applied_rule_list[0:-1]:
          my_applied_rule.flushActivity(invoke=0)
          my_applied_rule.aq_parent._delObject(my_applied_rule.getId())
        my_applied_rule = my_applied_rule_list[-1]

      # We are now certain we have a single applied rule
      # It is time to expand it
      self.activate().expand(my_applied_rule.getId())

    security.declareProtected(Permissions.ModifyPortalContent, 'autoPlan')
    def _autoPlan(self):
      """
        Sets the order to auto_planned. The auto_plan state
        is used to differentiate planned orders generated by
        the planification system with planned orders depending
        of a user decision
      """
      # self._createOrderRule()
      # No simulation created at this point

    autoPlan = WorkflowMethod(_autoPlan, id='auto_plan')

    security.declareProtected(Permissions.ModifyPortalContent, 'plan')
    def _plan(self):
      """
        Sets the order to planned
      """
      self._createOrderRule()

    plan = WorkflowMethod(_plan, id='plan')

    security.declareProtected(Permissions.ModifyPortalContent, 'order')
    def _order(self):
      """
        Sets the order to ordered
      """
      # make sure it is planned
      # then plan order simulation
      self._createOrderRule()

    order = WorkflowMethod(_order, id='order')

    security.declareProtected(Permissions.ModifyPortalContent, 'confirm')
    def _confirm(self):
      """
        Sets the order to ordered
        (a Workflow Script is responsible of creating the delivery)
218 219 220

        Confirm is still not creating deliveries XXX - check activities seriously to make sure
        they are not flushed in case of error
Jean-Paul Smets's avatar
Jean-Paul Smets committed
221 222
      """
      self._createOrderRule()
223 224
      # At confirm stage, we create deliveries for this order
      self.activate().buildDeliveryList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
225 226 227

    confirm = WorkflowMethod(_confirm, 'confirm')

228 229 230 231 232 233 234 235 236 237 238
    security.declareProtected(Permissions.ModifyPortalContent, 'buildDeliveryList')
    def buildDeliveryList(self):
      # Make sure there is exactly one applied rule
      my_applied_rule_list = self.getCausalityRelatedValueList(portal_type='Applied Rule')
      if len(my_applied_rule_list) != 1:
        # Make sure we have an order rule
        self._createOrderRule()
      # Make sure there is exactly one applied rule
      my_applied_rule_list = self.getCausalityRelatedValueList(portal_type='Applied Rule')
      if len(my_applied_rule_list) != 1:
        # XXX This is an error
239
        raise CategoryError, "Order has no or too many order rule(s)"
240 241 242
      applied_rule = my_applied_rule_list[0].getObject()
      if applied_rule is None:
        # XXX This is an error
243
        raise CategoryError, "Order has None order rule"
244 245
      # Make sure applied rule has been reindexed
      # Make sure there are no more activities on this order related to expand
246 247 248 249 250
      self.flushActivity(invoke=0, method_id='expand') # Make sure expand is finished
                                                       # We are expanding but are not allowed to if state wrong...
                                                       # (ex. confirmed)
      applied_rule.expand(force = 1)                   # thus, we mist force expand of applied order rule
      applied_rule.flushActivity(invoke=1)
251 252 253 254 255
      # Build delivery list on applied rule
      # Currently, we build it 'again' but we should actually only build
      # deliveries for orphaned movements
      if self.getPortalType() == 'Production Order' :
        delivery_list = self.ProductionOrder_buildDeliveryList() # Coramy specific moved to portal_simulation
256
      #else:
257 258 259 260 261 262 263 264 265
      elif self.getPortalType() in ('Purchase Order', 'Sales Order') :
        delivery_list = self.order_create_packing_list() # Coramy specific should be moved to portal_simulation
      #self.informDeliveryList(delivery_list=delivery_list, comment=repr(delivery_list)) # XXX Not ready

    def _informDeliveryList(self, delivery_list=None, comment=None):
      pass

    informDeliveryList = WorkflowMethod(_informDeliveryList, id='informDeliveryList')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 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 327 328 329 330
    security.declareProtected(Permissions.ModifyPortalContent, 'cancel')
    def cancel(self):
      """
        Sets the order to ordered
      """
      # No need to create an order rule
      # Should actually delete form simulation XXX
      self.activate().applyToOrderRelatedMovement(method_id = 'expand')

    cancel = WorkflowMethod(cancel)

    def applyToOrderRelatedMovement(self, portal_type='Simulation Movement', method_id = 'expand'):
      """
        Warning: does not work if it was not catalogued immediately
      """
      for my_simulation_movement in self.getOrderRelatedValueList(
                                                portal_type = 'Simulation Movement'):
          # And apply
          getattr(my_simulation_movement, method_id)()
      for m in self.contentValues(filter={'portal_type': movement_type_list}):
        # Find related in simulation
        for my_simulation_movement in m.getOrderRelatedValueList(
                                                portal_type = 'Simulation Movement'):
          # And apply
          getattr(my_simulation_movement, method_id)()
        for c in m.contentValues(filter={'portal_type': 'Delivery Cell'}):
          for my_simulation_movement in c.getOrderRelatedValueList(
                                                portal_type = 'Simulation Movement'):
            # And apply
            getattr(my_simulation_movement, method_id)()

    def applyToOrderRelatedAppliedRule(self, method_id = 'expand'):
      my_applied_rule = self.getCausalityRelatedValue(portal_type = 'Applied Rule')
      getattr(my_applied_rule.getObject(), method_id)()


    security.declareProtected(Permissions.AccessContentsInformation, 'getOrderRelatedMovementList')
    def getOrderRelatedMovementList(self):
      """
        Returns simulation movements related to a cell or line of this order
      """
      result = self.getOrderRelatedValueList( portal_type = 'Simulation Movement')
      for m in self.contentValues(filter={'portal_type': movement_type_list}):
        # Find related in simulation
        result += m.getOrderRelatedValueList( portal_type = 'Simulation Movement')
        for c in m.contentValues(filter={'portal_type': 'Delivery Cell'}):
          result += c.getOrderRelatedValueList( portal_type = 'Simulation Movement')
      return result

    def reindexObject(self, *k, **kw):
      """
        Reindex children and simulation
      """
      if self.isIndexable:
        # Reindex children
        self.activate().recursiveImmediateReindexObject()
        # Make sure expanded simulation is still OK (expand and reindex)
        # self.activate().applyToOrderRelatedMovement(method_id = 'expand')
        # Removed because overkill

    def manage_beforeDelete(self, item, container):
      """
          Delete related Applied Rule
      """
      for o in self.getCausalityRelatedValueList(portal_type='Applied Rule'):
331
        o.aq_parent.activate().deleteContent(o.getId())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
332 333
      Delivery.manage_beforeDelete(self, item, container)