src/pyams_content/component/extfile/interfaces.py
changeset 1059 34e6d07ea2e9
parent 1021 1de511ae7703
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pyams_content/component/extfile/interfaces.py	Tue Nov 06 14:40:22 2018 +0100
@@ -0,0 +1,107 @@
+#
+# Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+
+__docformat__ = 'restructuredtext'
+
+from zope.interface import Interface
+from zope.schema import Choice, TextLine
+
+from pyams_content.component.association.interfaces import IAssociationContainerTarget, IAssociationItem
+from pyams_i18n.schema import I18nAudioField, I18nFileField, I18nTextField, I18nTextLineField, I18nThumbnailImageField, \
+    I18nVideoField
+
+from pyams_content import _
+
+
+EXTFILE_CONTAINER_KEY = 'pyams_content.extfile'
+EXTFILE_LINKS_CONTAINER_KEY = 'pyams_content.extfile.links'
+
+
+class IBaseExtFile(IAssociationItem):
+    """Base external file interface"""
+
+    title = I18nTextLineField(title=_("Download link label"),
+                              description=_("Label of download link, as shown in front-office"),
+                              required=False)
+
+    description = I18nTextField(title=_("Description"),
+                                description=_("File description displayed by front-office template"),
+                                required=False)
+
+    author = TextLine(title=_("Author"),
+                      description=_("Name of document's author"),
+                      required=False)
+
+    language = Choice(title=_("Language"),
+                      description=_("File's content language"),
+                      vocabulary="PyAMS base languages",
+                      required=False)
+
+    filename = TextLine(title=_("Save file as..."),
+                        description=_("Name under which the file will be saved"),
+                        required=False)
+
+
+class IExtFile(IBaseExtFile):
+    """Generic external file interface"""
+
+    data = I18nFileField(title=_("File data"),
+                         description=_("File content"),
+                         required=True)
+
+
+class IExtMedia(IExtFile):
+    """External media file interface"""
+
+
+class IExtImage(IExtMedia):
+    """External image file interface"""
+
+    data = I18nThumbnailImageField(title=_("Image data"),
+                                   description=_("Image content"),
+                                   required=True)
+
+
+class IExtVideo(IExtMedia):
+    """External video file interface"""
+
+    data = I18nVideoField(title=_("Video data"),
+                          description=_("Video content"),
+                          required=True)
+
+
+class IExtAudio(IExtMedia):
+    """External audio file interface"""
+
+    data = I18nAudioField(title=_("Audio data"),
+                          description=_("Audio file content"),
+                          required=True)
+
+
+class IExtFileContainerTarget(IAssociationContainerTarget):
+    """External files container marker interface"""
+
+
+#
+# External files management
+#
+
+EXTFILE_MANAGER_INFO_KEY = 'pyams_content.extfile.manager'
+
+
+class IExtFileManagerInfo(Interface):
+    """External file manager interface"""
+
+    default_title_prefix = I18nTextLineField(title=_("Default title prefix"),
+                                             description=_("If used, this prefix will be automatically added to "
+                                                           "download link's label of all files"),
+                                             required=False)