def serialization_event_handler_non_wf(obj, event):
"""queues serialization of workflowed parent (if any)"""
#!+SERIALIZATION(mb, Jan-2013) Might change how changes are bubbled up
if not IWorkflowed.providedBy(obj):
# workflowed types will be handled by serialize_event_handler
wf_parent = obj
while not IWorkflowed.providedBy(wf_parent):
wf_parent = (wf_parent.__parent__
if hasattr(wf_parent, "__parent__") else None)
if not wf_parent:
break
if wf_parent:
queue_object_serialization(wf_parent)
def serialization_event_handler_non_wf(obj, event):
"""queues serialization of workflowed parent (if any)"""
#!+SERIALIZATION(mb, Jan-2013) Might change how changes are bubbled up
if not IWorkflowed.providedBy(obj):
# workflowed types will be handled by serialize_event_handler
wf_parent = obj
while not IWorkflowed.providedBy(wf_parent):
wf_parent = (wf_parent.__parent__ if hasattr(
wf_parent, "__parent__") else None)
if not wf_parent:
break
if wf_parent:
queue_object_serialization(wf_parent)
def is_workflowed_and_draft(instance):
"""is item workflowed, and is so is it in a logical draft state?
"""
if IWorkflowed.providedBy(instance):
tagged_key = instance.__class__.__name__.lower()
draft_states = get_states(tagged_key, tagged=["draft"])
return instance.status in draft_states
return False
def is_workflowed_and_draft(instance):
"""is item workflowed, and is so is it in a logical draft state?
"""
if IWorkflowed.providedBy(instance):
tagged_key = instance.__class__.__name__.lower()
draft_states = get_states(tagged_key, tagged=["draft"])
return instance.status in draft_states
return False
def batch_serialize(type_key="*", start_date=None, end_date=None):
"""Serialize all objects of `type_key` or all types if with a
wildcard(*) as the type key.
Item set may be filtered by status date (start_date and/or end date)
range.
"""
# keep count of serialized objects for feedback
serialized_count = 0
# list of domain classes to be serialized
domain_models = []
if type_key == "*":
types_vocab = get_vocabulary("serializable_type")
# we add the legislature and the chamber first
for term in types_vocab(None):
if term.value in ("legislature", "chamber"):
info = capi.get_type_info(term.value)
domain_models.append(info.domain_model)
# we add the rest now
for term in types_vocab(None):
if term.value == "*":
continue
if term.value not in ("legislature", "chamber"):
info = capi.get_type_info(term.value)
domain_models.append(info.domain_model)
else:
info = capi.get_type_info(type_key)
if info.workflow:
domain_models.append(info.domain_model)
session = Session()
for domain_model in domain_models:
query = session.query(domain_model)
if IWorkflowed.implementedBy(domain_model) and (start_date or end_date):
column = domain_model.status_date
if start_date and end_date:
expression = sql.between(column, start_date, end_date)
elif start_date:
expression = (column>=start_date)
elif end_date:
expression = (column<=end_date)
query = query.filter(expression)
objects = query.all()
# !+FILTER(ah, 2014-09-19) adding a filter here - sometimes there is a mismatch
# between the count shown on the screen i.e. X items sent for serialization and
# and only X-n items appear in the queue - there seem to be empty objects returned
# sometimes, so eliminating those
objects = filter(None, objects)
map(queue_object_serialization, objects)
log.error(" COUNTING_TYPES_SERIALIZED -- %s COUNT -- %s", domain_model, len(objects))
serialized_count += len(objects)
return serialized_count
def apply_customization_workflow(type_key, ti):
"""Apply customizations, features as per configuration from a workflow.
Must (currently) be run after db setup.
"""
domain_model, workflow = ti.domain_model, ti.workflow
assert domain_model and workflow, ti
# We "mark" the domain class with IWorkflowed, to be able to
# register/lookup adapters generically on this single interface.
#!+directlyImplementedBy? assert not IWorkflowed.implementedBy(domain_model), domain_model
if not IWorkflowed.implementedBy(domain_model):
classImplements(domain_model, IWorkflowed)
# dynamic features from workflow - setup domain/mapping as needed
for feature in workflow.features:
feature.setup_model(domain_model)
def apply_customization_workflow(type_key, ti):
"""Apply customizations, features as per configuration from a workflow.
Must (currently) be run after db setup.
"""
domain_model, workflow = ti.domain_model, ti.workflow
assert domain_model and workflow, ti
# We "mark" the domain class with IWorkflowed, to be able to
# register/lookup adapters generically on this single interface.
#!+directlyImplementedBy? assert not IWorkflowed.implementedBy(domain_model), domain_model
if not IWorkflowed.implementedBy(domain_model):
classImplements(domain_model, IWorkflowed)
# dynamic features from workflow - setup domain/mapping as needed
for feature in workflow.features:
feature.setup_model(domain_model)
def obj2dict(obj, depth, parent=None, include=[], exclude=[], lang=None, root_key=None):
""" Returns dictionary representation of a domain object.
"""
if lang is None:
lang = getattr(obj, "language", capi.default_language)
result = {}
obj = zope.security.proxy.removeSecurityProxy(obj)
descriptor = None
if IAlchemistContent.providedBy(obj):
try:
descriptor = utils.get_descriptor(obj)
except KeyError:
log.error("Could not get descriptor for IAlchemistContent %r", obj)
if parent is not None and IWorkflowed.providedBy(obj):
permissions = get_object_state_rpm(obj).permissions
result["permissions"] = get_permissions_dict(permissions)
result["tags"] = IStateController(obj).get_state().tags
# Get additional attributes
for name in include:
value = getattr(obj, name, None)
if value is None:
continue
if not name.endswith("s"):
name += "s"
if isinstance(value, collections.Iterable):
res = []
# !+ allowance for non-container-api-conformant alchemist containers
if IAlchemistContainer.providedBy(value):
value = value.values()
for item in value:
i = obj2dict(item, 0, lang=lang, root_key=root_key)
res.append(i)
result[name] = res
else:
result[name] = value
# Get mapped attributes
mapper = class_mapper(obj.__class__)
for property in mapper.iterate_properties:
if property.key in exclude:
continue
value = getattr(obj, property.key)
if value == parent:
continue
if value is None:
continue
if isinstance(property, RelationshipProperty) and depth > 0:
if isinstance(value, collections.Iterable):
result[property.key] = []
for item in value:
result[property.key].append(obj2dict(item, 1,
parent=obj,
include=[],
exclude=exclude + INNER_EXCLUDES,
lang=lang,
root_key=root_key
))
else:
result[property.key] = obj2dict(value, depth-1,
parent=obj,
include=[],
exclude=exclude + INNER_EXCLUDES,
lang=lang,
root_key=root_key
)
else:
if isinstance(property, RelationshipProperty):
continue
elif isinstance(property, ColumnProperty):
columns = property.columns
if len(columns) == 1:
if is_column_binary(columns[0]):
if (parent and
interfaces.ISerializable.providedBy(obj)):
#skip serialization of binary fields
#that have already been serialized elsewhere
continue
#save files
result[columns[0].key] = dict(
saved_file=PersistFiles.store_file(
obj, columns[0], root_key
)
)
continue
if descriptor:
columns = property.columns
is_foreign = False
if len(columns) == 1:
if len(columns[0].foreign_keys):
is_foreign = True
if (not is_foreign) and (property.key in descriptor.keys()):
field = descriptor.get(property.key)
if (field and field.property and
(schema.interfaces.IChoice.providedBy(field.property)
or IVocabularyTextField.providedBy(field.property))
):
factory = (field.property.vocabulary or
field.property.source
)
if factory is None:
vocab_name = getattr(field.property,
"vocabularyName", None)
factory = zope.component.getUtility(
schema.interfaces.IVocabularyFactory,
vocab_name
)
# !+VOCABULARIES(mb, aug-2012)some vocabularies
# expect an interaction to generate values
# todo - update these vocabularies to work
# with no request e.g. in notification threads
display_name = None
try:
vocabulary = factory(obj)
#handle vdex hierarchical terms
if ITreeVocabulary.providedBy(factory):
values = value.splitlines()
term_values = []
for val in values:
term_values.append(dict(
name=property.key,
value=val,
displayAs=factory.vdex.getTermCaption(
factory.getTermById(val),
lang
)
))
result[property.key] = term_values
continue
term = vocabulary.getTerm(value)
if lang:
if hasattr(factory, "vdex"):
display_name = (
factory.vdex.getTermCaption(
factory.getTermById(value),
lang
))
else:
display_name = translate(
(term.title or term.value),
target_language=lang,
domain="bungeni"
)
else:
display_name = term.title or term.value
except zope.security.interfaces.NoInteraction:
log.error("This vocabulary %s expects an"
"interaction to generate terms.",
factory
)
# try to use dc adapter lookup
try:
_prop = mapper.get_property_by_column(
property.columns[0])
_prop_value = getattr(obj, _prop.key)
dc = IDCDescriptiveProperties(
_prop_value, None)
if dc:
display_name = (
IDCDescriptiveProperties(
_prop_value).title
)
except KeyError:
log.warn("No display text found for %s"
" on object %s. Unmapped in orm.",
property.key, obj
)
except Exception, e:
log.error("Could not instantiate"
" vocabulary %s. Exception: %s",
factory, e
)
finally:
# fallback we cannot look up vocabularies/dc
if display_name is None:
if not isinstance(value, unicode):
display_name = unicode(value)
if display_name is not None:
result[property.key] = dict(
name=property.key,
value=value,
displayAs=display_name
)
continue
def is_workflowed(self):
"""() -> bool : is this view's context a workflowed object?
"""
return IWorkflowed.providedBy(self.context)
def is_workflowed(self):
"""() -> bool : is this view's context a workflowed object?
"""
return IWorkflowed.providedBy(self.context)
def obj2dict(obj, depth, parent=None, include=[], exclude=[], lang=None, root_key=None):
""" Returns dictionary representation of a domain object.
"""
if lang is None:
lang = getattr(obj, "language", capi.default_language)
result = {}
obj = zope.security.proxy.removeSecurityProxy(obj)
descriptor = None
if IAlchemistContent.providedBy(obj):
try:
descriptor = utils.get_descriptor(obj)
except KeyError:
log.error("Could not get descriptor for IAlchemistContent %r", obj)
if parent is not None and IWorkflowed.providedBy(obj):
permissions = get_object_state_rpm(obj).permissions
result["permissions"] = get_permissions_dict(permissions)
result["tags"] = IStateController(obj).get_state().tags
# Get additional attributes
for name in include:
value = getattr(obj, name, None)
if value is None:
continue
if not name.endswith("s"):
name += "s"
if isinstance(value, collections.Iterable):
res = []
# !+ allowance for non-container-api-conformant alchemist containers
if IAlchemistContainer.providedBy(value):
value = value.values()
for item in value:
i = obj2dict(item, 0, lang=lang, root_key=root_key)
res.append(i)
result[name] = res
else:
result[name] = value
# Get mapped attributes
seen_keys = []
mapper = class_mapper(obj.__class__)
for mproperty in mapper.iterate_properties:
if mproperty.key.startswith("_vp"):
#skip vertical props
continue
if mproperty.key in exclude:
continue
seen_keys.append(mproperty.key)
value = getattr(obj, mproperty.key)
if value == parent:
continue
if value is None:
continue
if isinstance(mproperty, RelationshipProperty) and depth > 0:
if isinstance(value, collections.Iterable):
result[mproperty.key] = []
for item in value:
# !+DEPTH(ah, 2014-09-19) depth was set to 1 here, this causes
# a very deep branching for upper level groups like legislature and chamber
# and legislature times out occasionally. Doesnt seem neccessary to go depth=1
# for child objects, because they get serialized independently anyway, changing
# depth to depth-1 so all dependent objects are iterated 1 level lower than the
# parent.
# UPDATE(ah, 2014-11-03) Item Schedule is an exceptional case of an object
# whose context is within a parent container but is not visible outside of the sitting
# it is not a type defined in types.xml and does not have its own
# wokflow so we need to handle that in a unique way
# we don't decrement the depth and instead process it as is
active_depth = depth
if item.__class__.__name__ == "ItemSchedule":
active_depth = depth
else:
active_depth = depth-1
result[mproperty.key].append(
obj2dict(
item,
active_depth,
parent=obj,
include=["owner", "item_schedule", "item_schedule_discussion"],
exclude=exclude + INNER_EXCLUDES,
lang=lang,
root_key=root_key
)
)
else:
result[mproperty.key] = obj2dict(value, depth-1,
parent=obj,
include=["owner"],
exclude=exclude + INNER_EXCLUDES,
lang=lang,
root_key=root_key
)
else:
if isinstance(mproperty, RelationshipProperty):
continue
elif isinstance(mproperty, ColumnProperty):
columns = mproperty.columns
if len(columns) == 1:
if is_column_binary(columns[0]):
fname = PersistFiles.store_file(obj, parent,
columns[0].key, root_key)
if fname:
result[columns[0].key] = dict(saved_file=fname)
continue
if descriptor:
columns = mproperty.columns
is_foreign = False
if len(columns) == 1:
if len(columns[0].foreign_keys):
is_foreign = True
if (not is_foreign) and (mproperty.key in descriptor.keys()):
field = descriptor.get(mproperty.key)
if (field and field.property and
(schema.interfaces.IChoice.providedBy(field.property) or
IVocabularyTextField.providedBy(field.property))
):
factory = field.property.vocabulary or field.property.source
if factory is None:
vocab_name = getattr(field.property, "vocabularyName", None)
factory = get_vocabulary(vocab_name)
# !+VOCABULARIES(mb, aug-2012)some vocabularies
# expect an interaction to generate values
# todo - update these vocabularies to work
# with no request e.g. in notification threads
display_name = None
try:
vocabulary = factory(obj)
# handle vdex hierarchical terms
if ITreeVocabulary.providedBy(factory):
values = value.splitlines()
term_values = []
for val in values:
term_values.append(dict(
name=mproperty.key,
value=val,
displayAs=factory.getTermCaption(
factory.getTermById(val), lang=lang)))
result[mproperty.key] = term_values
continue
term = vocabulary.getTerm(value)
if lang:
if hasattr(factory, "getTermCaption"):
display_name = factory.getTermCaption(
factory.getTermById(value), lang=lang)
else:
display_name = translate(
term.title or term.value,
target_language=lang,
domain="bungeni")
else:
display_name = term.title or term.value
except zope.security.interfaces.NoInteraction:
log.error("This vocabulary %s expects an interaction "
"to generate terms.", factory)
# try to use dc adapter lookup
try:
_prop = mapper.get_property_by_column(
mproperty.columns[0])
_prop_value = getattr(obj, _prop.key)
dc = IDCDescriptiveProperties(_prop_value, None)
if dc:
display_name = IDCDescriptiveProperties(
_prop_value).title
except KeyError:
log.warn("No display text found for %s on "
"object %s. Unmapped in orm.",
property.key, obj)
except Exception, e:
log.error("Could not instantiate vocabulary %s. "
"Exception: %s", factory, e)
finally:
# fallback we cannot look up vocabularies/dc
if display_name is None:
if not isinstance(value, unicode):
display_name = unicode(value)
if display_name is not None:
result[mproperty.key] = dict(
name=mproperty.key,
value=value,
displayAs=display_name)
continue
def obj2dict(obj,
depth,
parent=None,
include=[],
exclude=[],
lang=None,
root_key=None):
""" Returns dictionary representation of a domain object.
"""
if lang is None:
lang = getattr(obj, "language", capi.default_language)
result = {}
obj = zope.security.proxy.removeSecurityProxy(obj)
descriptor = None
if IAlchemistContent.providedBy(obj):
try:
descriptor = utils.get_descriptor(obj)
except KeyError:
log.error("Could not get descriptor for IAlchemistContent %r", obj)
if parent is not None and IWorkflowed.providedBy(obj):
permissions = get_object_state_rpm(obj).permissions
result["permissions"] = get_permissions_dict(permissions)
result["tags"] = IStateController(obj).get_state().tags
# Get additional attributes
for name in include:
value = getattr(obj, name, None)
if value is None:
continue
if not name.endswith("s"):
name += "s"
if isinstance(value, collections.Iterable):
res = []
# !+ allowance for non-container-api-conformant alchemist containers
if IAlchemistContainer.providedBy(value):
value = value.values()
for item in value:
i = obj2dict(item, 0, lang=lang, root_key=root_key)
res.append(i)
result[name] = res
else:
result[name] = value
# Get mapped attributes
mapper = class_mapper(obj.__class__)
for property in mapper.iterate_properties:
if property.key in exclude:
continue
value = getattr(obj, property.key)
if value == parent:
continue
if value is None:
continue
if isinstance(property, RelationshipProperty) and depth > 0:
if isinstance(value, collections.Iterable):
result[property.key] = []
for item in value:
result[property.key].append(
obj2dict(item,
1,
parent=obj,
include=[],
exclude=exclude + INNER_EXCLUDES,
lang=lang,
root_key=root_key))
else:
result[property.key] = obj2dict(value,
depth - 1,
parent=obj,
include=[],
exclude=exclude +
INNER_EXCLUDES,
lang=lang,
root_key=root_key)
else:
if isinstance(property, RelationshipProperty):
continue
elif isinstance(property, ColumnProperty):
columns = property.columns
if len(columns) == 1:
if is_column_binary(columns[0]):
if (parent
and interfaces.ISerializable.providedBy(obj)):
#skip serialization of binary fields
#that have already been serialized elsewhere
continue
#save files
result[columns[0].key] = dict(
saved_file=PersistFiles.store_file(
obj, columns[0], root_key))
continue
if descriptor:
columns = property.columns
is_foreign = False
if len(columns) == 1:
if len(columns[0].foreign_keys):
is_foreign = True
if (not is_foreign) and (property.key in descriptor.keys()):
field = descriptor.get(property.key)
if (field and field.property and
(schema.interfaces.IChoice.providedBy(field.property)
or IVocabularyTextField.providedBy(field.property))):
factory = (field.property.vocabulary
or field.property.source)
if factory is None:
vocab_name = getattr(field.property,
"vocabularyName", None)
factory = zope.component.getUtility(
schema.interfaces.IVocabularyFactory,
vocab_name)
# !+VOCABULARIES(mb, aug-2012)some vocabularies
# expect an interaction to generate values
# todo - update these vocabularies to work
# with no request e.g. in notification threads
display_name = None
try:
vocabulary = factory(obj)
#handle vdex hierarchical terms
if ITreeVocabulary.providedBy(factory):
values = value.splitlines()
term_values = []
for val in values:
term_values.append(
dict(name=property.key,
value=val,
displayAs=factory.vdex.
getTermCaption(
factory.getTermById(val),
lang)))
result[property.key] = term_values
continue
term = vocabulary.getTerm(value)
if lang:
if hasattr(factory, "vdex"):
display_name = (
factory.vdex.getTermCaption(
factory.getTermById(value), lang))
else:
display_name = translate(
(term.title or term.value),
target_language=lang,
domain="bungeni")
else:
display_name = term.title or term.value
except zope.security.interfaces.NoInteraction:
log.error(
"This vocabulary %s expects an"
"interaction to generate terms.", factory)
# try to use dc adapter lookup
try:
_prop = mapper.get_property_by_column(
property.columns[0])
_prop_value = getattr(obj, _prop.key)
dc = IDCDescriptiveProperties(
_prop_value, None)
if dc:
display_name = (IDCDescriptiveProperties(
_prop_value).title)
except KeyError:
log.warn(
"No display text found for %s"
" on object %s. Unmapped in orm.",
property.key, obj)
except Exception, e:
log.error(
"Could not instantiate"
" vocabulary %s. Exception: %s", factory, e)
finally:
# fallback we cannot look up vocabularies/dc
if display_name is None:
if not isinstance(value, unicode):
display_name = unicode(value)
if display_name is not None:
result[property.key] = dict(name=property.key,
value=value,
displayAs=display_name)
continue