diff options
| author | Dennis Fink | 2026-11-18 21:13:34 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-18 21:13:34 +0100 |
| commit | b2b5429bcf008db357d9d65db77ba37f7af908a8 (patch) | |
| tree | ed913ee050817609b56d2f5515b2c3fbc9945a75 /webmentions_ssg | |
| parent | beb0131b089293512c2dab2243b9b2ff314e2387 (diff) | |
| download | webmentions-ssg-b2b5429bcf008db357d9d65db77ba37f7af908a8.tar.gz webmentions-ssg-b2b5429bcf008db357d9d65db77ba37f7af908a8.zip | |
feat(sender): add source list filters and sorting
Add status, search, date, sorting, and page-size controls to the source
list with validated query parameters and stable pagination.
Preserve list context across source details, rescans, resends, and
pagination, and surface failed and retrying delivery counts with retry
deadlines.
Diffstat (limited to '')
| -rw-r--r-- | webmentions_ssg/config.py | 3 | ||||
| -rw-r--r-- | webmentions_ssg/forms/sources.py | 81 | ||||
| -rw-r--r-- | webmentions_ssg/templates/sent.html | 103 | ||||
| -rw-r--r-- | webmentions_ssg/templates/sent_source.html | 23 | ||||
| -rw-r--r-- | webmentions_ssg/views/sources.py | 166 |
5 files changed, 342 insertions, 34 deletions
diff --git a/webmentions_ssg/config.py b/webmentions_ssg/config.py index be54989..3d05e5d 100644 --- a/webmentions_ssg/config.py +++ b/webmentions_ssg/config.py @@ -91,6 +91,8 @@ class DefaultConfig: RECEIVED_RETENTION_DAYS = 30 # Maximum rows that an admin can request per received Webmentions page. RECEIVED_MAX_PAGE_SIZE = 100 + # Maximum rows that an admin can request per source document page. + SOURCES_MAX_PAGE_SIZE = 100 RECEIVED_RETENTION_SCHEDULE = "0 3 * * *" # Scanner @@ -246,6 +248,7 @@ def validated_config_overrides( "MAX_WEBMENTION_URL_BYTES", "RECEIVED_RETENTION_DAYS", "RECEIVED_MAX_PAGE_SIZE", + "SOURCES_MAX_PAGE_SIZE", ): value = config[key] if type(value) is not int or value <= 0: diff --git a/webmentions_ssg/forms/sources.py b/webmentions_ssg/forms/sources.py new file mode 100644 index 0000000..04afe77 --- /dev/null +++ b/webmentions_ssg/forms/sources.py @@ -0,0 +1,81 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +"""Source document filtering form.""" + +from flask import current_app +from flask_wtf import FlaskForm +from wtforms import ( + DateField, + HiddenField, + IntegerField, + SearchField, + SelectField, + ValidationError, +) +from wtforms.validators import AnyOf, NumberRange, Optional + +from .validators import CanonicalDate + +SOURCE_STATUS_CHOICES = { + "": "All sources", + "failing": "Failing sends", + "retrying": "Awaiting retry", + "deleted": "Deleted sources", +} + + +def default_source_page_size() -> int: + """Use 25 rows unless the configured maximum is lower.""" + return min(25, current_app.config["SOURCES_MAX_PAGE_SIZE"]) + + +class SourceFilterForm(FlaskForm): + """GET filters for the source document list.""" + + status = SelectField("Status", choices=SOURCE_STATUS_CHOICES, default="") + q = SearchField("Path or URL") + date_from = DateField( + "Last seen from (UTC)", validators=[Optional(), CanonicalDate()] + ) + date_to = DateField("Last seen to (UTC)", validators=[Optional(), CanonicalDate()]) + sort = HiddenField( + default="last_seen", + validators=[ + AnyOf( + ( + "path", + "url", + "webmentions", + "revision", + "created", + "last_seen", + "status", + ) + ) + ], + ) + order = HiddenField(default="desc", validators=[AnyOf(("asc", "desc"))]) + per_page = IntegerField( + "Rows per page", + default=default_source_page_size, + validators=[NumberRange(min=1)], + ) + + def validate_per_page(self, field: IntegerField) -> None: + """Enforce the deployment's maximum source-list page size.""" + if ( + field.data is not None + and field.data > current_app.config["SOURCES_MAX_PAGE_SIZE"] + ): + raise ValidationError("Rows per page exceeds the configured maximum.") + + def validate_date_to(self, field: DateField) -> None: + """Require an end date on or after the start date.""" + if ( + self.date_from.data is not None + and field.data is not None + and field.data < self.date_from.data + ): + raise ValidationError("End date must be on or after start date.") diff --git a/webmentions_ssg/templates/sent.html b/webmentions_ssg/templates/sent.html index d2a319d..6febdb9 100644 --- a/webmentions_ssg/templates/sent.html +++ b/webmentions_ssg/templates/sent.html @@ -7,6 +7,19 @@ SPDX-License-Identifier: BSD-3-Clause {% from "bootstrap5/pagination.html" import render_pagination %} +{% macro sortable_header(label, column, responsive_class="") %} + {% set active = sort_key == column %} + <th scope="col" + class="{{ responsive_class }}" + 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">Sources</h1> @@ -16,29 +29,72 @@ SPDX-License-Identifier: BSD-3-Clause class="btn btn-sm btn-primary" data-bs-toggle="modal" data-bs-target="#confirmation-modal" - data-action="{{ url_for('webmentions.rescan_sources') }}" + data-action="{{ url_for('webmentions.rescan_sources', page=sources.page, **filters) }}" data-title="Rescan sources?" data-message="All sources will be scanned again for changes and webmentions." data-confirm-label="Rescan" data-confirm-class="btn-primary">Rescan</button> </div> </div> + <form action="{{ url_for('webmentions.source_list') }}" + method="get" + class="row g-2 align-items-end mb-4" + role="search"> + {{ form.sort }} + {{ form.order }} + <div class="col-sm-6 col-lg"> + {{ form.status.label(class_="form-label") }} + {{ form.status(class_="form-select") }} + </div> + <div class="col-sm-6 col-lg"> + {{ form.q.label(class_="form-label") }} + {{ form.q(class_="form-control", placeholder="Search paths and URLs") }} + </div> + <div class="col-sm-6 col-lg"> + {{ form.date_from.label(class_="form-label") }} + {{ form.date_from(class_="form-control") }} + </div> + <div class="col-sm-6 col-lg"> + {{ form.date_to.label(class_="form-label") }} + {{ form.date_to(class_="form-control") }} + </div> + <div class="col-sm-6 col-lg-auto"> + {{ form.per_page.label(class_="form-label") }} + {{ form.per_page(class_="form-control", min=1, max=max_source_page_size, step=1) }} + </div> + <div class="col-auto d-flex gap-2 ms-auto"> + <button type="submit" class="btn btn-primary">Filter</button> + <a href="{{ url_for('webmentions.source_list') }}" + class="btn btn-outline-secondary">Clear</a> + </div> + </form> {% if sources.items %} <div class="table-responsive"> <table class="table table-bordered table-striped table-hover align-middle"> <thead> <tr> - <th scope="col">Path</th> - <th scope="col" class="d-none d-md-table-cell">URL</th> - <th scope="col">Webmentions</th> - <th scope="col" class="d-none d-md-table-cell">Revision</th> - <th scope="col" class="d-none d-md-table-cell">Created</th> - <th scope="col" class="d-none d-md-table-cell">Last seen</th> - <th scope="col">Status</th> + {{ sortable_header('Status', 'status') }} + {{ sortable_header('Path', 'path') }} + {{ sortable_header('URL', 'url', 'd-none d-md-table-cell') }} + {{ sortable_header('Webmentions', 'webmentions') }} + {{ sortable_header('Revision', 'revision', 'd-none d-md-table-cell') }} + {{ sortable_header('Created', 'created', 'd-none d-md-table-cell') }} + {{ sortable_header('Last seen', 'last_seen', 'd-none d-md-table-cell') }} </tr> </thead> <tbody> {% for source in sources %} + {% set statistics = namespace(sent=0, failed=0, retrying=0) %} + {% for webmention in source.sent_webmentions %} + {% if webmention.status == "sent" %} + {% set statistics.sent = statistics.sent + 1 %} + {% elif webmention.status == "failed" %} + {% set statistics.failed = statistics.failed + 1 %} + {% endif %} + {% if webmention.awaiting_processing and webmention.attempt_count > 0 and webmention.next_retry_at is not none %} + {% set statistics.retrying = statistics.retrying + 1 %} + {% endif %} + {% endfor %} {% if source.deleted_at is none %} {% set row_class = "table-success" %} {% set badge_class = "text-bg-success" %} @@ -49,13 +105,27 @@ SPDX-License-Identifier: BSD-3-Clause {% set status_text = "Deleted" %} {% endif %} <tr class="{{ row_class }}"> + <td> + <span class="badge {{ badge_class }}">{{ status_text }}</span> + </td> <td class="text-break"> - <a href="{{ url_for('webmentions.source_detail', source_uuid=source.uuid) }}">{{ source.path }}</a> + <a href="{{ url_for('webmentions.source_detail', source_uuid=source.uuid, source_page=sources.page, **filters) }}">{{ source.path }}</a> </td> <td class="text-break d-none d-md-table-cell"> <a href="{{ source.url }}">{{ source.url }}</a> </td> - <td>{{ source.sent_webmentions | length }}</td> + <td> + <span class="badge text-bg-info">{{ source.sent_webmentions | length }} Total</span> + {% if statistics.sent %} + <span class="badge text-bg-success">{{ statistics.sent }} sent</span> + {% endif %} + {% if statistics.failed %} + <span class="badge text-bg-danger">{{ statistics.failed }} failed</span> + {% endif %} + {% if statistics.retrying %} + <span class="badge text-bg-warning">{{ statistics.retrying }} awaiting retry</span> + {% endif %} + </td> <td class="d-none d-md-table-cell">{{ source.revision }}</td> <td class="text-nowrap d-none d-md-table-cell"> <time datetime="{{ source.created_at | utc_isoformat }}" @@ -69,21 +139,22 @@ SPDX-License-Identifier: BSD-3-Clause {{ source.last_seen_at | relative_time }} </time> </td> - <td> - <span class="badge {{ badge_class }}">{{ status_text }}</span> - </td> </tr> {% endfor %} </tbody> </table> </div> {% if sources.pages > 1 %} - <div class="mt-3">{{ render_pagination(sources) }}</div> + <div class="mt-3">{{ render_pagination(sources, args=filters) }}</div> {% endif %} - {% include "includes/confirmation_modal.html" %} {% else %} - <p class="text-body-secondary">No Webmention sources have been discovered yet.</p> + {% if filters %} + <p class="text-body-secondary">No sources match these filters.</p> + {% else %} + <p class="text-body-secondary">No Webmention sources have been discovered yet.</p> + {% endif %} {% endif %} + {% include "includes/confirmation_modal.html" %} {% endblock %} {% block scripts %} diff --git a/webmentions_ssg/templates/sent_source.html b/webmentions_ssg/templates/sent_source.html index 33e26a2..04f9d07 100644 --- a/webmentions_ssg/templates/sent_source.html +++ b/webmentions_ssg/templates/sent_source.html @@ -26,7 +26,7 @@ SPDX-License-Identifier: BSD-3-Clause {% block content %} <div class="mb-3"> - <a href="{{ url_for('webmentions.source_list') }}">← Back to sources</a> + <a href="{{ url_for('webmentions.source_list', page=source_page, **filters) }}">← Back to sources</a> </div> <div class="d-flex justify-content-between align-items-start mb-3"> <h1 class="mb-0">Source Details</h1> @@ -96,8 +96,8 @@ SPDX-License-Identifier: BSD-3-Clause <table class="table table-bordered table-striped table-hover align-middle"> <thead> <tr> - <th scope="col">Target</th> <th scope="col">Status</th> + <th scope="col">Target</th> <th scope="col" class="d-none d-md-table-cell">Active</th> <th scope="col" class="d-none d-md-table-cell">Revisions</th> <th scope="col" class="d-none d-md-table-cell">Delivery</th> @@ -110,13 +110,22 @@ SPDX-License-Identifier: BSD-3-Clause {% set style = sent_status_presentation.get(webmention.status, {"row_class": "table-info", "badge_class": "text-bg-info", "label": "Pending" }) %} <tr class="{{ style.row_class }}"> <td class="text-break"> - <a href="{{ webmention.target }}">{{ webmention.target }}</a> - </td> - <td class="text-break"> <span class="badge {{ style.badge_class }}">{{ style.label }}</span> {% if webmention.failure_reason is not none %} <div class="small mt-2">{{ webmention.failure_reason }}</div> {% endif %} + {% if webmention.awaiting_processing and webmention.attempt_count > 0 and webmention.next_retry_at is not none %} + <div class="small mt-2"> + Retry scheduled after attempt {{ webmention.attempt_count }}: + <time datetime="{{ webmention.next_retry_at | utc_isoformat }}" + title="{{ webmention.next_retry_at | utc_timestamp }}"> + {{ webmention.next_retry_at | relative_time }} + </time> + </div> + {% endif %} + </td> + <td class="text-break"> + <a href="{{ webmention.target }}">{{ webmention.target }}</a> </td> <td class="d-none d-md-table-cell"> {% if webmention.linked %} @@ -199,7 +208,7 @@ SPDX-License-Identifier: BSD-3-Clause class="btn btn-sm btn-primary" data-bs-toggle="modal" data-bs-target="#confirmation-modal" - data-action="{{ url_for('webmentions.resend_webmention', source_uuid=source.uuid, webmention_uuid=webmention.uuid) }}" + data-action="{{ url_for('webmentions.resend_webmention', source_uuid=source.uuid, webmention_uuid=webmention.uuid, source_page=source_page, page=webmentions.page, **filters) }}" data-title="Resend Webmention?" data-message="This Webmention will be queued again for delivery to {{ webmention.target }}." data-confirm-label="Resend" @@ -211,7 +220,7 @@ SPDX-License-Identifier: BSD-3-Clause </table> </div> {% if webmentions.pages > 1 %} - <div class="mt-3">{{ render_pagination(webmentions) }}</div> + <div class="mt-3">{{ render_pagination(webmentions, args=dict(filters, source_page=source_page)) }}</div> {% endif %} {% include "includes/confirmation_modal.html" %} {% else %} diff --git a/webmentions_ssg/views/sources.py b/webmentions_ssg/views/sources.py index b68d2fd..1c9cc58 100644 --- a/webmentions_ssg/views/sources.py +++ b/webmentions_ssg/views/sources.py @@ -5,39 +5,166 @@ """Authenticated source document and sent Webmention views.""" import uuid +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, 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 from ..extensions import db from ..forms.admin import ConfirmActionForm -from ..models.sources import SentWebmention, SourceDocument +from ..forms.sources import ( + SOURCE_STATUS_CHOICES, + SourceFilterForm, + default_source_page_size, +) +from ..models.sources import SentWebmention, SentWebmentionStatus, SourceDocument from ..tasks.scanner import manual_scan_sources from ..tasks.sender import send_webmention from .blueprint import webmentions_bp +class SourceFilterArgs(TypedDict, total=False): + """Validated source-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 source_filter_form() -> SourceFilterForm: + """Validate GET filters without requiring CSRF on the search form.""" + form = SourceFilterForm(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 source_filter_args(form: SourceFilterForm) -> SourceFilterArgs: + """Serialize non-default values for pagination, sorting, and navigation.""" + values: dict[str, str] = {} + for name in SourceFilterArgs.__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) + return cast(SourceFilterArgs, values) + + @webmentions_bp.route("/sources") @login_required def source_list() -> ResponseReturnValue: - """Display sources with sent Webmentions. + """Display source documents with filters for outgoing delivery problems.""" + form = source_filter_form() + filters = source_filter_args(form) + query = sa.select(SourceDocument).options( + selectinload(SourceDocument.sent_webmentions) + ) - :returns: Rendered page containing the paginated source list. - """ + # EXISTS avoids duplicate source rows when several Webmentions match. + sent = sa.select(SentWebmention.uuid).where( + SentWebmention.source_uuid == SourceDocument.uuid + ) + if status := filters.get("status"): + if status == "failing": + query = query.where( + sent.where( + SentWebmention.status == SentWebmentionStatus.FAILED + ).exists() + ) + elif status == "retrying": + query = query.where( + sent.where( + SentWebmention.awaiting_processing, + SentWebmention.attempt_count > 0, + SentWebmention.next_retry_at.is_not(None), + ).exists() + ) + else: # deleted + query = query.where(SourceDocument.deleted_at.is_not(None)) + + if text := filters.get("q"): + query = query.where( + sa.or_( + SourceDocument.path.icontains(text, autoescape=True), + SourceDocument.url.icontains(text, autoescape=True), + sent.where( + SentWebmention.target.icontains(text, autoescape=True) + ).exists(), + ) + ) + + if start := filters.get("date_from"): + query = query.where( + SourceDocument.last_seen_at + >= datetime.combine(date.fromisoformat(start), time.min, UTC) + ) + if end := filters.get("date_to"): + query = query.where( + SourceDocument.last_seen_at + <= datetime.combine(date.fromisoformat(end), time.max, UTC) + ) + + count = ( + sa.select(sa.func.count(SentWebmention.uuid)) + .where(SentWebmention.source_uuid == SourceDocument.uuid) + .scalar_subquery() + ) + sort_columns = { + "path": SourceDocument.path, + "url": SourceDocument.url, + "webmentions": count, + "revision": SourceDocument.revision, + "created": SourceDocument.uuid, + "last_seen": SourceDocument.last_seen_at, + "status": sa.case((SourceDocument.deleted_at.is_(None), 0), else_=1), + } + sort_key = filters.get("sort", "last_seen") + sort_order = filters.get("order", "desc") + column = sort_columns[sort_key] + query = query.order_by(column.asc() if sort_order == "asc" else column.desc()) + if sort_key != "created": + query = query.order_by(SourceDocument.uuid.desc()) + + page_size = int(filters.get("per_page", default_source_page_size())) sources = db.paginate( - sa.select(SourceDocument) - .options(selectinload(SourceDocument.sent_webmentions)) - .order_by(SourceDocument.last_seen_at.desc()), - per_page=25, + query, + per_page=page_size, + max_per_page=current_app.config["SOURCES_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 ("path", "url", "status") else "desc" + sort_filters: SourceFilterArgs = {**filters, "sort": key, "order": next_order} + sort_urls[key] = url_for("webmentions.source_list", **sort_filters) + return render_template( "sent.html", title="Sent Webmentions", sources=sources, + form=form, + filters=filters, + sort_key=sort_key, + sort_order=sort_order, + sort_urls=sort_urls, + status_choices=SOURCE_STATUS_CHOICES, + page_size=page_size, + max_source_page_size=current_app.config["SOURCES_MAX_PAGE_SIZE"], action_form=ConfirmActionForm(), ) @@ -52,10 +179,15 @@ def rescan_sources() -> ResponseReturnValue: if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) + filters = source_filter_args(source_filter_form()) manual_scan_sources() flash("Source rescan queued.", "success") - return redirect(url_for("webmentions.source_list")) + query_args: dict[str, str | int] = dict(filters) + page = request.args.get("page", 1, type=int) + if page > 1: + query_args["page"] = page + return redirect(url_for("webmentions.source_list", **query_args)) @webmentions_bp.route("/sources/<uuid:source_uuid>") @@ -66,6 +198,8 @@ def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: :param source_uuid: UUID of the source to display. :returns: Rendered source details page. """ + filters = source_filter_args(source_filter_form()) + source_page = request.args.get("source_page", 1, type=int) source = db.get_or_404(SourceDocument, source_uuid) webmentions = db.paginate( @@ -80,6 +214,8 @@ def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: title="Sent Webmentions", source=source, webmentions=webmentions, + filters=filters, + source_page=source_page, action_form=ConfirmActionForm(), ) @@ -103,6 +239,7 @@ def resend_webmention( if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) + filters = source_filter_args(source_filter_form()) webmention = db.get_or_404(SentWebmention, webmention_uuid) if webmention.source_uuid != source_uuid: @@ -119,4 +256,11 @@ def resend_webmention( flash(f"Webmention {webmention.uuid} queued for resend.", "success") - return redirect(url_for("webmentions.source_detail", source_uuid=source_uuid)) + detail_args: dict[str, str | int] = dict(filters) + for name in ("page", "source_page"): + page = request.args.get(name, 1, type=int) + if page > 1: + detail_args[name] = page + return redirect( + url_for("webmentions.source_detail", source_uuid=source_uuid, **detail_args) + ) |
