aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/views/admin.py
blob: 5246d3a0a0aaa61dd7b5c4149efd0726c7ac2dea (plain) (blame)
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 incoming and outgoing Webmention management."""

import uuid
from datetime import UTC, datetime, time
from http import HTTPStatus

import sqlalchemy as sa
from flask import abort, flash, redirect, render_template, request, url_for
from flask.typing import ResponseReturnValue
from flask_login import login_required
from sqlalchemy.orm import selectinload

from .. import forms
from ..extensions import db
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
def received_list() -> ResponseReturnValue:
    """Display received Webmentions.

    :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(
        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(),
    )


@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 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)
    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),
            status=filters.get("status"),
            q=filters.get("q"),
            date_from=filters.get("date_from"),
            date_to=filters.get("date_to"),
        )
    )


@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 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()

    db.session.commit()

    verify_webmention(webmention_uuid)

    flash(f"Webmention {webmention.uuid} queued for reverification.", "success")

    return redirect(
        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"),
        )
    )


@webmentions_bp.route("/sources")
@login_required
def source_list() -> ResponseReturnValue:
    """Display sources with sent Webmentions.

    :returns: Rendered page containing the paginated source list.
    """
    sources = db.paginate(
        sa.select(SourceDocument)
        .options(selectinload(SourceDocument.sent_webmentions))
        .order_by(SourceDocument.last_seen_at.desc()),
        per_page=25,
    )
    return render_template(
        "sent.html",
        title="Sent Webmentions",
        sources=sources,
        action_form=forms.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 forms.ConfirmActionForm().validate_on_submit():
        abort(HTTPStatus.BAD_REQUEST)

    manual_scan_sources()
    flash("Source rescan queued.", "success")

    return redirect(url_for("webmentions.source_list"))


@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.
    """
    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,
        action_form=forms.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 forms.ConfirmActionForm().validate_on_submit():
        abort(HTTPStatus.BAD_REQUEST)

    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")

    return redirect(url_for("webmentions.source_detail", source_uuid=source_uuid))