Rev 1639 | Rev 1644 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed
<?php/*** @category PHP* @package jrest* @author Raphaël Droz <raphael@tela-botania.org>* @copyright 2013 Tela-Botanica* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>*//*** Service d'export de données d'observation du CEL au format XLS** Format du service :* POST /ExportXLS* POST /ExportXLS/<Utilisateur>* TODO: GET /ExportXLS/<Utilisateur> [ sans "range" ? ]** Les données POST acceptées sont:* range (obligatoire): un range d'id_observation sous la forme d'entier ou d'intervalles d'entiers* séparés par des virgules ou bien '*' (pour toutes)* TODO: limit* TODO: départ* TODO: sets (ou colonnes, ou extended)* TODO: + les critères supportés par fabriquerSousRequeteRecherche()** Si <Utilisateur> est fourni, celui-ci doit être authentifié* TODO: export des données public et non-sensible d'un utilisateur** Si <Utilisateur> est fourni, le observations seront le résultat de l'intersection des 2 contraintes**/set_include_path(get_include_path() . PATH_SEPARATOR . dirname(dirname(realpath(__FILE__))) . '/lib');// TERMini_set('html_errors', 0);ini_set('xdebug.cli_color', 2);require_once('lib/PHPExcel/Classes/PHPExcel.php');define('SEPARATEUR_IMAGES', ",");// si getNomCommun_v2 ou getNomCommun_v3 sont utilisés/*require_once('/home/raphael/eflore/framework/framework/Framework.php');Framework::setCheminAppli("/home/raphael/eflore/projets/services/index.php");Framework::setInfoAppli(Config::get('info'));require_once('/home/raphael/eflore/projets/services/modules/0.1/Projets.php');*/class ExportXLS extends Cel {private $cache = Array();private $id_utilisateur = NULL;function ExportXLS($config) {parent::__construct($config);}/** Process $_POST et $_GET* TODO: changer JRest pour pouvoir disposer d'un nom de méthode plus représentatif que "updateXXX"* en POST*/function updateElement($uid, $pairs) {$params = Array('uid' => $uid[0]);// TODO: pas de range mais un utilisateur: possibleif(!isset($_POST['range'])) {header('HTTP/1.0 204 No Content');exit;}// trim() car: `POST http://url<<<"range=*"`elseif(trim($_POST['range']) == '*') {$obs_ids = Array('*');}else {$obs_ids = self::rangeToList(trim($_POST['range']));}$params['format'] = 'CSV';if($_POST['format'] == 'xls') $params['format'] = 'Excel5';if($_POST['format'] == 'xlsx') $params['format'] = 'Excel2007';$this->export($obs_ids, NULL, $params);exit;}/** $param: Tableau associatif, indexes supportés:* - widget: le nom du widget d'origine (utilisé pour les méta-données du tableur)**/function export(Array $obs_ids, String $fieldSets = NULL, Array $params = Array()) {$colonnes = self::nom_d_ensemble_vers_liste_de_colonnes($fieldSets);// $colonne_abbrev = array_keys($colonnes);$chercheur_observations = new RechercheObservation($this->config);$objPHPExcel = new PHPExcel();// TODO: $params['part'] pour le multi-part$params['widget'] = isset($params['widget']) ? $params['widget'] : 'CEL';// TODO: controleUtilisateur()if(! $params['uid']) { // || ! $this->controleUtilisateur($params['uid'])) {$params['uid'] = NULL;}if($params['uid']) $this->id_utilisateur = intval($params['uid']);$criteres = Array();if(! $obs_ids || count($obs_ids) == 1 && $obs_ids[0] == '*') {unset($criteres['raw']);}else {$criteres = Array('raw' =>sprintf('id_observation IN (%s)', implode(',', $obs_ids)));}$criteres['debut'] = isset($_GET['debut']) ? intval($_GET['debut']) : 0;$criteres['limite'] = isset($_GET['limite']) ? intval($_GET['limite']) : 0;$observations = $chercheur_observations->rechercherObservations($params['uid'], $criteres, $criteres['debut'], $criteres['limite'], TRUE)->get();// debug //echo ($chercheur_observations->requete_selection_observations);// XXX: malheureusement l'instance de JRest n'est pas accessible iciif(!$observations) {header('HTTP/1.0 204 No Content');exit;}$objPHPExcel->getProperties()->setCreator($params['widget']) // ou $uid ?->setLastModifiedBy("XX") // TODO: $uid->setTitle("YY") // TODO->setSubject("ZZ") // TODO->setDescription("Export blah");//->setKeywords("office PHPExcel php")//->setCategory("Test result file")$objPHPExcel->getActiveSheet()->setTitle("Observations");$feuille = $objPHPExcel->setActiveSheetIndex(0);$colid = 0;foreach($colonnes as $colonne) {if($colonne['extra'] == 2) continue;$feuille->setCellValueByColumnAndRow($colid, 1, $colonne['nom']);if($colonne['extra'] == 1) {$feuille->getStyleByColumnAndRow($colid, 1)->getBorders()->applyFromArray(array('allborders' => array('style' => PHPExcel_Style_Border::BORDER_DASHDOT,'color' => array('rgb' => PHPExcel_Style_Color::COLOR_BLUE))));}if(! $colonne['importable']) {$feuille->getStyleByColumnAndRow($colid, 1)->getFill()->applyFromArray(array('type' => PHPExcel_Style_Fill::FILL_SOLID,'color' => array('rgb' => PHPExcel_Style_Color::COLOR_YELLOW)));}$colid++;}$objPHPExcel->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);$ligne = 2;foreach ($observations as $obs) {$colid = 0;foreach($colonnes as $abbrev => $colonne) {if($colonne['extra'] == 2) continue;// valeur direct depuis cel_obs ?if(isset($obs[$abbrev])) $valeur = $obs[$abbrev];// pré-processeur de la champsif(function_exists($colonne['fonction'])) {$valeur = $colonne['fonction']($valeur);} elseif(method_exists(__CLASS__, $colonne['fonction'])) {$valeur = call_user_func(array(__CLASS__, $colonne['fonction']), $valeur);} elseif($colonne['fonction']) {die("méthode {$colonne['fonction']} introuvable");}// fonction pour obtenir des champs (étendus)elseif(function_exists($colonne['fonction_data'])) {$valeur = $colonne['fonction_data']($obs);}elseif(method_exists(__CLASS__, $colonne['fonction_data'])) {$valeur = call_user_func(array(__CLASS__, $colonne['fonction_data']), $obs);}// // cette section devrait être vide:// // cas particuliers ingérable avec l'architecture actuelle:if(false && $abbrev == 'date_observation' && $valeur == "0000-00-00") { /* blah */ }// // fin de section "cas particuliers"$feuille->setCellValueByColumnAndRow($colid, $ligne, $valeur);$colid++;}$ligne++;}header("Content-Type: application/vnd.ms-excel");header("Content-Disposition: attachment; filename=\"liste.xls\"; charset=utf-8");header("Cache-Control: max-age=0");// csv|xls|xlsx => CSV|Excel5|Excel2007// Note: le format Excel2007 utilise un fichier temporaire$generateur = PHPExcel_IOFactory::createWriter($objPHPExcel, $params['format']);$generateur->save('php://output');exit;}/** @param $fieldSets: un range, eg: 1-5,8,32,58-101* @return un tableau trié, eg: 1,2,3,4,5,8,32,58,...,101* http://stackoverflow.com/questions/7698664/converting-a-range-or-partial-array-in-the-form-3-6-or-3-6-12-into-an-arra*/static function rangeToList($in = '') {$inSets = explode(',', $in);$outSets = array();foreach($inSets as $inSet) {list($start,$end) = explode('-', $inSet . '-' . $inSet);// ignore les ranges trop importantsif($start > 10000000 || $end > 10000000 || abs($start-$end) > 10000) continue;$outSets = array_merge($outSets,range($start,$end));}$outSets = array_unique($outSets);$outSets = array_filter($outSets, 'is_numeric');sort($outSets);return $outSets;}/** @param $fieldSets: un liste de noms de colonnes ou de sets de colonnes* séparés par des virgules* eg: "espece" ou "champs-etendus", ...** @return: un tableau associatif déjà ordonné* clé: abbrev [machine-name] de la colonne (eg: "espece" ou "mot-clef")* valeur: des données relative à cette colonne, cf GenColInfo** @TODO: fonction commune à la génération en CSV**/static function nom_d_ensemble_vers_liste_de_colonnes($groupe_de_champs = 'standard') {if(! $groupe_de_champs) $groupe_de_champs = 'standard';$groupe_de_champs = array_flip(explode(',', $groupe_de_champs));$colonnes = Array();if(isset($groupe_de_champs['standard'])) {$colonnes += Array('nom_sel' => self::GenColInfo('nom_sel', 'Espèce'),'nom_sel_nn' => self::GenColInfo('nom_sel_nn', 'Numéro nomenclatural', 0, NULL, NULL, FALSE),'nom_ret' => self::GenColInfo('nom_ret', 'Nom retenu', 0, NULL, NULL, FALSE),'nom_ret_nn' => self::GenColInfo('nom_ret_nn', 'Numéro nomenclatural nom retenu', 0, NULL, NULL, FALSE),'nt' => self::GenColInfo('nt', 'Numéro taxonomique', 0, NULL, NULL, FALSE),'famille' => self::GenColInfo('famille', 'Famille', 0, NULL, NULL, FALSE),'nom_referentiel' => self::GenColInfo('nom_referentiel', 'Referentiel taxonomique'),'zone_geo' => self::GenColInfo('zone_geo', 'Commune'),'ce_zone_geo' => self::GenColInfo('ce_zone_geo', 'Identifiant Commune', 0, 'convertirCodeZoneGeoVersDepartement'),'date_observation' => self::GenColInfo('date_observation', 'Date', 0, 'formaterDate'),'lieudit' => self::GenColInfo('lieudit', 'Lieu-dit'),'station' => self::GenColInfo('station', 'Station'),'milieu' => self::GenColInfo('milieu', 'Milieu'),'commentaire' => self::GenColInfo('commentaire', 'Notes'),'latitude' => self::GenColInfo('latitude', 'Latitude', 1),'longitude' => self::GenColInfo('longitude', 'Longitude', 1),'geodatum' => self::GenColInfo('geodatum', 'Référentiel Géographique', 1, NULL, NULL, FALSE),// TODO: importable = FALSE car pas de merge de données importées'ordre' => self::GenColInfo('ordre', 'Ordre', 1, NULL, NULL, FALSE),'id_observation' => self::GenColInfo('id_observation', 'Identifiant', 1, NULL, NULL, FALSE),'mots_cles_texte' => self::GenColInfo('mots_cles_texte', 'Mots Clés', 1),'commentaire' => self::GenColInfo('commentaire', 'Commentaires', 1),'date_creation' => self::GenColInfo('date_creation', 'Date Création', 1, NULL, NULL, FALSE),'date_modification' => self::GenColInfo('date_modification', 'Date Modification', 1, NULL, NULL, FALSE),// rappel transmission = 1, signifie simplement "public"// des données importées peuvent être d'emblée "publiques"// "importable" = TRUE'transmission' => self::GenColInfo('transmission', 'Transmis', 1),'date_transmission' => self::GenColInfo('date_transmission', 'Date Transmission', 1, NULL, NULL, FALSE),'abondance' => self::GenColInfo('abondance', 'Abondance', 1),'certitude' => self::GenColInfo('certitude', 'Certitude', 1),'phenologie' => self::GenColInfo('phenologie', 'Phénologie', 1),'nom_commun' => self::GenColInfo('nom_commun', 'Nom Commun', 1, NULL, 'getNomCommun', FALSE),//'nom-commun' => self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v2'),//'nom-commun' => self::GenColInfo('nom-commun', 'Nom Commun', 1, NULL, 'getNomCommun_v3'),'images' => self::GenColInfo('images', 'Image(s)', 1, NULL, 'getImages', TRUE),);}return $colonnes;}/** Wrapper générant un tableau associatif:* @param $abbrev (obligatoire): nom court de colonne, largement utilisé lors de l'import.* En effet chaque ligne importée est accessible à l'aide du `define` de $abbrev en majuscule, préfixé de "C_"* Exemple: $ligne[C_LONGITUDE] pour "longitude".* cf: ImportXLS::detectionEntete()* @param $nom (obligatoire): nom complet de colonne (utilisé pour la ligne d'en-tête)* @param $is_extra:* Si 0, la colonne est une colonne standard* Si 1, la colonne est extra [le plus souvent générée automatiquement]* (auquel cas une bordure bleue entoure son nom dans la ligne d'entête)* Si 2, la colonne n'est pas traité à l'export, mais une définition peut lui être donnée* qui pourra être utilisée à l'import, exemple: "image"* @param $fonction (optionnel): un nom d'un fonction de préprocessing* $fonction doit prendre comme seul argument la valeur d'origine et retourner la valeur transformée* @param $fonction_data (optionnel): une *méthode* d'obtention de donnée* $fonction_data doit prendre comme premier argument le tableau des champs de l'enregistrement existant* $fonction_data doit retourner une valeur* @param $importable (optionnel): défini si la colonne est traitée (ou absolument ignorée par PHPExcel) lors de* l'import.*/static function GenColInfo($abbrev, $nom, $is_extra = 0, $fonction = NULL, $fonction_data = NULL, $importable = TRUE) {return Array('abbrev' => $abbrev,'nom' => $nom,'extra' => $is_extra ? 1 : 0,'fonction' => $fonction,'fonction_data' => $fonction_data,'importable' => $importable);}protected function formaterDate($date_heure_mysql, $format = NULL) {if (!$date_heure_mysql || $date_heure_mysql == "0000-00-00 00:00:00") return "00/00/0000";$timestamp = DateTime::createFromFormat("Y-m-d H:i:s", $date_heure_mysql)->getTimestamp();if(!$timestamp) return "00/00/0000";// TODO: les widget ne font malheureusement pas usage de l'heure dans le CEL// TODO: si modification, ne pas oublier de modifier le format d'import correspondant// dans ImportXLS (actuellement: "d/m/Y")$date_formatee = strftime('%d/%m/%Y', $timestamp);if(!$date_formatee) return "00/00/0000";return $date_formatee;}// TODO: mettre en static + param "id_utilisateur"function getImages($obs) {if(! $this->id_utilisateur) return NULL;$rec = $this->requeter(sprintf("SELECT GROUP_CONCAT(nom_original SEPARATOR '%s') FROM cel_images i". " LEFT JOIN cel_obs_images oi ON (i.id_image = oi.id_image)". " LEFT JOIN cel_obs o ON (oi.id_observation = o.id_observation)". " WHERE ce_utilisateur = %d",SEPARATEUR_IMAGES,$this->id_utilisateur));return $rec ? array_pop($rec) : NULL;}// TODO: référentiel ne devrait pas être généré au moment d'un Config::get,// comme dans Config::get('nomsVernaRechercheLimiteeTpl')// Par exemple, la variable pour "nva" ?function getNomCommun($obs) {$langue = 'fra';list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));if($referentiel == 'bdtfx') $referentiel = 'nvjfl';else return '';$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;if(isset($this->cache['getNomCommun'][$cache_id])) {//debug: error_log("require url_service_nom_attribution: OK ! (pour \"{$obs['nom_ret']}\")");return $this->cache['getNomCommun'][$cache_id];}// pas de cache://debug: error_log("require url_service_nom_attribution pour \"{$obs['nom_ret']}\"");// pour bdtfx:// /service:eflore:0.1/nvjfl/noms-vernaculaires/attributions?masque.nt=X&masque.lg=fra&retour.champs=num_statut// /projet/services/modules/0.1/nvjfl/NomsVernaculaires.php$url = str_replace(Array('{referentiel}', '{valeur}', '{langue}'),Array($referentiel, $obs['nt'], $langue),$this->config['eflore']['url_service_nom_attribution']) ."&retour.champs=num_statut";$noms = @json_decode(file_get_contents($url));if(! $noms) return '';$noms = array_filter((array)($noms->resultat), function($item) { return ($item->num_statut == 1); });$nom = array_pop($noms)->nom_vernaculaire;// cache$this->cache['getNomCommun'][$cache_id] = $nom;return $nom;}/* Tente de bootstraper le framework au plus court et d'initialiser une instance deNomsVernaculaires pour obtenir le nom commun */function getNomCommun_v2($obs) {static $service;$service = new Projets();$langue = 'fra';list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));if($referentiel == 'bdtfx') $referentiel = 'nvjfl';else return '';$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;if(isset($this->cache['getNomCommun'][$cache_id])) {error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");return $this->cache['getNomCommun'][$cache_id];}// pas de cache:error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");$donnees = Array('masque.nt' => $obs['nt'],'masque.lg' => $langue,'retour.champs' => 'num_statut');$noms = $service->consulter(Array('nvjfl', 'noms-vernaculaires'), $donnees);if(! $noms) return '';$noms = array_filter((array)($noms->resultat), function($item) { return ($item->num_statut == 1); });$nom = array_pop($noms)->nom_vernaculaire;// cache$this->cache['getNomCommun'][$cache_id] = $nom;return $nom;}/* Effectue un bootstraping plus sage que ci-dessus, mais le gain d'efficacitén'est pas aussi retentissant qu'espéré */static $service;function getNomCommun_v3($obs) {if(! $this->service) $this->service = new Projets();$langue = 'fra';list($referentiel) = explode(':', strtolower($obs['nom_referentiel']));if($referentiel == 'bdtfx') $referentiel = 'nvjfl';else return '';$cache_id = $referentiel . '-' . $obs['nt'] . '-' . $langue;if(isset($this->cache['getNomCommun'][$cache_id])) {error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");return $this->cache['getNomCommun'][$cache_id];}// pas de cache:error_log("require NomsVernaculaires.php pour \"{$obs['nom_ret']}\"");$donnees = Array('masque.nt' => $obs['nt'],'masque.lg' => $langue,'retour.champs' => 'conseil_emploi');$this->service->initialiserRessourcesEtParametres(Array('nvjfl', 'noms-vernaculaires', 'attributions'), $donnees);try {$noms = $this->service->traiterRessources();} catch(Exception $e) { return ''; }if(! $noms) return '';$noms = array_filter($noms['resultat'], function($item) { return ($item['num_statut'] == 1); });$nom = array_pop($noms)['nom_vernaculaire'];// cache$this->cache['getNomCommun'][$cache_id] = $nom;return $nom;}}