def ObjectTransitionedEventHandler(obj, event):
"""Object has been transitioned to an new state
"""
# only snapshot supported objects
if not supports_snapshots(obj):
return
# default transition entry
entry = {
"modified": DateTime().ISO(),
"action": event.action,
}
# get the last history item
history = api.get_review_history(obj, rev=True)
if history:
entry = history[0]
# make transitions also a modification entry
timestamp = entry.pop("time", DateTime())
entry["modified"] = timestamp.ISO()
entry["action"] = event.action
# take a new snapshot
take_snapshot(obj, **entry)
# reindex the object in the auditlog catalog
reindex_object(obj)
def get_previous_state(instance, omit=("stored", )):
# Get the review history, most recent actions first
history = api.get_review_history(instance)
for item in history:
status = item.get("review_state")
if not status or status in omit:
continue
return status
return None
def init_auditlog(portal):
"""Initialize the contents for the audit log
"""
# reindex the auditlog folder to display the icon right in the setup
portal.bika_setup.auditlog.reindexObject()
# Initialize contents for audit logging
start = time.time()
uid_catalog = api.get_tool("uid_catalog")
brains = uid_catalog()
total = len(brains)
logger.info("Initializing {} objects for the audit trail...".format(total))
for num, brain in enumerate(brains):
# Progress notification
if num and num % 1000 == 0:
transaction.commit()
logger.info("{}/{} ojects initialized for audit logging".format(
num, total))
# End progress notification
if num + 1 == total:
end = time.time()
duration = float(end - start)
logger.info(
"{} ojects initialized for audit logging in {:.2f}s".format(
total, duration))
if api.get_portal_type(brain) in SKIP_TYPES_FOR_AUDIT_LOG:
continue
obj = api.get_object(brain)
if not supports_snapshots(obj):
continue
if has_snapshots(obj):
continue
# Take one snapshot per review history item
rh = api.get_review_history(obj, rev=False)
for item in rh:
actor = item.get("actor")
user = get_user(actor)
if user:
# remember the roles of the actor
item["roles"] = get_roles(user)
# The review history contains the variable "time" which we will set
# as the "modification" time
timestamp = item.pop("time", DateTime())
item["time"] = timestamp.ISO()
item["modified"] = timestamp.ISO()
item["remote_address"] = None
take_snapshot(obj, **item)
def getReviewHistory(instance, reverse=True):
"""Returns the review history for the instance
:returns: the list of historic events as dicts
"""
return api.get_review_history(instance, rev=reverse)
def get_review_history(self):
"""Return the review history of the current context
"""
return api.get_review_history(self.context)