<?php
/**
 * Le web service image récupère toutes les données de la table del_obs_images
 * pour retourner une liste d'images associée à la détermination la plus probable
 * avec la possibilité de ne renvoyer que les images les mieux notées pour un protocole donné
 *
 * @category	php 5.2
 * @package	del
 * @subpackage images
 * @author		Raphaël Droz <raphael@tela-botanica.org>
 * @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
 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images
 */

class ListeImagesDeterminationsProbables {
	
	private $indexImagesIds = array();
	private $conteneur;
	private $navigation;
	private $masque;
	private $gestionBdd;
	private $bdd;
	private $parametres = array();
	private $ressources = array();
	private $tri = 'date_transmission';
	private $directionTri = 'desc';
	private $protocole_defaut = null;
	private $valeur_vote_min_defaut = null;
	
	public function __construct(Conteneur $conteneur = null) {
		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
		$this->conteneur->chargerConfiguration('config_determinations.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) {
		// initialiserRessourcesEtParametres()
		$this->ressources = $ressources;
		$this->parametres = $parametres;
		
		if(!isset($parametres['masque.protocole'])) {
			$this->parametres['masque.protocole'] = $this->protocole_defaut;
		}
		if(!isset($parametres['masque.valeur_vote_min'])) {
			$this->parametres['masque.valeur_vote_min'] = $this->valeur_vote_min_defaut;
		}
		
		// Gestion des configuration du script
		// configurer();
		$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
		$this->mappingObservation = $this->conteneur->getParametre('mapping_observation');
		$this->mappingVotes = $this->conteneur->getParametre('mapping_votes');
        
        // verifierConfiguration()
        if(! $this->conteneur->getParametre('protocoles_possibles')) {
			throw new Exception("Erreur lors de la configuration : \n- le fichier de configuration ne contient pas le parametre protocoles_possibles ou celui-ci est vide ;", RestServeur::HTTP_CODE_ERREUR);
		}

		$this->verifierParametres();
		
		// initialiserTri()
		$this->tri = isset($this->parametres['tri']) ? $this->parametres['tri'] : $this->tri;
		$this->directionTri = isset($this->parametres['ordre']) ? $this->parametres['ordre'] : $this->directionTri;

		
		// Lancement du service
		$liaisons = $this->chargerLiaisons();
        $images = array();
		$total = 0;

		if($liaisons) {
            $compte = $this->bdd->recuperer('SELECT FOUND_ROWS() AS nbre');
            $total = (int) $compte['nbre'];

			$images = $this->chargerImage($liaisons);
			$images = $this->chargerPropositionPlusProbable($images);
		}
		
		$this->navigation->setTotal($total);
		
		// Mettre en forme le résultat et l'envoyer pour affichage
		$resultat = new ResultatService();
		$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $images);
		
		return $resultat;
	}
	
	private function verifierParametres() {		
		$erreurs = array();
		$tableau_protocoles = explode(',',$this->conteneur->getParametre('protocoles_possibles'));

		if(isset($this->parametres['masque.protocole']) && 
			(!is_numeric($this->parametres['masque.protocole']) || 
			 !in_array($this->parametres['masque.protocole'], $tableau_protocoles)
			)) {
			$erreurs[] = '- la valeur pour le protocole doit être un entier compris dans les numéros de protocole existants '.$this->conteneur->getParametre('protocoles_possibles');
		}
		
		if(isset($this->parametres['masque.valeur_min_vote']) &&
				 (!is_numeric($this->parametres['masque.valeur_min_vote']) ||
				  $this->parametres['masque.valeur_min_vote'] < 0 ||
				  $this->parametres['masque.valeur_min_vote'] > 5
				 )) {
			$erreurs[] = '- la valeur minimum de valeur des votes doit être un entier compris entre 0 et 5 ';
		}
		 
		if (!empty($erreurs)) {
			throw new Exception("Erreur lors de l\'analyse des parametres du service : \n" . implode("\n", $erreurs), RestServeur::HTTP_CODE_ERREUR);
		}
	}
	
	/*-------------------------------------------------------------------------------
								CHARGEMENT DES IMAGES 
	--------------------------------------------------------------------------------*/
	private function chargerLiaisons() {
		$champs = array('di.id_observation as id_observation', 'nom_referentiel', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'ce_zone_geo', 'zone_geo', 
						'lieudit', 'station', 'milieu', 'date_observation', 'di.mots_cles_texte as mots_cles_texte', 'di.commentaire as commentaire', 
						'di.i_mots_cles_texte AS mots_cles_texte_image ', 'date_transmission', 'di.id_image as id_image', 'di.ce_utilisateur as ce_utilisateur', 
						'prenom', 'nom', 'courriel', 'di.nom_utilisateur', 'di.prenom_utilisateur', 'di.courriel_utilisateur', 'nom_original');
		
        $where = array();
        if(@$this->parametres['masque.protocole']) $where[] = 'ds.ce_protocole = ' . intval($this->parametres['masque.protocole']);
        if(@intval($this->parametres['masque.valeur_vote_min'])) $where[] = 'moyenne >= ' . intval($this->parametres['masque.valeur_vote_min']);

        $limite = @min(intval($this->parametres['navigation.limite']), 1000);
        $limite = $limite ? $limite : 10; // 0 => 10

		$requeteLiaisons = sprintf(
            'SELECT SQL_CALC_FOUND_ROWS %s ce_protocole, moyenne, nb_votes, nb_tags'
            // IF(LENGTH()) workaround pour la jointure sur tela_annuaire depuis un hash md5 casté
            . ' FROM v_del_image di LEFT JOIN del_utilisateur du ON du.id_utilisateur = IF(LENGTH(di.ce_utilisateur) > 5, 0, di.ce_utilisateur)'
            . ' LEFT JOIN del_image_stat ds ON di.id_image = ds.ce_image'
            . ' WHERE %s GROUP BY id_image /* car plusieurs image pour obs, see PHP */ ORDER BY moyenne LIMIT %d, %d -- %s:%d',

            implode(', ',$champs),
            implode(' AND ', $where),
            intval(@$this->parametres['navigation.depart']),
            $limite,
            __FILE__, __LINE__);

        // GROUP BY (très couteux) car multiples observations associées à une image
        // eg: 16150,16185,16245,16246,118995,129989

		return $this->bdd->recupererTous($requeteLiaisons);
	}
	
	/**
	* Retourner un tableau d'images formaté en fonction des liaisons trouvées
	* @param $liaisons les liaisons de la table del_obs_images
	* */
	private function chargerImage($liaisons) {
		
		$images = array();
		foreach ($liaisons as $liaison) {
			
			if($liaison['ce_utilisateur'] == 0) {
				$liaison['prenom'] = $liaison['prenom_utilisateur'];
				$liaison['nom'] = $liaison['nom_utilisateur'];
			}
			
			$idObs = $liaison['id_observation'];
			$idImage = $liaison['id_image'];
			// On enregistre l'ID de l'obs pour n'effectuer qu'une seule requête par la suite
			$this->obsIds[] = $idObs;
			$index = $liaison['id_image'].'-'.$liaison['id_observation'];
			$this->indexImagesIds[$idImage] = $index;
			$images[$index] = array(
						'id_image' => $idImage, 
						'id_observation' => $idObs,
						'auteur.intitule' => $liaison['prenom'].' '.$liaison['nom'],
						'binaire.href' => sprintf($this->conteneur->getParametre('url_images'), $idImage),
						'determination.famille' => $liaison['famille'],
						'determination.referentiel' => $liaison['nom_referentiel'],
						'determination.ns' => $liaison['nom_ret'],
						'determination.nn' => $liaison['nom_ret_nn'],
						'determination.nt' => $liaison['nt'],
						'date_observation' => $liaison['date_observation'],
						'localite' => $this->formaterLieu($liaison),
						'mots_cles_image_cel' => $this->formaterMotsClesCel($liaison['mots_cles_texte_image']),
						'mots_cles_image_del' => ""
			);
		}
		return $images;
	}
	
	/**
     * Charger les votes pour chaque image
     **/
	private function chargerPropositionPlusProbable($images) {
			$resultatsPropositions = $this->bdd->recupererTous(sprintf(
                'SELECT * FROM del_commentaire WHERE ce_observation IN (%s) AND nom_sel IS NOT NULL',
                implode(',', $this->obsIds)));

			$resultatsVotes = $this->bdd->recupererTous(sprintf(
                'SELECT ce_proposition, valeur, ce_utilisateur FROM del_commentaire_vote WHERE ce_proposition IN'.
                ' ( SELECT id_commentaire FROM del_commentaire WHERE ce_observation IN (%s) AND nom_sel IS NOT NULL )'.
                ' ORDER BY ce_proposition',
                implode(',', $this->obsIds)));

			$resultatsMotsCles = $this->bdd->recupererTous(sprintf(
                'SELECT tag, ce_image FROM del_image_tag WHERE ce_image IN (%s) AND actif = 1',
                implode(',', array_keys($this->indexImagesIds))));

			
			$propositions = array();
			$votes = array();
			
			foreach($resultatsVotes as $vote) {
				if(!isset($votes[$vote['ce_proposition']])) {
					$votes[$vote['ce_proposition']] = 0;
				}
				$valeur = ($vote['valeur'] == 1) ? 1 : -1;
				$votes[$vote['ce_proposition']] += is_numeric($vote['ce_utilisateur']) ? 3*$valeur : $valeur;
			}
						
			foreach($resultatsPropositions as $proposition) {
				$id_proposition = $proposition['id_commentaire'];
				$id_obs = $proposition['ce_observation'];
				
				if(isset($votes[$id_proposition])) {
					$score = $votes[$id_proposition];
				} else {
					$score = -1;
				}
								
				$proposition['valeur'] = $score;
				if(!isset($propositions[$id_obs])) {
					$propositions[$id_obs] = $proposition;
				} else {
					$score_ancienne_proposition = $propositions[$id_obs]['valeur'];
					$propositions[$id_obs] = ($score >= $score_ancienne_proposition) ? 
													$proposition : $propositions[$id_obs];
				}
			}
			
			foreach ($resultatsMotsCles as $motCle) {
				$tag = $motCle['tag'];
				$index = $this->indexImagesIds[$motCle['ce_image']];
				if($images[$index]['mots_cles_image_del'] != "") {
					$tag = ",".$tag;
				}
				$images[$index]['mots_cles_image_del'] .= $tag ;
			}

			foreach ($images as $id => $image) {
				if ($this->doitRemplacerObservationParProposition($propositions, $image)) {					
					$id_obs = $image['id_observation'];
					$images[$id]['determination.famille'] = $propositions[$id_obs]['famille'];
					$images[$id]['determination.ns'] = $propositions[$id_obs]['nom_sel'];
					$images[$id]['determination.nn'] = $propositions[$id_obs]['nom_sel_nn'];
					$images[$id]['determination.nt'] = $propositions[$id_obs]['nt'];
				}
				
				if(isset($images[$id]['determination.nn'])) {
					$images[$id]['url_fiche_eflore'] = sprintf($this->conteneur->getParametre('url_fiche_eflore'), $images[$id]['determination.nn']); // formaterUrlFicheEflore
				}
			}
		
		return $images;
	}
	
	private function doitRemplacerObservationParProposition($propositions, $image) {			
		return ((isset($propositions[$image['id_observation']]) && 
			$propositions[$image['id_observation']] != null &&
			$propositions[$image['id_observation']]['nom_sel_nn'] != 0) && 
			($propositions[$image['id_observation']]['valeur'] > 0 ||
			$image['determination.nn'] == 0)
		);
	}
	
	/*-------------------------------------------------------------------------------
								FORMATER ET METTRE EN FORME
	--------------------------------------------------------------------------------*/
	/**
	*  Formater les mots clés du cel en n'affichant que ceux faisant partie
	*  d'une liste définie dans le fichier de configuration
	*  @param $chaineMotCleCel la chaine de mots clés du cel
	*  @return string la chaine filtrée
	* */
	private function formaterMotsClesCel($chaineMotCleCel) {
		return implode(',', array_intersect(
            explode(',', $this->conteneur->getParametre('mots_cles_cel_affiches')), // $tabMotsClesAffiches
            explode(',', $chaineMotCleCel))); // $tabMotsClesCel
	}
	

	private function formaterLieu($image) {
		if(! $image['ce_zone_geo']) return '';

		$lieu = $image['zone_geo'];
        $id_zone_geo = $image['ce_zone_geo'];
        if(strpos($image['ce_zone_geo'], 'INSEE-C:') === 0) {
            $id_zone_geo = str_replace('INSEE-C:', '', $image['ce_zone_geo']);
            $id_zone_geo = strlen($id_zone_geo) >= 5 ? substr($id_zone_geo, 0, 2) : $id_zone_geo;
        }
				
        return $lieu . ' ('.$id_zone_geo.')';
	}
}