Envoyer des fichiers avec un formulaire Formidable

La version 3.0.0 du plugin Formidable permet de créer des formulaires comprenant des envois de fichiers. Cet article regroupe la documentation relative à cette fonctionnalité. Pour une présentation générale de Formidable, voir « Formidable, le générateur de formulaires ».

Configuration requise

Afin de pouvoir accéder à la fonction d’envoi de fichiers il vous faut :

  • Le plugin CVTupload dans sa version 1.9.4 au minimum. Attention, il reste possible d’activer Formidable sans avoir ce plugin. Simplement, il sera alors impossible d’envoyer des fichiers avec Formidable.
  • L’extension PHP fileinfo.
  • Le plugin Formidable en version 3.0.0, lequel nécessite notamment :
    • le plugin Saisies en version 2.17.0 au minimum ;
    • le plugin Vérifier en version 1.4.1 au minimum.

Configuration des fichiers à envoyer

Lors de la création d’un formulaire, il est possible de choisir un champ de type « Fichier(s) ».

Insertion d’un nouveau champ d’envoi de fichiers

Ce type de champ possède un certain nombre de propriétés configurables. Certaines, telles le titre, sont communes à l’ensemble des champs proposés par Formidable. Nous ne nous attarderons pas dessus, et n’exposerons que les propriétés spécifiques au type de champ « Fichier(s) ».

Accéder à la configuration d’un champ « Fichier(s) »

Nombre de fichiers

Dans la configuration du champ, l’onglet « Utilisation » permet de choisir le nombre de fichiers à envoyer pour ce champ. Par défaut, la valeur est 1.

Configuration du nombre de fichiers par champ

Notez qu’il s’agit du nombre de fichiers pour ce champ, mais qu’il est possible d’ajouter des champs supplémentaires pour d’autres fichiers, ce qui permet de distinguer les fichiers selon les besoins.

Pour l’instant, chaque fichier est associé à un input unique, afin d’être compatible avec un maximum de navigateur. Dans le futur, des versions améliorées de la saisie pourront être disponibles pour améliorer l’ergonomie.

Exemple de champ permettant d’envoyer un seul fichier
Exemple de champ permettant d’envoyer plusieurs fichiers

Notez que si une internaute triche et modifie le HTML afin d’envoyer plus de fichiers, le système n’enregistrera pas plus de fichiers que configurés.

Puisque chaque fichier est associé à un input unique, chaque input reçoit un label individuel. Il est cependant possible de désactiver ce label pour n’afficher que le label commun à l’ensemble des fichiers.

Validation

L’onglet « Validation » de la configuration du champ permet de régler les propriétés des fichiers envoyés.
Cet onglet est assez long, car il permet de choisir finement les types de fichiers autorisés à l’envoi.

Présentation globale des options de vérification d’un champ d’envoi de fichiers

Caractère obligatoire

La première option dans cet onglet, est, comme pour tous les champs, le caractère obligatoire ou non de l’envoi de fichier.

Notez que dans le cas d’un champ permettant d’envoyer plusieurs fichiers, on considère que l’obligation d’envoi est remplie à partir du moment où un fichier est envoyé. Si vous souhaitez imposer l’envoi de trois fichiers, il vous faut créer trois champs [1].

Type Mime et extension

Une première série de boutons radio permet de choisir types de fichiers sont autorisés :

  • Autoriser tous les types et extensions cette option est très déconseillée ;
  • Autoriser tous les types Mime et extensions connues de SPIP dans sa table spip_types_documents [2] ;
  • Autoriser uniquement les les images web (gif, jpg, png) (.jpg, .png, .gif) ;
  • Autoriser uniquement les types et extensions sélectionnés parmi les cases à cocher ; utile par exemple pour n’autoriser que l’envoi de pdf. Les cases à cocher de choix de type n’apparaissent que si on choisit cette option.

Notez les points suivants :

  • Dans tous les cas, Formidable zippera automatiquement les fichiers d’un type et/ou d’une extension absente de la table spip_types_documents, afin notamment d’empêcher son exécution sur le serveur.
  • Si vous choisissez l’option « Tous les types Mime et extension autorisés par SPIP » ou « Un type Mime associé à une extension précisée ci-dessous » la vérification se fera :
    • la plupart du temps, sur la base du type Mime détecté par PHP et de l’extension du fichier
    • lorsque PHP détecte un type Mime text/plain ou application/octet-stream, qui sont très génériques, sur la seule base de l’extension [3].

Taille du fichier

La taille du fichier est, de facto, limitée par la configuration de votre serveur. Souvent par défaut, 32 kio [4].

L’ami Marcimat travaille actuellement sur un projet « BigUp » qui permet d’envoyer des fichiers plus gros. Si cela est nécessaire pour vos besoins, le contacter.

En dehors même des limites techniques, il peut être utile de limiter pour des raisons éditoriales la taille des fichiers envoyés. Pour cela, il vous suffit de remplir le champ « taille » en indiquant une taille maximale en kio.

Notez ces deux points :

  • la vérification de la taille a lieu après l’envoi du fichier sur le serveur
  • la vérification de la taille se comprend fichier par fichier, et non pour l’ensemble des fichiers d’un même champ.

Dimension de l’image

Une dernière série de réglages permet de vérifier la dimension des images envoyées.

Configuration de la dimension d’une image

Notez qu’il faut dans ce cas s’assurer que le document envoyé est bien une image en choisissant la bonne option auparavant. De plus, la fonction utilisée pour déterminer la taille de l’image est getimagesize(), qui ne comprend pas tous les types d’images.

Il est possible de préciser une largeur maximum (en pixels) et une hauteur maximum (en pixels). Une option permet également d’autoriser les images qui rentrent dans ces dimensions lorsqu’on les tourne de 90°.

Configuration des traitements

Comme pour tous les formulaires Formidable, un formulaire proposant l’envoi de fichier peut enregistrer les réponses et/ou les envoyer par courriel. Il n’y a rien de particulier à faire dans le cas qui nous occupe.

Confidentialité des fichiers

Au moment de l’enregistrement des traitements, Formidable vérifie s’il est possible d’enregistrer les fichiers à un endroit inaccessible par http. En cas de problème, un message est affiché, et dans ce cas l’envoi des fichiers ne pourra avoir lieu tant que le problème ne sera pas résolu. Voir plus bas, le paragraphe sur « Où les fichiers sont-ils stockés ? ».

Durée du lien par email

Il est conseillé de choisir l’enregistrement des réponses, et de ne pas se contenter de l’envoi par courriel. En effet, les fichiers ne sont pas joints dans le courriel, pour éviter des problèmes en cas de fichiers lourds, mais un lien y est inséré.

Le lien dans l’email expire 24h après l’envoi du formulaire. Il est possible d’augmenter ce délai en mettant la ligne suivant dans votre fichier mes_options.php :

define ('_FORMIDABLE_EXPIRATION_FICHIERS_EMAIL', <une_durée_exprimée_en_seconde>);

Si la durée est mise sur 0, le lien est valable ad vitam aeternam.

Joindre directement les fichiers dans le courriel

Depuis la version 3.5.0, il est possible de joindre les fichiers directement dans le courriel.
Mais :
-  le lien entre les fichiers et les champ associé est perdu
-  les fichiers sont à la fin du courriel
-  si la taille (en Mio) dépasse la valeur de la constante _FORMIDABLE_TAILLE_MAX_FICHIERS_EMAIL (par défaut 10), les fichiers ne sont pas joints et on repasse à une présentation classique par insertion d’un lien.

Utiliser le formulaire en tant que visiteur⋅euse

Une fois le formulaire publié sur le site public, lela visiteur⋅euse peut le remplir et choisir les fichiers à envoyer.

Si ielle envoie une réponse avec des erreurs dans un champ, les fichiers déjà envoyés sont conservés, et il n’a pas besoin de les renvoyer. Ielle peut cependant décider, le cas échéant, de supprimer des fichiers déjà envoyés.

Lorsqu’un formulaire contient une erreur, les fichiers envoyés sont conservés

Si vous autorisez une visiteureuse à modifier une réponse envoyée, le formulaire de modification de réponse lui propose automatiquement les fichiers qu’ielle a auparavant envoyés, avec la possibilité de supprimer – et donc de remplacer – des fichiers.
Notez que, comme pour les autres champs, il n’est fait aucune sauvegarde des anciennes valeurs.

Exemple de présentation d’un formulaire pour modifier une réponse déjà existante
Exemple de remplacement d’un fichier envoyé auparavant

Récupérer les fichiers envoyés

Les fichiers envoyés sont stockés dans un endroit normalement inaccessible au public. Dans la présentation des réponses, que ce soit dans l’espace privé de SPIP ou par courriel, un lien est inséré.
Ce lien est sécurisé de telle sorte que seules les personnes ayant le droit de voir les réponses ou ayant reçue le courriel puissent télécharger le fichier.

Présentation des fichiers envoyés dans la réponse d’un formulaire

Notez que quelques changements sont effectués dans le nom des fichiers envoyés :

  • passage en minuscule ;
  • suppression des accents ;
  • remplacement des espaces par des tirets-bas ;
  • suppression des points initiaux si le nom du fichier commence par un point ;
  • ajout éventuel de suffixe pour distinguer les fichiers homonymes ;
  • mise en zip du fichier s’il n’est pas d’un type ou d’une extension listée dans la table spip_types_documents

Dans l’accusé de réception, ces liens sont également insérés.
Cependant, il est possible désactiver cela en mettant la ligne suivante dans le fichier mes_options.php :

define('_FORMIDABLE_LIENS_FICHIERS_ACCUSE_RECEPTION', false);

Où les fichiers sont-ils stockés ?

Cette partie de la documentation intéresse surtout les webmestres et non les administrateurtrices.

Dans tous les cas, les fichiers sont enregistrés dans le dossier config/fichiers/formidable, qui est automatiquement créé. Il vous faut donc transférer le dossier config/fichiers [5] lorsque vous migrez un site d’un serveur à un autre, et si possible sauvegarder régulièrement ce dossier.

Normalement SPIP s’assure que le dossier config n’est pas accessible en lecture à l’extérieur.
Par précaution, Formidable s’assure également de cela à chaque envoi du fichier.
Si ce critère n’est pas rempli, ou s’il est impossible d’écrire dans config/fichiers/formidable :

  • un message de log est enregistré dans formidable.log ;
  • le fichier n’est pas déplacé dans config/fichiers ;
  • un courriel est envoyé à l’adresse du webmestre configuré dans les réglages d’identité du site [6], ce qui lui permet de récupérer en urgence le fichier dans le dossier tmp/cvtupload ;

À l’intérieur de config/fichiers/formidable, les fichiers sont stockés selon la structure suivante :

  • Si les réponses sont enregistrées en base de données, un dossier par formulaire, puis un dossier par réponse, puis un dossier par champ. Par exemple formulaire_1/reponse_2/fichiers_3.
  • Si les réponses ne sont pas enregistrées, mais simplement envoyées par courriel, nous utilisons un dossier timestamp : à l’intérieur de ce dossier est créé un dossier par réponse, dont le nom correspond au timestamp de la réponse. Au sein de chaque dossier de réponse, un dossier est créé par champs.

Effacement des fichiers

Ces fichiers sont effacés :

  • Lorsque la réponse est effacée de la base de données, quand Formidable efface les réponses « à la poubelle ».
  • Lorsque le formulaire est effacé de la base de données quand Formidable efface les formulaires en statut « à la poubelle ».
  • Pour les réponses qui ne sont pas stockées en base de données, lorsque les fichiers sont plus vieux que la constante _FORMIDABLE_EFFACEMENT_FICHIERS_EMAIL, qui par défaut est égale à la constante _FORMIDABLE_EXPIRATION_FICHIERS_EMAIL, qui est égale par défaut à 24*3600 secondes. Vous pouvez modifier cette constante en ajoutant dans votre fichier mes_options.php la ligne suivante :
    define ('_FORMIDABLE_EFFACEMENT_FICHIERS_EMAIL', <une_durée_exprimée_en_seconde>);

    Si la durée est mise à 0, les fichiers sont conservés ad vitam aeternam.
    Dans tous les cas, veillez à ce que la constante _FORMIDABLE_EFFACEMENT_FICHIERS_EMAIL soit au moins égale à _FORMIDABLE_EXPIRATION_FICHIERS_EMAIL.

Notes

[1En général, dans ce cas, chaque champ correspond à un besoin différent.

[2Voir l’article de la documentation de SPIP « Ajouter un type de document ».

[3Nos tests en local nous ont montré qu’un fichier LaTeX, d’extension .tex, était détecté de type Mime application/octet-stream, ce qui n’est pas très utile comme information.

[4Un kibioctet (kio) contient 1024 octets, un kilooctet (ko) contient 1000 octets… il est vrai que SPIP considère qu’un kilooctets correspond à 1024 octets. Voir l’article Wikipédia à ce sujet.

[5Pour le moment, seul le plugin Formidable écrit dans config/fichiers, mais d’autres plugins pourraient le faire dans le futur.

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom