aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/forms
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--webmentions_ssg/forms/sources.py81
1 files changed, 81 insertions, 0 deletions
diff --git a/webmentions_ssg/forms/sources.py b/webmentions_ssg/forms/sources.py
new file mode 100644
index 0000000..04afe77
--- /dev/null
+++ b/webmentions_ssg/forms/sources.py
@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""Source document filtering form."""
+
+from flask import current_app
+from flask_wtf import FlaskForm
+from wtforms import (
+ DateField,
+ HiddenField,
+ IntegerField,
+ SearchField,
+ SelectField,
+ ValidationError,
+)
+from wtforms.validators import AnyOf, NumberRange, Optional
+
+from .validators import CanonicalDate
+
+SOURCE_STATUS_CHOICES = {
+ "": "All sources",
+ "failing": "Failing sends",
+ "retrying": "Awaiting retry",
+ "deleted": "Deleted sources",
+}
+
+
+def default_source_page_size() -> int:
+ """Use 25 rows unless the configured maximum is lower."""
+ return min(25, current_app.config["SOURCES_MAX_PAGE_SIZE"])
+
+
+class SourceFilterForm(FlaskForm):
+ """GET filters for the source document list."""
+
+ status = SelectField("Status", choices=SOURCE_STATUS_CHOICES, default="")
+ q = SearchField("Path or URL")
+ date_from = DateField(
+ "Last seen from (UTC)", validators=[Optional(), CanonicalDate()]
+ )
+ date_to = DateField("Last seen to (UTC)", validators=[Optional(), CanonicalDate()])
+ sort = HiddenField(
+ default="last_seen",
+ validators=[
+ AnyOf(
+ (
+ "path",
+ "url",
+ "webmentions",
+ "revision",
+ "created",
+ "last_seen",
+ "status",
+ )
+ )
+ ],
+ )
+ order = HiddenField(default="desc", validators=[AnyOf(("asc", "desc"))])
+ per_page = IntegerField(
+ "Rows per page",
+ default=default_source_page_size,
+ validators=[NumberRange(min=1)],
+ )
+
+ def validate_per_page(self, field: IntegerField) -> None:
+ """Enforce the deployment's maximum source-list page size."""
+ if (
+ field.data is not None
+ and field.data > current_app.config["SOURCES_MAX_PAGE_SIZE"]
+ ):
+ raise ValidationError("Rows per page exceeds the configured maximum.")
+
+ def validate_date_to(self, field: DateField) -> None:
+ """Require an end date on or after the start date."""
+ if (
+ self.date_from.data is not None
+ and field.data is not None
+ and field.data < self.date_from.data
+ ):
+ raise ValidationError("End date must be on or after start date.")