package org.apache.turbine.modules.pages;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 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 Turbine" 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",
* "Apache Turbine", 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/>.
*/
import java.util.Vector;
// Turbine Classes
import org.apache.turbine.modules.ActionLoader;
import org.apache.turbine.modules.LayoutLoader;
import org.apache.turbine.modules.Page;
import org.apache.turbine.modules.Screen;
import org.apache.turbine.modules.ScreenLoader;
import org.apache.turbine.services.resources.TurbineResources;
import org.apache.turbine.util.RunData;
// ECS Stuff
import org.apache.ecs.Doctype;
/**
* When building sites using templates, Screens need only be defined
* for templates which require dynamic (database or object) data.
*
* <p>
*
* This page can be used on sites where the number of Screens can be
* much less than the number of templates. The templates can be
* grouped in directories with common layouts. Screen modules are
* then expected to be placed in packages corresponding with the
* templates' directories and follow a specific naming scheme.
*
* <p>
*
* The template parameter is parsed and and a Screen whose package
* matches the templates path and shares the same name minus any
* extension and beginning with a capital letter is searched for. If
* not found, a Screen in a package matching the template's path with
* name Default is searched for. If still not found, a Screen with
* name Default is looked for in packages corresponding to parent
* directories in the template's path until a match is found.
*
* <p>
*
* For example if data.getParameters().getString("template") returns
* /about_us/directions/driving.wm, the search follows
* about_us.directions.Driving, about_us.directions.Default,
* about_us.Default, Default, WebMacroSiteScreen.
*
* <p>
*
* Only one Layout module is used, since it is expected that any
* dynamic content will be placed in navigations and screens. The
* layout template to be used is found in a similar way to the Screen.
* For example the following paths will be searched in the layouts
* subdirectory: /about_us/directions/driving.wm,
* /about_us/directions/default.wm, /about_us/default.wm, /default.wm.
*
* <p>
*
* This approach allows a site with largely static content to be
* updated and added to regularly by those with little Java
* experience.
*
* <p>
*
* The code is an almost a complete clone of the FreeMarkerSitePage
* written by John McNally. I've only modified it for WebMacro use.
*
* @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
* @version $Id$
*/
public class DefaultPage extends Page
{
/**
* Builds the Page.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
public void doBuild( RunData data )
throws Exception
{
// Template pages can use this to set up the context, so it is
// available to the Action and Screen. It does nothing here.
doBuildBeforeAction(data);
// If an action has been defined, execute it here. Actions
// can re-define the template definition.
if ( data.hasAction() )
{
ActionLoader.getInstance().exec ( data, data.getAction() );
}
// Set the default doctype from the value given in
// TurbineResources.properties.
setDefaultDoctype(data);
// Template pages can use this to set up default templates and
// associated class modules. It does nothing here.
doBuildAfterAction(data);
// Ask the Screen for its Layout and then execute the Layout.
// The Screen can override the getLayout() method to re-define
// the Layout depending on data passed in via the
// data.parameters object.
ScreenLoader sl = ScreenLoader.getInstance();
Screen aScreen = sl.getInstance(data.getScreen());
String layout = aScreen.getLayout(data);
// If the Layout has been set to be null, attempt to execute
// the Screen that has been defined.
if ( layout != null )
{
LayoutLoader.getInstance().exec ( data, layout );
}
else
{
ScreenLoader.getInstance().exec ( data, data.getScreen() );
}
// Do any post build actions (overridable by subclasses -
// does nothing here).
doPostBuild(data);
}
/**
* Can be used by template Pages to stuff the Context into the
* RunData so that it is available to the Action module and the
* Screen module via getContext(). It does nothing here.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
protected void doBuildBeforeAction(RunData data)
throws Exception
{
}
/**
* Can be overridden by template Pages to set up data needed to
* process a template. It does nothing here.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
protected void doBuildAfterAction(RunData data)
throws Exception
{
}
/**
* Can be overridden to perform actions when the request is
* fully processed. It does nothing here.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
protected void doPostBuild(RunData data)
throws Exception
{
}
/**
* Set the default Doctype. If Doctype is set to null, it will
* not be added. The default Doctype can be set in
* TurbineResources by using the single strings: Html40Strict,
* Html40Transitional, or Html40Frameset. Additionally the
* default can be supplied as two strings giving the dtd and uri.
*
* @param data Turbine information.
* @exception Exception, a generic exception.
*/
private void setDefaultDoctype( RunData data )
throws Exception
{
String errMsg =
"default.doctype property not set properly in TurbineResources.";
Vector doctypeProperty =
TurbineResources.getVector("default.doctype", null);
if (doctypeProperty != null && doctypeProperty.size() > 0)
{
if (doctypeProperty.size() == 1)
{
String doc = (String)doctypeProperty.firstElement();
if (doc.equalsIgnoreCase("Html40Transitional"))
{
data.getPage().setDoctype(new Doctype.Html40Transitional());
}
else if (doc.equalsIgnoreCase("Html40Strict"))
{
data.getPage().setDoctype(new Doctype.Html40Strict());
}
else if (doc.equalsIgnoreCase("Html40Frameset"))
{
data.getPage().setDoctype(new Doctype.Html40Frameset());
}
else
{
throw new Exception(errMsg);
}
}
else if (doctypeProperty.size() == 2)
{
data.getPage().setDoctype(
new Doctype()
.setIdentifier((String)doctypeProperty.elementAt(0))
.setUri((String)doctypeProperty.elementAt(1)));
}
else
{
throw new Exception(errMsg);
}
}
}
}