SQLDict.py 32.3 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002,2007 Nexedi SA and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Products.CMFActivity.ActivityTool import registerActivity
30 31
from Queue import VALID, INVALID_PATH, VALIDATION_ERROR_DELAY, \
        abortTransactionSynchronously
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from RAMDict import RAMDict
33
from Products.CMFActivity.ActiveObject import INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE
34
from Products.CMFActivity.Errors import ActivityFlushError
35
from ZODB.POSException import ConflictError
36
import sys
37
from types import ClassType
38 39
#from time import time
from SQLBase import SQLBase
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40

41 42 43 44 45
try:
  from transaction import get as get_transaction
except ImportError:
  pass

46
from zLOG import LOG, TRACE, WARNING, ERROR, INFO, PANIC
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47

48
MAX_PRIORITY = 5
49 50
# Stop validating more messages when this limit is reached
MAX_VALIDATED_LIMIT = 1000 
Yoshinori Okuji's avatar
Yoshinori Okuji committed
51
# Read up to this number of messages to validate.
52
READ_MESSAGE_LIMIT = 1000
Yoshinori Okuji's avatar
Yoshinori Okuji committed
53 54
# Stop electing more messages for processing if more than this number of
# objects are impacted by elected messages.
55
MAX_GROUPED_OBJECTS = 100
Jean-Paul Smets's avatar
Jean-Paul Smets committed
56

57
class SQLDict(RAMDict, SQLBase):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59 60 61 62
  """
    A simple OOBTree based queue. It should be compatible with transactions
    and provide sequentiality. Should not create conflict
    because use of OOBTree.
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63
  # Transaction commit methods
64 65 66 67 68 69
  def prepareQueueMessageList(self, activity_tool, message_list):
    registered_message_list = []
    for message in message_list:
      if message.is_registered:
        registered_message_list.append(message)
    if len(registered_message_list) > 0:
70
      #LOG('SQLDict prepareQueueMessageList', 0, 'registered_message_list = %r' % (registered_message_list,))
71 72 73 74
      path_list = ['/'.join(message.object_path) for message in registered_message_list]
      method_id_list = [message.method_id for message in registered_message_list]
      priority_list = [message.activity_kw.get('priority', 1) for message in registered_message_list]
      dumped_message_list = [self.dumpMessage(message) for message in registered_message_list]
75
      date_list = [message.activity_kw.get('at_date', None) for message in registered_message_list]
76 77
      group_method_id_list = ['\0'.join([message.activity_kw.get('group_method_id', ''), message.activity_kw.get('group_id', '')])
                              for message in registered_message_list]
78
      tag_list = [message.activity_kw.get('tag', '') for message in registered_message_list]
79
      order_validation_text_list = [self.getOrderValidationText(message) for message in registered_message_list]
80
      uid_list = activity_tool.getPortalObject().portal_ids.generateNewLengthIdList(id_group='portal_activity', 
81
                   id_count=len(registered_message_list), store=0)
82 83
      activity_tool.SQLDict_writeMessageList( uid_list = uid_list,
                                              path_list = path_list,
84 85 86
                                              method_id_list = method_id_list,
                                              priority_list = priority_list,
                                              message_list = dumped_message_list,
87
                                              date_list = date_list,
88
                                              group_method_id_list = group_method_id_list,
89 90
                                              tag_list = tag_list,
                                              order_validation_text_list = order_validation_text_list)
91

92 93
  def prepareDeleteMessage(self, activity_tool, m):
    # Erase all messages in a single transaction
Jean-Paul Smets's avatar
Jean-Paul Smets committed
94
    path = '/'.join(m.object_path)
95 96
    order_validation_text = self.getOrderValidationText(m)
    uid_list = activity_tool.SQLDict_readUidList(path = path, method_id = m.method_id,
97
                                                 order_validation_text = order_validation_text,
98
                                                 processing_node = None)
99
    uid_list = [x.uid for x in uid_list]
100
    if len(uid_list)>0:
101 102
      activity_tool.SQLDict_delMessage(uid = uid_list)

103 104 105 106 107 108 109 110
  def finishQueueMessage(self, activity_tool_path, m):
    # Nothing to do in SQLDict.
    pass

  def finishDeleteMessage(self, activity_tool_path, m):
    # Nothing to do in SQLDict.
    pass

111
  # Registration management
Jean-Paul Smets's avatar
Jean-Paul Smets committed
112
  def registerActivityBuffer(self, activity_buffer):
113
    pass
114

Jean-Paul Smets's avatar
Jean-Paul Smets committed
115
  def isMessageRegistered(self, activity_buffer, activity_tool, m):
116
    uid_set = activity_buffer.getUidSet(self)
117
    return (tuple(m.object_path), m.method_id, m.activity_kw.get('tag'), m.activity_kw.get('group_id')) in uid_set
118

Jean-Paul Smets's avatar
Jean-Paul Smets committed
119 120
  def registerMessage(self, activity_buffer, activity_tool, m):
    m.is_registered = 1
121
    uid_set = activity_buffer.getUidSet(self)
122
    uid_set.add((tuple(m.object_path), m.method_id, m.activity_kw.get('tag'), m.activity_kw.get('group_id')))
123 124
    message_list = activity_buffer.getMessageList(self)
    message_list.append(m)
125

Jean-Paul Smets's avatar
Jean-Paul Smets committed
126 127
  def unregisterMessage(self, activity_buffer, activity_tool, m):
    m.is_registered = 0 # This prevents from inserting deleted messages into the queue
128
    class_name = self.__class__.__name__
129
    uid_set = activity_buffer.getUidSet(self)
130
    uid_set.discard((tuple(m.object_path), m.method_id, m.activity_kw.get('tag'), m.activity_kw.get('group_id')))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131 132

  def getRegisteredMessageList(self, activity_buffer, activity_tool):
133 134
    message_list = activity_buffer.getMessageList(self)
    return [m for m in message_list if m.is_registered]
135
  
136
  def validateMessage(self, activity_tool, message, uid_list, priority, processing_node):
137
    validation_state = message.validate(self, activity_tool, check_order_validation=0)
138
    if validation_state is not VALID:
139 140 141 142 143 144 145 146
      # There is a serious validation error - we must lower priority
      if priority > MAX_PRIORITY:
        # This is an error
        if len(uid_list) > 0:
          activity_tool.SQLDict_assignMessage(uid=uid_list, processing_node=VALIDATE_ERROR_STATE)
                                                                          # Assign message back to 'error' state
        #m.notifyUser(activity_tool)                                      # Notify Error
        get_transaction().commit()                                        # and commit
147
      else:
148 149 150 151
        # Lower priority
        if len(uid_list) > 0: # Add some delay before new processing
          activity_tool.SQLDict_setPriority(uid=uid_list, delay=VALIDATION_ERROR_DELAY,
                                            priority=priority + 1, retry=1)
152 153 154
        get_transaction().commit() # Release locks before starting a potentially long calculation
      return 0
    return 1
155

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
  def getReservedMessageList(self, activity_tool, date, processing_node, limit=None, **kw):
    """
      Get and reserve a list of messages.
      limit
        Maximum number of messages to fetch.
        This number is not garanted to be reached, because of:
         - not enough messages being pending execution
         - race condition (other nodes reserving the same messages at the same
           time)
        This number is guaranted not to be exceeded.
        If None (or not given) no limit apply.
    """
    result = activity_tool.SQLDict_selectReservedMessageList(processing_node=processing_node, limit=limit)
    if len(result) == 0:
      activity_tool.SQLDict_reserveMessageList(limit=limit, processing_node=processing_node, to_date=date, **kw)
      result = activity_tool.SQLDict_selectReservedMessageList(processing_node=processing_node, limit=limit)
    return result

  def makeMessageListAvailable(self, activity_tool, uid_list):
    """
      Put messages back in processing_node=0 .
    """
    if len(uid_list):
      activity_tool.SQLDict_makeMessageListAvailable(uid_list=uid_list)

  def deleteDuplicatedLineList(self, activity_tool, date, processing_node, line):
    """
      Delete all messages matching given one except itself.
      Operator  Value
      !=        uid
      <=        date
      =         path, method_id, group_method_id, order_validation_text,
                processing_node, tag
    """
    activity_tool.SQLDict_deleteDuplicatedMessageList(
      processing_node=processing_node, uid=line.uid,
192
      path=line.path, method_id=line.method_id,
193
      group_method_id=line.group_method_id,
194
      order_validation_text=line.order_validation_text)
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

  def getProcessableMessageList(self, activity_tool, processing_node):
    """
      Always true:
        For each reserved message, delete redundant messages when it gets
        reserved (definitely lost, but they are expandable since redundant).

      - reserve a message
      - set reserved message to processing=1 state
      - if this message has a group_method_id:
        - reserve a bunch of BUNDLE_MESSAGE_COUNT messages
        - untill number of impacted objects goes over MAX_GROUPED_OBJECTS
          - get one message from the reserved bunch (this messages will be
            "needed")
          - increase the number of impacted object
        - set "needed" reserved messages to processing=1 state
        - unreserve "unneeded" messages
      - return still-reserved message list and a group_method_id

      If any error happens in above described process, try to unreserve all
      messages already reserved in that process.
      If it fails, complain loudly that some messages might still be in an
      unclean state.

      Returned values:
        3-tuple:
          - list of 3-tuple:
            - message uid
            - message
            - priority
          - impacted object count
          - group_method_id
    """
    def getReservedMessageList(**kw):
      line_list = self.getReservedMessageList(activity_tool=activity_tool,
                                              date=now_date,
                                              processing_node=processing_node,
                                              **kw)
      if len(line_list):
        LOG('SQLDict', TRACE, 'Reserved messages: %r' % ([x.uid for x in line_list]))
      return line_list
    def deleteDuplicatedLineList(line):
      self.deleteDuplicatedLineList(activity_tool=activity_tool, date=now_date,
                                 processing_node=processing_node, line=line)
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    BUNDLE_MESSAGE_COUNT = 100 # Arbitrary number
    now_date = self.getNow(activity_tool)
    message_list = []
    def append(line, message):
      uid = line.uid
      message_list.append((uid, message, line.priority))
    count = 0
    group_method_id = None
    try:
      result = getReservedMessageList(limit=1)
      if len(result) > 0:
        line = result[0]
253
        m = self.loadMessage(line.message, uid=line.uid)
254 255 256 257 258
        append(line, m)
        group_method_id = line.group_method_id
        # Delete all messages matching current one - except current one.
        deleteDuplicatedLineList(line)
        activity_tool.SQLDict_processMessage(uid=[line.uid])
259
        if group_method_id not in (None, '', '\0'):
260
          # Count the number of objects to prevent too many objects.
261
          count += len(m.getObjectList(activity_tool))
262 263
          if count < MAX_GROUPED_OBJECTS:
            # Retrieve objects which have the same group method.
264
            result = getReservedMessageList(limit=BUNDLE_MESSAGE_COUNT, group_method_id=group_method_id)
265
            path_and_method_id_dict = {}
266
            unreserve_uid_list = []
267
            for line in result:
268 269 270 271 272 273 274
              # All fetched lines have the same group_method_id and
              # processing_node.
              # Their dates are lower-than or equal-to now_date.
              # We read each line once so lines have distinct uids.
              # So what remains to be filtered on are path, method_id,
              # order_validation_text, tag
              key = (line.path, line.method_id, line.order_validation_text, line.tag)
275
              if key in path_and_method_id_dict:
276
                LOG('SQLDict', TRACE, 'Duplicate of message %r has been skipped (it should already be deleted anyway): %r' % (path_and_method_id_dict[key], line.uid))
277
                continue
278 279 280 281 282 283
              path_and_method_id_dict[key] = line.uid
              deleteDuplicatedLineList(line)
              if count < MAX_GROUPED_OBJECTS:
                m = self.loadMessage(line.message, uid=line.uid)
                count += len(m.getObjectList(activity_tool))
                append(line, m)
284
              else:
285 286 287 288 289 290 291 292 293 294 295 296 297
                unreserve_uid_list.append(line.uid)
            activity_tool.SQLDict_processMessage(uid=[x[0] for x in message_list])
            # Unreserve extra messages as soon as possible.
            makeMessageListAvailable(unreserve_uid_list)
      return message_list, count, group_method_id
    except:
      LOG('SQLDict', WARNING, 'Exception while reserving messages.', error=sys.exc_info())
      if len(message_list):
        to_free_uid_list = [x[0] for x in message_list]
        try:
          makeMessageListAvailable(to_free_uid_list)
        except:
          LOG('SQLDict', PANIC, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
298
        else:
299 300 301 302 303 304 305
          if len(to_free_uid_list):
            LOG('SQLDict', TRACE, 'Freed messages %r' % (to_free_uid_list, ))
      else:
        LOG('SQLDict', TRACE, '(no message was reserved)')
      return [], 0, None

  def finalizeMessageExecution(self, activity_tool, message_uid_priority_list):
306 307 308 309 310 311 312 313 314 315
    """
      If everything was fine, delete all messages.
      If anything failed, make successfull messages available (if any), and
      the following rules apply to failed messages:
        - Failures due to ConflictErrors cause messages to be postponed,
          but their priority is *not* increased.
        - Failures of messages already above maximum priority cause them to
          be put in a permanent-error state.
        - In all other cases, priotity is increased and message is delayed.
    """
316 317 318 319 320
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    deletable_uid_list = []
    delay_uid_list = []
    final_error_uid_list = []
321
    make_available_uid_list = []
322
    message_with_active_process_list = []
323
    notify_user_list = []
324
    something_failed = (len([x for x in message_uid_priority_list if not x[1].is_executed]) != 0)
325 326
    for uid, m, priority in message_uid_priority_list:
      if m.is_executed:
327 328 329 330 331 332
        if something_failed:
          make_available_uid_list.append(uid)
        else:
          deletable_uid_list.append(uid)
          if m.active_process:
            message_with_active_process_list.append(m)
333 334 335 336 337
      else:
        if type(m.exc_type) is ClassType and \
           issubclass(m.exc_type, ConflictError):
          delay_uid_list.append(uid)
        elif priority > MAX_PRIORITY:
338
          notify_user_list.append(m)
339
          final_error_uid_list.append(uid)
340
        else:
341 342 343 344 345 346 347
          try:
            # Immediately update, because values different for every message
            activity_tool.SQLDict_setPriority(
              uid=[uid],
              priority=priority + 1)
          except:
            LOG('SQLDict', WARNING, 'Failed to increase priority of %r' % (uid, ), error=sys.exc_info())
348
          delay_uid_list.append(uid)
349 350 351 352 353 354 355 356 357 358 359
    if len(deletable_uid_list):
      try:
        activity_tool.SQLDict_delMessage(uid=deletable_uid_list)
      except:
        LOG('SQLDict', PANIC, 'Failed to delete messages %r' % (deletable_uid_list, ), error=sys.exc_info())
      else:
        LOG('SQLDict', TRACE, 'Deleted messages %r' % (deletable_uid_list, ))
    if len(delay_uid_list):
      try:
        # If this is a conflict error, do not lower the priority but only delay.
        activity_tool.SQLDict_setPriority(uid=delay_uid_list, delay=VALIDATION_ERROR_DELAY)
360
      except:
361
        LOG('SQLDict', PANIC, 'Failed to delay %r' % (delay_uid_list, ), error=sys.exc_info())
362
      make_available_uid_list += delay_uid_list
363 364 365 366 367
    if len(final_error_uid_list):
      try:
        activity_tool.SQLDict_assignMessage(uid=final_error_uid_list,
                                            processing_node=INVOKE_ERROR_STATE)
      except:
368
        LOG('SQLDict', PANIC, 'Failed to set message to error state for %r' % (final_error_uid_list, ), error=sys.exc_info())
369 370 371 372 373 374 375
    if len(make_available_uid_list):
      try:
        makeMessageListAvailable(make_available_uid_list)
      except:
        LOG('SQLDict', PANIC, 'Failed to unreserve %r' % (make_available_uid_list, ), error=sys.exc_info())
      else:
        LOG('SQLDict', TRACE, 'Freed messages %r' % (make_available_uid_list, ))
376 377 378 379 380 381 382 383 384 385 386
    try:
      for m in notify_user_list:
        m.notifyUser(activity_tool)
      for m in message_with_active_process_list:
        active_process = activity_tool.unrestrictedTraverse(m.active_process)
        if not active_process.hasActivity():
          # No more activity
          m.notifyUser(activity_tool, message="Process Finished") # XXX commit bas ???
    except:
      # Notification failures must not cause this method to raise.
      LOG('SQLDict', WARNING, 'Exception during notification phase of finalizeMessageExecution', error=sys.exc_info())
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404

  # Queue semantic
  def dequeueMessage(self, activity_tool, processing_node):
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    message_uid_priority_list, count, group_method_id = \
      self.getProcessableMessageList(activity_tool, processing_node)
    if len(message_uid_priority_list):
      # Remove group_id parameter from group_method_id
      if group_method_id is not None:
        group_method_id = group_method_id.split('\0')[0]
      message_list = [x[1] for x in message_uid_priority_list]
      if group_method_id not in (None, ""):
        method  = activity_tool.invokeGroup
        args = (group_method_id, message_list)
      else:
        method = activity_tool.invoke
        args = (message_list[0], )
405 406 407 408 409 410 411 412 413
      # Commit right before executing messages.
      # As MySQL transaction do no start exactly at the same time as ZODB
      # transactions but a bit later, messages available might be called
      # on objects which are not available - or available in an old
      # version - to ZODB connector.
      # So all connectors must be commited now that we have selected
      # everything needed from MySQL to get a fresh view of ZODB objects.
      get_transaction().commit() 
      # Try to invoke
414 415 416 417
      try:
        method(*args)
      except:
        LOG('SQLDict', WARNING, 'Exception raised when invoking messages (uid, path, method_id) %r' % ([(x[0], x[1].object_path, x[1].method_id) for x in message_uid_priority_list], ), error=sys.exc_info())
418
        try:
419
          abortTransactionSynchronously()
420 421
        except:
          # Unfortunately, database adapters may raise an exception against abort.
422
          LOG('SQLDict', PANIC,
423
              'abort failed, thus some objects may be modified accidentally')
424
          return True # Stop processing messages for this tic call for this queue.
425 426 427 428 429 430 431
        to_free_uid_list = [x[0] for x in message_uid_priority_list]
        try:
          makeMessageListAvailable(to_free_uid_list)
        except:
          LOG('SQLDict', PANIC, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (to_free_uid_list))
432 433
      # Abort if something failed.
      if len([x for x in message_uid_priority_list if not x[1].is_executed]) != 0:
434 435 436
        endTransaction = abortTransactionSynchronously
      else:
        endTransaction = get_transaction().commit
Yoshinori Okuji's avatar
Yoshinori Okuji committed
437
      try:
438
        endTransaction()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
439
      except:
440 441 442 443 444 445 446 447
        LOG('SQLDict', WARNING, 'Failed to end transaction for messages (uid, path, method_id) %r' % ([(x[0], x[1].object_path, x[1].method_id) for x in message_uid_priority_list], ), error=sys.exc_info())
        if endTransaction == abortTransactionSynchronously:
          LOG('SQLDict', PANIC, 'Failed to abort executed messages. Some objects may be modified accidentally.')
        else:
          try:
            abortTransactionSynchronously()
          except:
            LOG('SQLDict', PANIC, 'Failed to abort executed messages which also failed to commit. Some objects may be modified accidentally.')
448 449 450 451 452 453 454 455
            return True # Stop processing messages for this tic call for this queue.
        failed_message_uid_list = [x[0] for x in message_uid_priority_list]
        try:
          makeMessageListAvailable(failed_message_uid_list)
        except:
          LOG('SQLDict', PANIC, 'Failed to free remaining messages: %r' % (failed_message_uid_list, ), error=sys.exc_info())
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (failed_message_uid_list, ))
456 457 458
      self.finalizeMessageExecution(activity_tool, message_uid_priority_list)
    get_transaction().commit()
    return not len(message_uid_priority_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
459

460
  def hasActivity(self, activity_tool, object, **kw):
461 462
    hasMessage = getattr(activity_tool, 'SQLDict_hasMessage', None)
    if hasMessage is not None:
463 464
      if object is not None:
        my_object_path = '/'.join(object.getPhysicalPath())
465
        result = hasMessage(path=my_object_path, **kw)
466 467 468 469
        if len(result) > 0:
          return result[0].message_count > 0
      else:
        return 1 # Default behaviour if no object specified is to return 1 until active_process implemented
Jean-Paul Smets's avatar
Jean-Paul Smets committed
470 471
    return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
472
  def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
473 474
    """
      object_path is a tuple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
475 476 477 478 479 480

      commit allows to choose mode
        - if we commit, then we make sure no locks are taken for too long
        - if we do not commit, then we can use flush in a larger transaction

      commit should in general not be used
481 482

      NOTE: commiting is very likely nonsenses here. We should just avoid to flush as much as possible
Jean-Paul Smets's avatar
Jean-Paul Smets committed
483 484
    """
    path = '/'.join(object_path)
485
    # LOG('Flush', 0, str((path, invoke, method_id)))
486
    method_dict = {}
487 488
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
489 490
      # Parse each message in registered
      for m in activity_tool.getRegisteredMessageList(self):
491
        if m.object_path == object_path and (method_id is None or method_id == m.method_id):
492
          #if not method_dict.has_key(method_id or m.method_id):
493 494
          if not method_dict.has_key(m.method_id):
            method_dict[m.method_id] = 1 # Prevents calling invoke twice
495 496
            if invoke:
              # First Validate
497 498
              validate_value = m.validate(self, activity_tool)
              if validate_value is VALID:
499 500 501 502
                activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
                if not m.is_executed:                                                 # Make sure message could be invoked
                  # The message no longer exists
                  raise ActivityFlushError, (
503
                      'Could not evaluate %s on %s' % (m.method_id , path))
504
              elif validate_value is INVALID_PATH:
505 506
                # The message no longer exists
                raise ActivityFlushError, (
507
                    'The document %s does not exist' % path)
508 509 510 511
              else:
                raise ActivityFlushError, (
                    'Could not validate %s on %s' % (m.method_id , path))
          activity_tool.unregisterMessage(self, m)
512
      # Parse each message in SQL dict
513 514
      result = readMessageList(path=path, method_id=method_id,
                               processing_node=None,include_processing=0)
515 516
      for line in result:
        path = line.path
517 518
        line_method_id = line.method_id
        if not method_dict.has_key(line_method_id):
519
          # Only invoke once (it would be different for a queue)
520 521
          # This is optimisation with the goal to process objects on the same
          # node and minimize network traffic with ZEO server
522
          method_dict[line_method_id] = 1
523
          m = self.loadMessage(line.message, uid = line.uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
524 525
          if invoke:
            # First Validate
526
            validate_value = m.validate(self, activity_tool)
Romain Courteaud's avatar
Romain Courteaud committed
527
#             LOG('SQLDict.flush validate_value',0,validate_value)
528
            if validate_value is VALID:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
529
              activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
Romain Courteaud's avatar
Romain Courteaud committed
530
#               LOG('SQLDict.flush m.is_executed',0,m.is_executed)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
531 532 533
              if not m.is_executed:                                                 # Make sure message could be invoked
                # The message no longer exists
                raise ActivityFlushError, (
534
                    'Could not evaluate %s on %s' % (m.method_id , path))
535
            elif validate_value is INVALID_PATH:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
536 537
              # The message no longer exists
              raise ActivityFlushError, (
538
                  'The document %s does not exist' % path)
539 540 541
            else:
              raise ActivityFlushError, (
                  'Could not validate %s on %s' % (m.method_id , path))
542 543

      if len(result):
544
        uid_list = activity_tool.SQLDict_readUidList(path = path, method_id = method_id,
545
                                                     processing_node = None,)
546 547
        if len(uid_list)>0:
          activity_tool.SQLDict_delMessage(uid = [x.uid for x in uid_list])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
548

549
  def getMessageList(self, activity_tool, processing_node=None, include_processing=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
550
    # YO: reading all lines might cause a deadlock
Jean-Paul Smets's avatar
Jean-Paul Smets committed
551
    message_list = []
552 553 554
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
      result = readMessageList(path=None, method_id=None, processing_node=None,
555
                               to_processing_date=None, include_processing=include_processing)
556 557 558 559
      for line in result:
        m = self.loadMessage(line.message, uid = line.uid)
        m.processing_node = line.processing_node
        m.priority = line.priority
560
        m.processing = line.processing
561
        message_list.append(m)
562 563
    return message_list

564 565 566
  def dumpMessageList(self, activity_tool):
    # Dump all messages in the table.
    message_list = []
567 568 569
    dumpMessageList = getattr(activity_tool, 'SQLDict_dumpMessageList', None)
    if dumpMessageList is not None:
      result = dumpMessageList()
570 571 572 573 574
      for line in result:
        m = self.loadMessage(line.message, uid = line.uid)
        message_list.append(m)
    return message_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
575
  def distribute(self, activity_tool, node_count):
576
    offset = 0
577 578
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
579
      now_date = self.getNow(activity_tool)
580
      result = readMessageList(path=None, method_id=None, processing_node=-1,
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
                               to_date=now_date, include_processing=0, offset=offset, count=READ_MESSAGE_LIMIT)
      validated_count = 0
      #TIME_begin = time()
      while len(result) and validated_count < MAX_VALIDATED_LIMIT:
        get_transaction().commit()

        validation_text_dict = {'none': 1}
        message_dict = {}
        for line in result:
          message = self.loadMessage(line.message, uid = line.uid,
                                     order_validation_text = line.order_validation_text)
          self.getExecutableMessageList(activity_tool, message, message_dict,
                                        validation_text_dict, now_date=now_date)
        distributable_count = len(message_dict)
        if distributable_count:
          activity_tool.SQLDict_assignMessage(processing_node=0, uid=[message.uid for message in message_dict.itervalues()])
          validated_count += distributable_count
        if validated_count < MAX_VALIDATED_LIMIT:
          offset += READ_MESSAGE_LIMIT
          result = readMessageList(path=None, method_id=None, processing_node=-1,
                                   to_date=now_date, include_processing=0, offset=offset, count=READ_MESSAGE_LIMIT)
      #TIME_end = time()
      #LOG('SQLDict.distribute', INFO, '%0.4fs : %i messages => %i distributables' % (TIME_end - TIME_begin, offset - READ_MESSAGE_LIMIT + len(result), validated_count))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
604

605
  # Validation private methods
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
  def _validate(self, activity_tool, method_id=None, message_uid=None, path=None, tag=None):
    if isinstance(method_id, str):
      method_id = [method_id]
    if isinstance(path, str):
      path = [path]
    if isinstance(tag, str):
      tag = [tag]

    if method_id or message_uid or path or tag:
      validateMessageList = activity_tool.SQLDict_validateMessageList
      result = validateMessageList(method_id=method_id,
                                   message_uid=message_uid,
                                   path=path,
                                   tag=tag)
      message_list = []
      for line in result:
        m = self.loadMessage(line.message,
                             uid=line.uid,
                             order_validation_text=line.order_validation_text,
                             date=line.date,
                             processing_node=line.processing_node)
        message_list.append(m)
      return message_list
    else:
      return []

632
  def _validate_after_method_id(self, activity_tool, message, value):
633
    return self._validate(activity_tool, method_id=value)
634

635
  def _validate_after_path(self, activity_tool, message, value):
636
    return self._validate(activity_tool, path=value)
637

638
  def _validate_after_message_uid(self, activity_tool, message, value):
639
    return self._validate(activity_tool, message_uid=value)
640

641
  def _validate_after_path_and_method_id(self, activity_tool, message, value):
642 643 644 645 646
    if not isinstance(value, (tuple, list)) or len(value) < 2:
      LOG('CMFActivity', WARNING,
          'unable to recognize value for after_path_and_method_id: %r' % (value,))
      return []
    return self._validate(activity_tool, path=value[0], method_id=value[1])
647

648
  def _validate_after_tag(self, activity_tool, message, value):
649
    return self._validate(activity_tool, tag=value)
650

651 652 653 654 655 656 657 658 659 660 661
  def _validate_after_tag_and_method_id(self, activity_tool, message, value):
    # Count number of occurances of tag and method_id
    if not isinstance(value, (tuple, list)) or len(value) < 2:
      LOG('CMFActivity', WARNING,
          'unable to recognize value for after_tag_and_method_id: %r' % (value,))
      return []
    return self._validate(activity_tool, tag=value[0], method_id=value[1])

  def countMessage(self, activity_tool, tag=None, path=None,
                   method_id=None, message_uid=None, **kw):
    """Return the number of messages which match the given parameters.
Sebastien Robin's avatar
Sebastien Robin committed
662
    """
663
    if isinstance(tag, str):
Sebastien Robin's avatar
Sebastien Robin committed
664
      tag = [tag]
665
    if isinstance(path, str):
Sebastien Robin's avatar
Sebastien Robin committed
666
      path = [path]
Jérome Perrin's avatar
bug.  
Jérome Perrin committed
667
    if isinstance(method_id, str):
Sebastien Robin's avatar
Sebastien Robin committed
668 669 670 671
      method_id = [method_id]
    result = activity_tool.SQLDict_validateMessageList(method_id=method_id, 
                                                       path=path,
                                                       message_uid=message_uid, 
672 673
                                                       tag=tag,
                                                       count=1)
Sebastien Robin's avatar
Sebastien Robin committed
674 675
    return result[0].uid_count

676
  def countMessageWithTag(self, activity_tool, value):
677
    """Return the number of messages which match the given tag.
678
    """
679
    return self.countMessage(activity_tool, tag=value)
680

681
  # Required for tests (time shift)
682
  def timeShift(self, activity_tool, delay, processing_node=None, retry=None):
683 684 685 686
    """
      To simulate timeShift, we simply substract delay from
      all dates in SQLDict message table
    """
687
    activity_tool.SQLDict_timeShift(delay=delay, processing_node=processing_node,retry=retry)
688

Jean-Paul Smets's avatar
Jean-Paul Smets committed
689
registerActivity(SQLDict)