Subversion Repositories eFlore/Applications.del

Rev

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

Rev Author Line No. Line
761 gduche 1
<?php
2
/**
1385 raphael 3
 * Le web service observations récupère toutes les information pour une observation:
4
 * images, votes sur image et protocole, commentaires, votes sur commentaires, ...
761 gduche 5
 *
6
 * @category	php 5.2
1385 raphael 7
 * @author		Raphaël Droz <raphael@tela-botanica.org>
8
 * @copyright	Copyright (c) 2013, Tela Botanica (accueil@tela-botanica.org)
761 gduche 9
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
10
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
11
 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations
1385 raphael 12
 *
13
 * @config-depend: "url_image" (dans configurations/config_observations.ini)
14
 *				   ex: http://www.tela-botanica.org/appli:cel-img:%09dXL.jpg
761 gduche 15
 */
16
 
17
// http://localhost/del/services/0.1/observations/#id => une observation donnée et ses images, SANS LES propositions & nombre de commentaire
1385 raphael 18
 
19
require_once(dirname(__FILE__) . '/ListeObservations2.php');
20
 
761 gduche 21
class Observation {
1385 raphael 22
 
23
	/* Map les champs MySQL vers les champs utilisés dans le JSON pour les clients pour
24
	   chacune des différentes tables utilisées pour le chargement de résultats ci-dessous.
25
	   - chargerObservation() (v_del_image)
26
	   - chargerVotesImage() (del_image_vote, del_image_protocole)
27
	   - chargerCommentaires() (del_commentaire_vote, del_commentaire).
28
	   Si la valeur vaut 1, aucun alias ne sera défini (nom du champ d'origine), cf consulter() */
29
	static $mappings = array(
30
		'observations' => array( // v_del_image
31
			"id_observation" => 1,
32
			"date_observation" => 1,
33
			"date_transmission" => 1,
34
			"famille" => "determination.famille",
35
			"nom_sel" => "determination.ns",
36
			"nom_sel_nn" => "determination.nn",
37
			"nom_referentiel" => "determination.referentiel",
38
			"nt" => "determination.nt",
39
			"ce_zone_geo" => "id_zone_geo",
40
			"zone_geo" => 1,
41
			"lieudit" => 1,
42
			"station" => 1,
43
			"milieu" => 1,
44
			"ce_utilisateur" => "auteur.id",
45
			"mots_cles_texte" => "mots_cles_texte",
46
			"commentaire" => 1),
47
		/* exclus car issus de la jointure annuaire:
48
		   "nom" => "auteur.nom", // XXX: jointure annuaire
49
		   "prenom" => "auteur.prenom",  // XXX: jointure annuaire
50
		   "courriel" => "observateur",  // XXX: jointure annuaire */
51
		/* présents dans cel_obs mais exclus:
52
		   ordre, nom_ret, nom_ret_nn, latitude, longitude, altitude, geodatum
53
		   transmission, date_creation, date_modificationabondance, certitude, phenologie, code_insee_calcule */
54
 
55
		'images' => array( // v_del_image
56
			"id_image" => 1,
57
			"hauteur" => 1,
58
			// "largeur" => 1, inutile semble-t-il
59
			"date_prise_de_vue" => "date"),
60
		/* présents dans cel_images mais exclus:
61
		   i_commentaire, nom_original, publiable_eflore, i_mots_cles_texte, i_ordre,
62
		   i_ce_utilisateur, i_prenom_utilisateur, i_nom_utilisateur, i_courriel_utilisateur */
63
 
64
		'protocoles' => array( // del_image_protocole
65
			"ce_protocole" => "protocole.id",
66
			"id_protocole" => "protocole.id",
67
			"intitule" => "protocole.intitule",
68
			"descriptif" => "protocole.descriptif",
69
			"tag" => "protocole.tag"),
70
 
71
		/* See desc del_commentaire_vote & desc del_image_vote;
72
		   Les deux schémas sont similaires, à l'exception de ce_protocole
73
		   spécifique à del_image_vote et ce_proposition => ce_image */
74
		'votes' => array( // del_image_vote et del_commentaire_vote
75
			"id_vote" => "vote.id",
76
			"ce_proposition" => "proposition.id",
77
			"ce_image" => "image.id",
78
			"ce_utilisateur" => "auteur.id", // attention, conflit avec commentaire, cf ci-dessous
79
			"valeur" => "vote",
80
			"date" => 1, // attention, conflit avec commentaire, cf ci-dessous
81
			// absents du JSON, et pourtant présents dans services/configurations/config_mapping_votes.ini
82
			// (nécessiterait une propre jointure sur del_utilisateur)
83
			/* "nom" => "auteur.nom",
84
			"prenom" => "auteur.prenom",
85
			"courriel" => "auteur.courriel" */),
86
 
87
		'commentaires' => array( // del_commentaire
88
			"id_commentaire" => 1,
89
			"ce_observation" => "observation",
90
			"ce_proposition" => "proposition",
91
			"ce_commentaire_parent" => "id_parent",
92
 
93
			// les deux alias suivants sont particuliers afin d'éviter un conflit d'alias
94
			// lors des jointures avec del_commentaire_vote ci-dessus
95
			// (cf cas particulier dans la boucle de chargerCommentaires())
96
			"ce_utilisateur" => "__auteur_com",
97
			"date" => "__date_com",
98
 
99
			"texte" => 1,
100
			"utilisateur_nom" => "auteur.nom",
101
			"utilisateur_prenom" => "auteur.prenom",
102
			"utilisateur_courriel" => "auteur.courriel",
103
			"nom_sel" => 1,
104
			"nom_sel_nn" => 1,
105
			"nom_ret_nn" => 1,
106
			"proposition_initiale" => 1),
107
	);
108
 
761 gduche 109
 
110
	private $conteneur;
111
	private $gestionBdd;
112
	private $bdd;
113
 
114
	public function __construct(Conteneur $conteneur = null) {
115
		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
787 delphine 116
		$this->conteneur->chargerConfiguration('config_votes.ini');
841 aurelien 117
		$this->conteneur->chargerConfiguration('config_mapping_votes.ini');
950 aurelien 118
		$this->conteneur->chargerConfiguration('config_mapping_commentaires.ini');
761 gduche 119
		$this->gestionBdd = $conteneur->getGestionBdd();
120
		$this->bdd = $this->gestionBdd->getBdd();
121
	}
122
 
123
	/**
124
	 * Méthode principale de la classe.
125
	 * Lance la récupération des images dans la base et les place dans un objet ResultatService
126
	 * pour l'afficher.
127
	 * @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)
128
	 * @param array $parametres les paramètres situés après le ? dans l'url
129
	 * */
130
	public function consulter($ressources, $parametres) {
1385 raphael 131
		if (!$ressources || count($ressources) != 1 ) {
132
			throw new Exception("Le service observation accepte un unique identifiant d'observation", RestServeur::HTTP_CODE_ERREUR);
133
		}
134
 
135
		// initialise les mappings:
136
		// substitue les valeurs à 1 par le nom de la clef (pas d'alias de champ)
137
		array_walk(self::$mappings['observations'], create_function('&$val, $k', 'if($val==1) $val = $k;'));
138
		array_walk(self::$mappings['images'], create_function('&$val, $k', 'if($val==1) $val = $k;'));
139
		array_walk(self::$mappings['protocoles'], create_function('&$val, $k', 'if($val==1) $val = $k;'));
140
		array_walk(self::$mappings['votes'], create_function('&$val, $k', 'if($val==1) $val = $k;'));
141
		array_walk(self::$mappings['commentaires'], create_function('&$val, $k', 'if($val==1) $val = $k;'));
142
 
143
 
761 gduche 144
		// Gestion des configuration du script
1385 raphael 145
		$idobs = $ressources[0];
146
		$protocole = isset($parametres['protocole']) && is_numeric($parametres['protocole']) ?intval($parametres['protocole']) : NULL;
1361 raphael 147
 
1385 raphael 148
		// 1) récupération de l'observation (et de ses images (v_del_image est une vue utilisant des INNER JOIN))
149
		$liaisons = self::chargerObservation($this->bdd, $idobs);
150
 
151
		if(!$liaisons) {
1379 raphael 152
			header('HTTP/1.0 404 Not Found');
153
			// don't die (phpunit)
154
			throw(new Exception());
155
		}
1361 raphael 156
 
1385 raphael 157
		// 2) réassocie les images "à plat" à leur observation (merge)
1389 raphael 158
		// TODO: appliquer le formattage dépendant de la configuration en fin de processus
1385 raphael 159
		$observations = ListeObservations2::reformateObservationSimpleIndex($liaisons, $this->conteneur->getParametre('url_images'));
160
		// bien que dans notre cas il n'y est qu'une seule observation, issu de plusieurs images
161
		// dans $liaisons, $observation est un tableau (cf reformateObservation).
162
		// Considérons la chose comme telle au cas où le webservice doivent demain demander une paire
163
		// d'observations (... convergence ListeObservations)
164
 
165
		$observation = array_pop($observations);
166
 
167
		// 3) charge les données de votes et protocoles associés aux images
168
		if($observation['images']) {
169
			$votes = self::chargerVotesImage($this->bdd, $observation['images'], $protocole);
170
			// 3") merge/reformate les données retournées
171
			self::mapVotesToImages($votes,
172
								   $observation['images']);
173
		}
174
 
175
		// 4) charge les commentaires et les votes associés
176
		// modifie/créé $observation['commentaires']
177
		self::chargerCommentaires($this->bdd, $observation);
178
 
179
 
180
		// désindexe le tableau (tel qu'apparement attendu par les applis), c'est une exception
181
		// corriger l'appli cliente pour utiliser les index puis supprimer cette ligne
182
		$observation['images'] = array_values($observation['images']);
183
		// autre élément de post-processing: le ce_utilisateur de l'observation non-numeric...
184
		if(!is_numeric($observation['auteur.id'])) $observation['auteur.id'] = "0";
185
		if(!isset($observation['auteur.nom'])) $observation['auteur.nom'] = '[inconnu]';
186
 
1389 raphael 187
 
188
		if(isset($parametres['justthrow'])) return $observation;
189
 
761 gduche 190
		// Mettre en forme le résultat et l'envoyer pour affichage
191
		$resultat = new ResultatService();
192
		$resultat->corps = $observation;
193
		return $resultat;
194
	}
1385 raphael 195
 
196
	static function chargerObservation($db, $idobs) {
197
		// prenom_utilisateur, nom_utilisateur, courriel_utilisateur sont exclus du mapping
198
		// car nous utilisons une construction SQL élaborée pour eux (cf IFNULL ci-dessous)
199
		$obs_fields = self::sqlFieldsToAlias(self::$mappings['observations'], NULL, 'dob');
200
 
201
		$image_fields = self::sqlFieldsToAlias(self::$mappings['images'], NULL, 'dob');
202
 
203
		// champs de l'annuaire (del_utilisateur): id_utilisateur prenom, nom, courriel
204
		$annuaire_fields = implode(', ', array("IFNULL(du.prenom, prenom_utilisateur) AS `auteur.prenom`",
205
											   "IFNULL(du.nom, nom_utilisateur) AS `auteur.nom`",
206
											   "IFNULL(du.courriel, courriel_utilisateur) AS observateur"));
207
		return $db->recupererTous(sprintf(
208
			'SELECT %s, %s, %s FROM v_del_image as dob'.
209
			' LEFT JOIN del_utilisateur du ON CAST(du.id_utilisateur AS CHAR) = CAST(dob.ce_utilisateur AS CHAR)'.
210
			' WHERE dob.id_observation = %d -- %s',
211
			$obs_fields, $image_fields, $annuaire_fields, $idobs, __FILE__ . ':' . __LINE__));
212
	}
213
 
761 gduche 214
 
1385 raphael 215
	// Charger les images et leurs votes associés
216
	static function chargerVotesImage($db, $images, $protocole = NULL) {
217
		if(!$images) return NULL;
218
 
219
 		$select = array('votes' =>
220
						array('id_vote', 'ce_image', 'ce_protocole', 'ce_utilisateur', 'valeur', 'date', /* del_image_vote */),
221
						'protocole' =>
222
						array('id_protocole', 'intitule', 'descriptif', 'tag' /* del_image_protocole */ ));
223
		$vote_fields = self::sqlFieldsToAlias(self::$mappings['votes'], $select['votes'], 'v'); // "v": cf alias dans la requête
224
		$proto_fields = self::sqlFieldsToAlias(self::$mappings['protocoles'], $select['protocole'], 'p');
225
 
226
		$where = array();
227
		$where[] = sprintf('v.ce_image IN (%s)',
228
						   implode(',', array_values(array_map(create_function('$a', 'return $a["id_image"];'), $images))));
229
 
230
		if ($protocole) {
231
			$where[] = "v.ce_protocole = $protocole";
761 gduche 232
		}
1385 raphael 233
 
234
		return $db->recupererTous(sprintf(
235
			'SELECT %s, %s FROM del_image_vote AS v'.
236
			' INNER JOIN del_image_protocole p ON v.ce_protocole = p.id_protocole'.
237
			' WHERE %s -- %s',
238
			$vote_fields, $proto_fields,
239
			$where ? implode(' AND ', $where) : 1,
240
			__FILE__ . ':' . __LINE__));
761 gduche 241
	}
242
 
243
	/**
1385 raphael 244
	 * Formater une observation depuis une ligne liaison
245
	 * @param $liaison liaison issue de la recherche
246
	 * @return $observation l'observation mise en forme
247
	 * Exemple: vote, au sortir de MySQL contient:
248
	 * 'xxx' => 'blah', 'descriptif' => 'foo', 'valeur' => 3
249
	 * et le tableau de mapping contient:
250
	 * descriptif = protocole.descriptif, valeur = vote
251
	 * Alors $retour[ contient:
252
	 *
761 gduche 253
	 * */
1385 raphael 254
	static function mapVotesToImages($votes, &$images) {
255
		if(!$votes) return;
256
 
257
		// pour chaque vote
258
		foreach ($votes as $vote) {
259
			$imgid = $vote['image.id'];
260
			$protoid = $vote['protocole.id'];
761 gduche 261
 
1385 raphael 262
			// un vote sans image associée ? est-ce possible ?
263
			// if(!isset($images[$imgid])) continue;
264
 
265
			if(!array_key_exists('protocoles_votes', $images[$imgid]) ||
266
			   !array_key_exists($protoid, $images[$imgid]['protocoles_votes'])) {
267
				// extrait les champs spécifique au protocole (le LEFT JOIN de chargerVotesImage les ramène en doublons
268
				$protocole = array_intersect_key($vote, array_flip(self::$mappings['protocoles']));
269
				$images[$imgid]['protocoles_votes'][$protoid] = $protocole;
761 gduche 270
			}
271
 
1385 raphael 272
			$vote = array_intersect_key($vote, array_flip(self::$mappings['votes']));
273
			$images[$imgid]['protocoles_votes'][$protoid]['votes'][$vote['vote.id']] = $vote;
761 gduche 274
		}
275
	}
1361 raphael 276
 
1385 raphael 277
	// Charger les commentaires et leurs votes associés
278
	static function chargerCommentaires($db, &$observation) {
279
		$select = array('votes' =>
280
						array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date' /* del_commentaire_vote */),
281
						'commentaires' =>
282
						array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte',
283
							  'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel',
284
							  'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date',
285
							  'proposition_initiale'));
286
		$vote_fields = self::sqlFieldsToAlias(self::$mappings['votes'], $select['votes'], 'cv'); // "v": cf alias dans la requête
287
		$comment_fields = self::sqlFieldsToAlias(self::$mappings['commentaires'], $select['commentaires'], 'dc');
288
 
289
		$commentaires = $db->recupererTous(sprintf(
290
			"SELECT %s, %s FROM del_commentaire as dc".
291
			// LEFT JOIN optionnel, mais explicatif:
292
			// on ne récupère des infos de vote que pour les commentaires comportant un
293
			// nom_sel "valide"
294
			" LEFT JOIN del_commentaire_vote cv".
295
			" ON cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL".
296
			" WHERE ce_observation = %d -- %s",
297
			$comment_fields, $vote_fields,
298
			$observation['id_observation'],
1358 raphael 299
			__FILE__ . ':' . __LINE__));
841 aurelien 300
 
1358 raphael 301
		if(!$commentaires) return;
302
 
1385 raphael 303
		// les commentaires réunifiées et dont les votes sont mergés
304
		$ret = array();
305
		foreach ($commentaires as $comment) {
306
			$commentid = $comment['id_commentaire'];
307
			$voteid = $comment['vote.id'];
308
 
309
			if(!array_key_exists($commentid, $ret)) {
310
				$comment_extract = array_intersect_key($comment, array_flip(self::$mappings['commentaires']));
311
				// cas particulier: conflit d'aliases avec del_commentaire_vote
312
				$comment_extract['auteur.id'] = $comment_extract['__auteur_com'];
313
				$comment_extract['date'] = $comment_extract['__date_com'];
314
				unset($comment_extract['__auteur_com'], $comment_extract['__date_com']);
315
 
316
				// toujours un éléments "votes", quand bien même il n'y en aurait pas
317
				$comment_extract['votes'] = array();
318
				$ret[$commentid] = $comment_extract;
787 delphine 319
			}
1385 raphael 320
 
321
			if(!$comment['nom_sel'] || ! $voteid) continue;
322
			$vote = array_intersect_key($comment, array_flip(self::$mappings['votes']));
323
			$ret[$commentid]['votes'][$voteid] = $vote;
787 delphine 324
		}
1385 raphael 325
		$observation['commentaires'] = $ret;
761 gduche 326
	}
327
 
1385 raphael 328
 
329
	/* SQL helper
330
	   Converti un tableau associatif et un préfix optionnel en une chaîne de champs adéquate
331
	   à un SELECT MySQL.
332
	   $select (optionnel) restreint les champs mappés aux valeurs de $select.
333
	   Si $select n'est pas fourni, toutes les clefs présentes dans $map seront présentes dans
334
	   le SELECT en sortie */
335
	static function sqlFieldsToAlias($map, $select = NULL, $prefix = NULL) {
336
		if($select) $arr = array_intersect_key($map, array_flip($select));
337
		else $arr = $map;
338
		$keys = array_keys($arr);
339
 
340
		if($prefix) array_walk($keys, create_function('&$val, $k, $prefix', '$val = sprintf("%s.`%s`", $prefix, $val);'), $prefix);
341
		else array_walk($keys, create_function('&$val, $k', '$val = sprintf("`%s`", $val);'));
342
 
343
		return implode(', ', array_map(create_function('$v, $k', 'return sprintf("%s AS `%s`", $k, $v);'), $arr, $keys));
761 gduche 344
	}
345
 
1385 raphael 346
}