/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-09 Wolfgang M. Meier
* wolfgang@exist-db.org
* http://exist.sourceforge.net
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* $Id$
*/
package org.exist.xquery.functions.request;
import org.apache.log4j.Logger;
import org.exist.dom.QName;
import org.exist.http.servlets.RequestWrapper;
import org.exist.xquery.BasicFunction;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.Variable;
import org.exist.xquery.XPathException;
import org.exist.xquery.XPathUtil;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.JavaObjectValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;
/**
* @author wolf
*/
public class GetParameter extends BasicFunction {
protected static final Logger logger = Logger.getLogger(GetParameter.class);
public final static FunctionSignature signatures[] = {
new FunctionSignature(
new QName(
"get-parameter",
RequestModule.NAMESPACE_URI,
RequestModule.PREFIX),
"Returns the HTTP request parameter identified by $name. If the parameter could not be found, " +
"the default value is returned instead. Note: this function will not try to expand " +
"predefined entities like & or <, so a & passed through a parameter will indeed " +
"be treated as an & character.",
new SequenceType[] {
new FunctionParameterSequenceType("name", Type.STRING, Cardinality.EXACTLY_ONE, "The parameter name"),
new FunctionParameterSequenceType("default-value", Type.ITEM, Cardinality.ZERO_OR_MORE, "The default value if the parameter does not exist")},
new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_MORE, "the parameter value")),
new FunctionSignature(
new QName(
"get-parameter",
RequestModule.NAMESPACE_URI,
RequestModule.PREFIX),
"Returns the HTTP request parameter identified by $name. If the parameter could not be found, " +
"the default value is returned instead. Note: this function will not try to expand " +
"predefined entities like & or <, so a & passed through a parameter will indeed " +
"be treated as an & character.",
new SequenceType[] {
new FunctionParameterSequenceType("name", Type.STRING, Cardinality.EXACTLY_ONE, "The parameter name"),
new FunctionParameterSequenceType("default-value", Type.ITEM, Cardinality.ZERO_OR_MORE, "The default value if the parameter does not exist"),
new FunctionParameterSequenceType( "failonerror", Type.BOOLEAN, Cardinality.ZERO_OR_MORE, "The fail on error flag. If the value is set to false, then the function will not fail if there is no request in scope." )},
new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_MORE, "the parameter value"))
};
public final static FunctionSignature deprecated =
new FunctionSignature(
new QName(
"request-parameter",
RequestModule.NAMESPACE_URI,
RequestModule.PREFIX),
"Returns the HTTP request parameter identified by $name. If the parameter could not be found, " +
"the default value is returned instead. Note: this function will not try to expand " +
"predefined entities like & or <, so a & passed through a parameter will indeed " +
"be treated as an & character.",
new SequenceType[] {
new FunctionParameterSequenceType("name", Type.STRING, Cardinality.EXACTLY_ONE, "The parameter name"),
new FunctionParameterSequenceType("default-value", Type.ITEM, Cardinality.ZERO_OR_MORE, "The default value if the parameter does not exist")},
new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_MORE, "the parameter value"),
"Renamed to request:get-parameter.");
public GetParameter(XQueryContext context, FunctionSignature signature) {
super(context, signature);
}
/* (non-Javadoc)
* @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
*/
public Sequence eval(Sequence[] args, Sequence contextSequence)
throws XPathException {
RequestModule myModule =
(RequestModule) context.getModule(RequestModule.NAMESPACE_URI);
boolean failOnError = true;
if( getSignature().getArgumentCount() == 3 ) {
failOnError = args[2].effectiveBooleanValue();
}
// request object is read from global variable $request
Variable var = myModule.resolveVariable(RequestModule.REQUEST_VAR);
if (var == null || var.getValue() == null || var.getValue().getItemType() != Type.JAVA_OBJECT) {
if( failOnError ) {
throw new XPathException(this, "Variable $request is not bound to an Java object.");
} else {
return args[1];
}
}
// get parameters
String param = args[0].getStringValue();
JavaObjectValue value = (JavaObjectValue) var.getValue().itemAt(0);
if (value.getObject() instanceof RequestWrapper) {
String[] values = ((RequestWrapper)value.getObject()).getParameterValues(param);
if (values == null || values.length == 0) {
return args[1];
}
if (values.length == 1) {
return XPathUtil.javaObjectToXPath(values[0], null, false);
} else {
return XPathUtil.javaObjectToXPath(values, null, false);
}
} else {
if( failOnError ) {
throw new XPathException(this, "Variable $request is not bound to a Request object.");
} else {
return args[1];
}
}
}
}