edu.scripps.fl.pubchem.web.session.WebSessionBase.java Source code

Introduction

Here is the source code for edu.scripps.fl.pubchem.web.session.WebSessionBase.java

Source

/*
 * Copyright 2011 The Scripps Research Institute
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package edu.scripps.fl.pubchem.web.session;

import java.awt.Desktop;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.xml.parsers.ParserConfigurationException;

import org.apache.commons.io.IOUtils;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.message.BasicNameValuePair;
import org.dom4j.Document;
import org.dom4j.Node;
import org.dom4j.io.DOMReader;
import org.dom4j.io.XMLWriter;
import org.htmlcleaner.DomSerializer;
import org.htmlcleaner.HtmlCleaner;
import org.htmlcleaner.TagNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import edu.scripps.fl.dom4j.util.FormControlVisitorSupport;

public abstract class WebSessionBase extends HttpClientBase {

    private static final Logger log = LoggerFactory.getLogger(WebSessionBase.class);
    public boolean DEBUGGING = false;

    public Document getDocumentFromHtml(InputStream inputStream) throws IOException, ParserConfigurationException {
        HtmlCleaner cleaner = new HtmlCleaner();
        TagNode root = cleaner.clean(inputStream);
        DOMReader reader = new DOMReader();
        Document doc = reader.read(new DomSerializer(cleaner.getProperties(), true).createDOM(root));
        if (DEBUGGING)
            debugDocumentToTempFile(doc, DEBUGGING);
        return doc;
    }

    protected void debugDocumentToTempFile(Document doc, boolean displayFile) throws IOException {
        File file = File.createTempFile(getClass().getName(), ".html");
        XMLWriter writer = new XMLWriter(new FileOutputStream(file));
        writer.write(doc);
        writer.close();
        if (displayFile)
            Desktop.getDesktop().open(file);
    }

    protected void addFormParts(Node formNode, MultipartEntity entity, Set<String> ignore)
            throws UnsupportedEncodingException {
        FormControlVisitorSupport fcvs = new FormControlVisitorSupport();
        formNode.accept(fcvs);
        for (Map.Entry<String, String> entry : fcvs.getFormParameters().entrySet()) {
            if (!ignore.contains(entry.getKey()))
                entity.addPart(entry.getKey(), new StringBody(entry.getValue()));
        }
    }

    protected List<NameValuePair> addParameters(List<NameValuePair> params, Object... pairs) {
        for (int ii = 0; ii < pairs.length; ii += 2)
            params.add(new BasicNameValuePair(pairs[ii].toString(), pairs[ii + 1].toString()));
        return params;
    }

    protected MultipartEntity addParts(MultipartEntity entity, Object... pairs)
            throws UnsupportedEncodingException {
        for (int ii = 0; ii < pairs.length; ii += 2)
            entity.addPart(pairs[ii].toString(), new StringBody(pairs[ii + 1].toString()));
        return entity;
    }

    protected Document getDocument(String uri) throws IOException, ParserConfigurationException {
        log.info("Getting uri: " + uri);
        HttpGet method = new HttpGet(uri);
        HttpResponse response = getHttpClient().execute(method);
        return getDocumentFromHtml(response.getEntity().getContent());
    }

    protected String getPage(HttpRequestBase method) throws IOException {
        HttpResponse response = getHttpClient().execute(method);
        String page = IOUtils.toString(response.getEntity().getContent());
        if (DEBUGGING)
            debugPageToTempFile(page, DEBUGGING);
        return page;
    }

    protected void debugPageToTempFile(String page, boolean displayFile) throws IOException {
        File file = File.createTempFile(getClass().getName(), ".html");
        IOUtils.write(page, new FileOutputStream(file));
        if (displayFile)
            Desktop.getDesktop().open(file);
    }

    protected String getPage(String uri) throws IOException {
        log.info("Getting uri: " + uri);
        return getPage(new HttpGet(uri));
    }

    protected String getPage(URI uri) throws IOException {
        log.info("Getting uri: " + uri);
        return getPage(new HttpGet(uri));
    }

    protected Document postDocument(String uri, HttpEntity entity)
            throws IOException, ParserConfigurationException {
        log.info("Posting form: " + uri);
        HttpEntityEnclosingRequestBase method = new HttpPost(uri);
        method.setEntity(entity);
        HttpResponse response = getHttpClient().execute(method);
        return getDocumentFromHtml(response.getEntity().getContent());
    }

    protected String postPage(String uri, HttpEntity entity) throws IOException {
        log.info("Posting form: " + uri);
        HttpPost method = new HttpPost(uri);
        method.setEntity(entity);
        return getPage(method);
    }
}