Subversion Repositories eFlore/Applications.cel

Rev

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

Rev Author Line No. Line
1654 aurelien 1
<?php
1656 raphael 2
 
3
/**
4
* @category  PHP
5
* @package   jrest
6
* @author    Raphaël Droz <raphael@tela-botania.org>
7
* @copyright 2013 Tela-Botanica
8
* @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
9
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
10
*/
11
 
12
define('SEPARATEUR_IMAGES', ",");
13
 
1654 aurelien 14
Class FormateurGroupeColonne {
1656 raphael 15
 
16
	static $cache = Array();
17
 
1654 aurelien 18
	/*
19
	* @param $fieldSets: un liste de noms de colonnes ou de sets de colonnes
20
	*		séparés par des virgules
21
	* 		eg: "espece" ou "champs-etendus", ...
22
	*
23
	* @return: un tableau associatif déjà ordonné
24
	* 		clé: abbrev [machine-name] de la colonne (eg: "espece" ou "mot-clef")
25
	* 		valeur: des données relative à cette colonne, cf GenColInfo
26
	*
27
	* @TODO: fonction commune à la génération en CSV
28
	*
29
	*/
30
	static function nomEnsembleVersListeColonnes($groupe_de_champs = 'standard') {
31
		if(! $groupe_de_champs) $groupe_de_champs = 'standard';
32
		$groupe_de_champs = array_flip(explode(',', $groupe_de_champs));
1656 raphael 33
		$colonnes = Array();
1654 aurelien 34
 
35
		if(isset($groupe_de_champs['standard'])) {
36
			$colonnes += Array(
37
				'nom_sel'			=> self::GenColInfo('nom_sel', 'Espèce'),
38
				'nom_sel_nn'		=> self::GenColInfo('nom_sel_nn', 'Numéro nomenclatural', 0, NULL, NULL, FALSE),
1656 raphael 39
				'nom_ret'			=> self::GenColInfo('nom_ret', 'Nom retenu', 0, NULL, NULL, FALSE),
40
				'nom_ret_nn'		=> self::GenColInfo('nom_ret_nn', 'Numéro nomenclatural nom retenu', 0, NULL, NULL, FALSE),
41
				'nt'				=> self::GenColInfo('nt', 'Numéro taxonomique', 0, NULL, NULL, FALSE),
42
				'famille'			=> self::GenColInfo('famille', 'Famille', 0, NULL, NULL, FALSE),
43
				'nom_referentiel'	=> self::GenColInfo('nom_referentiel', 'Referentiel taxonomique'),
44
				'zone_geo'			=> self::GenColInfo('zone_geo', 'Commune'),
1654 aurelien 45
				'ce_zone_geo'		=> self::GenColInfo('ce_zone_geo', 'Identifiant Commune', 0, 'convertirCodeZoneGeoVersDepartement'),
1656 raphael 46
				'date_observation'	=> self::GenColInfo('date_observation', 'Date', 0, 'formaterDate'),
47
				'lieudit'			=> self::GenColInfo('lieudit', 'Lieu-dit'),
48
				'station'			=> self::GenColInfo('station', 'Station'),
49
				'milieu'			=> self::GenColInfo('milieu', 'Milieu'),
50
				'commentaire'		=> self::GenColInfo('commentaire', 'Notes'),
51
				'latitude'			=> self::GenColInfo('latitude', 'Latitude', 1),
1654 aurelien 52
				'longitude'			=> self::GenColInfo('longitude', 'Longitude', 1),
53
				'geodatum'			=> self::GenColInfo('geodatum', 'Référentiel Géographique', 1, NULL, NULL, FALSE),
54
			);
55
		}
56
 
57
		if(isset($groupe_de_champs['avance'])) {
1656 raphael 58
			$colonnes += array(
59
			   // TODO: importable = FALSE car pas de merge de données importées
60
			   'ordre'				=> self::GenColInfo('ordre', 'Ordre', 1, NULL, NULL, FALSE),
61
			   'id_observation'		=> self::GenColInfo('id_observation', 'Identifiant', 1, NULL, NULL, FALSE),
62
 
63
			   'mots_cles_texte'	=> self::GenColInfo('mots_cles_texte', 'Mots Clés', 1),
64
			   'commentaire'		=> self::GenColInfo('commentaire', 'Commentaires', 1),
65
			   'date_creation'		=> self::GenColInfo('date_creation', 'Date Création', 1, NULL, NULL, FALSE),
66
			   'date_modification'	=> self::GenColInfo('date_modification', 'Date Modification', 1, NULL, NULL, FALSE),
67
 
68
			   // rappel transmission = 1, signifie simplement "public"
69
			   // des données importées peuvent être d'emblée "publiques"
70
			   // "importable" = TRUE
71
			   'transmission'		=> self::GenColInfo('transmission', 'Transmis', 1),
72
			   'date_transmission'	=> self::GenColInfo('date_transmission', 'Date Transmission', 1, NULL, NULL, FALSE),
73
			   'abondance'			=> self::GenColInfo('abondance', 'Abondance', 1),
74
			   'certitude'			=> self::GenColInfo('certitude', 'Certitude', 1),
75
			   'phenologie'			=> self::GenColInfo('phenologie', 'Phénologie', 1),
76
 
77
			   // XXX: getImages() dépend du contexte de Cel, et doit être appelée comme cas particulier
78
			   // cf ExportXLS::traiterLigneObservation()
1687 raphael 79
			   'images'				=> self::GenColInfo('images', 'Image(s)', 1, NULL, NULL /* cas particulier 'getImages' */, TRUE),
1685 raphael 80
 
81
			   /* 'nom_commun'			=> self::GenColInfo('nom_commun', 'Nom Commun', 1, NULL, 'getNomCommun', FALSE),
82
				  'nom-commun'			=> self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v2'),
83
				  'nom-commun'			=> self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v3'), */
1694 raphael 84
			   'nom-commun'			=> self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, NULL /* cas particu 'getNomCommun_v4' */, TRUE, 'getNomCommun_preload'),
1685 raphael 85
 
1654 aurelien 86
			);
87
		}
1656 raphael 88
 
1654 aurelien 89
		return $colonnes;
90
	}
1694 raphael 91
 
92
	static function preload($colonnes, $cel, $ids) {
93
		$result = array();
94
		foreach($colonnes as $abbrev => $colonne) {
95
			if(!$colonne['preload']) continue;
96
			$result[$abbrev] = call_user_func(array(__CLASS__, $colonne['preload']), $cel, $ids);
97
		}
98
		return $result;
99
	}
1654 aurelien 100
 
1656 raphael 101
	public static function getIntitulesColonnes($colonnes) {
1671 aurelien 102
		return array_map(array('FormateurGroupeColonne', 'retournerNomItem'), $colonnes);
1654 aurelien 103
	}
104
 
1671 aurelien 105
	public static function retournerNomItem(&$item) {
106
		return $item['nom'];
107
	}
1694 raphael 108
 
1656 raphael 109
	public static function getLigneObservation(&$obs, &$colonnes, $cel = false) {
1659 aurelien 110
 
1654 aurelien 111
		$ligne_formatee = array();
112
		foreach($colonnes as $abbrev => $colonne) {
113
			$valeur = null;
114
			if($colonne['extra'] == 2) continue;
115
 
116
			// valeur direct depuis cel_obs ?
117
			if(isset($obs[$abbrev])) $valeur = $obs[$abbrev];
118
 
119
			// pré-processeur de la champs
120
			if(function_exists($colonne['fonction'])) {
121
				$valeur = $colonne['fonction']($valeur);
122
			} elseif(method_exists(__CLASS__, $colonne['fonction'])) {
123
				$valeur = call_user_func(array(__CLASS__, $colonne['fonction']), $valeur);
124
			} elseif($colonne['fonction']) {
125
				die("méthode {$colonne['fonction']} introuvable");
126
			}
127
			// fonction pour obtenir des champs (étendus)
128
			elseif(function_exists($colonne['fonction_data'])) {
129
				$valeur = $colonne['fonction_data']($obs);
130
			}
1687 raphael 131
			elseif(method_exists(__CLASS__, $colonne['fonction_data'])) {
1654 aurelien 132
				$valeur = call_user_func(array(__CLASS__, $colonne['fonction_data']), $obs);
133
			}
134
 
135
			// // cette section devrait être vide:
136
			// // cas particuliers ingérable avec l'architecture actuelle:
137
			if(false && $abbrev == 'date_observation' && $valeur == "0000-00-00") {
138
				/* blah */
139
			}
1685 raphael 140
			// ici à cause du passage de $cel ($this), TODO: DB en Singleton !
1656 raphael 141
			if($abbrev == 'images') {
142
				$valeur = FormateurGroupeColonne::getImages($obs, $cel->id_utilisateur, $cel);
143
			}
1685 raphael 144
			if($abbrev == 'nom-commun') {
145
				$valeur = FormateurGroupeColonne::getNomCommun_v4($obs, $cel);
146
			}
1654 aurelien 147
 
148
			if($valeur == null) {
149
				$valeur = "";
150
			}
151
 
152
			// // fin de section "cas particuliers"
153
			$ligne_formatee[] = $valeur;
154
		}
1694 raphael 155
 
156
		// TODO:
157
		// taxon => (code_catminat) => syntaxon => données baseveg
158
 
1654 aurelien 159
		return $ligne_formatee;
160
	}
161
 
162
	/*
163
	* Wrapper générant un tableau associatif:
1694 raphael 164
	* Ne pas changer les valeurs par défaut du prototype sans réflexion sur l'implication pour nomEnsembleVersListeColonnes()
1654 aurelien 165
 
166
	* @param $abbrev (obligatoire): nom court de colonne, largement utilisé lors de l'import.
167
	*		  En effet chaque ligne importée est accessible à l'aide du `define` de $abbrev en majuscule, préfixé de "C_"
168
	*		  Exemple: $ligne[C_LONGITUDE] pour "longitude".
169
	*		  cf: ImportXLS::detectionEntete()
170
 
171
	* @param $nom (obligatoire): nom complet de colonne (utilisé pour la ligne d'en-tête)
172
 
173
	* @param $is_extra:
174
	* Si 0, la colonne est une colonne standard
175
	* Si 1, la colonne est extra [le plus souvent générée automatiquement]
176
	*		 (auquel cas une bordure bleue entoure son nom dans la ligne d'entête)
177
	* Si 2, la colonne n'est pas traité à l'export, mais une définition peut lui être donnée
178
	*		 qui pourra être utilisée à l'import, exemple: "image"
179
 
180
	* @param $fonction (optionnel): un nom d'un fonction de préprocessing
181
	* 		  $fonction doit prendre comme seul argument la valeur d'origine et retourner la valeur transformée
182
 
183
	* @param $fonction_data (optionnel): une *méthode* d'obtention de donnée
184
	* 		  $fonction_data doit prendre comme premier argument le tableau des champs de l'enregistrement existant
185
	*		  $fonction_data doit retourner une valeur
186
 
187
	* @param $importable (optionnel): défini si la colonne est traitée (ou absolument ignorée par PHPExcel) lors de
188
	*		  l'import.
1694 raphael 189
 
190
	* @param $preload (optionnel): défini une fonction de préchargement massif de donnée potentiellement utilisable par $fonction_data.
191
	*		  Utile, notamment, dans le cadre de l'export
1654 aurelien 192
 
193
	*/
1694 raphael 194
	static function GenColInfo($abbrev, $nom, $is_extra = 0, $fonction = NULL, $fonction_data = NULL, $importable = TRUE, $preload = NULL) {
1654 aurelien 195
		return Array('abbrev' => $abbrev,
1656 raphael 196
					 'nom' => $nom,
197
					 'extra' => $is_extra ? 1 : 0,
198
					 'fonction' => $fonction,
199
					 'fonction_data' => $fonction_data,
1694 raphael 200
					 'importable' => $importable,
201
					 'preload' => $preload,
1654 aurelien 202
		);
203
	}
204
 
1656 raphael 205
	static function formaterDate($date_heure_mysql) {
1671 aurelien 206
		//return "";
1654 aurelien 207
		if (!$date_heure_mysql || $date_heure_mysql == "0000-00-00 00:00:00") return "00/00/0000";
1671 aurelien 208
		// malheureusement pas disponible en php < 5.3
209
		//$date_format = DateTime::createFromFormat("Y-m-d H:i:s", $date_heure_mysql);
210
		$val = explode(' ', $date_heure_mysql);
211
		$date = explode('-', $val[0]);
212
		$heure = explode(':', $val[1]);
213
		$timestamp = mktime((int) $heure[0], (int) $heure[1], (int) $heure[2], (int) $date[1], (int) $date[2], (int) $date[0]);
1654 aurelien 214
		if(!$timestamp) return "00/00/0000";
1656 raphael 215
		// TODO: les widgets ne font malheureusement pas usage de l'heure dans le CEL
216
		// TODO: si modification, ne pas oublier de modifier le format d'import correspondant
217
		//	dans ImportXLS (actuellement: "d/m/Y")
218
		$date_formatee = strftime('%d/%m/%Y', $timestamp);
1654 aurelien 219
		if(!$date_formatee) return "00/00/0000";
220
		return $date_formatee;
221
	}
222
 
1656 raphael 223
	static function getImages($obs, $id_utilisateur, $cel) {
224
		if(! $id_utilisateur) return NULL;
225
		$rec = $cel->requeter(
1654 aurelien 226
			sprintf("SELECT GROUP_CONCAT(nom_original SEPARATOR '%s') FROM cel_images i"
1656 raphael 227
					." LEFT JOIN cel_obs_images oi ON (i.id_image = oi.id_image)"
228
					." LEFT JOIN cel_obs o ON (oi.id_observation = o.id_observation)"
229
					." WHERE ce_utilisateur = %d",
230
					SEPARATEUR_IMAGES,
231
					$id_utilisateur));
232
		return $rec ? array_pop($rec) : NULL;
1654 aurelien 233
	}
234
 
235
	public static function convertirCodeZoneGeoVersDepartement($code_zone_geo) {
236
		$code_departement = '';
237
		if(self::estUnCodeInseeDepartement($code_zone_geo)) {
238
			$code_departement = substr(ltrim($code_zone_geo,'INSEE-C:'),0,2);
239
		}
240
 
241
		return $code_departement;
242
	}
243
 
244
	public static function estUnCodeInseeDepartement($code_a_tester) {
245
		return preg_match('/^INSEE-C:[0-9]{5}/',$code_a_tester);
246
	}
247
 
248
 
249
	// TODO: référentiel ne devrait pas être généré au moment d'un Config::get,
250
	// comme dans Config::get('nomsVernaRechercheLimiteeTpl')
251
	// Par exemple, la variable pour "nva" ?
252
	function getNomCommun($obs) {
253
		$langue = 'fra';
254
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
255
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
256
		else return '';
257
 
258
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
1657 raphael 259
		if(isset(self::$cache['getNomCommun'][$cache_id])) {
1656 raphael 260
			//debug: error_log("require url_service_nom_attribution: OK ! (pour \"{$obs['nom_ret']}\")");
1657 raphael 261
			return self::$cache['getNomCommun'][$cache_id];
1654 aurelien 262
		}
263
		// pas de cache:
264
		//debug: error_log("require url_service_nom_attribution pour \"{$obs['nom_ret']}\"");
265
 
266
		// pour bdtfx:
267
		// /service:eflore:0.1/nvjfl/noms-vernaculaires/attributions?masque.nt=X&masque.lg=fra&retour.champs=num_statut
268
		// /projet/services/modules/0.1/nvjfl/NomsVernaculaires.php
269
		$url = str_replace(Array('{referentiel}', '{valeur}', '{langue}'),
1656 raphael 270
						   Array($referentiel, $obs['nt'], $langue),
1657 raphael 271
						   self::$config['eflore']['url_service_nom_attribution']) . // TODO !
1656 raphael 272
			"&retour.champs=num_statut";
1654 aurelien 273
		$noms = @json_decode(file_get_contents($url));
274
		if(! $noms) return '';
1673 raphael 275
		$noms = array_filter((array)($noms->resultat), array($this, retournerNumStatutUn)); // XXX: php 5.3
1654 aurelien 276
		$nom = array_pop($noms)->nom_vernaculaire;
277
 
278
		// cache
1657 raphael 279
		self::$cache['getNomCommun'][$cache_id] = $nom;
1654 aurelien 280
		return $nom;
281
	}
282
 
1671 aurelien 283
	private function retournerNumStatutUn(&$item) {
284
		return ($item->num_statut == 1);
285
	}
1673 raphael 286
 
287
	private function retournerNumStatutUnArr(&$item) {
288
		return ($item['num_statut'] == 1);
289
	}
1671 aurelien 290
 
1656 raphael 291
	// si getNomCommun_v2 ou getNomCommun_v3 sont utilisés
292
	/* require_once('/home/raphael/eflore/framework/framework/Framework.php');
293
	Framework::setCheminAppli("/home/raphael/eflore/projets/services/index.php");
294
	Framework::setInfoAppli(Config::get('info'));
295
	require_once('/home/raphael/eflore/projets/services/modules/0.1/Projets.php');*/
1654 aurelien 296
 
297
	/* Tente de bootstraper le framework au plus court et d'initialiser une instance de
1656 raphael 298
	   NomsVernaculaires pour obtenir le nom commun */
1654 aurelien 299
	function getNomCommun_v2($obs) {
300
		static $service;
1656 raphael 301
		$service = new Projets();
1654 aurelien 302
 
303
		$langue = 'fra';
304
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
305
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
306
		else return '';
307
 
308
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
1657 raphael 309
		if(isset(self::$cache['getNomCommun'][$cache_id])) {
1656 raphael 310
			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");
1657 raphael 311
			return self::$cache['getNomCommun'][$cache_id];
1654 aurelien 312
		}
313
		// pas de cache:
314
		error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");
315
 
1656 raphael 316
		$donnees = Array('masque.nt' => $obs['nt'],
317
						 'masque.lg' => $langue,
318
						 'retour.champs' => 'num_statut');
1654 aurelien 319
		$noms = $service->consulter(Array('nvjfl', 'noms-vernaculaires'), $donnees);
320
 
321
		if(! $noms) return '';
1673 raphael 322
		$noms = array_filter((array)($noms->resultat), array($this, retournerNumStatutUn)); // XXX: php 5.3
1654 aurelien 323
		$nom = array_pop($noms)->nom_vernaculaire;
324
 
1656 raphael 325
		// cache
1657 raphael 326
		self::$cache['getNomCommun'][$cache_id] = $nom;
1654 aurelien 327
		return $nom;
328
	}
329
 
330
 
331
	/* Effectue un bootstraping plus sage que ci-dessus, mais le gain d'efficacité
1656 raphael 332
	   n'est pas aussi retentissant qu'espéré */
1654 aurelien 333
	static $service;
334
	function getNomCommun_v3($obs) {
335
		if(! $this->service) $this->service = new Projets();
336
 
337
		$langue = 'fra';
338
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
339
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
340
		else return '';
341
 
342
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
1657 raphael 343
		if(isset(self::$cache['getNomCommun'][$cache_id])) {
1656 raphael 344
			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");
1657 raphael 345
			return self::$cache['getNomCommun'][$cache_id];
1654 aurelien 346
		}
347
		// pas de cache:
1656 raphael 348
		error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");
1654 aurelien 349
 
350
		$donnees = Array('masque.nt' => $obs['nt'],
1656 raphael 351
						 'masque.lg' => $langue,
352
						 'retour.champs' => 'conseil_emploi');
353
		$this->service->initialiserRessourcesEtParametres(Array('nvjfl', 'noms-vernaculaires', 'attributions'), $donnees);
1654 aurelien 354
		try {
1656 raphael 355
			$noms = $this->service->traiterRessources();
356
		} catch(Exception $e) {
357
			return '';
1654 aurelien 358
		}
1656 raphael 359
		if(! $noms) return '';
1673 raphael 360
		$noms = array_filter($noms['resultat'], array($this, retournerNumStatutUnArr)); // XXX: php 5.3
1656 raphael 361
		$premier_nom = array_pop($noms);
1654 aurelien 362
		$nom = $premier_nom['nom_vernaculaire'];
363
 
364
		// cache
1657 raphael 365
		self::$cache['getNomCommun'][$cache_id] = $nom;
1654 aurelien 366
		return $nom;
367
	}
1685 raphael 368
 
1694 raphael 369
	/* Cette fonction initialise le cache des noms communs en 1 fois, sur la liste des observations à exporter.
370
	   Ainsi, les appels successifs à getNomCommun_v4() ne sont pas couteux (pas de requête SQL)
371
	 */
372
	static function getNomCommun_preload($cel, $obsids) {
373
		if(!$obsids) return;
374
		if(!$cel->executerRequete("SHOW TABLES LIKE 'cel_references'", Cel::SQL_RETOUR_LIGNE)) return NULL;
375
 
376
		// CREATE INDEX i_nom_referentiel ON cel_obs (nom_referentiel(5));
377
		$req = sprintf("SELECT r.referentiel, r.num_taxon, r.nom_commun FROM cel_references r" .
378
					   " INNER JOIN cel_obs c ON (r.referentiel = substring_index(c.nom_referentiel, ':', 1) and r.num_taxon = c.nt)" .
379
					   " WHERE c.id_observation IN (%s)",
380
					   implode(',', $obsids));
381
		$res = $cel->requeter($req);
382
		foreach($res as $v) {
383
			self::$cache['getNomCommun'][$v['referentiel'] . '-' . $v['num_taxon'] . '-' . 'fra'] = $v['nom_commun'];
384
		}
385
		return NULL;
386
	}
387
 
1685 raphael 388
	static function getNomCommun_v4($obs, $cel) {
1689 raphael 389
		static $is_table = false;
1685 raphael 390
		if(! $obs['nt']) return NULL;
1689 raphael 391
 
392
		if(!$is_table) {
393
			// une seule fois
394
			if(! $cel->executerRequete("SHOW TABLES LIKE 'cel_references'", Cel::SQL_RETOUR_LIGNE)) return NULL;
395
			$is_table = true;
396
		}
1685 raphael 397
		$langue = 'fra';
398
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
399
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
400
 
401
		if(isset(self::$cache['getNomCommun'][$cache_id])) return self::$cache['getNomCommun'][$cache_id];
402
 
403
		// pas de cache:
404
		$nom = $cel->executerRequete(sprintf("SELECT nom_commun FROM cel_references " .
405
											 "WHERE referentiel = '%s' AND num_taxon = %d LIMIT 1",
406
											 $referentiel,
407
											 $obs['nt']),
408
									 Cel::SQL_RETOUR_LIGNE);
409
 
410
		if(! $nom) return NULL;
411
		$nom = $nom["nom_commun"];
412
 
413
		// cache
414
		self::$cache['getNomCommun'][$cache_id] = $nom;
415
		return $nom;
416
	}
1654 aurelien 417
 
1685 raphael 418
 
1654 aurelien 419
}