Subversion Repositories eFlore/Applications.del

Rev

Rev 2077 | Rev 2210 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2077 Rev 2156
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
		// rétrocompatibilité champs de l'annuaire après suppression de del_utilisateur
83
		$annuaireChamps = implode(', ', array(
83
		$annuaireChamps = implode(', ', array(
84
			"IFNULL(du.prenom, do.prenom_utilisateur) AS `auteur.prenom`",
84
			"do.prenom_utilisateur AS `auteur.prenom`",
85
			"IFNULL(du.nom, do.nom_utilisateur) AS `auteur.nom`",
85
			"do.nom_utilisateur AS `auteur.nom`",
86
			"IFNULL(du.courriel, do.courriel_utilisateur) AS `auteur.courriel`"));
86
			"do.courriel_utilisateur AS `auteur.courriel`"));
87
 
87
 
88
		$requete = "SELECT $obsChamps, $imgChamps, $annuaireChamps ".
88
		$requete = "SELECT $obsChamps, $imgChamps, $annuaireChamps ".
89
			"FROM del_observation AS do ".
89
			"FROM del_observation AS do ".
90
			"	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) ".
91
			"	LEFT JOIN del_utilisateur AS du ON (do.ce_utilisateur = du.id_utilisateur) ".
-
 
92
			"WHERE do.id_observation = {$this->idObs} ".
91
			"WHERE do.id_observation = {$this->idObs} ".
93
			'-- '.__FILE__.':'.__LINE__;
92
			'-- '.__FILE__.':'.__LINE__;
94
		//Debug::printr($requete);
93
		//Debug::printr($requete);
95
		return $this->bdd->recupererTous($requete);
94
		return $this->bdd->recupererTous($requete);
96
	}
95
	}
97
 
96
 
98
	private function formaterObservation($infos) {
97
	private function formaterObservation($infos) {
99
		$infos = array_filter($infos);
98
		$infos = array_filter($infos);
100
		foreach ($infos as $info) {
99
		foreach ($infos as $info) {
101
			$image = array_intersect_key($info, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original')));
100
			$image = array_intersect_key($info, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original')));
102
			$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl');
101
			$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl');
103
			$imageFormat = 'XL';
102
			$imageFormat = 'XL';
104
			$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], $imageFormat);
103
			$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], $imageFormat);
105
			unset($info['id_image'], $info['date'], $info['hauteur'], $info['largeur'], $info['nom_original']);
104
			unset($info['id_image'], $info['date'], $info['hauteur'], $info['largeur'], $info['nom_original']);
106
 
105
 
107
			// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire)
106
			// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire)
108
			if (!isset($this->observation)) {
107
			if (!isset($this->observation)) {
109
				$this->observation = $info;
108
				$this->observation = $info;
110
				$this->observation['images'] = array();
109
				$this->observation['images'] = array();
111
			}
110
			}
112
			if (!isset($this->observation['images'][$image['id_image']])) {
111
			if (!isset($this->observation['images'][$image['id_image']])) {
113
				$this->observation['images'][$image['id_image']] = $image;
112
				$this->observation['images'][$image['id_image']] = $image;
114
			}
113
			}
115
		}
114
		}
116
	}
115
	}
117
 
116
 
118
	private function getCommentaires() {
117
	private function getCommentaires() {
119
		$selectVotes = array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date');
118
		$selectVotes = array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date');
120
		$selectCommentaires = array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte',
119
		$selectCommentaires = array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte',
121
			'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel',
120
			'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel',
122
			'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date',
121
			'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date',
123
			'proposition_initiale','proposition_retenue');
122
			'proposition_initiale','proposition_retenue');
124
 
123
 
125
		$voteChamps = $this->sql->getAliasDesChamps($this->mappings['votes'], $selectVotes, 'cv');
124
		$voteChamps = $this->sql->getAliasDesChamps($this->mappings['votes'], $selectVotes, 'cv');
126
		$commentaireChamps = $this->sql->getAliasDesChamps($this->mappings['commentaires'], $selectCommentaires, 'dc');
125
		$commentaireChamps = $this->sql->getAliasDesChamps($this->mappings['commentaires'], $selectCommentaires, 'dc');
127
 
126
 
128
		// LEFT JOIN optionnel, mais explicatif : récupèration des infos de vote que pour les commentaires comportant un nom_sel "valide"
127
		// LEFT JOIN optionnel, mais explicatif : récupèration des infos de vote que pour les commentaires comportant un nom_sel "valide"
129
		$requete = "SELECT $commentaireChamps, $voteChamps ".
128
		$requete = "SELECT $commentaireChamps, $voteChamps ".
130
			"FROM del_commentaire AS dc ".
129
			"FROM del_commentaire AS dc ".
131
			"	LEFT JOIN del_commentaire_vote AS cv ".
130
			"	LEFT JOIN del_commentaire_vote AS cv ".
132
			"	ON (cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL) ".
131
			"	ON (cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL) ".
133
			"WHERE ce_observation = {$this->idObs} ".
132
			"WHERE ce_observation = {$this->idObs} ".
134
			'-- '.__FILE__.':'.__LINE__;
133
			'-- '.__FILE__.':'.__LINE__;
135
 
134
 
136
		$commentaires = $this->bdd->recupererTous($requete);
135
		$commentaires = $this->bdd->recupererTous($requete);
137
		return $commentaires;
136
		return $commentaires;
138
 
137
 
139
	}
138
	}
140
 
139
 
141
	private function ajouterCommentaires($commentaires) {
140
	private function ajouterCommentaires($commentaires) {
142
		if (!$commentaires) return;
141
		if (!$commentaires) return;
143
 
142
 
144
		$ret = array();
143
		$ret = array();
145
		foreach ($commentaires as $comment) {
144
		foreach ($commentaires as $comment) {
146
			$commentId = $comment['id_commentaire'];
145
			$commentId = $comment['id_commentaire'];
147
			$voteId = $comment['vote.id'];
146
			$voteId = $comment['vote.id'];
148
 
147
 
149
			if (!array_key_exists($commentId, $ret)) {
148
			if (!array_key_exists($commentId, $ret)) {
150
				$comment_extract = array_intersect_key($comment, array_flip($this->mappings['commentaires']));
149
				$comment_extract = array_intersect_key($comment, array_flip($this->mappings['commentaires']));
151
 
150
 
152
				// cas particulier: conflit d'aliases avec del_commentaire_vote
151
				// cas particulier: conflit d'aliases avec del_commentaire_vote
153
				$comment_extract['auteur.id'] = $comment_extract['__auteur_com'];
152
				$comment_extract['auteur.id'] = $comment_extract['__auteur_com'];
154
				$comment_extract['date'] = $comment_extract['__date_com'];
153
				$comment_extract['date'] = $comment_extract['__date_com'];
155
				unset($comment_extract['__auteur_com'], $comment_extract['__date_com']);
154
				unset($comment_extract['__auteur_com'], $comment_extract['__date_com']);
156
 
155
 
157
				// toujours un éléments "votes", quand bien même il n'y en aurait pas
156
				// toujours un éléments "votes", quand bien même il n'y en aurait pas
158
				$comment_extract['votes'] = array();
157
				$comment_extract['votes'] = array();
159
				$ret[$commentId] = $comment_extract;
158
				$ret[$commentId] = $comment_extract;
160
			}
159
			}
161
 
160
 
162
			if (!$comment['nom_sel'] || ! $voteId) continue;
161
			if (!$comment['nom_sel'] || ! $voteId) continue;
163
			$vote = array_intersect_key($comment, array_flip($this->mappings['votes']));
162
			$vote = array_intersect_key($comment, array_flip($this->mappings['votes']));
164
			$ret[$commentId]['votes'][$voteId] = $vote;
163
			$ret[$commentId]['votes'][$voteId] = $vote;
165
		}
164
		}
166
		$this->observation['commentaires'] = $ret;
165
		$this->observation['commentaires'] = $ret;
167
	}
166
	}
168
 
167
 
169
	private function nettoyerAuteur() {
168
	private function nettoyerAuteur() {
170
		if (!isset($this->observation['auteur.id']) || !is_numeric($this->observation['auteur.id'])) {
169
		if (!isset($this->observation['auteur.id']) || !is_numeric($this->observation['auteur.id'])) {
171
			$this->observation['auteur.id'] = '0';
170
			$this->observation['auteur.id'] = '0';
172
		}
171
		}
173
		if (!isset($this->observation['auteur.nom'])) {
172
		if (!isset($this->observation['auteur.nom'])) {
174
			$this->observation['auteur.nom'] = '[inconnu]';
173
			$this->observation['auteur.nom'] = '[inconnu]';
175
		}
174
		}
176
	}
175
	}
177
 
176
 
178
	/**
177
	/**
179
	 * Modifie une observation directement dans le CEL en faisant un appel à un web service du CEL.
178
	 * Modifie une observation directement dans le CEL en faisant un appel à un web service du CEL.
180
	 * Utilisé uniquement par les admins.
179
	 * Utilisé uniquement par les admins.
181
	 * Permet de dépublier une observation.
180
	 * Permet de dépublier une observation.
182
	 *
181
	 *
183
	 * @param array		$ressources tableau des informations contenues dans l'url après le nom du service
182
	 * @param array		$ressources tableau des informations contenues dans l'url après le nom du service
184
	 * @param array		$parametres contenu du post
183
	 * @param array		$parametres contenu du post
185
	 * @return mixed	Chaine "OK" (en majuscule) en cas de succès, booléen "false" en cas d'échec
184
	 * @return mixed	Chaine "OK" (en majuscule) en cas de succès, booléen "false" en cas d'échec
186
	 */
185
	 */
187
	public function modifier($ressources, $parametres) {
186
	public function modifier($ressources, $parametres) {
188
		$gestionUtilisateurs = $this->conteneur->getUtilisateur();
187
		$gestionUtilisateurs = $this->conteneur->getUtilisateur();
189
		$gestionUtilisateurs->etreUtilisateurAvecDroitAdmin();
188
		$gestionUtilisateurs->etreUtilisateurAvecDroitAdmin();
190
 
189
 
191
		$retour = false;
190
		$retour = false;
192
		if (isset($parametres['transmission'])) {
191
		if (isset($parametres['transmission'])) {
193
			$idObs = $ressources[0];
192
			$idObs = $ressources[0];
194
			$clientRest = $this->conteneur->getRestClient();
193
			$clientRest = $this->conteneur->getRestClient();
195
			$urlTpl = $this->conteneur->getParametre('urlServiceCelObs');
194
			$urlTpl = $this->conteneur->getParametre('urlServiceCelObs');
196
			$url = $urlTpl.$idObs;
195
			$url = $urlTpl.$idObs;
197
			$retourCel = $clientRest->modifier($url, $parametres);
196
			$retourCel = $clientRest->modifier($url, $parametres);
198
			$retour = preg_match('/^OK$/i', $retourCel) ? 'OK' : false;
197
			$retour = preg_match('/^OK$/i', $retourCel) ? 'OK' : false;
199
			if ($retour === false) {
198
			if ($retour === false) {
200
				$message = "Erreur du web service CEL : ".$retourCel;
199
				$message = "Erreur du web service CEL : ".$retourCel;
201
				$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
200
				$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
202
				throw new Exception($message, $code);
201
				throw new Exception($message, $code);
203
			}
202
			}
204
		} else {
203
		} else {
205
			$message = "Ce web service doit contenir un paramètre 'transmission'.";
204
			$message = "Ce web service doit contenir un paramètre 'transmission'.";
206
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
205
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
207
			throw new Exception($message, $code);
206
			throw new Exception($message, $code);
208
		}
207
		}
209
		return $retour;
208
		return $retour;
210
	}
209
	}
211
}
210
}