RM statistics with purge method

Author: petschki

CHANGES.md

@@ -5,7 +5,8 @@ Changelog
 ## 3.6.8 (unreleased)
 
 
-- Nothing changed yet.
+- Related Media Statistics view including a purge method to cleanup unused media.
+  [petschki]
 
 
 ## 3.6.7 (2025-03-11)

collective/behavior/relatedmedia/browser.py

@@ -24,6 +24,9 @@
 from zope.intid.interfaces import IIntIds
 
 import json
+import logging
+
+logger = logging.getLogger(__name__)
 
 
 class RelatedBaseView(BrowserView):
@@ -276,3 +279,89 @@ def render(self):
         if not IViewView.providedBy(self.view):
             return ""
         return super().render()
+
+
+class StatisticsView(BrowserView):
+    def __call__(self):
+        self.stats = {}
+
+        if self.request.get("REQUEST_METHOD", "GET") == "POST" and self.request.get(
+            "form.submitted"
+        ):
+            media_root = get_media_root(self.context)
+            self.media_root_path = media_root.absolute_url_path()
+            items = self.context.portal_catalog.unrestrictedSearchResults(
+                path=self.media_root_path, portal_type=["Image", "File"]
+            )
+            _all = len(items)
+            filter_keyword = self.request.get("filter", "").lower()
+            unrelated = []
+            relation_stats = {}
+            purge = self.request.get("purge_unrelated", False)
+
+            for idx, it in enumerate(items, 1):
+                obj = it.getObject()
+                match = True
+
+                logger.info(f"Processing {idx}/{_all}: {obj.absolute_url()}")
+
+                if filter_keyword:
+                    match = (
+                        filter_keyword in obj.title_or_id().lower()
+                        or filter_keyword in obj.absolute_url()
+                    )
+
+                relations = api.relation.get(target=obj, unrestricted=True)
+
+                if not relations and match:
+
+                    if purge:
+                        media_root.manage_delObjects([obj.getId()])
+                        logger.warning(f"Purged unrelated media: {obj.absolute_url()}")
+                        continue
+
+                    unrelated.append(
+                        dict(
+                            source=dict(
+                                title=obj.title_or_id(), url=obj.absolute_url_path()
+                            ),
+                            target=dict(title=None, url=None),
+                        )
+                    )
+
+                for relation in relations:
+
+                    if relation.from_attribute not in relation_stats:
+                        relation_stats[relation.from_attribute] = []
+
+                    source_obj = relation.from_object
+
+                    if filter_keyword and not match:
+                        # check if source or target matches the filter keyword
+                        match = (
+                            filter_keyword in source_obj.title_or_id().lower()
+                            or filter_keyword in source_obj.absolute_url()
+                        )
+
+                    if match:
+                        relation_stats[relation.from_attribute].append(
+                            dict(
+                                source=dict(
+                                    title=obj.title_or_id(),
+                                    url=obj.absolute_url_path(),
+                                ),
+                                target=dict(
+                                    title=source_obj.title_or_id(),
+                                    url=source_obj.absolute_url_path(),
+                                ),
+                            )
+                        )
+
+            relation_stats["unrelated"] = unrelated
+
+            self.stats = {
+                "relations": relation_stats,
+                "total": _all,
+            }
+
+        return self.index()

collective/behavior/relatedmedia/configure.zcml

@@ -197,6 +197,15 @@
       name="related_images_filter"
       />
 
+    <browser:page
+    name="relatedmedia-statistics"
+    for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+    class=".browser.StatisticsView"
+    template="statistics.pt"
+    permission="cmf.ManagePortal"
+    layer=".interfaces.ICollectiveBehaviorRelatedmediaLayer"
+    />
+
   <include file="upgrades.zcml" />
 
 </configure>

collective/behavior/relatedmedia/statistics.pt

@@ -0,0 +1,68 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    xmlns:metal="http://xml.zope.org/namespaces/metal" xmlns:tal="http://xml.zope.org/namespaces/tal"
+    metal:use-macro="context/@@main_template/macros/master" lang="en" xml:lang="en"
+    i18n:domain="collective.behavior.relatedmedia">
+
+<body>
+    <metal:main fill-slot="main" tal:define="stats view/stats">
+        <h1>RelatedMedia Statistics</h1>
+
+        <form action="./@@relatedmedia-statistics" method="post">
+            <div class="mb-3">
+                <label>Filter keyword (Source/Target Title/Description)</label>
+                <input type="text" name="filter" class="form-control" value="${request/filter|string:}" />
+            </div>
+            <div>
+                <button class="btn btn-secondary" type="submit">Load Statistics</button>
+            </div>
+            <input type="hidden" name="form.submitted" value="1" />
+        </form>
+
+        <tal:if condition="stats">
+
+            <p>Total number of media in ${view/media_root_path}: ${stats/total}</p>
+
+            <div class="accordion" id="accordionStats">
+                <div class="accordion-item" tal:repeat="attr stats/relations">
+                    <h2 class="accordion-header">
+                        <button class="accordion-button" type="button" data-bs-toggle="collapse"
+                            data-bs-target="#collapse${attr}" aria-expanded="true" aria-controls="collapse${attr}">
+                            ${attr} (${python:len(stats['relations'][attr])})
+                        </button>
+                    </h2>
+                    <div id="collapse${attr}" class="accordion-collapse collapse" data-bs-parent="#accordionStats">
+                        <div class="accordion-body">
+                            <table class="w-100 table table-condensed">
+                                <thead>
+                                    <tr>
+                                        <th class="w-50">Source</th>
+                                        <th>Target</th>
+                                    </tr>
+                                </thead>
+                                <tbody>
+                                    <tr tal:repeat="rel python:stats['relations'][attr]">
+                                        <td>${rel/source/title}<br /><a href="${rel/source/url}" target="_blank">
+                                                <small>${rel/source/url}</small></a></td>
+                                        <td>${rel/target/title}<br /><a href="${rel/target/url}" target="_blank">
+                                                <small>${rel/target/url}</small></a></td>
+                                    </tr>
+                                </tbody>
+                            </table>
+                        </div>
+                    </div>
+                </div>
+            </div>
+
+            <div class="mt-4">
+                <form action="./@@relatedmedia-statistics" method="post">
+                    <input type="hidden" name="purge_unrelated" value="1" />
+                    <input type="hidden" name="form.submitted" value="1" />
+                    <button class="btn btn-danger" type="submit" onclick="javascript:return(confirm('Are you sure?'));">Purge unused/unrelated Media</button>
+                </form>
+            </div>
+        </tal:if>
+
+    </metal:main>
+</body>
+
+</html>