Deactivted all BBB to ensure that we use only the latest code in zope…

….app

Made almost all tests pass again, except the few that heavily depended on
the old way of doing things: apidoc, module, presentation

tests/test_xmlnavigationviews.py

@@ -0,0 +1,87 @@
+##############################################################################
+#
+# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
+# 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.
+#
+##############################################################################
+"""XML Navigation Tree Tests
+
+$Id$
+"""
+from unittest import TestCase, TestLoader, TextTestRunner
+
+from zope.interface import implements
+from zope.pagetemplate.tests.util import check_xml
+from zope.publisher.browser import TestRequest
+from zope.publisher.interfaces.browser import IBrowserPublisher
+from zope.publisher.interfaces import NotFound
+
+from zope.app.testing import ztapi
+from zope.app.traversing.api import traverse
+from zope.app.container.interfaces import IReadContainer
+
+from zope.app.rotterdam.tests import util
+from zope.app.rotterdam.xmlobject import ReadContainerXmlObjectView
+from zope.app.rotterdam.xmlobject import XmlObjectView
+
+from zope.app.component.testing import PlacefulSetup
+
+class File(object):
+    pass
+
+class TestXmlObject(PlacefulSetup, TestCase):
+
+    def setUp(self):
+        PlacefulSetup.setUp(self, site=True)
+
+    def testXMLTreeViews(self):
+        rcxov = ReadContainerXmlObjectView
+        treeView = rcxov(self.folder1, TestRequest()).singleBranchTree
+        check_xml(treeView(), util.read_output('test1.xml'))
+
+        treeView = rcxov(self.folder1, TestRequest()).children
+        check_xml(treeView(), util.read_output('test2.xml'))
+
+        treeView = rcxov(self.folder1_1_1, TestRequest()).children
+        check_xml(treeView(), util.read_output('test3.xml'))
+
+        treeView = rcxov(self.rootFolder, TestRequest()).children
+        check_xml(treeView(), util.read_output('test4.xml'))
+
+        file1 = File()
+        self.folder1_1_1["file1"] = file1
+        self.file1 = traverse(self.rootFolder,
+                              '/folder1/folder1_1/folder1_1_1/file1')
+
+        class ReadContainerView(ReadContainerXmlObjectView):
+            implements(IBrowserPublisher)
+            def browserDefault(self, request):
+                return self, ()
+            def publishTraverse(self, request, name):
+                raise NotFound(self, name, request)
+            def __call__(self):
+                return self.singleBranchTree()
+
+        ztapi.browserView(IReadContainer, 'singleBranchTree.xml',
+                          ReadContainerView)
+
+        treeView = rcxov(self.folder1_1_1, TestRequest()).singleBranchTree
+        check_xml(treeView(), util.read_output('test5.xml'))
+
+        treeView = XmlObjectView(self.file1, TestRequest()).singleBranchTree
+        check_xml(treeView(), util.read_output('test5.xml'))
+
+
+def test_suite():
+    loader = TestLoader()
+    return loader.loadTestsFromTestCase(TestXmlObject)
+
+if __name__=='__main__':
+    TextTestRunner().run(test_suite())

xmlobject.py

@@ -0,0 +1,178 @@
+##############################################################################
+#
+# Copyright (c) 2002 Zope Corporation and Contributors.
+# 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.
+#
+##############################################################################
+"""Service manager interfaces
+
+$Id$
+"""
+
+from zope.app.publisher.browser import BrowserView
+from zope.app import zapi
+from zope.app.container.interfaces import IReadContainer
+from zope.app.traversing.api import getParents, getParent, traverse
+from zope.interface import Interface
+from zope.security.interfaces import Unauthorized, Forbidden
+from rfc822 import formatdate, time
+from xml.sax.saxutils import quoteattr
+
+def setNoCacheHeaders(response):
+    """Ensure that the tree isn't cached"""
+    response.setHeader('Pragma', 'no-cache')
+    response.setHeader('Cache-Control', 'no-cache')
+    response.setHeader('Expires', formatdate(time.time()-7*86400))#7 days ago
+
+def xmlEscape(format, *args):
+    quotedArgs = [ quoteattr(str(arg)) for arg in args ]
+    return format%tuple(quotedArgs)
+
+def xmlEscapeWithCData(format, *args):
+    cData = args[-1]
+    quotedArgs = [ quoteattr(str(arg)) for arg in args[:-1] ]
+    quotedArgsWithCData = quotedArgs + [cData]
+    return format%tuple(quotedArgsWithCData)
+
+
+class ReadContainerXmlObjectView(BrowserView):
+    """Provide a xml interface for dynamic navigation tree in UI"""
+
+    __used_for__ = IReadContainer
+
+
+    def getIconUrl(self, item):
+        result = ''
+        icon = zapi.queryMultiAdapter((item, self.request), name='zmi_icon')
+        if icon:
+            result = icon.url()
+        return result
+
+    def getLengthOf(self, item):
+        res = -1
+        if IReadContainer.providedBy(item):
+            try:
+                res = len(item)
+            except (Unauthorized, Forbidden):
+                pass
+        return res
+
+    def children_utility(self, container):
+        """Return an XML document that contains the children of an object."""
+        result = []
+
+        keys = list(container.keys())
+
+        # include the service manager
+        keys.append('++etc++site')
+
+        for name in keys:
+
+            # Only include items we can traverse to
+            item = traverse(container, name, None)
+            if item is None:
+                continue
+
+            iconUrl = self.getIconUrl(item)
+            item_len = self.getLengthOf(item)
+            if item_len >= 0:
+                result.append(xmlEscape(
+                    '<collection name=%s length=%s icon_url=%s/>',
+                    name, item_len, iconUrl))
+            else:
+                result.append(xmlEscape(
+                    '<item name=%s icon_url=%s/>',
+                    name, iconUrl))
+
+        return ' '.join(result)
+
+
+    def children(self):
+        """ """
+        container = self.context
+        self.request.response.setHeader('Content-Type', 'text/xml')
+        setNoCacheHeaders(self.request.response)
+        res = (u'<?xml version="1.0" ?><children> %s </children>'
+                % self.children_utility(container))
+        return res
+
+    def singleBranchTree(self, root=''):
+        """Return an XML document with the siblings and parents of an object.
+
+        There is only one branch expanded, in other words, the tree is
+        filled with the object, its siblings and its parents with
+        their respective siblings.
+
+        """
+        result = ''
+        oldItem = self.context
+        for item in getParents(self.context):
+            # skip skin if present
+            #if item == oldItem:
+            #        continue
+            subItems = []
+            if IReadContainer.providedBy(item):
+                keys = list(item.keys())
+            else:
+                keys = []
+
+            # include the service manager
+            keys.append('++etc++site')
+
+            for name in keys:
+                # Only include items we can traverse to
+                subItem = traverse(item, name, None)
+                iconUrl = self.getIconUrl(subItem)
+                subitem_len = self.getLengthOf(subItem)
+                if subitem_len >= 0:
+                    # the test below seems to be browken with the ++etc++site case
+                    if subItem == oldItem:
+                        subItems.append(xmlEscapeWithCData(
+                            '<collection name=%s length=%s '
+                            'icon_url=%s>%s</collection>', 
+                            name, subitem_len, iconUrl, result))
+                    else:
+                        subItems.append(xmlEscape(
+                            '<collection name=%s length=%s '
+                            'icon_url=%s/>',
+                            name, subitem_len, iconUrl))
+                else:
+                    subItems.append(xmlEscape(
+                        '<item name=%s icon_url=%s />', name, iconUrl))
+
+            result = ' '.join(subItems)
+            oldItem = item
+
+        # do not forget root folder
+        iconUrl = self.getIconUrl(oldItem)
+        result = (xmlEscapeWithCData('<collection name="" length=%s '
+                  'icon_url=%s isroot="">%s</collection>',
+                  len(oldItem), iconUrl, result))
+
+        self.request.response.setHeader('Content-Type', 'text/xml')
+        setNoCacheHeaders(self.request.response)
+        res= u'<?xml version="1.0" ?><children> %s </children>' % result
+        return res
+
+class XmlObjectView(BrowserView):
+    """Provide a xml interface for dynamic navigation tree in UI"""
+
+    __used_for__ = Interface
+
+    def singleBranchTree(self, root=''):
+        parent = getParent(self.context)
+        while parent is not None:
+                if IReadContainer.providedBy(parent):
+                    view = zapi.queryView(parent,
+                                          'singleBranchTree.xml',
+                                          self.request)
+                    return view()
+                else:
+                    parent = getParent(parent)