Source code for org.forms.settings
import datetime
import json
import re
import yaml
from functools import cached_property
from lxml import etree
from onegov.core.widgets import transform_structure
from onegov.core.widgets import XML_LINE_OFFSET
from onegov.form import Form
from onegov.form.fields import ChosenSelectField
from onegov.form.fields import ColorField
from onegov.form.fields import CssField
from onegov.form.fields import MarkupField
from onegov.form.fields import MultiCheckboxField
from onegov.form.fields import PreviewField
from onegov.form.fields import TagsField
from onegov.gever.encrypt import encrypt_symmetric
from onegov.gis import CoordinatesField
from onegov.org import _
from onegov.org.forms.fields import (HtmlField,
UploadOrSelectExistingMultipleFilesField)
from onegov.org.forms.user import AVAILABLE_ROLES
from onegov.org.forms.util import TIMESPANS
from onegov.org.theme import user_options
from onegov.ticket import handlers
from onegov.ticket import TicketPermission
from onegov.user import User
from purl import URL
from wtforms.fields import BooleanField
from wtforms.fields import EmailField
from wtforms.fields import FloatField
from wtforms.fields import IntegerField
from wtforms.fields import PasswordField
from wtforms.fields import RadioField
from wtforms.fields import StringField
from wtforms.fields import TextAreaField
from wtforms.fields import URLField
from wtforms.validators import InputRequired
from wtforms.validators import NumberRange
from wtforms.validators import Optional
from wtforms.validators import URL as UrlRequired
from wtforms.validators import ValidationError
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import Sequence
from onegov.org.models import Organisation
from onegov.org.request import OrgRequest
from onegov.org.theme import OrgTheme
from webob import Response
from wtforms import Field
from wtforms.fields.choices import _Choice
[docs]
class GeneralSettingsForm(Form):
""" Defines the settings form for onegov org. """
if TYPE_CHECKING:
[docs]
logo_url = StringField(
label=_('Logo'),
description=_('URL pointing to the logo'),
render_kw={'class_': 'image-url'})
[docs]
square_logo_url = StringField(
label=_('Logo (Square)'),
description=_('URL pointing to the logo'),
render_kw={'class_': 'image-url'})
[docs]
reply_to = EmailField(
_('E-Mail Reply Address (Reply-To)'), [InputRequired()],
description=_('Replies to automated e-mails go to this address.'))
[docs]
font_family_sans_serif = ChosenSelectField(
label=_('Default Font Family'),
choices=[],
validators=[InputRequired()]
)
[docs]
locales = RadioField(
label=_('Languages'),
choices=(
('de_CH', _('German')),
('fr_CH', _('French')),
('it_CH', _('Italian'))
),
validators=[InputRequired()]
)
[docs]
standard_image = StringField(
description=_(
'Will be used if an image is needed, but none has been set'),
fieldset=_('Images'),
label=_('Standard Image'),
render_kw={'class_': 'image-url'}
)
@property
[docs]
def theme_options(self) -> dict[str, Any]:
options = self.model.theme_options
if self.primary_color.data is None:
options['primary-color'] = user_options['primary-color']
else:
options['primary-color'] = self.primary_color.data
font_family = self.font_family_sans_serif.data
if font_family not in self.theme.font_families.values():
options['font-family-sans-serif'] = self.default_font_family
else:
options['font-family-sans-serif'] = font_family
# override the options using the default values if no value was given
for key in options:
if not options[key]:
options[key] = user_options[key]
return options
@theme_options.setter
def theme_options(self, options: dict[str, Any]) -> None:
self.primary_color.data = options.get('primary-color')
self.font_family_sans_serif.data = options.get(
'font-family-sans-serif') or self.default_font_family
@cached_property
@property
[docs]
def default_font_family(self) -> str | None:
return self.theme.default_options.get('font-family-sans-serif')
[docs]
def populate_obj(self, model: 'Organisation') -> None: # type:ignore
super().populate_obj(model)
model.theme_options = self.theme_options
model.custom_css = self.custom_css.data or ''
[docs]
def process_obj(self, model: 'Organisation') -> None: # type:ignore
super().process_obj(model)
self.theme_options = model.theme_options or {}
self.custom_css.data = model.custom_css or ''
[docs]
def populate_font_families(self) -> None:
self.font_family_sans_serif.choices = [
(value, label) for label, value in self.theme.font_families.items()
]
[docs]
def on_request(self) -> None:
self.populate_font_families()
@self.request.after
def clear_locale(response: 'Response') -> None:
response.delete_cookie('locale')
[docs]
class SocialMediaSettingsForm(Form):
[docs]
og_logo_default = StringField(
label=_('Image'),
description=_('Default social media preview image for rich link '
'previews. Optimal size is 1200:630 px.'),
fieldset='OpenGraph',
render_kw={'class_': 'image-url'}
)
[docs]
class FaviconSettingsForm(Form):
[docs]
favicon_win_url = StringField(
label=_('Icon 16x16 PNG (Windows)'),
description=_('URL pointing to the icon'),
render_kw={'class_': 'image-url'},
)
[docs]
favicon_mac_url = StringField(
label=_('Icon 32x32 PNG (Mac)'),
description=_('URL pointing to the icon'),
render_kw={'class_': 'image-url'},
)
[docs]
favicon_apple_touch_url = StringField(
label=_('Icon 57x57 PNG (iPhone, iPod, iPad)'),
description=_('URL pointing to the icon'),
render_kw={'class_': 'image-url'},
)
[docs]
favicon_pinned_tab_safari_url = StringField(
label=_('Icon SVG 20x20 (Safari)'),
description=_('URL pointing to the icon'),
render_kw={'class_': 'image-url'},
)
[docs]
class LinksSettingsForm(Form):
[docs]
disable_page_refs = BooleanField(
label=_('Disable page references'),
description=_(
"Disable showing the copy link '#' for the site reference. "
"The references themselves will still work. "
"Those references are only showed for logged in users.")
)
[docs]
class HeaderSettingsForm(Form):
[docs]
announcement_bg_color = ColorField(
label=_('Announcement bg color'),
fieldset=_('Announcement')
)
[docs]
announcement_font_color = ColorField(
label=_('Announcement font color'),
fieldset=_('Announcement')
)
[docs]
announcement_is_private = BooleanField(
label=_('Only show Announcement for logged-in users'),
fieldset=_('Announcement')
)
[docs]
header_links = StringField(
label=_('Header links'),
fieldset=_('Header links'),
render_kw={'class_': 'many many-links'}
)
[docs]
left_header_name = StringField(
label=_('Text'),
description=_(''),
fieldset=_('Text header left side')
)
[docs]
left_header_url = URLField(
label=_('URL'),
description=_('Optional'),
fieldset=_('Text header left side'),
validators=[UrlRequired(), Optional()]
)
[docs]
left_header_rem = FloatField(
label=_('Relative font size'),
fieldset=_('Text header left side'),
validators=[
NumberRange(0.5, 7)
],
default=1
)
[docs]
header_additions_fixed = BooleanField(
label=_(
'Keep header links and/or header text fixed to top on scrolling'),
fieldset=_('Header fixation')
)
@property
[docs]
def header_options(self) -> dict[str, Any]:
return {
'header_links': self.json_to_links(self.header_links.data) or None,
'left_header_name': self.left_header_name.data or None,
'left_header_url': self.left_header_url.data or None,
'left_header_color': self.left_header_color.data,
'left_header_rem': self.left_header_rem.data,
'announcement': self.announcement.data,
'announcement_url': self.announcement_url.data,
'announcement_bg_color': self.announcement_bg_color.data,
'announcement_font_color':
self.announcement_font_color.data,
'announcement_is_private': self.announcement_is_private.data,
'header_additions_fixed': self.header_additions_fixed.data
}
@header_options.setter
def header_options(self, options: dict[str, Any]) -> None:
if not options.get('header_links'):
self.header_links.data = self.links_to_json(None)
else:
self.header_links.data = self.links_to_json(
options.get('header_links')
)
self.left_header_name.data = options.get('left_header_name')
self.left_header_url.data = options.get('left_header_url')
self.left_header_color.data = options.get(
'left_header_color', '#000000'
)
self.left_header_rem.data = options.get('left_header_rem', 1)
self.announcement.data = options.get('announcement', '')
self.announcement_url.data = options.get('announcement_url', '')
self.announcement_bg_color.data = options.get(
'announcement_bg_color', '#FBBC05')
self.announcement_font_color.data = options.get(
'announcement_font_color', '#000000')
self.announcement_is_private.data = options.get(
'announcement_is_private', '')
self.header_additions_fixed.data = options.get(
'header_additions_fixed', '')
if TYPE_CHECKING:
else:
def __init__(self, *args, **kwargs) -> None:
super().__init__(*args, **kwargs)
self.link_errors = {}
[docs]
def populate_obj(self, model: 'Organisation') -> None: # type:ignore
super().populate_obj(model)
model.header_options = self.header_options
[docs]
def process_obj(self, model: 'Organisation') -> None: # type:ignore
super().process_obj(model)
self.header_options = model.header_options or {}
[docs]
def validate_header_links(self, field: StringField) -> None:
for text, url in self.json_to_links(self.header_links.data):
if text and not url:
raise ValidationError(_('Please add an url to each link'))
if url and not re.match(r'^(http://|https://|/)', url):
raise ValidationError(
_('Your URLs must start with http://,'
' https:// or / (for internal links)')
)
[docs]
def json_to_links(
self,
text: str | None = None
) -> list[tuple[str | None, str | None]]:
if not text:
return []
return [
(value['text'], link)
for value in json.loads(text).get('values', [])
if (link := value['link']) or value['text']
]
[docs]
def links_to_json(
self,
header_links: 'Sequence[tuple[str | None, str | None]] | None' = None
) -> str:
header_links = header_links or []
return json.dumps({
'labels': {
'text': self.request.translate(_('Text')),
'link': self.request.translate(_('URL')),
'add': self.request.translate(_('Add')),
'remove': self.request.translate(_('Remove')),
},
'values': [
{
'text': l[0],
'link': l[1],
'error': self.link_errors.get(ix, '')
} for ix, l in enumerate(header_links)
]
})
[docs]
class HomepageSettingsForm(Form):
[docs]
homepage_structure = TextAreaField(
fieldset=_('Structure'),
label=_('Homepage Structure (for advanced users only)'),
description=_('The structure of the homepage'),
render_kw={'rows': 32, 'data-editor': 'xml'})
# see homepage.py
[docs]
redirect_homepage_to = RadioField(
label=_('Homepage redirect'),
default='no',
choices=[
('no', _('No')),
('directories', _('Yes, to directories')),
('events', _('Yes, to events')),
('forms', _('Yes, to forms')),
('publications', _('Yes, to publications')),
('reservations', _('Yes, to reservations')),
('path', _('Yes, to a non-listed path')),
])
[docs]
redirect_path = StringField(
label=_('Path'),
validators=[InputRequired()],
depends_on=('redirect_homepage_to', 'path'))
[docs]
def validate_redirect_path(self, field: StringField) -> None:
if not field.data:
return
url = URL(field.data)
if url.scheme() or url.host():
raise ValidationError(
_('Please enter a path without schema or host'))
[docs]
def validate_homepage_structure(self, field: TextAreaField) -> None:
if field.data:
try:
registry = self.request.app.config.homepage_widget_registry
widgets = registry.values()
transform_structure(widgets, field.data)
except etree.XMLSyntaxError as exception:
correct_line = exception.position[0] - XML_LINE_OFFSET
correct_msg = 'line {}'.format(correct_line)
correct_msg = ERROR_LINE_RE.sub(correct_msg, exception.msg)
field.render_kw = field.render_kw or {}
field.render_kw['data-highlight-line'] = correct_line
raise ValidationError(correct_msg) from exception
[docs]
class ModuleSettingsForm(Form):
[docs]
mtan_session_duration_seconds = IntegerField(
label=_('Duration of mTAN session'),
description=_('Specify in number of seconds'),
fieldset=_('mTAN Access'),
validators=[Optional()]
)
[docs]
mtan_access_window_requests = IntegerField(
label=_(
'Prevent further accesses to protected resources '
'after this many have been accessed'
),
description=_('Leave empty to disable limiting requests'),
fieldset=_('mTAN Access'),
validators=[Optional()]
)
[docs]
mtan_access_window_seconds = IntegerField(
label=_(
'Prevent further accesses to protected resources '
'in this time frame'
),
description=_('Specify in number of seconds'),
fieldset=_('mTAN Access'),
validators=[Optional()]
)
[docs]
class MapSettingsForm(Form):
[docs]
default_map_view = CoordinatesField(
label=_('The default map view. This should show the whole town'),
render_kw={
'data-map-type': 'crosshair'
})
[docs]
geo_provider = RadioField(
label=_('Geo provider'),
default='geo-mapbox',
choices=[
('geo-admin', _('Swisstopo (Default)')),
('geo-admin-aerial', _('Swisstopo Aerial')),
('geo-mapbox', 'Mapbox'),
('geo-vermessungsamt-winterthur', 'Vermessungsamt Winterthur'),
('geo-zugmap-basisplan', 'ZugMap Basisplan Farbig'),
('geo-zugmap-orthofoto', 'ZugMap Orthofoto'),
('geo-bs', 'Geoportal Basel-Stadt'),
])
[docs]
class AnalyticsSettingsForm(Form):
[docs]
analytics_code = MarkupField(
label=_('Analytics Code'),
description=_('JavaScript for web statistics support'),
render_kw={'rows': 10, 'data-editor': 'html'})
[docs]
class HolidaySettingsForm(Form):
[docs]
cantonal_holidays = MultiCheckboxField(
label=_('Cantonal holidays'),
choices=[
('AG', _('Aargau')),
('AR', _('Appenzell Ausserrhoden')),
('AI', _('Appenzell Innerrhoden')),
('BL', _('Basel-Landschaft')),
('BS', _('Basel-Stadt')),
('BE', _('Berne')),
('FR', _('Fribourg')),
('GE', _('Geneva')),
('GL', _('Glarus')),
('GR', _('Grisons')),
('JU', _('Jura')),
('LU', _('Lucerne')),
('NE', _('Neuchâtel')),
('NW', _('Nidwalden')),
('OW', _('Obwalden')),
('SH', _('Schaffhausen')),
('SZ', _('Schwyz')),
('SO', _('Solothurn')),
('SG', _('St. Gallen')),
('TG', _('Thurgau')),
('TI', _('Ticino')),
('UR', _('Uri')),
('VS', _('Valais')),
('VD', _('Vaud')),
('ZG', _('Zug')),
('ZH', _('Zürich')),
])
[docs]
other_holidays = TextAreaField(
label=_('Other holidays'),
description=('31.10 - Halloween'),
render_kw={'rows': 10})
[docs]
preview = PreviewField(
label=_('Preview'),
fields=('cantonal_holidays', 'other_holidays'),
events=('change', 'click', 'enter'),
url=lambda meta: meta.request.link(
meta.request.app.org,
name='holiday-settings-preview'
))
[docs]
school_holidays = TextAreaField(
label=_('School holidays'),
description=('12.03.2022 - 21.03.2022'),
render_kw={'rows': 10})
[docs]
def validate_other_holidays(self, field: TextAreaField) -> None:
if not field.data:
return
for line in field.data.splitlines():
if not line.strip():
continue
if line.count('-') < 1:
raise ValidationError(_('Format: Day.Month - Description'))
if line.count('-') > 1:
raise ValidationError(_('Please enter one date per line'))
date, _description = line.split('-', 1)
if date.count('.') < 1:
raise ValidationError(_('Format: Day.Month - Description'))
if date.count('.') > 1:
raise ValidationError(_('Please enter only day and month'))
[docs]
def parse_date(self, date: str) -> datetime.date:
day, month, year = date.split('.', 2)
try:
return datetime.date(int(year), int(month), int(day))
except (ValueError, TypeError) as exception:
raise ValidationError(_(
'${date} is not a valid date',
mapping={'date': date}
)) from exception
[docs]
def validate_school_holidays(self, field: TextAreaField) -> None:
if not field.data:
return
for line in field.data.splitlines():
if not line.strip():
continue
if line.count('-') < 1:
raise ValidationError(
_('Format: Day.Month.Year - Day.Month.Year')
)
if line.count('-') > 1:
raise ValidationError(_('Please enter one date pair per line'))
start, end = line.split('-', 1)
if start.count('.') != 2:
raise ValidationError(
_('Format: Day.Month.Year - Day.Month.Year')
)
if end.count('.') != 2:
raise ValidationError(
_('Format: Day.Month.Year - Day.Month.Year')
)
start_date = self.parse_date(start)
end_date = self.parse_date(end)
if end_date <= start_date:
raise ValidationError(
_('End date needs to be after start date')
)
# FIXME: Use TypedDict?
@property
[docs]
def holiday_settings(self) -> dict[str, Any]:
def parse_other_holidays_line(line: str) -> tuple[int, int, str]:
date, desc = line.strip().split('-', 1)
day, month = date.split('.')
return int(month), int(day), desc.strip()
def parse_school_holidays_line(
line: str
) -> tuple[int, int, int, int, int, int]:
start, end = line.strip().split('-', 1)
start_day, start_month, start_year = start.split('.', 2)
end_day, end_month, end_year = end.split('.', 2)
return (
int(start_year), int(start_month), int(start_day),
int(end_year), int(end_month), int(end_day)
)
return {
'cantons': self.cantonal_holidays.data,
'school': (
parse_school_holidays_line(l)
for l in (self.school_holidays.data or '').splitlines()
if l.strip()
),
'other': (
parse_other_holidays_line(l)
for l in (self.other_holidays.data or '').splitlines()
if l.strip()
)
}
@holiday_settings.setter
def holiday_settings(self, data: dict[str, Any]) -> None:
data = data or {}
def format_other(d: tuple[int, int, str]) -> str:
return f'{d[1]:02d}.{d[0]:02d} - {d[2]}'
def format_school(d: tuple[int, int, int, int, int, int]) -> str:
return (
f'{d[2]:02d}.{d[1]:02d}.{d[0]:04d} - '
f'{d[5]:02d}.{d[4]:02d}.{d[3]:04d}'
)
self.cantonal_holidays.data = data.get(
'cantons', ())
self.other_holidays.data = '\n'.join(
format_other(d) for d in data.get('other', ()))
self.school_holidays.data = '\n'.join(
format_school(d) for d in data.get('school', ()))
[docs]
def populate_obj(self, model: 'Organisation') -> None: # type:ignore
model.holiday_settings = self.holiday_settings
[docs]
def process_obj(self, model: 'Organisation') -> None: # type:ignore
self.holiday_settings = model.holiday_settings
[docs]
class OrgTicketSettingsForm(Form):
[docs]
email_for_new_tickets = StringField(
label=_('Email adress for notifications '
'about newly opened tickets'),
description=('info@example.ch')
)
[docs]
ticket_auto_accept_style = RadioField(
label=_('Accept request and close ticket automatically based on:'),
choices=(
('category', _('Ticket category')),
('role', _('User role')),
),
default='category'
)
[docs]
ticket_auto_accepts = MultiCheckboxField(
label=_('Accept request and close ticket automatically '
'for these ticket categories'),
description=_("If auto-accepting is not possible, the ticket will be "
"in state pending. Also note, that after the ticket is "
"closed, the submitter can't send any messages."),
choices=[],
depends_on=('ticket_auto_accept_style', 'category')
)
[docs]
ticket_auto_accept_roles = MultiCheckboxField(
label=_('Accept request and close ticket automatically '
'for these user roles'),
description=_("If auto-accepting is not possible, the ticket will be "
"in state pending. Also note, that after the ticket is "
"closed, the submitter can't send any messages."),
choices=AVAILABLE_ROLES,
depends_on=('ticket_auto_accept_style', 'role')
)
[docs]
auto_closing_user = ChosenSelectField(
label=_('User used to auto-accept tickets'),
choices=[]
)
[docs]
tickets_skip_opening_email = MultiCheckboxField(
label=_('Block email confirmation when '
'this ticket category is opened'),
choices=[],
description=_('This is enabled by default for tickets that get '
'accepted automatically')
)
[docs]
tickets_skip_closing_email = MultiCheckboxField(
label=_('Block email confirmation when '
'this ticket category is closed'),
choices=[],
description=_('This is enabled by default for tickets that get '
'accepted automatically')
)
[docs]
ticket_always_notify = BooleanField(
label=_('Always send email notification '
'if a new ticket message is sent'),
default=True
)
[docs]
permissions = MultiCheckboxField(
label=_('Categories restricted by user group settings'),
choices=[],
render_kw={'disabled': True}
)
[docs]
def ensure_not_muted_and_auto_accept(self) -> bool | None:
if (
self.mute_all_tickets.data is True
and self.ticket_auto_accepts.data
):
assert isinstance(self.mute_all_tickets.errors, list)
self.mute_all_tickets.errors.append(
_('Mute tickets individually if the auto-accept feature is '
'enabled.')
)
return False
return None
[docs]
def code_title(self, code: str) -> str:
""" Renders a better translation for handler_codes.
Note that the registry of handler_codes is global and not all handlers
might are used in this app. The translations give a hint whether the
handler is used/defined in the app using this form.
A better translation is only then possible.
"""
trs = getattr(handlers.registry[code], 'code_title', None)
if not trs:
return code
translated = self.request.translate(trs)
if str(trs) == translated:
# Code not used by app
return code
return f'{code} - {translated}'
[docs]
def on_request(self) -> None:
choices: list[_Choice] = [
(key, self.code_title(key)) for key in handlers.registry.keys()
]
auto_accept_choices = ('RSV', 'FRM')
self.ticket_auto_accepts.choices = [
(key, self.code_title(key)) for key in auto_accept_choices
]
self.tickets_skip_opening_email.choices = choices
self.tickets_skip_closing_email.choices = choices
permissions: list[_Choice] = sorted((
(
p.id.hex,
': '.join(x for x in (p.handler_code, p.group) if x)
)
for p in self.request.session.query(TicketPermission)
), key=lambda x: x[1])
if not permissions:
self.delete_field('permissions')
else:
self.permissions.choices = permissions
self.permissions.default = [p[0] for p in permissions]
user_q = self.request.session.query(User).filter_by(role='admin')
user_q = user_q.order_by(User.created.desc())
self.auto_closing_user.choices = [
(u.username, u.title) for u in user_q
]
[docs]
class NewsletterSettingsForm(Form):
[docs]
secret_content_allowed = BooleanField(
label=_('Allow secret content in newsletter'),
default=False
)
[docs]
newsletter_categories = TextAreaField(
label=_('Newsletter categories'),
description=_(
'Example for newsletter topics with subtopics in yaml format. '
'Note: Deeper structures are not supported.'
'\n'
'```\n'
'Organisation:\n'
' - Topic 1:\n'
' - Subtopic 1.1\n'
' - Subtopic 1.2\n'
' - Topic 2\n'
' - Topic 3:\n'
' - Subtopic 3.1\n'
'```'
),
render_kw={
'rows': 16,
},
)
[docs]
def ensure_categories(self) -> bool | None:
assert isinstance(self.newsletter_categories.errors, list)
if self.newsletter_categories.data:
try:
data = yaml.safe_load(self.newsletter_categories.data)
except yaml.YAMLError:
self.newsletter_categories.errors.append(
_('Invalid YAML format. Please refer to the example.')
)
return False
if data:
if not isinstance(data, dict):
self.newsletter_categories.errors.append(
_('Invalid format. Please define an organisation name '
'with topics and subtopics according the example.')
)
return False
for items in data.values():
if not isinstance(items, list):
self.newsletter_categories.errors.append(
_('Invalid format. Please define topics and '
'subtopics according to the example.')
)
return False
for item in items:
if not isinstance(item, (dict, str)):
self.newsletter_categories.errors.append(
_('Invalid format. Please define topics and '
'subtopics according to the example.')
)
return False
if isinstance(item, dict):
for topic, sub_topic in item.items():
if not isinstance(sub_topic, list):
self.newsletter_categories.errors.append(
_(f'Invalid format. Please define '
f"subtopic(s) for '{topic}' "
f"or remove the ':'.")
)
return False
if not all(isinstance(sub, str)
for sub in sub_topic):
self.newsletter_categories.errors.append(
_('Invalid format. Only topics '
'and subtopics are allowed - no '
'deeper structures supported.')
)
return False
return None
[docs]
def populate_obj(self, model: 'Organisation') -> None: # type:ignore
super().populate_obj(model)
yaml_data = self.newsletter_categories.data
data = yaml.safe_load(yaml_data) if yaml_data else {}
model.newsletter_categories = data
[docs]
def process_obj(self, model: 'Organisation') -> None: # type:ignore
super().process_obj(model)
categories = model.newsletter_categories or {}
if not categories:
self.newsletter_categories.data = ''
return
yaml_data = yaml.safe_dump(categories, default_flow_style=False)
self.newsletter_categories.data = yaml_data
[docs]
class LinkMigrationForm(Form):
[docs]
old_domain = StringField(
label=_('Old domain'),
description='govikon.onegovcloud.ch',
validators=[InputRequired()]
)
[docs]
test = BooleanField(
label=_('Test migration'),
description=_('Compares links to the current domain'),
default=True
)
[docs]
def ensure_correct_domain(self) -> bool | None:
if self.old_domain.data:
errors = []
if self.old_domain.data.startswith('http'):
errors.append(
_('Use a domain name without http(s)')
)
if '.' not in self.old_domain.data:
errors.append(_('Domain must contain a dot'))
if errors:
self.old_domain.errors = errors
return False
return None
[docs]
class LinkHealthCheckForm(Form):
[docs]
scope = RadioField(
label=_('Choose which links to check'),
choices=(
('external', _('External links only')),
('internal', _('Internal links only')),
),
default='external'
)
[docs]
def validate_https(form: Form, field: 'Field') -> None:
if not field.data.startswith('https'):
raise ValidationError(_("Link must start with 'https'"))
[docs]
class GeverSettingsForm(Form):
if TYPE_CHECKING:
[docs]
gever_username = StringField(
_('Username'),
[InputRequired()],
description=_('Username for the associated Gever account'),
)
[docs]
gever_password = PasswordField(
_('Password'),
[InputRequired()],
description=_('Password for the associated Gever account'),
)
[docs]
gever_endpoint = URLField(
_('Gever API Endpoint where the documents are uploaded.'),
[InputRequired(), UrlRequired(), validate_https],
description=_('Website address including https://'),
)
[docs]
def populate_obj(self, model: 'Organisation') -> None: # type:ignore
super().populate_obj(model)
key_base64 = self.request.app.hashed_identity_key
try:
assert self.gever_password.data is not None
encrypted = encrypt_symmetric(self.gever_password.data, key_base64)
encrypted_str = encrypted.decode('utf-8')
model.gever_username = self.gever_username.data or ''
model.gever_password = encrypted_str or ''
except Exception:
model.gever_username = ''
model.gever_password = '' # nosec: B105
[docs]
def process_obj(self, model: 'Organisation') -> None: # type:ignore
super().process_obj(model)
self.gever_username.data = model.gever_username or ''
self.gever_password.data = model.gever_password or ''
[docs]
class OneGovApiSettingsForm(Form):
"""Provides a form to generate API keys (UUID'S) for the OneGov API."""
[docs]
class EventSettingsForm(Form):
[docs]
submit_events_visible = BooleanField(
label=_('Submit your event'),
description=_('Enables website visitors to submit their own events'),
default=True
)
[docs]
delete_past_events = BooleanField(
label=_('Delete events in the past'),
description=_('Events are automatically deleted once they have '
'occurred'),
default=False
)
[docs]
event_filter_type = RadioField(
label=_("Choose the filter type for events (default is 'Tags')"),
choices=(
('tags', _('A predefined set of tags')),
('filters', _('Manually configurable filters')),
('tags_and_filters', _('Both, predefined tags as well as '
'configurable filters')),
),
default='tags'
)
[docs]
event_files = UploadOrSelectExistingMultipleFilesField(
label=_('Documents'),
fieldset=_('General event documents')
)
[docs]
class DataRetentionPolicyForm(Form):
[docs]
auto_archive_timespan = RadioField(
label=_('Duration from opening a ticket to its automatic archival'),
validators=[InputRequired()],
default=0,
coerce=int,
choices=TIMESPANS
)
[docs]
auto_delete_timespan = RadioField(
label=_('Duration from archived state until deleted automatically'),
validators=[InputRequired()],
default=0,
coerce=int,
choices=TIMESPANS
)