Developer FAQ

Page waiting for translation. To translate, create an account, go back and clic on "Modify". Page en attente de traduction. Pour traduire, créez un compte, revenez et cliquez sur "Modifier". Página a traducir. Para traducirla, cree una cuenta, vuelva a la página y haga clic en "editar". Pagina da tradurre. Per tradurla, crea un utente, torna indietro e clicca su "modifica". Página a aguardar por tradução. Para traduzir, crie uma conta, volte atrás e clique em "Modificar". Seite wartet auf Übersetzung. Um Übersetzung zu erstellen, richte einen Account ein, geh zurück und klicke auf "bearbeiten". 页面等待翻译。若要翻译本页，先创建一个帐户、登录并返回本页后单击“编辑”。

Retour index
Documentation développeur

Récupérer/mettre à jour une version CVS développeur

Effectuer une sauvegarde de ses données et de sa configuration

Si vous avez déjà une installation en place, sauvegarder votre fichier htdocs/conf/conf.php au cas ou.

Récupération dernière version des sources par download

Cette méthode permet de récupérer la version CVS de la branche de développement principale (appelée HEAD). L'opération consiste à récupérer la dernière version des fichiers de Dolibarr regroupés toutes les nuits dans un zip. Pour cela, voir la version CVS du jour. Les nouveaux fichiers doivent écraser les anciens.

Récupération dernière version des sources par CVS

Pour récupérer la dernière version en cours de développement, vous pouvez aussi directement utiliser le serveur CVS en mode anonyme, si vous disposez d'un client CVS (commande CVS sous Linux, ou TortoiseCVS par exemple sous Windows).

La commande permettant de récupérer un snapshot intégral (sans suivi cvs) dans le répertoire courant est:

CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr
export CVSROOT
cvs -q checkout -r HEAD -d ./ dolibarr/

HEAD signifie qu'on veut la dernière version de la version en cours de développement.

La commande permettant de mettre à jour localement une copie de travail CVS qui a déjà été rappatriée: Sous linux (script shell):

CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr
export CVSROOT
cvs -q update -P -d

Sous Windows avec Tortoise cvs

"C:\Program Files\CVSNT\cvs.exe" -q update -P -d
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr

Et pour remettre au propre votre copie locale en annulant vos modifications sur les fichiers intégrés au cvs:

"C:\Program Files\CVSNT\cvs.exe" -q update -P -C -d
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr

Si besoin, modifiez les droits de propriétaire des dossiers, pour que le serveur y ait accès.

Récupération d'une autre branche par CVS

Si vous désirez une version particulière (avec ces patchs), il vous faut suivre la même procédure que ci-dessus mais en remplaçant HEAD par le nom de la branche. Par exemple DOLIBARR_2_2_BRANCH pour la branche 2.2 ou DOLIBARR_2_4_BRANCH pour la branche 2.4.

Restaurer sa configuration

Restaurer le fichier de configuration (./htdocs/conf/conf.php) d'après sa sauvegarde si vous l'avez écrasé.

Mise a jour de la base

La deuxième étape consiste à migrer la base. Pour celà, il suffit d'appeler la page http://maracinedolibarr/install/ et choisir l'option "Mise à jour".

Cette procédure de migration/mise à jour est conçue pour fonctionner quel que soit l'état de départ et peut être repassée plusieurs fois sans risque.

Démarrer le développement

Consulter intégralement la Documentation Développeur pour assimiler toutes les règles et principes imposées aux développeurs. Vous pouvez aussi consulter les FAQ suivantes.

Comment créer un nouveau theme

Voir pour cela la page Themes

Comment développer mon propre système de menu

Voir pour cela la page Système_de_menus

Comment développer mon propre module

Voir pour cela la page Developpement_module

Comment ajouter ou compléter une traduction

Voir pour cela la page Documentation_traducteur

Changer mon système de numérotation des factures en cours de route

Si le nouveau système de numérotation n'entre pas en conflit avec l'ancien, il suffit d'aller dans le menu Configuration - Modules - Configuration factures et prendre un nouveau modèle dans la liste. Si le nouveau système rentre en conflit, il est nécessaire de renuméroter vos références existantes. Cela peut-être fait avec une requête SQL. Par exemple, pour passer de Jupiter (FYYYYMM99) à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:

update llx_facture set facnumber=concat('FA',substr(facnumber,4,4),'-',substr(facnumber,8))
where facnumber like 'F%' and facnumber not like 'FA%';

Par exemple, pour passer d'un modele FAYYMM999 à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:

update llx_facture set facnumber=concat('FA',substr(facnumber,3,4),'-',substr(CONCAT('0000',substr(facnumber,7)),-4))
where facnumber like 'FA%' and facnumber not like '%-%';

Soumettre un patch, amélioration ou participer au développement

• Avec accès CVS en écriture

A ce jour, les accès en écriture au CVS sont restreints (le nombre de commit étant déjà suffisamment dynamique). Si vous bénéficiez à l'heure actuelle d'un accès CVS en écriture, utilisez-le et à condition que ce qui est commité corresponde bien à votre grade de développeur Dolibarr (Voir FAQ Développeur - Devenir développeur officiel pour les différents grades). Si, vous n'avez pas accès au CVS (vous êtes donc au grade de membre ou chasseur de l'alliance Dolibarr), il est nécessaire de suivre la procédure qui suit...

• Sans accès CVS en écriture

Sans accès CVS en écriture (sans compte développeur savannah), il est nécessaire de fournir par mail, votre fichier patch.

Sous tout OS:

Voici la méthode Pro selon laquelle travailler pour pouvoir générer un tel fichier patch:

- Avoir un répertoire qui contient la version de Dolibarr de référence (résultat de la mise à jour CVS ou bien tout simplement l'arborescence résultant de la décompression d'un snapshot tgz de Dolibarr). On appellera ce répertoire ancien_rep. Vous pouvez récupérer le snapshot de la version de dev en cours sur le site officiel de Dolibarr.

- Avoir un autre répertoire qui contient l'arborescence de Dolibarr mais dans laquelle vous faites ou avez fait vos modifications. On appellera ce répertoire nouveau_rep.

Pour générer le fichier patch, il suffit alors de lancer la commande diff (en standard sous Linux, fourni dans cygwin sous Windows) de la manière suivante:

diff -Naur --exclude=CVS --exclude=".#*" --exclude="*~" --exclude='*.rej' --exclude='*.orig'
 --exclude="*.bak" --exclude=conf.php --exclude=documents  ancien_rep  nouveau_rep  > fichier.patch

Envoyer votre patch sur la ML. L'intégration de votre patch n'est toutefois pas garantie, pas plus que le délai, mais si le patch est réalisé en suivant rigoureusement cette procédure, il a de forte chance d'être au moins testé (dans le cas contraire les chances sont proches de 0).

Sous Windows:

Si vous êtes sous Windows, une méthode moins Pro mais qui donne le même résultat est la suivante. Installer l'excellent outil open source de comparaison Winmerge qui sait fabriquer des patchs au format diff -Naur. Pour cela, comparer avec Winmerge le fichier référence et le fichier modifié et choisir dans le menu "Tools - Generate patch" (Générer des retouches en version française). Saisir un nom de fichier comme "resultat.patch", cocher la case "Append" et choisir l'option "Format Unified" (Style : unifié en version française). Cliquer sur "Ok". Éventuellement recommencer pour chaque fichier modifié. Au final, on obtient un beau fichier resultat.patch qui contient toutes les modifications au bon format.

Au lieu de rechercher manuellement vos fichiers, si vous avez installé conjointement TortoiseCVS et Winmerge, vous pouvez vous contenter de votre version modifiée sur votre ordinateur, et de la version CVS en ligne. Sous l'explorateur Windows, faites un clic droit sur le fichier qui doit être patché, et choisissez "CVS comparer" (pas WinMerge qui se trouve quelques lignes plus bas). Tortoise va lui-même lancer WinMerge. Puis reprenez la procédure décrite ci-dessus.

Appliquer un patch Si votre patch n'a pas encore été appliqué, mais que vous souhaitez de votre coté l'appliquer sur votre serveur linux fraichement mis à jour depuis la CVS, cela est possible grâce à l'utilitaire patch. En admettant que vous avez créé votre patch à partir du répertoire htdocs de votre copie locale du cvs modifiée par vos soins, et que vous avez envoyé votre patch (monfichier.patch) sur le serveur dans le dossier patchs situé au meme niveau que votre dossier htdocs distant, la commande suivante devrait faire l'affaire (executée depuis le dossier patchs):

patch -u -p0 -d ../htdocs < monfichier.patch

Pour information: -p0 permet d'utiliser le chemin entier tel que mentionné dans le fichier de patch (-pn en retire les n premiers niveau de l'arborescence) -d permet de préciser le chemin relatif vers le dossier htdocs à patcher. < permet de donner le chemin vers le fichier source à utiliser (le patch en mode unifié) -u permet de préciser que le patch est en mode unifié

Comment packager/livrer un module pour utilisation

Voir la page Developpement moduel - Créer un package pour livrer et installer votre module

Comment devenir développeur officiel

Dans la galaxie du projet Dolibarr, il existe plusieurs intervenants de différents niveaux/grades. Le nombre de développeurs et contributions est important, or tout projet qui veut atteindre un certains niveau de qualité se doit d'avoir une gestion contrôlée et des modifications validées des évolutions, aussi bien au niveau des besoins fonctionnels que du code. Pour cette raison, les accès en écriture sur les sources (serveur CVS) sont limités et régis par une organisation qui est décrite dans les lignes qui suivent. Chaque développeur a un grade qui dépend de son ancienneté et de ces contributions passées. Le niveau d'habilitation d'une personne sur le projet augmente avec les étapes de promotion de grade.

Le cursus d'un développeur Dolibarr passe donc par ces étapes, que l'on classe par un titre familié aux adeptes de science fiction. Voici ces étapes. Il est important de comprendre que cette organisation a pour seul but d'améliorer la qualité de Dolibarr et qu'il est nécessaire qu'elle soit rigoureusement respectée afin d'attendre ce but. Ne soyez donc pas offensé si, en tant que développeur, vous ne pouvez disposer d'un accès CVS en écriture avant un certain délai.

• Membre de l'alliance

La première chose qu'une personne désireuse d'aide doit faire et d'abord se familiariser avec les règles et normes de développements. En lisant toute la Documentation Développeur, vous faites preuve de volonté suffisante pour devenir automatiquement Membre de l'alliance Dolibarr (Votre grade est au niveau Membre). Et tout lire, c'est pas le plus facile...

Ce grade s'obtient sans validation supérieure.

• Chasseur de l'alliance

L'étape suivante consiste à soumettre des patch, en commençant par des simples, soit sur la Mailing List dev (voir FAQ Développeur pour la procédure), soit sur le forum (Mailing List préférée).

A votre première soumission acceptée (incluse dans le CVS par un Amiral ou Jedi), vous entrez alors automatiquement dans la famille des Chasseurs de l'alliance Dolibarr.

Le nombre de chasseurs n'est pas limité. Plus, il y en aura, plus on sera fort. Les chasseurs représentent la force vive principale de l'alliance Dolibarr.

• Amiral de l'alliance

Ce n'est qu'au bout d'un temps variable (qui peut être très long) au rang de Chasseur, et si la qualité des patch qui ont été envoyés est satisfaisante, qu'un Yoda en place vous offrira un accès CVS direct. Vous êtes devenu un Amiral de l'alliance Dolibarr.

Ce titre ne se demande pas, il s'obtient par décision ou proposition d'un Jedi ou Yoda qui estime que vous avez soumis suffisamment de patch pour être un sérieux Amiral. L'accès CVS d'un Amiral doit cependant n'être utilisé que pour commiter soit des traductions, soit des corrections de bugs déclarées sur Savannah ou le forum (que ces corrections soit personnelles ou issues d'un patch soumis par un Chasseur). Tout commit CVS doit ainsi obligatoirement inclure, dans la description (le champ log de commit), le numéro du bug Savannah corrigé OU le titre du message du forum signalant le problème. Seul une traduction échappe à cette contrainte (pas de restrictions pour les traductions). Le non respect de cette contrainte, peut provoquer une rétrogradation au rang de Chasseur. Pour la soumission de nouvelles fonctionnalités, il faut donc obligatoirement continuer sur le principe de patchs envoyés sur la ML.

L'obtention du grade d'Amiral est toutefois rare car limité. La qualité de Dolibarr ne pouvant être atteinte que par un nombre d'Amiraux contrôlé, ce qui n'empêche pas d'avoir un nombre de développeurs (Chasseurs) très important (grâce au système de patch).

• Jedi

C'est encore au bout d'un temps variable (sûrement le plus long de tous) au rang d'Amiral, et si la qualité des patch qui ont été envoyés est satisfaisante, qu'un Yoda vous signalera que vous êtes autorisé à réaliser des commits sans restrictions de fonctionnalités, à condition d'avoir cependant l'aval de principe d'un Maitre Yoda à qui vous aurez expliquer la fonctionnalité. Il peut toutefois y avoir une restriction temporaire définie par un Yoda pour raison de release proche. Vous êtes alors devenu un Jedi.

Ce titre ne se demande pas, il s'obtient par proposition d'un autre Jedi ou d'un Yoda.

Ce privilège est toutefois exceptionnel. La qualité de Dolibarr ne pouvant être atteinte que par un nombre de Jedi contrôlé, ce qui n'empêche pas d'avoir un nombre de développeurs (Chasseurs) très important (grâce au système de patch).

• Yoda

Au nombre de 1 à 5, être un Yoda, c'est assurer la gestion globale du développement du projet. Ce rang s'obtient par succession, suite au départ d'un Yoda qui se retire, par nomination directe ou vote organisé par le Yoda partant.

...Et Dark Vador alors ?

Il existe. Dans la galaxie Dolibarr, on qualifie de Dark Vador, le parasite qui pollue le forum ou la mailing-list de messages ou critiques non constructives, qui ralentissent le développement de Dolibarr plutôt que d'offrir des critiques constructives qui aident à progresser. La mauvaise foi ou le mauvais ton est souvent de rigueur chez les Dark Vador... Heureusement, statistiquement, on ne constate l'apparition et la mort que d'un seul Dark Vador par an environ...

Voir la page Le projet Dolibarr pour connaitre la liste des personnes à chaque grade actuellement.