Zikula France

MediaAttach

Module : MediaAttach-1.0 RC	Version française : MediaAttach
Description: MediaAttach est utilisé pour créer un dépôt de fichiers accessibles directement à l'aide du module lui-même ou depuis n'importe quel autre module qui l'utiliserait comme module intégré (hook).
Il s'agit d'une version disponible uniquement via le svn de ce module, pour savoir comment vous procurer cette version veuillez lire la documentation réalisée à cet effet.
Lien SVN : https://code.zikula.org/svn/mediaattach/trunk

(page en cours de création par Magicvince)

1. Présentation

1.1 Utilisations

MediaAttach est utilisé pour créer un dépôt de fichiers accessibles directement à l'aide du module lui-même ou depuis n'importe quel autre module qui l'utiliserait comme module intégré (hook). Dans ce dernier cas, ceci permet de rajouter une fonction d'ajout (ou d'attachement) de fichiers aux contenus produit. L'intégration aux autres modules est personnalisable en créant des "Définitions".

• Pour le développeur de module, MediaAttach le débarrasse du codage de fonctionnalité des dépôts et gestion de fichiers propres à son module. Il économise ainsi un codage supplémentaire de fonction pour son module.
• Pour l'administrateur du site, il centralise et gére tous les fichiers déposer pour le site grâce à ce module dans un répertoire de dépôts structurés qui peut se trouver sur le serveur en dehors du répertoire web public. Et ce, quelque soit le module utilisé.
• Pour l'utilisateur contributeur ceci lui permet d'associer des fichiers avec les contenus qu'il produit sur le site directement depuis la page concernée (à télécharger ou visualiser directement selon le format du fichier).
• Pour l'utilisateur visiteur, ceci lui offre la possibilité de consulter des contenus multimédias soit en les téléchargeant, soit en les visualisant directement depuis leur contexte de publication tout en gardant (selon les droits d'accès définis par l'administrateur) la possibilité de centraliser tous les téléchargements possibles sur le site par catégories, modules ou contributeur.

MediaAttach est un module spécialement développé pour Zikula 1.0 + (non compatible avec Postnuke).

1.2 Démonstrations

Quelques site utilisants MediaAttach

2. Installation et mises à jour

2.1 Récupérer MediaAttach

Le projet MediaAttach est hébergé sur le site CoZi (code.zikula.org).

• Télécharger l'archive de la dernière version => Attention lors de la rédaction de cette notice, ce lien n'est pas encore actif, utiliser la version SVN∞
• Récupérer les fichiers de la dernière version stable dans les dépôts SVN =>

  svn co https://code.zikula.org/svn/mediaattach/trunk/MediaAttach
• Récupérer les fichiers de langue française =>Téléchargement inclus dans le ValueAddons∞

2.2 Installer MediaAttach

2.3 Mettre à jour MediaAttach

3. Administration

Cette partie permet de régler, paramétrer et gérer le fonctionnement général de MediaAttach pour l'ensemble du site.
Vous devez être connecté comme administrateur et à partir du panneau d'administration vous rendre sur la page d'administration de MediaAttach.
Le panneau d'administration de MediaAttach se découpe en 8 onglets:

• Départ => Retour à l'accueil de l'administration du module (donne des indications sur son utilisation)
• Dépôt Admin. => Gestionnaire de fichier pour l'administrateur du site. Il pourra notamment importer l'ensemble des fichiers du site
• Dépôt Utilisateurs => Pour visualiser et administrer l'ensemble des fichiers déposé par les utilisateurs dans les différents modules utilisant MediaAttach
• Définitions => Ajuste pour chaque module la façon dont il utilise MediaAttach et le type de fichiers autorisés au dépôt.
• Formats => Déterminer les types de formats qui peuvent être utilisés avec MediaAttach
• Groupes => Rassemble les formats en groupes qui seront utilisés par les définitions
• Config. => Réglages des paramètres de MediaAttach (à paramétrer avant toute utilisation de MediaAttach - voir 3.1 -)
• Manuel => Aide en ligne (Actuellement pdf disponible en version anglophone)

3.1 Configuration

Avant de commencer à configurer pour la première fois MediaAttach à partir de l'onglet config., pensez à créer les répertoires qui seront nécessaires à son fonctionnement.

3.1.1 Paramètres généraux

• Répertoire de dépôt

Il s'agit du répertoire dans lequel seront stockés les fichiers déposés sur le site. Vous devez renseignez le champ en indiquant son chemin absolu par rapport à la structure d'organisation des fichiers sur le serveur (et non par rapport à la structure de nommage du site web : ex sur des serveurs linux, l'adresse sera généralement du type /home/login/RepertoireDepots?) sans slash (barre oblique) à la fin. Pour vous aidez, les deux premières lignes (répertoire de MediaAttach et Racine HTML) vous donnent les valeurs absolues pour localiser l'emplacement de MediaAttach et du site sur le serveur.

• Répertoire cache

A compléter par l'adresse relative par rapport et répertoire HTML du site du répertoire qui sera utilisé en tant que cache. Notez que cette fois l'adresse étant relative, elle ne doit pas être précédée d'un /.

• Fonction Courriel (Mail)

Cette fonction n'est visible que si vous avez installé et activé le module Mailer. Si vous cochez cette option, les utilisateurs qui déposeront des fichiers auront la possibilité de s'envoyer un courriel avec le fichier en pièce jointe. Vous devrez compléter un autre champ de paramétrage dans lequel vous indiquerez la taille maximum du courriel qui pourra être envoyé.

• Activer les quotas

Cette fonction permet d'activer ou désactiver la fonction quota qui activera un nouvel onglet dans le panneau d'administration de MediaAttach. Vous pourrez y définir des quotas par groupe d'utilisateurs ou par utilisateurs. Les quotas par utilisateurs sont prioritaires sur les quotas par groupe. Si un utilisateur atteint sa limite de quota, il ne pourra pas déposer de nouveau fichier, aussi longtemps que son quota sera au maximum autorisé.

• Autoriser la gestion de ses fichiers

Avec cette option, vous autorisez les utilisateurs à modifier ou supprimer les fichiers qu'ils auront déposé indépendament du réglage par défaut des permissions (plus d'information sur la partie consacrées aux permissions).

• Taille par défaut des aperçus (vignettes)

MediaAttach génère automatiquement des aperçus des images déposées. Vous pourrez en définir les dimensions. Vous pouvez définri plusieurs formats d'aperçu à utiliser alternativement selon les cas (possibilité d'avoir des tailles d'aperçu adaptées à chaque module).

• Ajuster les images automatiquement

cette option permet d'adapter automatiquement la taille des images déposées à une taille standard.
Taille maximum des images
Pour choisir la taille d'ajustement.

• Autoriser le recadrage

Comportement de l'outil de sélection
Si ce paramètre est réglé sur "non modifiable", la taille par défaut de la vignette sera la taille par défaut de la sélection.Si le paramètre est fixé sur "modifiable", l'utilisateur pourra choisir la taille de l'aperçu.
Activer pour la page d'accueil de l'utilisateur
Autorise l'utilisateur à choisir MediaAttach comme page d'accueil.

• Options de catégorisation

MediaAttach n'a pas de zone publique par défaut (qui rendrait le module autonome, comme si par exemple il s'agissait d'une module de téléchargement). Toutefois vous pouvez débloquer cette fonctionnalité. Les fichiers pourront être répartis par catégories, modules ou utilisateurs. N'oubliez pas que dès lors les visiteurs et les utilisateurs auront alors accès directement à tous les fichiers en fonction de leurs droits d'accès au module MediaAttach en priorité sur les droits qu'ils auraient sur les définitions de droits par modules.

• Informations complémentaires

Dans le tableau des valeurs récupérées dans le fichiers de configuration php.ini, vous pouvez retrouver les paramètres importants relatifs au dépôt de fichiers. Les descriptions suivantes la sinification de chaque directive :
open_basedir :répertoire du site
upload_tmp_dir : Répertoire où les fichiers sont stockés temporairement lors du dépôt (répertoire cache)
file_uploads : Indique si les fichiers déposés sont activés.
upload_max_filesize : Taille maximum des fichiers pouvant être stockés sur le serveur.
post_max_size : Taille maximum d'un fichier pouvant être envoyé par un formulaire sur le serveur
max_input_time : Indique la durée maximum pour qu'un ajout puisse s'effectuer

• Vérification de version

Au bas vous pouvez trouver un autre bloc pour vérifier l'existence d'une nouvelle version de MediaAttach. Pouvez ainsi vérifier rapidement si une nouvelle version est disponible. Si c'est le cas, un lien vous permettra d'aller directement télécharger cette dernière version.

3.2 Définitions

MediaAttach peut s'intégrer à chaque module de votre système. Vous pourrez ainsi attacher des fichiers à vos Nouvelles, aux messages des forums, à vos Pages statiques, etc... Toutefois il faut préalablement que vous ayez activé la fonction d'extension pour les modules qui utiliseront cette fonctionnalité étendue et pour chacun des modules il faudra leur créer une extension. Vous êtes ici dans l'onglet de création et d'administration de ces définitions.
* Explication des différents champs:
Module : Module pour lequel sera fait la définition
Groupes : Définis les types de fichiers qui seront utilisables pour cette définition (donc avec le module qui l'utilisera)
Montrer les fichiers déposés dans la zone utilisateur : Indique si les fichiers transférés sont affichés avec le formulaire de dépôt. Seulement les siens : indique que seuls les fichiers transmis par l'utilisateur sont visibles avec le formulaire (il ne pourra pas utiliser les fichiers déposés par d'autres).
Envoyer un courriel pour signaler la procédure de transfert : Destinataire du courriel
Taille maximum des fichiers transmis : Limite la taille des fichiers. Remarquez que la valeur doit être inférieure à celle indiquée par les directives upload_max_filesize et max_post_size signalé dans la partie configuration de ce manuel. (voir onglet config. 3.1)
Mode de transfert : Indique comment les fichiers sont affichés.
Physiquement indique un lien vers le fichier, tandis que En ligne "tente" d'afficher le fichier dans le navigateur. D'autres informations concernant cette fonction sont détaillées au chapître sur les modes de présentation.
Convention de nommage des fichiers : Par défaut les noms de fichiers originaux sont conservés une fois nettoyés des caractères spéciaux. Mais vous pouvez aussi définir que les fichiers soient renommés avec un nom aléatoire (à l'aide du générateur md5). Une troisième option vous permet de choisir un préfixe de nom statique compléter d'un chiffre qui sera incrémenté à chaque nouveau dépôt. Ainsi vous pouvez par exemple nommer les fichiers déposer pour pagemaster pagemaster<number>.extension ou ceux de DizKus? forum<number>.extension.
Nombre de fichiers : C'est le nombre de fichiers que vous pouvez transférer en même temps. Par défaut ce nombre est à 1, le maximum est 8.

3.3 Formats et Groupes de fichiers (ou médias)
Les différents formats de fichiers disponibles dans MediaAttach sont rassemblés dans différents groupes de types de fichiers. Ainsi un type de fichier peut être dans plusieurs groupes.
Chaque groupe est un regroupement virtuel. de type de formats. Plusieurs groupes ont été créés par défaut, mais vous pouvez les modifier ou en créer de nouveaux avec des mélanges originaux (comme c'est démontré dans le groupe "membres" défini en exemple.

3.4 Dépôts utilisateurs
Dans cette partie vous pouvez gérer les fichiers qui ont été déposer par les utilisateurs. Pour faciliter la votre visibilité, les fichiers sont classables selon différents champs.

3.5 Dépôt Admin / Imports
Au cours de l'installation, MediaAttach est activé par défaut pour MediaAttach. Vous pouvez créer une définition comme pour n'importe quel module. Ceci vous permets de séparer les dépôts de l'administrateur des autres utilisateurs (voir 3.4).
Cette zone du panneau d'administration donne aussi accès à un système d'import des fichiers présents dans les répertoires du serveur plus flexible et plus confortable. Essayez donc!
MediaAttach supporte aussi l'importation de fichiers ou de catégories depuis d'autres modules. Actuellement cet import est compatible avec Downloads 2, mediashare, PhotoGallery? et pnUpper. D'autres modules seront prochaînement supportés.

4. Permissions

Le schéma de permissions de MediaAttach utilise le composant MediaAttach:: et trois niveaux d'instances :
1.Pour un module spécifique
2.Pour un objet spécifique id, par exemple sid News, ou tid_pid pour PageSetter? affecteront la permission à une News spécifique ou un article spécifique.
3.Pour un dépôt spécifique à l'aide de l'ID du fichier déposé.

Quelques exemples pour illustrer:
pnForum:6: tous les fichiers déposés dans le topic 6
pnForum:6:(3|5) Seulement les fichiers 3 et 5 déposé dans le topic 6
News:(3|4|5∞): Tous les fichiers dans les articles 3 4 et 5
pagesetter:: Tous les fichiers dans pagesetter
pagesetter:4_3: Tous les fichiers dans la publication 3 de pubtype 4
pagesetter:4_*: tous les fichiers dans la pubtype 4
News:[^34∞]: Tous les fichiers dans tous les articles sauf les articles 3 et 4
pagesetter:2_[^34]: dans toutes les publications de pubtype 2 sauf la3 et la 4
pagesetter:2_\d*[^34]\d* dans toutes les publications de pubtype 2 sauf celle qui contiennent 3 ou 4

MediaAttach supporte actuellement les niveaux de permissions suivants:
Survoler Voir les fichiers et les informations
Lire Télécharger et envoyer des fichiers (par mail)
Commenter Ajouter de nouveaux fichiers
Éditer Faire des modifications sur les fichiers déposés
Supprimer Effacer des fichiers
Administrer Accès complet à l'administration du module et de ses contenus.

La gestions des permissions est parfois maladroite avec les modules "étendus" (hookés) dans la mesure où la reconnaissance du contexte d'utilisation du module n'est pas toujours bien géré.
MediaAttach utilise différentes approches en parallèle pour offrir une prise en main aussi aisée et rigoureuse que possible du système de permissions.
Indépendament des permissions de Zikula, vous pouvez définir des permissions spécifiques si les utilisateurs peuvent éditer ou supprimer leurs propres fichiers.
Avec pnForum (ou DisKuz?, MediaAttach exécute une vérification améliorée et ne détermine pas seulement si un utilisateur veux chercher à accéder à un fichier, mais s'il a accès à la catégorie qui le contient comme si celle-ci était un topic autorisé du forum. (MediaAttach performs an enhanced check and determines not only if a user wanting to reach a file has access to it, but even, if he has access to the category as well as the forum containing the according forum topic). Dans la feuille de route il est prévu de réaliser le même type de vérification pour tous les modules, bien que l'intégration ne soit aujourd'hui effective que pour pnForum.

5. Apparence et affichage (Templating et Design)

5.1 Blocs

5.2 Templates (modèles)

6. Fonctionnalités spéciales

6.1 Intégration avec les autres modules : Crochetage (Hooking)

6.1.1 MediaAttach hooker
MediaAttach peut être utilisé comme extension de module.

6.1.2 MediaAttach hooké
MediaAttach supporte aussi la fonctionnalité de d'extension du module MultiHook?. Ainsi l'intégration de téléchargements est facilité pour une utilisation sans plugin spécifique. Ainsi si l'on insère l'expression MEDIAATTACH{P-fileid|I-fileid} dans le contenu désiré, elle sera remplacée grâce à MultiHook? par l'affichage correspondant du fichier à visualiser ou télécharger.Par exemple MEDIAATTACHP-5 montrera le fichier qui a l'ID 5 avec le thème d'affichage du module utilisé, tandis que MEDIAATTACHI-5 utilisera le modèle de template inline.

6.2 Intégration avec Scribite et autres éditeurs wysiwyg

MediaAttach marche également avec l'éditeur wysiwyg xinha qui peut être utiliser dans les modules de rédaction de contenu grace au module scribite. Vous pourrez ainsi facilement ajouter des fichiers (images, sons, pdf, etc...) directement lors de l'édition de vos articles.
Dans le répertoire pndocs de MediaAtach?, vous trouverez un plugin "Guppy" qui permet l'utilisation de MediaAttach avec les modules utilisant par défaut se système d'éditeur de contenu (par exemple les modules Pagesetter ou Content). Ce fichier plugin permettra de rendre opérationnel MediaAtach? avec les éditeurs de ces modules.

7. Trucs et Astuces

8. Problèmes connus

9. Informations et liens complémentaires

10. Licence et contributeurs