Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
823 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe mère permettant de rassembler les manipulation concernant les mots clés.
5
 * Pour l'utiliser, il suffit d'étendre votre service avec cette classe à la place de Cel.
6
 * Encodage en entrée : utf8
7
 * Encodage en sortie : utf8
8
 *
9
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
10
 * @author Aurélien PERONNET <aurelien@tela-botanica.org>
11
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
12
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
13
 * @version $Id$
14
 * @copyright © 2011, Tela-Botanica
15
 */
16
// TODO : compléter la classe avec des méthdodes de modification, suppression et consultation des mots-clés.
17
// TODO : ajout vérification de la non présence du caractère '|' dans les chaines utilisateurs...
18
class CelMotCle extends Cel {
19
	const OBS_RACINE_ID = 'racine_obs';
20
	const OBS_RACINE_NOM = 'Projets';
21
	const OBS_TABLE_SUFFIXE = '_obs';
830 jpm 22
 
823 jpm 23
	const IMG_RACINE_ID = 'racine';
24
	const IMG_RACINE_NOM = 'Mots clés';
25
	const IMG_TABLE_SUFFIXE = '_images';
830 jpm 26
 
27
	const SEPARATEUR_MOT_CLE_TEXTE = '##';
28
	const SEPARATEUR_MOT_CLE_ID = ';';
823 jpm 29
 
30
	/**
31
	 * @var String permet de savoir si nous avons à faire à un mot clé d'observation ou d'image.
32
	 */
33
	private $suffix = '';
34
 
35
	/**
36
	 * @var String identifiant de l'utilisateur dont nous gérons les mots-clés.
37
	 */
38
	private $utilisateur_id = '';
39
 
830 jpm 40
	/**
41
	 * Lie un mot-clé à une ou plusieurs observations.
42
	 *
43
	 * @param String $utilisateur_id identifiant de l'utilisateur.
44
	 * @param String $mot_cle texte du mot-clé.
45
	 * @param Array $ordres_obs un tableau d'odre d'observation (int) pour lesquels nous devons ajouter le mot-clé.
46
	 */
47
	public function lierMotCleObs($utilisateur_id, Array $mots_cles_ids, Array $ordres) {
48
		$retour = false;
49
 
50
		if ($this->verifierOrdres($ordres)) {
51
			$mots_cles_ids_concatenes = $this->concatenerMotsClesIds($mots_cles_ids);
52
 
53
			$ordres_sql_in = implode(', ', $ordres);
54
			$requete =	'UPDATE cel_inventory '.
55
						"SET mots_cles = REPLACE(CONCAT(IFNULL(mots_cles, ''), |$mots_cles_ids_concatenes|), 'null', '') ".
56
						"WHERE ordre IN ($ordres_sql_in) ".
57
						"	AND identifiant = |$utilisateur_id| ";
58
			$resultat = $this->executer($requete);
59
			if ($resultat) {
60
				$retour = true;
61
				foreach ($ordres as $ordre) {
62
					$regeneration = $this->regenererIndexTexteMotCle($ordre);
63
					if ($regeneration === false) {
64
						$retour = false;
65
					}
66
				}
67
			} else {
68
				$e = "Erreur de mise à jour des mots clés d'une obs : $requete";
69
				$this->logger('CEL_bugs', $e);
70
				$this->messages[] = $e;
71
			}
72
 
73
		} else {
74
			$this->messages[] = "Le tableau des ordres des obs ne contenait pas que des nombres entiers.";
75
		}
76
 
77
		return $retour;
78
	}
79
 
80
	private function regenererIndexTexteMotCle($ordre) {
81
		$ok = false;
82
		$mots_cles_ids = $this->obtenirIdsMotsClesConcatenes($ordre);
83
		if ($mots_cles_ids) {
84
			$mots_cles = $this->obtenirMotClesTexte($mots_cles_ids);
85
			$mots_cles_concatenes = $this->concatenerMotsCles($mots_cles);
86
			$ok = $this->mettreAJourMotsClesConcatenes($mots_cles_concatenes, $ordre);
87
		}
88
		return $ok;
89
	}
90
 
91
	private function obtenirIdsMotsClesConcatenes($ordre) {
92
		$requete = 	'SELECT mots_cles '.
93
					'FROM cel_inventory '.
94
					"WHERE ordre = $ordre ".
95
					"	AND identifiant = |{$this->utilisateur_id}| ";
96
		$resultat = $this->recupererResultat($requete);
97
 
98
		$mots_cles_ids = false;
99
		if ($resultat) {
100
			$mots_cles_ids = $resultat['mots_cles'];
101
		}
102
		return $mots_cles_ids;
103
	}
104
 
105
	private function obtenirMotClesTexte($mot_cle_ids) {
106
		$mot_cle_ids_in = $this->formaterIdsMotClePourClauseInSql($mot_cle_ids);
107
		$requete = 	'SELECT cmc_mot_cle '.
108
					'FROM cel_mots_cles_obs '.
109
					"WHERE cmc_id_mot_cle_utilisateur IN ($mot_cle_ids_in) ".
110
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
111
		$resultats = $this->recupererResultats($requete);
112
		$mots_cles = array();
113
		if ($resultats) {
114
			foreach ($resultats as $mot_cle) {
115
				$mots_cles[] = $mot_cle['cmc_mot_cle'];
116
			}
117
		}
118
		return $mots_cles;
119
	}
120
 
121
	private function formaterIdsMotClePourClauseInSql($mot_cle_ids) {
122
		$mot_cle_ids = $this->nettoyerMotsCles($mot_cle_ids);
123
		$mot_cle_ids = str_replace(self::SEPARATEUR_MOT_CLE_ID, ',', $mot_cle_ids);
124
		$mot_cle_ids = trim($mot_cle_ids, ',');
125
		$mot_cle_ids_proteges = implode(',', $this->protegerTableau(explode(',', $mot_cle_ids)));
126
		return $mot_cle_ids_proteges;
127
	}
128
 
129
	private function concatenerMotsClesIds(Array $mots_cles_ids) {
130
		$mots_cles_ids_concatenes = '';
131
		if (count($mots_cles_ids) > 0) {
132
			foreach ($mots_cles_ids as $mot_cle_id) {
133
				$mots_cles_ids_concatenes .= $this->nettoyerMotsCles($mot_cle_id).self::SEPARATEUR_MOT_CLE_ID;
134
			}
135
		}
136
		return $mots_cles_ids_concatenes;
137
	}
138
 
139
	private function concatenerMotsCles(Array $mots_cles) {
140
		$mot_cles_concatenes = '';
141
		if (count($mots_cles) > 0) {
142
			foreach ($mots_cles as $mot_cle) {
143
				$mot_cles_concatenes .= $mot_cle.self::SEPARATEUR_MOT_CLE_TEXTE;
144
			}
145
		}
146
		$mot_cles_concatenes = rtrim($mot_cles_concatenes, self::SEPARATEUR_MOT_CLE_TEXTE);
147
 
148
		return $mot_cles_concatenes;
149
	}
150
 
151
	private function mettreAJourMotsClesConcatenes($mots_cles, $ordre) {
152
		$requete = 	'UPDATE cel_inventory '.
153
					"SET mots_cles_texte = |$mots_cles| ".
154
					"WHERE ordre = $ordre ".
155
					"	AND identifiant = |{$this->utilisateur_id}| ";
156
		$ok = $this->executer($requete) ? true : false;
157
		return $ok;
158
	}
159
 
160
	private function verifierOrdres($ordres) {
161
		$ok = true;
162
		foreach ($ordres as $ordre) {
163
			if (! preg_match('/^[0-9]+$/', $ordre)) {
164
				$this->debug[] = "Ordre pb : $ordre";
165
				$ok = false;
166
			}
167
		}
168
		return $ok;
169
	}
170
 
171
	private function nettoyerMotsCles($chaine) {
172
		$valeur = str_replace('null', '', $chaine);
173
		$valeur = trim($valeur, ';;');
174
 
175
		return $valeur;
176
	}
177
 
823 jpm 178
	public function ajouterMotCleObs($utilisateur_id, $mot_cle, $mot_cle_id, $mot_cle_parent_id) {
179
		$this->suffix = self::OBS_TABLE_SUFFIXE;
180
		$this->utilisateur_id = $utilisateur_id;
830 jpm 181
		return $this->ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id);
823 jpm 182
	}
183
 
184
	public function ajouterMotCleImg($utilisateur_id, $mot_cle, $mot_cle_id, $mot_cle_parent_id) {
185
		$this->suffix = self::IMG_TABLE_SUFFIXE;
186
		$this->utilisateur_id = $utilisateur_id;
830 jpm 187
		return $this->ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id);
823 jpm 188
	}
189
 
190
	private function ajouterMotCle($mot_cle, $mot_cle_id, $mot_cle_parent_id) {
830 jpm 191
		$retour = true;
823 jpm 192
		$this->ajouterMotCleRacine();
830 jpm 193
		if ($this->verifierAbscence($mot_cle_id)) {
194
			$this->commencerTransaction();
195
 
196
			$bornes = $this->retrouverBornesEtNiveau($mot_cle_parent_id);
197
			$borne_pere = $bornes['cmc_bd'];
198
			$niveau = $bornes['cmc_niveau'] + 1;
199
			$bg = $bornes['cmc_bd'];
200
			$bd = $bg + 1;
201
			$mot_cle_encode = $this->encoderMotCle($mot_cle);
202
 
203
			$transaction_reussie_1 = $this->decalerBornesPlusDeux($borne_pere) ? true : false;
204
 
205
			$requete = 	"INSERT INTO  cel_mots_cles{$this->suffix} ".
206
						"VALUES ( |$mot_cle|, |$bg|, |$bd|, |$mot_cle_encode|, |$mot_cle_id|, ".
207
						"	|{$this->utilisateur_id}|, |$mot_cle_parent_id|, |$niveau|) ";
208
			$transaction_reussie_2 = $this->executerSQL($requete);
209
			if (!$transaction_reussie_2) {
210
				$e = "Échec d'insertion du mot-clé : $requete ";
211
				$this->messages[] = $e;
212
			}
213
 
214
			$retour = null;
215
			if ($transaction_reussie_1 && $transaction_reussie_2) {
216
				$retour = $this->completerTransaction();
217
			} else {
218
				$retour = $this->annulerTransaction();
219
			}
823 jpm 220
		} else {
830 jpm 221
			$e = "Le mot-clé '$mot_cle' ayant l'id '$mot_cle_id' existe déjà.";
222
			$this->debug[] = $e;
823 jpm 223
		}
830 jpm 224
 
225
		return $retour;
823 jpm 226
	}
227
 
228
	private function ajouterMotCleRacine() {
229
		$nbre_mots_cles = $this->compterMotsCles();
831 jpm 230
		$this->debug[] = $nbre_mots_cles;
231
		if ($nbre_mots_cles == 0) {
823 jpm 232
			switch ($this->suffix) {
233
				case self::OBS_TABLE_SUFFIXE :
234
					$nom_racine = self::OBS_RACINE_NOM;
235
					$id_racine = self::OBS_RACINE_ID;
236
					break;
237
				case self::IMG_TABLE_SUFFIXE :
238
					$nom_racine = self::IMG_RACINE_NOM;
239
					$id_racine = self::IMG_RACINE_ID;
240
					break;
241
				default:
242
					$nom_racine = $this->suffix;
243
					$id_racine = $this->suffix;
244
			}
245
 
831 jpm 246
			$requete = 	"INSERT INTO cel_mots_cles{$this->suffix} ".
247
						"VALUES (|$nom_racine|, 1, 2, |$id_racine|, |$id_racine|, |{$this->utilisateur_id}|, '', 0) ";
248
			$this->debug[] = $requete;
249
			if ($this->executerSQL($requete) === false) {
250
				$e = "La requête d'insertion du mot-clé racine a échoué.";
251
				$this->messages[] = $e;
823 jpm 252
			}
253
		}
254
	}
255
 
830 jpm 256
	private function verifierAbscence($mot_cle_id) {
831 jpm 257
		$absence = false;
830 jpm 258
		$requete = 	'SELECT COUNT(*) AS nbre '.
259
					"FROM cel_mots_cles{$this->suffix} ".
260
					"WHERE cmc_id_mot_cle_utilisateur = |$mot_cle_id| ".
261
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
262
		$nbre = $this->recupererValeur($requete);
831 jpm 263
		if ($nbre === false) {
264
			$e = "La requête de vérification d'abscence d'un mot-clé a échoué.";
265
			$this->messages[] = $e;
266
		} else if ($nbre == 0) {
267
			$absence = true;
830 jpm 268
		}
269
		return $absence;
270
	}
271
 
823 jpm 272
	private function compterMotsCles() {
831 jpm 273
		$nbre = 0;
823 jpm 274
		$requete = 	'SELECT COUNT(*) AS nbre '.
275
					"FROM cel_mots_cles{$this->suffix} ".
276
					"WHERE cmc_id_proprietaire = |{$this->utilisateur_id}| ";
830 jpm 277
		$nbre = $this->recupererValeur($requete);
831 jpm 278
		if ($nbre === false) {
279
			$e = "La requête de comptage du nombre de mots-clés a échoué.";
280
			$this->messages[] = $e;
281
		}
823 jpm 282
		return $nbre;
283
	}
284
 
285
	/**
286
	 * Désactive l'auto-commit puis débute la transaction
287
	 */
288
	private function commencerTransaction() {
289
		// Désactive l'autocommit le temps de la manipulation de l'arbre
290
		$requete = 'SET AUTOCOMMIT = 0 ';
291
		$reussite_autocommit = $this->executerSQL($requete);
292
 
293
		// Débute une nouvelle transaction
294
		$requete = 'BEGIN ';
295
		$reussite_begin = $this->executerSQL($requete);
296
	}
297
 
298
	/**
299
	 * Termine la transaction puis réactive l'auto-commit
300
	 */
301
	private function completerTransaction() {
302
		// Complète la transaction
303
		$requete = 'COMMIT ';
304
		$reussite_commit = $this->executerSQL($requete);
305
 
306
		// Réactive l'autocommit le temps de la manipulation de l'arbre
307
		$requete = 'SET AUTOCOMMIT = 1 ';
308
		$reussite_autocommit = $this->executerSQL($requete);
309
 
830 jpm 310
		return true;
823 jpm 311
	}
312
 
313
	/**
314
	 * Annule la transaction et réactive l'auto-commit
315
	 */
316
	private function annulerTransaction() {
317
		// Annule la transaction
318
		$requete = 'ROLLBACK ';
319
		$reussite_rollback = $this->executerSQL($requete);
320
 
321
		// Réactive l'autocommit le temps de la manipulation de l'arbre
322
		$requete = 'SET AUTOCOMMIT = 1 ';
323
		$reussite_autocommit = $this->executerSQL($requete);
324
 
830 jpm 325
		return false;
823 jpm 326
	}
327
 
328
	/**
329
	 * Renvoie les bornes d'un noeud de l'arbre des mots clés
330
	 */
331
	private function retrouverBornesEtNiveau($mot_cle_id) {
332
		$requete = 	'SELECT cmc_bd, cmc_bg, cmc_niveau '.
333
					"FROM cel_mots_cles{$this->suffix} ".
334
					"WHERE cmc_id_mot_cle_utilisateur = |$mot_cle_id| ".
830 jpm 335
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 336
		$resultat = $this->recupererResultat($requete);
337
		return $resultat;
338
	}
339
 
340
	/**
341
	 * Décale les bornes de deux pour insérer un nouvel élément
342
	 */
343
	private function decalerBornesPlusDeux($valeur) {
344
		// Décalage borne droite
345
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
346
					'SET cmc_bd = cmc_bd + 2 '.
830 jpm 347
					"WHERE cmc_bd >= |$valeur| ".
348
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 349
		$reussi_1 = $this->executerSQL($requete);
830 jpm 350
		if (!$reussi_1) {
351
			$e = "Échec du décalage de la borne droite de +2 : $requete ";
352
			$this->messages[] = $e;
353
		}
823 jpm 354
 
355
		// Décalage borne gauche
356
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
357
					'SET cmc_bg = cmc_bg + 2 '.
830 jpm 358
					"WHERE cmc_bg >= |$valeur| ".
359
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 360
		$reussi_2 = $this->executerSQL($requete);
830 jpm 361
		if (!$reussi_2) {
362
			$e = "Échec du décalage de la borne gauche de +2 : $requete";
363
			$this->messages[] = $e;
364
		}
823 jpm 365
 
830 jpm 366
		return ($reussi_1 && $reussi_2);
823 jpm 367
	}
368
 
369
	/**
370
	 * Décale les bornes d'un intervalle négatif donné (pour la suppression d'un sous arbre).
371
	 */
372
	private function decalerBornesMoinsIntervalle($bg, $bd) {
373
		$decalage = $bd - $bg + 1;
374
 
375
		// Décalage borne droite
376
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
377
					"SET cmc_bd = cmc_bd - $decalage ".
830 jpm 378
					"WHERE cmc_bd >= |$bg| ".
379
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 380
		$reussi_1 = $this->executerSQL($requete);
381
 
382
		// Décalage borne gauche
383
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
384
					"SET cmc_bg = cmc_bg - $decalage ".
830 jpm 385
					"WHERE cmc_bg > |$bg| ".
386
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 387
		$reussi_2 = $this->executerSQL($requete);
388
 
389
		return $reussi_1 && $reussi_2;
390
	}
391
 
392
	/**
393
	 * Décale à droite des bornes donées d'un intervalle positif donné (pour l'ajout d'un sous arbre).
394
	 */
395
	private function decalerBornesPlusIntervalle($valeur_bornes, $largeur) {
396
		// Décalage borne droite
397
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
830 jpm 398
					"SET cmc_bd = cmc_bd + |$largeur| ".
399
					"WHERE cmc_bd >= |$valeur_bornes| ".
400
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 401
		$reussi_1 = $this->executerSQL($requete);
402
 
403
		// Décalage borne gauche
404
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
830 jpm 405
					"SET cmc_bg = cmc_bg + |$largeur| ".
406
					"WHERE cmc_bg >= |$valeur_bornes| ".
407
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 408
		$reussi_2 = $this->executerSQL($requete);
409
 
410
		return $reussi_1 && $reussi_2;
411
	}
412
 
413
	/**
414
	 * Inverse les bornes d'un intervalle pour l'exclure des modifications sur l'arbre sans changer la hiérarchie.
415
	 */
416
	private function exclureIntervalle($bg, $bd) {
417
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
830 jpm 418
					"SET cmc_bd = cmc_bd - |$bd| - 1 , ".
419
					"	cmc_bg =  cmc_bg - |$bd| - 1 ".
420
					"WHERE cmc_bd <= |$bd| ".
421
					"	AND cmc_bg >= |$bg| ".
422
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 423
		return $this->executerSQL($requete);
424
	}
425
 
426
	/**
427
	 * Recale les bornes dun intervalle pour l'inclure dans l'arbre à la bonne place.
428
	 * Décalage borne droite
429
	 */
430
	private function inclureIntervalle($bg, $bd, $largeur, $modif_niveau) {
431
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
830 jpm 432
					"SET cmc_bg =  cmc_bg + |$largeur| , ".
433
					"	cmc_bd = cmc_bd + |$largeur|, ".
434
					"	cmc_niveau = cmc_niveau + |$modif_niveau| ".
435
					"WHERE cmc_bg >=  |$bg| ".
436
					"	AND cmc_bd <=  |$bd| ".
437
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 438
 
439
		return $this->executerSQL($requete);
440
	}
441
 
442
	private function changerPere($mot_cle_id, $id_pere) {
443
		$requete = 	"UPDATE cel_mots_cles{$this->suffix} ".
444
					"SET cmc_id_parent = |$id_pere| ".
445
					"WHERE cmc_id_mot_cle_utilisateur = |$mot_cle_id| ".
830 jpm 446
					"	AND cmc_id_proprietaire = |{$this->utilisateur_id}| ";
823 jpm 447
 
448
		return $this->executerSQL($requete);
449
	}
450
 
451
	private function executerSQL($requete) {
452
		$execution = $this->executer($requete);
830 jpm 453
		$execution = ($execution === false) ? false : true;
823 jpm 454
		return $execution;
455
	}
456
 
830 jpm 457
	private function recupererValeur($requete) {
458
		$resultat = $this->requeter($requete, Cel::SQL_RETOUR_COLONNE);
459
		return $resultat;
460
	}
461
 
823 jpm 462
	private function recupererResultat($requete) {
463
		$resultat = $this->requeter($requete, Cel::SQL_RETOUR_LIGNE, Cel::SQL_MODE_ASSOC);
464
		return $resultat;
465
	}
466
 
830 jpm 467
	private function recupererResultats($requete) {
468
		$resultat = $this->requeter($requete, Cel::SQL_RETOUR_COMPLET, Cel::SQL_MODE_ASSOC);
469
		return $resultat;
470
	}
471
 
823 jpm 472
	private function verifierLignesAffectees($requete) {
473
		$execution = $this->executer($requete);
474
		return $execution;
475
	}
476
}
477
?>