Introduce ZPublisher.zpublish decorator to explicitly control zpubl…

…ishabilty
zopefoundation · Feb 17, 2024 · 74593fa · 74593fa
1 parent 9d00e1b
commit 74593fa
Show file tree

Hide file tree

Showing 32 changed files with 383 additions and 39 deletions.
diff --git a/docs/zdgbook/ObjectPublishing.rst b/docs/zdgbook/ObjectPublishing.rst
@@ -130,8 +130,17 @@ Publishable Object Requirements
 -------------------------------
 
 Zope has few restrictions on publishable objects. The basic rule is
-that the object must have a doc string. This requirement goes for
+that the object must have been marked as zpublishable. This requirement goes for
 methods, too.
+An object or method is marked as zpublishable by decorating
+its class (or a base class) or underlying function, respectively,
+with the ``Zpublisher.zpublish`` decorator.
+For backward compatibility, the existence of a docstring, too,
+marks an object or method as zpublishable; but this will be removed in
+the future.
+If you decorate a method or class with ``zpublsh(False)``,
+you explicitly mark it or its instances, respectively, as not
+zpublishable.
 
 Another requirement is that a publishable object must not have a name
 that begins with an underscore. These two restrictions are designed to
@@ -270,9 +279,13 @@ allow you to navigate between methods.
 
 Consider this example::
 
+  from ZPublisher import zpublish
+
+  @zpublish
   class Example:
       """example class"""
 
+      @zpublish
       def one(self):
           """render page one"""
           return """<html>
@@ -282,6 +295,7 @@ Consider this example::
                     </body>
                     </html>"""
 
+      @zpublish
       def two(self):
           """render page two"""
           return """<html>
@@ -298,9 +312,11 @@ the URL, relative links returned by ``index_html`` won't work right.
 
 For example::
 
+	    @zpublish
             class Example:
                 """example class""""
 
+		 @zpublish
                  def index_html(self):
                      """render default view"""
                     return """<html>
@@ -375,7 +391,9 @@ acquisition, you can use traversal to walk over acquired objects.
 Consider the the following object hierarchy::
 
         from Acquisition import Implicit
+	from ZPublisher import zpublish
 
+	@zpublish
         class Node(Implicit):
             ...
 
@@ -401,20 +419,27 @@ method that your acquire from outside your container.
 For example::
 
         from Acquisition import Implicit
+	from ZPublisher import zpublish
 
+	@zpublish
         class Basket(Implicit):
             ...
+	    @zpublish
             def number_of_items(self):
                 """Returns the number of contained items."""
                 ...
 
+	@zpublish
         class Vegetable(Implicit):
             ...
+	    @zpublish
             def texture(self):
                 """Returns the texture of the vegetable."""
 
+	@zpublish
         class Fruit(Implicit):
             ...
+	    @zpublish
             def color(self):
                 """Returns the color of the fruit."""
 
@@ -582,6 +607,7 @@ called from the web.
 
 Consider this function::
 
+      @zpublish
       def greet(name):
           """Greet someone by name."""
           return "Hello, %s!" % name
@@ -663,6 +689,7 @@ Argument Conversion
 The publisher supports argument conversion. For example consider this
 function::
 
+	@zpublish
         def one_third(number):
             """returns the number divided by three"""
             return number / 3.0

diff --git a/src/App/FactoryDispatcher.py b/src/App/FactoryDispatcher.py
@@ -25,6 +25,7 @@
 from Acquisition import aq_base
 from ExtensionClass import Base
 from OFS.metaconfigure import get_registered_packages
+from ZPublisher import zpublish
 
 
 def _product_packages():
@@ -45,6 +46,7 @@ def _product_packages():
     return _packages
 
 
+@zpublish
 class Product(Base):
     """Model a non-persistent product wrapper.
     """
@@ -68,6 +70,7 @@ def Destination(self):
 InitializeClass(Product)
 
 
+@zpublish
 class ProductDispatcher(Implicit):
     " "
     # Allow access to factory dispatchers
@@ -95,6 +98,7 @@ def __bobo_traverse__(self, REQUEST, name):
         return dispatcher.__of__(self)
 
 
+@zpublish
 class FactoryDispatcher(Implicit):
     """Provide a namespace for product "methods"
     """

diff --git a/src/App/Management.py b/src/App/Management.py
@@ -29,8 +29,10 @@
 from App.special_dtml import DTMLFile
 from ExtensionClass import Base
 from zope.interface import implementer
+from ZPublisher import zpublish
 
 
+@zpublish
 class Tabs(Base):
     """Mix-in provides management folder tab support."""
 
@@ -68,6 +70,7 @@ def filtered_manage_options(self, REQUEST=None):
 
     manage_workspace__roles__ = ('Authenticated',)
 
+    @zpublish
     def manage_workspace(self, REQUEST):
         """Dispatch to first interface in manage_options
         """
@@ -181,6 +184,7 @@ def manage_page_header(self, *args, **kw):
     security.declarePublic('zope_copyright')  # NOQA: D001
     zope_copyright = DTMLFile('dtml/copyright', globals())
 
+    @zpublish
     @security.public
     def manage_zmi_logout(self, REQUEST, RESPONSE):
         """Logout current user"""

diff --git a/src/App/ProductContext.py b/src/App/ProductContext.py
@@ -22,6 +22,7 @@
 from App.FactoryDispatcher import FactoryDispatcher
 from OFS.ObjectManager import ObjectManager
 from zope.interface import implementedBy
+from ZPublisher import zpublish
 
 
 if not hasattr(Products, 'meta_types'):
@@ -99,6 +100,9 @@ class will be registered.
         productObject = self.__prod
         pid = productObject.id
 
+        if instance_class is not None:
+            zpublish(instance_class)
+
         if permissions:
             if isinstance(permissions, str):  # You goofed it!
                 raise TypeError(
@@ -130,19 +134,21 @@ class will be registered.
         for method in legacy:
             if isinstance(method, tuple):
                 name, method = method
+                mname = method.__name__
                 aliased = 1
             else:
                 name = method.__name__
                 aliased = 0
             if name not in OM.__dict__:
+                method = zpublish(True, method)
                 setattr(OM, name, method)
                 setattr(OM, name + '__roles__', pr)
                 if aliased:
                     # Set the unaliased method name and its roles
                     # to avoid security holes.  XXX: All "legacy"
                     # methods need to be eliminated.
-                    setattr(OM, method.__name__, method)
-                    setattr(OM, method.__name__ + '__roles__', pr)
+                    setattr(OM, mname, method)
+                    setattr(OM, mname + '__roles__', pr)
 
         if isinstance(initial, tuple):
             name, initial = initial
@@ -195,7 +201,7 @@ class __FactoryDispatcher__(FactoryDispatcher):
             else:
                 name = os.path.split(method.__name__)[-1]
             if name not in productObject.__dict__:
-                m[name] = method
+                m[name] = zpublish(True, method)
                 m[name + '__roles__'] = pr
 
     def getApplication(self):

diff --git a/src/App/special_dtml.py b/src/App/special_dtml.py
@@ -33,6 +33,7 @@
 from DocumentTemplate.DT_String import DTReturn
 from DocumentTemplate.DT_String import _marker
 from Shared.DC.Scripts.Bindings import Bindings
+from ZPublisher import zpublish
 
 
 LOG = getLogger('special_dtml')
@@ -46,10 +47,12 @@ class Code:
     pass
 
 
+@zpublish
 class HTML(DocumentTemplate.HTML, Persistence.Persistent):
     "Persistent HTML Document Templates"
 
 
+@zpublish
 class ClassicHTMLFile(DocumentTemplate.HTMLFile, MethodObject.Method):
     "Persistent HTML Document Templates read from files"
 

diff --git a/src/OFS/Application.py b/src/OFS/Application.py
@@ -39,6 +39,7 @@
 from zExceptions import Forbidden
 from zExceptions import Redirect as RedirectException
 from zope.interface import implementer
+from ZPublisher import zpublish
 
 from . import Folder
 from . import misc_
@@ -107,6 +108,7 @@ def Redirect(self, destination, URL1):
 
     ZopeRedirect = Redirect
 
+    @zpublish
     @security.protected(view_management_screens)
     def getZMIMainFrameTarget(self, REQUEST):
         """Utility method to get the right hand side ZMI frame source URL
@@ -200,11 +202,13 @@ def ZopeVersion(self, major=False):
 
             return version
 
+    @zpublish
     def DELETE(self, REQUEST, RESPONSE):
         """Delete a resource object."""
         self.dav__init(REQUEST, RESPONSE)
         raise Forbidden('This resource cannot be deleted.')
 
+    @zpublish
     def MOVE(self, REQUEST, RESPONSE):
         """Move a resource to a new location."""
         self.dav__init(REQUEST, RESPONSE)

diff --git a/src/OFS/DTMLMethod.py b/src/OFS/DTMLMethod.py
@@ -39,6 +39,7 @@
 from zExceptions import ResourceLockedError
 from zExceptions.TracebackSupplement import PathTracebackSupplement
 from zope.contenttype import guess_content_type
+from ZPublisher import zpublish
 from ZPublisher.HTTPRequest import default_encoding
 from ZPublisher.Iterators import IStreamIterator
 
@@ -51,6 +52,7 @@ class Code:
     pass
 
 
+@zpublish
 class DTMLMethod(
     PathReprProvider,
     RestrictedDTML,
@@ -265,6 +267,7 @@ def get_size(self):
     security.declareProtected(change_proxy_roles, 'manage_proxyForm')  # NOQA: D001,E501
     manage_proxyForm = DTMLFile('dtml/documentProxy', globals())
 
+    @zpublish
     @security.protected(change_dtml_methods)
     def manage_edit(self, data, title, SUBMIT='Change', REQUEST=None):
         """ Replace contents with 'data', title with 'title'.
@@ -293,6 +296,7 @@ def manage_edit(self, data, title, SUBMIT='Change', REQUEST=None):
             message = "Saved changes."
             return self.manage_main(self, REQUEST, manage_tabs_message=message)
 
+    @zpublish
     @security.protected(change_dtml_methods)
     def manage_upload(self, file='', REQUEST=None):
         """ Replace the contents of the document with the text in 'file'.
@@ -336,6 +340,7 @@ def _validateProxy(self, roles=None):
             'do not have proxy roles.\n<!--%s, %s-->' % (
                 self.__name__, user, roles))
 
+    @zpublish
     @security.protected(change_proxy_roles)
     @requestmethod('POST')
     def manage_proxy(self, roles=(), REQUEST=None):
@@ -363,6 +368,7 @@ def document_src(self, REQUEST=None, RESPONSE=None):
             RESPONSE.setHeader('Content-Type', 'text/plain')
         return self.read()
 
+    @zpublish
     @security.protected(change_dtml_methods)
     def PUT(self, REQUEST, RESPONSE):
         """ Handle HTTP PUT requests.

diff --git a/src/OFS/FindSupport.py b/src/OFS/FindSupport.py
@@ -28,6 +28,7 @@
 from ExtensionClass import Base
 from OFS.interfaces import IFindSupport
 from zope.interface import implementer
+from ZPublisher import zpublish
 from ZPublisher.HTTPRequest import default_encoding
 
 
@@ -52,6 +53,7 @@ class FindSupport(Base):
         },
     )
 
+    @zpublish
     @security.protected(view_management_screens)
     def ZopeFind(self, obj, obj_ids=None, obj_metatypes=None,
                  obj_searchterm=None, obj_expr=None,
@@ -69,6 +71,7 @@ def ZopeFind(self, obj, obj_ids=None, obj_metatypes=None,
             pre=pre, apply_func=None, apply_path=''
         )
 
+    @zpublish
     @security.protected(view_management_screens)
     def ZopeFindAndApply(self, obj, obj_ids=None, obj_metatypes=None,
                          obj_searchterm=None, obj_expr=None,

diff --git a/src/OFS/Folder.py b/src/OFS/Folder.py
@@ -27,6 +27,7 @@
 from OFS.SimpleItem import PathReprProvider
 from webdav.Collection import Collection
 from zope.interface import implementer
+from ZPublisher import zpublish
 
 
 manage_addFolderForm = DTMLFile('dtml/folderAdd', globals())
@@ -50,6 +51,7 @@ def manage_addFolder(
         return self.manage_main(self, REQUEST)
 
 
+@zpublish
 @implementer(IFolder)
 class Folder(
     PathReprProvider,

diff --git a/src/OFS/History.py b/src/OFS/History.py
@@ -26,6 +26,7 @@
 from DateTime.DateTime import DateTime
 from ExtensionClass import Base
 from zExceptions import Redirect
+from ZPublisher import zpublish
 
 
 view_history = 'View History'
@@ -122,6 +123,7 @@ class Historical(Base):
         HistoryBatchSize=20,
         first_transaction=0, last_transaction=20)
 
+    @zpublish
     @security.protected(view_history)
     def manage_change_history(self):
         first = 0
@@ -146,6 +148,7 @@ def manage_change_history(self):
     def manage_beforeHistoryCopy(self):
         pass
 
+    @zpublish
     def manage_historyCopy(self, keys=[], RESPONSE=None, URL1=None):
         """ Copy a selected revision to the present """
         if not keys:
@@ -176,6 +179,7 @@ def manage_afterHistoryCopy(self):
     _manage_historyComparePage = DTMLFile(
         'dtml/historyCompare', globals(), management_view='History')
 
+    @zpublish
     @security.protected(view_history)
     def manage_historyCompare(self, rev1, rev2, REQUEST,
                               historyComparisonResults=''):
@@ -186,6 +190,7 @@ def manage_historyCompare(self, rev1, rev2, REQUEST,
             dt1=dt1, dt2=dt2,
             historyComparisonResults=historyComparisonResults)
 
+    @zpublish
     @security.protected(view_history)
     def manage_historicalComparison(self, REQUEST, keys=[]):
         """ Compare two selected revisions """