Subversion Repositories eFlore/Applications.del

Rev

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

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