loops/integrator/office/base.py
helmutm 9091b56c69 work in progress: read properties from Office documents and update version field if appropriate
git-svn-id: svn://svn.cy55.de/Zope3/src/loops/trunk@3926 fd906abe-77d9-0310-91a1-e0d9ade77398
2010-07-27 09:50:19 +00:00

108 lines
3.8 KiB
Python

#
# Copyright (c) 2010 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
#
"""
Resource adapter(s) for MS Office files.
$Id$
"""
from lxml import etree
from zipfile import ZipFile
import shutil
from zope.cachedescriptors.property import Lazy
from zope import component
from zope.component import adapts
from zope.interface import implements
from zope.traversing.api import getName, getParent
from cybertools.storage.interfaces import IExternalStorage
from loops.common import AdapterBase, adapted
from loops.integrator.interfaces import IOfficeFile
from loops.interfaces import IResource, IExternalFile
from loops.resource import ExternalFileAdapter
from loops.type import TypeInterfaceSourceList
from loops.versioning.interfaces import IVersionable
TypeInterfaceSourceList.typeInterfaces += (IOfficeFile,)
class OfficeFile(ExternalFileAdapter):
""" An external file that references a MS Office (2007/2010) file.
It provides access to the document content and properties.
"""
implements(IOfficeFile)
propertyMap = {u'Revision:': 'version'}
propFileName = 'docProps/custom.xml'
def setExternalAddress(self, addr):
super(OfficeFile, self).setExternalAddress(addr)
self.processDocument()
externalAddress = property(ExternalFileAdapter.getExternalAddress,
setExternalAddress)
def processDocument(self):
storage = component.getUtility(IExternalStorage, name=self.storageName)
subDir = self.storageParams.get('subdirectory')
fn = storage.getDir(self.externalAddress, subDir)
# TODO: check if suitable file type (.docx, .xlsm)
# open ZIP file, process properties, set version property in file
zf = ZipFile(fn, 'r')
#print '***', zf.namelist()
propsXml = zf.read(self.propFileName)
dom = etree.fromstring(propsXml)
changed = False
docVersion = None
version = IVersionable(self.context).versionId
strType = ('{http://schemas.openxmlformats.org/'
'officeDocument/2006/docPropsVTypes}lpwstr')
attributes = {}
for p in dom:
name = p.attrib.get('name')
value = p[0].text
#print '***', name, value, p[0].tag
attr = self.propertyMap.get(name)
if attr == 'version':
docVersion = value
if docVersion and docVersion != version:
# update XML
p[0] = etree.Element(strType)
p[0].text = version
changed = True
elif attr is not None:
attributes[attr] = value
zf.close()
if changed:
newFn = fn + '.new'
zf = ZipFile(fn, 'r')
newZf = ZipFile(newFn, 'w')
for info in zf.infolist():
name = info.filename
if name != self.propFileName:
newZf.writestr(info, zf.read(name))
newZf.writestr(self.propFileName, etree.tostring(dom))
newZf.close()
shutil.move(newFn, fn)
self.update(attributes)
def update(self, attributes):
# to be implemented by subclass
pass