Subversion Repositories eFlore/Applications.cel

Compare Revisions

Ignore whitespace Rev 1546 → Rev 1547

/branches/v1.6-croc/jrest/services/CelMotCle.php
New file
0,0 → 1,550
<?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';
 
const SEPARATEUR_MOT_CLE_TEXTE = ',';
const SEPARATEUR_MOT_CLE_ID_OBS = ',';
const SEPARATEUR_MOT_CLE_ID_IMG = ',';
 
/**
* @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 lierMotCleObs($utilisateur_id, Array $mots_cles_ids, Array $ids) {
$this->suffix = self::OBS_TABLE_SUFFIXE;
$this->utilisateur_id = $utilisateur_id;
return $this->lierMotCle($utilisateur_id, $mots_cles_ids, $ids);
}
public function lierMotCleImg($utilisateur_id, Array $mots_cles_ids, Array $ids) {
$this->suffix = self::IMG_TABLE_SUFFIXE;
$this->utilisateur_id = $utilisateur_id;
return $this->lierMotCle($utilisateur_id, $mots_cles_ids, $ids);
}
/**
* Lie un mot-clé à une ou plusieurs images ou obs suivant le suffixe en cours.
*
* @param String $utilisateur_id identifiant de l'utilisateur.
* @param Array $mots_cles_ids tableau d'ids des mot-clé.
* @param Array $ids un tableau d'ids d'obs ou img (int) qui seront associées aux mots clés.
*/
public function lierMotCle($utilisateur_id, Array $mots_cles_ids, Array $ids) {
$retour = false;
 
if ($this->contenirNbresEntiers($ids)) {
$champ_objet_lie = ($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'id_observation' : 'id_image';
$champ_mot_cle = ($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'id_mot_cle_obs' : 'id_mot_cle_image';
 
// le mot clé ignore est spécifique mysql, mais il est utilisé ici pour des raisons
// de performance, à remplacer par un test sur les mots clés déjà existant si ça gène
$requete = "INSERT IGNORE INTO cel{$this->suffix}_mots_cles ".
'('.$champ_objet_lie.', '.$champ_mot_cle.') '.
'VALUES ';
foreach($ids as $id) {
foreach($mots_cles_ids as $mot) {
$requete .= '('.$id.','.$this->proteger($mot).'),';
}
}
$requete = rtrim($requete,',');
$resultat = $this->executer($requete);
// J'en suis ici
if ($resultat) {
$retour = true;
foreach ($ids as $id) {
$regeneration = $this->regenererIndexTexteMotCle($id);
if ($regeneration === false) {
$retour = false;
}
}
} else {
$e = "Erreur de mise à jour des mots clés d'une obs : $requete";
$this->logger('CEL_bugs', $e);
$this->messages[] = $e;
}
} else {
$this->messages[] = "Le tableau des ordres des obs ne contenait pas que des nombres entiers.";
}
return $retour;
}
 
private function contenirNbresEntiers($ordres) {
$ok = true;
foreach ($ordres as $ordre) {
if (! preg_match('/^[0-9]+$/', $ordre)) {
$this->debug[] = "Ordre pb : $ordre";
$ok = false;
}
}
return $ok;
}
 
private function regenererIndexTexteMotCle($id) {
$ok = false;
$mots_cles = $this->obtenirMotsClesTexte($id);
$mots_cles_concatenes = $this->concatenerMotsCles($mots_cles);
$ok = $this->mettreAJourMotsClesConcatenes($mots_cles_concatenes, $id);
return $ok;
}
 
private function obtenirMotsClesTexte($id_image_ou_obs) {
$requete = 'SELECT mot_cle '.
'FROM '.'cel_mots_cles'.$this->suffix.' '.
'WHERE id_mot_cle_'.(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image').' IN '.
'('.
'SELECT id_mot_cle_'.(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image').' '.
'FROM cel'.$this->suffix.'_mots_cles '.
'WHERE '.(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'id_observation' : 'id_image').' = '.$this->proteger($id_image_ou_obs).
')';
 
$resultats = $this->requeter($requete);
return $resultats;
}
 
private function formaterIdsMotClePourClauseInSql($mot_cle_ids) {
$mot_cle_ids = $this->nettoyerMotsCles($mot_cle_ids);
$mot_cle_ids = str_replace(self::SEPARATEUR_MOT_CLE_ID_OBS, ',', $mot_cle_ids);
$mot_cle_ids = trim($mot_cle_ids, ',');
$mot_cle_ids_proteges = implode(',', $this->protegerTableau(explode(',', $mot_cle_ids)));
return $mot_cle_ids_proteges;
}
 
private function concatenerMotsCles(Array $mots_cles) {
$mot_cles_concatenes = '';
if (count($mots_cles) > 0) {
foreach ($mots_cles as $mot_cle) {
$mot_cles_concatenes .= $mot_cle['mot_cle'].self::SEPARATEUR_MOT_CLE_TEXTE;
}
}
$mot_cles_concatenes = rtrim($mot_cles_concatenes, self::SEPARATEUR_MOT_CLE_TEXTE);
return $mot_cles_concatenes;
}
 
private function mettreAJourMotsClesConcatenes($mots_cles, $id) {
$mots_cles = $this->proteger($mots_cles);
$utilisateur_id = $this->proteger($this->utilisateur_id);
 
$requete = 'UPDATE cel'.$this->suffix." ".
"SET mots_cles_texte = $mots_cles ".
"WHERE id_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'observation' : 'image')." = $id ";
 
$ok = $this->executer($requete) ? true : false;
return $ok;
}
 
 
private function nettoyerMotsCles($chaine) {
$valeur = str_replace('null', '', $chaine);
$valeur = trim($valeur, ';;');
 
return $valeur;
}
 
public function ajouterMotCleObs($utilisateur_id, $mot_cle, $mot_cle_parent_id) {
$this->suffix = self::OBS_TABLE_SUFFIXE;
$this->utilisateur_id = $utilisateur_id;
return $this->ajouterMotCle($mot_cle, $mot_cle_parent_id);
}
 
public function ajouterMotCleImg($utilisateur_id, $mot_cle, $mot_cle_parent_id) {
$this->suffix = self::IMG_TABLE_SUFFIXE;
$this->utilisateur_id = $utilisateur_id;
return $this->ajouterMotCle($mot_cle, $mot_cle_parent_id);
}
 
private function ajouterMotCle($mot_cle, $mot_cle_parent_id) {
$retour = true;
$this->ajouterMotCleRacine();
if ($this->verifierAbsence($mot_cle, $mot_cle_parent_id)) {
$mot_cle_id = $this->genererTagId($mot_cle);
 
$this->commencerTransaction();
 
$bornes = $this->retrouverBornesEtNiveau($mot_cle_parent_id);
$borne_pere = $bornes['bd'];
$niveau = $bornes['niveau'] + 1;
$bg = $bornes['bd'];
$bd = $bg + 1;
$mot_cle_encode = $this->encoderMotCle($mot_cle);
 
$mot_cle_protege = $this->proteger($mot_cle);
$bg = $this->proteger($bg);
$bd = $this->proteger($bd);
$mot_cle_encode = $this->proteger($mot_cle_encode);
$mot_cle_id = $this->proteger($mot_cle_id);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$mot_cle_parent_id_protege = $this->proteger($mot_cle_parent_id);
$niveau = $this->proteger($niveau);
 
$transaction_reussie_1 = $this->decalerBornesPlusDeux($borne_pere) ? true : false;
 
$requete = "INSERT INTO cel_mots_cles{$this->suffix} ".
"VALUES ($mot_cle_id, $id_utilisateur, $mot_cle_protege, $mot_cle_encode,".
" $bg, $bd, $niveau, $mot_cle_parent_id_protege) ";
 
$transaction_reussie_2 = $this->executerSQL($requete);
if (!$transaction_reussie_2) {
$e = "Échec d'insertion du mot-clé : $requete ";
$this->messages[] = $e;
}
 
if ($transaction_reussie_1 && $transaction_reussie_2) {
$retour = $this->completerTransaction();
} else {
$retour = $this->annulerTransaction();
}
} else {
$e = "Le mot-clé '$mot_cle' existe déjà dans la table cel_mots_cles{$this->suffix}.";
$this->debug[] = $e;
}
 
$id = ($retour) ? $this->getIdMotCle($mot_cle, $mot_cle_parent_id) : false;
return $id;
}
 
private function genererTagId($tag) {
$id = ($this->getHashCode($tag) + ((mt_rand() / (double)mt_getrandmax()) * 10000));
$id = str_replace(',', '.', $id);
return $id;
}
 
private function getHashCode($chaine){
$hash = 0;
$stringLength = strlen($chaine);
for ($i = 0; $i < $stringLength; $i++) {
$hash = 31 * $hash + $chaine[$i];
}
return $hash;
}
 
private function ajouterMotCleRacine() {
$nbre_mots_cles = $this->compterMotsCles();
$this->debug[] = "Nbre de mots-clés : $nbre_mots_cles";
if ($nbre_mots_cles == 0) {
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;
}
 
$md5_racine = $this->proteger($this->encoderMotCle($nom_racine));
$nom_racine = $this->proteger($nom_racine);
$id_racine = $this->proteger($id_racine);
$id_utilisateur = $this->proteger($this->utilisateur_id);
 
$requete = "INSERT INTO cel_mots_cles{$this->suffix} ".
"VALUES ($id_racine, $id_utilisateur, $nom_racine, $md5_racine,".
" 1, 2, 0, '') ";
 
if ($this->executerSQL($requete) === false) {
$e = "La requête d'insertion du mot-clé racine a échoué.";
$this->messages[] = $e;
}
}
}
 
private function verifierAbsence($mot_cle, $mot_cle_parent_id) {
$absence = false;
$mot_cle = $this->proteger($mot_cle);
$mot_cle_parent_id = $this->proteger($mot_cle_parent_id);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = 'SELECT COUNT(*) AS nbre '.
"FROM cel_mots_cles{$this->suffix} ".
"WHERE mot_cle = $mot_cle ".
" AND id_utilisateur = $id_utilisateur ".
" AND ce_mot_cle_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image')."_parent = $mot_cle_parent_id";
 
$nbre = $this->recupererValeur($requete);
if ($nbre === false) {
$e = "La requête de vérification d'absence d'un mot-clé a échoué.";
$this->messages[] = $e;
} else if ($nbre == 0) {
$absence = true;
}
return $absence;
}
 
private function getIdMotCle($mot_cle, $mot_cle_parent_id) {
$mot_cle = $this->proteger($mot_cle);
$mot_cle_parent_id = $this->proteger($mot_cle_parent_id);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = 'SELECT id_mot_cle_'.(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image').' AS id '.
"FROM cel_mots_cles{$this->suffix} ".
"WHERE mot_cle = $mot_cle ".
" AND id_utilisateur = $id_utilisateur ".
" AND ce_mot_cle_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image')."_parent = $mot_cle_parent_id";
$resultat = $this->recupererResultat($requete);
$mot_cle_id = ($resultat) ? $resultat['id'] : false;
return $mot_cle_id;
}
 
private function compterMotsCles() {
$nbre = 0;
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = 'SELECT COUNT(*) AS nbre '.
"FROM cel_mots_cles{$this->suffix} ".
"WHERE id_utilisateur = $id_utilisateur ";
 
$nbre = $this->recupererValeur($requete);
if ($nbre === false) {
$e = "La requête de comptage du nombre de mots-clés a échoué.";
$this->messages[] = $e;
}
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);
 
return true;
}
 
/**
* 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);
 
return false;
}
 
/**
* Renvoie les bornes d'un noeud de l'arbre des mots clés
*/
private function retrouverBornesEtNiveau($mot_cle_id) {
$mot_cle_id = $this->proteger($mot_cle_id);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = 'SELECT bd, bg, niveau '.
"FROM cel_mots_cles{$this->suffix} ".
"WHERE id_mot_cle_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image')." = $mot_cle_id ".
" AND id_utilisateur = $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
$valeur = $this->proteger($valeur);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
'SET bd = bd + 2 '.
"WHERE bd >= $valeur ".
" AND id_utilisateur = $id_utilisateur ";
$reussi_1 = $this->executerSQL($requete);
if (!$reussi_1) {
$e = "Échec du décalage de la borne droite de +2 : $requete ";
$this->messages[] = $e;
}
 
// Décalage borne gauche
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
'SET bg = bg + 2 '.
"WHERE bg >= $valeur ".
" AND id_utilisateur = $id_utilisateur ";
$reussi_2 = $this->executerSQL($requete);
if (!$reussi_2) {
$e = "Échec du décalage de la borne gauche de +2 : $requete";
$this->messages[] = $e;
}
 
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;
$bg = $this->proteger($bg);
$id_utilisateur = $this->proteger($this->utilisateur_id);
 
// Décalage borne droite
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bd = cmc_bd - $decalage ".
"WHERE bd >= $bg ".
" AND id_utilisateur = $id_utilisateur ";
$reussi_1 = $this->executerSQL($requete);
 
// Décalage borne gauche
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bg = bg - $decalage ".
"WHERE bg > $bg ".
" AND id_utilisateur = $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) {
$valeur_bornes = $this->proteger($valeur_bornes);
$largeur = $this->proteger($largeur);
$id_utilisateur = $this->proteger($this->utilisateur_id);
 
// Décalage borne droite
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bd = bd + $largeur ".
"WHERE bd >= $valeur_bornes ".
" AND id_utilisateur = $id_utilisateur ";
$reussi_1 = $this->executerSQL($requete);
 
// Décalage borne gauche
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bg = bg + $largeur ".
"WHERE bg >= $valeur_bornes ".
" AND id_utilisateur = $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) {
$bg = $this->proteger($bg);
$bd = $this->proteger($bd);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bd = bd - $bd - 1 , ".
" bg = bg - $bd - 1 ".
"WHERE bd <= $bd ".
" AND bg >= $bg ".
" AND id_utilisateur = $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) {
$bg = $this->proteger($bg);
$bd = $this->proteger($bd);
$largeur = $this->proteger($largeur);
$modif_niveau = $this->proteger($modif_niveau);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET bg = bg + $largeur , ".
" bd = bd + $largeur, ".
" niveau = niveau + $modif_niveau ".
"WHERE bg >= $bg ".
" AND bd <= $bd ".
" AND id_utilisateur = $id_utilisateur ";
 
return $this->executerSQL($requete);
}
 
private function changerPere($mot_cle_id, $id_pere) {
$mot_cle_id = $this->proteger($mot_cle_id);
$id_pere = $this->proteger($id_pere);
$id_utilisateur = $this->proteger($this->utilisateur_id);
$requete = "UPDATE cel_mots_cles{$this->suffix} ".
"SET ce_mot_cle_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image')."_parent = $id_pere ".
"WHERE id_mot_cle_".(($this->suffix == self::OBS_TABLE_SUFFIXE) ? 'obs' : 'image')." = $mot_cle_id ".
" AND id_utilisateur = $id_utilisateur ";
 
return $this->executerSQL($requete);
}
 
private function executerSQL($requete) {
$execution = $this->executer($requete);
$execution = ($execution === false) ? false : true;
return $execution;
}
 
private function recupererValeur($requete) {
$resultat = $this->requeter($requete, Cel::SQL_RETOUR_COLONNE);
return $resultat;
}
 
private function recupererResultat($requete) {
$resultat = $this->requeter($requete, Cel::SQL_RETOUR_LIGNE, Cel::SQL_MODE_ASSOC);
return $resultat;
}
 
private function recupererResultats($requete) {
$resultat = $this->requeter($requete, Cel::SQL_RETOUR_COMPLET, Cel::SQL_MODE_ASSOC);
return $resultat;
}
 
private function verifierLignesAffectees($requete) {
$execution = $this->executer($requete);
return $execution;
}
}
?>