SQLDict.py 35.5 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
#                    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.
#
##############################################################################

29
from Products.CMFActivity.ActivityTool import registerActivity, MESSAGE_NOT_EXECUTED, MESSAGE_EXECUTED
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
40
from Products.CMFActivity.ActivityRuntimeEnvironment import setActivityRuntimeValue, updateActivityRuntimeValue, clearActivityRuntimeEnvironment
41
from zExceptions import ExceptionFormatter
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42

43 44 45 46 47
try:
  from transaction import get as get_transaction
except ImportError:
  pass

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

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

59
class SQLDict(RAMDict, SQLBase):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
60 61 62 63 64
  """
    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
65
  # Transaction commit methods
66 67 68 69 70 71
  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:
72
      #LOG('SQLDict prepareQueueMessageList', 0, 'registered_message_list = %r' % (registered_message_list,))
73 74 75 76
      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]
77
      date_list = [message.activity_kw.get('at_date', None) for message in registered_message_list]
78 79
      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]
80
      tag_list = [message.activity_kw.get('tag', '') for message in registered_message_list]
81
      serialization_tag_list = [message.activity_kw.get('serialization_tag', '') for message in registered_message_list]
82
      order_validation_text_list = [self.getOrderValidationText(message) for message in registered_message_list]
83
      uid_list = activity_tool.getPortalObject().portal_ids.generateNewLengthIdList(id_group='portal_activity', 
84
                   id_count=len(registered_message_list), store=0)
85 86
      activity_tool.SQLDict_writeMessageList( uid_list = uid_list,
                                              path_list = path_list,
87 88 89
                                              method_id_list = method_id_list,
                                              priority_list = priority_list,
                                              message_list = dumped_message_list,
90
                                              date_list = date_list,
91
                                              group_method_id_list = group_method_id_list,
92
                                              tag_list = tag_list,
93
                                              serialization_tag_list = serialization_tag_list,
94
                                              order_validation_text_list = order_validation_text_list)
95

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

107 108 109 110 111 112 113 114
  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

115
  # Registration management
Jean-Paul Smets's avatar
Jean-Paul Smets committed
116
  def registerActivityBuffer(self, activity_buffer):
117
    pass
118

119 120
  def generateMessageUID(self, m):
    return (tuple(m.object_path), m.method_id, m.activity_kw.get('tag'), m.activity_kw.get('group_id'))
121

Jean-Paul Smets's avatar
Jean-Paul Smets committed
122 123
  def unregisterMessage(self, activity_buffer, activity_tool, m):
    m.is_registered = 0 # This prevents from inserting deleted messages into the queue
124
    class_name = self.__class__.__name__
125
    uid_set = activity_buffer.getUidSet(self)
126
    uid_set.discard(self.generateMessageUID(m))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127 128

  def getRegisteredMessageList(self, activity_buffer, activity_tool):
129 130
    message_list = activity_buffer.getMessageList(self)
    return [m for m in message_list if m.is_registered]
131
  
132
  def validateMessage(self, activity_tool, message, uid_list, priority, processing_node):
133
    validation_state = message.validate(self, activity_tool, check_order_validation=0)
134
    if validation_state is not VALID:
135 136 137 138 139 140 141 142
      # 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
143
      else:
144 145 146 147
        # 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)
148 149 150
        get_transaction().commit() # Release locks before starting a potentially long calculation
      return 0
    return 1
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
  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)

177
  def getDuplicateMessageUidList(self, activity_tool, line, processing_node):
178
    """
179 180
      Reserve unreserved messages matching given line.
      Return their uids.
181
    """
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    try:
      result = activity_tool.SQLDict_selectDuplicatedLineList(
        path=line.path,
        method_id=line.method_id,
        group_method_id=line.group_method_id,
        order_validation_text=line.order_validation_text
      )
      uid_list = [x.uid for x in result]
      if len(uid_list):
        activity_tool.SQLDict_reserveDuplicatedLineList(
          processing_node=processing_node,
          uid_list=uid_list
        )
      else:
        # Release locks
        activity_tool.SQLDict_commit()
    except:
      # Log
      LOG('SQLDict', WARNING, 'getDuplicateMessageUidList got an exception', error=sys.exc_info())
      # Release lock
      activity_tool.SQLDict_rollback()
      # And re-raise
      raise
    return uid_list
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

  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:
231
        4-tuple:
232 233 234 235 236 237
          - list of 3-tuple:
            - message uid
            - message
            - priority
          - impacted object count
          - group_method_id
238
          - uid_to_duplicate_uid_list_dict
239 240 241 242 243 244 245 246 247
    """
    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
248 249 250 251 252 253
    def getDuplicateMessageUidList(line):
      uid_list = self.getDuplicateMessageUidList(activity_tool=activity_tool, 
        line=line, processing_node=processing_node)
      if len(uid_list):
        LOG('SQLDict', TRACE, 'Reserved duplicate messages: %r' % (uid_list, ))
      return uid_list
254 255 256 257 258 259 260 261 262 263 264 265
    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)
266
      uid_to_duplicate_uid_list_dict = {}
267 268
      if len(result) > 0:
        line = result[0]
269
        m = self.loadMessage(line.message, uid=line.uid)
270 271 272
        append(line, m)
        group_method_id = line.group_method_id
        activity_tool.SQLDict_processMessage(uid=[line.uid])
273
        uid_to_duplicate_uid_list_dict.setdefault(line.uid, []).extend(getDuplicateMessageUidList(line))
274
        if group_method_id not in (None, '', '\0'):
275
          # Count the number of objects to prevent too many objects.
276
          count += len(m.getObjectList(activity_tool))
277 278
          if count < MAX_GROUPED_OBJECTS:
            # Retrieve objects which have the same group method.
279
            result = getReservedMessageList(limit=BUNDLE_MESSAGE_COUNT, group_method_id=group_method_id)
280
            path_and_method_id_dict = {}
281
            unreserve_uid_list = []
282
            for line in result:
283 284 285 286
              # 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.
287 288 289
              # So what remains to be filtered on are path, method_id and
              # order_validation_text.
              key = (line.path, line.method_id, line.order_validation_text)
290 291 292
              original_uid = path_and_method_id_dict.get(key)
              if original_uid is not None:
                uid_to_duplicate_uid_list_dict.setdefault(original_uid, []).append(line.uid)
293
                continue
294
              path_and_method_id_dict[key] = line.uid
295
              uid_to_duplicate_uid_list_dict.setdefault(line.uid, []).extend(getDuplicateMessageUidList(line))
296 297 298 299
              if count < MAX_GROUPED_OBJECTS:
                m = self.loadMessage(line.message, uid=line.uid)
                count += len(m.getObjectList(activity_tool))
                append(line, m)
300
              else:
301 302 303 304
                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)
305
      return message_list, count, group_method_id, uid_to_duplicate_uid_list_dict
306 307 308 309 310 311 312
    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:
313
          LOG('SQLDict', ERROR, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
314
        else:
315 316 317 318
          if len(to_free_uid_list):
            LOG('SQLDict', TRACE, 'Freed messages %r' % (to_free_uid_list, ))
      else:
        LOG('SQLDict', TRACE, '(no message was reserved)')
319
      return [], 0, None, {}
320

321
  def finalizeMessageExecution(self, activity_tool, message_uid_priority_list, uid_to_duplicate_uid_list_dict):
322 323 324 325 326 327 328 329 330 331
    """
      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.
    """
332 333 334 335 336
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    deletable_uid_list = []
    delay_uid_list = []
    final_error_uid_list = []
337
    make_available_uid_list = []
338
    message_with_active_process_list = []
339
    notify_user_list = []
340
    non_executable_message_list = []
341
    something_failed = (len([x for x in message_uid_priority_list if x[1].getExecutionState() == MESSAGE_NOT_EXECUTED]) != 0)
342
    for uid, m, priority in message_uid_priority_list:
343
      if m.getExecutionState() == MESSAGE_EXECUTED:
344 345
        if something_failed:
          make_available_uid_list.append(uid)
346
          make_available_uid_list.extend(uid_to_duplicate_uid_list_dict.get(uid, []))
347 348
        else:
          deletable_uid_list.append(uid)
349
          deletable_uid_list.extend(uid_to_duplicate_uid_list_dict.get(uid, []))
350
          if m.active_process:
351 352
            # XXX: Bug here: Even if a duplicate message has an active_process,
            # it won't be called on the duplicate.
353
            message_with_active_process_list.append(m)
354
      elif m.getExecutionState() == MESSAGE_NOT_EXECUTED:
355 356
        # Should duplicate messages follow strictly the original message, or
        # should they be just made available again ?
357
        make_available_uid_list.extend(uid_to_duplicate_uid_list_dict.get(uid, []))
Vincent Pelletier's avatar
Vincent Pelletier committed
358 359
        if type(m.exc_type) is ClassType and \
           issubclass(m.exc_type, ConflictError):
360 361
          delay_uid_list.append(uid)
        elif priority > MAX_PRIORITY:
362
          notify_user_list.append(m)
363
          final_error_uid_list.append(uid)
364
        else:
365 366 367 368 369 370 371
          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())
372
          delay_uid_list.append(uid)
373 374 375 376 377
      else:
        # Internal CMFActivity error: the message can not be executed because
        # something is missing (context object cannot be found, method cannot
        # be accessed on object).
        non_executable_message_list.append(uid)
378 379
    if len(deletable_uid_list):
      try:
380
        self._retryOnLockError(activity_tool.SQLDict_delMessage, kw={'uid': deletable_uid_list})
381
      except:
382
        LOG('SQLDict', ERROR, 'Failed to delete messages %r' % (deletable_uid_list, ), error=sys.exc_info())
383 384 385 386 387 388
      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)
389
      except:
390
        LOG('SQLDict', ERROR, 'Failed to delay %r' % (delay_uid_list, ), error=sys.exc_info())
391
      make_available_uid_list += delay_uid_list
392 393 394 395 396
    if len(final_error_uid_list):
      try:
        activity_tool.SQLDict_assignMessage(uid=final_error_uid_list,
                                            processing_node=INVOKE_ERROR_STATE)
      except:
397
        LOG('SQLDict', ERROR, 'Failed to set message to error state for %r' % (final_error_uid_list, ), error=sys.exc_info())
398 399 400 401 402
    if len(non_executable_message_list):
      try:
        activity_tool.SQLDict_assignMessage(uid=non_executable_message_list, processing_node=VALIDATE_ERROR_STATE)
      except:
        LOG('SQLDict', ERROR, 'Failed to set message to invalid path state for %r' % (non_executable_message_list, ), error=sys.exc_info())
403 404 405 406
    if len(make_available_uid_list):
      try:
        makeMessageListAvailable(make_available_uid_list)
      except:
407
        LOG('SQLDict', ERROR, 'Failed to unreserve %r' % (make_available_uid_list, ), error=sys.exc_info())
408 409
      else:
        LOG('SQLDict', TRACE, 'Freed messages %r' % (make_available_uid_list, ))
410 411 412 413 414 415 416 417 418 419 420
    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())
421 422 423

  # Queue semantic
  def dequeueMessage(self, activity_tool, processing_node):
424 425 426 427 428 429 430 431
    def makeMessageListAvailable(uid_list, uid_to_duplicate_uid_list_dict):
      final_uid_list = []
      for uid in uid_list:
        final_uid_list.append(uid)
        final_uid_list.extend(uid_to_duplicate_uid_list_dict.get(uid, []))
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=final_uid_list)
    message_uid_priority_list, count, group_method_id, \
      uid_to_duplicate_uid_list_dict = \
432 433 434 435 436 437
      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]
438
      clearActivityRuntimeEnvironment()
439
      if group_method_id not in (None, ""):
440
        setActivityRuntimeValue('group_method_id', group_method_id)
441 442 443 444
        method  = activity_tool.invokeGroup
        args = (group_method_id, message_list)
      else:
        method = activity_tool.invoke
445 446 447 448 449 450
        message = message_list[0]
        args = (message, )
        updateActivityRuntimeValue({'activity_kw': message.activity_kw,
                                    'priority': message_uid_priority_list[0][2],
                                    'uid': message_uid_priority_list[0][0]})
      setActivityRuntimeValue('processing_node', processing_node)
451 452 453 454 455 456 457 458 459
      # 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
460 461 462 463
      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())
464
        try:
465
          abortTransactionSynchronously()
466 467
        except:
          # Unfortunately, database adapters may raise an exception against abort.
468
          LOG('SQLDict', PANIC,
469
              'abort failed, thus some objects may be modified accidentally')
470
          raise
471 472
        to_free_uid_list = [x[0] for x in message_uid_priority_list]
        try:
473
          makeMessageListAvailable(to_free_uid_list, uid_to_duplicate_uid_list_dict)
474
        except:
475
          LOG('SQLDict', ERROR, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
476 477
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (to_free_uid_list))
478
      # Abort if something failed.
479
      if len([x for x in message_uid_priority_list if x[1].getExecutionState() == MESSAGE_NOT_EXECUTED]) != 0:
480 481 482
        endTransaction = abortTransactionSynchronously
      else:
        endTransaction = get_transaction().commit
Yoshinori Okuji's avatar
Yoshinori Okuji committed
483
      try:
484
        endTransaction()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
485
      except:
486 487 488 489 490 491 492 493
        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.')
494
            raise
495
        exc_info = sys.exc_info()
496
        for x in message_uid_priority_list:
497
          x[1].setExecutionState(MESSAGE_NOT_EXECUTED, exc_info=exc_info, log=False)
498 499
        failed_message_uid_list = [x[0] for x in message_uid_priority_list]
        try:
500
          makeMessageListAvailable(failed_message_uid_list, uid_to_duplicate_uid_list_dict)
501
        except:
502
          LOG('SQLDict', ERROR, 'Failed to free remaining messages: %r' % (failed_message_uid_list, ), error=sys.exc_info())
503 504
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (failed_message_uid_list, ))
505
      self.finalizeMessageExecution(activity_tool, message_uid_priority_list, uid_to_duplicate_uid_list_dict)
506 507
    get_transaction().commit()
    return not len(message_uid_priority_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
508

509
  def hasActivity(self, activity_tool, object, **kw):
510 511
    hasMessage = getattr(activity_tool, 'SQLDict_hasMessage', None)
    if hasMessage is not None:
512 513
      if object is not None:
        my_object_path = '/'.join(object.getPhysicalPath())
514
        result = hasMessage(path=my_object_path, **kw)
515 516 517 518
        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
519 520
    return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
521
  def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
522 523
    """
      object_path is a tuple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
524 525 526 527 528 529

      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
530 531

      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
532 533
    """
    path = '/'.join(object_path)
534
    # LOG('Flush', 0, str((path, invoke, method_id)))
535
    method_dict = {}
536 537
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
538 539
      # Parse each message in registered
      for m in activity_tool.getRegisteredMessageList(self):
540
        if m.object_path == object_path and (method_id is None or method_id == m.method_id):
541
          #if not method_dict.has_key(method_id or m.method_id):
542 543
          if not method_dict.has_key(m.method_id):
            method_dict[m.method_id] = 1 # Prevents calling invoke twice
544
            if invoke:
545 546
              # First Validate
              validate_value = m.validate(self, activity_tool)
547
              if validate_value is VALID:
548
                activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
549
                if m.getExecutionState() != MESSAGE_EXECUTED:                                                 # Make sure message could be invoked
550 551
                  # The message no longer exists
                  raise ActivityFlushError, (
552
                      'Could not evaluate %s on %s' % (m.method_id , path))
553
              elif validate_value is INVALID_PATH:
554 555
                # The message no longer exists
                raise ActivityFlushError, (
556
                    'The document %s does not exist' % path)
557 558 559 560
              else:
                raise ActivityFlushError, (
                    'Could not validate %s on %s' % (m.method_id , path))
          activity_tool.unregisterMessage(self, m)
561
      # Parse each message in SQL dict
562 563
      result = readMessageList(path=path, method_id=method_id,
                               processing_node=None,include_processing=0)
564 565
      for line in result:
        path = line.path
566 567
        line_method_id = line.method_id
        if not method_dict.has_key(line_method_id):
568
          # Only invoke once (it would be different for a queue)
569 570
          # This is optimisation with the goal to process objects on the same
          # node and minimize network traffic with ZEO server
571
          method_dict[line_method_id] = 1
572
          m = self.loadMessage(line.message, uid = line.uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
573
          if invoke:
574 575 576 577 578
            # First Validate (only if message is marked as new)
            if line.processing_node == -1:
              validate_value = m.validate(self, activity_tool)
            else:
              validate_value = VALID
Romain Courteaud's avatar
Romain Courteaud committed
579
#             LOG('SQLDict.flush validate_value',0,validate_value)
580
            if validate_value is VALID:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
581
              activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
582
              if m.getExecutionState() != MESSAGE_EXECUTED:                                                 # Make sure message could be invoked
Jean-Paul Smets's avatar
Jean-Paul Smets committed
583 584
                # The message no longer exists
                raise ActivityFlushError, (
585
                    'Could not evaluate %s on %s' % (m.method_id , path))
586
            elif validate_value is INVALID_PATH:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
587 588
              # The message no longer exists
              raise ActivityFlushError, (
589
                  'The document %s does not exist' % path)
590 591 592
            else:
              raise ActivityFlushError, (
                  'Could not validate %s on %s' % (m.method_id , path))
593 594

      if len(result):
595
        uid_list = activity_tool.SQLDict_readUidList(path = path, method_id = method_id,
596
                                                     processing_node = None,)
597 598
        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
599

600
  def getMessageList(self, activity_tool, processing_node=None, include_processing=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
601
    # YO: reading all lines might cause a deadlock
Jean-Paul Smets's avatar
Jean-Paul Smets committed
602
    message_list = []
603 604 605
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
      result = readMessageList(path=None, method_id=None, processing_node=None,
606
                               to_processing_date=None, include_processing=include_processing)
607 608 609 610
      for line in result:
        m = self.loadMessage(line.message, uid = line.uid)
        m.processing_node = line.processing_node
        m.priority = line.priority
611
        m.processing = line.processing
612
        message_list.append(m)
613 614
    return message_list

615 616 617
  def dumpMessageList(self, activity_tool):
    # Dump all messages in the table.
    message_list = []
618 619 620
    dumpMessageList = getattr(activity_tool, 'SQLDict_dumpMessageList', None)
    if dumpMessageList is not None:
      result = dumpMessageList()
621 622 623 624 625
      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
626
  def distribute(self, activity_tool, node_count):
627
    offset = 0
628 629
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
630
      now_date = self.getNow(activity_tool)
631
      result = readMessageList(path=None, method_id=None, processing_node=-1,
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
                               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
655

656
  # Validation private methods
657 658
  def _validate(self, activity_tool, method_id=None, message_uid=None, path=None, tag=None,
                serialization_tag=None):
659 660 661 662 663 664 665
    if isinstance(method_id, str):
      method_id = [method_id]
    if isinstance(path, str):
      path = [path]
    if isinstance(tag, str):
      tag = [tag]

666
    if method_id or message_uid or path or tag or serialization_tag:
667 668 669 670
      validateMessageList = activity_tool.SQLDict_validateMessageList
      result = validateMessageList(method_id=method_id,
                                   message_uid=message_uid,
                                   path=path,
671 672
                                   tag=tag,
                                   serialization_tag=serialization_tag)
673 674 675 676 677 678 679 680 681 682 683 684
      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 []

685
  def _validate_after_method_id(self, activity_tool, message, value):
686
    return self._validate(activity_tool, method_id=value)
687

688
  def _validate_after_path(self, activity_tool, message, value):
689
    return self._validate(activity_tool, path=value)
690

691
  def _validate_after_message_uid(self, activity_tool, message, value):
692
    return self._validate(activity_tool, message_uid=value)
693

694
  def _validate_after_path_and_method_id(self, activity_tool, message, value):
695
    if not (isinstance(value, (tuple, list)) or len(value) == 2):
696 697 698 699
      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])
700

701
  def _validate_after_tag(self, activity_tool, message, value):
702
    return self._validate(activity_tool, tag=value)
703

704 705 706 707 708 709 710 711
  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])

712 713 714
  def _validate_serialization_tag(self, activity_tool, message, value):
    return self._validate(activity_tool, serialization_tag=value)

715 716 717
  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
718
    """
719
    if isinstance(tag, str):
Sebastien Robin's avatar
Sebastien Robin committed
720
      tag = [tag]
721
    if isinstance(path, str):
Sebastien Robin's avatar
Sebastien Robin committed
722
      path = [path]
Jérome Perrin's avatar
bug.  
Jérome Perrin committed
723
    if isinstance(method_id, str):
Sebastien Robin's avatar
Sebastien Robin committed
724 725 726 727
      method_id = [method_id]
    result = activity_tool.SQLDict_validateMessageList(method_id=method_id, 
                                                       path=path,
                                                       message_uid=message_uid, 
728 729
                                                       tag=tag,
                                                       count=1)
Sebastien Robin's avatar
Sebastien Robin committed
730 731
    return result[0].uid_count

732
  def countMessageWithTag(self, activity_tool, value):
733
    """Return the number of messages which match the given tag.
734
    """
735
    return self.countMessage(activity_tool, tag=value)
736

737
  # Required for tests (time shift)
738
  def timeShift(self, activity_tool, delay, processing_node=None, retry=None):
739 740 741 742
    """
      To simulate timeShift, we simply substract delay from
      all dates in SQLDict message table
    """
743
    activity_tool.SQLDict_timeShift(delay=delay, processing_node=processing_node,retry=retry)
744

745 746 747 748 749
  def getPriority(self, activity_tool):
    method = activity_tool.SQLDict_getPriority
    default =  RAMDict.getPriority(self, activity_tool)
    return self._getPriority(activity_tool, method, default)

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