diff options
Diffstat (limited to '')
| -rw-r--r-- | tests/views/test_admin.py | 328 | ||||
| -rw-r--r-- | webmentions_ssg/static/js/received-bulk-actions.js | 68 | ||||
| -rw-r--r-- | webmentions_ssg/templates/received.html | 55 | ||||
| -rw-r--r-- | webmentions_ssg/views/admin.py | 113 |
4 files changed, 560 insertions, 4 deletions
diff --git a/tests/views/test_admin.py b/tests/views/test_admin.py index e82d94d..a475ad5 100644 --- a/tests/views/test_admin.py +++ b/tests/views/test_admin.py @@ -12,6 +12,7 @@ from unittest.mock import Mock from urllib.parse import parse_qs, urlsplit import pytest +from bs4 import BeautifulSoup from flask import Flask from flask.testing import FlaskClient @@ -389,7 +390,11 @@ def test_received_get_filter_controls_render_defaults( 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) + status_option = BeautifulSoup(html, "html.parser").select_one( + 'select[name="status"] option[value=""][selected]' + ) + assert status_option is not None + assert status_option.get_text(strip=True) == "All statuses" def test_received_filters_source_or_target_as_literal_substring( @@ -773,6 +778,327 @@ def test_reverify_received_webmention( verify_webmention.assert_called_once_with(identifier) +def test_received_bulk_toolbar_and_shared_confirmation_modal( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + first = create_received_webmention(app) + second = create_received_webmention(app, source="https://other.example/post") + + response = client.get("/received") + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + assert html.count('class="form-check-input received-select"') == 2 + assert f'value="{first}"' in html + assert f'value="{second}"' in html + assert 'id="received-select-all"' in html + assert 'id="received-selected-count"' in html + assert 'data-received-bulk-action="reverify"' in html + assert 'data-received-bulk-action="delete"' in html + assert 'data-title="Delete all declined webmentions?"' in html + assert html.count('id="confirmation-modal"') == 1 + assert 'id="confirmation-modal-form"' in html + assert 'received-bulk-actions.js' in html + + +def test_received_delete_all_declined_available_without_matching_rows( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + create_received_webmention(app, status="verified") + + response = client.get("/received", query_string={"status": "declined"}) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + assert 'data-title="Delete all declined webmentions?"' in html + assert 'id="confirmation-modal-form"' in html + assert 'data-received-bulk-action="delete"' not in html + assert 'id="received-select-all"' not in html + + +@pytest.mark.parametrize( + "path", + ["/received/bulk/reverify", "/received/bulk/delete", "/received/declined/delete"], +) +def test_received_bulk_actions_require_login(client: FlaskClient, path: str) -> None: + response = client.post(path) + + assert response.status_code == HTTPStatus.FOUND + assert "/login" in response.headers["Location"] + + +@pytest.mark.parametrize( + "path", + ["/received/bulk/reverify", "/received/bulk/delete", "/received/declined/delete"], +) +def test_received_bulk_actions_reject_invalid_form( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + path: str, +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="failed") + form = mock_admin_action_form(views_module, monkeypatch, valid=False) + + response = client.post(path, data={"webmention_uuids": str(identifier)}) + + assert response.status_code == HTTPStatus.BAD_REQUEST + form.validate_on_submit.assert_called_once_with() + with app.app_context(): + assert db.session.get(ReceivedWebmention, identifier).status == "failed" + + +@pytest.mark.parametrize( + "path", + ["/received/bulk/reverify", "/received/bulk/delete", "/received/declined/delete"], +) +def test_received_bulk_actions_reject_invalid_filters_before_mutating( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + path: str, +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="failed") + mock_admin_action_form(views_module, monkeypatch, valid=True) + verify = Mock() + monkeypatch.setattr(views_module, "verify_webmention", verify) + + response = client.post( + path, + query_string={"sort": "invalid"}, + data={"webmention_uuids": str(identifier)}, + ) + + assert response.status_code == HTTPStatus.BAD_REQUEST + with app.app_context(): + assert db.session.get(ReceivedWebmention, identifier).status == "failed" + verify.assert_not_called() + + +@pytest.mark.parametrize("action", ["reverify", "delete"]) +@pytest.mark.parametrize("selection", [[], ["bad-uuid"]]) +def test_received_bulk_actions_reject_empty_or_malformed_selection( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + action: str, + selection: list[str], +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="failed") + mock_admin_action_form(views_module, monkeypatch, valid=True) + verify = Mock() + monkeypatch.setattr(views_module, "verify_webmention", verify) + + response = client.post( + f"/received/bulk/{action}", data={"webmention_uuids": selection} + ) + + assert response.status_code == HTTPStatus.BAD_REQUEST + with app.app_context(): + assert db.session.get(ReceivedWebmention, identifier).status == "failed" + verify.assert_not_called() + + +@pytest.mark.parametrize("action", ["reverify", "delete"]) +def test_received_bulk_actions_reject_duplicate_oversized_or_stale_selection( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, + action: str, +) -> None: + log_in(app, client) + first = create_received_webmention(app, status="failed") + second = create_received_webmention(app, source="https://other.example/post") + mock_admin_action_form(views_module, monkeypatch, valid=True) + verify = Mock() + monkeypatch.setattr(views_module, "verify_webmention", verify) + path = f"/received/bulk/{action}" + + duplicate = client.post(path, data={"webmention_uuids": [str(first)] * 2}) + assert duplicate.status_code == HTTPStatus.BAD_REQUEST + + stale = client.post( + path, data={"webmention_uuids": [str(first), str(uuid.uuid7())]} + ) + assert stale.status_code == HTTPStatus.NOT_FOUND + + app.config["RECEIVED_MAX_PAGE_SIZE"] = 1 + oversized = client.post( + path, data={"webmention_uuids": [str(first), str(second)]} + ) + assert oversized.status_code == HTTPStatus.BAD_REQUEST + + with app.app_context(): + assert db.session.get(ReceivedWebmention, first).status == "failed" + assert db.session.get(ReceivedWebmention, second) is not None + verify.assert_not_called() + + +def test_delete_selected_received_webmentions( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, +) -> None: + log_in(app, client) + first = create_received_webmention(app, status="failed") + second = create_received_webmention(app, source="https://other.example/post") + unselected = create_received_webmention(app, source="https://third.example/post") + mock_admin_action_form(views_module, monkeypatch, valid=True) + + response = client.post( + "/received/bulk/delete", + query_string={"page": 3, "sort": "source", "order": "asc", "per_page": 37}, + data={"webmention_uuids": [str(first), str(second)]}, + ) + + assert response.status_code == HTTPStatus.FOUND + assert parse_qs(urlsplit(response.headers["Location"]).query) == { + "page": ["3"], + "sort": ["source"], + "order": ["asc"], + "per_page": ["37"], + } + with app.app_context(): + assert db.session.get(ReceivedWebmention, first) is None + assert db.session.get(ReceivedWebmention, second) is None + assert db.session.get(ReceivedWebmention, unselected) is not None + + +def test_reverify_selected_received_webmentions( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, +) -> None: + log_in(app, client) + first = create_received_webmention(app, status="failed", failure_reason="Failure") + second = create_received_webmention( + app, source="https://other.example/post", status="source_removed" + ) + unselected = create_received_webmention( + app, source="https://third.example/post", status="failed" + ) + mock_admin_action_form(views_module, monkeypatch, valid=True) + verify = Mock() + monkeypatch.setattr(views_module, "verify_webmention", verify) + + response = client.post( + "/received/bulk/reverify", + query_string={"status": "declined", "page": 2}, + data={"webmention_uuids": [str(first), str(second)]}, + ) + + assert response.status_code == HTTPStatus.FOUND + assert parse_qs(urlsplit(response.headers["Location"]).query) == { + "status": ["declined"], + "page": ["2"], + } + with app.app_context(): + for identifier in (first, second): + webmention = db.session.get(ReceivedWebmention, identifier) + assert webmention is not None + assert webmention.status == "received" + assert webmention.failure_reason is None + assert webmention.recovery_attempts == 0 + assert db.session.get(ReceivedWebmention, unselected).status == "failed" + assert verify.call_count == 2 + assert {call.args[0] for call in verify.call_args_list} == {first, second} + + +def test_delete_all_declined_received_webmentions_ignores_age_and_filters( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, +) -> None: + log_in(app, client) + failed = create_received_webmention(app, status="failed", updated_at=datetime.now(UTC)) + removed = create_received_webmention( + app, + source="https://other.example/post", + status="source_removed", + updated_at=datetime.now(UTC) - timedelta(days=60), + ) + retained = [ + create_received_webmention( + app, source=f"https://{status}.example/post", status=status + ) + for status in ("received", "verifying", "verified") + ] + mock_admin_action_form(views_module, monkeypatch, valid=True) + + response = client.post( + "/received/declined/delete", + query_string={"page": 4, "status": "verified", "q": "no-match"}, + ) + + assert response.status_code == HTTPStatus.FOUND + assert parse_qs(urlsplit(response.headers["Location"]).query) == { + "page": ["4"], + "status": ["verified"], + "q": ["no-match"], + } + with app.app_context(): + assert db.session.get(ReceivedWebmention, failed) is None + assert db.session.get(ReceivedWebmention, removed) is None + for identifier in retained: + assert db.session.get(ReceivedWebmention, identifier) is not None + + +def test_delete_all_declined_received_webmentions_when_none_exist( + app: Flask, + client: FlaskClient, + views_module: ModuleType, + monkeypatch: pytest.MonkeyPatch, +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="verified") + mock_admin_action_form(views_module, monkeypatch, valid=True) + + response = client.post("/received/declined/delete") + + assert response.status_code == HTTPStatus.FOUND + with app.app_context(): + assert db.session.get(ReceivedWebmention, identifier) is not None + + +def test_received_bulk_delete_requires_real_csrf_token( + app: Flask, client: FlaskClient +) -> None: + log_in(app, client) + identifier = create_received_webmention(app, status="failed") + app.config["WTF_CSRF_ENABLED"] = True + + invalid = client.post( + "/received/bulk/delete", data={"webmention_uuids": str(identifier)} + ) + assert invalid.status_code == HTTPStatus.BAD_REQUEST + + html = client.get("/received").get_data(as_text=True) + match = re.search( + r'<input\b(?=[^>]*name="csrf_token")(?=[^>]*value="([^"]+)")[^>]*>', + html, + ) + assert match is not None + valid = client.post( + "/received/bulk/delete", + data={"webmention_uuids": str(identifier), "csrf_token": match.group(1)}, + ) + assert valid.status_code == HTTPStatus.FOUND + with app.app_context(): + assert db.session.get(ReceivedWebmention, identifier) is None + + def test_rescan_sent_sources_requires_login(client: FlaskClient) -> None: response = client.post("/sources/rescan") diff --git a/webmentions_ssg/static/js/received-bulk-actions.js b/webmentions_ssg/static/js/received-bulk-actions.js new file mode 100644 index 0000000..c4ac31b --- /dev/null +++ b/webmentions_ssg/static/js/received-bulk-actions.js @@ -0,0 +1,68 @@ +// SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +// +// SPDX-License-Identifier: BSD-3-Clause + +document.addEventListener("DOMContentLoaded", () => { + const checkboxes = Array.from(document.querySelectorAll(".received-select")); + const selectAll = document.getElementById("received-select-all"); + const bulkButtons = document.querySelectorAll("[data-received-bulk-action]"); + const count = document.getElementById("received-selected-count"); + const modal = document.getElementById("confirmation-modal"); + + const selected = () => checkboxes.filter((checkbox) => checkbox.checked); + + const updateSelection = () => { + const selectedCount = selected().length; + if (count !== null) { + count.textContent = `${selectedCount} selected`; + } + bulkButtons.forEach((button) => { + button.disabled = selectedCount === 0; + }); + if (selectAll !== null) { + selectAll.checked = selectedCount === checkboxes.length; + selectAll.indeterminate = + selectedCount > 0 && selectedCount < checkboxes.length; + } + }; + + selectAll?.addEventListener("change", () => { + checkboxes.forEach((checkbox) => { + checkbox.checked = selectAll.checked; + }); + updateSelection(); + }); + checkboxes.forEach((checkbox) => { + checkbox.addEventListener("change", updateSelection); + }); + + modal?.addEventListener("show.bs.modal", (event) => { + const form = modal.querySelector("#confirmation-modal-form"); + // Never carry a previous bulk selection into an unrelated confirmation. + form.querySelectorAll('input[name="webmention_uuids"]').forEach((input) => { + input.remove(); + }); + + if (!event.relatedTarget?.dataset.receivedBulkAction) { + return; + } + + const selection = selected(); + const message = modal.querySelector("#confirmation-modal-message"); + if (event.relatedTarget.dataset.receivedBulkAction === "delete") { + message.textContent = `This permanently deletes ${selection.length} selected webmentions and cannot be undone.`; + } else { + message.textContent = `${selection.length} selected webmentions will be fetched and verified again.`; + } + + selection.forEach((checkbox) => { + const input = document.createElement("input"); + input.type = "hidden"; + input.name = "webmention_uuids"; + input.value = checkbox.value; + form.appendChild(input); + }); + }); + + updateSelection(); +}); diff --git a/webmentions_ssg/templates/received.html b/webmentions_ssg/templates/received.html index 8cd952c..de3a9b6 100644 --- a/webmentions_ssg/templates/received.html +++ b/webmentions_ssg/templates/received.html @@ -108,10 +108,56 @@ SPDX-License-Identifier: BSD-3-Clause class="btn btn-outline-secondary">Clear</a> </div> </form> + <div class="d-flex flex-wrap align-items-center gap-2 mb-3" + aria-label="Received Webmention actions"> + {% if webmentions.items %} + <span id="received-selected-count" + class="text-body-secondary" + role="status" + aria-live="polite">0 selected</span> + <button type="button" + class="btn btn-sm btn-outline-primary" + disabled + data-bs-toggle="modal" + data-bs-target="#confirmation-modal" + data-received-bulk-action="reverify" + data-action="{{ url_for('webmentions.reverify_selected_received_webmentions', page=webmentions.page, **filters) }}" + data-title="Reverify selected webmentions?" + data-message="All selected webmentions will be fetched and verified again." + data-confirm-label="Reverify selected" + data-confirm-class="btn-primary">Reverify selected</button> + <button type="button" + class="btn btn-sm btn-outline-danger" + disabled + data-bs-toggle="modal" + data-bs-target="#confirmation-modal" + data-received-bulk-action="delete" + data-action="{{ url_for('webmentions.delete_selected_received_webmentions', page=webmentions.page, **filters) }}" + data-title="Delete selected webmentions?" + data-message="This permanently deletes all selected webmentions and cannot be undone." + data-confirm-label="Delete selected" + data-confirm-class="btn-danger">Delete selected</button> + {% endif %} + <button type="button" + class="btn btn-sm btn-danger ms-auto" + data-bs-toggle="modal" + data-bs-target="#confirmation-modal" + data-action="{{ url_for('webmentions.delete_all_declined_received_webmentions', page=webmentions.page, **filters) }}" + data-title="Delete all declined webmentions?" + data-message="This permanently deletes all declined webmentions across every page, without waiting for automatic retention, regardless of the current filters. This cannot be undone." + data-confirm-label="Delete all declined" + data-confirm-class="btn-danger">Delete all declined</button> + </div> {% if webmentions.items %} <table class="table table-bordered table-striped table-hover align-middle"> <thead> <tr> + <th scope="col"> + <input type="checkbox" + class="form-check-input" + id="received-select-all" + aria-label="Select all Webmentions on this page"> + </th> {{ sortable_header('Status', 'status') }} {{ sortable_header('Source', 'source') }} {{ sortable_header('Target', 'target') }} @@ -125,6 +171,12 @@ SPDX-License-Identifier: BSD-3-Clause {% for webmention in webmentions %} {% set style = received_status_presentation.get(webmention.status, {"row_class": "table-danger", "badge_class": "text-bg-danger", "label": "Declined"}) %} <tr class="{{ style.row_class }}"> + <td> + <input type="checkbox" + class="form-check-input received-select" + value="{{ webmention.uuid }}" + aria-label="Select webmention {{ webmention.uuid }}"> + </td> <td><span class="badge {{ style.badge_class }}">{{ style.label }}</span></td> <td class="text-break"> <a href="{{ webmention.source }}">{{ webmention.source }}</a> @@ -170,7 +222,6 @@ SPDX-License-Identifier: BSD-3-Clause {% if webmentions.pages > 1 %} <div class="mt-3">{{ render_pagination(webmentions, args=filters) }}</div> {% endif %} - {% include "includes/confirmation_modal.html" %} {% else %} {% if filters %} <p class="text-body-secondary">No Webmentions match these filters.</p> @@ -178,9 +229,11 @@ SPDX-License-Identifier: BSD-3-Clause <p class="text-body-secondary">No Webmentions have been received yet.</p> {% endif %} {% endif %} + {% include "includes/confirmation_modal.html" %} {% endblock %} {% block scripts %} {{ super() }} <script src="{{ url_for('static', filename='js/confirmation-modal.js') }}"></script> + <script src="{{ url_for('static', filename='js/received-bulk-actions.js') }}"></script> {% endblock %} diff --git a/webmentions_ssg/views/admin.py b/webmentions_ssg/views/admin.py index 9bbc596..6754443 100644 --- a/webmentions_ssg/views/admin.py +++ b/webmentions_ssg/views/admin.py @@ -16,6 +16,7 @@ from flask_login import login_required from sqlalchemy.orm import selectinload from .. import forms +from ..db_helpers import rows_affected from ..extensions import db from ..models import ( ReceivedWebmention, @@ -85,8 +86,7 @@ def received_list() -> ResponseReturnValue: :returns: Rendered page containing the paginated received Webmentions. """ - filter_form = received_filter_form() - filters = received_filter_args(filter_form) + filters = received_filter_args(received_filter_form()) query = sa.select(ReceivedWebmention) @@ -235,6 +235,115 @@ def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnVa ) +def selected_received_webmentions() -> list[ReceivedWebmention]: + """Load a valid, nonempty selection of rows from the current list page. + + Reject malformed, duplicated, oversized, or stale selections rather than + silently performing only part of a requested bulk action. + """ + submitted = request.form.getlist("webmention_uuids") + if not submitted or len(submitted) > current_app.config["RECEIVED_MAX_PAGE_SIZE"]: + abort(HTTPStatus.BAD_REQUEST) + + try: + identifiers = {uuid.UUID(value) for value in submitted} + except ValueError, AttributeError, TypeError: + abort(HTTPStatus.BAD_REQUEST) + + if len(identifiers) != len(submitted): + abort(HTTPStatus.BAD_REQUEST) + + webmentions = list( + db.session.scalars( + sa.select(ReceivedWebmention).where( + ReceivedWebmention.uuid.in_(identifiers) + ) + ) + ) + if len(webmentions) != len(identifiers): + abort(HTTPStatus.NOT_FOUND) + + return webmentions + + +@webmentions_bp.post("/received/bulk/reverify") +@login_required +def reverify_selected_received_webmentions() -> ResponseReturnValue: + """Reopen and queue each selected received Webmention for verification.""" + if not forms.ConfirmActionForm().validate_on_submit(): + abort(HTTPStatus.BAD_REQUEST) + + filters = received_filter_args(received_filter_form()) + webmentions = selected_received_webmentions() + + identifiers = [webmention.uuid for webmention in webmentions] + for webmention in webmentions: + webmention.reopen_verification() + db.session.commit() + + for identifier in identifiers: + verify_webmention(identifier) + + flash(f"{len(webmentions)} Webmentions queued for reverification.", "success") + return redirect( + url_for( + "webmentions.received_list", + page=request.args.get("page", 1, type=int), + **filters, + ) + ) + + +@webmentions_bp.post("/received/bulk/delete") +@login_required +def delete_selected_received_webmentions() -> ResponseReturnValue: + """Permanently delete only the selected received Webmentions.""" + if not forms.ConfirmActionForm().validate_on_submit(): + abort(HTTPStatus.BAD_REQUEST) + + filters = received_filter_args(received_filter_form()) + webmentions = selected_received_webmentions() + + for webmention in webmentions: + db.session.delete(webmention) + db.session.commit() + + flash(f"{len(webmentions)} Webmentions deleted.", "success") + return redirect( + url_for( + "webmentions.received_list", + page=request.args.get("page", 1, type=int), + **filters, + ) + ) + + +@webmentions_bp.post("/received/declined/delete") +@login_required +def delete_all_declined_received_webmentions() -> ResponseReturnValue: + """Delete every declined received Webmention, regardless of age or filters.""" + if not forms.ConfirmActionForm().validate_on_submit(): + abort(HTTPStatus.BAD_REQUEST) + + filters = received_filter_args(received_filter_form()) + result = db.session.execute( + sa.delete(ReceivedWebmention).where( + ReceivedWebmention.status.in_(RECEIVED_STATUS_FILTERS["declined"]) + ) + ) + db.session.commit() + + count = rows_affected(result) + flash(f"{count} declined Webmentions deleted.", "success") + return redirect( + url_for( + "webmentions.received_list", + page=request.args.get("page", 1, type=int), + **filters, + ) + ) + + @webmentions_bp.route("/sources") @login_required def source_list() -> ResponseReturnValue: |
