downloadable.py 6.3 KB
Newer Older
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 28
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
#                    Nicolas Delaby <nicolas@nexedi.com>
#
# 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
from AccessControl import ClassSecurityInfo, Unauthorized
30
from Products.ERP5Type import Permissions
31
from Products.ERP5Type.Utils import fill_args_from_request
32 33
from Products.CMFCore.utils import getToolByName, _setCacheHeaders,\
    _ViewEmulator
Nicolas Delaby's avatar
Nicolas Delaby committed
34
import warnings
35
from zExceptions import Forbidden
36

37 38
_MARKER = []

39 40 41 42 43
class DownloadableMixin:
  security = ClassSecurityInfo()

  ### Content processing methods
  security.declareProtected(Permissions.View, 'index_html')
44
  @fill_args_from_request('display', 'quality', 'resolution', 'frame')
45
  def index_html(self, REQUEST, RESPONSE, format=_MARKER, **kw):
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
    """
      We follow here the standard Zope API for files and images
      and extend it to support format conversion. The idea
      is that an image which ID is "something.jpg" should
      ne directly accessible through the URL
      /a/b/something.jpg. The same is true for a file and
      for any document type which primary purpose is to
      be used by a helper application rather than displayed
      as HTML in a web browser. Exceptions to this approach
      include Web Pages which are intended to be primarily rendered
      withing the layout of a Web Site or withing a standard ERP5 page.
      Please refer to the index_html of TextDocument.

      Should return appropriate format (calling convert
      if necessary) and set headers.

      format -- the format specied in the form of an extension
      string (ex. jpeg, html, text, txt, etc.)

      **kw -- can be various things - e.g. resolution

    """
    from Products.ERP5.Document.Document import VALID_TEXT_FORMAT_LIST,\
                                                        VALID_IMAGE_FORMAT_LIST
    web_cache_kw = kw.copy()
71 72
    if format is not _MARKER:
      web_cache_kw['format'] = format
73 74
    _setCacheHeaders(_ViewEmulator().__of__(self), web_cache_kw)

75 76 77 78 79
    if format is _MARKER and not kw:
      # conversion parameters is mandatory to download the converted content.
      # By default allways return view action.
      # for all WevDAV access return raw content.
      return self.view()
80 81
    if format is _MARKER:
      format = None
82
    self._checkConversionFormatPermission(format, **kw)
83 84 85
    if not self.checkConversionFormatPermission(format, **kw):
      raise Forbidden('You are not allowed to get this document in this ' \
                      'format')
86
    mime, data = self.convert(format, **kw)
87
    output_format = None
Nicolas Delaby's avatar
Nicolas Delaby committed
88
    if not format:
89 90 91 92 93 94
      # Guess the format from original mimetype
      mimetypes_registry = getToolByName(self.getPortalObject(),
                                                          'mimetypes_registry')
      mimetype_object_list = mimetypes_registry.lookup(mime)
      for mimetype_object in mimetype_object_list:
        if mimetype_object.extensions:
95
          output_format = mimetype_object.extensions[0]
96 97
          break
        elif mimetype_object.globs:
98
          output_format = mimetype_object.globs.strip('*.')
99
          break
100 101
    else:
      output_format = format
102 103

    RESPONSE.setHeader('Content-Length', len(data))
104
    if output_format in VALID_TEXT_FORMAT_LIST:
105 106 107
      RESPONSE.setHeader('Content-Type', '%s; charset=utf-8' % mime)
    else:
      RESPONSE.setHeader('Content-Type', mime)
108
    if output_format not in (VALID_TEXT_FORMAT_LIST + VALID_IMAGE_FORMAT_LIST):
109
      # need to return it as attachment
Jérome Perrin's avatar
Jérome Perrin committed
110
      filename = self.getStandardFilename(format=format)
111 112 113 114 115 116
      RESPONSE.setHeader('Content-Disposition',
                         'attachment; filename="%s"' % filename)
      RESPONSE.setHeader('Accept-Ranges', 'bytes')
    return str(data)

  security.declareProtected(Permissions.AccessContentsInformation,
Nicolas Delaby's avatar
Nicolas Delaby committed
117 118
                            'getStandardFilename')
  def getStandardFilename(self, format=None):
119 120 121
    """Returns the document coordinates as a standard file name. This
    method is the reverse of getPropertyDictFromFileName.
    """
122 123
    try:
      method = self._getTypeBasedMethod('getStandardFilename',
Nicolas Delaby's avatar
Nicolas Delaby committed
124
                             fallback_script_id='Document_getStandardFilename')
125
    except AttributeError:
Nicolas Delaby's avatar
Nicolas Delaby committed
126 127
      # backward compatibility
      method = self._getTypeBasedMethod('getStandardFileName',
128
                             fallback_script_id='Document_getStandardFileName')
129 130 131 132 133
    try:
      return method(format=format)
    except TypeError:
      # Old versions of this script did not support 'format' parameter
      return method()
134

Nicolas Delaby's avatar
Nicolas Delaby committed
135 136 137 138 139 140 141 142 143
  # backward compatibility
  security.declareProtected(Permissions.AccessContentsInformation,
                            'getStandardFileName')
  def getStandardFileName(self, format=None):
    """(deprecated) use getStandardFilename() instead."""
    warnings.warn('getStandardFileName() is deprecated. '
                  'use getStandardFilename() instead.')
    return self.getStandardFilename(format=format)

144 145 146 147 148 149
  def manage_FTPget(self):
    """Return body for ftp. and WebDAV
    """
    # pass format argument to force downloading raw content
    REQUEST = self.REQUEST
    return self.index_html(REQUEST, REQUEST.RESPONSE, format=None)