Les plugins de GLPI. Les plugins de GLPI permettent d ajouter les fonctionnalités suivantes :

Transcription

1 Céline Gondot Stage 1 ère année BTS SIO Les plugins de GLPI. Document annexe : Fichier XML Les plugins de GLPI permettent d ajouter les fonctionnalités suivantes : Les traitements personnalisés sur les éléments existants L ajout de nouveaux objets d inventaires L import de données extérieures dans les champs de GLPI. Un mécanisme de hooks (décrochages) est fournis par le cœur de GLPI, ce sont des mécanismes pour : Interagir avec des évènements standards du Framework GLPI : création/modification/suppression/purge/restauration Afficher des informations dans l interface utilisateur de GLPI : nouveaux onglets dans des objets existants, actions massives, rapports/statistiques Ajouter des tâches planifiées via le cron GLPI Créer des notifications supplémentaires Un plugin peut posséder sa propre gestion de droits par profils. Il enrichit la collection de droits pour un profil défini dans le cœur de GLPI. C'est-à-dire qu il y les droits concernant le cœur du GLPI, plus les droits du plugin. On peut lier un plugin avec : Des actions ou des objets du cœur du GLPI : o Historique : gestions de l historisation/ affichage de l historique avec l utilisation du formulaire du cœur o Réservations : gestion des réservations depuis le cœur o Déclaration de tickets : création/ affichage des tickets sur un objet d un plugin géré par le cœur o Documents

2 o Notes o Informations financières D autres objets du cœur (gestion à l intérieur du plugin de la liaison entre l objet du cœur et celui du plugin) Liaison inter-plugin, c'est-à-dire les liaisons entre les plugins Le plugin ne modifie pas les tables appartenant au cœur de GLPI, en revanche il peut ajouter ses propres tables si besoin. Framework : kit de composants logiciels structurels, qui sert à créer les fondations ainsi que les grandes lignes de tout ou d une partie d un logiciel. Il est donc conçu et utilisé pour modeler l architecture des logiciels applicatifs, des applications web et des composants logiciels. Il est acquis par les ingénieurs, puis incorporés dans les logiciels applicatifs mis sur le marché. Hook : permet à l utilisateur d un logiciel de personnaliser le fonctionnement du logiciel. Pour ce faire, il lui fait réaliser des actions supplémentaires à des moments déterminés. Il peut se présenter sous la forme d un fichier, dans un langage de script, localisé à un endroit particulier. Le programme principal impose généralement les caractéristiques du hook : son type, sa localisation, voire son nom et le moment auquel il sera exécuté. Par défaut, le hook est en général vide, seul les fonctionnalités de base sont exécutées. Cron GLPI : GLPI réalise les tâches automatiquement tant qu il y a une activité sur l application. Il existe une gestion de version des plugins. Le but est de créer un système de version de plugins standard et normalisé. La version doit être composée de 3 chiffres. Généralement la première version est Le premier chiffre représente la modification majeure du code. Le second chiffre représente les nouvelles fonctionnalités ou modifications qui nécessitent une modification au schéma de la base de données. Le troisième chiffre correspond à la correction des bugs Un plugin a un cycle de vie. La première version stable doit être Lors de la première correction de bug la version est La première évolution est La première évolution majeure est 2.0.0

3 Pour GLPI s il y a une évolution la version deviendra et s il s agit d évolution (s) majeure (s) ce sera Ecriture d un plugin. Il existe une certaine façon pour écrire des plugins pour GLPI. Il se présente sous forme de dossier que l on doit ajouter dans le répertoire plugins de l arborescence de GLPI. Ce dossier devra contenir tous les fichiers PHP. Le nom du répertoire ne doit comporter que des caractères alphanumériques. Le plugin ne fait qu ajouter des tables dans la base de données MySQL, afin de gérer ses propres données ou alors d écrire des données dans des tables déjà existantes (par l API du cœur de GLPI). API : Application Programming Interface. C est une interface de programmation, c'est-à-dire une suite formalisée de classes, des méthodes ou fonctions offertes par une bibliothèque logicielle ou un service web. Elle sert de façade par laquelle un logiciel offre des services à d autres logiciels. Les conventions de programmation. Le nom des tables : Doit respecter la règle suivante : glpi_plugin_<plugin_name>_xxxx Pour les tables de type dropdown (liste des valeurs), la règle est la suivante : glpi_dropdown_plugin_<plugin_name>_xxxx Respect de l arborescence des fichiers du plugin : Un répertoire «locales» : dictionnaires o Type : fr_fr.php / en_gb.php Un répertoire «docs» : o Readme.txt, Lisezmoi.txt, Roadmap.txt, Changelog.txt Un répertoire «inc» : classes et fonctions o Fonctions : plugin_<plugin_name>.db.function.php o Classes : plugin_<plugin_name>.db.class.php Un répertoire «front» : formulaires o Formulaire de création / édition d un objet : plugin_<plugin_name>.<object>.form.php o Affichage du moteur de recherche associé à un objet : plugin_<plugin_name>.php Un répertoire «pics» : images Un répertoire «ajax» : tout fichier qui touchent à l ajax (affichage onglets)

4 A la racine : o Obligatoire : o Facultatif : hook.php setup.php index.php Si le plugin doit créer des fichiers temporaires o Création dans le répertoire files de GLPI sous files/_plugins/<plugin_name> o Penser à créer le répertoire files/_plugin/<plugin_name> lors de l installation du plugin et à la supprimer lors de sa suppression. Ceci permet d éviter la gestion des droits à chaque release du plugin. Les droits s appliqueront lors de l installation ou de la mise à jour de GLPI. Ajax : Asynchronous JavaScript and XML. C est une architecture informatique qui permet de construire des applications Web et des sites web dynamiques interactifs sur le poste client en se servant de différentes technologies ajoutées aux navigateurs web entre 1995 et Gestion des noms de fonctions o Classe : class Plugin<Plugin_name>XXXX o Fonction: function plugin_<plugin_name>_<fonction> Look et aspect des plugins Pour que les plugins s intègrent correctement dans le GLPI au niveau de l image, il est conseillé de reprendre les classes de mise en forme déjà définies et utilisées dans GLPI. Ces classes se trouvent dans les fichiers CSS de GLPI. Structures des fichiers de base du plugin et la définition des hooks GLPI Lorsqu un plugin n est pas installé, ses fichiers ne sont pas chargés. Lors de son installation les fichiers setup.php et hook.php sont chargés. C est le cœur du GLPI qui gère l installation et la désinstallation du plugin. Pour ce faire, le cœur appelle des fonctions se trouvant dans le fichier hook.php. Les textes du plugin qui seront affichés dans GLPI devront être externalisés dans un fichier, afin qu ils puissent traduire l interface. Les fichiers de langues se trouvent dans le répertoire «locales». La convention pour le nommage des fichiers de langue est le même que celui de GLPI et utilise la norme i18n.

5 Norme i18n : i18n signifie internationalization. Le chiffre 18 car il y a 18 lettres entre le i et le n d internationalization. Cette norme permet à une application, un script ou un programme d être indépendant de la notion de langage, d alphabet, de temps, de devises monétaires etc. Exemples : o fr_fr : le français de France o en_gb : pour l anglais d Angleterre o es_es : pour l espagnol d Espagne Dans le fichier, les libellés sont stockés dans un tableau : $LANG[ <plugin_name> ][ titile ][0]= mon titre ; $LANG[ <plugin_name> ][ myplugin ][1]= libellé 1 ; $LANG[ <plugin_name> ][ myplugin ][2]= libellé 2 ; Encodage UTF-8 Le fichier de langue correspondant à la langue courante de l utilisateur sera chargé automatiquement. Si elle n existe pas dans GLPI, il tentera de charger successivement, le fichier de la langue par défaut, de l anglais puis du français. UTF-8 : (UCS transformation format 8 bits) est un codage de caractères informatique conçu pour coder l ensemble des caractères internationaux d Unicode en restant compatible avec la norme ASCII. Il s agit de coder les caractères Unicode sous forme de séquences de un à quatre codets (groupe d éléments représentant une donnée élémentaire selon un code) de un octet chacun. Squelette d une page affichée dans GLPI Une page qui est dans GLPI ou dans l un de ses plugins doit définir au minimum : o la constante GLPI_ROOT contenant le chemin vers la racine de GLPI : define ( GLPI_ROOT,../.. ) ; o les includes: include (GLPI_ROOT. /inc/includes.php ) Si l on souhaite utiliser les fonctions des objets de GLPI, il faut définir avant l inclusion de /inc/define.php un tableau $NEEDED_ITEMS, qui contient la liste des fonctions d objets GLPI à charger. Cette liste contient les appels de fonctions suivantes : o La fonction commonheader affiche l entête d une page GLPI, menu compris. Elle prend en paramètre minimum le titre de la page. o La fonction commonfooter affiche le pied de page par défaut d une page GLPI.

6 o Les autres affichages de la page se font entre la fonction commonheader et commonfooter. Il existe des cas particuliers pour les posts et formulaire : o La fonction glpi_header redirige la page vers une autre page. Elle prend en paramètre l URL de la page cible. o Mettre les includes dans le fichier hook.php, ce qui permettra à la fonction useplugin (<plugin_name>, true) de charger tous les fichiers inc du plugin ainsi que le hook. Le but étant de limiter le chargement excessif d include dans le setup.php. CommonDBTM Si l on définit un nouveau type, il faut aussi définir la classe associée à ce nouveau type. Elle doit hériter de la classe CommonDBTM qui permet de s abstraire de tous les accès direct à la base de données. Définition minimale : class PluginExample extends CommonDBTM { }; function plugin_example () { } $this->table= glpi_plugin_example ; $this -> type=plugin_example_type; Pour rendre son plugin disponible il faut demander l ouverture d un projet sur la forge des plugins en envoyant un sur la mailing list glpi-dev AT gna.org (en précisant un nom court de 20 caractères maximum sans espace). Une fois que le projet est créé, nous pouvons gérer son évolution comme nous le souhaitons : Svn propre au projet (plugin) Wiki Annonces Publications de fichiers Ajout de personnes dans l équipe du projet Svn : Subversion. C est un système de gestion de version. Il permet de gérer les versions d un fichier source et de garder un historique de toutes ces versions. Il permet aussi de travailler en collaboration sur le même projet.

7 Wiki : c est un site web dont les pages peuvent être modifiées par les visiteurs, pour permettre l écriture et l illustration collaboratives des documents numériques qu il contient. Ce site utilise un langage de balisage et son contenu peut être modifié au moyen d un navigateur. Voir son plugin quand il est publié sur le catalogue Lorsque notre plugin est publié sur le catalogue, il nous est possible de le voir. Pour ce faire il faut : Rajouter à la racine du svn du plugin : o Un fichier XML o Un logo en png 100*100 maximum et un fond transparent Envoyer un sur la mailing list glpi-dev AT gna.org afin de demander l ajout du plugin au catalogue. Png : (Portable Network Graphics) est un format ouvert d image numériques qui a été crée pour remplacer le format GIF. C est un format non destructeur et il est adapté pour publier des images simples comprenant des aplats de couleurs il a été normalisé par l ISO(Organisation Internationale de normalisation), (ISO/CEI :2004). Document réalisé le 27 Mai. Modifié le 28 Mai.

8 Document annexe : Le fichier XML : <?xml version="1.0" encoding="utf-8"?> <root> <name>plugin name </name> <key>uniquekeyduplugin</key> <state>stable</state> <logo> <description> <short> <fr><![cdata[texte court décrivant le plugin ]]></fr> <en></en> </short> <long> <fr><![cdata[texte long décrivant le plugin ]]></fr> <en></en> </long> </description> <homepage> <download> <authors> <author>michel Dupont </author> <author>mike Durand </author> </authors> <versions> <version> <num>3.0.0</num>

9 <compatibility>0.72</compatibility> </version> <version> <num>2.0.0</num> <compatibility>0.71</compatibility> </version> <version> <num>1.0.0</num> <compatibility>0.65</compatibility> </version> </versions> <langs> <lang>fr_fr</lang> <lang>en_gb</lang> </langs> <license><![cdata[gpl v2+]]></license> <tags> <fr> <tag>réseau</tag> <tag>graphique</tag> </fr> <en> <tag>network</tag> <tag>graph</tag> </en> </tags> </root>

10