Subversion Repositories eFlore/Applications.cel

<?php

// declare(encoding='UTF-8');

/**

 * Classe recherchant des infos sur un taxon.

 *

 * Elle appelle les web service d'eflore pour éviter que le code client ne soit dépendant de la BDD d'eFlore.

 *

 * @internal   Mininum PHP version : 5.2

 * @category   CEL

 * @package    Services

 * @subpackage Bibliothèques

 * @version    0.1

 * @author     Mathias CHOUET <mathias@tela-botanica.org>

 * @author     Jean-Pascal MILCENT <jpm@tela-botanica.org>

 * @author     Aurelien PERONNET <aurelien@tela-botanica.org>

 * @license    GPL v3 <http://www.gnu.org/licenses/gpl.txt>

 * @license    CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>

 * @copyright  1999-2014 Tela Botanica <accueil@tela-botanica.org>

 */

class RechercheInfosTaxonBeta extends Cel {

	const DEBUG = FALSE;

	private $url_service_nom = null;

	private $url_service_taxon = null;

	private $url_service_chorologie = null;

	private $masque_recherche = null;

	private $code_referentiel = 'bdtfx';

	// initialisé à TRUE par rechercherInfosSurTexteCodeOuNumTax()

	// si l'espèce passée a le motif <ref>:(nt|nn):<num>, eg: isfan:nt:1591

	public $is_notation_spe = FALSE;

	// un cache utilisé pour les requêtes effectuées sur /service:eflore:0.1/bdtfx/noms?masque=

	// qui sont lourdes, et parfois identiques (cf cas de l'import XLS)

	static $cache = array();

	public function RechercheInfosTaxonBeta($config, $code_referentiel = 'bdtfx') {

		parent::__construct($config);

		$this->setReferentiel($code_referentiel);

	}

	public function setReferentiel($code_referentiel = 'bdtfx') {

		$this->code_referentiel = $code_referentiel;

		$this->formaterUrlsServices($this->config);

	}

	private function formaterUrlsServices($config) {

		$this->url_service_nom = str_replace('{referentiel}', $this->code_referentiel ,$config['eflore']['url_service_nom']);

		$this->url_service_taxon = str_replace('{referentiel}', $this->code_referentiel ,$config['eflore']['url_service_taxon']);

		$this->url_service_chorologie_obs = $config['eflore']['url_service_chorologie_obs'];

		$this->config = $config;

	}

	public function rechercherGenreEspeceSurPrefixe($genre = null, $espece = null) {

		$liste_genre_espece = array();

		$this->masque_recherche = trim(trim($genre).' '.trim($espece,' *'));

		$masque = urlencode($this->masque_recherche);

		if(self::DEBUG) error_log("CEL fetch: " . $this->url_service_nom.'?masque='.$masque.'&recherche=etendue&retour.format=min&navigation.limite=50&ns.structure=au');

		$urlService = $this->url_service_nom.'?masque='.$masque.'&recherche=etendue&retour.format=min&navigation.limite=50&ns.structure=au';

		$requete = @file_get_contents($urlService);

		if($requete != '') {

			$requete = json_decode($requete);

			if(is_object($requete) && isset($requete->resultat)) {

				foreach ($requete->resultat as $id => $res) {

					$retenu = ($res->retenu == "true") ? '3' : '4';

					$liste_genre_espece[] = array($res->nom_sci_complet, $id, $retenu, $res->nom_sci);

				}

			}

			usort($liste_genre_espece, array($this, 'comparerParRetenuPuisNom'));

		}

		return $liste_genre_espece;

	}

	function comparerParRetenuPuisNom($a, $b) {

		if($a[2] == 3 && $b[2] != 3) {

			return -1;

		} elseif($a[2] != 3 && $b[2] == 3) {

			return 1;

		} else {

			// maintient l'ordre lexicographique - et normalement le genre en premier, en utilisant le nom_sci (sans auteur)

			return strcasecmp($a[3], $b[3]);

			// @WTF levenshtein c'était juste pour garder le genre en premier ?

			//return levenshtein($this->masque_recherche, $a[0]) >= levenshtein($this->masque_recherche, $b[0]);

		}

	}

	public function effectuerRequeteInfosComplementairesEtFormaterNom($numNom) {

		$resultat_infos_complementaires = (array)$this->effectuerRequeteInfosComplementairesSurNumNom($numNom);

		$retour_infos_complementaires = array();

		if (isset($resultat_infos_complementaires['nom_retenu_complet']) && $resultat_infos_complementaires['nom_retenu_complet']) {

			$retour_infos_complementaires=array((self::supprimerBiblio($resultat_infos_complementaires['nom_retenu_complet'])));

		}

		return $retour_infos_complementaires;

	}

	public function rechercherInformationsComplementairesSurNom($nom_saisi) {

		$nom_saisi = trim($nom_saisi);

		// Essai de recherche sur le nom saisi tel quel

		$liste_genre_espece = $this->effectuerRequeteUrlRecherche($nom_saisi, 'stricte');

		if($liste_genre_espece) return $liste_genre_espece;

		// Essai de recherche stricte en tentant de supprimer le nom d'auteur

		if( ($nom_saisi_sans_auteur = self::supprimerAuteur($nom_saisi)) ) { // ne pas faire la requête sur un mot vide

			$liste_genre_espece = $this->effectuerRequeteUrlRecherche($nom_saisi_sans_auteur, 'stricte');

		}

		if($liste_genre_espece) return $liste_genre_espece;

		// avant-dernière tentative : essai de recherche étendue

		$liste_genre_espece = $this->effectuerRequeteUrlRecherche($nom_saisi, 'etendue');

		if($liste_genre_espece) return $liste_genre_espece;

		// dernière tentative: concaténation (nom_sci,auteur) (= nom-retenu généré utilisé comme nom_sci)

		$liste_genre_espece = $this->effectuerRequeteUrlRecherche($nom_saisi, 'concat');

		return $liste_genre_espece;

	}

	private function effectuerRequeteUrlRecherche($nom_saisi, $mode = 'stricte') {

		$url = sprintf(

			'%1$s?masque=%2$s&recherche=%3$s&ns.format=txt&retour.champs=%4$s&navigation.limite=1',

			$this->url_service_nom,

			urlencode($nom_saisi),

			$mode,

			implode(',', array("id","nom_sci","auteur","nom_retenu.id","famille","num_taxonomique","nom_retenu_complet")));

		if(! array_key_exists($url, self::$cache)) {

			if(self::DEBUG) error_log("CEL fetch: " . $url);

			$res = @json_decode(file_get_contents($url));

			self::$cache[$url] = $res;

		} else {

			$res = self::$cache[$url];

		}

		if(!$res) return NULL;

		$resultat = (array)$res->resultat;

		return array_pop($resultat);

	}

	static function supprimerAuteur($nom_saisi) {

		// TODO: gérer les hybrides

		if(self::estUnHybride($nom_saisi) || self::estUneFormuleHybridite($nom_saisi)) {

			$nom_decoupe = explode(' ', $nom_saisi);

			$derniere_position_hybride = array_keys($nom_decoupe, 'x');

			$nom_saisi_sans_auteur = implode(' ',array_slice($nom_decoupe, 0, end($derniere_position_hybride) + 2));

		} else {

			/* Attention le parseur de nom n'est pas fiable à 100%

			   mais ça marche dans la plupart des cas

			   à part les formules d'hybridité saisies avec un auteur */

			$nameparser = new NameParser();

			$auteur = $nameparser->parse_auth($nom_saisi);

			$nom_saisi_sans_auteur = str_replace($auteur, '', $nom_saisi);

		}

		return trim($nom_saisi_sans_auteur);

	}

	static function estUneFormuleHybridite($nom_saisi) {

		return strpos($nom_saisi,' x ') !== false;

	}

	static function estUnHybride($nom_saisi) {

		return strpos($nom_saisi,'x ') === 0;

	}

	public function effectuerRequeteInfosComplementairesSurNumNom($num_nom, $ref = NULL) {

		if($ref && isset($this->config['eflore']['api_host'])) {

			if(self::DEBUG) error_log("CEL fetch: " .$this->config['eflore']['api_host'] . '/');

			return @json_decode(file_get_contents($this->config['eflore']['api_host'] . '/' .

			$ref . '/' .

			'noms' . '/' .

			$num_nom .

			'?retour.champs=' . implode(',', array('nom_sci,auteur',

			'id',

			'nom_retenu_complet',

			'nom_retenu.id',

			'num_taxonomique',

			'famille'))));

		}

		// XXX: compat

		if(self::DEBUG) error_log("CEL fetch: " . $this->url_service_nom.'/'.$num_nom.'?retour.champs=nom_sci,auteur,id,nom_retenu_complet,nom_retenu.id,num_taxonomique,famille');

		return @json_decode(file_get_contents($this->url_service_nom.'/'.$num_nom.'?retour.champs=nom_sci,auteur,id,nom_retenu_complet,nom_retenu.id,num_taxonomique,famille'));

	}

	static function supprimerBiblio($nom) {

		return trim(preg_replace('/ \[.*\]/','',$nom));

	}

	public function rechercherNumTaxSurNumNom($num_nom) {

		$nt = null;

		$url = $this->url_service_nom."/".$num_nom.'?retour.champs=num_taxonomique';

		if(self::DEBUG) error_log("CEL fetch: $url");

		$resultat = @file_get_contents($url);

		if($resultat != '') {

			$infos = json_decode($resultat);

			$nt = $infos->num_taxonomique;

		}

		return $nt;

	}

	public function taxonEstPresentDansDepartement($num_taxon,$code_departement) {

		$presence_taxon = false;

		$url = $this->url_service_chorologie_obs.'?masque.departement='.$code_departement.'&masque.determination.nt='.$num_taxon.'&navigation.limite=1';

		if(self::DEBUG) error_log("CEL fetch: $url");

		$resultat = @file_get_contents($url);

		if($resultat != '') {

			$resultat = json_decode($resultat);

			if(is_object($resultat) && isset($resultat->resultat) && count($resultat->resultat) > 0) {

				$presence_taxon = true;

			}

		}

		return $presence_taxon;

	}

	/* texte libre, nom scientifique,

	   ou code nomenclatural (format bdtfx:nn:999999)

	   ou code taxonomique (format bdtfx:nt:999999)

	   TODO: voir ce qu'on fait pour l'import de différent référentiels */

	function rechercherInfosSurTexteCodeOuNumTax($identifiant_espece) {

		preg_match('/(' . implode('|', Cel::$referentiels_valides) .'):(nn|nt):(\d+)/i', $identifiant_espece, $elements);

		if($elements) {

			$this->is_notation_spe = TRUE;

			list(, $ref, $type, $num) = $elements;

			if($ref != $this->code_referentiel) {

				// TODO: ignorer la colonne référentiel, et utiliser le référentiel donné

				// mais il faut alors avertir le service (d'import/modif) d'utiliser le référentiel

				// passé au nom d'espèce

				// Seul le effectuerRequeteInfosComplementairesSurNumNom() le supporte, car c'est encore

				// un peu complexe à implémenter proprement pour cause d'attributs de classes.

			}

			// Numero nomenclatural

			if ($type == 'nn') {

				$obj = $this->effectuerRequeteInfosComplementairesSurNumNom($num, $ref);

			}

			// Numero taxonomique

			else {

				//TODO: retourner moins de champs grâce au paramètre retour.champs

				if(self::DEBUG) error_log("CEL fetch: " . $this->url_service_taxon."/nt:".$num);

				$obj = @json_decode(file_get_contents($this->url_service_taxon."/nt:".$num));

			}

			if($obj) $obj->ref = $ref;

			return $obj;

		}

		// Nom scientifique

		return $this->rechercherInformationsComplementairesSurNom($identifiant_espece);

	}

	public function rechercherSynonymesSurNumNom($num_nom) {

		$retour = array();

		if(self::DEBUG) error_log("CEL fetch: " . $this->url_service_nom.'/'.$num_nom.'/relations/synonymie/?retour.format=min');

		$resultat = @file_get_contents($this->url_service_nom.'/'.$num_nom.'/relations/synonymie/?retour.format=min');

		if($resultat != '') {

			$resultat = json_decode($resultat);

			if(is_object($resultat) && isset($resultat->resultat) && count($resultat->resultat) > 0) {

				$retour = $resultat->resultat;

			}

		}

		return $retour;

	}

}