core/src/main/java/com/opensymphony/xwork2/interceptor/ParameterRemoverInterceptor.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.opensymphony.xwork2.interceptor;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.util.TextParseUtil;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.struts2.action.NoParameters;
import org.apache.struts2.dispatcher.HttpParameters;
import org.apache.struts2.dispatcher.Parameter;

import java.util.Collections;
import java.util.Set;

/**
 * This is a simple XWork interceptor that allows parameters (matching
 * one of the paramNames attribute csv value) to be
 * removed from the parameter map if they match a certain value
 * (matching one of the paramValues attribute csv value), before they
 * are set on the action. A typical usage would be to want a dropdown/select
 * to map onto a boolean value on an action. The select had the options
 * none, yes and no with values -1, true and false. The true and false would
 * map across correctly. However the -1 would be set to false.
 * This was not desired as one might needed the value on the action to stay null.
 * This interceptor fixes this by preventing the parameter from ever reaching
 * the action.
 *
 * <ul>
 * 	<li>paramNames - A comma separated value (csv) indicating the parameter name
 *                   whose param value should be considered that if they match any of the
 *                   comma separated value (csv) from paramValues attribute, shall be
 *                   removed from the parameter map such that they will not be applied
 *                   to the action</li>
 * 	<li>paramValues - A comma separated value (csv) indicating the parameter value that if
 *                    matched shall have its parameter be removed from the parameter map
 *                    such that they will not be applied to the action</li>
 * </ul>
 * <p>
 * No intended extension point
 *
 * <pre>
 * &lt;action name="sample" class="org.martingilday.Sample"&gt;
 * 	&lt;interceptor-ref name="paramRemover"&gt;
 *          &lt;param name="paramNames"&gt;aParam,anotherParam&lt;/param&gt;
 *          &lt;param name="paramValues"&gt;--,-1&lt;/param&gt;
 * 	&lt;/interceptor-ref&gt;
 * 	&lt;interceptor-ref name="defaultStack" /&gt;
 * 	...
 * &lt;/action&gt;
 * </pre>
 */
public class ParameterRemoverInterceptor extends AbstractInterceptor {

    private static final Logger LOG = LogManager.getLogger(ParameterRemoverInterceptor.class);

    private Set<String> paramNames = Collections.emptySet();
    private Set<String> paramValues = Collections.emptySet();

    /**
     * Decide if the parameter should be removed from the parameter map based on
     * <code>paramNames</code> and <code>paramValues</code>.
     *
     * @see com.opensymphony.xwork2.interceptor.AbstractInterceptor
     */
    @Override
    public String intercept(ActionInvocation invocation) throws Exception {
        if (!(invocation.getAction() instanceof NoParameters)
            && (null != this.paramNames)) {
            ActionContext ac = invocation.getInvocationContext();
            HttpParameters parameters = ac.getParameters();

            if (parameters != null) {
                for (String removeName : paramNames) {
                    try {
                        Parameter parameter = parameters.get(removeName);
                        if (parameter.isDefined() && this.paramValues.contains(parameter.getValue())) {
                            parameters.remove(removeName);
                        }
                    } catch (Exception e) {
                        LOG.error("Failed to convert parameter to string", e);
                    }
                }
            }
        }
        return invocation.invoke();
    }

    /**
     * Allows <code>paramNames</code> attribute to be set as comma-separated-values (csv).
     *
     * @param paramNames the paramNames to set
     */
    public void setParamNames(String paramNames) {
        this.paramNames = TextParseUtil.commaDelimitedStringToSet(paramNames);
    }

    /**
     * Allows <code>paramValues</code> attribute to be set as a comma-separated-values (csv).
     *
     * @param paramValues the paramValues to set
     */
    public void setParamValues(String paramValues) {
        this.paramValues = TextParseUtil.commaDelimitedStringToSet(paramValues);
    }

}