Subversion Repositories Applications.referentiel

Rev

Rev 203 | Rev 272 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe Controleur générale partagée par les différents modules de l'application.
5
 *
6
 * @package		Referentiel
7
 * @category	Php5.2
8
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
9
 * @copyright	2010 Tela-Botanica
10
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
11
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
12
 * @version		SVN: $Id$
13
 */
14
abstract class AppliControleur extends Controleur {
15
 
16
	const RENDU_TETE = 'tete';
17
	const RENDU_CORPS = 'corps';
18
	const RENDU_PIED = 'pied';
37 jpm 19
	const RENDU_NAVIGATION = 'navigation';
20
	const RENDU_MENU = 'menu';
6 jpm 21
 
22
	// FIXME : voir s'il est plus intéressant d'utiliser une méthode dans les classes filles
23
	protected $url = null;
26 jpm 24
	private $parametres = array();
46 jpm 25
	protected $manuel = null;
26 jpm 26
	private $sortie = array();
27
	private $messages = null;
6 jpm 28
 
26 jpm 29
	//+----------------------------------------------------------------------------------------------------------------+
30
	// Constructeur
31
 
6 jpm 32
	public function __construct()  {
33
		$registre = Registre::getInstance();
34
		$this->parametres = $registre->get('parametres');
35
		$this->url = $this->parametres['url'];
46 jpm 36
		// Chargement des infos du manuel technique des référentiels
203 delphine 37
		$this->manuel = parse_ini_file(Config::get('chemin_appli').DS.'..'.DS.'configurations'.DS.Config::get('manuel'));
6 jpm 38
		parent::__construct();
39
	}
40
 
26 jpm 41
	//+----------------------------------------------------------------------------------------------------------------+
42
	// Accesseurs
43
 
6 jpm 44
	/**
26 jpm 45
	 * Retourne le tableau de sortie à utiliser dans le controleur principal de l'application.
46
	 */
47
	public function getSortie() {
48
		return $this->sortie;
49
	}
50
 
51
	/**
6 jpm 52
	 * Attribue à la bonne position de sortie un contenu.
53
	 */
54
	protected function setSortie($position, $contenu, $fusionner = false) {
55
		if ($this->verifierExistencePosition($position)) {
56
			if ($fusionner) {
57
				$this->sortie[$position] .= $contenu;
58
			} else {
59
				$this->sortie[$position] = $contenu;
60
			}
61
		}
62
	}
63
 
64
	/**
26 jpm 65
	 * Retourne le tableau des messages
66
	 */
67
	protected function getMessages() {
68
		return $this->messages;
69
	}
70
	/**
71
	 * Ajoute un message
72
	 */
73
	protected function addMessage($message) {
74
		if ('' != $message) {
75
			$this->messages[] = $message;
76
		}
77
	}
78
 
79
 
80
	//+----------------------------------------------------------------------------------------------------------------+
81
	// Méthodes
82
 
83
	/**
6 jpm 84
	 * Vérifie l'existence de la position indiquée pour son utilisation dans le tableau de sortie.
85
	 * @param string la position à tester.
86
	 * @return bool true si la position est valide, sinon false.
87
	 */
88
	private function verifierExistencePosition($position) {
89
		$existe = true;
90
		if ($position != self::RENDU_TETE &&
91
			$position != self::RENDU_CORPS &&
37 jpm 92
			$position != self::RENDU_PIED &&
93
			$position != self::RENDU_NAVIGATION &&
94
			$position != self::RENDU_MENU) {
6 jpm 95
			trigger_error("La position '$position' n'est pas une valeur prédéfinie.", E_USER_WARNING);
96
			$existe = false;
97
		}
98
		return $existe;
99
	}
100
 
101
	/**
102
	 * Execute l'action d'un module donnée et fusionne le résultat avec le tableau de sortie.
103
	 */
104
	protected function executerAction($ClasseModule, $action) {
105
		$module = new $ClasseModule();
106
		$module->$action();
107
		$this->fusionnerSortie($module->getSortie());
70 delphine 108
	}
109
 
134 delphine 110
	protected function executerActionReferentiel($ClasseModule, $action, $referentiel, $afficheMoteur = null) {
70 delphine 111
		$module = new $ClasseModule();
134 delphine 112
		$module->$action($referentiel, $afficheMoteur);
70 delphine 113
		$this->fusionnerSortie($module->getSortie());
6 jpm 114
 
115
	}
116
 
117
	/**
118
	 * Fusionne un tableau de sortie par défaut avec le tableau passé en paramêtre.
119
	 * @param array le tableau à fusionner
120
	 */
121
	private function fusionnerSortie($sortie) {
122
		$this->sortie = array_merge($this->sortie, $sortie);
123
	}
124
 
125
	protected function postraiterDonnees(&$tableau) {
126
		if (count($tableau) > 0) {
127
			foreach ($tableau as $cle => &$valeur) {
128
				if ($valeur == '') {
129
					$valeur = '&nbsp;';
130
				} else if (is_string($valeur)) {
33 jpm 131
					$valeur = $this->remplacerEsperluette($valeur);
6 jpm 132
				} else if (is_array($valeur)) {
133
					$this->postraiterDonnees($valeur);
134
				}
135
			}
136
		}
137
	}
33 jpm 138
 
139
	protected function traiterEsperluette(&$tableau) {
140
		if (count($tableau) > 0) {
141
			foreach ($tableau as $cle => &$valeur) {
142
				if (is_string($valeur)) {
143
					$valeur = $this->remplacerEsperluette($valeur);
144
				} else if (is_array($valeur)) {
145
					$this->traiterEsperluette($valeur);
146
				}
147
			}
148
		}
149
	}
150
 
57 jpm 151
	protected function remplacerEsperluette($txt) {
33 jpm 152
		$txt = preg_replace('/&(?!([a-z]+|#[0-9]+|#x[0-9a-f]+);)/i', '&amp;', $txt, -1);
153
		return $txt;
154
	}
45 jpm 155
 
57 jpm 156
	protected function supprimerSlash($doc) {
157
		if (is_string($doc)) {
158
			$doc = stripslashes($doc);
58 jpm 159
		} else if (is_array($doc) && count($doc) > 0) {
160
			foreach ($doc as $cle => $valeur) {
161
				$doc[$cle] = $this->supprimerSlash($valeur);
57 jpm 162
			}
163
		}
164
		return $doc;
165
	}
166
 
45 jpm 167
	protected function initialiserModulePrincipal() {
168
		$_SESSION['module_principal'] = null;
169
	}
170
 
171
	protected function definirCommeModulePrincipal($module_nom) {
172
		$_SESSION['module_principal'] = $module_nom;
173
	}
174
 
175
	private function getModulePrincipalCourant() {
176
		return $_SESSION['module_principal'];
177
	}
178
 
37 jpm 179
	/**
180
	 * Construction du menu et stockage dans le conteneur de sortie RENDU_MENU.
181
	 *
182
	 * @param string $referentiel code du référentiel.
183
	 */
184
	protected function construireMenu($referentiel) {
185
		$menu['nom'] = 'Accueil';
47 jpm 186
		$menu['url'] = $this->obtenirUrlMenuAccueil();
271 delphine 187
		$menu['activite'] = (($this->getModulePrincipalCourant() == 'Accueil') ? 'actif' : 'inactif');
188
		$menu['title'] = "Liste des référentiels consultables.";
37 jpm 189
		$donnees['menus'][] = $menu;
271 delphine 190
		$menu['nom'] = 'Consultation';
191
		$menu['url'] = $this->obtenirUrlMenuConsultation($referentiel);
192
		$menu['activite'] = ((preg_match('/^(?:Consultation|Recherche|FicheTaxon)$/', $this->getModulePrincipalCourant())) ? 'actif' : 'inactif');
193
		$menu['title'] = "Interroger la base en cours de travail.";
194
		$donnees['menus'][] = $menu;
37 jpm 195
		$menu['nom'] = 'Tests';
196
		$menu['url'] = $this->obtenirUrlMenuTest($referentiel);
271 delphine 197
		$menu['activite'] = (($this->getModulePrincipalCourant() == 'Test') ? 'actif' : 'inactif securise');
198
		$menu['title'] = "Réservé aux coordinateurs. Contrôler les données saisies.";
37 jpm 199
		$donnees['menus'][] = $menu;
200
		$menu['nom'] = 'Versionnage';
201
		$menu['url'] = $this->obtenirUrlMenuVersionnage($referentiel);
271 delphine 202
		$menu['activite'] = (($this->getModulePrincipalCourant() == 'Versionnage') ? 'actif' : 'inactif securise');
203
		$menu['title'] = "Réservé aux coordinateurs. Arrêter une version de votre base.";
37 jpm 204
		$donnees['menus'][] = $menu;
271 delphine 205
		$menu['nom'] = 'Informations';
206
		$menu['url'] = $this->obtenirUrlMenuInformations($referentiel);
207
		$menu['activite'] = (($this->getModulePrincipalCourant() == 'Informations') ? 'actif' : 'inactif');
208
		$menu['title'] = "Informations sur le projet.";
37 jpm 209
		$donnees['menus'][] = $menu;
210
		$this->setSortie(self::RENDU_MENU, $this->getVue('menu', $donnees), false);
211
	}
212
	/**
213
	 * Construction du fil d'ariane et stockage dans le conteneur de sortie RENDU_NAVIGATION.
214
	 *
215
	 * @param $referentiel code du référentiel
216
	 * @param $id_traitement id du traitement
217
	 * @param $id_resultat id du résultat
218
	 */
219
	protected function construireFilAriane($referentiel = null, $id_traitement = null, $id_resultat = null) {
220
		$entree['nom'] = 'Accueil';
221
		$entree['url'] = $this->obtenirUrlMenuAccueil();
222
		$donnees['entrees'][] = $entree;
223
 
224
		if (isset($referentiel)) {
271 delphine 225
			$entree['nom'] = 'Informations '.strtoupper($referentiel);
37 jpm 226
			$entree['url'] = $this->obtenirUrlDetailReferentiel($referentiel);
227
			$donnees['entrees'][] = $entree;
228
 
45 jpm 229
			$module_principal = $this->getModulePrincipalCourant();
230
			if (isset($module_principal)) {
231
				$entree['nom'] = $module_principal;
232
				$entree['url'] = $this->obtenirUrlMenu($module_principal, $referentiel);
37 jpm 233
				$donnees['entrees'][] = $entree;
234
			}
235
 
236
			if (isset($id_traitement)) {
237
				$entree['nom'] = "Traitement #$id_traitement";
238
				$entree['url'] = $this->obtenirUrlFicheTraitement($referentiel, $id_traitement);
239
				$donnees['entrees'][] = $entree;
240
			}
241
 
242
			if (isset($id_resultat)) {
243
				$entree['nom'] = "Résultat #$id_resultat";
244
				$entree['url'] = $this->obtenirUrlFicheResultat($referentiel, $id_resultat);
245
				$donnees['entrees'][] = $entree;
246
			}
247
		}
248
 
249
		$this->setSortie(self::RENDU_NAVIGATION, $this->getVue('fil_ariane', $donnees), false);
250
	}
33 jpm 251
 
37 jpm 252
	protected function obtenirUrlDetailReferentiel($referentiel) {
253
		$this->url->setRequete(false);
271 delphine 254
		$this->url->setVariableRequete('module', 'Informations');
37 jpm 255
		$this->url->setVariableRequete('ref', $referentiel);
256
		$url = $this->url->getURL();
257
		$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));
258
		return $url;
259
	}
260
 
271 delphine 261
	protected function obtenirUrlMenuInformations($referentiel) {
262
		return $this->obtenirUrlMenu('Informations', $referentiel);
263
	}
264
 
37 jpm 265
	protected function obtenirUrlMenuAccueil() {
266
		return $this->obtenirUrlMenu('Accueil');
267
	}
268
 
269
	protected function obtenirUrlMenuTest($referentiel) {
270
		return $this->obtenirUrlMenu('Test', $referentiel);
271
	}
272
 
273
	protected function obtenirUrlMenuVersionnage($referentiel) {
274
		return $this->obtenirUrlMenu('Versionnage', $referentiel);
275
	}
276
 
46 jpm 277
	protected function obtenirUrlDemandeVersionnage($referentiel) {
278
		$this->url->setRequete(false);
279
		$this->url->setVariableRequete('module', 'Versionnage');
280
		$this->url->setVariableRequete('action', 'demanderTraitement');
281
		$this->url->setVariableRequete('ref', $referentiel);
282
		$url = $this->url->getURL();
283
		$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));
284
		return $url;
285
	}
286
 
37 jpm 287
	protected function obtenirUrlMenuConsultation($referentiel) {
288
		return $this->obtenirUrlMenu('Consultation', $referentiel);
289
	}
290
 
291
	private function obtenirUrlMenu($menu, $referentiel = null) {
292
		$this->url->setRequete(false);
293
		$this->url->setVariableRequete('module', $menu);
294
		if (isset($referentiel)) {
295
			$this->url->setVariableRequete('ref', $referentiel);
296
		}
297
		$url = $this->url->getURL();
298
		$this->url->unsetVariablesRequete(array('module', 'ref'));
299
		return $url;
300
	}
301
 
302
	protected function obtenirUrlFicheTraitement($referentiel, $id_traitement) {
303
		$this->url->setRequete(false);
304
		$this->url->setVariableRequete('module', 'Traitement');
305
		$this->url->setVariableRequete('id-t', $id_traitement);
306
		$this->url->setVariableRequete('ref', $referentiel);
307
		$url = $this->url->getURL();
308
		$this->url->unsetVariablesRequete(array('module', 'id-t', 'ref'));
309
		return $url;
310
	}
311
 
312
	protected function obtenirUrlFicheResultat($referentiel, $id_resultat) {
313
		$this->url->setRequete(false);
314
		$this->url->setVariableRequete('module', 'Resultat');
315
		$this->url->setVariableRequete('id-r', $id_resultat);
316
		$this->url->setVariableRequete('ref', $referentiel);
317
		$url = $this->url->getURL();
318
		$this->url->unsetVariablesRequete(array('module', 'id-r', 'ref'));
319
		return $url;
320
	}
39 jpm 321
 
77 delphine 322
	protected function obtenirUrlRecherche($referentiel = null, $txt = null) {
70 delphine 323
		$this->url->setRequete(false);
77 delphine 324
		if (!is_null($referentiel)) {
325
			$this->url->setVariableRequete('ref', $referentiel);
326
		}
70 delphine 327
		$this->url->setVariableRequete('module', 'Recherche');
328
		$this->url->setVariableRequete('action', 'rechercher');
329
		if (!is_null($txt)) {
330
			$this->url->setVariableRequete('recherche', $txt);
331
		}
332
		$url = $this->url->getURL();
333
		$this->url->unsetVariablesRequete(array('ref', 'module', 'action', 'recherche'));
334
		return $url;
335
	}
103 jpm 336
	protected function obtenirUrlFicheTaxon($referentiel, $num_nom = null) {
77 delphine 337
		$this->url->setRequete(false);
338
		$this->url->setVariableRequete('ref', $referentiel);
339
		$this->url->setVariableRequete('module', 'FicheTaxon');
340
		if (!is_null($num_nom)) {
341
			$this->url->setVariableRequete('num_nom', $num_nom);
342
		}
343
		$url = clone $this->url;
344
		$this->url->unsetVariablesRequete(array('module', 'id'));
345
		return $url->getURL();
346
	}
70 delphine 347
 
39 jpm 348
	/**
349
	 * Lance l'ajout d'un traitement
350
	 */
351
	protected function ajouterTraitement($referentiel_code, $script_nom) {
51 jpm 352
		$this->ajouterTraitementParametre($referentiel_code, null, $script_nom);
353
	}
354
 
355
	/**
356
	 * Lance l'ajout d'un traitement
357
	 */
358
	protected function ajouterTraitementParametre($referentiel_code, $parametres_serialises, $script_nom) {
39 jpm 359
		if (is_null($referentiel_code)) {
156 jpm 360
			$this->addMessage("Aucun code de projet de référentiel n'est indiqué (Ex. bdtfx).");
39 jpm 361
		} else {
46 jpm 362
			$traitements_a_supprimer = null;
39 jpm 363
			$traitementDao = new TraitementDao();
364
			$resultat_traitement_en_attente = $traitementDao->getTraitementsEnAttente($referentiel_code, $script_nom);
365
			if ($resultat_traitement_en_attente) {
46 jpm 366
				foreach ($resultat_traitement_en_attente as $traitement) {
367
					$difference = $this->differenceEnSecondeEntreDeuxDates($traitement['meta_date_creation'], date ("Y-m-d H:i:s"));
368
					Debug::printr("Différence attente : $difference > ".Config::get('ddv_traitement_attente'));
369
					if ($difference > Config::get('ddv_traitement_attente')) {
370
						$traitements_a_supprimer[] = $traitement['id_traitement'];
371
						$this->addMessage("Le traitement #{$traitement['id_traitement']} était en attente depuis plus de 5mn, il a été supprimé.");
372
					} else {
373
						$this->addMessage("Un traitement est déjà en attente...");
374
					}
375
				}
39 jpm 376
			} else {
377
				$resultat_traitement_en_cours = $traitementDao->getTraitementsEnCours($referentiel_code, $script_nom);
378
				if ($resultat_traitement_en_cours) {
46 jpm 379
					foreach ($resultat_traitement_en_cours as $traitement) {
380
						$difference = $this->differenceEnSecondeEntreDeuxDates($traitement['date_debut'], date ("Y-m-d H:i:s"));
381
						Debug::printr("Différence en cours : $difference > ".Config::get('ddv_traitement_en_cours'));
382
						if ($difference > Config::get('ddv_traitement_en_cours')) {
383
							$traitements_a_supprimer[] = $traitement['id_traitement'];
384
							$this->addMessage("Le traitement #{$traitement['id_traitement']} était en cours depuis plus de 5mn, il a été supprimé.");
385
						} else {
386
							$this->addMessage("Un traitement est déjà en cours...");
387
						}
388
					}
39 jpm 389
				} else {
51 jpm 390
					$resultat = $traitementDao->ajouterTraitementParametre($referentiel_code, $parametres_serialises, $script_nom);
39 jpm 391
					if ($resultat != false) {
392
						$this->addMessage("Le traitement #'$resultat' a été ajouté.");
393
						$this->lancerScript($referentiel_code, $script_nom);
394
					} else {
395
						$this->addMessage("Un problème est survenu lors de la tentative d'ajout du traitement.");
396
					}
397
				}
398
			}
46 jpm 399
			// Suppression des traitements posant problème
400
			if (count($traitements_a_supprimer) > 0) {
401
				$traitementDao->supprimer($traitements_a_supprimer);
402
			}
39 jpm 403
		}
404
	}
405
 
46 jpm 406
	private function differenceEnSecondeEntreDeuxDates($date_01, $date_02) {
407
		if (floatval(phpversion()) >= 5.3 ) {
408
			$d1 = new DateTime($date_01);
409
			$d2 = new DateTime($date_02);
410
			$difference_absolue = true;
411
			$diff = $d1->diff($d2, $difference_absolue);
412
			$nbre_secondes = $diff->format('s');
413
		} else {
414
			$nbre_secondes = abs(round((strtotime($date_01) - strtotime($date_02))));
415
		}
416
		return $nbre_secondes;
417
	}
418
 
39 jpm 419
	/**
420
	 * Lance le script d'execution des traitements
421
	 */
422
	protected function lancerScript($referentiel_code, $script_nom) {
423
		$php = Config::get('chemin_bin_php');
424
		$exe = Config::get('chemin_script');
425
		$action = 'tout';
426
		$log = Config::get('chemin_script_log');
46 jpm 427
		$limite_memoire = Config::get('script_limite_memoire');
428
		$commande = "$php -d memory_limit=$limite_memoire -f $exe $script_nom -p $referentiel_code -a $action > $log &";
39 jpm 429
 
430
		if ($this->verifierSafeModeOff() === false) {
431
			$e = "Le safe_mode est actif sur ce serveur.";
432
		} else if ($this->verifierAccesFonctionExec() === false) {
433
			$e = "La fonction 'exec()' fait partie des fonctions désactivées sur ce serveur (voir disable_functions).";
434
		} else {
435
			$this->addMessage("Lancement du script effectuant les traitements.");
436
			exec($commande);
437
		}
438
 
439
		// Affichage des message de paramêtrage du serveur si nécessaire
440
		if (Config::get('script_messages') == true) {
441
			$message_erreur_tpl = "%s\n.".
442
				"Il est nécessaire de configurer le lancement du script via une tache dans le cron.\n".
443
				"La commande à lancer est : <code>$commande</code>";
444
			$this->addMessage(sprintf($message_erreur_tpl, $e));
445
		}
446
	}
447
 
448
	private function verifierSafeModeOff() {
449
		return ('1' == ini_get('safe_mode')) ? false : true;
450
	}
451
 
452
	private function verifierAccesFonctionExec() {
453
		$disabled = explode(', ', ini_get('disable_functions'));
454
		return !in_array('exec', $disabled);
455
	}
120 jpm 456
 
457
	//+----------------------------------------------------------------------------------------------------------------+
458
	// GESTION DU CLIENT REST
459
 
460
	protected function getRestClient() {
461
		if (! isset($this->restClient)) {
462
			$this->restClient = new RestClient();
463
		}
464
		return $this->restClient;
465
	}
466
 
467
	//+----------------------------------------------------------------------------------------------------------------+
468
	// GESTION DE L'IDENTIFICATION
469
 
470
	protected function getAuthIdentifiant() {
471
		$id = (isset($_SERVER['PHP_AUTH_USER'])) ? $_SERVER['PHP_AUTH_USER'] : null;
472
		return $id;
473
	}
474
 
475
	protected function getAuthMotDePasse() {
476
		$mdp = (isset($_SERVER['PHP_AUTH_PW'])) ? $_SERVER['PHP_AUTH_PW'] : null;
477
		return $mdp;
478
	}
479
 
480
	public function authentifierCoordinateur() {
481
		$message_accueil = "Veuillez vous identifier avec votre compte Tela Botanica.";
482
		$message_echec = "Accès limité aux coordinateurs du projet.\n".
483
			"Votre tentative d'identification a échoué.\n".
484
			"Actualiser la page pour essayer à nouveau si vous êtes bien inscrit comme coordinateur.";
485
		return $this->authentifier($message_accueil, $message_echec);
486
	}
487
 
488
	private function authentifier($message_accueil, $message_echec) {
489
		$id = $this->getAuthIdentifiant();
490
		if (!isset($id)) {
491
			$this->envoyerAuth($message_accueil, $message_echec);
492
		} else {
493
			$autorisation = $this->etreCoordinateurAutorise();
494
			if ($autorisation == false) {
495
				$this->envoyerAuth($message_accueil, $message_echec);
496
			}
497
		}
498
		return true;
499
	}
500
 
501
	public function etreCoordinateurAutorise($identifiant) {
502
		$identifiant = $this->getAuthIdentifiant();
503
		$mdp = md5($this->getAuthMotDePasse());
504
		$url = sprintf(Config::get('authentification.serviceUrlTpl'), $identifiant, $mdp);
505
		$json = $this->getRestClient()->envoyerRequeteConsultation($url);
506
		$existe = json_decode($json);
507
		$admin = $this->etreCoordinateur($identifiant) ? true : false;
508
		$autorisation = ($existe && $admin) ? true : false;
509
		return $autorisation;
510
	}
511
 
512
	public function etreCoordinateur($courriel) {
513
		$coordinateurs = Config::get('authentification.coordinateurs');
514
		$courriels_autorises = explode(',', $coordinateurs);
515
 
516
		$autorisation = (in_array($courriel, $courriels_autorises)) ? true : false ;
517
		return $autorisation;
518
	}
519
 
520
	private function envoyerAuth($message_accueil, $message_echec) {
521
		header('HTTP/1.0 401 Unauthorized');
522
		header('WWW-Authenticate: Basic realm="'.mb_convert_encoding($message_accueil, 'ISO-8859-1', 'UTF-8').'"');
523
		header('Content-type: text/plain; charset=UTF-8');
524
		print $message_echec;
525
		exit(0);
526
	}
6 jpm 527
}