Subversion Repositories Applications.referentiel

Compare Revisions

Ignore whitespace Rev 343 → Rev 344

/branches/v2.0-betulales/interfaces/controleurs/AppliControleur.php
New file
0,0 → 1,603
<?php
// declare(encoding='UTF-8');
/**
* Classe Controleur générale partagée par les différents modules de l'application.
*
* @package Referentiel
* @category Php5.2
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @copyright 2010 Tela-Botanica
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
* @version SVN: $Id$
*/
abstract class AppliControleur extends Controleur {
const RENDU_TETE = 'tete';
const RENDU_CORPS = 'corps';
const RENDU_PIED = 'pied';
const RENDU_NAVIGATION = 'navigation';
const RENDU_MENU = 'menu';
// FIXME : voir s'il est plus intéressant d'utiliser une méthode dans les classes filles
protected $url = null;
private $parametres = array();
protected $manuel = null;
private $sortie = array();
private $messages = null;
//+----------------------------------------------------------------------------------------------------------------+
// Constructeur
public function __construct() {
$registre = Registre::getInstance();
$this->parametres = $registre->get('parametres');
$this->url = $this->parametres['url'];
// Chargement des infos du manuel technique des référentiels
$this->manuel = parse_ini_file(Config::get('chemin_appli').DS.'..'.DS.'configurations'.DS.Config::get('manuel'));
parent::__construct();
}
//+----------------------------------------------------------------------------------------------------------------+
// Accesseurs
 
/**
* Retourne le tableau de sortie à utiliser dans le controleur principal de l'application.
*/
public function getSortie() {
return $this->sortie;
}
 
/**
* Attribue à la bonne position de sortie un contenu.
*/
protected function setSortie($position, $contenu, $fusionner = false) {
if ($this->verifierExistencePosition($position)) {
if ($fusionner) {
$this->sortie[$position] .= $contenu;
} else {
$this->sortie[$position] = $contenu;
}
}
}
/**
* Retourne le tableau des messages
*/
protected function getMessages() {
return $this->messages;
}
/**
* Ajoute un message
*/
protected function addMessage($message) {
if ('' != $message) {
$this->messages[] = $message;
}
}
//+----------------------------------------------------------------------------------------------------------------+
// Méthodes
/**
* Vérifie l'existence de la position indiquée pour son utilisation dans le tableau de sortie.
* @param string la position à tester.
* @return bool true si la position est valide, sinon false.
*/
private function verifierExistencePosition($position) {
$existe = true;
if ($position != self::RENDU_TETE &&
$position != self::RENDU_CORPS &&
$position != self::RENDU_PIED &&
$position != self::RENDU_NAVIGATION &&
$position != self::RENDU_MENU) {
trigger_error("La position '$position' n'est pas une valeur prédéfinie.", E_USER_WARNING);
$existe = false;
}
return $existe;
}
/**
* Execute l'action d'un module donnée et fusionne le résultat avec le tableau de sortie.
*/
protected function executerAction($ClasseModule, $action) {
$module = new $ClasseModule();
$module->$action();
$this->fusionnerSortie($module->getSortie());
}
protected function executerActionReferentiel($ClasseModule, $action, $referentiel, $afficheMoteur = null) {
$module = new $ClasseModule();
$module->$action($referentiel, $afficheMoteur);
$this->fusionnerSortie($module->getSortie());
}
/**
* Fusionne un tableau de sortie par défaut avec le tableau passé en paramêtre.
* @param array le tableau à fusionner
*/
private function fusionnerSortie($sortie) {
$this->sortie = array_merge($this->sortie, $sortie);
}
protected function postraiterDonnees(&$tableau) {
if (count($tableau) > 0) {
foreach ($tableau as $cle => &$valeur) {
if ($valeur == '') {
$valeur = '&nbsp;';
} else if (is_string($valeur)) {
$valeur = $this->remplacerEsperluette($valeur);
} else if (is_array($valeur)) {
$this->postraiterDonnees($valeur);
}
}
}
}
protected function traiterEsperluette(&$tableau) {
if (count($tableau) > 0) {
foreach ($tableau as $cle => &$valeur) {
if (is_string($valeur)) {
$valeur = $this->remplacerEsperluette($valeur);
} else if (is_array($valeur)) {
$this->traiterEsperluette($valeur);
}
}
}
}
protected function remplacerEsperluette($txt) {
$txt = preg_replace('/&(?!([a-z]+|#[0-9]+|#x[0-9a-f]+);)/i', '&amp;', $txt, -1);
return $txt;
}
protected function supprimerSlash($doc) {
if (is_string($doc)) {
$doc = stripslashes($doc);
} else if (is_array($doc) && count($doc) > 0) {
foreach ($doc as $cle => $valeur) {
$doc[$cle] = $this->supprimerSlash($valeur);
}
}
return $doc;
}
protected function initialiserModulePrincipal() {
$_SESSION['module_principal'] = null;
}
protected function definirCommeModulePrincipal($module_nom) {
$_SESSION['module_principal'] = $module_nom;
}
 
private function getModulePrincipalCourant() {
return $_SESSION['module_principal'];
}
/**
* Construction du menu et stockage dans le conteneur de sortie RENDU_MENU.
*
* @param string $referentiel code du référentiel.
*/
protected function construireMenu($referentiel) {
$menu['nom'] = 'Accueil';
$menu['url'] = $this->obtenirUrlMenuAccueil();
$menu['activite'] = (($this->getModulePrincipalCourant() == 'Accueil') ? 'actif' : 'inactif');
$menu['title'] = "Liste des référentiels consultables.";
$donnees['menus'][] = $menu;
$menu['nom'] = 'Consultation';
$menu['url'] = $this->obtenirUrlMenuConsultation($referentiel);
$menu['activite'] = ((preg_match('/^(?:Consultation|Recherche|FicheTaxon)$/', $this->getModulePrincipalCourant())) ? 'actif' : 'inactif');
$menu['title'] = "Interroger la base en cours de travail.";
$donnees['menus'][] = $menu;
$menu['nom'] = 'Arbre taxo';
$menu['url'] = $this->obtenirUrlMenuArbre($referentiel);
$menu['activite'] = (($this->getModulePrincipalCourant() == 'Arbre') ? 'actif' : 'inactif');
$menu['title'] = "Consulter l'aborescence du référentiel";
$donnees['menus'][] = $menu;
$menu['nom'] = 'Tests';
$menu['url'] = $this->obtenirUrlMenuTest($referentiel);
$menu['activite'] = (($this->getModulePrincipalCourant() == 'Test') ? 'actif' : 'inactif securise');
$menu['title'] = "Réservé aux coordinateurs. Contrôler les données saisies.";
$donnees['menus'][] = $menu;
$menu['nom'] = 'Versionnage';
$menu['url'] = $this->obtenirUrlMenuVersionnage($referentiel);
$menu['activite'] = (($this->getModulePrincipalCourant() == 'Versionnage') ? 'actif' : 'inactif securise');
$menu['title'] = "Réservé aux coordinateurs. Générer une version de la base.";
$donnees['menus'][] = $menu;
$menu['nom'] = 'Informations et téléchargements';
$menu['url'] = $this->obtenirUrlMenuInformations($referentiel);
$menu['activite'] = (($this->getModulePrincipalCourant() == 'Informations') ? 'actif' : 'inactif');
$menu['title'] = "Informations sur le projet et téléchargements.";
$donnees['menus'][] = $menu;
$this->setSortie(self::RENDU_MENU, $this->getVue('menu', $donnees), false);
}
/**
* Construction du fil d'ariane et stockage dans le conteneur de sortie RENDU_NAVIGATION.
*
* @param $referentiel code du référentiel
* @param $id_traitement id du traitement
* @param $id_resultat id du résultat
*/
protected function construireFilAriane($referentiel = null, $id_traitement = null, $id_resultat = null) {
$entree['nom'] = 'Accueil';
$entree['url'] = $this->obtenirUrlMenuAccueil();
$donnees['entrees'][] = $entree;
if (isset($referentiel)) {
$entree['nom'] = 'Informations '.strtoupper($referentiel);
$entree['url'] = $this->obtenirUrlDetailReferentiel($referentiel);
$donnees['entrees'][] = $entree;
$module_principal = $this->getModulePrincipalCourant();
if (isset($module_principal)) {
$entree['nom'] = $module_principal;
$entree['url'] = $this->obtenirUrlMenu($module_principal, $referentiel);
$donnees['entrees'][] = $entree;
}
if (isset($id_traitement)) {
$entree['nom'] = "Traitement #$id_traitement";
$entree['url'] = $this->obtenirUrlFicheTraitement($referentiel, $id_traitement);
$donnees['entrees'][] = $entree;
}
if (isset($id_resultat)) {
$entree['nom'] = "Résultat #$id_resultat";
$entree['url'] = $this->obtenirUrlFicheResultat($referentiel, $id_resultat);
$donnees['entrees'][] = $entree;
}
}
$this->setSortie(self::RENDU_NAVIGATION, $this->getVue('fil_ariane', $donnees), false);
}
protected function obtenirUrlDetailReferentiel($referentiel) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Informations');
$this->url->setVariableRequete('ref', $referentiel);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));
return $url;
}
protected function obtenirUrlDetailReferentielTelechargement($referentiel) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Informations');
$this->url->setVariableRequete('action', 'telecharger');
$this->url->setVariableRequete('ref', $referentiel);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));
return $url;
}
protected function obtenirUrlMenuInformations($referentiel) {
return $this->obtenirUrlMenu('Informations', $referentiel);
}
protected function obtenirUrlMenuAccueil() {
return $this->obtenirUrlMenu('Accueil');
}
protected function obtenirUrlMenuTest($referentiel) {
return $this->obtenirUrlMenu('Test', $referentiel);
}
protected function obtenirUrlMenuVersionnage($referentiel) {
return $this->obtenirUrlMenu('Versionnage', $referentiel);
}
protected function obtenirUrlDemandeVersionnage($referentiel) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Versionnage');
$this->url->setVariableRequete('action', 'demanderTraitement');
$this->url->setVariableRequete('ref', $referentiel);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));
return $url;
}
protected function obtenirUrlMenuConsultation($referentiel) {
return $this->obtenirUrlMenu('Consultation', $referentiel);
}
protected function obtenirUrlMenuArbre($referentiel) {
return $this->obtenirUrlMenu('Arbre', $referentiel);
}
protected function obtenirUrlMenuBranche($referentiel, $num_nom) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Arbre');
$this->url->setVariableRequete('action', 'afficherBranche');
$this->url->setVariableRequete('ref', $referentiel);
$this->url->setVariableRequete('num_nom', $num_nom);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'action', 'ref', 'num_nom'));
return $url;
}
protected function obtenirUrlMenuBrancheSynonyme($referentiel, $num_nom) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Arbre');
$this->url->setVariableRequete('action', 'afficherBrancheSynonyme');
$this->url->setVariableRequete('ref', $referentiel);
$this->url->setVariableRequete('num_nom', $num_nom);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'action', 'ref', 'num_nom'));
return $url;
}
private function obtenirUrlMenu($menu, $referentiel = null) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', $menu);
if (isset($referentiel)) {
$this->url->setVariableRequete('ref', $referentiel);
}
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'ref'));
return $url;
}
protected function obtenirUrlFicheTraitement($referentiel, $id_traitement) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Traitement');
$this->url->setVariableRequete('id-t', $id_traitement);
$this->url->setVariableRequete('ref', $referentiel);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'id-t', 'ref'));
return $url;
}
protected function obtenirUrlFicheResultat($referentiel, $id_resultat) {
$this->url->setRequete(false);
$this->url->setVariableRequete('module', 'Resultat');
$this->url->setVariableRequete('id-r', $id_resultat);
$this->url->setVariableRequete('ref', $referentiel);
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('module', 'id-r', 'ref'));
return $url;
}
protected function obtenirUrlRecherche($referentiel = null, $txt = null) {
$this->url->setRequete(false);
if (!is_null($referentiel)) {
$this->url->setVariableRequete('ref', $referentiel);
}
$this->url->setVariableRequete('module', 'Recherche');
$this->url->setVariableRequete('action', 'rechercher');
if (!is_null($txt)) {
$this->url->setVariableRequete('recherche', $txt);
}
$url = $this->url->getURL();
$this->url->unsetVariablesRequete(array('ref', 'module', 'action', 'recherche'));
return $url;
}
protected function obtenirUrlFicheTaxon($referentiel, $num_nom = null) {
$this->url->setRequete(false);
$this->url->setVariableRequete('ref', $referentiel);
$this->url->setVariableRequete('module', 'FicheTaxon');
if (!is_null($num_nom)) {
$this->url->setVariableRequete('num_nom', $num_nom);
}
$url = clone $this->url;
$this->url->unsetVariablesRequete(array('module', 'id'));
return $url->getURL();
}
/**
* Lance l'ajout d'un traitement
*/
protected function ajouterTraitement($referentiel_code, $script_nom) {
$this->ajouterTraitementParametre($referentiel_code, null, $script_nom);
}
/**
* Lance l'ajout d'un traitement
*/
protected function ajouterTraitementParametre($referentiel_code, $parametres_serialises, $script_nom) {
if (is_null($referentiel_code)) {
$this->addMessage("Aucun code de projet de référentiel n'est indiqué (Ex. bdtfx).");
} else {
$traitements_a_supprimer = null;
$traitementDao = new TraitementDao();
$resultat_traitement_en_attente = $traitementDao->getTraitementsEnAttente($referentiel_code, $script_nom);
if ($resultat_traitement_en_attente) {
foreach ($resultat_traitement_en_attente as $traitement) {
$difference = $this->differenceEnSecondeEntreDeuxDates($traitement['meta_date_creation'], date ("Y-m-d H:i:s"));
Debug::printr("Différence attente : $difference > ".Config::get('ddv_traitement_attente'));
if ($difference > Config::get('ddv_traitement_attente')) {
$traitements_a_supprimer[] = $traitement['id_traitement'];
$this->addMessage("Le traitement #{$traitement['id_traitement']} était en attente depuis plus de 5mn, il a été supprimé.");
} else {
$this->addMessage("Un traitement est déjà en attente...");
}
}
} else {
$resultat_traitement_en_cours = $traitementDao->getTraitementsEnCours($referentiel_code, $script_nom);
if ($resultat_traitement_en_cours) {
foreach ($resultat_traitement_en_cours as $traitement) {
$difference = $this->differenceEnSecondeEntreDeuxDates($traitement['date_debut'], date ("Y-m-d H:i:s"));
Debug::printr("Différence en cours : $difference > ".Config::get('ddv_traitement_en_cours'));
if ($difference > Config::get('ddv_traitement_en_cours')) {
$traitements_a_supprimer[] = $traitement['id_traitement'];
$this->addMessage("Le traitement #{$traitement['id_traitement']} était en cours depuis plus de 5mn, il a été supprimé.");
} else {
$this->addMessage("Un traitement est déjà en cours...");
}
}
} else {
$resultat = $traitementDao->ajouterTraitementParametre($referentiel_code, $parametres_serialises, $script_nom);
if ($resultat != false) {
$this->addMessage("Le traitement #'$resultat' a été ajouté.");
$this->lancerScript($referentiel_code, $script_nom);
} else {
$this->addMessage("Un problème est survenu lors de la tentative d'ajout du traitement.");
}
}
}
// Suppression des traitements posant problème
if (count($traitements_a_supprimer) > 0) {
$traitementDao->supprimer($traitements_a_supprimer);
}
}
}
private function differenceEnSecondeEntreDeuxDates($date_01, $date_02) {
if (floatval(phpversion()) >= 5.3 ) {
$d1 = new DateTime($date_01);
$d2 = new DateTime($date_02);
$difference_absolue = true;
$diff = $d1->diff($d2, $difference_absolue);
$nbre_secondes = $diff->format('s');
} else {
$nbre_secondes = abs(round((strtotime($date_01) - strtotime($date_02))));
}
return $nbre_secondes;
}
/**
* Lance le script d'execution des traitements
*/
protected function lancerScript($referentiel_code, $script_nom) {
$php = Config::get('chemin_bin_php');
$exe = Config::get('chemin_script');
$action = 'tout';
$log = Config::get('chemin_script_log');
$limite_memoire = Config::get('script_limite_memoire');
$commande = "$php -d memory_limit=$limite_memoire -f $exe $script_nom -p $referentiel_code -a $action > $log &";
if ($this->verifierSafeModeOff() === false) {
$e = "Le safe_mode est actif sur ce serveur.";
} else if ($this->verifierAccesFonctionExec() === false) {
$e = "La fonction 'exec()' fait partie des fonctions désactivées sur ce serveur (voir disable_functions).";
} else {
$this->addMessage("Lancement du script effectuant les traitements.");
exec($commande);
}
 
// Affichage des message de paramêtrage du serveur si nécessaire
if (Config::get('script_messages') == true) {
$message_erreur_tpl = "%s\n.".
"Il est nécessaire de configurer le lancement du script via une tache dans le cron.\n".
"La commande à lancer est : <code>$commande</code>";
$this->addMessage(sprintf($message_erreur_tpl, $e));
}
}
private function verifierSafeModeOff() {
return ('1' == ini_get('safe_mode')) ? false : true;
}
private function verifierAccesFonctionExec() {
$disabled = explode(', ', ini_get('disable_functions'));
return !in_array('exec', $disabled);
}
//+----------------------------------------------------------------------------------------------------------------+
// GESTION DES FICHIERS A TELECHARGER
/**
* Crée la liste d'url des fichiers à télécharger pour un traitement donné
* @param Array $infos_traitement tableau contenant les informations du traitement
*
* @return Array un tableau contenant la liste des urls des fichiers à télécharger
*/
protected function obtenirUrlsZipPourTraitement($infos_traitement) {
$urls_zip = array();
if (isset($infos_traitement['script']) && $infos_traitement['script'] == 'versionnage') {
$meta = unserialize($infos_traitement['script_parametres']);
$projet = strtolower($infos_traitement['referentiel_code']);
$version = str_replace('.', '_', $meta['version']);
$fichier_zip_bdnt = $projet.'_v'.$version.'.zip';
$url_zip_bdnt = sprintf(Config::get('url_zip_tpl'), $fichier_zip_bdnt);
if ($this->testerUrl($url_zip_bdnt)) {
$urls_zip[$fichier_zip_bdnt] = $url_zip_bdnt;
}
}
return $urls_zip;
}
/**
* Teste une url donnée, en tentant de l'ouvrir et de la fermer
*
* @return boolean un booléen indiquant le succès ou non de l'opération
*/
protected function testerUrl($url) {
//TODO: voir si on peut inclure cette fonction dans le framework
ini_set('allow_url_fopen', '1');
return (@fclose(@fopen($url, 'r'))) ? true : false;
}
//+----------------------------------------------------------------------------------------------------------------+
// GESTION DU CLIENT REST
protected function getRestClient() {
if (! isset($this->restClient)) {
$this->restClient = new RestClient();
}
return $this->restClient;
}
//+----------------------------------------------------------------------------------------------------------------+
// GESTION DE L'IDENTIFICATION
protected function getAuthIdentifiant() {
$id = (isset($_SERVER['PHP_AUTH_USER'])) ? $_SERVER['PHP_AUTH_USER'] : null;
return $id;
}
protected function getAuthMotDePasse() {
$mdp = (isset($_SERVER['PHP_AUTH_PW'])) ? $_SERVER['PHP_AUTH_PW'] : null;
return $mdp;
}
public function authentifierCoordinateur() {
$message_accueil = "Veuillez vous identifier avec votre compte Tela Botanica.";
$message_echec = "Accès limité aux coordinateurs du projet.\n".
"Votre tentative d'identification a échoué.\n".
"Actualiser la page pour essayer à nouveau si vous êtes bien inscrit comme coordinateur.";
return $this->authentifier($message_accueil, $message_echec);
}
private function authentifier($message_accueil, $message_echec) {
$id = $this->getAuthIdentifiant();
if (!isset($id)) {
$this->envoyerAuth($message_accueil, $message_echec);
} else {
$autorisation = $this->etreCoordinateurAutorise();
if ($autorisation == false) {
$this->envoyerAuth($message_accueil, $message_echec);
}
}
return true;
}
public function etreCoordinateurAutorise($identifiant) {
$identifiant = $this->getAuthIdentifiant();
$mdp = md5($this->getAuthMotDePasse());
$url = sprintf(Config::get('authentification.serviceUrlTpl'), $identifiant, $mdp);
$json = $this->getRestClient()->envoyerRequeteConsultation($url);
$existe = json_decode($json);
$admin = $this->etreCoordinateur($identifiant) ? true : false;
$autorisation = ($existe && $admin) ? true : false;
return $autorisation;
}
public function etreCoordinateur($courriel) {
$coordinateurs = Config::get('authentification.coordinateurs');
$courriels_autorises = explode(',', $coordinateurs);
 
$autorisation = (in_array($courriel, $courriels_autorises)) ? true : false ;
return $autorisation;
}
private function envoyerAuth($message_accueil, $message_echec) {
header('HTTP/1.0 401 Unauthorized');
header('WWW-Authenticate: Basic realm="'.mb_convert_encoding($message_accueil, 'ISO-8859-1', 'UTF-8').'"');
header('Content-type: text/plain; charset=UTF-8');
print $message_echec;
exit(0);
}
}