loops/external/base.py
helmutm 3b08ca8346 flexible export with selection based on parent concepts
git-svn-id: svn://svn.cy55.de/Zope3/src/loops/trunk@3605 fd906abe-77d9-0310-91a1-e0d9ade77398
2009-10-27 07:50:15 +00:00

259 lines
9.7 KiB
Python

#
# Copyright (c) 2008 Helmut Merz helmutm@cy55.de
#
# 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
#
"""
Reading and writing loops objects (represented by IElement objects)
in Python function notation.
$Id$
"""
from cStringIO import StringIO
import itertools
import os, sys
import zdaemon
from zope import component
from zope.cachedescriptors.property import Lazy
from zope.interface import implements
from zope.traversing.api import getName, getParent
from cybertools.composer.interfaces import IInstance
from cybertools.composer.schema.interfaces import ISchemaFactory
from cybertools.external.base import BaseLoader
from cybertools.typology.interfaces import IType
from loops.common import adapted
from loops.external.interfaces import ILoader, IExtractor, ISubExtractor
from loops.external.element import elementTypes
from loops.interfaces import IConceptSchema, IResourceSchema
from loops.layout.base import LayoutNode
from loops.resource import Document, MediaAsset
from loops.setup import SetupManager
class Base(object):
def __init__(self, context, resourceDirectory=None):
self.context = context
self.resourceDirectory = resourceDirectory
@Lazy
def concepts(self):
return self.context.getConceptManager()
@Lazy
def resources(self):
return self.context.getResourceManager()
@Lazy
def views(self):
return self.context.getViewManager()
@Lazy
def typeConcept(self):
return self.concepts.getTypeConcept()
@Lazy
def typePredicate(self):
return self.concepts.getTypePredicate()
class Loader(Base, BaseLoader, SetupManager):
implements(ILoader)
def __init__(self, context, resourceDirectory=None):
#super(Loader, self).__init__(context, resourceDirectory)
Base.__init__(self, context, resourceDirectory)
BaseLoader.__init__(self, context)
self.logger = StringIO()
#self.logger = sys.stdout
# TODO: care for setting attributes via Instance (Editor)
# instead of using SetupManager methods:
# def addConcept(self, ...):
class Extractor(Base):
implements(IExtractor)
def extract(self):
return itertools.chain(self.extractTypes(),
self.extractConcepts(),
self.extractChildren(),
self.extractResources(),
self.extractResourceRelations(),
self.extractNodes(),
)
def extractTypes(self):
typeElement = elementTypes['type']
for obj in self.typeConcept.getChildren([self.typePredicate]):
data = self.getObjectData(obj)
element = typeElement(getName(obj), obj.title, **data)
self.provideSubElements(obj, element)
yield element
def extractConcepts(self):
for name, obj in self.concepts.items():
if obj.conceptType != self.typeConcept:
yield self.getConceptElement(name, obj)
def extractResources(self):
for name, obj in self.resources.items():
yield self.getResourceElement(name, obj)
def extractChildren(self):
for c in self.concepts.values():
for r in self.getChildRelations(c):
yield r
def extractResourceRelations(self):
for c in self.concepts.values():
for r in self.getResourceRelations(c):
yield r
def extractNodes(self, parent=None, path=''):
if parent is None:
parent = self.views
for name, obj in parent.items():
data = {}
for attr in ('description', 'body', 'viewName', 'pageName'):
value = getattr(obj, attr, None)
if value:
data[attr] = value
target = obj.target
if target is not None:
data['target'] = '/'.join((getName(getParent(target)), getName(target)))
elementClass = (isinstance(obj, LayoutNode) and elementTypes['layoutNode']
or elementTypes['node'])
elem = elementClass(name, obj.title, path, obj.nodeType, **data)
self.provideSubElements(obj, elem)
yield elem
childPath = path and '/'.join((path, name)) or name
for elem in self.extractNodes(obj, childPath):
#self.provideSubElements(obj, elem)
yield elem
def extractForParents(self, parents, predicates=None,
includeSubconcepts=False, includeResources=False):
concepts = set(parents)
for p in parents:
self.collectConcepts(p, predicates, includeSubconcepts, concepts)
conceptList = sorted(concepts, key=lambda x:
(x.conceptType != self.typeConcept, getName(x)))
for c in conceptList:
yield self.getConceptElement(getName(c), c)
for c in conceptList:
for r in c.getChildRelations(predicates):
if r.predicate != self.typePredicate and r.second in concepts:
yield self.getChildElement(r)
if includeResources:
resources = set()
for c in conceptList:
for obj in c.getResources(predicates):
if obj not in resources:
resources.add(obj)
yield self.getResourceElement(getName(obj), obj)
for c in conceptList:
for r in c.getResourceRelations(predicates):
if r.predicate != self.typePredicate and r.second in resources:
yield self.getResourceRelationElement(r)
def collectConcepts(self, concept, predicates, includeSubconcepts, concepts):
for obj in concept.getChildren(predicates):
if obj not in concepts:
concepts.add(obj)
if includeSubconcepts:
self.collectConcepts(obj, predicates, includeSubconcepts,
concepts)
# helper methods
def getConceptElement(self, name, obj):
if obj.conceptType is None:
raise ValueError('Concept type is None for %s.' % getName(obj))
data = self.getObjectData(obj)
type = obj.conceptType
if type == self.typeConcept:
element = elementTypes['type'](getName(obj), obj.title, **data)
else:
tp = getName(type)
element = elementTypes['concept'](name, obj.title, tp, **data)
self.provideSubElements(obj, element)
return element
def getResourceElement(self, name, obj):
data = self.getObjectData(obj, IResourceSchema)
tp = getName(obj.resourceType)
if isinstance(obj, Document): # backward compatibility
tp = 'textdocument'
element = elementTypes['resource'](name, obj.title, tp, **data)
element.processExport(self)
self.provideSubElements(obj, element)
return element
def provideSubElements(self, obj, element):
for name, extractor in component.getAdapters((obj,), ISubExtractor):
for sub in extractor.extract():
element.add(sub)
def getChildRelations(self, c, predicates=None):
for r in c.getChildRelations(predicates):
if r.predicate != self.typePredicate:
yield self.getChildElement(r)
def getChildElement(self, r):
args = [getName(r.first), getName(r.second), getName(r.predicate)]
if r.order != 0 or r.relevance != 1.0:
args.append(r.order)
if r.relevance != 1.0:
args.append(r.relevance)
return elementTypes['child'](*args)
def getResourceRelations(self, c, predicates=None):
for r in c.getResourceRelations(predicates):
if r.predicate != self.typePredicate:
yield self.getResourceRelationElement(r)
def getResourceRelationElement(self, r):
args = [getName(r.first), getName(r.second), getName(r.predicate)]
if r.order != 0 or r.relevance != 1.0:
args.append(r.order)
if r.relevance != 1.0:
args.append(r.relevance)
return elementTypes['resourceRelation'](*args)
def getObjectData(self, obj, defaultInterface=IConceptSchema):
aObj = adapted(obj)
schemaFactory = component.getAdapter(aObj, ISchemaFactory)
ti = IType(obj).typeInterface or defaultInterface
schema = schemaFactory(ti, manager=self, mode='export') #, request=self.request)
instance = IInstance(aObj)
instance.template = schema
# TODO: this should also convert object attributes like e.g. typeInterface
#data = instance.applyTemplate(mode='export')
data = instance.applyTemplate(mode='edit')
noexp = getattr(aObj, '_noexportAttributes', ())
for attr in tuple(noexp) + ('title', 'name'):
if attr in data:
del data[attr]
data['description'] = obj.description
if not data['description']:
del data['description']
return data