Subversion Repositories eFlore/Projets.eflore-projets

<?php
// declare(encoding='UTF-8');
/**
 * Classe permettant d'obtenir le nom et les codes d'une zone administrative à partir de ces coordonnées (latitude et longitude).
 * La latitude et longitude doivent être exprimée par un nombre décimal.
 * Ce service fonctionne uniquement pour les zones administratives dont les contours ont été tracés dans OpenStreetMap.
 * Source des données : OpenStreetMap <http://wiki.openstreetmap.org>
 * Tag:boundary=administrative : <http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative>
 * Paramètres du service :
 *  - lat : latitude
 *  - lon : longitude
 * Exemple :
 * http://localhost/service-test:eflore:0.1/osm/nom-commune?lon=3.83619&lat=44.74231
 *
 * @category    php 5.2
 * @package             eFlore
 * @subpackage  Services
 * @author              Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @author              Mohcen BENMOUNAH <mohcen@tela-botanica.org>
 * @copyright   Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
 * @license             CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt>
 * @license             GNU-GPL <http://www.gnu.org/licenses/gpl.html>
 */
class ZoneADmin {

        const PATTERN_LAT = '/^[-]?[0-9]+(?:[.][0-9]+|)$/';
        const PATTERN_LON = '/^[-]?[0-9]+(?:[.][0-9]+|)$/';
        const MIME_JSON = 'application/json';

        private $parametres = array();
        private $bdd = null;

        private $lat = null;
        private $lon = null;
        private $zone = null;
        private $niveaux = null;
        private $pays = null;
        
        private $masque = null;
        private $limite = 1;

        public function __construct(Bdd $bdd) {
                $this->bdd = $bdd;
        }

        public function consulter($ressources, $parametres) {
                $this->parametres = $parametres;
                $this->verifierParametres();
                $this->masque = isset($this->parametres['masque']) ? $this->parametres['masque'] : null;
                $this->limite = isset($this->parametres['limite']) ? intval($this->parametres['limite']) : $this->limite;
                $this->lat = isset($this->parametres['lat']) ? $this->parametres['lat'] : null;
                $this->lon = isset($this->parametres['lon']) ? $this->parametres['lon'] : null;
                $this->zone = isset($this->parametres['zone']) ? $this->parametres['zone'] : null;
                $this->niveaux = isset($this->parametres['niveau']) ? explode(',', $this->parametres['niveau']) : null;
                $this->pays = isset($this->parametres['pays']) ? $this->parametres['pays'] : null;
                
                if($this->masque != null) {
                        $corps = $this->rechercherZoneGeoParNom($this->masque, $this->niveaux, $this->limite, $this->pays);
                } else {
                        $zoneTrouveeInfos = $this->localiserPointLatLon();
                        $corps = $this->formaterResultats($zoneTrouveeInfos);
                }

                $resultat = new ResultatService();
                $resultat->mime = self::MIME_JSON;
                $resultat->corps = $corps;
                return $resultat;
        }

        private function verifierParametres() {
                extract($this->parametres);
                $messages = array();
                
                if(array_key_exists('masque', $this->parametres)) {
                        if (empty($masque)) {
                                $messages[] = "S'il est présent le paramètre recherche ne peut pas être vide";
                        }
                } else {        
                        if (! array_key_exists('lat', $this->parametres)) {
                                $messages[] = "Vous devez indiquer une latitude en degré décimal à l'aide du paramètres d'url : lat";
                        } else if (!preg_match(self::PATTERN_LAT, $lat)) {
                                $messages[] = "La valeur de latitude doit être un nombre décimal dont le séparateur décimal est un point. Ex. : 44 ou 43.03";
                        }
                        if (! array_key_exists('lon', $this->parametres)) {
                                $messages[] = "Vous devez indiquer une longitude en degré décimal à l'aide du paramètres d'url : lon";
                        } else if (!preg_match(self::PATTERN_LON, $lon)) {
                                $messages[] = "La valeur de longitude doit être un nombre décimal dont le séparateur décimal est un point. Ex. : -4.03 ou 3.256";
                        }
                }
                if (count($messages) != 0) {
                        $message = implode('<br />', $messages);
                        $code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
                        throw new Exception($message, $code);
                }
        }

        private function formaterResultats($zonesTrouveesInfos) {
                $retour = array();
                foreach ($zonesTrouveesInfos as $infos) {
                        $donnees = array();
                        foreach ($infos as $champ => $valeur) {
                                if ($valeur != '' && $champ != 'niveau') {
                                        if ($champ == 'wikipedia') {
                                                $valeur = $this->formaterUrlWikipedia($valeur);
                                        }
                                        $donnees[$champ] = $valeur;
                                }
                        }
                        $retour[$infos['niveau']] = $donnees;
                }
                ksort($retour);
                return $retour;
        }

        private function localiserPointLatLon() {
                $osmIdsInClause = $this->getOsmIdsDesCentresAProximites();
                $zone = isset($this->zone) ? $this->bdd->proteger($this->zone) : null;

                $requete = 'SELECT id_zone_geo AS codeZoneGeo, intitule, code_iso_3166_1 AS codeIso31661, '.
                        'code_iso_3166_2 AS codeIso31662, code_insee AS codeInsee, code_nuts as codeNuts, '.
                        'nom_en AS nomEn, nom_es AS nomEs, wikipedia, niveau '.
                        'FROM osm_zones_admin '.
                        "WHERE st_within(GEOMFROMTEXT('POINT($this->lon $this->lat)'), polygone) = 1 ".
                        (isset($zone) ? "AND zone = $zone " : '').
                        "AND osm_id IN ($osmIdsInClause) ".
                        ' -- '.__FILE__.' : '.__LINE__;
                
                $resultat = $this->bdd->recupererTous($requete);
                if ($resultat === false) {
                        $msgTpl = "Service '%s' : aucune zone correspondant aux coordonnées : %s, %s.";
                        $msg = sprintf($msgTpl, get_class($this), $this->lat, $this->lon);
                        throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
                }
                return $resultat;
        }

        private function getOsmIdsDesCentresAProximites() {
                $requete = $this->construireRequeteUnion();
                $resultats = $this->bdd->recupererTous($requete);
                if ($resultats === false) {
                        $msgTpl = "Service '%s' : aucun centroïde correspondant aux coordonnées : %s, %s.";
                        $msg = sprintf($msgTpl, get_class($this), $this->lat, $this->lon);
                        throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
                }
                $osmIds = array();
                foreach ($resultats as $info) {
                        $osmIds[] = $info['osm_id'];
                }
                $osmIdsInClause = implode(',', $this->bdd->proteger($osmIds));
                return $osmIdsInClause;
        }

        private function construireRequeteUnion() {
                $zone = isset($this->zone) ? $this->bdd->proteger($this->zone) : null;
                $niveaux = isset($this->niveaux) ? $this->niveaux : null;
                
                $requeteTpl = 'SELECT osm_id, '.
                        "(($this->lon - centre_lng) * ($this->lon -centre_lng) + ($this->lat - centre_lat) * ($this->lat - centre_lat)) AS distance ".
                        'FROM osm_zones_admin '.
                        'WHERE niveau = %s '.
                        (isset($zone) ? "AND zone = $zone " : '').
                        'ORDER BY distance ASC '.
                        "LIMIT %s ";
                $niveaux = isset($niveaux) ? $niveaux : array(2,3,4,5,6,7,8);
                $requetesAUnir = array();
                foreach ($niveaux as $niveau) {
                        $requetesAUnir[] = sprintf($requeteTpl, $this->bdd->proteger($niveau), ($niveau * 2));
                }
                $requete = '('.implode(') UNION (', $requetesAUnir).') -- '.__FILE__.' : '.__LINE__;
                return $requete;
        }

        private function formaterUrlWikipedia($infoWikipedia) {
                list($lang, $page) = explode(':', $infoWikipedia);
                $pageEncode = rawurlencode($page);
                $urlTpl = 'https://%s.wikipedia.org/wiki/%s';
                return sprintf($urlTpl, $lang, $pageEncode);
        }
        
        public function rechercherZoneGeoParNom($masque, $niveaux = null, $limite = 1, $pays = null) {
                $masque_fmt = str_replace(array(' ', '-'), '_', $masque);
                // Cas d'une recherche pour autocompletion
                $masque_fmt = ($limite > 1) ? $masque_fmt.'%' : $masque_fmt;
                
                $champs = 'id_zone_geo, osm_id, intitule, centre_lat, centre_lng, '.
                                        'zone, niveau, code_iso_3166_1 AS codeIso31661, code_iso_3166_2 AS codeIso31662, code_insee, '.
                                        'nom, nom_fr, nom_en, nom_es, wikipedia';
                
                $champs_tri = 'IF(ISNULL(nom_fr), 0, 1) as nom_fr_present, '.
                                'IF(ISNULL(nom_en), 0, 1) as nom_en_present, '.
                                'IF(ISNULL(nom_es), 0, 1) as nom_es_present, '.
                                'IF(ISNULL(intitule), 0, 1) as intitule_present, '.
                                'IF(ISNULL(nom), 0, 1) as nom_present, '.
                                'IF(zone = "north-america", 0, 1) as hors_amerique_du_nord ';
                
                // les US ont beaucoup de villes qui possèdent des noms similaires 
                // à des villes européennes, ce qui entraine beaucoup de résultats vers les US
                // au lieu de la ville originelle, on les "déclasse" donc artificiellement
                $ordre = 'hors_amerique_du_nord DESC, niveau DESC, nom_present DESC, nom_fr_present DESC, nom_fr_present DESC, '.
                                 'nom_es_present DESC, intitule_present DESC';
                
                $niveau_str = array();
                if($niveaux != null) {
                        foreach ($niveaux as $niveau) {
                                $niveau_str[] = $this->bdd->proteger($niveau);
                        }
                }

                if($pays != null) {
                        // Si le pays correspond, on fait remonter le résultat
                        $champs_tri .= ', IF(code_iso_3166_1 = ' . $this->bdd->proteger($pays)
                                . ' OR  ' . 'code_iso_3166_2 LIKE ' . $this->bdd->proteger($pays."%") . ', 1, 0) as pays_correspond ';
                        $ordre = 'pays_correspond DESC, ' . $ordre;
                }
                
                $requete = "SELECT $champs, $champs_tri FROM osm_zones_admin ".
                                        "WHERE ".
                                                (!empty($niveau_str) ? ("niveau IN (".implode(',', $niveau_str).") AND ") : "").
                                                "(nom LIKE ".$this->bdd->proteger($masque_fmt).' OR '.
                                                "intitule LIKE ".$this->bdd->proteger($masque_fmt).' OR '.
                                                "nom_fr LIKE ".$this->bdd->proteger($masque_fmt).' OR '.
                                                "nom_en LIKE ".$this->bdd->proteger($masque_fmt).' OR '.
                                                "nom_es LIKE ".$this->bdd->proteger($masque_fmt).') '.  
                        "ORDER BY ".$ordre." LIMIT ".$limite;

                $resultat = $this->bdd->recupererTous($requete);
                if (empty($resultat)) {
                        $msgTpl = "Service '%s' : aucune zone correspondant au nom : %s .";
                        $msg = sprintf($msgTpl, get_class($this), $masque);
                        throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
                } else {
                        $resultat = ($limite == 1) ? $resultat[0] : $resultat;
                }
                
                return $resultat;
        }
}