Merge branch 'main' into fix_seeaarch_sort_order

Author: mamico

.github/workflows/test-matrix.yml

@@ -48,7 +48,7 @@ jobs:
 #  """
 ##
     - name: Pip cache
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ matrix.config[0] }}-${{ hashFiles('setup.*', 'tox.ini') }}

.gitignore

@@ -47,6 +47,7 @@ local.cfg
 /sources/
 /venv/
 .installed.txt
+/.mxdev_cache/
 
 /docs/styles/Microsoft/
 

docs/source/endpoints/aliases.md

@@ -15,7 +15,6 @@ When an object is moved (renamed or cut/pasted into a different location), the r
 
 The API consumer can create, read, and delete aliases.
 
-
 | Verb     | URL         | Action                                 |
 | -------- | ----------- | -------------------------------------- |
 | `POST`   | `/@aliases` | Add one or more aliases                |
@@ -135,7 +134,20 @@ Response:
 
 ## Filter aliases
 
-To search for specific aliases, send a `GET` request to the `/@aliases` endpoint on site `root` with a `q` parameter:
+### Parameters
+
+All of the following parameters are optional.
+
+| Name      | Type    | Description                                            |
+| --------- | ------- | ------------------------------------------------------ |
+| `query`   | string  | Full-text search. Can match paths or text fields.      |
+| `manual`  | boolean | Filter by manual or automatically created redirects.   |
+| `start`   | string  | Filter redirects created **after** this date.          |
+| `end`     | string  | Filter redirects created **before** this date.         |
+| `b_start` | integer | Batch start index (offset).                            |
+| `b_size`  | integer | Batch size (maximum items returned).                   |
+
+To search for specific aliases, send a `GET` request to the `@aliases` endpoint with one or more of the above named parameters as shown in the following example.
 
 ```{eval-rst}
 ..  http:example:: curl httpie python-requests

news/+0b828c61.tests.md

@@ -0,0 +1 @@
+Fix tests to expect an extra registry record.  @mauritsvanrees

news/1791.feature

@@ -0,0 +1 @@
+`@aliases` service: Add support for filtering aliases for a non-root item. @jnptk

src/plone/restapi/services/aliases/add.py

@@ -42,7 +42,15 @@ def reply(self):
 
         failed_aliases = []
         for alias in aliases:
+            date = None
             if isinstance(alias, dict):
+                date = alias.get("datetime")
+                if date:
+                    try:
+                        date = DateTime(date)
+                    except DateTimeError:
+                        logger.warning("Failed to parse as DateTime: %s", date)
+
                 alias = alias.get("path")
 
             if alias.startswith("/"):
@@ -61,6 +69,7 @@ def reply(self):
             storage.add(
                 alias,
                 "/".join(self.context.getPhysicalPath()),
+                now=date,
                 manual=True,
             )
 

src/plone/restapi/services/aliases/delete.py

@@ -1,7 +1,7 @@
 from plone.app.redirector.interfaces import IRedirectionStorage
 from plone.restapi.deserializer import json_body
 from plone.restapi.services import Service
-from plone.restapi.services.aliases.get import deroot_path
+from plone.restapi.utils import deroot_path
 from Products.CMFPlone.controlpanel.browser.redirects import absolutize_path
 from zope.component import getUtility
 from zope.interface import alsoProvides

src/plone/restapi/services/aliases/get.py

@@ -1,12 +1,20 @@
+from BTrees.OOBTree import OOBTree
+from DateTime import DateTime
+from DateTime.interfaces import DateTimeError
 from plone.app.redirector.interfaces import IRedirectionStorage
+from plone.restapi.batching import HypermediaBatch
 from plone.restapi.bbb import IPloneSiteRoot
 from plone.restapi.interfaces import IExpandableElement
 from plone.restapi.serializer.converters import datetimelike_to_iso
 from plone.restapi.services import Service
+from plone.restapi.utils import deroot_path
+from plone.restapi.utils import is_falsy
+from plone.restapi.utils import is_truthy
 from Products.CMFPlone.controlpanel.browser.redirects import RedirectsControlPanel
+from zExceptions import BadRequest
+from zExceptions import HTTPNotAcceptable as NotAcceptable
 from zope.component import adapter
 from zope.component import getUtility
-from zope.component.hooks import getSite
 from zope.interface import implementer
 from zope.interface import Interface
 
@@ -22,40 +30,60 @@ def __init__(self, context, request):
         self.context = context
         self.request = request
 
-    def reply_item(self):
+    def reply(self, query, manual, start, end):
         storage = getUtility(IRedirectionStorage)
+        portal_path = "/".join(self.context.getPhysicalPath()[:2])
         context_path = "/".join(self.context.getPhysicalPath())
-        redirects = storage.redirects(context_path)
-        aliases = [deroot_path(alias) for alias in redirects]
-        self.request.response.setStatus(200)
-        self.request.response.setHeader("Content-Type", "application/json")
-        return [{"path": alias} for alias in aliases], len(aliases)
-
-    def reply_root(self):
-        """
-        redirect-to - target
-        path        - path
-        redirect    - full path with root
-        """
-        batch = RedirectsControlPanel(self.context, self.request).redirects()
-        redirects = [entry for entry in batch]
-
-        for redirect in redirects:
-            del redirect["redirect"]
-            redirect["datetime"] = datetimelike_to_iso(redirect["datetime"])
-        self.request.response.setStatus(200)
 
-        self.request.form["b_start"] = "0"
-        self.request.form["b_size"] = "1000000"
-        self.request.__annotations__.pop("plone.memoize")
+        if not IPloneSiteRoot.providedBy(self.context):
+            tree = OOBTree()
+            rds = storage.redirects(context_path)
+            for rd in rds:
+                rd_full = storage.get_full(rd)
+                tree[rd] = rd_full
+            storage = tree
+        else:
+            storage = storage._paths
+
+        if query and query.startswith("/"):
+            min_k = f"{portal_path}/{query.strip('/')}"
+            max_k = min_k[:-1] + chr(ord(min_k[-1]) + 1)
+            redirects = storage.items(min=min_k, max=max_k, excludemax=True)
+        elif query:
+            redirects = [path for path in storage.items() if query in path]
+        else:
+            redirects = storage.items()
+
+        aliases = []
+        for path, info in redirects:
+            if manual != "":
+                if info[2] != manual:
+                    continue
+            if start and info[1]:
+                if info[1] < start:
+                    continue
+            if end and info[1]:
+                if info[1] >= end:
+                    continue
+
+            redirect = {
+                "path": deroot_path(path),
+                "redirect-to": deroot_path(info[0]),
+                "datetime": datetimelike_to_iso(info[1]),
+                "manual": info[2],
+            }
+            aliases.append(redirect)
+
+        batch = HypermediaBatch(self.request, aliases)
 
-        newbatch = RedirectsControlPanel(self.context, self.request).redirects()
-        items_total = len([item for item in newbatch])
+        self.request.response.setStatus(200)
         self.request.response.setHeader("Content-Type", "application/json")
-
-        return redirects, items_total
+        return [i for i in batch], batch.items_total, batch.links
 
     def reply_root_csv(self):
+        if not IPloneSiteRoot.providedBy(self.context):
+            raise NotAcceptable("CSV reply is only available from site root.")
+
         batch = RedirectsControlPanel(self.context, self.request).redirects()
         redirects = [entry for entry in batch]
 
@@ -80,19 +108,50 @@ def reply_root_csv(self):
         return content
 
     def __call__(self, expand=False):
+        data = self.request.form
+
+        query = data.get("query", data.get("q", None))
+        manual = data.get("manual", "")
+        start = data.get("start", None)
+        end = data.get("end", None)
+
+        if query and not isinstance(query, str):
+            raise BadRequest('Parameter "query" must be a string.')
+
+        if manual:
+            if is_truthy(manual):
+                manual = True
+            elif is_falsy(manual):
+                manual = False
+            else:
+                raise BadRequest('Parameter "manual" must be a boolean.')
+
+        if start:
+            try:
+                start = DateTime(start)
+            except DateTimeError as e:
+                raise BadRequest(str(e))
+
+        if end:
+            try:
+                end = DateTime(end)
+            except DateTimeError as e:
+                raise BadRequest(str(e))
+
         result = {"aliases": {"@id": f"{self.context.absolute_url()}/@aliases"}}
         if not expand:
             return result
-        if IPloneSiteRoot.providedBy(self.context):
-            if self.request.getHeader("Accept") == "text/csv":
-                result["aliases"]["items"] = self.reply_root_csv()
-                return result
-            else:
-                items, items_total = self.reply_root()
+        if self.request.getHeader("Accept") == "text/csv":
+            result["aliases"]["items"] = self.reply_root_csv()
+            return result
         else:
-            items, items_total = self.reply_item()
+            items, items_total, batching = self.reply(query, manual, start, end)
+
         result["aliases"]["items"] = items
         result["aliases"]["items_total"] = items_total
+        if batching:
+            result["aliases"]["links"] = batching
+
         return result
 
 
@@ -115,12 +174,3 @@ def render(self):
             return json.dumps(
                 content, indent=2, sort_keys=True, separators=(", ", ": ")
             )
-
-
-def deroot_path(path):
-    """Remove the portal root from alias"""
-    portal = getSite()
-    root_path = "/".join(portal.getPhysicalPath())
-    if not path.startswith("/"):
-        path = "/%s" % path
-    return path.replace(root_path, "", 1)

src/plone/restapi/tests/http-examples/aliases_get.resp

@@ -5,7 +5,10 @@ Content-Type: application/json
     "@id": "http://localhost:55001/plone/front-page/@aliases",
     "items": [
         {
-            "path": "/simple-alias"
+            "datetime": "2022-05-05T00:00:00",
+            "manual": true,
+            "path": "/simple-alias",
+            "redirect-to": "/front-page"
         }
     ],
     "items_total": 1

src/plone/restapi/tests/http-examples/aliases_non_root_filter.req

@@ -0,0 +1,3 @@
+GET /plone/front-page/@aliases?query=/fizzbuzz HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0