/branches/v1.12-aluminium/services/modules/0.1/observations/ListeObservations.php |
---|
New file |
0,0 → 1,386 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Web service récupèrant toutes les observations et, pour chacune d'elle, les images qui lui sont associées. |
* |
* ATTENTION : le web service commence par récupérer seulement les id des obs (1er requete SQL), puis dans une |
* deuxième requête SQL récupère les informations complémentaires. Il s'avère qu'en procédant ainsi le web service |
* est 3 fois plus rapide ! |
* |
* @category DEL |
* @package Services |
* @subpackage Observations |
* @version 0.1 |
* @author Mathias CHOUET <mathias@tela-botanica.org> |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org> |
* @author Aurelien PERONNET <aurelien@tela-botanica.org> |
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt> |
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt> |
* @copyright 1999-2014 Tela Botanica <accueil@tela-botanica.org> |
*/ |
class ListeObservations { |
private $conteneur; |
private $bdd; |
private $navigation; |
private $filtrage; |
private $sql; |
private $mappings = array(); |
private $paramsFiltres = array(); |
private $idsObsOrdonnees = array(); |
private $infosObs = array(); |
private $infosObsOrdonnee = array(); |
private $evenementsObs = array(); |
public function __construct(Conteneur $conteneur) { |
$this->conteneur = $conteneur; |
$this->conteneur->chargerConfiguration('config_departements_bruts.ini'); |
$this->bdd = $this->conteneur->getBdd(); |
$this->filtrage = $this->conteneur->getParametresFiltrage(); |
$this->sql = $this->conteneur->getSql(); |
$this->navigation = $this->conteneur->getNavigation(); |
$this->mappings['votes'] = $this->conteneur->getParametreTableau('votes.mapping'); |
$this->mappings['commentaires'] = $this->conteneur->getParametreTableau('commentaires.mapping'); |
} |
public function consulter($ressources, $parametres) { |
$this->paramsFiltres = $this->filtrage->filtrerUrlParamsAppliObs(); |
$this->sql->setAppli(Sql::APPLI_OBS); |
$this->sql->setParametres($this->paramsFiltres); |
$this->sql->ajouterContraintes(); |
$this->sql->ajouterConstrainteAppliObs(); |
$this->sql->definirOrdreSqlAppliObs(); |
$this->idsObsOrdonnees = $this->getIdObs(); |
$this->navigation->setTotal($this->sql->getTotalLignesTrouvees()); |
// Ce n'est pas la peine de continuer s'il n'y a pas eu de résultats |
$resultat = new ResultatService(); |
$resultat->corps = array('entete' => $this->navigation->getEntete(), 'resultats' => array()); |
if (count($this->idsObsOrdonnees) > 0) { |
// 2) récupération des données nécessaires pour ces observations (obs + images) |
$this->infosObs = $this->getInfosObs(); |
// 3) suppression, merge des données en tableau assez représentatif du futur JSON en output |
$this->infosObsOrdonnees = $this->formaterObservations(); |
// 4) Ajouter commentaires + votes à $this->infosObsOrdonnees |
$this->chargerDeterminations(); |
$resultat->corps = array( |
'entete' => $this->navigation->getEntete(), |
// 5) Applatissage du tableau afin de garder l'ordre de tri |
// (qui n'est pas garanti dans un objet json) |
'resultats' => array_values($this->infosObsOrdonnees)); |
} |
return $resultat; |
} |
// 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 |
*/ |
private function getIdObs() { |
$requete = $this->renvoyerRequeteSelonType(); |
//Debug::printr($requete); |
$resultats = $this->bdd->recupererTous($requete); |
$idObs = array(); |
if ($resultats !== false ) { |
foreach ($resultats as $resultat) { |
$idObs[] = $resultat['id_observation']; |
} |
} |
return $idObs; |
} |
private function renvoyerRequeteSelonType() { |
if($this->monActiviteEstDemandee()) { |
$gestion_utilisateur = new GestionUtilisateur($this->conteneur); |
$utilisateur = $gestion_utilisateur->getUtilisateur(); |
if ($utilisateur['connecte'] === true) { |
$id_utilisateur = $utilisateur['id_utilisateur']; |
$requete = $this->sql->getRequeteIdObsMonactiviteTout($id_utilisateur, $this->sql->getLimit()).' -- '.__FILE__.':'.__LINE__; |
// Enregistrement de la date de consultation pour ne pas réafficher des événements déjà consultés |
$gestion_utilisateur->setDerniereDateConsultationEvenements($id_utilisateur, date('Y-m-d H:i:s')); |
} else { |
//TODO: que faire si l'on n'est pas connecté ? |
} |
} else { |
$requete = 'SELECT SQL_CALC_FOUND_ROWS id_observation '. |
'FROM del_observation AS do '. |
$this->sql->getJoin(). |
'WHERE '.$this->sql->getWhere(). |
$this->sql->getGroupBy(). |
$this->sql->getOrderBy(). |
$this->sql->getLimit(). |
' -- '.__FILE__.':'.__LINE__; |
} |
/*echo "REQ: "; var_dump($requete); |
exit;*/ |
return $requete; |
} |
private function monActiviteEstDemandee() { |
return isset($this->paramsFiltres['masque.type']) && in_array('monactivite',array_keys($this->paramsFiltres['masque.type'])); |
} |
/** |
* Après avoir récupérer seulement les ids dans une première requête, nous récupérons maintenant les infos. |
* Le web service est ainsi 3 fois plus rapide. |
*/ |
private function getInfosObs() { |
$idsObsConcat = implode(',', $this->idsObsOrdonnees); |
$requete = "SELECT 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, pays, '. |
'zone_geo, lieudit, station, milieu, date_observation, do.mots_cles_texte, '. |
'do.date_transmission, do.commentaire, '. |
'do.ce_utilisateur AS `auteur.id`, do.prenom_utilisateur AS `auteur.prenom`, '. |
'do.nom_utilisateur AS `auteur.nom`, '. |
'id_image, date_prise_de_vue AS `date`, hauteur, largeur, nom_original '. |
'FROM del_observation AS do '. |
' LEFT JOIN del_image AS di ON (do.id_observation = di.ce_observation) '. |
"WHERE id_observation IN ($idsObsConcat) ". |
' -- '.__FILE__.':'.__LINE__; |
if ($this->monActiviteEstDemandee()) { |
$this->stockerEvenementsObs($idsObsConcat); |
} |
//Debug::printr($requete); |
return $this->bdd->recupererTous($requete); |
} |
private function stockerEvenementsObs($idsObsConcat) { |
$gestion_utilisateur = new GestionUtilisateur($this->conteneur); |
$utilisateur = $gestion_utilisateur->getUtilisateur(); |
$id_utilisateur = $utilisateur['id_utilisateur']; |
$evenements = $this->sql->getEvenementsObs($idsObsConcat, $id_utilisateur); |
$this->evenements_obs = array(); |
foreach($evenements as &$evenement) { |
$this->affecterTypeEvenement($evenement, $id_utilisateur, $evenement['id_observation']); |
} |
} |
private function affecterTypeEvenement(&$evenement, $id_utilisateur, $id_observation) { |
$type = ""; |
$infos = ""; |
// La date maximale détermine le type d'évènement |
switch($evenement['date_max']) { |
// Quelqu'un a fait un nouveau commentaire ou proposition |
case $evenement['date_com']: |
if(!empty($evenement['nom_sel_com'])) { |
$type = 'nouvelle_proposition'; |
$infos = $evenement['proposition_commentaire_nom_sel']; |
} else { |
$type = 'nouveau_commentaire'; |
$infos = $evenement['proposition_commentaire_texte']; |
} |
// J'ai commenté ou fait une proposition |
if($evenement['utilisateur_commentaire'] == $id_utilisateur) { |
$type .= "_vous_a_obs_autre"; |
} else { |
$type .= "_autre_sur_obs_vous"; |
} |
break; |
// Quelqu'un a répondu à un de mes commentaires ou une de mes propositions |
case $evenement['date_com_reponse']: |
if(!empty($evenement['nom_sel_com_parent'])) { |
$type = 'nouvelle_reponse_autre_sur_proposition_vous'; |
} else { |
$type = 'nouvelle_reponse_autre_sur_commentaire_vous'; |
} |
$infos = $evenement['proposition_commentaire_texte_commente']; |
break; |
// Quelqu'un a fait un nouveau vote |
case $evenement['date_vote']: |
$type = 'nouveau_vote'; |
// Sur une proposition qui n'est pas à moi sur une observation à moi |
if($evenement['utilisateur_commentaire_vote'] != $evenement['utilisateur_observation'] && $evenement['utilisateur_commentaire_vote'] != $id_utilisateur) { |
$type .= "_autre_sur_com_autre_obs_vous"; |
} else { |
// Sur une proposition qui est à moi sur une observation (à moi ou non) |
$type .= "_autre_sur_com_vous"; |
} |
$infos = $evenement['proposition_commentaire_nom_sel_votee']; |
break; |
// Quelqu'un a validé une proposition |
case $evenement['date_validation']: |
$type = "nouvelle_validation_autre_sur_prop_vous"; |
$infos = $evenement['proposition_validee_nom_sel']; |
// $type = "nouvelle_validation_vous_a_prop_autre"; |
break; |
// Cas qui ne devrait jamais arriver |
default: |
$type = 'inconnu'; |
$infos = ""; |
} |
$infos_evts = array('type' => $type, 'infos_complementaires' => $infos); |
// La requête est un peu trop complexe et certains évènements sortent en doublons |
// donc on dédoublonne ici (mais ça n'est pas une solution pérenne) |
// TODO: optimiser et simplifier ceci |
if(empty($this->evenementsObs[$id_observation])) { |
$this->evenementsObs[$id_observation] = array(); |
} |
if(array_search($infos_evts, $this->evenementsObs[$id_observation]) === false) { |
$this->evenementsObs[$id_observation][] = $infos_evts; |
} |
} |
/** |
* Les informations étant extraites d'une vue dont les infos des obs sont dupliquées pour chaque image, |
* il nous faut maintenant récupérer qu'une seule fois les données d'observations et y intégrer les données |
* des images. |
*/ |
private function formaterObservations() { |
$observations = array_map('array_filter', $this->infosObs); |
$obsFormatees = array_flip($this->idsObsOrdonnees);// Permet de garder l'ordre de sortie ! |
foreach ($observations as &$obs) { |
$this->nettoyerAuteur($obs); |
$id = $obs['id_observation']; |
// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire) |
if (is_array($obsFormatees[$id]) === false) { |
$obsFormatees[$id] = $obs; |
} |
$obsFormatees[$id]['images'][] = $this->extraireInfosImage($obs); |
if(isset($this->evenementsObs[$id])) { |
$obsFormatees[$id]['evenements'] = $this->evenementsObs[$id]; |
} |
} |
return $obsFormatees; |
} |
private function nettoyerAuteur(&$obs) { |
// 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($obs['auteur.id']) || !is_numeric($obs['auteur.id'])) { |
$obs['auteur.id'] = "0"; |
} |
if (!isset($obs['auteur.nom'])) { |
$obs['auteur.nom'] = '[inconnu]'; |
} |
} |
private function extraireInfosImage(&$obs) { |
$champsImageAffichables = array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original'); |
$image = array_intersect_key($obs, array_flip($champsImageAffichables)); |
$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl'); |
$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], 'XL'); |
unset($obs['id_image'], $obs['date'], $obs['hauteur'], $obs['largeur'], $obs['nom_original']); |
return $image; |
} |
/** |
* 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() { |
$idObsConcat = implode(',', $this->idsObsOrdonnees); |
$requete = 'SELECT * '. |
'FROM del_commentaire AS dc '. |
'WHERE dc.nom_sel IS NOT NULL '. |
"AND ce_observation IN ($idObsConcat) ". |
'-- '.__FILE__.':'.__LINE__; |
$commentaires = $this->chargerNombreCommentaireObs(); |
$propositions = $this->bdd->recupererTous($requete); |
if ($propositions) { |
foreach ($propositions as $proposition) { |
$idObs = $proposition['ce_observation']; |
$idComment = $proposition['id_commentaire']; |
$comment = $this->formaterDetermination($idComment, $proposition); |
if ($comment) { |
$this->infosObsOrdonnees[$idObs]['commentaires'][$idComment] = $comment; |
} |
$this->infosObsOrdonnees[$idObs]['nb_commentaires'] = isset($commentaires[$idObs]) ? $commentaires[$idObs] : 0; |
} |
} |
} |
private function formaterDetermination($propositionId, $propositionInfos) { |
if (!$propositionInfos) return NULL; |
$propositionFormatee = array(); |
foreach ($this->mappings['commentaires'] as $nomChamp => $nomAttributJson) { |
if (isset($propositionInfos[$nomChamp])) { |
$propositionFormatee[$nomAttributJson] = $propositionInfos[$nomChamp]; |
} |
} |
// Charger les votes sur les déterminations |
$requete = "SELECT * FROM del_commentaire_vote WHERE ce_proposition = $propositionId". |
'-- '.__FILE__.':'.__LINE__; |
$resultatsVotes = $this->bdd->recupererTous($requete); |
foreach ($resultatsVotes as $vote) { |
$propositionFormatee['votes'][$vote['id_vote']] = $this->formaterVote($vote); |
} |
$propositionFormatee['nb_commentaires'] = $this->chargerNombreCommentaire($propositionId); |
return $propositionFormatee; |
} |
/** |
* Formater un vote en fonction du fichier de configuration config_votes.ini |
* @param $votes array() |
*/ |
private function formaterVote($vote) { |
$voteFormate = array(); |
foreach ($vote as $nomChamp => $valeur) { |
$voteFormate[$this->mappings['votes'][$nomChamp]] = $valeur; |
} |
return $voteFormate; |
} |
private function chargerNombreCommentaireObs() { |
$idObsConcat = implode(',', $this->idsObsOrdonnees); |
$requete = 'SELECT ce_observation, COUNT( id_commentaire ) AS nb '. |
'FROM del_commentaire '. |
"WHERE ce_observation IN ($idObsConcat) ". |
'GROUP BY ce_observation '. |
'-- '.__FILE__.':'.__LINE__; |
$commentaires = $this->bdd->recupererTous($requete); |
$commentaires_par_obs = array(); |
foreach($commentaires as $commentaire) { |
$commentaires_par_obs[$commentaire['ce_observation']] = $commentaire['nb']; |
} |
return $commentaires_par_obs; |
} |
private function chargerNombreCommentaire($propositionId) { |
$requete = 'SELECT COUNT( id_commentaire ) AS nb '. |
'FROM del_commentaire '. |
"WHERE ce_proposition = $propositionId ". |
'GROUP BY ce_proposition '. |
'-- '.__FILE__.':'.__LINE__; |
$commentaires = $this->bdd->recuperer($requete); |
return $commentaires ? $commentaires['nb'] : 0; |
} |
} |
/branches/v1.12-aluminium/services/modules/0.1/observations/ObservationDetails.php |
---|
New file |
0,0 → 1,209 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Web service retournant toutes les infos d'une observation donnée : |
* images, votes sur image et protocole, commentaires, votes sur commentaires, ... |
* |
* @category DEL |
* @package Services |
* @subpackage Observations |
* @version 0.1 |
* @author Mathias CHOUET <mathias@tela-botanica.org> |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org> |
* @author Aurelien PERONNET <aurelien@tela-botanica.org> |
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt> |
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt> |
* @copyright 1999-2014 Tela Botanica <accueil@tela-botanica.org> |
*/ |
class ObservationDetails { |
private $conteneur; |
private $bdd; |
private $sql; |
private $idObs; |
private $protocole; |
private $observation; |
private $mappings = array(); |
public function __construct(Conteneur $conteneur) { |
$this->conteneur = $conteneur; |
$this->bdd = $this->conteneur->getBdd(); |
$this->sql = $this->conteneur->getSql(); |
$this->mappings['observations'] = $this->conteneur->getParametreTableau('observations.mapping'); |
$this->mappings['images'] = $this->conteneur->getParametreTableau('images.mapping'); |
$this->mappings['votes'] = $this->conteneur->getParametreTableau('votes.mapping'); |
$this->mappings['commentaires'] = $this->conteneur->getParametreTableau('commentaires.mapping'); |
// les deux alias suivants sont particuliers afin d'éviter un conflit d'alias lors des jointures avec del_commentaire_vote |
$this->mappings['commentaires']['ce_utilisateur'] = '__auteur_com'; |
$this->mappings['commentaires']['date'] = '__date_com'; |
} |
public function consulter($ressources, $parametres) { |
$this->idObs = $ressources[0]; |
$this->protocole = isset($parametres['protocole']) && is_numeric($parametres['protocole']) ? intval($parametres['protocole']) : null; |
$infos = $this->getInfosObservationEtImages(); |
if (! $infos) { |
$message = "Aucune observation ne possède d'identifiant '{$this->idObs}'."; |
throw new Exception($message, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE); |
} |
$this->formaterObservation($infos); |
// 3) charge les données de votes et protocoles associés aux images |
if ($this->observation['images']) { |
$idsImages = array_keys($this->observation['images']); |
$votes = $this->sql->getVotesDesImages($idsImages, $this->protocole); |
$this->sql->ajouterInfosVotesProtocoles($votes, $this->observation['images']); |
} |
// 4) charge les commentaires et les votes associés -> modifie/créé $observation['commentaires'] |
$commentaires = $this->getCommentaires(); |
$this->ajouterCommentaires($commentaires); |
// désindexe le tableau (tel qu'apparement attendu par les applis), c'est une exception |
// TODO : corriger l'appli cliente pour utiliser les index puis supprimer cette ligne |
$this->observation['images'] = array_values($this->observation['images']); |
// autre élément de post-processing: le ce_utilisateur de l'observation non-numeric... |
$this->nettoyerAuteur(); |
// Mettre en forme le résultat et l'envoyer pour affichage |
$resultat = new ResultatService(); |
$resultat->corps = $this->observation; |
return $resultat; |
} |
private function getInfosObservationEtImages() { |
$obsChamps = $this->sql->getAliasDesChamps($this->mappings['observations'], null, 'do'); |
$imgChamps = $this->sql->getAliasDesChamps($this->mappings['images'], null, 'di'); |
// rétrocompatibilité champs de l'annuaire après suppression de del_utilisateur |
$annuaireChamps = implode(', ', array( |
"do.prenom_utilisateur AS `auteur.prenom`", |
"do.nom_utilisateur AS `auteur.nom`")); |
$requete = "SELECT $obsChamps, $imgChamps, $annuaireChamps ". |
"FROM del_observation AS do ". |
" LEFT JOIN del_image AS di ON (do.id_observation = di.ce_observation) ". |
"WHERE do.id_observation = {$this->idObs} ". |
'-- '.__FILE__.':'.__LINE__; |
//Debug::printr($requete); |
return $this->bdd->recupererTous($requete); |
} |
private function formaterObservation($infos) { |
$infos = array_filter($infos); |
foreach ($infos as $info) { |
$image = array_intersect_key($info, array_flip(array('id_image', 'date', 'hauteur' , 'largeur', 'nom_original'))); |
$urlImgTpl = $this->conteneur->getParametre('cel_img_url_tpl'); |
$imageFormat = 'XL'; |
$image['binaire.href'] = sprintf($urlImgTpl, $image['id_image'], $imageFormat); |
unset($info['id_image'], $info['date'], $info['hauteur'], $info['largeur'], $info['nom_original']); |
// ATTENTION : la requête retourne de nombreuses lignes avec les mêmes données (test de l'existence nécessaire) |
if (!isset($this->observation)) { |
$this->observation = $info; |
$this->observation['images'] = array(); |
} |
if (!isset($this->observation['images'][$image['id_image']])) { |
$this->observation['images'][$image['id_image']] = $image; |
} |
} |
} |
private function getCommentaires() { |
$selectVotes = array('id_vote', 'ce_proposition', 'ce_utilisateur', 'valeur', 'date'); |
$selectCommentaires = array('id_commentaire', 'ce_observation', 'ce_proposition', 'ce_commentaire_parent', 'texte', |
'ce_utilisateur', 'utilisateur_prenom', 'utilisateur_nom', |
'nom_sel', 'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'nom_referentiel', 'date', |
'proposition_initiale','proposition_retenue'); |
$voteChamps = $this->sql->getAliasDesChamps($this->mappings['votes'], $selectVotes, 'cv'); |
$commentaireChamps = $this->sql->getAliasDesChamps($this->mappings['commentaires'], $selectCommentaires, 'dc'); |
// LEFT JOIN optionnel, mais explicatif : récupèration des infos de vote que pour les commentaires comportant un nom_sel "valide" |
$requete = "SELECT $commentaireChamps, $voteChamps ". |
"FROM del_commentaire AS dc ". |
" LEFT JOIN del_commentaire_vote AS cv ". |
" ON (cv.ce_proposition = dc.id_commentaire AND dc.nom_sel != '' AND dc.nom_sel IS NOT NULL) ". |
"WHERE ce_observation = {$this->idObs} ". |
'-- '.__FILE__.':'.__LINE__; |
$commentaires = $this->bdd->recupererTous($requete); |
return $commentaires; |
} |
private function ajouterCommentaires($commentaires) { |
if (!$commentaires) return; |
$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($this->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($this->mappings['votes'])); |
$ret[$commentId]['votes'][$voteId] = $vote; |
} |
$this->observation['commentaires'] = $ret; |
} |
private function nettoyerAuteur() { |
if (!isset($this->observation['auteur.id']) || !is_numeric($this->observation['auteur.id'])) { |
$this->observation['auteur.id'] = '0'; |
} |
if (!isset($this->observation['auteur.nom'])) { |
$this->observation['auteur.nom'] = '[inconnu]'; |
} |
} |
/** |
* Modifie une observation directement dans le CEL en faisant un appel à un web service du CEL. |
* Utilisé uniquement par les admins. |
* Permet de dépublier une observation. |
* |
* @param array $ressources tableau des informations contenues dans l'url après le nom du service |
* @param array $parametres contenu du post |
* @return mixed Chaine "OK" (en majuscule) en cas de succès, booléen "false" en cas d'échec |
*/ |
public function modifier($ressources, $parametres) { |
$gestionUtilisateurs = $this->conteneur->getUtilisateur(); |
$gestionUtilisateurs->etreUtilisateurAvecDroitAdmin(); |
$retour = false; |
if (isset($parametres['transmission'])) { |
$idObs = $ressources[0]; |
$clientRest = $this->conteneur->getRestClient(); |
$urlTpl = $this->conteneur->getParametre('urlServiceCelObs'); |
$url = $urlTpl.$idObs; |
$retourCel = $clientRest->modifier($url, $parametres); |
$retour = preg_match('/^OK$/i', $retourCel) ? 'OK' : false; |
if ($retour === false) { |
$message = "Erreur du web service CEL : ".$retourCel; |
$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE; |
throw new Exception($message, $code); |
} |
} else { |
$message = "Ce web service doit contenir un paramètre 'transmission'."; |
$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE; |
throw new Exception($message, $code); |
} |
return $retour; |
} |
} |
/branches/v1.12-aluminium/services/modules/0.1/observations/VoteObservation.php |
---|
New file |
0,0 → 1,270 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Web service permetant d'ajouter ou de modifier les votes associés aux propositions d'une observation. |
* |
* @category DEL |
* @package Services |
* @subpackage Observations |
* @version 0.1 |
* @author Mathias CHOUET <mathias@tela-botanica.org> |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org> |
* @author Aurelien PERONNET <aurelien@tela-botanica.org> |
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt> |
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt> |
* @copyright 1999-2014 Tela Botanica <accueil@tela-botanica.org> |
*/ |
class VoteObservation { |
private $conteneur; |
private $bdd; |
private $navigation; |
private $mapping; |
private $ressources; |
private $parametres; |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->bdd = $this->conteneur->getBdd(); |
$this->navigation = $conteneur->getNavigation(); |
$this->mapping = $this->conteneur->getParametreTableau('votes.mapping'); |
} |
public function consulter($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
$votes = $this->chargerVotes(); |
$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->navigation->getEntete(), 'resultats' => $votes); |
return $resultat; |
} |
private function chargerVotes() { |
$idCommentaireP = $this->bdd->proteger($this->ressources[1]); |
$requete = 'SELECT * '. |
'FROM del_commentaire_vote '. |
"WHERE ce_proposition = $idCommentaireP "; |
' -- '.__FILE__.':'.__LINE__; |
$resultats = $this->bdd->recupererTous($requete); |
$votes = array(); |
foreach ($resultats as $vote) { |
$votes[$vote['id_vote']] = $this->formaterVotes($vote); |
$utilisateur = $this->chercherUtilisateur($vote['ce_utilisateur']); |
if ($utilisateur && count($utilisateur) > 0) { |
$votes[$vote['id_vote']] = array_merge($votes[$vote['id_vote']], $utilisateur); |
} |
} |
return $votes; |
} |
private function formaterVotes($vote) { |
$retour = array(); |
foreach ($vote as $param => $valeur) { |
$retour[$this->mapping[$param]] = $valeur; |
} |
return $retour; |
} |
/** |
* Recherche les coordonnées d'un utilisateur en fonction de son ID; |
* puisqu'il a un ID c'est qu'il est connecté, on suppose donc qu'il |
* a un tuple dans del_utilisateur_infos |
* |
* @TODO vérifier cette hypothèse |
*/ |
private function chercherUtilisateur($id) { |
// par défaut, pas d'info |
$utilisateur = array(); |
// Si l'id utilisateur est un hash de session, on ne cherche rien |
if (is_numeric($id)) { |
$idUtilisateurP = $this->bdd->proteger($id); |
$requete = "SELECT id_utilisateur AS 'auteur.id', nom AS 'auteur.nom', prenom AS 'auteur.prenom', ". |
'FROM del_utilisateur_infos '. |
"WHERE id_utilisateur = $idUtilisateurP ". |
' -- '.__FILE__.':'.__LINE__; |
$utilisateur = $this->bdd->recuperer($requete); |
} |
return $utilisateur; |
} |
public function ajouter($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
$this->verifierParametresAjoutModif(); |
$idVote = $this->ajouterVote(); |
if ($idVote) { |
$resultat = new ResultatService(); |
$resultat->corps = array('id_vote' => $idVote); |
return $resultat; |
} |
return false; |
} |
private function ajouterVote() { |
$idProposition = $this->creerPropositionDeterminationInitiale(); |
$idObsP = $this->bdd->proteger($this->ressources[0]); |
$idPropositionP = $this->bdd->proteger($idProposition); |
$idUtilisateurP = $this->bdd->proteger($this->parametres['utilisateur']); |
$valeurP = $this->bdd->proteger($this->parametres['valeur']); |
$requete = 'INSERT INTO del_commentaire_vote (ce_proposition , ce_utilisateur , valeur , date) '. |
"VALUES ($idPropositionP, $idUtilisateurP, $valeurP, NOW()) ". |
' -- '.__FILE__.' : '.__LINE__; |
$resultat = $this->bdd->executer($requete); |
if ($resultat === false) { |
$msg = "Un problème est survenu lors de l'ajout d'un vote."; |
throw new Exception($msg, RestServeur::HTTP_CODE_ERREUR); |
} else if ($resultat === 0) { |
$msg = "Aucun vote ne correspond au critères fournis : ". |
"idObs -> $idObsP, idProposition -> $idPropositionP et id_utilisateur -> $idUtilisateurP."; |
throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE); |
} |
// ATTENTION : idVote doit être récupéré avant toute nouvelle requete ! |
$idVote = $this->bdd->recupererIdDernierAjout(); |
$requete = "UPDATE tb_new_cel.`occurrence` join |
(SELECT ce_observation, id_commentaire, nom_sel_nn, `proposition_retenue` FROM `del_commentaire` WHERE id_commentaire = ".$idPropositionP.") c |
on id = ce_observation AND user_sci_name_id= `nom_sel_nn` |
SET `identiplante_score`= case |
when ".$this->parametres['valeur']." = 0 and ".$idUtilisateurP." REGEXP '^-?[0-9]+$' then ifnull(identiplante_score, 0) -3 |
when ".$this->parametres['valeur']." = 0 then ifnull(identiplante_score, 0) -1 |
when ".$this->parametres['valeur']." = 1 and ".$idUtilisateurP." REGEXP '^-?[0-9]+$' then ifnull(identiplante_score, 0) + 3 |
when ".$this->parametres['valeur']." = 1 then ifnull(identiplante_score, 0) + 1 END;"; |
$resultat = $this->bdd->executer($requete); |
return $idVote; |
} |
/** 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) |
*/ |
private function creerPropositionDeterminationInitiale() { |
$idProposition = $this->ressources[1]; |
if ($idProposition == 0) { |
$propositionExiste = $this->verifierExistencePropositionInitiale(); |
if ($propositionExiste === false) { |
$idProposition = $this->creerPropositionInitiale(); |
} else { |
$idProposition = $this->getIdPropositionInitiale(); |
} |
} |
return $idProposition; |
} |
private function verifierExistencePropositionInitiale() { |
$idObservationP = $this->bdd->proteger($this->ressources[0]); |
$requete = 'SELECT COUNT(*) >= 1 AS existe '. |
'FROM del_commentaire '. |
"WHERE ce_observation = $idObservationP ". |
'AND proposition_initiale = 1 '. |
' -- '.__FILE__.' : '.__LINE__; |
$resultat = $this->bdd->recuperer($requete); |
return $resultat['existe'] == 1; |
} |
private function creerPropositionInitiale() { |
$idObservationP = $this->bdd->proteger($this->ressources[0]); |
$requete = 'INSERT IGNORE INTO del_commentaire '. |
'(ce_observation, ce_utilisateur, utilisateur_prenom, utilisateur_nom, '. |
'nom_sel, nom_sel_nn, nom_ret, nom_ret_nn, nt, famille, nom_referentiel, date, proposition_initiale) '. |
'SELECT id_observation, ce_utilisateur, prenom_utilisateur, nom_utilisateur, '. |
' nom_sel, nom_sel_nn, nom_ret, nom_ret_nn, '. |
" nt, famille, nom_referentiel, NOW(), '1' ". |
'FROM del_observation do '. |
"WHERE id_observation = $idObservationP ". |
' -- '.__FILE__.' : '.__LINE__; |
$this->bdd->executer($requete); |
$id = $this->bdd->recupererIdDernierAjout(); |
return $id; |
} |
private function getIdPropositionInitiale() { |
$idObservationP = $this->bdd->proteger($this->ressources[0]); |
$requete = 'SELECT id_commentaire '. |
'FROM del_commentaire '. |
"WHERE ce_observation = $idObservationP ". |
'AND proposition_initiale = 1 '. |
' -- '.__FILE__.' : '.__LINE__; |
$resultat = $this->bdd->recuperer($requete); |
return $resultat['id_commentaire']; |
} |
public function modifier($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
$this->verifierParametresAjoutModif(); |
$resultat = $this->modifierVote(); |
if ($resultat > 0) { |
return 'ok'; |
} |
} |
private function modifierVote() { |
// protection anti-usurpateurs @TODO faudrait pt-être la faire ! |
$idUtilisateur = $this->parametres['utilisateur']; |
/*$gestionUtilisateurs = $this->conteneur->getUtilisateur(); |
$gestionUtilisateurs->controleUtilisateurIdentifie($idUtilisateur);*/ |
$idObsP = $this->bdd->proteger($this->ressources[0]); |
$idPropositionP = $this->bdd->proteger($this->ressources[1]); |
$idUtilisateurP = $this->bdd->proteger($idUtilisateur); |
$valeurP = $this->bdd->proteger($this->parametres['valeur']); |
$requete = 'UPDATE del_commentaire_vote '. |
"SET valeur = $valeurP, date = NOW() ". |
"WHERE ce_proposition = $idPropositionP AND ce_utilisateur = $idUtilisateurP ". |
' -- '.__FILE__.' : '.__LINE__; |
$resultat = $this->bdd->executer($requete); |
if ($resultat === false) { |
$msg = "Une erreur est survenue lors de la tentative de modification du vote."; |
throw new Exception($msg, RestServeur::HTTP_CODE_ERREUR); |
} else if ($resultat === 0) { |
$msg = "Aucun vote ne correspond au critères fournis : ". |
"idObs -> $idObsP, idProposition -> $idPropositionP et id_utilisateur -> $idUtilisateurP."; |
throw new Exception($msg, RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE); |
} |
$requete = "UPDATE tb_new_cel.`occurrence` join |
(SELECT ce_observation, id_commentaire, nom_sel_nn, `proposition_retenue` FROM `del_commentaire` WHERE id_commentaire = ".$idPropositionP.") c |
on id = ce_observation AND user_sci_name_id= `nom_sel_nn` |
SET `identiplante_score`= case |
when ".$this->parametres['valeur']." = 0 and ".$idUtilisateurP." REGEXP '^-?[0-9]+$' then ifnull(identiplante_score, 0) -6 |
when ".$this->parametres['valeur']." = 0 then ifnull(identiplante_score, 0) -2 |
when ".$this->parametres['valeur']." = 1 and ".$idUtilisateurP." REGEXP '^-?[0-9]+$' then ifnull(identiplante_score, 0) + 6 |
when ".$this->parametres['valeur']." = 1 then ifnull(identiplante_score, 0) + 2 END;"; |
$resultat = $this->bdd->executer($requete); |
return $resultat; |
} |
private function verifierParametresAjoutModif() { |
$erreurs = array(); |
if (!isset($this->parametres['utilisateur'])) { |
$erreurs[] = 'Paramètre "utilisateur" manquant.'; |
} |
if (!isset($this->parametres['valeur'])) { |
$erreurs[] = 'Paramètre "valeur" manquant.'; |
} else { |
if (!is_numeric($this->parametres['valeur'])) { |
$erreurs[] = 'Le paramètre "valeur" doit être numérique.'; |
} elseif($this->parametres['valeur'] != 0 && $this->parametres['valeur'] != 1) { |
$erreurs[] = 'Le paramètre "valeur" ne peut prendre que la valeur 0 ou 1.'; |
} |
} |
if (!empty($erreurs)) { |
$msg = "Erreur lors de la configuration : \n".implode("\n", $erreurs); |
throw new Exception($msg, RestServeur::HTTP_CODE_MAUVAISE_REQUETE); |
} |
} |
} |