Subversion Repositories eFlore/Applications.del

Rev

Rev 1960 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1960 Rev 1980
1
<?php
1
<?php
2
// declare(encoding='UTF-8');
2
// declare(encoding='UTF-8');
3
/**
3
/**
4
 * Web service retournant toutes les infos d'une observation donnée :
4
 * Web service retournant toutes les infos d'une observation donnée :
5
 * images, votes sur image et protocole, commentaires, votes sur commentaires, ...
5
 * images, votes sur image et protocole, commentaires, votes sur commentaires, ...
6
 *
6
 *
7
 * @category   DEL
7
 * @category   DEL
8
 * @package    Services
8
 * @package    Services
9
 * @subpackage Observations
9
 * @subpackage Observations
10
 * @version    0.1
10
 * @version    0.1
11
 * @author     Mathias CHOUET <mathias@tela-botanica.org>
11
 * @author     Mathias CHOUET <mathias@tela-botanica.org>
12
 * @author     Jean-Pascal MILCENT <jpm@tela-botanica.org>
12
 * @author     Jean-Pascal MILCENT <jpm@tela-botanica.org>
13
 * @author     Aurelien PERONNET <aurelien@tela-botanica.org>
13
 * @author     Aurelien PERONNET <aurelien@tela-botanica.org>
14
 * @license    GPL v3 <http://www.gnu.org/licenses/gpl.txt>
14
 * @license    GPL v3 <http://www.gnu.org/licenses/gpl.txt>
15
 * @license    CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
15
 * @license    CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
16
 * @copyright  1999-2014 Tela Botanica <accueil@tela-botanica.org>
16
 * @copyright  1999-2014 Tela Botanica <accueil@tela-botanica.org>
17
 */
17
 */
18
class ObservationDetails {
18
class ObservationDetails {
19
 
19
 
20
	private $conteneur;
20
	private $conteneur;
21
	private $bdd;
21
	private $bdd;
22
	private $sql;
22
	private $sql;
23
	private $idObs;
23
	private $idObs;
24
	private $protocole;
24
	private $protocole;
25
	private $observation;
25
	private $observation;
26
	private $mappings = array();
26
	private $mappings = array();
27
 
27
 
28
	public function __construct(Conteneur $conteneur) {
28
	public function __construct(Conteneur $conteneur) {
29
		$this->conteneur = $conteneur;
29
		$this->conteneur = $conteneur;
30
		$this->bdd = $this->conteneur->getBdd();
30
		$this->bdd = $this->conteneur->getBdd();
31
		$this->sql = $this->conteneur->getSql();
31
		$this->sql = $this->conteneur->getSql();
32
 
32
 
33
		$this->mappings['observations'] = $this->conteneur->getParametreTableau('observations.mapping');
33
		$this->mappings['observations'] = $this->conteneur->getParametreTableau('observations.mapping');
34
		$this->mappings['images'] = $this->conteneur->getParametreTableau('images.mapping');
34
		$this->mappings['images'] = $this->conteneur->getParametreTableau('images.mapping');
35
		$this->mappings['votes'] = $this->conteneur->getParametreTableau('votes.mapping');
35
		$this->mappings['votes'] = $this->conteneur->getParametreTableau('votes.mapping');
36
		$this->mappings['commentaires'] = $this->conteneur->getParametreTableau('commentaires.mapping');
36
		$this->mappings['commentaires'] = $this->conteneur->getParametreTableau('commentaires.mapping');
37
		// les deux alias suivants sont particuliers afin d'éviter un conflit d'alias lors des jointures avec del_commentaire_vote
37
		// les deux alias suivants sont particuliers afin d'éviter un conflit d'alias lors des jointures avec del_commentaire_vote
38
		$this->mappings['commentaires']['ce_utilisateur'] = '__auteur_com';
38
		$this->mappings['commentaires']['ce_utilisateur'] = '__auteur_com';
39
		$this->mappings['commentaires']['date'] = '__date_com';
39
		$this->mappings['commentaires']['date'] = '__date_com';
40
	}
40
	}
41
 
41
 
42
	public function consulter($ressources, $parametres) {
42
	public function consulter($ressources, $parametres) {
43
		$this->idObs = $ressources[0];
43
		$this->idObs = $ressources[0];
44
		$this->protocole = isset($parametres['protocole']) && is_numeric($parametres['protocole']) ? intval($parametres['protocole']) : null;
44
		$this->protocole = isset($parametres['protocole']) && is_numeric($parametres['protocole']) ? intval($parametres['protocole']) : null;
45
 
45
 
46
		$infos = $this->getInfosObservationEtImages();
46
		$infos = $this->getInfosObservationEtImages();
47
		if (! $infos) {
47
		if (! $infos) {
48
			$message = "Aucune observation ne possède d'identifiant '{$this->idObs}'.";
48
			$message = "Aucune observation ne possède d'identifiant '{$this->idObs}'.";
49
			throw new Exception($message, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
49
			throw new Exception($message, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE);
50
		}
50
		}
51
		$this->formaterObservation($infos);
51
		$this->formaterObservation($infos);
52
 
52
 
53
		// 3) charge les données de votes et protocoles associés aux images
53
		// 3) charge les données de votes et protocoles associés aux images
54
 
54
 
55
		if ($this->observation['images']) {
55
		if ($this->observation['images']) {
56
			$idsImages = array_keys($this->observation['images']);
56
			$idsImages = array_keys($this->observation['images']);
57
			$votes = $this->sql->getVotesDesImages($idsImages, $this->protocole);
57
			$votes = $this->sql->getVotesDesImages($idsImages, $this->protocole);
58
			$this->sql->ajouterInfosVotesProtocoles($votes, $this->observation['images']);
58
			$this->sql->ajouterInfosVotesProtocoles($votes, $this->observation['images']);
59
		}
59
		}
60
 
60
 
61
		// 4) charge les commentaires et les votes associés -> modifie/créé $observation['commentaires']
61
		// 4) charge les commentaires et les votes associés -> modifie/créé $observation['commentaires']
62
		$commentaires = $this->getCommentaires();
62
		$commentaires = $this->getCommentaires();
63
		$this->ajouterCommentaires($commentaires);
63
		$this->ajouterCommentaires($commentaires);
64
 
64
 
65
		// désindexe le tableau (tel qu'apparement attendu par les applis), c'est une exception
65
		// désindexe le tableau (tel qu'apparement attendu par les applis), c'est une exception
66
		// TODO : corriger l'appli cliente pour utiliser les index puis supprimer cette ligne
66
		// TODO : corriger l'appli cliente pour utiliser les index puis supprimer cette ligne
67
		$this->observation['images'] = array_values($this->observation['images']);
67
		$this->observation['images'] = array_values($this->observation['images']);
68
 
68
 
69
		// autre élément de post-processing: le ce_utilisateur de l'observation non-numeric...
69
		// autre élément de post-processing: le ce_utilisateur de l'observation non-numeric...
70
		$this->nettoyerAuteur();
70
		$this->nettoyerAuteur();
71
 
71
 
72
		// Mettre en forme le résultat et l'envoyer pour affichage
72
		// Mettre en forme le résultat et l'envoyer pour affichage
73
		$resultat = new ResultatService();
73
		$resultat = new ResultatService();
74
		$resultat->corps = $this->observation;
74
		$resultat->corps = $this->observation;
75
		return $resultat;
75
		return $resultat;
76
	}
76
	}
77
 
77
 
78
	private function getInfosObservationEtImages() {
78
	private function getInfosObservationEtImages() {
79
		$obsChamps = $this->sql->getAliasDesChamps($this->mappings['observations'], null, 'do');
79
		$obsChamps = $this->sql->getAliasDesChamps($this->mappings['observations'], null, 'do');
80
		$imgChamps = $this->sql->getAliasDesChamps($this->mappings['images'], null, 'di');
80
		$imgChamps = $this->sql->getAliasDesChamps($this->mappings['images'], null, 'di');
81
 
81
 
82
		// champs de l'annuaire (del_utilisateur): id_utilisateur prenom, nom, courriel
82
		// champs de l'annuaire (del_utilisateur): id_utilisateur prenom, nom, courriel
83
		$annuaireChamps = implode(', ', array(
83
		$annuaireChamps = implode(', ', array(
84
			"IFNULL(du.prenom, do.prenom_utilisateur) AS `auteur.prenom`",
84
			"IFNULL(du.prenom, do.prenom_utilisateur) AS `auteur.prenom`",
85
			"IFNULL(du.nom, do.nom_utilisateur) AS `auteur.nom`",
85
			"IFNULL(du.nom, do.nom_utilisateur) AS `auteur.nom`",
86
			"IFNULL(du.courriel, do.courriel_utilisateur) AS `auteur.courriel`"));
86
			"IFNULL(du.courriel, do.courriel_utilisateur) AS `auteur.courriel`"));
87
 
-
 
88
		// TODO : bizarement MYSQL 5.6 retourne plusieurs fois les mêmes enregistrements d'où le DISTINCT (normalement inutile)
87
 
89
		$requete = "SELECT DISTINCT $obsChamps, $imgChamps, $annuaireChamps ".
88
		$requete = "SELECT $obsChamps, $imgChamps, $annuaireChamps ".
90
			"FROM del_observation AS do ".
89
			"FROM del_observation AS do ".
91
			"	LEFT JOIN del_image AS di ON (do.id_observation = di.ce_observation) ".
90
			"	LEFT JOIN del_image AS di ON (do.id_observation = di.ce_observation) ".
92
			"	LEFT JOIN del_utilisateur AS du ON (do.ce_utilisateur = du.id_utilisateur) ".
91
			"	LEFT JOIN del_utilisateur AS du ON (do.ce_utilisateur = du.id_utilisateur) ".
93
			"WHERE do.id_observation = {$this->idObs} ".
92
			"WHERE do.id_observation = {$this->idObs} ".
94
			'-- '.__FILE__.':'.__LINE__;
93
			'-- '.__FILE__.':'.__LINE__;
95
		//Debug::printr($requete);
94
		//Debug::printr($requete);
96
		return $this->bdd->recupererTous($requete);
95
		return $this->bdd->recupererTous($requete);
97
	}
96
	}
98
 
97
 
99
	private function formaterObservation($infos) {
98
	private function formaterObservation($infos) {
100
		$infos = array_filter($infos);
99
		$infos = array_filter($infos);
101
		foreach ($infos as $info) {
100
		foreach ($infos as $info) {
102
			$image = array_intersect_key($info, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original')));
101
			$image = array_intersect_key($info, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original')));
103
			$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl');
102
			$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl');
104
			$imageFormat = 'XL';
103
			$imageFormat = 'XL';
105
			$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], $imageFormat);
104
			$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], $imageFormat);
106
			unset($info['id_image'], $info['date'], $info['hauteur'], $info['largeur'], $info['nom_original']);
105
			unset($info['id_image'], $info['date'], $info['hauteur'], $info['largeur'], $info['nom_original']);
107
 
106
 
108
			// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire)
107
			// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire)
109
			if (!isset($this->observation)) {
108
			if (!isset($this->observation)) {
110
				$this->observation = $info;
109
				$this->observation = $info;
111
				$this->observation['images'] = array();
110
				$this->observation['images'] = array();
112
			}
111
			}
113
			if (!isset($this->observation['images'][$image['id_image']])) {
112
			if (!isset($this->observation['images'][$image['id_image']])) {
114
				$this->observation['images'][$image['id_image']] = $image;
113
				$this->observation['images'][$image['id_image']] = $image;
115
			}
114
			}
116
		}
115
		}
117
	}
116
	}
118
 
117
 
119
	private function getCommentaires() {
118
	private function getCommentaires() {
120
		$selectVotes = array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date');
119
		$selectVotes = array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date');
121
		$selectCommentaires = array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte',
120
		$selectCommentaires = array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte',
122
			'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel',
121
			'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel',
123
			'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date',
122
			'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date',
124
			'proposition_initiale','proposition_retenue');
123
			'proposition_initiale','proposition_retenue');
125
 
124
 
126
		$voteChamps = $this->sql->getAliasDesChamps($this->mappings['votes'], $selectVotes, 'cv');
125
		$voteChamps = $this->sql->getAliasDesChamps($this->mappings['votes'], $selectVotes, 'cv');
127
		$commentaireChamps = $this->sql->getAliasDesChamps($this->mappings['commentaires'], $selectCommentaires, 'dc');
126
		$commentaireChamps = $this->sql->getAliasDesChamps($this->mappings['commentaires'], $selectCommentaires, 'dc');
128
 
127
 
129
		// LEFT JOIN optionnel, mais explicatif : récupèration des infos de vote que pour les commentaires comportant un nom_sel "valide"
128
		// LEFT JOIN optionnel, mais explicatif : récupèration des infos de vote que pour les commentaires comportant un nom_sel "valide"
130
		$requete = "SELECT $commentaireChamps, $voteChamps ".
129
		$requete = "SELECT $commentaireChamps, $voteChamps ".
131
			"FROM del_commentaire AS dc ".
130
			"FROM del_commentaire AS dc ".
132
			"	LEFT JOIN del_commentaire_vote AS cv ".
131
			"	LEFT JOIN del_commentaire_vote AS cv ".
133
			"	ON (cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL) ".
132
			"	ON (cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL) ".
134
			"WHERE ce_observation = {$this->idObs} ".
133
			"WHERE ce_observation = {$this->idObs} ".
135
			'-- '.__FILE__.':'.__LINE__;
134
			'-- '.__FILE__.':'.__LINE__;
136
 
135
 
137
		$commentaires = $this->bdd->recupererTous($requete);
136
		$commentaires = $this->bdd->recupererTous($requete);
138
		return $commentaires;
137
		return $commentaires;
139
 
138
 
140
	}
139
	}
141
 
140
 
142
	private function ajouterCommentaires($commentaires) {
141
	private function ajouterCommentaires($commentaires) {
143
		if (!$commentaires) return;
142
		if (!$commentaires) return;
144
 
143
 
145
		$ret = array();
144
		$ret = array();
146
		foreach ($commentaires as $comment) {
145
		foreach ($commentaires as $comment) {
147
			$commentId = $comment['id_commentaire'];
146
			$commentId = $comment['id_commentaire'];
148
			$voteId = $comment['vote.id'];
147
			$voteId = $comment['vote.id'];
149
 
148
 
150
			if (!array_key_exists($commentId, $ret)) {
149
			if (!array_key_exists($commentId, $ret)) {
151
				$comment_extract = array_intersect_key($comment, array_flip($this->mappings['commentaires']));
150
				$comment_extract = array_intersect_key($comment, array_flip($this->mappings['commentaires']));
152
 
151
 
153
				// cas particulier: conflit d'aliases avec del_commentaire_vote
152
				// cas particulier: conflit d'aliases avec del_commentaire_vote
154
				$comment_extract['auteur.id'] = $comment_extract['__auteur_com'];
153
				$comment_extract['auteur.id'] = $comment_extract['__auteur_com'];
155
				$comment_extract['date'] = $comment_extract['__date_com'];
154
				$comment_extract['date'] = $comment_extract['__date_com'];
156
				unset($comment_extract['__auteur_com'], $comment_extract['__date_com']);
155
				unset($comment_extract['__auteur_com'], $comment_extract['__date_com']);
157
 
156
 
158
				// toujours un éléments "votes", quand bien même il n'y en aurait pas
157
				// toujours un éléments "votes", quand bien même il n'y en aurait pas
159
				$comment_extract['votes'] = array();
158
				$comment_extract['votes'] = array();
160
				$ret[$commentId] = $comment_extract;
159
				$ret[$commentId] = $comment_extract;
161
			}
160
			}
162
 
161
 
163
			if (!$comment['nom_sel'] || ! $voteId) continue;
162
			if (!$comment['nom_sel'] || ! $voteId) continue;
164
			$vote = array_intersect_key($comment, array_flip($this->mappings['votes']));
163
			$vote = array_intersect_key($comment, array_flip($this->mappings['votes']));
165
			$ret[$commentId]['votes'][$voteId] = $vote;
164
			$ret[$commentId]['votes'][$voteId] = $vote;
166
		}
165
		}
167
		$this->observation['commentaires'] = $ret;
166
		$this->observation['commentaires'] = $ret;
168
	}
167
	}
169
 
168
 
170
	private function nettoyerAuteur() {
169
	private function nettoyerAuteur() {
171
		if (!isset($this->observation['auteur.id']) || !is_numeric($this->observation['auteur.id'])) {
170
		if (!isset($this->observation['auteur.id']) || !is_numeric($this->observation['auteur.id'])) {
172
			$this->observation['auteur.id'] = '0';
171
			$this->observation['auteur.id'] = '0';
173
		}
172
		}
174
		if (!isset($this->observation['auteur.nom'])) {
173
		if (!isset($this->observation['auteur.nom'])) {
175
			$this->observation['auteur.nom'] = '[inconnu]';
174
			$this->observation['auteur.nom'] = '[inconnu]';
176
		}
175
		}
177
	}
176
	}
178
 
177
 
179
	/**
178
	/**
180
	 * Modifie une observation directement dans le CEL en faisant un appel à un web service du CEL.
179
	 * Modifie une observation directement dans le CEL en faisant un appel à un web service du CEL.
181
	 * Utilisé uniquement par les admins.
180
	 * Utilisé uniquement par les admins.
182
	 * Permet de dépublier une observation.
181
	 * Permet de dépublier une observation.
183
	 *
182
	 *
184
	 * @param array		$ressources tableau des informations contenues dans l'url après le nom du service
183
	 * @param array		$ressources tableau des informations contenues dans l'url après le nom du service
185
	 * @param array		$parametres contenu du post
184
	 * @param array		$parametres contenu du post
186
	 * @return mixed	Chaine "OK" (en majuscule) en cas de succès, booléen "false" en cas d'échec
185
	 * @return mixed	Chaine "OK" (en majuscule) en cas de succès, booléen "false" en cas d'échec
187
	 */
186
	 */
188
	public function modifier($ressources, $parametres) {
187
	public function modifier($ressources, $parametres) {
189
		$controlAcces = $this->conteneur->getControleAcces();
188
		$controlAcces = $this->conteneur->getControleAcces();
190
		$controlAcces->etreUtilisateurAvecDroitAdmin();
189
		$controlAcces->etreUtilisateurAvecDroitAdmin();
191
 
190
 
192
		$retour = false;
191
		$retour = false;
193
		if (isset($parametres['transmission'])) {
192
		if (isset($parametres['transmission'])) {
194
			$idObs = $ressources[0];
193
			$idObs = $ressources[0];
195
			$clientRest = $this->conteneur->getRestClient();
194
			$clientRest = $this->conteneur->getRestClient();
196
			$urlTpl = $this->conteneur->getParametre('urlServiceCelObs');
195
			$urlTpl = $this->conteneur->getParametre('urlServiceCelObs');
197
			$url = $urlTpl.$idObs;
196
			$url = $urlTpl.$idObs;
198
			$retourCel = $clientRest->modifier($url, $parametres);
197
			$retourCel = $clientRest->modifier($url, $parametres);
199
			$retour = preg_match('/^OK$/i', $retourCel) ? 'OK' : false;
198
			$retour = preg_match('/^OK$/i', $retourCel) ? 'OK' : false;
200
			if ($retour === false) {
199
			if ($retour === false) {
201
				$message = "Erreur du web service CEL : ".$retourCel;
200
				$message = "Erreur du web service CEL : ".$retourCel;
202
				$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
201
				$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
203
				throw new Exception($message, $code);
202
				throw new Exception($message, $code);
204
			}
203
			}
205
		} else {
204
		} else {
206
			$message = "Ce web service doit contenir un paramètre 'transmission'.";
205
			$message = "Ce web service doit contenir un paramètre 'transmission'.";
207
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
206
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
208
			throw new Exception($message, $code);
207
			throw new Exception($message, $code);
209
		}
208
		}
210
		return $retour;
209
		return $retour;
211
	}
210
	}
212
}
211
}