/*
    * This file is part of NetPisteur.
    * 
    * Copyright 2001-2002 : Olivier CORNEC, David BOUANCHEAU, Loic LOPEZ,
    *                       Gaetan BOUDARD, Mael LE LANNOU, Julien ROBINEAU
    * 
    * Copyright 2002-2003 : Olivier BRIENS, Simon DEZE, Florence FRIGOULT,
    *                       Olivier JOURNEAULT, Francois MARTINIER, Damien RAUDE-MORVAN
    * 
   * Copyright 2004-2007 : Damien RAUDE-MORVAN
   * 
   * NetPisteur is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation; either version 2 of the License, or
   * (at your option) any later version.
   *
   * NetPisteur is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with NetPisteur; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   *
   */
  package com.drazzib.netpisteur.loader;
  
  import java.io.BufferedReader;
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.InputStreamReader;
  import java.net.HttpURLConnection;
  import java.net.URL;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   * <P>
   * <STRONG>Description </STRONG>
   * <P>
   * Manage the connection with a server and get the content of the Url with the
   * method getObject
   * 
   * @see com.drazzib.netpisteur.loader.Connexion
   * @version 1.0
   * @since 2002/03/18
   * @author NetPisteur Team
   */
  
  public class ConnexionHttp extends Connexion {
  	
  	private static Log log = LogFactory.getLog(ConnexionHttp.class);
  
  	// /////////////////////////////////////
  	// attributes
  
  	/**
  	 * Represents the Http connection
  	 */
  	private HttpURLConnection connexionHttp;
  
  	private String messageErreur;
  
  	private boolean connecte;
  
  	// /////////////////////////////////////
  	// constants
  
  	/**
  	 * Represents an error code for stream reader
  	 */
  	static final int LECTURE_FLUX_IMPOSSIBLE = 6;
  
  	// /////////////////////////////////////
  	// constructor
  
  	/**
  	 * Creates a ConnexionHttp object using the class httpUrlConnection
  	 * 
  	 * @param uneUrl :
  	 *            uneUrl
  	 * 
  	 */
  	public ConnexionHttp(URL uneUrl) {
  		super(uneUrl);
  		this.connexionHttp = null;
  		this.messageErreur = null;
  		this.connecte = false;
  		HttpURLConnection.setFollowRedirects(true);
  	} // ConnexionHttp()
  
  	// /////////////////////////////////////
  	// Accessors
  
  	/**
  	 * Gets the Url of the connection. This method redifines the Connexion
  	 * getUrl() method by checking if the connection to this Url is possible
 	 * 
 	 * @return URL: url of this connection
 	 */
 	public URL getTheUrl() {
 
 		if (this.connecte) {
 			return this.url;
 
 		}
 		return null;
 
 	} // getTheUrl()
 
 	/**
 	 * Is the connection made ?
 	 * 
 	 * @return boolean : return false is the connection to this url is
 	 *         impossible
 	 */
 	public boolean getConnecte() {
 		return (this.connecte);
 	} // getConnecte()
 
 	/**
 	 * Gives the current error message
 	 * 
 	 * @return String : the current error message
 	 */
 	public String getMessageErreur() {
 		return (this.messageErreur);
 	} // getMessageErreur()
 
 	// /////////////////////////////////////
 	// operations
 
 	/**
 	 * Opens a http connection using a url and checking the errors
 	 * 
 	 * @return boolean : success or failure
 	 */
 	public boolean connexion() {
 
 		int typeErreur;
 		boolean lectureFluxPossible = false;
 		// initialisation du message d'erreur
 		this.messageErreur = null;
 
 		try {
 
 			// affectation de l'url a l'objet HttpURLConnection
 			this.connexionHttp = (HttpURLConnection) (this.url)
 					.openConnection();
 
 			// Permet d'interroger un serveur en simulant un utilisateur car
 			// certains serveurs refusent les connexions etablies par des
 			// programmes
 			this.connexionHttp
 					.setRequestProperty("User-Agent", "Netpisteur v2");
 
 			// Evite l'ouverture de connexion KeepALive
 			// difficiles  grer avec le navigateur
 			this.connexionHttp.setRequestProperty("Connection", "close");
 			this.connexionHttp.setRequestProperty("Proxy-Connection", "close");
 			this.connexionHttp.connect();
 
 			// recuperation des codes d'erreur
 			typeErreur = this.connexionHttp.getResponseCode();
 
 			// analyse des codes d'erreur
 			this.messageErreur = traitementErreur(typeErreur);
 
 			lectureFluxPossible = this.connexionHttp.getDoInput();
 
 			if (!lectureFluxPossible) {
 				this.messageErreur = traitementErreur(LECTURE_FLUX_IMPOSSIBLE);
 			}
 
 		} catch (java.io.IOException exWithOpenConnection) {
 			this.messageErreur = "Connexion a l'url : " + getURL()
 					+ " impossible \n";
 		}
 
 		return this.connecte;
 	} // ----------------------------------------------------connexion()
 
 	/**
 	 * Sends a request to the serveur 1-It deconnects the previous connection
 	 * 2-Gets the last url used in the connectionHttp 3-Builds a new url with
 	 * the parameters to send 4-Opens a new connection with this new url
 	 * 
 	 * @param parametre :
 	 *            the message error of the connection
 	 * @return boolean : success or failure
 	 */
 	public boolean connexionAvecParam(String parametre) {
 
 		String stringRequete;
 		URL hote;
 		URL urlAvecParam;
 		int typeErreur;
 		boolean lectureFluxPossible = false;
 		// initialisation du message d'erreur
 		this.messageErreur = null;
 
 		// Deconnexion
 		this.deconnexion();
 
 		// Recuperation de la derniere url
 		hote = this.connexionHttp.getURL();
 
 		// Ajout des parametres de la requete
 		// stringRequete = ( cheminScript + "?" + param1 + "=" + val1 + "&" +
 		// param2 + "=" + val2 );
 		stringRequete = parametre;
 
 		try {
 			// Connexion
 
 			// nouvelle url avec les parametres
 			urlAvecParam = new URL(hote, stringRequete);
 			this.url = urlAvecParam;
 			this.connexionHttp = (HttpURLConnection) (this.url)
 					.openConnection();
 
 			// Permet d'interroger un serveur en simulant un utilisateur car
 			// certains serveurs refuse les connexion etablies par des
 			// programmes
 			this.connexionHttp.setRequestProperty("User-Agent", "Netpisteurv2");
 			this.connexionHttp.connect();
 
 			// recuperation des codes d'erreurs
 			typeErreur = this.connexionHttp.getResponseCode();
 
 			// analyse des codes d'erreurs si pas d'erreur renvoie true
 			this.messageErreur = traitementErreur(typeErreur);
 
 			lectureFluxPossible = this.connexionHttp.getDoInput();
 
 			if (!lectureFluxPossible) {
 				this.messageErreur = traitementErreur(LECTURE_FLUX_IMPOSSIBLE);
 			}
 
 		} catch (java.io.IOException exWithOpenConnection) {
 			this.messageErreur = "\nConnexion a l'url : " + getURL()
 					+ " impossible \n";
 		}
 
 		return this.connecte;
 	} // ----------------------------------------------------connexionAvecParam()
 
 	/**
 	 * Gets the ressource of an url using the http protocol This ressource is
 	 * stored in a string
 	 * 
 	 * @return String: The ressource of the url
 	 */
 	public String getSourceByString() {
 
 		InputStream fluxEntree = null;
 		InputStreamReader lecteurFlux = null;
 		BufferedReader netIn = null;
 		String reponseServeur = null;
 		String reponseServeurTmp = null;
 
 		try {
 			if (this.connecte) {
 
 				fluxEntree = this.connexionHttp.getInputStream();
 				lecteurFlux = new InputStreamReader(fluxEntree);
 				netIn = new BufferedReader(lecteurFlux);
 				do {
 					reponseServeurTmp = (netIn.readLine());
 					reponseServeur = reponseServeur + reponseServeurTmp;
 				} while (reponseServeurTmp != null);
 			} else {
 				reponseServeur = (this.messageErreur);
 
 			}
 
 		} catch (java.io.IOException exWithGetInputStream) {
 			this.messageErreur = "erreur de lecture de flux d'entree dans ConnexionHttp.getSourceByString()";
 		} finally {
 			try {
 				if (netIn != null)
 				{
 					netIn.close();
 				}
 				if (lecteurFlux != null) {
 					lecteurFlux.close();
 				}
 				if (fluxEntree != null) {
 					fluxEntree.close();
 				}
 			} catch (IOException e) {
 				log.error(e);
 			}
 		}
 
 		return reponseServeur;
 	} // ----------------------------------------------------getSourceByString()
 
 	/**
 	 * Gets the reader of an InputStream using the http protocol This ressource
 	 * is stored in an InputStream object
 	 * 
 	 * @return InputStream : the reader of the url
 	 */
 	public InputStreamReader getSourceByReader() {
 
 		InputStreamReader fluxEntree = null;
 
 		try {
 			if (this.connecte) {
 				fluxEntree = new InputStreamReader(this.connexionHttp
 						.getInputStream());
 				fluxEntree.close();
 			}
 		} catch (java.io.IOException exWithOpenConnection) {
 			this.messageErreur = "erreur de lecture de flux d'entree dans ConnexioHttp.getSourceByReader()";
 		}
 		return fluxEntree;
 	} // ----------------------------------------------------getSourceByReader()
 
 	/**
 	 * Checks the response code from the serveur
 	 * 
 	 * @param unTypeErreur :
 	 *            the code error to study
 	 * @return String : the error message
 	 */
 	public String traitementErreur(int unTypeErreur) {
 
 		String message = null;
 
 		switch (unTypeErreur) {
 
 		case (200):
 			message = "Succs 200. OK. La requte a abouti... ";
 			this.connecte = true;
 			return message;
 
 		case (201):
 			message = "Succs 201. Cr. La requte a abouti et une nouvelle ressource rseau en rsulte... ";
 			this.connecte = true;
 			return message;
 
 		case (202):
 			message = "Succs 202. Accepte. La requte a abouti et est interprte correctement, mais son traitement n'est pas termin... ";
 			this.connecte = true;
 			return message;
 
 		case (204):
 			message = "Succs 204. Pas de contenu. La requte a abouti et le serveur n'a rien retourn en retour... ";
 			this.connecte = true;
 			return message;
 
 		case (300):
 			message = "Erreur 300. Choix multiple. La ressource vise est disponible en un ou plusieurs autres points du rseau... ";
 			this.connecte = true;
 			return message;
 
 		case (301):
 			message = "Erreur 301. Changement d'adresse dfinitive. La ressource demande est dsormais accessible via une autre URL... ";
 			this.connecte = true;
 			return message;
 
 		case (302):
 			message = "Erreur 302. Changement d'adresse temporaire. La ressource demande est actuellement et temporairement accessible via une autre URL... ";
 			this.connecte = true;
 			return message;
 
 		case (304):
 			message = "Erreur 304. Non modifi. La ressource demande n'est pas accessible car elle n'a pas t modifie... ";
 			this.connecte = true;
 			return message;
 
 		case (400):
 			message = "Erreur 400. Requte incorrecte. La requte n'a pas pu tre reconnue par le serveur pour cause d'une syntaxe incorrecte... ";
 			this.connecte = false;
 			return message;
 
 		case (401):
 			message = "Erreur 401. Non autoris. La requte demande ncessite une authentification de la part de l'utilisateur... ";
 			this.connecte = false;
 			return message;
 
 		case (403):
 			message = "Erreur 403. Interdit. Le serveur a compris la requte mais refuse de la satisfaire... ";
 			this.connecte = false;
 			return message;
 
 		case (404):
 			message = "Erreur 404. Non trouv. Le serveur n'a trouv aucune ressource correspondant  l'URL vise... ";
 			this.connecte = false;
 			return message;
 
 		case (500):
 			message = "Erreur 500. Erreur serveur interne. Le serveur a t en prsence d'un vnement inattendu... ";
 			this.connecte = false;
 			return message;
 
 		case (501):
 			message = "Erreur 501. Non implment. Le serveur ne supporte pas les fonctionnalits requises pour satisfaire la requte... ";
 			this.connecte = false;
 			return message;
 
 		case (502):
 			message = "Erreur 502. Erreur de routeur. Le serveur a reu une rponse invalide de la part du serveur amont contact pour satisfaire la requte... ";
 			this.connecte = false;
 			return message;
 
 		case (503):
 
 			message = "Erreur 503. Service indisponible. Le serveur ne peut pas traiter la requte momentanment... ";
 			this.connecte = false;
 			return message;
 
 		case (6):
 
 			message = "Erreur, lecteur de flux impossible, veuillez vrifier vos paramtres de connexion... ";
 			this.connecte = false;
 			return message;
 
 		default:
 
 			message = "Erreur inconnue";
 			this.connecte = false;
 			return message;
 
 		}
 
 	} // ----------------------------------------------------traitementErreur()
 
 	/**
 	 * Closes the connexionHttp
 	 * 
 	 * @return boolean : state of the connection
 	 */
 	public boolean deconnexion() {
 
 		this.connexionHttp.disconnect();
 		this.connecte = false;
 		return this.connecte;
 	} // ---------------deconnexion()
 
 } // -----------------------------------------------------------------------------------fin
 // ConnexionHttp