ActivityTool.py 26.7 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.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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
import socket, asyncore, urllib
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30
from Products.CMFCore import CMFCorePermissions
31
from Products.ERP5Type.Document.Folder import Folder
32 33
from Products.ERP5Type.Utils import getPath
from Products.ERP5Type.Error import Error
34
from Products.PythonScripts.Utility import allow_class
35 36 37
from App.ApplicationManager import ApplicationManager
from AccessControl import ClassSecurityInfo, Permissions
from AccessControl.SecurityManagement import newSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from Products.CMFCore.utils import UniqueObject, _checkPermission, _getAuthenticatedUser
39
from Globals import InitializeClass, DTMLFile, get_request
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41
from Acquisition import aq_base
from DateTime.DateTime import DateTime
42
from Products.CMFActivity.ActiveObject import DISTRIBUTABLE_STATE, INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE
43
from ActivityBuffer import ActivityBuffer
44
from AccessControl.SecurityManagement import newSecurityManager
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45
import threading
46
import sys
47
from ZODB.POSException import ConflictError
48
from OFS.Traversable import NotFound
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49

50 51 52
from zLOG import LOG, INFO

try:
53
  from Products.TimerService import getTimerService
54
except ImportError:
55 56
  def getTimerService(self):
    pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59 60 61 62

# Using a RAM property (not a property of an instance) allows
# to prevent from storing a state in the ZODB (and allows to restart...)
active_threads = 0
max_active_threads = 1 # 2 will cause more bug to appear (he he)
is_initialized = 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63
tic_lock = threading.Lock() # A RAM based lock
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64 65 66 67 68 69 70 71

# Activity Registration
activity_dict = {}
activity_list = []

def registerActivity(activity):
  # Must be rewritten to register
  # class and create instance for each activity
72
  #LOG('Init Activity', 0, str(activity.__name__))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
73 74 75 76 77
  activity_instance = activity()
  activity_list.append(activity_instance)
  activity_dict[activity.__name__] = activity_instance

class Message:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
78

79
  def __init__(self, object, active_process, activity_kw, method_id, args, kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
80 81 82 83
    if type(object) is type('a'):
      self.object_path = object.split('/')
    else:
      self.object_path = object.getPhysicalPath()
84 85 86 87 88 89
    if type(active_process) is type('a'):
      self.active_process = active_process.split('/')
    elif active_process is None:
      self.active_process = None
    else:
      self.active_process = active_process.getPhysicalPath()
90
      self.active_process_uid = active_process.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91 92 93 94
    self.activity_kw = activity_kw
    self.method_id = method_id
    self.args = args
    self.kw = kw
Jean-Paul Smets's avatar
Jean-Paul Smets committed
95
    self.is_executed = 0
96
    self.user_name = str(_getAuthenticatedUser(self))
97
    self.object_list = None
98
    # Store REQUEST Info ?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
99

100 101 102 103
  def getObject(self, activity_tool):
    return activity_tool.unrestrictedTraverse(self.object_path)
    
  def getObjectList(self, activity_tool):
104
    if getattr(self, 'object_list', None) is None:
105 106 107 108 109 110 111
      try:
        expand_method_id = self.activity_kw['expand_method_id']
        obj = self.getObject(activity_tool)
        # FIXME: how to pass parameters?
        self.object_list = getattr(obj, expand_method_id)()
      except KeyError:
        self.object_list = [self.getObject(activity_tool)]
112
      
113
    return self.object_list
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
      
  def hasExpandMethod(self):
    return self.activity_kw.has_key('expand_method_id')
    
  def changeUser(self, user_name, activity_tool):
    uf = activity_tool.getPortalObject().acl_users
    user = uf.getUserById(user_name)
    if user is not None:
      user = user.__of__(uf)
      newSecurityManager(None, user)
    return user

  def activateResult(self, activity_tool, result, object):
    if self.active_process is not None:
      active_process = activity_tool.unrestrictedTraverse(self.active_process)
      if isinstance(result,Error):
        result.edit(object_path=object)
        result.edit(method_id=self.method_id)
        active_process.activateResult(result) # XXX Allow other method_id in future
      else:
        active_process.activateResult(Error(object_path=object,method_id=self.method_id,result=result)) # XXX Allow other method_id in future
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
136
  def __call__(self, activity_tool):
137
    try:
138 139
#       LOG('WARNING ActivityTool', 0,
#            'Trying to call method %s on object %s' % (self.method_id, self.object_path))
140
      object = self.getObject(activity_tool)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
141
      # Change user if required (TO BE DONE)
142 143
      # We will change the user only in order to execute this method
      current_user = str(_getAuthenticatedUser(self))
144
      user = self.changeUser(self.user_name, activity_tool)
145
      result = getattr(object, self.method_id)(*self.args, **self.kw)
146 147
      # Use again the previous user
      if user is not None:
148 149
        self.changeUser(current_user, activity_tool)
      self.activateResult(activity_tool, result, object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
150
      self.is_executed = 1
151 152
    except ConflictError:
      raise
153
    except:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154
      self.is_executed = 0
155 156
      LOG('WARNING ActivityTool', 0,
          'Could not call method %s on object %s' % (self.method_id, self.object_path), error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
157 158 159 160

  def validate(self, activity, activity_tool):
    return activity.validate(activity_tool, self, **self.activity_kw)

161
  def notifyUser(self, activity_tool, message="Failed Processing Activity"):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
162 163 164 165 166 167
    #LOG('notifyUser begin', 0, str(self.user_name))
    user_email = activity_tool.portal_membership.getMemberById(self.user_name).getProperty('email')
    if user_email in ('', None):
      user_email = activity_tool.email_from_address
    #LOG('notifyUser user_email', 0, str(user_email))
    mail_text = """From: %s
168 169 170 171 172 173 174 175 176
To: %s
Subject: %s

%s

Document: %s
Method: %s
    """ % (activity_tool.email_from_address, user_email,
           message, message, '/'.join(self.object_path), self.method_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
177 178 179
    #LOG('notifyUser mail_text', 0, str(mail_text))
    activity_tool.MailHost.send( mail_text )
    #LOG('notifyUser send', 0, '')
180

Jean-Paul Smets's avatar
Jean-Paul Smets committed
181 182
class Method:

183
  def __init__(self, passive_self, activity, active_process, kw, method_id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184 185
    self.__passive_self = passive_self
    self.__activity = activity
186
    self.__active_process = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
187 188 189 190
    self.__kw = kw
    self.__method_id = method_id

  def __call__(self, *args, **kw):
191
    m = Message(self.__passive_self, self.__active_process, self.__kw, self.__method_id, args, kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193
    activity_dict[self.__activity].queueMessage(self.__passive_self.portal_activities, m)

194 195
allow_class(Method)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
196 197
class ActiveWrapper:

198
  def __init__(self, passive_self, activity, active_process, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
199 200
    self.__dict__['__passive_self'] = passive_self
    self.__dict__['__activity'] = activity
201
    self.__dict__['__active_process'] = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204 205
    self.__dict__['__kw'] = kw

  def __getattr__(self, id):
    return Method(self.__dict__['__passive_self'], self.__dict__['__activity'],
206
                  self.__dict__['__active_process'],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
207 208
                  self.__dict__['__kw'], id)

209
class ActivityTool (Folder, UniqueObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
210
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
211 212 213 214 215 216 217 218 219 220 221 222
    ActivityTool is the central point for activity management.

    Improvement to consider to reduce locks:

      Idea 1: create an SQL tool which accumulate queries and executes them at the end of a transaction,
              thus allowing all SQL transaction to happen in a very short time
              (this would also be a great way of using MyISAM tables)

      Idea 2: do the same at the level of ActivityTool

      Idea 3: do the same at the level of each activity (ie. queueMessage
              accumulates and fires messages at the end of the transactino)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
223 224 225
    """
    id = 'portal_activities'
    meta_type = 'CMF Activity Tool'
226
    portal_type = 'Activity Tool'
227
    allowed_types = ( 'CMF Active Process', )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
228 229
    security = ClassSecurityInfo()

230 231 232
    _distributingNode = ''
    _nodes = ()

233 234
    manage_options = tuple(
                     [ { 'label' : 'Overview', 'action' : 'manage_overview' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
235
                     , { 'label' : 'Activities', 'action' : 'manageActivities' }
236
                     , { 'label' : 'LoadBalancing', 'action' : 'manageLoadBalancing'}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
237
                     ,
238
                     ] + list(Folder.manage_options))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239 240 241 242

    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageActivities' )
    manageActivities = DTMLFile( 'dtml/manageActivities', globals() )

243 244
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manage_overview' )
    manage_overview = DTMLFile( 'dtml/explainActivityTool', globals() )
245 246 247 248 249 250
    
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageLoadBalancing' )
    manageLoadBalancing = DTMLFile( 'dtml/manageLoadBalancing', globals() )
    
    distributingNode = ''
    _nodes = ()
251 252 253

    def __init__(self):
        return Folder.__init__(self, ActivityTool.id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
254

255 256 257 258 259 260 261 262 263 264
    # Filter content (ZMI))
    def filtered_meta_types(self, user=None):
        # Filters the list of available meta types.
        all = ActivityTool.inheritedAttribute('filtered_meta_types')(self)
        meta_types = []
        for meta_type in self.all_meta_types():
            if meta_type['name'] in self.allowed_types:
                meta_types.append(meta_type)
        return meta_types

Jean-Paul Smets's avatar
Jean-Paul Smets committed
265 266
    def initialize(self):
      global is_initialized
Sebastien Robin's avatar
Sebastien Robin committed
267
      from Activity import RAMQueue, RAMDict, SQLQueue, SQLDict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
268 269 270 271 272
      # Initialize each queue
      for activity in activity_list:
        activity.initialize(self)
      is_initialized = 1

273 274 275 276 277
    security.declareProtected(Permissions.manage_properties, 'subscribe')
    def subscribe(self):
        """ subscribe to the global Timer Service """
        service = getTimerService(self)
        if not service:
278 279
            LOG('ActivityTool', INFO, 'TimerService not available')
            return 
280 281 282 283 284 285 286 287 288

        service.subscribe(self)
        return "Subscribed to Timer Service"

    security.declareProtected(Permissions.manage_properties, 'unsubscribe')
    def unsubscribe(self):
        """ unsubscribe from the global Timer Service """
        service = getTimerService(self)
        if not service:
289 290
            LOG('ActivityTool', INFO, 'TimerService not available')
            return 
291 292

        service.unsubscribe(self)
293
        return "Unsubscribed from Timer Service"
294 295 296

    def manage_beforeDelete(self, item, container):
        self.unsubscribe()
297 298
        Folder.inheritedAttribute('manage_beforeDelete')(self, item, container)
    
299 300
    def manage_afterAdd(self, item, container):
        self.subscribe()
301 302
        Folder.inheritedAttribute('manage_afterAdd')(self, item, container)
       
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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    def getCurrentNode(self):
        """ Return current node in form ip:port """
        port = ''
        from asyncore import socket_map
        for k, v in socket_map.items():
            if hasattr(v, 'port'):
                # see Zope/lib/python/App/ApplicationManager.py: def getServers(self)
                type = str(getattr(v, '__class__', 'unknown'))
                if type == 'ZServer.HTTPServer.zhttp_server':
                    port = v.port
                    break
        ip = socket.gethostbyname(socket.gethostname())
        currentNode = '%s:%s' %(ip, port)
        return currentNode
        
    security.declarePublic('getDistributingNode')
    def getDistributingNode(self):
        """ Return the distributingNode """
        return self.distributingNode

    security.declarePublic('getNodeList')
    def getNodes(self):
        """ Return all nodes """
        return self._nodes

    security.declarePublic('manage_setDistributingNode')
    def manage_setDistributingNode(self, distributingNode, REQUEST=None):
        """ set the distributing node """
        self.distributingNode = distributingNode
        if REQUEST is not None:
            REQUEST.RESPONSE.redirect(
                REQUEST.URL1 +
                '/manageLoadBalancing?manage_tabs_message=' +
                urllib.quote("Distributing Node successfully changed."))
    
    security.declarePublic('manage_addNode')
    def manage_addNode(self, node, REQUEST=None):
        """ add a node """
        if node in self._nodes:
            if REQUEST is not None:
                REQUEST.RESPONSE.redirect(
                    REQUEST.URL1 +
                    '/manageLoadBalancing?manage_tabs_message=' +
                    urllib.quote("Node exists already."))
            return
            
        self._nodes = self._nodes + (node,)
        
        if REQUEST is not None:
            REQUEST.RESPONSE.redirect(
                REQUEST.URL1 +
                '/manageLoadBalancing?manage_tabs_message=' +
                urllib.quote("Node successfully added."))
                        
    security.declarePublic('manage_delNode')
    def manage_delNode(self, deleteNodes, REQUEST=None):
        """ delete nodes """
        nodeList = list(self._nodes)
        for node in deleteNodes:
            if node in self._nodes:
                nodeList.remove(node)
        self._nodes = tuple(nodeList)
        if REQUEST is not None:
            REQUEST.RESPONSE.redirect(
                REQUEST.URL1 +
                '/manageLoadBalancing?manage_tabs_message=' +
                urllib.quote("Node(s) successfully deleted."))
        
    def process_timer(self, tick, interval):
        """ 
        Call distribute() if we are the Distributing Node and call tic()
        with our node number.
        This method is called by TimerService in the interval given
        in zope.conf. The Default is every 5 seconds.
        """
        
        # get owner of portal_catalog, so normally we should be able to
        # have the permission to invoke all activities
        user = self.portal_catalog.getOwner()
        newSecurityManager(self.REQUEST, user)
        
        currentNode = self.getCurrentNode()
        
        # only distribute when we are the distributingNode or if it's empty
        if (self.distributingNode == self.getCurrentNode()):
            self.distribute(len(self._nodes))
            #LOG('CMFActivity:', INFO, 'self.distribute(node_count=%s)' %len(self._nodes))

        elif not self.distributingNode:
            self.distribute(1)
            #LOG('CMFActivity:', INFO, 'distributingNodes empty! Calling distribute(1)')
        
        # call tic for the current processing_node
        # the processing_node numbers are the indices of the elements in the node tuple +1
        # because processing_node starts form 1
        if currentNode in self._nodes:
            self.tic(list(self._nodes).index(currentNode)+1)
            #LOG('CMFActivity:', INFO, 'self.tic(processing_node=%s)' %str(list(self._nodes).index(currentNode)+1))
            
        elif len(self._nodes) == 0:
            self.tic(1)
            #LOG('CMFActivity:', INFO, 'Node List is empty! Calling tic(1)')


Jean-Paul Smets's avatar
Jean-Paul Smets committed
407 408 409 410 411 412 413 414 415 416
    security.declarePublic('distribute')
    def distribute(self, node_count=1):
      """
        Distribute load
      """
      # Initialize if needed
      if not is_initialized: self.initialize()

      # Call distribute on each queue
      for activity in activity_list:
417
        try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
418
          activity.distribute(self, node_count)
419 420
        except ConflictError:
          raise
421
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
422
          LOG('CMFActivity:', 100, 'Core call to distribute failed for activity %s' % activity, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
423

Jean-Paul Smets's avatar
Jean-Paul Smets committed
424
    security.declarePublic('tic')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
425
    def tic(self, processing_node=1, force=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
426 427
      """
        Starts again an activity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
428
        processing_node starts from 1 (there is not node 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
429 430 431 432
      """
      global active_threads, is_initialized

      # return if the number of threads is too high
433 434 435 436 437 438
      tic_lock.acquire()
      too_many_threads = (active_threads >= max_active_threads)
      tic_lock.release()
      if too_many_threads :
        if not force:
          raise RuntimeError, 'Too many threads'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
439

Jean-Paul Smets's avatar
Jean-Paul Smets committed
440
      if tic_lock is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
441 442 443 444 445 446
        return

      # Initialize if needed
      if not is_initialized: self.initialize()

      # increase the number of active_threads
Jean-Paul Smets's avatar
Jean-Paul Smets committed
447
      tic_lock.acquire()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448
      active_threads += 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
449
      tic_lock.release()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
450

451 452
      try:
        # Wakeup each queue
Jean-Paul Smets's avatar
Jean-Paul Smets committed
453
        for activity in activity_list:
454
          try:
455 456 457
            activity.wakeup(self, processing_node)
          except ConflictError:
            raise
458
          except:
459 460 461 462 463 464 465 466 467 468
            LOG('CMFActivity:', 100, 'Core call to wakeup failed for activity %s' % activity)
  
        # Process messages on each queue in round robin
        has_awake_activity = 1
        while has_awake_activity:
          has_awake_activity = 0
          for activity in activity_list:
            try:
              activity.tic(self, processing_node) # Transaction processing is the responsability of the activity
              has_awake_activity = has_awake_activity or activity.isAwake(self, processing_node)
469
              #LOG('ActivityTool tic', 0, 'has_awake_activity = %r, activity = %r, activity.isAwake(self, processing_node) = %r' % (has_awake_activity, activity, activity.isAwake(self, processing_node)))
470 471 472 473 474 475 476 477 478
            except ConflictError:
              raise
            except:
              LOG('CMFActivity:', 100, 'Core call to tic or isAwake failed for activity %s' % activity, error=sys.exc_info())
      finally:
        # decrease the number of active_threads
        tic_lock.acquire()
        active_threads -= 1
        tic_lock.release()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
479

480
    def hasActivity(self, *args, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
481
      # Check in each queue if the object has deferred tasks
482 483 484 485 486
      # if not argument is provided, then check on self
      if len(args) > 0:
        object = args[0]
      else:
        object = self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
487 488 489 490 491
      for activity in activity_list:
        if activity.hasActivity(self, object, **kw):
          return 1
      return 0

492
    def activate(self, object, activity, active_process, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
493 494
      global is_initialized
      if not is_initialized: self.initialize()
495
      if not hasattr(self, '_v_activity_buffer'): self._v_activity_buffer = ActivityBuffer()
496
      return ActiveWrapper(object, activity, active_process, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
497

498 499
    def deferredQueueMessage(self, activity, message):
      self._v_activity_buffer.deferredQueueMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
500

501
    def deferredDeleteMessage(self, activity, message):
502
      if not hasattr(self, '_v_activity_buffer'): self._v_activity_buffer = ActivityBuffer()
503
      self._v_activity_buffer.deferredDeleteMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
504

Jean-Paul Smets's avatar
Jean-Paul Smets committed
505
    def getRegisteredMessageList(self, activity):
506 507 508 509
      activity_buffer = getattr(self, '_v_activity_buffer', None)
      #if getattr(self, '_v_activity_buffer', None):
      if activity_buffer is not None:
        activity_buffer._register() # This is required if flush flush is called outside activate
510 511 512
        return activity.getRegisteredMessageList(self._v_activity_buffer, self)
      else:
        return []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
513

Jean-Paul Smets's avatar
Jean-Paul Smets committed
514
    def unregisterMessage(self, activity, message):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
515
      self._v_activity_buffer._register() # Required if called by flush, outside activate
Jean-Paul Smets's avatar
Jean-Paul Smets committed
516
      return activity.unregisterMessage(self._v_activity_buffer, self, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
517

Jean-Paul Smets's avatar
Jean-Paul Smets committed
518 519 520
    def flush(self, object, invoke=0, **kw):
      global is_initialized
      if not is_initialized: self.initialize()
521 522 523 524 525
      if not hasattr(self, '_v_activity_buffer'): self._v_activity_buffer = ActivityBuffer()
      if type(object) is type(()):
        object_path = object
      else:
        object_path = object.getPhysicalPath()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
526
      for activity in activity_list:
527
#         LOG('CMFActivity: ', 0, 'flushing activity %s' % activity.__class__.__name__)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
528 529
        activity.flush(self, object_path, invoke=invoke, **kw)

530 531 532 533
    def start(self, **kw):
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
534
#         LOG('CMFActivity: ', 0, 'starting activity %s' % activity.__class__.__name__)
535 536 537 538 539 540
        activity.start(self, **kw)

    def stop(self, **kw):
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
541
#         LOG('CMFActivity: ', 0, 'starting activity %s' % activity.__class__.__name__)
542 543
        activity.stop(self, **kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
544 545
    def invoke(self, message):
      message(self)
546 547 548 549 550 551 552 553 554 555 556 557
      
    def invokeGroup(self, method_id, message_list):
      # Invoke a group method.
      object_list = []
      expanded_object_list = []
      new_message_list = []
      path_dict = {}
      # Filter the list of messages. If an object is not available, ignore such a message.
      # In addition, expand an object if necessary, and make sure that no duplication happens.
      for m in message_list:
        try:
          obj = m.getObject(self)
558
          i = len(new_message_list) # This is an index of this message in new_message_list.
559
          if m.hasExpandMethod():
560 561
            for subobj in m.getObjectList(self):
              path = subobj.getPath()
562
              if path not in path_dict:
563 564
                path_dict[path] = i
                expanded_object_list.append(subobj)
565 566 567
          else:
            path = obj.getPath()
            if path not in path_dict:
568
              path_dict[path] = i
569
              expanded_object_list.append(obj)
570
          object_list.append(obj)
571 572 573 574 575 576 577 578 579 580 581 582 583
          new_message_list.append(m)
        except ConflictError:
          raise
        except:
          m.is_executed = 0
          LOG('WARNING ActivityTool', 0,
              'Could not call method %s on object %s' % (m.method_id, m.object_path), error=sys.exc_info())
              
      if len(expanded_object_list) > 0:
        try:
          method = self.unrestrictedTraverse(method_id)
          # FIXME: how to pass parameters?
          # FIXME: how to apply security here?
584 585
          # NOTE: expanded_object_list must be set to failed objects by the callee.
          #       If it fully succeeds, expanded_object_list must be empty when returning.
586 587 588 589
          result = method(expanded_object_list)
        except ConflictError:
          raise
        except:
590
          # In this case, the group method completely failed.
591 592 593 594 595
          for m in new_message_list:
            m.is_executed = 0
          LOG('WARNING ActivityTool', 0,
              'Could not call method %s on objects %s' % (method_id, expanded_object_list), error=sys.exc_info())
        else:
596 597 598 599 600 601 602 603
          # Obtain all indices of failed messages. Note that this can be a partial failure.
          failed_message_dict = {}
          for obj in expanded_object_list:
            path = obj.getPath()
            i = path_dict[path]
            failed_message_dict[i] = None
            
          # Only for succeeded messages, an activity process is invoked (if any).
604 605 606
          for i in xrange(len(object_list)):
            object = object_list[i]
            m = new_message_list[i]
607
            if i in failed_message_dict:
608
              m.is_executed = 0
609 610 611 612 613 614 615 616 617 618 619 620
              LOG('WARNING ActivityTool', 0, 
                  'the method %s partially failed on object %s' % (m.method_id, m.object_path,))
            else:
              try:
                m.activateResult(self, result, object)
                m.is_executed = 1
              except ConflictError:
                raise
              except:
                m.is_executed = 0
                LOG('WARNING ActivityTool', 0,
                    'Could not call method %s on object %s' % (m.method_id, m.object_path), error=sys.exc_info())
621
            
622 623
    def newMessage(self, activity, path, active_process, activity_kw, method_id, *args, **kw):
      # Some Security Cheking should be made here XXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
624 625
      global is_initialized
      if not is_initialized: self.initialize()
626
      if not hasattr(self, '_v_activity_buffer'): self._v_activity_buffer = ActivityBuffer()
627
      activity_dict[activity].queueMessage(self, Message(path, active_process, activity_kw, method_id, args, kw))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
628 629 630 631 632 633 634

    def manageInvoke(self, object_path, method_id, REQUEST=None):
      """
        Invokes all methods for object "object_path"
      """
      if type(object_path) is type(''):
        object_path = tuple(object_path.split('/'))
635
      self.flush(object_path,method_id=method_id,invoke=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
636 637 638 639 640 641 642 643 644
      if REQUEST is not None:
        return REQUEST.RESPONSE.redirect('%s/%s' % (self.absolute_url(), 'manageActivities'))

    def manageCancel(self, object_path, method_id, REQUEST=None):
      """
        Cancel all methods for object "object_path"
      """
      if type(object_path) is type(''):
        object_path = tuple(object_path.split('/'))
645
      self.flush(object_path,method_id=method_id,invoke=0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
646 647 648 649 650 651 652 653
      if REQUEST is not None:
        return REQUEST.RESPONSE.redirect('%s/%s' % (self.absolute_url(), 'manageActivities'))

    security.declarePublic('getMessageList')
    def getMessageList(self):
      """
        List messages waiting in queues
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
654 655 656
      # Initialize if needed
      if not is_initialized: self.initialize()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
657 658
      message_list = []
      for activity in activity_list:
Sebastien Robin's avatar
Sebastien Robin committed
659 660 661 662
        try:
          message_list += activity.getMessageList(self)
        except AttributeError:
          LOG('getMessageList, could not get message from Activity:',0,activity)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
663 664
      return message_list

665
    security.declareProtected( CMFCorePermissions.ManagePortal , 'newActiveProcess' )
666
    def newActiveProcess(self, **kw):
667 668 669
      from ActiveProcess import addActiveProcess
      new_id = str(self.generateNewId())
      addActiveProcess(self, new_id)
670 671 672
      active_process = self._getOb(new_id)
      active_process.edit(**kw)
      return active_process
673 674 675 676

    def reindexObject(self):
      self.immediateReindexObject()

677 678 679 680 681 682 683
    # Active synchronisation methods
    def validateOrder(self, message, validator_id, validation_value):
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
        method_id = "_validate_%s" % validator_id
        if hasattr(activity, method_id):
684
#           LOG('CMFActivity: ', 0, 'validateOrder calling method_id %s' % method_id)
685 686 687
          if getattr(activity,method_id)(self, message, validation_value):
            return 1
      return 0
688

Yoshinori Okuji's avatar
Yoshinori Okuji committed
689 690
    # Required for tests (time shift)
    def timeShift(self, delay):
691 692 693 694
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
        activity.timeShift(self, delay)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
695

696
InitializeClass(ActivityTool)