SQLQueue.py 25.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
from RAMQueue import RAMQueue
31 32
from Queue import VALID, INVALID_PATH, VALIDATION_ERROR_DELAY, \
        abortTransactionSynchronously
33
from Products.CMFActivity.ActiveObject import INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE
34
from Products.CMFActivity.Errors import ActivityFlushError
Romain Courteaud's avatar
Romain Courteaud committed
35
from ZODB.POSException import ConflictError
36
from types import ClassType
37
import sys
38
from time import time
39 40
from sets import ImmutableSet
from SQLBase import SQLBase
41
from Products.CMFActivity.ActivityRuntimeEnvironment import setActivityRuntimeValue, updateActivityRuntimeValue, clearActivityRuntimeEnvironment
42
from zExceptions import ExceptionFormatter
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43

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

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

51
MAX_PRIORITY = 5
52 53 54 55 56
# Stop validating more messages when this limit is reached
MAX_VALIDATED_LIMIT = 1000
# Read this many messages to validate.
READ_MESSAGE_LIMIT = 1000
# Process this many messages in each dequeueMessage call.
57 58 59 60 61 62 63 64 65 66
# Downside of setting to a "small" value: the cost of reserving a batch of
# few messages increases relatively to the cost of executing activities,
# making CMFActivity overhead significant.
# Downside of setting to a "big" value: if there are many slow activities in
# a multi-activity-node environment, multiple slow activities will be reserved
# by a single node, making a suboptimal use of the parallelisation offered by
# the cluster.
# Before increasing this value, consider using SQLDict with group methods
# first.
MESSAGE_BUNDLE_SIZE = 1
67 68

class SQLQueue(RAMQueue, SQLBase):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71 72
    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
73
  """
74 75 76 77 78 79 80 81

  def prepareQueueMessageList(self, activity_tool, message_list):
    registered_message_list = [m for m in message_list if m.is_registered]
    if len(registered_message_list):
      uid_list = activity_tool.getPortalObject().portal_ids.generateNewLengthIdList(
        id_group='portal_activity_queue', id_count=len(registered_message_list),
        store=0)
      path_list = ['/'.join(m.object_path) for m in registered_message_list]
82
      active_process_uid_list = [m.active_process_uid for m in registered_message_list]
83 84 85 86 87 88 89 90
      method_id_list = [m.method_id for m in registered_message_list]
      priority_list = [m.activity_kw.get('priority', 1) for m in registered_message_list]
      date_list = [m.activity_kw.get('at_date', None) for m in registered_message_list]
      tag_list = [m.activity_kw.get('tag', '') for m in registered_message_list]
      serialization_tag_list = [m.activity_kw.get('serialization_tag', '') for m in registered_message_list]
      message_list = [self.dumpMessage(m) for m in registered_message_list]
      activity_tool.SQLQueue_writeMessageList(uid_list=uid_list,
                                              path_list=path_list,
91
                                              active_process_uid_list=active_process_uid_list,
92 93 94 95 96
                                              method_id_list=method_id_list,
                                              priority_list=priority_list,
                                              message_list=message_list,
                                              date_list=date_list,
                                              tag_list=tag_list,
97
                                              processing_node_list=None,
98
                                              serialization_tag_list=serialization_tag_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
99

100 101
  def prepareDeleteMessage(self, activity_tool, m):
    # Erase all messages in a single transaction
102
    #LOG("prepareDeleteMessage", 0, str(m.__dict__))
103
    activity_tool.SQLQueue_delMessage(uid = [m.uid])
104

105 106 107 108 109 110 111 112
  def finishQueueMessage(self, activity_tool_path, m):
    # Nothing to do in SQLQueue.
    pass

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

113 114 115 116 117 118 119 120 121 122 123 124
  def getReservedMessageList(self, activity_tool, date, processing_node, limit=None):
    """
      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.
    """
125
    result = activity_tool.SQLQueue_selectReservedMessageList(processing_node=processing_node, count=limit)
126
    if len(result) == 0:
127 128
      activity_tool.SQLQueue_reserveMessageList(count=limit, processing_node=processing_node, to_date=date)
      result = activity_tool.SQLQueue_selectReservedMessageList(processing_node=processing_node, count=limit)
129
    return result
130

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
  def makeMessageListAvailable(self, activity_tool, uid_list):
    """
      Put messages back in processing_node=0 .
    """
    if len(uid_list):
      activity_tool.SQLQueue_makeMessageListAvailable(uid_list=uid_list)

  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

      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:
        list of 3-tuple:
          - message uid
          - message
          - priority
    """
    def getReservedMessageList(limit):
      line_list = self.getReservedMessageList(activity_tool=activity_tool,
                                              date=now_date,
                                              processing_node=processing_node,
                                              limit=limit)
      if len(line_list):
        LOG('SQLQueue', TRACE, 'Reserved messages: %r' % ([x.uid for x in line_list]))
      return line_list
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    now_date = self.getNow(activity_tool)
    message_list = []
    def append(line, message):
      uid = line.uid
      message_list.append((uid, message, line.priority))
    try:
      result = getReservedMessageList(limit=MESSAGE_BUNDLE_SIZE)
      for line in result:
        m = self.loadMessage(line.message, uid=line.uid)
        append(line, m)
      if len(message_list):
        activity_tool.SQLQueue_processMessage(uid=[x[0] for x in message_list])
      return message_list
    except:
      LOG('SQLQueue', WARNING, 'Exception while reserving messages.', error=sys.exc_info())
      if len(message_list):
        to_free_uid_list = [x[0] for x in message_list]
194
        try:
195
          makeMessageListAvailable(to_free_uid_list)
196
        except:
197
          LOG('SQLQueue', ERROR, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
198 199 200 201 202 203 204 205 206 207 208 209 210 211
        else:
          if len(to_free_uid_list):
            LOG('SQLQueue', TRACE, 'Freed messages %r' % (to_free_uid_list, ))
      else:
        LOG('SQLQueue', TRACE, '(no message was reserved)')
      return []

  def finalizeMessageExecution(self, activity_tool, message_uid_priority_list):
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    deletable_uid_list = []
    delay_uid_list = []
    final_error_uid_list = []
    message_with_active_process_list = []
212
    notify_user_list = []
213
    non_executable_message_list = []
214
    for uid, m, priority in message_uid_priority_list:
215
      if m.getExecutionState() == MESSAGE_EXECUTED:
216 217 218
        deletable_uid_list.append(uid)
        if m.active_process:
          message_with_active_process_list.append(m)
219
      elif m.getExecutionState() == MESSAGE_NOT_EXECUTED:
Vincent Pelletier's avatar
Vincent Pelletier committed
220 221
        if type(m.exc_type) is ClassType and \
           issubclass(m.exc_type, ConflictError):
222 223
          delay_uid_list.append(uid)
        elif priority > MAX_PRIORITY:
224
          notify_user_list.append(m)
225 226 227 228 229 230 231 232 233 234 235 236 237
          final_error_uid_list.append(uid)
        else:
          try:
            # Immediately update, because values different for every message
            activity_tool.SQLQueue_setPriority(
              uid=[uid],
              delay=VALIDATION_ERROR_DELAY,
              priority=priority + 1)
          except:
            LOG('SQLQueue', WARNING, 'Failed to increase priority of %r' % (uid, ), error=sys.exc_info())
          try:
            makeMessageListAvailable(delay_uid_list)
          except:
238
            LOG('SQLQueue', ERROR, 'Failed to unreserve %r' % (uid, ), error=sys.exc_info())
239 240
          else:
            LOG('SQLQueue', TRACE, 'Freed message %r' % (uid, ))
241 242 243 244 245
      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)
246 247
    if len(deletable_uid_list):
      try:
248
        self._retryOnLockError(activity_tool.SQLQueue_delMessage, kw={'uid': deletable_uid_list})
249
      except:
250
        LOG('SQLQueue', ERROR, 'Failed to delete messages %r' % (deletable_uid_list, ), error=sys.exc_info())
251 252 253 254 255
      else:
        LOG('SQLQueue', 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.
256
        activity_tool.SQLQueue_setPriority(uid=delay_uid_list, delay=VALIDATION_ERROR_DELAY, priority=None)
257
      except:
258
        LOG('SQLQueue', ERROR, 'Failed to delay %r' % (delay_uid_list, ), error=sys.exc_info())
259 260 261
      try:
        makeMessageListAvailable(delay_uid_list)
      except:
262
        LOG('SQLQueue', ERROR, 'Failed to unreserve %r' % (delay_uid_list, ), error=sys.exc_info())
263 264 265 266 267 268 269
      else:
        LOG('SQLQueue', TRACE, 'Freed messages %r' % (delay_uid_list, ))
    if len(final_error_uid_list):
      try:
        activity_tool.SQLQueue_assignMessage(uid=final_error_uid_list,
                                             processing_node=INVOKE_ERROR_STATE)
      except:
270
        LOG('SQLQueue', ERROR, 'Failed to set message to error state for %r' % (final_error_uid_list, ), error=sys.exc_info())
271 272 273 274 275 276
    if len(non_executable_message_list):
      try:
        activity_tool.SQLQueue_assignMessage(uid=non_executable_message_list,
                                             processing_node=VALIDATE_ERROR_STATE)
      except:
        LOG('SQLQueue', ERROR, 'Failed to set message to invalid path state for %r' % (final_error_uid_list, ), error=sys.exc_info())
277 278 279 280 281 282 283 284 285 286 287
    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('SQLQueue', WARNING, 'Exception during notification phase of finalizeMessageExecution', error=sys.exc_info())
288

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  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 = \
      self.getProcessableMessageList(activity_tool, processing_node)
    if len(message_uid_priority_list):
      processing_stop_time = time() + 30 # Stop processing after more than 10 seconds were spent
      processed_message_uid_list = []
      # 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()
      for value in message_uid_priority_list:
306 307 308 309 310
        clearActivityRuntimeEnvironment()
        updateActivityRuntimeValue({'processing_node': processing_node,
                                    'activity_kw': value[1].activity_kw,
                                    'priority': value[2],
                                    'uid': value[0]})
311 312
        processed_message_uid_list.append(value)
        # Try to invoke
313
        try:
314
          activity_tool.invoke(value[1])
315
          if value[1].getExecutionState() != MESSAGE_NOT_EXECUTED:
316 317 318 319 320 321 322 323
            # Commit so that if a message raises it doesn't causes previous
            # successfull messages to be rolled back. This commit might fail,
            # so it is protected the same way as activity execution by the
            # same "try" block.
            get_transaction().commit()
          else:
            # This message failed, revert.
            abortTransactionSynchronously()
324
        except:
325 326 327 328 329 330
          LOG('SQLQueue', WARNING, 'Exception raised when invoking message (uid, path, method_id) %r' % ((value[0], value[1].object_path, value[1].method_id), ), error=sys.exc_info())
          try:
            abortTransactionSynchronously()
          except:
            # Unfortunately, database adapters may raise an exception against abort.
            LOG('SQLQueue', PANIC, 'abort failed, thus some objects may be modified accidentally')
331
            raise
332 333 334
          # We must make sure that the message is not set as executed.
          # It is possible that the message is executed but the commit
          # of the transaction fails
335
          value[1].setExecutionState(MESSAGE_NOT_EXECUTED, context=activity_tool)
336 337 338
          try:
            makeMessageListAvailable([value[0]])
          except:
339
            LOG('SQLQueue', ERROR, 'Failed to free message: %r' % (value, ), error=sys.exc_info())
340 341 342 343 344 345 346 347 348 349 350 351
          else:
            LOG('SQLQueue', TRACE, 'Freed message %r' % (value, ))
        if time() > processing_stop_time:
          LOG('SQLQueue', TRACE, 'Stop processing message batch because processing delay exceeded')
          break
      # Release all unprocessed messages
      processed_uid_set = ImmutableSet([x[0] for x in processed_message_uid_list])
      to_free_uid_list = [x[0] for x in message_uid_priority_list if x[0] not in processed_uid_set]
      if len(to_free_uid_list):
        try:
          makeMessageListAvailable(to_free_uid_list)
        except:
352
          LOG('SQLQueue', ERROR, 'Failed to free remaining messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
353
        else:
354
          LOG('SQLQueue', TRACE, 'Freed messages %r' % (to_free_uid_list, ))
355 356 357 358
      self.finalizeMessageExecution(activity_tool, processed_message_uid_list)
    get_transaction().commit()
    return not len(message_uid_priority_list)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
359

360
  def hasActivity(self, activity_tool, object, method_id=None, only_valid=None, active_process_uid=None):
361 362
    hasMessage = getattr(activity_tool, 'SQLQueue_hasMessage', None)
    if hasMessage is not None:
363 364 365 366
      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
367
    return 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
368

369
  def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
370 371
    """
      object_path is a tuple
372 373 374 375 376 377 378 379

      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

      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
380
    """
381 382
    readMessageList = getattr(activity_tool, 'SQLQueue_readMessageList', None)
    if readMessageList is not None:
383 384 385 386 387 388
      #return # Do nothing here to precent overlocking
      path = '/'.join(object_path)
      # Parse each message in registered
      for m in activity_tool.getRegisteredMessageList(self):
        if object_path == m.object_path and (method_id is None or method_id == m.method_id):
          if invoke:
389 390
            # First Validate
            validate_value = m.validate(self, activity_tool)
391
            if validate_value is VALID:
392
              activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
393
              if m.getExecutionState() != MESSAGE_EXECUTED:                                                 # Make sure message could be invoked
394 395
                # The message no longer exists
                raise ActivityFlushError, (
396 397
                    'Could not evaluate %s on %s' % (m.method_id , path))
            elif validate_value is INVALID_PATH:
398 399
              # The message no longer exists
              raise ActivityFlushError, (
400
                  'The document %s does not exist' % path)
401 402 403 404 405
            else:
              raise ActivityFlushError, (
                  'Could not validate %s on %s' % (m.method_id , path))
          activity_tool.unregisterMessage(self, m)
      # Parse each message in SQL queue
406
      result = readMessageList(path=path, method_id=method_id, processing_node=None, to_date=None, include_processing=0)
407 408 409 410 411
      for line in result:
        path = line.path
        method_id = line.method_id
        m = self.loadMessage(line.message, uid = line.uid)
        if invoke:
412 413 414 415 416
          # 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
417 418
          if validate_value is VALID:
            activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
419
            if m.getExecutionState() != MESSAGE_EXECUTED:                                                 # Make sure message could be invoked
420 421 422 423 424 425 426 427 428 429
              # The message no longer exists
              raise ActivityFlushError, (
                  'Could not evaluate %s on %s' % (method_id , path))
          elif validate_value is INVALID_PATH:
            # The message no longer exists
            raise ActivityFlushError, (
                'The document %s does not exist' % path)
          else:
            raise ActivityFlushError, (
                'Could not validate %s on %s' % (m.method_id , path))
430 431 432

      if len(result):
        activity_tool.SQLQueue_delMessage(uid = [line.uid for line in result])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
433

434
  def getMessageList(self, activity_tool, processing_node=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
435
    message_list = []
436 437
    readMessageList = getattr(activity_tool, 'SQLQueue_readMessageList', None)
    if readMessageList is not None:
438
      result = readMessageList(path=None, method_id=None, processing_node=None, to_date=None, include_processing=0)
439 440 441 442 443
      for line in result:
        m = self.loadMessage(line.message)
        m.processing_node = line.processing_node
        m.priority = line.priority
        message_list.append(m)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
444 445
    return message_list

446 447 448
  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.
449
    """
450
    if isinstance(tag, str):
451
      tag = [tag]
452
    if isinstance(path, str):
453
      path = [path]
454
    if isinstance(method_id, str):
455 456
      method_id = [method_id]
    result = activity_tool.SQLQueue_validateMessageList(method_id=method_id, 
457 458 459
                                                        path=path,
                                                        message_uid=message_uid, 
                                                        tag=tag,
460
                                                        serialization_tag=None,
461
                                                        count=1)
462 463 464
    return result[0].uid_count

  def countMessageWithTag(self, activity_tool, value):
465
    """Return the number of messages which match the given tag.
466
    """
467
    return self.countMessage(activity_tool, tag=value)
468

469 470 471
  def dumpMessageList(self, activity_tool):
    # Dump all messages in the table.
    message_list = []
472 473 474
    dumpMessageList = getattr(activity_tool, 'SQLQueue_dumpMessageList', None)
    if dumpMessageList is not None:
      result = dumpMessageList()
475 476 477 478
      for line in result:
        m = self.loadMessage(line.message, uid = line.uid)
        message_list.append(m)
    return message_list
479

480
  def distribute(self, activity_tool, node_count):
481
    offset = 0
482 483
    readMessageList = getattr(activity_tool, 'SQLQueue_readMessageList', None)
    if readMessageList is not None:
484 485 486
      now_date = self.getNow(activity_tool)
      result = readMessageList(path=None, method_id=None, processing_node=-1,
                               to_date=now_date, include_processing=0, 
487
                               offset=offset, count=READ_MESSAGE_LIMIT)
488 489 490
      validated_count = 0
      while len(result) and validated_count < MAX_VALIDATED_LIMIT:
        get_transaction().commit()
491

492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
        validation_text_dict = {'none': 1}
        message_dict = {}
        for line in result:
          message = self.loadMessage(line.message, uid = line.uid)
          message.order_validation_text = self.getOrderValidationText(message)
          self.getExecutableMessageList(activity_tool, message, message_dict,
                                        validation_text_dict, now_date=now_date)
        distributable_count = len(message_dict)
        if distributable_count:
          activity_tool.SQLQueue_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, 
507
                                   offset=offset, count=READ_MESSAGE_LIMIT)
508

509
  # Validation private methods
510 511
  def _validate(self, activity_tool, method_id=None, message_uid=None, path=None, tag=None,
                serialization_tag=None):
512 513 514 515 516 517 518
    if isinstance(method_id, str):
      method_id = [method_id]
    if isinstance(path, str):
      path = [path]
    if isinstance(tag, str):
      tag = [tag]

519
    if method_id or message_uid or path or tag or serialization_tag:
520 521 522 523
      validateMessageList = activity_tool.SQLQueue_validateMessageList
      result = validateMessageList(method_id=method_id,
                                   message_uid=message_uid,
                                   path=path,
524
                                   tag=tag,
525
                                   count=False,
526
                                   serialization_tag=serialization_tag)
527 528 529 530 531 532 533 534 535 536 537 538
      message_list = []
      for line in result:
        m = self.loadMessage(line.message,
                             uid=line.uid,
                             date=line.date,
                             processing_node=line.processing_node)
        m.order_validation_text = self.getOrderValidationText(m)
        message_list.append(m)
      return message_list
    else:
      return []

539
  # Required for tests (time shift)
540
  def timeShift(self, activity_tool, delay, processing_node = None):
541 542
    """
      To simulate timeShift, we simply substract delay from
Vincent Pelletier's avatar
Vincent Pelletier committed
543
      all dates in SQLQueue message table
544
    """
545
    activity_tool.SQLQueue_timeShift(delay=delay, processing_node=processing_node)
546

547 548 549 550 551
  def getPriority(self, activity_tool):
    method = activity_tool.SQLQueue_getPriority
    default =  RAMQueue.getPriority(self, activity_tool)
    return self._getPriority(activity_tool, method, default)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
552
registerActivity(SQLQueue)