diff options
Diffstat (limited to '')
| -rw-r--r-- | contrib/webmentions-ssg.example.cfg | 4 | ||||
| -rw-r--r-- | tests/test_config.py | 21 | ||||
| -rw-r--r-- | tests/test_forms.py | 44 | ||||
| -rw-r--r-- | tests/views/test_admin.py | 309 | ||||
| -rw-r--r-- | webmentions_ssg/config.py | 3 | ||||
| -rw-r--r-- | webmentions_ssg/forms.py | 53 | ||||
| -rw-r--r-- | webmentions_ssg/templates/received.html | 69 | ||||
| -rw-r--r-- | webmentions_ssg/views/admin.py | 113 |
8 files changed, 560 insertions, 56 deletions
diff --git a/contrib/webmentions-ssg.example.cfg b/contrib/webmentions-ssg.example.cfg index 8dd347b..afc5621 100644 --- a/contrib/webmentions-ssg.example.cfg +++ b/contrib/webmentions-ssg.example.cfg @@ -115,6 +115,10 @@ VERIFICATION_RECOVERY_SCHEDULE = "*/5 * * * *" # recent update; verified, pending, and outgoing records are never purged. # Deleted status pages return 404; the same pair can be resubmitted afterward. RECEIVED_RETENTION_DAYS = 30 +# Maximum rows allowed per page in the received Webmentions admin list. +# Administrators can enter any page size from 1 through this limit. +# The initial page size is 25, or this maximum when it is below 25. +RECEIVED_MAX_PAGE_SIZE = 100 # Daily at 03:00 UTC (Huey's default timezone). RECEIVED_RETENTION_SCHEDULE = "0 3 * * *" diff --git a/tests/test_config.py b/tests/test_config.py index a4c5e9b..d075e7d 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -354,11 +354,18 @@ def test_resource_limits_have_safe_defaults() -> None: assert DefaultConfig.MAX_CONTENT_LENGTH == 64 * 1024 assert DefaultConfig.MAX_WEBMENTION_URL_BYTES == 8192 assert DefaultConfig.RECEIVED_RETENTION_DAYS == 30 + assert DefaultConfig.RECEIVED_MAX_PAGE_SIZE == 100 assert DefaultConfig.RECEIVED_RETENTION_SCHEDULE == "0 3 * * *" @pytest.mark.parametrize( - "key", ["MAX_CONTENT_LENGTH", "MAX_WEBMENTION_URL_BYTES", "RECEIVED_RETENTION_DAYS"] + "key", + [ + "MAX_CONTENT_LENGTH", + "MAX_WEBMENTION_URL_BYTES", + "RECEIVED_RETENTION_DAYS", + "RECEIVED_MAX_PAGE_SIZE", + ], ) @pytest.mark.parametrize("value", [None, "100", 0, -1, 1.5]) def test_invalid_resource_limits_fail_at_startup( @@ -372,6 +379,18 @@ def test_invalid_resource_limits_fail_at_startup( create_app(InvalidResourceLimit) +def test_received_max_page_size_can_be_set_in_cfg(tmp_path: Path) -> None: + config_file = tmp_path / "development.cfg" + config_file.write_text("RECEIVED_MAX_PAGE_SIZE = 250\n") + + class ConfiguredDevelopment(DevelopmentConfig): + CONFIG_FILE = str(config_file) + LOG_FILE = str(tmp_path / "development.log") + + app = create_app(ConfiguredDevelopment) + assert app.config["RECEIVED_MAX_PAGE_SIZE"] == 250 + + def test_proxy_fix_disabled_by_default(tmp_path: Path) -> None: class DirectConfig(TestingConfig): LOG_FILE = str(tmp_path / "direct.log") diff --git a/tests/test_forms.py b/tests/test_forms.py index 7f09da6..c6a8b25 100644 --- a/tests/test_forms.py +++ b/tests/test_forms.py @@ -12,8 +12,8 @@ from webmentions_ssg.forms import ( ConfirmActionForm, LoginForm, MaxURLBytes, - RejectNonPublicIPLiteral, ReceivedWebmentionFilterForm, + RejectNonPublicIPLiteral, WebmentionSubmissionForm, ) @@ -186,6 +186,48 @@ def test_received_filter_form_rejects_invalid_get_params( assert form.errors +def test_received_filter_form_validates_sort_and_page_size(app: Flask) -> None: + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm( + formdata=MultiDict({"sort": "updated", "order": "asc", "per_page": "37"}), + meta={"csrf": False}, + ) + assert form.validate() + assert form.sort.data == "updated" + assert form.order.data == "asc" + assert form.per_page.data == 37 + + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm(formdata=MultiDict(), meta={"csrf": False}) + assert form.validate() + assert (form.sort.data, form.order.data, form.per_page.data) == ( + "received", + "desc", + 25, + ) + + +@pytest.mark.parametrize( + "data", + [ + {"sort": "invalid"}, + {"order": "invalid"}, + {"per_page": "0"}, + {"per_page": "101"}, + {"per_page": "invalid"}, + ], +) +def test_received_filter_form_rejects_invalid_sort_and_page_size( + app: Flask, data: dict[str, str] +) -> None: + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm( + formdata=MultiDict(data), meta={"csrf": False} + ) + assert not form.validate() + assert form.errors + + def test_admin_action_form_accepts_submission(app: Flask) -> None: with app.test_request_context(method="POST"): form = ConfirmActionForm(meta={"csrf": False}) diff --git a/tests/views/test_admin.py b/tests/views/test_admin.py index 73265bd..e82d94d 100644 --- a/tests/views/test_admin.py +++ b/tests/views/test_admin.py @@ -144,7 +144,209 @@ def test_received_filters_by_display_status( ) -def test_received_get_filter_form_renders_wtforms_fields( +def test_received_filter_args_uses_typed_dict_fields( + app: Flask, views_module: ModuleType +) -> None: + with app.test_request_context( + "/received", + query_string={ + "status": "declined", + "q": " example.org ", + "date_from": "2026-11-08", + "date_to": "2026-11-14", + "sort": "updated", + "order": "asc", + "per_page": "37", + }, + ): + form = views_module.received_filter_form() + assert set(views_module.ReceivedFilterArgs.__annotations__) == set(form._fields) + assert views_module.received_filter_args(form) == { + "status": "declined", + "q": "example.org", + "date_from": "2026-11-08", + "date_to": "2026-11-14", + "sort": "updated", + "order": "asc", + "per_page": "37", + } + + +@pytest.mark.parametrize("max_page_size", [10, 100]) +def test_received_filter_args_omits_defaults_for_configured_page_size( + app: Flask, views_module: ModuleType, max_page_size: int +) -> None: + app.config["RECEIVED_MAX_PAGE_SIZE"] = max_page_size + with app.test_request_context("/received"): + form = views_module.received_filter_form() + assert form.per_page.data == min(25, max_page_size) + assert views_module.received_filter_args(form) == {} + + +@pytest.mark.parametrize( + ("sort", "order", "expected"), + [ + ("received", "desc", ("removed", "failed", "verified", "pending")), + ("received", "asc", ("pending", "verified", "failed", "removed")), + ("updated", "desc", ("verified", "failed", "pending", "removed")), + ("updated", "asc", ("removed", "pending", "failed", "verified")), + ("status", "asc", ("pending", "verified", "removed", "failed")), + ("status", "desc", ("removed", "failed", "verified", "pending")), + ], +) +def test_received_sorting( + app: Flask, client: FlaskClient, sort: str, order: str, expected: tuple[str, ...] +) -> None: + log_in(app, client) + for label, status, day in ( + ("pending", "received", 12), + ("verified", "verified", 14), + ("failed", "failed", 13), + ("removed", "source_removed", 11), + ): + create_received_webmention( + app, + source=f"https://{label}.example/post", + status=status, + updated_at=datetime(2026, 11, day, tzinfo=UTC), + ) + + response = client.get("/received", query_string={"sort": sort, "order": order}) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + indices = [html.index(f"https://{label}.example/post") for label in expected] + assert indices == sorted(indices) + assert f'aria-sort="{"ascending" if order == "asc" else "descending"}"' in html + + +@pytest.mark.parametrize("column", ["source", "target"]) +@pytest.mark.parametrize("order", ["asc", "desc"]) +def test_received_sorts_by_source_or_target( + app: Flask, client: FlaskClient, column: str, order: str +) -> None: + log_in(app, client) + # Deliberately create rows out of lexical order for both URL columns. + for source_name, target_name in ( + ("beta", "alpha"), + ("alpha", "gamma"), + ("gamma", "beta"), + ): + create_received_webmention( + app, + source=f"https://source.example/{source_name}", + target=f"https://target.example/{target_name}", + ) + + response = client.get("/received", query_string={"sort": column, "order": order}) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + rows = re.findall(r"<tr[^>]*>.*?</tr>", html, flags=re.DOTALL) + urls = re.findall(rf'<a href="(https://{column}\.example/[^"]+)">', "".join(rows)) + assert urls == sorted(urls, reverse=(order == "desc")) + assert len(urls) == 3 + assert f'aria-sort="{"ascending" if order == "asc" else "descending"}"' in html + + +def test_received_sort_links_preserve_filters_and_page_size( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + create_received_webmention(app, source="https://some.example/post", status="failed") + response = client.get( + "/received", + query_string={ + "status": "declined", + "q": "some.example", + "sort": "updated", + "order": "desc", + "per_page": "37", + }, + ) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + links = [ + parse_qs(urlsplit(unescape(link)).query) + for link in re.findall(r'href="([^"]+)"', html) + if urlsplit(unescape(link)).path == "/received" + ] + for sort, order in ( + ("received", "desc"), + ("updated", "asc"), + ("status", "asc"), + ("source", "asc"), + ("target", "asc"), + ): + assert { + "status": ["declined"], + "q": ["some.example"], + "sort": [sort], + "order": [order], + "per_page": ["37"], + } in links + assert 'name="sort"' in html + assert 'name="order"' in html + assert 'name="per_page"' in html + assert 'value="37"' in html + + +def test_received_page_size_is_free_form_and_controls_pagination( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + for index in range(52): + create_received_webmention(app, source=f"https://source.example/{index}") + + for page_size, expected_rows in ((25, 25), (37, 37), (50, 50), (100, 52)): + response = client.get("/received", query_string={"per_page": page_size}) + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + assert "52 total" in html + assert html.count('data-title="Reverify webmention?"') == expected_rows + assert ("page=2" in html) == (page_size < 52) + + response = client.get("/received", query_string={"per_page": 37, "page": 2}) + assert response.status_code == HTTPStatus.OK + assert ( + response.get_data(as_text=True).count('data-title="Reverify webmention?"') == 15 + ) + + +def test_received_default_page_size_is_capped_when_max_is_below_25( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + app.config["RECEIVED_MAX_PAGE_SIZE"] = 10 + for index in range(11): + create_received_webmention(app, source=f"https://source.example/{index}") + + response = client.get("/received") + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + assert html.count('data-title="Reverify webmention?"') == 10 + assert 'name="per_page"' in html + assert 'value="10"' in html + assert "page=2" in html + + +def test_received_page_size_respects_configured_maximum( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + app.config["RECEIVED_MAX_PAGE_SIZE"] = 50 + response = client.get("/received", query_string={"per_page": 50}) + assert response.status_code == HTTPStatus.OK + assert re.search( + r'<input\b(?=[^>]*name="per_page")(?=[^>]*max="50")', + response.get_data(as_text=True), + ) + assert client.get("/received?per_page=51").status_code == HTTPStatus.BAD_REQUEST + + +def test_received_get_filter_controls_render_serialized_values( app: Flask, client: FlaskClient ) -> None: log_in(app, client) @@ -155,21 +357,41 @@ def test_received_get_filter_form_renders_wtforms_fields( "q": "example.org", "date_from": "2026-11-08", "date_to": "2026-11-14", + "sort": "updated", + "order": "asc", + "per_page": "37", }, ) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) - for field in ("status", "q", "date_from", "date_to"): + for field in ("status", "q", "date_from", "date_to", "sort", "order", "per_page"): assert f'name="{field}"' in html assert 'type="search"' in html assert html.count('type="date"') == 2 assert 'value="example.org"' in html assert 'value="2026-11-08"' in html assert 'value="2026-11-14"' in html + assert 'name="sort" type="hidden" value="updated"' in html + assert 'name="order" type="hidden" value="asc"' in html + assert 'value="37"' in html assert re.search(r'<form[^>]*method="get"[^>]*role="search"', html) +def test_received_get_filter_controls_render_defaults( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + response = client.get("/received") + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + assert 'name="sort" type="hidden" value="received"' in html + assert 'name="order" type="hidden" value="desc"' in html + assert 'value="25"' in html + assert re.search(r'<option value="" selected>All statuses</option>', html) + + def test_received_filters_source_or_target_as_literal_substring( app: Flask, client: FlaskClient ) -> None: @@ -262,6 +484,13 @@ def test_received_filters_are_combined(app: Flask, client: FlaskClient) -> None: "date_from=2026-11-8", "date_to=2026-02-30", "date_from=2026-11-15&date_to=2026-11-08", + "sort=unknown", + "order=sideways", + "per_page=0", + "per_page=-1", + "per_page=101", + "per_page=abc", + "per_page=1.5", ], ) def test_received_rejects_invalid_filters( @@ -311,6 +540,56 @@ def test_received_pagination_and_actions_keep_filters( } +def test_received_pagination_and_actions_keep_sort_and_page_size( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + for index in range(38): + create_received_webmention(app, source=f"https://source.example/{index}") + + response = client.get( + "/received", query_string={"sort": "updated", "order": "asc", "per_page": 37} + ) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + expected = {"sort": ["updated"], "order": ["asc"], "per_page": ["37"]} + assert any( + urlsplit(unescape(link)).path == "/received" + and parse_qs(urlsplit(unescape(link)).query) == {**expected, "page": ["2"]} + for link in re.findall(r'href="([^"]+)"', html) + ) + for link in re.findall(r'data-action="([^"]+)"', html): + assert parse_qs(urlsplit(unescape(link)).query) == {**expected, "page": ["1"]} + + +@pytest.mark.parametrize("action", ["delete", "reverify"]) +def test_received_action_redirect_keeps_sort_and_page_size( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + action: str, +) -> None: + log_in(app, client) + identifier = create_received_webmention(app) + mock_admin_action_form(views_module, monkeypatch, valid=True) + monkeypatch.setattr(views_module, "verify_webmention", Mock()) + + response = client.post( + f"/received/{identifier}/{action}", + query_string={"page": 3, "sort": "updated", "order": "asc", "per_page": 37}, + ) + + assert response.status_code == HTTPStatus.FOUND + assert parse_qs(urlsplit(response.headers["Location"]).query) == { + "page": ["3"], + "sort": ["updated"], + "order": ["asc"], + "per_page": ["37"], + } + + @pytest.mark.parametrize("action", ["delete", "reverify"]) def test_received_action_redirect_keeps_filters( app: Flask, @@ -374,6 +653,32 @@ def test_received_action_rejects_invalid_filters_before_mutating( @pytest.mark.parametrize("action", ["delete", "reverify"]) +@pytest.mark.parametrize("invalid", ["sort=invalid", "order=invalid", "per_page=101"]) +def test_received_action_rejects_invalid_sort_and_page_size_before_mutating( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + action: str, + invalid: str, +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="received") + mock_admin_action_form(views_module, monkeypatch, valid=True) + verify = Mock() + monkeypatch.setattr(views_module, "verify_webmention", verify) + + response = client.post(f"/received/{identifier}/{action}?{invalid}") + + assert response.status_code == HTTPStatus.BAD_REQUEST + with app.app_context(): + row = db.session.get(ReceivedWebmention, identifier) + assert row is not None + assert row.status == "received" + verify.assert_not_called() + + +@pytest.mark.parametrize("action", ["delete", "reverify"]) def test_received_admin_actions_require_login(client: FlaskClient, action: str) -> None: response = client.post(f"/received/{uuid.uuid7()}/{action}") diff --git a/webmentions_ssg/config.py b/webmentions_ssg/config.py index 2110a62..1419b82 100644 --- a/webmentions_ssg/config.py +++ b/webmentions_ssg/config.py @@ -64,6 +64,8 @@ class DefaultConfig: VERIFICATION_RECOVERY_SCHEDULE = "*/5 * * * *" # Purge terminal failed/source-removed received Webmentions after 30 days. RECEIVED_RETENTION_DAYS = 30 + # Maximum rows that an admin can request per received Webmentions page. + RECEIVED_MAX_PAGE_SIZE = 100 RECEIVED_RETENTION_SCHEDULE = "0 3 * * *" # Scanner @@ -224,6 +226,7 @@ def validated_config_overrides( "MAX_CONTENT_LENGTH", "MAX_WEBMENTION_URL_BYTES", "RECEIVED_RETENTION_DAYS", + "RECEIVED_MAX_PAGE_SIZE", ): value = config[key] if type(value) is not int or value <= 0: diff --git a/webmentions_ssg/forms.py b/webmentions_ssg/forms.py index d97cc69..ae969b3 100644 --- a/webmentions_ssg/forms.py +++ b/webmentions_ssg/forms.py @@ -12,6 +12,8 @@ from flask_wtf import FlaskForm from wtforms import ( DateField, Field, + HiddenField, + IntegerField, PasswordField, SearchField, SelectField, @@ -20,11 +22,25 @@ from wtforms import ( ValidationError, ) from wtforms.form import BaseForm -from wtforms.validators import InputRequired, Optional, StopValidation +from wtforms.validators import ( + AnyOf, + InputRequired, + NumberRange, + Optional, + StopValidation, +) from .net import is_public_address, normalized_hostname from .validation import is_control_character +RECEIVED_STATUS_CHOICES = { + "": "All statuses", + "pending": "Pending", + "verifying": "Verifying", + "verified": "Verified", + "declined": "Declined", +} + class MaxURLBytes: """Check the UTF-8 byte length of a submitted URL using the current config.""" @@ -186,25 +202,38 @@ class CanonicalDate: raise ValidationError(field.gettext("Invalid date.")) +def default_received_page_size() -> int: + """Use 25 rows unless the configured maximum is lower.""" + return min(25, current_app.config["RECEIVED_MAX_PAGE_SIZE"]) + + class ReceivedWebmentionFilterForm(FlaskForm): """GET filters for the received Webmention list.""" - status = SelectField( - "Status", - choices={ - "": "All statuses", - "pending": "Pending", - "verifying": "Verifying", - "verified": "Verified", - "declined": "Declined", - }, - default="", - ) + status = SelectField("Status", choices=RECEIVED_STATUS_CHOICES, default="") q = SearchField("Source or target") date_from = DateField( "Updated from (UTC)", validators=[Optional(), CanonicalDate()] ) date_to = DateField("Updated to (UTC)", validators=[Optional(), CanonicalDate()]) + sort = HiddenField( + default="received", + validators=[AnyOf(("received", "updated", "status", "source", "target"))], + ) + order = HiddenField(default="desc", validators=[AnyOf(("asc", "desc"))]) + per_page = IntegerField( + "Rows per page", + default=default_received_page_size, + validators=[NumberRange(min=1)], + ) + + def validate_per_page(self, field: IntegerField) -> None: + """Enforce the deployment's maximum received-list page size.""" + if ( + field.data is not None + and field.data > current_app.config["RECEIVED_MAX_PAGE_SIZE"] + ): + raise ValidationError("Rows per page exceeds the configured maximum.") def validate_date_to(self, field: DateField) -> None: """Require the end date to be on or after the start date.""" diff --git a/webmentions_ssg/templates/received.html b/webmentions_ssg/templates/received.html index 9034ca8..8cd952c 100644 --- a/webmentions_ssg/templates/received.html +++ b/webmentions_ssg/templates/received.html @@ -34,6 +34,18 @@ SPDX-License-Identifier: BSD-3-Clause } } %} +{% macro sortable_header(label, column) %} + {% set active = sort_key == column %} + <th scope="col" + aria-sort="{{ ('ascending' if sort_order == 'asc' else 'descending') if active else 'none' }}"> + <a href="{{ sort_urls[column] }}" + class="link-body-emphasis text-decoration-none"> + {{ label }} + {% if active %}<span aria-hidden="true">{{ "↑" if sort_order == "asc" else "↓" }}</span>{% endif %} + </a> + </th> +{% endmacro %} + {% block content %} <div class="d-flex justify-content-between align-items-center mb-3"> <h1 class="mb-0">Received Webmentions</h1> @@ -43,21 +55,52 @@ SPDX-License-Identifier: BSD-3-Clause method="get" class="row g-2 align-items-end mb-4" role="search"> + <input id="sort" name="sort" type="hidden" value="{{ sort_key }}"> + <input id="order" name="order" type="hidden" value="{{ sort_order }}"> <div class="col-sm-6 col-lg"> - {{ filter_form.status.label(class="form-label") }} - {{ filter_form.status(class="form-select") }} + <label class="form-label" for="status">Status</label> + <select class="form-select" id="status" name="status"> + {% for value, label in status_choices.items() %} + <option value="{{ value }}" + {% if filters.get("status", "") == value %} selected{% endif %}>{{ label }}</option> + {% endfor %} + </select> </div> <div class="col-sm-6 col-lg"> - {{ filter_form.q.label(class="form-label") }} - {{ filter_form.q(class="form-control", placeholder="Search URLs") }} + <label class="form-label" for="q">Source or target</label> + <input class="form-control" + id="q" + name="q" + type="search" + value="{{ filters.get('q', '') }}" + placeholder="Search URLs"> </div> <div class="col-sm-6 col-lg"> - {{ filter_form.date_from.label(class="form-label") }} - {{ filter_form.date_from(class="form-control") }} + <label class="form-label" for="date_from">Updated from (UTC)</label> + <input class="form-control" + id="date_from" + name="date_from" + type="date" + value="{{ filters.get('date_from', '') }}"> </div> <div class="col-sm-6 col-lg"> - {{ filter_form.date_to.label(class="form-label") }} - {{ filter_form.date_to(class="form-control") }} + <label class="form-label" for="date_to">Updated to (UTC)</label> + <input class="form-control" + id="date_to" + name="date_to" + type="date" + value="{{ filters.get('date_to', '') }}"> + </div> + <div class="col-sm-6 col-lg-auto"> + <label class="form-label" for="per_page">Rows per page</label> + <input class="form-control" + id="per_page" + name="per_page" + type="number" + value="{{ page_size }}" + min="1" + max="{{ max_received_page_size }}" + step="1"> </div> <div class="col-auto d-flex gap-2 ms-auto"> <button type="submit" class="btn btn-primary">Filter</button> @@ -69,11 +112,11 @@ SPDX-License-Identifier: BSD-3-Clause <table class="table table-bordered table-striped table-hover align-middle"> <thead> <tr> - <th scope="col">Status</th> - <th scope="col">Source</th> - <th scope="col">Target</th> - <th scope="col">Received</th> - <th scope="col">Updated</th> + {{ sortable_header('Status', 'status') }} + {{ sortable_header('Source', 'source') }} + {{ sortable_header('Target', 'target') }} + {{ sortable_header('Received', 'received') }} + {{ sortable_header('Updated', 'updated') }} <th scope="col">Reason</th> <th scope="col">Actions</th> </tr> diff --git a/webmentions_ssg/views/admin.py b/webmentions_ssg/views/admin.py index 5246d3a..9bbc596 100644 --- a/webmentions_ssg/views/admin.py +++ b/webmentions_ssg/views/admin.py @@ -5,11 +5,12 @@ """Authenticated incoming and outgoing Webmention management.""" import uuid -from datetime import UTC, datetime, time +from datetime import UTC, date, datetime, time from http import HTTPStatus +from typing import TypedDict, cast import sqlalchemy as sa -from flask import abort, flash, redirect, render_template, request, url_for +from flask import abort, current_app, flash, redirect, render_template, request, url_for from flask.typing import ResponseReturnValue from flask_login import login_required from sqlalchemy.orm import selectinload @@ -38,6 +39,18 @@ RECEIVED_STATUS_FILTERS = { } +class ReceivedFilterArgs(TypedDict, total=False): + """Validated received-list query parameters; keys match GET form fields.""" + + status: str + q: str + date_from: str + date_to: str + sort: str + order: str + per_page: str + + def received_filter_form() -> forms.ReceivedWebmentionFilterForm: """Validate query-string filters without requiring CSRF on the GET form.""" form = forms.ReceivedWebmentionFilterForm( @@ -49,15 +62,20 @@ def received_filter_form() -> forms.ReceivedWebmentionFilterForm: return form -def received_filter_args(form: forms.ReceivedWebmentionFilterForm) -> dict[str, str]: - """Return validated, nonempty filters for pagination and redirects.""" - values = { - "status": form.status.data, - "q": form.q.data, - "date_from": form.date_from.data.isoformat() if form.date_from.data else "", - "date_to": form.date_to.data.isoformat() if form.date_to.data else "", - } - return {key: value for key, value in values.items() if value} +def received_filter_args( + form: forms.ReceivedWebmentionFilterForm, +) -> ReceivedFilterArgs: + """Serialize non-default form fields registered in ``ReceivedFilterArgs``.""" + values: dict[str, str] = {} + for name in ReceivedFilterArgs.__annotations__: + field = form[name] + value = field.data + default = field.default() if callable(field.default) else field.default + if value is None or value == "" or value == default: + continue + values[name] = value.isoformat() if isinstance(value, date) else str(value) + # TypedDict keys are dynamic because this function iterates its annotations. + return cast(ReceivedFilterArgs, values) @webmentions_bp.route("/received") @@ -72,12 +90,12 @@ def received_list() -> ResponseReturnValue: query = sa.select(ReceivedWebmention) - if status := filter_form.status.data: + if status := filters.get("status"): query = query.where( ReceivedWebmention.status.in_(RECEIVED_STATUS_FILTERS[status]) ) - if text := filter_form.q.data: + if text := filters.get("q"): query = query.where( sa.or_( ReceivedWebmention.source.icontains(text, autoescape=True), @@ -85,26 +103,73 @@ def received_list() -> ResponseReturnValue: ) ) - if (start := filter_form.date_from.data) is not None: + if start := filters.get("date_from"): query = query.where( - ReceivedWebmention.updated_at >= datetime.combine(start, time.min, UTC) + ReceivedWebmention.updated_at + >= datetime.combine(date.fromisoformat(start), time.min, UTC) ) - if (end := filter_form.date_to.data) is not None: + if end := filters.get("date_to"): query = query.where( - ReceivedWebmention.updated_at <= datetime.combine(end, time.max, UTC) + ReceivedWebmention.updated_at + <= datetime.combine(date.fromisoformat(end), time.max, UTC) ) + # Keep both declined lifecycle states together when sorting by status. + # UUID is a unique tie-breaker for stable pagination. + status_rank = sa.case( + (ReceivedWebmention.status == ReceivedWebmentionStatus.RECEIVED, 0), + (ReceivedWebmention.status == ReceivedWebmentionStatus.VERIFYING, 1), + (ReceivedWebmention.status == ReceivedWebmentionStatus.VERIFIED, 2), + else_=3, + ) + sort_columns = { + "received": ReceivedWebmention.uuid, + "updated": ReceivedWebmention.updated_at, + "status": status_rank, + "source": ReceivedWebmention.source, + "target": ReceivedWebmention.target, + } + + sort_key = filters.get("sort", "received") + sort_order = filters.get("order", "desc") + + column = sort_columns[sort_key] + ordering = column.asc() if sort_order == "asc" else column.desc() + + query = query.order_by(ordering) + + if sort_key != "received": + query = query.order_by(ReceivedWebmention.uuid.desc()) + + page_size = int(filters.get("per_page", forms.default_received_page_size())) webmentions = db.paginate( - query.order_by(ReceivedWebmention.uuid.desc()), per_page=25 + query, + per_page=page_size, + max_per_page=current_app.config["RECEIVED_MAX_PAGE_SIZE"], ) + sort_urls = {} + for key in sort_columns: + if key == sort_key: + next_order = "asc" if sort_order == "desc" else "desc" + else: + next_order = "asc" if key in ("status", "source", "target") else "desc" + + sort_filters: ReceivedFilterArgs = {**filters, "sort": key, "order": next_order} + sort_urls[key] = url_for("webmentions.received_list", **sort_filters) + return render_template( "received.html", title="Received Webmentions", webmentions=webmentions, filters=filters, - filter_form=filter_form, + sort_key=sort_key, + sort_order=sort_order, + status_choices=forms.RECEIVED_STATUS_CHOICES, + page_size=page_size, + sort_urls=sort_urls, + max_received_page_size=current_app.config["RECEIVED_MAX_PAGE_SIZE"], action_form=forms.ConfirmActionForm(), ) @@ -132,10 +197,7 @@ def delete_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValu url_for( "webmentions.received_list", page=request.args.get("page", 1, type=int), - status=filters.get("status"), - q=filters.get("q"), - date_from=filters.get("date_from"), - date_to=filters.get("date_to"), + **filters, ) ) @@ -168,10 +230,7 @@ def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnVa url_for( "webmentions.received_list", page=request.args.get("page", 1, type=int), - status=filters.get("status"), - q=filters.get("q"), - date_from=filters.get("date_from"), - date_to=filters.get("date_to"), + **filters, ) ) |
