Subversion Repositories eFlore/Applications.cel

Rev

Rev 1591 | Blame | Last modification | View Log | RSS feed

<?php
// ATTENTION ! Classe compatible uniquement avec nouveau format de bdd du cel //

/**
* PHP Version 5
*
* @category  PHP
* @package   jrest
* @author    Aurelien Peronnet <aurelien@tela-botanica.org>
* @copyright 2010 Tela-Botanica
* @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
* @version   SVN: <svn_id>
* @link      /doc/jrest/
*/

/**
* Classe de gestion de l'ajout, modification et suppression des observations
* 
* in=utf8
* out=utf8
*
*/ 
class GestionObservation extends Cel {
        
        /**
        * 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) {
                                        
                $retour = true;
                $parametres['ordre'] = $this->renvoyerDernierOrdreUtilisePlusUn($utilisateur);
                                
        $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 = $this->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 = ".$this->proteger($utilisateur);

            $dernier_ordre = $this->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 = ".$this->proteger($utilisateur)." ".
                                                                                   "AND ordre = ".$this->proteger($ordre)." ";
        
                $dernier_id = $this->executerRequete($requete_selection_dernier_id); 
                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) {
                
                $retour = true;
                $requete_modification = "UPDATE cel_obs SET " ;

                $sous_requete_modification = $this->traiterParametresObservationEtConstruireSousRequeteMaj($parametres);
                $requete_modification .= $sous_requete_modification;

                $requete_modification .= " WHERE ordre IN (".$ordre.") AND ce_utilisateur = ".$this->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 = $this->executerRequeteSimple($requete_modification);
        
        if ($resultat_modification === false) {
                $retour = false;
                $this->logger("CEL_bugs","Erreur de mise à jour d'une liste d'observations : ".$requete_modification);
        }
                
                return $retour;
        }
        
        /**
        * 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) {
        
                $retour = true;
                $requete_modification = "UPDATE cel_obs SET " ;
        
                $sous_requete_modification = $this->traiterParametresObservationEtConstruireSousRequeteMaj($parametres);
                $requete_modification .= $sous_requete_modification;
        
                $requete_modification .= " WHERE id_observation = ".$this->proteger($id).
                                                                 " AND ce_utilisateur = ".$this->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 = $this->executerRequeteSimple($requete_modification);
                 
                if ($resultat_modification === false) {
                        $retour = false;
                        $this->logger("CEL_bugs","Erreur de mise à jour de l\'observation : ".$id);
                }
        
                return $retour;
        }
        
        /**
        * 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($this, 'proteger'), $tableau_ordre);
                $ordre = implode(',', $tableau_ordre);

                $requete_ids_observations = 'SELECT id_observation as id_obs FROM cel_obs '.
                                                                        'WHERE ce_utilisateur = '.$this->proteger($utilisateur).' '.
                                                                        'AND ordre IN ('.$ordre.')';
                $resultat_ids_observations = $this->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[] = $this->proteger($id_observation['id_obs']);
                        }
                        
                        $chaine_ids_obs = implode(',', $ids_obs);                                       
                    $requete_supression_observations = 'DELETE FROM cel_obs WHERE '.
                                                       'ce_utilisateur = '.$this->proteger($utilisateur).' '.
                                                       'AND id_observation IN ('.$chaine_ids_obs.')';

                        $resultat_suppression_observations = $this->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_utilisateur = '.$this->proteger($utilisateur).' '.
                                                                                                          'AND id_observation IN ('.$chaine_ids_obs.')';
        
                    $resultat_suppression_liens = $this->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 = $this->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 = '.$this->proteger($ancien_id).' ORDER BY ordre';
                $resultat_releves_temporaires = $this->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 = '.$this->proteger($id_utilisateur).', '.
                                                                                        'ordre = '.$nouvel_ordre.' '. 
                                                                                        'WHERE ce_utilisateur = '.$ancien_id.' '.
                                                                                        'AND ordre = '.$releve_temporaire['ordre'];
                            $migration_releve = $this->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 = '.$this->proteger($infos_utilisateur['id_utilisateur']).', '.
                                                                                                'prenom_utilisateur = '.$this->proteger($infos_utilisateur['prenom']).', '.
                                                                                                'nom_utilisateur = '.$this->proteger($infos_utilisateur['nom']).', '.
                                                                                                'courriel_utilisateur = '.$this->proteger($infos_utilisateur['courriel']).' '.
                                                                                                'WHERE ce_utilisateur = '.$this->proteger($mail_utilisateur).' ';

                $migration_releve = $this->executerRequeteSimple($requete_migration_releve);
        
                return $migration_releve;
        }
        
        /**
        * 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
        */
        private function formaterParametresObservation(&$parametres) {
                                
                $code_referentiel = 'bdtfx';
                if(!isset($parametres['nom_referentiel'])) {
                        $parametres['nom_referentiel'] = 'bdtfx:v1.01';
                }
                $code_referentiel = substr($parametres['nom_referentiel'], 0, 5);
                if ($this->estUnNomSolitaire($parametres)) {
                        
                        $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(count($complement) > 0) {
                                $parametres['nom_sel_nn'] = $complement[0][0];
                        }
                }

                if ($this->parametreNumNomEstPresent($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->rechercherInformationsComplementairesSurNumNom($parametres['nom_sel_nn']);
                        
                        $parametres['nom_ret']=$complement['Nom_Retenu'];
                $parametres['nom_ret_nn']=$complement['Num_Nom_Retenu'];
                $parametres['nt']=$complement['Num_Taxon'];
                $parametres['famille']=$complement['Famille'];
                }
                
                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'];
                }
                
                // 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'] = $this->obtenirCodeInseeCommunePourNomEtDepartement($parametres['zone_geo'], $parametres['ce_zone_geo']);
                        } else {                         
                                $parametres['ce_zone_geo'] = $this->convertirCodeInseeVersCodeZoneGeo($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";
                }
        }
        return $parametres;
        }
        
        private function estUnNomSolitaire($parametres) {
                return $this->parametreNumNomPasPresent($parametres) && $parametres['nom_sel'] != '';
        }
        
        private function parametreNumNomEstPresent($parametres) {
                return !$this->parametreNumNomPasPresent($parametres);
        }
        
        private function parametreNumNomPasPresent($parametres) {
                return (!isset($parametres['nom_sel_nn']) || 
                                $parametres['nom_sel_nn'] == null ||
                                $parametres['nom_sel_nn'] == '' || 
                                $parametres['nom_sel_nn'] == 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 = '';

                $parametres = $this->formaterParametresObservation($parametres);
                
                $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 = $this->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 
         */     
        private function traiterParametresObservationEtConstruireSousRequeteMAJ($parametres) {
                
                $sous_requete = '';

                $parametres = $this->formaterParametresObservation($parametres);
                
                // 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 = $this->proteger($valeur);
                        }
                        
                $sous_requete .= $cle." = ".$valeur.", ";
                }
                
                $sous_requete .= ' date_modification = now() ';
                
                return $sous_requete;
        }
} 
?>