Les plugins dans Garradin

Garradin permet d'étendre ses fonctionnalités avec des plugins (appelés extensions dans la partie privée/admin de Garradin).

L'interface de Garradin est séparée en deux sections : la section publique correspond au site web de l'association, accessible à tout visiteur, et la section privée, aussi appelée administration de l'association. Les plugins peuvent étendre l'une ou l'autre partie, ou même les deux.

Les plugins peuvent être installés de deux manières :

  • par le catalogue des extensions (extensions officielles) [non fonctionnel pour le moment]
  • simplement en copiant le fichier de l'extension dans le répertoire "plugins/" de Garradin (extensions non-officielles)

Bonnes pratiques

Les plugins officiels sont relus et vérifiés avant publication et garantissent qu'ils ne devraient pas atteindre au bon fonctionnement de Garradin ou des autres plugins.

Pour pouvoir être intégré au catalogue des plugins officiels il faut qu'il respecte un ensemble de règles édicté plus bas : règles du catalogue.

Les plugins non-officiels ne sont soumis à aucune règle mais il est quand même recommandé de suivre celles qui sont indiquées ici.

Règles du catalogue

Pour intégrer le catalogue des plugins officiels disponibles directement depuis Garradin le plugin doit :

  • être sous licence libre (compatible Debian et FOSS : GPL, AGPL, BSD, etc.) afin de pouvoir être maintenu dans le temps par la communauté ;
  • avoir un code lisible et clair (peu importe la convention de codage) ;
  • ne pas porter atteinte à l'intégrité et la stabilité de Garradin, cela implique :
    • NE PAS patcher, éditer, supprimer ou ajouter de fichiers au code de Garradin lui-même : le plugin doit être contenu dans son archive. Il est par contre possible de faire dépendre un plugin de code ou composants contenus dans un autre plugin.
    • NE PAS stocker de données en dehors de la base de données de Garradin.
    • NE PAS ajouter, modifier ou supprimer directement des données dans la base de données de Garradin (hormis dans sa propre table).
    • NE PAS enregistrer de documents sans utiliser les méthodes fournies par Garradin.
  • respecter la vie privée des utilisateurs et notamment :
    • NE PAS contacter un serveur distant (sauf besoin spécifique) ni transmettre des informations ou statistiques à un serveur tiers.

Détails techniques

Format des plugins

Les plugins sont des archives .tar.gz : tous les fichiers du plugin (code PHP, CSS, templates, images, etc.) sont stockés dans l'archive et y restent.

Il est possible de créer soi-même l'archive .tar.gz de cette manière, depuis le répertoire racine du plugin :

$ tar czvf src/plugins/test.tar.gz ./

Un script PHP (make_plugin.php) est fourni dans le répertoire tools/ de la version de développement de Garradin afin de vérifier l'arborescence et de créer l'archive en ligne de commande. Son utilisation est très simple :

$ php ~/garradin/tools/make_plugin.php ~/dev/plugins/test ~/garradin/src/plugins/test.tar.gz

Informations sur le plugin (garradin_plugin.ini)

Chaque plugin doit au moins fournir à la racine de son archive un fichier nommé garradin_plugin.ini. Ce fichier fournit le nom, la description et quelques détails sur le plugin :

nom="Ma première extension Garradin"
description="Affiche un message trop cool"
auteur="Anne Onyme"
url="http://garradin.eu/"
version="1.0"
menu=1
config=1
min_version="0.7.0"

La directive nom indique le nom du plugin, qui sera utilisé dans les listes et menus. description fournit une description plus longue d'une phrase ou deux, auteur donne le nom de l'auteur du plugin, et url indique l'adresse du site web de l'auteur.

version est utilisée pour savoir quelle est la version du plugin fournie dans l'archive. Voir plus loin : Mise à jour.

menu indique à Garradin s'il doit afficher une entrée dans le menu des extensions de la partie privée. Cette entrée sera visible par tous les membres qui peuvent se connecter, même si l'extension restreint ensuite son accès. L'entrée du menu appellera le fichier www/admin/index.php qui devra donc exister, à défaut l'installation de l'extension échouera.

config indique si l'extension possède une configuration modifiable par l'utilisateur. Si positionné à 1 (ou true) alors la page de gestion des extensions proposera un lien pour configurer l'extension (appelant le fichier www/admin/config.php), et le fichier config.json sera importé comme configuration par défaut. Ces deux fichiers sont donc obligatoires si config est activé.

min_version est facultatif et peut comporter le numéro de version de Garradin minimal nécessaire à l'installation du plugin. Par exemple si on renseigne "0.8.0" et que la version installé de Garradin est la 0.7.1, le plugin refusera de s'installer.

Attention, si le fichier garradin_plugin.ini n'existe pas dans l'archive elle ne pourra pas être installée, n'étant pas considérée comme un plugin de Garradin.

Configuration du plugin

Si config est positionné à 1 ou true (ou même On) dans garradin_plugin.ini la configuration au format JSON stockée dans config.json sera importée comme configuration par défaut du plugin.

Attention les objets javascript sont transformés en tableaux à l'import, il n'est donc pas possible de stocker un objet dynamique dans la configuration.

Le plugin peut ensuite lire sa configuration depuis son code, avec $plugin->getConfig(string $key), et changer ses infos en faisant $plugin->setConfig(string $key, string $value).

Scripts magiques

Chaque archive peut comporter certains scripts magiques qui seront appelés automatiquement par Garradin lors de certains événements.

  • install.php est appelé quand le plugin a été téléchargé et qu'il est déjà noté comme installé (post-installation), utile notamment pour créer une table dans la base de données
  • upgrade.php : quand la version de l'archive (notée dans garradin_plugin.ini) ne correspond pas à la version enregistrée en base de donnée
  • uninstall.php : juste avant que le plugin ne soit supprimé, utile par exemple pour supprimer une table créée dans la base de données
  • signals.php : inclus quand un signal enregistré est appelé

Ces scripts ne peuvent pas être appelés par une requête HTTP via l'interface privée ou publique.

Objet GarradinPlugin

  • __construct(string $id)
  • setConfig(string $key, string $value) : enregistre la configuration du plugin, si $value est null alors tte clé est effacée de la configuration
  • getConfig(string $key) : récupère la valeur de la clé $key pour la configuration du plugin
  • getInfos() : renvoie les informations enregistrées sur le plugin
  • upgrade() : mise à jour du plugin
  • needsUpgrade() : le plugin doit-il être mis à jour ?
  • uninstall() : désinstaller le plugin
  • id() : renvoie l'identifiant du plugin
  • path() : renvoie le chemin vers l'archive du plugin
  • registerSignal(string $signal, string $callback) : enregistre un callback associé à un signal

Base de données

Tous les plugins ont un accès illimité à la base de données principale de Garradin. Cependant il est interdit d'ajouter, modifier ou supprimer des données directement dans les tables de cette BDD afin de ne pas compromettre l'intégrité des données. Pour modifier ces données il faut utiliser les méthodes de Garradin.

Chaque plugin peut créer une ou plusieurs tables dans cette BDD, elles devront par contre être supprimées à la désinstallation. Dans ce cas un plugin peut modifier directement ses tables.

Fichiers

Les plugins ne doivent pas créer, modifier ou supprimer de fichiers dans l'arborescence de Garradin.

Les seuls fichiers qu'un plugin devrait modifier sont :

  • du cache : utiliser de préférence l'objet Static_Cache de Garradin, ou faire attention aux collisions de noms ;
  • les squelettes dans le répertoire www/squelettes/

Pour enregistrer et récupérer des documents il faut utiliser les méthodes de stockage de fichiers fournies par Garradin.

Signaux

Les plugins peuvent se « brancher » sur des signaux émis par Garradin lors de certaines actions.

Les signaux accessibles sont :

  • membre.nouveau, appelé juste après l'insertion du membre dans la base de données
  • membre.suppression, appelé juste avant la suppression d'un ou plusieurs membres de la base de données
  • boucle.TYPE_DE_LA_BOUCLE, appelé quand une boucle de type inconnu est rencontrée dans un squelette
  • rappels.auto (depuis 0.8.0) appelé après l'envoi automatique des emails de rappel
  • cotisation.ajout (depuis 0.8.0) appelé après l'ajout d'une cotisation liée à un membre

Un plugin peut se connecter à un signal lors de son installation ou de sa mise à jour :

$plugin->registerSignal('membre.nouveau', 'Garradin\Plugin\MonPlugin::nouveauMembre');

La méthode indiquée en second paramètre sera appelée à chaque fois que le signal est déclenché, avec deux arguments, le premier est un tableau de paramètres, et le second un tableau de valeurs à retourner (utilisé pour les boucles).

Dans les templates

Garradin fournit la lib Smartyer pour les pages privées (répertoire /admin/), où elle est déjà chargée par défaut. C'est une version allégée du moteur de template Smarty 2. Voir la documentation de Smartyer

Afficher un template contenu dans le plugin :

$tpl->display(PLUGIN_ROOT . '/templates/index.tpl');

Inclure un template de Garradin depuis un template :

{include file="admin/_head.tpl"}

Inclure un template du plugin depuis un autre template du plugin :

{include file="%s/templates/_nav.tpl"|args:$plugin_root}

Faire un lien vers une autre page du plugin :

<a href="{plugin_url file="liste.php"}">Liste des trucs</a>

Inclure une feuille de style CSS supplémentaire sur les pages du plugin (chemin relatif à la racine du plugin) :

$tpl->assign('plugin_css', 'styles/bleu.css');

Site public

Le site public de l'association n'utilise pas Smartyer mais des squelettes, qui sont très similaires aux squelettes utilisés par SPIP.

Un plugin peut modifier les squelettes (dans ce cas il est intéressant de proposer une sauvegarde à l'utilisateur pour ne pas écraser les modifs qu'il a pu faire), via la méthode Squelette::editSource(string $file, string $content). Ne pas modifier les fichiers des squelettes directement, mais seulement en utilisant cette méthode.

Un plugin peut également implémenter de nouveaux types de boucles. Dans ce cas l'installation du plugin doit enregistrer un signal du nom 'boucle.NOMDELA_BOUCLE'. Par exemple : $plugin->registerSignal('boucle.meteo', 'GarradinPluginMeteo::Boucle'). Ensuite quand cette boucle sera utilisée dans un squelette, le fichier signals.php à la racine du plugin sera inclus et la méthode indiquée sera appelée. Les paramètres sont fournis dans un tableau contenant :

  • loopName = le nom de la boucle (par exemple dans <BOUCLE_actu(ARTICLES)> c'est actu)
  • loopType = le type de boucle
  • loopCriterias = les critères de la boucle, sous forme de tableau, voir la doc de KD2MiniSkel pour les détails
  • loopContent = le contenu de la boucle
  • preContent = le contenu (facultatif) pré-boucle qui ne sera renvoyé qu'en cas de succès
  • postContent = le contenu (facultatif) post-boucle qui ne sera renvoyé qu'en cas de succès
  • altContent = le contenu (facultatif) alternatif qui sera affiché si la boucle ne renvoie rien

Un second tableau est passé en second paramètre contenant les clés suivantes, qui sont des références qui peuvent être remplies :

  • query = la requête SQL à effectuer pour remplir la boucle
  • query_args = les arguments à utiliser pour la requête SQL préparée
  • loop_start = code PHP à exécuter au début de chaque itération de la boucle

La manière la plus simple d'implémenter un nouveau type de boucle est de remplir la variable $query dans skel_loop.php. Exemple :

if ($loopType == 'stats_articles')
{
    $query = 'SELECT COUNT(*) AS nb_articles FROM wiki_pages;';
}

Ainsi la requête SQL sera exécutée dans la base SQLite de Garradin et chaque itération de résultat donnera lieu à l'affichage de $loopContent, dont les tags seront remplacés (ici par exemple #NB_ARTICLES sera automatiquement remplacé).

Il est possible aussi de remplir dans ce contexte la variable $loop_start avec du code PHP, qui sera exécuté à chaque itération de la boucle avant l'affichage. Par exemple on peut l'utiliser pour remplir une balise :

$loopStart = '$row[\'iteration\'] = $i++;';

Enfin, une autre méthode est d'utiliser un return dans skel_loop.php. En ce cas il faut renvoyer un string contenant du code PHP, qui sera enregistré dans le fichier de cache compilé et exécuté. Consulter le code de GarradinSquelette pour en savoir plus.