Subversion Repositories eFlore/Projets.eflore-projets

<?php
// declare(encoding='UTF-8');
/**
 * Classe permettant d'obtenir le nom et le code INSEE d'une commune à 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 communes de France métropolitaine (Corse comprise) dont les contours ont été tracés dans OpenStreetMap.
 * Source des données : OpenStreetMap http://wiki.openstreetmap.org
 * Projet France limites administratives : http://wiki.openstreetmap.org/wiki/WikiProject_France/Limites_administratives
 * 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             carto-osm
 * @author              Mohcen BENMOUNAH <mohcen@tela-botanica.org>
 * @author              Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright   Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
 * @license             http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @license             http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 * @version             $Id$
 */
class NomCommune {

        const PATTERN_LAT = '/^[0-9]+(?:[.][0-9]+|)$/';
        const PATTERN_LON = '/^[-]?[0-9]+(?:[.][0-9]+|)$/';
        const LAT_MAX = 51.071667;
        const LAT_MIN = 41.316667;
        const LON_MAX = 9.513333;
        const LON_MIN = -5.140278;
        const MIME_JSON = 'application/json';

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

        private $lat = null;
        private $lon = null;

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

        public function consulter($ressources, $parametres) {
                $this->parametres = $parametres;
                $this->verifierParametres();
                $this->lat = $this->parametres['lat'];
                $this->lon = $this->parametres['lon'];

                $communesProches = $this->trouverCommunesProches();
                $communeTrouveeInfos = $this->localiserPointLatLon($communesProches);
                $corps = $this->formaterResultats($communeTrouveeInfos);

                $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('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 positif dont le séparateur décimal est un point. Ex. : 44 ou 43.03";
                } else if ($lat > self::LAT_MAX) {
                        $messages[] = "La valeur de latitude indiquée est supérieure à {".self::LAT_MAX."} qui est le point le plus au Nord de la France métropolitaine.";
                } else if ($lat < self::LAT_MIN) {
                        $messages[] = "La valeur de latitude indiquée est infèrieure à {".self::LAT_MIN."} qui est le point le plus au Sud de la France métropolitaine.";
                }
                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";
                } else if ($lon > self::LON_MAX) {
                        $messages[] = "La valeur de longitude indiquée est supérieure à {".self::LON_MAX."} qui est le point le plus à l'Est de la France métropolitaine.";
                } else if ($lon < self::LON_MIN) {
                        $messages[] = "La valeur de longitude indiquée est infèrieure à {".self::LON_MIN."} qui est le point le plus à l'Ouest de la France métropolitaine.";
                }
                if (count($messages) != 0) {
                        $message = implode('<br />', $messages);
                        $code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
                        throw new Exception($message, $code);
                }
        }

        /**
         * requête qui récupère les 20 communes les plus proches du point recherché
         * La distance(AB = \sqrt{(x_B-x_A)^2 + (y_B-y_A)^2}) est calculée sans la racine
         * (calcul en plus qui change pas le résultat). La distance n'est donc pas juste mais permet de récupérer
         * le bon ordre.
        */
        private function trouverCommunesProches() {
                $requete =      'SELECT id_osm, '.
                        "(({$this->lon} - X(centre)) * ({$this->lon} -X(centre)) + ({$this->lat} - Y(centre)) * ({$this->lat} - Y(centre))) AS distance ".
                        'FROM osm_communes '.
                        'ORDER BY distance ASC '.
                        'LIMIT 20 '.
                        ' -- '.__FILE__.' : '.__LINE__;
                $resultat = $this->bdd->recupererTous($requete);

                if ($resultat == false) {
                        $msgTpl = "Service '%s' : aucune commune dont le centroïde correspond 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 formaterResultats($communeTrouveeInfos) {
                return array(
                        'nom' => $communeTrouveeInfos['nom'],
                        'codeINSEE' => $communeTrouveeInfos['code_insee'],
                        'wikipedia' => $this->formaterUrlWikipedia($communeTrouveeInfos['wikipedia'])
                );
        }

        private function localiserPointLatLon($communesProches) {
                $zonesIds = array();
                foreach ($communesProches as $commune) {
                        $zonesIds[] = $commune['id_osm'];
                }
                $idsOsmClauseIn = implode(',', $this->bdd->proteger($zonesIds));
                $requete = "SELECT id_osm, code_insee, nom, wikipedia ".
                        'FROM osm_communes '.
                        "WHERE st_within(GEOMFROMTEXT('POINT($this->lon $this->lat)'), polygone) = 1 ".
                        "AND id_osm IN ($idsOsmClauseIn) ".
                        ' -- '.__FILE__.' : '.__LINE__;
                $resultat = $this->bdd->recuperer($requete);
                if ($resultat === false) {
                        $msgTpl = "Service '%s' : aucune commune 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 formaterUrlWikipedia($infoWikipedia) {
                list($lang, $page) = explode(':', $infoWikipedia);
                $pageEncode = rawurlencode($page);
                $urlTpl = 'https://%s.wikipedia.org/wiki/%s';
                return sprintf($urlTpl, $lang, $pageEncode);
        }
}