Patrons

Cette page référence les fichiers de patrons (« template »), leurs rôles ainsi que les variables disponibles dans leurs contextes. L’audience visée pour cette référence sont les designers qui souhaitent construire un thème personnalisé pour Canaille.

Base

Ces patrons sont partagés par toutes les pages de Canaille.

Fichiers de patrons

TEMPLATE base.html

Le patron principal dont hérite à peu près tous les autres patrons.

Paramètres:

• user (User) – L’utilisateur courant, si connecté.

• features (Features) – Les fonctionnalités disponibles, et activées dans Canaille.

• locale (str) – La code de la langue utilisée par l’utilisateur.

• website_name (str) – Le nom de l’instance de Canaille défini dans NAME.

• logo_url (str) – L’URL du logo de l’instance défini dans LOGO.

• favicon_url (str) – L’URL du favicon de l’instance de Canaille défini dans FAVICON.

• request_is_boosted (bool) – Indique si les pages sont propulsées par HTMX.

• menu (bool) – Indique si le menu doit être affiché ou non.

• debug (bool) – Indique si Canaille a été lancé en mode débogage.

• no_secret_key (bool) – Indique si le paramètre SECRET_KEY a été défini.

TEMPLATE error.html

La page d’erreur. Cette page est affichée pour tous types d’erreurs (page non trouvée, erreur interne du serveur, etc.).

Paramètres:

• error_code (int) – Le code HTTP de l’erreur (404, 500, etc.)

• description (str) – La description du code d’erreur.

• icon (str) – La référence optionnelle à un icône Font Awesome.

TEMPLATE macro/flask.html

Macros pour l’affichage des messages informatifs de Flask

TEMPLATE macro/form.html

Macros pour l’affichage des formulaires et de leurs champs.

Connecte WTForms, Fomantic-UI et HTMX.

TEMPLATE macro/table.html

Macros pour l’affichage de tables paginées avec HTMX.

Formulaires

class canaille.app.forms.TableForm(*args, **kwargs)

Bases : I18NFormMixin, FlaskForm

Un formulaire pour le rendu en tableau de collection d’objets.

page = <UnboundField(IntegerField, (), {'default': 1})>

query = <UnboundField(StringField, (), {'default': ''})>

validate_page(field)

Cœur

Ces patrons sont affichés dans les pages d’authentification et d’édition de profiles utilisateurs.

Fichiers de patrons

TEMPLATE core/about.html

La page « À propos ».

La page « À propos ».

La page « À propos ».

Cette page est informationnelle, elle affiche les liens du projet.

Paramètres:

• version (str) – La version de l’instance de Canaille.

TEMPLATE core/group.html

La page d’édition des groupes.

La page d’édition des groupes.

Page d’édition des groupes.

Affiche le formulaire d’édition ou de création d’un groupe.

Paramètres:

• edited_group (Group) – None dans un contexte de création. Dans un contexte d’édition, c’est le groupe édité.

• form (CreateGroupForm or EditGroupForm) – Le formulaire de création et d’édition de groupes.

TEMPLATE core/groups.html

La page de liste des groupes.

La page de liste des groupes.

La page de liste des groupes.

Paramètres:

• table (TableForm) – Un formulaire de pagination de Group.

TEMPLATE core/invite.html

La page de formulaire d’invitation.

La page de formulaire d’invitation.

La page de formulaire d’invitation.

Affiche le formulaire d’invitation aux utilisateurs en ayant la permission.

Paramètres:

• form (InvitationForm) – Le formulaire d’invitation d’utilisateurs.

TEMPLATE core/invite_group_member.html

Group invitation form page.

Displays the group invitation form to users with the appropriate permissions.

Paramètres:

• form (GroupInvitationForm) – The group invitation form.

• group (Group) – The group to invite members to.

TEMPLATE core/join.html

La page d’acceptation d’une invitation.

Cette page est affichée aux utilisateurs qui ont cliqué sur le lien d’invitation qui leur a été envoyé par mail (ou par un autre médium). Il affiche un formulaire basique de création de compte.

Paramètres:

• form (JoinForm) – Le formulaire de création de compte.

• captcha_data – Optional CAPTCHA data when CAPTCHA is enabled

TEMPLATE core/login.html

La page de connexion.

La page de connexion.

La page de connexion.

Cette page affiche un formulaire qui récupère l’identifiant d’un utilisateur.

Paramètres:

• form (LoginForm) – Le formulaire de connexion.

TEMPLATE core/users.html

La liste des utilisateurs.

Affiche une liste paginée de User.

Paramètres:

• table_form (TableForm of User.) – Le formulaire de listes paginées.

TEMPLATE core/partials/profile_settings_fido.html

WebAuthn passkeys management partial.

Displays the passkeys section in profile settings.

Paramètres:

• edited_user (User) – The user being edited.

TEMPLATE core/partial/captcha_field.html

CAPTCHA field partial template.

This macro renders a complete CAPTCHA field with: - Hidden token field - CAPTCHA image - Audio playback button - Refresh button - Input field for user response - Error messages

Paramètres:

• form – The form containing captcha and captcha_token fields

• captcha_data – Dict with “token” and “image_data_uri”

• audio_endpoint – Flask endpoint name for audio CAPTCHA (e.g., “core.auth.password.captcha_audio”)

TEMPLATE core/account/add.html

Page de création de compte utilisateur.

Ce patron affiche un formulaire de création de compte. Il est utilisé par la page d’enregistrement, et sur la page de création manuelle de compte disponibles aux utilisateurs avec les permissions de gestion des utilisateurs.

Paramètres:

• form (FlaskForm) – Le formulaire de création d’utilisateur. Fabriqué dynamiquement à partir des permissions de READ et WRITE. Les champs disponibles sont ceux listés dans READ et WRITE. Ceux n’apparaissant que dans READ sont en lecture seule.

TEMPLATE core/account/edit.html

La page d’édition de profil utilisateur.

La page d’édition de profil utilisateur.

Le patron d’édition de profil.

Affiche un formulaire d’édition de profil utilisateur.

Paramètres:

• edited_user (User) – L’utilisateur édité par le formulaire.

• profile_form (FlaskForm) – Le formulaire d’édition de profil utilisateur. Fabriqué dynamiquement à partir des permissions de READ et WRITE. Les champs disponibles sont ceux listés dans READ et WRITE. Ceux n’apparaissant que dans READ sont en lecture seule.

• emails_form (EmailConfirmationForm) – Un formulaire d’édition d’adresse email. Utilisé lorsque la fonctionnalité de confirmation des adresses email est activée.

TEMPLATE core/account/settings.html

La page de paramètres de profil utilisateur.

La page de paramètres de profil utilisateur.

Le patron de paramètres de profil utilisateur.

Affiche le formulaire d’édition des paramètres utilisateur.

Paramètres:

• edited_user (User) – L’utilisateur édité par le formulaire.

• form (FlaskForm) – Le formulaire d’édition de profil utilisateur. Fabriqué dynamiquement à partir des permissions de READ et WRITE. Les champs disponibles sont ceux listés dans READ et WRITE. Ceux n’apparaissant que dans READ sont en lecture seule.

• self_deletion (bool) – Indique si l’éditeur a la permission de supprimé le compte de l’utilisateur édité.

TEMPLATE core/account/auth/fido2.html

The FIDO2/WebAuthn authentication factor template.

Displays the passkeys management.

Paramètres:

• edited_user (User) – The user being edited.

TEMPLATE core/account/auth/index.html

The authentication factors list template.

Displays the list of available authentication factors for a user.

Paramètres:

• edited_user (User) – The user being edited.

TEMPLATE core/account/auth/otp.html

The OTP authentication factor template.

Displays the authenticator application management.

Paramètres:

• edited_user (User) – The user being edited.

TEMPLATE core/account/auth/password.html

The password authentication factor template.

Displays the password management form.

Paramètres:

• edited_user (User) – The user being edited.

• form (FlaskForm) – The password form.

TEMPLATE core/auth/email.html

Le patron de vérification de codes d’authentification multi-facteurs.

Affiche un formulaire qui requière un code d’authentification multi-facteurs.

Paramètres:

• form (TwoFactorForm) – Le formulaire de vérification de code.

TEMPLATE core/auth/fido-setup.html

WebAuthn credential registration template.

Displays the WebAuthn registration interface.

Paramètres:

• options_json (str) – The WebAuthn registration options in JSON format.

TEMPLATE core/auth/fido.html

WebAuthn authentication template.

Displays the WebAuthn authentication interface.

Paramètres:

• options_json (str) – The WebAuthn authentication options in JSON format.

TEMPLATE core/auth/firstlogin.html

La page de première connexion.

La page de première connexion.

La page de première connexion.

Cette page est affichée aux utilisateurs qui n’ont pas encore paramétré un mot de passe.

TEMPLATE core/auth/forgotten-password-code.html

The password reinitialization code page.

The password reinitialization code page.

Password forgotten code page.

This page displays a form asking for the code sent to the email address of users who cannot remember their password.

TEMPLATE core/auth/forgotten-password.html

La page de réinitialisation de mot de passe.

La page de réinitialisation de mot de passe.

Page d’oubli du mot de passe.

Cette page affiche un formulaire requérant l’adresse email d’un utilisateur ayant oublié son mot de passe.

TEMPLATE core/auth/otp.html

Le patron de vérification de codes d’authentification multi-facteurs.

Affiche un formulaire qui requière un code d’authentification multi-facteurs.

Paramètres:

• form (TwoFactorForm) – Le formulaire de vérification de code.

TEMPLATE core/auth/reset-password.html

La page de réinitialisation de mot de passe.

La page de réinitialisation de mot de passe.

Le patron de réinitialisation de mot de passe.

Affiche un formulaire de réinitialisation de mot de passe.

Paramètres:

• form (PasswordResetForm) – Le formulaire de réinitialisation de mot de passe.

• user (User) – L’utilisateur associé à l’URL.

• token (str) – The secret link token.

TEMPLATE core/auth/setup-otp.html

Le patron d’initialisation de l’authentification multi-facteurs.

Affiche un QR-code et le secret OTP.

Paramètres:

• secret (str) – Le secret de l’OTP.

• qr_image (A base64 encoded str) – Une image QR-code représentant le secret OTP.

TEMPLATE core/auth/sms.html

Le patron de vérification de codes d’authentification multi-facteurs.

Affiche un formulaire qui requière un code d’authentification multi-facteurs.

Paramètres:

• form (TwoFactorForm) – Le formulaire de vérification de code.

TEMPLATE core/auth/partials/fido_errors.html

WebAuthn error messages partial.

Displays all possible WebAuthn error messages (hidden by default).

Paramètres:

• attached (bool) – If true, use “attached” style instead of “icon” style.

TEMPLATE core/auth/partials/fido_setup_content.html

WebAuthn registration content partial.

Displays the registration instructions, error messages, and options.

Paramètres:

• options_json (str) – The WebAuthn registration options in JSON format.

Formulaires

class canaille.core.endpoints.forms.CaptchaField(*args, **kwargs)

Bases : StringField

CAPTCHA field for security code input.

class canaille.core.endpoints.forms.CreateGroupForm(*args, **kwargs)

Bases : Form

Le formulaire de création de groupes.

class canaille.core.endpoints.forms.DeleteGroupMemberForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.EditGroupForm(*args, **kwargs)

Bases : Form

Le formulaire d’édition de groupes.

class canaille.core.endpoints.forms.EmailConfirmationForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.FirstLoginForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.ForgottenPasswordCodeForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.ForgottenPasswordForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.GroupInvitationForm(*args, **kwargs)

Bases : Form

The group invitation form.

class canaille.core.endpoints.forms.InvitationForm(*args, **kwargs)

Bases : Form

Le formulaire d’invitation d’utilisateurs.

class canaille.core.endpoints.forms.JoinForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.JoinFormWithCaptcha(*args, **kwargs)

Bases : JoinForm

class canaille.core.endpoints.forms.LoginForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.PasswordForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.PasswordResetForm(*args, **kwargs)

Bases : Form

class canaille.core.endpoints.forms.PasswordWithCaptchaForm(*args, **kwargs)

Bases : PasswordForm

class canaille.core.endpoints.forms.TwoFactorForm(*args, **kwargs)

Bases : Form

canaille.core.endpoints.forms.add_captcha_fields(form)

Add CAPTCHA fields to a dynamically built form.

OIDC

Les patrons OIDC sont affichés lors des étapes de consentement OIDC.

Fichiers de patrons

TEMPLATE oidc/authorize.html

La page de requête de consentement.

La page de requête de consentement.

Le patron de requête de consentement.

Ce patron est affiché aux utilisateurs accédant à une nouvelle application qui requête l’accès à des informations personnelles. Il liste les informations personnelles demandées, et propose à l’utilisateur d’accepter ou de refuser.

Paramètres:

• user (User) – L’utilisateur dont le consentement est requis.

• grant (An Authlib Grant) – Le flux OIDC.

TEMPLATE oidc/client_add.html

La page d’ajout d’application cliente.

La page d’ajout d’application cliente.

Le patron d’ajout d’application cliente.

Affiche un formulaire de création de Client.

Paramètres:

• form (ClientAddForm.) – Le formulaire de création de client.

TEMPLATE oidc/client_edit.html

La page d’ajout d’application cliente.

La page d’ajout d’application cliente.

Le formulaire d’édition de client.

Affiche un formulaire d’édition de Client.

Paramètres:

• form (ClientAddForm.) – Le formulaire de création de client.

• client (Client) – Le client édité.

TEMPLATE oidc/client_list.html

La liste des clients OIDC.

Affiche une liste paginée de Client.

Paramètres:

• table_form (TableForm of Client.) – Le formulaire de listes paginées.

TEMPLATE oidc/consent_list.html

La liste d’application avec consentement explicite.

La liste d’application avec consentement explicite.

La liste d’application avec consentement explicite.

Affiche une liste d’applications clientes auxquelles l’utilisateur a donné ou révoqué son consentement.

Paramètres:

• scope_details (dict) – Description des scopes OIDC.

• ignored_scopes (list) – Les scopes à masquer.

• nb_consents (int) – Le nombre de consentements.

• nb_trusted (int) – Le nombre de clients de confiance.

TEMPLATE oidc/logout.html

Le patron de déconnexion OIDC.

Utilisé durant la déconnexion initiée par les applications clients OIDC, lorsque le consentement de l’utilisateur est nécessaire.

Paramètres:

• form (LogoutForm.) – Le formulaire de déconnexion.

• client (Client) – Le client requérant la déconnexion.

TEMPLATE oidc/token_list.html

La liste des jetons.

La liste des jetons.

La liste des jetons.

Affiche une liste paginée de Token.

Paramètres:

• table_form (TableForm of Token.) – Le formulaire de listes paginées.

TEMPLATE oidc/token_view.html

La page de visualisation de jeton.

La page de visualisation de jeton.

Le patron de visualisation de jetons.

Affiche les détails d’un Token.

Paramètres:

• form (TokenRevokationForm.) – Un formulaire de révocation de jeton.

TEMPLATE oidc/trusted_list.html

La liste d’applications de confiance.

La liste d’applications de confiance.

La liste d’applications de confiance.

Affiche une liste d’applications clientes de confiance dont il est établi que les utilisateurs n’ont pas besoin de fournir un consentement explicite.

Paramètres:

• scope_details (dict) – Description des scopes OIDC.

• ignored_scopes (list) – Les scopes à masquer.

• trusted (list [ Client ]) – La liste des clients avec consentements implicite.

• nb_consents (int) – Le nombre de consentements.

• nb_trusted (int) – Le nombre de clients de confiance.

Formulaires

class canaille.oidc.endpoints.forms.AuthorizeForm(*args, **kwargs)

Bases : Form

class canaille.oidc.endpoints.forms.ClientAddForm(*args, **kwargs)

Bases : Form

Simplified form for adding a new client with only essential fields.

class canaille.oidc.endpoints.forms.ClientEditForm(*args, **kwargs)

Bases : ClientAddForm

Complete form for editing a client with all metadata fields.

class canaille.oidc.endpoints.forms.LogoutForm(*args, **kwargs)

Bases : Form

class canaille.oidc.endpoints.forms.TokenRevokationForm(*args, **kwargs)

Bases : Form