OOoDocument.py 16.7 KB
Newer Older
Bartek Górny's avatar
Bartek Górny 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
##############################################################################
#
# Copyright (c) 2002-2006 Nexedi SARL and Contributors. All Rights Reserved.
#
# 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.
#
##############################################################################

28
import xmlrpclib, base64, re, zipfile, cStringIO, socket
29
from warnings import warn
30
from DateTime import DateTime
31
from xmlrpclib import Fault
Bartek Górny's avatar
Bartek Górny committed
32 33
from AccessControl import ClassSecurityInfo
from OFS.Image import Pdata
34
from Products.CMFCore.utils import getToolByName, _setCacheHeaders
35
from Products.DCWorkflow.DCWorkflow import ValidationFailed
Bartek Górny's avatar
Bartek Górny committed
36 37 38 39
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Message import Message
from Products.ERP5Type.Cache import CachingMethod
from Products.ERP5Type.XMLObject import XMLObject
40
from Products.ERP5.Document.File import File
41
from Products.ERP5.Document.Document import ConversionCacheMixin, ConversionError
42
from Products.ERP5.Document.File import _unpackData
43
from zLOG import LOG, INFO, ERROR
44

Bartek Górny's avatar
Bartek Górny committed
45 46 47
enc=base64.encodestring
dec=base64.decodestring

48
_MARKER = []
49
STANDARD_IMAGE_FORMAT_LIST = ('png', 'jpg', 'gif', )
50

51
class OOoDocument(File, ConversionCacheMixin):
Bartek Górny's avatar
Bartek Górny committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
  """
    A file document able to convert OOo compatible files to
    any OOo supported format, to capture metadata and to
    update metadata in OOo documents.

    This class can be used:

    - to create an OOo document database with powerful indexing (r/o)
      and metadata handling (r/w) features (ex. change title in ERP5 ->
      title is changed in OOo document)

    - to massively convert MS Office documents to OOo format

    - to easily keep snapshots (in PDF and/or OOo format) of OOo documents
      generated from OOo templates

    This class may be used in the future:

    - to create editable OOo templates (ex. by adding tags in WYSIWYG mode
      and using tags to make document dynamic - ask kevin for more info)

    - to automatically sign / encrypt OOo documents based on user

    - to automatically sign / encrypt PDF generated from OOo documents based on user

    This class should not be used:

    - to store files in formats not supported by OOo

    - to stored pure images (use Image for that)

    - as a general file conversion system (use portal_transforms for that)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
84 85 86

    TODO:
    - better permissions
Bartek Górny's avatar
Bartek Górny committed
87 88 89 90 91 92 93
  """
  # CMF Type Definition
  meta_type = 'ERP5 OOo Document'
  portal_type = 'OOo Document'
  isPortalContent = 1
  isRADContent = 1

94
  searchable_property_list = ('asText', 'title', 'description', 'id', 'reference',
95 96
                              'version', 'short_title',
                              'subject', 'source_reference', 'source_project_title',)
Bartek Górny's avatar
Bartek Górny committed
97 98 99 100 101 102 103

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Default Properties
  property_sheets = ( PropertySheet.Base
104 105
                    , PropertySheet.XMLObject
                    , PropertySheet.Reference
Bartek Górny's avatar
Bartek Górny committed
106 107 108
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Version
109
                    , PropertySheet.Document
110 111 112 113
                    , PropertySheet.Snapshot
                    , PropertySheet.ExternalDocument
                    , PropertySheet.Url
                    , PropertySheet.Periodicity
Bartek Górny's avatar
Bartek Górny committed
114 115
                    )

116
  # regular expressions for stripping xml from ODF documents
117 118
  rx_strip = re.compile('<[^>]*?>', re.DOTALL|re.MULTILINE)
  rx_compr = re.compile('\s+')
119

120 121 122 123 124
  def _setFile(self, data, precondition=None):
    File._setFile(self, data, precondition=precondition)
    if self.hasBaseData():
      # This is a hack - XXX - new accessor needed to delete properties
      delattr(self, 'base_data')
125

126
  security.declareProtected(Permissions.View, 'index_html')
127
  def index_html(self, REQUEST, RESPONSE, format=None, display=None, **kw):
128
    """
129 130 131
      Default renderer with conversion support. Format is
      a string. The list of available formats can be obtained
      by calling getTargetFormatItemList.
132
    """
133 134 135
    # Accelerate rendering in Web mode
    _setCacheHeaders(self, {'format' : format})
    # Return the original file by default
136
    if format is None:
137 138 139 140 141
      return File.index_html(self, REQUEST, RESPONSE)
    # Make sure file is converted to base format
    if not self.hasBaseData():
      self.convertToBaseFormat()
    # Else try to convert the document and return it
142
    mime, result = self.convert(format=format, display=display, **kw)
143 144
    if not mime:
      mime = getToolByName(self, 'mimetypes_registry').lookupExtension('name.%s' % format)
145
    RESPONSE.setHeader('Content-Length', len(result))
146 147 148 149
    RESPONSE.setHeader('Content-Type', mime)
    RESPONSE.setHeader('Accept-Ranges', 'bytes')
    return result

150
  # Format conversion implementation
151
  def _getServerCoordinate(self):
Bartek Górny's avatar
Bartek Górny committed
152
    """
153 154
      Returns the oood conversion server coordinates
      as defined in preferences.
Bartek Górny's avatar
Bartek Górny committed
155
    """
156 157 158 159 160 161 162
    preference_tool = getToolByName(self, 'portal_preferences')
    address = preference_tool.getPreferredOoodocServerAddress()
    port = preference_tool.getPreferredOoodocServerPortNumber()
    if not address or not port:
      raise ConversionError('Can not proceed with conversion: '
                            'conversion server host and port is not defined in preferences')
    return address, port
Bartek Górny's avatar
Bartek Górny committed
163 164 165

  def _mkProxy(self):
    """
166
      Create an XML-RPC proxy to access the conversion server.
Bartek Górny's avatar
Bartek Górny committed
167
    """
168 169 170
    server_proxy = xmlrpclib.ServerProxy('http://%s:%d' % self._getServerCoordinate(),
                                         allow_none=True)
    return server_proxy
Bartek Górny's avatar
Bartek Górny committed
171

172 173
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getTargetFormatItemList')
Bartek Górny's avatar
Bartek Górny committed
174 175 176 177 178
  def getTargetFormatItemList(self):
    """
      Returns a list of acceptable formats for conversion
      in the form of tuples (for listfield in ERP5Form)

179 180
      NOTE: it is the responsability of the conversion server
      to provide an extensive list of conversion formats.
Bartek Górny's avatar
Bartek Górny committed
181
    """
182
    def cached_getTargetFormatItemList(content_type):
183
      server_proxy = self._mkProxy()
184
      try:
185 186 187 188 189 190 191
        response_code, response_dict, response_message = server_proxy.getAllowedTargetItemList(content_type)
        if response_code == 200:
          allowed = response_dict['response_data']
        else:
          # This is very temporary code - XXX needs to be changed
          # so that the system can retry
          raise ConversionError(response_code), response_message
192 193 194 195
      except Fault, f:
        allowed = server_proxy.getAllowedTargets(content_type)
        warn('Your oood version is too old, using old method '
            'getAllowedTargets instead of getAllowedTargetList',
196
             DeprecationWarning)
197 198 199

      # tuple order is reversed to be compatible with ERP5 Form
      return [(y, x) for x, y in allowed]
Bartek Górny's avatar
Bartek Górny committed
200

201
    # Cache valid format list
202 203 204 205
    cached_getTargetFormatItemList = CachingMethod(
                                cached_getTargetFormatItemList,
                                id="OOoDocument_getTargetFormatItemList",
                                cache_factory='erp5_ui_medium')
Bartek Górny's avatar
Bartek Górny committed
206

207 208 209 210
    return cached_getTargetFormatItemList(self.getBaseContentType())

  security.declareProtected(Permissions.AccessContentsInformation, 'getTargetFormatTitleList')
  def getTargetFormatTitleList(self):
Bartek Górny's avatar
Bartek Górny committed
211 212 213 214 215
    """
      Returns a list of acceptable formats for conversion
    """
    return map(lambda x: x[0], self.getTargetFormatItemList())

216 217
  security.declareProtected(Permissions.AccessContentsInformation, 'getTargetFormatList')
  def getTargetFormatList(self):
Bartek Górny's avatar
Bartek Górny committed
218
    """
219
      Returns a list of acceptable formats for conversion
Bartek Górny's avatar
Bartek Górny committed
220
    """
221
    return map(lambda x: x[1], self.getTargetFormatItemList())
Bartek Górny's avatar
Bartek Górny committed
222

223 224
  security.declareProtected(Permissions.ModifyPortalContent,'isTargetFormatAllowed')
  def isTargetFormatAllowed(self, format):
225
    """
226 227 228 229 230 231 232 233 234 235
      Checks if the current document can be converted
      into the specified target format.
    """
    return format in self.getTargetFormatList()

  security.declarePrivate('_convert')
  def _convert(self, format):
    """
      Communicates with server to convert a file 
    """
236 237
    if not self.hasBaseData():
      self.convertToBaseFormat()
238 239 240
    if format == 'text-content':
      # Extract text from the ODF file
      cs = cStringIO.StringIO()
241
      cs.write(_unpackData(self.getBaseData()))
242 243 244 245 246 247
      z = zipfile.ZipFile(cs)
      s = z.read('content.xml')
      s = self.rx_strip.sub(" ", s) # strip xml
      s = self.rx_compr.sub(" ", s) # compress multiple spaces
      cs.close()
      z.close()
248
      return 'text/plain', s
249
    server_proxy = self._mkProxy()
250
    response_code, response_dict, response_message = server_proxy.run_generate(self.getId(),
251 252 253
                                       enc(_unpackData(self.getBaseData())),
                                       None, 
                                       format)
254
    # XXX: handle possible OOOd server failure
255
    return response_dict['mime'], Pdata(dec(response_dict['data']))
256

257
  # Conversion API
258
  security.declareProtected(Permissions.View, 'convert')
259
  def convert(self, format, display=None, **kw):
Bartek Górny's avatar
Bartek Górny committed
260
    """
261
      Implementation of thGet file in a given format.
262 263
      Runs makeFile to make sure we have the requested version cached,
      then returns from cache.
Bartek Górny's avatar
Bartek Górny committed
264
    """
265 266
    # Make sure we can support html and pdf by default
    is_html = 0
267
    original_format = format
268 269 270
    if format == 'base-data':
      if not self.hasBaseData(): self.convertToBaseFormat()
      return self.getBaseContentType(), self.getBaseData()
271 272 273
    if format == 'pdf':
      format_list = [x for x in self.getTargetFormatList() if x.endswith('pdf')]
      format = format_list[0]
274 275 276
    elif format in STANDARD_IMAGE_FORMAT_LIST:
      format_list = [x for x in self.getTargetFormatList() if x.endswith(format)]
      format = format_list[0]
277 278 279 280
    elif format == 'html':
      format_list = [x for x in self.getTargetFormatList() if x.startswith('html')]
      format = format_list[0]
      is_html = 1
281 282 283 284 285 286 287 288 289 290
    elif format in ('txt', 'text', 'text-content'):
      format_list = self.getTargetFormatList()
      if format in format_list:
        format = format_list[format_list.index(format)]
      if 'txt' in format_list:
        format = format_list[format_list.index('txt')]
      elif 'text' in format_list:
        format = format_list[format_list.index('text')]
      else:
        return 'text/plain', self.asTextContent()
291 292 293 294 295
    # Raise an error if the format is not supported
    if not self.isTargetFormatAllowed(format):
      raise ConversionError, 'Target format %s is not supported' % format
    # Check if we have already a base conversion
    if not self.hasBaseData():
296
      self.convertToBaseFormat()
297
    # Return converted file
298 299 300 301 302
    if display is None or original_format not in STANDARD_IMAGE_FORMAT_LIST:
      has_format = self.hasConversion(format=format)
    else:
      has_format = self.hasConversion(format=format, display=display)
    if not has_format:
303 304 305 306 307 308
      # Do real conversion
      mime, data = self._convert(format)
      if is_html:
        # Extra processing required since
        # we receive a zip file
        cs = cStringIO.StringIO()
309
        cs.write(_unpackData(data))
310 311 312 313 314 315 316 317 318 319
        z = zipfile.ZipFile(cs)
        for f in z.infolist():
          fn = f.filename
          if fn.endswith('html'):
            data = z.read(fn)
            break
        mime = 'text/html'
        self.populateContent(zip_file=z)
        z.close()
        cs.close()
320 321 322 323 324 325 326 327 328 329 330 331 332 333
      if display is None or original_format not in STANDARD_IMAGE_FORMAT_LIST:
        self.setConversion(data, mime, format=format)
      else:
        temp_image = self.portal_contributions.newContent(
                                       portal_type='Image',
                                       temp_object=1)
        temp_image._setData(data)
        mime, data = temp_image.convert(format, display=display)
        self.setConversion(data, mime, format=format, display=display)
    if display is None or original_format not in STANDARD_IMAGE_FORMAT_LIST:
      return self.getConversion(format=format)
    else:
      return self.getConversion(format=format, display=display)

334 335 336 337 338 339 340
  security.declareProtected(Permissions.View, 'asTextContent')
  def asTextContent(self):
    """
      Extract plain text from ooo docs by stripping the XML file.
      This is the simplest way, the most universal and it is compatible
      will all formats.
    """
341
    return self._convert(format='text-content')
342 343 344 345 346 347 348 349 350 351 352 353

  security.declareProtected(Permissions.ModifyPortalContent, 'populateContent')
  def populateContent(self, zip_file=None):
    """
    Extract content from the ODF zip file and populate the document.
    Optional parameter zip_file prevents from converting content twice.
    """
    if zip_file is None:
      format_list = [x for x in self.getTargetFormatList() if x.startswith('html')]
      format = format_list[0]
      mime, data = self._convert(format)
      archive_file = cStringIO.StringIO()
354
      archive_file.write(_unpackData(data))
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
      zip_file = zipfile.ZipFile(archive_file)
      must_close = 1
    else:
      must_close = 0
    for f in zip_file.infolist():
      file_name = f.filename
      if not file_name.endswith('html'):
        document = self.get(file_name, None)
        if document is not None:
          self.manage_delObjects([file_name])
        self.portal_contributions.newContent(id=file_name, container=self,
                                             file_name=file_name,
                                             data=zip_file.read(file_name))
    if must_close:
      zip_file.close()
      archive_file.close()

  # Base format implementation
  security.declarePrivate('_convertToBaseFormat')
  def _convertToBaseFormat(self):
Bartek Górny's avatar
Bartek Górny committed
375
    """
376 377 378
      Converts the original document into ODF
      by invoking the conversion server. Store the result
      on the object. Update metadata information.
Bartek Górny's avatar
Bartek Górny committed
379
    """
380
    server_proxy = self._mkProxy()
381
    response_code, response_dict, response_message = server_proxy.run_convert(self.getSourceReference() or self.getId(),
382
                                      enc(_unpackData(self.getData())))
383 384 385 386 387 388 389 390 391
    if response_code == 200:
      # sucessfully converted document
      self._setBaseData(dec(response_dict['data']))
      metadata = response_dict['meta']
      self._base_metadata = metadata
      if metadata.get('MIMEType', None) is not None:
        self._setBaseContentType(metadata['MIMEType'])
    else:
      # log and raise errors with converting server.Explicitly raise the exception!
392
      LOG('[DMS]', ERROR, 'Error converting document to base format %s:%s' %(response_code, response_message))
393
      raise ConversionError(response_code), response_message
Bartek Górny's avatar
Bartek Górny committed
394

395 396
  security.declareProtected(Permissions.AccessContentsInformation, 'getContentInformation')
  def getContentInformation(self):
Bartek Górny's avatar
Bartek Górny committed
397
    """
398 399
      Returns the metadata extracted by the conversion
      server.
Bartek Górny's avatar
Bartek Górny committed
400
    """
401
    return self._base_metadata
Bartek Górny's avatar
Bartek Górny committed
402

403
  security.declareProtected(Permissions.ModifyPortalContent, 'updateBaseMetadata')
404
  def updateBaseMetadata(self, *arg, **kw):
Bartek Górny's avatar
Bartek Górny committed
405
    """
406 407 408
      Updates metadata information in the converted OOo document
      based on the values provided by the user. This is implemented
      through the invocation of the conversion server.
Bartek Górny's avatar
Bartek Górny committed
409
    """
410
    server_proxy = self._mkProxy()
411 412 413 414 415 416 417 418
    response_code, response_dict, response_message = server_proxy.run_setmetadata(self.getId(),
                                                          enc(_unpackData(self.getBaseData())),
                                                          kw)
    if response_code == 200:
      # successful meta data extraction
      self._setBaseData(dec(response_dict['data']))
    else:
      # log and raise errors with converting server.Explicitly raise the exception!
419
      LOG('[DMS]', ERROR, 'Error getting document\'s metadata %s:%s' %(response_code, response_message))
420
      raise ConversionError(response_code), response_message