ActiveObject.py 8.13 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets 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 30
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@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.
#
##############################################################################

import ExtensionClass
from AccessControl import ClassSecurityInfo
31
from Acquisition import aq_base
32
from ZODB.POSException import ConflictError
33
from Products.CMFCore.utils import getToolByName
34
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

36 37 38 39 40
try:
  from Products.CMFCore import permissions
except ImportError:
  from Products.CMFCore import CMFCorePermissions as permissions

41
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44

DEFAULT_ACTIVITY = 'SQLDict'

45 46 47 48 49
# Processing node are used to store processing state or processing node
DISTRIBUTABLE_STATE = -1
INVOKE_ERROR_STATE = -2
VALIDATE_ERROR_STATE = -3
STOP_STATE = -4
50 51
# Special state which allows to select positive nodes
POSITIVE_NODE_STATE = 'Positive Node State'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53

class ActiveObject(ExtensionClass.Base):
54 55 56 57 58 59 60
  """Active Object Mixin Class.

  Active object are objects whose methods are lazilly evaluated in the
  Activity Queue. To use an active object, you just have to call the
  method on the wrapper returned by the `activate` method like this:

  >>> obj.activate().aMethod()
61

62 63
  This will defer the call to obj.aMethod() 
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64 65 66

  security = ClassSecurityInfo()

67 68 69
  def activate(self, activity=DEFAULT_ACTIVITY, active_process=None,
               passive_commit=0, activate_kw=None, **kw):
    """Returns an active wrapper for this object.
70

71
      Reserved Optional parameters:
72

73
      at_date           --  request execution date for this activate call
74

75 76 77
      after_method_id   --  never validate message if after_method_id
                            is in the list of methods which are
                            going to be executed
78

79 80 81
      after_message_uid --  never validate message if after_message_uid
                            is in the list of messages which are
                            going to be executed
82

83 84
      after_path        --  never validate message if after_path
                            is in the list of path which are
85
                            going to be executed
86

87 88 89 90 91 92 93 94 95
      after_path_and_method_id
                        -- never validate message if a message for
                           method_id on path is in the queue.

      tag               -- add a tag to a message

      after_tag         -- never validate message if there is a message
                           tagged with this tag.

96
    """
97 98
    # Get activate values from activate_kw, then _v_activate_kw
    # only if they are not set directly as arguments to activate()
99
    if activate_kw is not None:
100 101 102 103 104 105
      for k, v in activate_kw.iteritems():
        if k not in kw:
          kw[k] = v

    # Get default parameters from a transactional variable.
    tv = getTransactionalVariable()
106
    key = ('default_activate_parameter', id(aq_base(self)))
107 108 109 110 111 112 113 114
    try:
      for k, v in tv[key].iteritems():
        if k not in kw:
          kw[k] = v
    except KeyError:
      pass

    # Deprecated: This volatile variable '_v_activate_kw' can be used to pass parameters
115
    # automatically to activate.
116
    if getattr(self, '_v_activate_kw', None) is not None:
117 118 119 120 121 122 123 124
      import warnings
      warnings.warn('_v_activate_kw is deprecated;\n'
                    ' use setDefaultActivateParameters instead.',
                    DeprecationWarning)
      for k, v in self._v_activate_kw.iteritems():
        if k not in kw:
          kw[k] = v

125
    activity_tool = getToolByName(self, 'portal_activities', None)
126
    if activity_tool is None: return self # Do nothing if no portal_activities
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127 128 129 130
    # activate returns an ActiveWrapper
    # a queue can be provided as well as extra parameters
    # which can be used for example to define deferred tasks
    try:
131
      return activity_tool.activateObject(self, activity, active_process, **kw)
132 133
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134
    except:
135 136
      LOG("CMFActivity", WARNING,
          'could not create activity for %s' % self.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
137 138
      # If the portal_activities were not created
      # return a passive object
139
      if passive_commit: get_transaction().commit()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
140 141
      return self

142
  security.declareProtected( permissions.ModifyPortalContent, 'flushActivity' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
143
  def flushActivity(self, invoke=0, **kw):
144
    activity_tool = getToolByName(self, 'portal_activities', None)
145
    if activity_tool is None: return # Do nothing if no portal_activities
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146
    # flush all activities related to this object
147 148 149 150
    activity_tool.flush(self, invoke=invoke, **kw)

  security.declareProtected( permissions.ModifyPortalContent,
                             'recursiveFlushActivity' )
151
  def recursiveFlushActivity(self, invoke=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152
    # flush all activities related to this object
153
    self.flushActivity(invoke=invoke, **kw)
154
    if getattr(aq_base(self), 'objectValues', None) is not None:
155
      for o in self.objectValues():
156
        if getattr(aq_base(o), 'recursiveFlushActivity', None) is not None:
157
          o.recursiveFlushActivity(invoke=invoke, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
158

159
  security.declareProtected( permissions.View, 'hasActivity' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160
  def hasActivity(self, **kw):
161
    """Tells if there is pending activities for this object.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
162
    """
163
    activity_tool = getToolByName(self, 'portal_activities', None)
164
    if activity_tool is None: return 0 # Do nothing if no portal_activities
Jean-Paul Smets's avatar
Jean-Paul Smets committed
165
    try:
166
      return activity_tool.hasActivity(self, **kw)
167 168
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
169 170 171 172
    except:
      # If the portal_activities were not created
      # there can not be any activity
      return 0
173

174
  security.declareProtected( permissions.View, 'hasErrorActivity' )
175
  def hasErrorActivity(self, **kw):
176
    """Tells if there is failed activities for this object.
177 178 179
    """
    return self.hasActivity(processing_node = INVOKE_ERROR_STATE)

180
  security.declareProtected( permissions.View, 'hasInvalidActivity' )
181
  def hasInvalidActivity(self, **kw):
182
    """Tells if there is invalied activities for this object.
183 184 185
    """
    return self.hasActivity(processing_node = VALIDATE_ERROR_STATE)

186
  security.declareProtected( permissions.View, 'getActiveProcess' )
187
  def getActiveProcess(self):
188
    activity_tool = getToolByName(self, 'portal_activities', None)
189
    if activity_tool is None: return None # Do nothing if no portal_activities
190 191
    return activity_tool.getActiveProcess()

192 193 194 195 196
  security.declareProtected( permissions.ModifyPortalContent, 'setDefaultActivateParameters' )
  def setDefaultActivateParameters(self, **kw):
    # This method sets the default keyword parameters to activate. This is useful
    # when you need to specify special parameters implicitly (e.g. to reindexObject).
    tv = getTransactionalVariable()
197
    key = ('default_activate_parameter', id(aq_base(self)))
198 199 200 201 202 203 204 205 206 207
    tv[key] = kw

  security.declareProtected( permissions.View, 'getDefaultActivateParameterDict' )
  def getDefaultActivateParameterDict(self):
    # This method returns default activate parameters to self.
    # The result can be either a dict object or None.
    tv = getTransactionalVariable()
    key = ('default_activate_parameter', id(aq_base(self)))
    return tv.get(key)