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

29 30
import zope.interface

31 32
import mimetypes
import re
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33

34
from AccessControl import ClassSecurityInfo
35
from Products.ERP5Type.Base import WorkflowMethod
36
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
37 38
from Products.ERP5Type.Cache import CachingMethod
from Products.ERP5.Document.Document import Document
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from Products.ERP5.Document.Document import ConversionCacheMixin
40
from Products.ERP5.Document.Document import ConversionError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43
from Products.ERP5Type.Base import Base
from Products.CMFDefault.File import File as CMFFile
from zLOG import LOG
44
from DateTime import DateTime
45

46 47
mimetypes.init()

48 49 50 51 52 53 54 55 56 57 58 59 60
def _unpackData(data):
  """
  Unpack Pdata into string
  """
  if isinstance(data, str):
    return data
  else:
    data_list = []
    while data is not None:
      data_list.append(data.data)
      data = data.next
    return ''.join(data_list)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
61
class File(Document, CMFFile, ConversionCacheMixin):
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  """
      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
  isPortalContent = 1
  isRADContent = 1

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

  # Default global values
  content_type = '' # Required for WebDAV support (default value)
90
  data = '' # A hack required to use OFS.Image.index_html without calling OFS.Image.__init__
91 92 93

  # Default Properties
  property_sheets = ( PropertySheet.Base
94 95 96 97 98 99 100 101 102 103
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Version
                    , PropertySheet.Reference
                    , PropertySheet.Document
                    , PropertySheet.Data
                    , PropertySheet.ExternalDocument
                    , PropertySheet.Url
                    , PropertySheet.Periodicity
104
    )
105

106 107 108 109
  searchable_property_list = ('title', 'description', 'id', 'reference',
                              'version', 'short_title',
                              'subject', 'source_reference', 'source_project_title',)

110
  # Declarative interfaces
111
  #zope.interface.implements( , )
112 113 114

  ### Special edit method
  security.declarePrivate( '_edit' )
115
  def _edit(self, set_filename__=1, **kw):
116 117
    """\
      This is used to edit files
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118
    """
119 120 121 122
    if kw.has_key('file'):
      file = kw.get('file')
      precondition = kw.get('precondition')
      if self._isNotEmpty(file):
Romain Courteaud's avatar
Romain Courteaud committed
123
        self._setFile(file, precondition=precondition)
124 125
      if set_filename__:
        filename = getattr(file, 'filename', None)
126 127
        # if file field is empty(no file is uploaded),
        # filename is empty string.
Yusei Tahara's avatar
Yusei Tahara committed
128
        if filename not in (None, ''):
129
          kw['source_reference'] = filename
130 131 132 133 134 135 136 137 138 139
      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
    """
140 141 142 143
    data_len = len(getattr(self, 'data', ''))
    if not data_len:
      data_len = len(self.getBaseData() or '')
    return data_len
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144

145
  getcontentlength = get_size
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146

Romain Courteaud's avatar
Romain Courteaud committed
147 148 149 150 151 152 153 154 155
  def _setFile(self, data, precondition=None):
    self.clearConversionCache()
    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()

156 157 158 159 160 161 162
  security.declareProtected(Permissions.AccessContentsInformation, 'hasFile')
  def hasFile(self):
    """
    Checks whether a file was uploaded into the document.
    """
    return self.hasData()

163 164 165 166 167 168 169 170
  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()

171 172 173 174 175 176 177 178 179 180 181 182 183
  security.declareProtected(Permissions.ModifyPortalContent, 'guessMimeType')
  def guessMimeType(self, fname=''):
    """
      get mime type from file name
    """
    if fname == '': fname = self.getOriginalFilename()
    if fname:
      content_type,enc = mimetypes.guess_type(fname)
      if content_type is not None:
        self.content_type = content_type
    return content_type

  security.declareProtected(Permissions.ModifyPortalContent,'PUT')
184
  def PUT(self, REQUEST, RESPONSE):
Romain Courteaud's avatar
Romain Courteaud committed
185
    self.clearConversionCache()
186
    CMFFile.PUT(self, REQUEST, RESPONSE)
187 188

  # DAV Support
Jean-Paul Smets's avatar
Jean-Paul Smets committed
189 190
  index_html = CMFFile.index_html 
  PUT = CMFFile.PUT
191
  security.declareProtected('FTP access', 'manage_FTPget', 'manage_FTPstat', 'manage_FTPlist')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
192 193 194
  manage_FTPget = CMFFile.manage_FTPget
  manage_FTPlist = CMFFile.manage_FTPlist
  manage_FTPstat = CMFFile.manage_FTPstat
195 196 197 198 199 200 201 202 203 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

  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)