/branches/v1.1-helium/services/modules/0.1/observations/ListeObservations.php |
---|
New file |
0,0 → 1,435 |
<?php |
/** |
* Le web service observations récupère toutes les observations et, pour chacune d'elle, les |
* images qui lui sont associées. |
* Basée sur la classe antérieure dans ListeObservations.php de |
* Grégoire Duché et Aurélien Peronnet |
* (formaterVote, formaterDeterminations, chargerNombreCommentaire, chargerVotes, chargerDeterminations) |
* |
* @category php 5.2 |
* @package del |
* @author Raphaël Droz <raphael@tela-botanica.org> |
* @copyright Copyright (c) 2013 Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations |
* |
* TODO: |
* PDO::prepare() |
* Sphinx pour auteur, genre, ns, commune, tag et masque-général |
*/ |
require_once(dirname(__FILE__) . '/../DelTk.php'); |
/* |
restore_error_handler(); |
restore_exception_handler(); |
error_reporting(E_ALL); |
*/ |
class ListeObservations { |
private $conteneur; |
private $gestionBdd; |
private $bdd; |
private $parametres = array(); |
private $ressources = array(); |
static $tris_possibles = array('date_observation'); |
// paramètres autorisés |
static $sql_fields_liaisons = array( |
'dob' => array('id_observation', 'nom_sel AS `determination.ns`', 'nt AS `determination.nt`', |
'nom_sel_nn AS `determination.nn`', 'famille AS `determination.famille`', |
'nom_referentiel AS `determination.referentiel`', |
'ce_zone_geo AS id_zone_geo', 'zone_geo', 'lieudit', |
'station', 'milieu', 'date_observation', 'mots_cles_texte', 'date_transmission', |
'ce_utilisateur AS `auteur.id`', 'prenom_utilisateur AS `auteur.prenom`', |
'nom_utilisateur AS `auteur.nom`', 'courriel_utilisateur AS observateur', |
'commentaire'), |
'di' => array('id_image', 'date_prise_de_vue AS `date`', 'hauteur',/* 'largeur','nom_original' // apparemment inutilisés */), |
'du' => array('prenom', 'nom', 'courriel'), |
'dc' => array('commentaire') |
); |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->conteneur->chargerConfiguration('config_departements_bruts.ini'); |
$this->conteneur->chargerConfiguration('config_observations.ini'); |
$this->conteneur->chargerConfiguration('config_mapping_votes.ini'); |
$this->conteneur->chargerConfiguration('config_mapping_commentaires.ini'); |
$this->navigation = $conteneur->getNavigation(); |
$this->masque = $conteneur->getMasque(); |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
} |
static function reformateObservation($obs, $url_pattern = '') { |
$obs = array_map('array_filter', $obs); |
$obs_merged = array(); |
foreach($obs as $o) { |
$id = $o['id_observation']; |
// car auteur.id peut être un email, un hash, ou un annuaire_tela.U_ID |
// mais dans les deux premiers cas SELECT courriel AS observateur fait déjà l'affaire |
if(!isset($o['auteur.id']) || !is_numeric($o['auteur.id'])) $o['auteur.id'] = "0"; |
if(!isset($o['auteur.nom'])) $o['auteur.nom'] = '[inconnu]'; |
$image = array_intersect_key($o, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original'))); |
$image['binaire.href'] = sprintf($url_pattern, $image['id_image']); |
unset($o['id_image'], $o['date'], $o['hauteur'], $o['largeur'], $o['nom_original']); |
if(!isset($obs_merged['"' . $id . '"'])) $obs_merged['"' . $id . '"'] = $o; |
$obs_merged['"' . $id . '"']['images'][] = $image; |
} |
return $obs_merged; |
} |
/** |
* Méthode principale de la classe. |
* Lance la récupération des images dans la base et les place dans un objet ResultatService |
* pour l'afficher. |
* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2) |
* @param array $parametres les paramètres situés après le ? dans l'url |
**/ |
public function consulter($ressources, $parametres) { |
// SELECT, à terme, pourrait affecter getInfos(), mais en aucune manière getIdObs() |
$req = array('select' => array(), 'join' => array(), 'where' => array(), 'groupby' => array(), 'having' => array()); |
// toujours nécessaire puisque nous tapons sur v_del_image qui INNER JOIN cel_images, or nous voulons certes |
// toutes les images, mais nous voulons $limite observations uniques. |
$req['groupby'][] = 'vdi.id_observation'; |
$db = $this->bdd; |
// filtrage de l'INPUT |
$params = DelTk::requestFilterParams($parametres, DelTk::$parametres_autorises, $this->conteneur); |
$params['masque.tag'] = DelTk::buildTagsAST(@$parametres['masque.tag'], 'OR', ','); |
// ... et paramètres par défaut |
$params = array_merge(DelTk::$default_params, $params); |
// création des contraintes (masques) |
DelTk::sqlAddConstraint($params, $db, $req); |
self::sqlAddConstraint($params, $db, $req, $this->conteneur); |
self::sqlAddMasqueConstraint($params, $db, $req, $this->conteneur); |
// 1) grunt-work: *la* requête de récupération des id valides (+ SQL_CALC_FOUND_ROWS) |
$idobs_tab = self::getIdObs($params, $req, $db); |
// idobs est une liste (toujours ordonnée) des id d'observations recherchées |
$idobs = array_values(array_map(create_function('$a', 'return $a["id_observation"];'), $idobs_tab)); |
if($idobs) { |
$total = $db->recuperer('SELECT FOUND_ROWS() AS c'); $total = intval($total['c']); |
// 2) récupération des données nécessaires pour ces observations (obs + images) |
// ici les champs récupérés sont issus de self::$sql_fields_liaisons mais sans préfixes |
// car tout provient de v_del_image |
$obs_unfmt = self::getInfos($idobs, $db); |
// 3) suppression, merge des données en tableau assez représentatif du futur JSON en output |
$observations = self::reformateObservation($obs_unfmt, $this->conteneur->getParametre('url_images')); |
// 4) récupération des données nécessaires pour ces observations (commentaires + votes) |
// modifie $observations |
$this->configurer(); |
$this->chargerDeterminations($observations); |
// 5) restauration de l'ordre souhaité initialement |
$observations = self::sortArrayByArray($observations, $idobs); |
} else { |
$observations = array(); |
$total = 0; |
} |
// 6) JSON output |
$resultat = new ResultatService(); |
$resultat->corps = array('entete' => DelTk::makeJSONHeader($total, $params, Config::get('url_service')), |
'resultats' => $observations); |
return $resultat; |
} |
static function sortArrayByArray($array, $orderArray) { |
$ordered = array(); |
foreach($orderArray as $key) { |
if(array_key_exists('"' . $key . '"', $array)) { |
$ordered['"' . $key . '"'] = $array['"' . $key . '"']; |
unset($array['"' . $key . '"']); |
} |
} |
return $ordered + $array; |
} |
// SQL helpers |
/* |
* Retourne une liste ordonnée d'id d'observation correspondant aux critères |
* passés dans p et aux clauses where/join présentes dans le tableau $req |
* |
* @param p: $params (filtrés sauf escape-string) |
* @param req: le tableau représentant les composants de la requete SQL |
* @param db: l'instance de db |
*/ |
static function getIdObs($p, $req, $db) { |
$req_s = sprintf('SELECT SQL_CALC_FOUND_ROWS id_observation' . |
' FROM v_del_image vdi'. |
' %s' . // LEFT JOIN if any |
' WHERE %s'. // where-clause ou TRUE |
' %s'. // group-by |
' %s'. // having (si commentaires) |
' ORDER BY %s %s %s'. |
' LIMIT %d, %d -- %s', |
$req['join'] ? implode(' ', $req['join']) : '', |
$req['where'] ? implode(' AND ', $req['where']) : 'TRUE', |
$req['groupby'] ? ('GROUP BY ' . implode(', ', array_unique($req['groupby']))) : '', |
$req['having'] ? ('HAVING ' . implode(' AND ', $req['having'])) : '', |
$p['tri'], strtoupper($p['ordre']), |
// date_transmission peut-être NULL et nous voulons de la consistence |
// (sauf après r1860 de Cel) |
$p['tri'] == 'date_transmission' ? ', id_observation' : '', |
$p['navigation.depart'], $p['navigation.limite'], __FILE__ . ':' . __LINE__); |
$res = $db->recupererTous($req_s); |
$err = mysql_error(); |
if(!$res && $err) { |
// http_response_code(400); |
// if(defined('DEBUG') && DEBUG) header("X-Debug: $req_s"); |
throw new Exception('not found', 400); |
} |
// ordre préservé, à partir d'ici c'est important. |
return $res; |
} |
/* |
Champs récupérés: |
Pour del_images, la vue retourne déjà ce que nous recherchons de cel_obs et cel_images |
(cel_obs.* et cel_[obs_]images.{id_observation, id_image, date_prise_de_vue AS date, hauteur, largeur}) |
Pour del_commentaires: nous voulons * |
Reste ensuite à formatter. |
Note: le préfixe de table utilisé ici (vdi) n'impacte *aucune* autre partie du code car rien |
n'en dépend pour l'heure. (inutilisation de $req['select']) |
*/ |
static function getInfos($idobs, $db) { |
/*$select_fields = implode(',', array_merge( |
array_map(create_function('$a', 'return "vdi.".$a;'), self::$sql_fields_liaisons['dob']), |
array_map(create_function('$a', 'return "vdi.".$a;'), self::$sql_fields_liaisons['di']), |
array_map(create_function('$a', 'return "du.".$a;'), self::$sql_fields_liaisons['du'])));*/ |
$select_fields = array_merge(self::$sql_fields_liaisons['dob'], |
self::$sql_fields_liaisons['di']); |
$req_s = sprintf('SELECT %s FROM v_del_image vdi'. |
// ' LEFT JOIN del_commentaire AS dc ON di.id_observation = dc.ce_observation AND dc.nom_sel IS NOT NULL'. |
' WHERE id_observation IN (%s)', |
implode(',', $select_fields), |
implode(',', $idobs)); |
return $db->recupererTous($req_s); |
} |
/** |
* Complément à DelTk::sqlAddConstraint() |
* |
* @param $p les paramètres (notamment de masque) passés par l'URL et déjà traités/filtrés (sauf quotes) |
* @param $req le tableau, passé par référence représentant les composants de la requête à bâtir |
* @param $c conteneur, utilisé soit pour l'appel récursif à requestFilterParams() en cas de param "masque" |
* soit pour la définition du type (qui utilise la variable nb_commentaires_discussion) |
*/ |
static function sqlAddConstraint($p, $db, &$req, Conteneur $c = NULL) { |
if(!empty($p['masque.tag'])) { |
// TODO: remove LOWER() lorsqu'on est sur que les tags sont uniformés en minuscule |
// i_mots_cles_texte provient de la VIEW v_del_image |
if(isset($p['masque.tag']['AND'])) { |
/* Lorsque nous interprêtons la chaîne provenant du masque général (cf: buildTagsAST($p['masque'], 'OR', ' ') dans sqlAddMasqueConstraint()), |
nous sommes splittés par espace. Cependant, assurons que si une virgule à été saisie, nous n'aurons pas le motif |
" AND CONCAT(mots_cles_texte, i_mots_cles_texte) REGEXP ',' " dans notre requête. |
XXX: Au 12/11/2013, une recherche sur tag depuis le masque général implique un OU, donc le problème ne se pose pas ici */ |
$subwhere = array(); |
foreach($p['masque.tag']['AND'] as $tag) { |
if(trim($tag) == ',') continue; |
$subwhere[] = sprintf('LOWER(CONCAT(%s)) REGEXP %s', |
DelTk::sqlAddIfNullPourConcat(array('vdi.mots_cles_texte', 'vdi.i_mots_cles_texte')), |
$db->proteger(strtolower($tag))); |
} |
$req['where'][] = '(' . implode(' AND ', $subwhere) . ')'; |
} |
else { |
$req['where'][] = sprintf('LOWER(CONCAT(%s)) REGEXP %s', |
DelTk::sqlAddIfNullPourConcat(array('vdi.mots_cles_texte', 'vdi.i_mots_cles_texte')), |
$db->proteger(strtolower(implode('|', $p['masque.tag']['OR'])))); |
} |
} |
if(!empty($p['masque.type'])) { |
self::addTypeConstraints($p['masque.type'], $db, $req, $c); |
} |
} |
/* Le masque fait une recherche générique parmi de nombreux champs ci-dessus. |
Nous initialisons donc ces paramètres (excepté masque biensur), et nous rappelons |
récursivement. À la seule différence que nous n'utiliserons que $or_req['where'] |
imploded par des " OR ". */ |
static function sqlAddMasqueConstraint($p, $db, &$req, Conteneur $c = NULL) { |
if(!empty($p['masque'])) { |
$or_params = array('masque.auteur' => $p['masque'], |
'masque.departement' => $p['masque'], |
'masque.id_zone_geo' => $p['masque'], |
'masque.tag' => $p['masque'], |
'masque.ns' => $p['masque'], |
'masque.famille' => $p['masque'], |
'masque.date' => $p['masque'], |
'masque.genre' => $p['masque'], |
/* milieu: TODO ? */ ); |
/* Cependant les champs spécifiques ont priorité sur le masque général. |
Pour cette raison nous supprimons la génération de SQL du masque général sur les |
champ spécifiques qui feront l'objet d'un traitement avec une valeur propre. */ |
if(isset($p['masque.auteur'])) unset($or_params['masque.auteur']); |
if(isset($p['masque.departement'])) unset($or_params['masque.departement']); |
if(isset($p['masque.id_zone_geo'])) unset($or_params['masque.id_zone_geo']); |
if(isset($p['masque.tag'])) unset($or_params['masque.tag']); |
if(isset($p['masque.famille'])) unset($or_params['masque.famille']); |
if(isset($p['masque.date'])) unset($or_params['masque.date']); |
if(isset($p['masque.genre'])) unset($or_params['masque.genre']); |
$or_masque = DelTk::requestFilterParams($or_params, array_keys($or_params), $c); |
if(isset($or_params['masque.tag'])) { |
$or_masque['masque.tag'] = DelTk::buildTagsAST($p['masque'], 'OR', ' '); |
} |
// $or_req = array('select' => array(), 'join' => array(), 'where' => array(), 'groupby' => array(), 'having' => array()); |
$or_req = array('join' => array(), 'where' => array()); |
DelTk::sqlAddConstraint($or_masque, $db, $or_req); |
self::sqlAddConstraint($or_masque, $db, $or_req); |
if($or_req['where']) { |
$req['where'][] = '(' . implode(' OR ', $or_req['where']) . ')'; |
// utile au cas ou des jointures seraient rajoutées |
$req['join'] = array_unique(array_merge($req['join'], $or_req['join'])); |
} |
} |
} |
private function configurer() { |
$this->mappingVotes = $this->conteneur->getParametre('mapping_votes'); |
$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire'); |
} |
/* |
* @param $req: la représentation de la requête MySQL complète, à amender. |
*/ |
static function addTypeConstraints($val, $db, &$req, Conteneur $c) { |
if(array_key_exists('adeterminer', $val)) { |
// On récupère toutes les observations qui on le tag "aDeterminer" *ou* qui n'ont pas de nom d'espèce |
// *ou* qui ont la "certitude" à ("aDeterminer" *ou* "douteux") |
$req['where'][] = '(' . implode(' OR ', array( |
'vdi.certitude = "aDeterminer"', |
'vdi.certitude = "douteux"', |
'vdi.mots_cles_texte LIKE "%aDeterminer%"', |
'vdi.nom_sel_nn IS NULL', // TODO: ensure pas d'entrée à 0 |
)) . ')'; |
} |
if(array_key_exists('validees', $val)) { |
//On récupère toutes les observations ayant un commentaire doté de proposition_retenue = 1 |
$req['join'][] = 'INNER JOIN del_commentaire AS dc ON vdi.id_observation = dc.ce_observation AND dc.proposition_retenue = 1'; |
} |
// solution n°1: impraticable |
if(false && array_key_exists('endiscussion', $val)) { |
//Si on veut les observations en discussion, |
// on va récupérer les ids des observations dont le nombre de commentaire est supérieur à N |
$req['select'][] = 'COUNT(dc.id_commentaire) AS comm_count'; |
$req['join'][] = 'INNER JOIN del_commentaire AS dc ON vdi.id_observation = dc.ce_observation'; |
$req['groupby'][] = 'vdi.id_observation'; |
$req['having'][] = "COUNT(id_commentaire) > " . $c->getParametre('nb_commentaires_discussion'); |
} |
if(array_key_exists('endiscussion', $val)) { |
$req['where'][] = '(SELECT COUNT(id_commentaire) FROM del_commentaire AS dc'. |
' WHERE ce_observation = id_observation) > ' . intval($c->getParametre('nb_commentaires_discussion')); |
} |
} |
/** |
* Récupérer toutes les déterminations et le nombre de commentaire au total |
* @param array $observations la liste des observations à mettre à jour |
* */ |
private function chargerDeterminations(&$observations) { |
$idObs = array_values(array_map(create_function('$a', 'return $a["id_observation"];'), |
$observations)); |
$r = sprintf('SELECT * FROM del_commentaire AS dc WHERE dc.nom_sel IS NOT NULL AND ce_observation IN (%s) -- %s', |
implode(',',$idObs), |
__FILE__ . ':' . __LINE__); |
$propositions = $this->bdd->recupererTous($r); |
if(!$propositions) return; |
foreach ($propositions as $proposition) { |
$idObs = $proposition['ce_observation']; |
$idComment = $proposition['id_commentaire']; |
$comment = $this->formaterDetermination($idComment, $proposition); |
if($comment) $observations['"' . $idObs . '"']['commentaires'][$idComment] = $comment; |
} |
} |
private function formaterDetermination($commentId, $proposition) { |
if(!$proposition) return NULL; |
$proposition_formatee = array('nb_commentaires' => '0'); |
foreach ($this->mappingCommentaire as $nomOriginal => $nomFinal) { |
if (isset($proposition[$nomOriginal])) { |
$proposition_formatee[$nomFinal] = $proposition[$nomOriginal]; |
} |
} |
// Charger les votes sur les déterminations |
$resultatsVotes = $this->bdd->recupererTous( |
sprintf('SELECT * FROM del_commentaire_vote WHERE ce_proposition = %d', $commentId)); |
foreach ($resultatsVotes as $vote) { |
$proposition_formatee['votes'][$vote['id_vote']] = $this->formaterVote($vote); |
} |
// chargerNombreCommentaire() |
// Charger le nombre de commentaires (sans détermination) associé à l'observation |
$listeCommentaires = $this->bdd->recupererTous(sprintf( |
'SELECT ce_commentaire_parent, ce_proposition, COUNT( id_commentaire ) AS nb '. |
'FROM del_commentaire WHERE ce_proposition = %d GROUP BY ce_proposition -- %s', |
$commentId, __FILE__ . ':' . __LINE__)); |
foreach ($listeCommentaires as $ligneProposition) { |
// ce test sert à exclure les proposition de 1er niveau qui sont elles aussi des commentaires |
if($ligneProposition['ce_commentaire_parent']) { |
// TODO/debug: id_commentaire_parent != $commentId ?? |
// reprendre la "logique" du code... moins de boucles, moins de requêtes, ... |
if($ligneProposition['ce_commentaire_parent'] != $commentId) { |
// restore_error_handler(); |
error_log(sprintf("possible error: nb_commentaires = %s: comment = %d, parent = %d, %s", |
$ligneProposition['nb'], $commentId, $ligneProposition['ce_commentaire_parent'], __FILE__)); |
} |
$proposition_formatee['nb_commentaires'] = $ligneProposition['nb']; |
} else { |
$proposition_formatee['observation']['nb_commentaires'] = $ligneProposition['nb']; |
} |
} |
return $proposition_formatee; |
} |
/** |
* Formater un vote en fonction du fichier de configuration config_votes.ini |
* @param $votes array() |
* */ |
private function formaterVote($vote) { |
$retour = array(); |
foreach ($vote as $param=>$valeur) { |
$retour[$this->mappingVotes[$param]] = $valeur; |
} |
return $retour; |
} |
} |
/branches/v1.1-helium/services/modules/0.1/observations/ListeObservationsWidget.php |
---|
New file |
0,0 → 1,394 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Le web service observations récupère toutes les observations et, pour chacune d'elle, les |
* images qui lui sont associées. |
* |
* @category php 5.2 |
* @package del |
* @subpackage images |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org> |
* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $ |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations |
*/ |
class ListeObservationsWidget { |
private $conteneur; |
private $navigation; |
private $masque; |
private $gestionBdd; |
private $bdd; |
private $parametres = array(); |
private $ressources = array(); |
private $tri = 'date_transmission'; |
private $directionTri = 'desc'; |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->conteneur->chargerConfiguration('config_observations.ini'); |
$this->conteneur->chargerConfiguration('config_departements_bruts.ini'); |
$this->navigation = $conteneur->getNavigation(); |
$this->masque = $conteneur->getMasque(); |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
} |
/** |
* Méthode principale de la classe. |
* Lance la récupération des images dans la base et les place dans un objet ResultatService |
* pour l'afficher. |
* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2) |
* @param array $parametres les paramètres situés après le ? dans l'url |
* */ |
public function consulter($ressources, $parametres) { |
$this->initialiserRessourcesEtParametres($ressources, $parametres); |
// Gestion des configuration du script |
$this->configurer(); |
$this->verifierConfiguration(); |
$this->verifierParametresTri(); |
$this->initialiserTri(); |
// Lancement du service |
$observations = $this->chargerObservations(); |
$total = $this->compterObservations(); |
$this->navigation->setTotal($total); |
$observations = $this->formaterObservations($observations); |
// Mettre en forme le résultat et l'envoyer pour affichage |
$resultat = new ResultatService(); |
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $observations); |
return $resultat; |
} |
private function initialiserRessourcesEtParametres($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
} |
private function verifierParametresTri() { |
$erreurs = array(); |
$tris_possibles = $this->conteneur->getParametre('tris_possibles'); |
$tris_possibles_tableau = explode(',', $tris_possibles); |
if(isset($this->parametres['tri']) && !in_array($this->parametres['tri'], $tris_possibles_tableau)) { |
$erreurs[] = '- le type de tri demandé est incorrect, les valeurs possibles sont '.$tris_possibles.' ;'; |
} |
$directions_tri = array('asc', 'desc'); |
if(isset($this->parametres['ordre']) && !in_array($this->parametres['ordre'], $directions_tri)) { |
$erreurs[] = '- la direction du tri demandé est incorrecte, les valeurs supportées sont asc ou desc ;'; |
} |
if (!empty($erreurs)) { |
$e = 'Erreur lors de l\'analyse des parametres du tri : '."\n"; |
$e .= implode("\n", $erreurs); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
} |
private function initialiserTri() { |
$this->tri = isset($this->parametres['tri']) ? $this->parametres['tri'] : $this->tri; |
$this->directionTri = isset($this->parametres['ordre']) ? $this->parametres['ordre'] : $this->directionTri; |
} |
/*------------------------------------------------------------------------------- |
CONFIGURATION DU SERVICE |
--------------------------------------------------------------------------------*/ |
/** |
* Configuration du service en fonction du fichier de config config_del.ini |
* */ |
private function configurer() { |
$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque'); |
$this->mappingObservation = $this->conteneur->getParametre('mapping_observation'); |
$this->mappingVotes = $this->conteneur->getParametre('mapping_votes'); |
$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire'); |
} |
/** |
* Vérifier que le service est bien configuré |
* */ |
private function verifierConfiguration() { |
$erreurs = array(); |
$tableauObservations = $this->conteneur->getParametre('observations'); |
if (empty($tableauObservations)) { |
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [images] ou celui-ci est vide ;'; |
} else { |
if ($this->conteneur->getParametre('url_service') == null) { |
$erreurs[] = '- paramètre "url_service" manquant ;'; |
} |
if ($this->conteneur->getParametre('url_images') == null) { |
$erreurs[] = '- paramètre "url_images" manquant ;'; |
} |
} |
if (empty($this->mappingObservation)) { |
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_observation] ou celui-ci est vide ;'; |
} else { |
$champsMappingObs = array('id_observation', 'date_observation', 'date_transmission', 'famille', 'nom_sel', 'nom_sel_nn', 'nt', |
'ce_zone_geo', 'zone_geo', 'lieudit', 'station', 'courriel', 'ce_utilisateur', 'nom', 'prenom'); |
foreach ($champsMappingObs as $champ) { |
if (!isset($this->mappingObservation[$champ])) { |
$erreurs[] = '- le mapping du champ "'.$champ.'" pour l\'observation est manquant ;'; |
} |
} |
} |
if (!empty($erreurs)) { |
$e = 'Erreur lors de la configuration : '."\n"; |
$e .= implode("\n", $erreurs); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
} |
/** |
* Charger la clause WHERE en fonction des paramètres de masque |
* */ |
private function chargerClauseWhere() { |
$where = array(); |
$tableauMasque = $this->masque->getMasque(); |
if (!empty($tableauMasque)) { |
foreach($tableauMasque as $idMasque => $valeurMasque) { |
$idMasque = str_replace('masque.', '', $idMasque); |
switch ($idMasque) { |
// nom du masque => nom BDD |
case 'auteur' : |
$whereAuteur = ' '.$this->creerFiltreAuteur($this->masque->getMasque('auteur')); |
if($whereAuteur != '') { |
$where[] = $whereAuteur; |
} |
break; |
case 'date' : |
$whereDate = ' '.$this->creerFiltreDate($valeurMasque); |
if($whereDate != '') { |
$where[] = $whereDate; |
} |
break; |
case 'departement' : |
$where[] = ' '.$this->creerFiltreIdZoneGeo($valeurMasque); |
break; |
case 'genre' : |
$where[] = ' '.$this->mappingFiltre['ns'].' LIKE '.$this->proteger('%'.$valeurMasque.'% %'); |
break; |
case 'tag' : |
$where[] = ' '.$this->creerFiltreMotsCles($valeurMasque); |
break; |
case 'ns' : |
$where[] = ' nom_sel LIKE '.$this->proteger($valeurMasque.'%'); |
break; |
case 'commune' : |
$where[] = ' '.$this->mappingFiltre[$idMasque].' LIKE '.$this->proteger(str_replace(array('-',' '), '_', $valeurMasque).'%'); |
break; |
case 'masque' : |
$where[] = ' '.$this->creerFiltreMasqueGeneral($valeurMasque); |
break; |
default: |
$where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque); |
break; |
} |
} |
} |
if (!empty($where)) { |
return ' WHERE '.implode('AND', $where); |
} else { |
return; |
} |
} |
private function creerFiltreMasqueGeneral($valeurMasque) { |
//TODO: affecter d'aborder les variables, puis les tester pour les |
// ajouter à la chaine |
$whereAuteur = $this->creerFiltreAuteur($valeurMasque); |
$whereIdZoneGeo = $this->creerFiltreIdZoneGeo($valeurMasque); |
$masqueGeneral = '( '. |
(($whereAuteur != '') ? $whereAuteur.' OR ' : '' ). |
(($whereIdZoneGeo != '') ? $whereIdZoneGeo.' OR ' : '' ). |
'zone_geo LIKE '.$this->proteger($this->remplacerParJokerCaractere($valeurMasque).'%').' OR '. |
$this->creerFiltreMotsCles($valeurMasque).' OR '. |
'nom_sel LIKE '.$this->proteger($valeurMasque.'%').' OR '. |
'famille LIKE '.$this->proteger($valeurMasque.'%').' OR '. |
'milieu LIKE '.$this->proteger($valeurMasque).' OR '. |
$this->mappingFiltre['ns'].' LIKE '.$this->proteger('%'.$valeurMasque.'% %').' OR '. |
$this->creerFiltreDate($valeurMasque). |
') '; |
return $masqueGeneral; |
} |
private function creerFiltreAuteur($valeurMasque) { |
$masque = ''; |
$auteurId = $valeurMasque; |
if (is_numeric($auteurId)) { |
$masque = ' ce_utilisateur = '.$auteurId; |
} else { |
if (strpos($auteurId, '@') === false) { |
$tableauNomPrenom = explode(' ',$auteurId, 2); |
if(count($tableauNomPrenom) == 2) { |
// on teste potentiellement un nom prenom ou bien un prénom nom |
$masque = '('. |
'(nom LIKE '.$this->proteger($tableauNomPrenom[0].'%').' AND '. |
'prenom LIKE '.$this->proteger($tableauNomPrenom[1].'%').') OR '. |
'(nom LIKE '.$this->proteger($tableauNomPrenom[1].'%').' AND '. |
'prenom LIKE '.$this->proteger($tableauNomPrenom[0].'%').') OR '. |
'(dob.nom_utilisateur LIKE '.$this->proteger($tableauNomPrenom[0].'%').' AND '. |
'dob.prenom_utilisateur LIKE '.$this->proteger($tableauNomPrenom[1].'%').') OR '. |
'(dob.nom_utilisateur LIKE '.$this->proteger($tableauNomPrenom[1].'%').' AND '. |
'dob.prenom_utilisateur LIKE '.$this->proteger($tableauNomPrenom[0].'%').') '. |
')'; |
} else { |
$masque = '( |
(nom LIKE '.$this->proteger($auteurId.'%').' OR '. |
'prenom LIKE '.$this->proteger($auteurId.'%').' OR '. |
'dob.nom_utilisateur LIKE '.$this->proteger($auteurId.'%').' OR '. |
'dob.prenom_utilisateur LIKE '.$this->proteger($auteurId.'%').')'. |
')'; |
} |
} else { |
$masque = " courriel LIKE ".$this->proteger($valeurMasque.'%'). |
" OR dob.courriel_utilisateur LIKE ".$this->proteger($valeurMasque.'%')." "; |
} |
} |
return $masque; |
} |
private function remplacerParJokerCaractere($valeurMasque) { |
return str_replace(array('-',' '), '_', $valeurMasque); |
} |
//TODO: déplacer les fonctions ci dessus et dessous dans une classe |
// utilitaire |
function supprimerAccents($str, $charset='utf-8') |
{ |
$str = htmlentities($str, ENT_NOQUOTES, $charset); |
$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str); |
$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // pour les ligatures e.g. 'œ' |
$str = preg_replace('#&[^;]+;#', '', $str); // supprime les autres caractères |
return $str; |
} |
private function obtenirIdDepartement($nomDpt) { |
$nomDpt = $this->supprimerAccents($nomDpt); |
$nomDpt = strtolower(str_replace(' ','-',$nomDpt)); |
$idDpt = $this->conteneur->getParametre($nomDpt); |
if($idDpt == null || $idDpt == ' ') { |
$idDpt = ' '; |
} |
return $idDpt; |
} |
private function creerFiltreIdZoneGeo($valeurMasque) { |
$masque = ''; |
$dept = $valeurMasque; |
if (is_numeric($dept)) { |
$dept = sprintf('%02s', $dept); |
$dept = sprintf("%-'_5s", $dept); |
$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$dept); |
} else { |
$deptId = $this->conteneur->getParametre($dept); |
if ($deptId != null) { |
$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$deptId.'%'); |
} else { |
$id = $this->obtenirIdDepartement($valeurMasque); |
$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$id.'%'); |
} |
} |
return $masque; |
} |
private function creerFiltreDate($valeurMasque) { |
//TODO: définir dans le fichier de config un tableau contenant plusieurs format de date |
// autorisés pour la recherche, qui seraient ajoutés au OR |
$masque = '('; |
$masque .= (is_numeric($valeurMasque)) ? ' YEAR(date_observation) = '.$this->proteger($valeurMasque).' OR ' : ''; |
$masque .= " DATE_FORMAT(date_observation, '%d/%m/%Y') = ".$this->proteger($valeurMasque).' '. |
')'; |
return $masque; |
} |
private function creerFiltreMotsCles($valeurMasque) { |
$mots_cles = explode(' ', $valeurMasque); |
$requeteMotsClesImg = ''; |
$requeteMotsClesObs = ''; |
//TODO voir s'il existe un moyen plus simple que le foreach + rtrim |
// comme avec implode (attention au fait que l'on concatène des % au début et à la fin) |
foreach($mots_cles as $mot_cle) { |
$requeteMotsCles = $this->proteger('%'.$mot_cle.'%'); |
$requeteMotsClesObs .= 'dob.mots_cles_texte LIKE '.$requeteMotsCles.' AND '; |
} |
$requeteMotsClesImg = rtrim($requeteMotsClesImg, ' AND '); |
$requeteMotsClesObs = rtrim($requeteMotsClesObs, ' AND '); |
$masque = '('. |
'('.$requeteMotsClesImg.') OR '. |
'('.$requeteMotsClesObs.') '. |
') '; |
return $masque; |
} |
/*------------------------------------------------------------------------------- |
CHARGEMENT DES OBSERVATIONS |
--------------------------------------------------------------------------------*/ |
/** |
* Chargement depuis la bdd de toutes les liaisons entre images et observations |
* */ |
private function chargerObservations() { |
$requete = 'SELECT DISTINCT dob.id_observation '. |
'FROM '.$this->gestionBdd->formaterTable('del_observation', 'dob'). |
'INNER JOIN '.$this->gestionBdd->formaterTable('del_obs_image', 'doi'). |
'ON doi.id_observation = dob.id_observation '. |
$this->chargerClauseWhere(). |
' ORDER BY '.$this->tri.' '.$this->directionTri.' '. |
$this->gestionBdd->getLimitSql(); |
return $this->bdd->recupererTous($requete); |
} |
/** |
* Compter le nombre total d'images dans la base pour affichage dans entete. |
* */ |
private function compterObservations() { |
$requete = 'SELECT FOUND_ROWS() AS nbre '; |
$resultats = $this->bdd->recuperer($requete); |
return (int) $resultats['nbre']; |
} |
/** |
* Retourner un tableau d'images formaté en fonction des liaisons trouvées |
* @param $liaisons les liaisons de la table del_obs_images |
* */ |
private function formaterObservations($liaisons) { |
$observations = array(); |
foreach ($liaisons as $liaison) { |
$observations[] = $liaison['id_observation']; |
} |
return $observations; |
} |
/*------------------------------------------------------------------------------- |
FORMATER ET METTRE EN FORME |
--------------------------------------------------------------------------------*/ |
private function proteger($valeur) { |
if (is_array($valeur)) { |
return $this->bdd->protegerTableau($valeur); |
} else { |
return $this->bdd->proteger($valeur); |
} |
} |
} |
?> |
/branches/v1.1-helium/services/modules/0.1/observations/VoteObservation.php |
---|
New file |
0,0 → 1,279 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Les web service permet d'ajouter ou de modifier les votes associés aux propositions d'une observation |
* |
* @category php 5.2 |
* @package del |
* @subpackage images |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org> |
* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $ |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images |
*/ |
class VoteObservation extends RestService { |
protected $conteneur; |
protected $gestionBdd; |
protected $bdd; |
protected $navigation; |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
$this->navigation = $conteneur->getNavigation(); |
$this->conteneur->chargerConfiguration('config_mapping_votes.ini'); |
} |
/** |
* Configuration du service en fonction du fichier de config config_del.ini |
* */ |
private function configurer() { |
$this->mappingVotes = $this->conteneur->getParametre('mapping_votes'); |
} |
/** |
* Méthode seulement présente pour interdire proprement l'accès à la consultation |
* */ |
public function consulter($ressources, $parametres) { |
$this->configurer(); |
//TODO: faut il vérifier quelque chose, si on n'a pas renseigné les valeurs correctement |
// dans ressource, le service n'est même pas appelé |
$votes = $this->chargerVotes($ressources[1]); |
$this->conteneur->getNavigation()->setTotal(count($votes)); |
// Mettre en forme le résultat et l'envoyer pour affichage |
$resultat = new ResultatService(); |
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $votes); |
return $resultat; |
} |
private function chargerVotes($id_commentaire) { |
$requeteVotes = 'SELECT * FROM '. |
$this->gestionBdd->formaterTable('del_commentaire_vote'). |
'WHERE ce_proposition = '.$this->proteger($id_commentaire); |
$resultatsVotes = $this->bdd->recupererTous($requeteVotes); |
$votes = array(); |
foreach ($resultatsVotes as $vote) { |
$votes[$vote['id_vote']] = $this->formaterVotes($vote); |
$utilisateur = $this->chercherUtilisateur($vote['ce_utilisateur']); |
if($utilisateur) { |
$votes[$vote['id_vote']] = array_merge($votes[$vote['id_vote']], $utilisateur); |
} |
} |
return $votes; |
} |
/** |
* Trouver l'utilisateur en fonction des paramètres ou de la base de données si le nom, prénom et courriel ne sont pas donnés |
* @return le tableau utilisateur |
* */ |
private function chercherUtilisateur($id) { |
$utilisateur = array(); |
$requete = "SELECT id_utilisateur as 'auteur.id', nom as 'auteur.nom', prenom as 'auteur.prenom', courriel as 'auteur.courriel' ". |
'FROM '.$this->gestionBdd->formaterTable('del_utilisateur'). |
'WHERE id_utilisateur = '.$this->bdd->proteger($id); |
$utilisateur = $this->bdd->recuperer($requete); |
return $utilisateur; |
} |
/** |
* Formater un vote en fonction du fichier de configuration config_votes.ini |
* @param $votes array() |
* */ |
private function formaterVotes($vote) { |
$retour = array(); |
foreach ($vote as $param => $valeur) { |
$retour[$this->mappingVotes[$param]] = $valeur; |
} |
return $retour; |
} |
/** |
* Ajoute un vote à une proposition grâce aux informations passées en paramètres |
* @param array $ressources tableau des informations contenues dans l'url après le nom du service |
* @param array $parametres contenu du post |
* |
* @return void |
* |
* */ |
public function ajouter($ressources, $parametres) { |
$this->verifierParametresAjoutModif($ressources, $parametres); |
// Vérifie si la proposition existe, et la crée sinon |
// (cas du vote sur la proposition fabriquée à partir de l'observation originale) |
if($ressources[1] == 0) { |
$ressources[1] = $this->renvoyerIdOuCreerPropositionDeterminationInitiale($ressources[0]); |
} |
$insertion = 'INSERT INTO del_commentaire_vote '. |
'(ce_proposition , ce_utilisateur , valeur , date) '. |
'VALUES ('.$this->proteger($ressources[1]).','.$this->proteger($parametres['utilisateur']).','. |
$this->proteger($parametres['valeur']).', NOW());'; |
$resultatsVotes = $this->bdd->requeter($insertion); |
if ($resultatsVotes == false) { |
RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_MAUVAISE_REQUETE); |
} else { |
RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_CREATION_OK); |
} |
} |
private function renvoyerIdPropositionObservation($id_observation) { |
$id_commentaire = null; |
// Récupération de l'utilisateur + nom sel de l'observation originale |
$requete_selection_obs = 'SELECT ce_utilisateur, nom_sel '. |
'FROM del_observation '. |
'WHERE id_observation ='.$this->proteger($id_observation); |
$obs = $this->bdd->recuperer($requete_selection_obs); |
if(is_array($obs) && isset($obs['ce_utilisateur'])) { |
// On considère que la proposition faite par le même utilisateur et ayant le même |
// nom sélectionné est bien la proposition composée à partir de l'obs originale |
$requete_selection_comm = 'SELECT id_commentaire FROM del_commentaire '. |
'WHERE ce_observation = '.$this->proteger($id_observation).' '. |
' AND nom_sel = '.$this->proteger($obs['nom_sel']).' AND '. |
' ce_utilisateur = '.$this->proteger($obs['ce_utilisateur']); |
$commentaire = $this->bdd->recuperer($requete_selection_comm); |
$id_commentaire = (is_array($commentaire) && $commentaire['id_commentaire'] != null) ? $commentaire['id_commentaire'] : null; |
} |
return $id_commentaire; |
} |
private function renvoyerIdOuCreerPropositionDeterminationInitiale($id_observation) { |
$proposition_existe = $this->propositionInitialeExiste($id_observation); |
if(!$proposition_existe) { |
$id_proposition = $this->creerPropositionAPartirObservation($id_observation); |
} else { |
$requete = "SELECT id_commentaire FROM del_commentaire WHERE ce_observation = ".$id_observation." ". |
"AND proposition_initiale = 1"; |
$resultat = $this->bdd->recuperer($requete); |
$id_proposition = $resultat['id_commentaire']; |
} |
return $id_proposition; |
} |
private function propositionInitialeExiste($id_observation) { |
$requete = "SELECT COUNT(*) >= 1 as existe FROM del_commentaire WHERE ce_observation = ".$id_observation." ". |
"AND proposition_initiale = 1"; |
$resultat = $this->bdd->recuperer($requete); |
return $resultat['existe'] == 1; |
} |
private function creerPropositionAPartirObservation($id_observation) { |
$insertion = 'INSERT IGNORE INTO del_commentaire '. |
'(ce_observation, ce_utilisateur, utilisateur_prenom, utilisateur_nom, utilisateur_courriel, '. |
'nom_sel, nom_sel_nn, nom_ret, nom_ret_nn, nt, famille, nom_referentiel, date, proposition_initiale) '. |
'SELECT id_observation, ce_utilisateur, prenom, nom, '. |
' courriel, nom_sel, nom_sel_nn, nom_ret, nom_ret_nn, '. |
" nt, famille, 'bdtfx_v1', NOW(), '1' ". |
'FROM del_observation do '. |
' LEFT JOIN del_utilisateur du ON '. |
'do.ce_utilisateur = du.id_utilisateur '. |
'WHERE id_observation = '.$this->proteger($id_observation); |
$resultat = $this->bdd->requeter($insertion); |
// Attention à l'abstraction utilisée, récupérer le dernier id en mysql ou msqli ça marche bien, mais pour d'autres moins |
$id = $this->bdd->recupererIdDernierAjout(); |
return $id; |
} |
/** |
* Modifie un vote associé à une proposition grâce aux informations passées en paramètres |
* @param array $ressources tableau des informations contenues dans l'url après le nom du service |
* @param array $parametres contenu du post |
* |
* @return void |
* |
* */ |
public function modifier($ressources, $parametres) { |
$this->verifierParametresAjoutModif($ressources, $parametres); |
// Si l'identifiant de proposition vaut 0, c'est un vote sur une proposition |
// fabriquée à partir de l'observation originale, dont on doit obtenir l'id |
// (cas où l'on vient de voter pour celle et cela a créé la proposition, puis |
// on revote pour celle ci en changeant d'avis sans recharger la page) |
if($ressources[1] == 0) { |
$id_proposition = $this->renvoyerIdOuCreerPropositionDeterminationInitiale($ressources[0]); |
if($id_proposition == null) { |
$this->envoyerMessageErreurIdProposition(); |
exit; |
} else { |
$ressources[1] = $id_proposition; |
} |
} |
$modification = 'UPDATE del_commentaire_vote '. |
'SET valeur ='.$this->proteger($parametres['valeur']).', '. |
'date = NOW() '. |
'WHERE '. |
'ce_proposition = '.$this->proteger($ressources[1]).' AND '. |
'ce_utilisateur = '.$this->proteger($parametres['utilisateur']); |
$resultatsVotes = $this->bdd->requeter($modification); |
if ($resultatsVotes == false) { |
RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_MAUVAISE_REQUETE); |
} else { |
RestServeur::envoyerEnteteStatutHttp(RestServeur::HTTP_CODE_OK); |
} |
} |
public function verifierParametresAjoutModif($ressources, $parametres) { |
$erreurs = array(); |
if (!is_numeric($ressources[1])) { |
$erreurs[] = '- le paramètre indiquant l\'identifiant de la proposition doit être numérique ;'; |
} |
if (!isset($parametres['utilisateur'])) { |
$erreurs[] = '- paramètre "utilisateur" manquant ;'; |
} |
if (!isset($parametres['valeur'])) { |
$erreurs[] = '- paramètre "valeur" manquant ;'; |
} else { |
if (!is_numeric($parametres['valeur'])) { |
$erreurs[] = '- le paramètre "valeur" doit être numérique ;'; |
} elseif($parametres['valeur'] != 0 && $parametres['valeur'] != 1) { |
$erreurs[] = '- le paramètre "valeur" ne peut prendre que la valeur 0 ou 1 ;'; |
} |
} |
if (!empty($erreurs)) { |
$e = 'Erreur lors de la configuration : '."\n"; |
$e .= implode("\n", $erreurs); |
RestServeur::ajouterMessage($e); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
} |
protected function envoyerMessageErreurIdProposition() { |
$erreurs = array('Aucun identifiant de proposition n\'est lié à cette observation'); |
$e = 'Erreur lors de la configuration : '."\n"; |
$e .= implode("\n", $erreurs); |
RestServeur::ajouterMessage($e); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
protected function proteger($valeur) { |
if (is_array($valeur)) { |
return $this->bdd->protegerTableau($valeur); |
} else { |
return $this->bdd->proteger($valeur); |
} |
} |
} |
?> |
/branches/v1.1-helium/services/modules/0.1/observations/Observation.php |
---|
New file |
0,0 → 1,347 |
<?php |
/** |
* Le web service observations récupère toutes les information pour une observation: |
* images, votes sur image et protocole, commentaires, votes sur commentaires, ... |
* |
* @category php 5.2 |
* @author Raphaël Droz <raphael@tela-botanica.org> |
* @copyright Copyright (c) 2013, Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations |
* |
* @config-depend: "url_image" (dans configurations/config_observations.ini) |
* ex: http://www.tela-botanica.org/appli:cel-img:%09dXL.jpg |
*/ |
// http://localhost/del/services/0.1/observations/#id => une observation donnée et ses images, SANS LES propositions & nombre de commentaire |
require_once(dirname(__FILE__) . '/../DelTk.php'); |
class Observation { |
/* Map les champs MySQL vers les champs utilisés dans le JSON pour les clients pour |
chacune des différentes tables utilisées pour le chargement de résultats ci-dessous. |
- chargerObservation() (v_del_image) |
- chargerVotesImage() (del_image_vote, del_image_protocole) |
- chargerCommentaires() (del_commentaire_vote, del_commentaire). |
Si la valeur vaut 1, aucun alias ne sera défini (nom du champ d'origine), cf consulter() */ |
static $mappings = array( |
'observations' => array( // v_del_image |
"id_observation" => 1, |
"date_observation" => 1, |
"date_transmission" => 1, |
"famille" => "determination.famille", |
"nom_sel" => "determination.ns", |
"nom_sel_nn" => "determination.nn", |
"nom_referentiel" => "determination.referentiel", |
"nt" => "determination.nt", |
"ce_zone_geo" => "id_zone_geo", |
"zone_geo" => 1, |
"lieudit" => 1, |
"station" => 1, |
"milieu" => 1, |
"ce_utilisateur" => "auteur.id", |
"mots_cles_texte" => "mots_cles_texte", |
"commentaire" => 1), |
/* exclus car issus de la jointure annuaire: |
"nom" => "auteur.nom", // XXX: jointure annuaire |
"prenom" => "auteur.prenom", // XXX: jointure annuaire |
"courriel" => "observateur", // XXX: jointure annuaire */ |
/* présents dans cel_obs mais exclus: |
ordre, nom_ret, nom_ret_nn, latitude, longitude, altitude, geodatum |
transmission, date_creation, date_modificationabondance, certitude, phenologie, code_insee_calcule */ |
'images' => array( // v_del_image |
"id_image" => 1, |
"hauteur" => 1, |
// "largeur" => 1, inutile semble-t-il |
"date_prise_de_vue" => "date"), |
/* présents dans cel_images mais exclus: |
i_commentaire, nom_original, publiable_eflore, i_mots_cles_texte, i_ordre, |
i_ce_utilisateur, i_prenom_utilisateur, i_nom_utilisateur, i_courriel_utilisateur */ |
'protocoles' => array( // del_image_protocole |
"ce_protocole" => "protocole.id", |
"id_protocole" => "protocole.id", |
"intitule" => "protocole.intitule", |
"descriptif" => "protocole.descriptif", |
"tag" => "protocole.tag"), |
/* See desc del_commentaire_vote & desc del_image_vote; |
Les deux schémas sont similaires, à l'exception de ce_protocole |
spécifique à del_image_vote et ce_proposition => ce_image */ |
'votes' => array( // del_image_vote et del_commentaire_vote |
"id_vote" => "vote.id", |
"ce_proposition" => "proposition.id", |
"ce_image" => "image.id", |
"ce_utilisateur" => "auteur.id", // attention, conflit avec commentaire, cf ci-dessous |
"valeur" => "vote", |
"date" => 1, // attention, conflit avec commentaire, cf ci-dessous |
// absents du JSON, et pourtant présents dans services/configurations/config_mapping_votes.ini |
// (nécessiterait une propre jointure sur del_utilisateur) |
/* "nom" => "auteur.nom", |
"prenom" => "auteur.prenom", |
"courriel" => "auteur.courriel" */), |
'commentaires' => array( // del_commentaire |
"id_commentaire" => 1, |
"ce_observation" => "observation", |
"ce_proposition" => "proposition", |
"ce_commentaire_parent" => "id_parent", |
// les deux alias suivants sont particuliers afin d'éviter un conflit d'alias |
// lors des jointures avec del_commentaire_vote ci-dessus |
// (cf cas particulier dans la boucle de chargerCommentaires()) |
"ce_utilisateur" => "__auteur_com", |
"date" => "__date_com", |
"texte" => 1, |
"utilisateur_nom" => "auteur.nom", |
"utilisateur_prenom" => "auteur.prenom", |
"utilisateur_courriel" => "auteur.courriel", |
"nom_sel" => 1, |
"nom_sel_nn" => 1, |
"nom_ret_nn" => 1, |
"nom_referentiel" => 1, |
"proposition_initiale" => 1), |
); |
private $conteneur; |
private $gestionBdd; |
private $bdd; |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->conteneur->chargerConfiguration('config_votes.ini'); |
$this->conteneur->chargerConfiguration('config_mapping_votes.ini'); |
$this->conteneur->chargerConfiguration('config_mapping_commentaires.ini'); |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
} |
/** |
* Méthode principale de la classe. |
* Lance la récupération des images dans la base et les place dans un objet ResultatService |
* pour l'afficher. |
* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2) |
* @param array $parametres les paramètres situés après le ? dans l'url |
* */ |
public function consulter($ressources, $parametres) { |
if (!$ressources || count($ressources) != 1 ) { |
throw new Exception("Le service observation accepte un unique identifiant d'observation", RestServeur::HTTP_CODE_ERREUR); |
} |
// initialise les mappings: |
// substitue les valeurs à 1 par le nom de la clef (pas d'alias de champ) |
array_walk(self::$mappings['observations'], create_function('&$val, $k', 'if($val==1) $val = $k;')); |
array_walk(self::$mappings['images'], create_function('&$val, $k', 'if($val==1) $val = $k;')); |
array_walk(self::$mappings['protocoles'], create_function('&$val, $k', 'if($val==1) $val = $k;')); |
array_walk(self::$mappings['votes'], create_function('&$val, $k', 'if($val==1) $val = $k;')); |
array_walk(self::$mappings['commentaires'], create_function('&$val, $k', 'if($val==1) $val = $k;')); |
// Gestion des configuration du script |
$idobs = $ressources[0]; |
$protocole = isset($parametres['protocole']) && is_numeric($parametres['protocole']) ?intval($parametres['protocole']) : NULL; |
// 1) récupération de l'observation (et de ses images (v_del_image est une vue utilisant des INNER JOIN)) |
$liaisons = self::chargerObservation($this->bdd, $idobs); |
if(!$liaisons) { |
header('HTTP/1.0 404 Not Found'); |
// don't die (phpunit) |
throw(new Exception()); |
} |
// 2) réassocie les images "à plat" à leur observation (merge) |
// TODO: appliquer le formattage dépendant de la configuration en fin de processus |
$observations = self::reformateObservationSimpleIndex($liaisons, $this->conteneur->getParametre('url_images')); |
// bien que dans notre cas il n'y ait qu'une seule observation, issue de plusieurs images |
// dans $liaisons, $observation est un tableau (cf reformateObservation). |
// Considérons la chose comme telle au cas où le webservice doivent demain demander une paire |
// d'observations (... convergence avec ListeObservations & DelTk) |
$observation = array_pop($observations); |
// 3) charge les données de votes et protocoles associés aux images |
if($observation['images']) { |
$votes = self::chargerVotesImage($this->bdd, $observation['images'], $protocole); |
// 3") merge/reformate les données retournées |
self::mapVotesToImages($votes, |
$observation['images']); |
} |
// 4) charge les commentaires et les votes associés |
// modifie/créé $observation['commentaires'] |
self::chargerCommentaires($this->bdd, $observation); |
// désindexe le tableau (tel qu'apparement attendu par les applis), c'est une exception |
// corriger l'appli cliente pour utiliser les index puis supprimer cette ligne |
$observation['images'] = array_values($observation['images']); |
// autre élément de post-processing: le ce_utilisateur de l'observation non-numeric... |
if(!is_numeric($observation['auteur.id'])) $observation['auteur.id'] = "0"; |
if(!isset($observation['auteur.nom'])) $observation['auteur.nom'] = '[inconnu]'; |
if(isset($parametres['justthrow'])) return $observation; |
// Mettre en forme le résultat et l'envoyer pour affichage |
$resultat = new ResultatService(); |
$resultat->corps = $observation; |
return $resultat; |
} |
static function chargerObservation($db, $idobs) { |
// prenom_utilisateur, nom_utilisateur, courriel_utilisateur sont exclus du mapping |
// car nous utilisons une construction SQL élaborée pour eux (cf IFNULL ci-dessous) |
$obs_fields = DelTk::sqlFieldsToAlias(self::$mappings['observations'], NULL, 'dob'); |
$image_fields = DelTk::sqlFieldsToAlias(self::$mappings['images'], NULL, 'dob'); |
// champs de l'annuaire (del_utilisateur): id_utilisateur prenom, nom, courriel |
$annuaire_fields = implode(', ', array("IFNULL(du.prenom, prenom_utilisateur) AS `auteur.prenom`", |
"IFNULL(du.nom, nom_utilisateur) AS `auteur.nom`", |
"IFNULL(du.courriel, courriel_utilisateur) AS observateur")); |
return $db->recupererTous(sprintf( |
'SELECT %s, %s, %s FROM v_del_image as dob'. |
' LEFT JOIN del_utilisateur du ON CAST(du.id_utilisateur AS CHAR) = CAST(dob.ce_utilisateur AS CHAR)'. |
' WHERE dob.id_observation = %d -- %s', |
$obs_fields, $image_fields, $annuaire_fields, $idobs, __FILE__ . ':' . __LINE__)); |
} |
// Charger les images et leurs votes associés |
static function chargerVotesImage($db, $images, $protocole = NULL) { |
if(!$images) return NULL; |
$select = array('votes' => |
array('id_vote', 'ce_image', 'ce_protocole', 'ce_utilisateur', 'valeur', 'date', /* del_image_vote */), |
'protocole' => |
array('id_protocole', 'intitule', 'descriptif', 'tag' /* del_image_protocole */ )); |
$vote_fields = DelTk::sqlFieldsToAlias(self::$mappings['votes'], $select['votes'], 'v'); // "v": cf alias dans la requête |
$proto_fields = DelTk::sqlFieldsToAlias(self::$mappings['protocoles'], $select['protocole'], 'p'); |
$where = array(); |
$where[] = sprintf('v.ce_image IN (%s)', |
implode(',', array_values(array_map(create_function('$a', 'return $a["id_image"];'), $images)))); |
if ($protocole) { |
$where[] = "v.ce_protocole = $protocole"; |
} |
return $db->recupererTous(sprintf( |
'SELECT %s, %s FROM del_image_vote AS v'. |
' INNER JOIN del_image_protocole p ON v.ce_protocole = p.id_protocole'. |
' WHERE %s -- %s', |
$vote_fields, $proto_fields, |
$where ? implode(' AND ', $where) : 1, |
__FILE__ . ':' . __LINE__)); |
} |
/** |
* Formater une observation depuis une ligne liaison |
* @param $liaison liaison issue de la recherche |
* @return $observation l'observation mise en forme |
* Exemple: vote, au sortir de MySQL contient: |
* 'xxx' => 'blah', 'descriptif' => 'foo', 'valeur' => 3 |
* et le tableau de mapping contient: |
* descriptif = protocole.descriptif, valeur = vote |
* Alors $retour[ contient: |
* |
* */ |
static function mapVotesToImages($votes, &$images) { |
if(!$votes) return; |
// pour chaque vote |
foreach ($votes as $vote) { |
$imgid = $vote['image.id']; |
$protoid = $vote['protocole.id']; |
// un vote sans image associée ? est-ce possible ? |
// if(!isset($images[$imgid])) continue; |
if(!array_key_exists('protocoles_votes', $images[$imgid]) || |
!array_key_exists($protoid, $images[$imgid]['protocoles_votes'])) { |
// extrait les champs spécifique au protocole (le LEFT JOIN de chargerVotesImage les ramène en doublons |
$protocole = array_intersect_key($vote, array_flip(self::$mappings['protocoles'])); |
$images[$imgid]['protocoles_votes'][$protoid] = $protocole; |
} |
$vote = array_intersect_key($vote, array_flip(self::$mappings['votes'])); |
$images[$imgid]['protocoles_votes'][$protoid]['votes'][$vote['vote.id']] = $vote; |
} |
} |
// Charger les commentaires et leurs votes associés |
static function chargerCommentaires($db, &$observation) { |
$select = array('votes' => |
array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date' /* del_commentaire_vote */), |
'commentaires' => |
array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte', |
'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', 'utilisateur_courriel', |
'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date', |
'proposition_initiale')); |
$vote_fields = DelTk::sqlFieldsToAlias(self::$mappings['votes'], $select['votes'], 'cv'); // "v": cf alias dans la requête |
$comment_fields = DelTk::sqlFieldsToAlias(self::$mappings['commentaires'], $select['commentaires'], 'dc'); |
$commentaires = $db->recupererTous(sprintf( |
"SELECT %s, %s FROM del_commentaire as dc". |
// LEFT JOIN optionnel, mais explicatif: |
// on ne récupère des infos de vote que pour les commentaires comportant un |
// nom_sel "valide" |
" LEFT JOIN del_commentaire_vote cv". |
" ON cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL". |
" WHERE ce_observation = %d -- %s", |
$comment_fields, $vote_fields, |
$observation['id_observation'], |
__FILE__ . ':' . __LINE__)); |
if(!$commentaires) return; |
// les commentaires réunifiées et dont les votes sont mergés |
$ret = array(); |
foreach ($commentaires as $comment) { |
$commentid = $comment['id_commentaire']; |
$voteid = $comment['vote.id']; |
if(!array_key_exists($commentid, $ret)) { |
$comment_extract = array_intersect_key($comment, array_flip(self::$mappings['commentaires'])); |
// cas particulier: conflit d'aliases avec del_commentaire_vote |
$comment_extract['auteur.id'] = $comment_extract['__auteur_com']; |
$comment_extract['date'] = $comment_extract['__date_com']; |
unset($comment_extract['__auteur_com'], $comment_extract['__date_com']); |
// toujours un éléments "votes", quand bien même il n'y en aurait pas |
$comment_extract['votes'] = array(); |
$ret[$commentid] = $comment_extract; |
} |
if(!$comment['nom_sel'] || ! $voteid) continue; |
$vote = array_intersect_key($comment, array_flip(self::$mappings['votes'])); |
$ret[$commentid]['votes'][$voteid] = $vote; |
} |
$observation['commentaires'] = $ret; |
} |
// cf ListeObservation::reformateObservation() et ListeImages2::reformateImagesDoubleIndex() |
// (trop de variétés de formatage, à unifier côté client pour unifier côté backend ...) |
static function reformateObservationSimpleIndex($obs, $url_pattern = '') { |
// XXX: cf Observation.php::consulter(), nous pourriouns ici |
// conserver les valeurs vides (pour les phptests notamment, ou non) |
$obs = array_map('array_filter', $obs); |
$obs_merged = array(); |
foreach($obs as $o) { |
$id = $o['id_observation']; |
$image = array_intersect_key($o, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original'))); |
$image['binaire.href'] = sprintf($url_pattern, $image['id_image']); |
unset($o['id_image'], $o['date'], $o['hauteur'], $o['largeur'], $o['nom_original']); |
if(!isset($obs_merged[$id])) $obs_merged[$id] = $o; |
$obs_merged[$id]['images'][$image['id_image']] = $image; |
} |
return $obs_merged; |
} |
} |