Source code for pluserable.configuration

"""At startup pluserable validates its configuration settings."""

from bag.email_validator import DomainValidator
import colander as c
from kerno.typing import DictStr

domain_validator = DomainValidator()


class DomainsSchema(c.SchemaNode):
    """Colander schema that validates a list of domain names."""

    schema_type = c.String

    def validator(self, node, val):
        """Colander validator for a domain name."""
        # When reading an INI file a sequence comes as a single string.
        domains = val.split("\n") if isinstance(val, str) else val

        for domain in domains:
            domain, error = domain_validator.validate_domain(domain.strip())
            if error:
                raise c.Invalid(node, error)


class PluserableConfigSchema(c.MappingSchema):
    """Colander validation schema for the entire configuration dictionary.

    When using a INI configuration file, these settings are placed in
    the ``[pluserable]`` section.
    """

    autologin = c.SchemaNode(
        c.Bool(),
        missing=False,
        doc="Whether to log a user in directly after registration",
    )
    email_domains_blacklist = DomainsSchema(missing="")
    require_activation = c.SchemaNode(
        c.Bool(),
        missing=True,
        doc="If true, users can only log in after confirming their email address",
    )
    redis_url = c.SchemaNode(
        c.String(),
        missing="",
        doc="Prevents brute force. redis://username:password@localhost:6379/0",
    )
    seconds_after_login_fail = c.SchemaNode(
        c.Int(),
        missing=15,
        doc="Number of seconds a user must wait before trying login again",
        validator=c.Range(min=10),
    )

    deform_retail = c.SchemaNode(
        c.Bool(),
        missing=False,
        doc="Whether to enable retail rendering of deform forms",
    )

    activate_redirect = c.SchemaNode(
        c.String(),
        missing="index",
        doc="Route or URL after a user confirms their email",
    )
    forgot_password_redirect = c.SchemaNode(
        c.String(),
        missing="index",
        doc="Route or URL after a user fills the forgot password form",
    )
    login_redirect = c.SchemaNode(
        c.String(), missing="index", doc="Route or URL after a user logs in"
    )
    logout_redirect = c.SchemaNode(
        c.String(), missing="index", doc="Route or URL after a user logs out"
    )
    register_redirect = c.SchemaNode(
        c.String(),
        missing="index",
        doc="Route or URL after a user signs up for an account",
    )
    reset_password_redirect = c.SchemaNode(
        c.String(),
        missing="index",
        doc="Route or URL after a user resets their password",
    )


def validate_pluserable_config(adict: DictStr):
    """Validate pluserable settings and return a clean dictionary."""
    schema = PluserableConfigSchema()
    clean = schema.deserialize(adict)
    return clean