uploadable.py 4.7 KB
Newer Older
Jean-Paul Smets 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 28 29 30
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@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.
#
##############################################################################

from zope.interface import Interface
31
MAX_REPEAT = 0 # XXX - this variable should be put somewhere else
Jean-Paul Smets committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

class IUploadable(Interface):
  """
  Uploadable interface specification

  Documents which implement IUploadable can be updated
  by uploading a file using multiple formats. IUploadable
  provides methods to list possible source formats which
  can be uploaded into a document.
  """

  def isSourceFormatAllowed(format):
    """
    Checks if a file with the specified format
    can be uploaded into the current document.

    format -- the source conversion format specified either as an
              extension (ex. 'png') or as a mime type
              string (ex. 'text/plain')
    """

  def isSourceFormatPermitted(format):
    """
    Checks if the current user can upload into the current
    document a file with the specified source format.
    This method can be used to restrict the list of possible
58
    formats which can be uploaded into a document to a certain group of
Jean-Paul Smets committed
59
    users (ex. users which are known to use
60
    OpenOffice in a company are only allowed to upload ODT files,
Jean-Paul Smets committed
61 62 63 64 65 66 67 68 69 70 71 72 73
    as a way to prevent the use of illegal copies of other applications).

    format -- the source conversion format specified either as an
              extension (ex. 'png') or as a mime type
              string (ex. 'text/plain')
    """

  def getSourceFormatItemList():
    """
    Returns the list of acceptable formats for upload
    in the form of tuples which can be used for example for
    listfield in ERP5Form. Each tuple in the list has the form
    (title, format) where format is an extension (ex. 'png')
74 75
    which can be passed to IConvertable.convert or to
    IDownloadable.index_html and title is a string which
Jean-Paul Smets committed
76
    can be translated and displayed to the user.
77 78 79

    Example of result:
        [('ODF Drawing', 'odg'), ('ODF Drawing Template', 'otg'),
Jean-Paul Smets committed
80 81 82 83 84
        ('OpenOffice.org 1.0 Drawing', 'sxd')]
    """

  def getSourceFormatTitleList():
    """
85 86
    Returns the list of titles of acceptable formats for upload
    as a list of strings which can be translated and displayed
Jean-Paul Smets committed
87 88 89 90 91 92
    to the user.
    """

  def getSourceFormatList():
    """
    Returns the list of acceptable formats for upload
93
    where format is an extension (ex. 'png') which can be
Jean-Paul Smets committed
94
    passed to IConvertable.convert or to IDownloadable.index_html
95 96
    """

97 98
  def updateContentFromURL(url=None, repeat=MAX_REPEAT, crawling_depth=0,
                           repeat_interval=1, batch_mode=True):
99 100 101
    """
    Download and update content of this document from the specified URL.
    If no url is specified, Document which support the IUrlGetter
102
    interface use the Url of the document itself.
103 104 105 106

    url -- optional URL to download the updated content from.
           required whenever document does not implement IUrlGetter

107
    crawling_depth -- optional crawling depth for documents which
108 109
                      implement ICrawlable

110 111 112 113 114 115
    repeat -- optional max number of retries for download

    repeat_interval -- optional interval between repeats

    batch_mode -- optional specify False if used in a user interface

116 117 118
    NOTE: implementation is normally delegated to ContributionTool.

    XXX - it is unclear whether MAX_REPEAT should be part of signature
119 120 121 122 123 124
    """

  def isExternalDocument():
    """
    Returns True if content was downloaded from a URL. Returns False
    if content was uploaded from a file.
125
    """