aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/views.py
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--webmentions_ssg/views.py454
1 files changed, 0 insertions, 454 deletions
diff --git a/webmentions_ssg/views.py b/webmentions_ssg/views.py
deleted file mode 100644
index 5b563f0..0000000
--- a/webmentions_ssg/views.py
+++ /dev/null
@@ -1,454 +0,0 @@
-# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
-#
-# SPDX-License-Identifier: BSD-3-Clause
-
-"""Provide routes for authentication and Webmention administration."""
-
-import hashlib
-import secrets
-import uuid
-from datetime import UTC, datetime, timedelta
-from typing import Any, cast
-
-import sqlalchemy as sa
-import sqlalchemy.exc as sa_exc
-from flask import (
- Blueprint,
- Response,
- abort,
- current_app,
- flash,
- redirect,
- render_template,
- request,
- url_for,
-)
-from flask.typing import ResponseReturnValue
-from flask_limiter.util import get_remote_address
-from flask_login import current_user, login_required, login_user, logout_user
-from sqlalchemy.engine import CursorResult
-from sqlalchemy.orm import selectinload
-
-from . import CSRF, LIMITER, forms
-from . import DATABASE as db
-from .models import ReceivedWebmention, SentWebmention, Source, User
-from .tasks.receiver import verify_webmention
-from .tasks.scanner import manual_scan_sources
-from .tasks.sender import send_webmention
-from .url_digest import received_url_digest
-from .url_security import is_safe_next_url
-
-root_page = Blueprint("root", __name__)
-
-DUMMY_USER = User(username=secrets.token_urlsafe())
-DUMMY_USER.password = secrets.token_urlsafe()
-
-
-def login_username_limit_key() -> str:
- """Group submitted usernames across IPs without storing raw account names."""
- username = request.form.get("username", "").strip().casefold()
- if not username:
- # A missing username must not put all clients into one global bucket.
- return f"missing-username:{get_remote_address()}"
- digest = hashlib.sha256(username.encode("utf-8")).hexdigest()
- return f"username:{digest}"
-
-
-@root_page.route("/")
-def index() -> ResponseReturnValue:
- """
- Redirect to the received Webmentions view.
-
- :return: Redirect response to the received Webmentions view.
- """
- return redirect(url_for("root.received"))
-
-
-@root_page.route("/login", methods=["GET", "POST"])
-@LIMITER.limit(
- lambda: current_app.config["LOGIN_USERNAME_RATE_LIMIT"],
- key_func=login_username_limit_key,
- methods=["POST"],
- error_message="Too many login attempts. Please try again later.",
-)
-@LIMITER.limit(
- lambda: current_app.config["LOGIN_RATE_LIMIT"],
- methods=["POST"],
- error_message="Too many login attempts. Please try again later.",
-)
-def login() -> ResponseReturnValue:
- """
- Authenticate a user and start a login session.
-
- Authenticated users are redirected to the application index. After a
- successful login, the user is redirected to the requested local URL when
- provided.
-
- :return: Rendered login page or redirect response.
- """
- if current_user.is_authenticated:
- return redirect(url_for("root.index"))
-
- form = forms.LoginForm()
-
- if form.validate_on_submit():
- user = db.session.scalar(
- sa.select(User).where(User.username == form.username.data)
- )
-
- user_exists = user is not None
-
- if user is None:
- user = DUMMY_USER
-
- if (
- form.password.data is None
- or not user.check_password(form.password.data)
- or not user_exists
- ):
- flash("Invalid username or password", "danger")
- return redirect(url_for("root.login"))
- login_user(user)
-
- next_url = request.args.get("next")
- if not next_url or not is_safe_next_url(next_url):
- next_url = url_for("root.index")
- return redirect(next_url)
-
- return render_template("login.html", form=form)
-
-
-@root_page.route("/logout", methods=("POST",))
-@login_required
-def logout() -> ResponseReturnValue:
- """
- End the current user's login session.
-
- :return: Redirect response to the application index.
- """
- logout_user()
- return redirect(url_for("root.index"))
-
-
-@root_page.route("/received")
-@login_required
-def received() -> ResponseReturnValue:
- """
- Display received Webmentions.
-
- :return: Rendered page containing the paginated received Webmentions.
- """
- webmentions = db.paginate(
- sa.select(ReceivedWebmention).order_by(ReceivedWebmention.uuid.desc()),
- per_page=25,
- )
-
- return render_template(
- "received.html",
- title="Received Webmentions",
- webmentions=webmentions,
- action_form=forms.AdminActionForm(),
- )
-
-
-@root_page.post("/received/<uuid:identifier>/delete")
-@login_required
-def delete_received_webmention(identifier: uuid.UUID) -> ResponseReturnValue:
- """
- Delete a received Webmention.
-
- :param identifier: Identifier of the Webmention to delete.
- :return: Redirect response to the received Webmentions view.
- """
- form = forms.AdminActionForm()
-
- if not form.validate_on_submit():
- return abort(400)
-
- webmention = db.session.get(ReceivedWebmention, identifier)
-
- if webmention is None:
- return abort(404)
-
- db.session.delete(webmention)
- db.session.commit()
-
- flash(f"Webmention {webmention.uuid} deleted.", "success")
-
- return redirect(
- url_for("root.received", page=request.args.get("page", 1, type=int))
- )
-
-
-@root_page.post("/received/<uuid:identifier>/reverify")
-@login_required
-def reverify_received_webmention(identifier: uuid.UUID) -> ResponseReturnValue:
- """
- Queue a received Webmention for reverification.
-
- The Webmention status is reset before a new verification task is queued.
-
- :param identifier: Identifier of the Webmention to reverify.
- :return: Redirect response to the received Webmentions view.
- """
- form = forms.AdminActionForm()
-
- if not form.validate_on_submit():
- return abort(400)
-
- webmention = db.session.get(ReceivedWebmention, identifier)
-
- if webmention is None:
- return abort(404)
-
- webmention.status = "received"
- webmention.failure_reason = None
- webmention.recovery_attempts = 0
-
- db.session.commit()
-
- verify_webmention(identifier)
-
- flash(f"Webmention {webmention.uuid} queued for reverification.", "success")
-
- return redirect(
- url_for("root.received", page=request.args.get("page", 1, type=int))
- )
-
-
-@root_page.route("/sent")
-@login_required
-def sent() -> ResponseReturnValue:
- """
- Display sources with sent Webmentions.
-
- :return: Rendered page containing the paginated source list.
- """
- sources = db.paginate(
- sa.select(Source)
- .options(selectinload(Source.sent_webmentions))
- .order_by(Source.last_seen_at.desc()),
- per_page=25,
- )
- return render_template(
- "sent.html",
- title="Sent Webmentions",
- sources=sources,
- action_form=forms.AdminActionForm(),
- )
-
-
-@root_page.post("/sent/rescan")
-@login_required
-def rescan_sent_sources() -> ResponseReturnValue:
- """
- Queue a manual scan of sent Webmention sources.
-
- :return: Redirect response to the sent Webmentions view.
- """
- form = forms.AdminActionForm()
- if form.validate_on_submit():
- manual_scan_sources()
- flash("Source rescan queued.", "success")
- return redirect(url_for("root.sent"))
-
-
-@root_page.route("/sent/<uuid:source_identifier>")
-@login_required
-def sent_source(source_identifier: uuid.UUID) -> ResponseReturnValue:
- """
- Display the sent Webmentions associated with a source.
-
- :param source_identifier: Identifier of the source to display.
- :return: Rendered source details page.
- """
- source = db.session.scalar(
- sa.select(Source).where(Source.uuid == source_identifier)
- )
-
- if source is None:
- return abort(404)
-
- webmentions = db.paginate(
- sa.select(SentWebmention)
- .where(SentWebmention.source_id == 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.AdminActionForm(),
- )
-
-
-@root_page.post("/sent/<uuid:source_identifier>/<uuid:webmention_identifier>/resend")
-@login_required
-def resend_sent_webmention(
- source_identifier: uuid.UUID, webmention_identifier: 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_identifier: Identifier of the source owning the Webmention.
- :param webmention_identifier: Identifier of the sent Webmention to resend.
- :return: Redirect response to the source details view.
- """
- form = forms.AdminActionForm()
-
- if not form.validate_on_submit():
- return abort(400)
-
- webmention = db.session.get(SentWebmention, webmention_identifier)
-
- if webmention is None or webmention.source_id != source_identifier:
- return abort(404)
-
- # Reopen the existing desired revision instead of inventing a new source
- # revision. send_webmention() otherwise exits when this revision has already
- # been processed.
- webmention.processed_revision = None
- webmention.attempt_count = 0
- webmention.next_retry_at = None
- webmention.status = None
- webmention.failure_reason = None
- webmention.endpoint = None
- webmention.response_status = None
- webmention.status_url = None
-
- db.session.commit()
-
- send_webmention(webmention_identifier)
-
- flash(f"Webmention {webmention.uuid} queued for resend.", "success")
-
- return redirect(url_for("root.sent_source", source_identifier=source_identifier))
-
-
-@root_page.post("/endpoint")
-@LIMITER.limit(
- lambda: current_app.config["ENDPOINT_GLOBAL_RATE_LIMIT"],
- key_func=lambda: "all-clients",
-)
-@LIMITER.limit(lambda: current_app.config["ENDPOINT_RATE_LIMIT"])
-@CSRF.exempt
-def endpoint() -> ResponseReturnValue:
- """
- Receive and queue a Webmention for verification.
-
- Existing Webmentions with the same source and target are reset for
- reverification. Concurrent insertion of the same Webmention is handled by
- retrieving and updating the row created by the competing request.
-
- :return: HTTP 201 response with the Webmention status URL in the
- ``Location`` header, or validation errors with HTTP 400.
- """
- form = forms.EndpointForm(meta={"csrf": False})
-
- if not form.validate_on_submit():
- return form.errors, 400
-
- source = cast(str, form.source.data)
- target = cast(str, form.target.data)
-
- url_digest = received_url_digest(source, target)
- webmention = db.session.execute(
- sa.select(ReceivedWebmention).where(ReceivedWebmention.url_digest == url_digest)
- ).scalar_one_or_none()
-
- # A SHA-256 collision must never cause an unrelated Webmention to be overwritten.
- if webmention is not None and (webmention.source, webmention.target) != (
- source,
- target,
- ):
- return {"error": "Webmention URL fingerprint conflict"}, 409
-
- should_verify = False
-
- if webmention is None:
- identifier = uuid.uuid7()
-
- webmention = ReceivedWebmention(uuid=identifier, source=source, target=target)
-
- db.session.add(webmention)
-
- try:
- db.session.commit()
- should_verify = True
- except sa_exc.IntegrityError:
- db.session.rollback()
-
- # Another request may have inserted the same source/target pair
- # after our SELECT but before our COMMIT.
- webmention = db.session.execute(
- sa.select(ReceivedWebmention).where(
- ReceivedWebmention.url_digest == url_digest
- )
- ).scalar_one_or_none()
- if webmention is None or (webmention.source, webmention.target) != (
- source,
- target,
- ):
- return {"error": "Webmention URL fingerprint conflict"}, 409
-
- else:
- now = datetime.now(UTC)
- cutoff = now - timedelta(
- seconds=current_app.config["ENDPOINT_REVERIFY_COOLDOWN_SECONDS"]
- )
-
- # Atomic conditional update: only one concurrent request can reopen an expired verification.
- result = cast(
- CursorResult[Any],
- db.session.execute(
- sa.update(ReceivedWebmention)
- .where(
- ReceivedWebmention.uuid == webmention.uuid,
- ReceivedWebmention.updated_at <= cutoff,
- )
- .values(
- status="received",
- failure_reason=None,
- recovery_attempts=0,
- updated_at=now,
- )
- .execution_options(synchronize_session=False)
- ),
- )
- should_verify = result.rowcount == 1
- db.session.commit()
-
- identifier = webmention.uuid
-
- if should_verify:
- verify_webmention(identifier)
-
- status_url = url_for("root.status", identifier=str(identifier), _external=True)
-
- return Response(status=201, headers={"Location": status_url})
-
-
-@root_page.route("/status/<uuid:identifier>")
-def status(identifier: uuid.UUID) -> ResponseReturnValue:
- """
- Display the verification status of a received Webmention.
-
- :param identifier: Identifier of the Webmention to display.
- :return: Rendered Webmention status page.
- """
- webmention = db.session.get(ReceivedWebmention, identifier)
-
- if webmention is None:
- return abort(404)
-
- return render_template(
- "status.html", title="Webmention status", webmention=webmention
- )