<?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 = '';

	/**
	 * Lie un mot-clé à une ou plusieurs observations.
	 *
	 * @param String $utilisateur_id identifiant de l'utilisateur.
	 * @param String $mot_cle texte du mot-clé.
	 * @param Array $ordres_obs un tableau d'odre d'observation (int) pour lesquels nous devons ajouter le mot-clé.
	 */
	public function lierMotCleObs($utilisateur_id, Array $mots_cles_ids, Array $ordres) {
		$retour = false;

		if ($this->contenirNbresEntiers($ordres)) {
			$mots_cles_ids_concatenes = $this->concatenerMotsClesIdsObs($mots_cles_ids);
			$mots_cles_ids_concatenes = $this->proteger($mots_cles_ids_concatenes);
			$utilisateur_id = $this->proteger($utilisateur_id);

			$ordres_sql_in = implode(', ', $ordres);
			$requete =	'UPDATE cel_inventory '.
						"SET mots_cles = REPLACE(CONCAT(IFNULL(mots_cles, ''), $mots_cles_ids_concatenes), 'null', '') ".
						"WHERE ordre IN ($ordres_sql_in) ".
						"	AND identifiant = $utilisateur_id ";
			$resultat = $this->executer($requete);
			if ($resultat) {
				$retour = true;
				foreach ($ordres as $ordre) {
					$regeneration = $this->regenererIndexTexteMotCle($ordre);
					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;
	}

	/**
	 * Lie un mot-clé à une ou plusieurs images.
	 *
	 * @param String $utilisateur_id identifiant de l'utilisateur.
	 * @param String $mot_cle texte du mot-clé.
	 * @param Array $images_ids un tableau d'id d'images (int) pour lesquels nous devons ajouter le mot-clé.
	 */
	public function lierMotCleImg($utilisateur_id, Array $mots_cles_ids, Array $images_ids) {
		$retour = false;

		if ($this->contenirNbresEntiers($images_ids)) {
			$mots_cles_ids_concatenes = $this->concatenerMotsClesIdsImg($mots_cles_ids);
			$mots_cles_ids_concatenes = $this->proteger($mots_cles_ids_concatenes);
			$utilisateur_id = $this->proteger($utilisateur_id);

			$images_ids_sql_in = implode(', ', $images_ids);
			$requete =	'UPDATE cel_images '.
					"SET ci_meta_mots_cles = REPLACE(CONCAT(IFNULL(ci_meta_mots_cles, ''), $mots_cles_ids_concatenes), 'null', '') ".
					"WHERE ci_id_image IN ($images_ids_sql_in) ".
					"	AND ci_ce_utilisateur = $utilisateur_id ";
			$resultat = $this->executer($requete);
			if ($resultat) {
				$retour = true;
			} else {
				$e = "Erreur de mise à jour des mots clés d'une image : $requete";
				$this->logger('CEL_bugs', $e);
				$this->messages[] = $e;
			}
		} else {
			$this->messages[] = "Le tableau des identifiants des images 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($ordre) {
		$ok = false;
		$mots_cles_ids = $this->obtenirIdsMotsClesConcatenes($ordre);
		if ($mots_cles_ids) {
			$mots_cles = $this->obtenirMotClesTexte($mots_cles_ids);
			$mots_cles_concatenes = $this->concatenerMotsCles($mots_cles);
			$ok = $this->mettreAJourMotsClesConcatenes($mots_cles_concatenes, $ordre);
		}
		return $ok;
	}

	private function obtenirIdsMotsClesConcatenes($ordre) {
		$utilisateur_id = $this->proteger($this->utilisateur_id);

		$requete = 	'SELECT mots_cles '.
					'FROM cel_inventory '.
					"WHERE ordre = $ordre ".
					"	AND identifiant = $utilisateur_id ";
		$resultat = $this->recupererResultat($requete);

		$mots_cles_ids = false;
		if ($resultat) {
			$mots_cles_ids = $resultat['mots_cles'];
		}
		return $mots_cles_ids;
	}

	private function obtenirMotClesTexte($mot_cle_ids) {
		$mot_cle_ids_in = $this->formaterIdsMotClePourClauseInSql($mot_cle_ids);
		$utilisateur_id = $this->proteger($this->utilisateur_id);

		$requete = 	'SELECT cmc_mot_cle '.
					'FROM cel_mots_cles_obs '.
					"WHERE cmc_id_mot_cle_utilisateur IN ($mot_cle_ids_in) ".
					"	AND cmc_id_proprietaire = $utilisateur_id ";
		$resultats = $this->recupererResultats($requete);
		$mots_cles = array();
		if ($resultats) {
			foreach ($resultats as $mot_cle) {
				$mots_cles[] = $mot_cle['cmc_mot_cle'];
			}
		}
		return $mots_cles;
	}

	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 concatenerMotsClesIdsObs(Array $mots_cles_ids) {
		return $this->concatenerMotsClesIds($mots_cles_ids, self::SEPARATEUR_MOT_CLE_ID_OBS);
	}

	private function concatenerMotsClesIdsImg(Array $mots_cles_ids) {
		return $this->concatenerMotsClesIds($mots_cles_ids, self::SEPARATEUR_MOT_CLE_ID_IMG);
	}

	private function concatenerMotsClesIds(Array $mots_cles_ids, $separateur) {
		$mots_cles_ids_concatenes = '';
		if (count($mots_cles_ids) > 0) {
			foreach ($mots_cles_ids as $mot_cle_id) {
				$mots_cles_ids_concatenes .= $this->nettoyerMotsCles($mot_cle_id).$separateur;
			}
		}
		return $mots_cles_ids_concatenes;
	}

	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.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, $ordre) {
		$mots_cles = $this->proteger($mots_cles);
		$utilisateur_id = $this->proteger($this->utilisateur_id);

		$requete = 	'UPDATE cel_inventory '.
					"SET mots_cles_texte = $mots_cles ".
					"WHERE ordre = $ordre ".
					"	AND identifiant = $utilisateur_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->verifierAbscence($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['cmc_bd'];
			$niveau = $bornes['cmc_niveau'] + 1;
			$bg = $bornes['cmc_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_protege, $bg, $bd, $mot_cle_encode, $mot_cle_id, ".
						"	$id_utilisateur, $mot_cle_parent_id_protege, $niveau) ";
			$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;
			}

			$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 ($nom_racine, 1, 2, $id_racine, $id_racine, $id_utilisateur, '', 0) ";
			if ($this->executerSQL($requete) === false) {
				$e = "La requête d'insertion du mot-clé racine a échoué.";
				$this->messages[] = $e;
			}
		}
	}

	private function verifierAbscence($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 cmc_mot_cle = $mot_cle ".
			"	AND cmc_id_proprietaire = $id_utilisateur ".
			"	AND cmc_id_parent = $mot_cle_parent_id";
		$nbre = $this->recupererValeur($requete);
		if ($nbre === false) {
			$e = "La requête de vérification d'abscence 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 cmc_id_mot_cle_utilisateur AS id '.
			"FROM cel_mots_cles{$this->suffix} ".
			"WHERE cmc_mot_cle = $mot_cle ".
			"	AND cmc_id_proprietaire = $id_utilisateur ".
			"	AND cmc_id_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 cmc_id_proprietaire = $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 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 = $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 cmc_bd = cmc_bd + 2 '.
					"WHERE cmc_bd >= $valeur ".
					"	AND cmc_id_proprietaire = $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 cmc_bg = cmc_bg + 2 '.
					"WHERE cmc_bg >= $valeur ".
					"	AND cmc_id_proprietaire = $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 cmc_bd = cmc_bd - $decalage ".
					"WHERE cmc_bd >= $bg ".
					"	AND cmc_id_proprietaire = $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 = $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 cmc_bd = cmc_bd + $largeur ".
					"WHERE cmc_bd >= $valeur_bornes ".
					"	AND cmc_id_proprietaire = $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 = $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 cmc_bd = cmc_bd - $bd - 1 , ".
					"	cmc_bg =  cmc_bg - $bd - 1 ".
					"WHERE cmc_bd <= $bd ".
					"	AND cmc_bg >= $bg ".
					"	AND cmc_id_proprietaire = $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 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 = $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 cmc_id_parent = $id_pere ".
					"WHERE cmc_id_mot_cle_utilisateur = $mot_cle_id ".
					"	AND cmc_id_proprietaire = $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;
	}
}
?>