ActiveProcess.py 6.66 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 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 Acquisition import aq_base
from Globals import InitializeClass, DTMLFile
from AccessControl import ClassSecurityInfo
from Products.CMFCore import CMFCorePermissions
from Products.ERP5Type.Base import Base
from Products.ERP5Type import PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from BTrees.IOBTree import IOBTree
36
from BTrees.Length import Length
37
from Products.CMFActivity.ActiveObject import DISTRIBUTABLE_STATE, INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE
38
from random import randint
39 40 41 42
from zLOG import LOG

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

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

class ActiveProcess(Base):
    """
        ActiveProcess is used to centralise interaction between multiple ActiveObject
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60
        RENAME: ActiveResult
61 62 63
    """

    meta_type='CMF Active Process'
64
    portal_type='Active Process'
65
    isPortalContent = 0 
66 67 68 69 70 71 72 73 74 75 76 77 78
    isRADContent = 1
    icon = None

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

    # Declarative properties
    property_sheets = ( PropertySheet.Base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79
                      , PropertySheet.SimpleItem
80
                      , PropertySheet.Folder
81
                      , PropertySheet.ActiveProcess )
82 83 84 85

    # Declarative constructors
    constructors =   (manage_addActiveProcessForm, addActiveProcess)

86 87 88 89 90 91 92
    def _generateRandomId(self):
      """
      Generate a random int depending on the size of the result list
      """
      random_id = randint(1, 10000 * (self.result_len.value + 1)) 
      return random_id

Jean-Paul Smets's avatar
Jean-Paul Smets committed
93 94
    security.declareProtected(CMFCorePermissions.ManagePortal, 'postResult')
    def postResult(self, result):
95
      if getattr(self, 'result_list', None) is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96
        self.result_list = IOBTree()
97
        self.result_len = Length()
98 99 100 101 102 103 104
      random_id = self._generateRandomId()
      _marker = []
      # use a random id in order to store result in a way with
      # fewer conflict errors
      while self.result_list.get(random_id, _marker) is not _marker:
        random_id = self._generateRandomId()
      self.result_list[random_id] = result
105
      self.result_len.change(1)
106

Jean-Paul Smets's avatar
Jean-Paul Smets committed
107
    security.declareProtected(CMFCorePermissions.ManagePortal, 'getResultList')
108
    def getResultList(self, **kw):
109
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
110
        Returns the list of results
111
      """
112
      if getattr(self, 'result_list', None) is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
113
        self.result_list = IOBTree()
114
        self.result_len = Length()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
115 116
      # Improve this to include sort order XXX
      return self.result_list.values()
117

Jean-Paul Smets's avatar
Jean-Paul Smets committed
118 119 120 121 122 123
#     security.declareProtected(CMFCorePermissions.ManagePortal, 'getErrorListText')
#     def getResultListText(self):
#       """
#         Returns the list of errors as text
#       """
#       return '\n'.join(map(lambda x:repr(x), self.error_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124
#
125 126 127
    security.declareProtected(CMFCorePermissions.ManagePortal, 'activateResult')
    def activateResult(self, result):
      if result not in (None, 0, '', (), []):
128
        #self.activate().postError(result)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
129 130 131 132
        self.postResult(result) # Until we get SQLQueue
      # If result is a callable, then use it to propagate result (... ??? )
      #if callable(result):
      #  return self.activateResult(Result(self, 'activateResult',result())
133

134 135 136
    security.declareProtected( CMFCorePermissions.View, 'hasActivity' )
    def hasActivity(self, **kw):
      """
Sebastien Robin's avatar
Sebastien Robin committed
137
        Tells if there is still some activities not finished attached to this process
138 139 140
      """
      activity_tool = getattr(self, 'portal_activities', None)
      if activity_tool is None: return 0 # Do nothing if no portal_activities
141
      return activity_tool.hasActivity(None, active_process_uid = self.getUid(), **kw)
142 143 144 145

    security.declareProtected( CMFCorePermissions.View, 'hasErrorActivity' )
    def hasErrorActivity(self, **kw):
      """
Sebastien Robin's avatar
Sebastien Robin committed
146
        Tells if some attached activities are in a error 
147 148 149 150 151 152 153 154 155 156
      """
      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)

157
    def getCreationDate(self):
158 159 160 161 162 163
      """
        Define a Creation Date for an active process
        thanks to the start date
      """
      return self.getStartDate()

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    def start():
      # start activities related to this process
      pass

    def stop():
      # stop activities related to this process
      pass

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


179
InitializeClass( ActiveProcess )