diff options
| author | Dennis Fink | 2026-11-17 17:09:59 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-17 17:09:59 +0100 |
| commit | 6d6d079a3a99d3d3a922a640b6925eb2adf044de (patch) | |
| tree | 33cc19241f4ce86ea43b2f194087c58e3fdc8a4d /webmentions_ssg/views/admin.py | |
| parent | 227092b57acc886469e16bcc4c0d3256e86d3d1e (diff) | |
| download | webmentions-ssg-6d6d079a3a99d3d3a922a640b6925eb2adf044de.tar.gz webmentions-ssg-6d6d079a3a99d3d3a922a640b6925eb2adf044de.zip | |
refactor(core)!: split forms and models by feature
Replace monolithic form and model modules with focused packages for
receiver, moderation, source, user, and shared validation concerns.
Rename source policy concepts to domain moderation, including routes,
models, tables, configuration, templates, and tests.
BREAKING CHANGE: form and model import paths, moderation routes, and
`SOURCE_ALLOWLIST_ENABLED` have changed; use `ALLOWLIST_ENABLED` and the
new feature-specific modules.
Diffstat (limited to '')
| -rw-r--r-- | webmentions_ssg/views/received.py (renamed from webmentions_ssg/views/admin.py) | 246 |
1 files changed, 26 insertions, 220 deletions
diff --git a/webmentions_ssg/views/admin.py b/webmentions_ssg/views/received.py index eb5a5e7..7d633ab 100644 --- a/webmentions_ssg/views/admin.py +++ b/webmentions_ssg/views/received.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Authenticated incoming and outgoing Webmention management.""" +"""Authenticated views for received Webmentions.""" import uuid from datetime import UTC, date, datetime, time @@ -13,25 +13,20 @@ import sqlalchemy as sa 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.exc import IntegrityError -from sqlalchemy.orm import selectinload -from .. import forms from ..db_helpers import rows_affected from ..extensions import db -from ..models import ( - AllowedSource, - BlockedSource, - ReceivedWebmention, - ReceivedWebmentionStatus, - SentWebmention, - SourceDocument, +from ..forms.admin import ConfirmActionForm +from ..forms.received import ( + RECEIVED_STATUS_CHOICES, + ReceivedWebmentionFilterForm, + default_received_page_size, ) -from ..source_policy import source_domain_from_url -from ..tasks.scanner import manual_scan_sources -from ..tasks.sender import send_webmention +from ..models.received import ReceivedWebmention, ReceivedWebmentionStatus +from ..moderation_policy import domain_from_url from ..tasks.verification import verify_webmention from .blueprint import webmentions_bp +from .moderation import block_domains RECEIVED_STATUS_FILTERS = { "pending": (ReceivedWebmentionStatus.RECEIVED,), @@ -42,7 +37,6 @@ RECEIVED_STATUS_FILTERS = { ReceivedWebmentionStatus.SOURCE_REMOVED, ), } -SOURCE_DOMAIN_MODELS = {"blocked": BlockedSource, "allowed": AllowedSource} class ReceivedFilterArgs(TypedDict, total=False): @@ -57,20 +51,16 @@ class ReceivedFilterArgs(TypedDict, total=False): per_page: str -def received_filter_form() -> forms.ReceivedWebmentionFilterForm: +def received_filter_form() -> ReceivedWebmentionFilterForm: """Validate query-string filters without requiring CSRF on the GET form.""" - form = forms.ReceivedWebmentionFilterForm( - formdata=request.args, meta={"csrf": False} - ) + form = ReceivedWebmentionFilterForm(formdata=request.args, meta={"csrf": False}) if not form.validate(): abort(HTTPStatus.BAD_REQUEST) form.q.data = (form.q.data or "").strip() return form -def received_filter_args( - form: forms.ReceivedWebmentionFilterForm, -) -> ReceivedFilterArgs: +def received_filter_args(form: ReceivedWebmentionFilterForm) -> ReceivedFilterArgs: """Serialize non-default form fields registered in ``ReceivedFilterArgs``.""" values: dict[str, str] = {} for name in ReceivedFilterArgs.__annotations__: @@ -147,7 +137,7 @@ def received_list() -> ResponseReturnValue: if sort_key != "received": query = query.order_by(ReceivedWebmention.uuid.desc()) - page_size = int(filters.get("per_page", forms.default_received_page_size())) + page_size = int(filters.get("per_page", default_received_page_size())) webmentions = db.paginate( query, per_page=page_size, @@ -171,11 +161,11 @@ def received_list() -> ResponseReturnValue: filters=filters, sort_key=sort_key, sort_order=sort_order, - status_choices=forms.RECEIVED_STATUS_CHOICES, + status_choices=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(), + action_form=ConfirmActionForm(), ) @@ -187,7 +177,7 @@ def delete_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValu :param webmention_uuid: UUID of the Webmention to delete. :returns: Redirect response to the received Webmentions view. """ - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) @@ -217,7 +207,7 @@ def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnVa :param webmention_uuid: UUID of the Webmention to reverify. :returns: Redirect response to the received Webmentions view. """ - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) @@ -275,7 +265,7 @@ def selected_received_webmentions() -> list[ReceivedWebmention]: @login_required def reverify_selected_received_webmentions() -> ResponseReturnValue: """Reopen and queue each selected received Webmention for verification.""" - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) @@ -303,7 +293,7 @@ def reverify_selected_received_webmentions() -> ResponseReturnValue: @login_required def delete_selected_received_webmentions() -> ResponseReturnValue: """Permanently delete only the selected received Webmentions.""" - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) @@ -327,7 +317,7 @@ def delete_selected_received_webmentions() -> ResponseReturnValue: @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(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) @@ -349,46 +339,21 @@ def delete_all_declined_received_webmentions() -> ResponseReturnValue: ) -def block_source_domains(domains: set[str]) -> int: - """Persist distinct source domains, tolerating concurrent blocklist inserts. - - Savepoints isolate unique-constraint races so one preexisting entry cannot - prevent other selected domains from being blocked. - """ - existing = set( - db.session.scalars( - sa.select(BlockedSource.domain).where(BlockedSource.domain.in_(domains)) - ) - ) - added = 0 - for domain in sorted(domains - existing): - try: - with db.session.begin_nested(): - db.session.add(BlockedSource(domain=domain)) - db.session.flush() - except IntegrityError: - # A concurrent admin action has already blocked this hostname. - continue - added += 1 - db.session.commit() - return added - - @webmentions_bp.post("/received/bulk/block-sources") @login_required def block_selected_received_sources() -> ResponseReturnValue: """Block the unique source domains of selected received Webmentions.""" - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) webmentions = selected_received_webmentions() - domains = {source_domain_from_url(webmention.source) for webmention in webmentions} + domains = {domain_from_url(webmention.source) for webmention in webmentions} if None in domains: # Fail the entire selection instead of silently skipping a source. abort(HTTPStatus.BAD_REQUEST) - added = block_source_domains(cast(set[str], domains)) + added = block_domains(cast(set[str], domains)) flash( f"{added} source domains newly blocked from {len(webmentions)} selected Webmentions.", "success", @@ -406,15 +371,15 @@ def block_selected_received_sources() -> ResponseReturnValue: @login_required def block_received_source(webmention_uuid: uuid.UUID) -> ResponseReturnValue: """Add a received Webmention's source hostname to the blocklist.""" - if not forms.ConfirmActionForm().validate_on_submit(): + if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) filters = received_filter_args(received_filter_form()) webmention = db.get_or_404(ReceivedWebmention, webmention_uuid) - if (domain := source_domain_from_url(webmention.source)) is None: + if (domain := domain_from_url(webmention.source)) is None: abort(HTTPStatus.BAD_REQUEST) - block_source_domains({domain}) + block_domains({domain}) flash(f"Source domain {domain} blocked.", "success") return redirect( @@ -424,162 +389,3 @@ def block_received_source(webmention_uuid: uuid.UUID) -> ResponseReturnValue: **filters, ) ) - - -@webmentions_bp.get("/source-domains") -@login_required -def source_domain_list() -> ResponseReturnValue: - """Manage blocklist and allowlist entries used by the receiver.""" - return render_template( - "source_domains.html", - title="Source domain rules", - blocked=db.session.scalars( - sa.select(BlockedSource).order_by(BlockedSource.domain) - ).all(), - allowed=db.session.scalars( - sa.select(AllowedSource).order_by(AllowedSource.domain) - ).all(), - allowlist_enabled=current_app.config["SOURCE_ALLOWLIST_ENABLED"], - ) - - -@webmentions_bp.post("/source-domains/<kind>/add") -@login_required -def source_domain_add(kind: str) -> ResponseReturnValue: - """Validate and add one normalized hostname to the selected list.""" - if (model := SOURCE_DOMAIN_MODELS.get(kind)) is None: - abort(HTTPStatus.NOT_FOUND) - - form = forms.SourceDomainForm() - if not form.validate_on_submit(): - abort(HTTPStatus.BAD_REQUEST) - - domain = cast(str, form.domain.data) - if db.session.scalar(sa.select(model.id).where(model.domain == domain)) is None: - db.session.add(model(domain=domain)) - try: - db.session.commit() - except IntegrityError: - db.session.rollback() - - flash(f"Source domain {domain} added to {kind} list.", "success") - return redirect(url_for("webmentions.source_domain_list")) - - -@webmentions_bp.post("/source-domains/<kind>/<int:entry_id>/delete") -@login_required -def source_domain_delete(kind: str, entry_id: int) -> ResponseReturnValue: - """Remove one entry; a blocked domain becomes eligible for new submissions.""" - if (model := SOURCE_DOMAIN_MODELS.get(kind)) is None: - abort(HTTPStatus.NOT_FOUND) - - if not forms.ConfirmActionForm().validate_on_submit(): - abort(HTTPStatus.BAD_REQUEST) - - entry = db.get_or_404(model, entry_id) - domain = entry.domain - db.session.delete(entry) - db.session.commit() - flash(f"Source domain {domain} removed from {kind} list.", "success") - return redirect(url_for("webmentions.source_domain_list")) - - -@webmentions_bp.route("/sources") -@login_required -def source_list() -> ResponseReturnValue: - """Display sources with sent Webmentions. - - :returns: Rendered page containing the paginated source list. - """ - sources = db.paginate( - sa.select(SourceDocument) - .options(selectinload(SourceDocument.sent_webmentions)) - .order_by(SourceDocument.last_seen_at.desc()), - per_page=25, - ) - return render_template( - "sent.html", - title="Sent Webmentions", - sources=sources, - action_form=forms.ConfirmActionForm(), - ) - - -@webmentions_bp.post("/sources/rescan") -@login_required -def rescan_sources() -> ResponseReturnValue: - """Queue a manual scan of sent Webmention sources. - - :returns: Redirect response to the sent Webmentions view. - """ - if not forms.ConfirmActionForm().validate_on_submit(): - abort(HTTPStatus.BAD_REQUEST) - - manual_scan_sources() - flash("Source rescan queued.", "success") - - return redirect(url_for("webmentions.source_list")) - - -@webmentions_bp.route("/sources/<uuid:source_uuid>") -@login_required -def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: - """Display the sent Webmentions associated with a source. - - :param source_uuid: UUID of the source to display. - :returns: Rendered source details page. - """ - source = db.get_or_404(SourceDocument, source_uuid) - - webmentions = db.paginate( - sa.select(SentWebmention) - .where(SentWebmention.source_uuid == source.uuid) - .order_by(SentWebmention.target, SentWebmention.uuid), - per_page=25, - ) - - return render_template( - "sent_source.html", - title="Sent Webmentions", - source=source, - webmentions=webmentions, - action_form=forms.ConfirmActionForm(), - ) - - -@webmentions_bp.post("/sources/<uuid:source_uuid>/<uuid:webmention_uuid>/resend") -@login_required -def resend_webmention( - source_uuid: uuid.UUID, webmention_uuid: uuid.UUID -) -> ResponseReturnValue: - """Queue an outgoing Webmention to be sent again. - - The current desired source revision is reopened for processing so the - sender task does not treat the Webmention as already completed. Historical - successful-send fields are preserved, while result fields from the previous - attempt are cleared. - - :param source_uuid: UUID of the source owning the Webmention. - :param webmention_uuid: UUID of the sent Webmention to resend. - :returns: Redirect response to the source details view. - """ - if not forms.ConfirmActionForm().validate_on_submit(): - abort(HTTPStatus.BAD_REQUEST) - - webmention = db.get_or_404(SentWebmention, webmention_uuid) - - if webmention.source_uuid != source_uuid: - abort(HTTPStatus.NOT_FOUND) - - # Requeue the existing desired revision instead of inventing a new source - # revision. send_webmention() otherwise exits when this revision has already - # been processed. - webmention.clear_result_for_resend() - - db.session.commit() - - send_webmention(webmention_uuid) - - flash(f"Webmention {webmention.uuid} queued for resend.", "success") - - return redirect(url_for("webmentions.source_detail", source_uuid=source_uuid)) |
