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
|
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause
"""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, current_app, flash, redirect, render_template, request, url_for
from flask.typing import ResponseReturnValue
from flask_login import login_required
from ..extensions import db
from ..forms.admin import ConfirmActionForm
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 source documents with filters for outgoing delivery problems."""
filter_form = source_filter_form()
filters = source_filter_args(filter_form)
query = sa.select(SourceDocument)
# 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(
query,
per_page=page_size,
max_per_page=current_app.config["SOURCES_MAX_PAGE_SIZE"],
)
statistics = {}
if sources.items:
statistics = {
row.source_uuid: row
for row in db.session.execute(
SourceDocument.sent_webmention_statistics(
[source.uuid for source in sources.items]
)
)
}
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,
statistics=statistics,
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"],
filter_form=filter_form,
action_form=ConfirmActionForm(),
)
@webmentions_bp.post("/sources/rescan")
@login_required
def rescan_sources() -> ResponseReturnValue:
"""Queue a manual scan of sent Webmention sources.
:returns: Redirect response to the sent Webmentions view.
"""
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")
page = request.args.get("page", 1, type=int)
return redirect(
url_for("webmentions.source_list", page=page if page > 1 else None, **filters)
)
@webmentions_bp.route("/sources/<uuid:source_uuid>")
@login_required
def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue:
"""Display the sent Webmentions associated with a source.
: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(
sa.select(SentWebmention)
.where(SentWebmention.source_uuid == source.uuid)
.order_by(SentWebmention.target, SentWebmention.uuid),
per_page=25,
)
return render_template(
"sent_source.html",
title="Sent Webmentions",
source=source,
webmentions=webmentions,
filters=filters,
source_page=source_page,
action_form=ConfirmActionForm(),
)
@webmentions_bp.post("/sources/<uuid:source_uuid>/<uuid:webmention_uuid>/resend")
@login_required
def resend_webmention(
source_uuid: uuid.UUID, webmention_uuid: uuid.UUID
) -> ResponseReturnValue:
"""Queue an outgoing Webmention to be sent again.
The current desired source revision is reopened for processing so the
sender task does not treat the Webmention as already completed. Historical
successful-send fields are preserved, while result fields from the previous
attempt are cleared.
:param source_uuid: UUID of the source owning the Webmention.
:param webmention_uuid: UUID of the sent Webmention to resend.
:returns: Redirect response to the source details view.
"""
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:
abort(HTTPStatus.NOT_FOUND)
# Requeue the existing desired revision instead of inventing a new source
# revision. send_webmention() otherwise exits when this revision has already
# been processed.
webmention.clear_result_for_resend()
db.session.commit()
send_webmention(webmention_uuid)
flash(f"Webmention {webmention.uuid} queued for resend.", "success")
page = request.args.get("page", 1, type=int)
source_page = request.args.get("source_page", 1, type=int)
return redirect(
url_for(
"webmentions.source_detail",
source_uuid=source_uuid,
page=page if page > 1 else None,
source_page=source_page if source_page > 1 else None,
**filters,
)
)
|