Certaines modifications sont faites sur le wiki de MoinMoin pour nos besoins
Sommaire
Le making of du wiki
Ce wiki est basé sur le moteur MoinMoin, un moteur de wiki écrit en python. Sans s'intéresser davantage aux motivations de ce choix, détaillons le fonctionnement du wiki.
Où
Ce wiki est installé et est servi par un domU nommé niomniom.crans.org. Il est servi par le module python d'apache2. Il devrait également être possible de le servir par un fastCGI (donc en utilisant un serveur web plus léger que apache2), mais l'installation avec le module python d'apache est tellement aisé.
Il ne s'agit pas exactement de la version upstream de MoinMoin, mais de la version debian légèrement modifiée. Le moteur est installé au moyen d'un paquet debian customisé, basé sur le paquet python-moinmoin.
(On pourrait détailler davantage ici la conf d'apache2 qui va notamment:
- rediriger vers une url fully-qualified
- servir le vieux site web en priorité
- forcer le SSL pour les envois de données "sensibles"
- logger là où il faut
- distribuer les ressources statiques de là où elles sont installées
- enfin, il envoie les requêtes au module python)
Apache2 envoie toutes les requêtes à /usr/share/moin/server/moinmodpy.py. moinmodpy va donc charger sa configuration /etc/moin/farmconfig.py, qui est la conf de base fournie par debian (dans /usr/share/moin/config/wikifarm) MoinMoin étant correctement installé, moinmodpy.py n'aura aucun mal à trouver le moteur.
Ainsi la configuration du wiki du crans, /etc/moin/mywiki.py est chargée par wikifarm.py. C'est donc dans ce fichier que se trouvent les détails de configuration du wiki du Crans, dans laquelle sont modifiés les paramètres dont les valeurs par défaut définies dans /usr/share/python-support/python-moinmoin/MoinMoin/config/multiconfig.py ne nous conviennent pas.
Notamment, c'est dans ce fichier qu'est détaillé là où se trouvent les données du wiki, à savoir /var/local/wiki/data. Notons néanmoins que là se trouve installé (en fait linké) des ressources, la documentation (linkée depuis là où elle a été installée par le paquet debian, /usr/share/moin/htdocs/underlay), ainsi que quelques-uns des plugins (qui sont des scripts) depuis /usr/scripts.
On remarquera également que les ressources statiques sont configurés pour être dans les urls en wiki/. Apache sait donc qu'il doit rediriger ces requêtes vers les ressources statiques qui sont dans /usr/share/moin/htdocs, installées par notre paquet debian custom. C'est là que se trouvent donc les icônes ainsi que les css, et les scripts javascript.
Modification de fichiers du paquet de MoinMoin
Pourquoi un paquet debian custom
Les hacks du wiki se sont tout d'abord accumulés dans /usr/scripts. Cela causait une pagaille noire lors de mises à jour de MoinMoin. Il fallait déjà réinstaller tous les hacks, et de nombreux fichiers avaient été copiés depuis les ressources statiques fournies par le paquet dans son ancienne version, puis sauvagement hackés, ce qui les rendaient obsolètes après la mise à jour. Ils étaient donc soit laissés tels quels augmentant ainsi l'entropie, soit sauvagement hackés rendant la chose complètement immaintenable.
L'utilisation d'un paquet custom rend la procédure d'installation complètement triviale. Actuellement, en dehors des modifications apportées dans le paquet pyton-moinmon, le seul fichier qu'il faudra mettre à jour à la main lors des mises à jour est le fichier de conf spécifique au wiki du crans /etc/moin/mywiki.py. Il faudra peut-être aussi convertir les données du wiki, mais nos amis les packageurs de debian veilleront à nous fournir des scripts adéquats.
Les modifications apportés au paquet debian
Elles sont de trois types:
- Hacks sauvages pour gérer de manière plus agréable les permissions et permettre un wiki à deux régimes.
- Modifications assez importantes du code de rendering (et des ressources statiques associées) pour afficher des portails et des boîtes
- Rajout de plugins.
Hacks sauvages
Eux ne portent que sur le code du moteur
Servir en lecture les pages dans la CatégoriePagePublique, à quiconque le demande
- Refuser la création d'un compte crans en dehors de la zone Crans
- Afficher le nom de la machine lors d'une modification effectuée par un anonyme depuis la zone Crans (on a en effet remarqué que bien souvent le propriétaire, ou tout du moins son surnom, pouvait être inféré depuis le nom d'hôte de sa machine.
Forcer un thème en fonction du VirtualHost (un thème de "site web" pour www.crans.org, alors que le thème par défaut est un thème "wiki")
- Modification du template pour dumper le wiki (pour les pages proxy)
==== Modifications du code de rendering ==== Pour pouvoir afficher des boxes et des portails, portent donc à la fois sur les ressources statiques et le code du moteur.
Création de nouvelles primitives de rendering (crans_box et crans_portal)
- Leur implémentation en html
- Leur implémentation en css (ajoutées aux ressources statiques)
- rajout des images nécessaires (ajoutées aux ressources statiques)
Rajouts de plugins
On retrouve dans /usr/scripts/wiki-lenny/share les fichiers de moinmoins que nous avons modifiés nous-mêmes. Pour qu'ils soient utilisés on supprime les originaux dans /usr/share/python-support/python-moinmoin/MoinMoin et on les remplaces par des liens symboliques pointant vers les fichiers correspondant dans /usr/script/wiki-lenny/share. Pour différencier quels fichiers il faut mettre et ne pas mettre on créé un fichier portant l'extension .orig.py pour ceux qu'on utiliser.
Les fichiers qui s'y trouvent sont commités avec la source originale correspondant à la version du paquet debian installé. Les diffs suivants correspondent à nos modifications propres. Les lignes modifiées sont repérables avec les balises
#### HACK SAUVAGE
et
#### FIN DU HACK
Les patchs sont regroupés sur cette page
Ajout de macro/parser/formatter
Parce qu'on aime pimper le wiki, on a rajouter quelques autres formatters et des macros, qui sont stockés dans /usr/scripts/wiki-lenny/local et qu'il faut installer dans /var/local/wiki/data/plugins
Création de parseur
Création de formatter
Ajout de thème
La partie en python s'occupant de la mise en forme est stockée dans /usr/scripts/wiki-lenny/plugins/theme, en effet nos themes persos sont bien des plugins du wiki.
Les éléments graphiques (css et images) sont eux stockés (enfin, c'est vite dit vu le bordel que c'est) dans /usr/scripts/wiki-lenny/static
Comment dumper le wiki
Il est possible de publier des pages du wiki sous forme /statique/ comme on en trouve ici.
Lorsqu'une modification est faite sur les pages du wiki, il faut mettre à jour les pages statiques correspondantes.
Cette manipulation se fait facilement grâce aux scripts fournis avec moinmoin:
- On commence par se logguer sur le serveur sur lequel il y le wiki
On crée un répertoire temporaire destiné à accueillir les futures pages statiques générées (par exemple dans son home ~/dump_temp).
- On peut ensuite lancer le script (en temps que www-data, parce qu'on est pas un gros porc) en lui passant comme arguments, le nom des pages sous forme d'expression régulière et le répertoire de destination des pages statiques. Ex :
sudo -u www-data moin \ --config-dir=/etc/moin --wiki-url=http://wiki.crans.org/ \ export dump \ --page "WiFi(/PositionnementDesBornes|/AvoirLeWifi.*)?" \ --target-dir=/home/myname/outputdir
Les pages générées seront dans le répertoire ~/outputdir et les pièces jointes correspondantes seront dans le répertoire ~/outputdir/attachment. Penser à donner les droits en écriture à www-data.
Ne pas oublier de linker les images (bien souvent dans ./crans/img).
La dernière étape consiste à mettre les fichiers générés : /var/www/wifi