= Les fichiers dans le code de Garradin =

== Stockage ==

Pour minimiser les ressources (espace disque, temps processeur), le contenu du fichier est stocké séparé des méta-données du fichier. Ainsi un fichier peut être uploadé plusieurs fois, à plusieurs endroits différents, et n'être stocké qu'une seule fois. De même le cache ne stocke qu'une seule fois le fichier, quel que soit le nombre d'occurrences.

== Upload ==

L'envoi de fichier utilise l'API javascript File pour lire les données du fichier avant envoi. Cela permet de vérifier que la taille du fichier rentre dans les clous. Mais on fait aussi un appel XHR avec le SHA1 du fichier (on utilise https://github.com/srijs/rusha pour ça) pour savoir s'il n'est pas déjà stocké. S'il est déjà stocké ça ne sert à rien de l'envoyer et gaspiller de la bande passante ou du processeur.

= 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)
# 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|#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|#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 Garradin\Plugin ==

* __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.

FIXME plus de doc.

=== Dans les templates ===

Garradin fournit la lib Template_Lite 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 de Smarty 2.

Afficher un template contenu dans le plugin :
<pre>
    $tpl->display(PLUGIN_ROOT . '/templates/index.tpl');
</pre>

Inclure un template de Garradin depuis un template :
<pre>
    {include file="admin/_head.tpl"}
</pre>

Inclure un template du plugin depuis un autre template du plugin :
<pre>
    {include file="`$plugin_root`/templates/_nav.tpl"}
</pre>

Faire un lien vers une autre page du plugin :
<verbatim>
    <a href="{plugin_url file="liste.php"}">Liste des trucs</a>
</verbatim>

Inclure une feuille de style CSS supplémentaire sur les pages du plugin (chemin relatif à la racine du plugin) :
<pre>
    $tpl->assign('plugin_css', 'styles/bleu.css');
</pre>

=== Site public ===

Le site public de l'association n'utilise pas Template_Lite 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 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.NOM_DE_LA_BOUCLE'. Par exemple : $plugin->registerSignal('boucle.meteo', 'Garradin\Plugin\Meteo::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 KD2\MiniSkel 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

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 :

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

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 $loopStart 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 :

<pre>
$loopStart = '$row[\'iteration\'] = $i++;';
</pre>

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 \KD2\Squelette pour en savoir plus.

= Les squelettes dans Garradin =

Dans Garradin le site public de l'association est affiché via des squelettes. Ce sont des fichiers HTML qui permettent de choisir les données affichées sur le site. Ils sont semblables aux squelettes de SPIP.

= Exemples =

== Contenu conditionnel ==

Si on souhaite afficher un message pour les visiteurs anglophones, on peut utiliser :

[[[
[(#LANGUE_VISITEUR|=={fr})
<p>
	Welcome to our non-profit organization website!
</p>
]
]]]

= Guide de référence =

== Les boucles ==

=== Boucle ARTICLES ===

=== Boucle RUBRIQUES ===

=== Boucle PAGES ===

== Les critères ==

== Les balises générales ==

=== #LANGUE_VISITEUR ===

Donne la langue principale du visiteur.

== Les filtres ==

=== choixsiegal ===

Ce filtre permet d'afficher un contenu alternatif.

== Différences connues avec la syntaxe SPIP ==

=== Boucles ===

* La syntaxe raccourcie n'est pas reconnue (par exemple <BOUCLE_a(ARTICLES) />#TOTAL_BOUCLE<//B_a>)

=== Balises ===

Les fonctions suivantes ne sont pas supportées par Garradin pour le moment :

* La balise #ENV n'est pas gérée
* La double étoile #BALISE** n'est pas pris en compte, seulement #BALISE* (voir [[http://www.spip.net/fr_article4376.html]])
* Les paramètres des balises dynamiques ne sont pas supportés (par exemple #ENV{lang,fr})
* Les balises non-ambigües ne sont pas supportées (par exemple #_rubriques:TITRE)
* Il n'est pas possible d'imbriquer des balises étendues dans les arguments des filtres d'une balise. Exemple : [(#LANGUE_VISITEUR|!={fr}|et{#LANGUE_VISITEUR|!={ro}})