Rev 7 | Rev 19 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed
<?php
/**
* PHP Version 5
*
* @category PHP
* @package annuaire
* @author aurelien <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/annuaire/
*/
class AnnuaireControleur extends Controleur {
/**
* (fonction héritée de la classe Controleur)
* Avant chaque chargement de vue, on ajoute l'url de la page dans
* les variables à insérer.
* @param Array $donnes les données à insérer dans la vue
* @return Array $donnees les données modifiées
*/
public function preTraiterDonnees($donnees) {
$donnees['base_url'] = Registre::getInstance()->get('base_url_application');
return $donnees;
}
/**
* Fonction affichant la vue par défaut, ici le menu principal
* @return String la vue contenant le menu
*/
public function index() {
$data = array();
$index_annuaire = $this->getVue('index_annuaire', $data);
return $index_annuaire;
}
/**-------- Fonctions de gestion des annuaires --------------------------------*/
/**
* Charge la vue contenant la liste des annuaires gérés par l'application
* @return string la vue contenant la liste des annuaires
*/
public function chargerListeAnnuaire() {
$this->chargerModele('AnnuaireModele');
$data['erreurs'] = null;
$data['annuaires'] = $this->AnnuaireModele->chargerListeAnnuaire();
$liste_annu = $this->getVue(Config::get('dossier_squelettes_annuaires').'liste_annu', $data);
return $liste_annu;
}
/**
* Charge la vue contenant les informations d'un annuaire donné en paramètre
* @param int $id l'identifiant de l'annuaire
* @return string la vue contenant les informations sur l'annuaire
*/
public function chargerAnnuaire($id) {
$this->chargerModele('AnnuaireModele');
$this->chargerModele('MetadonneeModele');
$data['erreurs'] = array();
$data['annuaire'] = $this->AnnuaireModele->chargerAnnuaire($id, true);
$data['metadonnees'] = $this->MetadonneeModele->chargerListeMetadonneeAnnuaire($id);
$annuaire = $this->getVue(Config::get('dossier_squelettes_annuaires').'annuaire', $data);
return $annuaire;
}
/**
* Charge et affiche la liste des inscrits à un annuaire donné en paramètre
* @param $id int l'identifiant de l'annuaire
* @return string la vue contenant les inscrits à l'annuaire
*/
public function chargerAnnuaireListeInscrits($id, $numero_page = 1, $taille_page = 50) {
$this->chargerModele('AnnuaireModele');
$data['erreurs'] = array();
$data['champs'] = $this->obtenirChampsMappageAnnuaire($id);
$total_inscrits = $this->AnnuaireModele->chargerNombreAnnuaireListeInscrits($id);
$data['annuaire'] = $this->AnnuaireModele->chargerAnnuaireListeInscrits($id, $data['champs'][0], $numero_page, $taille_page);
$url_base = clone(Registre::getInstance()->get('base_url_application'));
$url_base->setVariableRequete('m','annuaire_inscrits');
$url_base->setVariableRequete('id_annuaire',$id);
$data['pagination'] = $this->paginer($numero_page,$taille_page,$total_inscrits,$url_base);
$annuaires_inscrits = $this->getVue(Config::get('dossier_squelettes_annuaires').'annuaire_inscrits', $data);
return $annuaires_inscrits;
}
/**-------- Fonctions d'affichage du formulaire de saisie d'un champ de metadonnée suivant le type de champ---------*/
/**
* Affiche le formulaire d'inscription pour un annuaire donné
* @param int $id_annuaire l'identifiant de l'annuaire pour lequel on veut afficher le formulaire
* @param Array $donnees le tableau de données pour préremplir le formulaire si besoin (en cas de retour erreur)
*/
public function afficherFormulaireInscription($id_annuaire, $donnees=array()) {
$this->chargerModele('AnnuaireModele');
$annuaire = $this->AnnuaireModele->chargerAnnuaire($id_annuaire, false);
$this->chargerModele('MetadonneeModele');
$donnees['aa_id_annuaire'] = $id_annuaire;
$metadonnees = $this->MetadonneeModele->chargerListeMetadonneeAnnuaire($id_annuaire);
// TODO: ceci charge toutes les métadonnées, voir si l'on ne peut pas parser le formulaire
// pour ne charger que ce qui est nécéssaire
foreach($metadonnees as $metadonnee) {
$id_champ = $metadonnee['amc_id_champ'];
$nom_champ = $metadonnee['amc_abreviation'];
$metadonnee['aa_id_annuaire'] = $id_annuaire;
// on charge le formaulaire d'affichage de chacune des métadonnées
$donnees['champs'][$nom_champ] = $this->afficherFormulaireChampMetadonnees($id_champ,$metadonnee);
}
// le nom du formulaire d'inscription est le même que le code de l'annuaire
// TODO: réfléchir à une meilleure manière de stocker ça
// Générer un fichier s'il n'existe pas ? et ensuite le lire ?
if(!$this->formulaireExiste($annuaire['informations']['aa_code'])) {
$formulaire_inscription = $this->genererFormulaireInscription($donnees);
} else {
$formulaire_inscription = $this->GetVue(Config::get('dossier_squelettes_formulaires').$annuaire['informations']['aa_code'].'_inscription',$donnees);
}
return $formulaire_inscription;
}
/**
* Charge et affiche le champ correspondant à la modification ou l'ajout d'un champ de metadonnée
* @param int $id_champ l'identifiant du champ demandé
* @return string la vue contenant le champ de formulaire correspondant
*/
public function afficherFormulaireChampMetadonnees($id_champ, $donnees=array()) {
// si le champ est restreint à une valeur de liste
if($donnees['amc_ce_ontologie'] != 0) {
$this->chargerModele('OntologieModele');
$donnees['liste_valeurs'] = $this->OntologieModele->chargerListeOntologie($donnees['amc_ce_ontologie']);
}
$donnees['amc_id_champ'] = $id_champ;
$this->chargerModele('MetadonneeModele');
$nom__type_champ = $this->MetadonneeModele->renvoyerCorrespondanceNomTemplateChamp($donnees['amc_ce_type_affichage']);
return $this->getVue(Config::get('dossier_squelettes_champs').$nom__type_champ,$donnees);
}
/**-------- Fonctions d'inscription -------------------------------------------------------------------------------*/
/**
* Lors d'une tentative d'inscription, ajoute les infos dans la table d'inscription
* temporaire et envoie le mail contenant le lien de confirmation si tout s'est bien passé
* @param Array $valeurs les valeurs à ajouter
* @return string la vue contenant la confirmation de l'inscription
*/
public function ajouterInscriptionTemporaire($valeurs) {
$this->chargerModele('MetadonneeModele');
$id_annuaire = $valeurs['aa_id_annuaire'];
unset($valeurs['aa_id_annuaire']);
$tableau_mappage = $this->obtenirChampsMappageAnnuaire($id_annuaire);
$valeurs_mappees = array();
// on itère sur le tableau de valeur pour récupérer les champs de mappage;
foreach($valeurs as $nom_champ => $valeur) {
// pour chaque valeur
// on extrait l'id du champ
$ids_champ = mb_split("_",$nom_champ, 3);
if(count($ids_champ) == 3) {
$type = $ids_champ[0];
$id_champ = $ids_champ[2];
$confirmation = $ids_champ[2];
} else {
$type = $ids_champ[0];
$confirmation = false;
$id_champ = $ids_champ[1];
}
// on fait des vérifications et des remplacements sur certaines valeurs
$valeurs[$nom_champ] = $this->verifierEtRemplacerValeurChamp($type,$valeur,$confirmation);
// Si le champ fait partie des champs mappés
$cle_champ = array_search($id_champ, $tableau_mappage[1]);
if($cle_champ) {
// on ajoute sa clé correspondante dans le tableau des champs mappés
// qui sont les champs à vérifier
if($confirmation) {
$valeurs_mappees[$cle_champ.'_conf'] = $valeur;
} else {
$valeurs_mappees[$cle_champ] = $valeur;
}
}
}
// vérification des champs minimaux : nom, prénom, mail, mot de passe
// TODO: des champs minimaux différents pour chaque annuaire ? comment les stocke t'on ?
if($erreurs = $this->verifierErreursChamps($id_annuaire,$valeurs_mappees, $tableau_mappage)) {
$valeurs['erreurs'] = $erreurs;
return $this->afficherFormulaireInscription($id_annuaire, $valeurs);
}
$code_confirmation = $this->InsererDansTableTemporaireEtCreerCodeConfirmationInscription($valeurs);
$this->envoyerMailConfirmationInscription($valeurs_mappees['champ_mail'],
$valeurs_mappees['champ_nom'],
$valeurs_mappees['champ_prenom'],
$code_confirmation);
// Si tout s'est bien passé, on affiche la page de confirmation
return $this->getVue(Config::get('dossier_squelettes_annuaires').'annuaire_inscription_reussie',array());
}
/**
* Ajoute une nouvelle inscription à un annuaire à partir de données d'une table temporaire.
* Typiquement, on déclenche cette fonction en cliquant sur le lien contenu dans le mail de confirmation
* @param int $indentifant L'identifant de session d'une tentative d'inscription
*/
public function ajouterNouvelleInscription($identifiant) {
$this->chargerModele('AnnuaireModele');
$valeurs = $this->AnnuaireModele->chargerDonneesInscriptionTemporaire($identifiant);
if(!$valeurs || count($valeurs) == 0) {
// TODO afficher vue en cas d'echec
}
//$id_annuaire = $valeurs['aa_id_annuaire'];
unset($valeurs['aa_id_annuaire']);
$id_annuaire = 1;
$this->chargerModele('MetadonneeModele');
$tableau_mappage = $this->obtenirChampsMappageAnnuaire($id_annuaire);
$valeurs_mappees = array();
// on itère sur le tableau de valeur pour récupérer les métadonnées;
foreach($valeurs as $nom_champ => $valeur) {
// pour chaque valeur
// on extrait l'id du champ
$ids_champ = mb_split("_",$nom_champ);
$id_champ = $ids_champ[count($ids_champ) - 1];
// Si le champ fait partie des champs mappés
$cle_champ = array_search($id_champ, $tableau_mappage[1]);
if($cle_champ) {
// on ajoute sa clé correspondante dans l'annuaire mappé et sa valeur dans le tableau des champs mappés
$valeurs_mappees[$tableau_mappage[0][$cle_champ]] = $valeur;
// et on supprime sa valeur du tableau de valeurs pour ne pas la retrouver lors
// de l'insertion des métadonnées
unset($valeurs[$nom_champ]);
}
}
// obtenir l'id du nouvel arrivant en faisant un select sur le mail qui doit être unique
$id_nouvel_inscrit = $this->ajouterNouvelleInscriptionDansAnnuaireMappe($id_annuaire,$valeurs_mappees, $tableau_mappage[0]);
// les champs de metadonnees arrivent avec un identifiant sous la forme type_xxx_id
foreach($valeurs as $nom_champ => $valeur) {
// l'identifiant du champ est la dernière valeur du tableau
$ids_champ = mb_split("_",$nom_champ);
$type = $ids_champ[0];
$id_champ = $ids_champ[count($ids_champ) - 1];
// Si l'insertion dans la base a réussi
if($this->MetadonneeModele->ajouterNouvelleValeurMetadonnee($id_champ,$id_nouvel_inscrit,$valeur)) {
// on continue
} else {
// Si une des insertions échoue, on supprime les méta valeurs déjà entrées.
$this->MetadonneeModele->supprimerValeursMetadonneesParIdEnregistrementLie($id_nouvel_inscrit);
return false;
}
}
//TODO: gérer le cas de spip et de wikini par un multimapping des champs
//TODO: voir openid
// Si tout a réussi on supprime les données d'inscription temporaire
$this->AnnuaireModele->supprimerDonneesInscriptionTemporaire($identifiant);
// TODO: renvoyer l'utilisateur sur sa fiche
return $this->afficherFormulaireUploadImage($id_annuaire, $identifiant);
}
/**
* Ajoute un nouvel inscrit dans l'annuaire mappé donné en paramètre.
* En cas de succès, renvoie l'identifiant du nouvel inscrit qui sera
* utilisé pour insérer les métadonnées liées
*
* @param int $id_annuaire identifiant de l'annuaire auquel sera lié le nouvel inscrit
* @param Array $valeurs_mappees Tableau contenant les valeurs à insérer et ayant comme clés des noms de colonnes
* @param Array $noms_champs Tableau contenant les noms des champs à insérer
* @return int l'identifiant unique du nouvel inscrit
*/
public function ajouterNouvelleInscriptionDansAnnuaireMappe($id_annuaire,$valeurs_mappees, $noms_champs) {
$this->chargerModele('AnnuaireModele');
$resultat = $this->AnnuaireModele->ajouterDansAnnuaireMappe($id_annuaire, $valeurs_mappees, $noms_champs);
return $resultat;
}
/**
* Affiche la fiche principale d'un utilisateur
* @param int $id_annuaire l'identifiant de l'annuaire
* @param int $id_utilisateur l'identifiant de l'utilisateur
* @return string la vue contenant la fiche utilisateur
*/
public function afficherFicheUtilisateur($id_annuaire, $id_utilisateur) {
$this->chargerModele('AnnuaireModele');
$tableau_mappage = $this->obtenirChampsMappageAnnuaire($id_annuaire);
$tableau_valeurs = $this->AnnuaireModele->obtenirValeursUtilisateur($id_annuaire, $id_utilisateur,$tableau_mappage[0]);
// pour le moment on considère que les champs de mappage ne sont pas des valeurs d'ontologies
// stockées dans la table ontologie
foreach($tableau_mappage[0] as $cle => $nom_champ) {
$valeur = $tableau_valeurs[$nom_champ] ;
$tableau_valeurs[$cle] = $valeur;
unset($tableau_valeurs[$nom_champ]);
}
$this->chargerModele('MetadonneeModele');
$champs_metadonnees= $this->MetadonneeModele->chargerListeValeursMetadonneesUtilisateur($id_annuaire, $id_utilisateur);
$donnees['id_annuaire'] = $id_annuaire;
$donnees['champs'] = array_merge($tableau_valeurs, $champs_metadonnees);
$annuaire_inscrits = $this->getVue(Config::get('dossier_squelettes_fiches').'annuaire_tela_inscrits_fiche',$donnees);
return $annuaire_inscrits;
}
/**
* En cas de tentative d'inscription, envoie un mail contenant un lien de confirmation à l'utilisateur
* @param string $adresse_mail adresse mail
* @param string $nom nom
* @param string $prenom prénom
* @param string $code_confirmation_inscription code de confirmation à inclure dans le mail
*
* @return boolean le succès ou l'échec de l'envoi du mail
*/
public function envoyerMailConfirmationInscription($adresse_mail, $nom, $prenom, $code_confirmation_inscription) {
$base_url = clone(Registre::getInstance()->get('base_url_application'));
$base_url->setVariableRequete('m','annuaire_inscription_confirmation');
$base_url->setVariableRequete('id',$code_confirmation_inscription);
$donnees = array('nom' => $nom, 'prenom' => $prenom, 'lien_confirmation_inscription' => $base_url->getURL());
$contenu_mail = $this->getVue(Config::get('dossier_squelettes_mails').'mail_confirmation_inscription',$donnees);
// Pour envoyer un mail HTML, l'en-tête Content-type doit être défini
$entetes = 'MIME-Version: 1.0' . "\r\n";
$entetes .= 'Content-type: text/html; charset='.Config::get('appli_encodage'). "\r\n";
// En-têtes additionnels
$entetes .= 'To: '.$adresse_mail."\r\n";
$entetes .= 'From: '.Config::get('adresse_mail_annuaire')."\r\n";
return mail($adresse_mail,'Inscription au site Tela Botanica',$contenu_mail, $entetes);
}
/**
* Insère les données dans la table d'inscription temporaire et crée un code de confirmation (à insérer dans le mail)
* @param Array $valeurs les valeurs à insérer
*/
private function InsererDansTableTemporaireEtCreerCodeConfirmationInscription($valeurs) {
// Le code de confirmation est constitué des 8 premiers caractères de l'identifiant de session
$code_confirmation = substr(session_id(), 0, 8) ;
$this->chargerModele('AnnuaireModele');
if(!$this->AnnuaireModele->ajouterNouvelleInscriptionTemporaire($code_confirmation, $valeurs)) {
return false;
}
return $code_confirmation;
}
/**--------------------------- Fonctions de vérification et de correspondance des champs --------------------*/
/**
* Renvoie les champs de mappage correspondant à un annuaire donné
* @param int $id_annuaire l'indentifant de l'annuaire pour lequel on veut ces informations
* @return Array un tableau de mappage des champs
*
*/
private function obtenirChampsMappageAnnuaire($id_annuaire) {
$tableau_mappage = array();
$tableau_mappage[0]['champ_id'] = 'U_ID';
$tableau_mappage[0]['champ_mail'] = 'U_MAIL';
$tableau_mappage[0]['champ_nom'] = 'U_NAME';
$tableau_mappage[0]['champ_prenom'] = 'U_SURNAME';
$tableau_mappage[0]['champ_pass'] = 'U_PASSWD';
//$tableau_mappage[1]['champ_id'] = 'U_ID';
$tableau_mappage[1]['champ_mail'] = '16';
$tableau_mappage[1]['champ_nom'] = '1';
$tableau_mappage[1]['champ_prenom'] = '7';
$tableau_mappage[1]['champ_pass'] = '11';
// TODO: voir comment stocker les correspondances de mappage
return $tableau_mappage;
}
// TODO: utiliser les fonction de mappage définies plus haut
/**
* Vérifie que les valeurs pour des champs de mappage d'un annuaire donné
* sont correctes
* @param int $id_annuaire l'identifiant de l'annuaire
* @param Array $valeurs les valeurs à vérifier
*/
private function verifierErreursChamps($id_annuaire, $valeurs, $tableau_mappage) {
$erreurs = false;
if(!$this->mailValide($valeurs['champ_mail'])) {
$erreurs['text_'.$tableau_mappage[1]['champ_mail']] = 'mail invalide';
}
if(trim($valeurs['champ_pass']) == ''
|| $valeurs['champ_pass'] != $valeurs['champ_pass']) {
$erreurs['password_'.$tableau_mappage[1]['champ_pass']] = 'mot de passe invalide';
}
if(trim($valeurs['champ_nom']) == '') {
$erreurs['text_'.$tableau_mappage[1]['champ_prenom']] = 'le nom est obligatoire';
}
if(trim($valeurs['champ_prenom']) == '') {
$erreurs['text_'.$tableau_mappage[1]['champ_nom']] = 'le prénom est obligatoire';
}
return $erreurs;
}
private function verifierEtRemplacerValeurChamp($type, $valeur) {
$valeur_modifiee = $valeur;
switch($type) {
// cas du champ texte, à priori, rien de particulier
case 'text':
$valeur_modifiee = $valeur;
break;
// cas du champ password : on le crypte
case 'password':
$valeur_modifiee = $this->encrypterMotDePasse($valeur);
break;
// cas du champ checkbox
case 'checkbox':
// Si c'est un groupe checkbox, alors c'est une liste de checkbox liée à une ontologie
if(is_array($valeur)) {
// on stocke les valeurs d'ontologies liées au cases cochées
$valeur_modifiee = implode(Config::get('separateur_metadonnee'), array_keys($valeur));
} else {
// sinon on stocke 1 pour indique que la case est cochée (cas de la checkbox oui/non)
$valeur_modifiee = 1;
}
break;
default:
$valeur_modifiee = $valeur;
break;
}
return $valeur_modifiee;
}
private function verifierEtRemplacerValeurChampPourAffichage($type, $valeur) {
$valeur_modifiee = $valeur;
/*switch($type) {
// cas du champ texte, à priori, rien de particulier
case 'text':
$valeur_modifiee = $valeur;
break;
// cas du champ checkbox
case 'checkbox':
// Si c'est un groupe checkbox, alors c'est une liste de checkbox liée à une ontologie
if(is_array($valeur)) {
// on stocke les valeurs d'ontologies liées au cases cochées
$valeur_modifiee = implode(Config::get('separateur_metadonnee'), array_keys($valeur));
} else {
// sinon on stocke 1 pour indique que la case est cochée (cas de la checkbox oui/non)
$valeur_modifiee = 1;
}
break;
default:
$valeur_modifiee = $valeur;
break;
}*/
return $valeur_modifiee;
}
/**
* Renvoie vrai ou faux suivant qu'un mail donné en paramètre est syntaxiquement valide (ne vérifie pas l'existence
* de l'adresse)
* @param string $mail le mail à tester
* @return boolean vrai ou faux suivant que le mail est valide ou non
*/
private function mailValide($mail) {
$regexp_mail = '/^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})$/';
return preg_match($regexp_mail, $mail);
}
/**
* Renvoie un mot de passe crypté selon la fonction d'encryptage définie dans le fichier de configuration
* (si celle-ci n'existe pas on utilise une fonction par défaut)
* @param string $pass le mot de passe à encrypter
* @return string le mot de passe encrypté
*/
private function encrypterMotDePasse($pass) {
$fonction = Config::get('pass_crypt_fonct');
if(function_exists($fonction)) {
return $fonction($pass);
} else {
return md5($pass);
}
}
/**
* Renvoie le formulaire demandé s'il existe, sinon faux
* @param string $nom_formulaire le nom du formulaire demandé (qui est normalement le code d'un annuaire)
* @return boolean true si le formulaire existe, false sinon
*/
private function formulaireExiste($nom_formulaire) {
return file_exists(Config::get('chemin_squelettes').Config::get('dossier_squelettes_formulaires').$nom_formulaire.'_inscription.tpl.html');
}
/**
* Renvoie un formulaire d'inscription minimal auto-généré
* @param string $donnees les donnée à inclure dans le formulaire
* @return string la vue contenant le formulaire généré
*/
private function genererFormulaireInscription($donnees) {
$formulaire_modele = $this->getVue(Config::get('dossier_squelettes_formulaires').'inscription',$donnees);
if($formulaire_modele) {
return $formulaire_modele;
} else {
trigger_error("impossible de trouver le squelette de référence pour le formulaire");
}
return false;
}
/**
* Renvoie le template de pagination, considérant des éléments donnés en paramètre
*/
private function paginer($numero_page, $taille_page, $total, $url_base = '') {
// TODO, faire plus complexe, tri alphabétique etc...
$page_precedente = $numero_page-1;
$page_suivante = $numero_page+1;
$nombre_pages = round($total/$taille_page,'PHP_ROUND_HALF_DOWN') ;
if($numero_page < 2) {
$page_precedente = false;
}
if($taille_page*($numero_page) >= $total) {
$page_suivante = false;
}
$donnees['pagination']= array('numero_page' => $numero_page, 'page_precedente' => $page_precedente, 'page_suivante' => $page_suivante, 'nombre_pages' => $nombre_pages, 'taille_page' => $taille_page);
$donnees['base_url_pagination'] = clone($url_base);
return $this->getVue(Config::get('dossier_squelettes_elements').'pagination',$donnees);
}
public function afficherFormulaireUploadImage($id_annuaire,$id_utilisateur) {
$donnees['aa_id_annuaire'] = $id_annuaire;
$donnees['id_utilisateur'] = $id_utilisateur;
$donnees['amc_nom'] = 'Avatar';
$donnees['amc_id_champ'] = 101;
return $this->getVue(Config::get('dossier_squelettes_champs').'image',$donnees);
}
/**
* Ajoute une image uploadée à travers le formulaire
*
*/
public function ajouterImageUtilisateur($id_annuaire, $id_utilisateur, $fichier_a_stocker) {
foreach($fichier_a_stocker as $nom_champ => $fichier) {
//TODO: ajouter les vérifications de format
$ids_champ = mb_split("_",$nom_champ, 3);
if(count($ids_champ) == 2) {
$type = $ids_champ[0];
$id_champ = $ids_champ[1];
} else {
trigger_error('Ce champ n\'est pas relié à un annuaire');
return false;
}
$this->chargerModele('ImageModele');
$stockage_image = $this->ImageModele->stockerFichier($id_annuaire, $id_utilisateur, $fichier);
$this->chargerModele('MetadonneeModele');
if($stockage_image && $this->MetadonneeModele->ajouterNouvelleValeurMetadonnee($id_champ,$id_utilisateur,$stockage_image)) {
} else {
return false;
}
}
return true ;
}
}
?>