Authentification

2011-09-25T19:42:32Z

Graveen:

[[Category:Noyau]]
{{TemplateDocDev}}

= Introduction =
Le système d'authentification de Dolibarr devient relativement complexe, et un bug peut être particulièrement difficile à trouver si l'on ne connaît pas le processus d'authentification.
Cette page présente une découpe du processus, qui permet de suivre la procédure et d'intervenir là où il le faut. Une connaissance de la notion de session PHP est requise.

= Processus =
Le processus démarre par l'appel de la page que l'on souhaite voir. Par exemple, la page d'accueil htdocs/index.php. Mais ce n'est pas ce fichier assure la demande d'authentification. En fait toute page de Dolibarr inclut un fichier pre.inc.php qui lui même inclut le fichier main.php qui inclut master.php.
Nous avons donc:
<source lang="php">
<mapage.php>
<main.inc.php>
<master.inc.php>
#1#
</master.inc.php>
#2#
if (! isset($_SESSION["dol_login"]))
{
if (isset($_POST["username"]))
{
...
// if user and pass are ok, we set $login
$login=
}
if (! $login)
{
// We show login page
include_once(DOL_DOCUMENT_ROOT."/lib/security.lib.php");
dol_loginfunction($langs,$conf,$mysoc);
exit;
}
...
}
</main.inc.php>
#3#
</mapage.php>
</source>

Le #1# représente le chargement de tout un tas de librairie que nous utiliserons par la suite, ainsi que l'initialisation du contexte d'exécution du code PHP (langue, configuration, utilisateur vierge).

Le #2# represente le code d'authentification: Le programm vérifie si on est dans une session logguée (cela signifie que $_SESSION["dol_login"] existe). Si non, on vérifie si on a reçu des données issu du formulaire de login/mote passe. Au premier appel, ce n'est pas le cas puisque nous n'avons pas encore eu le formulaire à l'écran. Donc on continue et $login est faut, aussi on affiche alors le formulaire HTML et le script se termine.

Après la soumission du login, la même page (donc index.php) est appelée, nous allons toujours dans le #1#, puis #2# et cette fois $_POST["username"] est défini. Aussi nous vérifions si le user et mot de passe sont ok (la vérifivation est faite dans la base, en LDAP ou autre, cela dépend de la variable $dolibarr_main_authentication du fichier de configuration). Si le couple login/pass est ok, la variable $login est définie, aussi nous n'affichons pas à nouveau le formulaire mais nous conitnuons et positionnons $_SESSION["dol_login"], ainsi au prochain appel d'une page, nous ne rentrons plus dans le "if (! isset($_SESSION["dol_login"]))".

Le #3# correspond à la vérification des permissions métiers et à l'affichage de la page si c'est ok. Voir la page See [[Permissions]] pour plus d'informations.

= Les modules de login =

Les modules de login sont les fichiers qui contiennent les fonctions qui contrôlent la validité d'un couple user/password.
Il y a un fichier par module. Chaque fichier assure un type de contrôle différent.
* Le fichier '''htdocs/include/login/functions_http.php''' contrôle la validité du couple user/mot de passe par une authentification de type http Basic.
* Le fichier '''htdocs/include/login/functions_ldap.php''' vérifie la validité d'un couple user/mot de passe dans un annuaire LDAP.
* Le fichier '''htdocs/include/login/functions_dolibarr.php''' vérifie la validité d'un couple user/mot de passe dans la base de donnée Dolibarr.

Chaque fichier contient en fait uniquement une fonction '''check_user_password_xxx''' mais Dolibarr ne va en utiliser qu'un. Ce sera celui dont la valeur '''xxx''' correspond a la valeur de la variable '''dolibarr_main_authentication''' du fichier '''conf/conf.php'''.
Dans ce fichier, Dolibarr sollicite la seule fonction qui s'y trouve en envoyant comme paramètres le user et mot de passe.La fonction renvoie vrai si le couple est valide.

Outils de développement

2011-09-25T17:13:57Z

Graveen: /* Si vous êtes sous Windows */

{{TemplateDocDev}}

Tout environnement de développement peut être utilisé.
Toutefois voici une liste d'outils fortement recommandés pour leur complétude, leur qualité et la productivité du développement qu'ils apportent. Ils sont utilisés par la plupart des développeurs principaux de Dolibarr. Notons que toutes ces solutions sont gratuites et OpenSource.

= [[File:Eclipsephp.jpg]] Pour tout développeur =

Voici le socle de travail recommandé, toutefois tout outil respectant les standards Web, PHP, Mysql peuvent faire l'affaire.

== Un serveur AMP ==

* Apache, Mysql et PHP

Sur Linux: Ces 3 produits sont disponibles dans toutes distributions.

Sur Windows: Installez [http://www.wampserver.com/ WampServer 2] (base Mysql, Apache et PHP tout clé en main). Ce serveur WAMP offre le trio MySql+Apache+PHP, avec possibilité de basculer de version pour n'importe lequel de ces composants d'un simple clic).

== Firefox et plugins ==
* Firefox avec les plugins:
** Firebug + Firecookie,
** HTML Validator,
** Phplangeditor et les Dictionnaires des langues si vous compter traduire
** User agent switcher pour simuler des accès depuis un smartphone
** Selenium IDE
** Cert Viewer Plus si vous comptez faire des tests en HTTPS,
** QuickProxy si vous voulez basculer rapidement votre navigateur vers des utilitaires Proxy (WebScarab)...
A télécharger depuis le site http://www.firefox.com

== SquirrelSQL ==
* SquirrelSQL pour l'administration de base
A télécharger depuis le site http://squirrel-sql.sf.net

== Eclipse et plugins ==
=== Installation d'Eclipse ===
Nous recommandons la version suivante d'Eclipse:

{{DownloadEclipse}}

Sinon toute version disponible sur le site [http://www.eclipse.org Eclipse] fait l'affaire.

=== Installation du plugin Eclipse pour PHP: PDT. ===
Avec certaines installations d'Eclipse, PDT peut etre installé depuis Help -> Install new software et choisir PDT.
Si PDT n'est pas présent, si vous avez installé la version Eclipse ci-dessus, il suffit d'utiliser la procédure Help -> Install new software -> Add -> Archive pour installer le package complémentaire:
{{DownloadEclipsePDT}}

=== Configurer Eclipse pour récupérer la version CVS ===

Une fois qu'Eclipse est installé, vous pouvez vous connecter au repository CVS pour y récupérer la dernière version de développement.

* Créer un nouveau projet : File >> New >> Projects puis sélectionner "Project from CVS" et "Next"
* Sélectionner "Create a new repository location" puis "Next"
* Remplir la fenêtre suivante comme ceci :
** Host : '''cvs.savannah.nongnu.org'''
** Repository path : '''/cvsroot/dolibarr'''
** User : '''anonymous''' (ou '''login savannah''' si vous avez un compte [http://savannah.nongnu.org/projects/dolibarr/ savannah])
** Password : (laisser vide)
** Connection type : '''pserver''' (ou '''ext''' si vous avez un compte [http://savannah.nongnu.org/projects/dolibarr/ savannah])
** Use default port
* Ensuite remplir le champ Use specified module name : '''dolibarr''' ou '''dolibarrmod''' pour le modules externes
* Choisir ensuite le nom que le projet aura sur votre machine :
** Cocher Check out as a projet in the workspace
** Project Name : '''dolibarr''' ou '''dolibarrmod''' pour le modules externes
** Cocher Checkout subfolders
* Ensuite, laisser le chemin par défaut du workspace et "Next"
* Enfin, sélectionner la branche à charger
** HEAD est la version de développement
** Les versions 2.6, 2.7, etc., se trouvent dans Branches
* Cliquer sur "Finish"

Les fichiers devraient être téléchargés sur votre disque dur.

Pour ensuite mettre à jour la version de votre machine, il faut passer en perspective "Team Synchronizing" pour utiliser la fonction "Synchronize CVS", ce qui aura pour effet de télécharger les dernières versions sur votre disque dur. Seuls les fichiers qui ont été modifiés sont téléchargés.

= [[File:Computer.png]] Optionnel =

== Installation du plugin Eclipse pour GIT ==
* Installation du plugin Git pour Eclipse: EGit.
Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour:

http://download.eclipse.org/egit/updates

Puis installer le composant EGit.

== Si vous gérez d'autres projets sous SVN ==
* Installation du plugin SVN pour Eclipse: SubClipse.
Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour:

http://subclipse.tigris.org/install.html

ou bien
* Installation du plugin SVN pour Eclipse: Subversive
http://community.polarion.com/projects/subversive/download/eclipse/2.0/ganymede-site/ - [required] Subversive SVN Connectors

http://community.polarion.com/projects/subversive/download/integrations/ganymede-site/ - [optional] Subversive Integrations

== Si vous désirez faire des scripts en Perl ==
* Installation du plugin Eclipse pour Perl: EPIC
Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://e-p-i-c.sourceforge.net/updates

== Si vous désirez développer des modules avec le générateur UML2Dolibarr ==

Une méthode pour générer un module fonctionnel depuis l'UML est en cours de mise au point.
Plus d'informations sur la page [[UML2Dolibarr - Générer un module par MDA]].
Pour l'utiliser, vous devez installer les composants suivants (si vous avez installé la version d'Eclipse recommandé plus haut, tout ceci est déjà fait):

* Installation de TopCased 1.4 ou +: http://www.topcased.org

* Installation d'acceleo 2.2.1 ou +: Pour cela, utiliser la procédure '''Find And Install''' et ajouter l'URL de mise à jour: http://www.acceleo.org/update/

* Installation d'UML2Dolibarr
Pour cela, récupérer les projets par la commande:
<source lang="bash">
svn checkout svn://svn.forge.objectweb.org/svnroot/acceleo/trunk/modules/community/uml21/dolibarr/trunk/
</source>
et les importer dans Eclipse.

== Si vous êtes sous Windows ==

* Notepad++ (pour ceux qui ne supportent pas java ou utilisent un vieux coucou trop faible pour Eclipse).

* WinMerge (pour la comparaison de fichiers ou répertoires)

* CygWin (pour la commande patch et la commande en ligne cvs si vous préferez les lignes de commandes)

A noter que Netbeans-PHP fonctionne efficacement avec Dolibarr.

== Si vous désirez faire du debuggage pas à pas ou du tunning (XDebug) ==

* Pour ajouter des infos de tuning page sur la barre d'état du navigateur, ajouter la variable d'environnement DOL_TUNING à 1 dans Apache. Pour cela, inclure la ligne suivante dans votre fichier apache.conf:
<source lang="ini">
SetEnv DOL_TUNING 1
</source>
Enuite, vérifier que votre navigateur n'a pas d'option pour bloquer la modification de la barre de tache par le javasscript.

* Pour du tuning à la ligne de code près, installer XDebug:
=== [[File:Logo_windows.png|24px]] In Windows ===
* Télécharger le fichier dll '''php_debug_xxx.dll''' sur http://www.xdebug.org et stocker le dans le répertoire /ext de php. Ensuite activer le plugin.

* Modifier le ficiher php.ini ou xdebug.ini pour ajouter le paramètres suivant:
<source lang="ini">
[xdebug]
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.profiler_enable=1
xdebug.show_local_vars=off
xdebug.profiler_output_dir=c:/temp
xdebug.profiler_append=0
</source>

=== [[File:Logo_ubuntu.png|24px]] In Ubuntu / Linux ===
* Installer le package '''php-xdebug''':
<source lang="bash">
sudo apt-get install php5-xdebug
</source>

* Modifier xdebug.ini pour ajouter les parmètres suivants après les lignes de type zend_extension=xxx (ou similaire):
<source lang="ini">
xdebug.remote_enable=on
xdebug.remote_handle=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.profiler_enable=1
xdebug.show_local_vars=off
xdebug.profiler_output_dir=/var/tmp
xdebug.profiler_append=0
</source>

=== [[File:Eclipsephp.jpg|24px]] Eclipse configuration ===
* Ouvrir Eclipse. Dans Window->Preferences->General->Web Browser, sélectionner navigateur externe, et choisisser le navigateur par défaut de votre système.

* Aller dans la rubrique Window->Preferences->PHP->Debug, et positionner les options PHP Debugger à XDebug. Remarquer que la case “Stop a la première ligne” sur cette page doit également être active. Vous pourrez la modifier plus tard.

* Après avoir validé les changements, aller dans la vue PHP Debug prespective, puis aller dans le menu Debug Configurations… Ici, vérifier que le Server Debugger est positionné à XDebug, et que votre server PHP pointe sur http://localhost/ ou le chemin approprié au serveur. La zone de localisation des fichiers doit de plus pointer sur le fichier à débugger, relativement à votre workspace. Ce chemin doit être quelquechose comme /dolibarr/htdocs/index.php.

* Vérifiez la section URL pour voir si elle pointe correctement – si non, vérifier que la case “Auto-Generate” est bien décochée, et entrer manuellement le bon chemin. Appliquer les changement et fermer la fenêtre de dialogue.

* Vous devriez maintenant être prêt pour lancer du debug de Dolibarr. Cliquer sur Run->Debug ou F11 pour activer le debug, Eclipse devrait basculer sur la vue Debug, et la page devrait commencer à se charger dans le navigateur externe. Si la case “Break at First Line” a bien été cochée précédemment, alors le programme aura stoppé à la première ligne. Vous pouvez alors faire du pas à pas sur les lignes de code successives en utilisant les boutons de la barre de Debug d'Eclipse. Eventuellement, vous pouvez placer des point d'arrêts à différents endroits du code pour y stopper l'exécution du code.

* Ensuite pour analyser les fichiers de profiling générés par XDebug, vous pouvez installer KCacheGrind (Linux) ou WinCacheGrind (Windows).

== Pour développer ou utiliser les tests PHPUnit ==
=== Depuis Eclipse ===
La meilleure méthode est d'installer les PHP Tools integration (PTI) pour Eclipse, en utilisant l'URL suivante via l'interface d'installation de plugins Eclipse:

http://www.phpsrc.org/eclipse/pti/

En faisant cela, l'installation et l'exécution de tests PHPUnit est directement intégré à votre Eclipse. Modifier la configuration dans Eclipse (Windows-Preferences-PHPTools-PHPUnit) comme sur la copie écran suivante (cliquer pour zoomer):

[[File:Eclipse setup PHPUnit.png|100px]]

Sinon, il faut réaliser une installation et exécution en manuel en ligne de commande.

=== En ligne de commande manuelle ===
==== Installer PHPUnit ====
* Télécharger l'archive de la version sur http://pear.phpunit.de/get/ et dézipper le contenu dans un répertoire inclus dans le paramètre include_path de votre fichier de configuration php.ini.
* Préparer le script phpunit:
** Sur Linux: Renommer le script phpunit.php script en phpunit et remplacer la chaine @php_bin@ dans ce fichier avec le chemin complet de la ligne de commande de l'interpréteur PHP (en général /usr/bin/php).
** Sur Windows: Remplacer la chaine @php_bin@ dans le fichier phpunit.bat avec le chemin complet de la ligne de commande de l'interpréteur PHP et remplacer la chaine @bin_dir@ avec le répertoire de PHPUnit.
** Modifier votre PATH pour inclure le répertoire contenant phpunit.
** Donner les permissions de s'exécuter (chmod +x phpunit sur Linux).
* Préparer le script PHPUnit/Util/PHP.php:
** Remplacer la chaine @php_bin@ dans ce fichier avec le chemin complet de la ligne de commande de l'interpréteur PHP (en général /usr/bin/php).
* Le module xdebug est également requis si vous voulez faire du reporting de couverture de tests.

==== Exécuter les tests PHPUnit ====
* Aller dans le répertoire '''/test''' de la version CVS. Reportez vous au fichier '''README''' pour connaitre la procédure pour lancer une campagne de tests.

== Pour développer ou utiliser les tests Selenium ==
=== Depuis Firefox ===
==== Installer le plugin pour Firefox Selenium IDE ====
* Télécharger le fichier du plugin Selenium IDE pour Firefox.
* L'ajouter dans Outils - Modules complémentaires de Firefox.

==== Exécuter les tests Selenium ====
* Aller dans le menu Outils - Selinum IDE de firefox.
* Ouvrir le fichier de tests xml
* Executer le test.

== Pour générer la documentation Doxygen ==
* Installer Doxygen disponible sur http://www.doxygen.org (ou par le package doxygen sous Ubuntu).
* Installer le plugin Eclipse en ajoutant l'url source http://download.gna.org/eclox/update/ dans l'outil de mise à jour Eclipse puis configurer Eclipse pour indiquer l'emplacement de Doxygen (Window-Preferences-Doxygen).

= [[File:Art.png]] Configuration repository CVS =
Si vous êtes un développeur officiel avec accès CVS en écriture, ajouter dans la configuration CVS de votre Eclipse, une entrée CVS.

* ''':ext:yourlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarr''' pour la version principale de Dolibarr
* ''':ext:yourlogin@cvs.savannah.nongnu.org:/cvsroot/dolibarrmod''' pour les modules externes

Sinon il vous faut récupérer les sources depuis le tarball disponible sur le site web Dolibarr ( http://www.dolibarr.fr ) dans l'espace téléchargement

Dolibarr ERP CRM Wiki - User contributions [en]

Authentification

Outils de développement