SQLDict.py 8.82 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 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
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL 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.
#
##############################################################################

29
import random
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31 32 33 34
from Products.CMFActivity.ActivityTool import registerActivity
from RAMDict import RAMDict

from zLOG import LOG

35
MAX_PRIORITY = 5
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36

Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39 40
DISTRIBUTABLE_STATE = -1
INVOKE_ERROR_STATE = -2
VALIDATE_ERROR_STATE = -3

41 42 43 44 45 46 47
priority_weight = \
  [1] * 64 + \
  [2] * 20 + \
  [3] * 10 + \
  [4] * 5 + \
  [5] * 1

48 49 50
class ActivityFlushError(Exception):
    """Error during active message flush"""

Jean-Paul Smets's avatar
Jean-Paul Smets committed
51 52 53 54 55 56 57 58
class SQLDict(RAMDict):
  """
    A simple OOBTree based queue. It should be compatible with transactions
    and provide sequentiality. Should not create conflict
    because use of OOBTree.
  """

  def queueMessage(self, activity_tool, m):
59 60 61 62
    activity_tool.SQLDict_writeMessage(path = '/'.join(m.object_path) ,
                                       method_id = m.method_id,
                                       priority = m.activity_kw.get('priority', 1),
                                       message = self.dumpMessage(m))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63

Jean-Paul Smets's avatar
Jean-Paul Smets committed
64
  def dequeueMessage(self, activity_tool, processing_node):
65 66 67 68 69
    priority = random.choice(priority_weight)
    # Try to find a message at given priority level
    result = activity_tool.SQLDict_readMessage(processing_node=processing_node, priority=priority)
    if len(result) == 0:
      # If empty, take any message
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71
      priority = None
      result = activity_tool.SQLDict_readMessage(processing_node=processing_node, priority=priority)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
72 73 74 75
    if len(result) > 0:
      line = result[0]
      path = line.path
      method_id = line.method_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76 77
      uid_list = activity_tool.SQLDict_readUidList( path=path, method_id= method_id, processing_node = None )
      uid_list = map(lambda x:x.uid, uid_list)
78
      # Make sure message can not be processed anylonger
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79 80
      if len(uid_list) > 0:
        activity_tool.SQLDict_processMessage(uid = uid_list)
81
      get_transaction().commit() # Release locks before starting a potentially long calculation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
82
      m = self.loadMessage(line.message)
83 84 85 86
      # Make sure object exists
      if not m.validate(self, activity_tool):
        if line.priority > MAX_PRIORITY:
          # This is an error
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87 88
          if len(uid_list) > 0:
            activity_tool.SQLDict_assignMessage(uid = uid_list, processing_node = VALIDATE_ERROR_STATE)
89 90
                                                                            # Assign message back to 'error' state
          get_transaction().commit()                                        # and commit
91
        else:
92
          # Lower priority
Jean-Paul Smets's avatar
Jean-Paul Smets committed
93 94
          if len(uid_list) > 0:
            activity_tool.SQLDict_setPriority(uid = uid_list,
95 96 97 98
                                            priority = line.priority + 1)
          get_transaction().commit() # Release locks before starting a potentially long calculation
      else:
        # Try to invoke
99
        activity_tool.invoke(m) # Try to invoke the message - what happens if read conflict error restarts transaction ?
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100
        if m.is_executed:                                          # Make sure message could be invoked
Jean-Paul Smets's avatar
Jean-Paul Smets committed
101 102
          if len(uid_list) > 0:
            activity_tool.SQLDict_delMessage(uid = uid_list)  # Delete it
Jean-Paul Smets's avatar
Jean-Paul Smets committed
103 104 105
          get_transaction().commit()                                        # If successful, commit
        else:
          get_transaction().abort()                                         # If not, abort transaction and start a new one
106 107
          if line.priority > MAX_PRIORITY:
            # This is an error
Jean-Paul Smets's avatar
Jean-Paul Smets committed
108 109
            if len(uid_list) > 0:
              activity_tool.SQLDict_assignMessage(uid = uid_list, processing_node = INVOKE_ERROR_STATE)
110 111 112 113
                                                                              # Assign message back to 'error' state
            get_transaction().commit()                                        # and commit
          else:
            # Lower priority
Jean-Paul Smets's avatar
Jean-Paul Smets committed
114 115 116
            if len(uid_list) > 0:
              activity_tool.SQLDict_setPriority(uid = uid_list,
                                                priority = line.priority + 1)
117
            get_transaction().commit() # Release locks before starting a potentially long calculation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118
      return 0
119
    get_transaction().commit() # Release locks before starting a potentially long calculation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
120 121 122 123 124 125 126 127 128
    return 1

  def hasActivity(self, activity_tool, object, method_id=None, **kw):
    my_object_path = '/'.join(object.getPhysicalPath())
    result = activity_tool.SQLDict_hasMessage(path=my_object_path, method_id=method_id)
    if len(result) > 0:
      return result[0].message_count > 0
    return 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
129
  def flush(self, activity_tool, object_path, invoke=0, method_id=None, commit=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130 131
    """
      object_path is a tuple
Jean-Paul Smets's avatar
Jean-Paul Smets committed
132 133 134 135 136 137

      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
138 139

      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
140 141
    """
    path = '/'.join(object_path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
142 143
    uid_list = activity_tool.SQLDict_readUidList(path=path, method_id=method_id,processing_node=None)
    uid_list = map(lambda x:x.uid, uid_list)
144
    # LOG('Flush', 0, str((path, invoke, method_id)))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
145
    if invoke:
146 147 148
      result = activity_tool.SQLDict_readMessageList(path=path, method_id=method_id,processing_node=None)
      method_dict = {}
      # Parse each message
Jean-Paul Smets's avatar
Jean-Paul Smets committed
149 150 151 152 153 154 155
      for line in result:
        path = line.path
        method_id = line.method_id
        if not method_dict.has_key(method_id):
          # Only invoke once (it would be different for a queue)
          method_dict[method_id] = 1
          m = self.loadMessage(line.message)
156 157
          # First Validate
          if m.validate(self, activity_tool):
158
            activity_tool.invoke(m) # Try to invoke the message - what happens if invoke calls flushActivity ??
159 160 161 162 163 164 165 166 167
            if not m.is_executed:                                                 # Make sure message could be invoked
              # The message no longer exists
              raise ActivityFlushError, (
                  'Could not evaluate %s on %s' % (method_id , path))
          else:
            # The message no longer exists
            raise ActivityFlushError, (
                'The document %s does not exist' % path)
    # Erase all messages in a single transaction
Jean-Paul Smets's avatar
Jean-Paul Smets committed
168 169
    if len(uid_list) > 0:
      activity_tool.SQLDict_delMessage(uid = uid_list)  # Delete all "old" messages (not -1 processing)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
170

Jean-Paul Smets's avatar
Jean-Paul Smets committed
171
  def getMessageList(self, activity_tool, processing_node=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
172
    message_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
173
    result = activity_tool.SQLDict_readMessageList(path=None, method_id=None, processing_node=None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
174 175
    for line in result:
      m = self.loadMessage(line.message)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
176
      m.processing_node = line.processing_node
177
      m.priority = line.priority
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178 179 180
      message_list.append(m)
    return message_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
181 182 183 184 185 186 187 188 189 190
  def distribute(self, activity_tool, node_count):
    processing_node = 1
    result = activity_tool.SQLDict_readMessageList(path=None, method_id=None, processing_node = -1) # Only assign non assigned messages
    get_transaction().commit() # Release locks before starting a potentially long calculation
    path_dict = {}
    for line in result:
      path = line.path
      if not path_dict.has_key(path):
        # Only assign once (it would be different for a queue)
        path_dict[path] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
191
        activity_tool.SQLDict_assignMessage(path=path, processing_node=processing_node, uid=None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193 194 195 196
        get_transaction().commit() # Release locks immediately to allow processing of messages
        processing_node = processing_node + 1
        if processing_node > node_count:
          processing_node = 1 # Round robin

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