File.py 12.8 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3
##############################################################################
#
Nicolas Delaby's avatar
Nicolas Delaby committed
4
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
from AccessControl import ClassSecurityInfo
31
from Products.ERP5Type.Base import WorkflowMethod
32
from Products.ERP5Type import Permissions, PropertySheet
Nicolas Delaby's avatar
Nicolas Delaby committed
33
from Products.ERP5.Document.Document import Document, VALID_TEXT_FORMAT_LIST
34
from Products.ERP5.Document.Document import ConversionError
35
from Products.ERP5Type.Base import Base, removeIContentishInterface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from Products.CMFDefault.File import File as CMFFile
37
from Products.CMFCore.utils import getToolByName
Nicolas Delaby's avatar
Nicolas Delaby committed
38 39
from OFS.Image import Pdata
import cStringIO
40

41 42 43
def _unpackData(data):
  """
  Unpack Pdata into string
44
  OBSOLETED. use str(data) instead, because Pdata.__str__ is defined.
45
  """
46
  return str(data)
47

Nicolas Delaby's avatar
Nicolas Delaby committed
48
class File(Document, CMFFile):
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
  """
      A File can contain raw data which can be uploaded and downloaded.
      It is the root class of Image, OOoDocument (ERP5OOo product),
      etc. The main purpose of the File class is to handle efficiently
      large files. It uses Pdata from OFS.File for this purpose.

      File inherits from XMLObject and can be synchronized
      accross multiple sites.

      Subcontent: File can only contain role information.

      TODO:
      * make sure ZODB BLOBS are supported to prevent
       feeding the ZODB cache with unnecessary large data
  """

  meta_type = 'ERP5 File'
  portal_type = 'File'
  add_permission = Permissions.AddPortalContent

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

  # Default global values
  content_type = '' # Required for WebDAV support (default value)
75
  data = '' # A hack required to use OFS.Image.index_html without calling OFS.Image.__init__
76 77 78

  # Default Properties
  property_sheets = ( PropertySheet.Base
79 80 81 82 83 84 85 86 87 88
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Version
                    , PropertySheet.Reference
                    , PropertySheet.Document
                    , PropertySheet.Data
                    , PropertySheet.ExternalDocument
                    , PropertySheet.Url
                    , PropertySheet.Periodicity
89
    )
90

91 92
  ### Special edit method
  security.declarePrivate( '_edit' )
93 94
  def _edit(self, **kw):
    """
95
      This is used to edit files
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96
    """
97 98 99
    if kw.has_key('file'):
      file = kw.get('file')
      precondition = kw.get('precondition')
100 101 102 103 104
      filename = getattr(file, 'filename', None)
      # if file field is empty(no file is uploaded),
      # filename is empty string.
      if filename:
        self._setSourceReference(filename)
105 106
      if self._isNotEmpty(file):
        self._setFile(file, precondition=precondition)
107 108 109 110 111 112 113 114 115 116
      del kw['file']
    Base._edit(self, **kw)

  security.declareProtected( Permissions.ModifyPortalContent, 'edit' )
  edit = WorkflowMethod( _edit )

  def get_size(self):
    """
    has to be overwritten here, otherwise WebDAV fails
    """
Nicolas Delaby's avatar
Nicolas Delaby committed
117
    return self.getSize()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118

119
  getcontentlength = get_size
Jean-Paul Smets's avatar
Jean-Paul Smets committed
120

Romain Courteaud's avatar
Romain Courteaud committed
121 122 123 124 125 126 127 128
  def _setFile(self, data, precondition=None):
    CMFFile._edit(self, precondition=precondition, file=data)

  security.declareProtected(Permissions.ModifyPortalContent,'setFile')
  def setFile(self, data, precondition=None):
    self._setFile(data, precondition=precondition)
    self.reindexObject()

129 130 131 132 133 134 135
  security.declareProtected(Permissions.AccessContentsInformation, 'hasFile')
  def hasFile(self):
    """
    Checks whether a file was uploaded into the document.
    """
    return self.hasData()

136 137 138 139 140 141 142 143
  security.declareProtected(Permissions.AccessContentsInformation, 'hasBaseData')
  def hasBaseData(self):
    """
      By default, a File instance does not require conversion
      to a base format. Therefore, hasBaseData must be overriden.
    """
    return self.hasData()

144
  security.declareProtected(Permissions.ModifyPortalContent, 'guessMimeType')
145
  def guessMimeType(self, fname=None):
146 147 148
    """
      get mime type from file name
    """
149 150
    if not fname:
      fname = self.getSourceReference()
151
    if fname:
152 153 154
      portal = self.getPortalObject()
      content_type = getToolByName(portal, 'mimetypes_registry').\
                                                         lookupExtension(fname)
155
      if content_type is not None:
Nicolas Delaby's avatar
Nicolas Delaby committed
156
        self.setContentType(content_type)
157 158
    else:
      content_type = None
159 160
    return content_type

Nicolas Delaby's avatar
Nicolas Delaby committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  security.declareProtected(Permissions.ModifyPortalContent, '_setData')
  def _setData(self, data):
    """
    """
    size = None
    # update_data use len(data) when size is None, which breaks this method.
    # define size = 0 will prevent len be use and keep the consistency of 
    # getData() and setData()
    if data is None:
      size = 0
    if not isinstance(data, Pdata) and data is not None:
      file = cStringIO.StringIO(data)
      data, size = self._read_data(file)
    if getattr(self, 'update_data', None) is not None:
      # We call this method to make sure size is set and caches reset
      self.update_data(data, size=size)
    else:
      self._baseSetData(data) # XXX - It would be better to always use this accessor
      self._setSize(size)
      self.ZCacheable_invalidate()
      self.ZCacheable_set(None)
      self.http__refreshEtag()

  security.declareProtected(Permissions.AccessContentsInformation, 'getData')
  def getData(self, default=None):
    """return Data as str."""
    data = self._baseGetData()
    if data is None:
      return None
    else:
      return str(data)

193
  security.declareProtected(Permissions.ModifyPortalContent,'PUT')
194 195
  def PUT(self, REQUEST, RESPONSE):
    CMFFile.PUT(self, REQUEST, RESPONSE)
196 197

  # DAV Support
Jean-Paul Smets's avatar
Jean-Paul Smets committed
198 199
  index_html = CMFFile.index_html 
  PUT = CMFFile.PUT
200
  security.declareProtected('FTP access', 'manage_FTPget', 'manage_FTPstat', 'manage_FTPlist')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201 202 203
  manage_FTPget = CMFFile.manage_FTPget
  manage_FTPlist = CMFFile.manage_FTPlist
  manage_FTPstat = CMFFile.manage_FTPstat
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

  security.declareProtected(Permissions.AccessContentsInformation, 'getMimeTypeAndContent')
  def getMimeTypeAndContent(self):
    """This method returns a tuple which contains mimetype and content."""
    from Products.ERP5.Document.EmailDocument import MimeTypeException
    # return a tuple (mime_type, data)
    mime_type = None
    content = None

    # WARNING - this could fail since getContentType
    # is not (yet) part of Document API
    if getattr(self, 'getContentType', None) is not None:
      mime_type = self.getContentType()
    elif getattr(self, 'getTextFormat', None) is not None:
      mime_type = self.getTextFormat()
    else:
      raise ValueError, "Cannot find mimetype of the document."

    if mime_type is not None:
      try:
        mime_type, content = self.convert(mime_type)
      except ConversionError:
        mime_type = self.getBaseContentType()
        content = self.getBaseData()
      except (NotImplementedError, MimeTypeException):
        pass

    if content is None:
      if getattr(self, 'getTextContent', None) is not None:
        content = self.getTextContent()
      elif getattr(self, 'getData', None) is not None:
        content = self.getData()
      elif getattr(self, 'getBaseData', None) is not None:
        content = self.getBaseData()

    if content and not isinstance(content, str):
      content = str(content)

    return (mime_type, content)

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
  security.declareProtected(Permissions.AccessContentsInformation, 'convert')
  def convert(self, format, **kw):
    """According content_type of data we can proceed some Conversions.
    The idea is to wrap data into TempDocument who support conversion
    then return conversion from this temporary document.

    mimetype                             Class of temp document

    text/????                            newTempTextDocument
    image/????                           newTempImage
    application/pdf                      newTempPDFDocument
    [ooo supported content_type list]    newTempOOoDocument
    unknown                              no conversion supported

    XXX Another idea of implementation from JPS: Changing dynamicaly the Class
    of persistent_object.
    for example any instance of File portal_type can follow TextDocument API
    if content_type is 'text/html' and support conversion features of
    TextDocument.
    """
    content_type = self.getContentType()

    # Build the list of acceptable content_type for OOoDocument
    # Hopefully this is cached
    from Products.ERP5Type.Document import newTempOOoDocument
    temp_odt = newTempOOoDocument(self, 'testOOoOdt')
    temp_odt.edit(base_content_type='application/vnd.oasis.opendocument.text',
                  base_data='not empty')
    temp_ods = newTempOOoDocument(self, 'testOOoOds')
    temp_ods.edit(
            base_content_type='application/vnd.oasis.opendocument.spreadsheet',
            base_data='not empty')
    temp_odg = newTempOOoDocument(self, 'testOOoOdg')
    temp_odg.edit(base_content_type='application/vnd.oasis.opendocument.draw',
                  base_data='not empty')
    temp_odb = newTempOOoDocument(self, 'testOOoOdb')
    temp_odb.edit(base_content_type='application/vnd.oasis.opendocument.base',
                  base_data='not empty')

    supported_ooo_content_type_list = [item[0] for item in\
                                           temp_odt.getTargetFormatItemList()]\
                    + [item[0] for item in temp_ods.getTargetFormatItemList()]\
                    + [item[0] for item in temp_odg.getTargetFormatItemList()]\
                    + [item[0] for item in temp_odb.getTargetFormatItemList()]
    if content_type.startswith('text'):
      # We can wrap it into TextDocument
      from Products.ERP5Type.Document import newTempTextDocument
      temp_document = newTempTextDocument(self, 'temp_%s' % self.getId(),
                                          text_content=self.getData(),
                                          content_type=content_type)
      return temp_document.convert(format=format, **kw)
    elif content_type.startswith('image'):
      # We can wrap it into Image
      from Products.ERP5Type.Document import newTempImage
      temp_document = newTempImage(self, 'temp_%s' % self.getId(),
                                   data=self.getData(),
                                   content_type=content_type)
      return temp_document.convert(format=format, **kw)
    elif content_type == 'application/pdf':
      # We can wrap it into PDFDocument
      from Products.ERP5Type.Document import newTempPDFDocument
      temp_document = newTempPDFDocument(self, 'temp_%s' % self.getId(),
                                         data=self.getData(),
                                         content_type=content_type)
      return temp_document.convert(format=format, **kw)
    elif content_type in supported_ooo_content_type_list:
      # We can wrap it into OOoDocument
      temp_document = newTempOOoDocument(self, 'temp_%s' % self.getId(),
                                         text_content=self.getData(),
                                         content_type=content_type)
      return temp_document.convert(format=format, **kw)
    else:
      # We didn't find suitable wrapper to convert this File
      if format in VALID_TEXT_FORMAT_LIST:
        # This is acceptable to return empty string
        # for a File we can not convert
        return 'text/plain', ''
      elif format is None:
        # No conversion is asked,
        # we can return safely the file content itself
        return content_type, self.getData()
      raise NotImplementedError

327 328 329
# CMFFile also brings the IContentishInterface on CMF 2.2, remove it.
removeIContentishInterface(File)