V5 CPLcommun - Forks
CPLcommun - Forks
Fork est un mot anglais signifiant fourche ou bifurcation en français. Il est utilisé dans le monde du logiciel libre pour désigner un logiciel issu d'un autre et réalisant essentiellement les mêmes fonctions. Par exemple, libre office est un fork d'open office. J'utilise ici, abusivement, le mot fork pour toute modification que j'apporte à un fichier de GuppY. Je n'ai pas l'intention de créer un GuppY bis, mais pour les besoins de certains plugins ou pour des fonctionnalités originales, je modifie plus ou moins certains programmes. Le but de cet article est de décrire comment, au cas où il y aurait un problème, bien que toutes les assurances soient prises.
La bibliothèque contient 2 fonctions pour gérer les forks. La première (estForkInstalle) teste si un fork est installé. La seconde (cpl_fork) installe ou supprime un fork. Elles sont appelées au moment de l'installation d'un plugin ou de sa configuration.
Un fork a un nom (obligatoire) et peut contenir un commentaire. Il agit sur un seul fichier mais peut faire des modifications à plusieurs endroits.
Lorsqu'un fork est appliqué, la méthode est toujours la même :
- le fichier d'origine est dupliqué sous le nom
nomfichier concaténé avec CPL_FORK_nomfork_date - une portion de texte est recherchée.
- elle est rendue inactive en l'entourant des caractères /* et */
- devant le premier /* est ajouté un commentaire
// date - DEBUT CPL FORK nomfork - commentairefork - Vient ensuite la modification
- suivi d'un nouveau commentaire
// date - FIN CPL FORK nomfork - commentairefork.
S'il y a un souci, vous n'avez qu'à renommer le fichier sauvegardé. ATTENTION: si vous appliquez plusieurs forks sur le même fichier, il est sauvegardé autant de fois.
Lorsqu'un fork est supprimé, il est recherché sur son nom, les lignes inactivées sont réactivées, les lignes ajoutées sont supprimées ainsi que les commentaires. Le fichier de sauvegarde n'est pas supprimé. C'est à vous de le faire, si vous le souhaitez. Avec la date et le nom, vous avez un historique des forks qui ont été appliqués; il est peut-être intéressant de les conserver.