LABINVENT (InventIrap)

h1. Labinvent 2.0 (cakephp3)

{{toc}}

---

h2. TODOLIST

 * Vérifier que la migration vers la prochaine version de cakephp3 (3.3 ?) sera facile...

(décrire la procédure à suivre)

 * Faire un script d'installation qu'on peut exécuter et ré-exécuter plusieurs fois sans crainte de tout casser

 * Le script d'installation doit proposer par défaut l'installation de "faux utilisateurs" pour tester l'application, avec des mots de passe (mot passe = login ; par exemple, "superadmin/superadmin", "responsable/responsable"...)

---

h2. RECUPERATION

1) Authenticate to https://gitlab.irap.omp.eu/epallier/labinvent

In order to get this software, you must first authenticate on the IRAP gitlab.

For this, just go to https://gitlab.irap.omp.eu/epallier/labinvent

and either sign in with your LDAP account (if you are from IRAP),

or register via the "Sign up" form (then, confirm your registration by answering an email sent by gitlab,

and wait for the "SI" to authorize your registration)

If you want, you can browse the code online (from gitlab) :

https://gitlab.irap.omp.eu/epallier/labinvent/tree/master

2) Récupérer le logiciel

Deux options se présentent à vous :

 * a) soit vous récupérez une version statique du logiciel, en le téléchargeant

 * b) soit vous récupérez une version synchronisée, avec git

a) Download it (static version, not synchronized)...

You can download the current version of the software.

Go to https://gitlab.irap.omp.eu/epallier/labinvent/tree/master

Click on "Download zip" on the up right hand corner.

Double-click on it to unzip it (or run "gzip -d labinvent.zip")

You should get a "labinvent.git" folder.

In this documentation, this software folder will be referenced as "LABINVENT".

(you can rename "labinvent.git" as "labinvent" if you want : "mv labinvent.git labinvent")

b) ... or Get it from GIT (dynamic version, synchronized)

(If you are using Windows, you must first get the git software, see below "Get git for Windows")

By getting the software from git, you will get a dynamically synchronized version,

which means that you will be able to update your version as soon as a new version is available

(with the command : "git pull").

* From Eclipse : See below, section "NOTES FOR ECLIPSE USERS"

* From the terminal

<pre>

git clone https://gitlab.irap.omp.eu/epallier/labinvent.git labinvent

</pre>

_(or also : git clone git@gitlab.irap.omp.eu:epallier/labinvent.git labinvent)_

If you ever get this error message... :

<pre>

fatal: unable to access 'https://gitlab.irap.omp.eu/epallier/labinvent.git/': Peer's certificate issuer has been marked as not trusted by the user.

</pre>

...then, type this command (and then run again the "git clone" command):

<pre>

$ git config --global http.sslVerify false

Then check that your config is ok:

$ cat ~/.gitconfig 

[user]

	name = Etienne Pallier

	email = epallier@irap.omp.eu

[http]

	sslVerify = false

[push]

	default = simple

</pre>

(Also, the first time you get the project, git will ask you for a login and password)

This creates a labinvent/ folder containing the project (with a .git/ subfolder for synchronization with the git repository)

(Windows only) : Get git for Windows:

 * Download git at https://git-scm.com/download/win

 * Run setup (keep default configurations)

 * Once installed, open cmd

<pre>

$ git config --global http.sslVerify false

</pre>

You can now use your git from the cmd or the graphic client !

3) Préparation

* Vérifier que vous etes le propriétaire du dossier (il ne doit pas appartenir à "root"), sinon faire : 

> sudo chown -R nom_utilisateur LABINVENT

* 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/localhost/public_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

h2. INSTALLATION

h3. A/ PREREQUIS

(L'exemple est donné ici pour une distribution linux UBuntu 14.04.4)

* Pour commencer il faut mettre à jour les "repository" de apt : 

> sudo apt-get update && sudo apt-get upgrade

* Un serveur web (apache avec le mod_rewrite actif)

> sudo apt-get install apache2

> Editer le fichier /etc/apache2/apache2.conf et mettre le paramêtre "KeepAlive" à "Off" :

<pre>

KeepAlive Off

</pre>

=> (pas nécessaire sur Mac OS avec Xampp)

> Par défaut Apache utilise un "event module" et PHP un "prefork module".

> Il faut désactiver le 1er module et activer le second :

> > sudo a2dismod mpm_event

> > sudo a2enmod mpm_prefork

=> (pas nécessaire sur Mac OS avec Xampp)

* Un serveur de base de données (MySQL)

> sudo apt-get install mysql-server 

* PHP 5.5.9 ou plus 

> sudo apt-get install php5 php-pear

> sudo apt-get install php5-mysql

> Dans le fichier /etc/php5/apache2/php.ini, vous devez positionner votre répertoire de log :

<pre>

error_reporting = E_ALL

error_log = /var/log/php/error.log

max_input_time = 30

</pre>

> Ensuite il faut créer le dossier en question et donner à apache (ici www-data) les droits sur ce dossier :

> > sudo mkdir /var/log/php

> > sudo chown www-data /var/log/php

=> (pas nécessaire sur Mac OS avec Xampp)

* Extension PHP "mbstring" et librairie "zlib"

La collection de librairies est normalement déja installée avec PHP en tant que dépendances, sinon faire :

> sudo apt-get install libapache2-mod-php5

=> (TODO: y a-t-il un moyen simple de vérifier la présence de ces librairies ?)

* Extension PHP "intl"

Vérifier que cette extension est activée dans le php.ini:

<pre>

extension=intl.so

</pre>

Vérifier qu'elle est bien installée :

<pre>

$ php -m| grep intl

(ça devrait retourner "intl")

</pre>

Sinon, l'installer

> sudo apt-get install php5-intl

(Sur MacOS avec XAMPP: cf http://stackoverflow.com/questions/27886117/php-intl-installation-on-xampp)

(Il se pourrait que vous ayez besoin de ré-exécuter l'installeur de XAMPP afin de cocher l'option "XAMPP Developer Files", si vous ne l'aviez pas déjà fait lors de votre installation de XAMPP)

<pre>

cd /Applications/XAMPP/bin

sudo ./pecl install intl

</pre>

(Vérifier qu'elle a bien été installée dans /Applications/XAMPP/xamppfiles/lib/php/extensions/no-debug-non-zts-20131226/)

* Librairie PHP "php-gd" 

>  sudo apt-get install php5-gd

Quand "php-gd" est installé, aller dans le fichier /etc/php5/apache2/php.ini :

Vérifier que la ligne suivante est présente et décommentée (absence de ";" devant la ligne) sinon il faut la rajouter : 

<pre>

extension=gd.so

</pre>

=> (TODO: y a-t-il un moyen simple de vérifier la présence de cette librairie ?)

* Pour vérifier la configuration d'apache et de ses modules :

> Il faut créer une page info.php dans le dossier public_html contenant les lignes suivantes : 

<pre>

<?php

   phpinfo();

?>

</pre>

=> (TODO: normalement, c'est déjà fait dans le projet labinvent, et accessible depuis le menu "Outils", donc pas besoin de le refaire)

> La page d'info devrait être accessible : http://localhost/info.php

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

> sudo apt-get php5-mcrypt

> sudo apt-get install phpmyadmin

> Pensez à activer mcrypt : sudo php5enmod mcrypt

* Vous devez maintenant redémarrer Apache :

> > sudo service apache2 restart

(ou simplement le recharger: utiliser "reload" au lieu de "restart")

h3. B/ INSTALLATION

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.

* Aller dans le repertoire d'installation :

cd LABINVENT/install/

* Exécuter le script d'installation :

./installation.sh

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

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

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

TODO: Moi (EP) j'ai eu une erreur car /tmp/cache/persistent/ n'était pas "writeable"

Il faut donc ajouter la commande suivante dans le script:

<pre>

chmod -R a+w tmp/cache/*"

</pre>

* Configuration BD

- Après avoir terminé le script d'installation, ouvrir le fichier ./config/app.php

- Aller à la section Datasources 

- Modifier les attributs "host", "username", "password" et "database" pour qu'ils correspondent à votre base de données.

=> (TODO: à faire dans le script installation.sh)

* Autoriser les fichiers .htaccess sur le site :

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

=> (TODO: expliquer rapidement comment faire)

Dans le fichier /etc/apache2/apache2.conf, si vous avez déja quelque chose comme ceci, cela suffit :

<pre>

<Directory />

  Options FollowSymLinks

  AllowOverride All

  Order deny,allow

  Deny from all

  </Directory>

</pre>

Sinon, vous pouvez ajouter ceci, uniquement pour Labinvent :

<pre>

<Directory /labinvent>

  Options FollowSymLinks

  AllowOverride All

</Directory>

</pre>

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>

* Activer le mode rewrite de Apache :

> sudo a2enmod rewrite

* Redémarrer Apache 

* Tester l'accès web à l'application : http://localhost/labinvent.git/

Il est possible que le mode rewrite ne fonctionne pas correctement si les fichiers .htaccess dans la racine et dans webroot disparaissent. Sur certains systèmes les fichiers commençant par un point peuvent disparaitre lors d'une copie. Si c'est le cas pour vous, voici le contenu de ces deux fichiers et leurs emplacements : 

<pre>

Fichier ./.htaccess : 

<IfModule mod_rewrite.c>

    RewriteEngine on

    RewriteRule    ^$    webroot/    [L]

    RewriteRule    (.*) webroot/$1    [L]

</IfModule>

</pre>

<pre>

Fichier ./webroot/.htaccess : 

<IfModule mod_rewrite.c>

    RewriteEngine On

    RewriteCond %{REQUEST_FILENAME} !-f

    RewriteRule ^ index.php [L]

</IfModule>

</pre>

> Remarques :

> > Dans CakePHP3 un serveur de développement est disponible, il faut se placer à la racine du projet faire la commande "bin/cake server".

> > L'application devrait être accessible à l'adresse suivante par défaut : http://localhost:8765/

h2. (DEV ONLY) Installation from scratch (Sous UBuntu)

h3. Création projet avec Composer

* Télécharger composer.phar : 

"curl -s https://getcomposer.org/installer | php"

* Avec le Composer créer un nouveau projet : 

"php composer.phar create-project --prefer-dist cakephp/app labinvent_2.0"

> Voir structure projet : http://book.cakephp.org/3.0/fr/intro/cakephp-folder-structure.html

* On rempli la base de données avec le fichier sql

* On indique la BD utilisé à CakePHP dans le fichier config/app.php, propriété "Datasources".

* On se place à la racine du projet

* On génère le code Scaffold : 

"bin/cake bake all nom_table" --> ça génére les modeles, les vues, et les controlleurs.

> Commande (en une fois) :

> > bin/cake bake all categories && bin/cake bake all emprunts && bin/cake bake all groupes_metiers && bin/cake bake all groupes_thematiques && bin/cake bake all organismes && bin/cake bake all sites && bin/cake bake all sous_categories && bin/cake bake all suivis && bin/cake bake all sur_categories && bin/cake bake all type_suivis && bin/cake bake all documents && bin/cake bake all users && bin/cake bake all materiels

h3. Modification de la base de données 

> Une version du sql corrigée au fur et à mesure est disponible dans le git :

> > Dans database/, le fichier labinvent_2.0_19-04-16 correspond à la création de la base.

> > Dans database/, le fichier labinvent_2.0_insert-irap_19-04-16 correspond aux insertions.

* Table "fichiers" en doublon de "documents" => supprimer

* Attribut organisme inutile dans la table matériel => supprimer

h3. Autres remarques lors du dévellopement

* Le script d'installation modifie le fichier config app.php ce qui entraine un problème au niveau de l'URL-Rewriting, voici la ligne en question et sa véritable forme : !!! A CORRIGER !!! 

<pre>

'weblabinvent2user' => 'webroot',

</pre>

remplacé par : 

<pre>

'webroot' => 'webroot',

</pre>

=> TODO: à corriger dans le script installation.sh !!!

* En mode debug la page d'acceuil est une page d'information sur l'état et la configuration de CakePHP3 et de ses dépendances.

Je pense que il y a moyen de rajouter des lignes pour vérifier TOUTE la config, ce serait pas mal comme outil de debug.

* CakePHP permet de se configurer en PHP, on pourrait permettre au super-admin de configurer sa base, les noms, les logos, et autres graphiquement outils config dans la section outils ?

<pre>

Configure::write('nomObjet', [

    'attribut1' => 'valeur1',

    'attribut2' => 'valeur2'

]);

</pre>

On peut aussi créer des lecteurs de configuration, ce qui nous permettrait d'avoir des fichiers config au format voulu (xml, ...).

Suite au 1er problème de ces remarques, il doit être possible de configurer l'application directement avec le script d'installation ?

* Avec CakePHP3 on peut gérér les ACL avec plusieurs gestionnaires d’autorisation propre à chaque profils (rôles), et une table users dans la base. 

(Lorsqu'un utilisateur se connecte, le gestionnaire de son type de compte se déclenche et les autres gestionnaires sont ignorés)

> Voir (explication) : http://book.cakephp.org/3.0/fr/controllers/components/authentication.html

> Voir (exemple) : http://book.cakephp.org/3.0/fr/tutorials-and-examples/blog-auth-example/auth.html

> Pour faire des tests d'authentication : http://book.cakephp.org/3.0/fr/development/testing.html#testing-authentication

Il faudrait transformer la table "utilisateurs" en "users" et rajouter l'attribut "password" pour gérér les ACL correctement avec CakePHP3 sans modifier le dossier Vendor (ce qui est très déconseillé ==> coeur du framework).

Il faut aussi renommer l'attribut "login" en "username".

Un problème se pose, l'insertion des users manuellement avec le script ne permettra pas d'hacher les mots de passes.

Comment fonctionne le LDAP à ce niveau, ou la simulation du LDAP ?

* Pour inclure un css : <?= $this->Html->css('nom_css_sans_l'extension'); ?> 

Le mieux serait de créer les templates de bake pour les opérations CRUD et les listes afin de gagner du temps dans la mise en forme (et dans l'optique de migration future, peut-etre CakePHP4...) : 

> http://book.cakephp.org/3.0/fr/bake/development.html#creating-a-bake-theme

!!! Problème : texte invisible si pas de balise ou balise "<p>" !!!

* La commande Bake de CakePHP3, permet aussi de générer des tests...

---

* Suivre les conventions de CakePHP est le top pour ne pas avoir à refaire de la config (bidouiller), il faudrait vérifier réguliérement que c'est le cas (outil "cakephp-codesniffer")...

> http://book.cakephp.org/3.0/fr/contributing/cakephp-coding-conventions.html

h2. %{margin-left:0px; font-weight:bold; font-size:25px;  display:block; color:red;}(DEV ONLY) NOTES FOR ECLIPSE USERS%

0) Install Eclipse (if necessary)

Get the Eclipse version for Php

1) Deactivate CA certificate verification

Window -> Preferences -> Team -> git -> configuration -> Add entry

Key = http.sslVerify

Value = false

2) Fetch the project

File/Import project from git

Select repository source: Clone URI: https://gitlab.irap.omp.eu/epallier/labinvent.git

Directory: 

- par défaut, il propose : /Users/epallier/git/labinvent

- mais on peut le mettre n'importe où ailleurs, 

par exemple, on pourrait le mettre directement dans le repertoire web de Apache:

/Applications/XAMPP/xamppfiles/htdocs 

(si on veut que le projet s'execute directement dans le dossier web apache htdocs, mais ca n'est pas obligatoire...)

initial branch: master

remote name: origin

Import as general project

Project name: LABINVENT

3) Configure the project

a) S'assurer que le projet est bien reconnu comme un projet PHP (il doit y avoir un petit "P" sur le dossier racine du projet)

Si ça n'est pas le cas, vérifier que le fichier .project (à la racine) contient bien

	<natures>

		<nature>org.eclipse.php.core.PHPNature</nature>

	</natures>

NB : Le fichier .project est normalement versionné et donc le projet labinvent devrait être reconnu automatiquement comme projet PHP

b) S'assurer que les fichiers de vue de cakephp ("*.ctp") sont bien reconnus comme des fichiers PHP.

Pour tester cela, ouvrir le fichier de vue cakephp/app/View/Categories/get_all.ctp

Si ce fichier s'ouvre comme un simple fichier texte, c'est qu'il n'est pas reconnu par Eclipse comme un fichier Php. 

Il faut donc associer l'editeur Php a l'extension de fichier "*.ctp" :

- Preferences/General/Content types

- Dans la liste "Content types", ouvrir la section "Text", selectionner PHP

- Ajouter l'extension "*.ctp"

c) Vérifier la version de php utilisée (il serait préférable d'utiliser la meme version que celle officiellement utilisée par le logiciel, c'est à dire php 5.6, mais attention, le serveur IRAP utilise toujours une version 5.3 pour inventirap) :

- Clic-droit sur le projet, Propriétés

- PHP

- Interpreter

- Enable project specific settings, PHP Version : "PHP 5.6"

d) S'assurer que le texte est bien encodé en UTF-8 par défaut :

clic-droit sur le dossier racine du projet (dans PHP Explorer), Properties, Resource : dans la zone "Text file encoding" cocher "Other" et sélectionner UTF-8

(

Il faudrait commiter ça mais je ne sais pas trop si c'est risqué ou pas.

Les fichiers concernés sont :

- .project (déjà versionné) : car il commence par la ligne "<?xml version="1.0" encoding="UTF-8"?>"

- mais c'est surtout celui-ci qui compte (actuellement ignoré de git) : .settings/org.eclipse.core.resources.prefs : car sa 2eme ligne est "encoding/<project>=UTF-8"

)

Les éléments suivants sont normalement DEJA ignorés par git, à vérifier :

- .settings/

- cakephp/app/tmp/ : tout sauf 

	- documents/

- cakephp/app/Config/ :

	- database.php

	- labinvent.php

<pre>

*********************************************************

REMARQUES INTERRESSANTES (MAIS VOUS POUVEZ LES IGNORER)

// DEBUT DES REMARQUES

A la racine du projet, j'ai plusieurs éléments cachés de configuration Eclipse :

1) fichier .buildpath 

Il est versionné puisque "svn status .buildpath" (depuis la console) ne donne rien

Il contient :

<?xml version="1.0" encoding="UTF-8"?>

<buildpath>

        <buildpathentry kind="con" path="org.eclipse.php.core.LANGUAGE"/>

        <buildpathentry kind="lib" path="docs/mockup/mockup_html.zip"/>

        <buildpathentry kind="src" path="cakephp"/>

</buildpath>

2) fichier .project

Il est déjà versionné

Il contient :

<?xml version="1.0" encoding="UTF-8"?>

<projectDescription>

        <name>invirap</name>

        <comment></comment>

        <projects>

        </projects>

        <buildSpec>

                <buildCommand>

                        <name>org.eclipse.wst.common.project.facet.core.builder</name>

                        <arguments>

                        </arguments>

                </buildCommand>

                <buildCommand>

                        <name>org.eclipse.wst.validation.validationbuilder</name>

                        <arguments>

                        </arguments>

                </buildCommand>

                <buildCommand>

                        <name>org.eclipse.dltk.core.scriptbuilder</name>

                        <arguments>

                        </arguments>

                </buildCommand>

        </buildSpec>

        <natures>

                <nature>org.eclipse.php.core.PHPNature</nature>

                <nature>org.eclipse.wst.common.project.facet.core.nature</nature>

        </natures>

</projectDescription>

3) dossier .settings/ (exclus de svn)

Il contient 3 fichiers :

- org.eclipse.core.resources.prefs : bizarrement, il ne contient que quelques références seulement :

eclipse.preferences.version=1

encoding//cakephp/app/Controller/MaterielsController.php=UTF-8

encoding//cakephp/app/View/Elements/menu_view.ctp=UTF-8

encoding//cakephp/app/View/Layouts/default.ctp=UTF-8

encoding//cakephp/app/View/Materiels/index.ctp=UTF-8

encoding//cakephp/app/View/Materiels/scaffold.view.ctp=UTF-8

encoding//database/Upd_TableConstraints.sql=UTF-8

encoding//database/update/README.txt=UTF-8

encoding//docs/HOWTO.txt=UTF-8

encoding//install/HOWTO.txt=UTF-8

encoding/<project>=UTF-8

- org.eclipse.php.core.prefs

eclipse.preferences.version=1

include_path=0;/invirap\u00051;/invirap/docs/mockup/mockup_html.zip

- org.eclipse.wst.common.project.facet.core.xml : sans doute inutile ? (lié à "Faceted Project Validation Builder" dans Properties/Builders)

<?xml version="1.0" encoding="UTF-8"?>

<faceted-project>

  <fixed facet="php.core.component"/>

  <fixed facet="php.component"/>

  <installed facet="php.core.component" version="1"/>

  <installed facet="php.component" version="5.4"/>

</faceted-project>

// FIN DES REMARQUES

*********************************************************

</pre>

4) (TODO:) Set Code style

Window/Preferences : PHP / Editor

...

5) (TODO: virtualenv) Now, once the PHP5 virtual environment is installed (see above),

set it in Eclipse as the project interpreter:

(cf http://virtphp.org)

...

6) (TODO:) Test

7) (TODO:) Run

check http://localhost:8080/