eea.api.redirector 0.1__tar.gz → 0.2__tar.gz

{eea_api_redirector-0.1/eea.api.redirector.egg-info → eea_api_redirector-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eea.api.redirector
-Version: 0.1
+Version: 0.2
 Summary: Plone Redirector extension to get redirect URLs also from Redis
 Home-page: https://github.com/eea/eea.api.redirector
 Author: European Environment Agency: IDM2 A-Team
@@ -61,7 +61,8 @@ Main features
 9. **Proper HTTP status codes**: Returns 410 Gone for permanently deleted resources (empty redirect targets)
 10. **Redirect loop prevention**: Built-in protection against circular redirects
 11. **Easy configuration**: Simple environment variable setup for Redis connections
-12. **Non-intrusive**: Extends existing Plone functionality without replacing it
+12. **CSV import endpoint**: Upload CSV files directly to the backend for bulk imports
+13. **Non-intrusive**: Extends existing Plone functionality without replacing it
 
 
 Install
@@ -236,6 +237,27 @@ Response::
       "failed": []
     }
 
+**POST /@redirects-import**
+
+Import redirects from a CSV file upload.
+
+Request:
+
+* Multipart form-data with ``file`` field containing the CSV file
+
+Example::
+
+    curl -u admin:admin -F "file=@redirects.csv" http://localhost:8080/Plone/@redirects-import
+
+Response::
+
+    {
+      "type": "success",
+      "success_count": 10,
+      "failed_count": 0,
+      "failed": []
+    }
+
 
 Performance
 ===========
@@ -321,32 +343,37 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+0.2 - (2025-12-20)
+------------------------
+* Feature: CSV import endpoint (@redirects-import) for server-side processing
+  [avoinea - refs #293748]
+
 0.1 - (2025-11-28)
 -----------------------
 
 * Feature: Redis-backed URL redirects with high-performance lookups
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: REST API endpoints (@redirects, @redirects-statistics) for full CRUD operations
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Advanced search with regex support and search scope selector (old_url, new_url, both)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: HTTP 410 Gone support for permanently deleted content (empty redirect targets)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: High-performance statistics using Redis pipelining (~2s for 100k+ redirects)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Pagination support with configurable batch sizes (10, 25, 50, 100, 500, 1000)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Alphabetical sorting of redirects for consistent display
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Bulk import/export via REST API (CSV support in frontend)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Fallback mechanism to check Redis when redirects not found in Plone storage
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Graceful error handling - Redis failures don't break redirection system
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: API endpoint support with intelligent hierarchical URL matching
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Redirect loop prevention
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Easy configuration via environment variables (REDIS_SERVER, REDIS_PORT, REDIS_DB, REDIS_TIMEOUT)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]

{eea_api_redirector-0.1 → eea_api_redirector-0.2}/README.rst

@@ -27,7 +27,8 @@ Main features
 9. **Proper HTTP status codes**: Returns 410 Gone for permanently deleted resources (empty redirect targets)
 10. **Redirect loop prevention**: Built-in protection against circular redirects
 11. **Easy configuration**: Simple environment variable setup for Redis connections
-12. **Non-intrusive**: Extends existing Plone functionality without replacing it
+12. **CSV import endpoint**: Upload CSV files directly to the backend for bulk imports
+13. **Non-intrusive**: Extends existing Plone functionality without replacing it
 
 
 Install
@@ -202,6 +203,27 @@ Response::
       "failed": []
     }
 
+**POST /@redirects-import**
+
+Import redirects from a CSV file upload.
+
+Request:
+
+* Multipart form-data with ``file`` field containing the CSV file
+
+Example::
+
+    curl -u admin:admin -F "file=@redirects.csv" http://localhost:8080/Plone/@redirects-import
+
+Response::
+
+    {
+      "type": "success",
+      "success_count": 10,
+      "failed_count": 0,
+      "failed": []
+    }
+
 
 Performance
 ===========

{eea_api_redirector-0.1 → eea_api_redirector-0.2}/docs/HISTORY.txt

@@ -1,32 +1,37 @@
 Changelog
 =========
 
+0.2 - (2025-12-20)
+------------------------
+* Feature: CSV import endpoint (@redirects-import) for server-side processing
+  [avoinea - refs #293748]
+
 0.1 - (2025-11-28)
 -----------------------
 
 * Feature: Redis-backed URL redirects with high-performance lookups
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: REST API endpoints (@redirects, @redirects-statistics) for full CRUD operations
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Advanced search with regex support and search scope selector (old_url, new_url, both)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: HTTP 410 Gone support for permanently deleted content (empty redirect targets)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: High-performance statistics using Redis pipelining (~2s for 100k+ redirects)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Pagination support with configurable batch sizes (10, 25, 50, 100, 500, 1000)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Alphabetical sorting of redirects for consistent display
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Bulk import/export via REST API (CSV support in frontend)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Fallback mechanism to check Redis when redirects not found in Plone storage
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Graceful error handling - Redis failures don't break redirection system
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: API endpoint support with intelligent hierarchical URL matching
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Redirect loop prevention
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]
 * Feature: Easy configuration via environment variables (REDIS_SERVER, REDIS_PORT, REDIS_DB, REDIS_TIMEOUT)
-  [avoinea - refs $293748]
+  [avoinea - refs #293748]

eea_api_redirector-0.2/eea/api/redirector/restapi/add.py

@@ -0,0 +1,122 @@
+"""RestAPI endpoint @redirects POST"""
+
+from plone.restapi.deserializer import json_body
+from plone.restapi.services import Service
+from zExceptions import BadRequest
+from zope.component import getUtility
+from zope.interface import alsoProvides
+from zope.interface import implementer
+from zope.publisher.interfaces import IPublishTraverse
+from eea.api.redirector.interfaces import IStorageUtility
+import plone.protect.interfaces
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def add_redirects(storage, redirects):
+    """Validate and add redirects to storage."""
+    failed_redirects = []
+    success_count = 0
+
+    for redirect in redirects:
+        if not isinstance(redirect, dict):
+            failed_redirects.append(
+                {
+                    "redirect": str(redirect),
+                    "error": "Item must be a dictionary with 'path' and 'redirect-to' keys",
+                }
+            )
+            continue
+
+        path = redirect.get("path")
+        target = redirect.get("redirect-to")
+
+        if not path:
+            failed_redirects.append(
+                {"redirect": str(redirect), "error": "Missing 'path' field"}
+            )
+            continue
+
+        if target is None:
+            failed_redirects.append(
+                {"redirect": str(redirect), "error": "Missing 'redirect-to' field"}
+            )
+            continue
+
+        # Validate paths
+        if not path.startswith("/"):
+            failed_redirects.append(
+                {
+                    "redirect": str(redirect),
+                    "error": f"Path must start with '/': {path}",
+                }
+            )
+            continue
+
+        # Prevent self-redirects (but allow empty target for Gone)
+        if target and path == target:
+            failed_redirects.append(
+                {
+                    "redirect": str(redirect),
+                    "error": "Path and target cannot be the same",
+                }
+            )
+            continue
+
+        # Add to Redis
+        try:
+            result = storage.set(path, target)
+            if result:
+                success_count += 1
+                logger.info("Added redirect: %s -> %s", path, target)
+            else:
+                failed_redirects.append(
+                    {
+                        "path": path,
+                        "redirect-to": target,
+                        "error": "Failed to set value in Redis",
+                    }
+                )
+        except Exception as err:
+            logger.exception("Error adding redirect %s -> %s: %s", path, target, err)
+            failed_redirects.append(
+                {"path": path, "redirect-to": target, "error": str(err)}
+            )
+
+    return success_count, failed_redirects
+
+
+@implementer(IPublishTraverse)
+class RedisRedirectsPost(Service):
+    """Add redirects to Redis"""
+
+    def reply(self):
+        """Add one or more redirects to Redis storage"""
+        # Disable CSRF protection
+        if "IDisableCSRFProtection" in dir(plone.protect.interfaces):
+            alsoProvides(self.request, plone.protect.interfaces.IDisableCSRFProtection)
+
+        data = json_body(self.request)
+        storage = getUtility(IStorageUtility)
+        redirects = data.get("items", [])
+
+        if not redirects:
+            raise BadRequest(
+                "No items provided. Expected format: {'items': [{'path': '/old', 'redirect-to': '/new'}]}"
+            )
+
+        success_count, failed_redirects = add_redirects(storage, redirects)
+
+        # Return appropriate response
+        if failed_redirects:
+            self.request.response.setStatus(207)  # Multi-Status
+            return {
+                "type": "partial_success" if success_count > 0 else "error",
+                "success_count": success_count,
+                "failed_count": len(failed_redirects),
+                "failed": failed_redirects,
+            }
+
+        return self.reply_no_content()

{eea_api_redirector-0.1 → eea_api_redirector-0.2}/eea/api/redirector/restapi/configure.zcml

@@ -37,6 +37,15 @@
     permission="cmf.ManagePortal"
     />
 
+  <!-- POST endpoint to import Redis redirects from CSV -->
+  <plone:service
+    method="POST"
+    name="@redirects-import"
+    for="Products.CMFCore.interfaces.ISiteRoot"
+    factory=".import_csv.RedisRedirectsCSVImport"
+    permission="cmf.ManagePortal"
+    />
+
   <!-- GET endpoint for redirect statistics -->
   <plone:service
     method="GET"

eea_api_redirector-0.2/eea/api/redirector/restapi/import_csv.py

@@ -0,0 +1,89 @@
+"""RestAPI endpoint @redirects-import POST (CSV upload)."""
+
+import csv
+import io
+import plone.protect.interfaces
+from plone.restapi.services import Service
+from zExceptions import BadRequest
+from zope.component import getUtility
+from zope.interface import alsoProvides
+from zope.interface import implementer
+from zope.publisher.interfaces import IPublishTraverse
+
+from eea.api.redirector.interfaces import IStorageUtility
+from eea.api.redirector.restapi.add import add_redirects
+
+
+@implementer(IPublishTraverse)
+class RedisRedirectsCSVImport(Service):
+    """Import redirects from a CSV file upload."""
+
+    def _get_uploaded_file(self):
+        file_upload = self.request.form.get("file")
+        if not file_upload:
+            raise BadRequest(
+                "No file uploaded. Expected multipart/form-data with 'file' field."
+            )
+        return file_upload
+
+    def _parse_csv(self, file_upload):
+        data = file_upload.read()
+        if not data:
+            raise BadRequest("CSV file is empty")
+
+        try:
+            text = data.decode("utf-8-sig")
+        except Exception as err:
+            raise BadRequest(f"Failed to decode CSV file: {err}") from err
+
+        reader = csv.reader(io.StringIO(text))
+        redirects = []
+        failed_rows = []
+
+        for index, row in enumerate(reader):
+            if index == 0:
+                continue
+            if not row or all(not cell.strip() for cell in row):
+                continue
+
+            old_url = row[0].strip() if len(row) > 0 else ""
+            new_url = row[1].strip() if len(row) > 1 else ""
+
+            if not old_url:
+                failed_rows.append({"row": index + 1, "error": "Missing old URL"})
+                continue
+
+            redirects.append({"path": old_url, "redirect-to": new_url})
+
+        return redirects, failed_rows
+
+    def reply(self):
+        """Import redirects to Redis storage from CSV."""
+        if "IDisableCSRFProtection" in dir(plone.protect.interfaces):
+            alsoProvides(self.request, plone.protect.interfaces.IDisableCSRFProtection)
+
+        file_upload = self._get_uploaded_file()
+        redirects, failed_rows = self._parse_csv(file_upload)
+
+        if not redirects and not failed_rows:
+            raise BadRequest("No valid redirects found in CSV file")
+
+        storage = getUtility(IStorageUtility)
+        success_count, failed_redirects = add_redirects(storage, redirects)
+        failed = failed_rows + failed_redirects
+
+        if failed:
+            self.request.response.setStatus(207)  # Multi-Status
+            return {
+                "type": "partial_success" if success_count > 0 else "error",
+                "success_count": success_count,
+                "failed_count": len(failed),
+                "failed": failed,
+            }
+
+        return {
+            "type": "success",
+            "success_count": success_count,
+            "failed_count": 0,
+            "failed": [],
+        }

eea_api_redirector-0.2/eea/api/redirector/version.txt

@@ -0,0 +1 @@
+0.2