Subversion Repositories eFlore/Applications.cel

<?php
// declare(encoding='UTF-8');
/**
 * Classe mère permettant de rassembler les manipulation concernant les mots clés.
 * Pour l'utiliser, il suffit d'étendre votre service avec cette classe à la place de Cel.
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 *
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @author Aurélien 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>
 * @version $Id$
 * @copyright © 2011, Tela-Botanica
 */
// TODO : compléter la classe avec des méthdodes de modification, suppression et consultation des mots-clés.
// TODO : ajout vérification de la non présence du caractère '|' dans les chaines utilisateurs...
class CelMotCle extends Cel {
        const OBS_RACINE_ID = 'racine_obs';
        const OBS_RACINE_NOM = 'Projets';
        const OBS_TABLE_SUFFIXE = '_obs';
        const IMG_RACINE_ID = 'racine';
        const IMG_RACINE_NOM = 'Mots clés';
        const IMG_TABLE_SUFFIXE = '_images';
        
        /**
         * @var String permet de savoir si nous avons à faire à un mot clé d'observation ou d'image.
         */
        private $suffix = '';
        
        /**
         * @var String identifiant de l'utilisateur dont nous gérons les mots-clés.
         */
        private $utilisateur_id = '';
        
        public function ajouterMotCleObs($utilisateur_id, $mot_cle, $mot_cle_id, $mot_cle_parent_id) {
                $this->suffix = self::OBS_TABLE_SUFFIXE;
                $this->utilisateur_id = $utilisateur_id;
                $this->ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id);
        }
        
        public function ajouterMotCleImg($utilisateur_id, $mot_cle, $mot_cle_id, $mot_cle_parent_id) {
                $this->suffix = self::IMG_TABLE_SUFFIXE;
                $this->utilisateur_id = $utilisateur_id;
                $this->ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id);
        }
        
        private function ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id) {
                $this->ajouterMotCleRacine();
                $this->commencerTransaction();

                $bornes = $this->retrouverBornesEtNiveau($mot_cle_parent_id);
                $borne_pere = $bornes['cmc_bd'];
                $niveau = $bornes['cmc_niveau'] + 1;
                $bg = $bornes['cmc_bd'];
                $bd = $bg + 1;
                $mot_cle_encode = $this->encoderMotCle($mot_cle);
                
                $transaction_reussie_1 = $this->decalerBornesPlusDeux($borne_pere) ? true : false;
                
                $requete =      "INSERT INTO  cel_mots_cles{$this->suffix} ".
                                        "VALUES ( |$mot_cle_protege|, $bg, $bd, |$mot_cle_encode|, |$mot_cle_id|, ". 
                                        "       |{$this->utilisateur_id}|, |$mot_cle_parent_id|, $niveau) ";
                $transaction_reussie_2 = $this->executerSQL($requete);

                if ($transaction_reussie_1 && $transaction_reussie_2) {
                        $this->completerTransaction();
                        echo 'OK';
                } else {
                        $this->annulerTransaction();
                }
        }
                
        private function ajouterMotCleRacine() {
                $nbre_mots_cles = $this->compterMotsCles();
                if ($nbre_mots_cles) {
                        switch ($this->suffix) {
                                case self::OBS_TABLE_SUFFIXE :
                                        $nom_racine = self::OBS_RACINE_NOM;
                                        $id_racine = self::OBS_RACINE_ID;
                                        break;
                                case self::IMG_TABLE_SUFFIXE :
                                        $nom_racine = self::IMG_RACINE_NOM;
                                        $id_racine = self::IMG_RACINE_ID;
                                        break;
                                default:
                                        $nom_racine = $this->suffix;
                                        $id_racine = $this->suffix;
                        }

                        if ($nbre_mots_cles == 0) {
                                $requete =      "INSERT INTO cel_mots_cles{$this->suffix} ".
                                                        "VALUES (|$nom_racine|, 1, 2, |$id_racine|, |$id_racine|, |{$this->utilisateur_id}|, '', 0) ";
                                $this->executerSQL($requete);
                        }
                }
        }
        
        private function compterMotsCles() {
                $nbre = false;
                $requete =      'SELECT COUNT(*) AS nbre '.
                                        "FROM cel_mots_cles{$this->suffix} ".
                                        "WHERE cmc_id_proprietaire = |{$this->utilisateur_id}| ";
                $resultat = $this->recupererResultat($requete);

                if ($resultat) {
                        $nbre = $resultat['nbre'];
                }
                return $nbre;
        }
        
        /**
         * Désactive l'auto-commit puis débute la transaction
         */
        private function commencerTransaction() {
                // Désactive l'autocommit le temps de la manipulation de l'arbre
                $requete = 'SET AUTOCOMMIT = 0 ';
                $reussite_autocommit = $this->executerSQL($requete);

                // Débute une nouvelle transaction
                $requete = 'BEGIN ';
                $reussite_begin = $this->executerSQL($requete);
        }

        /**
         * Termine la transaction puis réactive l'auto-commit
         */
        private function completerTransaction() {
                // Complète la transaction
                $requete = 'COMMIT ';
                $reussite_commit = $this->executerSQL($requete);

                // Réactive l'autocommit le temps de la manipulation de l'arbre
                $requete = 'SET AUTOCOMMIT = 1 ';
                $reussite_autocommit = $this->executerSQL($requete);

                echo 'OK';
        }
        
        /**
         * Annule la transaction et réactive l'auto-commit
         */
        private function annulerTransaction() {
                // Annule la transaction
                $requete = 'ROLLBACK ';
                $reussite_rollback = $this->executerSQL($requete);

                // Réactive l'autocommit le temps de la manipulation de l'arbre
                $requete = 'SET AUTOCOMMIT = 1 ';
                $reussite_autocommit = $this->executerSQL($requete);

                echo 'ERROR';
        }

        /** 
         * Renvoie les bornes d'un noeud de l'arbre des mots clés
         */
        private function retrouverBornesEtNiveau($mot_cle_id) {
                $requete =      'SELECT cmc_bd, cmc_bg, cmc_niveau '.
                                        "FROM cel_mots_cles{$this->suffix} ".
                                        "WHERE cmc_id_mot_cle_utilisateur = |$mot_cle_id| ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $resultat = $this->recupererResultat($requete);
                return $resultat;
        }

        /**
         * Décale les bornes de deux pour insérer un nouvel élément
         */ 
        private function decalerBornesPlusDeux($valeur) {
                // Décalage borne droite
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        'SET cmc_bd = cmc_bd + 2 '.
                                        "WHERE cmc_bd >= $valeur ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_1 = $this->executerSQL($requete);
                
                // Décalage borne gauche
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        'SET cmc_bg = cmc_bg + 2 '.
                                        "WHERE cmc_bg >= $valeur ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_2 = $this->executerSQL($requete);
                
                return $reussi_1 && $reussi_2;
        }

        /**
         * Décale les bornes d'un intervalle négatif donné (pour la suppression d'un sous arbre).
         */
        private function decalerBornesMoinsIntervalle($bg, $bd) {
                $decalage = $bd - $bg + 1;
                
                // Décalage borne droite
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bd = cmc_bd - $decalage ".
                                        "WHERE cmc_bd >= $bg ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_1 = $this->executerSQL($requete);

                // Décalage borne gauche
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bg = cmc_bg - $decalage ".
                                        "WHERE cmc_bg > $bg ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_2 = $this->executerSQL($requete);
                
                return $reussi_1 && $reussi_2;
        }

        /**
         * Décale à droite des bornes donées d'un intervalle positif donné (pour l'ajout d'un sous arbre).
         */ 
        private function decalerBornesPlusIntervalle($valeur_bornes, $largeur) {
                // Décalage borne droite
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bd = cmc_bd + $largeur ".
                                        "WHERE cmc_bd >= $valeur_bornes ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_1 = $this->executerSQL($requete);

                // Décalage borne gauche
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bg = cmc_bg + $largeur ".
                                        "WHERE cmc_bg >= $valeur_bornes ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                $reussi_2 = $this->executerSQL($requete);

                return $reussi_1 && $reussi_2;
        }

        /**
         * Inverse les bornes d'un intervalle pour l'exclure des modifications sur l'arbre sans changer la hiérarchie.
         */
        private function exclureIntervalle($bg, $bd) {
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bd = cmc_bd - $bd - 1 , ".
                                        "       cmc_bg =  cmc_bg - $bd - 1 ".
                                        "WHERE cmc_bd <= $bd ".
                                        "       AND cmc_bg >= $bg ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                return $this->executerSQL($requete);
        }

        /** 
         * Recale les bornes dun intervalle pour l'inclure dans l'arbre à la bonne place.
         * Décalage borne droite
         */
        private function inclureIntervalle($bg, $bd, $largeur, $modif_niveau) {
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_bg =  cmc_bg + $largeur , ".
                                        "       cmc_bd = cmc_bd + $largeur, ".
                                        "       cmc_niveau = cmc_niveau + $modif_niveau ".
                                        "WHERE cmc_bg >=  $bg ".
                                        "       AND cmc_bd <=  $bd ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";

                return $this->executerSQL($requete);
        }

        private function changerPere($mot_cle_id, $id_pere) {
                $requete =      "UPDATE cel_mots_cles{$this->suffix} ".
                                        "SET cmc_id_parent = |$id_pere| ".
                                        "WHERE cmc_id_mot_cle_utilisateur = |$mot_cle_id| ".
                                        "       AND cmc_id_proprietaire = |{$this->id_utilisateur}| ";
                
                return $this->executerSQL($requete);
        }
        
        private function executerSQL($requete) {
                $execution = $this->executer($requete);
                $execution = $execution ? true : false;
                return $execution;
        }
        
        private function recupererResultat($requete) {
                $resultat = $this->requeter($requete, Cel::SQL_RETOUR_LIGNE, Cel::SQL_MODE_ASSOC);
                return $resultat;
        }
        
        private function verifierLignesAffectees($requete) {
                $execution = $this->executer($requete);
                return $execution;
        }
}
?>