* @author Aurelien Peronnet * @copyright 2010, 2013 Tela-Botanica * @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL * @license GPL v3 * @link /doc/jrest/ * * Classe de gestion de l'ajout, modification et suppression des observations * * TODO: $sous_requete .= ' date_modification = now() ' * devrait être une clause ON UPDATE ou un TRIGGER * afin de mettre à jour la date de modification uniquement lorsqu'une modification a effectivement eu lieu * */ class GestionObservation extends Cel { static $cel_obs = array( "id_observation", "ordre", "ce_utilisateur", "prenom_utilisateur", "nom_utilisateur", "courriel_utilisateur", "nom_sel", "nom_sel_nn", "nom_ret", "nom_ret_nn", "nt", "famille", "nom_referentiel", "ce_zone_geo", "zone_geo", "lieudit", "station", "milieu", "latitude", "longitude", "altitude", "geodatum", "date_observation", "mots_cles_texte", "commentaire", "transmission", "date_creation", "date_modification", "date_transmission", "abondance", "certitude", "phenologie", "code_insee_calcul"); /** * Ajoute une observation grâce aux paramètres fournis * * @param int $utilisateur id utilisateur du proprietaire de l'observation * @param array $parametres tableau indexé avec les mêmes noms de champs que la bdd * * @return true ou false suivant le succès de l'opération */ public function ajouterObservation($utilisateur, $parametres) { $origin_params = $parametres; $base_param = array('nom_sel_nn' => NULL, 'nom_sel' => NULL, 'nom_ret_nn' => NULL, 'nom_referentiel' => NULL); $parametres = array_merge($base_param, $parametres); $retour = true; $parametres['ordre'] = $this->renvoyerDernierOrdreUtilisePlusUn($utilisateur); $this->traiterEspece($parametres); // si la détermination à échoué, alors: // soit le référentiel d'origine était "valide", soit non if(!$parametres['nom_sel_nn']) { // quoiqu'il en soit, on le met à "autre" $parametres['nom_referentiel'] = Cel::$fallback_referentiel; } $this->ajoutInfoUtilisateurARequete($parametres); self::formaterParametresObservation($parametres); $requete_insertion_observation = 'INSERT INTO cel_obs '; $sous_requete_colonnes = $this->traiterParametresObservationEtConstruireSousRequeteAjout($parametres); $requete_insertion_observation = $requete_insertion_observation.$sous_requete_colonnes; // important ! ne pas utiliser la fonction executerRequete qui renvoie une erreur si la requete contient des | (pipes) // ce qui peut arriver dans les commentaires // TODO: corriger la fonction ou bien continuer à utiliser executerRequeteSimple $resultat_ajout_observation = Cel::db()->executerRequeteSimple($requete_insertion_observation); if ($resultat_ajout_observation === false) { $retour = false; $this->logger("CEL_bugs","Erreur de creation d'une observation : ".$resultat_ajout_observation); } else { $retour = $this->renvoyerIdPourOrdre($utilisateur ,$parametres['ordre']); } return $retour; } /** * Renvoie le prochain numero d'ordre relatif à un utilisateur (i.e. dernier ordre + 1) * * @param int $utilisateur id utilisateur * * @return int le nouveau numero d'ordre relatif à l'utilisateur ou bien 0 s'il n'a jamais créé d'observations */ public function renvoyerDernierOrdreUtilisePlusUn($utilisateur) { $requete_selection_dernier_ordre = "SELECT max(ordre) AS ordre FROM cel_obs ". "WHERE ce_utilisateur = ".Cel::db()->proteger($utilisateur); $dernier_ordre = Cel::db()->executerRequete($requete_selection_dernier_ordre); $nouvel_ordre = 0; if (is_array($dernier_ordre) && count($dernier_ordre) > 0 && trim($dernier_ordre[0]['ordre']) != '') { $nouvel_ordre = $dernier_ordre[0]['ordre'] + 1; } return $nouvel_ordre; } /** * Renvoie l'id d'observation associé à l'utilisateur et l'ordre donné * * @param int $utilisateur id utilisateur * @return int le numero d'ordre relatif à l'utilisateur */ public function renvoyerIdPourOrdre($utilisateur, $ordre) { $requete_selection_dernier_id = "SELECT id_observation FROM cel_obs ". "WHERE ce_utilisateur = ".Cel::db()->proteger($utilisateur)." ". "AND ordre = ".Cel::db()->proteger($ordre)." "; $dernier_id = Cel::db()->executerRequete($requete_selection_dernier_id); if(!$dernier_id) return NULL; return $dernier_id[0]['id_observation']; } /** * Modifie une ou plusieurs observations grâce aux paramètres fournis * * @param int $utilisateur id utilisateur du proprietaire de l'observation * @param mixed $ordre ordre(s) observation(s) relatif(s) à l'utilisateur: un seul ordre ou bien "ordre1,ordre2,ordre3" etc... * @param array $parametres tableau indexé avec les mêmes noms de champs que la bdd * * @return true ou false suivant le succès de l'opération */ public function modifierObservation($utilisateur, $ordre, $parametres) { $base_param = array('nom_sel_nn' => NULL, 'nom_sel' => NULL, 'nom_ret_nn' => NULL, 'nom_referentiel' => NULL); // $parametres = array_merge($base_param, $parametres); $retour = true; $requete_modification = "UPDATE cel_obs SET " ; // si pas de nom_sel : on supprime les champs automatiques. et le référentiel. if(false && (!isset($parametres['nom_sel']) || !@$parametres['nom_sel'])) { $parametres['nom_referentiel'] = NULL; // pas d'update de traiterParametresObservationEtConstruireSousRequeteMaj() $requete_modification .= "nom_referentiel = NULL, nom_sel_nn = NULL, nom_ret_nn = NULL, nom_ret = NULL, nt = NULL, famille = NULL,"; } elseif(false) { /* TODO: * si (à l'origine) pas de nom_sel_nn (donc pas de référentiel) POSTé * et aucun nom déterminés, alors on supprime les données automatiques: * alors on test une différence de réferentiel... */ $r = $parametres['nom_referentiel']; $requete_modification .= <<traiterEspece($parametres); } self::formaterParametresObservation($parametres); $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); $champ_maj[] = "date_modification = now()"; $requete_modification .= implode(', ', $champ_maj) . " WHERE ordre IN (".$ordre.") AND ce_utilisateur = ".Cel::db()->proteger($utilisateur); // important ! ne pas utiliser la fonction executerRequete qui renvoie une erreur si la requete contient des | (pipes) // ce qui peut arriver dans les commentaires // TODO: corriger la fonction ou bien continuer à utiliser executerRequeteSimple $resultat_modification = Cel::db()->executerRequeteSimple($requete_modification . ' -- ' . __FILE__ . ':' . __LINE__); if ($resultat_modification === false) { $retour = false; $this->logger("CEL_bugs","Erreur de mise à jour d'une liste d'observations : ".$requete_modification); } return $retour; } /** * @return nombre d'observations mises à jour, ou FALSE en cas de problème */ static function modifierMultiplesObservation($utilisateur, Array $ordre, $parametres) { // nous pouvons aussi retirer 'ce_utilisateur' (== $utilisateur) qui sera dans la clause WHERE $exclusions = array('nom_sel_nn', 'nom_sel', 'nom_ret_nn', 'nom_referentiel', 'ce_utilisateur'); $parametres = array_diff_key($parametres, array_flip($exclusions)); $parametres = array_intersect_key($parametres, array_flip(self::$cel_obs)); $parametres = array_filter( $parametres, create_function('$e','return strpos($e, "(Valeurs multiples)") === false;')); // modifie $parametres par référence self::formaterParametresObservation($parametres); $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); if(!$champ_maj) return 0; // rien à mettre à jour finalement $champ_maj[] = "date_modification = now()"; $nb_upd = Cel::db()->executer(sprintf( "UPDATE cel_obs SET %s WHERE ordre IN (%s) AND ce_utilisateur = %s -- %s:%d", implode(', ', $champ_maj), implode(', ', $ordre), Cel::db()->proteger($utilisateur), __FILE__, __LINE__)); if($nb_upd === FALSE) return FALSE; return $nb_upd; // TODO: return json_encode(updated_rows()); } /** * Modifie une observation publique dont l'id et l'utilisateur sont passé en paramètre * * @param int $utilisateur id utilisateur du proprietaire de l'observation * @param int $id identifiant de l'observation * @param array $parametres tableau indexé avec les mêmes noms de champs que la bdd * * @return true ou false suivant le succès de l'opération */ public function modifierObservationPublique($utilisateur, $id, $parametres) { $base_param = array('nom_sel_nn' => NULL, 'nom_sel' => NULL, 'nom_ret_nn' => NULL, 'nom_referentiel' => NULL); $parametres = array_merge($base_param, $parametres); $this->traiterEspece($parametres); self::formaterParametresObservation($parametres); $retour = true; $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); $champ_maj[] = "date_modification = now()"; $requete_modification = "UPDATE cel_obs SET " . implode(', ', $champ_maj) . " WHERE id_observation = ".Cel::db()->proteger($id). " AND ce_utilisateur = ".Cel::db()->proteger($utilisateur)." ". " AND transmission = 1"; // important ! ne pas utiliser la fonction executerRequete qui renvoie une erreur si la requete contient des | (pipes) // ce qui peut arriver dans les commentaires // TODO: corriger la fonction ou bien continuer à utiliser executerRequeteSimple $resultat_modification = Cel::db()->executerRequeteSimple($requete_modification . ' -- ' . __FILE__ . ':' . __LINE__); if ($resultat_modification === false) { $this->logger("CEL_bugs","Erreur de mise à jour de l\'observation : ".$id); } return $resultat_modification; } /** * Supprime une ou plusieurs observations grâce aux paramètres fournis * * @param int $utilisateur id utilisateur du proprietaire de l'observation * @param mixed $ordre ordre(s) observation(s) relatif(s) à l'utilisateur: un seul ordre ou bien "ordre1,ordre2,ordre3" etc... * * @return true ou false suivant le succès de l'opération */ public function supprimerObservation($utilisateur, $ordre) { // TODO changer le systeme pour n'utiliser plus que les id $retour = false; $tableau_ordre = explode(',', $ordre); $tableau_ordre = array_map(array(Cel::db(),'proteger'), $tableau_ordre); $ordre = implode(',', $tableau_ordre); $requete_ids_observations = 'SELECT id_observation as id_obs FROM cel_obs '. 'WHERE ce_utilisateur = '.Cel::db()->proteger($utilisateur).' '. 'AND ordre IN ('.$ordre.')'; $resultat_ids_observations = Cel::db()->requeter($requete_ids_observations); $ids_obs = array(); if(is_array($resultat_ids_observations) && count($resultat_ids_observations) > 0) { foreach($resultat_ids_observations as $id_observation) { $ids_obs[] = Cel::db()->proteger($id_observation['id_obs']); } $chaine_ids_obs = implode(',', $ids_obs); $requete_supression_observations = 'DELETE FROM cel_obs WHERE '. 'ce_utilisateur = '.Cel::db()->proteger($utilisateur).' '. 'AND id_observation IN ('.$chaine_ids_obs.')'; $resultat_suppression_observations = Cel::db()->executerRequeteSimple($requete_supression_observations); // TODO: Faire la suppression des mots clés // et des liaisons obs images dans une ou des fonctions à part if ($resultat_suppression_observations === false) { $this->logger("CEL_bugs","Erreur de suppression d'une liste d'observations : ".$resultat_suppression_observations); } else { $requete_supression_lien_obs_images = 'DELETE FROM cel_obs_images WHERE id_observation IN ('.$chaine_ids_obs.')'; $resultat_suppression_liens = Cel::db()->executerRequeteSimple($requete_supression_lien_obs_images); if ($resultat_suppression_liens === false) { $this->logger("CEL_bugs","Erreur de suppression d'une liste de liaison entre observations et images : ".$requete_supression_lien_obs_images); } else { $retour = true; } $requete_supression_lien_mots_cles = 'DELETE FROM cel_obs_mots_cles WHERE '. 'id_observation in ('.$chaine_ids_obs.')'; $resultat_suppression_mots_cles = Cel::db()->executerRequeteSimple($requete_supression_lien_mots_cles); if ($resultat_suppression_mots_cles === false) { $this->logger("CEL_bugs","Erreur de suppression d'une liste de mots clés d'observation(s) : ".$resultat_suppression_mots_cles); } else { $retour = true; } } } else { $retour = true; } return $retour; } /** * Fonction utilisée pour importer les observations faites avec des comptes anonymes vers un * utilisateur identifié * @param string $ancien_id * @param string $id_utilisateur */ public function migrerObservations($ancien_id, $id_utilisateur) { //TODO faire une fonction plus complexe qui déplace, images, observations, mots-clés etc... d'un utilisateur à l'autre // qui pourrait servir pour fusionner des comptes $nouvel_ordre = $this->renvoyerDernierOrdreUtilisePlusUn($id_utilisateur); // Recuperation relevés associés a la session $requete_selection_releves_temporaires = 'SELECT ordre FROM cel_obs WHERE ce_utilisateur = '.Cel::db()->proteger($ancien_id).' ORDER BY ordre'; $resultat_releves_temporaires = Cel::db()->executerRequete($requete_selection_releves_temporaires); $reussite = true; if(is_array($resultat_releves_temporaires)) { foreach($resultat_releves_temporaires as $releve_temporaire) { $requete_migration_releve = 'UPDATE cel_obs SET '. 'ce_utilisateur = '.Cel::db()->proteger($id_utilisateur).', '. 'ordre = '.$nouvel_ordre.' '. 'WHERE ce_utilisateur = '.$ancien_id.' '. 'AND ordre = '.$releve_temporaire['ordre']; $migration_releve = Cel::db()->executerRequeteSimple($requete_migration_releve); //TODO: meilleure vérification if($migration_releve === false) { $reussite = false; } $nouvel_ordre++; } } return $reussite; } /** * Fonction utilisée pour importer les anciennes observations saisie dans les widget dans un compte identifié * Dans ce cas là, le widget remplit la case id_utilisateur par le mail indiqué lors de la saisie * @param string $mail_utilisateur * @param string $id_utilisateur */ public function migrerObservationsMailVersId($mail_utilisateur, $infos_utilisateur) { // ATTENTION : cette fonction suppose que l'utilisateur n'ai pas déjà d'observations dans le CEL // avec l'identifiant $id_utilisateur ce qui est normalement le cas $requete_migration_releve = 'UPDATE cel_obs SET '. 'ce_utilisateur = '.Cel::db()->proteger($infos_utilisateur['id_utilisateur']).', '. 'prenom_utilisateur = '.Cel::db()->proteger($infos_utilisateur['prenom']).', '. 'nom_utilisateur = '.Cel::db()->proteger($infos_utilisateur['nom']).', '. 'courriel_utilisateur = '.Cel::db()->proteger($infos_utilisateur['courriel']).' '. 'WHERE ce_utilisateur = '.Cel::db()->proteger($mail_utilisateur).' '; $migration_releve = Cel::db()->executerRequeteSimple($requete_migration_releve); return $migration_releve; } private function traiterEspece(&$parametres) { if(!$parametres['nom_referentiel']) { $parametres['nom_referentiel'] = Cel::$default_referentiel; } $code_referentiel = substr(trim($parametres['nom_referentiel']), 0, 5); // TODO/XXX: quoi ?! if(!$parametres['nom_sel_nn'] && !$parametres['nom_sel'] && $parametres['nom_ret_nn']) { $parametres['nom_ret'] = $parametres['nom_ret_nn'] = $parametres['nt'] = $parametres['famille'] = ""; } /* pour un nom saisi sans autocomplétion 3 cas de figure existent: 1) référentiel bdtfx 1.1) trouvé par le webservice => ref = bdtfx 1.2) pas trouvé par le webservice => ref = autre 2) si le référentiel est inconnu (explicitement mis à "autre"), alors pas d'appel au webservice => ref = autre */ if(in_array($code_referentiel, Cel::$referentiels_valides)) { // $deuxieme_passe = true; // nom saisi sans numéro if ($parametres['nom_sel'] && !$parametres['nom_sel_nn']) { $chercheur_infos_complementaires = new RechercheInfosTaxonBeta($this->config, $code_referentiel); // Utilisation d'un nom sans numéro nomenclatural, recherche d'une correspondance sur le nom $complement = $chercheur_infos_complementaires->rechercherInformationsComplementairesSurNom($parametres['nom_sel']); // Si l'on a trouvé un résultat sur la recherche, il s'agit vraisemblablement d'un copié-collé // de nom de taxon qui n'a pas été validé par la selection if($complement) { $parametres['nom_sel_nn'] = $complement->id; $parametres['nom_ret'] = RechercheInfosTaxonBeta::supprimerBiblio($complement->nom_retenu_complet); $parametres['nom_ret_nn'] = $complement->{"nom_retenu.id"}; $parametres['nt'] = $complement->num_taxonomique; $parametres['famille'] = $complement->famille; } else { // pas de résultat de recherche sur le référentiel demandé, le webservice doit peut-être être corrigé // mais en tout état de cause nous n'insérerons PAS de données incertaines associées à un référentiel ! $code_referentiel = Cel::$fallback_referentiel; $parametres['nom_sel_nn'] = $parametres['nom_ret'] = $parametres['nom_ret_nn'] = $parametres['nt'] = $parametres['famille'] = NULL; // goto out; $deuxieme_passe = false; } } // XXX: ne devrait plus être nécessaire maintenant que rechercherInformationsComplementairesSurNom() [plus précisément effectuerRequeteUrlRecherche()] // a été modifiée pour retourner tous les champs nécessaire. if ($deuxieme_passe && (! array_key_exists('nom_ret_nn', $parametres) || ! array_key_exists('nt', $parametres))) { // Utilisation d'un nom faisant parti du referentiel : recherche du nom valide correspondant $chercheur_infos_complementaires = new RechercheInfosTaxonBeta($this->config , $code_referentiel); $complement = $chercheur_infos_complementaires->effectuerRequeteInfosComplementairesSurNumNom($parametres['nom_sel_nn']); // les paramètres passés datait peut-être d'une précédente autocomplétion, mais le référentiel ayant été changé par l'utilisateur // la détection ne fonctionne plus : nous supprimons les données précédemment générées de la base ! if(!$complement) { $parametres['nom_sel_nn'] = $parametres['nom_ret'] = $parametres['nom_ret_nn'] = $parametres['nt'] = $parametres['famille'] = NULL; } else { $parametres['nom_ret'] = RechercheInfosTaxonBeta::supprimerBiblio($complement->nom_retenu_complet); $parametres['nom_ret_nn'] = $complement->{"nom_retenu.id"}; $parametres['nt'] = $complement->num_taxonomique; $parametres['famille'] = $complement->famille; } } } // référentiel "autre": on vide ! else { $parametres['nom_sel_nn'] = $parametres['nom_ret'] = $parametres['nom_ret_nn'] = $parametres['nt'] = $parametres['famille'] = NULL; } // mise à jour du référentiel utilisé, sans n° de version $parametres['nom_referentiel'] = $code_referentiel; } // uniquement nécessaire lors de l'ajout private function ajoutInfoUtilisateurARequete(&$parametres) { if(! isset($parametres['ce_utilisateur'])) return; $infos_utilisateur = $this->getInfosComplementairesUtilisateur($parametres['ce_utilisateur']); $parametres['courriel_utilisateur'] = $infos_utilisateur['courriel']; $parametres['nom_utilisateur'] = $infos_utilisateur['nom']; $parametres['prenom_utilisateur'] = $infos_utilisateur['prenom']; } /** * Formate les paramètres fournis en ajoutant des infos complementaires * * @param array $parametres tableau indexé avec les mêmes noms de champs que la bdd * * @return $parametres le tableau modifié selon ce qu'il contenait */ static function formaterParametresObservation(&$parametres) { // Pour empecher que des numéros de département de 1 à 9 soient saisis sans 0 // TODO: décider quoi faire pour les zones géo plus générales if (isset($parametres['ce_zone_geo'])) { if($parametres['ce_zone_geo'] == 'null' || trim($parametres['ce_zone_geo']) == "") { $parametres['ce_zone_geo'] = ""; } else { if (strlen($parametres['ce_zone_geo']) == 4) { $parametres['ce_zone_geo'] = '0'.$parametres['ce_zone_geo']; } if (strlen($parametres['ce_zone_geo']) > 0 && strlen($parametres['ce_zone_geo']) <= 2) { $parametres['ce_zone_geo'] = Cel::obtenirCodeInseeCommunePourNomEtDepartement($parametres['zone_geo'], $parametres['ce_zone_geo']); } else { $parametres['ce_zone_geo'] = 'INSEE-C:'. $parametres['ce_zone_geo']; } } } // TODO : voir si l'on peut utiliser un des fonctions de la classe cel if (isset($parametres['date_observation']) && $parametres['date_observation']!="null") { //TODO: prendre en compte des dates incomplètes ? if(count(explode("/",$parametres['date_observation'])) >= 3) { list($jour,$mois,$annee)=explode("/",$parametres['date_observation']); $parametres['date_observation']=$annee."-".$mois."-".$jour." 0:0:0"; } } } /** * Assemble une sous requete pour un ajout, tout en formatant les paramètres et en recherchant * les infos complémentaires * * @param array $parametres un tableau avec les index correspondant aux champs de la bdd * * @return string une sous requete utilisable pour l'ajout d'une observation */ private function traiterParametresObservationEtConstruireSousRequeteAjout($parametres) { $sous_requete = ''; $champs = ''; $valeurs = ''; // Nullifiage ... // TODO: code dupliqué, en faire une fonction à mettre à la place appropriée foreach($parametres as $cle => $valeur) { // Pour apparaitre le premier dans les tris ... if (trim($valeur) == "" || trim($valeur) == "null") { $valeur = "NULL"; } else { $valeur = Cel::db()->proteger($valeur); } $champs .= $cle.', '; $valeurs .= $valeur.', '; } $champs = '('.$champs.'mots_cles_texte, transmission, date_creation, date_modification, date_transmission)'; $valeurs = '('.$valeurs.'"", 0, now(), now(), "0000-00-00 00:00:00")'; $sous_requete .= $champs.' VALUES '.$valeurs; return $sous_requete; } /** * Assemble une sous requete pour une mise à jour, tout en formatant les paramètres et en recherchant * les infos complémentaires * * @param array $parametres un tableau avec les index correspondant aux champs de la bdd * * @return string une sous requete utilisable pour la modification d'une observation * selon la syntaxe UPDATE table SET colonne1 = valeur1, colonne2 = valeur2 WHERE condition */ static function traiterParametresObservationEtConstruireSousRequeteMaj($parametres) { $champs = array(); // Nullifiage ... // TODO: code dupliqué, en faire une fonction à mettre à la place appropriée foreach($parametres as $cle => $valeur) { // Pour apparaitre le premier dans les tris ... if (trim($valeur) == "" || trim($valeur) == "null" || trim($valeur) == "000null") { $valeur = "NULL"; } else { $valeur = Cel::db()->proteger($valeur); } $champs[] = $cle." = ".$valeur; } return $champs; } }