/*****************************************************************************
* Copyright (C) The Apache Software Foundation. All rights reserved. *
* ------------------------------------------------------------------------- *
* This software is published under the terms of the Apache Software License *
* version 1.1, a copy of which has been included with this distribution in *
* the LICENSE file. *
*****************************************************************************/
package org.apache.cocoon.acting;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.logger.AbstractLoggable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.acting.*;
import org.apache.cocoon.Constants;
import org.apache.cocoon.environment.Redirector;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.cocoon.util.Tokenizer;
import org.apache.log.Logger;
import org.apache.cocoon.components.language.markup.xsp.XSPCookieHelper;
import org.apache.cocoon.environment.ObjectModelHelper;
/**
* This is the action used to validate Cookie parameters (values).
* The parameters are described via the external xml
* file (its format is defined in AbstractValidatorAction).
*
* Variant 1
*
* <map:act type="cookie-validator">
* <parameter name="descriptor" value="context://descriptor.xml">
* <parameter name="validate" value="username,password">
* </map:act>
*
* The list of parameters to be validated is specified as a comma separated
* list of their names. descriptor.xml can therefore be used among many
* various actions.
*
* Variant 2
*
*
* <map:act type="cookie-validator">
* <parameter name="descriptor" value="context://descriptor.xml">
* <parameter name="validate-set" value="is-logged-in">
* </map:act>
*
*
* The parameter "validate-set" tells to take a given "constraint-set"
* from description
* file and test all parameters against given criteria. This variant is more
* powerful, more aspect oriented and more flexibile than the previous one,
* becuase it allows the comparsion constructs, etc. See
* AbstractValidatorAction documentation.
*
* This action returns null when validation fails, otherwise it provides
* all validated parameters to the sitemap via {name} expression.
*
* @author Paolo Scaffardi <paolo@arsenio.net>
* @version CVS $Revision: 1.0.0.0 $ $Date: 2001/10/18 12:00:00 $
*/
public class CookieValidatorAction extends AbstractValidatorAction {
public CookieValidatorAction() {
}
public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters parameters)
throws java.lang.Exception {
Request req = ObjectModelHelper.getRequest(objectModel);
if (req == null) {
getLogger ().debug ("COOKIEVALIDATOR: no request object");
return null;
}
// read global parameter settings
boolean reloadable = Constants.DESCRIPTOR_RELOADABLE_DEFAULT;
if (this.settings.containsKey("reloadable"))
reloadable = Boolean.getBoolean((String) this.settings.get("reloadable"));
String valsetstr = (String) this.settings.get("validate-set");
String valstr = (String) this.settings.get("validate");
try {
/* Configuration conf = this.getConfiguration (
parameters.getParameter ("descriptor",
(String) this.settings.get("descriptor")),
parameters.getParameterAsBoolean("reloadable",reloadable));
*/
Configuration conf = this.getConfiguration (
parameters.getParameter ("descriptor",
(String) this.settings.get("descriptor")),
resolver, parameters.getParameterAsBoolean("reloadable",reloadable));
valstr = parameters.getParameter ("validate", valstr);
valsetstr = parameters.getParameter ("validate-set", valsetstr);
Configuration[] desc = conf.getChildren ("parameter");
Configuration[] csets = conf.getChildren ("constraint-set");
HashMap actionMap = new HashMap ();
/*
* old obsoleted method
*/
if (!"".equals (valstr.trim ())) {
getLogger ().debug ("COOKIEVALIDATOR: validating parameters "
+ "as specified via 'validate' parameter");
/* get list of params to be validated */
String[] rparams = Tokenizer.tokenize (valstr, ",", false);
/* perform actuall validation */
ValidatorActionHelper result = null;
String name = null;
HashMap params = new HashMap (rparams.length);
/* put required params into hash */
for (int i = 0; i < rparams.length; i ++) {
name = rparams[i];
if (name == null || "".equals (name.trim ())) {
getLogger ().debug ("COOKIEVALIDATOR: "
+ "wrong syntax of the 'validate' parameter");
return null;
}
name = name.trim ();
/* String cookieValue = XSPCookieHelper.getValue(objectModel, name,-1) ;
getLogger().debug("COOKIE(" + name + ")=" + cookieValue + "(" +
XSPCookieHelper.getCookie (objectModel, name, -1).getValue()
+")");
*/
params.put (name, XSPCookieHelper.getCookie (objectModel, name, -1).getValue());
}
for (int i = 0; i < rparams.length; i ++) {
name = rparams[i].trim ();
result = validateParameter (name, null, desc,
params, false);
if (!result.isOK()) {
getLogger().debug ("COOKIEVALIDATOR: "
+ "validation failed for parameter " + name);
return null;
}
actionMap.put (name, result.getObject());
}
}
/*
* new set-based method
*/
if (valsetstr != null && !"".equals (valsetstr.trim ())) {
getLogger ().debug ("COOKIEVALIDATOR: validating parameters "
+ "from given constraint-set " + valsetstr);
Configuration cset = null;
String setname = null;
int j = 0;
boolean found = false;
for (j = 0; j < csets.length; j ++) {
setname = csets[j].getAttribute ("name", "");
if (valsetstr.trim().equals (setname.trim ())) {
found = true;
break;
}
}
if (!found) {
getLogger ().debug ("COOKIEVALIDATOR: given set "
+ valsetstr
+ " does not exist in a description file");
return null;
}
cset = csets[j];
/* get the list of params to be validated */
Configuration[] set = cset.getChildren ("validate");
/* perform actuall validation */
ValidatorActionHelper result = null;
String name = null;
HashMap params = new HashMap (set.length);
getLogger ().debug ("COOKIEVALIDATOR: given set "
+ valsetstr
+ " contains " + set.length + " rules");
/* put required params into hash */
for (int i = 0; i < set.length; i ++) {
name = set[i].getAttribute ("name", "");
if ("".equals (name.trim ())) {
getLogger ().debug ("COOKIEVALIDATOR: wrong syntax "
+ " of 'validate' children nr. " + i);
return null;
}
name = name.trim ();
params.put (name, XSPCookieHelper.getCookie (objectModel, name, -1).getValue());
}
for (int i = 0; i < set.length; i ++) {
name = set[i].getAttribute ("name", null);
result = validateParameter (name, set[i],
desc, params, false);
if (!result.isOK()) {
getLogger().debug ("COOKIEVALIDATOR: "
+ "validation failed for cookie '" + name+"'");
return null;
}
actionMap.put (name, result.getObject());
}
}
getLogger().debug ("COOKIEVALIDATOR: all cookies validated");
return Collections.unmodifiableMap (actionMap);
} catch (Exception e) {
getLogger().debug ("exception: ", e);
}
return null;
}
}