aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg
diff options
context:
space:
mode:
Diffstat (limited to 'webmentions_ssg')
-rw-r--r--webmentions_ssg/forms.py55
-rw-r--r--webmentions_ssg/templates/received.html38
-rw-r--r--webmentions_ssg/views/admin.py93
3 files changed, 175 insertions, 11 deletions
diff --git a/webmentions_ssg/forms.py b/webmentions_ssg/forms.py
index 1ce591d..d97cc69 100644
--- a/webmentions_ssg/forms.py
+++ b/webmentions_ssg/forms.py
@@ -9,9 +9,18 @@ import ipaddress
import httpx
from flask import current_app
from flask_wtf import FlaskForm
-from wtforms import Field, PasswordField, StringField, SubmitField, ValidationError
+from wtforms import (
+ DateField,
+ Field,
+ PasswordField,
+ SearchField,
+ SelectField,
+ StringField,
+ SubmitField,
+ ValidationError,
+)
from wtforms.form import BaseForm
-from wtforms.validators import InputRequired, StopValidation
+from wtforms.validators import InputRequired, Optional, StopValidation
from .net import is_public_address, normalized_hostname
from .validation import is_control_character
@@ -165,6 +174,48 @@ class WebmentionSubmissionForm(FlaskForm):
raise ValidationError(field.gettext("Field must not be equal to target."))
+class CanonicalDate:
+ """Require HTML date inputs to use the canonical YYYY-MM-DD format."""
+
+ def __call__(self, form: BaseForm, field: DateField) -> None:
+ if (
+ field.data is not None
+ and field.raw_data
+ and field.raw_data[0] != field.data.isoformat()
+ ):
+ raise ValidationError(field.gettext("Invalid date."))
+
+
+class ReceivedWebmentionFilterForm(FlaskForm):
+ """GET filters for the received Webmention list."""
+
+ status = SelectField(
+ "Status",
+ choices={
+ "": "All statuses",
+ "pending": "Pending",
+ "verifying": "Verifying",
+ "verified": "Verified",
+ "declined": "Declined",
+ },
+ default="",
+ )
+ q = SearchField("Source or target")
+ date_from = DateField(
+ "Updated from (UTC)", validators=[Optional(), CanonicalDate()]
+ )
+ date_to = DateField("Updated to (UTC)", validators=[Optional(), CanonicalDate()])
+
+ def validate_date_to(self, field: DateField) -> None:
+ """Require the end date to be 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.")
+
+
class ConfirmActionForm(FlaskForm):
"""Form for confirming an administrative action."""
diff --git a/webmentions_ssg/templates/received.html b/webmentions_ssg/templates/received.html
index f94d104..9034ca8 100644
--- a/webmentions_ssg/templates/received.html
+++ b/webmentions_ssg/templates/received.html
@@ -39,6 +39,32 @@ SPDX-License-Identifier: BSD-3-Clause
<h1 class="mb-0">Received Webmentions</h1>
<span class="text-body-secondary">{{ webmentions.total }} total</span>
</div>
+ <form action="{{ url_for('webmentions.received_list') }}"
+ method="get"
+ class="row g-2 align-items-end mb-4"
+ role="search">
+ <div class="col-sm-6 col-lg">
+ {{ filter_form.status.label(class="form-label") }}
+ {{ filter_form.status(class="form-select") }}
+ </div>
+ <div class="col-sm-6 col-lg">
+ {{ filter_form.q.label(class="form-label") }}
+ {{ filter_form.q(class="form-control", placeholder="Search URLs") }}
+ </div>
+ <div class="col-sm-6 col-lg">
+ {{ filter_form.date_from.label(class="form-label") }}
+ {{ filter_form.date_from(class="form-control") }}
+ </div>
+ <div class="col-sm-6 col-lg">
+ {{ filter_form.date_to.label(class="form-label") }}
+ {{ filter_form.date_to(class="form-control") }}
+ </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.received_list') }}"
+ class="btn btn-outline-secondary">Clear</a>
+ </div>
+ </form>
{% if webmentions.items %}
<table class="table table-bordered table-striped table-hover align-middle">
<thead>
@@ -79,7 +105,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.reverify_received_webmention', webmention_uuid=webmention.uuid, page=webmentions.page) }}"
+ data-action="{{ url_for('webmentions.reverify_received_webmention', webmention_uuid=webmention.uuid, page=webmentions.page, **filters) }}"
data-title="Reverify webmention?"
data-message="The webmention will be fetched and verified again."
data-confirm-label="Reverify"
@@ -88,7 +114,7 @@ SPDX-License-Identifier: BSD-3-Clause
class="btn btn-sm btn-danger"
data-bs-toggle="modal"
data-bs-target="#confirmation-modal"
- data-action="{{ url_for('webmentions.delete_received_webmention', webmention_uuid=webmention.uuid, page=webmentions.page) }}"
+ data-action="{{ url_for('webmentions.delete_received_webmention', webmention_uuid=webmention.uuid, page=webmentions.page, **filters) }}"
data-title="Delete webmention?"
data-message="This permanently deletes the webmention and cannot be undone."
data-confirm-label="Delete"
@@ -99,11 +125,15 @@ SPDX-License-Identifier: BSD-3-Clause
</tbody>
</table>
{% if webmentions.pages > 1 %}
- <div class="mt-3">{{ render_pagination(webmentions) }}</div>
+ <div class="mt-3">{{ render_pagination(webmentions, args=filters) }}</div>
{% endif %}
{% include "includes/confirmation_modal.html" %}
{% else %}
- <p class="text-body-secondary">No Webmentions have been received yet.</p>
+ {% if filters %}
+ <p class="text-body-secondary">No Webmentions match these filters.</p>
+ {% else %}
+ <p class="text-body-secondary">No Webmentions have been received yet.</p>
+ {% endif %}
{% endif %}
{% endblock %}
diff --git a/webmentions_ssg/views/admin.py b/webmentions_ssg/views/admin.py
index 23abe65..5246d3a 100644
--- a/webmentions_ssg/views/admin.py
+++ b/webmentions_ssg/views/admin.py
@@ -5,6 +5,7 @@
"""Authenticated incoming and outgoing Webmention management."""
import uuid
+from datetime import UTC, datetime, time
from http import HTTPStatus
import sqlalchemy as sa
@@ -15,12 +16,49 @@ from sqlalchemy.orm import selectinload
from .. import forms
from ..extensions import db
-from ..models import ReceivedWebmention, SentWebmention, SourceDocument
+from ..models import (
+ ReceivedWebmention,
+ ReceivedWebmentionStatus,
+ SentWebmention,
+ SourceDocument,
+)
from ..tasks.scanner import manual_scan_sources
from ..tasks.sender import send_webmention
from ..tasks.verification import verify_webmention
from .blueprint import webmentions_bp
+RECEIVED_STATUS_FILTERS = {
+ "pending": (ReceivedWebmentionStatus.RECEIVED,),
+ "verifying": (ReceivedWebmentionStatus.VERIFYING,),
+ "verified": (ReceivedWebmentionStatus.VERIFIED,),
+ "declined": (
+ ReceivedWebmentionStatus.FAILED,
+ ReceivedWebmentionStatus.SOURCE_REMOVED,
+ ),
+}
+
+
+def received_filter_form() -> forms.ReceivedWebmentionFilterForm:
+ """Validate query-string filters without requiring CSRF on the GET form."""
+ form = forms.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) -> 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}
+
@webmentions_bp.route("/received")
@login_required
@@ -29,15 +67,44 @@ def received_list() -> ResponseReturnValue:
:returns: Rendered page containing the paginated received Webmentions.
"""
+ filter_form = received_filter_form()
+ filters = received_filter_args(filter_form)
+
+ query = sa.select(ReceivedWebmention)
+
+ if status := filter_form.status.data:
+ query = query.where(
+ ReceivedWebmention.status.in_(RECEIVED_STATUS_FILTERS[status])
+ )
+
+ if text := filter_form.q.data:
+ query = query.where(
+ sa.or_(
+ ReceivedWebmention.source.icontains(text, autoescape=True),
+ ReceivedWebmention.target.icontains(text, autoescape=True),
+ )
+ )
+
+ if (start := filter_form.date_from.data) is not None:
+ query = query.where(
+ ReceivedWebmention.updated_at >= datetime.combine(start, time.min, UTC)
+ )
+
+ if (end := filter_form.date_to.data) is not None:
+ query = query.where(
+ ReceivedWebmention.updated_at <= datetime.combine(end, time.max, UTC)
+ )
+
webmentions = db.paginate(
- sa.select(ReceivedWebmention).order_by(ReceivedWebmention.uuid.desc()),
- per_page=25,
+ query.order_by(ReceivedWebmention.uuid.desc()), per_page=25
)
return render_template(
"received.html",
title="Received Webmentions",
webmentions=webmentions,
+ filters=filters,
+ filter_form=filter_form,
action_form=forms.ConfirmActionForm(),
)
@@ -53,6 +120,7 @@ def delete_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValu
if not forms.ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
+ filters = received_filter_args(received_filter_form())
webmention = db.get_or_404(ReceivedWebmention, webmention_uuid)
db.session.delete(webmention)
@@ -61,7 +129,14 @@ def delete_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValu
flash(f"Webmention {webmention.uuid} deleted.", "success")
return redirect(
- url_for("webmentions.received_list", page=request.args.get("page", 1, type=int))
+ 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"),
+ )
)
@@ -78,6 +153,7 @@ def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnVa
if not forms.ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
+ filters = received_filter_args(received_filter_form())
webmention = db.get_or_404(ReceivedWebmention, webmention_uuid)
webmention.reopen_verification()
@@ -89,7 +165,14 @@ def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnVa
flash(f"Webmention {webmention.uuid} queued for reverification.", "success")
return redirect(
- url_for("webmentions.received_list", page=request.args.get("page", 1, type=int))
+ 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"),
+ )
)