Subversion Repositories eFlore/Applications.cel

Rev

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

Rev Author Line No. Line
1630 raphael 1 
<?php
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 
/**
13 
 * Service d'export de données d'observation du CEL au format XLS
14 
 *
15 
 * Format du service :
16 
 * POST /ExportXLS
17 
 * POST /ExportXLS/<Utilisateur>
18 
 * TODO: GET /ExportXLS/<Utilisateur> [ sans "range" ? ]
19 
 *
20 
 * Les données POST acceptées sont:
21 
 * range (obligatoire): un range d'id_observation sous la forme d'entier ou d'intervalles d'entiers
22 
 *						séparés par des virgules ou bien '*' (pour toutes)
23 
 * TODO: limit
24 
 * TODO: départ
25 
 * TODO: sets (ou colonnes, ou extended)
26 
 * TODO: + les critères supportés par fabriquerSousRequeteRecherche()
27 
 *
28 
 * Si <Utilisateur> est fourni, celui-ci doit être authentifié
29 
 * TODO: export des données public et non-sensible d'un utilisateur
30 
 *
31 
 * Si <Utilisateur> est fourni, le observations seront le résultat de l'intersection des 2 contraintes
32 
 *
33 
 */
34 
set_include_path(get_include_path() . PATH_SEPARATOR . dirname(dirname(realpath(__FILE__))) . '/lib');
1634 raphael 35 
// TERM
36 
ini_set('html_errors', 0);
37 
ini_set('xdebug.cli_color', 2);
38 
require_once('lib/PHPExcel/Classes/PHPExcel.php');
1630 raphael 39 
 
1633 raphael 40 
// si getNomCommun_v2 ou getNomCommun_v3 sont utilisés
41 
/*require_once('/home/raphael/eflore/framework/framework/Framework.php');
42 
Framework::setCheminAppli("/home/raphael/eflore/projets/services/index.php");
43 
Framework::setInfoAppli(Config::get('info'));
44 
require_once('/home/raphael/eflore/projets/services/modules/0.1/Projets.php');*/
45 
 
1630 raphael 46 
class ExportXLS extends Cel  {
47 
 
1633 raphael 48 
	private $cache = Array();
49 
 
1630 raphael 50 
	function ExportXLS($config) {
51 
		parent::__construct($config);
52 
	}
53 
 
54 
	/*
55 
	 * Process $_POST et $_GET
56 
	 * TODO: changer JRest pour pouvoir disposer d'un nom de méthode plus représentatif que "updateXXX"
57 
	 * en POST
58 
	 */
59 
	function updateElement($uid, $pairs) {
1632 raphael 60 
		$params = Array('uid' => $uid[0]);
1630 raphael 61 
		// TODO: pas de range mais un utilisateur: possible
62 
		if(!isset($_POST['range'])) {
63 
			header('HTTP/1.0 204 No Content');
64 
			exit;
65 
		}
1632 raphael 66 
		// trim() car: `POST http://url<<<"range=*"`
67 
		elseif(trim($_POST['range']) == '*') {
1638 raphael 68 
			$obs_ids = Array('*');
1630 raphael 69 
		}
70 
		else {
1638 raphael 71 
			$obs_ids = self::rangeToList(trim($_POST['range']));
1630 raphael 72 
		}
1638 raphael 73 
		$this->export($obs_ids, NULL, $params);
1630 raphael 74 
		exit;
75 
	}
76 
 
77 
	/*
78 
	 * $param: Tableau associatif, indexes supportés:
79 
	 * 		   - widget: le nom du widget d'origine (utilisé pour les méta-données du tableur)
80 
	 *
81 
	 */
1638 raphael 82 
	function export(Array $obs_ids, String $fieldSets = NULL, Array $params = Array()) {
83 
		$colonnes = self::nom_d_ensemble_vers_liste_de_colonnes($fieldSets);
84 
		// $colonne_abbrev = array_keys($colonnes);
1630 raphael 85 
		$chercheur_observations = new RechercheObservation($this->config);
86 
 
87 
		$objPHPExcel = new PHPExcel();
88 
 
89 
		// TODO: $params['part'] pour le multi-part
90 
		$params['widget'] = isset($params['widget']) ? $params['widget'] : 'CEL';
91 
		// TODO: controleUtilisateur()
1632 raphael 92 
		if(! $params['uid']) { // || ! $this->controleUtilisateur($params['uid'])) {
1630 raphael 93 
			$params['uid'] = NULL;
94 
		}
95 
 
96 
		$criteres = Array();
1638 raphael 97 
		if(! $obs_ids || count($obs_ids) == 1 && $obs_ids[0] == '*') {
1630 raphael 98 
			unset($criteres['raw']);
99 
		}
100 
		else {
101 
			$criteres = Array('raw' =>
1638 raphael 102 
							  sprintf('id_observation IN (%s)', implode(',', $obs_ids)));
1630 raphael 103 
		}
104 
 
105 
		$criteres['debut'] = isset($_GET['debut']) ? intval($_GET['debut']) : 0;
106 
		$criteres['limite'] = isset($_GET['limite']) ? intval($_GET['limite']) : 0;
1632 raphael 107 
		$observations = $chercheur_observations
1634 raphael 108 
			->rechercherObservations($params['uid'], $criteres, $criteres['debut'], $criteres['limite'], TRUE)
1632 raphael 109 
			->get();
110 
 
111 
		// debug //echo ($chercheur_observations->requete_selection_observations);
1630 raphael 112 
		// XXX: malheureusement l'instance de JRest n'est pas accessible ici
113 
		if(!$observations) {
114 
			header('HTTP/1.0 204 No Content');
115 
			exit;
116 
		}
117 
 
118 
		$objPHPExcel->getProperties()->setCreator($params['widget']) // ou $uid ?
119 
			->setLastModifiedBy("XX") // TODO: $uid
120 
			->setTitle("YY") // TODO
121 
			->setSubject("ZZ") // TODO
122 
			->setDescription("Export blah");
123 
			//->setKeywords("office PHPExcel php")
124 
			//->setCategory("Test result file")
125 
 
126 
		$objPHPExcel->getActiveSheet()->setTitle("Observations");
1638 raphael 127 
		$feuille = $objPHPExcel->setActiveSheetIndex(0);
1630 raphael 128 
		$colid = 0;
129 
		foreach($colonnes as $colonne) {
1638 raphael 130 
			$feuille->setCellValueByColumnAndRow($colid, 1, $colonne['nom']);
1630 raphael 131 
			if($colonne['extra']) {
1638 raphael 132 
				$feuille->getStyleByColumnAndRow($colid, 1)->getBorders()->applyFromArray(
1630 raphael 133 
					array(
134 
						'allborders' => array(
135 
							'style' => PHPExcel_Style_Border::BORDER_DASHDOT,
136 
							'color' => array('rgb' => PHPExcel_Style_Color::COLOR_BLUE)
137 
						)
138 
					)
139 
				);
140 
			}
141 
			$colid++;
142 
		}
143 
 
144 
		$objPHPExcel->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
145 
 
1638 raphael 146 
		$ligne = 2;
1630 raphael 147 
		foreach ($observations as $obs) {
148 
			$colid = 0;
1638 raphael 149 
			foreach($colonnes as $abbrev => $colonne) {
1632 raphael 150 
				// valeur direct depuis cel_obs ?
1638 raphael 151 
				if(isset($obs[$abbrev])) $valeur = $obs[$abbrev];
1630 raphael 152 
 
1632 raphael 153 
				// pré-processeur de la champs
154 
				if(function_exists($colonne['fonction'])) {
155 
					$valeur = $colonne['fonction']($valeur);
156 
				} elseif(method_exists(__CLASS__, $colonne['fonction'])) {
157 
					$valeur = call_user_func(array(__CLASS__, $colonne['fonction']), $valeur);
158 
				} elseif($colonne['fonction']) {
159 
					die("méthode {$colonne['fonction']} introuvable");
1630 raphael 160 
				}
1632 raphael 161 
				// fonction pour obtenir des champs (étendus)
162 
				elseif(function_exists($colonne['fonction_data'])) {
163 
					$valeur = $colonne['fonction_data']($obs);
164 
				}
165 
				elseif(method_exists(__CLASS__, $colonne['fonction_data'])) {
166 
					$valeur = call_user_func(array(__CLASS__, $colonne['fonction_data']), $obs);
167 
				}
1630 raphael 168 
 
1632 raphael 169 
 
1630 raphael 170 
				// // cette section devrait être vide:
171 
				// // cas particuliers ingérable avec l'architecture actuelle:
1638 raphael 172 
				if(false && $abbrev == 'date_observation' && $valeur == "0000-00-00") { /* blah */ }
1630 raphael 173 
				// // fin de section "cas particuliers"
174 
 
1638 raphael 175 
				$feuille->setCellValueByColumnAndRow($colid, $ligne, $valeur);
1630 raphael 176 
				$colid++;
177 
			}
1638 raphael 178 
			$ligne++;
1630 raphael 179 
		}
180 
 
181 
		header("Content-Type: application/vnd.ms-excel");
182 
		header("Content-Disposition: attachment; filename=\"liste.xls\"; charset=utf-8");
183 
		header("Cache-Control: max-age=0");
184 
		// Le format Excel2007 utilise un fichier temporaire
1638 raphael 185 
		$generateur = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Excel2007');
186 
		// $generateur = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Excel5');
187 
		$generateur->save('php://output');
1630 raphael 188 
		exit;
189 
	}
190 
 
191 
	/*
192 
	 * @param $fieldSets: un range, eg: 1-5,8,32,58-101
193 
	 * @return un tableau trié, eg: 1,2,3,4,5,8,32,58,...,101
1638 raphael 194 
	 * http://stackoverflow.com/questions/7698664/converting-a-range-or-partial-array-in-the-form-3-6-or-3-6-12-into-an-arra
1630 raphael 195 
	 */
196 
	static function rangeToList($in = '') {
197 
		$inSets = explode(',', $in);
198 
		$outSets = array();
1632 raphael 199 
 
1630 raphael 200 
		foreach($inSets as $inSet) {
201 
			list($start,$end) = explode('-', $inSet . '-' . $inSet);
1634 raphael 202 
			// ignore les ranges trop importants
203 
			if($start > 10000000 || $end > 10000000 || abs($start-$end) > 10000) continue;
1630 raphael 204 
			$outSets = array_merge($outSets,range($start,$end));
205 
		}
206 
		$outSets = array_unique($outSets);
207 
		$outSets = array_filter($outSets, 'is_numeric');
208 
		sort($outSets);
209 
		return $outSets;
210 
	}
211 
 
212 
	/*
213 
	 * @param $fieldSets: un liste de noms de colonnes ou de sets de colonnes
214 
	 *		séparés par des virgules
215 
	 * 		eg: "espece" ou "champs-etendus", ...
216 
	 *
217 
	 * @return: un tableau associatif déjà ordonné
1638 raphael 218 
	 * 		clé: abbrev [machine-name] de la colonne (eg: "espece" ou "mot-clef")
1630 raphael 219 
	 * 		valeur: des données relative à cette colonne, cf GenColInfo
220 
	 *
221 
	 * @TODO: fonction commune à la génération en CSV
1638 raphael 222 
	 *
1630 raphael 223 
	 */
1638 raphael 224 
	static function nom_d_ensemble_vers_liste_de_colonnes($groupe_de_champs = 'standard') {
225 
		if(! $groupe_de_champs) $groupe_de_champs = 'standard';
226 
		$groupe_de_champs = array_flip(explode(',', $groupe_de_champs));
1630 raphael 227 
		$colonnes = Array();
228 
 
1638 raphael 229 
		if(isset($groupe_de_champs['standard'])) {
1630 raphael 230 
		   $colonnes += Array(
231 
			   'nom_sel'			=> self::GenColInfo('nom_sel', 'Espèce'),
1632 raphael 232 
			   'nom_sel_nn'			=> self::GenColInfo('nom_sel_nn', 'Numéro nomenclatural'),
1630 raphael 233 
			   'nom_ret'			=> self::GenColInfo('nom_ret', 'Nom retenu'),
1632 raphael 234 
			   'nom_ret_nn'			=> self::GenColInfo('nom_ret_nn', 'Numéro nomenclatural nom retenu'),
235 
			   'nt'					=> self::GenColInfo('nt', 'Numéro taxonomique'),
1630 raphael 236 
			   'famille'			=> self::GenColInfo('famille', 'Famille'),
237 
			   'nom_referentiel'	=> self::GenColInfo('nom_referentiel', 'Referentiel taxonomique'),
238 
			   'zone_geo'			=> self::GenColInfo('zone_geo', 'Commune'),
239 
			   'ce_zone_geo'		=> self::GenColInfo('ce_zone_geo', 'Identifiant Commune', 0, 'convertirCodeZoneGeoVersDepartement'),
240 
			   'date_observation'	=> self::GenColInfo('date_observation', 'Date', 0, 'formaterDate'),
241 
			   'lieudit'			=> self::GenColInfo('lieudit', 'Lieu-dit'),
242 
			   'station'			=> self::GenColInfo('station', 'Station'),
243 
			   'milieu'				=> self::GenColInfo('milieu', 'Milieu'),
244 
			   'commentaire'		=> self::GenColInfo('commentaire', 'Notes'),
245 
			   'latitude'			=> self::GenColInfo('latitude', 'Latitude', 1),
246 
			   'longitude'			=> self::GenColInfo('longitude', 'Longitude', 1),
1632 raphael 247 
			   'geodatum'			=> self::GenColInfo('geodatum', 'Référentiel Géographique', 1),
1630 raphael 248 
 
1635 raphael 249 
			   // TODO: importable = FALSE car pas de merge de données importées
250 
			   'ordre'				=> self::GenColInfo('ordre', 'Ordre', 1, NULL, NULL, FALSE),
251 
			   'id_observation'		=> self::GenColInfo('id_observation', 'Identifiant', 1, NULL, NULL, FALSE),
1630 raphael 252 
 
253 
			   'mots_cles_texte'	=> self::GenColInfo('mots_cles_texte', 'Mots Clés', 1),
254 
			   'commentaire'		=> self::GenColInfo('commentaire', 'Commentaires', 1),
255 
			   'date_creation'		=> self::GenColInfo('date_creation', 'Date Création', 1),
256 
			   'date_modification'	=> self::GenColInfo('date_modification', 'Date Modification', 1),
1635 raphael 257 
			   // importable = FALSE car à l'import ce sont de "nouvelles" données, donc "non-transmises"
258 
			   'transmission'		=> self::GenColInfo('transmission', 'Transmis', 1, NULL, NULL, FALSE),
1630 raphael 259 
			   'date_transmission'	=> self::GenColInfo('date_transmission', 'Date Transmission', 1),
1635 raphael 260 
			   'abondance'			=> self::GenColInfo('abondance', 'Abondance', 1, NULL, NULL, FALSE),
261 
			   'certitude'			=> self::GenColInfo('certitude', 'Certitude', 1, NULL, NULL, FALSE),
262 
			   'phenologie'			=> self::GenColInfo('phenologie', 'Phénologie', 1, NULL, NULL, FALSE),
1632 raphael 263 
 
1635 raphael 264 
			   'nom_commun'			=> self::GenColInfo('nom_commun', 'Nom Commun', 1, NULL, 'getNomCommun', FALSE)
1632 raphael 265 
			   //'nom-commun'			=> self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v2')
266 
			   //'nom-commun'			=> self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v3')
1630 raphael 267 
		   );
268 
		}
269 
 
270 
		return $colonnes;
271 
	}
272 
 
273 
	/*
274 
	 * Wrapper générant un tableau associatif:
275 
	 * @param $is_extra: défini si la colonne est extra (auquelle une bordure bleue entoure son nom dans la première ligne
1632 raphael 276 
	 * @param $fonction (optionnel): un nom d'un fonction de préprocessing
277 
	 * 		  $fonction doit prendre comme seul argument la valeur d'origine et retourner la valeur transformée
278 
	 * @param $fonction_data (optionnel): une *méthode* d'obtention de donnée
279 
	 * 		  $fonction_data doit prendre comme premier argument les champs de l'enregistrement existant
280 
	 *		  $fonction_data doit retourner une valeur
281 
 
1630 raphael 282 
	 */
1638 raphael 283 
	static function GenColInfo($abbrev, $nom, $is_extra = 0, $fonction = NULL, $fonction_data = NULL, $importable = TRUE) {
284 
		return Array('abbrev' => $abbrev,
1630 raphael 285 
					 'nom' => $nom,
286 
					 'extra' => $is_extra ? 1 : 0,
1632 raphael 287 
					 'fonction' => $fonction,
1635 raphael 288 
					 'fonction_data' => $fonction_data,
289 
					 'importable' => $importable
1630 raphael 290 
		);
291 
	}
292 
 
293 
	protected function formaterDate($date_heure_mysql, $format = NULL) {
294 
		if (!$date_heure_mysql || $date_heure_mysql == "0000-00-00 00:00:00") return "00/00/0000";
1632 raphael 295 
		$timestamp = DateTime::createFromFormat("Y-m-d H:i:s", $date_heure_mysql)->getTimestamp();
1630 raphael 296 
		if(!$timestamp) return "00/00/0000";
297 
		// TODO: les widget ne font malheureusement pas usage de l'heure dans le CEL
1632 raphael 298 
		$date_formatee = strftime('%A %d %B %Y', $timestamp);
1630 raphael 299 
		if(!$date_formatee) return "00/00/0000";
300 
		return $date_formatee;
301 
	}
1633 raphael 302 
 
303 
 
304 
	// TODO: référentiel ne devrait pas être généré au moment d'un Config::get,
305 
	// comme dans Config::get('nomsVernaRechercheLimiteeTpl')
306 
	// Par exemple, la variable pour "nva" ?
307 
	function getNomCommun($obs) {
308 
		$langue = 'fra';
309 
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
310 
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
311 
		else return '';
312 
 
313 
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
314 
		if(isset($this->cache['getNomCommun'][$cache_id])) {
315 
			//debug: error_log("require url_service_nom_attribution: OK ! (pour \"{$obs['nom_ret']}\")");
316 
			return $this->cache['getNomCommun'][$cache_id];
317 
		}
318 
		// pas de cache:
319 
		//debug: error_log("require url_service_nom_attribution pour \"{$obs['nom_ret']}\"");
320 
 
321 
		// pour bdtfx:
322 
		// /service:eflore:0.1/nvjfl/noms-vernaculaires/attributions?masque.nt=X&masque.lg=fra&retour.champs=num_statut
323 
		// /projet/services/modules/0.1/nvjfl/NomsVernaculaires.php
324 
		$url = str_replace(Array('{referentiel}', '{valeur}', '{langue}'),
325 
						   Array($referentiel, $obs['nt'], $langue),
326 
						   $this->config['eflore']['url_service_nom_attribution']) .
327 
			"&retour.champs=num_statut";
328 
		$noms = @json_decode(file_get_contents($url));
329 
		if(! $noms) return '';
330 
		$noms = array_filter((array)($noms->resultat), function($item) { return ($item->num_statut == 1); });
331 
		$nom = array_pop($noms)->nom_vernaculaire;
332 
 
333 
		// cache
334 
		$this->cache['getNomCommun'][$cache_id] = $nom;
335 
		return $nom;
336 
	}
337 
 
338 
 
339 
	/* Tente de bootstraper le framework au plus court et d'initialiser une instance de
340 
	   NomsVernaculaires pour obtenir le nom commun */
341 
	function getNomCommun_v2($obs) {
342 
		static $service;
343 
		$service = new Projets();
344 
 
345 
		$langue = 'fra';
346 
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
347 
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
348 
		else return '';
349 
 
350 
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
351 
		if(isset($this->cache['getNomCommun'][$cache_id])) {
352 
			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");
353 
			return $this->cache['getNomCommun'][$cache_id];
354 
		}
355 
		// pas de cache:
356 
		error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");
357 
 
1638 raphael 358 
		$donnees = Array('masque.nt' => $obs['nt'],
1633 raphael 359 
							 'masque.lg' => $langue,
360 
							 'retour.champs' => 'num_statut');
1638 raphael 361 
		$noms = $service->consulter(Array('nvjfl', 'noms-vernaculaires'), $donnees);
1633 raphael 362 
 
363 
		if(! $noms) return '';
364 
		$noms = array_filter((array)($noms->resultat), function($item) { return ($item->num_statut == 1); });
365 
		$nom = array_pop($noms)->nom_vernaculaire;
366 
 
367 
		// cache
368 
		$this->cache['getNomCommun'][$cache_id] = $nom;
369 
		return $nom;
370 
	}
371 
 
372 
 
373 
	/* Effectue un bootstraping plus sage que ci-dessus, mais le gain d'efficacité
374 
	   n'est pas aussi retentissant qu'espéré */
375 
	static $service;
376 
	function getNomCommun_v3($obs) {
377 
		if(! $this->service) $this->service = new Projets();
378 
 
379 
		$langue = 'fra';
380 
		list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));
381 
		if($referentiel == 'bdtfx') $referentiel = 'nvjfl';
382 
		else return '';
383 
 
384 
		$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;
385 
		if(isset($this->cache['getNomCommun'][$cache_id])) {
386 
			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");
387 
			return $this->cache['getNomCommun'][$cache_id];
388 
		}
389 
		// pas de cache:
390 
		error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");
391 
 
1638 raphael 392 
		$donnees = Array('masque.nt' => $obs['nt'],
1633 raphael 393 
					  'masque.lg' => $langue,
394 
					  'retour.champs' => 'conseil_emploi');
1638 raphael 395 
		$this->service->initialiserRessourcesEtParametres(Array('nvjfl', 'noms-vernaculaires', 'attributions'), $donnees);
1633 raphael 396 
		try {
397 
			$noms = $this->service->traiterRessources();
398 
		} catch(Exception $e) { return ''; }
399 
		if(! $noms) return '';
400 
		$noms = array_filter($noms['resultat'], function($item) { return ($item['num_statut'] == 1); });
401 
		$nom = array_pop($noms)['nom_vernaculaire'];
402 
 
403 
		// cache
404 
		$this->cache['getNomCommun'][$cache_id] = $nom;
405 
		return $nom;
406 
	}
407 
 
408 
}