Subversion Repositories eFlore/Applications.del

<?php
// declare(encoding='UTF-8');
/**
 * Classe principale de chargement des sous-services "images" de DEL.
 *
 * Cette classe se charge toujours de :
 *  - vérifier l'existance des ressources (services) demandés
 *  - vérifier la cohérence et le format des paramêtres passées dans l'url
 * En fonction, de la compléxité du service, elle peut :
 *  - dans un premier temps, exécuter directement les actions : consulter, ajouter, modifier, supprimer.
 *  - dans un second temps, charger dynamiquement d'éventuelles sous-classes du service en fonction des ressources présentes dans l'URL.
 *
 * URLs possibles :
 * GET :
 * http://localhost/del/services/0.1/images/ => toutes les images : classe ListeImages
 * http://localhost/del/services/0.1/images/#idImg/votes => tous les votes d'une image (#idImg) classés par protocole : classe VotesImage
 *
 * Non Implémenté : http://localhost/del/services/0.1/images/#id => une image donnée => en test pour remplacer les appels à eflore/cel
 * Non Implémenté : http://localhost/del/services/0.1/images/#id/votes?protocole=#id => tous les votes d'une image et d'un protocole donné
 *
 * PUT :
 * http://localhost/del/services/0.1/images/#idImg => ajouter un vote sur une image donnée (#idImg)
 *
 * POST :
 * http://localhost/del/services/0.1/images/#idImg => modifier un vote sur une image donnée (#idImg)
 *
 * DELETE :
 * http://localhost/del/services/0.1/images/#idImg => supprimer une image donnée (#idImg)
 * http://localhost/del/services/0.1/images/#idImg/votes/#idVote => supprimer un vote (#idVote) d'une image donnée (#idImg)
 *
 * @category   DEL
 * @package    Services
 * @subpackage Images
 * @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>
 */
restore_error_handler();
restore_exception_handler();
error_reporting(E_ALL);

class Images extends RestService {

        private $conteneur;
        private $cheminCourant;
        private $parametres = array();
        private $ressources = array();
        private $methode;
        private $serviceNom = 'images';
        private $sousServiceNom;

        /** Indique si oui (true) ou non (false), on veut utiliser les paramètres bruts. */
        protected $utilisationParametresBruts = true;

        public function __construct() {
                $this->conteneur = new Conteneur();
                $this->cheminCourant = dirname(__FILE__).DS;
        }

        public function consulter($ressources, $parametres) {
                $this->methode = 'consulter';
                $this->initialiserRessourcesEtParametres($ressources, $parametres);
                return $this->executerService();
        }

        public function ajouter($ressources, $requeteDonnees) {
                $this->methode = 'ajouter';
                $this->initialiserRessourcesEtParametres($ressources, $requeteDonnees);
                return $this->executerService();
        }

        public function modifier($ressources, $requeteDonnees) {
                $this->methode = 'modifier';
                $this->initialiserRessourcesEtParametres($ressources, $requeteDonnees);
                return $this->executerService();
        }

        public function supprimer($ressources) {
                $this->methode = 'supprimer';
                $this->initialiserRessourcesEtParametres($ressources);
                return $this->executerService();
        }

        private function initialiserRessourcesEtParametres($ressources, $parametres = array()) {
                $this->ressources = $ressources;
                $this->parametres = $parametres;
        }

        private function executerService() {
                $resultat = $this->traiterRessources();
                if ($resultat === true || $resultat === false) {
                        return $resultat;
                }

                $reponseHttp = new ReponseHttp();
                $reponseHttp->setResultatService($resultat);
                $reponseHttp->emettreLesEntetes();
                return $reponseHttp->getCorps();
        }

        private function traiterRessources() {
                $this->analyserRessources();
                $retour = $this->initialiserService();
                return $retour;
        }

        private function analyserRessources() {
                if ($this->methode == 'consulter') {
                        $this->analyserRessoucesConsultation();
                } else if ($this->methode == 'modifier' || $this->methode == 'ajouter') {
                        $this->analyserRessoucesModification();
                } else if ($this->methode == 'supprimer') {
                        $this->analyserRessoucesSuppression();
                }
                if ($this->sousServiceNom == null) {
                        $this->lancerMessageErreurRessource();
                }
        }

        private function analyserRessoucesConsultation() {
                if (count($this->ressources) == 0) {
                        $this->sousServiceNom = 'liste-images';
                } else if (count($this->ressources) == 2) {
                        if ($this->etreRessourceIdentifiant(0) && $this->verifierRessourceValeur(1, 'votes')) {
                                $this->sousServiceNom = 'votes-image';
                        }
                }
        }

        private function analyserRessoucesModification() {
                if (count($this->ressources) == 2) {
                        if ($this->etreRessourceIdentifiant(0) && $this->verifierRessourceValeur(1, 'votes')) {
                                $this->sousServiceNom = 'votes-image';
                        }
                }
        }

        private function analyserRessoucesSuppression() {
                if (count($this->ressources) == 1 && $this->etreRessourceIdentifiant(0)) {
                        $this->sousServiceNom = 'liste-images';
                } else if (count($this->ressources) == 3) {
                        if ($this->etreRessourceIdentifiant(0) && $this->verifierRessourceValeur(1, 'votes') && $this->etreRessourceIdentifiant(2) ) {
                                $this->sousServiceNom = 'votes-image';
                        }
                }
        }

        private function etreRessourceIdentifiant($num) {
                $presenceId = false;
                if (isset($this->ressources[$num]) && is_numeric($this->ressources[$num])) {
                        $presenceId = true;
                }
                return $presenceId;
        }

        private function verifierRessourceValeur($num, $valeur) {
                $ok = false;
                if (isset($this->ressources[$num]) && $this->ressources[$num] == $valeur) {
                        $ok = true;
                }
                return $ok;
        }

        private function lancerMessageErreurRessource() {
                $ressource = $this->sousServiceNom.'/'.implode('/', $this->ressources);
                $message = "La ressource demandée '$ressource' ".
                        "n'est pas disponible pour le service ".$this->serviceNom." !\n".
                        $this->getDoc();
                $code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
                throw new Exception($message, $code);
        }

        public function getDoc() {
                return "Les URLs disponibles sont : \n".
                        " * en GET : \n".
                        "  - images => toutes les images\n".
                        "  - images/#idImg/votes => tous les votes d'une image (#idImg) classés par protocole\n".
                        " * en PUT : \n".
                        "  - /images/#idImg/votes => ajouter un vote sur une image donnée (#idImg)\n".
                        " * en POST : \n".
                        "  - /images/#idImg/votes => modifier un vote sur une image donnée (#idImg)\n".
                        " * en DELETE : \n".
                        "  - /images/#idImg => supprimer une image donnée (#idImg)\n".
                        "  - /images/#idImg/votes/#idVote => supprimer un vote (#idVote) d'une image donnée (#idImg)";
        }

        private function initialiserService() {
                $classe = $this->obtenirNomClasseService($this->sousServiceNom);
                $chemins = array();
                $chemins[] = $this->cheminCourant.$this->serviceNom.DS.$classe.'.php';
                $chemins[] = $this->cheminCourant.'commun'.DS.$classe.'.php';
                $retour = '';
                $service = null;
                foreach ($chemins as $chemin) {
                        if (file_exists($chemin)) {
                                require_once $chemin;
                                $service = new $classe($this->conteneur);
                                if ($this->methode == 'consulter') {
                                        $retour = $service->consulter($this->ressources, $this->parametres);
                                } elseif ($this->methode == 'ajouter') {
                                        $retour = $service->ajouter($this->ressources, $this->parametres);
                                } elseif ($this->methode == 'modifier') {
                                        $retour = $service->modifier($this->ressources, $this->parametres);
                                } elseif ($this->methode == 'supprimer') {
                                        $retour = $service->supprimer($this->ressources);
                                }
                        }
                }

                if (is_null($service)) {
                        $ressource = implode('/', $this->ressources);
                        $msg = "Le classe '$classe' correspondant à la ressource '$ressource' ".
                                "n'existe pas dans le service '{$this->serviceNom}' !\n".$this->getDoc();
                        throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
                }
                return $retour;
        }

        private function obtenirNomClasseService($mot) {
                $classeNom = str_replace(' ', '', ucwords(strtolower(str_replace('-', ' ', $mot))));
                return $classeNom;
        }
}