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

29
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
30
from AccessControl import ClassSecurityInfo
31
from Products.CMFCore import permissions as CMFCorePermissions
32 33
from Products.ERP5Type.Base import Base
from Products.ERP5Type import PropertySheet
34
from Products.ERP5Type.ConflictFree import ConflictFreeLog
35
from BTrees.Length import Length
Vincent Pelletier's avatar
Vincent Pelletier committed
36 37
from Products.CMFActivity.ActiveObject import INVOKE_ERROR_STATE, \
  VALIDATE_ERROR_STATE
38
from random import randrange
39
from .ActiveResult import ActiveResult
40

41
manage_addActiveProcessForm = DTMLFile('dtml/ActiveProcess_add', globals())
42

43
def addActiveProcess(self, id, title='', REQUEST=None, activate_kw=None, **kw):
44 45 46 47
  """Add a new Active Process.
  """
  o = ActiveProcess(id)
  if activate_kw is not None:
48
    o.__of__(self).setDefaultActivateParameterDict(activate_kw)
49 50 51
  o.uid = self.portal_catalog.newUid()
  self._setObject(id, o)
  o = self._getOb(id)
52 53
  if kw:
    o._edit(force_update=1, **kw)
54 55 56
  if REQUEST is not None:
    REQUEST['RESPONSE'].redirect( 'manage_main' )
  return o
57 58

class ActiveProcess(Base):
59
  """
Vincent Pelletier's avatar
Vincent Pelletier committed
60 61
      ActiveProcess is used to centralise interaction between multiple
      ActiveObject
62 63 64
      RENAME: ActiveResult
  """

65 66
  meta_type = 'CMF Active Process'
  portal_type = 'Active Process'
67 68 69 70 71 72 73 74 75 76 77 78 79 80
  icon = None

  # Declarative security
  security = ClassSecurityInfo()
  security.declareProtected(CMFCorePermissions.ManagePortal,
                            'manage_editProperties',
                            'manage_changeProperties',
                            'manage_propertiesForm',
                              )

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.Folder
81
                    , PropertySheet.CategoryCore
82 83 84 85 86
                    , PropertySheet.ActiveProcess )

  # Declarative constructors
  constructors =   (manage_addActiveProcessForm, addActiveProcess)

87 88 89
  def __init__(self, *args, **kw):
    Base.__init__(self, *args, **kw)
    self.result_list = ConflictFreeLog()
90 91 92

  security.declareProtected(CMFCorePermissions.ManagePortal, 'postResult')
  def postResult(self, result):
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
    try:
      result_list = self.result_list
    except AttributeError:
      # BBB: self was created before implementation of __init__
      self.result_list = result_list = ConflictFreeLog()
    else:
      if type(result_list) is not ConflictFreeLog: # BBB: result_list is IOBTree
        # use a random id in order to store result in a way with
        # fewer conflict errors
        random_id = randrange(0, 10000 * (self.result_len.value + 1))
        while result_list.has_key(random_id):
          random_id += 1
        result_list[random_id] = result
        self.result_len.change(1)
        return
    result_list.append(result)
109

110 111 112 113
  security.declareProtected(CMFCorePermissions.ManagePortal, 'postActiveResult')
  def postActiveResult(self, *args, **kw):
    return self.postResult(ActiveResult(*args, **kw))

114 115 116 117 118 119
  security.declareProtected(CMFCorePermissions.ManagePortal, 'getResultList')
  def getResultList(self, **kw):
    """
      Returns the list of results
    """
    # Improve this to include sort order XXX
120 121 122 123 124 125 126 127
    try:
      result_list = self.result_list
    except AttributeError:
      # BBB: self was created before implementation of __init__
      return []
    if type(result_list) is not ConflictFreeLog: # BBB: result_list is IOBTree
      return result_list.values()
    return list(result_list)
128 129 130 131 132 133 134 135 136

  security.declareProtected(CMFCorePermissions.ManagePortal, 'activateResult')
  def activateResult(self, result):
    if result not in (None, 0, '', (), []):
      self.postResult(result) # Until we get SQLQueue

  security.declareProtected( CMFCorePermissions.View, 'hasActivity' )
  def hasActivity(self, **kw):
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
137 138
      Tells if there is still some activities not finished attached to this
      process
139 140
    """
    activity_tool = getattr(self, 'portal_activities', None)
141 142
    if activity_tool is None:
      return 0 # Do nothing if no portal_activities
Vincent Pelletier's avatar
Vincent Pelletier committed
143 144
    return activity_tool.hasActivity(None, active_process_uid = self.getUid(),
      **kw)
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

  security.declareProtected( CMFCorePermissions.View, 'hasErrorActivity' )
  def hasErrorActivity(self, **kw):
    """
      Tells if some attached activities are in a error 
    """
    return self.hasActivity(processing_node = INVOKE_ERROR_STATE)

  security.declareProtected( CMFCorePermissions.View, 'hasInvalidActivity' )
  def hasInvalidActivity(self, **kw):
    """
      Tells if an object if active
    """
    return self.hasActivity(processing_node = VALIDATE_ERROR_STATE)

  def getCreationDate(self):
    """
      Define a Creation Date for an active process
      thanks to the start date
    """
    return self.getStartDate()

  def flush(self):
    # flush  activities related to this process
    activity_tool = getattr(self, 'portal_activities', None)
170 171
    if activity_tool is None:
      return # Do nothing if no portal_activities
172
    return activity_tool.flush(None, active_process = self, invoke = 0) # FLush
173 174


175
InitializeClass( ActiveProcess )