Merge branch 'feature/exclude-from-sitemap' into develop

Author: marteinn

CHANGELOG.md

@@ -3,15 +3,20 @@
 ## [Unreleased]
 ### Added
 - Add support for Wagtail 7.0 and 7.1 (@marteinn)
+- Make it possible to exclude pages in trash from sitemap using SkipSitemapIfInTrashMixin (@marteinn)
+- Exclude TrashCanPage from sitemap (@marteinn)
+- Add support for Django 5.2 (@marteinn)
 
 ### Changed
 ### Fixed
 - Bump postgres version to 15 in local dev environment (@marteinn)
 - Use python 3.13 when running linting/publish in CI (@marteinn)
+- Update usage examples (@marteinn)
 
 ### Removed
 - Drop support for Wagtail 5.2 (@marteinn)
 - Drop support for Wagtail 6.2 (@marteinn)
+- Drop support for Django 5.0 (@marteinn)
 
 ## [3.1.0] - 2025-02-01
 ### Added

README.md

@@ -33,14 +33,31 @@ From the trash can in Wagtail admin it's then possible to permanently delete the
 If the parent of the deleted page is either in the trash can or permanently deleted it's still possible to restore the pages by supplying an alternate parent.
 
 
-## Caveats
+## Usage
 
+### App order
 Since Wagtail Trash uses the hook `before_delete_page` it might interfere with your applications `before_delete_page` if you have defined one that returns a status code. Make sure wagtail trash is the last hook that runs otherwise or your custom `before_delete_page` might not run since Wagtail Trash doesn't call it.
 
+```python
+# Example
+INSTALLED_APPS = [
+    "wagtail.sites",
+    "wagtail",
+    "wagtail.contrib.forms",
+    "wagtail.contrib.redirects",
+    "wagtail_modeladmin",
+    "wagtail.contrib.routable_page",
+    "wagtail.contrib.settings",
+    "wagtail_trash",  # Import here
+    ...
+]
+```
+
+### Page manager
 Also, Wagtail Trash "deletes" pages by unpublishing them, so if you use a queryset that doesn't filter out unpublished pages, pages in trash can might show up. There is a manager that will fix this for you included, example:
 
 ```python
-from wagtail.core.models import Page, PageManager
+from wagtail.models import Page, PageManager
 from wagtail_trash.managers import TrashManager
 
 class SomePage(Page):
@@ -51,7 +68,19 @@ class SomePage(Page):
 SomePage.objects_excluding_trash.all()
 ```
 
-Permissions: If you remove a page under a restricted area, this page will be moved and therefore get new permissions. A user might go from not being allowed to see pages under e.g. "Secret Page", but when a page under this area is moved to trash can, the permissions from "Secret Page" are gone so now the user will see it in the trash can.
+### Exclude from sitemap
+Add SkipSitemapIfInTrashMixin if you want trashed pages to be excluded from sitemap.
+
+```python
+from wagtail.models import Page
+from wagtail_trash.mixins import SkipSitemapIfInTrashMixin
+
+class SomePage(SkipSitemapIfInTrashMixin, Page):
+    ...
+```
+
+### Permissions
+If you remove a page under a restricted area, this page will be moved and therefore get new permissions. A user might go from not being allowed to see pages under e.g. "Secret Page", but when a page under this area is moved to trash can, the permissions from "Secret Page" are gone so now the user will see it in the trash can.
 This is a solvable issue and will be fixed in a later version.
 
 

setup.py

@@ -44,8 +44,8 @@
         "Programming Language :: Python :: 3.13",
         "Framework :: Django",
         "Framework :: Django :: 4.2",
-        "Framework :: Django :: 5.0",
         "Framework :: Django :: 5.1",
+        "Framework :: Django :: 5.2",
         "Framework :: Wagtail",
         "Framework :: Wagtail :: 6",
         "Framework :: Wagtail :: 7",

tests/app/models.py

@@ -1,13 +1,14 @@
 from wagtail.models import Page, PageManager
 
 from wagtail_trash.managers import TrashManager
+from wagtail_trash.mixins import SkipSitemapIfInTrashMixin
 
 
-class TestPage(Page):
+class TestPage(SkipSitemapIfInTrashMixin, Page):
     objects = PageManager()
     objects_excluding_bins = TrashManager()
 
 
-class OtherPage(Page):
+class OtherPage(SkipSitemapIfInTrashMixin, Page):
     objects = PageManager()
     objects_excluding_bins = TrashManager()

tests/test_admin.py

@@ -3,6 +3,7 @@
 from wagtail.models import Page
 from wagtail.test.utils import WagtailTestUtils
 
+from tests.app.models import TestPage
 from wagtail_trash.models import TrashCan, TrashCanPage
 from wagtail_trash.views import trash_bulk_delete, trash_delete
 from wagtail_trash.wagtail_hooks import TrashCanModelAdmin
@@ -82,6 +83,22 @@ def test_removing_page_sends_it_to_trash_can(self):
         assert new_page.child_of(TrashCanPage.objects.first())
         assert TrashCan.objects.count() == 1
 
+    def test_trash_can_and_children_are_not_indexed_in_sitemap(self):
+        root_page = Page.objects.get(url_path="/")
+
+        new_page = TestPage(title="new page")
+        root_page.add_child(instance=new_page)
+
+        assert len(new_page.get_sitemap_urls()) != 0
+
+        with self.register_hook("before_delete_page", trash_delete):
+            delete_url = reverse("wagtailadmin_pages:delete", args=(new_page.id,))
+            self.client.post(delete_url)
+
+        trash_can_page = TrashCanPage.objects.first()
+        assert len(trash_can_page.get_sitemap_urls()) == 0
+        assert len(new_page.get_sitemap_urls()) == 0
+
     def test_bulk_delete_sets_and_unsets_slug(self):
         from wagtail_trash.wagtail_hooks import urlconf_time
 

wagtail_trash/mixins.py

@@ -0,0 +1,12 @@
+from wagtail_trash.models import TrashCan
+
+
+class SkipSitemapIfInTrashMixin:
+    def get_sitemap_urls(self, request=None):
+        if self.in_trash_can():
+            return []
+
+        return super().get_sitemap_urls(request=request)
+
+    def in_trash_can(self) -> bool:
+        return TrashCan.objects.filter(page=self).exists()

wagtail_trash/models.py

@@ -32,3 +32,6 @@ class Meta:
 class TrashCanPage(Page):
     parent_page_types = []
     subpage_types = []
+
+    def get_sitemap_urls(self, request=None):
+        return []