/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, 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 Cocoon" and "Apache Software Foundation" 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", 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 (INCLU-
DING, 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 and was originally created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.webapps.session.transformation;
import java.io.IOException;
import java.io.StringBufferInputStream;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.avalon.framework.configuration.SAXConfigurationHandler;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.acting.ValidatorActionResult;
import org.apache.cocoon.components.source.SourceUtil;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.webapps.session.SessionConstants;
import org.apache.cocoon.xml.XMLUtils;
import org.apache.excalibur.source.Source;
import org.apache.excalibur.source.SourceException;
import org.apache.excalibur.source.SourceParameters;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Node;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* This is the session post transformer. It does all the setting and
* destroying. Thus it should be the last transformer (before the xsl) in
* the pipeline.
* For performance and simplicity reasons this transformer inherits from
* the SessionPreTransformer, although this is not needed (But then the
* implementation of the SessionTransformer would be very unperformant.
*
* @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
* @version CVS $Id: SessionPostTransformer.java,v 1.3 2003/05/16 07:19:43 cziegeler Exp $
*/
public class SessionPostTransformer
extends SessionPreTransformer {
public static final String DELETECONTEXT_ELEMENT = "deletecontext";
public static final String DELETECONTEXT_NAME_ATTRIBUTE = "name";
public static final String SETXML_ELEMENT = "setxml";
public static final String SETXML_CONTEXT_ATTRIBUTE = "context";
public static final String SETXML_PATH_ATTRIBUTE = "path";
public static final String APPENDXML_ELEMENT = "appendxml";
public static final String APPENDXML_CONTEXT_ATTRIBUTE = "context";
public static final String APPENDXML_PATH_ATTRIBUTE = "path";
public static final String REMOVEXML_ELEMENT = "removexml";
public static final String REMOVEXML_CONTEXT_ATTRIBUTE = "context";
public static final String REMOVEXML_PATH_ATTRIBUTE = "path";
public static final String MERGEXML_ELEMENT = "mergexml";
public static final String MERGEXML_CONTEXT_ATTRIBUTE = "context";
public static final String MERGEXML_PATH_ATTRIBUTE = "path";
public static final String SAVECONTEXT_ELEMENT = "savexml";
public static final String SAVECONTEXT_CONTEXT_ATTRIBUTE = "context";
public static final String SAVECONTEXT_PATH_ATTRIBUTE = "path"; // optional
public static final String INPUTXML_ELEMENT = "inputxml";
public static final String INPUTXML_CONTEXT_ATTRIBUTE = "context";
public static final String INPUTXML_PATH_ATTRIBUTE = "path";
public static final String INPUTXML_NAME_ATTRIBUTE = "name";
public static final String INPUTXML_TYPE_ATTRIBUTE = "type"; // optional
public static final String INPUTXML_VALIDATIONRESULT_ATTRIBUTE = "valresult";
/** The form element */
public static final String FORM_ELEMENT = "form";
/** The form action element */
public static final String FORM_ACTION_ELEMENT = "action";
/** The form content element */
public static final String FORM_CONTENT_ELEMENT = "content";
/** The form validation rules */
public static final String FORM_VALIDATION_ELEMENT = "validate";
public static final String FORM_VALIDATION_SOURCE_ATTRIBUTE = "src";
public static final String FORM_VALIDATESET_ELEMENT = "validate-set";
/** State: no element parsed */
private static final int STATE_OUTSIDE = 0;
/** State: form element */
private static final int STATE_FORM = 1;
/** The current state */
private int state;
/** The current form name */
private String formName;
/** The validation results */
private Map validationResultMap;
public void setupTransforming()
throws ProcessingException, SAXException, IOException {
super.setupTransforming();
this.state = STATE_OUTSIDE;
this.formName = null;
}
/**
* This is the real implementation of the startElement event
* for the transformer
* The event is checked for a valid element and the corresponding command
* is executed.
*/
public void startTransformingElement(String uri,
String name,
String raw,
Attributes attr)
throws ProcessingException, IOException, SAXException {
if (this.getLogger().isDebugEnabled() == true) {
this.getLogger().debug("BEGIN startTransformingElement uri=" + uri +
", name=" + name + ", raw=" + raw + ", attr=" + attr);
}
if (name.equals(DELETECONTEXT_ELEMENT) == true) {
this.getContextManager().deleteContext(attr.getValue(DELETECONTEXT_NAME_ATTRIBUTE));
} else if (name.equals(SETXML_ELEMENT) == true) {
this.startRecording();
stack.push(attr.getValue(SETXML_CONTEXT_ATTRIBUTE));
stack.push(attr.getValue(SETXML_PATH_ATTRIBUTE));
// Element: mergexml
} else if (name.equals(MERGEXML_ELEMENT) == true) {
this.startRecording();
stack.push(attr.getValue(MERGEXML_CONTEXT_ATTRIBUTE));
stack.push(attr.getValue(MERGEXML_PATH_ATTRIBUTE));
// Element: appendxml
} else if (name.equals(APPENDXML_ELEMENT) == true) {
this.startRecording();
stack.push(attr.getValue(APPENDXML_CONTEXT_ATTRIBUTE));
stack.push(attr.getValue(APPENDXML_PATH_ATTRIBUTE));
// Element: removexml
} else if (name.equals(REMOVEXML_ELEMENT) == true) {
this.startTextRecording();
stack.push(attr.getValue(REMOVEXML_CONTEXT_ATTRIBUTE));
stack.push(attr.getValue(REMOVEXML_PATH_ATTRIBUTE));
} else if (name.equals(SAVECONTEXT_ELEMENT) == true) {
this.startParametersRecording();
stack.push(attr.getValue(SAVECONTEXT_CONTEXT_ATTRIBUTE));
if (attr.getValue(SAVECONTEXT_PATH_ATTRIBUTE) != null) {
stack.push(attr.getValue(SAVECONTEXT_PATH_ATTRIBUTE));
} else {
stack.push("/");
}
// Element: inputxml
} else if (name.equals(INPUTXML_ELEMENT) == true) {
stack.push(attr.getValue(INPUTXML_CONTEXT_ATTRIBUTE));
String fieldname = attr.getValue(INPUTXML_NAME_ATTRIBUTE);
stack.push(fieldname);
stack.push(attr.getValue(INPUTXML_PATH_ATTRIBUTE));
AttributesImpl newattr = new AttributesImpl();
newattr.addAttribute("", INPUTXML_NAME_ATTRIBUTE, INPUTXML_NAME_ATTRIBUTE, "CDATA", fieldname);
if (attr.getValue(INPUTXML_TYPE_ATTRIBUTE) != null) {
newattr.addAttribute("",
INPUTXML_TYPE_ATTRIBUTE,
INPUTXML_TYPE_ATTRIBUTE,
"CDATA", attr.getValue(INPUTXML_TYPE_ATTRIBUTE));
}
ValidatorActionResult validationResult = null;
if (validationResultMap != null && validationResultMap.get(fieldname) != null) {
validationResult = (ValidatorActionResult)validationResultMap.get(fieldname);
newattr.addAttribute("",
INPUTXML_VALIDATIONRESULT_ATTRIBUTE,
INPUTXML_VALIDATIONRESULT_ATTRIBUTE,
"CDATA", validationResult.toString());
}
super.startTransformingElement("", name, name, newattr); // remove namespace
this.startRecording();
// Element form
} else if (name.equals(FORM_ELEMENT) == true
&& this.state == STATE_OUTSIDE) {
String formName = attr.getValue("name");
if (formName == null) {
throw new ProcessingException("The name attribute of the form element is required.");
}
this.stack.push(new Integer(this.state));
this.state = STATE_FORM;
this.stack.push(new AttributesImpl(attr));
// Element form action
} else if (name.equals(FORM_ACTION_ELEMENT) == true
&& this.state == STATE_FORM) {
this.startTextRecording();
// Element form content
} else if (name.equals(FORM_CONTENT_ELEMENT) == true
&& this.state == STATE_FORM) {
// get validation results to be used for inputxml elements
validationResultMap = (Map)this.getSessionManager().getSession(true).
getAttribute(this.formName + "validation-result");
// Element form validation rules
} else if (name.equals(FORM_VALIDATION_ELEMENT) == true
&& this.state == STATE_FORM) {
this.startRecording();
if (attr.getValue(FORM_VALIDATION_SOURCE_ATTRIBUTE) != null) {
stack.push(attr.getValue(FORM_VALIDATION_SOURCE_ATTRIBUTE));
} else {
stack.push("EMPTY");
}
} else {
super.startTransformingElement(uri, name, raw, attr);
}
if (this.getLogger().isDebugEnabled() == true) {
this.getLogger().debug("END startTransformingElement");
}
}
public void endTransformingElement(String uri,
String name,
String raw)
throws ProcessingException ,IOException, SAXException {
if (this.getLogger().isDebugEnabled() == true) {
this.getLogger().debug("BEGIN endTransformingElement uri=" + uri + ", name=" + name + ", raw=" + raw);
}
if (name.equals(DELETECONTEXT_ELEMENT) == true) {
// do nothing, the context was destroyed on the startElement event
// Element: setxml
} else if (name.equals(SETXML_ELEMENT) == true) {
String path = (String)stack.pop();
String contextName = (String)stack.pop();
this.getSessionManager().setContextFragment(contextName, path, this.endRecording());
// Element: mergexml
} else if (name.equals(MERGEXML_ELEMENT) == true) {
String path = (String)stack.pop();
String contextName = (String)stack.pop();
this.getSessionManager().mergeContextFragment(contextName, path, this.endRecording());
// Element: appendxml
} else if (name.equals(APPENDXML_ELEMENT) == true) {
String path = (String)stack.pop();
String contextName = (String)stack.pop();
this.getSessionManager().appendContextFragment(contextName, path, this.endRecording());
// Element: removexml
} else if (name.equals(REMOVEXML_ELEMENT) == true) {
String path = (String)stack.pop();
String contextName = (String)stack.pop();
// result is ignored
endTextRecording();
this.getSessionManager().removeContextFragment(contextName, path);
// Element: savexml
} else if (name.equals(SAVECONTEXT_ELEMENT) == true) {
String path = (String)stack.pop();
String contextName = (String)stack.pop();
SourceParameters pars = this.endParametersRecording((SourceParameters)null);
pars.setSingleParameterValue("contextname", contextName);
pars.setSingleParameterValue("path", path);
this.getContextManager().getContext(contextName).saveXML(path,
pars,
this.objectModel,
this.resolver,
this.manager);
// Element: inputxml
} else if (name.equals(INPUTXML_ELEMENT) == true) {
String path = (String)this.stack.pop();
String fieldname = (String)this.stack.pop();
String contextname = (String)this.stack.pop();
DocumentFragment defaultFragment = this.endRecording();
if (this.formName == null) {
throw new ProcessingException("The inputxml must be contained inside a form.");
}
DocumentFragment value = this.getFormManager().registerInputField(contextname, path, fieldname, formName);
if (value == null) value = defaultFragment;
this.sendEvents(value);
super.endTransformingElement("", name, name);
// Element form
} else if (name.equals(FORM_ELEMENT) == true
&& this.state == STATE_FORM) {
this.state = ((Integer)this.stack.pop()).intValue();
this.sendEndElementEvent("form");
this.formName = null;
// Element form action
} else if (name.equals(FORM_ACTION_ELEMENT) == true
&& this.state == STATE_FORM) {
String action = this.endTextRecording();
AttributesImpl a = (AttributesImpl)this.stack.pop();
this.formName = a.getValue("name");
boolean hasPars = (action.indexOf("?") != -1);
action = this.response.encodeURL(action + (hasPars ? '&' : '?') + SessionConstants.SESSION_FORM_PARAMETER+'='+this.formName);
a.addAttribute("", "action", "action", "CDATA", action);
if (a.getValue("method") == null) {
a.addAttribute("", "method", "method", "CDATA", "POST");
}
this.sendStartElementEvent("form", a);
// Element form content
} else if (name.equals(FORM_CONTENT_ELEMENT) == true
&& this.state == STATE_FORM) {
// ignore this
// Element form validation rules
} else if (name.equals(FORM_VALIDATION_ELEMENT) == true
&& this.state == STATE_FORM) {
if (this.formName == null) {
throw new ProcessingException("The validate element must be contained inside a form.");
}
DocumentFragment validationDoc = this.endRecording();
String source = (String)stack.pop();
if (!source.equals("EMPTY")) {
// get configuration from external file
// referenced by "src" attribute of "validate" element
Configuration conf = null;
Session session = null;
try {
Source resource = this.resolver.resolveURI(source);
SAXConfigurationHandler saxBuilder = new SAXConfigurationHandler();
SourceUtil.parse(this.manager, resource, saxBuilder);
conf = saxBuilder.getConfiguration();
session = this.getSessionManager().getSession(true);
session.setAttribute(this.formName, conf);
if (validationDoc != null) {
//validationDoc contains "validate-set" element
validationDoc.normalize();
Node validationNode = validationDoc.getFirstChild();
while (validationNode.getNodeType() != Node.ELEMENT_NODE) {
validationNode = validationNode.getNextSibling();
if (validationNode == null) break;
}
if (validationNode != null &&
validationNode.getNodeType() == Node.ELEMENT_NODE &&
validationNode.getNodeName().equals(FORM_VALIDATESET_ELEMENT)) {
String validationXML = XMLUtils.serializeNodeToXML(validationNode);
DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
conf = builder.build(new StringBufferInputStream(validationXML));
session.setAttribute(this.formName+"validate-set", conf);
}
}
} catch (SourceException se) {
throw new ProcessingException("Cannot resolve"+source, se);
} catch (ConfigurationException ce) {
throw new ProcessingException("Error building Configuration out of validate-set element", ce);
}
} else if (validationDoc != null) {
//validationDoc contains the validation rules inline
try {
validationDoc.normalize();
Node validationNode = validationDoc.getFirstChild();
while (validationNode.getNodeType() != Node.ELEMENT_NODE) {
validationNode = validationNode.getNextSibling();
if (validationNode == null) break;
}
if (validationNode != null &&
validationNode.getNodeType() == Node.ELEMENT_NODE &&
validationNode.getNodeName().equals("root")) {
String validationXML = XMLUtils.serializeNodeToXML(validationNode);
DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
Configuration conf = null;
Session session = null;
conf = builder.build(new StringBufferInputStream(validationXML));
session = this.getSessionManager().getSession(true);
session.setAttribute(this.formName, conf);
//the constraint-set to validate is the first and single one
session.setAttribute(this.formName+"validate-set", conf.getChildren ("constraint-set")[0]);
}
} catch (ConfigurationException ce) {
throw new ProcessingException("Error building Configuration out of validation XML", ce);
}
}
} else {
super.endTransformingElement(uri, name, raw);
}
if (this.getLogger().isDebugEnabled() == true) {
this.getLogger().debug("END endTransformingElement");
}
}
}