Subversion Repositories eFlore/Applications.cel

<?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>

*/

define('SEPARATEUR_IMAGES', ",");

Class FormateurGroupeColonne {

	static $cache = Array();

	/*

	* @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 nomEnsembleVersListeColonnes($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),

			);

		}

		if(isset($groupe_de_champs['avance'])) {

			$colonnes += array(

			   // 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),

			   // XXX: getImages() dépend du contexte de Cel, et doit être appelée comme cas particulier

			   // cf ExportXLS::traiterLigneObservation()

			   'images'				=> self::GenColInfo('images', 'Image(s)', 1, NULL, 'getImages', TRUE),

			);

		}

		/* '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'), */

		return $colonnes;

	}

	public static function getIntitulesColonnes($colonnes) {

		return array_map(function($item) { return $item['nom']; }, $colonnes);

	}

	public static function getLigneObservation(&$obs, &$colonnes, $cel = false) {

		$ligne_formatee = array();

		foreach($colonnes as $abbrev => $colonne) {

			$valeur = null;

			if($colonne['extra'] == 2) continue;

			// valeur direct depuis cel_obs ?

			if(isset($obs[$abbrev])) $valeur = $obs[$abbrev];

			// pré-processeur de la champs

			if(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($abbrev != 'images' && 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 */

			}

			if($abbrev == 'images') {

				$valeur = FormateurGroupeColonne::getImages($obs, $cel->id_utilisateur, $cel);

			}

			if($valeur == null) {

				$valeur = "";

			}

			// // fin de section "cas particuliers"

			$ligne_formatee[] = $valeur;

		}

		return $ligne_formatee;

	}

	/*

	* 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

		);

	}

	static function formaterDate($date_heure_mysql) {

		if (!$date_heure_mysql || $date_heure_mysql == "0000-00-00 00:00:00") return "00/00/0000";

		$date_format = DateTime::createFromFormat("Y-m-d H:i:s", $date_heure_mysql);

		$timestamp = @$date_format->getTimestamp();

		if(!$timestamp) return "00/00/0000";

		// TODO: les widgets 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;

	}

	static function getImages($obs, $id_utilisateur, $cel) {

		if(! $id_utilisateur) return NULL;

		$rec = $cel->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,

					$id_utilisateur));

		return $rec ? array_pop($rec) : NULL;

	}

	public static function convertirCodeZoneGeoVersDepartement($code_zone_geo) {

		$code_departement = '';

		if(self::estUnCodeInseeDepartement($code_zone_geo)) {

			$code_departement = substr(ltrim($code_zone_geo,'INSEE-C:'),0,2);

		}

		return $code_departement;

	}

	public static function estUnCodeInseeDepartement($code_a_tester) {

		return preg_match('/^INSEE-C:[0-9]{5}/',$code_a_tester);

	}

	// 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(self::$cache['getNomCommun'][$cache_id])) {

			//debug: error_log("require url_service_nom_attribution: OK ! (pour \"{$obs['nom_ret']}\")");

			return self::$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),

						   self::$config['eflore']['url_service_nom_attribution']) . // TODO !

			"&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

		self::$cache['getNomCommun'][$cache_id] = $nom;

		return $nom;

	}

	// 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');*/

	/* Tente de bootstraper le framework au plus court et d'initialiser une instance de

	   NomsVernaculaires 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(self::$cache['getNomCommun'][$cache_id])) {

			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");

			return self::$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

		self::$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(self::$cache['getNomCommun'][$cache_id])) {

			error_log("require NomsVernaculaires.php: OK ! (pour \"{$obs['nom_ret']}\")");

			return self::$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); });

		$premier_nom = array_pop($noms);

		$nom = $premier_nom['nom_vernaculaire'];

		// cache

		self::$cache['getNomCommun'][$cache_id] = $nom;

		return $nom;

	}

}