SQLDict.py 34.6 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
      path_list = ['/'.join(message.object_path) for message in registered_message_list]
74
      active_process_uid_list = [message.active_process_uid for message in registered_message_list]
75 76 77
      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]
78
      date_list = [message.activity_kw.get('at_date', None) for message in registered_message_list]
79 80
      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]
81
      tag_list = [message.activity_kw.get('tag', '') for message in registered_message_list]
82
      serialization_tag_list = [message.activity_kw.get('serialization_tag', '') for message in registered_message_list]
83
      order_validation_text_list = [self.getOrderValidationText(message) for message in registered_message_list]
84
      uid_list = activity_tool.getPortalObject().portal_ids.generateNewLengthIdList(id_group='portal_activity', 
85
                   id_count=len(registered_message_list), store=0)
86 87
      activity_tool.SQLDict_writeMessageList( uid_list = uid_list,
                                              path_list = path_list,
88
                                              active_process_uid_list=active_process_uid_list,
89 90 91
                                              method_id_list = method_id_list,
                                              priority_list = priority_list,
                                              message_list = dumped_message_list,
92
                                              date_list = date_list,
93
                                              group_method_id_list = group_method_id_list,
94
                                              tag_list = tag_list,
95
                                              serialization_tag_list = serialization_tag_list,
96
                                              processing_node_list=None,
97
                                              order_validation_text_list = order_validation_text_list)
98

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

109 110 111 112 113 114 115 116
  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

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

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

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

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

154
  def getReservedMessageList(self, activity_tool, date, processing_node, limit=None, group_method_id=None):
155 156 157 158 159 160 161 162 163 164 165
    """
      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.
    """
166
    result = activity_tool.SQLDict_selectReservedMessageList(processing_node=processing_node, count=limit)
167
    if len(result) == 0:
168
      activity_tool.SQLDict_reserveMessageList(count=limit, processing_node=processing_node, to_date=date, group_method_id=group_method_id)
169
      result = activity_tool.SQLDict_selectReservedMessageList(processing_node=processing_node, count=limit)
170 171 172 173 174 175 176 177 178
    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)

179
  def getDuplicateMessageUidList(self, activity_tool, line, processing_node):
180
    """
181 182
      Reserve unreserved messages matching given line.
      Return their uids.
183
    """
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
    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
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

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

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

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

514
  def hasActivity(self, activity_tool, object, method_id=None, only_valid=None, active_process_uid=None):
515 516
    hasMessage = getattr(activity_tool, 'SQLDict_hasMessage', None)
    if hasMessage is not None:
517 518 519 520
      my_object_path = '/'.join(object.getPhysicalPath())
      result = hasMessage(path=my_object_path, method_id=method_id, only_valid=only_valid, active_process_uid=active_process_uid)
      if len(result) > 0:
        return result[0].message_count > 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
521 522
    return 0

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

      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
532 533

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

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

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

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

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

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

  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
691
    """
692
    if isinstance(tag, str):
Sebastien Robin's avatar
Sebastien Robin committed
693
      tag = [tag]
694
    if isinstance(path, str):
Sebastien Robin's avatar
Sebastien Robin committed
695
      path = [path]
Jérome Perrin's avatar
bug.  
Jérome Perrin committed
696
    if isinstance(method_id, str):
Sebastien Robin's avatar
Sebastien Robin committed
697 698 699 700
      method_id = [method_id]
    result = activity_tool.SQLDict_validateMessageList(method_id=method_id, 
                                                       path=path,
                                                       message_uid=message_uid, 
701
                                                       tag=tag,
702
                                                       serialization_tag=None,
703
                                                       count=1)
Sebastien Robin's avatar
Sebastien Robin committed
704 705
    return result[0].uid_count

706
  def countMessageWithTag(self, activity_tool, value):
707
    """Return the number of messages which match the given tag.
708
    """
709
    return self.countMessage(activity_tool, tag=value)
710

711
  # Required for tests (time shift)
712
  def timeShift(self, activity_tool, delay, processing_node=None, retry=None):
713 714 715 716
    """
      To simulate timeShift, we simply substract delay from
      all dates in SQLDict message table
    """
717
    activity_tool.SQLDict_timeShift(delay=delay, processing_node=processing_node,retry=retry)
718

719 720 721 722 723
  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
724
registerActivity(SQLDict)