Subversion Repositories eFlore/Applications.cel

Rev

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

Rev Author Line No. Line
712 jpm 1
<?php
2
/**
2688 mathias 3
 * Widget fournissant des interfaces de saisie simplifiée pour différent projets
712 jpm 4
 *
5
 * Cas d'utilisation et documentation :
2688 mathias 6
 * @link http://www.tela-botanica.org/wikini/AideCarnetEnLigne/wakka.php?wiki=AideCELWidgetSaisie
712 jpm 7
 *
8
 * Paramètres :
2688 mathias 9
 * - projet [par défaut : defaut] : indique le mot-clé à associer aux obs saisies; si un widget de saisie personnalisé
10
 * 		portant ce nom existe, il sera chargé
11
 * - mission [par défaut : vide] : permet de charger un "sous-widget", dans le cas où un widget personnalisé
12
 * 		est associé au projet, et ce widget accepte des sous-widgets (ex: "missions-flore")
712 jpm 13
 *
2408 jpm 14
 * @author Mathias CHOUET <mathias@tela-botanica.org>
15
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
16
 * @author Aurelien PERONNET <aurelien@tela-botanica.org>
17
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
18
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
2688 mathias 19
 * @copyright 1999-2015 Tela Botanica <accueil@tela-botanica.org>
712 jpm 20
 */
21
class Saisie extends WidgetCommun {
1050 jpm 22
 
712 jpm 23
	const DS = DIRECTORY_SEPARATOR;
1345 aurelien 24
	const PROJET_DEFAUT = 'defaut';
1580 jpm 25
	const WS_SAISIE = 'CelWidgetSaisie';
1888 mathias 26
	const WS_UPLOAD = 'CelWidgetUploadImageTemp';
1580 jpm 27
	const WS_OBS = 'CelObs';
28
	const WS_NOM = 'noms';
29
	const EFLORE_API_VERSION = '0.1';
2688 mathias 30
	const REFERENTIEL_DEFAUT = 'bdtfx';
1050 jpm 31
 
2688 mathias 32
	/** référentiel utilisé pour al complétion des noms scientifiques */
33
	protected $ns_referentiel;
34
	/** mot-clé associé aux saisies, et template personnalisé si appliquable */
35
	protected $projet = null;
36
	protected $configProjet = null;
37
	protected $configMission = null;
2805 mathias 38
	protected $mission = null;
2786 mathias 39
	/** langue (traduction), charge un template de la forme "defaut_en.tpl.html" */
40
	protected $langue = null;
1050 jpm 41
 
712 jpm 42
	/**
2688 mathias 43
	 * Amorçage du widget
712 jpm 44
	 */
45
	public function executer() {
2688 mathias 46
		// paramètres par défaut
47
		$this->ns_referentiel = self::REFERENTIEL_DEFAUT;
48
		$this->projet = self::PROJET_DEFAUT;
712 jpm 49
 
2688 mathias 50
		// définition du projet / mission
51
		if (isset($this->parametres['projet']) && trim($this->parametres['projet']) != "") {
52
			$projets = explode(',', $this->parametres['projet']);
2577 aurelien 53
			$this->projet = strtolower($projets[0]);
2500 mathias 54
		}
719 jpm 55
		$this->chargerConfigProjet();
1050 jpm 56
 
2688 mathias 57
		// exécution du service (le widget entier ou une sous-partie, par ex "Taxons")
58
		$retour = null;
59
		$service = isset($this->parametres['service']) ? $this->parametres['service'] : 'widget';
719 jpm 60
		$methode = $this->traiterNomMethodeExecuter($service);
712 jpm 61
		if (method_exists($this, $methode)) {
62
			$retour = $this->$methode();
63
		} else {
2688 mathias 64
			$this->messages[] = "Le service '$methode' n'est pas disponible.";
712 jpm 65
		}
66
 
2786 mathias 67
		// définition de la langue, en mode souple
68
		if (isset($this->parametres['lang'])) {
69
			$this->langue = $this->parametres['lang'];
70
		}
71
 
2688 mathias 72
		// injection des données dans le squelette
1050 jpm 73
		$contenu = null;
74
		$mime = null;
75
		if (is_array($retour) && array_key_exists('squelette', $retour)) {
719 jpm 76
			$ext = (isset($retour['squelette_ext'])) ? $retour['squelette_ext'] : '.tpl.html';
2786 mathias 77
			// Suffixe de template pour la langue - fr par défaut @TODO configurer ça un jour
78
			$suffixeLangue = "";
79
			if ($this->langue != null && $this->langue != "fr") {
80
				$suffixeLangue = "_" . $this->langue;
81
			}
82
			// Template par défaut ou spécifique
2406 jpm 83
			if ($this->projetASquelette()) {
2786 mathias 84
				$squelette = dirname(__FILE__).self::DS.'squelettes'.self::DS.$this->projet.self::DS.$retour['squelette'].$suffixeLangue.$ext;
1475 aurelien 85
			} else {
2786 mathias 86
				$squelette = dirname(__FILE__).self::DS.'squelettes'.self::DS.'defaut'.self::DS.'defaut'.$suffixeLangue.$ext;
1475 aurelien 87
			}
712 jpm 88
			$contenu = $this->traiterSquelettePhp($squelette, $retour['donnees']);
1050 jpm 89
			$mime = isset($retour['mime']) ? $retour['mime'] : null;
90
		} else {
91
			if (count($this->messages) == 0) {
2688 mathias 92
				$this->messages[] = "La méthode du sous-service ne renvoie pas les données dans le bon format";
1050 jpm 93
			}
2688 mathias 94
			$contenu = 'Un problème est survenu : ' . print_r($this->messages, true);
712 jpm 95
		}
1050 jpm 96
 
2688 mathias 97
		// envoi de la page
1050 jpm 98
		$this->envoyer($contenu, $mime);
712 jpm 99
	}
1050 jpm 100
 
2688 mathias 101
	/**
102
	 * Charge le fichier de configuration associé au projet : configurations/nomduprojet.ini
103
	 * Si une mission est définie, charge séparément la section de la configuration concernant
104
	 * cette mission : [nommission]
105
	 */
106
	protected function chargerConfigProjet() {
719 jpm 107
		$fichier_config = dirname(__FILE__).self::DS.'configurations'.self::DS.$this->projet.'.ini';
108
		if (file_exists($fichier_config)) {
2408 jpm 109
			if ($this->configProjet = parse_ini_file($fichier_config, true)) {
110
				if (isset($_GET['mission'])) {
2805 mathias 111
					$this->mission = strtolower(trim($_GET['mission']));
112
					if (isset($this->configProjet[$this->mission])) {
113
						$this->configMission = $this->configProjet[$this->mission];
2408 jpm 114
					}
2688 mathias 115
				}
2408 jpm 116
			} else {
2688 mathias 117
				$this->messages[] = "Le fichier de configuration '$fichier_config' n'a pu être chargé.";
1050 jpm 118
			}
719 jpm 119
		} else {
2688 mathias 120
			$this->debug[] = "Le fichier de configuration '$fichier_config' n'existe pas.";
719 jpm 121
		}
122
	}
1526 jpm 123
 
2688 mathias 124
	/**
125
	 * Retourne true si le dossier du projet courant existe, false sinon
126
	 * @return boolean
127
	 */
128
	protected function projetASquelette() {
2408 jpm 129
		return file_exists(dirname(__FILE__).self::DS.'squelettes'.self::DS.$this->projet);
1476 aurelien 130
	}
1050 jpm 131
 
2688 mathias 132
	/**
133
	 * Exécution du widget complet
134
	 * @return Ambigous <string, unknown, multitype:string unknown >
135
	 */
1345 aurelien 136
	public function executerWidget() {
1476 aurelien 137
		$referentiel_impose = false;
2343 aurelien 138
		if (isset($_GET['referentiel']) && $_GET['referentiel'] != '' && $_GET['referentiel'] != "autre") {
2688 mathias 139
			$this->ns_referentiel = $_GET['referentiel'];
1476 aurelien 140
			$referentiel_impose = true;
141
		}
1526 jpm 142
 
1050 jpm 143
		$widget['squelette'] = $this->projet;
144
		$widget['donnees'] = array();
145
		$widget['donnees']['url_base'] = sprintf($this->config['chemins']['baseURLAbsoluDyn'], '');
146
		$widget['donnees']['url_ws_saisie'] = sprintf($this->config['chemins']['baseURLServicesCelTpl'], self::WS_SAISIE);
1580 jpm 147
		$widget['donnees']['url_ws_obs'] = sprintf($this->config['chemins']['baseURLServicesCelTpl'], self::WS_OBS);
1888 mathias 148
		$widget['donnees']['url_ws_upload'] = sprintf($this->config['chemins']['baseURLServicesCelTpl'], self::WS_UPLOAD);
1536 jpm 149
		$widget['donnees']['url_ws_annuaire'] = sprintf($this->config['chemins']['baseURLServicesAnnuaireTpl'], 'utilisateur/identite-par-courriel/');
2082 mathias 150
		$widget['donnees']['url_remarques'] = $this->config['chemins']['widgetRemarquesUrl'];
1526 jpm 151
 
1516 aurelien 152
		$widget['donnees']['logo'] = isset($_GET['logo']) ? $_GET['logo'] : 'defaut';
2408 jpm 153
		$widget['donnees']['titre'] = $this->getTitrePage();
2805 mathias 154
		$widget['donnees']['nom_mission'] = $this->getNomMissionFlore();
1526 jpm 155
 
2498 aurelien 156
		$widget['donnees']['referentiel_impose'] = $referentiel_impose;
157
		$widget['donnees']['espece_imposee'] = false;
158
		$widget['donnees']['nn_espece_defaut'] = '';
159
		$widget['donnees']['nom_sci_espece_defaut'] = '';
160
		$widget['donnees']['infos_espece'] = '{}';
2847 mathias 161
 
162
		$widget['donnees']['prod'] = ($this->config['parametres']['modeServeur'] == "prod");
2498 aurelien 163
 
2406 jpm 164
		$projetsAutorises = $this->transformerEnTableau($this->config['projets']['autorises']);
1526 jpm 165
 
2498 aurelien 166
		$urlWsNsTpl = $this->config['chemins']['baseURLServicesEfloreTpl'];
167
		$urlWsNs = sprintf($urlWsNsTpl, self::EFLORE_API_VERSION, $this->ns_referentiel, self::WS_NOM);
168
		$urlWsNsSansRef = sprintf($urlWsNsTpl, self::EFLORE_API_VERSION, '{referentiel}', self::WS_NOM);
169
		$widget['donnees']['url_ws_autocompletion_ns'] = $urlWsNs;
170
		$widget['donnees']['url_ws_autocompletion_ns_tpl'] = $urlWsNsSansRef;
171
		$widget['donnees']['ns_referentiel'] = $this->ns_referentiel;
2744 aurelien 172
 
173
		$widget['donnees']['url_ws_trace_rue_tpl'] = $this->config['chemins']['serviceTraceRueUrl'];
2498 aurelien 174
 
175
		if ($this->especeEstImposee()) {
176
			$nnEspeceImposee = $this->getNnEspeceImposee();
2810 mathias 177
			$nom = $this->chargerInfosTaxon($nnEspeceImposee);
2498 aurelien 178
			$widget['donnees']['espece_imposee'] = true;
179
			$widget['donnees']['nn_espece_defaut'] = $nnEspeceImposee;
2801 mathias 180
			$widget['donnees']['nom_sci_espece_defaut'] = $nom['nom_complet'];
2498 aurelien 181
			$widget['donnees']['infos_espece'] = $this->array2js($nom, true);
1536 jpm 182
		}
2406 jpm 183
 
184
		$projetsAListeDeNoms = $this->transformerEnTableau($this->config['projets']['liste_noms']);
185
		if (in_array($this->projet, $projetsAListeDeNoms)) {
186
			$projetsAListeDeNomsSciEtVerna = $this->transformerEnTableau($this->config['projets']['liste_noms_sci_et_verna']);
187
			if (in_array($this->projet, $projetsAListeDeNomsSciEtVerna)) {
1613 jpm 188
				$widget['donnees']['taxons'] = $this->recupererListeNoms();
189
			} else {
190
				$widget['donnees']['taxons'] = $this->recupererListeNomsSci();
2328 jpm 191
			}
2406 jpm 192
		}
193
 
194
		// Chargement de la liste des milieux issues du fichier .ini du projet
195
		$projetsAListeDeMilieux = $this->transformerEnTableau($this->config['projets']['liste_milieux']);
196
		if (in_array($this->projet, $projetsAListeDeMilieux)) {
1345 aurelien 197
			$widget['donnees']['milieux'] = $this->parserMilieux();
719 jpm 198
		}
2406 jpm 199
 
200
		return $widget;
719 jpm 201
	}
1526 jpm 202
 
2688 mathias 203
	protected function getTitrePage() {
2408 jpm 204
		$titre = 'defaut';
205
		if (isset($this->configProjet['titre_page'])) {
206
			$titre = $this->configProjet['titre_page'];
207
		}
208
		if (isset($this->configMission['titre_page'])) {
209
			$titre = $this->configMission['titre_page'];
210
		}
211
		if (isset($_GET['titre'])) {
212
			$titre = $_GET['titre'];
213
		}
214
		if ($titre === 0) {
215
			$titre = '';
216
		}
217
		return $titre;
1475 aurelien 218
	}
1050 jpm 219
 
2688 mathias 220
	/**
2805 mathias 221
	 * Un nom un peu plus sympatoche à afficher que juste le mot-clef associé; s'il
222
	 * n'est pas défini dans la config, on prend le mot-clef tout de même
223
	 */
224
	protected function getNomMissionFlore() {
225
		$nom = $this->mission;
226
		if (isset($this->configMission['nom_mission'])) {
227
			$nom = $this->configMission['nom_mission'];
228
		}
229
		return $nom;
230
	}
231
 
232
	/**
2688 mathias 233
	 * Remplit un fichier JS avec une variable contenant une liste restreinte de taxons,
234
	 * pour certains projets
235
	 * @return string
236
	 */
2328 jpm 237
	public function executerTaxons() {
238
		$widget['squelette'] = $this->projet.'_taxons';
239
		$widget['squelette_ext'] = '.tpl.js';
1613 jpm 240
		$widget['donnees'] = array();
1629 jpm 241
		$nomsAAfficher = $this->recupererListeNomsSci();
242
		$taxons_tries = array();
1691 raphael 243
		foreach ($nomsAAfficher as $taxon) {
1629 jpm 244
			$taxons_tries[$taxon['num_nom_sel']] = $taxon;
2328 jpm 245
		}
246
		$widget['donnees']['taxons'] = json_encode($taxons_tries);
247
		return $widget;
248
	}
1613 jpm 249
 
2688 mathias 250
	/**
251
	 * Trie par nom français les taxons lus dans le fichier tsv
252
	 */
253
	protected function recupererListeNomsSci() {
1613 jpm 254
		$taxons = $this->recupererListeTaxon();
255
		if (is_array($taxons)) {
256
			$taxons = self::trierTableauMd($taxons, array('nom_fr' => SORT_ASC));
257
		}
1629 jpm 258
		return $taxons;
1613 jpm 259
	}
260
 
2688 mathias 261
	/**
262
	 * @TODO documenter
263
	 * @return array
264
	 */
265
	protected function recupererListeNoms() {
1613 jpm 266
		$taxons = $this->recupererListeTaxon();
267
		$nomsAAfficher = array();
268
		$nomsSpeciaux = array();
269
		if (is_array($taxons)) {
270
			foreach ($taxons as $taxon) {
271
				$nomSciTitle = $taxon['nom_ret'].
272
					($taxon['nom_fr'] != '' ? ' - '.$taxon['nom_fr'] : '' ).
273
					($taxon['nom_fr_autre'] != '' ? ' - '.$taxon['nom_fr_autre'] : '' );
274
				$nomFrTitle = $taxon['nom_sel'].
275
					($taxon['nom_ret'] != $taxon['nom_sel']? ' - '.$taxon['nom_ret'] : '' ).
276
					($taxon['nom_fr_autre'] != '' ? ' - '.$taxon['nom_fr_autre'] : '' );
277
 
278
				if ($taxon['groupe'] == 'special') {
279
					$nomsSpeciaux[] = array(
280
						'num_nom' => $taxon['num_nom_sel'],
281
						'nom_a_afficher' => $taxon['nom_fr'],
282
						'nom_a_sauver' => $taxon['nom_sel'],
283
						'nom_title' => $nomSciTitle,
284
						'nom_type' => 'nom-special');
285
				} else {
286
					$nomsAAfficher[] = array(
287
						'num_nom' => $taxon['num_nom_sel'],
288
						'nom_a_afficher' => $taxon['nom_sel'],
289
						'nom_a_sauver' => $taxon['nom_sel'],
290
						'nom_title' => $nomSciTitle,
291
						'nom_type' => 'nom-sci');
292
					$nomsAAfficher[] = array(
293
						'num_nom' => $taxon['num_nom_sel'],
294
						'nom_a_afficher' => $taxon['nom_fr'],
295
						'nom_a_sauver' => $taxon['nom_fr'],
296
						'nom_title' => $nomFrTitle,
297
						'nom_type' => 'nom-fr');
298
				}
299
			}
300
			$nomsAAfficher = self::trierTableauMd($nomsAAfficher, array('nom_a_afficher' => SORT_ASC));
301
			$nomsSpeciaux = self::trierTableauMd($nomsSpeciaux, array('nom_a_afficher' => SORT_ASC));
302
		}
303
		return array('speciaux' => $nomsSpeciaux, 'sci-et-fr' => $nomsAAfficher);
304
	}
2328 jpm 305
 
2688 mathias 306
	/**
307
	 * Lit une liste de taxons depuis un fichier tsv fourni
308
	 */
309
	protected function recupererListeTaxon() {
310
		$taxons = array();
2328 jpm 311
		$fichier_tsv = dirname(__FILE__).self::DS.'configurations'.self::DS.$this->projet.'_taxons.tsv';
312
		if (file_exists($fichier_tsv) && is_readable($fichier_tsv)) {
712 jpm 313
			$taxons = $this->decomposerFichierTsv($fichier_tsv);
2328 jpm 314
		} else {
315
			$this->debug[] = "Impossible d'ouvrir le fichier '$fichier_tsv'.";
316
		}
317
		return $taxons;
712 jpm 318
	}
1050 jpm 319
 
2688 mathias 320
	/**
321
	 * Découpe un fihcier tsv
322
	 */
323
	protected function decomposerFichierTsv($fichier, $delimiter = "\t"){
2328 jpm 324
		$header = null;
325
		$data = array();
326
		if (($handle = fopen($fichier, 'r')) !== FALSE) {
327
			while (($row = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
328
				if (!$header) {
329
					$header = $row;
330
				} else {
331
					$data[] = array_combine($header, $row);
332
				}
333
			}
334
			fclose($handle);
335
		}
336
		return $data;
337
	}
338
 
2688 mathias 339
	/**
340
	 * Récupère la liste des milieux depuis la section [milieux] de la configuration
341
	 * du projet, si elle existe
342
	 * @return array
343
	 */
344
	protected function parserMilieux() {
1050 jpm 345
		$infosMilieux = array();
1536 jpm 346
		if (isset($this->configProjet['milieux'])) {
347
			$milieux = explode('|', $this->configProjet['milieux']);
348
			foreach ($milieux as $milieu) {
2328 jpm 349
				$milieu = trim($milieu);
1536 jpm 350
				$details = explode(';', $milieu);
351
				if (isset($details[1])) {
352
					$infosMilieux[$details[0]] = $details[1];
353
				} else {
354
					$infosMilieux[$details[0]] = '';
355
				}
1050 jpm 356
			}
1536 jpm 357
			ksort($infosMilieux);
1050 jpm 358
		}
359
		return $infosMilieux;
360
	}
1526 jpm 361
 
2688 mathias 362
	/**
363
	 * Retourne true si le widget est restreint à une espèce, false sinon
364
	 * @return boolean
365
	 */
366
	protected function especeEstImposee() {
367
		return ((isset($_GET['num_nom']) && $_GET['num_nom'] != '')
2408 jpm 368
			|| isset($this->configProjet['sp_imposee']) || isset($this->configMission['sp_imposee']));
1418 aurelien 369
	}
1526 jpm 370
 
2688 mathias 371
	/**
372
	 * Retourne le numéro nomenclatural (nn) de l'espèce imposée si tel est
373
	 * le cas, null sinon
374
	 * @return string
375
	 */
376
	protected function getNnEspeceImposee() {
2328 jpm 377
		$nn = null;
378
		if (isset($_GET['num_nom']) && is_numeric($_GET['num_nom'])) {
379
			$nn = $_GET['num_nom'];
380
		} else if (isset($this->configProjet['sp_imposee'])) {
381
			$nn = $this->configProjet['sp_imposee'];
2408 jpm 382
		} else if (isset($this->configMission['sp_imposee'])) {
383
			$nn = $this->configMission['sp_imposee'];
2328 jpm 384
		}
385
		return $nn;
386
	}
387
 
2688 mathias 388
	/**
389
	 * Consulte un webservice pour obtenir des informations sur le taxon dont le
390
	 * numéro nomenclatural est $num_nom (ce sont donc plutôt des infos sur le nom
391
	 * et non le taxon?)
392
	 * @param string|int $num_nom
393
	 * @return array
394
	 */
395
	protected function chargerInfosTaxon($num_nom) {
2408 jpm 396
		$url_service_infos = sprintf($this->config['chemins']['infosTaxonUrl'], $this->ns_referentiel, $num_nom);
1418 aurelien 397
		$infos = json_decode(file_get_contents($url_service_infos));
2688 mathias 398
		// trop de champs injectés dans les infos espèces peuvent
1909 raphael 399
		// faire planter javascript
2801 mathias 400
		$champs_a_garder = array('id', 'nom_sci','nom_sci_complet', 'nom_complet',
2840 mathias 401
			'famille','nom_retenu.id', 'nom_retenu_complet', 'num_taxonomique');
1419 aurelien 402
		$resultat = array();
1539 jpm 403
		if (isset($infos) && !empty($infos)) {
1419 aurelien 404
			$infos = (array)$infos;
2367 jpm 405
			if (isset($infos['nom_sci']) && $infos['nom_sci'] != '') {
1909 raphael 406
				$resultat = array_intersect_key($infos, array_flip($champs_a_garder));
407
				$resultat['retenu'] = ($infos['id'] == $infos['nom_retenu.id']) ? "true" : "false";
1916 jpm 408
			}
1419 aurelien 409
		}
1418 aurelien 410
		return $resultat;
411
	}
1050 jpm 412
 
2688 mathias 413
	/**
414
	 * Convertit un tableau PHP en Javascript - @WTF pourquoi ne pas faire un json_encode ?
415
	 * @param array $array
416
	 * @param boolean $show_keys
417
	 * @return une portion de JSON représentant le tableau
418
	 */
419
	protected function array2js($array,$show_keys) {
1536 jpm 420
		$tableauJs = '{}';
421
		if (!empty($array)) {
422
			$total = count($array) - 1;
423
			$i = 0;
424
			$dimensions = array();
425
			foreach ($array as $key => $value) {
426
				if (is_array($value)) {
427
					$dimensions[$i] = array2js($value,$show_keys);
428
					if ($show_keys) {
429
						$dimensions[$i] = '"'.$key.'":'.$dimensions[$i];
430
					}
431
				} else {
432
					$dimensions[$i] = '"'.addslashes($value).'"';
433
					if ($show_keys) {
434
						$dimensions[$i] = '"'.$key.'":'.$dimensions[$i];
435
					}
1526 jpm 436
				}
1536 jpm 437
				if ($i == 0) {
438
					$dimensions[$i] = '{'.$dimensions[$i];
1526 jpm 439
				}
1536 jpm 440
				if ($i == $total) {
441
					$dimensions[$i].= '}';
442
				}
443
				$i++;
1526 jpm 444
			}
1536 jpm 445
			$tableauJs = implode(',', $dimensions);
1526 jpm 446
		}
1536 jpm 447
		return $tableauJs;
1526 jpm 448
	}
2360 jpm 449
}