Subversion Repositories eFlore/Projets.eflore-projets

Compare Revisions

Ignore whitespace Rev 855 → Rev 856

/trunk/services/modules/0.1/coste/Textes.php
1,497 → 1,397
<?php
/*
* @copyright 2013 Tela Botanica (accueil@tela-botanica.org)
* @author Raphaël Droz <raphael@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>
*
* pattern: /service:eflore:0.1/coste/textes/bdtfx.nn:182
* params: txt.format=(htm|txt) , retour.champs=(titre,texte,...) , retour.format=(min|max), ...
*
* Ce webservice est censé pouvoir:
* 1) retourner des informations (choisies) à propos d'un taxon donné (à partir de son numéro nomenclatural
* 2) retourner des informations (choisies) à propos de taxons recherchés (à partir de divers critères)
*
* TODO: masque.titre => masque.tag
*
*/
 
/**
* Description :
* Classe Textes.php est une classe qui contient les méthodes permettant la consultation des textes (clé de détermination
* ou description). Les identifiants des textes correspondent au tag de type CleCoste1937TXXPXXNomSci pour le projet
* coste.
* Encodage en entrée : utf8
* Encodage en sortie : utf8
* @package framework-v3
* @author Jennifer Dhé <jennifer.dhe@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 1.0
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
*/
/*restore_error_handler();
error_reporting(E_ALL);*/
class Textes {
// paramètres autorisés
static $allow_params = array(
'txt.format', 'retour.format', 'retour.champs',
'recherche',
'masque.ns', 'masque.txt', 'masque.page', 'masque.tome', 'masque.famille',
'masque.titre', // masque sur titre de la page wiki correspondante (page "clef" OR page "description")
'navigation.depart', 'navigation.limite');
// et valeurs par défaut
static $default_params = array('txt.format' => 'txt', 'retour.format' => 'max', 'recherche' => 'stricte',
'retour.champs' => 'titre,texte,determination,tag',
'navigation.depart' => 0, 'navigation.limite' => 50);
 
// les champs de base de coste_v2_00
// mysql -N tb_eflore<<<"SHOW FIELDS FROM coste_v2_00"|egrep -v 'page_'|awk '{print $1}'|xargs -i -n1 printf "'%s' => 'c.%s',\n" {} {}
static $allow_champs = array(
'num_nom' => 'c.num_nom',
'num_nom_retenu' => 'c.num_nom_retenu',
'num_tax_sup' => 'c.num_tax_sup',
'rang' => 'c.rang',
'nom_sci' => 'c.nom_sci',
'nom_supra_generique' => 'c.nom_supra_generique',
'genre' => 'c.genre',
'epithete_infra_generique' => 'c.epithete_infra_generique',
'epithete_sp' => 'c.epithete_sp',
'type_epithete' => 'c.type_epithete',
'epithete_infra_sp' => 'c.epithete_infra_sp',
'cultivar_groupe' => 'c.cultivar_groupe',
'cultivar' => 'c.cultivar',
'nom_commercial' => 'c.nom_commercial',
'auteur' => 'c.auteur',
'annee' => 'c.annee',
'biblio_origine' => 'c.biblio_origine',
'notes' => 'c.notes',
'nom_addendum' => 'c.nom_addendum',
'nom_francais' => 'c.nom_francais',
'nom_coste' => 'c.nom_coste',
'auteur_coste' => 'c.auteur_coste',
'biblio_coste' => 'c.biblio_coste',
'num_nom_coste' => 'c.num_nom_coste',
'num_nom_retenu_coste' => 'c.num_nom_retenu_coste',
'num_tax_sup_coste' => 'c.num_tax_sup_coste',
'synonymie_coste' => 'c.synonymie_coste',
'tome' => 'c.tome',
'page' => 'c.page',
'nbre_taxons' => 'c.nbre_taxons',
'flore_bdtfx_nn' => 'c.flore_bdtfx_nn',
'flore_bdtfx_nt' => 'c.flore_bdtfx_nt',
'image' => 'c.image',
'image_auteur' => 'c.image_auteur',
'nom_sci_html' => 'c.nom_sci_html',
 
class Textes extends Commun {
protected $limite_requete = array('depart' => 0, 'limite' => 100);
protected $requete_champ = ' t1.resource AS tag, t1.value AS num_nom, t2.value AS titre, p.body AS texte';
protected $requete_condition = null;
protected $requete_group_by = ' ORDER BY CAST( t1.value AS DECIMAL )';
protected $table_retour;
protected $retour_format = 'max';
protected $format_reponse = 'textes';
protected $table_param = array();
protected $total_resultat;
protected $table_ressources = array();
protected $html = 'txt';
protected $recherche = 'stricte';
protected $service = 'textes';
protected $masque = null;
protected $config;
public function __construct($config) {
$this->config = is_null($config) ? Config::get('Textes') : $config;
}
public function consulter($ressources, $parametres) {
$resultat_formate = '';
$this->table = array(Config::get("bdd_triples")." t1", Config::get("bdd_triples")." t2", Config::get("bdd_pages")." p");
$this->traiterParametres($parametres);
$this->traiterRessources($ressources);
if ($this->corps_http == '' && $this->entete_http == '') {
$requete = $this->assemblerLaRequete();
$resultat = $this->getBdd()->recupererTous($requete);
$this->testerResultat($resultat, $resultat_formate, $requete);
// handly duplicate (redirigé vers nom_sci ou nom_sci_html selon que txt.format vaut "txt" ou "htm"
'titre' => 'c.nom_sci',
 
// champs spécifiques (et étrangères)
'texte' => 'dsc.body',
'determination' => 'cle.body',
'tag' => 'dsc.tag',
'famille' => 'b.famille', // cf sqlAddJoins()
'*' => 'XXX' // spécial
);
 
// les champs suivants disparaissent de la liste utilisée pour former la requête SQL
static $special_champs = array('nom_sci_html', 'nom_sci', '*');
// le pattern utilisé pour la recherche dite "floue"
static $soundex_scheme = '(%1$s LIKE %2$s OR SOUNDEX(%1$s) = SOUNDEX(%2$s) OR SOUNDEX(REVERSE(%1$s)) = SOUNDEX(REVERSE(%2$s)))';
 
// contrainte du point d'entrée d'API webservice Tela lors d'un GET
public function consulter($ressources, $parametres, $db = NULL) {
if(!$db) {
// http_response_code(500);
throw new Exception('no DB', 500);
}
return $this->formerReponseHTTP($resultat_formate);
}
public function formerReponseHTTP($resultat_formate, $mime = 'application/json', $encodage= 'utf-8') {
// Si aucune erreur n'a été établie (donc un tableau de résultat a bien ete renvoyé...)
if ($this->corps_http == '' && $this->entete_http == '') {
$this->entete_http = RestServeur::HTTP_CODE_OK;
$this->corps_http = $resultat_formate;
 
// parser la requête et filtrer les paramètres valides
// en cas d'accès HTTP
if(array_key_exists('QUERY_STRING', $_SERVER)) {
self::requestParse($uri, $params);
}
if ($this->entete_http != RestServeur::HTTP_CODE_OK) {
$mime = 'text/html';
// en cas d'accès phpunit
else {
$uri = $ressources;
}
// Gestion du type de contenu
if (!is_null($mime) && !is_null($encodage)) {
header("Content-Type: $mime; charset=$encodage");
} else if (!is_null($mime) && is_null($encodage)) {
header("Content-Type: $mime");
 
if(is_null($parametres)) $parametres = Array();
$params = self::requestFilterParams($parametres);
 
// renvoie du plain/text d'aide (cf fin de programme)
if(count($uri) == 1 && $uri[0] == 'aide') return self::aide();
$id = 0;
// getNN renvoie le num_nom passé comme segment d'URI
// ou bien l'extrait du pattern bdtfx.nn:#id
if(count($uri) == 1) $id = self::getNN($uri[0]);
 
 
// en cas d'échec (id invalide), bail-out
// note: NULL is ok, mais FALSE est le retour de getNN()
if($id === FALSE || count($uri) > 1) {
// http_response_code(500);
throw new Exception('not supported', 500);
}
// Envoie de l'entête
RestServeur::envoyerEnteteStatutHttp($this->entete_http);
// Envoie du corps
return $this->corps_http;
}
public function testerResultat($resultat, &$resultat_formate, $requete) {
if ($resultat == '') { //cas ou coste/services/ ou la requete comporte des erreurs
$e = 'La requête SQL formée comporte une erreur!';
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,$e);
Debug::printr($requete);
} elseif ($resultat) {
$resultat_formate = $this->retournerResultatFormate($resultat);
} else {
if ($this->format_reponse == 'textes/relations') {
$resultat_formate = 'null';
} else {
$m = 'Données introuvables dans la base';
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,$m);
Debug::printr($requete);
}
 
// XXX: temporaires, pour chopper $db dans l'instance
// (non disponibles dans nos helpers statics)
$GLOBALS[__FILE__] = $db;
$req = self::getCosteInfo($params, $id);
unset($GLOBALS[__FILE__]);
$res = $db->recupererTous($req);
$err = mysql_error();
if(!$res && $err) {
// http_response_code(400);
// if(defined('DEBUG') && DEBUG) header("X-Debug: $req");
throw new Exception('not found', 400);
}
}
//---------------------------------TRAITER RESSOURCES-----------------------------------------------------------------
public function traiterRessources(&$ressources) {
if (isset($ressources) && !empty($ressources)) {
$this->table = Config::get('bdd_triples');
$this->table_ressources = $ressources;
if ($ressources[0] == 'relations') {
$this->traiterRelationsProjet($ressources);
$this->format_reponse .= '/relations';
} elseif (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
$this->traiterRessourceId($this->table_ressources[0]);
if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
$this->format_reponse .= '/champ';
}
} else {
$e = "Erreur dans votre requête. <br/> Les ressources disponibles sont :
<li> /textes/#id (id correspondant au tag de la page </li>
<li> /textes/#id/#champ+#champ </li>
<li> /textes/relations/bdtfx/#id (id correspondant au num_nom du projet bdtfx </li>";
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
}
} else {
$this->traiterRessourcesListe();
 
// rapide formatage des résultats:
$matches = 0;
 
if($res) {
// nombre de matches (sans LIMIT) utilisé pour l'en-tête
$matches = $db->recuperer('SELECT FOUND_ROWS() AS total');
$matches = intval($matches['total']);
}
$this->requete_condition[] = "p.latest = 'Y'";
 
// reformate les résultats pour les indexer par num_nom
$res2 = array();
foreach($res as $v) {
$res2[$v['num_nom']] = $v;
}
 
// l'appelant s'occupera du json_encode()
// même si ça démange d'exit'er ici
header("Content-Type: application/json; charset=utf-8");
return array('entete' => array('depart' => $params['navigation.depart'],
'limite' => $params['navigation.limite'],
'total' => count($res2),
'match' => $matches),
'resultats' => $res2);
 
}
public function traiterRessourceId($id) {
$this->format_reponse .= '/id';
if ($this->recherche == 'etendue') {
$id = '%'.str_replace(' ','%', $id).'%';
}
if (is_numeric($id)) {
$this->requete_condition[] = 'c.id ='.$this->getBdd()->proteger($id);
} else {
$id = explode('bdtfx.nn:', $id);
if (isset($id[1]) && is_numeric($id[1])) {
$this->requete_condition[] = 'c.num_nom ='.$this->getBdd()->proteger($id[1]);
} else {
$e = "Erreur dans votre requête. <br/> Dans le cas d'une ressource bdtfx.nn: le num nom est obligatoire !";
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
}
}
 
 
// la fonction central: récupère les infos à partir de paramètres
// et une optionnel contrainte de num_nom
static function getCosteInfo(array $params, $id = NULL) {
assert('is_int($id)');
 
// contraintes (WHERE):
$constraints = self::sqlAddConstraint($params);
// ajout de la contrainte sur num_nom si un composant d'URL supplémentaire
// comportant un #id existe
if($id) array_unshift($constraints, "c.num_nom = $id");
 
 
// champs:
$champs_valides_non_formattes = NULL;
$champs_valides = self::sqlSelectFields($params, $champs_valides_non_formattes);
 
// joins:
$other_join = self::sqlAddJoins($params, $champs_valides_non_formattes);
 
$req = sprintf(<<<EOF
SELECT SQL_CALC_FOUND_ROWS c.num_nom, %s
FROM tb_eflore.coste_v2_00 c
LEFT JOIN tela_prod_wikini.florecoste_pages dsc ON c.page_wiki_dsc = dsc.tag AND dsc.latest = 'Y'
LEFT JOIN tela_prod_wikini.florecoste_pages cle ON c.page_wiki_cle = cle.tag AND cle.latest = 'Y'
%s
WHERE %s ORDER BY c.num_nom LIMIT %u, %u -- %s
EOF
,
$champs_valides, // dans le SELECT (parmi champs coste_v2_00)
// autre join, si nécessaire
$other_join ? $other_join : '',
// where
$constraints ? implode(' AND ', $constraints) : '1',
 
// limit
$params['navigation.depart'],
$params['navigation.limite'],
__FILE__ . ':' . __LINE__);
$this->requete_champ = 'c.id AS num_nom, i.nom_sci AS titre, t1.resource AS tag, p.body AS texte';
$this->table = array(Config::get("bdd_correspondance_bdnff").' c',
Config::get("bdd_triples").' t1',
Config::get("bdd_index").' i',
Config::get("bdd_pages").' p');
$this->requete_condition[] = 'c.id = i.num_nom';
$this->requete_condition[] = 'i.nom_sci = t1.value';
$this->requete_condition[] = 't1.resource = p.tag';
/*$this->requete_champ = ' t1.resource AS tag, t1.value AS num_nom, t2.value AS titre, p.body AS texte';
$this->requete_condition[] = 't1.resource LIKE '.$this->getBdd()->proteger($id);
$this->requete_condition[] = 't1.property = "num_nom"';
$this->requete_condition[] = '(t1.resource = t2.resource AND t2.property = "titre")';
$this->requete_condition[] = 't1.resource = p.tag';
$this->table = array(Config::get("bdd_triples").' t1',
Config::get("bdd_triples").' t2',
Config::get("bdd_pages").' p');
$this->ajouterRechercheFloue('t1.resource', $id);*/
return $req;
}
public function traiterRessourcesListe() {
$this->requete_condition[] = "t1.property = 'num_nom'";
$this->requete_condition[] = "(t1.resource = t2.resource AND t2.property = 'titre')";
$this->requete_condition[] = "t1.resource = p.tag";
}
public function traiterRelationsProjet($tab_ress) {
$this->table = array(Config::get("bdd_triples")." t1", Config::get("bdd_pages")." p", Config::get("bdd_table").'_v0_1 c');
$projet = $tab_ress[1];
$num_nom = $tab_ress[2];
$nom_champ_projet = "flore_$projet"."_num";
if (isset($tab_ress[3])) {
$type = $tab_ress[3];
if (!in_array($type, array('cle', 'dsc'))) {
$e = "Le type de texte ne peut etre que clé ou description";
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
 
 
 
 
// SQL helpers
// le préfix de coste_v2_00 est "c"
// le préfix de florecoste_pages sur la description est est "dsc"
// le préfix de florecoste_pages sur la clef de détermination est est "cle"
static function sqlAddConstraint($params) {
$q = $GLOBALS[__FILE__];
 
$stack = array();
if(!empty($params['masque.ns'])) {
if($params['recherche'] == 'etendue')
$stack[] = 'c.nom_sci LIKE ' . $q->proteger('%' . trim($params['masque.ns']) . '%');
elseif($params['recherche'] == 'floue')
$stack[] = sprintf(self::$soundex_scheme,
'c.nom_sci',
$q->proteger('%' . trim($params['masque.ns']) . '%'));
else
$stack[] = 'c.nom_sci = ' . $q->proteger(trim($params['masque.ns']));
}
 
// le masque sur texte est toujours un LIKE() "étendue", sauf si "floue" spécifié
if(!empty($params['masque.txt'])) {
if($params['recherche'] == 'floue') {
$stack[] = sprintf(self::$soundex_scheme,
'dsc.body',
$q->proteger('%' . trim($params['masque.txt']) . '%'));
}
else {
$stack[] = 'dsc.body LIKE ' . $q->proteger('%' . trim($params['masque.txt']) . '%');
}
}
$this->requete_condition[] = "c.flore_bdnff_num = ".$this->getBdd()->proteger($num_nom);
$this->requete_condition[] = "t1.value = c.num_nom";
$this->requete_condition[] = "t1.property = 'num_nom'";
$this->requete_condition[] = "t1.resource = p.tag";
$this->requete_champ = 't1.resource AS tag, t1.value AS num_nom, p.body AS texte';
if (isset($type)) $this->requete_condition[] = "t1.resource LIKE ".$this->getBdd()->proteger(ucfirst($type.'%'));
}
public function ajouterRechercheFloue($nom_champ, $id) {
if ($this->recherche == 'floue') {
$id = $this->getBdd()->proteger($id);
$this->requete_condition[array_search("$nom_champ LIKE $id",
$this->requete_condition)] =
"($nom_champ LIKE $id)".
" OR ( SOUNDEX($nom_champ) = SOUNDEX($id))".
" OR SOUNDEX(REVERSE($nom_champ)) = SOUNDEX(REVERSE($id))))";
}
}
//---------------------------------------TRAITER PARAMETRES-------------------------------------------------------------
public function traiterParametres($parametres) {
if (isset($parametres) && !empty($parametres)) {
$this->table_param = $parametres;
if (isset($parametres['recherche']) && $parametres['recherche'] != '') {
$this->recherche = $parametres['recherche'];
 
if(!empty($params['masque.titre'])) {
if($params['recherche'] == 'stricte') {
$stack[] = sprintf('(dsc.tag = %1$s OR cle.tag = %1$s)',
$q->proteger(trim($params['masque.titre'])));
}
foreach ($parametres as $param => $val) {
switch ($param) {
case 'retour.format' : $this->retour_format = $val; break;
case 'masque.titre' : $this->ajouterLeFiltreMasque('titre', $val); break;
case 'masque.famille' : $this->ajouterLeFiltreMasque('famille', $val); break;
case 'masque.ns' : $this->ajouterLeFiltreMasque('nom_sci', $val); break;
case 'masque.type' : $this->ajouterLeFiltreMasque('type', $val); break;
case 'masque.txt' : $this->ajouterLeFiltreMasque('texte', $val); break;
case 'masque.page' : $this->ajouterLeFiltreMasque('page',$val); break;
case 'masque.tome' : $this->ajouterLeFiltreMasque('tome',$val); break;
case 'navigation.depart': $this->limite_requete['depart'] = $val; break;
case 'navigation.limite': $this->limite_requete['limite'] = $val; break;
case 'recherche' : break;
case 'txt.format' : break;
default :
$e = "Erreur dans les paramètres de recherche de votre requête : </br> Le parametre $param n\'existe pas.";
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,$e);
break;
}
else {
$stack[] = sprintf('(dsc.tag LIKE %1$s OR cle.tag LIKE %1$s)',
$q->proteger('%' . trim($params['masque.titre']) . '%'));
}
}
}
public function ajouterLeFiltreMasque($masque, $valeur) {
if ($this->recherche == 'etendue') {
$valeur = '%'.str_replace(' ','%', $valeur).'%';
 
if(array_key_exists('masque.famille', $params)) {
$stack[] = 'b.famille LIKE ' . $q->proteger(trim($params['masque.famille']));
}
$valeur = $this->getBdd()->proteger($valeur);
$this->masque[] = "$masque=$valeur";
switch ($masque) {
case 'famille' :
break;
case 'nom_sci' :
$this->requete_condition[] = "t1.value = c.num_nom AND nom_sci LIKE $valeur)";
$this->ajouterRechercheFloue('nom_sci', $valeur);
$this->table[] = Config::get("bdd_table").'_v0_1 c';
break;
case 'type' :
$type = ($this->getBdd()->proteger($valeur) == '"cle"') ? 'Cle%' : 'Dsc%';
$this->requete_condition[] = 't1.resource LIKE '.$this->getBdd()->proteger($type);
break;
case 'texte' :
$this->requete_condition[] = "p.body LIKE $valeur";
$this->ajouterRechercheFloue('p.body', $valeur);
break;
case 'titre' :
$this->requete_condition[] = "t2.value LIKE $valeur";
$this->ajouterRechercheFloue('t2.value', $valeur);
break;
case 'page' :
$this->requete_condition[] = "t1.value = c.num_nom AND c.page = $valeur";
$this->table[] = Config::get("bdd_table").'_v0_1 c';
break;
case 'tome' :
$this->requete_condition[] = "t1.value = c.num_nom AND c.tome = $valeur";
$this->table[] = Config::get("bdd_table").'_v0_1 c';
break;
default :
break;
 
if(array_key_exists('masque.page', $params)) {
$stack[] = 'c.page = ' . intval($params['masque.page']);
}
}
//-----------------------------FONCTIONS DASSEMBLAGE DE LA REQUETE-----------------------------------------------------
public function assemblerLaRequete() {
$requete = ' SELECT '.$this->requete_champ.
' FROM '.implode(', ', $this->table)
.$this->retourneRequeteCondition()
.$this->requete_group_by
.$this->formerRequeteLimite();
return $requete;
}
 
public function retourneRequeteCondition() {
$condition = '';
if ($this->requete_condition !== null) {
$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
}
return $condition;
}
public function formerRequeteLimite() {
if (in_array($this->format_reponse , array('textes/id', 'textes/id/relations'))) {
$this->requete_limite = '';
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
$this->limite_requete['depart'] =
(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
} else {
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
if(array_key_exists('masque.tome', $params)) {
$stack[] = 'c.tome = ' . intval($params['masque.tome']);
}
return $this->requete_limite;
 
return $stack;
}
/**
* Recupere le nombre total de résultat d'une requete lancée.
* Est utilisée lors de l'affichage du total dans le résultat retourné et pr déterminer les limites et départ
* @return nombre total de résultat
*/
public function recupererTotalResultat() {
$total = null;
$requete = 'SELECT count(*) as nombre FROM '
.implode(', ', $this->table).$this->retourneRequeteCondition()
.$this->requete_group_by;
$res = $this->getBdd()->recuperer($requete);
if ($res) {
$total = $res['nombre'];
} else {
$e = 'Données introuvables dans la base ou erreur dans la requête SQL';
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
}
return $total;
}
 
//-------------------FONCTIONS POUR LE FORMATAGE EN JSON----------------------------------------------------------------
public function retournerResultatFormate($resultat) {
$reponse = '';
switch ($this->format_reponse) {
case 'textes' : $reponse = $this->formaterTextes($resultat); break;
case 'textes/relations' : $reponse = $this->formaterTextesRelations($resultat); break;
case 'textes/id' : $reponse = $this->formaterTextesId($resultat[0]); break;
case 'textes/id/champ' : $reponse = $this->formaterTextesIdChamp($resultat[0]); break;
default : break;
 
// $unmerged contient la même liste de champs que celle renvoyée
// à la différence que celle-ci n'est pas reformatée et s'avère donc
// utilisable plus aisément dans sqlAddJoins() qui peut en avoir besoin
static function sqlSelectFields($params, &$unmerged) {
$champs = $params['retour.champs'];
// champs coste_v2_00
$c = array_intersect_key(self::$allow_champs, array_flip(explode(',', $champs)));
if(isset($c['*'])) {
$t = array_diff_key(self::$allow_champs, array_flip(self::$special_champs));
}
return $reponse;
}
public function formaterTextes($resultat) {
$this->ajouterEnteteResultat($resultat);
$reponse['entete'] = $this->table_retour;
$this->table_retour = array();
foreach ($resultat as $description) {
$tag = $description['tag'];
$this->afficherDonnees('titre', $description['titre']);
$type = (preg_match('/^Cle.*$/', $tag)) ? '1' : '2' ;
$this->afficherDonnees('type', $type);
$this->table_retour['texte'] = $description['texte'];
$reponse['resultat'][$tag] = $this->table_retour;
$this->table_retour = array();
$reponse['resultat'][$tag]['href'] = $this->ajouterHref('textes', $tag);
else {
// just loop below
$t = $c;
}
return $reponse;
}
public function formaterTextesRelations($resultat) {
foreach ($resultat as $description) {
$tag = $description['tag'];
$type = (preg_match('/^Cle.*$/', $tag)) ? '1' : '2' ;
$this->afficherDonnees('type', $type);
$this->table_retour['texte'] = $description['texte'];
$reponse[$tag] = $this->table_retour;
$this->table_retour = array();
$reponse[$tag]['href'] = $this->ajouterHref('textes', $tag);
 
// si aucun des champs fournis n'est valide
// on se rappelle nous-même après avoir réinitialisé retour.champs
// avec les champs par défaut
if(!$t) {
$params['retour.champs'] = self::$default_params['retour.champs'];
return self::sqlSelectFields($params);
}
return $reponse;
}
public function ajouterEnteteResultat($resultat) {
if ($this->masque) {
$this->table_retour['masque'] = implode('&', $this->masque);
 
if(array_key_exists('titre', $t))
$t['titre'] = $params['txt.format'] == 'txt' ? 'c.nom_sci' : 'c.nom_sci_html';
 
$unmerged = $t;
 
// XXX: PHP-5.3
$ret = array();
foreach($t as $k => $v) {
$ret[] = "$v AS $k";
}
$this->table_retour['depart'] = $this->limite_requete['depart'];
$this->table_retour['limite'] = $this->limite_requete['limite'];
$this->table_retour['total'] = $this->total_resultat;
//formuler les urls
$url = $this->formulerUrl($this->total_resultat, '/'.$this->service);
if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
if ($url['suivant'] != '') { $this->table_retour['href.suivant'] = $url['suivant']; }
return implode(',',$ret);
}
public function formaterTextesId($reponse) {
$this->afficherDonnees('titre', $reponse['titre']);
$type = (preg_match('/^Cle.*$/', $reponse['tag'])) ? '2' : '1' ;
$this->afficherDonnees('type', $type);
$this->table_retour['texte'] = $reponse['texte'];
//$this->afficherDonnees('id', $reponse['num_nom']);
return $this->table_retour;
}
public function formaterTextesIdChamp($resultat) {
//on recupère tous les resultats possibles
$reponse_id = $this->formaterTextesId($resultat);
$this->table_retour = array();
//on recupère les résultats demandés à partir du tableau de résultat complet
$this->table_retour['id'] = $resultat['tag'];
$champs = explode(' ', $this->table_ressources[1]);
foreach ($champs as $champ) {
if ($this->verifierValiditeChamp($champ, $reponse_id)) {
if (preg_match('/^[^.]+\.\*$/', $champ)) {
$this->afficherPointEtoile($champ, $reponse_id);
} else {
$this->table_retour[$champ] = $reponse_id[$champ];
}
}
 
static function sqlAddJoins($params, $champs) {
$j = '';
// ces tests doivent correspondre aux champs générés par sqlSelectFields()
// ou contraintes générées par sqlAddConstraint()
if(array_key_exists('masque.famille', $params) ||
array_key_exists('famille', $champs)) {
$j .= 'LEFT JOIN tb_eflore.bdtfx_v1_02 b ON c.num_nom = b.num_nom';
}
return $this->table_retour;
 
return $j;
}
public function afficherPointEtoile($champ, $reponse_id) {
preg_match('/^([^.]+\.)\*$/', $champ, $match);
foreach ($reponse_id as $chp => $valeur) {
if (strrpos($chp, $match[1]) !== false) {
$this->table_retour[$chp] = $valeur;
}
}
 
// request handler
static function requestParse(&$ressource, &$params) {
$uri = explode('/', $_SERVER['REDIRECT_URL']);
if(!empty($_SERVER['QUERY_STRING']))
parse_str($_SERVER['REDIRECT_QUERY_STRING'], $params);
$ressource = array_slice($uri, array_search('textes', $uri) + 1, 3);
}
public function verifierValiditeChamp($champ, $reponse_id) {
$validite = false;
preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
if (array_key_exists($match[1], $reponse_id)) {
$validite = true;
if (isset($match[2]) && !empty($match[2])) {
if ($match[1] == 'type') {
$suffixes = array('.code', '.href', '.*');
$validite = (in_array($match[2], $suffixes)) ? true : false;
} else {
$validite = false;
}
}
}
if (!$validite) {
$champs = implode('</li><li>', array_keys($reponse_id));
$e = 'Erreur dans votre requête : </br> Le champ "'.$champ.'" n\'existe pas. Les champs disponibles
sont : <li>'.$champs.'</li>';
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
}
return $validite;
 
// supprime l'index du tableau des paramètres si sa valeur ne correspond pas
// au spectre passé par $values.
static function unsetIfInvalid(&$var, $index, $values) {
if(array_key_exists($index, $var) && !in_array($var[$index], $values))
unset($var[$index]);
}
//------------------------------------------------Fonction d'affichage ------------------------------------------------
public function afficherDonnees($champ, $valeur) {
if ($this->retour_format == 'min') {
$champ = ($champ == 'type') ? $champ.'.code' : $champ;
$this->table_retour[$champ] = $valeur;
} else {
$this->afficherDonneesMax($champ, $valeur);
 
static function requestFilterParams(Array $params) {
$p = array_intersect_key($params, array_flip(self::$allow_params));
self::unsetIfInvalid($p, 'txt.format', array('txt', 'htm'));
self::unsetIfInvalid($p, 'retour.format', array('min','max'));
self::unsetIfInvalid($p, 'recherche', array('stricte','etendue','floue'));
 
if(isset($params['masque.ns'])) $p['masque.ns'] = trim($params['masque.ns']);
if(isset($params['masque.texte'])) $p['masque.texte'] = trim($params['masque.texte']);
 
if(isset($params['masque.famille'])) {
// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v1_02;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
$p['masque.famille'] = preg_replace('/[^a-zA-Z %_]/', '', iconv("UTF-8",
"ASCII//TRANSLIT",
$params['masque.famille']));
}
 
// TODO: use filter_input(INPUT_GET);
// renvoie FALSE ou NULL si absent ou invalide
$p['navigation.limite'] = filter_var(@$params['navigation.limite'],
FILTER_VALIDATE_INT,
array('options' => array('default' => NULL,
'min_range' => 1,
'max_range' => 500)));
$p['navigation.depart'] = filter_var(@$params['navigation.depart'],
FILTER_VALIDATE_INT,
array('options' => array('default' => NULL,
'min_range' => 0,
'max_range' => 10000))); // count(1) from coste_v2_00
 
// on filtre les NULL, FALSE et '', mais pas les 0, d'où le callback()
// TODO: PHP-5.3
$p = array_filter($p, create_function('$a','return !in_array($a, array("",false,null),true);'));
$p = array_merge(self::$default_params, $p);
 
return $p;
}
public function afficherDonneesMax($champ, $valeur) {
if ($champ == 'id') {
$this->table_retour[$champ] = "coste.".$valeur;
$this->table_retour['nom_sci'] = $this->recupererNomSci($valeur);
$this->table_retour['id.href'] = $this->ajouterHref('noms', $valeur);
} elseif (in_array($champ, array('type'))) {
$this->table_retour[$champ.'.code'] = $valeur;
$this->table_retour[$champ] = $this->recupererSignificationCode($valeur);
$this->table_retour[$champ.'.href'] = $this->ajouterHrefAutreProjet('ontologies', 'texteType:', $valeur, 'eflore');
} else {
$this->table_retour[$champ] = $valeur;
}
 
static function aide() {
header("Content-Type: text/plain; charset=utf-8");
return sprintf("
Service coste/textes:
Retourne des informations (choisies) à propos d'un taxon donné (à partir de son numéro nomenclatural
Retourne des informations (choisies) à propos de taxons recherchés (à partir de divers critères)
 
Usage:
coste/textes/bdtfx.nn:#id?<params>
coste/textes/#id?<params>
coste/textes?<params>
* #id étant un numéro nomenclatural d'un taxon bdtfx
* retour.champs une liste de champs séparés par des virgules parmi *,%s
* les paramètres acceptés sont les suivants: %s
* les champs retournés par défaut sont les suivants: %s
* le paramètre \"recherche\" affecte les masques \"ns\" et \"texte\"
* le paramètre \"famille\" est traité via LIKE et accepte les caractères '_' et '%'
* le paramètre \"retour.format\" est inutilisé pour l'instant",
implode(',', array_keys(self::$allow_champs)),
implode(',', self::$allow_params),
self::$default_params['retour.champs']
);
}
public function recupererSignificationCode($code) {
$url = $this->ajouterHrefAutreProjet('ontologies', 'texteType:', $code.'/nom', 'eflore');
$res = $this->consulterHref($url);
return $res->nom;
}
public function recupererNomSci($id) {
$req = 'SELECT nom_sci FROM coste_v0_1 WHERE num_nom = '.$id;
if ($this->html == 'htm') {
$req = str_replace('nom_sci', 'nom_sci_html as nom_sci', $req);
}
$res = $this->getBdd()->recuperer($req);
return $res['nom_sci'];
 
static function getNN($refnn) {
if(is_numeric($refnn) && intval($refnn) >= 1) return intval($refnn);
if(strpos($refnn, 'bdtfx.nn:') !== 0) return FALSE;
return intval(str_replace('bdtfx.nn:', '', $refnn));
}
 
}
 
?>