Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 132 | Rev 160 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

<?php
/**
* Description :
* Classe NomsVernaculaires.php fournit une liste de noms vernaculaires et leur liaison à la bdtfx
* Le but étant de fournir un ensemble minimal d'information comprenant :
* un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une langue et
* une relation avec un taxon de la bdtfx.
* Si l'url finit par /noms-vernaculaires on retourne une liste de noms (seulement les 100 premières par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /observations?param1=val1&param2=val2&...
*
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.region , recherche,
* distinct, retour.format, navigation.depart et navigation.limite.
*
* Encodage en entrée : utf8
* Encodage en sortie : utf8
* @package framework-v3
* @author Delphine Cauquil <delphine@tela-botanica.org>
* @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 1.0
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
*/
class NomsVernaculaires extends Commun {
        protected $champ_infos = array(
                        'taxon' => array('service' => 'taxons', 'ressource' => 'nt:', 'projet' => 'bdtfx', 'nom' => 'nom_sci'),
                        'conseil_emploi' => array('service' => 'ontologies', 'ressource' => 'numStatut:', 'projet' => 'nvjfl', 'nom' => 'nom'),
                        'genre' => array('service' => 'ontologies', 'ressource' => 'genreNombre:', 'projet' => 'nvjfl', 'nom' => 'nom'));

        protected $service = 'noms-vernaculaires';

        /**
         * Permet de stocker la requete formulée : /noms-vernaculaires | /noms-vernaculaires/#id |
         *  /noms-vernaculaires/#id/champ | /noms-vernaculaires/#id/relations
         * Est remplit au cours de l'analyse des ressources (traiterRessources()), par défaut, a la valeur du service.
         * Est utilisée principalement pr déterminer le format du tableau à retourner.        */
        protected $format_reponse = 'noms-vernaculaires';

        /** Variables constituant les parametres de la requete SQL (champ, condition, limit) remplie
         * selon ressources et paramètres */
        protected $requete_champ = array(' * ');
        protected $requete_condition = '';
        protected $limite_requete = array(
                'depart' => 0,
                'limite' => 100
        );

        /**
         * Precise la contenance plus ou moins précise du tableau à retourner :
         *  - min = les données présentes dans la table
         *  - max = les données de la table + les informations complémentaires (pour les identifiants et les codes)
         *  - oss = la liste des nom_sci (uniquement pour noms et taxons) */
        protected $retour_format = 'max';
        /** Valeur du paramètre de requete recherche :
         *  - stricte : le masque est passé tel quel à l'opérateur LIKE.
         *  - etendue : ajout automatique du signe % à la place des espaces et en fin de masque avec utilisation de LIKE.
         *  - floue : recherche tolérante vis-à-vis d'approximations ou d'erreurs (fautes d'orthographe par exemple) */
        protected $recherche;

        /** Permet de stocker le tableau de résultat (non encodé en json) */
        protected $table_retour = array();
        /** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
        protected $total_resultat;

        //+------------------------------------------------------------------------------------------------------+
        // créer une condition en fonction du paramétre
        public function traiterParametres() {
                if (isset($this->parametres) && !empty($this->parametres)) {

                        if (isset($this->parametres['recherche']) && $this->parametres['recherche'] != '') {
                                $this->recherche = $this->parametres['recherche'];
                        }
                        foreach ($this->parametres as $param => $valeur) {
                                switch ($param) {
                                        case 'masque' :
                                                $this->ajouterLeFiltreMasque('nom_vernaculaire', $valeur);
                                                break;
                                        case 'masque.nt' :
                                                $this->ajouterLeFiltreMasque('num_taxon', $valeur);
                                                break;
                                        case 'masque.nv' :
                                                $this->ajouterLeFiltreMasque('nom_vernaculaire', $valeur);
                                                break;
                                        case 'masque.lg' :
                                                $this->ajouterLeFiltreMasque('code_langue', $valeur);
                                                break;
                                        case 'masque.cce' :
                                                $this->ajouterLeFiltreMasque('num_statut', $valeur);
                                                break;
                                        case 'retour.format' :
                                                $this->retour_format = $valeur;
                                                break;
                                        case 'navigation.depart' :
                                                $this->limite_requete['depart'] = $valeur;
                                                break;
                                        case 'navigation.limite' :
                                                $this->limite_requete['limite'] = $valeur;
                                                break;
                                        case 'recherche' :
                                                break;
                                        default :
                                                $p = 'Erreur dans les paramètres de recherche de votre requête : '.
                                                        '</br> Le paramètre " '.$param.' " n\'existe pas.';
                                                        $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $p);
                                }
                        }
                }
        }

        public function ajouterLeFiltreMasque($nom_champ, $valeur) {
                if ($nom_champ == 'num_taxon') { // si il s'agit d'un chiffre
                        $this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
                } else {
                        if ($this->recherche == 'floue') {
                                $this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
                                        .' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\'))) ';
                        } else {
                                if ($this->recherche == 'etendue') {
                                        $valeur = str_replace(' ','% ', $valeur);
                                        $valeur .= '%';
                                }
                                $this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
                        }
                }
        }

        //+------------------------------------------------------------------------------------------------------+
        // en fonction de la présence des ressources modifie requete_champ et requete_condition
        public function traiterRessources() {
                if (isset($this->ressources) && !empty($this->ressources)) {
                        if (isset($this->ressources[0]) && !empty($this->ressources[0])) {
                                $this->traiterRessourceId(); // ajoute condition id=#valeur
                                if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
                                        $this->traiterRessourceChampOuRelations(); //modifie requete_champ ou requete_condition
                                }
                        }
                } else { //rajoute distinct pour ne pas avoir plusieurs fois le même nom
                        $this->requete_champ = array('distinct(id)', 'nom_vernaculaire ');
                }
        }

        //requete : /noms-vernaculaires/#id (ex : /noms-vernaculaires/7)
        public function traiterRessourceId() {
                if (is_numeric($this->ressources[0])) {
                        $this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]);
                        $this->format_reponse .= '/id';
                } else {
                        $r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->ressources[0].
                                ' " n\'existe pas.';
                        $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
                }
        }


        public function traiterRessourceChampOuRelations() {
                //requete = /noms-vernaculaires/#id/relations :
                if ($this->ressources[1] == 'relations') {
                        $this->format_reponse .= '/relations';
                        $this->requete_condition[] = 'num_taxon = (SELECT region FROM '.$this->table.' WHERE '
                                                                                .implode(' AND ', $this->requete_condition).')';
                //requete = /noms-vernaculaires/#id/#champ :
                } else {
                        $this->format_reponse .= '/champ';
                        $this->analyserChamp();
                }
        }

        public function analyserChamp() {
                $this->requete_champ = array();
                $this->recupererTableConfig('champs_possibles');// s'il y a plusieurs champs correspondant au champ demandé ils sont séparé par des |
                $champs = explode(' ', $this->ressources[1]);
                foreach ($champs as $champ) {
                        preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match);
                        if (isset($this->champs_possibles[$match[1]])) {
                                $this->requete_champ[] = str_replace('|', ', ', $this->champs_possibles[$match[1]]);
                        } elseif (isset($this->champs_possibles[$match[0]])) {
                                $this->requete_champ[] = str_replace('|', ', ', $this->champs_possibles[$match[0]]);
                        } else {
                                $champs_possibles = implode('</li><li>', array_keys($this->champs_possibles));
                                $c = 'Erreur dans votre requête : </br> Le champ "'.$champ_possibles.'" n\'existe pas. '.
                                        'Les champs disponibles sont : <li>'.$champs_possibles.'</li> et leurs déclinaisons (ex. ".code").';
                                $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $c);
                        }
                }
        }

        //+------------------------------------------------------------------------------------------------------+
        public function assemblerLaRequete() {
                $requete = ' SELECT '.$this->formerRequeteChamp().
                                        ' FROM '.$this->table
                                        .$this->formerRequeteCondition()
                                        .$this->formerRequeteLimite();
                return $requete;
        }

        public  function formerRequeteChamp() {
                if (in_array('*', $this->requete_champ)) {
                        $champ = ' * ';
                } else {
                        $champ = implode(', ', $this->requete_champ);
                }
                return $champ;
        }

        public  function formerRequeteCondition() {
                $condition = '';
                if ($this->requete_condition != null) {
                        $condition = ' WHERE '.implode(' AND ', $this->requete_condition);
                }
                return $condition;
        }

        //ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
        // suivantes : /noms-vernaculaires et /noms-vernaculaires/#id/relations)
        public function formerRequeteLimite() {
                if (in_array($this->format_reponse , array($this->service.'/id', $this->service.'/id/champs'))) {
                        $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;
        }

        //on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /noms-vernaculaires)
        public function recupererTotalResultat() {
                $requete = 'SELECT count(distinct(id)) as nombre FROM '
                        .$this->table
                        .$this->formerRequeteCondition();
                $res = $this->getBdd()->recuperer($requete);

                if ($res) {
                        $total = $res['nombre'];
                } else {
                        $t = 'Fonction recupererTotalResultat() : <br/>Données introuvables dans la base';
                        $this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $t);
                }
                return $total;
        }

        //+------------------------------------------------------------------------------------------------------+
        // determine en fct du service appelé (/noms-vernaculaires | /noms-vernaculaires/#id | /noms-vernaculaires/#id/champ |
        // /noms-vernaculaires/#id/relations) le format du tableau à retourner.
        public function retournerResultatFormate($resultat) {
                $this->recupererTableConfig('correspondance_champs');
                switch ($this->format_reponse) {
                        case 'noms-vernaculaires'                               : 
                                $reponse = ($this->retour_format == 'oss') ? $this->formaterEnOss($resultat) : $this->formaterNomsVernaculaires($resultat);                     break;
                        case 'noms-vernaculaires/id'                    : $reponse = $this->formaterNomsVernaculairesId($resultat);                     break;
                        case 'noms-vernaculaires/id/champ'              : $reponse = $this->formaterNomsVernaculairesIdChamp($resultat);        break;
                        default                                                                 :                                                                                                                                       break;
                }
                return $reponse;
        }

        public function formaterNomsVernaculaires($resultat) {
                //on remplit la table $table_retour_json['entete']
                $table_retour_json['entete']['depart'] = $this->limite_requete['depart'];
                $table_retour_json['entete']['limite'] = $this->limite_requete['limite'];
                $table_retour_json['entete']['total']  = $this->total_resultat;
                $url = $this->formulerUrl($this->total_resultat, '/noms-vernaculaires');
                if (isset($url['precedent']) && $url['precedent'] != '') { $table_retour_json['entete']['href.precedent'] = $url['precedent']; }
                if (isset($url['suivant']) && $url['suivant']   != '') { $table_retour_json['entete']['href.suivant']   = $url['suivant']; }

                //on remplit la table $table_retour_json['resultat']
                if (isset($this->parametres['masque_nv'])) {
                        $resultat = $this->trierRechercheFloue($this->parametres['masque_nv'], $resultat, 'nom_vernaculaire');
                }
                foreach ($resultat as $tab) {
                        foreach ($tab as $key => $valeur) {
                                if ($valeur != '') {
                                        switch ($key) {
                                                case 'id'                               : $num = $valeur;                                                               break;
                                                case 'nom_vernaculaire' : $this->table_retour['nom'] = $valeur;                 break;
                                                default                                 :                                                                                               break;
                                        }
                                }
                        }
                        if ($this->retour_format == 'max') $this->table_retour['href'] = $this->ajouterHref('noms-vernaculaires', $num);
                        $resultat_json[$num] = $this->table_retour;
                        $this->table_retour = array();
                }

                $table_retour_json['resultat'] = $resultat_json;
                return $table_retour_json;
        }
        
        public function formaterEnOss($resultat) {
                $table_nom = array();
                $oss = '';
                foreach ($resultat as $tab) {
                        if (isset($tab['nom_vernaculaire']) ) {
                                if (!in_array($tab['nom_vernaculaire'], $table_nom)) {
                                        $table_nom[] = $tab['nom_vernaculaire'];
                                        $oss [] = $tab['nom_vernaculaire'];
                                }
                        }
                }
                if (isset($this->masque)) $masque = implode('&', $this->masque);
                else $masque = 'Pas de masque';
                $table_retour_oss = array($masque, $oss);
                return $table_retour_oss;
        }

        // formatage de la reponse /id ss la forme
        // id, nom_vernaculaire, attributions
        // langue
        // num_nom (correspond à un taxon bdtfx)
        public function formaterNomsVernaculairesId($resultat) {
                foreach ($resultat as $taxon) { // pour chaque attribution à un taxon bdtfx
                        // on crée les variables qui serviront de clés et on les enléves du tableau
                        $num_nom = $taxon['num_nom_vernaculaire']; // unique pour un trinôme id, langue, taxon
                        unset($taxon['num_nom_vernaculaire']);
                        $langue = $taxon['code_langue'];
                        unset($taxon['code_langue']);

                        foreach ($this->correspondance_champs as $key => $correspondance) { // ordonne les infos pour affichage
                                if (isset($taxon[$key]) && $taxon[$key] != "") {
                                        $this->afficherDonnees($correspondance, $taxon[$key], $langue, $num_nom);
                                }
                        }
                        foreach ($taxon as $key => $valeur) { // rajoute les champs non prévus dans l'api
                                if (!isset($this->correspondance_champs[$key]) && $valeur != "") {
                                        $this->afficherDonnees($key, $valeur, $langue, $num_nom);
                                }
                        }
                        if ($this->retour_format == 'max') $this->chargerBiblio($num_nom, $langue);
                }
                if ($this->retour_format == 'max') $this->afficherTaxons(); // va chercher les noms de tous les taxons
                unset($this->table_retour['href']);
                return $this->table_retour;
        }

        public function afficherDonnees($champ, $valeur, $langue = '', $num_nom = '') {
                if ($champ == 'id' || $champ == 'nom_vernaculaire') {
                        $this->table_retour[$champ] = $valeur;
                } elseif (preg_match('/^(.*)\.code$/', $champ, $match)) {
                                switch ($match[1]) {
                                        case 'taxon'    : if ($this->retour_format == 'max') {$this->taxons[$num_nom] = $valeur;}
                                                $this->afficherPointCode($match[1], $langue, $num_nom, $valeur);        break;
                                        case 'langue'   : //$this->afficherPointCode($match[1], 'iso-639-3', 'langues', $valeur);
                                                break;
                                        case 'genre'    : $this->afficherPointCode($match[1], $langue, $num_nom, $valeur);      break;
                                        case 'conseil_emploi'   : $this->afficherPointCode($match[1], $langue, $num_nom, $valeur);      break;
                                        default : break;
                                }

                } elseif ($langue != '') {
                        $this->table_retour['attributions'][$langue][$num_nom][$champ] = $valeur;
                } else {
                        $this->table_retour[$champ] = $valeur;
                }
        }

        public function afficherPointCode($nomChamp, $langue, $num_nom, $valeur) {
                if (isset($this->champ_infos[$nomChamp])) {
                        extract($this->champ_infos[$nomChamp]);
                }

                if ($this->retour_format == 'max') {
                        $url = $this->ajouterHrefAutreProjet($service, $ressource, $valeur, $projet);
                        if ($service == 'taxons') {
                                $code_valeur = '';
                        } else {
                                $code_valeur = $this->chercherSignificationCode($url, $nom);
                        }
                        if ($projet != '') $projet .= '.';
                        $this->table_retour['attributions'][$langue][$num_nom][$nomChamp] = $code_valeur;
                        $this->table_retour['attributions'][$langue][$num_nom][$nomChamp.'.code'] = $projet.$ressource.$valeur;
                        $this->table_retour['attributions'][$langue][$num_nom][$nomChamp.'.href'] = $url;
                } else {
                        if ($projet != '') $projet .= '.';
                        $this->table_retour['attributions'][$langue][$num_nom][$nomChamp.'.code'] = $projet.$ressource.$valeur;
                }
        }

        public function chercherSignificationCode($url, $nom) {
                if (isset($this->signification_code[$url])) {
                        $valeur = $this->signification_code[$url];
                } else {
                        $res = $this->consulterHref($url);
                        $valeur = $res->$nom;
                        $this->signification_code[$url] = $valeur;
                }
                return $valeur;
        }

        public function afficherTaxons() {
                $url = Config::get('url_service_base').'bdtfx/taxons?navigation.limite=500&masque.nt='.$this->getBdd()->proteger(implode(',', $this->taxons));
                $res = $this->consulterHref($url);
                foreach ($res->resultat as $id=>$taxon) {
                        $resultat[$taxon->num_taxonomique] = $taxon->nom_sci;
                }
                foreach ($this->table_retour['attributions'] as $code_langue=>$langue) {
                        foreach ($langue as $num_nom=>$taxon) {
                                $num_tax = ltrim($taxon['taxon.code'], 'bdtfx.nt:');
                                if (isset($resultat[$num_tax])) {
                                        $this->table_retour['attributions'][$code_langue][$num_nom]['taxon'] = $resultat[$num_tax];
                                }
                        }
                }
        }

        public function formaterNomsVernaculairesIdChamp($resultat) {
                $this->table_retour['id'] = $this->ressources[0];
                $champs = explode(' ', $this->ressources[1]);
                if (in_array('attributions', $champs) != false) {
                        $this->formaterNomsVernaculairesId($resultat);
                        unset($this->table_retour['nom_vernaculaire']);
                } else {//print_r($resultat);
                        $champ_attributions = array('num_taxon', 'zone_usage', 'num_statut', 'num_genre', 'notes');
                        foreach ($resultat as $taxon) {
                                foreach ($taxon as $key=>$valeur) {
                                        if ($key == 'code_langue' && in_array('langue', $champs) != false) {
                                                $this->table_retour['attributions']['langue'][] = $valeur;
                                        } elseif (in_array($key, $champ_attributions) != false) {
                                                $this->afficherPoint($this->correspondance_champs[$key] , $valeur, $taxon['code_langue'], $taxon['num_nom_vernaculaire']);
                                        } elseif (in_array($key, $champs) != false) {
                                                $this->table_retour[$key] = $valeur;
                                        }
                                }
                                if (in_array('biblio', $champs) != false) $this->chargerBiblio($taxon['num_nom_vernaculaire'], $taxon['code_langue']);
                        }
                        if (in_array('biblio', $champs) != false && array_search('biblio.num_ref', $this->table_retour) != false) $this->table_retour['biblio'] = null;
                }
                return $this->table_retour;
        }

        public function afficherPoint($champ, $valeur, $langue, $num_nom) {
                preg_match('/^(.*)\.code$/', $champ, $match);
                $champ = $match[1];
                if (isset($this->champ_infos[$champ])) {
                        extract($this->champ_infos[$champ]);
                        $url = $this->ajouterHrefAutreProjet($service, $ressource, $valeur, $projet);
                        $projet .= '.';
                }

                $champs = explode(' ', $this->ressources[1]);
                if (in_array($champ.'.*', $champs) !== false && isset($projet)) {
                        $this->table_retour['attributions'][$langue][$num_nom][$champ.'.code'] = $projet.$ressource.$valeur;
                        $this->table_retour['attributions'][$langue][$num_nom][$champ.'.href'] = $url;
                }
                if (in_array($champ.'.code', $champs) !== false && isset($projet)) {
                        $this->table_retour['attributions'][$langue][$num_nom][$champ.'.code'] = $projet.$ressource.$valeur;
                }
                if (in_array($champ.'.href', $champs) !== false && isset($projet)) {
                        $this->table_retour['attributions'][$langue][$num_nom][$champ.'.href'] = $url;
                }
                if (in_array($champ, $champs) !== false) {
                        if (isset($url)) {
                                $this->table_retour['attributions'][$langue][$num_nom][$champ] = $this->chercherSignificationCode($url, $nom);
                        } else {
                                $this->table_retour['attributions'][$langue][$champ] = $valeur;
                        }
                }
        }

        public function afficherLangue($nomChamp, $projet, $service, $valeur, $ressource = '', $nom = 'nom') {
                if ($this->retour_format == 'max') {
                                $this->table_retour['attributions'][$nomChamp] = $nom;
                                $this->table_retour['attributions'][$nomChamp.'.code'] = $projet.$ressource.$valeur;
                                $this->table_retour['attributions'][$nomChamp.'.href'] = $url;
                } else {
                        $this->table_retour['attributions'][$nomChamp.'.code'] = $projet.$ressource.$valeur;
                }
        }

        public function chargerBiblio($num_nom, $langue) {
                list($table, $version) = explode('_v',$this->table);
                $requete = "SELECT b.*, lb.notes FROM nvjfl_lien_biblio_v$version lb, nvjfl_biblio_v$version b ".
                                        "WHERE b.num_ref = lb.num_ref AND lb.num_nom = '$num_nom' ;";
                $resultat = $this->getBdd()->recupererTous($requete); //Debug::printr($resultat);

                 if ($resultat == '') { //cas ou la requete comporte des erreurs
                        $r = 'La requête SQL formée comporte une erreur !!';
                        $this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $r);
                        Debug::printr($requete);
                 } elseif ($resultat) {
                        foreach ($resultat as $res) {
                                foreach ($res as $cle => $valeur) {
                                        if ($valeur !== "") {
                                                $this->table_retour['attributions'][$langue][$num_nom]['biblio.'.$cle] = $valeur;
                                        }
                            }
                        }
                }
        }

}
?>