History

Wiki » Labinvent nouvelle version »

« Previous - Version 3/22 (diff) - Next » - Current version
Etienne Pallier, 06/02/2016 03:40 pm

Documentation technique

Cette page décrit les différents concepts techniques utilisés dans le projet.

LIENS UTILES

Schéma de la base de données (v2.0.0)

Error executing the thumbnail macro (Attachment BDD_IRAP.png not found)

ROADMAP - Plan de développement

Le stage se déroule de mi-avril à fin juin, soit sur 12 semaines (S1 à S12), ou 24 demi-semaines.
(Ne pas oublier de rédiger le rapport de stage au fur et à mesure)

Voir le détail de la roadmap: https://projects.irap.omp.eu/projects/inventirap/roadmap

Prévu Réalisé
S01 (11/4-15/4) 1 version 2.0 - Cakephp3 + Php5 version 2.0
2
S02 (18/4-22/4) 1
2
S03 (25/4-29/4) 1
2 version 2.1 - Implémentation complète du CRUD
S04 (02/5-06/5) 1 version 2.1
2
S05 (09/5-13/5) 1
2 version 2.2 - Implémentation de toutes les autres actions
S06 (16/5-20/5) 1 version 2.2
2
S07 (23/5-27/5) 1 version 2.3 - Implémentation du LDAP version 2.3
2
S08 (30/5-03/6) 1 version 2.4 - Implémentation des ACL version 2.4 (en cours...)
2
S09 (06/6-10/6) 1 version 2.5 - Documents attaches aux materiels
2
S10 (13/6-17/6) 1 version 2.6 - Evolutions prévues dans 1.3 et 1.4
2
S11 (20/6-24/6) 1 version 2.7 - Cakephp3 + Php7
2
S12 (27/6-30/6) 1 version 2.8 - Autres ajouts
2

COMMIT PROCEDURE

Voici les différentes étapes à respecter au moment de chaque commit:

1) S'assurer que tous les tests passent toujours...

2) Mettre à jour le fichier README (ceci est un exemple, un template)

Date: 11/05/2016
Version: 2.1.9
Mise à jour doc install
(Attention, changement structure BDD)
Demande (terminée): https://projects.irap.omp.eu/issues/3542
Version majeure en cours (2.1): https://projects.irap.omp.eu/versions/101

Remarques:
=> Version: 2.1.9 = 9ème commit sur la version 2.1
=> préciser "(bugfix)" si c'est le cas
=> ajouter "(Attention, changement structure BDD)" s'il y a eu une modif de la BDD
=> "Demande (terminée)" ou "Demande (en cours)", ou pas de demande du tout (exceptionnellement)
=> ces infos permettront de savoir quelle version (et date) exacte du projet on a actuellement sur son disque

[3) Si c'est la fin d'une version majeure (2.0, 2.1, 2.2, ...)]

  • On doit normalement avoir écrit quelques nouveaux tests pour cette version !!!
  • Ajouter cette version en tête de la section "MAIN CHANGES (MILESTONES)" dans le fichier README
  • Mettre à jour la doc install/INSTALLATION à partir du wiki (si nécessaire)
  • Tester une installation du logiciel from scratch

4) pull

(au cas où quelqu'un d'autre aurait fait un push)

5) commit

Reprendre dans le message de commit, faire un simple copier/coller des infos du fichier README (sauf date):

Version: 2.1.9
Mise à jour doc install (bugfix)
Demande (terminée): https://projects.irap.omp.eu/issues/3542
Version majeure en cours (2.1): https://projects.irap.omp.eu/versions/101

[6) push]

(seulement si le commit est important/urgent, ou suite à un ensemble de commits sur un même thème)

Installation from scratch (Sous UBuntu)

Création projet avec Composer

  • 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

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.1_09-05-16 correspond à la création de la base.
Dans database/, le fichier labinvent_2.0_insert-irap_19-04-16 correspond aux insertions propre à l'IRAP, fichier insertion uniquement pour les dévellopeurs.

  • Création table "config"

Mise à jour dans le fichier de création de base
Mise à jour à part : db-update-2016-05-09.sql

Gestion des mails de management

  • L'envoi de mail en local est réalisé grace à une adresse créer pour labinvent et donc le protocole d'envoi est défini dans app.php, lors de l'envoi d'un mail il faut utiliser le transport 'gmail' en local.

Mail : / Mot De Passe : cakephp3

  • Pour changer de mail et de transport, il faut aller dans la section Email/Transport de app.php, remplacer l'adresse et son mot de passe, puis il faut définir un protocole d'envoi compatible avec l'adresse mail rentré précédemment.

Tests (Mise en place et éxécution)

  • CakePHP permet aussi de gérer les tests facilement et de générer leurs squelettes avec la commande "bake".
    --> Pour commencer il faut récupérer phpunit (https://phpunit.de/), si la version de PHP est inférieur à 5.6, il faut télécharger le phpunit.phar compatible avec PHP, sinon il faut prendre la derniere version (compatible avec PHP7 également).
    --> Il faut configurer une base de donnée pour les tests dans "app.php" 
    Commande génération test (se placer à la racine du projet ./labinvent) : 

bin/cake bake test "type_src" "nom_table" 

"type_src" correspond à Controller, Table, Entity, Form, Helper, Fixture...

LDAP

  • Pour le développement, j'utilise openLDAP pour avoir un LDAP et y connecter Labinvent2, pour gérer openLDAP, j'utilise l'outil de configuration phpLDAPadmin.
    --> J'utilise une VM oû les outils d'openLDAP sont déja installés et configurés.
    --> Il suffit de récupérer la machine virtuelle prête à l'emploi, et de lui attribuer manuellement une adresse IP libre (en général x.x.x.253/254) et son masque
    --> Aller sur une autre machine (physique ou virtuelle), et taper l'adresse ip défini précédement dans un navigateur
    --> Vous accéderez à une page de gestion (phpLdapAdmin)
    --> ATTENTION -> Votre PC doit être branché en filaire pour que la machine virtuelle soit accessible

https://www.turnkeylinux.org/openldap

Gestion des ACL

  • CakePHP3 n'integre plus un composant pour un gérer les ACLs, un plugin est à disposition pour remplacer ce composant, hélas il n'est pas stable, et le fait qu'il utilise la base de données ralenti les applications, car le composant effectue beaucoup de requêtes.
  • De plus, il est conseillé pour des autorisations basiques d'utiliser la fonction isAuthorized($user) dans les controller.
  • Dans labinvent2, on utilise la fonction isAuthorized($user), qui définit les choses que les utilisateurs connecté peuvent faire et donne tous les droits au Super-Admin dans AppContoller.php.
    Puis, dans chaque controller la fonction est redéclarer, on définit les actions possible pour chaque rôle.
  • Procédure ajout d'une fonctionnalité
    - On ajoute la fonctionnalité dans le controller
    - Si la fonctionnalité est accessible par tout le monde, il faut l'ajouter dans le isAuthorized($user) de l'AppController
    - Sinon il faut ajouter la condition lié à l'action dans la fonction isAuthorized($user) du controller correspondant (1ère fonction de tous les controllers)
    - Enfin lorsque vous réalisez la vue correspondante, il faut cacher les champs/boutons de votre fonctionnalité en fonction de vos droits, une variable "$role" est accessible dans toutes les vues, ainsi qu'une variable "$username" (nom de l'utilisateur, pas le login) pour tester la proriété d'un objet dans une vue.

Autres remarques lors du dévellopement

  • 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")...

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

  • La solution pour insérer un utilisateur directement dans la base et pouvoir se connecter avec dans l'application est de l'insérer avec un mot de passe haché de la méme façon.
    Le mot de passe "login" = "$2y$10$LZzpws3oDidBcqO/Fy1RTedLLk3ENTmplny5J7bZ6R1PqFoGOw3Ma".
    Le mot de passe vide "" = "$2y$10$nBQMNstgN.sgad1ZANznY.pbJI.ZG/.Q5qX4gC8SXCFQnDIZC8rcW".
  • Vérifier que la migration vers la prochaine version de cakephp3 (3.3 ?) sera facile... (décrire la procédure à suivre)
    --> Une migration vers une version mineur 3.2 => 3.3, se réalise avec la mise à jour de CakePHP à l'aide de Composer
    --> Puis il faut regarder les changements dans la page migration correspondant à la version voulu et adapter les changements au code.

Voir : http://book.cakephp.org/3.0/fr/appendices/3-2-migration-guide.html

  • Outil (plugin) "DebugKit" de CakePHP3 :
    --> DebugKit est un plugin qui fournit une toolbar pour aider à debugger les applications CakePHP plus facilement.
    --> Par défaut il est installé avec le squelette de l'application, pour l'activer, il faut se placer à la racine.
    --> Puis il faut éxécuter la ligne suivante : bin/cake plugin load DebugKit .
    --> La commande va aller modifier le fichier config bootstrap.php.
    --> Le fichier bootstrap.php actuel de l'application sur le git, est configuré pour charger le plugin lorsque l'application est en mode debug de CakePHP, je ne pense pas que exécuter la commande précédente soit utile vu la configuration de ce fichier dans notre application.
    --> Le plugin nécessite l'extension php5-sqlite par défaut (il supporte l'équivalent avec de la config).

Voir : http://book.cakephp.org/3.0/fr/debug-kit.html

  • Mode debug personnaliser :

Faire $this->myDebug($var) dans un controlleur pour afficher le contenu de la variable si mode debug personnalisé actif, à condition que le mode debug soit activé.

Voir : http://book.cakephp.org/3.0/fr/development/testing.html

  • Pour charger une librairie (ex : phpqrcode, ...)

Voir : http://book.cakephp.org/3.0/fr/core-libraries/app.html#charger-les-fichiers-de-vendor

  • Pour créer les fichiers pdf d'entrée et de sortie, on utilise fpdf 1.8.1, on pourrait utiliser le plugin développer pour CakePHP3.

Voir : https://github.com/FriendsOfCake/CakePdf

  • Pour le JavaScript, le JS Helper a été retiré

Voir : http://book.cakephp.org/3.0/fr/appendices/3-0-migration-guide.html#jshelper

  • Avant de déployer l'application sur le serveur de production, optimiser les performances

Voir : http://book.cakephp.org/3.0/fr/deployment.html#ameliorer-les-performances-de-votre-application

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 ""
- 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

*********************************************************
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
*********************************************************

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/

BDD_IRAP.png (171 KB) Alexandre Cases, 06/30/2016 03:41 pm