aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--webmentions_ssg/config.py2
-rw-r--r--webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py36
-rw-r--r--webmentions_ssg/models.py4
-rw-r--r--webmentions_ssg/tasks/consumer.py5
-rw-r--r--webmentions_ssg/tasks/notifications.py49
-rw-r--r--webmentions_ssg/tasks/receiver.py16
-rw-r--r--webmentions_ssg/views.py6
7 files changed, 88 insertions, 30 deletions
diff --git a/webmentions_ssg/config.py b/webmentions_ssg/config.py
index aea201b..010e393 100644
--- a/webmentions_ssg/config.py
+++ b/webmentions_ssg/config.py
@@ -24,7 +24,9 @@ class DefaultConfig:
SOURCE_DIRECTORY = None
SOURCE_BASE_URL = None
SCANNER_SCHEDULE = "0 * * * *"
+
NOTIFICATION_EMAIL = None
+ NOTIFICATION_SCHEDULE = "0 8 * * *"
MAIL_SERVER = "localhost"
MAIL_PORT = 25
diff --git a/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py b/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py
new file mode 100644
index 0000000..905b2c2
--- /dev/null
+++ b/webmentions_ssg/migrations/versions/408fc2eca9ce_track_webmention_digest_notifications.py
@@ -0,0 +1,36 @@
+"""Track webmention digest notifications
+
+Revision ID: 408fc2eca9ce
+Revises: be6e229d6a3d
+Create Date: 2026-10-29 20:24:42.008723
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "408fc2eca9ce"
+down_revision = "be6e229d6a3d"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ with op.batch_alter_table("received_webmentions", schema=None) as batch_op:
+ batch_op.add_column(
+ sa.Column("notification_sent_at", sa.DateTime(timezone=True), nullable=True)
+ )
+ op.execute(
+ "UPDATE received_webmentions SET notification_sent_at = CURRENT_TIMESTAMP"
+ )
+ # ### end Alembic commands ###
+
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ with op.batch_alter_table("received_webmentions", schema=None) as batch_op:
+ batch_op.drop_column("notification_sent_at")
+
+ # ### end Alembic commands ###
diff --git a/webmentions_ssg/models.py b/webmentions_ssg/models.py
index 688da67..11740a8 100644
--- a/webmentions_ssg/models.py
+++ b/webmentions_ssg/models.py
@@ -110,6 +110,10 @@ class ReceivedWebmention(Base):
nullable=False,
)
+ notification_sent_at: Mapped[datetime | None] = mapped_column(
+ DateTime(timezone=True), nullable=True, default=None
+ )
+
__table_args__ = (
UniqueConstraint("source", "target", name="uq_webmention_source_target"),
)
diff --git a/webmentions_ssg/tasks/consumer.py b/webmentions_ssg/tasks/consumer.py
index 4dd10c7..559ef5d 100644
--- a/webmentions_ssg/tasks/consumer.py
+++ b/webmentions_ssg/tasks/consumer.py
@@ -26,6 +26,11 @@ def create_consumer() -> Huey:
schedule = crontab(*app.config["SCANNER_SCHEDULE"].split(), strict=True)
HUEY.periodic_task(schedule)(scanner.scan_sources)
+ notification_schedule = crontab(
+ *app.config["NOTIFICATION_SCHEDULE"].split(), strict=True
+ )
+ HUEY.periodic_task(notification_schedule)(notifications.send_webmention_digest)
+
return HUEY.huey
diff --git a/webmentions_ssg/tasks/notifications.py b/webmentions_ssg/tasks/notifications.py
index d2195b0..475fad1 100644
--- a/webmentions_ssg/tasks/notifications.py
+++ b/webmentions_ssg/tasks/notifications.py
@@ -2,10 +2,11 @@
#
# SPDX-License-Identifier: BSD-3-Clause
-"""Send email notifications for verified incoming Webmentions."""
+"""Send bounded digest notifications for verified incoming Webmentions."""
-import uuid
+from datetime import UTC, datetime
+import sqlalchemy as sa
from flask import current_app
from flask_mail import Message
@@ -15,24 +16,50 @@ from .. import MAIL as mail
from ..models import ReceivedWebmention
-@huey.task(retries=2, retry_delay=60)
-def send_webmention_notification(webmention_uuid: uuid.UUID) -> None:
- """Send an email when a received webmention has been verified."""
+@huey.lock_task("send-webmention-digest")
+def send_webmention_digest() -> None:
+ """Send one digest of verified, previously unreported Webmentions."""
+
recipient = current_app.config.get("NOTIFICATION_EMAIL")
if not recipient:
return
- webmention = db.session.get(ReceivedWebmention, webmention_uuid)
- if webmention is None or webmention.status != "verified":
+ cutoff = datetime.now(UTC)
+
+ conditions = (
+ ReceivedWebmention.status == "verified",
+ ReceivedWebmention.notification_sent_at.is_(None),
+ ReceivedWebmention.updated_at <= cutoff,
+ )
+
+ count = (
+ db.session.scalar(
+ sa.select(sa.func.count())
+ .select_from(ReceivedWebmention)
+ .where(*conditions)
+ )
+ or 0
+ )
+
+ if count == 0:
return
message = Message(
- subject="New verified webmention",
+ subject=f"Webmention digest: {count} new verified",
recipients=[recipient],
body=(
- "A received webmention has been verified.\n\n"
- f"Source: {webmention.source}\n"
- f"Target: {webmention.target}\n"
+ f"{count} new Webmentions have been verified.\n\n"
+ "Visit your Webmentions administration page to review them.\n"
),
)
+
+ # If SMTP fails, the records remain pending for the next digest.
mail.send(message)
+
+ db.session.execute(
+ sa.update(ReceivedWebmention)
+ .where(*conditions)
+ .values(notification_sent_at=cutoff)
+ .execution_options(synchronize_session="fetch")
+ )
+ db.session.commit()
diff --git a/webmentions_ssg/tasks/receiver.py b/webmentions_ssg/tasks/receiver.py
index 0b7743d..2bb7222 100644
--- a/webmentions_ssg/tasks/receiver.py
+++ b/webmentions_ssg/tasks/receiver.py
@@ -17,7 +17,6 @@ from .. import DATABASE as db
from .. import HUEY as huey
from ..models import ReceivedWebmention
from ..url_security import AddressResolutionError, is_public_url
-from .notifications import send_webmention_notification
class VerificationError(Exception):
@@ -217,9 +216,7 @@ def source_mentions_target(source_url: str, target_url: str) -> bool:
@huey.task(retries=2, retry_delay=50)
-def verify_webmention(
- webmention_uuid: uuid.UUID, send_notification: bool = True
-) -> None:
+def verify_webmention(webmention_uuid: uuid.UUID) -> None:
"""
Verify a received webmention and store its verification status.
@@ -227,8 +224,6 @@ def verify_webmention(
retry the task.
:param webmention_uuid: Identifier of the received webmention to verify.
- :param send_notification: Whether to enqueue an email notification after
- successful verification.
:raises TemporaryFetchError: If fetching the source fails temporarily.
:raises httpx.RequestError: If an HTTP request error occurs while fetching
the source.
@@ -270,12 +265,3 @@ def verify_webmention(
webmention.failure_reason = "Source does not mention target"
db.session.commit()
-
- if send_notification:
- try:
- send_webmention_notification(webmention_uuid)
- except Exception:
- # Notification delivery must not change the persisted verification status.
- current_app.logger.exception(
- "Could not enqueue webmention notification for %s", webmention_uuid
- )
diff --git a/webmentions_ssg/views.py b/webmentions_ssg/views.py
index bb1f38a..7a97480 100644
--- a/webmentions_ssg/views.py
+++ b/webmentions_ssg/views.py
@@ -170,7 +170,7 @@ def reverify_received_webmention(identifier: uuid.UUID) -> ResponseReturnValue:
db.session.commit()
- verify_webmention(identifier, send_notification=False)
+ verify_webmention(identifier)
flash(f"Webmention {webmention.uuid} queued for reverification.", "success")
@@ -327,7 +327,6 @@ def endpoint() -> ResponseReturnValue:
).scalar_one_or_none()
should_verify = False
- send_notification = False
if webmention is None:
identifier = uuid.uuid7()
@@ -339,7 +338,6 @@ def endpoint() -> ResponseReturnValue:
try:
db.session.commit()
should_verify = True
- send_notification = True
except sa_exc.IntegrityError:
db.session.rollback()
@@ -377,7 +375,7 @@ def endpoint() -> ResponseReturnValue:
identifier = webmention.uuid
if should_verify:
- verify_webmention(identifier, send_notification=send_notification)
+ verify_webmention(identifier)
status_url = url_for("root.status", identifier=str(identifier), _external=True)