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

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

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

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

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

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

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

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

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

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

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

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

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

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

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  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)

181
  def getDuplicateMessageUidList(self, activity_tool, line, processing_node):
182
    """
183 184
      Reserve unreserved messages matching given line.
      Return their uids.
185
    """
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    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
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

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

325
  def finalizeMessageExecution(self, activity_tool, message_uid_priority_list, uid_to_duplicate_uid_list_dict):
326 327 328 329 330 331 332 333 334 335
    """
      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.
    """
336 337 338 339 340
    def makeMessageListAvailable(uid_list):
      self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list)
    deletable_uid_list = []
    delay_uid_list = []
    final_error_uid_list = []
341
    make_available_uid_list = []
342
    message_with_active_process_list = []
343
    notify_user_list = []
344
    something_failed = (len([x for x in message_uid_priority_list if not x[1].is_executed]) != 0)
345 346
    for uid, m, priority in message_uid_priority_list:
      if m.is_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
      else:
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 372 373 374
          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())
375
          delay_uid_list.append(uid)
376 377 378 379
    if len(deletable_uid_list):
      try:
        activity_tool.SQLDict_delMessage(uid=deletable_uid_list)
      except:
380
        LOG('SQLDict', ERROR, 'Failed to delete messages %r' % (deletable_uid_list, ), error=sys.exc_info())
381 382 383 384 385 386
      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)
387
      except:
388
        LOG('SQLDict', ERROR, 'Failed to delay %r' % (delay_uid_list, ), error=sys.exc_info())
389
      make_available_uid_list += delay_uid_list
390 391 392 393 394
    if len(final_error_uid_list):
      try:
        activity_tool.SQLDict_assignMessage(uid=final_error_uid_list,
                                            processing_node=INVOKE_ERROR_STATE)
      except:
395
        LOG('SQLDict', ERROR, 'Failed to set message to error state for %r' % (final_error_uid_list, ), error=sys.exc_info())
396 397 398 399
    if len(make_available_uid_list):
      try:
        makeMessageListAvailable(make_available_uid_list)
      except:
400
        LOG('SQLDict', ERROR, 'Failed to unreserve %r' % (make_available_uid_list, ), error=sys.exc_info())
401 402
      else:
        LOG('SQLDict', TRACE, 'Freed messages %r' % (make_available_uid_list, ))
403 404 405 406 407 408 409 410 411 412 413
    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())
414 415 416

  # Queue semantic
  def dequeueMessage(self, activity_tool, processing_node):
417 418 419 420 421 422 423 424
    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 = \
425 426 427 428 429 430 431 432 433 434 435 436
      self.getProcessableMessageList(activity_tool, processing_node)
    if len(message_uid_priority_list):
      # Remove group_id parameter from group_method_id
      if group_method_id is not None:
        group_method_id = group_method_id.split('\0')[0]
      message_list = [x[1] for x in message_uid_priority_list]
      if group_method_id not in (None, ""):
        method  = activity_tool.invokeGroup
        args = (group_method_id, message_list)
      else:
        method = activity_tool.invoke
        args = (message_list[0], )
437 438 439 440 441 442 443 444 445
      # 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
446 447 448 449
      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())
450
        try:
451
          abortTransactionSynchronously()
452 453
        except:
          # Unfortunately, database adapters may raise an exception against abort.
454
          LOG('SQLDict', PANIC,
455
              'abort failed, thus some objects may be modified accidentally')
456
          raise
457 458
        to_free_uid_list = [x[0] for x in message_uid_priority_list]
        try:
459
          makeMessageListAvailable(to_free_uid_list, uid_to_duplicate_uid_list_dict)
460
        except:
461
          LOG('SQLDict', ERROR, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info())
462 463
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (to_free_uid_list))
464 465
      # Abort if something failed.
      if len([x for x in message_uid_priority_list if not x[1].is_executed]) != 0:
466 467 468
        endTransaction = abortTransactionSynchronously
      else:
        endTransaction = get_transaction().commit
Yoshinori Okuji's avatar
Yoshinori Okuji committed
469
      try:
470
        endTransaction()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
471
      except:
472 473 474 475 476 477 478 479
        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.')
480
            raise
481 482
        for x in message_uid_priority_list:
          x[1].is_executed = 0
483 484
        failed_message_uid_list = [x[0] for x in message_uid_priority_list]
        try:
485
          makeMessageListAvailable(failed_message_uid_list, uid_to_duplicate_uid_list_dict)
486
        except:
487
          LOG('SQLDict', ERROR, 'Failed to free remaining messages: %r' % (failed_message_uid_list, ), error=sys.exc_info())
488 489
        else:
          LOG('SQLDict', TRACE, 'Freed messages %r' % (failed_message_uid_list, ))
490
      self.finalizeMessageExecution(activity_tool, message_uid_priority_list, uid_to_duplicate_uid_list_dict)
491 492
    get_transaction().commit()
    return not len(message_uid_priority_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
493

494
  def hasActivity(self, activity_tool, object, **kw):
495 496
    hasMessage = getattr(activity_tool, 'SQLDict_hasMessage', None)
    if hasMessage is not None:
497 498
      if object is not None:
        my_object_path = '/'.join(object.getPhysicalPath())
499
        result = hasMessage(path=my_object_path, **kw)
500 501 502 503
        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
504 505
    return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
506
  def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
507 508
    """
      object_path is a tuple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
509 510 511 512 513 514

      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
515 516

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

      if len(result):
578
        uid_list = activity_tool.SQLDict_readUidList(path = path, method_id = method_id,
579
                                                     processing_node = None,)
580 581
        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
582

583
  def getMessageList(self, activity_tool, processing_node=None, include_processing=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
584
    # YO: reading all lines might cause a deadlock
Jean-Paul Smets's avatar
Jean-Paul Smets committed
585
    message_list = []
586 587 588
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
      result = readMessageList(path=None, method_id=None, processing_node=None,
589
                               to_processing_date=None, include_processing=include_processing)
590 591 592 593
      for line in result:
        m = self.loadMessage(line.message, uid = line.uid)
        m.processing_node = line.processing_node
        m.priority = line.priority
594
        m.processing = line.processing
595
        message_list.append(m)
596 597
    return message_list

598 599 600
  def dumpMessageList(self, activity_tool):
    # Dump all messages in the table.
    message_list = []
601 602 603
    dumpMessageList = getattr(activity_tool, 'SQLDict_dumpMessageList', None)
    if dumpMessageList is not None:
      result = dumpMessageList()
604 605 606 607 608
      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
609
  def distribute(self, activity_tool, node_count):
610
    offset = 0
611 612
    readMessageList = getattr(activity_tool, 'SQLDict_readMessageList', None)
    if readMessageList is not None:
613
      now_date = self.getNow(activity_tool)
614
      result = readMessageList(path=None, method_id=None, processing_node=-1,
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
                               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
638

639
  # Validation private methods
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
  def _validate(self, activity_tool, method_id=None, message_uid=None, path=None, tag=None):
    if isinstance(method_id, str):
      method_id = [method_id]
    if isinstance(path, str):
      path = [path]
    if isinstance(tag, str):
      tag = [tag]

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

666
  def _validate_after_method_id(self, activity_tool, message, value):
667
    return self._validate(activity_tool, method_id=value)
668

669
  def _validate_after_path(self, activity_tool, message, value):
670
    return self._validate(activity_tool, path=value)
671

672
  def _validate_after_message_uid(self, activity_tool, message, value):
673
    return self._validate(activity_tool, message_uid=value)
674

675
  def _validate_after_path_and_method_id(self, activity_tool, message, value):
676 677 678 679 680
    if not isinstance(value, (tuple, list)) or len(value) < 2:
      LOG('CMFActivity', WARNING,
          'unable to recognize value for after_path_and_method_id: %r' % (value,))
      return []
    return self._validate(activity_tool, path=value[0], method_id=value[1])
681

682
  def _validate_after_tag(self, activity_tool, message, value):
683
    return self._validate(activity_tool, tag=value)
684

685 686 687 688 689 690 691 692 693 694 695
  def _validate_after_tag_and_method_id(self, activity_tool, message, value):
    # Count number of occurances of tag and method_id
    if not isinstance(value, (tuple, list)) or len(value) < 2:
      LOG('CMFActivity', WARNING,
          'unable to recognize value for after_tag_and_method_id: %r' % (value,))
      return []
    return self._validate(activity_tool, tag=value[0], method_id=value[1])

  def countMessage(self, activity_tool, tag=None, path=None,
                   method_id=None, message_uid=None, **kw):
    """Return the number of messages which match the given parameters.
Sebastien Robin's avatar
Sebastien Robin committed
696
    """
697
    if isinstance(tag, str):
Sebastien Robin's avatar
Sebastien Robin committed
698
      tag = [tag]
699
    if isinstance(path, str):
Sebastien Robin's avatar
Sebastien Robin committed
700
      path = [path]
Jérome Perrin's avatar
bug.  
Jérome Perrin committed
701
    if isinstance(method_id, str):
Sebastien Robin's avatar
Sebastien Robin committed
702 703 704 705
      method_id = [method_id]
    result = activity_tool.SQLDict_validateMessageList(method_id=method_id, 
                                                       path=path,
                                                       message_uid=message_uid, 
706 707
                                                       tag=tag,
                                                       count=1)
Sebastien Robin's avatar
Sebastien Robin committed
708 709
    return result[0].uid_count

710
  def countMessageWithTag(self, activity_tool, value):
711
    """Return the number of messages which match the given tag.
712
    """
713
    return self.countMessage(activity_tool, tag=value)
714

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

723 724 725 726 727
  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
728
registerActivity(SQLDict)