Subversion Repositories eFlore/Applications.cel

Rev

Rev 2802 | 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;
2809 mathias 38
	protected $mission = null;
2787 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
 
2787 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';
2787 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()) {
2787 mathias 84
				$squelette = dirname(__FILE__).self::DS.'squelettes'.self::DS.$this->projet.self::DS.$retour['squelette'].$suffixeLangue.$ext;
1475 aurelien 85
			} else {
2787 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'])) {
2809 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();
2809 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'] = '{}';
161
 
2406 jpm 162
		$projetsAutorises = $this->transformerEnTableau($this->config['projets']['autorises']);
1526 jpm 163
 
2498 aurelien 164
		$urlWsNsTpl = $this->config['chemins']['baseURLServicesEfloreTpl'];
165
		$urlWsNs = sprintf($urlWsNsTpl, self::EFLORE_API_VERSION, $this->ns_referentiel, self::WS_NOM);
166
		$urlWsNsSansRef = sprintf($urlWsNsTpl, self::EFLORE_API_VERSION, '{referentiel}', self::WS_NOM);
167
		$widget['donnees']['url_ws_autocompletion_ns'] = $urlWsNs;
168
		$widget['donnees']['url_ws_autocompletion_ns_tpl'] = $urlWsNsSansRef;
169
		$widget['donnees']['ns_referentiel'] = $this->ns_referentiel;
2744 aurelien 170
 
171
		$widget['donnees']['url_ws_trace_rue_tpl'] = $this->config['chemins']['serviceTraceRueUrl'];
2498 aurelien 172
 
173
		if ($this->especeEstImposee()) {
174
			$nnEspeceImposee = $this->getNnEspeceImposee();
2688 mathias 175
			$nom = $this->chargerInfosTaxon($nnEspeceImposee);
2498 aurelien 176
			$widget['donnees']['espece_imposee'] = true;
177
			$widget['donnees']['nn_espece_defaut'] = $nnEspeceImposee;
2802 mathias 178
			$widget['donnees']['nom_sci_espece_defaut'] = $nom['nom_complet'];
2498 aurelien 179
			$widget['donnees']['infos_espece'] = $this->array2js($nom, true);
1536 jpm 180
		}
2406 jpm 181
 
182
		$projetsAListeDeNoms = $this->transformerEnTableau($this->config['projets']['liste_noms']);
183
		if (in_array($this->projet, $projetsAListeDeNoms)) {
184
			$projetsAListeDeNomsSciEtVerna = $this->transformerEnTableau($this->config['projets']['liste_noms_sci_et_verna']);
185
			if (in_array($this->projet, $projetsAListeDeNomsSciEtVerna)) {
1613 jpm 186
				$widget['donnees']['taxons'] = $this->recupererListeNoms();
187
			} else {
188
				$widget['donnees']['taxons'] = $this->recupererListeNomsSci();
2328 jpm 189
			}
2406 jpm 190
		}
191
 
192
		// Chargement de la liste des milieux issues du fichier .ini du projet
193
		$projetsAListeDeMilieux = $this->transformerEnTableau($this->config['projets']['liste_milieux']);
194
		if (in_array($this->projet, $projetsAListeDeMilieux)) {
1345 aurelien 195
			$widget['donnees']['milieux'] = $this->parserMilieux();
719 jpm 196
		}
2406 jpm 197
 
198
		return $widget;
719 jpm 199
	}
1526 jpm 200
 
2688 mathias 201
	protected function getTitrePage() {
2408 jpm 202
		$titre = 'defaut';
203
		if (isset($this->configProjet['titre_page'])) {
204
			$titre = $this->configProjet['titre_page'];
205
		}
206
		if (isset($this->configMission['titre_page'])) {
207
			$titre = $this->configMission['titre_page'];
208
		}
209
		if (isset($_GET['titre'])) {
210
			$titre = $_GET['titre'];
211
		}
212
		if ($titre === 0) {
213
			$titre = '';
214
		}
215
		return $titre;
1475 aurelien 216
	}
1050 jpm 217
 
2688 mathias 218
	/**
2809 mathias 219
	 * Un nom un peu plus sympatoche à afficher que juste le mot-clef associé; s'il
220
	 * n'est pas défini dans la config, on prend le mot-clef tout de même
221
	 */
222
	protected function getNomMissionFlore() {
223
		$nom = $this->mission;
224
		if (isset($this->configMission['nom_mission'])) {
225
			$nom = $this->configMission['nom_mission'];
226
		}
227
		return $nom;
228
	}
229
 
230
	/**
2688 mathias 231
	 * Remplit un fichier JS avec une variable contenant une liste restreinte de taxons,
232
	 * pour certains projets
233
	 * @return string
234
	 */
2328 jpm 235
	public function executerTaxons() {
236
		$widget['squelette'] = $this->projet.'_taxons';
237
		$widget['squelette_ext'] = '.tpl.js';
1613 jpm 238
		$widget['donnees'] = array();
1629 jpm 239
		$nomsAAfficher = $this->recupererListeNomsSci();
240
		$taxons_tries = array();
1691 raphael 241
		foreach ($nomsAAfficher as $taxon) {
1629 jpm 242
			$taxons_tries[$taxon['num_nom_sel']] = $taxon;
2328 jpm 243
		}
244
		$widget['donnees']['taxons'] = json_encode($taxons_tries);
245
		return $widget;
246
	}
1613 jpm 247
 
2688 mathias 248
	/**
249
	 * Trie par nom français les taxons lus dans le fichier tsv
250
	 */
251
	protected function recupererListeNomsSci() {
1613 jpm 252
		$taxons = $this->recupererListeTaxon();
253
		if (is_array($taxons)) {
254
			$taxons = self::trierTableauMd($taxons, array('nom_fr' => SORT_ASC));
255
		}
1629 jpm 256
		return $taxons;
1613 jpm 257
	}
258
 
2688 mathias 259
	/**
260
	 * @TODO documenter
261
	 * @return array
262
	 */
263
	protected function recupererListeNoms() {
1613 jpm 264
		$taxons = $this->recupererListeTaxon();
265
		$nomsAAfficher = array();
266
		$nomsSpeciaux = array();
267
		if (is_array($taxons)) {
268
			foreach ($taxons as $taxon) {
269
				$nomSciTitle = $taxon['nom_ret'].
270
					($taxon['nom_fr'] != '' ? ' - '.$taxon['nom_fr'] : '' ).
271
					($taxon['nom_fr_autre'] != '' ? ' - '.$taxon['nom_fr_autre'] : '' );
272
				$nomFrTitle = $taxon['nom_sel'].
273
					($taxon['nom_ret'] != $taxon['nom_sel']? ' - '.$taxon['nom_ret'] : '' ).
274
					($taxon['nom_fr_autre'] != '' ? ' - '.$taxon['nom_fr_autre'] : '' );
275
 
276
				if ($taxon['groupe'] == 'special') {
277
					$nomsSpeciaux[] = array(
278
						'num_nom' => $taxon['num_nom_sel'],
279
						'nom_a_afficher' => $taxon['nom_fr'],
280
						'nom_a_sauver' => $taxon['nom_sel'],
281
						'nom_title' => $nomSciTitle,
282
						'nom_type' => 'nom-special');
283
				} else {
284
					$nomsAAfficher[] = array(
285
						'num_nom' => $taxon['num_nom_sel'],
286
						'nom_a_afficher' => $taxon['nom_sel'],
287
						'nom_a_sauver' => $taxon['nom_sel'],
288
						'nom_title' => $nomSciTitle,
289
						'nom_type' => 'nom-sci');
290
					$nomsAAfficher[] = array(
291
						'num_nom' => $taxon['num_nom_sel'],
292
						'nom_a_afficher' => $taxon['nom_fr'],
293
						'nom_a_sauver' => $taxon['nom_fr'],
294
						'nom_title' => $nomFrTitle,
295
						'nom_type' => 'nom-fr');
296
				}
297
			}
298
			$nomsAAfficher = self::trierTableauMd($nomsAAfficher, array('nom_a_afficher' => SORT_ASC));
299
			$nomsSpeciaux = self::trierTableauMd($nomsSpeciaux, array('nom_a_afficher' => SORT_ASC));
300
		}
301
		return array('speciaux' => $nomsSpeciaux, 'sci-et-fr' => $nomsAAfficher);
302
	}
2328 jpm 303
 
2688 mathias 304
	/**
305
	 * Lit une liste de taxons depuis un fichier tsv fourni
306
	 */
307
	protected function recupererListeTaxon() {
308
		$taxons = array();
2328 jpm 309
		$fichier_tsv = dirname(__FILE__).self::DS.'configurations'.self::DS.$this->projet.'_taxons.tsv';
310
		if (file_exists($fichier_tsv) && is_readable($fichier_tsv)) {
712 jpm 311
			$taxons = $this->decomposerFichierTsv($fichier_tsv);
2328 jpm 312
		} else {
313
			$this->debug[] = "Impossible d'ouvrir le fichier '$fichier_tsv'.";
314
		}
315
		return $taxons;
712 jpm 316
	}
1050 jpm 317
 
2688 mathias 318
	/**
319
	 * Découpe un fihcier tsv
320
	 */
321
	protected function decomposerFichierTsv($fichier, $delimiter = "\t"){
2328 jpm 322
		$header = null;
323
		$data = array();
324
		if (($handle = fopen($fichier, 'r')) !== FALSE) {
325
			while (($row = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
326
				if (!$header) {
327
					$header = $row;
328
				} else {
329
					$data[] = array_combine($header, $row);
330
				}
331
			}
332
			fclose($handle);
333
		}
334
		return $data;
335
	}
336
 
2688 mathias 337
	/**
338
	 * Récupère la liste des milieux depuis la section [milieux] de la configuration
339
	 * du projet, si elle existe
340
	 * @return array
341
	 */
342
	protected function parserMilieux() {
1050 jpm 343
		$infosMilieux = array();
1536 jpm 344
		if (isset($this->configProjet['milieux'])) {
345
			$milieux = explode('|', $this->configProjet['milieux']);
346
			foreach ($milieux as $milieu) {
2328 jpm 347
				$milieu = trim($milieu);
1536 jpm 348
				$details = explode(';', $milieu);
349
				if (isset($details[1])) {
350
					$infosMilieux[$details[0]] = $details[1];
351
				} else {
352
					$infosMilieux[$details[0]] = '';
353
				}
1050 jpm 354
			}
1536 jpm 355
			ksort($infosMilieux);
1050 jpm 356
		}
357
		return $infosMilieux;
358
	}
1526 jpm 359
 
2688 mathias 360
	/**
361
	 * Retourne true si le widget est restreint à une espèce, false sinon
362
	 * @return boolean
363
	 */
364
	protected function especeEstImposee() {
365
		return ((isset($_GET['num_nom']) && $_GET['num_nom'] != '')
2408 jpm 366
			|| isset($this->configProjet['sp_imposee']) || isset($this->configMission['sp_imposee']));
1418 aurelien 367
	}
1526 jpm 368
 
2688 mathias 369
	/**
370
	 * Retourne le numéro nomenclatural (nn) de l'espèce imposée si tel est
371
	 * le cas, null sinon
372
	 * @return string
373
	 */
374
	protected function getNnEspeceImposee() {
2328 jpm 375
		$nn = null;
376
		if (isset($_GET['num_nom']) && is_numeric($_GET['num_nom'])) {
377
			$nn = $_GET['num_nom'];
378
		} else if (isset($this->configProjet['sp_imposee'])) {
379
			$nn = $this->configProjet['sp_imposee'];
2408 jpm 380
		} else if (isset($this->configMission['sp_imposee'])) {
381
			$nn = $this->configMission['sp_imposee'];
2328 jpm 382
		}
383
		return $nn;
384
	}
385
 
2688 mathias 386
	/**
387
	 * Consulte un webservice pour obtenir des informations sur le taxon dont le
388
	 * numéro nomenclatural est $num_nom (ce sont donc plutôt des infos sur le nom
389
	 * et non le taxon?)
390
	 * @param string|int $num_nom
391
	 * @return array
392
	 */
393
	protected function chargerInfosTaxon($num_nom) {
2408 jpm 394
		$url_service_infos = sprintf($this->config['chemins']['infosTaxonUrl'], $this->ns_referentiel, $num_nom);
1418 aurelien 395
		$infos = json_decode(file_get_contents($url_service_infos));
2688 mathias 396
		// trop de champs injectés dans les infos espèces peuvent
1909 raphael 397
		// faire planter javascript
2802 mathias 398
		$champs_a_garder = array('id', 'nom_sci','nom_sci_complet', 'nom_complet',
2367 jpm 399
			'famille','nom_retenu.id', 'nom_retenu.libelle', 'num_taxonomique');
1419 aurelien 400
		$resultat = array();
1539 jpm 401
		if (isset($infos) && !empty($infos)) {
1419 aurelien 402
			$infos = (array)$infos;
2367 jpm 403
			if (isset($infos['nom_sci']) && $infos['nom_sci'] != '') {
1909 raphael 404
				$resultat = array_intersect_key($infos, array_flip($champs_a_garder));
405
				$resultat['retenu'] = ($infos['id'] == $infos['nom_retenu.id']) ? "true" : "false";
1916 jpm 406
			}
1419 aurelien 407
		}
1418 aurelien 408
		return $resultat;
409
	}
1050 jpm 410
 
2688 mathias 411
	/**
412
	 * Convertit un tableau PHP en Javascript - @WTF pourquoi ne pas faire un json_encode ?
413
	 * @param array $array
414
	 * @param boolean $show_keys
415
	 * @return une portion de JSON représentant le tableau
416
	 */
417
	protected function array2js($array,$show_keys) {
1536 jpm 418
		$tableauJs = '{}';
419
		if (!empty($array)) {
420
			$total = count($array) - 1;
421
			$i = 0;
422
			$dimensions = array();
423
			foreach ($array as $key => $value) {
424
				if (is_array($value)) {
425
					$dimensions[$i] = array2js($value,$show_keys);
426
					if ($show_keys) {
427
						$dimensions[$i] = '"'.$key.'":'.$dimensions[$i];
428
					}
429
				} else {
430
					$dimensions[$i] = '"'.addslashes($value).'"';
431
					if ($show_keys) {
432
						$dimensions[$i] = '"'.$key.'":'.$dimensions[$i];
433
					}
1526 jpm 434
				}
1536 jpm 435
				if ($i == 0) {
436
					$dimensions[$i] = '{'.$dimensions[$i];
1526 jpm 437
				}
1536 jpm 438
				if ($i == $total) {
439
					$dimensions[$i].= '}';
440
				}
441
				$i++;
1526 jpm 442
			}
1536 jpm 443
			$tableauJs = implode(',', $dimensions);
1526 jpm 444
		}
1536 jpm 445
		return $tableauJs;
1526 jpm 446
	}
2360 jpm 447
}