* @author Jean-Pascal MILCENT * @author Aurelien PERONNET * @license GPL v3 * @license CECILL v2 * @copyright 1999-2014 Tela Botanica */ class GestionObservation extends Cel { static $cel_obs = ['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', 'pays', '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); $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); $this->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()->executer($requete_insertion_observation); $retour = true; if ($resultat_ajout_observation === false) { $retour = false; $msg = "Erreur de creation d'une observation : $resultat_ajout_observation"; $this->logger('CEL_bugs', $msg); } 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) { $idUtilisateurP = Cel::db()->proteger($utilisateur); $requete = 'SELECT max(ordre) AS ordre '. 'FROM cel_obs '. "WHERE ce_utilisateur = $idUtilisateurP ". ' -- ' . __FILE__ . ':' . __LINE__; $dernier_ordre = Cel::db()->requeter($requete); $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) { $idUtilisateurP = Cel::db()->proteger($utilisateur); $ordreP = Cel::db()->proteger($ordre); $requete = 'SELECT id_observation '. 'FROM cel_obs '. "WHERE ce_utilisateur = $idUtilisateurP ". "AND ordre = $ordreP ". ' -- ' . __FILE__ . ':' . __LINE__; $dernier_id = Cel::db()->requeter($requete); $retour = null; if ($dernier_id != false) { $retour = $dernier_id[0]['id_observation']; } return $retour; } /** * 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) { if (isset($parametres['nom_sel'])) { // uniquement en cas de nom_sel présent $this->traiterEspece($parametres); } $this->formaterParametresObservation($parametres); $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); $champ_maj[] = "date_modification = NOW()"; $clauseSet = implode(', ', $champ_maj); $utilisateurIdP = Cel::db()->proteger($utilisateur); $requete = "UPDATE cel_obs SET $clauseSet ". "WHERE ordre IN ($ordre) ". " AND ce_utilisateur = $utilisateurIdP ". ' -- '.__FILE__.':'.__LINE__; $resultat = Cel::db()->executer($requete); $retour = true; if ($resultat === false) { $retour = false; $this->logger('CEL_bugs', "Erreur de mise à jour d'une liste d'observations : $requete"); } return $retour; } /** * @return nombre d'observations mises à jour, ou FALSE en cas de problème */ public function modifierMultiplesObservation($utilisateur, Array $ordre, $parametres) { // nous retirons 'ce_utilisateur' (== $utilisateur) qui sera dans la clause WHERE $exclusions = ['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 $this->formaterParametresObservation($parametres); if (isset($parametres['nom_sel'])) { // uniquement en cas de nom_sel présent $this->traiterEspece($parametres); } $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); $nbreUpdate = count($champ_maj); if ($nbreUpdate > 0) { $champ_maj[] = 'date_modification = NOW()'; $clauseSet = implode(', ', $champ_maj); $ordresListe = implode(', ', $ordre); $utilisateurIdP = Cel::db()->proteger($utilisateur); $requete = "UPDATE cel_obs SET $clauseSet ". "WHERE ordre IN ($ordresListe) ". "AND ce_utilisateur = $utilisateurIdP " .' -- '.__FILE__.':'.__LINE__; $nbreUpdate = Cel::db()->executer($requete); } return $nbreUpdate; // 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($id_obs, $parametres) { $parametresDefaut = array( 'nom_sel_nn' => NULL, 'nom_sel' => NULL, 'nom_ret_nn' => NULL, 'nom_referentiel' => NULL); $parametres = array_merge($parametresDefaut, $parametres); $this->traiterEspece($parametres); $this->formaterParametresObservation($parametres); $champ_maj = self::traiterParametresObservationEtConstruireSousRequeteMaj($parametres); $champ_maj[] = 'date_modification = NOW()'; $requete = "UPDATE cel_obs SET " . implode(', ', $champ_maj) . " WHERE id_observation = ".Cel::db()->proteger($id_obs). " AND transmission = 1 ". ' -- ' . __FILE__ . ':' . __LINE__; $resultat = Cel::db()->executer($requete); if ($resultat === false) { $this->logger("CEL_bugs", "Erreur de mise à jour de l'observation : ".$id_obs); } return $resultat; } /** * Si vous utiliser cette méthode, penser à mettre à jour les champs correspondant de la table cel_images. * Pour ce faire, utiliser GetionImage->modifierTransmissionParObs(). * @param mixed $ids_obs_ou_tableau id d'observation ou tableau d'ids d'observation. * @param bool $publier true pour publier, false pour dépublier. * @return type */ public function modifierTransmissionObservation($idsObs, $publier) { $ids_obs_proteges = Cel::db()->proteger($idsObs); $idsObsConcat = is_array($ids_obs_proteges) ? implode(', ', $ids_obs_proteges) : $ids_obs_proteges; $etat_transmission = $publier ? 1 : 0; $dateTransmission = $publier ? 'NOW()' : 'NULL'; $requete = 'UPDATE cel_obs '. "SET transmission = $etat_transmission , date_transmission = $dateTransmission, date_modification = NOW() ". "WHERE id_observation IN ($idsObsConcat) ". ' -- ' . __FILE__ . ':' . __LINE__; $resultat = Cel::db()->executer($requete); return $resultat; } /** * 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); $idUtilisateurP = Cel::db()->proteger($utilisateur); $requete = 'SELECT id_observation AS id_obs '. 'FROM cel_obs '. "WHERE ce_utilisateur = $idUtilisateurP ". "AND ordre IN ($ordre) ". ' -- '.__FILE__.':'.__LINE__; $resultats = Cel::db()->requeter($requete); $ids_obs = array(); $ids_obs_non_protegees = array(); if (is_array($resultats) && count($resultats) > 0) { foreach ($resultats as $id_observation) { $ids_obs[] = Cel::db()->proteger($id_observation['id_obs']); $ids_obs_non_protegees[] = $id_observation['id_obs']; } $chaine_ids_obs = implode(',', $ids_obs); $requete = 'DELETE FROM cel_obs WHERE '. "ce_utilisateur = $idUtilisateurP ". "AND id_observation IN ($chaine_ids_obs) ". ' -- '.__FILE__.':'.__LINE__; $resultat = Cel::db()->executer($requete); // TODO: Faire la suppression des mots clés // et des liaisons obs images dans une ou des fonctions à part if ($resultat === false) { $msg = "Erreur de suppression d'une liste d'observations : $resultat"; $this->logger('CEL_bugs', $msg); } else { // TODO [jpm] : pourquoi on supprime pas les images si on supprime les obs ? $gestion_mots_cles = new GestionMotsClesChemin($this->config, 'obs'); $resultat_suppression_mots_cles = $gestion_mots_cles->supprimerToutesLiaisonsPourIdsElementsLies($ids_obs_non_protegees); if ($resultat_suppression_mots_cles === false) { $msg = "Erreur de suppression d'une liste de mots clés d'observation(s) : $resultat_suppression_mots_cles"; $this->logger('CEL_bugs', $msg); } 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 $idAncienP = Cel::db()->proteger($ancien_id); $requete = 'SELECT ordre '. 'FROM cel_obs '. "WHERE ce_utilisateur = $idAncienP ". 'ORDER BY ordre '. ' -- '.__FILE__.' : '.__LINE__; $resultat = Cel::db()->requeter($requete); $reussite = true; if (is_array($resultat)) { foreach ($resultat as $releve_temporaire) { $idUtilisateurP = Cel::db()->proteger($id_utilisateur); $ancienOrdre = $releve_temporaire['ordre']; $requete = 'UPDATE cel_obs SET '. "ce_utilisateur = $idUtilisateurP, ". "ordre = $nouvel_ordre ". "WHERE ce_utilisateur = $idAncienP ". "AND ordre = $ancienOrdre ". ' -- '.__FILE__.' : '.__LINE__; $migration_releve = Cel::db()->executer($requete); //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).' '. ' -- '.__FILE__.' : '.__LINE__; $migration_releve = Cel::db()->executer($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'], $code_referentiel); // 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_sel'] = empty($parametres['nom_sel']) ? $complement->nom_sci : $parametres['nom_sel']; $parametres['nom_ret_nn'] = $complement->{"nom_retenu.id"}; $parametres['nt'] = $complement->num_taxonomique; $parametres['famille'] = $complement->famille; } } } else { // référentiel "autre": on vide ! $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'])) { $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 */ public function formaterParametresObservation(&$parametres) { if (isset($parametres['ce_zone_geo'])) { if (!$this->estPossiblementUnDepartement($parametres['ce_zone_geo'])) { $parametres['ce_zone_geo'] = ""; } else { if($this->estLaCorse($parametres['ce_zone_geo'])) { // "Décorsifiage" $parametres['ce_zone_geo'] = str_ireplace(array("2A", "2B"), "2", $parametres['ce_zone_geo']); } // Pour empecher que des numéros de département de 1 à 9 soient saisis sans 0 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']; } $parametres['pays'] = 'FR'; } } if(empty($parametres['pays']) && !empty($parametres['latitude']) && !empty($parametres['longitude'])) { $recherche_pays = new RechercheInfosZoneGeo($this->config); // Dans le cas de l'insertion de l'obs, il serait déraisonnable d'attendre plus de 2 secondes // pour détecter le pays qui sera de toute façon retrouvé par le script lancé en cron $recherche_pays->maxTimeoutRequeteMondiale = 2; $infos_pays = $recherche_pays->obtenirInfosPourCoordonnees($parametres); if($infos_pays['type'] == 'france') { $parametres['pays'] = 'FR'; // Ajout d'infos supplémentaires si jamais on a pas de ce zone geo ou de zone geo if(empty($parametres['ce_zone_geo'])) { $parametres['ce_zone_geo'] = 'INSEE-C:'.$infos_pays['code_insee']; } if(empty($parametres['zone_geo'])) { $parametres['zone_geo'] = $infos_pays['nom']; } } else { $parametres['pays'] = $infos_pays['code_pays']; } } // 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'; } } } private function estPossiblementUnDepartement($code) { return $code != 'null' && trim($code) != "" && (is_numeric($code) || $this->estLaCorse($code)); } private function estLaCorse($code) { return strtoupper($code) == "2A" || strtoupper($code) == "2B"; } /** * 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) { $champs = ''; $valeurs = ''; // Nullifiage ... // TODO: code dupliqué, en faire une fonction à mettre à la place appropriée foreach ($parametres as $cle => $valeur) { $valeur = self::renvoyerValeurDenullifiee($valeur); $champs .= $cle.', '; $valeurs .= $valeur.', '; } $champs = '('.$champs.'mots_cles_texte, transmission, date_creation, date_modification, date_transmission)'; $valeurs = '('.$valeurs.'"", 0, NOW(), NOW(), NULL)'; $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) { // Nullifiage ... // TODO: code dupliqué, en faire une fonction à mettre à la place appropriée $champs = array(); foreach ($parametres as $cle => $valeur) { $valeur = self::renvoyerValeurDenullifiee($valeur); $champs[] = $cle.' = '.$valeur; } return $champs; } private static function renvoyerValeurDenullifiee($valeur) { if (trim($valeur) == '' || trim($valeur) == 'null' || trim($valeur) == '000null') { $valeur = 'NULL'; } else { $valeur = Cel::db()->proteger($valeur); } return $valeur; } }