<?php
/**
* Description :
* Classe Ontologies.php fournit des informations sur ensemble structuré des termes et concepts représentant les éléments
* d'un domaine de connaissances .
* Le but étant de fournir un ensemble minimal d'information comprenant :
* un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une description et
* éventuellement une relation hiérarchique avec un autre terme (=classe).
* Si l'url finit par /ontologies on retourne une liste de termes (seulement les 100 premières par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /ontologies?param1=val1&param2=val2&...
*
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.description , recherche,
* distinct, retour.format, navigation.depart et navigation.limite.
*
* Encodage en entrée : utf8
* Encodage en sortie : utf8
* @package eflore-projets
* @author Jennifer DHÉ <jennifer.dhe@tela-botanica.org>
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
* @version 0.1
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
*/
class Ontologies extends Commun {

	protected $requete_condition = null; //Représente la partie de la requete SQL ajoutant une condition (WHERE ...)
	/** Permet de stocker la requete formulée: /ontologies | /ontologies/#id | /ontologies/#id/champ | /ontologies/#id/relations */
	protected $format_reponse = 'ontologies';
	/**  Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).
	 * Stocke également les valeurs des paramètres navigation.depart et navigation.limite passés dans la requete*/
	protected $limite_requete = array( 'depart' => 0, 'limite' => 100);
	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
	protected $total_resultat;
	protected $retour_format = 'max';

	// beaucoup plus flexible dans le cas de requêtes SQL complexes
	protected $mesChamps = '';
	protected $mesJoinsEtConditions = '';

	public function traiterParametres() {
		if (isset($this->parametres) && !empty($this->parametres)) {
			foreach ($this->parametres as $param => $valeur) {
				switch ($param) {
					case 'masque' 			  :  $this->ajouterLeFiltreMasque('masque', $valeur); 				break;
					case 'masque.code' 		  :  $this->ajouterLeFiltreMasque('code', $valeur); 				break;
					case 'masque.nom' 		  :  $this->ajouterLeFiltreMasque('nom', $valeur); 					break;
					case 'masque.description' :  $this->ajouterLeFiltreMasque('description', $valeur); 			break;
					case 'retour.format' 	  :  $this->retour_format = $valeur;								break;
					case 'retour.champs' 	  :  $this->parametres['retour_champs'] = $valeur;					break;
					case 'navigation.depart'  :  $this->limite_requete['depart'] = $valeur;	  					break;
					case 'navigation.limite'  :  $this->limite_requete['limite'] = $valeur;	  					break;
					case 'recherche' : 																			break;
					case 'version.projet' : 																	break;
					default :
						$e = 'Erreur dans les parametres de recherche de votre requête : </br> Le paramètre " '
							.$param.' " n\'existe pas.';
						$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);						break;
				}
			}
		}
	}

	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
		if ($nom_champ == 'code') {
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
		} else {
			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'floue') {
				if ($nom_champ == 'masque') {
					$this->requete_condition[] = '( code = '.$this->getBdd()->proteger($valeur)
						.' OR ( SOUNDEX(nom) = SOUNDEX(\''.$valeur.'\')'
						.' OR SOUNDEX(REVERSE(nom)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
						.') OR ( SOUNDEX(description) = SOUNDEX(\''.$valeur.'\')'
						.' OR SOUNDEX(REVERSE(description)) = SOUNDEX(REVERSE(\''.$valeur.'\')) ))';
				} else {
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\')))';
				}
			} else {
					if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'etendue') {
					$valeur = str_replace(' ','%', $valeur);
					$valeur .= '%';
				}
				if ($nom_champ == 'masque') {
					$this->requete_condition[] = '(code = '.$this->getBdd()->proteger($valeur)
						.' OR nom LIKE '.$this->getBdd()->proteger($valeur)
						.' OR description LIKE '.$this->getBdd()->proteger($valeur).')';
				} else {
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
				}
			}
		}
	}


	public function traiterRessources() {
		if (isset($this->ressources) && !empty($this->ressources)) {
			if (isset($this->ressources[0]) && !empty($this->ressources[0])) {
				//requete = /ontologies/#id
				$this->traiterRessourceId();
				if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
					//requete = /ontologies/#id/relations
					$this->traiterRessourceRelations();
				}
			}
		}
	}


	public function traiterRessourceId() {
		$this->requete_condition = array();
		//requete : /ontologies/#id (ex : /ontologies/7)
		if (is_numeric($this->ressources[0])) {
			$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]);
			$this->format_reponse .= '/id';
		//requete : /ontologies/#classe:#code (ex : /ontologies/rangTaxo:290)
		} elseif (strrpos($this->ressources[0], ':') !== false) {
			// plusieurs couples #classe:#code séparés par des virgules
			if(strrpos($this->ressources[0], ',') !== false) {
				$this->traiterMultipleRessourceId();
				return;
			}

			// ou un unique couple #classe:#code
			$this->format_reponse .= '/id';
			preg_match('/^([^:]+):([^:]+)$/', $this->ressources[0], $match);
			$this->requete_condition[] =
				' id IN (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[2])
				.' AND classe_id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[1]).'))';
			// TODO: optimiser, à voir: traiterMultipleRessourceId() ci-dessous
			// SELECT a.*
			// FROM $this->table a 
			// LEFT JOIN $this->table b ON a.id = b.id LEFT JOIN $this->table c ON b.classe_id = c.id
			// WHERE b.code = $this->getBdd()->proteger($match[2])
			// AND c.code = $this->getBdd()->proteger($match[1]);
		} else {
			$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le paramètre " '
				.$this->ressources[0].' " n\'existe pas.';
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
		}
	}

	// Requète : /ontologies/#classe:#code,[...] (ex : /ontologies/numStatus:2,numStatus:3,genreNombre:10)
	public function traiterMultipleRessourceId() {
		$this->format_reponse .= '/ids'; // noter le "s"
		$this->mesChamps = Array(
			// 'a.*' // pourquoi pas, mais alors des unset() seront nécessaire
			'a.id',
			'a.classe_id AS `classe.id`',
			'a.nom',
			'a.description',
			'a.code',
			'a.complements',
			'c.nom AS classe', // évite très simplement (un très couteux) ajouterClasseCorrespondante()
			'concat(c.code,":", b.code) AS requete'); // permet aux appelants de récupérer la valeur qu'ils recherchent
		$this->mesChamps = implode(', ', $this->mesChamps);

		$this->mesJoinsEtConditions =
			// alias de la table première
			" a "
			. " LEFT JOIN {$this->table} b ON a.id = b.id LEFT JOIN {$this->table} c ON b.classe_id = c.id"
			. " WHERE ";

		$or_stack = false;
		$tab = explode(',', $this->ressources[0]);
		foreach($tab as $couple) {
			preg_match('/^([^:]+):([^:]+)$/', $couple, $match);
			if($or_stack) {
				// une fois qu'un set de condition et présent,
				// les autres sont `OR`-ed.
				$this->mesJoinsEtConditions .= " OR ";
			}
			$this->mesJoinsEtConditions .=
				sprintf("(b.code = %s AND c.code = %s)",
						$this->getBdd()->proteger($match[2]),
						$this->getBdd()->proteger($match[1]));
			$or_stack = true;
		}
	}

	public function traiterRessourceRelations() {
		//requete = /ontologies/#id/relations :
		if ($this->ressources[1] == 'relations') {
			$this->format_reponse .= '/relations';
			$this->requete_condition = array('classe_id = (SELECT classe_id FROM '.$this->table.' WHERE '
										.implode(' AND ', $this->requete_condition).')');
		}
	}

	//+--------------------------FONCTION ASSEMBLAGE DE LA REQUETE-------------------------------------------+

	public function assemblerLaRequete() {
		$requete = 	' SELECT '.$this->formerRequeteChamp().
						' FROM '.$this->table
							.$this->retournerRequeteCondition()
							.$this->formerRequeteLimite(); //print_r($requete);
		return $requete;
	}

	public  function formerRequeteChamp() {
		if($this->mesChamps) return $this->mesChamps;

		$champ[] = 'id';
		if ($this->format_reponse == 'ontologies') {
				$champ[] = 'nom, code ';
		}
		if (isset($this->parametres['retour_champs']) || $this->format_reponse == 'ontologies/id/champs') {
			$champs_recherches = explode(',', $this->parametres['retour_champs']);
			$champs_possibles = $this->rechercherChampsPossibles();
			foreach ($champs_recherches as $champ_recherche) {
				if ($this->verifierValiditeChamp($champ_recherche, $champs_possibles)) {
					$champ[] = (preg_match('/classe/', $champ_recherche)) ? 'classe_id' : $champ_recherche;
				}
			}
		}
		if (count($champ) == 1) {
			$champ = array(' * ');
		}
		return implode(', ', $champ);
	}

	public function rechercherChampsPossibles() {
		$this->recupererNomChamp($this->table);
		$champs_possibles = $this->champs_table;
		$champs_possibles[] = 'classe.id';
		$champs_possibles[] = 'classe';
		$champs_possibles[] = 'classe.href';
		return $champs_possibles;
	}

	public function verifierValiditeChamp($champ, $champs_possibles) {
		$validite = false;
		preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
		if (in_array($match[1], $champs_possibles)) {
			$validite = true;
		} else {
			$champs = implode('</li><li>', $champs_possibles);
			$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;
	}

	public  function retournerRequeteCondition() {
		if($this->mesJoinsEtConditions) return $this->mesJoinsEtConditions;

		$condition = '';
		if ($this->requete_condition !== null) {
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
		}
		return $condition;
	}

	public function formerRequeteLimite() {
		$this->total_resultat = $this->recupererTotalResultat();
		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->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'];
		}
		return $this->requete_limite;
	}


	public function recupererTotalResultat() {
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /ontologies)
		$requete = 'SELECT count(*) as nombre FROM '
			.$this->table
			.$this->retournerRequeteCondition();
		$res = $this->getBdd()->recuperer($requete);
		if ($res) {
			$total = $res['nombre'];
		} else {
			$e = 'Données introuvables dans la base';
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
			Debug::printr($requete);
		}
		return $total;
	}

	//+------------------------------------------------------------------------------------------------------+
	public function retournerResultatFormate($resultat) {
		// determine en fct du service appelé (/ontologies | /ontologies/#id | /ontologies/#id/champ |
		// /ontologies/#id/relations) le format du tableau à retourner. Encode en json
		switch ($this->format_reponse) {
			case 'ontologies' 				: $reponse = $this->formaterOntologies($resultat); 			 break;
			case 'ontologies/id' 			: $reponse = $this->formaterOntologiesId($resultat[0]); 	 break;
			case 'ontologies/ids' 			: $reponse = $this->formaterMultipleOntologiesId($resultat);	break;
			case 'ontologies/id/relations' 	: $reponse = $this->formaterOntologiesIdRelations($resultat); break;
			default : break;
		}
		return $reponse;
	}


	public function formaterOntologies($resultat) {
		$this->ajouterEnteteResultat($resultat);
		$table_retour_json['entete'] = $this->ajouterEnteteResultat($resultat);
		if (isset($this->parametres['masque_code']) || isset($this->parametres['masque'])) {
			$resultat = $this->trierRechercheFloue($this->parametres['masque_code'], $resultat, 'code');
		} elseif (isset($this->parametres['masque_nom'])) {
			$resultat = $this->trierRechercheFloue($this->parametres['masque_nom'], $resultat, 'nom');
		} elseif (isset($this->parametres['masque_description'])) {
			$resultat = $this->trierRechercheFloue($this->parametres['masque_description'], $resultat, 'description');
		}
		//on remplit la table $table_retour_json['resultat']
		foreach ($resultat as $tab) {
			$num = $tab['id'];
			unset($tab['id']);
			foreach ($tab as $param => $valeur) {
				$resultat_json[$num][$param] = $valeur;
			}
			if ($this->retour_format == 'max') $resultat_json[$num]['href'] = $this->ajouterHref('ontologies', $num);
		}
		$table_retour_json['resultat'] = $resultat_json;
		return $table_retour_json;
	}

	public function ajouterEnteteResultat($resultat) {
		//on remplit la table $table_retour_json['entete']
		$entete['depart'] = $this->limite_requete['depart'];
		$entete['limite'] = $this->limite_requete['limite'];
		$entete['total']  = $this->total_resultat;
		//formuler les urls
		$url = $this->formulerUrl($this->total_resultat, '/ontologies');
		if (isset($url['precedent']) && $url['precedent'] != '') { $entete['href.precedent'] = $url['precedent']; }
		if (isset($url['suivant']) && $url['suivant'] != '') { $entete['href.suivant']   = $url['suivant']; }
		return $entete;
	}

	public function __anonyme1($val) { return $val != ''; }

	public function formaterOntologiesId($resultat) {
		$table_retour = array_filter($resultat, array($this, '__anonyme1'));
		$this->calculerClassID($table_retour);
		return $table_retour;
	}

	public function formaterMultipleOntologiesId($resultats) {
		$result = Array();
		foreach($resultats as $k => $resultat) {
			$id = $resultat['requete'];
			$result[$id] = array_filter($resultat, array($this, '__anonyme1'));
			unset($result[$id]['requete']);
			$this->calculerClassID($result[$id]);
		}
		return $result;
	}

	public function calculerClassID(&$resultat) {
		// commenté: pourquoi restreindre le choix des champs au format "max",
		// ça ne semble pas logique...
		// if ($this->retour_format != 'max') return;

 		// question: pourquoi ne pas passer les infos relatives aux ontologies 0 ?
		// et que signifie ce commentaire: "pas de parent"
		if (@$resultat['classe_id'] == '0') return;

		$valeur = isset($resultat['classe_id']) ? $resultat['classe_id'] : $resultat['classe.id'];
		if(! isset($resultat['classe.id'])) {
			$resultat['classe.id'] = $resultat['classe_id'];
			unset($resultat['classe_id']);
		}

		// max-format et pas de champs spécifiques demandés ?
		// Alors on rempli "classe" et "classe.href"
		// Mais ne pas recalculer (surtout la classe) si ce n'est pas nécessaire
		// (c'est le cas si l'on a demandé plusieurs critère [provenons de formaterMultipleOntologiesId()])
		if (! isset($this->parametres['retour_champs'])) {
			if(! isset($resultat['classe'])) {
				$nom_classe = $this->ajouterClasseCorrespondante($valeur);
				if (isset($nom_classe)) $resultat['classe'] = $nom_classe;
			}
			if(! isset($resultat['classe.href'])) {
				$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
			}
			return;
		}

		// cas où des champs sont demandés
		$champs = explode(',', $this->parametres['retour_champs']);
		if(in_array('classe', $champs) && ! isset($resultat['classe'])) {
			$this->ajouterClasseCorrespondante($valeur);
		}

		if(in_array('classe.id', $champs) && ! isset($resultat['classe.id'])) {
			$resultat['classe.id'] = $valeur;
		}

		if(in_array('classe.href', $champs) && ! isset($resultat['classe.href'])) {
			$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
		}

		if(in_array('classe.*', $champs) && (! isset($resultat['classe.href']) || ! isset($resultat['classe.id']))) {
			$resultat['classe.id'] = $valeur;
			$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
		}
	}

	/** Recherche par interrogation de la base, le nom de la classe à partir de son identifiant (classe.id)  */
	public function ajouterClasseCorrespondante($classe_id) {
		$nom = null;
		if ($classe_id != 0) {
			$nom = '';
			$req = 'SELECT nom FROM '.$this->table.' WHERE id = '.$this->getBdd()->proteger($classe_id);
			$res = $this->getBdd()->recuperer($req);
			if ($res) {
				$nom = $res['nom'];
			} else {
				$e = "Données introuvables dans la table $this->table";
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
				Debug::printr($req);
			}
		}
		return $nom;
	}

	public function formaterOntologiesIdRelations($resultat) {
		$retour = null;
		if ($resultat != '') {
			$retour['entete'] = $this->ajouterEnteteResultat($resultat);
			//on remplit la table $table_retour_json['resultat']
			foreach ($resultat as $tab) {
				$num = $tab['id'];
				$retour['resultat'][$num]['nom'] = $tab['nom'];
				if ($this->retour_format == 'max') {
					$retour['resultat'][$num]['href'] = $this->ajouterHref('ontologies', $num);
				}
			}
		}
		return $retour;
	}
}
?>