source: extensions/jiwigo/trunk/src/main/java/fr/mael/jiwigo/transverse/util/Outil.java @ 6821

package fr.mael.jiwigo.transverse.util;

import java.io.BufferedInputStream;
import java.io.DataInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.MessageDigest;

import org.jdom.Document;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.jdom.output.XMLOutputter;

/**
   Copyright (c) 2010, Mael
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of jiwigo nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   DISCLAIMED. IN NO EVENT SHALL Mael BE LIABLE FOR ANY
   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
 
 * @author mael
 *
 */
public class Outil {
    /**
     * Logger
     */
    public static final org.apache.commons.logging.Log LOG = org.apache.commons.logging.LogFactory.getLog(Outil.class);

    /**
     * Transformation d'un inputstream en string.<br/>
     * Util pour lire la réponse du webservice
     * @param input le stream
     * @return la string
     * @throws IOException
     */
    public static String readInputStreamAsString(InputStream input) throws IOException {
        DataInputStream dis = new DataInputStream(new BufferedInputStream(input));

        String temp;
        StringBuffer buffer = new StringBuffer();
        while ((temp = dis.readLine()) != null) {
            buffer.append(temp);
        }
        return buffer.toString();
    }

    /**
     * Transformation d'une string en document
     * @param string la string
     * @return le document correspondant
     * @throws JDOMException
     * @throws IOException
     */
    public static Document stringToDocument(String string) throws JDOMException, IOException {
        SAXBuilder sb = new SAXBuilder();
        Document doc = sb.build(new StringReader(string));
        return doc;

    }

    /**
     * Transformation d'un inputstream en document
     * @param input l'inputstream
     * @return le document
     * @throws JDOMException
     * @throws IOException
     */
    public static Document readInputStreamAsDocument(InputStream input) throws JDOMException, IOException {
        return stringToDocument(readInputStreamAsString(input));
    }

    /**
     * Transformation d'un document en string
     * @param doc le document à transformer
     * @return la string
     */
    public static String documentToString(Document doc) {
        return new XMLOutputter().outputString(doc);

    }

    /**
     * Fonction qui retour l'url d'un fichier donné.
     * Utile pour récupérer le chemin des images à l'intérieur du jar
     * @param fileName le chemin du fichier
     * @return l'url
     */
    public static URL getURL(String fileName) {
        URLClassLoader urlLoader = (URLClassLoader) Outil.class.getClassLoader();
        URL fileLocation = urlLoader.findResource(fileName);
        return fileLocation;
    }

    /**
     * Fonction qui retourne la somme de controle MD5 d'un fichier donné
     * @param filename le chemin du fichier
     * @return la somme de controle
     * @throws Exception
     */
    public static String getMD5Checksum(String filename) throws Exception {
        byte[] b = createChecksum(filename);
        String result = "";
        for (int i = 0; i < b.length; i++) {
            result += Integer.toString((b[i] & 0xff) + 0x100, 16).substring(1);
        }
        return result;
    }

    /**
     * Creation de la somme de controle d'un fichier
     * @param filename le chemin du fichier
     * @return la somme de controle sous forme de byte[]
     * @throws Exception
     */
    private static byte[] createChecksum(String filename) throws Exception {
        InputStream fis = new FileInputStream(filename);

        byte[] buffer = new byte[1024];
        MessageDigest complete = MessageDigest.getInstance("MD5");
        int numRead;
        do {
            numRead = fis.read(buffer);
            if (numRead > 0) {
                complete.update(buffer, 0, numRead);
            }
        } while (numRead != -1);
        fis.close();
        return complete.digest();
    }

    /**
     * Fonction qui transforme un fichier en tableau de bytes
     * @param file le fichier
     * @return le tableau de bytes
     * @throws IOException
     */
    public static byte[] getBytesFromFile(File file) throws IOException {
        InputStream is = new FileInputStream(file);
        long length = file.length();

        byte[] bytes = new byte[(int) length];
        int offset = 0;
        int numRead = 0;
        while (offset < bytes.length && (numRead = is.read(bytes, offset, bytes.length - offset)) >= 0) {
            offset += numRead;
        }

        if (offset < bytes.length) {
            throw new IOException("Could not completely read file " + file.getName());
        }
        is.close();
        return bytes;
    }

    /**
     * Fonction qui vérifie que si la réponse du webservice est positive
     * @param doc le document que retourne le webservice
     * @return true si c'est ok
     */
    public static boolean checkOk(Document doc) {
        if (doc.getRootElement().getAttributeValue("stat").equals("ok")) {
            return true;
        } else {
            LOG.error("Resultat : " + doc.getRootElement().getAttributeValue("stat") + "\nDocument retourné : \n"
                    + Outil.documentToString(doc));
            return false;
        }

    }

    /**
     * Exception to string
     * @param aThrowable exception
     * @return l'exception en string
     */
    public static String getStackTrace(Throwable aThrowable) {
        final Writer result = new StringWriter();
        final PrintWriter printWriter = new PrintWriter(result);
        aThrowable.printStackTrace(printWriter);
        return result.toString();
    }
}