LABINVENT (InventIrap)

h1. INVENTIRAP WIKI

{{toc}}

Nouveau wiki en cours (sur gitlab): https://gitlab.irap.omp.eu/epallier/labinvent/wikis/home

-----------------

h2. INSTALLATION DU LOGICIEL (HOWTO)

-----------------

(Pour les developpeurs avec Eclipse, voir aussi le document install/manual_install/INSTALLATION_MANUELLE_mode_expert.txt)

(Une fois l'installation terminee, les developpeurs devraient aussi lire le document docs/HOWTO.txt) 

LabInvent est un logiciel multi-plateformes (Linux, Mac OS X, Windows), il nécessite les services suivants :

- serveur web (Apache)

- serveur de base de données (Mysql)

- interpréteur Php 5.3+ (minimum)

Il est aussi conseillé d'avoir un "phpmyadmin" installé pour pouvoir gérer manuellement la base de données

Il a été testé avec les configurations suivantes :

- OS : CentOS 6.2 et 6.6, Mac OS 10.7, Windows 7

- PHP : 5.3, 5.4, et 5.6

- Mysql : 5.1, 5.6

- Apache : 2.2.14, 2.2.15, et 2.4.10

Le projet occupe un espace d'environ 190 Mo (environ 370 Mo si versionné avec svn).

ATTENTION, pré-requis : 

1) Apache rewrite activé 

Le module rewrite d'apache doit etre chargé et actif. 

Pour verifier le chargement, phpinfo affiche la liste des modules d'apache pris en compte. 

2) Le projet necessite la librairie gd (utilisee par php), sans quoi vous aurez une erreur (fatale) 

lors de la visualisation de la fiche d'un materiel (qui contient l'image d'un QRCode). 

(Pour info, c'est la librairie phpqrcode, dans cakephp/app/Vendor, qui génère le QRCode et donc utilise gd, par exemple pour appeler des fonctions telles que ImageCreate...)

Il faut donc vérifier que gd et php-gd sont installés :

- gd => on l'installe avec "yum install gd" sur CentOS

- php-gd doit etre installé avec la bonne version, c'est à dire celle du php que vous utilisez 

(par exemple, si php 5.4, installer php-gd version 5.4) => on l'installe avec "yum install php-gd" sur CentOS 

(Pour info, la librairie phpqrcode necessite aussi la librairie zlib qui offre les fonctions gzcompress, gzuncompress, etc.)

-----------------

h3. INSTALLATION

-----------------

Pour une MISE A JOUR du logiciel, aller directement à la fin de ce document, a la section MISE A JOUR (UPGRADE)

Il y a deux façons de l'installer :

- Pour une installation manuelle (mode expert) allez dans le sous-repertoire manual_install et lisez le document INSTALLATION_MANUELLE_mode_expert.txt

- Sinon (méthode conseillée), si vous voulez une installation complètement assistée (avec questions/réponses), poursuivez la lecture de ce document.

(NB : l'ancien script d'installation fourni à l'origine par Upsilon s'appelle install-upsillon.sh, il n'est plus a jour)

Nous vous préconisons d'installer le logiciel en mode "SANS LDAP", et d'activer le mode "AVEC LDAP" par la suite, si vous en avez besoin.

Pour cela, suivez les instructions ci-dessous.

Si ce n'est pas déjà fait, récuperer l'archive labinvent.tgz

Placer cette archive à l'endroit voulu, 2 possibilités :

- (1) soit vous placez cette archive directement dans le repertoire des sites webs du serveur web (par exemple /var/www/html/)

- (2) soit vous la placez n'importe où ailleurs (par exemple dans votre repertoire home), et ensuite vous indiquerez au serveur web où trouver ce projet

Dézipper l'archive :

	tar xvfz labinvent.tgz

	=> cela crée un dossier labinvent_1-3-xxx/

Aller dans le repertoire d'installation :

	cd labinvent/install/

Exécuter le script d'installation :

	./installation.sh

(vous pouvez le faire en tant qu'administrateur "root", mais ça n'est pas nécessaire, le script fera quelques petits "sudo" seulement quand nécessaire).

(Conseil : à la plupart des questions, laissez les réponses par défaut)

(Comme expliqué au début, faites une installation en mode "sans LDAP")

Autoriser les fichiers .htaccess sur le site :

(cf http://book.cakephp.org/2.0/fr/installation/url-rewriting.html)

Dans le fichier httpd.conf de Apache, si vous avez deja quelquechose comme ceci, cela suffit :

<Directory />

    Options FollowSymLinks

    AllowOverride All

#    Order deny,allow

#    Deny from all

</Directory>

Sinon, vous pouvez ajouter ceci, uniquement pour Labinvent :

<Directory /labinvent>

    Options FollowSymLinks

    AllowOverride All

</Directory>

NB : si labinvent n'est pas dans le repertoire des sites webs, il faut mettre son chemin absolu a la place de /labinvent :

<Directory /chemin/abosolu/vers/labinvent>

Tester l'accès web à l'application :

- (1) Si vous avez placé le logiciel directement dans le repertoire des sites webs du serveur web :

	=> tester l'url http://localhost/labinvent/cakephp

- (2) Si vous avez placé le logiciel dans un autre repertoire, par exemple /home/votre_nom/ :

	Faites un lien nommé "labinvent" dans le repertoire des sites webs du serveur web (par exemple /var/www/html/), qui pointe vers le repertoire "cakephp" du logiciel :

	=> cd /var/www/html/

	=> ln -s /home/votre_nom/labinvent/cakephp/ labinvent

	=> puis, tester l'url http://localhost/labinvent/

	(Si vous ne voulez ou ne pouvez pas utiliser un lien, vous pouvez plutôt créer un Virtual Host, voir tout à la fin de ce doc, la section "VIRTUAL HOST") 

Tester le bon fonctionnement de l'application :

- Connectez-vous au logiciel (normalement, vous etes le super administrateur) avec votre login (ldap), SANS MOT DE PASSE (grâce au mode "SANS ldap")

- Vous etes maintenant sur la page d'accueil générale ; vous devez voir votre nom s'afficher :

"Vous êtes connecté en tant que <vos nom et prénom> et avec le niveau d'authentification Super Administrateur"

- Cliquez un peu partout pour voir si tout s'affiche bien sans erreur (par exemple, "Liste des matériels" doit afficher 0 matériel...)

- Cliquez sur Outils, puis "Gérer les utilisateurs privilégiés" : vous devriez voir un seul utilisateur dans la liste, le "super administrateur" (a priori vous)

- Déconnectez-vous du logiciel 

Voila, felicitations, votre installation fonctionne !

Pensez à personnaliser les 2 fichiers logos suivants dans cakephp/app/webroot/img/ :

	- logo_entity.jpg : le logo du laboratoire

	- logo_software.jpg : le logo du logiciel

-----------------

h3. PASSAGE EN MODE "AVEC LDAP" (facultatif) :

-----------------

Maintenant, si vous le désirez, vous pouvez ajouter la connexion au LDAP :

- soit en refaisant une nouvelle installation complète, qui incluera cette fois-ci une connexion au LDAP, 

	mais il faudra répondre à nouveau à toutes les questions

- soit (méthode conseillée) directement à la main dans votre fichier de configuration comme ceci :

	Editer votre fichier de configuration cakephp/app/Config/labinvent.php, chercher la section ci-dessous, 

	et remplacer chacune des valeurs par celles concernant votre LDAP.

	Attention, il faut bien mettre USE_LDAP à la valeur TRUE :

	'USE_LDAP' => TRUE,

	'ldap' => array (

		'host'		 			=> 'ldap-servername-or-ip',

		'port'					=> '389',

		'authenticationType'	=> 'cn',

		'baseDn'				=> 'ou=users,dc=irap,dc=omp,dc=eu',

		'filter'				=> '(cn=*)'

	),

Pour tester que votre connexion LDAP fonctionne bien,

connectez-vous au logiciel d'inventaire avec votre login ldap, et cette fois-ci AVEC votre mot de passe LDAP 

(normalement, vous ne devriez plus pouvoir vous connecter sans mot de passe)

Voila, vous devriez maintenant etre connecte sur le logiciel avec votre login ldap et avec le profil "super administrateur" 

La base de donnees est actuellement vide. Vous pouvez donc commencer à alimenter le logiciel avec quelques données.

Pour cela, poursuivez votre lecture.

-----------------

h3. PARAMETRAGE DU LOGICIEL (PERSONNALISATION)

-----------------

Vous devez maintenant personnaliser le logiciel à partir des données concernant votre entité (laboratoire).

Pour cela, éditer le fichier de configuration cakephp/app/Config/labinvent.php et adapter la valeur des paramètres

contenus dans le tableau "localisation".

		'localisation' => array(

			// Nom de l'entité (laboratoire) :			

			//'labName' => "IRAP",

			'labName' => "LABONAME",

			...

		), // $localisation

-----------------

h3. ALIMENTATION DE LA BASE DE DONNEES

-----------------

En ce qui concerne le rôle quotidien des personnes de l'administration sur ce logiciel, voir le document Inventirap_AdministrationUser_Manual.docx dans le dossier docs/

En ce qui concerne les possibilites offertes à tout utilisateur (non privilegie) de ce logiciel, voir le document Inventirap_User_Manual.docx dans le dossier docs/

Ici, nous allons plutot expliquer comment commencer a alimenter la base de donnees du logiciel (a priori vide) avec un minimum de donnees 

afin de rendre possible la saisie de l'inventaire materiel. En effet, pour pouvoir saisir des materiels dans l'inventaire, 

il vous faut au prealable :

1) definir quelques utilisateurs PRIVILEGIES (comme vous, mais avec des profils moins forts comme "administrateur", "responsable"...)

qui seront habilites a faire cette saisie (notamment le personnel administratif) ; attention,

tout utilisateur (du LDAP) non privilegie peut entrer un nouveau materiel dans l'inventaire, mais seul le personnel administratif 

pourra ensuite faire la saisie des informations administratives et valider la fiche materiel...

2) definir quelques domaines et categories (et éventuellement des sous-categories si vous en avez besoin), qui permettront de classer le materiel

3) (FACULTATIF) definir des groupes metiers (auquels on pourra associer les utilisateurs mais aussi les materiels) et groupes thematiques (associés aux materiels)

=> Pour ces 3 premiers points, lire le document Inventirap_AdministrationUser_Manual.docx (dans le dossier docs/) au chapitre 2 "Les outils"

On pourra ensuite enfin commencer la saisie des materiels

=> Sur ce point, lire le document Inventirap_User_Manual.docx (dans le dossier docs/) au chapitre 3, en particulier 3.2 "Saisie de materiel"

-----------------

h3. LOGS (facultatif)

-----------------

Un fichier de log est créé et alimenté par l'application.

Il s'agit de cakephp/app/tmp/logs/labinvent.log

-----------------

h3. INSTALLATION DES ETIQUETEUSES (facultatif)

-----------------

Si vous désirez imprimer des étiquettes (ruban) à coller sur les materiels inventoriés,

il vous faut installer une ou plusieurs étiqueteuses (au moins une) sur les postes clients.

Voici la procédure à suivre pour installer une étiqueteuse sur un poste client :

1) Acheter la bonne imprimante (!) 

L'imprimante configurée est une "DYMO LabelManager PnP USB"

Pour avoir plus d'informations sur cette étiqueteuse, aller sur la page Outils puis cliquer sur "Voir les étiqueteuses installées"

2) Installer cette imprimante sur le poste client

Attention, il faut bien faire l'installation dans cette ordre sinon ça ne marche pas :

a) Mettre la batterie dans l'imprimante

b) Connecter l'imprimante sur un port USB du poste client, l'imprimante s'installe normalement toute seule,

et représente un nouvel espace disque sur le bureau (sur Windows, elle occupe une lettre de lecteur disque monté, style "G:")

C'est normal car ce disque contient un mini logiciel qui permet d'utiliser très simplement cette imprimante.

Mais ce n'est pas ce logiciel que nous allons utiliser, donc surtout ne l'installez pas. 

3) Télécharger et installer le logiciel DLS (Dymo Label Software) associé à cette imprimante

Pour cela aller dans la section "LOGICIEL DLS (DYMO LABEL SOFTWARE) A INSTALLER", et cliquer sur le lien "Téléchargement logiciel"

Selon que c'est un poste Mac ou Windows, cliquer sur le bon lien "DOWNLOAD"

Installer ce logiciel

4) Imprimer une étiquette 

Allumer l'imprimante (si ce n'est déjà fait)

Depuis ce poste client, aller sur le logiciel Labinvent (via un navigateur comme Firefox par exemple),

cliquez sur "Liste des matériels", cliquez sur un matériel quelconque, et cliquez sur le bouton "Impr. ruban"

Les 5 étapes suivantes ne sont à faire qu'une seule fois pour toutes : 

- Une boîte de dialogue s'ouvre pour vous demander quel logiciel il faut ouvrir.

- Cliquez sur le bouton "Choisir..." (à droite du texte "Ouvrir avec")

- Choisir l'application DLS (Dymo Label Software)

- Cocher l'option "Toujours effectuer cette opération avec ce type de fichier"

- Cliquer sur OK

Le logiciel DLS s'ouvre avec l'étiquette prête à être imprimée.

Cliquer sur le bouton "Imprimer"

-----------------

h3. AUTORISATIONS (ACL) : REGLAGE DES DROITS ASSOCIES A CHAQUE PROFIL

-----------------

TODO: expliquer comment ajouter, modifer, ou supprimer un profil 

Cette application définit 5 profils de pouvoir croissant :

- USER : le profil par défaut de tout utilisateur)

- RESPONSABLE : le responsable d'un ou plusieurs matériels 

- ADMIN : le service administratif (gestion)

- ADMINPLUS : le responsable administratif

- SUPERADMIN (ce profil correspond au super administrateur, il a TOUS les droits)

Les droits associés à chaque profil sont décrits dans le document docs/userguide/ACL.pdf, principalement dans le tableau II-B.

L'ensemble de tous ces droits est contrôllé (presque) entièrement par un seul tableau nommé $easyACL

Il vous suffit donc de jouer sur le contenu de ce tableau pour modifier les droits.

On peut définir ces droits à deux niveaux : 

- Les droits PAR DEFAUT sont définis dans la classe mère de tous les controleurs, nommée app/Controller/AppController

- Les droits spécifiques à un modèle (Matériel, Suivi, Emprunt) sont définis dans le controleur respectif (MaterielsController, SuivisController, EmpruntController...)

1) Les droits PAR DEFAUT sont définis dans la classe mère de tous les controleurs, nommée app/Controller/AppController

Vous y trouverez un tableau $easyACL avec un contenu semblable à celui-ci :

	protected $easyACL = array(

			'ALL' => array (

				// CRUD actions :

				'index' => 'Y', // Read all

				'view' => 'Y', // Read one

				'add' => 'Y', // Create

				'edit' => 'N', // Update

				//'delete' => 'N', // Delete

			),

			'USER' => array (

				// CRUD actions :

				'index' => 'Y', // read all

				'view' => 'Y', // read one

				//'add' => 'Y', // create

				'edit' => 'N', // update

				'delete' => 'N',

			),

			'RESPONSABLE' => array (

				// CRUD actions :

				'index' => 'Y', // read all

				'view' => 'Y', // read one

				'add' => 'Y', // create

				'edit' => 'N', // update

				'delete' => 'Y',

			),

			...

	}

Le sous-tableau 'ALL' contient les DROITS PAR DEFAUT pour TOUS les profils (ALL), 

pour TOUS les modèles, et pour les actions qu'il définit (ici, les actions CRUD, Create Read Update Delete).

Par exemple, avec l'entrée 'delete' => 'N', par défaut aucun profil n'a le droit de supprimer quelque modèle (matériel, suivi, emprunt, ...) que ce soit,

même les nouveaux modèles qui pourraient être ajoutés dans le futur.

Attention, ce système est "permissif" dans le sens ou par défaut tout est autorisé.

Si vous voulez interdire une action, il faut le dire explicitement, sinon elle est autorisée par défaut.

En général, cela simplifie les choses.

Donc, par exemple, si on commente l'action 'delete', elle est alors autorisée.

C'est comme si elle était définie avec 'delete' => 'Y'

Si un profil spécifique doit avoir un droit sur une action, qui est différent du droit PAR DEFAUT défini dans 'ALL',

alors il faut ajouter un sous-tableau pour ce profil, portant le nom de ce profil (en majuscule).

Ainsi, le sous-tableau 'USER' contient les droits spécifiques pour le profil USER, 

pour TOUS les modèles, et pour les actions qu'il définit. 

Par exemple, avec l'entrée 'delete' => 'N', par défaut un USER n'a pas le droit de supprimer quelque modèle (matériel, suivi, emprunt, ...) que ce soit.

Si une action n'est pas définie (par exemple 'add'), alors c'est l'autorisation définie dans 'ALL' qui fait foi.

Le sous-tableau 'ADMIN' contient les droits par défaut pour le profil ADMIN, 

pour TOUS les modèles, et pour les actions qu'il définit. 

Par exemple, avec l'entrée 'delete' => 'Y', par défaut un ADMIN a le droit de supprimer TOUS les modèles (matériel, suivi, emprunt, ...),

y-compris les nouveaux modèles qui pourraient être ajoutés dans le futur.

Et ainsi de suite pour les autres profils ADMIN, ADMINPLUS, et SUPERADMIN.

S'ils ne sont pas définis, alors ils héritent des autorisations par défaut définies dans 'ALL'. 

2) Les droits spécifiques à un modèle (Matériel, Suivi, Emprunt) sont définis dans le controleur respectif (MaterielsController, SuivisController, EmpruntController...)

Si, pour un modèle donné, on veut définir des droits différents de ceux définis globalement dans app/Controller/AppController,

il faut le faire dans le controleur correspondant au modèle.

Par exemple, si on veut des droits particuliers pour les matériels, il faut les définirs dans app/Controller/MaterielsController

Cependant, afin de garder la plupart des droits définis globalement dans AppController, 

et de redéfinir SEULEMENT CERTAINS droits spécifiques pour certains profils ou certaines actions,

on définira les nouveaux droits un peu différemment de ce qui a été fait dans AppController.

(TODO: je n'ai pas réussi avec Php 5.3 à gérer un héritage au niveau du tableau $easyACL entre celui de AppController et celui des sous-classes,

car celui défini dans une sous-classe écrase complètement celui de la classe mère AppController ; peut-être qu'avec Php 5.6 il y aurait une solution plus éléguante).

En effet, plutôt que de définir à nouveau un tableau $easyACL qui écraserait celui défini dans AppController,

on hérite du $easyACL de AppController, et on en écrase seulement certaines entrées.

On définit ces nouvelles entrées dans la méthode beforeFilter() du controleur.

Voir par exemple les entrées définies dans la méthode beforeFilter() du controleur MaterielsController. 

Par exemple, une entrée comme celle-ci :

	$this->easyACL['ALL']['view'] = 'N';

remplacerait l'entrée par défaut de AppController

	'ALL' => array (

		...

		'view' => 'Y',

		...

	);

Une entrée (un peu plus complexe) comme celle-ci :

	$this->easyACL['ALL']['delete'] = 'status == CREATED';

remplacerait l'entrée par défaut de AppController

	'ALL' => array (

		...

		'delete' => 'Y',

		...

	);

et signifierait que la suppression d'un matériel n'est possible (par défaut) que si le statut du matériel est "CREATED" (il vient d'être créé, mais il n'est pas encore validé). 

Enfin, une entrée (encore plus complexe) comme celle-ci :

	$this->easyACL['USER']['edit'] = '&& nom_createur == CURRENT_USER_NAME';

remplacerait l'entrée par défaut de AppController pour le profile USER

	'USER' => array (

		...

		'edit' => 'Y',

		...

	);

et ajouterait (grâce au '&&') une contrainte supplémentaire pour la modification d'un matériel (pour les USER),

qui est que le matériel doit avoir été créé par l'utilisateur qui en fait la modification

... etc.

A vous de jouer maintenant, vous savez comment "tuner" votre application, au niveau des droits de chaque profil et sur chaque action.

-----------------

h3. VIRTUAL HOST (facultatif)

-----------------

But : Créer un virtual host pour pouvoir acceder au logiciel avec cette simple url "http://localhost:8081" par exemple.

Pour cela :

- Ajouter a la fin du fichier de conf apache /etc/httpd.conf (ou /etc/httpd/conf/httpd.conf, ou encore XAMPP/xamppfiles/etc/httpd.conf) la ligne :

	Include etc/extra/labinvent.conf

	(ou conf.d/labinvent.conf)

- Editer ce fichier etc/extra/labinvent.conf et y mettre ceci :

#####################

Listen 8081

NameVirtualHost *:8081

<VirtualHost *:8081>

        ServerAdmin VOTRE_ADRESSE_MAIL

        DocumentRoot "/Applications/XAMPP/xamppfiles/htdocs/labinvent/cakephp/app/webroot"

        ErrorLog logs/labinvent.error_log

        CustomLog logs/labinvent.access_log combined

</VirtualHost>

#####################

- Remplacer VOTRE_ADRESSE_MAIL par votre adresse email

- Modifier la ligne DocumentRoot avec le chemmin absolu vers votre installation de l'application (jusqu'au dossier webroot inclus)

Redemarrez maintenant votre serveur web Apache

Voila ! Vous devriez maintenant pouvoir vous connecter a l'application avec l'url http://localhost:8081

NB: Une fois l'installation terminee, les developpeurs devraient aussi lire le document docs/HOWTO.txt 

-----------------

h3. MISE A JOUR (UPGRADE) en 5 petites etapes

-----------------

Nous expliquons ici comment mettre à jour votre logiciel,

en installant une nouvelle version,

qui doit remplacer la version actuelle (déjà installée et utilisée avec des données).

Le but est de mettre a jour le logiciel tout en conservant la connexion a la base de données actuelle et son contenu.

1) Desactiver la version actuelle

Aller dans le repertoire parent de l’application actuelle

Le repertoire de l’application actuelle devrait avoir un nom du style labinvent/

C’est sur ce nom que doit pointer l’URL du navigateur (ex: http://labinvent/cakephp)

Renommer ce repertoire en "labinvent_OLD" :

	mv labinvent labinvent_OLD

2) Activer la nouvelle version

Extraire la nouvelle version à côté de l’actuelle :

	tar xvfz labinvent_X-Y-ZZZ.tgz (par exemple : tar xvfz labinvent_1-3-460.tgz)

=> cela doit créer un dossier labinvent_X-Y-ZZZ/ (par exemple : labinvent_1-3-460/)

(à coté du dossier labinvent_OLD/)

Renommer ce repertoire en "labinvent" :

	mv labinvent_X-Y-ZZZ.tgz labinvent (par exemple : mv labinvent_1-3-460 labinvent)

3) Aller dans le dossier d’installation de la NOUVELLE version

cd labinvent/install/

4) Executer le script installation.sh

./installation.sh

ATTENTION : Répondre "Non" à la question "Voulez-vous creer la base de donnees ?"

5) Récupérer la configuration de l’application actuelle dans la nouvelle

- Configuration Base de données : 

Copier le fichier labinvent_OLD/cakephp/app/Config/database.php de l’application actuelle dans la nouvelle, c’est à dire dans labinvent/cakephp/app/Config/

- Configuration Générale : 

Adapter le nouveau fichier labinvent/cakephp/app/Config/labinvent.php à partir de ce que vous avez dans le même fichier de l’application actuelle,

c'est à dire dans labinvent_OLD/cakephp/app/Config/labinvent.php

(la commande « diff » peut aider à voir ce qui a changé)

h2. Comment accéder au site redmine depuis l'extérieur ?

-----------------

1) Créer un tunnel (entre le port local 9443 et le port distant 443 du serveur web irap, via la passerelle)

ssh -L 9443:projects.irap.omp.eu:443 MONLOGINDULABO@PASSERELLE.irap.omp.eu

(Pour les personnes qui utilisent Windows, vous pouvez faire la même chose avec le logiciel Putty, en vous inspirant de ce qui est décrit au point 4) a) de cet article http://planetoweb.cesr.fr/twiki/bin/view/Main/HowtoInformatique#Se_connecter_un_serveur_linux_en) 

2) Pointer son navigateur sur https://localhost:9443

-----------------

h2. Dépôt SVN

-----------------

https://usvn-inventirap.irap.omp.eu/repo/inventirap/trunk/

-----------------

h2. Mailing list

-----------------

usvn-repo_inventirap AT irap.omp.eu

(https://listes.irap.omp.eu/wws/info/usvn-repo_inventirap)