/trunk/services/modules/0.1/motscles/ListeMotsCles.php |
---|
New file |
0,0 → 1,184 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Le web service image récupère des listes de mots clés associés aux images |
* |
* @category php 5.2 |
* @package del |
* @subpackage motscles |
* @author Aurélien PERONNET <aurelien@tela-botanica.org> |
* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @version $Id$ |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images |
*/ |
class ListeMotsCles { |
private $conteneur; |
private $navigation; |
private $masque; |
private $gestionBdd; |
private $bdd; |
private $parametres = array(); |
private $ressources = array(); |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->conteneur->chargerConfiguration('config_mots_cles.ini'); |
$this->conteneur->chargerConfiguration('config_mapping_mots_cles.ini'); |
$this->navigation = $conteneur->getNavigation(); |
$this->masque = $conteneur->getMasque(); |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
} |
/** |
* Méthode principale de la classe. |
* Lance la récupération des images dans la base et les place dans un objet ResultatService |
* pour l'afficher. |
* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2) |
* @param array $parametres les paramètres situés après le ? dans l'url |
* */ |
public function consulter($ressources, $parametres) { |
$this->initialiserRessourcesEtParametres($ressources, $parametres); |
// Gestion des configuration du script |
$this->configurer(); |
$this->verifierConfiguration(); |
// Lancement du service |
$mots_cles = $this->chargerMotsCles(); |
$mots_cles = $this->formaterMotsCles($mots_cles); |
$total = $this->compterMotsCles(); |
$this->navigation->setTotal($total); |
$resultat = new ResultatService(); |
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $mots_cles); |
return $resultat; |
} |
private function initialiserRessourcesEtParametres($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
} |
/*------------------------------------------------------------------------------- |
CONFIGURATION DU SERVICE |
--------------------------------------------------------------------------------*/ |
/** |
* Configuration du service en fonction du fichier de config config_del.ini |
* */ |
public function configurer() { |
$this->mappingMotsCles = $this->conteneur->getParametre('mapping_mots_cles'); |
$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque'); |
} |
/** |
* Vérifier que le service est bien configuré |
* */ |
public function verifierConfiguration() { |
$erreurs = array(); |
$tableau_mots_cles = $this->conteneur->getParametre('motscles'); |
if (empty($tableau_mots_cles)) { |
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [motscles] ou celui-ci est vide ;'; |
} else { |
if ($this->conteneur->getParametre('url_service') == null) { |
$erreurs[] = '- paramètre "url_service" manquant ;'; |
} |
} |
if (empty($this->mappingFiltre)) { |
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_masque] ou celui-ci est vide ;'; |
} |
if (!empty($erreurs)) { |
$e = 'Erreur lors de la configuration : '."\n"; |
$e .= implode("\n", $erreurs); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
} |
/** |
* Charger la clause WHERE en fonction des paramètres de masque |
* */ |
private function chargerClauseWhere() { |
$where = array(); |
$tableauMasque = $this->masque->getMasque(); |
if (!empty($tableauMasque)) { |
foreach($tableauMasque as $idMasque => $valeurMasque) { |
//TODO: scinder ceci en fonctions réutilisables ? |
// voir si c'est interessant par rapport à la recherche générale |
$idMasque = str_replace('masque.', '', $idMasque); |
switch ($idMasque) { |
default: |
$where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque); |
break; |
} |
} |
} |
if (!empty($where)) { |
return ' WHERE '.implode('AND', $where); |
} else { |
return; |
} |
} |
/*------------------------------------------------------------------------------- |
CHARGEMENT DES MOTS CLES |
--------------------------------------------------------------------------------*/ |
/** |
* Chargement depuis la bdd de tous les mots clés |
* */ |
private function chargerMotsCles() { |
$requeteLiaisons = 'SELECT DISTINCT SQL_CALC_FOUND_ROWS * '. |
'FROM '.$this->gestionBdd->formaterTable('del_image_tag', 'dit'); |
$requeteLiaisons .= $this->chargerClauseWhere(); |
$requeteLiaisons .= $this->gestionBdd->getLimitSql(); |
return $this->bdd->recupererTous($requeteLiaisons); |
} |
/** |
* Compter le nombre total de mots clés dans la base pour affichage dans en tete. |
* */ |
private function compterMotsCles() { |
$requete = 'SELECT FOUND_ROWS() AS nbre '; |
$resultats = $this->bdd->recuperer($requete); |
return (int) $resultats['nbre']; |
} |
/*------------------------------------------------------------------------------- |
FORMATER ET METTRE EN FORME |
--------------------------------------------------------------------------------*/ |
/** |
* Formater les mots clés |
* @param $mots clés les mots clés à mettre à jour |
* @return $mots clés les mots clés mis à jour |
* */ |
private function formaterMotsCles($mots_cles) { |
$retour = array(); |
foreach ($mots_cles as $id => $mot_cle) { |
$mapping = array(); |
foreach ($this->mappingMotsCles as $nomOriginal => $nomFinal) { |
$mapping[$nomFinal] = $mot_cle[$nomOriginal]; |
} |
$retour[$mot_cle['id_tag']] = $mapping; |
} |
return $retour; |
} |
private function proteger($valeur) { |
if (is_array($valeur)) { |
return $this->bdd->protegerTableau($valeur); |
} else { |
return $this->bdd->proteger($valeur); |
} |
} |
} |
?> |
/trunk/services/modules/0.1/motscles/AjouterMotCle.php |
---|
New file |
0,0 → 1,141 |
<?php |
// declare(encoding='UTF-8'); |
/** |
* Ajoute un mot clé en l'associant à un identifiant d'image |
* |
* @category php 5.2 |
* @package del |
* @subpackage images |
* @author Aurélien PERONNET <aurelien@tela-botanica.org> |
* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org) |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL |
* @version $Id$ |
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images |
*/ |
class AjouterMotCle { |
private $conteneur; |
private $navigation; |
private $masque; |
private $gestionBdd; |
private $bdd; |
private $parametres = array(); |
private $ressources = array(); |
private $commentaire; |
public function __construct(Conteneur $conteneur = null) { |
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur; |
$this->navigation = $conteneur->getNavigation(); |
$this->masque = $conteneur->getMasque(); |
$this->gestionBdd = $conteneur->getGestionBdd(); |
$this->bdd = $this->gestionBdd->getBdd(); |
} |
/** |
* Ajoute un mot-clé si les objets fournis en paramètres sont valides |
* pour l'afficher. |
* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2) |
* @param array $parametres les paramètres situés après le ? dans l'url |
* */ |
public function ajouter($ressources, $parametres) { |
$this->initialiserRessourcesEtParametres($ressources, $parametres); |
// Gestion des configuration du script |
$this->verifierConfiguration(); |
$insertion = $this->insererMotCle($this->parametres); |
// Mettre en forme le résultat et l'envoyer pour affichage |
$resultat = new ResultatService(); |
$resultat->corps = array('id_mot_cle' => $insertion); |
return $resultat; |
} |
private function initialiserRessourcesEtParametres($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
} |
/*------------------------------------------------------------------------------- |
CONFIGURATION DU SERVICE |
--------------------------------------------------------------------------------*/ |
/** |
* Vérifier que le service est bien configuré |
* */ |
public function verifierConfiguration() { |
$erreurs = array(); |
if (!isset($this->parametres['image'])) { |
$erreurs[] = ' - impossible d\'ajouter un mot clé sans image associée ;'; |
} else if(!is_numeric($this->parametres['image'])) { |
$erreurs[] = ' - l\'identifiant d\'image doit être un entier ;'; |
} |
if (!isset($this->parametres['mot_cle'])) { |
$erreurs[] = ' - impossible d\'ajouter un mot clé sans le mot clé ;'; |
} |
if (!isset($this->parametres['auteur.id'])) { |
$erreurs[] = ' - impossible d\'ajouter un mot clé sans auteur associé ;'; |
} |
if (!empty($erreurs)) { |
$e = 'Erreur de configuration :'; |
$e = implode("\n", $erreurs); |
echo var_dump($e); |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
} |
/*------------------------------------------------------------------------------- |
INSERTION DES MOTS CLES |
--------------------------------------------------------------------------------*/ |
/** |
* Insère un mot clé dans la table |
* @param $mot_cle array la liste des paramètres |
* */ |
private function insererMotCle($mot_cle) { |
$mot_cle_normalise = $this->normaliserMotCle($mot_cle['mot_cle']); |
$requete = 'INSERT INTO del_image_tag '. |
'(ce_image, ce_utilisateur, tag, tag_normalise, date) '. |
'VALUES ('.$this->bdd->proteger($mot_cle['image']).','. |
$this->bdd->proteger($mot_cle['auteur.id']).', '. |
$this->bdd->proteger($mot_cle['mot_cle']).', '. |
$this->bdd->proteger($mot_cle_normalise).', '. |
'NOW() '. |
')'; |
$retour = $this->bdd->requeter($requete); |
if ($retour == null) { |
$e = 'Erreur inopinée lors de l\insertion'; |
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR); |
} |
$retour = $this->bdd->recupererIdDernierAjout(); |
return $retour; |
} |
private function normaliserMotCle($mot_cle) { |
return mb_strtolower($this->supprimerAccents($mot_cle)); |
} |
//TODO: déplacer les fonctions ci dessus et dessous dans une classe |
// utilitaire |
private function supprimerAccents($str, $charset='utf-8') |
{ |
$str = htmlentities($str, ENT_NOQUOTES, $charset); |
$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str); |
$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // pour les ligatures e.g. 'œ' |
$str = preg_replace('#&[^;]+;#', '', $str); // supprime les autres caractères |
return $str; |
} |
} |
?> |
/trunk/services/modules/0.1/MotsCles.php |
---|
New file |
0,0 → 1,193 |
<?php |
/** |
* Description : |
* Classe principale de chargement des services d'eFlore. |
* |
* Encodage en entrée : utf8 |
* Encodage en sortie : utf8 |
* @package del |
* @author Aurélien 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> |
* @version 0.1 |
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org) |
*/ |
class MotsCles extends RestService { |
/* |
* url possibles : |
* http://localhost/del/services/0.1/motscles/#id => les mots clés associés à une image donnée |
* */ |
private $parametres = array(); |
private $ressources = array(); |
private $methode = null; |
private $projetNom = array(); |
private $serviceNom = array(); |
private $cheminCourant = null; |
private $conteneur; |
/** Indique si oui (true) ou non (false), on veut utiliser les paramètres bruts. */ |
protected $utilisationParametresBruts = true; |
public function __construct() { |
$this->cheminCourant = dirname(__FILE__).DS; |
} |
public function consulter($ressources, $parametres) { |
$this->methode = 'consulter'; |
$resultat = ''; |
$reponseHttp = new ReponseHttp(); |
try { |
$this->initialiserRessourcesEtParametres($ressources, $parametres); |
$this->conteneur = new Conteneur($this->parametres); |
$resultat = $this->traiterRessources(); |
$reponseHttp->setResultatService($resultat); |
} catch (Exception $e) { |
$reponseHttp->ajouterErreur($e); |
} |
$reponseHttp->emettreLesEntetes(); |
$corps = $reponseHttp->getCorps(); |
return $corps; |
} |
public function ajouter($ressources, $parametres) { |
$this->methode = 'ajouter'; |
$resultat = ''; |
$reponseHttp = new ReponseHttp(); |
try { |
$this->initialiserRessourcesEtParametres($ressources, $parametres); |
$this->conteneur = new Conteneur($this->parametres); |
$resultat = $this->traiterRessources(); |
$reponseHttp->setResultatService($resultat); |
} catch (Exception $e) { |
$reponseHttp->ajouterErreur($e); |
} |
$corps = $reponseHttp->getCorps(); |
return $corps; |
} |
public function modifier($ressources, $requeteDonnees) { |
} |
private function initialiserRessourcesEtParametres($ressources, $parametres) { |
$this->ressources = $ressources; |
$this->parametres = $parametres; |
} |
private function traiterRessources() { |
$retour = ''; |
$this->initialiserProjet(); |
$retour = $this->initialiserService(); |
return $retour; |
} |
/*------------------------------------------------------------------------------------------------------------------ |
CONFIGURATION DU PROJET |
------------------------------------------------------------------------------------------------------------------*/ |
private function initialiserProjet() { |
$this->chargerNomDuProjet(); |
$this->chargerConfigProjet(); |
} |
private function chargerNomDuProjet() { |
$this->projetNom = 'motscles'; |
} |
private function chargerConfigProjet() { |
$projet = $this->projetNom; |
$chemin = Config::get('chemin_configurations')."config_$projet.ini"; |
Config::charger($chemin); |
} |
/*------------------------------------------------------------------------------------------------------------------ |
CONFIGURATION DU SERVICE |
------------------------------------------------------------------------------------------------------------------*/ |
private function chargerNomService() { |
// si la méthode est POST, on ajouter un commentaire |
if ($this->methode == 'ajouter') { |
$this->serviceNom = 'ajouter-mot-cle'; |
} else if ($this->methode == 'supprimer') { |
$this->serviceNom = 'supprimer-mot-cle'; |
} |
else { |
//S'il n'y a pas de ressources => tous les commentaires |
if (!isset($this->ressources) || empty($this->ressources)) { |
$this->serviceNom = 'liste-mots-cles'; |
} else { |
if (!is_numeric($this->ressources[0])) { |
$message = "La première ressource doit être un identifiant"; |
$code = RestServeur::HTTP_CODE_ERREUR; |
throw new Exception($message, $code); |
} else { |
$this->serviceNom = 'consulter-mots-cles'; |
} |
} |
} |
} |
private function editerMessageErreurRessource() { |
$message = "Le service demandé '".$this->projetNom.'/'.implode('/', $this->ressources). |
"' n'est pas disponible pour le projet ".$this->projetNom." !\n". |
"Les services disponibles sont : images, images/#id/votes, images/#id/vote/#id_vote"; |
$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE; |
throw new Exception($message, $code); |
} |
private function etreRessourceIdentifiant($num) { |
$presenceId = false; |
if (is_numeric($this->ressources[$num])) { |
$presenceId = true; |
} else { |
$message = "Le service demandé '$service' nécessite d'avoir un identifiant d'image valide"; |
$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE; |
throw new Exception($message, $code); |
} |
return $presenceId; |
} |
private function initialiserService() { |
$this->chargerNomService(); |
$classe = $this->obtenirNomClasseService($this->serviceNom); |
$chemins = array(); |
$chemins[] = $this->cheminCourant.$this->projetNom.DS.$classe.'.php'; |
$chemins[] = $this->cheminCourant.'commun'.DS.$classe.'.php'; |
$retour = ''; |
$service = null; |
foreach ($chemins as $chemin) { |
if (file_exists($chemin)) { |
$this->conteneur->chargerConfiguration('config_'.$this->projetNom.'.ini'); |
require_once $chemin; |
$service = new $classe($this->conteneur); |
if ($this->methode == 'consulter') { |
$retour = $service->consulter($this->ressources, $this->parametres); |
} elseif ($this->methode == 'ajouter') { |
$retour = $service->ajouter($this->ressources, $this->parametres); |
} elseif ($this->methode == 'modifier') { |
$retour = $service->modifier($this->ressources, $this->parametres); |
} |
} |
} |
if (is_null($service)) { |
$message = "Le service demandé '{$this->serviceNom}' n'existe pas dans le projet {$this->projetNom} !"; |
$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE; |
throw new Exception($message, $code); |
} |
return $retour; |
} |
private function obtenirNomClasseService($mot) { |
$classeNom = str_replace(' ', '', ucwords(strtolower(str_replace('-', ' ', $mot)))); |
return $classeNom; |
} |
} |
?> |
/trunk/services/configurations/config_mapping_mots_cles.ini |
---|
New file |
0,0 → 1,7 |
; +------------------------------------------------------------------------------------------------------+ |
[mapping_mots_cles] |
id_tag = "id_mot_cle" |
ce_image = "image" |
ce_utilisateur = "auteur.id" |
date = "date" |
tag = "mot_cle" |
/trunk/services/configurations/config_mots_cles.ini |
---|
New file |
0,0 → 1,17 |
; Encodage : UTF-8 |
; Nom du projet |
nom_projet = "del" |
masques_possibles = "image,auteur.id" |
[motscles] |
; URL de base des services de ce projet |
url_service="{ref:url_base}del/services/0.1/motscles" |
; +------------------------------------------------------------------------------------------------------+ |
; Config spécifique au projet |
[mapping_masque] |
image = "ce_image" |
auteur.id = "ce_utilisateur" |