plone.tiles 3.0.0__py3-none-any.whl

plone/tiles/__init__.py

@@ -0,0 +1,7 @@
+from plone.tiles.tile import PersistentTile
+from plone.tiles.tile import Tile
+
+
+# Convenience imports
+
+assert Tile, PersistentTile  # silence pyflakes

plone/tiles/absoluteurl.py

@@ -0,0 +1,101 @@
+from plone.tiles.data import encode
+from plone.tiles.interfaces import ITileDataManager
+from plone.tiles.interfaces import ITileType
+from urllib import parse
+from zope.annotation import IAnnotations
+from zope.component import getMultiAdapter
+from zope.component import queryUtility
+from zope.traversing.browser.absoluteurl import AbsoluteURL
+from zope.traversing.browser.interfaces import IAbsoluteURL
+
+
+_safe = "@+"
+
+
+class BaseTileAbsoluteURL(AbsoluteURL):
+    """Convenience base class"""
+
+    def __str__(self):
+        tile = self.context
+        request = self.request
+
+        tid = tile.id
+        name = tile.__name__
+        context = tile.__parent__
+
+        if name is None or context is None:
+            raise TypeError("Insufficient context to determine URL")
+
+        tileFragment = "@@" + parse.quote(name.encode("utf-8"), _safe)
+        if tid:
+            tileFragment += "/" + parse.quote(tid.encode("utf-8"), _safe)
+
+        absolute_url = getMultiAdapter((context, request), IAbsoluteURL)
+        try:
+            tileFragment = "/".join([str(absolute_url), tileFragment])
+        except TypeError:  # Not enough context to get URL information
+            pass
+
+        return tileFragment
+
+    def breadcrumbs(self):
+        tile = self.context
+        request = self.request
+
+        tid = tile.id
+        name = tile.__name__
+        context = tile.__parent__
+
+        tileFragment = "@@" + parse.quote(name.encode("utf-8"), _safe)
+        if tid:
+            tileFragment += "/" + parse.quote(tid.encode("utf-8"), _safe)
+
+        base = tuple(getMultiAdapter((context, request), IAbsoluteURL).breadcrumbs())
+        base += (
+            {
+                "name": name,
+                "url": "/".join([base[-1]["url"], tileFragment]),
+            },
+        )
+
+        return base
+
+
+class TransientTileAbsoluteURL(BaseTileAbsoluteURL):
+    """Absolute URL for a transient tile. Includes the tile traverser and
+    tile data encoded in the query string.
+    """
+
+    def __str__(self):
+        url = super().__str__()
+        manager = ITileDataManager(self.context)
+
+        # Transient looking tile with id is only really transient
+        # if it caches its decoded query data in request annotations
+        transient = manager.storage == IAnnotations(self.request)
+
+        # When transient looking tile with id is not really transient,
+        # its data should not be encoded into query string
+        if self.context.id and not transient:
+            return url
+
+        # All tiles don't need / have configuration data at all.
+        data = manager.get()
+        if not data:
+            return url
+
+        # But when configuration data is really read from query string
+        # and not persisted, it should also be kept in query string
+        tileType = queryUtility(ITileType, name=self.context.__name__)
+        if tileType is not None and tileType.schema is not None:
+            if "?" in url:
+                url += "&" + encode(data, tileType.schema)
+            else:
+                url += "?" + encode(data, tileType.schema)
+        return url
+
+
+class PersistentTileAbsoluteURL(BaseTileAbsoluteURL):
+    """Absolute URL for a persistent tile. Includes the tile traverser, but no
+    tile data encoded in the query string.
+    """

plone/tiles/configure.zcml

@@ -0,0 +1,184 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
+    i18n_domain="plone.tiles"
+    >
+
+  <!-- Data manager -->
+  <adapter factory=".data.transientTileDataManagerFactory" />
+  <adapter factory=".data.PersistentTileDataManager" />
+  <adapter factory=".data.defaultTileDataContext" />
+  <adapter factory=".data.defaultTileDataStorage" />
+  <adapter factory=".data.defaultPersistentTileDataStorage" />
+
+  <!-- Absolute URL -->
+  <view
+      name="absolute_url"
+      factory=".absoluteurl.TransientTileAbsoluteURL"
+      allowed_interface="zope.traversing.browser.interfaces.IAbsoluteURL"
+      for=".interfaces.ITile"
+      permission="zope.Public"
+      type="zope.publisher.interfaces.http.IHTTPRequest"
+      />
+
+  <view
+      factory=".absoluteurl.TransientTileAbsoluteURL"
+      provides="zope.traversing.browser.interfaces.IAbsoluteURL"
+      for=".interfaces.ITile"
+      permission="zope.Public"
+      type="zope.publisher.interfaces.http.IHTTPRequest"
+      />
+
+  <view
+      name="absolute_url"
+      factory=".absoluteurl.PersistentTileAbsoluteURL"
+      allowed_interface="zope.traversing.browser.interfaces.IAbsoluteURL"
+      for=".interfaces.IPersistentTile"
+      permission="zope.Public"
+      type="zope.publisher.interfaces.http.IHTTPRequest"
+      />
+
+  <view
+      factory=".absoluteurl.PersistentTileAbsoluteURL"
+      provides="zope.traversing.browser.interfaces.IAbsoluteURL"
+      for=".interfaces.IPersistentTile"
+      permission="zope.Public"
+      type="zope.publisher.interfaces.http.IHTTPRequest"
+      />
+
+  <!-- ESI -->
+  <browser:page
+      name="esi-head"
+      for=".interfaces.IESIRendered"
+      class=".esi.ESIHead"
+      permission="zope.Public"
+      />
+
+  <browser:page
+      name="esi-body"
+      for=".interfaces.IESIRendered"
+      class=".esi.ESIBody"
+      permission="zope.Public"
+      />
+
+  <configure zcml:condition="installed plone.protect">
+    <adapter
+        factory=".esi.ESIProtectTransform"
+        provides="plone.transformchain.interfaces.ITransform"
+        for=".esi.ESIHead
+             *"
+        name="plone.protect.autocsrf"
+        zcml:condition="installed plone.transformchain"
+        />
+
+    <adapter
+        factory=".esi.ESIProtectTransform"
+        provides="plone.transformchain.interfaces.ITransform"
+        for=".esi.ESIBody
+             *"
+        name="plone.protect.autocsrf"
+        zcml:condition="installed plone.transformchain"
+        />
+
+    <adapter
+        factory=".tile.TileProtectTransform"
+        provides="plone.transformchain.interfaces.ITransform"
+        for=".tile.Tile
+             *"
+        name="plone.protect.autocsrf"
+        zcml:condition="installed plone.transformchain"
+        />
+  </configure>
+
+  <adapter
+      factory=".tile.TileThemingTransform"
+      provides="plone.transformchain.interfaces.ITransform"
+      for=".tile.Tile
+           *"
+      name="plone.tiles.tiletheming"
+      zcml:condition="installed plone.transformchain"
+      />
+
+  <!-- Field Type converters -->
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IBytesLine"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IASCIILine"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.ITextLine"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IURI"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IId"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IDottedName"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.NoConverter"
+      for="zope.schema.interfaces.IChoice"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.TextConverter"
+      for="zope.schema.interfaces.IBytes"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.TextConverter"
+      for="zope.schema.interfaces.IText"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.TextConverter"
+      for="zope.schema.interfaces.IASCII"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.LongConverter"
+      for="zope.schema.interfaces.IInt"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.FloatConverter"
+      for="zope.schema.interfaces.IFloat"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.BoolConverter"
+      for="zope.schema.interfaces.IBool"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.TupleConverter"
+      for="zope.schema.interfaces.ITuple"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.ListConverter"
+      for="zope.schema.interfaces.IList"
+      />
+
+  <adapter
+      factory="plone.tiles.fieldtypeconverters.DictConverter"
+      for="zope.schema.interfaces.IDict"
+      />
+
+</configure>