Subversion Repositories eFlore/Applications.cel

Rev

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