Comment disposer en permanence de la dernière version à jour du logiciel PhpGedView ?
Sommaire
Introduction
PhpGedView est un logiciel particulièrement vivant, puisque le rythme de sortie des nouvelles versions est un des plus rapides dans le monde du logiciel libre. La communauté des développeurs de PhpGedView est donc particulièrement dynamique et productive ! Chaque sortie officielle d’une nouvelle version de PhpGedView est signalée sur la page d’accueil de ce PGVWiki, et est représentée par une suite de 3 chiffres (par exemple la version 4.1.3). Chacune de ces versions contient le cœur du logiciel ainsi qu’une série de modules optionnels tels que par exemple, Googlemaps. Or, dans la réalité, une nouvelle version de PhpGedView n’apparaît pas brutalement de temps à autre : la version de PhpGedView vit tous les jours, au rythme des modifications apportées par l’équipe de développeurs.
Dans le contexte du projet PhpGedView, un dépôt central dit SVN (pour Subversion) enregistre et maintient tous les codes source du logiciel PhpGedView. Les développeurs de PhpGedView qui disposent d’un droit d’écriture au dépôt peuvent effectuer des modifications sur le code et les transférer dans le dépôt afin que tout le monde puisse voir ces modifications et en bénéficier.
Ainsi, la version 4.1.3 porte le numéro de révision 2223 daté du 19 novembre 2007 à 16h02 UTC. De même, la version 4.1 porte le numéro de révision 1399 daté du 6 août 2007 à 17h11 UTC. Au moment où j'écris ces lignes, le logiciel en est au numéro de révision 2436 du 24 décembre 2007 à 16h43 UTC. Ce numéro de révision est une partie de la future version officielle 4.1.4...
Ces versions « stables » sont placées dans le répertoire trunk du dépôt central SVN de PhpgedView.
Quel est l'intérêt de récupérer la dernière version présente dans ce dépot central ?
- en premier lieu, pour disposer en permanence de la dernière version de PhpGedView disponible,
- en second lieu, pour n'avoir qu'à transférer un minimum de fichiers à chaque sortie d'une révision...celà évite ainsi de devoir transférer un nombre trop important de fichiers lors de la sortie d'une nouvelle version officielle...
Ce dépôt central est constitué de cinq répertoires: le répertoire trunk, qui contient la dernière version stable de PhpGedView le répertoire branches, qui contient la prochaine version officiellle de PhpGedView. Attention, cette version est instable ! Il n'est donc pas recommandé de l'installer ! le répertoire tags, qui contient des copies du code source de PhpGedView à chaque fois qu'une version officielle sort. Ce répertoire contient donc les codes sources des versions antérieures: la 4.1.2, la 4.1.1, la 4.1, la 4.0, etc... les répertoires vendor_branches et vendor_tags, qui concernent les sociétés commerciales qui travaillent avec PhpGedView.
Structure des dépôts de PhpGedView
PhpGedView utilise la structure standard suivante pour déposer les différentes versions de son logiciel:
phpgedview/ | |___branches | |___tags | |___trunk | |___vendor_branches | |___vendor_tags
Vous pouvez parcourir le dépôt de PhpgedView en ligne, directement depuis la page d'accueil de Sourceforge, en cliquant dans la barre de menu sur Code --> Svn Browse:
ou en vous connectant directement à cette adresse: [1]
Vous accédez alors à la page suivante qui vous montre l'état d'avancement de chacune des branches. Sur cette image, vous pouvez voir que la branche trunk a été modifiée pour la dernère fois il y a 11 heures par Meliza, et que cette modification porte sur le numéro de révision 2437. Cette révision concerne des traductions réalisées par Matti (Matti's translations)
Trunk (Le tronc)
Le répertoire trunk (tronc) contient la dernière version stable de PhpGedView qui prend en compte la résolution de tous les bugs qui ont été signalés depuis la sortie de dernière version officielle. La plupart des travaux de développement vers la prochaine version officielle sont placés dans une branche différente du répertoire trunk. Cela garantit ainsi la stabilité de la version présente dans le répertoire trunk, c’est pourquoi il vous est conseillé en tant que simple utilisateur (et non développeur) de PhpGedView, d’utiliser la dernière version qui a été déposée par les développeurs dans ce répertoire trunk. Les dépots autres que trunk, sont dédiés à l’usage exclusif des développeurs ou des utilisateurs qui sont prêts à tester une version de PhpGedView qui a encore beaucoup de bugs.
Vous pouvez consulter en ligne le contenu du dépôt trunk en vous connectant à cette adresse: [2].
Il vous suffit alors, sur la fenêtre qui apparaît, de cliquer sur le lien "phpGedView", pour visualiser le contenu détaillé de cette branche.
Tags
Le répertoire tags contient des copies du code source à des instants spécifiques. Chaque fois qu’une sortie officielle d’une nouvelle version de PhpGedView est réalisée, le code est "taggé (marqué)" en copiant le code source présent dans le répertoire trunk dans un sous-répertoire renommé pour l’occasion, du répertoire tags. Ainsi, dans le sous-répertoire stable-4.1 du répertoire tags, se trouve le code source de la version 4.1 stable-4.1 tel qu’il était dans le répertoire trunk au moment de la sortie officielle de cette version 4.1.
Les données qui sont dans le répertoire tags directory shne doivent JAMAIS être modifiées !
Branches
Il existe une branche du dépôt de PhpGedView qui contient la prochaine version officielle de PhpGedView. C’est cette branche qui est utilisée par les développeurs du logiciel PhpGedView. Cette branche a été crée afin de préserver la stabilité du répertoire trunk, ceci afin de permettre au plus grand nombre d’utilisateurs, de bénéficier du code source de la dernière version stable de PhpGedView. Le code source de PhpGedView qui est présent dans le répertoire branches est instable, et peut donc ne pas fonctionner et contenir des fonctionnalités partiellement implémentées. A moins que vous ne soyez vous-même un développeur, vous n’avez a priori aucune raison d’aller chercher le code source dans ce répertoire branch.
Révisions
La dépôt SVN assure lui-même la maintenance de son numéro de révision interne. Cela est différent, et même souvent confus pour ceux qui sont familiers avec CVS dans la mesure où CVS assure la maintenance de numéros de version independants pour chacun des fichiers présents dans son répertoire.
A chaque fois qu’un développeur réalise une modification valide du code source, le numéro interne de révision de dépôt est automatiquement incrémenté. Chaque numéro de révision est effectivement un "tag" (identifiant) qui représente l’état du dépôt après chaque modification du code source. En fait, les numéros de révision peuvent être utilisés pour parcourir le dépôt (ou une partie du dépôt) à différents moments afin de récupérer le code source correspondant strictement au numéro de révision voulu.
Accès au dépôt
Pour pouvoir accéder au dépôt SVN, vous devez installer un logiciel client de Subversion – ces logiciels sont disponibles pour la plupart des systèmes d’exploitation existants : Windows, Linuw, Macintosh,... Le dépôt SVN de PhpGedView est hébergé à cette adresse SourceForge.
Seuls les développeurs qui disposent d’un droit d’écriture dans le dépôt peuvent effectuer des modifications sur le code source, toutes les autres personnes peuvent lire/explorer le code source présent dans le dépôt.
Subversion (SVN) est un logiciel de gestion de version (Version Control System : VCS). Il vous permet de suivre pas à pas toutes les modifications qui sont apportées à tout type de donnée informatique, comme par exemple les codes sources des programmes, les pages web. Subversion est actuellement une alternative au logiciel CVS, qui est également un projet open source (logiciel libre).
Comment utiliser Subversion ?
ETAPE 1
Installer un Client pour Windows
Il existe des logiciels fonctionnant sous Windows qui vous permettront de construire une réplique des fichiers présents dans les répertoires du dépôt central SVN de PhpGedView. Tortoise est l'un d'entre eux: il est facile d'utilisation et peut être téléchargé à cette adresse: http://tortoisesvn.tigris.org/. C'est l'utilisation de ce logiciel qui vous est présentée dans ce Wiki.
Bien que le logiciel Tortoise ne soit pas encore traduit en français, son installation est très simple. Voici l'écran d'accueil qui apparaît lorsque vous lancez le programme d'installation.
Cliquez sur Next> pour démarrer le processus d'installation.
Cliquez sur I accept the terms of the license agreement> sur l'écran suivant.
Puis cliquez sur "Install" pour lancer le processus d'installation.
Une fois que le processus d'installation est terminé, redémarrez votre ordinateur.
Installer un Client pour Linux ou MacOS
Pour les environnements Linux/*BSD/Unix la ligne de commande SVN peut être installée pour la distribution Linux de votre choix. Pour plus d'informations sur les lignes de commande SVN à utiliser, vous pouvez consulter ce site: http://subversion.tigris.org . La liste des clients en mode graphique disponibles sous Linux, est consultable ici: http://www.labo-linux.org/articles-fr/subversion-le-travail-communautaire-sur-fichier/les-outils-pour-subversion
Pour les utilisateurs MacOS X users, vous pouvez télécharger: - le client svnX, en consultant ce blog: http://zine.spip.org/spip.php?article44 - le client Syncro SVN Client que vous pouvez télécharger ici: http://www.syncrosvnclient.com/ sinon, vous pouvez visiter ce site (en anglais) WikiHow.
Checkout
Une fois que votre ordinateur a redémarré pour prendre en compte le logiciel Tortoise, ouvrez l'explorateur Windows et faites un clic-droit n'importe où.
Vous verrez alors apparaître dans le menu qui s'affiche, deux nouvelles entrées dans ce menu: SVN Checkout et TortoiseSVN.
L'étape suivante va consister à récupérer une copie du répertoire trunk du dépôt de PhpGedView sur votre ordinateur – en anglais, cela s'appelle effectuer un “checkout” (une vérification). Cliquez donc dans ce menu sur l'option intitulée "SVN Checkout".
Vous voyez alors apparaître la fenêtre suivante:
Il vous faut alors entrer l'URL suivante dans la case "URL for repository": http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/
Puis en dessous de "Checkout directory", il vous suffit d'entrer le répertoire de votre ordinateur dans lequel vous voulez placer cette copie du répertoire trunk du dépôt de PhpGedView. Vous pouvez par exemple entrer 'SVN checkout". C'est ce nom qui dans la suite de ce tutoriel, désignera le répertoire local de votre ordinateur qui héberge le contenu du dépôt SVn de PhpGedView.
Puis cliquez sur OK.
Votre ordinateur va alors se connecter au dépôt de PhpGedView, et une liste de fichiers va alors défiler pendant toute la durée du téléchargement sur la fenêtre qui apparaît sur votre écran.
La première fois que vous lancerez un "SVN checkout", plus de 3 800 fichiers seront rapatriés sur votre ordinateur, répartis dans plus de 200 répertoires et sou-répertoires, pour une taille de plus de 42 Mb.
Lorsque le téléchargement est terminé, ouvrez votre explorateur Windows et parcourez le contenu de votre répertoire. Le répertoire dans lequel vous avez copié le contenu du dépôt est reconnaissable à la petite flèche verte qui est apposée sur licône du répertoire, ainsi que sur tous les fichiers et sous-répértoires. Cette petite flèche verte indique qu'il s'agit d'un répertoire particulier qui est géré par Tortoise.
Si vous ouvrez ce répertoire, vous constaterez qu'en plus des répertoires habituels de PhpGedView, il y a des répertoires cachés nommés ".svn". Ces répertoires ".svn" sont des marqueurs apposés par le logiciel Tortoise dans tous les répertoires et sous-répertoires de votre répertoire "SVN checkout", afin que le logiciel sache à chaque fois qu'il se connectera au dépôt, quels sont les fichiers qu'il a chargés.. celà permet ainsi à Tortoise de faire très rapidement une comparaison entre le contenu du dépôt SVN de PhpGedView et le contenu de votre répertoire "SVN checkout".
ETAPE 2
Les répertoires ".svn"
Ces répertoires ".svn" n'ont rien à voir avec PhpGedView et n'ont donc pas besoin d'être téléchargés sur votre serveur web pour mettre à jour votre site sous PhpGedView. De plus, ils prennent beaucoup de place. Pour vous donner une idée, ils doublent le nombre et la quantité d'espace disque utilisés par PhpGedView.
C'est pourquoi on va utiliser une fonctionnalité du logiciel Tortoise qui permet d'exporter dans un autre répertoire de votre ordinateur l'ensemble du contenu de votre répertoire "SVN checjout", en filtrant tous les répertoires ".svn".
Préparer le transfert du contenu de votre répertoire "SVN checkout"
Nous allons utiliser la fonction "export" de Tortoise pour créer un répertoire contenant l'ensemble du contenu du dépôt SVN de PhpGedView, en ayant éliminé au prélable tous les répertoires ".svn".
Pour ce faire, placez vous dans votre répertoire "SVN checkout" et faites un clic-droit avec la souris. Le menu qui apparaît a une rubrique “TortoiseSVN”, qui vous mène à la sous-rubrique Export…” Cliquez sur cette sous-rubrique "Export".
Choisissez le répertoire de votre ordinateur qui recevra cette copie exportée et cliquez sur "Créez un nouveau dossier". Cliquez ensuite sur OK.
Ce processus va alors construire une copie locale de votre répertoire "SVN checkout", sans les répertoires .svn.
Attention: ce processusne fonctionne pas actuellement sous Microsoft Vista. Peut-être qu'au moment où vous lirez ces lignes, ce processus fonctionnera !
Une fois que ce processus est achevé, vous êtes prêts à copier le contenu de ce répertoire d'export sur votre serveur web. Mais selon qu'il s'agisse d'un premier transfert en utilisant Tortoise, ou bien d'un des transferts suivants, la méthode d'export et les conditions de transfert sur votre serveur web ne sont pas les mêmes. Il est vous est donc conseillé de bien lire les instructions de l'étape suivante.
ETAPE 3
Il s'agit de la première fois que vous réalisez un transfert suite à la copie via Tortoise du dépôt de PhpGedView
Dans ce cas, vous pouvez considérer le contenu de votre répertoire exportable "SVN checkout" (exportable signifie qu'il s'agit du répertoire "SVN checkout" que vous avez exporté précédemment et non du répertoire "SVN checkout d'origine qui contient les répertoires .svn) comme un package logiciel de n'importe quelle version de PhpGedView, sauf qu'il manque le fichier config.php que vous allez devoir récupérer sur votre serveur web, dans le répertoire de votre installation actuellement utilisée de PhpgedView.
Vous avez dès lors deux méthodes pour transférer le contenu de ce répertoire exportable "SVN checkout":
- Première méthode: vous transférez l'intégralité de ce répertoire dans le répertoire d'installation de votre site PhpgedView, c'est à dire que vous écrasez les fichiers existant sur votre serveur. Cette méthode est déconseillée pour les néophytes, car si le transfert ne se déroule pas normalement ou si vous oubliez de transférer un fichier, votre site ne fonctionnera plus.
- Deuxième méthode: vous conservez sur votre serveur web le répertoire d'installation de votre site PhpgedView actuellement en fonctionnement, et vous allez créer un deuxième répertoire sur votre serveur, dans lequel vous transférerez l'intégralité de votre répertoire exportable "SVN checkout". Cette méthode vous permet d'attendre que votre nouvelle version fonctionne avant d'abandonner la version de PhpGedView actuellement en fonctionnement. C'est cette méthode qui est conseillée !
Une fois que vous avez transféré l'intégralité de votre répertoire exportable "SVN checkout" dans ce nouveau répertoire, vous allez devoir réaliser les opérations suivantes:
- sauvegardez sur votre ordinateur le fichier config.php qui se situe à la racine du répertoire d'installation de votre site PhpGedView actuellement en fonctionnement,
- sauvegardez sur votre ordinateur le répertoire index du répertoire d'installation de votre site PhpGedView actuellement en fonctionnement dans sa totalité,
Puis:
- transférez sur votre serveur web, à la racine du répertoire "SVN checkout", le fichier config.php que vous avez téléchargé sur votre ordinateur,
- transférez sur votre serveur web, à la racine du répertoire "SVN checkout", l'intégralité du répertoire "index" que vous avez téléchargé sur votre ordinateur...vous pouvez écraser le contenu du répertoire index qui a été téléchargé précédemment depuis votre répertoire "SVN checkout"
- lancez votre nouvelle version de PhpGedView,
- indiquez dans le menu administration --> gérer les fichiers gedcom, l'emplacement du répertoire "media" que vous utilisiez avec votre précédente version de PhpGedView, ou bien déplacez votre répertoire media dans le réperoire d'installation de cette nouvelle version de PhpGedView
- indiquez dans le menu Administration --> Configurer PhpGedview --> URL du serveur, le nouveau chemin d'installation de votre nouvelle version de PhpgedView.
Et le tour est joué !
Il ne s'agit pas de la première fois que vous réalisez un transfert suite à la copie via Tortoise du dépôt de PhpGedView
Dans ce cas, lorsque vous ferez un "SVN checkout" avec Tortoise, afin de vérifier l'existence d'une nouvelle révision de PhpGedView, il ne faut transférer que les seuls fichiers qui ont été ajoutés ou modifiés dans cette nouvelle révision de PhpgedView.
C'est pourquoi, il vous faut noter le numéro de révision de PhpGedView la première fois que vous réalisez un transfert suite à la copie via Tortoise du dépôt de PhpGedView.
Ensuite, lorsqu'une opération "SVN Checkout" rapatrie sur votre ordinateur local une nouvelle révision de PhpgedView, il vous faut déterminer la liste des fichiers qui ont été ajoutés ou modifiés depuis la révision précédente afin de ne transférer sur votre serveur web que ces seuls fichiers.
Pour ce faire, il vous suffit d'aller avec l'explorateur Windows dans le répertoire "SVN Checkout" de votre ordinateur personnel, de faire un clic droit avec la souris sur l'icône de ce répertoire "SVN Checkout". En face de "Tortoise SVN", cliquez sur le sous-menu "Show log".
Votre ordinateur se connecte alors au site qui héberge le dépôt central de PhpGedView, afin de récupérer les caractéristiques (numéro de révision, date de révision, auteur des révisions, fichiers objets de chaque révision) de toutes les révisions de PhpgedView. Vous obtenez alors une fenêtre qui ressemble à celle de l'image de gauche. Sur la partie supérieure de cette image, vous avez une zone qui vous affiche la liste des révisions, avec le nom de l'auteur qui est le responsable de cette révision, la date de la révision ainsi qu'un message qui vous indique la nature de la révision.
Si vous pointez votre souris sur une des révisions, vous voyez s'afficher sur la partie inférieure de la fenêtre, le détail de la révision. Ainsi, sur l'exemple de l'image de gauche, vous voyez à propos de révision 2439, que cette révision:
- a été effectuée par canajun2eh (c'est le pseudo de l'un des développeurs de PhpGedView),
- qu'elle a été effectuée le samedi 29 décembre 2007 à 02h50'32",
- que cette révision a consisté à ajouter Malte à la liste des lieux disponibles (Add Malta to place list)
- sur la partie inférieure de l'écran, vous voyez que concrètement cette révision a consisté à ajouter (added) les fichiers suivants: /trunk/phpGedView/places/MLT, /trunk/phpGedView/places/MLT/MLT.gif et /trunk/phpGedView/places/MLT/MLT.htm
Si vous placez votre souris sur la bulle qui se trouve au sommet du graphe (comme sur n'importe quelle bulle du graphe), vous voyez affichées les caractéristiques de cette révision de PhpGedView.
Dans la barre d'outils supérieure, cliquez alors avec votre souris sur la première icône qui suit la case de zoom 100%. Cette case s'appelle "Shows all revisions where changes were made to this item" (afficher tous les changements de révision qui ont été faites sur cet item).
Vous visualisez alors le graphe détaillé de toutes les révisions de PhpGedView. Affichez le sommet du graphe, de manière à voir sur la même fenêtre, la dernière révision de PhpGedView ainsi que la révision qui était celle que vous aviez téléchargé la dernière fois.
Vous cliquez alors sur le rectangle supérieur correspondant à la dernière révision, puis tout en maintenant enfoncée la touche Ctrl du clavier, vous cliquez sur le rectangle correspondant au numéro de révision qui était celle que vous aviez téléchargé la dernière fois. Vous voyez alors apparâitre une petite fenêtre dans laquelle est écrit "compare revisions" et "Unified diff". Cliquez sur "compare revisions".
Vous voyez alors sur votre écran, la liste des fichiers qui ont été ajoutés, modifiés ou supprimés entre ces deux révisions de PhpGedView. Cette liste correspond à la liste des fichiers que devez transférer sur votre serveur web afin de mettre à jour votre logiciel PhpGedView. En fait, vous ne devvrez transférer que les seuls fichiers qui ont été ajoutés ou modifiés, pas ceux qui ont été supprimés !
Pour sélectionner les seuls fichiers qui ont été ajoutés ou modifiés dans cette liste qui s'affiche, sélectionnez avec votre souris les seuls fichiers qui ont été ajoutés ou modifiés dans cette liste en maintenant enfoncée la touche Ctrl du clavier. Vous voyez alors apparaître une petite fenêtre dans laquelle sont écrits les phrases suivantes:
- compare revisions
- blame revisions
- save list of selected files to...
- export selection to...
Cliquez sur "export selection to...".
Ensuite, vous choisissez le répertoire dans lequel vous voulez exporter ces fichiers..vous pouvez appeler ce répertoire par exemple "Export xxxx vers yyyy", où xxxx et yyyy sont les numéros de révision.
La phase d'export se poursuit...et une fois terminée, vous n'avez plus qu'à transférer sur votre serveur web, l'intégralité du contenu de ce répertoire, en écrasant si nécessaire les fichiers existants...
Les erreurs courantes avec SVN
Une erreur courante lors de la phase de vérification (checkout) d’un dépôt est la suivante:
svn: Can't convert string from 'UTF-8' to native encoding:
Cette erreur vient du fait que PhpGedView supporte certains langages qui utilisent des caractères qui ne sont pas reconnus par votre ordinateur personnel. Pour résoudre ce bug, il vous suffit de rendre votre ordinateur compatible avec le format d’encodage UTF-8. Sur les systèmes d’exploitation Linux, vous pouvez vérifier cette compatibilité en tapant depuis la ligne de commande suivante depuis votre terminal:
locale
Vous devez alors obtenir une suite d’instructions qui ressemblent à celles-ci et qui vous indiquent que votre ordinateur personnel ne supporte pas le format d’encodage UTF-8:
LANG=fr_FR LC_CTYPE=" fr_FR " LC_NUMERIC=" fr_FR " LC_TIME=" fr_FR " LC_COLLATE=" fr_FR " LC_MONETARY=" fr_FR " LC_MESSAGES=" fr_FR " LC_PAPER=" fr_FR " LC_NAME=" fr_FR " LC_ADDRESS=" fr_FR " LC_TELEPHONE=" fr_FR " LC_MEASUREMENT=" fr_FR " LC_IDENTIFICATION=" fr_FR " LC_ALL=
En tapant la commande suivante, vous pouvez ajouter le support d’encodage UTF-8:
export LANG= fr_FR.UTF-8
Liens externes
- Site officiel de SVN
- http://subversion.tigris.org/
- SVN sur Wikipedia
- Subversion_(software)
- Documentation en ligne de SVN
- http://svnbook.red-bean.com/
- Documentation de SVN sur SourceForge
- Version control for non-programmers with Subversion
- Command-line SVN client
- TortoiseSVN
- SVN
- Logiciels graphiques de SVN
- TortoiseSVN - Official website
- Subclipse - Official website for the Eclipse plugin
