############################################################################## # # Copyright (c) 2002,2007 Nexedi SA and Contributors. All Rights Reserved. # 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, MESSAGE_NOT_EXECUTED, MESSAGE_EXECUTED from RAMQueue import RAMQueue from Queue import VALID, INVALID_PATH, abortTransactionSynchronously from Products.CMFActivity.ActiveObject import INVOKE_ERROR_STATE, VALIDATE_ERROR_STATE from Products.CMFActivity.Errors import ActivityFlushError from ZODB.POSException import ConflictError from types import ClassType import sys from time import time from SQLBase import SQLBase, sort_message_key from Products.CMFActivity.ActivityRuntimeEnvironment import ( ActivityRuntimeEnvironment, getTransactionalVariable) from zExceptions import ExceptionFormatter try: from transaction import get as get_transaction except ImportError: pass from zLOG import LOG, WARNING, ERROR, INFO, PANIC, TRACE # 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. # 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 MAX_MESSAGE_LIST_SIZE = 100 class SQLQueue(RAMQueue, SQLBase): """ A simple OOBTree based queue. It should be compatible with transactions and provide sequentiality. Should not create conflict because use of OOBTree. """ sql_table = 'message_queue' def prepareQueueMessageList(self, activity_tool, message_list): message_list = [m for m in message_list if m.is_registered] for i in xrange(0, len(message_list), MAX_MESSAGE_LIST_SIZE): registered_message_list = message_list[i:i + MAX_MESSAGE_LIST_SIZE] # The uid_list also is store in the ZODB uid_list = activity_tool.getPortalObject().portal_ids.generateNewIdList( id_generator='uid', id_group='portal_activity_queue', id_count=len(registered_message_list)) path_list = ['/'.join(m.object_path) for m in registered_message_list] active_process_uid_list = [m.active_process_uid for m in registered_message_list] 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] dumped_message_list = [self.dumpMessage(m) for m in registered_message_list] activity_tool.SQLQueue_writeMessageList(uid_list=uid_list, path_list=path_list, active_process_uid_list=active_process_uid_list, method_id_list=method_id_list, priority_list=priority_list, message_list=dumped_message_list, date_list=date_list, tag_list=tag_list, processing_node_list=None, serialization_tag_list=serialization_tag_list) def prepareDeleteMessage(self, activity_tool, m): # Erase all messages in a single transaction #LOG("prepareDeleteMessage", 0, str(m.__dict__)) activity_tool.SQLBase_delMessage(table=self.sql_table, uid=[m.uid]) 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 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. """ result = activity_tool.SQLQueue_selectReservedMessageList(processing_node=processing_node, count=limit) if len(result) == 0: activity_tool.SQLQueue_reserveMessageList(count=limit, processing_node=processing_node, to_date=date) result = activity_tool.SQLQueue_selectReservedMessageList(processing_node=processing_node, count=limit) return result 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 messages """ 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 = [] try: result = getReservedMessageList(limit=MESSAGE_BUNDLE_SIZE) for line in result: m = self.loadMessage(line.message, uid=line.uid, line=line) message_list.append(m) if len(message_list): activity_tool.SQLQueue_processMessage(uid=[m.uid 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 = [m.uid for m in message_list] try: makeMessageListAvailable(to_free_uid_list) except: LOG('SQLQueue', ERROR, 'Failed to free messages: %r' % (to_free_uid_list, ), error=sys.exc_info()) 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 dequeueMessage(self, activity_tool, processing_node): def makeMessageListAvailable(uid_list): self.makeMessageListAvailable(activity_tool=activity_tool, uid_list=uid_list) message_list = \ self.getProcessableMessageList(activity_tool, processing_node) if message_list: processing_stop_time = time() + 30 # Stop processing after more than 10 seconds were spent processed_count = 0 # Commit right before executing messages. # As MySQL transaction does not 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 committed now that we have selected # everything needed from MySQL to get a fresh view of ZODB objects. get_transaction().commit() tv = getTransactionalVariable(None) for m in message_list: tv['activity_runtime_environment'] = ActivityRuntimeEnvironment(m) processed_count += 1 # Try to invoke try: activity_tool.invoke(m) if m.getExecutionState() != MESSAGE_NOT_EXECUTED: # 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() except: value = m.uid, m.object_path, m.method_id LOG('SQLQueue', WARNING, 'Exception raised when invoking message (uid, path, method_id) %r' % (value, ), 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') raise # 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 m.setExecutionState(MESSAGE_NOT_EXECUTED, context=activity_tool) # XXX Is it still useful to free message now that this node is able # to reselect it ? try: makeMessageListAvailable([m.uid]) except: LOG('SQLQueue', ERROR, 'Failed to free message: %r' % (value, ), error=sys.exc_info()) 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 to_free_uid_list = [m.uid for m in message_list[processed_count:]] if to_free_uid_list: try: makeMessageListAvailable(to_free_uid_list) except: LOG('SQLQueue', ERROR, 'Failed to free remaining messages: %r' % (to_free_uid_list, ), error=sys.exc_info()) else: LOG('SQLQueue', TRACE, 'Freed messages %r' % (to_free_uid_list, )) self.finalizeMessageExecution(activity_tool, message_list[:processed_count]) get_transaction().commit() return not message_list def hasActivity(self, activity_tool, object, method_id=None, only_valid=None, active_process_uid=None): hasMessage = getattr(activity_tool, 'SQLQueue_hasMessage', None) if hasMessage is not None: if object is None: my_object_path = None else: 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 return 0 def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw): """ object_path is a tuple 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 """ readMessageList = getattr(activity_tool, 'SQLQueue_readMessageList', None) if readMessageList is not None: #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: # First Validate validate_value = m.validate(self, activity_tool) if validate_value is VALID: activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ?? if m.getExecutionState() != MESSAGE_EXECUTED: # Make sure message could be invoked # The message no longer exists raise ActivityFlushError, ( 'Could not evaluate %s on %s' % (m.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)) activity_tool.unregisterMessage(self, m) # Parse each message in SQL queue result = readMessageList(path=path, method_id=method_id, processing_node=None, to_date=None, include_processing=0) for line in result: path = line.path method_id = line.method_id m = self.loadMessage(line.message, uid=line.uid, line=line) if invoke: # 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 if validate_value is VALID: activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ?? if m.getExecutionState() != MESSAGE_EXECUTED: # Make sure message could be invoked # 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)) if len(result): activity_tool.SQLBase_delMessage(table=self.sql_table, uid=[line.uid for line in result]) getMessageList = SQLBase.getMessageList 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. """ if isinstance(tag, str): tag = [tag] if isinstance(path, str): path = [path] if isinstance(method_id, str): method_id = [method_id] result = activity_tool.SQLQueue_validateMessageList(method_id=method_id, path=path, message_uid=message_uid, tag=tag, serialization_tag=None, count=1) return result[0].uid_count def countMessageWithTag(self, activity_tool, value): """Return the number of messages which match the given tag. """ return self.countMessage(activity_tool, tag=value) def dumpMessageList(self, activity_tool): # Dump all messages in the table. message_list = [] dumpMessageList = getattr(activity_tool, 'SQLQueue_dumpMessageList', None) if dumpMessageList is not None: result = dumpMessageList() for line in result: m = self.loadMessage(line.message, uid=line.uid, line=line) message_list.append(m) return message_list def distribute(self, activity_tool, node_count): offset = 0 readMessageList = getattr(activity_tool, 'SQLQueue_readMessageList', None) if readMessageList is not None: now_date = self.getNow(activity_tool) validated_count = 0 while 1: result = readMessageList(path=None, method_id=None, processing_node=-1, to_date=now_date, include_processing=0, offset=offset, count=READ_MESSAGE_LIMIT) if not result: return get_transaction().commit() validation_text_dict = {'none': 1} message_dict = {} for line in result: message = self.loadMessage(line.message, uid=line.uid, line=line) message.order_validation_text = self.getOrderValidationText(message) self.getExecutableMessageList(activity_tool, message, message_dict, validation_text_dict, now_date=now_date) if message_dict: distributable_uid_set = set() serialization_tag_dict = {} for message in message_dict.itervalues(): serialization_tag = message.activity_kw.get('serialization_tag') if serialization_tag is None: distributable_uid_set.add(message.uid) else: serialization_tag_dict.setdefault(serialization_tag, []).append(message) for message_list in serialization_tag_dict.itervalues(): # Sort list of messages to validate the message with highest score message_list.sort(key=sort_message_key) distributable_uid_set.add(message_list[0].uid) distributable_count = len(distributable_uid_set) if distributable_count: activity_tool.SQLBase_assignMessage(table=self.sql_table, processing_node=0, uid=tuple(distributable_uid_set)) validated_count += distributable_count if validated_count >= MAX_VALIDATED_LIMIT: return offset += READ_MESSAGE_LIMIT # Validation private methods def _validate(self, activity_tool, method_id=None, message_uid=None, path=None, tag=None, serialization_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 or serialization_tag: validateMessageList = activity_tool.SQLQueue_validateMessageList result = validateMessageList(method_id=method_id, message_uid=message_uid, path=path, tag=tag, count=False, serialization_tag=serialization_tag) 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 [] # Required for tests (time shift) def timeShift(self, activity_tool, delay, processing_node = None): """ To simulate timeShift, we simply substract delay from all dates in SQLQueue message table """ activity_tool.SQLQueue_timeShift(delay=delay, processing_node=processing_node) def getPriority(self, activity_tool): method = activity_tool.SQLQueue_getPriority default = RAMQueue.getPriority(self, activity_tool) return self._getPriority(activity_tool, method, default) registerActivity(SQLQueue)