Subversion Repositories eFlore/Applications.cel

Rev

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