/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Jetspeed" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache" or
* "Apache Jetspeed", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jetspeed.portal.portlets;
//Element Construction Set
import org.apache.jetspeed.util.JetspeedClearElement;
import org.apache.ecs.ConcreteElement;
//Jetspeed stuff
import org.apache.jetspeed.portal.PortletConfig;
import org.apache.jetspeed.portal.PortletException;
import org.apache.jetspeed.util.rewriter.Rewriter;
import org.apache.jetspeed.util.rewriter.HTMLRewriter;
import org.apache.jetspeed.util.Base64;
//turbine
import org.apache.turbine.util.Log;
import org.apache.turbine.util.RunData;
//standard java stuff
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.Reader;
import java.net.URL;
import java.net.URLConnection;
/**
* A class that loads a web page and filters it to have certain features
* deleted.
*
* @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
*/
public class WebPagePortlet2 extends AbstractInstancePortlet {
protected Rewriter rewriter = null;
protected boolean initDone = false;
protected boolean contentStale = true;
protected boolean cacheContent = false;
protected String username = null;
protected String password = null;
/**
* Initialize this portlet by defining a HTML rewriter.
* @throws PortletException Initialization failed
*/
public void init() throws PortletException {
if (initDone) // Why is init called more than once per portlet?
return;
PortletConfig config = this.getPortletConfig();
try
{
rewriter = new HTMLRewriter();
// fetch username and password for HTTP Basic Autentication
username = config.getInitParameter("username");
password = config.getInitParameter("password");
contentStale = true;
initDone = true;
} catch (Exception e) {
Log.info("Exception occurred:" + e.toString());
e.printStackTrace();
throw new PortletException( e.toString() );
}
}
/**
* took this from FileServerPortlet as it was private
*
*/
// FIXME: Currently only the expiration the HTTP Response header is honored.
// Expiration information in <meta> tags are not honored
protected Reader getReader(String url) throws IOException
{
URL pageUrl = new URL(url);
URLConnection pageConn = pageUrl.openConnection();
try
{
// set HTTP Basic Authetication header if username and password are set
if (username != null && password !=null)
{
pageConn.setRequestProperty("Authorization", "Basic " +
Base64.encodeAsString(username + ":" + password));
}
}
catch (Exception e)
{
Log.info("Exception occurred:" + e.toString());
e.printStackTrace();
}
long pageExpiration = pageConn.getExpiration();
String encoding = pageConn.getContentEncoding();
String tempString = null;
String noCache = "no-cache";
if(encoding == null)
{
// Standard HTTP encoding
encoding = "iso-8859-1";
}
/*
* Determing if content should be cached.
*/
cacheContent = true; // Assume content is cached
if (pageExpiration == 0) {
cacheContent = false;
}
// Check header field CacheControl
tempString = pageConn.getHeaderField( "Cache-Control");
if (tempString != null) {
if (tempString.toLowerCase().indexOf(noCache) >= 0) {
cacheContent = false;
}
}
// Check header field Pragma
tempString = pageConn.getHeaderField( "Pragma");
if (tempString != null) {
if (tempString.toLowerCase().indexOf(noCache) >= 0) {
cacheContent = false;
}
}
// Assign a reader
Reader rdr = new InputStreamReader(pageConn.getInputStream(),
encoding );
// Only set the page expiration it the page has not expired
if (pageExpiration > System.currentTimeMillis() && (cacheContent == true))
{
contentStale = false;
Log.debug( "WebPagePortlet caching URL: " +
url +
" Expiration: " +
pageExpiration +
", " +
(pageExpiration - System.currentTimeMillis() ) +
" milliseconds into the future" );
setExpirationMillis(pageExpiration);
} else {
contentStale = true;
}
return rdr;
}
/**
This methods outputs the content of the portlet for a given
request.
@param data the RunData object for the request
@return the content to be displayed to the user-agent
*/
public ConcreteElement getContent( RunData data )
{
PortletConfig config = this.getPortletConfig();
if (contentStale == true)
return getWebPageContent(data, config);
if (null == getExpirationMillis())
return getContent( data, null, true);
if (getExpirationMillis().longValue() <= System.currentTimeMillis())
return getWebPageContent(data, config);
return getContent( data, null , true );
}
private ConcreteElement getWebPageContent( RunData data, PortletConfig config )
{
String convertedString = null; // parsed and re-written HTML
JetspeedClearElement element = null;
String url = selectUrl( data, config );
try
{
Reader htmlReader = getReader( url );
convertedString = rewriter.rewrite(htmlReader, url);
element = new JetspeedClearElement(convertedString);
//FIXME: We should do a clearContent() for the media type, not ALL media types
this.clearContent(); // doing this because setContent() is not overwriting current content.
this.setContent(element);
htmlReader.close();
} catch (Exception e) {
Log.info("Exception occurred:" + e.toString());
e.printStackTrace();
}
return element;
}
/**
* Usually called by caching system when portlet is marked as expired, but
* has not be idle longer then TimeToLive.
*
* Any cached content that is expired need to be refreshed.
*/
public void refresh() {
if (cacheContent == true) {
getWebPageContent(null, this.getPortletConfig());
}
}
/**
* Select the URL to use for this portlet.
* @return The URL to use for this portlet
*/
protected String selectUrl( RunData data, PortletConfig config )
{
String url = config.getURL();
return url;
} // selectUrl
}