1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause
"""Authenticated views for received Webmentions."""
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, current_app, flash, redirect, render_template, request, url_for
from flask.typing import ResponseReturnValue
from flask_login import login_required
from ..db_helpers import rows_affected
from ..extensions import db
from ..forms.admin import ConfirmActionForm
from ..forms.received import (
RECEIVED_STATUS_CHOICES,
ReceivedWebmentionFilterForm,
default_received_page_size,
)
from ..models.received import (
ReceivedWebmention,
ReceivedWebmentionStatus,
ReceivedWebmentionStatusEvent,
purge_orphaned_received_events,
)
from ..moderation_policy import domain_from_url
from ..received_failure import describe_received_failure
from ..tasks.verification import verify_webmention
from .blueprint import webmentions_bp
from .moderation import block_domains
webmentions_bp.add_app_template_filter(
describe_received_failure, "received_failure_guidance"
)
RECEIVED_STATUS_FILTERS = {
"pending": (ReceivedWebmentionStatus.RECEIVED,),
"verifying": (ReceivedWebmentionStatus.VERIFYING,),
"verified": (ReceivedWebmentionStatus.VERIFIED,),
"declined": (
ReceivedWebmentionStatus.FAILED,
ReceivedWebmentionStatus.SOURCE_REMOVED,
),
}
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() -> ReceivedWebmentionFilterForm:
"""Validate query-string filters without requiring CSRF on the GET form."""
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: 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")
@login_required
def received_list() -> ResponseReturnValue:
"""Display received Webmentions.
:returns: Rendered page containing the paginated received Webmentions.
"""
filters = received_filter_args(received_filter_form())
query = sa.select(ReceivedWebmention)
if status := filters.get("status"):
query = query.where(
ReceivedWebmention.status.in_(RECEIVED_STATUS_FILTERS[status])
)
if text := filters.get("q"):
query = query.where(
sa.or_(
ReceivedWebmention.source.icontains(text, autoescape=True),
ReceivedWebmention.target.icontains(text, autoescape=True),
)
)
if start := filters.get("date_from"):
query = query.where(
ReceivedWebmention.updated_at
>= datetime.combine(date.fromisoformat(start), time.min, UTC)
)
if end := filters.get("date_to"):
query = query.where(
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", default_received_page_size()))
webmentions = db.paginate(
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,
sort_key=sort_key,
sort_order=sort_order,
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=ConfirmActionForm(),
)
@webmentions_bp.get("/received/<uuid:webmention_uuid>")
@login_required
def received_detail(webmention_uuid: uuid.UUID) -> ResponseReturnValue:
"""Display a private received Webmention detail and its recorded history."""
filters = received_filter_args(received_filter_form())
webmention = db.get_or_404(ReceivedWebmention, webmention_uuid)
history = db.session.scalars(
sa.select(ReceivedWebmentionStatusEvent)
.where(ReceivedWebmentionStatusEvent.webmention_uuid == webmention_uuid)
.order_by(ReceivedWebmentionStatusEvent.id.desc())
).all()
page = request.args.get("page", 1, type=int)
return render_template(
"received_detail.html",
title="Received Webmention details",
webmention=webmention,
history=history,
filters=filters,
page=page,
action_form=ConfirmActionForm(),
)
def received_action_redirect(
webmention_uuid: uuid.UUID, filters: ReceivedFilterArgs
) -> ResponseReturnValue:
"""Return to details for detail actions, otherwise to the filtered list."""
page = request.args.get("page", 1, type=int)
if request.args.get("return_to") == "detail":
return redirect(
url_for(
"webmentions.received_detail",
webmention_uuid=webmention_uuid,
page=page,
**filters,
)
)
return redirect(url_for("webmentions.received_list", page=page, **filters))
@webmentions_bp.post("/received/<uuid:webmention_uuid>/delete")
@login_required
def delete_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValue:
"""Delete a received Webmention.
:param webmention_uuid: UUID of the Webmention to delete.
:returns: Redirect response to the received Webmentions view.
"""
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)
db.session.delete(webmention)
db.session.commit()
flash(f"Webmention {webmention.uuid} deleted.", "success")
return redirect(
url_for(
"webmentions.received_list",
page=request.args.get("page", 1, type=int),
**filters,
)
)
@webmentions_bp.post("/received/<uuid:webmention_uuid>/reverify")
@login_required
def reverify_received_webmention(webmention_uuid: uuid.UUID) -> ResponseReturnValue:
"""Queue a received Webmention for reverification.
The Webmention status is reset before a new verification task is queued.
:param webmention_uuid: UUID of the Webmention to reverify.
:returns: Redirect response to the received Webmentions view.
"""
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)
webmention.reopen_verification()
db.session.add(
ReceivedWebmentionStatusEvent(
webmention_uuid=webmention_uuid,
status=ReceivedWebmentionStatus.RECEIVED,
action="Manually queued for reverification",
occurred_at=webmention.updated_at,
)
)
db.session.commit()
verify_webmention(webmention_uuid)
flash(f"Webmention {webmention.uuid} queued for reverification.", "success")
return received_action_redirect(webmention_uuid, filters)
def selected_received_webmentions() -> list[ReceivedWebmention]:
"""Load a valid, nonempty selection of rows from the current list page.
Reject malformed, duplicated, oversized, or stale selections rather than
silently performing only part of a requested bulk action.
"""
submitted = request.form.getlist("webmention_uuids")
if not submitted or len(submitted) > current_app.config["RECEIVED_MAX_PAGE_SIZE"]:
abort(HTTPStatus.BAD_REQUEST)
try:
identifiers = {uuid.UUID(value) for value in submitted}
except ValueError, AttributeError, TypeError:
abort(HTTPStatus.BAD_REQUEST)
if len(identifiers) != len(submitted):
abort(HTTPStatus.BAD_REQUEST)
webmentions = list(
db.session.scalars(
sa.select(ReceivedWebmention).where(
ReceivedWebmention.uuid.in_(identifiers)
)
)
)
if len(webmentions) != len(identifiers):
abort(HTTPStatus.NOT_FOUND)
return webmentions
@webmentions_bp.post("/received/bulk/reverify")
@login_required
def reverify_selected_received_webmentions() -> ResponseReturnValue:
"""Reopen and queue each selected received Webmention for verification."""
if not ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
filters = received_filter_args(received_filter_form())
webmentions = selected_received_webmentions()
identifiers = [webmention.uuid for webmention in webmentions]
for webmention in webmentions:
webmention.reopen_verification()
db.session.add(
ReceivedWebmentionStatusEvent(
webmention_uuid=webmention.uuid,
status=ReceivedWebmentionStatus.RECEIVED,
action="Manually queued for reverification",
occurred_at=webmention.updated_at,
)
)
db.session.commit()
for identifier in identifiers:
verify_webmention(identifier)
flash(f"{len(webmentions)} Webmentions queued for reverification.", "success")
return redirect(
url_for(
"webmentions.received_list",
page=request.args.get("page", 1, type=int),
**filters,
)
)
@webmentions_bp.post("/received/bulk/delete")
@login_required
def delete_selected_received_webmentions() -> ResponseReturnValue:
"""Permanently delete only the selected received Webmentions."""
if not ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
filters = received_filter_args(received_filter_form())
webmentions = selected_received_webmentions()
for webmention in webmentions:
db.session.delete(webmention)
db.session.flush()
purge_orphaned_received_events()
db.session.commit()
flash(f"{len(webmentions)} Webmentions deleted.", "success")
return redirect(
url_for(
"webmentions.received_list",
page=request.args.get("page", 1, type=int),
**filters,
)
)
@webmentions_bp.post("/received/declined/delete")
@login_required
def delete_all_declined_received_webmentions() -> ResponseReturnValue:
"""Delete every declined received Webmention, regardless of age or filters."""
if not ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
filters = received_filter_args(received_filter_form())
result = db.session.execute(
sa.delete(ReceivedWebmention).where(
ReceivedWebmention.status.in_(RECEIVED_STATUS_FILTERS["declined"])
)
)
purge_orphaned_received_events()
db.session.commit()
count = rows_affected(result)
flash(f"{count} declined Webmentions deleted.", "success")
return redirect(
url_for(
"webmentions.received_list",
page=request.args.get("page", 1, type=int),
**filters,
)
)
@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 ConfirmActionForm().validate_on_submit():
abort(HTTPStatus.BAD_REQUEST)
filters = received_filter_args(received_filter_form())
webmentions = selected_received_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_domains(cast(set[str], domains))
flash(
f"{added} source domains newly blocked from {len(webmentions)} selected Webmentions.",
"success",
)
return redirect(
url_for(
"webmentions.received_list",
page=request.args.get("page", 1, type=int),
**filters,
)
)
@webmentions_bp.post("/received/<uuid:webmention_uuid>/block-source")
@login_required
def block_received_source(webmention_uuid: uuid.UUID) -> ResponseReturnValue:
"""Add a received Webmention's source hostname to the blocklist."""
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 := domain_from_url(webmention.source)) is None:
abort(HTTPStatus.BAD_REQUEST)
block_domains({domain})
flash(f"Source domain {domain} blocked.", "success")
return received_action_redirect(webmention_uuid, filters)
|