Subversion Repositories eFlore/Applications.del

<?php

/**

 * @author		Raphaël Droz <raphael@tela-botanica.org>

 * @copyright	Copyright (c) 2013, 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

 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images

 * @see http://www.tela-botanica.org/wikini/identiplante/wakka.php?wiki=IdentiPlante_PictoFlora_MoteurRecherche

 *

 * Backend pour PictoFlora (del.html#page_recherche_images)

 *

 *

 * == Notes ==

 *

 * tri=votes et tri=tags: affectent le choix des images affichées (donc getIdImages())

 * Cependant ce total ne nous intéresse même pas (MoyenneVotePresenteur.java s'en occupe).

 * Seul tri=date_transmission nous évite l'AVG() + GROUP BY

 *

 * protocole: il affecte l'affichage des information, mais le JSON contient déjà

 * l'intégralité (chercher les données de vote pour 1 ou plusieurs protocoles) est quasi-identique.

 * Par contre, le tri par moyenne des votes, sous-entend "pour un protocole donné".

 * Dès lors le choix d'un protocole doit avoir été fait afin de régler le JOIN et ainsi l'ORDER BY.

 * (cf requestFilterParams())

 *

 * Histoire: auparavant (pré-r142x) un AVG + GROUP BY étaient utilisés pour générer on-the-fly les valeurs

 * utilisées ensuite pour l'ORDER BY. La situation à base de del_image_stat

 * est déjà bien meilleure sans être pour autant optimale. cf commentaire de sqlAddConstraint()

 *

 *

 * Tags:

 * Le comportement habituel dans le masque *général*: les mots sont séparés par des espaces,

 * implod()ed par des AND (tous les mots doivent matcher).

 * Et le test effectué doit matcher sur:

 * %(les tags d'observations)% *OU* %(les tags d'images)% *OU* %(les tags publics)%

 *

 * Le comportement habituel dans le masque *tag*: les mots ne sont *pas* splittés (1 seule expression),

 * Et le test effectué doit matcher sur:

 * ^(expression)% *OU* %(expression)% [cf getConditionsImages()]

 *

 * Par défaut les tags sont comma-separated (OU logique).

 * Cependant pour conserver le comportement du masque général qui sous-entend un ET logique sur

 * des tags séparés par des espaces recherche

 *

 * TODO:

 * -affiner la gestion de passage de mots-clefs dans le masque général.

 * - subqueries dans le FROM pour les critère WHERE portant directement sur v_del_image

 * plutôt que dans WHERE (qui nécessite dès lors un FULL-JOIN)

 * (http://www.mysqlperformanceblog.com/2007/04/06/using-delayed-join-to-optimize-count-and-limit-queries/)

 * - éviter de dépendre d'une jointure systématique sur `cel_obs`, uniquement pour `(date_)transmission

 * (cf VIEW del_image)

 * - poursuivre la réorganisation des méthodes statiques parmis Observation, ListeObservations et ListeImages2

 * - *peut-être*: passer requestFilterParams() en méthode de classe

 *

 *

 * MySQL sux:

 * EXPLAIN SELECT  id_image FROM v_del_image vdi WHERE vdi.id_image IN (SELECT ce_image FROM del_image_tag WHERE actif = 1 LIMIT 1);

 *	MySQL doesn't yet support 'LIMIT & IN/ALL/ANY/SOME subquery

 * EXPLAIN SELECT * FROM del_image WHERE id_image IN (SELECT 3);

 *	PRIMARY

 * EXPLAIN SELECT * FROM del_image WHERE id_image IN (SELECT MIN(3));

 *	DEPENDENT SUBQUERY ... ... ... mwarf !

 * EXPLAIN SELECT  id_image FROM v_del_image vdi WHERE vdi.id_image IN (SELECT ce_image FROM del_image_tag WHERE actif = 1);

 *	5.5: MATERIALIZED		del_image_tag	ALL				ce_image NULL NULL NULL 38276 Using where

 *	5.1: DEPENDENT SUBQUERY	del_image_tag	index_subquery	ce_image ce_image 8 func 1 Using where

 * FORCE INDEX/IGNORE INDEX semble incapable de résoudre le problème de l'optimiseur MySQL

 *

 */

require_once(dirname(__FILE__) . '/../DelTk.php');

require_once(dirname(__FILE__) . '/../observations/Observation.php');

restore_error_handler();

restore_exception_handler();

error_reporting(E_ALL);

// del/services/0.1/images?navigation.depart=0&navigation.limite=12&tri=votes&ordre=desc

// del/services/0.1/images?navigation.depart=0&navigation.limite=12&tri=votes&ordre=desc&masque=plop

// del/services/0.1/images?navigation.depart=0&navigation.limite=12&tri=votes&ordre=desc&protocole=3

// del/services/0.1/images?navigation.depart=0&navigation.limite=12&tri=votes&ordre=desc&protocole=3&masque=plop

class ListeImages {

    // TODO: PHP-x.y, ces variables devrait être des "const"

    static $format_image_possible = array('O','CRX2S','CRS','CXS','CS','XS','S','M','L','XL','X2L','X3L');

    static $tri_possible = array('date_transmission', 'date_observation', 'votes', 'tags', 'points');

    // en plus de ceux dans DelTk

    static $parametres_autorises = array('protocole', 'masque.tag_cel', 'masque.tag_pictoflora', 'masque.milieu');

    static $default_params = array('navigation.depart' => 0, 'navigation.limite' => 10,

				   'tri' => 'date_transmission', 'ordre' => 'desc',

				   // spécifiques à PictoFlora:

				   'format' => 'XL');

    static $default_proto = 3; // proto par défaut: capitalisation d'img (utilisé uniquement pour tri=(tags|votes|points))

    static $mappings = array(

	'observations' => array( // v_del_image

	    "id_observation" => 1,

	    "date_observation" => 1,

	    "date_transmission" => 1,

	    "famille" => "determination.famille",

	    "nom_sel" => "determination.ns",

	    "nom_sel_nn" => "determination.nn",

	    "nom_referentiel" => "determination.referentiel",

	    "nt" => "determination.nt",

	    "ce_zone_geo" => "id_zone_geo",

	    "zone_geo" => 1,

	    "lieudit" => 1,

	    "station" => 1,

	    "milieu" => 1,

	    "mots_cles_texte" => "mots_cles_texte",

	    "commentaire" => 1,

	    "ce_utilisateur" => "auteur.id",

	    "nom_utilisateur" => "auteur.nom",

	    "prenom_utilisateur" => "auteur.prenom",

	),

	'images' => array( // v_del_image

	    'id_image' => 1,

	    // l'alias suivant est particulier: in-fine il doit s'appeler mots_cles_texte

	    // mais nous afin d'éviter un conflit d'alias nous le renommons plus tard (reformateImagesDoubleIndex)

	    'i_mots_cles_texte' => 1

	));

    public function __construct(Conteneur $conteneur = null) {

		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;

		$this->conteneur->chargerConfiguration('config_images.ini');

		$this->gestionBdd = $conteneur->getGestionBdd();

		$this->bdd = $this->gestionBdd->getBdd();

    }

    public function consulter($ressources, $parametres) {

	/* Certes nous sélectionnons ici (nom|prenom|courriel)_utilisateur de cel_obs, mais il ne nous intéressent pas

	   Par contre, ci-dessous nous prenons i_(nom|prenom|courriel)_utilisateur.

	   Notons cependant qu'aucun moyen ne devrait permettre que i_*_utilisateur != *_utilisateur

	   Le propriétaire d'une obs et de l'image associée est *toujours* le même. */

	array_walk(self::$mappings['observations'], create_function('&$val, $k', 'if($val==1) $val = $k;'));

	array_walk(self::$mappings['images'], create_function('&$val, $k', 'if($val==1) $val = $k;'));

	// pour les votes, les mappings de "Observation" nous suffisent

	array_walk(Observation::$mappings['votes'], create_function('&$val, $k', 'if($val==1) $val = $k;'));

	// la nécessité du 'groupby' dépend des 'join's utilisés (LEFT ou INNER) ainsi que de la cardinalité

	// de `ce_image` dans ces tables jointes.

	// Contrairement à IdentiPlantes, nous n'avons de HAVING pour PictoFlora, mais par contre un ORDER BY

	$req = array('select' => array(), 'join' => array(), 'where' => array(), 'groupby' => array(), 'orderby' => array());

	$db = $this->bdd;

	// filtrage de l'INPUT général, on réutilise 90% de identiplante en terme de paramètres autorisés

	// ($parametres_autorises) sauf... masque.type qui fait des modif' de WHERE sur les mots-clefs.

	// Évitons ce genre de chose pour PictoFlora et les risques de conflits avec masque.tag

	// même si ceux-ci sont improbables (pas d'<input> pour cela).

	$params_ip = DelTk::requestFilterParams($parametres,

						array_diff(DelTk::$parametres_autorises,

							   array('masque.type')),

						$this->conteneur);

	// notre propre filtrage sur l'INPUT

	$params_pf = self::requestFilterParams($parametres,

					       array_merge(DelTk::$parametres_autorises,

							   self::$parametres_autorises));

	/* filtrage des tags + sémantique des valeurs multiples:

	   Lorsqu'on utilise masque.tag* pour chercher des tags, ils sont

	   postulés comme séparés par des virgule, et l'un au moins des tags doit matcher. */

	$params_pf['masque.tag_cel'] = DelTk::buildTagsAST(@$parametres['masque.tag_cel'], 'OR', ',');

	if(!isset($parametres['masque.tag_pictoflora']) && isset($parametres['masque.tag'])) {

		$parametres['masque.tag_pictoflora'] = $parametres['masque.tag'];

	}

	$params_pf['masque.tag_pictoflora'] = DelTk::buildTagsAST(@$parametres['masque.tag_pictoflora'], 'OR', ',');

	$params = array_merge(

            DelTk::$default_params, // paramètre par défaut Identiplante

            self::$default_params, // paramètres par défaut PictoFlora

            $params_ip, // les paramètres passés, traités par Identiplante