ActivityTool.py 48.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 30 31 32
import socket
import urllib
import threading
import sys
Vincent Pelletier's avatar
Vincent Pelletier committed
33
from types import StringType
34 35
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 ActivityBuffer import ActivityBuffer
50
from zExceptions import ExceptionFormatter
51
from BTrees.OIBTree import OIBTree
52
from Products import iHotfix
53

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

57
from zLOG import LOG, INFO, WARNING, ERROR
58
from warnings import warn
59 60

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

66 67 68 69 70
try:
  from traceback import format_list, extract_stack
except ImportError:
  format_list = extract_stack = None

71
# minimal IP:Port regexp
72
NODE_RE = re.compile('^\d+\.\d+\.\d+\.\d+:\d+$')
73

Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76 77
# 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)
Vincent Pelletier's avatar
Vincent Pelletier committed
78
is_initialized = False
79 80
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
81
is_running_lock = threading.Lock()
82
first_run = True
83 84 85
currentNode = None
ROLE_IDLE = 0
ROLE_PROCESSING = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
86 87 88 89

# Activity Registration
activity_dict = {}

90
logging = False
91 92 93 94 95 96 97 98 99

def enableLogging():
  global logging
  logging = True

def disableLogging():
  global logging
  logging = False

100 101 102 103 104 105 106 107
activity_creation_trace = False

def enableActivityCreationTrace():
  global activity_creation_trace
  activity_creation_trace = True

def disableActivityCreationTrace():
  global activity_creation_trace
Vincent Pelletier's avatar
Vincent Pelletier committed
108
  activity_creation_trace = False
109

110 111 112 113 114 115 116
# Here go ActivityBuffer instances
# Structure:
#  global_activity_buffer[activity_tool_path][thread_id] = ActivityBuffer
global_activity_buffer = {}
from thread import get_ident, allocate_lock
global_activity_buffer_lock = allocate_lock()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
117 118 119
def registerActivity(activity):
  # Must be rewritten to register
  # class and create instance for each activity
120
  #LOG('Init Activity', 0, str(activity.__name__))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
121 122 123
  activity_instance = activity()
  activity_dict[activity.__name__] = activity_instance

124 125 126 127
MESSAGE_NOT_EXECUTED = 0
MESSAGE_EXECUTED = 1
MESSAGE_NOT_EXECUTABLE = 2

Jean-Paul Smets's avatar
Jean-Paul Smets committed
128
class Message:
129
  """Activity Message Class.
130

131 132
  Message instances are stored in an activity queue, inside the Activity Tool.
  """
133 134
  def __init__(self, obj, active_process, activity_kw, method_id, args, kw):
    if isinstance(obj, str):
135
      self.object_path = tuple(obj.split('/'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
136
    else:
137
      self.object_path = obj.getPhysicalPath()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
138
    if type(active_process) is StringType:
139 140 141 142 143
      self.active_process = active_process.split('/')
    elif active_process is None:
      self.active_process = None
    else:
      self.active_process = active_process.getPhysicalPath()
144
      self.active_process_uid = active_process.getUid()
145 146 147
    if activity_kw.get('serialization_tag', False) is None:
      # Remove serialization_tag if it's None.
      del activity_kw['serialization_tag']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148 149 150 151
    self.activity_kw = activity_kw
    self.method_id = method_id
    self.args = args
    self.kw = kw
152
    self.is_executed = MESSAGE_NOT_EXECUTED
Vincent Pelletier's avatar
Vincent Pelletier committed
153 154 155
    self.exc_type = None
    self.exc_value = None
    self.traceback = None
156
    if activity_creation_trace and format_list is not None:
157 158 159 160
      # Save current traceback, to make it possible to tell where a message
      # was generated.
      # Strip last stack entry, since it will always be the same.
      self.call_traceback = ''.join(format_list(extract_stack()[:-1]))
161 162
    else:
      self.call_traceback = None
163
    self.processing = None
164
    self.user_name = str(_getAuthenticatedUser(self))
165
    # Store REQUEST Info
166
    self.request_info = {}
167 168
    request = getattr(obj, 'REQUEST', None)
    if request is not None:
169 170 171 172 173 174 175 176 177
      if 'SERVER_URL' in request.other:
        self.request_info['SERVER_URL'] = request.other['SERVER_URL']
      if 'VirtualRootPhysicalPath' in request.other:
        self.request_info['VirtualRootPhysicalPath'] = \
          request.other['VirtualRootPhysicalPath']
      if 'HTTP_ACCEPT_LANGUAGE' in request.environ:
        self.request_info['HTTP_ACCEPT_LANGUAGE'] = \
          request.environ['HTTP_ACCEPT_LANGUAGE']
      self.request_info['_script'] = list(request._script)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178

179
  def getObject(self, activity_tool):
180
    """return the object referenced in this message."""
181
    return activity_tool.unrestrictedTraverse(self.object_path)
182

183
  def getObjectList(self, activity_tool):
184
    """return the list of object that can be expanded from this message."""
185
    object_list = []
186
    try:
187
      object_list.append(self.getObject(activity_tool))
188
    except KeyError:
189 190 191 192 193 194
      pass
    else:
      if self.hasExpandMethod():
        expand_method_id = self.activity_kw['expand_method_id']
        # FIXME: how to pass parameters?
        object_list = getattr(object_list[0], expand_method_id)()
195
    return object_list
196

197
  def hasExpandMethod(self):
198 199 200 201 202
    """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)."""
203
    return self.activity_kw.has_key('expand_method_id')
204

205
  def changeUser(self, user_name, activity_tool):
206
    """restore the security context for the calling user."""
207 208
    uf = activity_tool.getPortalObject().acl_users
    user = uf.getUserById(user_name)
209
    # if the user is not found, try to get it from a parent acl_users
210 211 212 213
    # 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.
214 215 216
    if user is None:
      uf = activity_tool.getPortalObject().aq_parent.acl_users
      user = uf.getUserById(user_name)
217 218 219
    if user is not None:
      user = user.__of__(uf)
      newSecurityManager(None, user)
220
    else :
221 222
      LOG("CMFActivity", WARNING,
          "Unable to find user %s in the portal" % user_name)
223
      noSecurityManager()
224 225 226 227 228
    return user

  def activateResult(self, activity_tool, result, object):
    if self.active_process is not None:
      active_process = activity_tool.unrestrictedTraverse(self.active_process)
229
      if isinstance(result, ActiveResult):
230 231
        result.edit(object_path=object)
        result.edit(method_id=self.method_id)
232 233
        # XXX Allow other method_id in future
        active_process.activateResult(result)
234
      else:
235
        active_process.activateResult(
236
                    ActiveResult(object_path=object,
237 238
                                 method_id=self.method_id,
                                 result=result)) # XXX Allow other method_id in future
239

Jean-Paul Smets's avatar
Jean-Paul Smets committed
240
  def __call__(self, activity_tool):
241
    try:
242
      obj = self.getObject(activity_tool)
243 244 245
    except KeyError:
      self.is_executed = MESSAGE_NOT_EXECUTABLE
    else:
246
      try:
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
        old_security_manager = getSecurityManager()
        # Change user if required (TO BE DONE)
        # We will change the user only in order to execute this method
        user = self.changeUser(self.user_name, activity_tool)
        # XXX: There is no check to see if user is allowed to access
        # that method !
        method = getattr(obj, self.method_id, None)
        try:
          if method is None:
            self.is_executed = MESSAGE_NOT_EXECUTABLE
          else:
            result = method(*self.args, **self.kw)
        finally:
          setSecurityManager(old_security_manager)

        if method is not None:
          self.activateResult(activity_tool, result, obj)
          self.is_executed = MESSAGE_EXECUTED
      except:
        self.is_executed = MESSAGE_NOT_EXECUTED
        exc_info = sys.exc_info()
        LOG('ActivityTool', WARNING,
269 270
            'Could not call method %s on object %s. Activity created at:\n%s' % (
            self.method_id, self.object_path, self.call_traceback), error=exc_info)
271 272 273
        # push the error in ZODB error_log
        if getattr(activity_tool, 'error_log', None) is not None:
          activity_tool.error_log.raising(exc_info)
274 275 276 277
        self.exc_type = exc_info[0]
        self.exc_value = str(exc_info[1])
        self.traceback = ''.join(ExceptionFormatter.format_exception(
                                 *exc_info))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
278

279 280 281 282 283 284 285
  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
286

287
  def notifyUser(self, activity_tool, message="Failed Processing Activity"):
288 289
    """Notify the user that the activity failed."""
    portal = activity_tool.getPortalObject()
290
    user_email = portal.getProperty('email_to_address',
291
                       portal.getProperty('email_from_address'))
292 293 294 295 296

    call_traceback = ''
    if self.call_traceback:
      call_traceback = 'Created at:\n%s' % self.call_traceback

Jean-Paul Smets's avatar
Jean-Paul Smets committed
297
    mail_text = """From: %s
298 299 300 301 302
To: %s
Subject: %s

%s

303
Server: %s
304 305
Document: %s
Method: %s
306 307
Arguments: %r
Named Parameters: %r
308 309
%s

Vincent Pelletier's avatar
Vincent Pelletier committed
310
Exception: %s %s
311

312
%s
313 314 315
""" % (activity_tool.email_from_address, user_email, message, message,
       self.request_info.get('SERVER_URL', ''),
       '/'.join(self.object_path), self.method_id, self.args, self.kw,
316
       call_traceback, self.exc_type, self.exc_value, self.traceback)
317 318
    try:
      activity_tool.MailHost.send( mail_text )
Vincent Pelletier's avatar
Vincent Pelletier committed
319 320
    except (socket.error, MailHostError), message:
      LOG('ActivityTool.notifyUser', WARNING, 'Mail containing failure information failed to be sent: %s. Exception was: %s %s\n%s' % (message, self.exc_type, self.exc_value, self.traceback))
321

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  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
337 338
class Method:

339
  def __init__(self, passive_self, activity, active_process, kw, method_id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
340 341
    self.__passive_self = passive_self
    self.__activity = activity
342
    self.__active_process = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
343 344 345 346
    self.__kw = kw
    self.__method_id = method_id

  def __call__(self, *args, **kw):
347
    m = Message(self.__passive_self, self.__active_process, self.__kw, self.__method_id, args, kw)
348
    if logging:
349
      LOG('Activity Tracking', INFO, 'queuing message: activity=%s, object_path=%s, method_id=%s, args=%s, kw=%s, activity_kw=%s, user_name=%s' % (self.__activity, '/'.join(m.object_path), m.method_id, m.args, m.kw, m.activity_kw, m.user_name))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
350 351
    activity_dict[self.__activity].queueMessage(self.__passive_self.portal_activities, m)

352 353
allow_class(Method)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
354 355
class ActiveWrapper:

356
  def __init__(self, passive_self, activity, active_process, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
357 358
    self.__dict__['__passive_self'] = passive_self
    self.__dict__['__activity'] = activity
359
    self.__dict__['__active_process'] = active_process
Jean-Paul Smets's avatar
Jean-Paul Smets committed
360 361 362 363
    self.__dict__['__kw'] = kw

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

367 368 369 370 371 372 373
# Set to False when shutting down. Access outside of process_shutdown must
# be done under the protection of is_running_lock lock.
is_running = True
# True when activities cannot be executing any more.
has_processed_shutdown = False


374
class ActivityTool (Folder, UniqueObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
376 377 378 379 380 381 382 383 384 385 386 387
    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
388 389 390
    """
    id = 'portal_activities'
    meta_type = 'CMF Activity Tool'
391
    portal_type = 'Activity Tool'
392
    allowed_types = ( 'CMF Active Process', )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
393 394
    security = ClassSecurityInfo()

395 396
    manage_options = tuple(
                     [ { 'label' : 'Overview', 'action' : 'manage_overview' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
397
                     , { 'label' : 'Activities', 'action' : 'manageActivities' }
398
                     , { 'label' : 'LoadBalancing', 'action' : 'manageLoadBalancing'}
399
                     , { 'label' : 'Advanced', 'action' : 'manageActivitiesAdvanced' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
400
                     ,
401
                     ] + list(Folder.manage_options))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
402 403 404 405

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

406 407 408
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageActivitiesAdvanced' )
    manageActivitiesAdvanced = DTMLFile( 'dtml/manageActivitiesAdvanced', globals() )

409 410
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manage_overview' )
    manage_overview = DTMLFile( 'dtml/explainActivityTool', globals() )
411 412 413 414 415 416
    
    security.declareProtected( CMFCorePermissions.ManagePortal , 'manageLoadBalancing' )
    manageLoadBalancing = DTMLFile( 'dtml/manageLoadBalancing', globals() )
    
    distributingNode = ''
    _nodes = ()
417 418 419

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

421 422 423 424 425 426 427 428 429 430
    # 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
431 432
    def initialize(self):
      global is_initialized
Sebastien Robin's avatar
Sebastien Robin committed
433
      from Activity import RAMQueue, RAMDict, SQLQueue, SQLDict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
434
      # Initialize each queue
435
      for activity in activity_dict.itervalues():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
436
        activity.initialize(self)
Vincent Pelletier's avatar
Vincent Pelletier committed
437
      is_initialized = True
438 439 440
      
    security.declareProtected(Permissions.manage_properties, 'isSubscribed')
    def isSubscribed(self):
Aurel's avatar
Aurel committed
441
        """
442 443 444 445 446 447 448 449 450 451 452 453
        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
454

455
    security.declareProtected(Permissions.manage_properties, 'subscribe')
456
    def subscribe(self, REQUEST=None, RESPONSE=None):
457 458
        """ subscribe to the global Timer Service """
        service = getTimerService(self)
459
        url = '%s/manageLoadBalancing?manage_tabs_message=' %self.absolute_url()
460
        if not service:
461
            LOG('ActivityTool', INFO, 'TimerService not available')
462 463 464 465
            url += urllib.quote('TimerService not available')
        else:
            service.subscribe(self)
            url += urllib.quote("Subscribed to Timer Service")
466 467
        if RESPONSE is not None:
            RESPONSE.redirect(url)
468 469

    security.declareProtected(Permissions.manage_properties, 'unsubscribe')
470
    def unsubscribe(self, REQUEST=None, RESPONSE=None):
471 472
        """ unsubscribe from the global Timer Service """
        service = getTimerService(self)
473
        url = '%s/manageLoadBalancing?manage_tabs_message=' %self.absolute_url()
474
        if not service:
475
            LOG('ActivityTool', INFO, 'TimerService not available')
476 477 478 479
            url += urllib.quote('TimerService not available')
        else:
            service.unsubscribe(self)
            url += urllib.quote("Unsubscribed from Timer Service")
480 481
        if RESPONSE is not None:
            RESPONSE.redirect(url)
482 483 484

    def manage_beforeDelete(self, item, container):
        self.unsubscribe()
485 486
        Folder.inheritedAttribute('manage_beforeDelete')(self, item, container)
    
487 488
    def manage_afterAdd(self, item, container):
        self.subscribe()
489 490
        Folder.inheritedAttribute('manage_afterAdd')(self, item, container)
       
491 492
    def getCurrentNode(self):
        """ Return current node in form ip:port """
493 494 495 496 497 498 499 500 501 502 503 504 505
        global currentNode
        if currentNode is None:
          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)
506 507 508 509 510 511 512
        return currentNode
        
    security.declarePublic('getDistributingNode')
    def getDistributingNode(self):
        """ Return the distributingNode """
        return self.distributingNode

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    def getNodeList(self, role=None):
      node_dict = self.getNodeDict()
      if role is None:
        result = [x for x in node_dict.keys()]
      else:
        result = [node_id for node_id, node_role in node_dict.items() if node_role == role]
      result.sort()
      return result

    def getNodeDict(self):
      nodes = self._nodes
      if isinstance(nodes, tuple):
        new_nodes = OIBTree()
        new_nodes.update([(x, ROLE_PROCESSING) for x in self._nodes])
        self._nodes = nodes = new_nodes
      return nodes

    def registerNode(self, node):
      node_dict = self.getNodeDict()
      if not node_dict.has_key(node):
        if len(node_dict) == 0: # If we are registering the first node, make
                                # it both the distributing node and a processing
                                # node.
          role = ROLE_PROCESSING
          self.distributingNode = node
        else:
          role = ROLE_IDLE
        self.updateNode(node, role)

    def updateNode(self, node, role):
      node_dict = self.getNodeDict()
      node_dict[node] = role

    security.declareProtected(CMFCorePermissions.ManagePortal, 'getProcessingNodeList')
    def getProcessingNodeList(self):
      return self.getNodeList(role=ROLE_PROCESSING)

550
    security.declareProtected(CMFCorePermissions.ManagePortal, 'getIdleNodeList')
551 552
    def getIdleNodeList(self):
      return self.getNodeList(role=ROLE_IDLE)
553

554 555 556 557
    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)
      
558 559
    security.declarePublic('manage_setDistributingNode')
    def manage_setDistributingNode(self, distributingNode, REQUEST=None):
560
        """ set the distributing node """   
561
        if not distributingNode or self._isValidNodeName(distributingNode):
562 563 564 565 566 567 568 569 570 571 572 573 574
          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."))

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
    security.declareProtected(CMFCorePermissions.ManagePortal, 'manage_delNode')
    def manage_delNode(self, unused_node_list=None, REQUEST=None):
      """ delete selected unused nodes """
      processing_node = self.getDistributingNode()
      updated_processing_node = False
      if unused_node_list is not None:
        node_dict = self.getNodeDict()
        for node in unused_node_list:
          if node in node_dict:
            del node_dict[node]
          if node == processing_node:
            self.processing_node = ''
            updated_processing_node = True
      if REQUEST is not None:
        if unused_node_list is None:
          message = "No unused node selected, nothing deleted."
        else:
          message = "Deleted nodes %r." % (unused_node_list, )
        if updated_processing_node:
          message += "Disabled distributing node because it was deleted."
        REQUEST.RESPONSE.redirect(
          REQUEST.URL1 +
          '/manageLoadBalancing?manage_tabs_message=' +
          urllib.quote(message))

    security.declareProtected(CMFCorePermissions.ManagePortal, 'manage_addToProcessingList')
    def manage_addToProcessingList(self, unused_node_list=None, REQUEST=None):
      """ Change one or more idle nodes into processing nodes """
      if unused_node_list is not None:
        node_dict = self.getNodeDict()
        for node in unused_node_list:
          self.updateNode(node, ROLE_PROCESSING)
      if REQUEST is not None:
        if unused_node_list is None:
          message = "No unused node selected, nothing done."
        else:
          message = "Nodes now procesing: %r." % (unused_node_list, )
        REQUEST.RESPONSE.redirect(
          REQUEST.URL1 +
          '/manageLoadBalancing?manage_tabs_message=' +
          urllib.quote(message))

    security.declareProtected(CMFCorePermissions.ManagePortal, 'manage_removeFromProcessingList')
    def manage_removeFromProcessingList(self, processing_node_list=None, REQUEST=None):
      """ Change one or more procesing nodes into idle nodes """
      if processing_node_list is not None:
        node_dict = self.getNodeDict()
        for node in processing_node_list:
          self.updateNode(node, ROLE_IDLE)
      if REQUEST is not None:
        if processing_node_list is None:
          message = "No used node selected, nothing done."
        else:
          message = "Nodes now unused %r." % (processing_node_list, )
        REQUEST.RESPONSE.redirect(
          REQUEST.URL1 +
          '/manageLoadBalancing?manage_tabs_message=' +
          urllib.quote(message))
633

634 635 636 637 638
    def process_shutdown(self, phase, time_in_phase):
        """
          Prevent shutdown from happening while an activity queue is
          processing a batch.
        """
639 640 641
        is_running = False
        if phase == 3 and not has_processed_shutdown:
          has_processed_shutdown = True
642 643 644 645 646
          LOG('CMFActivity', INFO, "Shutdown: Waiting for activities to finish.")
          is_running_lock.acquire()
          LOG('CMFActivity', INFO, "Shutdown: Activities finished.")
          is_running_lock.release()

647
    def process_timer(self, tick, interval, prev="", next=""):
648
        """
649 650 651 652 653
        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.
        """
654 655 656 657
        # Prevent TimerService from starting multiple threads in parallel
        acquired = timerservice_lock.acquire(0)
        if not acquired:
          return
658

659
        try:
660
          old_sm = getSecurityManager()
661
          try:
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
            try:
              # get owner of portal_catalog, so normally we should be able to
              # have the permission to invoke all activities
              user = self.portal_catalog.getWrappedOwner()
              newSecurityManager(self.REQUEST, user)

              currentNode = self.getCurrentNode()
              self.registerNode(currentNode)
              processing_node_list = self.getNodeList(role=ROLE_PROCESSING)

              # only distribute when we are the distributingNode or if it's empty
              if (self.getDistributingNode() == currentNode):
                self.distribute(len(processing_node_list))

              # 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)

              # 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 processing_node_list:
                self.tic(processing_node_list.index(currentNode)+1)
            except:
              # Catch ALL exception to avoid killing timerserver.
              LOG('ActivityTool', ERROR, 'process_timer received an exception', error=sys.exc_info())
          finally:
            setSecurityManager(old_sm)
Jérome Perrin's avatar
Jérome Perrin committed
694
        finally:
695
          timerservice_lock.release()
696

Jean-Paul Smets's avatar
Jean-Paul Smets committed
697 698 699 700 701 702
    security.declarePublic('distribute')
    def distribute(self, node_count=1):
      """
        Distribute load
      """
      # Initialize if needed
Vincent Pelletier's avatar
Vincent Pelletier committed
703 704
      if not is_initialized:
        self.initialize()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
705 706

      # Call distribute on each queue
707
      for activity in activity_dict.itervalues():
708
        activity.distribute(aq_inner(self), node_count)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
709

Jean-Paul Smets's avatar
Jean-Paul Smets committed
710
    security.declarePublic('tic')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
711
    def tic(self, processing_node=1, force=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
712 713
      """
        Starts again an activity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
714
        processing_node starts from 1 (there is not node 0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
715
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
716
      global active_threads, first_run
Jean-Paul Smets's avatar
Jean-Paul Smets committed
717 718

      # return if the number of threads is too high
719
      # else, increase the number of active_threads and continue
720 721
      tic_lock.acquire()
      too_many_threads = (active_threads >= max_active_threads)
722
      if not too_many_threads or force:
723
        active_threads += 1
724 725 726
      else:
        tic_lock.release()
        raise RuntimeError, 'Too many threads'
727
      tic_lock.release()
728

Jean-Paul Smets's avatar
Jean-Paul Smets committed
729
      # Initialize if needed
Vincent Pelletier's avatar
Vincent Pelletier committed
730 731
      if not is_initialized:
        self.initialize()
732

733
      inner_self = aq_inner(self)
734

735 736 737
      # If this is the first tic after zope is started, reset the processing
      # flag for activities of this node
      if first_run:
738 739 740 741
        inner_self.SQLDict_clearProcessingFlag(
                                processing_node=processing_node)
        inner_self.SQLQueue_clearProcessingFlag(
                                processing_node=processing_node)
742
        first_run = False
743

744
      try:
745 746 747 748 749 750 751
        #Sort activity list by priority
        activity_list = activity_dict.values()
        # Sort method must be local to access "self"
        def cmpActivities(activity_1, activity_2):
          return cmp(activity_1.getPriority(self), activity_2.getPriority(self))
        activity_list.sort(cmpActivities)
        
752
        # Wakeup each queue
753
        for activity in activity_list:
754
          activity.wakeup(inner_self, processing_node)
755

756 757 758 759
        # Process messages on each queue in round robin
        has_awake_activity = 1
        while has_awake_activity:
          has_awake_activity = 0
760
          for activity in activity_list:
761 762
            is_running_lock.acquire()
            try:
763
              if is_running:
764 765 766 767
                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)
            finally:
              is_running_lock.release()
768 769 770 771 772
      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
773

774
    def hasActivity(self, *args, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
775
      # Check in each queue if the object has deferred tasks
776 777
      # if not argument is provided, then check on self
      if len(args) > 0:
778
        obj = args[0]
779
      else:
780
        obj = self
781
      for activity in activity_dict.itervalues():
782
        if activity.hasActivity(aq_inner(self), obj, **kw):
783 784
          return True
      return False
Jean-Paul Smets's avatar
Jean-Paul Smets committed
785

786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
    def getActivityBuffer(self, create_if_not_found=True):
      """
        Get activtity buffer for this thread for this activity tool.
        If no activity buffer is found at lowest level and create_if_not_found
        is True, create one.
        Intermediate level is unconditionaly created if non existant because
        chances are it will be used in the instance life.
        Lock is held when checking for intermediate level existance
        because:
         - intermediate level dict must not be created in 2 threads at the
           same time, since one creation would destroy the existing one.
        It's released after that step because:
         - lower level access is at thread scope, thus by definition there
           can be only one access at a time to a key
         - GIL protects us when accessing python instances
      """
802 803
      # Safeguard: make sure we are wrapped in  acquisition context before
      # using our path as an activity tool instance-wide identifier.
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
      assert getattr(self, 'aq_self', None) is not None
      my_instance_key = self.getPhysicalPath()
      my_thread_key = get_ident()
      global_activity_buffer_lock.acquire()
      try:
        if my_instance_key not in global_activity_buffer:
          global_activity_buffer[my_instance_key] = {}
      finally:
        global_activity_buffer_lock.release()
      thread_activity_buffer = global_activity_buffer[my_instance_key]
      if my_thread_key not in thread_activity_buffer:
        if create_if_not_found:
          buffer = ActivityBuffer(activity_tool=self)
        else:
          buffer = None
        thread_activity_buffer[my_thread_key] = buffer
      activity_buffer = thread_activity_buffer[my_thread_key]
      return activity_buffer

823 824
    security.declarePrivate('activateObject')
    def activateObject(self, object, activity, active_process, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
825 826
      if not is_initialized:
        self.initialize()
827
      self.getActivityBuffer()
828
      return ActiveWrapper(object, activity, active_process, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
829

830
    def deferredQueueMessage(self, activity, message):
831 832
      activity_buffer = self.getActivityBuffer()
      activity_buffer.deferredQueueMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
833

834
    def deferredDeleteMessage(self, activity, message):
835 836
      activity_buffer = self.getActivityBuffer()
      activity_buffer.deferredDeleteMessage(self, activity, message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
837

Jean-Paul Smets's avatar
Jean-Paul Smets committed
838
    def getRegisteredMessageList(self, activity):
839
      activity_buffer = self.getActivityBuffer(create_if_not_found=False)
840
      if activity_buffer is not None:
841 842
        #activity_buffer._register() # This is required if flush flush is called outside activate
        return activity.getRegisteredMessageList(activity_buffer,
843
                                                 aq_inner(self))
844 845
      else:
        return []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
846

Jean-Paul Smets's avatar
Jean-Paul Smets committed
847
    def unregisterMessage(self, activity, message):
848 849 850
      activity_buffer = self.getActivityBuffer()
      #activity_buffer._register()
      return activity.unregisterMessage(activity_buffer, aq_inner(self), message)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
851

852
    def flush(self, obj, invoke=0, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
853 854
      if not is_initialized:
        self.initialize()
855
      self.getActivityBuffer()
856 857
      if isinstance(obj, tuple):
        object_path = obj
858
      else:
859
        object_path = obj.getPhysicalPath()
860
      for activity in activity_dict.itervalues():
861
        activity.flush(aq_inner(self), object_path, invoke=invoke, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
862

863
    def start(self, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
864 865
      if not is_initialized:
        self.initialize()
866
      for activity in activity_dict.itervalues():
867
        activity.start(aq_inner(self), **kw)
868 869

    def stop(self, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
870 871
      if not is_initialized:
        self.initialize()
872
      for activity in activity_dict.itervalues():
873
        activity.stop(aq_inner(self), **kw)
874

Jean-Paul Smets's avatar
Jean-Paul Smets committed
875
    def invoke(self, message):
876
      if logging:
877
        LOG('Activity Tracking', INFO, 'invoking message: object_path=%s, method_id=%s, args=%s, kw=%s, activity_kw=%s, user_name=%s' % ('/'.join(message.object_path), message.method_id, message.args, message.kw, message.activity_kw, message.user_name))
878
      old_ihotfix_context = False
879 880
      if getattr(self, 'aq_chain', None) is not None:
        # Grab existing acquisition chain and extrach base objects.
881
        base_chain = [aq_base(x) for x in self.aq_chain]
882 883 884
        # Grab existig request (last chain item) and create a copy.
        request_container = base_chain.pop()
        request = request_container.REQUEST
885 886 887 888 889 890 891 892
        # Generate PARENTS value. Sadly, we cannot reuse base_chain since
        # PARENTS items must be wrapped in acquisition
        parents = []
        application = self.getPhysicalRoot().aq_base
        for parent in self.aq_chain:
          if parent.aq_base is application:
            break
          parents.append(parent)
893 894
        # XXX: REQUEST.clone() requires PARENTS to be set, and it's not when
        # runing unit tests. Recreate it if it does not exist.
895 896
        if getattr(request.other, 'PARENTS', None) is None:
          request.other['PARENTS'] = parents
897 898 899
        # XXX: itools (used by iHotfix) requires PATH_INFO to be set, and it's
        # not when runing unit tests. Recreate it if it does not exist.
        if request.environ.get('PATH_INFO') is None:
900
          request.environ['PATH_INFO'] = '/Control_Panel/timer_service/process_timer'
901 902 903
        
        # restore request information
        new_request = request.clone()
904
        request_info = message.request_info
905 906
        # PARENTS is truncated by clone
        new_request.other['PARENTS'] = parents
907 908
        new_request._script = request_info['_script']
        if 'SERVER_URL' in request_info:
909
          new_request.other['SERVER_URL'] = request_info['SERVER_URL']
910 911 912
        if 'VirtualRootPhysicalPath' in request_info:
          new_request.other['VirtualRootPhysicalPath'] = request_info['VirtualRootPhysicalPath']
        if 'HTTP_ACCEPT_LANGUAGE' in request_info:
913
          new_request.environ['HTTP_ACCEPT_LANGUAGE'] = request_info['HTTP_ACCEPT_LANGUAGE']
914 915 916 917 918 919 920 921 922 923 924
          # Replace iHotfix Context, saving existing one
          ihotfix_context = iHotfix.Context(new_request)
          id = get_ident()
          iHotfix._the_lock.acquire()
          try:
            old_ihotfix_context = iHotfix.contexts.get(id)
            iHotfix.contexts[id] = ihotfix_context
          finally:
            iHotfix._the_lock.release()
          # Execute iHotfix "patch 2"
          new_request.processInputs()
925 926

        new_request_container = request_container.__class__(REQUEST=new_request)
927 928 929 930 931 932 933 934
        # Recreate acquisition chain.
        my_self = new_request_container
        base_chain.reverse()
        for item in base_chain:
          my_self = item.__of__(my_self)
      else:
        my_self = self
        LOG('CMFActivity.ActivityTool.invoke', INFO, 'Strange: invoke is called outside of acquisition context.')
935 936 937 938 939 940 941 942 943 944 945 946 947 948
      try:
        message(my_self)
      finally:
        if old_ihotfix_context is not False:
          # Restore iHotfix context
          id = get_ident()
          iHotfix._the_lock.acquire()
          try:
            if old_ihotfix_context is None:
              del iHotfix.contexts[id]
            else:
              iHotfix.contexts[id] = old_ihotfix_context
          finally:
            iHotfix._the_lock.release()
949
      if logging:
950
        LOG('Activity Tracking', INFO, 'invoked message')
951 952 953
      if my_self is not self: # We rewrapped self
        for held in my_self.REQUEST._held:
          self.REQUEST._hold(held)
954

955
    def invokeGroup(self, method_id, message_list):
956
      if logging:
957
        LOG('Activity Tracking', INFO, 'invoking group messages: method_id=%s, paths=%s' % (method_id, ['/'.join(m.object_path) for m in message_list]))
958 959 960 961 962
      # Invoke a group method.
      object_list = []
      expanded_object_list = []
      new_message_list = []
      path_dict = {}
963
      # Filter the list of messages. If an object is not available, mark its message as non-executable.
964 965
      # In addition, expand an object if necessary, and make sure that no duplication happens.
      for m in message_list:
966 967
        # alternate method is used to segregate objects which cannot be grouped.
        alternate_method_id = m.activity_kw.get('alternate_method_id')
968 969
        try:
          obj = m.getObject(self)
970 971 972 973
        except KeyError:
          m.is_executed = MESSAGE_NOT_EXECUTABLE
          continue
        try:
974
          i = len(new_message_list) # This is an index of this message in new_message_list.
975
          if m.hasExpandMethod():
976 977
            for subobj in m.getObjectList(self):
              path = subobj.getPath()
978
              if path not in path_dict:
979
                path_dict[path] = i
980 981 982 983 984 985
                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']
986 987
                  if 'group_id' in activity_kw:
                    del activity_kw['group_id']                    
988 989 990 991
                  active_obj = subobj.activate(**activity_kw)
                  getattr(active_obj, alternate_method_id)(*m.args, **m.kw)
                else:
                  expanded_object_list.append(subobj)
992 993 994
          else:
            path = obj.getPath()
            if path not in path_dict:
995
              path_dict[path] = i
996 997 998 999 1000 1001
              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']
1002 1003
                if 'group_id' in activity_kw:
                  del activity_kw['group_id']
1004 1005 1006 1007
                active_obj = obj.activate(**activity_kw)
                getattr(active_obj, alternate_method_id)(*m.args, **m.kw)
              else:
                expanded_object_list.append(obj)
1008
          object_list.append(obj)
1009 1010
          new_message_list.append(m)
        except:
1011
          m.is_executed = MESSAGE_NOT_EXECUTED
1012 1013 1014 1015 1016
          exc_info = sys.exc_info()
          m.exc_type = exc_info[0]
          m.exc_value = str(exc_info[1])
          m.traceback = ''.join(ExceptionFormatter.format_exception(
                                *exc_info))
1017
          LOG('WARNING ActivityTool', 0,
1018
              'Could not call method %s on object %s' %
1019
              (m.method_id, m.object_path), error=exc_info)
1020

1021 1022
      try:
        if len(expanded_object_list) > 0:
1023 1024
          method = self.unrestrictedTraverse(method_id)
          # FIXME: how to apply security here?
1025 1026
          # 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.
1027
          result = method(expanded_object_list, **m.kw)
1028
        else:
1029 1030 1031
          result = None
      except:
        # In this case, the group method completely failed.
1032 1033 1034 1035 1036
        exc_info = sys.exc_info()
        exc_type = exc_info[0]
        exc_value = str(exc_info[1])
        traceback = ''.join(ExceptionFormatter.format_exception(
                            *exc_info))
1037
        for m in new_message_list:
1038
          m.is_executed = MESSAGE_NOT_EXECUTED
1039 1040 1041
          m.exc_type = exc_type
          m.exc_value = exc_value
          m.traceback = traceback
1042
        LOG('WARNING ActivityTool', 0,
1043
            'Could not call method %s on objects %s' %
1044
            (method_id, expanded_object_list), error=exc_info)
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
      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:
1058
            m.is_executed = MESSAGE_NOT_EXECUTED
1059
            LOG('ActivityTool', WARNING,
1060 1061
                'the method %s partially failed on object %s' %
                (m.method_id, m.object_path,))
1062 1063 1064
          else:
            try:
              m.activateResult(self, result, object)
1065
              m.is_executed = MESSAGE_EXECUTED
1066
            except:
1067
              m.is_executed = MESSAGE_NOT_EXECUTED
Vincent Pelletier's avatar
Vincent Pelletier committed
1068
              m.exc_type = sys.exc_info()[0]
1069
              LOG('ActivityTool', WARNING,
1070
                  'Could not call method %s on object %s' % (
Vincent Pelletier's avatar
Vincent Pelletier committed
1071
                  m.method_id, m.object_path), error=sys.exc_info())
1072
      if logging:
1073
        LOG('Activity Tracking', INFO, 'invoked group messages')
1074

1075 1076
    def newMessage(self, activity, path, active_process,
                   activity_kw, method_id, *args, **kw):
1077
      # Some Security Cheking should be made here XXX
Vincent Pelletier's avatar
Vincent Pelletier committed
1078 1079
      if not is_initialized:
        self.initialize()
1080
      self.getActivityBuffer()
1081
      activity_dict[activity].queueMessage(aq_inner(self),
1082
        Message(path, active_process, activity_kw, method_id, args, kw))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1083

1084
    security.declareProtected( CMFCorePermissions.ManagePortal, 'manageInvoke' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1085 1086 1087 1088 1089 1090
    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('/'))
1091
      self.flush(object_path,method_id=method_id,invoke=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1092
      if REQUEST is not None:
1093 1094
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manageActivities'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1095

1096
    security.declareProtected( CMFCorePermissions.ManagePortal, 'manageCancel' )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1097 1098 1099 1100 1101 1102
    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('/'))
1103
      self.flush(object_path,method_id=method_id,invoke=0)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1104
      if REQUEST is not None:
1105 1106
        return REQUEST.RESPONSE.redirect('%s/%s' %
                (self.absolute_url(), 'manageActivities'))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1107

1108 1109
    security.declareProtected( CMFCorePermissions.ManagePortal,
                               'manageClearActivities' )
1110
    def manageClearActivities(self, keep=1, REQUEST=None):
1111 1112 1113 1114 1115
      """
        Clear all activities and recreate tables.
      """
      folder = getToolByName(self, 'portal_skins').activity

1116 1117
      # Obtain all pending messages.
      message_list = []
1118
      if keep:
1119
        for activity in activity_dict.itervalues():
1120 1121 1122 1123 1124 1125
          if hasattr(activity, 'dumpMessageList'):
            try:
              message_list.extend(activity.dumpMessageList(self))
            except ConflictError:
              raise
            except:
1126 1127 1128
              LOG('ActivityTool', WARNING,
                  'could not dump messages from %s' %
                  (activity,), error=sys.exc_info())
1129 1130

      if getattr(folder, 'SQLDict_createMessageTable', None) is not None:
1131 1132 1133 1134 1135
        try:
          folder.SQLDict_dropMessageTable()
        except ConflictError:
          raise
        except:
1136
          LOG('CMFActivity', WARNING,
1137
              'could not drop the message table',
1138 1139 1140
              error=sys.exc_info())
        folder.SQLDict_createMessageTable()

1141
      if getattr(folder, 'SQLQueue_createMessageTable', None) is not None:
1142 1143 1144 1145 1146
        try:
          folder.SQLQueue_dropMessageTable()
        except ConflictError:
          raise
        except:
1147
          LOG('CMFActivity', WARNING,
1148
              'could not drop the message queue table',
1149 1150 1151
              error=sys.exc_info())
        folder.SQLQueue_createMessageTable()

1152 1153 1154
      # Reactivate the messages.
      for m in message_list:
        try:
1155
          m.reactivate(aq_inner(self))
1156 1157 1158 1159
        except ConflictError:
          raise
        except:
          LOG('ActivityTool', WARNING,
1160 1161
              'could not reactivate the message %r, %r' %
              (m.object_path, m.method_id), error=sys.exc_info())
1162

1163
      if REQUEST is not None:
1164 1165 1166 1167 1168 1169
        message = 'Activities%20Cleared'
        if keep:
          message = 'Tables%20Recreated'
        return REQUEST.RESPONSE.redirect(
            '%s/manageActivitiesAdvanced?manage_tabs_message=%s' % (
              self.absolute_url(), message))
1170

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1171
    security.declarePublic('getMessageList')
1172
    def getMessageList(self,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1173 1174 1175
      """
        List messages waiting in queues
      """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1176
      # Initialize if needed
Vincent Pelletier's avatar
Vincent Pelletier committed
1177 1178
      if not is_initialized:
        self.initialize()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1179

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1180
      message_list = []
1181
      for activity in activity_dict.itervalues():
Sebastien Robin's avatar
Sebastien Robin committed
1182
        try:
1183
          message_list += activity.getMessageList(aq_inner(self),**kw)
Sebastien Robin's avatar
Sebastien Robin committed
1184 1185
        except AttributeError:
          LOG('getMessageList, could not get message from Activity:',0,activity)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1186 1187
      return message_list

1188 1189 1190 1191 1192 1193
    security.declarePublic('countMessageWithTag')
    def countMessageWithTag(self, value):
      """
        Return the number of messages which match the given tag.
      """
      message_count = 0
1194
      for activity in activity_dict.itervalues():
1195
        message_count += activity.countMessageWithTag(aq_inner(self), value)
Sebastien Robin's avatar
Sebastien Robin committed
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
      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
1206
        path : for activities on a particular object
Sebastien Robin's avatar
Sebastien Robin committed
1207 1208 1209 1210
        tag : activities with a particular tag
        message_uid : activities with a particular uid
      """
      message_count = 0
1211
      for activity in activity_dict.itervalues():
1212
        message_count += activity.countMessage(aq_inner(self), **kw)
1213 1214
      return message_count

1215
    security.declareProtected( CMFCorePermissions.ManagePortal , 'newActiveProcess' )
1216
    def newActiveProcess(self, **kw):
1217 1218
      from ActiveProcess import addActiveProcess
      new_id = str(self.generateNewId())
1219
      return addActiveProcess(self, new_id, **kw)
1220

1221
    # Active synchronisation methods
1222
    security.declarePrivate('validateOrder')
1223
    def validateOrder(self, message, validator_id, validation_value):
1224 1225 1226 1227 1228
      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):
Vincent Pelletier's avatar
Vincent Pelletier committed
1229 1230
      if not is_initialized:
        self.initialize()
1231
      message_list = []
Vincent Pelletier's avatar
Vincent Pelletier committed
1232
      method_id = "_validate_%s" % validator_id
1233
      for activity in activity_dict.itervalues():
1234 1235 1236 1237 1238 1239
        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
1240

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1241 1242
    # Required for tests (time shift)
    def timeShift(self, delay):
Vincent Pelletier's avatar
Vincent Pelletier committed
1243 1244
      if not is_initialized:
        self.initialize()
1245
      for activity in activity_dict.itervalues():
1246
        activity.timeShift(aq_inner(self), delay)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1247

1248
InitializeClass(ActivityTool)