ActivityTool.py 36.9 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 30 31 32 33 34 35
import socket
import urllib
import threading
import sys
from types import TupleType, StringType
import re

Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.CMFCore import CMFCorePermissions
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from Products.ERP5Type.Core.Folder import Folder
38
from Products.CMFActivity.ActiveResult import ActiveResult
39
from Products.PythonScripts.Utility import allow_class
40
from AccessControl import ClassSecurityInfo, Permissions
Jérome Perrin's avatar
Jérome Perrin committed
41 42 43 44
from AccessControl.SecurityManagement import newSecurityManager
from AccessControl.SecurityManagement import noSecurityManager
from AccessControl.SecurityManagement import setSecurityManager
from AccessControl.SecurityManagement import getSecurityManager
45 46
from Products.CMFCore.utils import UniqueObject, _getAuthenticatedUser, getToolByName
from Globals import InitializeClass, DTMLFile
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47
from Acquisition import aq_base
48
from Acquisition import aq_inner
49
from Products.CMFActivity.ActiveObject import DISTRIBUTABLE_STATE, INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE
50
from ActivityBuffer import ActivityBuffer
51
from zExceptions import ExceptionFormatter
52

53
from ZODB.POSException import ConflictError
54
from Products.MailHost.MailHost import MailHostError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
55

56
from zLOG import LOG, INFO, WARNING
57 58

try:
59
  from Products.TimerService import getTimerService
60
except ImportError:
61 62
  def getTimerService(self):
    pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63

64
# minimal IP:Port regexp
65
NODE_RE = re.compile('^\d+\.\d+\.\d+\.\d+:\d+$')
66

Jean-Paul Smets's avatar
Jean-Paul Smets committed
67 68 69 70 71
# 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
72 73
tic_lock = threading.Lock() # A RAM based lock to prevent too many concurrent tic() calls
timerservice_lock = threading.Lock() # A RAM based lock to prevent TimerService spamming when busy
74
first_run = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75 76 77 78 79 80 81 82

# Activity Registration
activity_dict = {}
activity_list = []

def registerActivity(activity):
  # Must be rewritten to register
  # class and create instance for each activity
83
  #LOG('Init Activity', 0, str(activity.__name__))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
84 85 86 87 88
  activity_instance = activity()
  activity_list.append(activity_instance)
  activity_dict[activity.__name__] = activity_instance

class Message:
89
  """Activity Message Class.
90

91 92
  Message instances are stored in an activity queue, inside the Activity Tool.
  """
93 94 95
  def __init__(self, obj, active_process, activity_kw, method_id, args, kw):
    if isinstance(obj, str):
      self.object_path = obj.split('/')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96
    else:
97
      self.object_path = obj.getPhysicalPath()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
98
    if type(active_process) is StringType:
99 100 101 102 103
      self.active_process = active_process.split('/')
    elif active_process is None:
      self.active_process = None
    else:
      self.active_process = active_process.getPhysicalPath()
104
      self.active_process_uid = active_process.getUid()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
105 106 107 108
    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
109
    self.is_executed = 0
110
    self.exc_type = None
111
    self.processing = None
112 113
    self.user_name = str(_getAuthenticatedUser(self))
    # Store REQUEST Info ?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
114

115
  def getObject(self, activity_tool):
116
    """return the object referenced in this message."""
117
    return activity_tool.unrestrictedTraverse(self.object_path)
118

119
  def getObjectList(self, activity_tool):
120
    """return the list of object that can be expanded from this message."""
121 122 123 124 125 126 127
    try:
      expand_method_id = self.activity_kw['expand_method_id']
      obj = self.getObject(activity_tool)
      # FIXME: how to pass parameters?
      object_list = getattr(obj, expand_method_id)()
    except KeyError:
      object_list = [self.getObject(activity_tool)]
128

129
    return object_list
130

131
  def hasExpandMethod(self):
132 133 134 135 136
    """return true if the message has an expand method.
    An expand method is used to expand the list of objects and to turn a
    big recursive transaction affecting many objects into multiple
    transactions affecting only one object at a time (this can prevent
    duplicated method calls)."""
137
    return self.activity_kw.has_key('expand_method_id')
138

139
  def changeUser(self, user_name, activity_tool):
140
    """restore the security context for the calling user."""
141 142
    uf = activity_tool.getPortalObject().acl_users
    user = uf.getUserById(user_name)
143
    # if the user is not found, try to get it from a parent acl_users
144 145 146 147
    # XXX this is still far from perfect, because we need to store all
    # informations about the user (like original user folder, roles) to
    # replay the activity with exactly the same security context as if
    # it had been executed without activity.
148 149 150
    if user is None:
      uf = activity_tool.getPortalObject().aq_parent.acl_users
      user = uf.getUserById(user_name)
151 152 153
    if user is not None:
      user = user.__of__(uf)
      newSecurityManager(None, user)
154
    else :
155 156
      LOG("CMFActivity", WARNING,
          "Unable to find user %s in the portal" % user_name)
157
      noSecurityManager()
158 159 160 161 162
    return user

  def activateResult(self, activity_tool, result, object):
    if self.active_process is not None:
      active_process = activity_tool.unrestrictedTraverse(self.active_process)
163
      if isinstance(result,ActiveResult):
164 165
        result.edit(object_path=object)
        result.edit(method_id=self.method_id)
166 167
        # XXX Allow other method_id in future
        active_process.activateResult(result)
168
      else:
169
        active_process.activateResult(
170
                    ActiveResult(object_path=object,
171 172
                          method_id=self.method_id,
                          result=result)) # XXX Allow other method_id in future
173

Jean-Paul Smets's avatar
Jean-Paul Smets committed
174
  def __call__(self, activity_tool):
175
    try:
176
      obj = self.getObject(activity_tool)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
177
      # Change user if required (TO BE DONE)
178 179
      # We will change the user only in order to execute this method
      current_user = str(_getAuthenticatedUser(self))
180
      user = self.changeUser(self.user_name, activity_tool)
181 182 183 184 185 186 187
      try:
        result = getattr(obj, self.method_id)(*self.args, **self.kw)
      finally:
        # Use again the previous user
        if user is not None:
          self.changeUser(current_user, activity_tool)
      self.activateResult(activity_tool, result, obj)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
188
      self.is_executed = 1
189
    except:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190
      self.is_executed = 0
191
      self.exc_type = sys.exc_info()[0]
192
      self.exc_value = str(sys.exc_info()[1])
193 194
      self.traceback = ''.join(ExceptionFormatter.format_exception(
                               *sys.exc_info()))
195
      LOG('ActivityTool', WARNING,
196
          'Could not call method %s on object %s' % (
197
          self.method_id, self.object_path), error=sys.exc_info())
198 199 200
      # push the error in ZODB error_log
      if hasattr(activity_tool, 'error_log'):
        activity_tool.error_log.raising(sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201

202 203 204 205 206 207 208
  def validate(self, activity, activity_tool, check_order_validation=1):
    return activity.validate(activity_tool, self,
                             check_order_validation=check_order_validation,
                             **self.activity_kw)

  def getDependentMessageList(self, activity, activity_tool):
    return activity.getDependentMessageList(activity_tool, self, **self.activity_kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
209

210
  def notifyUser(self, activity_tool, message="Failed Processing Activity"):
211 212 213 214 215 216
    """Notify the user that the activity failed."""
    portal = activity_tool.getPortalObject()
    user_email = None
    user = portal.portal_membership.getMemberById(self.user_name)
    if user is not None:
      user_email = user.getProperty('email')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
217
    if user_email in ('', None):
218 219
      user_email = portal.getProperty('email_to_address',
                       portal.getProperty('email_from_address'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
220
    mail_text = """From: %s
221 222 223 224 225 226 227
To: %s
Subject: %s

%s

Document: %s
Method: %s
228
Exception: %s %s
229

230
%s
231
""" % (activity_tool.email_from_address, user_email, message,
232 233
       message, '/'.join(self.object_path), self.method_id,
       self.exc_type, self.exc_value, self.traceback)
234 235 236 237
    try:
      activity_tool.MailHost.send( mail_text )
    except (socket.error, MailHostError), message:
      LOG('ActivityTool.notifyUser', WARNING, 'Mail containing failure information failed to be sent: %s' % (message, ))
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  def reactivate(self, activity_tool):
    # Reactivate the original object.
    obj= self.getObject(activity_tool)
    # Change user if required (TO BE DONE)
    # We will change the user only in order to execute this method
    current_user = str(_getAuthenticatedUser(self))
    user = self.changeUser(self.user_name, activity_tool)
    try:
      active_obj = obj.activate(**self.activity_kw)
      getattr(active_obj, self.method_id)(*self.args, **self.kw)
    finally:
      # Use again the previous user
      if user is not None:
        self.changeUser(current_user, activity_tool)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
254 255
class Method:

256
  def __init__(self, passive_self, activity, active_process, kw, method_id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
257 258
    self.__passive_self = passive_self
    self.__activity = activity
259
    self.__active_process = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
260 261 262 263
    self.__kw = kw
    self.__method_id = method_id

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

267 268
allow_class(Method)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
269 270
class ActiveWrapper:

271
  def __init__(self, passive_self, activity, active_process, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272 273
    self.__dict__['__passive_self'] = passive_self
    self.__dict__['__activity'] = activity
274
    self.__dict__['__active_process'] = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
275 276 277 278
    self.__dict__['__kw'] = kw

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

282
class ActivityTool (Folder, UniqueObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
283
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
284 285 286 287 288 289 290 291 292 293 294 295
    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
296 297 298
    """
    id = 'portal_activities'
    meta_type = 'CMF Activity Tool'
299
    portal_type = 'Activity Tool'
300
    allowed_types = ( 'CMF Active Process', )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
301 302
    security = ClassSecurityInfo()

303 304 305
    _distributingNode = ''
    _nodes = ()

306 307
    manage_options = tuple(
                     [ { 'label' : 'Overview', 'action' : 'manage_overview' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
308
                     , { 'label' : 'Activities', 'action' : 'manageActivities' }
309
                     , { 'label' : 'LoadBalancing', 'action' : 'manageLoadBalancing'}
310
                     , { 'label' : 'Advanced', 'action' : 'manageActivitiesAdvanced' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
311
                     ,
312
                     ] + list(Folder.manage_options))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
313 314 315 316

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

317 318 319
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageActivitiesAdvanced' )
    manageActivitiesAdvanced = DTMLFile( 'dtml/manageActivitiesAdvanced', globals() )

320 321
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manage_overview' )
    manage_overview = DTMLFile( 'dtml/explainActivityTool', globals() )
322 323 324 325 326 327
    
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageLoadBalancing' )
    manageLoadBalancing = DTMLFile( 'dtml/manageLoadBalancing', globals() )
    
    distributingNode = ''
    _nodes = ()
328 329 330

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

332 333 334 335 336 337 338 339 340 341
    # 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
342 343
    def initialize(self):
      global is_initialized
Sebastien Robin's avatar
Sebastien Robin committed
344
      from Activity import RAMQueue, RAMDict, SQLQueue, SQLDict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
345 346 347 348
      # Initialize each queue
      for activity in activity_list:
        activity.initialize(self)
      is_initialized = 1
349 350 351
      
    security.declareProtected(Permissions.manage_properties, 'isSubscribed')
    def isSubscribed(self):
Aurel's avatar
Aurel committed
352
        """
353 354 355 356 357 358 359 360 361 362 363 364
        return True, if we are subscribed to TimerService.
        Otherwise return False.
        """
        service = getTimerService(self)
        if not service:
            LOG('ActivityTool', INFO, 'TimerService not available')
            return False
        
        path = '/'.join(self.getPhysicalPath())
        if path in service.lisSubscriptions():
            return True
        return False
Jean-Paul Smets's avatar
Jean-Paul Smets committed
365

366
    security.declareProtected(Permissions.manage_properties, 'subscribe')
367
    def subscribe(self, REQUEST=None, RESPONSE=None):
368 369
        """ subscribe to the global Timer Service """
        service = getTimerService(self)
370
        url = '%s/manageLoadBalancing?manage_tabs_message=' %self.absolute_url()
371
        if not service:
372
            LOG('ActivityTool', INFO, 'TimerService not available')
373 374 375 376
            url += urllib.quote('TimerService not available')
        else:
            service.subscribe(self)
            url += urllib.quote("Subscribed to Timer Service")
377 378
        if RESPONSE is not None:
            RESPONSE.redirect(url)
379 380

    security.declareProtected(Permissions.manage_properties, 'unsubscribe')
381
    def unsubscribe(self, REQUEST=None, RESPONSE=None):
382 383
        """ unsubscribe from the global Timer Service """
        service = getTimerService(self)
384
        url = '%s/manageLoadBalancing?manage_tabs_message=' %self.absolute_url()
385
        if not service:
386
            LOG('ActivityTool', INFO, 'TimerService not available')
387 388 389 390
            url += urllib.quote('TimerService not available')
        else:
            service.unsubscribe(self)
            url += urllib.quote("Unsubscribed from Timer Service")
391 392
        if RESPONSE is not None:
            RESPONSE.redirect(url)
393 394 395

    def manage_beforeDelete(self, item, container):
        self.unsubscribe()
396 397
        Folder.inheritedAttribute('manage_beforeDelete')(self, item, container)
    
398 399
    def manage_afterAdd(self, item, container):
        self.subscribe()
400 401
        Folder.inheritedAttribute('manage_afterAdd')(self, item, container)
       
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
    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

422
    security.declarePublic('getNodeList getNodes')
423 424 425
    def getNodes(self):
        """ Return all nodes """
        return self._nodes
426
    getNodeList = getNodes
427

428 429 430 431
    def _isValidNodeName(self, node_name) :
      """Check we have been provided a good node name"""
      return isinstance(node_name, str) and NODE_RE.match(node_name)
      
432 433
    security.declarePublic('manage_setDistributingNode')
    def manage_setDistributingNode(self, distributingNode, REQUEST=None):
434
        """ set the distributing node """   
435
        if not distributingNode or self._isValidNodeName(distributingNode):
436 437 438 439 440 441 442 443 444 445 446 447 448
          self.distributingNode = distributingNode
          if REQUEST is not None:
              REQUEST.RESPONSE.redirect(
                  REQUEST.URL1 +
                  '/manageLoadBalancing?manage_tabs_message=' +
                  urllib.quote("Distributing Node successfully changed."))
        else :
          if REQUEST is not None:
              REQUEST.RESPONSE.redirect(
                  REQUEST.URL1 +
                  '/manageLoadBalancing?manage_tabs_message=' +
                  urllib.quote("Malformed Distributing Node."))

449 450 451
    security.declarePublic('manage_addNode')
    def manage_addNode(self, node, REQUEST=None):
        """ add a node """
452 453 454 455 456 457 458 459
        if not self._isValidNodeName(node) :
            if REQUEST is not None:
                REQUEST.RESPONSE.redirect(
                    REQUEST.URL1 +
                    '/manageLoadBalancing?manage_tabs_message=' +
                    urllib.quote("Malformed node."))
            return
        
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
        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."))
489

490
    def process_timer(self, tick, interval, prev="", next=""):
491
        """
492 493 494 495 496
        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.
        """
497 498 499 500
        # Prevent TimerService from starting multiple threads in parallel
        acquired = timerservice_lock.acquire(0)
        if not acquired:
          return
501

Jérome Perrin's avatar
Jérome Perrin committed
502
        old_sm = getSecurityManager()
503 504 505
        try:
          # get owner of portal_catalog, so normally we should be able to
          # have the permission to invoke all activities
Jérome Perrin's avatar
Jérome Perrin committed
506
          user = self.portal_catalog.getWrappedOwner()
507
          newSecurityManager(self.REQUEST, user)
508

509
          currentNode = self.getCurrentNode()
510

511
          # only distribute when we are the distributingNode or if it's empty
512
          if (self.distributingNode == currentNode):
Jérome Perrin's avatar
Jérome Perrin committed
513
            self.distribute(len(self._nodes))
514 515

          elif not self.distributingNode:
Jérome Perrin's avatar
Jérome Perrin committed
516
            self.distribute(1)
517

518 519 520 521 522 523 524
          # SkinsTool uses a REQUEST cache to store skin objects, as
          # with TimerService we have the same REQUEST over multiple
          # portals, we clear this cache to make sure the cache doesn't
          # contains skins from another portal.
          stool = getToolByName(self, 'portal_skins', None)
          if stool is not None:
            stool.changeSkin(None)
525

526 527 528 529
          # 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:
Jérome Perrin's avatar
Jérome Perrin committed
530
            self.tic(list(self._nodes).index(currentNode)+1)
531

532
          elif len(self._nodes) == 0:
Jérome Perrin's avatar
Jérome Perrin committed
533
            self.tic(1)
534

Jérome Perrin's avatar
Jérome Perrin committed
535
        finally:
536
          timerservice_lock.release()
Jérome Perrin's avatar
Jérome Perrin committed
537
          setSecurityManager(old_sm)
538

Jean-Paul Smets's avatar
Jean-Paul Smets committed
539 540 541 542 543 544
    security.declarePublic('distribute')
    def distribute(self, node_count=1):
      """
        Distribute load
      """
      # Initialize if needed
545
      global is_initialized
Jean-Paul Smets's avatar
Jean-Paul Smets committed
546 547 548 549
      if not is_initialized: self.initialize()

      # Call distribute on each queue
      for activity in activity_list:
550
        try:
551
          activity.distribute(aq_inner(self), node_count)
552 553
        except ConflictError:
          raise
554
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
555
          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
556

Jean-Paul Smets's avatar
Jean-Paul Smets committed
557
    security.declarePublic('tic')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
558
    def tic(self, processing_node=1, force=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
559 560
      """
        Starts again an activity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
561
        processing_node starts from 1 (there is not node 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
562
      """
563
      global active_threads, is_initialized, first_run
Jean-Paul Smets's avatar
Jean-Paul Smets committed
564 565

      # return if the number of threads is too high
566
      # else, increase the number of active_threads and continue
567 568
      tic_lock.acquire()
      too_many_threads = (active_threads >= max_active_threads)
569
      if not too_many_threads or force:
570
        active_threads += 1
571 572 573
      else:
        tic_lock.release()
        raise RuntimeError, 'Too many threads'
574
      tic_lock.release()
575

Jean-Paul Smets's avatar
Jean-Paul Smets committed
576 577
      # Initialize if needed
      if not is_initialized: self.initialize()
578

579
      inner_self = aq_inner(self)
580

581 582 583
      # If this is the first tic after zope is started, reset the processing
      # flag for activities of this node
      if first_run:
584 585 586 587
        inner_self.SQLDict_clearProcessingFlag(
                                processing_node=processing_node)
        inner_self.SQLQueue_clearProcessingFlag(
                                processing_node=processing_node)
588 589
        first_run = 0

590 591
      try:
        # Wakeup each queue
Jean-Paul Smets's avatar
Jean-Paul Smets committed
592
        for activity in activity_list:
593
          try:
594
            activity.wakeup(inner_self, processing_node)
595 596
          except ConflictError:
            raise
597
          except:
598
            LOG('CMFActivity:', 100, 'Core call to wakeup failed for activity %s' % activity)
599

600 601 602 603 604 605
        # 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:
606 607
              activity.tic(inner_self, processing_node) # Transaction processing is the responsability of the activity
              has_awake_activity = has_awake_activity or activity.isAwake(inner_self, processing_node)
608 609 610 611 612 613 614 615 616
            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
617

618
    def hasActivity(self, *args, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
619
      # Check in each queue if the object has deferred tasks
620 621
      # if not argument is provided, then check on self
      if len(args) > 0:
622
        obj = args[0]
623
      else:
624
        obj = self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
625
      for activity in activity_list:
626
        if activity.hasActivity(aq_inner(self), obj, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
627 628 629
          return 1
      return 0

630 631
    security.declarePrivate('activateObject')
    def activateObject(self, object, activity, active_process, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
632 633
      global is_initialized
      if not is_initialized: self.initialize()
634
      if getattr(self, '_v_activity_buffer', None) is None:
635
        self._v_activity_buffer = ActivityBuffer(activity_tool=self)
636
      return ActiveWrapper(object, activity, active_process, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
637

638 639
    def deferredQueueMessage(self, activity, message):
      self._v_activity_buffer.deferredQueueMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
640

641
    def deferredDeleteMessage(self, activity, message):
642
      if getattr(self, '_v_activity_buffer', None) is None:
643
        self._v_activity_buffer = ActivityBuffer(activity_tool=self)
644
      self._v_activity_buffer.deferredDeleteMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
645

Jean-Paul Smets's avatar
Jean-Paul Smets committed
646
    def getRegisteredMessageList(self, activity):
647 648 649
      activity_buffer = 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
650 651
        return activity.getRegisteredMessageList(self._v_activity_buffer,
                                                 aq_inner(self))
652 653
      else:
        return []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
654

Jean-Paul Smets's avatar
Jean-Paul Smets committed
655
    def unregisterMessage(self, activity, message):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
656
      self._v_activity_buffer._register() # Required if called by flush, outside activate
657
      return activity.unregisterMessage(self._v_activity_buffer, aq_inner(self), message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
658

659
    def flush(self, obj, invoke=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
660 661
      global is_initialized
      if not is_initialized: self.initialize()
662
      if getattr(self, '_v_activity_buffer', None) is None:
663
        self._v_activity_buffer = ActivityBuffer(activity_tool=self)
664 665
      if isinstance(obj, tuple):
        object_path = obj
666
      else:
667
        object_path = obj.getPhysicalPath()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
668
      for activity in activity_list:
669
        activity.flush(aq_inner(self), object_path, invoke=invoke, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
670

671 672 673 674
    def start(self, **kw):
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
675
        activity.start(aq_inner(self), **kw)
676 677 678 679 680

    def stop(self, **kw):
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
681
        activity.stop(aq_inner(self), **kw)
682

Jean-Paul Smets's avatar
Jean-Paul Smets committed
683 684
    def invoke(self, message):
      message(self)
685

686 687 688 689 690 691 692 693 694
    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:
695 696
        # alternate method is used to segregate objects which cannot be grouped.
        alternate_method_id = m.activity_kw.get('alternate_method_id')
697 698
        try:
          obj = m.getObject(self)
699
          i = len(new_message_list) # This is an index of this message in new_message_list.
700
          if m.hasExpandMethod():
701 702
            for subobj in m.getObjectList(self):
              path = subobj.getPath()
703
              if path not in path_dict:
704
                path_dict[path] = i
705 706 707 708 709 710
                if alternate_method_id is not None \
                   and hasattr(aq_base(subobj), alternate_method_id):
                  # if this object is alternated, generate a new single active object.
                  activity_kw = m.activity_kw.copy()
                  if 'group_method_id' in activity_kw:
                    del activity_kw['group_method_id']
711 712
                  if 'group_id' in activity_kw:
                    del activity_kw['group_id']                    
713 714 715 716
                  active_obj = subobj.activate(**activity_kw)
                  getattr(active_obj, alternate_method_id)(*m.args, **m.kw)
                else:
                  expanded_object_list.append(subobj)
717 718 719
          else:
            path = obj.getPath()
            if path not in path_dict:
720
              path_dict[path] = i
721 722 723 724 725 726 727 728 729 730
              if alternate_method_id is not None \
                  and hasattr(aq_base(obj), alternate_method_id):
                # if this object is alternated, generate a new single active object.
                activity_kw = m.activity_kw.copy()
                if 'group_method_id' in activity_kw:
                  del activity_kw['group_method_id']
                active_obj = obj.activate(**activity_kw)
                getattr(active_obj, alternate_method_id)(*m.args, **m.kw)
              else:
                expanded_object_list.append(obj)
731
          object_list.append(obj)
732 733 734
          new_message_list.append(m)
        except:
          m.is_executed = 0
735
          m.exc_type = sys.exc_info()[0]
736
          LOG('WARNING ActivityTool', 0,
737 738
              'Could not call method %s on object %s' %
              (m.method_id, m.object_path), error=sys.exc_info())
739

740 741
      try:
        if len(expanded_object_list) > 0:
742 743
          method = self.unrestrictedTraverse(method_id)
          # FIXME: how to apply security here?
744 745
          # 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.
746
          result = method(expanded_object_list, **m.kw)
747
        else:
748 749 750 751 752 753 754
          result = None
      except:
        # In this case, the group method completely failed.
        for m in new_message_list:
          m.is_executed = 0
          m.exc_type = sys.exc_info()[0]
        LOG('WARNING ActivityTool', 0,
755 756
            'Could not call method %s on objects %s' %
            (method_id, expanded_object_list), error=sys.exc_info())
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
      else:
        # 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).
        for i in xrange(len(object_list)):
          object = object_list[i]
          m = new_message_list[i]
          if i in failed_message_dict:
            m.is_executed = 0
            LOG('ActivityTool', WARNING,
772 773
                'the method %s partially failed on object %s' %
                (m.method_id, m.object_path,))
774 775 776 777 778
          else:
            try:
              m.activateResult(self, result, object)
              m.is_executed = 1
            except:
779
              m.is_executed = 0
780
              m.exc_type = sys.exc_info()[0]
781
              LOG('ActivityTool', WARNING,
782 783
                  'Could not call method %s on object %s' % (
                  m.method_id, m.object_path), error=sys.exc_info())
784

785 786
    def newMessage(self, activity, path, active_process,
                   activity_kw, method_id, *args, **kw):
787
      # Some Security Cheking should be made here XXX
Jean-Paul Smets's avatar
Jean-Paul Smets committed
788 789
      global is_initialized
      if not is_initialized: self.initialize()
790
      if getattr(self, '_v_activity_buffer', None) is None:
791
        self._v_activity_buffer = ActivityBuffer(activity_tool=self)
792
      activity_dict[activity].queueMessage(aq_inner(self),
793
        Message(path, active_process, activity_kw, method_id, args, kw))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
794

795
    security.declareProtected( CMFCorePermissions.ManagePortal, 'manageInvoke' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
796 797 798 799 800 801
    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('/'))
802
      self.flush(object_path,method_id=method_id,invoke=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
803
      if REQUEST is not None:
804 805
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manageActivities'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
806

807
    security.declareProtected( CMFCorePermissions.ManagePortal, 'manageCancel' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
808 809 810 811 812 813
    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('/'))
814
      self.flush(object_path,method_id=method_id,invoke=0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
815
      if REQUEST is not None:
816 817
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manageActivities'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
818

819 820
    security.declareProtected( CMFCorePermissions.ManagePortal,
                               'manageClearActivities' )
821
    def manageClearActivities(self, keep=1, REQUEST=None):
822 823 824 825 826
      """
        Clear all activities and recreate tables.
      """
      folder = getToolByName(self, 'portal_skins').activity

827 828
      # Obtain all pending messages.
      message_list = []
829 830 831 832 833 834 835 836
      if keep:
        for activity in activity_list:
          if hasattr(activity, 'dumpMessageList'):
            try:
              message_list.extend(activity.dumpMessageList(self))
            except ConflictError:
              raise
            except:
837 838 839
              LOG('ActivityTool', WARNING,
                  'could not dump messages from %s' %
                  (activity,), error=sys.exc_info())
840 841

      if getattr(folder, 'SQLDict_createMessageTable', None) is not None:
842 843 844 845 846
        try:
          folder.SQLDict_dropMessageTable()
        except ConflictError:
          raise
        except:
847
          LOG('CMFActivity', WARNING,
848
              'could not drop the message table',
849 850 851
              error=sys.exc_info())
        folder.SQLDict_createMessageTable()

852
      if getattr(folder, 'SQLQueue_createMessageTable', None) is not None:
853 854 855 856 857
        try:
          folder.SQLQueue_dropMessageTable()
        except ConflictError:
          raise
        except:
858
          LOG('CMFActivity', WARNING,
859
              'could not drop the message queue table',
860 861 862
              error=sys.exc_info())
        folder.SQLQueue_createMessageTable()

863 864 865
      # Reactivate the messages.
      for m in message_list:
        try:
866
          m.reactivate(aq_inner(self))
867 868 869 870
        except ConflictError:
          raise
        except:
          LOG('ActivityTool', WARNING,
871 872
              'could not reactivate the message %r, %r' %
              (m.object_path, m.method_id), error=sys.exc_info())
873

874
      if REQUEST is not None:
875 876
        return REQUEST.RESPONSE.redirect('%s/%s' % (self.absolute_url(),
          'manageActivitiesAdvanced?manage_tabs_message=Activities%20Cleared'))
877

Jean-Paul Smets's avatar
Jean-Paul Smets committed
878
    security.declarePublic('getMessageList')
879
    def getMessageList(self,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
880 881 882
      """
        List messages waiting in queues
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
883 884 885
      # Initialize if needed
      if not is_initialized: self.initialize()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
886 887
      message_list = []
      for activity in activity_list:
Sebastien Robin's avatar
Sebastien Robin committed
888
        try:
889
          message_list += activity.getMessageList(aq_inner(self),**kw)
Sebastien Robin's avatar
Sebastien Robin committed
890 891
        except AttributeError:
          LOG('getMessageList, could not get message from Activity:',0,activity)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
892 893
      return message_list

894 895 896 897 898 899 900
    security.declarePublic('countMessageWithTag')
    def countMessageWithTag(self, value):
      """
        Return the number of messages which match the given tag.
      """
      message_count = 0
      for activity in activity_list:
901
        message_count += activity.countMessageWithTag(aq_inner(self), value)
Sebastien Robin's avatar
Sebastien Robin committed
902 903 904 905 906 907 908 909 910 911
      return message_count

    security.declarePublic('countMessage')
    def countMessage(self, **kw):
      """
        Return the number of messages which match the given parameter.

        Parameters allowed:

        method_id : the id of the method
Jérome Perrin's avatar
Jérome Perrin committed
912
        path : for activities on a particular object
Sebastien Robin's avatar
Sebastien Robin committed
913 914 915 916 917
        tag : activities with a particular tag
        message_uid : activities with a particular uid
      """
      message_count = 0
      for activity in activity_list:
918
        message_count += activity.countMessage(aq_inner(self), **kw)
919 920
      return message_count

921
    security.declareProtected( CMFCorePermissions.ManagePortal , 'newActiveProcess' )
922
    def newActiveProcess(self, **kw):
923 924 925
      from ActiveProcess import addActiveProcess
      new_id = str(self.generateNewId())
      addActiveProcess(self, new_id)
926 927 928
      active_process = self._getOb(new_id)
      active_process.edit(**kw)
      return active_process
929 930 931 932

    def reindexObject(self):
      self.immediateReindexObject()

933
    # Active synchronisation methods
934
    security.declarePrivate('validateOrder')
935
    def validateOrder(self, message, validator_id, validation_value):
936 937 938 939 940
      message_list = self.getDependentMessageList(message, validator_id, validation_value)
      return len(message_list) > 0

    security.declarePrivate('getDependentMessageList')
    def getDependentMessageList(self, message, validator_id, validation_value):
941 942
      global is_initialized
      if not is_initialized: self.initialize()
943
      message_list = []
Vincent Pelletier's avatar
Vincent Pelletier committed
944
      method_id = "_validate_%s" % validator_id
945
      for activity in activity_list:
946 947 948 949 950 951
        method = getattr(activity, method_id, None)
        if method is not None:
          result = method(aq_inner(self), message, validation_value)
          if result:
            message_list.extend([(activity, m) for m in result])
      return message_list
952

Yoshinori Okuji's avatar
Yoshinori Okuji committed
953 954
    # Required for tests (time shift)
    def timeShift(self, delay):
955 956 957
      global is_initialized
      if not is_initialized: self.initialize()
      for activity in activity_list:
958
        activity.timeShift(aq_inner(self), delay)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
959

960
InitializeClass(ActivityTool)