WebSVN – eFlore/Projets.eflore-projets – /trunk/services/modules/0.1/bdtfx/Noms.php

<?php
// declare(encoding='UTF-8');
/**
* Classe permettant de fournir des informations sur les noms scientifiques.
* Si l'url finit par /noms on retourne une liste de noms latin et leurs identifiants (seulement les 100 premeiers noms par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /noms?param1=val1&param2=val2&...
* 
* Les paramètres de requête disponibles sont : masque, masque.gen (nom de genre), masque.sp (épithète d'espèce), masque.ssp (épithète infra-spécifique),
* masque.au (auteur du nom), masque.an (année de publication du nom), masque.bib (réf biblio de la publi d'origine du nom), masque.ad (nomen addendum), 
* masque.nn (identifiant du nom), recherche, rang, distinct, retour.format, nl.format, nl.structure, navigation.depart et navigation.limite.
* Les différentes requetes :  
*   - noms | noms/relations/#projet/#id_projet | noms/#id | noms/#id/#champ+#champ
*   - noms/#id/relations | noms/#id/relations/synonymie | noms/#id/relations/homonymie | noms/#id/relations/flores
*   - noms/stats/rangs | noms/stats/annees | noms/stats/initiales
* 
* @package bdtfx
* @author Jennifer Dhé <jennifer.dhe@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>
* @version $Id$
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=EfloreApi01Noms
*/

class Noms extends CommunNomsTaxons {
        
        protected $format_reponse        = 'noms'; // Permet de stocker la requete formulée
        protected $service                       = 'noms';      
        protected $requete_champ         = 'num_nom, nom_sci, num_nom_retenu';
        protected $requete_condition = null; 
        protected $requete_group_by  = '';
        /** Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).*/
        protected $limite_requete        = array('depart' => 0, 'limite' => 100);       
        protected $distinct                      = null; // Valeur du paramètre de requete distinct (=0|1) 
        
        public function consulter($ressources, $parametres) {
                return parent::consulter($ressources, $parametres);
        }
        
//+----------------FONCTION D'ANALYSE DES PARAMETRES---------------------------------------------------------+
        
        public function traiterParametresSpecifiques() {
                foreach ($this->parametres as $param => $val) {
                        switch ($param) {
                                case 'masque' :
                                        $this->ajouterFiltreMasque('nom_sci', $val);                                    
                                        break;
                                case 'masque.sg' :
                                        $this->ajouterFiltreMasque('nom_supra_generique', $val);                
                                        break;
                        case 'masque.gen' :
                                $this->ajouterFiltreMasque('genre', $val);                                      
                                break;
                        case 'masque.sp' :
                                $this->ajouterFiltreMasque('epithete_sp', $val);                                
                                break;
                        case 'masque.ssp' :
                                $this->ajouterFiltreMasque('epithete_infra_sp',$val);                   
                                break;
                        case 'masque.au' :
                                $this->ajouterFiltreMasque('auteur', $val);                             
                                break;
                        case 'masque.an' :
                                $this->ajouterFiltreMasque('annee', $val);                      
                                        break;
                        case 'masque.bib' :
                                $this->ajouterFiltreMasque('biblio_origine',$val);
                                break;
                        case 'masque.ad' :
                                $this->ajouterFiltreMasque('nom_addendum', $val);
                                break;
                        case 'masque.nn' :
                                $this->requete_condition []= 'num_nom IN ('.$val.')';   
                                $this->masque['num_nom'] = "num_nom=$val";                                              
                                break;
                        case 'masque.rg' :
                                $this->ajouterFiltreMasque('rang', $val);                                               
                                break;
                        case 'retour.champs' :
                                $this->verifierParamChamps($param, $val);
                                break;
                        case 'distinct' :
                                $this->distinct = $val;                                                         
                                break;
                        }
                        $this->ajouterNomDistinct();
                }
        }
        
        public function verifierParamChamps($param, $val) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
                $champs_demandes = explode(',', $val);
                $champs_verifies = array();
                $champs_api = array_flip($this->champs_api);
                foreach ($champs_demandes as $champ) {
                        if (array_key_exists($champ, $champs_api)) {
                                $champs_verifies[] = $champs_api[$champ];
                        }
                }
                if (count($champs_verifies) > 0) {
                        $this->requete_champ .= ', '.implode(',', $champs_verifies);
                }
        }       
        
        /** Permet de rajouter à la requete sql le parametre distinct. N'est utilisé qu'avec le format oss */
        public function ajouterNomDistinct() {
                if (isset($this->distinct)) {
                        if ($this->distinct == 1 && $this->parametres['retour.format'] == 'oss') {
                                if ($this->compo_nom == '') {
                                        $this->requete_champ = ' DISTINCT nom_sci ';
                                } else {
                                        $this->requete_champ = ' DISTINCT nom_sci, '.implode(', ',$this->compo_nom);
                                }
                        } elseif ($this->distinct == 1 && $this->parametres['retour.format'] != 'oss') {
                                $e = 'Erreur dans votre requête </br> L\'utilisation du paramètre distinct ne se fait que sous 
                                        le format oss';
                                $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
                        }
                }
        }
                                                                                
//-----------------FONCTION D'ANALYSE DES RESSOURCES--------------------------------------------------------------------

        public function traiterRessourcesIdentifiant() {
                //on initialise la condition de la requete sql et le format de réponse
                $this->requete_condition = array(); //on vide la table dans le cas de plusieurs version
                $this->requete_condition[] = 'num_nom = '.$this->getBdd()->proteger($this->ressources[0]);
                $this->format_reponse = $this->service.'/id';
                if (isset($this->ressources[1]) && !empty($this->ressources[1])) { 
                        // requete de type noms/#id/#champ+#champ
                        if (($this->ressources[1] != 'relations')) {
                                $this->requete_champ = ' *, nom_sci ';
                                $this->format_reponse .= '/champ';
                        // requete de type noms/#id/relations/#relations
                        } elseif ($this->ressources[1] == 'relations') { 
                                $this->traiterRessourceIdRelations();
                        } else {
                                $e = 'Erreur dans votre requête </br> Ressources disponibles : <br/>
                                         <li> noms/#id/relations </li> <li> noms/#id/#champ+#champ </li>
                                         <li> noms/#id/relations/synonymie </li> <li> noms/#id/relations/flores </li>
                                         <li> noms/#id/relations/homonymie </li>';
                                $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
                        }
                } else { // requete de type noms/#id : rajout du nom_sci pour récupérer le format html par la fct mettreAuFormat()
                        $this->requete_champ = ' *, nom_sci ';
                }
        }
        
        public function traiterRessourceRelations() {
                $this->format_reponse .= '/relations';
                $projet = $this->ressources[1];
                $num_nom = $this->ressources[2];
                if (strrpos($num_nom, 'nn.coste') !== false) {
                        list($p, $nn) = explode('=', $num_nom);
                        $num_nom = $nn;
                } 
                $champ = "flore_$projet"."_num";
                if (isset($this->ressources[3])) {
                        $type = $this->ressources[3];
                        if (!in_array($type, array('homonymie', 'synonymie', 'flores'))) {
                                $e = "Les types disponibles pour les noms sont homonymie, synonymie et flores";
                                $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
                        }
                } 
                $this->requete_champ = ' num_nom ';
                $this->requete_condition = array();
                $this->requete_condition[] = "$champ = ".$this->getBdd()->proteger($num_nom);
        }
        
        public function traiterRessourceIdRelations() {
                $this->format_reponse .= '/relations';
                if (isset($this->ressources[2]) && !empty($this->ressources[2])) {
                        // requete de type noms/#id/relations/#relation
                        switch ($this->ressources[2]) {
                                case 'synonymie' : 
                                        $this->traiterRessourceIdSynonymie();
                                        break;
                                case 'flores' :
                                        $this->traiterRessourceIdFlores();
                                        break; 
                                case 'homonymie' :
                                        $this->traiterRessourceIdHomonymie();
                                        break;
                                default : 
                                        $e = 'Erreur dans votre requête </br> Ressources disponibles : <br/>
                                         <li> noms/#id/relations </li>  <li> noms/#id/relations/synonymie </li> 
                                         <li> noms/#id/relations/flores </li> <li> noms/#id/relations/homonymie </li>';
                                        $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e); 
                                        break;
                        }
                } 
        }
        
        public function traiterRessourceIdSynonymie() {
                // SELECT num_nom, nom_sci, num_nom_retenu, basionyme FROM bdtfx_v2_00 WHERE num_nom = X LIMIT 0,100;
                $this->format_reponse .= '/synonymie';
                if (strrpos($this->requete_champ, ', basionyme') === false) {
                        $this->requete_champ .= ', basionyme ';
                }
                $this->requete_condition[0] = 'num_nom_retenu = '.
                        '(SELECT num_nom_retenu FROM '.$this->table.' WHERE '.$this->requete_condition[0].')';
        }
        
        public function traiterRessourceIdHomonymie() {
                // SELECT num_nom, nom_sci, num_nom_retenu FROM bdtfx_v2_00 WHERE nom_sci = (SELECT nom_sci FROM bdtfx_v2_00 WHERE num_nom = X);
                $this->format_reponse    .=  '/homonymie';
                $this->requete_condition[0] =  'nom_sci = (SELECT nom_sci FROM '.$this->table
                                                                        .' WHERE '.$this->requete_condition[0].')';
        }
                
        public function traiterRessourceIdFlores() {
                $champ_flores = '';
                foreach ($this->champs_table as $champ) {
                        if (preg_match('/^flore_.*$/', $champ)) {
                                $champ_flores .= ', '.$champ;
                        }
                }
                $this->format_reponse .=  '/flores';
                $this->requete_champ   = 'num_nom'.$champ_flores;
        }
                
        public function traiterRessourceStatsRangs() {
                // SELECT count(*) as nombre, rang FROM bdtfx_v2_00 [WHERE rang = 290] GROUP BY rang ORDER BY rang;
                $this->format_reponse   .= '/rangs';
                $this->requete_champ     = 'count(*) as nombre, rang '; 
                $this->requete_group_by  = ' GROUP BY rang ORDER BY rang ';
        }
        
        public function traiterRessourceStatsAnnees() {
                // SELECT count(*) as nombre, annee FROM bdtfx_v2_00 GROUP BY annee ORDER BY annee;
                $this->format_reponse   .= '/annees';
                $this->requete_champ     = 'count(*) as nombre, annee ';
                $this->requete_condition = null;
                $this->requete_group_by  = ' GROUP BY annee ORDER BY annee ';   
        }
        
        public function traiterRessourceStatsInitiales() {
                // SELECT count(left( nom_sci, 2 )) as nb, rang, left(nom_sci, 2) as lettre GROUP BY rang, left(nom_sci, 2);
                $this->format_reponse .= '/initiales';
                $this->requete_champ   = 'count(left( nom_sci, 2 )) as nb, rang, left(nom_sci, 2) as lettre ';  
                $this->requete_group_by  = ' GROUP BY rang, left(nom_sci, 2)';
        }
        
        
        
//-----------------------------FONCTIONS DASSEMBLAGE DE LA REQUETE-----------------------------------------------------
        
        public function assemblerLaRequete() {
                if ( strrpos($this->format_reponse, 'noms/stats/') === false ) {
                        $this->mettreAuFormat(); //Ds CommunNomsTaxons.php
                }
                $requete =      ' SELECT '.$this->requete_champ.
                                ' FROM '.$this->table
                                .$this->retournerRequeteCondition()
                                .$this->requete_group_by
                                .$this->formerRequeteLimite(); 
        return $requete;
        
        }

        public function formerRequeteLimite() {
                if ($this->format_reponse != 'noms' && $this->format_reponse != 'noms/id/relations/synonymie' 
                        && $this->format_reponse != 'noms/id/relations/homonymie') {
                        $this->requete_limite = ''; 
                } elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
                        $this->limite_requete['depart'] = 
                                (($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
                        $this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite']; 
                } else {
                        $this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite']; 
                }
                return $this->requete_limite;
        }
                
        public function retournerRequeteCondition() {
                $condition = '';
                if ($this->requete_condition) { 
                        $condition = ' WHERE '.implode(' AND ', $this->requete_condition);
                } 
                return $condition;
        }
        
        
        /** Recupere le nombre total de résultat d'une requete lancée. */
        public function recupererTotalResultat() {
                $total = null;
                $requete = 'SELECT count(*) as nombre FROM '.$this->table.$this->retournerRequeteCondition().$this->requete_group_by;
                $res = $this->getBdd()->recuperer($requete);
                if ($res) {
                        $total = $res['nombre'];
                } else {
                        $e = 'Fct recupererTotalResultat() : <br/>Données introuvables dans la base';
                        $this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
                }
                return $total;
        }
        
        
//-------------------FONCTIONS POUR LE FORMATAGE EN JSON----------------------------------------------------------------
        
        public function retournerResultatFormate($resultat, $version) {
                switch ($this->format_reponse) {
                        case 'noms/relations' :
                                $reponse = $this->formaterRelations($resultat[0]);
                                break;
                        case 'noms/id' : //ds CommunNomsTaxons
                                $reponse = $this->formaterId($resultat[0]);
                                break;
                        case 'noms/id/champ' : //ds CommunNomsTaxons
                                $reponse = $this->formaterIdChamp($resultat[0]);
                                break;
                        case 'noms/id/relations' :
                                $reponse = $this->formaterIdRelations($resultat[0]);
                                break; 
                        case 'noms/id/relations/synonymie' :
                                $reponse = $this->formaterIdSynonymie($resultat);
                                break;
                        case 'noms/id/relations/homonymie' :
                                $reponse = $this->formaterIdHomonymie($resultat);
                                break;
                        case 'noms/id/relations/flores' : //ds CommunsNomsTaxons
                                $reponse = $this->formaterIdFlores($resultat[0]);
                                break;
                        case 'noms/stats/annees' : //ds CommunNomsTaxons
                                $reponse = $this->formaterStatsAnnee($resultat);
                                break;
                        case 'noms/stats/rangs' : //ds CommunNomsTaxons
                                $reponse = $this->formaterStatsRang($resultat);
                                break;
                        case 'noms/stats/initiales' : //ds CommunNomsTaxons
                                $reponse = $this->formaterStatsInitiales($resultat);
                                break;
                        case 'noms' :
                                $reponse = $this->formaterNoms($resultat);
                                break;
                }
                return $reponse;
        }
        
//+---------------------concerne les resultats pour des requetes de type noms/id-----------------------------+
        
        public function formaterRelations($resultat) {
                $num_nom = $resultat['num_nom'];
                if (isset($this->ressources[3])) {
                        $url = Config::get('url_service').$this->service."/$num_nom/relations";
                } else {
                        $type = $this->ressources[3];
                        $url = Config::get('url_service')."/$this->service/$num_nom/relations/$type";
                }
                $res = $this->consulterHref($url);
                return $res;
        }       
        
        public function formaterIdRelations($resultat) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
                $this->resultat_req = $resultat;        
                $retour_id_rel = array ('entete' => array()); //on initialise pr que l'entete apparaisse en premier lors de l'affichage
                
                //on recupère le resultat de chaque relation (appel du WS correspondant)
                $flores = $this->ajouterRelations('flores', $version);
                if (isset($flores)) $retour_id_rel['resultat']['flores'] = $flores;
                $homonymes = $this->ajouterRelations('homonymie', $version);
                if (isset($homonymes)) $retour_id_rel['resultat']['homonymes'] = $homonymes;
                $synonymes = $this->ajouterRelations('synonymie', $version);
                if (isset($synonymes)) $retour_id_rel['resultat']['synonymes'] = $synonymes;
                
                //on renvoit null si il n'existe aucune relations (on efface l'entete en premier lieu)
                if (!isset($retour_id_rel['resultat'])) {
                        $retour_id_rel = null; 
                } else { //on rajoute l'entete si des relations existent
                        $this->afficherDonnees('num_nom', $this->ressources[0]); 
                        $retour_id_rel['entete'] = $this->table_retour;
                        $this->table_retour = array();
                }
                return $retour_id_rel;
        }
        
        /**
         * Recupere les relations (type de la relation passée en paramètres :[type_relation] = synonymie, homonymie ou 
         * flores) par l'appel du web service [version]/noms/#id/relations/[type_relation]
         */
        public function ajouterRelations($relation, $version) {
                $version = str_replace(Config::get('bdd_table').'_', '', $version);
                $res = null;
                $parametres_url = '';
                if ($this->parametres != array()) $parametres_url = '?'.http_build_query($this->parametres, '', '&');
                $url = Config::get('url_service').'/'.$version.'/'.$this->service.'/'
                                                                        .$this->ressources[0].'/relations/'
                                                                        .$relation.$parametres_url;     
                $relation = $this->consulterHref($url);
                $res = $relation->resultat;
                return $res;
        }
        
        
        public function formaterIdSynonymie($resultat) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
                $retour_id_syn = array();
                if ($resultat[0]['num_nom_retenu'] == '') {
                        $retour_id_syn[] = 'nom_retenu N.D.';
                } elseif (count($resultat) != 1) { 
                        //on remplit d'abord l'entete du resultat 
                        $this->table_retour['id'] = $this->ressources[0];
                        $this->afficherEnteteResultat('/'.$this->service.'/'.$this->ressources[0].'/relations/synonymie');
                        $retour_id_syn['entete'] = $this->table_retour;
                        $this->table_retour = array();
                        foreach ($resultat as $tab) {
                                //pour chaque basionyme, on recupère le résultat : num_nom, nom_sci, basionyme et num_nom_retenu :
                                $this->resultat_req = $tab; 
                                $num = $tab['num_nom'];
                                $this->afficherNomHrefRetenu($tab, $num);
                                $this->afficherDonnees('basionyme', $tab['basionyme']); 
                                $retour_id_syn['resultat'][$num] = $this->table_retour;
                                $this->table_retour = array();
                        }
                        if (!isset($retour_id_syn['resultat']) && !in_array('nom_retenu N.D.', $retour_id_syn)) {
                                $retour_id_syn = null; //on initialise le resultat à null
                        } 
                }
                return $retour_id_syn;
        }
        
        public function formaterIdHomonymie($resultat) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
                if (count($res_version) != 1) {
                        $this->table_retour['id'] = $this->ressources[0];
                        $this->afficherEnteteResultat($resultat, '/'.$this->service.'/'.$this->ressources[0].'/relations/homonymie');
                        $retour_id_hom['entete'] = $this->table_retour;
                        $this->table_retour = array();
                        foreach ($resultat as $homonyme) {
                                $this->resultat_req = $homonyme;
                                $id = $homonyme['num_nom'];
                                $this->afficherDonnees('num_nom', $id);
                                if ($homonyme['num_nom_retenu'] != '') {
                                        $retenu = ($id == $homonyme['num_nom_retenu']) ? 'true' : 'false';      
                                        $this->table_retour['retenu'] = $retenu; 
                                }                                               
                                $retour_id_hom['resultat'][$id] = $this->table_retour;
                                unset($retour_id_hom['resultat'][$id]['id']);
                                $this->table_retour = array();
                        }
                } else {
                        $retour_id_hom = null; 
                }
                return $retour_id_hom;
        }
                
        public function formaterIdFlores($resultat) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp,noms_projets');
                $this->resultat_req = $resultat;        
                $id = array_shift($resultat);
                $reponse['entete']['id'] = $id;
                foreach ($resultat as $flores => $valeur) {
                        if ($valeur != '' && $valeur != '0') {
                                $this->afficherInfosFlore($res_version, $flores, $valeur);
                        }
                }
                if ($this->table_retour != array()) {
                        $reponse['resultat'] = $this->table_retour;
                        $this->table_retour = array();
                } else { 
                        $reponse = null; 
                }
                return $reponse;
        }
                
        public function afficherInfosFlore(&$resultat, $flores, $valeur) {
                $flore = substr($flores,0,strrpos($flores, '_')); 
                $projet = $this->noms_projets[$flore];
                if (strrpos($flores, 'num') !== false) { 
                        if (preg_match('/^([0-9]+)(?:[.]syn[^a-z]*|(.*))?$/', $valeur, $match)) { 
                                $this->table_retour[$flore]['id'] = $match[1];
                                if ($projet == 'coste') {
                                        $this->table_retour[$flore]['href'] = $this->ajouterHrefAutreProjet('noms', 'nn_coste:', $match[1], $projet);
                                }
                                if (isset($match[2]) && $match[2] != '') $this->table_retour[$flore]['cle'] = $match[2];
                        } 
                        if (isset($resultat[$flore.'_rem']) && !empty($resultat[$flore.'_rem'])) {
                                $this->table_retour[$flore]['remarque'] = $resultat[$flore.'_rem'];
                                unset($resultat[$flore.'_rem']);
                        }
                } elseif (strrpos($flores,'belge') !== false) {
                        if (preg_match('/^([0-9]+) (R|S)?$/', $valeur, $match)) {
                                if (isset($match[2])) $type = ($match[2] == 'R') ? 'taxons' : 'synonyme';
                                $this->table_retour[$flore]['page'] = $match[1];
                                $this->table_retour[$flore]['type'] = $type;
                        }
                }
        }
        
        
        
//+---------------------concerne les resultats pour des requetes de type /noms avec ou sans paramètres-------+

        public function formaterNoms($resultat) {
                if ($this->parametres['retour.format'] == 'oss') {
                        $reponse = $this->formaterEnOss($resultat);      //Ds CommunNomsTaxons.php
                } else {
                        $reponse = $this->formaterEnJsonMax($resultat);
                }
                return $reponse;
        }

        public function formaterEnJsonMax($resultat) {
                $this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
                $masque = $this->recupererMasquePrincipal();
                if (isset($masque)) {
                        $resultat = $this->trierRechercheFloue($this->parametres[$masque[0]], $resultat, $masque[1]);
                }
                if (isset($this->masque)) {
                        $this->table_retour['masque'] = implode('&', $this->masque); 
                }
                $this->afficherEnteteResultat('/'.$this->service); //communNomTaxons
                $table_retour_json['entete'] = $this->table_retour;
                //on remplit la table $table_retour_json['resultat']
                $champs = null;
                if (array_key_exists('retour.champs', $this->parametres)) {
                        $champs = explode(',', $this->parametres['retour.champs']);
                }
                $resultat_json = null;
                foreach ($resultat as $tab) {
                        $this->table_retour = array();
                        $num = $tab['num_nom'];
                        $this->afficherNomHrefRetenu($tab, $num);
                        $reponse_id = $this->formaterId($tab);
                        $this->ajouterChampsPersonnalises($champs, $reponse_id);
                        $resultat_json[$num] = $this->table_retour;
                }
                $table_retour_json['resultat'] = $resultat_json; 
                return $table_retour_json;
        }
}
?>
Subversion Repositories eFlore/Projets.eflore-projets

(root)/trunk/services/modules/0.1/bdtfx/Noms.php – Rev 3
