forked from Github-Mirrors/canaille
451 lines
13 KiB
Python
451 lines
13 KiB
Python
import wtforms.form
|
|
import wtforms.validators
|
|
from flask import current_app
|
|
from flask import g
|
|
from flask_wtf.file import FileAllowed
|
|
from flask_wtf.file import FileField
|
|
|
|
from canaille.app import models
|
|
from canaille.app.forms import BaseForm
|
|
from canaille.app.forms import DateTimeUTCField
|
|
from canaille.app.forms import Form
|
|
from canaille.app.forms import IDToModel
|
|
from canaille.app.forms import email_validator
|
|
from canaille.app.forms import is_uri
|
|
from canaille.app.forms import phone_number
|
|
from canaille.app.forms import set_readonly
|
|
from canaille.app.forms import unique_values
|
|
from canaille.app.i18n import lazy_gettext as _
|
|
from canaille.app.i18n import native_language_name_from_code
|
|
from canaille.backends import BaseBackend
|
|
|
|
MINIMUM_PASSWORD_LENGTH = 8
|
|
|
|
|
|
def unique_user_name(form, field):
|
|
if models.User.get(user_name=field.data) and (
|
|
not getattr(form, "user", None) or form.user.user_name != field.data
|
|
):
|
|
raise wtforms.ValidationError(
|
|
_("The user name '{user_name}' already exists").format(user_name=field.data)
|
|
)
|
|
|
|
|
|
def unique_email(form, field):
|
|
if models.User.get(emails=field.data) and (
|
|
not getattr(form, "user", None) or field.data not in form.user.emails
|
|
):
|
|
raise wtforms.ValidationError(
|
|
_("The email '{email}' is already used").format(email=field.data)
|
|
)
|
|
|
|
|
|
def unique_group(form, field):
|
|
if models.Group.get(display_name=field.data):
|
|
raise wtforms.ValidationError(
|
|
_("The group '{group}' already exists").format(group=field.data)
|
|
)
|
|
|
|
|
|
def existing_login(form, field):
|
|
if not current_app.config["CANAILLE"][
|
|
"HIDE_INVALID_LOGINS"
|
|
] and not BaseBackend.get().get_user_from_login(field.data):
|
|
raise wtforms.ValidationError(
|
|
_("The login '{login}' does not exist").format(login=field.data)
|
|
)
|
|
|
|
|
|
def non_empty_groups(form, field):
|
|
"""LDAP groups cannot be empty because groupOfNames.member is a MUST
|
|
attribute.
|
|
|
|
https://www.rfc-editor.org/rfc/rfc2256.html#section-7.10
|
|
"""
|
|
if not form.user:
|
|
return
|
|
|
|
for group in form.user.groups:
|
|
if len(group.members) == 1 and group not in field.data:
|
|
raise wtforms.ValidationError(
|
|
_(
|
|
"The group '{group}' cannot be removed, because it must have at least one user left."
|
|
).format(group=group.display_name)
|
|
)
|
|
|
|
|
|
class LoginForm(Form):
|
|
login = wtforms.StringField(
|
|
_("Login"),
|
|
validators=[wtforms.validators.DataRequired(), existing_login],
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
"inputmode": "email",
|
|
},
|
|
)
|
|
|
|
|
|
class PasswordForm(Form):
|
|
password = wtforms.PasswordField(
|
|
_("Password"),
|
|
validators=[wtforms.validators.DataRequired()],
|
|
render_kw={
|
|
"autocomplete": "current-password",
|
|
},
|
|
)
|
|
|
|
|
|
class ForgottenPasswordForm(Form):
|
|
login = wtforms.StringField(
|
|
_("Login"),
|
|
validators=[wtforms.validators.DataRequired(), existing_login],
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
)
|
|
|
|
|
|
class PasswordResetForm(Form):
|
|
password = wtforms.PasswordField(
|
|
_("Password"),
|
|
validators=[wtforms.validators.DataRequired()],
|
|
render_kw={
|
|
"autocomplete": "new-password",
|
|
},
|
|
)
|
|
confirmation = wtforms.PasswordField(
|
|
_("Password confirmation"),
|
|
validators=[
|
|
wtforms.validators.EqualTo(
|
|
"password", _("Password and confirmation do not match.")
|
|
),
|
|
],
|
|
render_kw={
|
|
"autocomplete": "new-password",
|
|
},
|
|
)
|
|
|
|
|
|
class FirstLoginForm(Form):
|
|
pass
|
|
|
|
|
|
def available_language_choices():
|
|
languages = [
|
|
(lang_code, native_language_name_from_code(lang_code))
|
|
for lang_code in g.available_language_codes
|
|
]
|
|
languages.sort()
|
|
return [("auto", _("Automatic"))] + languages
|
|
|
|
|
|
PROFILE_FORM_FIELDS = dict(
|
|
user_name=wtforms.StringField(
|
|
_("Username"),
|
|
render_kw={"placeholder": _("jdoe")},
|
|
validators=[wtforms.validators.DataRequired(), unique_user_name],
|
|
),
|
|
formatted_name=wtforms.StringField(_("Name")),
|
|
title=wtforms.StringField(
|
|
_("Title"), render_kw={"placeholder": _("Vice president")}
|
|
),
|
|
given_name=wtforms.StringField(
|
|
_("Given name"),
|
|
render_kw={
|
|
"placeholder": _("John"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
),
|
|
family_name=wtforms.StringField(
|
|
_("Family Name"),
|
|
validators=[wtforms.validators.DataRequired()],
|
|
render_kw={
|
|
"placeholder": _("Doe"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
),
|
|
display_name=wtforms.StringField(
|
|
_("Display Name"),
|
|
validators=[wtforms.validators.Optional()],
|
|
render_kw={
|
|
"placeholder": _("Johnny"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
),
|
|
emails=wtforms.FieldList(
|
|
wtforms.EmailField(
|
|
_("Email addresses"),
|
|
validators=[
|
|
wtforms.validators.DataRequired(),
|
|
email_validator,
|
|
unique_email,
|
|
],
|
|
description=_(
|
|
"This email will be used as a recovery address to reset the password if needed"
|
|
),
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
),
|
|
min_entries=1,
|
|
validators=[unique_values],
|
|
),
|
|
phone_numbers=wtforms.FieldList(
|
|
wtforms.TelField(
|
|
_("Phone numbers"),
|
|
render_kw={"placeholder": _("555-000-555")},
|
|
validators=[wtforms.validators.Optional(), phone_number],
|
|
),
|
|
min_entries=1,
|
|
validators=[unique_values],
|
|
),
|
|
formatted_address=wtforms.StringField(
|
|
_("Address"),
|
|
render_kw={
|
|
"placeholder": _("132, Foobar Street, Gotham City 12401, XX"),
|
|
},
|
|
),
|
|
street=wtforms.StringField(
|
|
_("Street"),
|
|
render_kw={
|
|
"placeholder": _("132, Foobar Street"),
|
|
},
|
|
),
|
|
postal_code=wtforms.StringField(
|
|
_("Postal Code"),
|
|
render_kw={
|
|
"placeholder": "12401",
|
|
},
|
|
),
|
|
locality=wtforms.StringField(
|
|
_("Locality"),
|
|
render_kw={
|
|
"placeholder": _("Gotham City"),
|
|
},
|
|
),
|
|
region=wtforms.StringField(
|
|
_("Region"),
|
|
render_kw={
|
|
"placeholder": _("North Pole"),
|
|
},
|
|
),
|
|
photo=FileField(
|
|
_("Photo"),
|
|
validators=[FileAllowed(["jpg", "jpeg"])],
|
|
render_kw={"accept": "image/jpg, image/jpeg"},
|
|
),
|
|
photo_delete=wtforms.BooleanField(_("Delete the photo")),
|
|
password1=wtforms.PasswordField(
|
|
_("Password"),
|
|
validators=[
|
|
wtforms.validators.Optional(),
|
|
wtforms.validators.Length(min=MINIMUM_PASSWORD_LENGTH),
|
|
],
|
|
render_kw={
|
|
"autocomplete": "new-password",
|
|
},
|
|
),
|
|
password2=wtforms.PasswordField(
|
|
_("Password confirmation"),
|
|
validators=[
|
|
wtforms.validators.EqualTo(
|
|
"password1", message=_("Password and confirmation do not match.")
|
|
)
|
|
],
|
|
render_kw={
|
|
"autocomplete": "new-password",
|
|
},
|
|
),
|
|
employee_number=wtforms.StringField(
|
|
_("User number"),
|
|
render_kw={
|
|
"placeholder": _("1234"),
|
|
},
|
|
),
|
|
department=wtforms.StringField(
|
|
_("Department"),
|
|
render_kw={
|
|
"placeholder": _("1234"),
|
|
},
|
|
),
|
|
organization=wtforms.StringField(
|
|
_("Organization"),
|
|
render_kw={
|
|
"placeholder": _("Cogip LTD."),
|
|
},
|
|
),
|
|
profile_url=wtforms.URLField(
|
|
_("Website"),
|
|
render_kw={
|
|
"placeholder": _("https://mywebsite.tld"),
|
|
},
|
|
validators=[wtforms.validators.Optional(), is_uri],
|
|
),
|
|
preferred_language=wtforms.SelectField(
|
|
_("Preferred language"),
|
|
choices=available_language_choices,
|
|
),
|
|
groups=wtforms.SelectMultipleField(
|
|
_("Groups"),
|
|
default=[],
|
|
choices=lambda: [(group, group.display_name) for group in models.Group.query()],
|
|
render_kw={"placeholder": _("users, admins …")},
|
|
coerce=IDToModel("Group"),
|
|
validators=[non_empty_groups],
|
|
),
|
|
)
|
|
|
|
|
|
def build_profile_form(write_field_names, readonly_field_names, user=None):
|
|
if "password" in write_field_names:
|
|
write_field_names |= {"password1", "password2"}
|
|
|
|
if "photo" in write_field_names:
|
|
write_field_names |= {"photo_delete"}
|
|
|
|
fields = {
|
|
name: PROFILE_FORM_FIELDS.get(name)
|
|
for name in write_field_names | readonly_field_names
|
|
if PROFILE_FORM_FIELDS.get(name)
|
|
}
|
|
|
|
if "groups" in fields and not models.Group.query():
|
|
del fields["groups"]
|
|
|
|
if current_app.backend.get().has_account_lockability(): # pragma: no branch
|
|
fields["lock_date"] = DateTimeUTCField(
|
|
_("Account expiration"),
|
|
validators=[wtforms.validators.Optional()],
|
|
format=[
|
|
"%Y-%m-%d %H:%M",
|
|
"%Y-%m-%dT%H:%M",
|
|
"%Y-%m-%d %H:%M:%S",
|
|
"%Y-%m-%dT%H:%M:%S",
|
|
],
|
|
)
|
|
|
|
form = BaseForm(fields)
|
|
form.user = user
|
|
for field in form:
|
|
if field.name in readonly_field_names - write_field_names:
|
|
set_readonly(field)
|
|
|
|
return form
|
|
|
|
|
|
class CreateGroupForm(Form):
|
|
display_name = wtforms.StringField(
|
|
_("Name"),
|
|
validators=[wtforms.validators.DataRequired(), unique_group],
|
|
render_kw={
|
|
"placeholder": _("group"),
|
|
},
|
|
)
|
|
description = wtforms.StringField(
|
|
_("Description"),
|
|
validators=[wtforms.validators.Optional()],
|
|
)
|
|
|
|
|
|
class EditGroupForm(Form):
|
|
display_name = wtforms.StringField(
|
|
_("Name"),
|
|
validators=[
|
|
wtforms.validators.DataRequired(),
|
|
wtforms.validators.ReadOnly(),
|
|
],
|
|
render_kw={
|
|
"readonly": "true",
|
|
},
|
|
)
|
|
description = wtforms.StringField(
|
|
_("Description"),
|
|
validators=[wtforms.validators.Optional()],
|
|
)
|
|
|
|
|
|
class JoinForm(Form):
|
|
email = wtforms.EmailField(
|
|
_("Email address"),
|
|
validators=[
|
|
wtforms.validators.DataRequired(),
|
|
email_validator,
|
|
],
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
)
|
|
|
|
def validate_email(form, field):
|
|
if not current_app.config["CANAILLE"]["HIDE_INVALID_LOGINS"]:
|
|
unique_email(form, field)
|
|
|
|
|
|
class InvitationForm(Form):
|
|
user_name = wtforms.StringField(
|
|
_("User name"),
|
|
render_kw={"placeholder": _("jdoe")},
|
|
validators=[wtforms.validators.DataRequired(), unique_user_name],
|
|
)
|
|
user_name_editable = wtforms.BooleanField(_("Username editable by the invitee"))
|
|
email = wtforms.EmailField(
|
|
_("Email address"),
|
|
validators=[
|
|
wtforms.validators.DataRequired(),
|
|
email_validator,
|
|
unique_email,
|
|
],
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
)
|
|
groups = wtforms.SelectMultipleField(
|
|
_("Groups"),
|
|
choices=lambda: [(group, group.display_name) for group in models.Group.query()],
|
|
render_kw={},
|
|
coerce=IDToModel("Group"),
|
|
)
|
|
|
|
|
|
class EmailConfirmationForm(Form):
|
|
old_emails = wtforms.FieldList(
|
|
wtforms.EmailField(
|
|
validators=[wtforms.validators.ReadOnly()],
|
|
description=_(
|
|
"This email will be used as a recovery address to reset the password if needed"
|
|
),
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
"readonly": "true",
|
|
},
|
|
),
|
|
label=_("Email addresses"),
|
|
)
|
|
new_email = wtforms.EmailField(
|
|
_("New email address"),
|
|
validators=[
|
|
wtforms.validators.DataRequired(),
|
|
email_validator,
|
|
unique_email,
|
|
],
|
|
render_kw={
|
|
"placeholder": _("jane@doe.com"),
|
|
"spellcheck": "false",
|
|
"autocorrect": "off",
|
|
},
|
|
)
|