convertable.py 4.07 KB
Newer Older
Jean-Paul Smets's avatar
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 31 32 33 34 35
# -*- 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

class IConvertable(Interface):
  """
  Convertable interface specification

Jean-Paul Smets's avatar
typo  
Jean-Paul Smets committed
36
  Documents which implement IConvertable can be converted
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37 38 39 40 41 42 43 44 45 46 47
  to multiple formats. IConvertable also provides 
  methods to list possible formats which documents can
  be converted to.
  """

  def convert(format, **kw):
    """
    Converts the current document to the specified format
    taking into account optional parameters. This method
    returns a tuple of two values: a mime type string and
    the converted data.
48 49 50 51
    
    This methods raises a ConversionError if the target format
    is not allowed, or an Unauthorized error if the target format
    is not permitted.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53 54 55 56 57 58 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 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

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

    kw -- optional parameters which can be passed to the
          conversion engine
    """

  def isTargetFormatAllowed(format):
    """
    Checks if the current document can be converted
    to the specified target format.

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

  def isTargetFormatPermitted(format):
    """
    Checks if the current user can convert the current
    document to the specified target format.
    This method can be used to restrict the list of possible
    formats to deliver a document to a certain group of 
    users (ex. read-only PDF only for anonymous users)

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

  def getTargetFormatItemList():
    """
    Returns the list of acceptable formats for conversion
    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')
    which can be passed to IConvertable.convert or to 
    IDownloadable.index_html and title is a string which 
    can be translated and displayed to the user.
 
    Example of result:    
        [('ODF Drawing', 'odg'), ('ODF Drawing Template', 'otg'), 
        ('OpenOffice.org 1.0 Drawing', 'sxd')]
    """

  def getTargetFormatTitleList():
    """
    Returns the list of titles of acceptable formats for conversion 
    as a list of strings which can be translated and displayed 
    to the user.
    """

  def getTargetFormatList():
    """
    Returns the list of acceptable formats for conversion
    where format is an extension (ex. 'png') which can be 
    passed to IConvertable.convert or to IDownloadable.index_html
111
    """