Subversion Repositories eFlore/Applications.del

Rev

Rev 1705 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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