diff --git a/product/ERP5/Document/Document.py b/product/ERP5/Document/Document.py index 7aa5be9dff90f67b8db4a716a3d5f5bf1cad4cf3..5c41655245dba8e843b00f1fb14fcaee08965865 100644 --- a/product/ERP5/Document/Document.py +++ b/product/ERP5/Document/Document.py @@ -129,30 +129,6 @@ class DocumentProxyError(Exception):pass class NotConvertedError(Exception):pass allow_class(NotConvertedError) -class DocumentProxyMixin: - """ - Provides access to documents referenced by the follow_up field - """ - # Declarative security - security = ClassSecurityInfo() - security.declareObjectProtected(Permissions.AccessContentsInformation) - - security.declareProtected(Permissions.AccessContentsInformation,'index_html') - def index_html(self, REQUEST, *args, **kw): - """ Only a proxy method """ - return self.getProxiedDocument().index_html(REQUEST, *args, **kw) - - security.declareProtected(Permissions.AccessContentsInformation, - 'getProxiedDocument' ) - def getProxiedDocument(self): - """ - Try to retrieve the original document - """ - proxied_document = self.getDocumentProxyValue() - if proxied_document is None: - raise DocumentProxyError("Unable to find a proxied document") - return proxied_document - class UpdateMixIn: """ Provides an API to compute a date index based on the update @@ -206,7 +182,6 @@ class UpdateMixIn: fallback_script_id = 'Document_isUpdatable') return method() - class Document(DocumentExtensibleTraversableMixIn, XMLObject, UrlMixIn, CachedConvertableMixin, SnapshotMixin, UpdateMixIn, TextConvertableMixin, DownloadableMixin, DocumentMixin): diff --git a/product/ERP5/Document/EmailDocument.py b/product/ERP5/Document/EmailDocument.py index 5a198ee7245133d84fa2426ae9ac2bfbb2d04ddd..6763dd2084bbe9abd62a896a83a5ee2e4efa9e2e 100644 --- a/product/ERP5/Document/EmailDocument.py +++ b/product/ERP5/Document/EmailDocument.py @@ -35,11 +35,10 @@ from Products.CMFCore.utils import _checkPermission from Products.ERP5Type import Permissions, PropertySheet from Products.ERP5.Document.TextDocument import TextDocument from Products.ERP5.Document.File import File -from Products.ERP5.Document.Document import ConversionError, \ - DocumentProxyMixin, DocumentProxyError +from Products.ERP5.Document.Document import ConversionError +from Products.ERP5.mixin.document_proxy import DocumentProxyMixin, DocumentProxyError from Products.ERP5.Tool.NotificationTool import buildEmailMessage from MethodObject import Method - from zLOG import LOG, INFO try: diff --git a/product/ERP5/interfaces/document_proxy.py b/product/ERP5/interfaces/document_proxy.py new file mode 100644 index 0000000000000000000000000000000000000000..7da5dc20f9f23723cc9942d50fb0c947c5d888c9 --- /dev/null +++ b/product/ERP5/interfaces/document_proxy.py @@ -0,0 +1,49 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved. +# Ivan Tyagov <ivan@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 ILegacyDocumentProxy(Interface): + + def getProxiedDocument(self, **kw): + """ + Get the proxied document + """ + +class IDocumentProxy(ILegacyDocumentProxy): + """ + Document Proxy interface specification + + IDocumentProxy provides API to access to proxied documents of the current context. + """ + + def getProxiedDocumentValue(self, **kw): + """ + Get the proxied document + """ \ No newline at end of file diff --git a/product/ERP5/mixin/document_proxy.py b/product/ERP5/mixin/document_proxy.py new file mode 100644 index 0000000000000000000000000000000000000000..f147c5632e54d8e96793739babcb12772ae2ae04 --- /dev/null +++ b/product/ERP5/mixin/document_proxy.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved. +# Ivan Tyagov <ivan@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 AccessControl import ClassSecurityInfo +from Products.ERP5Type import Permissions +from warnings import warn + +class DocumentProxyError(Exception):pass + +class DocumentProxyMixin: + """ + This class provides a generic implementation of IDocumentProxy and IDownloadable. + """ + + # Declarative security + security = ClassSecurityInfo() + security.declareObjectProtected(Permissions.AccessContentsInformation) + + security.declareProtected(Permissions.AccessContentsInformation, 'index_html') + def index_html(self, REQUEST, *args, **kw): + """ Only a proxy method """ + return self.getProxiedDocument().index_html(REQUEST, *args, **kw) + + security.declareProtected(Permissions.AccessContentsInformation, \ + 'getProxiedDocument' ) + def getProxiedDocument(self): + """ + Try to retrieve the original document + """ + warn("getProxiedDocument() function is deprecated. Use getProxiedDocumentValue() instead.", \ + DeprecationWarning, stacklevel=2) + return self.getProxiedDocumentValue() + + security.declareProtected(Permissions.AccessContentsInformation, + 'getProxiedDocument' ) + def getProxiedDocumentValue(self): + """ + Try to retrieve the original document + """ + proxied_document = self.getDocumentProxyValue() + if proxied_document is None: + raise DocumentProxyError("Unable to find a proxied document") + return proxied_document + \ No newline at end of file