aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/views
diff options
context:
space:
mode:
Diffstat (limited to 'webmentions_ssg/views')
-rw-r--r--webmentions_ssg/views/admin.py113
1 files changed, 86 insertions, 27 deletions
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,
)
)