| /* |
| * 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.util.TextParseUtil; |
| import com.opensymphony.xwork2.util.WildcardHelper; |
| |
| import java.util.HashMap; |
| import java.util.Set; |
| |
| /** |
| * Utility class contains common methods used by |
| * {@link com.opensymphony.xwork2.interceptor.MethodFilterInterceptor}. |
| * |
| * @author tm_jee |
| */ |
| public class MethodFilterInterceptorUtil { |
| |
| /** |
| * Static method to decide if the specified <code>method</code> should be |
| * apply (not filtered) depending on the set of <code>excludeMethods</code> and |
| * <code>includeMethods</code>. |
| * |
| * <ul> |
| * <li> |
| * <code>includeMethods</code> takes precedence over <code>excludeMethods</code> |
| * </li> |
| * </ul> |
| * <b>Note:</b> Supports wildcard listings in includeMethods/excludeMethods |
| * |
| * @param excludeMethods list of methods to exclude. |
| * @param includeMethods list of methods to include. |
| * @param method the specified method to check |
| * @return <tt>true</tt> if the method should be applied. |
| */ |
| public static boolean applyMethod(Set<String> excludeMethods, Set<String> includeMethods, String method) { |
| |
| // quick check to see if any actual pattern matching is needed |
| boolean needsPatternMatch = false; |
| for (String includeMethod : includeMethods) { |
| if (!"*".equals(includeMethod) && includeMethod.contains("*")) { |
| needsPatternMatch = true; |
| break; |
| } |
| } |
| |
| for (String excludeMethod : excludeMethods) { |
| if (!"*".equals(excludeMethod) && excludeMethod.contains("*")) { |
| needsPatternMatch = true; |
| break; |
| } |
| } |
| |
| // this section will try to honor the original logic, while |
| // still allowing for wildcards later |
| if (!needsPatternMatch && (includeMethods.contains("*") || includeMethods.size() == 0) ) { |
| if (excludeMethods != null |
| && excludeMethods.contains(method) |
| && !includeMethods.contains(method) ) { |
| return false; |
| } |
| } |
| |
| // test the methods using pattern matching |
| WildcardHelper wildcard = new WildcardHelper(); |
| String methodCopy ; |
| if (method == null ) { // no method specified |
| methodCopy = ""; |
| } |
| else { |
| methodCopy = new String(method); |
| } |
| for (String pattern : includeMethods) { |
| if (pattern.contains("*")) { |
| int[] compiledPattern = wildcard.compilePattern(pattern); |
| HashMap<String, String> matchedPatterns = new HashMap<>(); |
| boolean matches = wildcard.match(matchedPatterns, methodCopy, compiledPattern); |
| if (matches) { |
| return true; // run it, includeMethods takes precedence |
| } |
| } |
| else { |
| if (pattern.equals(methodCopy)) { |
| return true; // run it, includeMethods takes precedence |
| } |
| } |
| } |
| if (excludeMethods.contains("*") ) { |
| return false; |
| } |
| |
| // CHECK ME: Previous implementation used include method |
| for ( String pattern : excludeMethods) { |
| if (pattern.contains("*")) { |
| int[] compiledPattern = wildcard.compilePattern(pattern); |
| HashMap<String, String> matchedPatterns = new HashMap<>(); |
| boolean matches = wildcard.match(matchedPatterns, methodCopy, compiledPattern); |
| if (matches) { |
| // if found, and wasn't included earlier, don't run it |
| return false; |
| } |
| } |
| else { |
| if (pattern.equals(methodCopy)) { |
| // if found, and wasn't included earlier, don't run it |
| return false; |
| } |
| } |
| } |
| |
| |
| // default fall-back from before changes |
| return includeMethods.size() == 0 || includeMethods.contains(method) || includeMethods.contains("*"); |
| } |
| |
| /** |
| * Same as {@link #applyMethod(Set, Set, String)}, except that <code>excludeMethods</code> |
| * and <code>includeMethods</code> are supplied as comma separated string. |
| * |
| * @param excludeMethods comma seperated string of methods to exclude. |
| * @param includeMethods comma seperated string of methods to include. |
| * @param method the specified method to check |
| * @return <tt>true</tt> if the method should be applied. |
| */ |
| public static boolean applyMethod(String excludeMethods, String includeMethods, String method) { |
| Set<String> includeMethodsSet = TextParseUtil.commaDelimitedStringToSet(includeMethods == null? "" : includeMethods); |
| Set<String> excludeMethodsSet = TextParseUtil.commaDelimitedStringToSet(excludeMethods == null? "" : excludeMethods); |
| |
| return applyMethod(excludeMethodsSet, includeMethodsSet, method); |
| } |
| |
| } |