aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/tasks/verification.py
blob: d55608c943f8132a4822cdebd6af6a75475c52f8 (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
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
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

"""Fetch and verify incoming Webmentions with transactional state changes."""

import uuid
from dataclasses import dataclass
from datetime import UTC, datetime, timedelta
from http import HTTPStatus

import httpx
import sqlalchemy as sa
from flask import current_app

from ..db_helpers import rows_affected
from ..extensions import db, huey
from ..models import ReceivedWebmention, ReceivedWebmentionStatus
from ..net import (
    AddressResolutionError,
    ResponseTooLargeError,
    UnsafeAddressError,
    build_public_http_client,
    is_retryable_status,
    media_type_of,
    read_limited_body,
)
from ..source_policy import source_rejection_reason
from ..version import APP_NAME, VERSION
from .target_matching import html_mentions_target, text_mentions_target

RECOVERY_EXHAUSTED_REASON = "Verification recovery limit reached"


class VerificationError(Exception):
    """The source permanently failed ReceivedWebmention verification."""


class SourceGoneError(VerificationError):
    """The source explicitly reports that it has been removed."""


class RetryableFetchError(Exception):
    """Fetching the source may succeed when retried later."""


@dataclass(frozen=True)
class VerificationClaim:
    """Source and lease version for one atomically claimed verification."""

    webmention_uuid: uuid.UUID
    source: str
    target: str
    lease_started_at: datetime


def fetch_source_document(source_url: str) -> tuple[httpx.Response, bytes]:
    """Fetch a webmention source document.

    The request follows redirects while enforcing the configured timeout,
    redirect limit, and maximum response size.

    :param source_url: URL of the source document.
    :returns: HTTP response and response body.
    :raises SourceGoneError: If the source returns HTTP 410.
    :raises RetryableFetchError: If the source returns a temporary HTTP error.
    :raises VerificationError: If the source returns another unsuccessful HTTP status or
                               exceeds the configured maximum response size.
    """
    try:
        with (
            build_public_http_client(
                f"{APP_NAME}/{VERSION} ReceivedWebmention",
                accept="text/html, application/xhtml+xml;q=0.9, text/plain;q=0.8",
            ) as client,
            client.stream("GET", source_url) as response,
        ):
            if response.status_code == HTTPStatus.OK:
                pass
            elif response.status_code == HTTPStatus.GONE:
                raise SourceGoneError("Source returned HTTP 410")
            elif is_retryable_status(response.status_code):
                raise RetryableFetchError(
                    f"Source returned HTTP {response.status_code}"
                )
            else:
                raise VerificationError(f"Source returned HTTP {response.status_code}")

            try:
                return response, read_limited_body(
                    response,
                    current_app.config["MAX_RECEIVED_SOURCE_BYTES"],
                    label="Source",
                )
            except ResponseTooLargeError as exc:
                raise VerificationError(str(exc)) from exc

    except UnsafeAddressError as exc:
        raise VerificationError("Source resolves to a non-public address") from exc
    except AddressResolutionError as exc:
        raise RetryableFetchError("Source hostname could not be resolved") from exc


def source_mentions_target(source_url: str, target_url: str) -> bool:
    """Fetch a source and check whether it mentions the target URL.

    HTML and XHTML sources are inspected for supported URL attributes, while
    plain-text sources are searched for the exact target IRI.

    :param source_url: URL of the source document.
    :param target_url: Exact target URL to look for.
    :returns: Whether the source mentions the target URL.
    :raises VerificationError: If the source has an unsupported or missing content type.
    :raises SourceGoneError: If the source explicitly reports that it is gone.
    :raises RetryableFetchError: If fetching the source fails temporarily.
    """
    response, body = fetch_source_document(source_url)

    media_type = media_type_of(response.headers)

    match media_type:
        case "text/html" | "application/xhtml+xml":
            return html_mentions_target(body, str(response.url), target_url)
        case "text/plain":
            try:
                decoded_body = body.decode(
                    response.encoding or "utf-8", errors="replace"
                )
            except LookupError:
                decoded_body = body.decode("utf-8", errors="replace")
            return text_mentions_target(decoded_body, target_url)
        case _:
            raise VerificationError(
                f"Unsupported source content type: {media_type or 'missing'}"
            )


def claim_for_verification(webmention_uuid: uuid.UUID) -> VerificationClaim | None:
    """Claim an eligible row, returning its source, target, and lease version.

    :param webmention_uuid: Identifier of the received Webmention to claim.
    :returns: Verification claim, or ``None`` if the row cannot be claimed.
    """
    webmention = db.session.get(ReceivedWebmention, webmention_uuid)

    if webmention is None:
        current_app.logger.warning(
            "Cannot verify unknown ReceivedWebmention %s", webmention_uuid
        )
        return None

    if webmention.status not in {
        ReceivedWebmentionStatus.RECEIVED,
        ReceivedWebmentionStatus.FAILED,
    }:
        return None

    if (
        webmention.status == ReceivedWebmentionStatus.FAILED
        and webmention.failure_reason == RECOVERY_EXHAUSTED_REASON
    ):
        return None

    claim = VerificationClaim(
        webmention_uuid=webmention_uuid,
        source=webmention.source,
        target=webmention.target,
        lease_started_at=datetime.now(UTC),
    )
    changed = db.session.execute(
        sa.update(ReceivedWebmention)
        .where(
            ReceivedWebmention.uuid == webmention_uuid,
            ReceivedWebmention.status == webmention.status,
            ReceivedWebmention.updated_at == webmention.updated_at,
        )
        .values(
            status=ReceivedWebmentionStatus.VERIFYING,
            failure_reason=None,
            updated_at=claim.lease_started_at,
        )
    )

    if rows_affected(changed) != 1:
        db.session.rollback()
        return None

    db.session.commit()
    return claim


def determine_verification_outcome(
    claim: VerificationClaim,
) -> tuple[ReceivedWebmentionStatus, str | None]:
    """Map verification results and permanent errors to a final status/reason.

    :param claim: Claim containing the source and target URLs to verify.
    :returns: Final verification status and optional reason.
    :raises RetryableFetchError: If the source fetch fails transiently and should be
                                 retried.
    :raises httpx.RequestError: If a transient HTTP request error should be retried.
    """
    # Recheck at worker time: a source may have been blocked since submission.
    if reason := source_rejection_reason(claim.source):
        return ReceivedWebmentionStatus.FAILED, reason

    try:
        mentions_target = source_mentions_target(claim.source, claim.target)
    except SourceGoneError as exc:
        return ReceivedWebmentionStatus.SOURCE_REMOVED, str(exc)
    except VerificationError as exc:
        return ReceivedWebmentionStatus.FAILED, str(exc)
    except RetryableFetchError, httpx.RequestError:
        raise  # These errors must be persisted and then retried by Huey.
    except Exception as exc:
        # InvalidURL is not a RequestError; unexpected source errors are terminal.
        current_app.logger.exception(
            "Unexpected error verifying ReceivedWebmention %s", claim.webmention_uuid
        )
        return ReceivedWebmentionStatus.FAILED, str(exc) or type(exc).__name__

    if mentions_target:
        return ReceivedWebmentionStatus.VERIFIED, None
    return ReceivedWebmentionStatus.SOURCE_REMOVED, "Source does not mention target"


def store_verification_outcome(
    claim: VerificationClaim, status: ReceivedWebmentionStatus, reason: str | None
) -> bool:
    """Persist an outcome only if this worker still owns the verification lease.

    :param claim: Verification lease acquired by this worker.
    :param status: Final status to persist for the claimed Webmention.
    :param reason: Optional explanation for a failed or source-removed Webmention.
    :returns: ``True`` if the worker still owned the lease and persisted the outcome.
    """
    changed = db.session.execute(
        sa.update(ReceivedWebmention)
        .where(
            ReceivedWebmention.uuid == claim.webmention_uuid,
            ReceivedWebmention.status == ReceivedWebmentionStatus.VERIFYING,
            ReceivedWebmention.updated_at == claim.lease_started_at,
        )
        .values(status=status, failure_reason=reason, updated_at=datetime.now(UTC))
    )
    db.session.commit()
    return rows_affected(changed) == 1


@huey.task(retries=2, retry_delay=50)
def verify_webmention(webmention_uuid: uuid.UUID) -> None:
    """Claim and verify a received Webmention, preserving its lease on release.

    Temporary fetch failures are recorded and re-raised for Huey's retries.

    Retry transient fetch errors; persist only results belonging to the currently held
    lease.

    :param webmention_uuid: Identifier of the received webmention to verify.
    :raises RetryableFetchError: If fetching the source fails temporarily.
    :raises httpx.RequestError: If an HTTP request fails while fetching.
    """
    if (claim := claim_for_verification(webmention_uuid)) is None:
        return

    try:
        status, reason = determine_verification_outcome(claim)
    except (RetryableFetchError, httpx.RequestError) as exc:
        store_verification_outcome(
            claim,
            ReceivedWebmentionStatus.FAILED,
            str(exc) or "Source could not be fetched",
        )
        raise

    store_verification_outcome(claim, status, reason)


def recover_stale_verifications() -> int:
    """Requeue verification attempts that were abandoned or lost from the queue.

    Recover both stale ``verifying`` rows (workers that died) and stale
    ``received`` rows (tasks that were never enqueued or were lost). Conditional
    updates prevent overlapping reapers from enqueueing the same row. Each
    reclaimed row is committed *before* enqueueing, so the worker can claim it.
    A crash between commit and enqueue is recovered on a later sweep.
    Persist a recovery count so repeatedly lost or crashing tasks eventually
    terminate rather than being requeued forever.

    Eligible expired verification leases are returned to the queue, subject to recovery
    limits.

    :returns: Number of webmentions requeued.
    """
    now = datetime.now(UTC)
    cutoff = now - timedelta(
        seconds=current_app.config["VERIFICATION_STALE_AFTER_SECONDS"]
    )

    stale = db.session.execute(
        sa.select(
            ReceivedWebmention.uuid,
            ReceivedWebmention.status,
            ReceivedWebmention.updated_at,
            ReceivedWebmention.recovery_attempts,
        ).where(
            ReceivedWebmention.status.in_(
                (ReceivedWebmentionStatus.VERIFYING, ReceivedWebmentionStatus.RECEIVED)
            ),
            ReceivedWebmention.updated_at <= cutoff,
        )
    ).all()

    recovered = 0
    exhausted = 0
    max_recoveries = current_app.config["VERIFICATION_MAX_RECOVERIES"]

    for identifier, status, updated_at, recovery_attempts in stale:
        at_limit = recovery_attempts >= max_recoveries
        changed = db.session.execute(
            sa.update(ReceivedWebmention)
            .where(
                ReceivedWebmention.uuid == identifier,
                ReceivedWebmention.status == status,
                ReceivedWebmention.updated_at == updated_at,
                ReceivedWebmention.recovery_attempts == recovery_attempts,
            )
            .values(
                **(
                    {
                        "status": ReceivedWebmentionStatus.FAILED,
                        "failure_reason": RECOVERY_EXHAUSTED_REASON,
                        "updated_at": now,
                        "recovery_attempts": recovery_attempts,
                    }
                    if at_limit
                    else ReceivedWebmention.reopen_verification_values(
                        at=now, recovery_attempts=recovery_attempts + 1
                    )
                )
            )
        )

        if rows_affected(changed) != 1:
            db.session.rollback()
            continue

        db.session.commit()

        if at_limit:
            exhausted += 1
            continue
        verify_webmention(identifier)
        recovered += 1

    if exhausted:
        current_app.logger.warning(
            "Failed %d stale webmentions after maximum verification recoveries",
            exhausted,
        )

    if recovered:
        current_app.logger.warning(
            "Requeued %d stale received webmention verifications", recovered
        )

    return recovered