File.py 6.4 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 mimetypes
import re
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31

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

43 44
mimetypes.init()

45 46 47 48 49 50 51 52 53 54 55 56 57
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
58
class File(Document, CMFFile, ConversionCacheMixin):
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 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)

  # Default Properties
  property_sheets = ( PropertySheet.Base
90 91 92 93 94 95 96 97 98 99
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Version
                    , PropertySheet.Reference
                    , PropertySheet.Document
                    , PropertySheet.Data
                    , PropertySheet.ExternalDocument
                    , PropertySheet.Url
                    , PropertySheet.Periodicity
100
    )
101

102 103 104 105
  searchable_property_list = ('title', 'description', 'id', 'reference',
                              'version', 'short_title',
                              'subject', 'source_reference', 'source_project_title',)

106 107 108 109 110 111 112 113
  # Declarative interfaces
  #__implements__ = ( , )

  ### Special edit method
  security.declarePrivate( '_edit' )
  def _edit(self, **kw):
    """\
      This is used to edit files
Jean-Paul Smets's avatar
Jean-Paul Smets committed
114
    """
115 116 117 118
    if kw.has_key('file'):
      file = kw.get('file')
      precondition = kw.get('precondition')
      if self._isNotEmpty(file):
Romain Courteaud's avatar
Romain Courteaud committed
119
        self._setFile(file, precondition=precondition)
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
      del kw['file']
    Base._edit(self, **kw)

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

  # Copy support needs to be implemented by ExtFile
  ################################
  # Special management methods   #
  ################################

  def manage_afterClone(self, item):
    Base.manage_afterClone(self, item)
    CMFFile.manage_afterClone(self, item)

  def manage_afterAdd(self, item, container):
    Base.manage_afterAdd(self, item, container)
    CMFFile.manage_afterAdd(self, item, container)

  def manage_beforeDelete(self, item, container):
    CMFFile.manage_beforeDelete(self, item, container)

  def get_size(self):
    """
    has to be overwritten here, otherwise WebDAV fails
    """
    try:
      return len(self.data)
    except (AttributeError, TypeError):
      return 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
150

151
  getcontentlength = get_size
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152

Romain Courteaud's avatar
Romain Courteaud committed
153 154 155 156 157 158 159 160 161
  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()

162 163 164 165 166 167 168
  security.declareProtected(Permissions.AccessContentsInformation, 'hasFile')
  def hasFile(self):
    """
    Checks whether a file was uploaded into the document.
    """
    return self.hasData()

169 170 171 172 173 174 175 176 177 178 179 180 181
  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')
182
  def PUT(self, REQUEST, RESPONSE):
Romain Courteaud's avatar
Romain Courteaud committed
183
    self.clearConversionCache()
184
    CMFFile.PUT(self, REQUEST, RESPONSE)
185 186

  # DAV Support
Jean-Paul Smets's avatar
Jean-Paul Smets committed
187 188
  index_html = CMFFile.index_html 
  PUT = CMFFile.PUT
189
  security.declareProtected('FTP access', 'manage_FTPget', 'manage_FTPstat', 'manage_FTPlist')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190 191 192
  manage_FTPget = CMFFile.manage_FTPget
  manage_FTPlist = CMFFile.manage_FTPlist
  manage_FTPstat = CMFFile.manage_FTPstat