diff options
Diffstat (limited to 'webmentions_ssg/views/sources.py')
| -rw-r--r-- | webmentions_ssg/views/sources.py | 166 |
1 files changed, 155 insertions, 11 deletions
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) + ) |
