Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 862 | Rev 864 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 862 Rev 863
1
<?php
1
<?php
2
/*
2
/*
3
 * @copyright 2013 Tela Botanica (accueil@tela-botanica.org)
3
 * @copyright 2013 Tela Botanica (accueil@tela-botanica.org)
4
 * @author Raphaël Droz <raphael@tela-botanica.org>
4
 * @author Raphaël Droz <raphael@tela-botanica.org>
5
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
5
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
6
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
6
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
7
 *
7
 *
8
 * pattern: /service:eflore:0.1/coste/textes/bdtfx.nn:182,631
8
 * pattern: /service:eflore:0.1/coste/textes/bdtfx.nn:182,631
9
 * params: txt.format=(htm|txt) ,  retour.champs=(titre,texte,...) , retour.format=(min|max), ...
9
 * params: txt.format=(htm|txt) ,  retour.champs=(titre,texte,...) , retour.format=(min|max), ...
10
 *
10
 *
11
 * Ce webservice est censé pouvoir:
11
 * Ce webservice est censé pouvoir:
12
 * 1) retourner des informations (choisies) à propos d'un ou plusieurs taxon(s) donné(s)
12
 * 1) retourner des informations (choisies) à propos d'un ou plusieurs taxon(s) donné(s)
13
 *	  (à partir de son numéro nomenclatural
13
 *	  (à partir de son numéro nomenclatural
14
 * 2) retourner des informations (choisies) à propos de taxons recherchés
14
 * 2) retourner des informations (choisies) à propos de taxons recherchés
15
 *	  (à partir de divers critères)
15
 *	  (à partir de divers critères)
16
 *
16
 *
17
 * TODO: masque.titre => masque.tag
17
 * TODO: masque.titre => masque.tag
18
 * TODO: clarifier l'attribut "tag" retourné (tag de la description ou des clefs de détermination)
18
 * TODO: clarifier l'attribut "tag" retourné (tag de la description ou des clefs de détermination)
19
 *
19
 *
20
 */
20
 */
21
 
21
 
22
// affecte le nombre d'ids autorisés dans le dernier segment d'URL
22
// affecte le nombre d'ids autorisés dans le dernier segment d'URL
23
// *et* la valeur maximale autorisée pour navigation.limite.
23
// *et* la valeur maximale autorisée pour navigation.limite.
24
define('_COSTE_TEXTE_MAX_RESULT_LIMIT', 500);
24
define('_COSTE_TEXTE_MAX_RESULT_LIMIT', 500);
25
 
25
 
26
// simplifie et accélère la sanitization de l'input:
26
// simplifie et accélère la sanitization de l'input:
27
// SELECT MAX(num_nom) FROM coste_v2_00;
27
// SELECT MAX(num_nom) FROM coste_v2_00;
28
define('_COSTE_TEXTE_MAX_COSTE_NN', 7015 + 1000);
28
define('_COSTE_TEXTE_MAX_COSTE_NN', 7015 + 1000);
29
// SELECT MAX(page) FROM coste_v2_00;
29
// SELECT MAX(page) FROM coste_v2_00;
30
define('_COSTE_TEXTE_MAX_COSTE_PAGE', 4126);
30
define('_COSTE_TEXTE_MAX_COSTE_PAGE', 4126);
31
// SELECT MAX(tome) FROM coste_v2_00;
31
// SELECT MAX(tome) FROM coste_v2_00;
32
define('_COSTE_TEXTE_MAX_COSTE_TOME', 3);
32
define('_COSTE_TEXTE_MAX_COSTE_TOME', 3);
33
// SELECT MAX(num_taxonomique) FROM coste_v2_00;
33
// SELECT MAX(num_taxonomique) FROM coste_v2_00;
34
define('_COSTE_TEXTE_MAX_BDTFX_NT', 37809);
34
define('_COSTE_TEXTE_MAX_BDTFX_NT', 37809);
35
// SELECT MAX(num_nom) FROM bdtfx_v1_02;
35
// SELECT MAX(num_nom) FROM bdtfx_v1_02;
36
define('_COSTE_TEXTE_MAX_BDTFX_NN', 103386 + 10000);
36
define('_COSTE_TEXTE_MAX_BDTFX_NN', 103386 + 10000);
37
 
37
 
38
/*restore_error_handler();
38
/* restore_error_handler();
39
  error_reporting(E_ALL);*/
39
   error_reporting(E_ALL); */
40
class Textes {
40
class Textes {
41
	// paramètres autorisés
41
	// paramètres autorisés
42
	static $allow_params = array(
42
	static $allow_params = array(
43
		'txt.format', 'retour.format', 'retour.champs',
43
		'txt.format', 'retour.format', 'retour.champs', 'retour.indexBy',
44
		'recherche',
44
		'recherche',
45
		'masque.ns', 'masque.txt', 'masque.page', 'masque.tome', 'masque.famille', 'masque.nt',
45
		'masque.ns', 'masque.txt', 'masque.page', 'masque.tome', 'masque.famille', 'masque.nt',
46
		'masque.titre', // masque sur titre de la page wiki correspondante (page "clef" OR page "description")
46
		'masque.titre', // masque sur titre de la page wiki correspondante (page "clef" OR page "description")
47
		'navigation.depart', 'navigation.limite');
47
		'navigation.depart', 'navigation.limite');
48
	// et valeurs par défaut
48
	// et valeurs par défaut
49
	static $default_params = array('txt.format' => 'txt', 'retour.format' => 'max', 'recherche' => 'stricte',
49
	static $default_params = array('txt.format' => 'txt', 'retour.format' => 'max', 'retour.indexBy' => 'coste',
-
 
50
								   'recherche' => 'stricte',
50
								   'retour.champs' => 'titre,texte,determination,tag',
51
								   'retour.champs' => 'titre,texte,determination,tag',
51
								   'navigation.depart' => 0, 'navigation.limite' => 50);
52
								   'navigation.depart' => 0, 'navigation.limite' => 50);
52
 
53
 
53
	// les champs de base de coste_v2_00
54
	// les champs de base de coste_v2_00
54
	// mysql -N tb_eflore<<<"SHOW FIELDS FROM coste_v2_00"|egrep -v 'page_'|awk '{print $1}'|xargs -i -n1 printf "'%s' => 'c.%s',\n" {} {}
55
	// mysql -N tb_eflore<<<"SHOW FIELDS FROM coste_v2_00"|egrep -v 'page_'|awk '{print $1}'|xargs -i -n1 printf "'%s' => 'c.%s',\n" {} {}
55
	static $allow_champs = array(
56
	static $allow_champs = array(
56
		'coste:nn' => 'c.num_nom',
57
		'coste:nn' => 'c.num_nom',
57
		'bdtfx:nn' => 'IF(c.flore_bdtfx_nn = "",NULL,c.flore_bdtfx_nn)',
58
		'bdtfx:nn' => 'IF(c.flore_bdtfx_nn = "",NULL,c.flore_bdtfx_nn)',
58
		'bdtfx:nt' => 'c.flore_bdtfx_nt',
59
		'bdtfx:nt' => 'c.flore_bdtfx_nt',
59
		'num_nom' => 'c.num_nom',
60
		'num_nom' => 'c.num_nom',
60
		'num_nom_retenu' => 'c.num_nom_retenu',
61
		'num_nom_retenu' => 'c.num_nom_retenu',
61
		'num_tax_sup' => 'c.num_tax_sup',
62
		'num_tax_sup' => 'c.num_tax_sup',
62
		'rang' => 'c.rang',
63
		'rang' => 'c.rang',
63
		'nom_sci' => 'c.nom_sci',
64
		'nom_sci' => 'c.nom_sci',
64
		'nom_supra_generique' => 'c.nom_supra_generique',
65
		'nom_supra_generique' => 'c.nom_supra_generique',
65
		'genre' => 'c.genre',
66
		'genre' => 'c.genre',
66
		'epithete_infra_generique' => 'c.epithete_infra_generique',
67
		'epithete_infra_generique' => 'c.epithete_infra_generique',
67
		'epithete_sp' => 'c.epithete_sp',
68
		'epithete_sp' => 'c.epithete_sp',
68
		'type_epithete' => 'c.type_epithete',
69
		'type_epithete' => 'c.type_epithete',
69
		'epithete_infra_sp' => 'c.epithete_infra_sp',
70
		'epithete_infra_sp' => 'c.epithete_infra_sp',
70
		'cultivar_groupe' => 'c.cultivar_groupe',
71
		'cultivar_groupe' => 'c.cultivar_groupe',
71
		'cultivar' => 'c.cultivar',
72
		'cultivar' => 'c.cultivar',
72
		'nom_commercial' => 'c.nom_commercial',
73
		'nom_commercial' => 'c.nom_commercial',
73
		'auteur' => 'c.auteur',
74
		'auteur' => 'c.auteur',
74
		'annee' => 'c.annee',
75
		'annee' => 'c.annee',
75
		'biblio_origine' => 'c.biblio_origine',
76
		'biblio_origine' => 'c.biblio_origine',
76
		'notes' => 'c.notes',
77
		'notes' => 'c.notes',
77
		'nom_addendum' => 'c.nom_addendum',
78
		'nom_addendum' => 'c.nom_addendum',
78
		'nom_francais' => 'c.nom_francais',
79
		'nom_francais' => 'c.nom_francais',
79
		'nom_coste' => 'c.nom_coste',
80
		'nom_coste' => 'c.nom_coste',
80
		'auteur_coste' => 'c.auteur_coste',
81
		'auteur_coste' => 'c.auteur_coste',
81
		'biblio_coste' => 'c.biblio_coste',
82
		'biblio_coste' => 'c.biblio_coste',
82
		'num_nom_coste' => 'c.num_nom_coste',
83
		'num_nom_coste' => 'c.num_nom_coste',
83
		'num_nom_retenu_coste' => 'c.num_nom_retenu_coste',
84
		'num_nom_retenu_coste' => 'c.num_nom_retenu_coste',
84
		'num_tax_sup_coste' => 'c.num_tax_sup_coste',
85
		'num_tax_sup_coste' => 'c.num_tax_sup_coste',
85
		'synonymie_coste' => 'c.synonymie_coste',
86
		'synonymie_coste' => 'c.synonymie_coste',
86
		'tome' => 'c.tome',
87
		'tome' => 'c.tome',
87
		'page' => 'c.page',
88
		'page' => 'c.page',
88
		'nbre_taxons' => 'c.nbre_taxons',
89
		'nbre_taxons' => 'c.nbre_taxons',
89
		'flore_bdtfx_nn' => 'c.flore_bdtfx_nn',
90
		'flore_bdtfx_nn' => 'c.flore_bdtfx_nn',
90
		'flore_bdtfx_nt' => 'c.flore_bdtfx_nt',
91
		'flore_bdtfx_nt' => 'c.flore_bdtfx_nt',
91
		'image' => 'c.image',
92
		'image' => 'c.image',
92
		'image_auteur' => 'c.image_auteur',
93
		'image_auteur' => 'c.image_auteur',
93
		'nom_sci_html' => 'c.nom_sci_html',
94
		'nom_sci_html' => 'c.nom_sci_html',
94
 
95
 
95
		// handly duplicate (redirigé vers nom_sci ou nom_sci_html selon que txt.format vaut "txt" ou "htm"
96
		// handly duplicate (redirigé vers nom_sci ou nom_sci_html selon que txt.format vaut "txt" ou "htm"
96
		'titre' => 'c.nom_sci',
97
		'titre' => 'c.nom_sci',
97
 
98
 
98
		// champs spécifiques (et étrangères)
99
		// champs spécifiques (et étrangères)
99
		'texte' => 'dsc.body',
100
		'texte' => 'dsc.body',
100
		'determination' => 'cle.body',
101
		'determination' => 'cle.body',
101
		'tag' => 'dsc.tag',
102
		'tag' => 'dsc.tag',
102
		'famille' => 'b.famille', // cf sqlAddJoins()
103
		'famille' => 'b.famille', // cf sqlAddJoins()
103
		'*' => 'XXX' // spécial
104
		'*' => 'XXX' // spécial
104
	);
105
	);
105
 
106
 
106
	// les champs suivants disparaissent de la liste utilisée pour former la requête SQL
107
	// les champs suivants disparaissent de la liste utilisée pour former la requête SQL
107
	// (ils sont exclue lorsque '*' est utilisée, ce sont généralement des synonymes)
108
	// (ils sont exclue lorsque '*' est utilisée, ce sont généralement des synonymes)
108
	static $special_champs = array('nom_sci_html', 'nom_sci', '*', 'flore_bdtfx_nn', 'flore_bdtfx_nt', 'num_nom');
109
	static $special_champs = array('nom_sci_html', 'nom_sci', '*', 'flore_bdtfx_nn', 'flore_bdtfx_nt', 'num_nom');
109
 
110
 
110
	// ces champs sont toujours dans les résultats (cf sqlSelectFields()
111
	// ces champs sont toujours dans les résultats (cf sqlSelectFields()
111
	static $champs_obligatoires = array('coste:nn', 'bdtfx:nn');
112
	static $champs_obligatoires = array('coste:nn', 'bdtfx:nn');
112
 
113
 
113
 
114
 
114
	// le pattern utilisé pour la recherche dite "floue"
115
	// le pattern utilisé pour la recherche dite "floue"
115
	static $soundex_scheme = '(%1$s LIKE %2$s OR SOUNDEX(%1$s) = SOUNDEX(%2$s) OR SOUNDEX(REVERSE(%1$s)) = SOUNDEX(REVERSE(%2$s)))';
116
	static $soundex_scheme = '(%1$s LIKE %2$s OR SOUNDEX(%1$s) = SOUNDEX(%2$s) OR SOUNDEX(REVERSE(%1$s)) = SOUNDEX(REVERSE(%2$s)))';
116
 
117
 
117
	// contrainte du point d'entrée d'API webservice Tela lors d'un GET
118
	// contrainte du point d'entrée d'API webservice Tela lors d'un GET
118
	public function consulter($ressources, $parametres, $db = NULL) {
119
	public function consulter($ressources, $parametres, $db = NULL) {
119
		if(!$db) {
120
		if(!$db) {
120
			// http_response_code(500);
121
			// http_response_code(500);
121
			throw new Exception('no DB', 500);
122
			throw new Exception('no DB', 500);
122
		}
123
		}
123
 
124
 
124
		// parser la requête et filtrer les paramètres valides
125
		// parser la requête et filtrer les paramètres valides
125
		// en cas d'accès HTTP
126
		// en cas d'accès HTTP
126
		if(array_key_exists('QUERY_STRING', $_SERVER)) {
127
		if(array_key_exists('QUERY_STRING', $_SERVER)) {
127
			self::requestParse($uri, $params);
128
			self::requestParse($uri, $params);
128
		}
129
		}
129
		// en cas d'accès phpunit
130
		// en cas d'accès phpunit
130
		else {
131
		else {
131
			$uri = $ressources;
132
			$uri = $ressources;
132
		}
133
		}
133
 
134
 
134
		// renvoie du plain/text d'aide (cf fin de programme)
135
		// renvoie du plain/text d'aide (cf fin de programme)
135
		if(count($uri) == 1 && $uri[0] == 'aide') return self::aide();
136
		if(count($uri) == 1 && $uri[0] == 'aide') return self::aide();
136
 
137
 
137
 
138
 
138
		if(is_null($parametres)) $parametres = Array();
139
		if(is_null($parametres)) $parametres = Array();
139
		$params = self::requestFilterParams($parametres);
140
		$params = self::requestFilterParams($parametres);
140
		// les contraintes liées aux ids (passés comme composants d'URL)
141
		// les contraintes liées aux ids (passés comme composants d'URL)
141
		// sont ajoutées aux params [sans être accepté comme paramètre d'URL]
142
		// sont ajoutées aux params [sans être accepté comme paramètre d'URL]
142
		$params['_ids'] = self::requestFilterIds($uri);
143
		$params['_ids'] = self::requestFilterIds($uri);
143
 
144
 
144
		// XXX: temporaires, passage de $db aux fonctions
145
		// XXX: temporaires, passage de $db aux fonctions
145
		// de toolkits
146
		// de toolkits
146
		$req = self::getCosteInfo($params, $db);
147
		$req = self::getCosteInfo($params, $db);
147
 
148
 
148
		$res = $db->recupererTous($req);
149
		$res = $db->recupererTous($req);
149
		$err = mysql_error();
150
		$err = mysql_error();
150
		if(!$res && $err) {
151
		if(!$res && $err) {
151
			// http_response_code(400);
152
			// http_response_code(400);
152
			// if(defined('DEBUG') && DEBUG) header("X-Debug: $req");
153
			// if(defined('DEBUG') && DEBUG) header("X-Debug: $req");
153
			throw new Exception('not found', 400);
154
			throw new Exception('not found', 400);
154
		}
155
		}
155
 
156
 
156
		// rapide formatage des résultats:
157
		// rapide formatage des résultats:
157
		$matches = 0;
158
		$matches = 0;
158
 
159
 
159
		if($res) {
160
		if($res) {
160
			// nombre de matches (sans LIMIT) utilisé pour l'en-tête
161
			// nombre de matches (sans LIMIT) utilisé pour l'en-tête
161
			$matches = $db->recuperer('SELECT FOUND_ROWS() AS total');
162
			$matches = $db->recuperer('SELECT FOUND_ROWS() AS total');
162
			$matches = intval($matches['total']);
163
			$matches = intval($matches['total']);
163
		}
164
		}
164
 
165
 
-
 
166
		// reformate les résultats pour les indexer par coste:nn par défaut
-
 
167
		// cependant le paramètre retour.indexBy permet de choisir une indexation par num_nom de bdtfx
165
		// reformate les résultats pour les indexer par coste:nn
168
		$clef_index = $params['retour.indexBy'] == 'coste' ? 'coste:nn' : 'bdtfx:nn';
166
		$res2 = array();
169
		$res2 = array();
-
 
170
		foreach($res as $v) {
167
		foreach($res as $v) {
171
			if(!$v[$clef_index]) throw new Exception('format error: index NULL, use retour.indexBy=coste', 400);
168
			$res2[$v['coste:nn']] = $v;
172
			$res2[$v[$clef_index]] = $v;
169
		}
173
		}
170
 
174
 
171
		// l'appelant s'occupera du json_encode()
175
		// l'appelant s'occupera du json_encode()
172
		// même si ça démange d'exit'er ici
176
		// même si ça démange d'exit'er ici
173
		header("Content-Type: application/json; charset=utf-8");
177
		header("Content-Type: application/json; charset=utf-8");
174
		return array('entete' => array('depart' => $params['navigation.depart'],
178
		return array('entete' => array('depart' => $params['navigation.depart'],
175
									   'limite' => $params['navigation.limite'],
179
									   'limite' => $params['navigation.limite'],
176
									   'total' => count($res2),
180
									   'total' => count($res2),
177
									   'match' => $matches),
181
									   'match' => $matches),
178
					 'resultats' => $res2);
182
					 'resultats' => $res2);
179
 
183
 
180
	}
184
	}
181
 
185
 
182
 
186
 
183
	// la fonction centrale: récupère les infos à partir de paramètres
187
	// la fonction centrale: récupère les infos à partir de paramètres
184
	// et une optionnelle contrainte sur coste:nn ou bdtfx:nn
188
	// et une optionnelle contrainte sur coste:nn ou bdtfx:nn
185
	static function getCosteInfo(array $params, $db) {
189
	static function getCosteInfo(array $params, $db) {
186
		// contraintes (WHERE):
190
		// contraintes (WHERE):
187
		$constraints = self::sqlAddConstraint($params, $db);
191
		$constraints = self::sqlAddConstraint($params, $db);
188
		// XXX: que faire en l'absence de contrainte ? pour l'instant : "WHERE 1"
192
		// XXX: que faire en l'absence de contrainte ? pour l'instant : "WHERE 1"
189
 
193
 
190
		// champs:
194
		// champs:
191
		$champs_valides_non_formattes = NULL;
195
		$champs_valides_non_formattes = NULL;
192
		$champs_valides = self::sqlSelectFields($params, $champs_valides_non_formattes);
196
		$champs_valides = self::sqlSelectFields($params, $champs_valides_non_formattes);
193
 
197
 
194
		// joins:
198
		// joins:
195
		$other_join = self::sqlAddJoins($params, $champs_valides_non_formattes);
199
		$other_join = self::sqlAddJoins($params, $champs_valides_non_formattes);
196
		$req = sprintf(<<<EOF
200
		$req = sprintf(<<<EOF
197
SELECT SQL_CALC_FOUND_ROWS  %s
201
SELECT SQL_CALC_FOUND_ROWS  %s
198
FROM tb_eflore.coste_v2_00 c
202
FROM tb_eflore.coste_v2_00 c
199
LEFT JOIN tela_prod_wikini.florecoste_pages dsc ON c.page_wiki_dsc = dsc.tag AND dsc.latest = 'Y'
203
LEFT JOIN tela_prod_wikini.florecoste_pages dsc ON c.page_wiki_dsc = dsc.tag AND dsc.latest = 'Y'
200
LEFT JOIN tela_prod_wikini.florecoste_pages cle ON c.page_wiki_cle = cle.tag AND cle.latest = 'Y'
204
LEFT JOIN tela_prod_wikini.florecoste_pages cle ON c.page_wiki_cle = cle.tag AND cle.latest = 'Y'
201
%s
205
%s
202
WHERE %s ORDER BY c.num_nom LIMIT %u, %u -- %s
206
WHERE %s ORDER BY c.num_nom LIMIT %u, %u -- %s
203
EOF
207
EOF
204
					   ,
208
					   ,
205
					   $champs_valides, // dans le SELECT (parmi champs coste_v2_00)
209
					   $champs_valides, // dans le SELECT (parmi champs coste_v2_00)
206
					   // autre join, si nécessaire
210
					   // autre join, si nécessaire
207
					   $other_join ? $other_join : '',
211
					   $other_join ? $other_join : '',
208
					   // where
212
					   // where
209
					   $constraints ? implode(' AND ', $constraints) : '1',
213
					   $constraints ? implode(' AND ', $constraints) : '1',
210
 
214
 
211
					   // limit
215
					   // limit
212
					   $params['navigation.depart'],
216
					   $params['navigation.depart'],
213
					   $params['navigation.limite'],
217
					   $params['navigation.limite'],
214
					   __FILE__ . ':' . __LINE__);
218
					   __FILE__ . ':' . __LINE__);
215
		
219
		
216
		return $req;
220
		return $req;
217
	}
221
	}
218
 
222
 
219
 
223
 
220
 
224
 
221
 
225
 
222
	// SQL helpers
226
	// SQL helpers
223
	// le préfix de coste_v2_00 est "c"
227
	// le préfix de coste_v2_00 est "c"
224
	// le préfix de florecoste_pages sur la description est est "dsc"
228
	// le préfix de florecoste_pages sur la description est est "dsc"
225
	// le préfix de florecoste_pages sur la clef de détermination est est "cle"
229
	// le préfix de florecoste_pages sur la clef de détermination est est "cle"
226
	static function sqlAddConstraint($params, $db) {
230
	static function sqlAddConstraint($params, $db) {
227
		$stack = array();
231
		$stack = array();
228
		if(!empty($params['masque.ns'])) {
232
		if(!empty($params['masque.ns'])) {
229
			if($params['recherche'] == 'etendue')
233
			if($params['recherche'] == 'etendue')
230
				$stack[] = 'c.nom_sci LIKE ' . $db->proteger('%' . trim($params['masque.ns']) . '%');
234
				$stack[] = 'c.nom_sci LIKE ' . $db->proteger('%' . trim($params['masque.ns']) . '%');
231
			elseif($params['recherche'] == 'floue')
235
			elseif($params['recherche'] == 'floue')
232
				$stack[] = sprintf(self::$soundex_scheme,
236
				$stack[] = sprintf(self::$soundex_scheme,
233
								   'c.nom_sci',
237
								   'c.nom_sci',
234
								   $db->proteger('%' . trim($params['masque.ns']) . '%'));
238
								   $db->proteger('%' . trim($params['masque.ns']) . '%'));
235
			else
239
			else
236
				$stack[] = 'c.nom_sci = ' . $db->proteger(trim($params['masque.ns']));
240
				$stack[] = 'c.nom_sci = ' . $db->proteger(trim($params['masque.ns']));
237
		}
241
		}
238
 
242
 
239
		// le masque sur texte est toujours un LIKE() "étendue", sauf si "floue" spécifié
243
		// le masque sur texte est toujours un LIKE() "étendue", sauf si "floue" spécifié
240
		if(!empty($params['masque.txt'])) {
244
		if(!empty($params['masque.txt'])) {
241
			if($params['recherche'] == 'floue') {
245
			if($params['recherche'] == 'floue') {
242
				$stack[] = sprintf(self::$soundex_scheme,
246
				$stack[] = sprintf(self::$soundex_scheme,
243
								   'dsc.body',
247
								   'dsc.body',
244
								   $db->proteger('%' . trim($params['masque.txt']) . '%'));
248
								   $db->proteger('%' . trim($params['masque.txt']) . '%'));
245
			}
249
			}
246
			else {
250
			else {
247
				$stack[] = 'dsc.body LIKE ' . $db->proteger('%' . trim($params['masque.txt']) . '%');
251
				$stack[] = 'dsc.body LIKE ' . $db->proteger('%' . trim($params['masque.txt']) . '%');
248
			}
252
			}
249
		}
253
		}
250
 
254
 
251
		if(!empty($params['masque.titre'])) {
255
		if(!empty($params['masque.titre'])) {
252
			if($params['recherche'] == 'stricte') {
256
			if($params['recherche'] == 'stricte') {
253
				$stack[] = sprintf('(dsc.tag = %1$s OR cle.tag = %1$s)',
257
				$stack[] = sprintf('(dsc.tag = %1$s OR cle.tag = %1$s)',
254
								   $db->proteger(trim($params['masque.titre'])));
258
								   $db->proteger(trim($params['masque.titre'])));
255
			}
259
			}
256
			else {
260
			else {
257
				$stack[] = sprintf('(dsc.tag LIKE %1$s OR cle.tag LIKE %1$s)',
261
				$stack[] = sprintf('(dsc.tag LIKE %1$s OR cle.tag LIKE %1$s)',
258
								   $db->proteger('%' .  trim($params['masque.titre']) . '%'));
262
								   $db->proteger('%' .  trim($params['masque.titre']) . '%'));
259
			}
263
			}
260
		}
264
		}
261
 
265
 
262
		if(array_key_exists('masque.famille', $params)) {
266
		if(array_key_exists('masque.famille', $params)) {
263
			$stack[] = 'b.famille LIKE ' . $db->proteger(trim($params['masque.famille']));
267
			$stack[] = 'b.famille LIKE ' . $db->proteger(trim($params['masque.famille']));
264
		}
268
		}
265
 
269
 
266
		if(array_key_exists('masque.page', $params)) {
270
		if(array_key_exists('masque.page', $params)) {
267
			$stack[] = 'c.page = ' . intval($params['masque.page']);
271
			$stack[] = 'c.page = ' . intval($params['masque.page']);
268
		}
272
		}
269
 
273
 
270
		if(array_key_exists('masque.tome', $params)) {
274
		if(array_key_exists('masque.tome', $params)) {
271
			$stack[] = 'c.tome = ' . intval($params['masque.tome']);
275
			$stack[] = 'c.tome = ' . intval($params['masque.tome']);
272
		}
276
		}
273
 
277
 
274
		if(array_key_exists('masque.nt', $params)) {
278
		if(array_key_exists('masque.nt', $params)) {
275
			$stack[] = 'c.flore_bdtfx_nt = ' . intval($params['masque.nt']);
279
			$stack[] = 'c.flore_bdtfx_nt = ' . intval($params['masque.nt']);
276
		}
280
		}
277
 
281
 
278
		// ajout de la contrainte sur coste:nn ou bdtfx:nn si un composant d'URL supplémentaire
282
		// ajout de la contrainte sur coste:nn ou bdtfx:nn si un composant d'URL supplémentaire
279
		// comportant un #id existe, cf self::requestFilterIds()
283
		// comportant un #id existe, cf self::requestFilterIds()
280
		$o_stack = array();
284
		$o_stack = array();
281
		if(array_key_exists('_ids', $params) && $params['_ids']) {
285
		if(array_key_exists('_ids', $params) && $params['_ids']) {
282
			if($params['_ids']['coste']) {
286
			if($params['_ids']['coste']) {
283
				$o_stack[] = sprintf("c.num_nom IN (%s)", implode(',', $params['_ids']['coste']));
287
				$o_stack[] = sprintf("c.num_nom IN (%s)", implode(',', $params['_ids']['coste']));
284
			}
288
			}
285
			if($params['_ids']['bdtfx']) {
289
			if($params['_ids']['bdtfx']) {
286
				$o_stack[] = sprintf("c.flore_bdtfx_nn IN (%s)", implode(',', $params['_ids']['bdtfx']));
290
				$o_stack[] = sprintf("c.flore_bdtfx_nn IN (%s)", implode(',', $params['_ids']['bdtfx']));
287
			}
291
			}
288
		}
292
		}
289
		if($o_stack) $stack[] = '(' . implode(' OR ', $o_stack) . ')';
293
		if($o_stack) $stack[] = '(' . implode(' OR ', $o_stack) . ')';
290
 
294
 
291
		return $stack;
295
		return $stack;
292
	}
296
	}
293
 
297
 
294
 
298
 
295
	// $unmerged contient la même liste de champs que celle renvoyée
299
	// $unmerged contient la même liste de champs que celle renvoyée
296
	// à la différence que celle-ci n'est pas reformatée et s'avère donc
300
	// à la différence que celle-ci n'est pas reformatée et s'avère donc
297
	// utilisable plus aisément dans sqlAddJoins() qui peut en avoir besoin
301
	// utilisable plus aisément dans sqlAddJoins() qui peut en avoir besoin
298
	static function sqlSelectFields($params, &$unmerged) {
302
	static function sqlSelectFields($params, &$unmerged) {
299
		$champs = $params['retour.champs'];
303
		$champs = $params['retour.champs'];
300
		// champs coste_v2_00
304
		// champs coste_v2_00
301
		$c = self::addSQLToFieldSynonym(explode(',', $champs));
305
		$c = self::addSQLToFieldSynonym(explode(',', $champs));
302
		if(isset($c['*'])) {
306
		if(isset($c['*'])) {
303
			$t = array_diff_key(self::$allow_champs, array_flip(self::$special_champs));
307
			$t = array_diff_key(self::$allow_champs, array_flip(self::$special_champs));
304
		}
308
		}
305
		else {
309
		else {
306
			// just loop below
310
			// just loop below
307
			$t = $c;
311
			$t = $c;
308
		}
312
		}
309
 
313
 
310
		// si aucun des champs fournis n'est valide
314
		// si aucun des champs fournis n'est valide
311
		// on se rappelle nous-même après avoir réinitialisé retour.champs
315
		// on se rappelle nous-même après avoir réinitialisé retour.champs
312
		// avec les champs par défaut
316
		// avec les champs par défaut
313
		if(!$t) {
317
		if(!$t) {
314
			$params['retour.champs'] = self::$default_params['retour.champs'];
318
			$params['retour.champs'] = self::$default_params['retour.champs'];
315
			return self::sqlSelectFields($params);
319
			return self::sqlSelectFields($params);
316
		}
320
		}
317
 
321
 
318
		if(array_key_exists('titre', $t))
322
		if(array_key_exists('titre', $t))
319
			$t['titre'] = $params['txt.format'] == 'txt' ? 'c.nom_sci' : 'c.nom_sci_html';
323
			$t['titre'] = $params['txt.format'] == 'txt' ? 'c.nom_sci' : 'c.nom_sci_html';
320
 
324
 
321
		// champs obligatoires:
325
		// champs obligatoires:
322
		$t = array_merge($t, self::addSQLToFieldSynonym(self::$champs_obligatoires));
326
		$t = array_merge($t, self::addSQLToFieldSynonym(self::$champs_obligatoires));
323
		$unmerged = $t;
327
		$unmerged = $t;
324
 
328
 
325
		// XXX: PHP-5.3
329
		// XXX: PHP-5.3
326
		$ret = array();
330
		$ret = array();
327
		foreach($t as $k => $v) {
331
		foreach($t as $k => $v) {
328
			if(strpos($k, ':') !== FALSE) {
332
			if(strpos($k, ':') !== FALSE) {
329
				$ret[] = "$v AS \"$k\"";
333
				$ret[] = "$v AS \"$k\"";
330
			} else {
334
			} else {
331
				$ret[] = "$v AS $k";
335
				$ret[] = "$v AS $k";
332
			}
336
			}
333
		}
337
		}
334
		return implode(',',$ret);
338
		return implode(',',$ret);
335
	}
339
	}
336
 
340
 
337
	static function sqlAddJoins($params, $champs) {
341
	static function sqlAddJoins($params, $champs) {
338
		$j = '';
342
		$j = '';
339
		// ces tests doivent correspondre aux champs générés par sqlSelectFields()
343
		// ces tests doivent correspondre aux champs générés par sqlSelectFields()
340
		// ou contraintes générées par sqlAddConstraint()
344
		// ou contraintes générées par sqlAddConstraint()
341
		if(array_key_exists('masque.famille', $params) ||
345
		if(array_key_exists('masque.famille', $params) ||
342
		   array_key_exists('famille', $champs)) {
346
		   array_key_exists('famille', $champs)) {
343
			$j .= 'LEFT JOIN tb_eflore.bdtfx_v1_02 b ON c.flore_bdtfx_nn = b.num_nom';
347
			$j .= 'LEFT JOIN tb_eflore.bdtfx_v1_02 b ON c.flore_bdtfx_nn = b.num_nom';
344
		}
348
		}
345
 
349
 
346
		return $j;
350
		return $j;
347
	}
351
	}
348
 
352
 
349
	// d'un tableau de type array("coste:nn", "type_epithete")
353
	// d'un tableau de type array("coste:nn", "type_epithete")
350
	// retourne
354
	// retourne
351
	// un tableau de type array("coste:nn" => "c.num_nom", "type_epithete" => "c.type_epithete")
355
	// un tableau de type array("coste:nn" => "c.num_nom", "type_epithete" => "c.type_epithete")
352
	// basé sur self::$allow_champs
356
	// basé sur self::$allow_champs
353
	static function addSQLToFieldSynonym(Array $syno) {
357
	static function addSQLToFieldSynonym(Array $syno) {
354
		return array_intersect_key(self::$allow_champs, array_flip($syno));
358
		return array_intersect_key(self::$allow_champs, array_flip($syno));
355
	}
359
	}
356
 
360
 
357
	// request handler
361
	// request handler
358
	static function requestParse(&$ressource, &$params) {
362
	static function requestParse(&$ressource, &$params) {
359
		$uri = explode('/', $_SERVER['REDIRECT_URL']);
363
		$uri = explode('/', $_SERVER['REDIRECT_URL']);
360
		if(!empty($_SERVER['QUERY_STRING']))
364
		if(!empty($_SERVER['QUERY_STRING']))
361
			parse_str($_SERVER['REDIRECT_QUERY_STRING'], $params);
365
			parse_str($_SERVER['REDIRECT_QUERY_STRING'], $params);
362
		$ressource = array_slice($uri, array_search('textes', $uri) + 1, 3);
366
		$ressource = array_slice($uri, array_search('textes', $uri) + 1, 3);
363
	}
367
	}
364
 
368
 
365
	// supprime l'index du tableau des paramètres si sa valeur ne correspond pas
369
	// supprime l'index du tableau des paramètres si sa valeur ne correspond pas
366
	// au spectre passé par $values.
370
	// au spectre passé par $values.
367
	static function unsetIfInvalid(&$var, $index, $values) {
371
	static function unsetIfInvalid(&$var, $index, $values) {
368
		if(array_key_exists($index, $var) && !in_array($var[$index], $values))
372
		if(array_key_exists($index, $var) && !in_array($var[$index], $values))
369
			unset($var[$index]);
373
			unset($var[$index]);
370
	}
374
	}
371
 
375
 
372
	static function requestFilterParams(Array $params) {
376
	static function requestFilterParams(Array $params) {
373
		$p = array_intersect_key($params, array_flip(self::$allow_params));
377
		$p = array_intersect_key($params, array_flip(self::$allow_params));
374
		self::unsetIfInvalid($p, 'txt.format', array('txt', 'htm'));
378
		self::unsetIfInvalid($p, 'txt.format', array('txt', 'htm'));
375
		self::unsetIfInvalid($p, 'retour.format', array('min','max'));
379
		self::unsetIfInvalid($p, 'retour.format', array('min','max'));
-
 
380
		self::unsetIfInvalid($p, 'retour.indexBy', array('coste', 'bdtfx'));
376
		self::unsetIfInvalid($p, 'recherche', array('stricte','etendue','floue'));
381
		self::unsetIfInvalid($p, 'recherche', array('stricte','etendue','floue'));
377
 
382
 
378
		if(isset($params['masque.ns'])) $p['masque.ns'] = trim($params['masque.ns']);
383
		if(isset($params['masque.ns'])) $p['masque.ns'] = trim($params['masque.ns']);
379
		if(isset($params['masque.texte'])) $p['masque.texte'] = trim($params['masque.texte']);
384
		if(isset($params['masque.texte'])) $p['masque.texte'] = trim($params['masque.texte']);
380
 
385
 
381
		if(isset($params['masque.famille'])) {
386
		if(isset($params['masque.famille'])) {
382
			// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v1_02;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
387
			// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v1_02;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
383
			$p['masque.famille'] = preg_replace('/[^a-zA-Z %_]/', '', iconv("UTF-8",
388
			$p['masque.famille'] = preg_replace('/[^a-zA-Z %_]/', '', iconv("UTF-8",
384
																			"ASCII//TRANSLIT",
389
																			"ASCII//TRANSLIT",
385
																			$params['masque.famille']));
390
																			$params['masque.famille']));
386
		}
391
		}
387
 
392
 
388
		// TODO: use filter_input(INPUT_GET);
393
		// TODO: use filter_input(INPUT_GET);
389
		// renvoie FALSE ou NULL si absent ou invalide
394
		// renvoie FALSE ou NULL si absent ou invalide
390
		$p['navigation.limite'] = filter_var(@$params['navigation.limite'],
395
		$p['navigation.limite'] = filter_var(@$params['navigation.limite'],
391
												  FILTER_VALIDATE_INT,
396
												  FILTER_VALIDATE_INT,
392
												  array('options' => array('default' => NULL,
397
												  array('options' => array('default' => NULL,
393
																		   'min_range' => 1,
398
																		   'min_range' => 1,
394
																		   'max_range' => _COSTE_TEXTE_MAX_RESULT_LIMIT)));
399
																		   'max_range' => _COSTE_TEXTE_MAX_RESULT_LIMIT)));
395
		$p['navigation.depart'] = filter_var(@$params['navigation.depart'],
400
		$p['navigation.depart'] = filter_var(@$params['navigation.depart'],
396
												  FILTER_VALIDATE_INT,
401
												  FILTER_VALIDATE_INT,
397
												  array('options' => array('default' => NULL,
402
												  array('options' => array('default' => NULL,
398
																		   'min_range' => 0,
403
																		   'min_range' => 0,
399
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_NN)));
404
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_NN)));
400
		$p['masque.page'] = filter_var(@$params['masque.page'],
405
		$p['masque.page'] = filter_var(@$params['masque.page'],
401
												  FILTER_VALIDATE_INT,
406
												  FILTER_VALIDATE_INT,
402
												  array('options' => array('default' => NULL,
407
												  array('options' => array('default' => NULL,
403
																		   'min_range' => 0,
408
																		   'min_range' => 0,
404
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_PAGE)));
409
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_PAGE)));
405
		$p['masque.tome'] = filter_var(@$params['masque.tome'],
410
		$p['masque.tome'] = filter_var(@$params['masque.tome'],
406
												  FILTER_VALIDATE_INT,
411
												  FILTER_VALIDATE_INT,
407
												  array('options' => array('default' => NULL,
412
												  array('options' => array('default' => NULL,
408
																		   'min_range' => 0,
413
																		   'min_range' => 0,
409
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_TOME)));
414
																		   'max_range' => _COSTE_TEXTE_MAX_COSTE_TOME)));
410
		$p['masque.nt'] = filter_var(@$params['masque.nt'],
415
		$p['masque.nt'] = filter_var(@$params['masque.nt'],
411
												  FILTER_VALIDATE_INT,
416
												  FILTER_VALIDATE_INT,
412
												  array('options' => array('default' => NULL,
417
												  array('options' => array('default' => NULL,
413
																		   'min_range' => 0,
418
																		   'min_range' => 0,
414
																		   'max_range' => _COSTE_TEXTE_MAX_BDTFX_NT)));
419
																		   'max_range' => _COSTE_TEXTE_MAX_BDTFX_NT)));
415
 
420
 
416
		// on filtre les NULL, FALSE et '', mais pas les 0, d'où le callback()
421
		// on filtre les NULL, FALSE et '', mais pas les 0, d'où le callback()
417
		// TODO: PHP-5.3
422
		// TODO: PHP-5.3
418
		$p = array_filter($p, create_function('$a','return !in_array($a, array("",false,null),true);'));
423
		$p = array_filter($p, create_function('$a','return !in_array($a, array("",false,null),true);'));
419
		$p = array_merge(self::$default_params, $p);
424
		$p = array_merge(self::$default_params, $p);
420
 
425
 
421
		return $p;
426
		return $p;
422
	}
427
	}
423
 
428
 
424
	static function requestFilterIds($uri) {
429
	static function requestFilterIds($uri) {
425
		if(count($uri) != 1) return NULL;
430
		if(count($uri) != 1) return NULL;
426
 
431
 
427
		// getNN* renvoient le num_nom passé comme segment d'URI:
432
		// getNN* renvoient le num_nom passé comme segment d'URI:
428
		// - soit un id selon coste (num_nom dans coste_v2_00)
433
		// - soit un id selon coste (num_nom dans coste_v2_00)
429
		// - soit un id selon bdtfx (num_nom dans bdtfx_v1_02)
434
		// - soit un id selon bdtfx (num_nom dans bdtfx_v1_02)
430
		// ou bien l'extrait du pattern bdtfx.nn:(#id)
435
		// ou bien l'extrait du pattern bdtfx.nn:(#id)
431
		$ids_coste = array_filter(array_map(array(__CLASS__, 'getNNCoste'), explode(',', $uri[0])));
436
		$ids_coste = array_filter(array_map(array(__CLASS__, 'getNNCoste'), explode(',', $uri[0])));
432
		$ids_bdtfx = array_filter(array_map(array(__CLASS__, 'getNNBdtfx'), explode(',', $uri[0])));
437
		$ids_bdtfx = array_filter(array_map(array(__CLASS__, 'getNNBdtfx'), explode(',', $uri[0])));
433
 
438
 
434
		// en cas d'échec (tous les id sont invalides), bail-out
439
		// en cas d'échec (tous les id sont invalides), bail-out
435
		if(!$ids_bdtfx && !$ids_coste) {
440
		if(!$ids_bdtfx && !$ids_coste) {
436
			// http_response_code(500);
441
			// http_response_code(500);
437
			throw new Exception('not supported', 500);
442
			throw new Exception('not supported', 500);
438
		}
443
		}
439
 
444
 
440
		return array(
445
		return array(
441
			'coste' => array_slice($ids_coste, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT/2) ),
446
			'coste' => array_slice($ids_coste, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT/2) ),
442
			'bdtfx' => array_slice($ids_bdtfx, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT/2) )
447
			'bdtfx' => array_slice($ids_bdtfx, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT/2) )
443
		);
448
		);
444
	}
449
	}
445
 
450
 
446
	static function aide() {
451
	static function aide() {
447
		header("Content-Type: text/plain; charset=utf-8");
452
		header("Content-Type: text/plain; charset=utf-8");
448
		return sprintf("
453
		return sprintf("
449
Service coste/textes:
454
Service coste/textes:
450
Retourne des informations (choisies) à propos d'un taxon donné (à partir de son numéro nomenclatural
455
Retourne des informations (choisies) à propos d'un taxon donné (à partir de son numéro nomenclatural
451
Retourne des informations (choisies) à propos de taxons recherchés (à partir de divers critères)
456
Retourne des informations (choisies) à propos de taxons recherchés (à partir de divers critères)
452
Les résultats sont indexés. La clef par défaut est le num_nom d'après coste (attribut \"coste:nn\")
457
Les résultats sont indexés. La clef par défaut est le num_nom d'après coste (attribut \"coste:nn\")
453
Usage:
458
Usage:
454
			coste/textes/<liste-num_nom>?<params>
459
			coste/textes/<liste-num_nom>?<params>
455
* <liste-num_nom> étant une liste de numéros nomenclaturaux de taxons séparés par des virgules au format:
460
* <liste-num_nom> étant une liste de numéros nomenclaturaux de taxons séparés par des virgules au format:
456
 - <#id>: un numéro nomenclatural dans la base coste
461
 - <#id>: un numéro nomenclatural dans la base coste
457
 - <bdtfx.nn:#id>: un numéro nomenclatural dans la base bdtfx
462
 - <bdtfx.nn:#id>: un numéro nomenclatural dans la base bdtfx
458
* retour.champs une liste de champs séparés par des virgules parmi *,%s
463
* retour.champs une liste de champs séparés par des virgules parmi *,%s
459
* les paramètres acceptés sont les suivants: %s
464
* les paramètres acceptés sont les suivants: %s
460
* les champs retournés par défaut sont les suivants: %s
465
* les champs retournés par défaut sont les suivants: %s
461
* le paramètre \"recherche\" affecte les masques \"ns\" et \"texte\"
466
* le paramètre \"recherche\" affecte les masques \"ns\" et \"texte\"
462
* le paramètre \"famille\" est traité via LIKE et accepte les caractères '_' et '%'
467
* le paramètre \"famille\" est traité via LIKE et accepte les caractères '_' et '%'
463
* le paramètre \"retour.format\" est inutilisé pour l'instant",
468
* le paramètre \"retour.format\" est inutilisé pour l'instant",
464
					   implode(',', array_keys(self::$allow_champs)),
469
					   implode(',', array_keys(self::$allow_champs)),
465
					   implode(',', self::$allow_params),
470
					   implode(',', self::$allow_params),
466
					   self::$default_params['retour.champs']
471
					   self::$default_params['retour.champs']
467
		);
472
		);
468
	}
473
	}
469
 
474
 
470
	static function getNNCoste($refnn) {
475
	static function getNNCoste($refnn) {
471
		if(is_numeric($refnn)) {
476
		if(is_numeric($refnn)) {
472
			$t = intval($refnn);
477
			$t = intval($refnn);
473
			if($t >= 1 && $t < _COSTE_TEXTE_MAX_COSTE_NN) return $t;
478
			if($t >= 1 && $t < _COSTE_TEXTE_MAX_COSTE_NN) return $t;
474
		}
479
		}
475
		return FALSE;
480
		return FALSE;
476
	}
481
	}
477
 
482
 
478
	static function getNNBdtfx($refnn) {
483
	static function getNNBdtfx($refnn) {
479
		if(strpos($refnn, 'bdtfx.nn:') !== 0) return FALSE;
484
		if(strpos($refnn, 'bdtfx.nn:') !== 0) return FALSE;
480
		$t = intval(str_replace('bdtfx.nn:', '', $refnn));
485
		$t = intval(str_replace('bdtfx.nn:', '', $refnn));
481
		if($t >= 1 && $t < _COSTE_TEXTE_MAX_BDTFX_NN) return $t;
486
		if($t >= 1 && $t < _COSTE_TEXTE_MAX_BDTFX_NN) return $t;
482
		return FALSE;
487
		return FALSE;
483
	}
488
	}
484
}
489
}