Match a path which may contain a wildcard : Path « File « Java Tutorial

1. Java Tutorial
2. File
3. Path

/*
Copyright (c) 2003 eInnovation Inc. All rights reserved

This library 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.1 of the License, or (at your option) any later version.

This library 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.
*/

/*--

 Copyright (C) 2001-2002 Anthony Eden.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, 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 disclaimer that follows
    these conditions in the documentation and/or other materials
    provided with the distribution.

 3. The name "JPublish" must not be used to endorse or promote products
    derived from this software without prior written permission.  For
    written permission, please contact me@anthonyeden.com.

 4. Products derived from this software may not be called "JPublish", nor
    may "JPublish" appear in their name, without prior written permission
    from Anthony Eden (me@anthonyeden.com).

 In addition, I request (but do not require) that you include in the
 end-user documentation provided with the redistribution and/or in the
 software itself an acknowledgement equivalent to the following:
     "This product includes software developed by
      Anthony Eden (http://www.anthonyeden.com/)."

 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 AUTHOR(S) BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, 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.

 For more information on JPublish, please see <http://www.jpublish.org/>.

 */


/**
 * Utility class for working with request paths.
 *
 * @author Anthony Eden
 */
public final class PathUtilities
{
  private static final String WILDCARD = "*";

  /**
   * Match a path which may contain a wildcard.
   *
   * @param requestPath The request path submitted by the client
   * @param exPath The match path with * wildcard
   *
   * @return DOCME
   */
  public static boolean match(String requestPath, String wildcardPath)
  {
    //  *somestuffhereverylong*  != stuff
    if( wildcardPath.length() - 2 > requestPath.length())
    {
      return false;
    }
    
    //log.debug("match(" + requestPath + "," + exPath + ")");
    int wildcardIndex = wildcardPath.indexOf(WILDCARD);

    if (wildcardIndex == -1)
    {
      return requestPath.equalsIgnoreCase(wildcardPath);
    }
    else if( wildcardPath.charAt(0) == '*' && wildcardPath.charAt(wildcardPath.length()-1) == '*' )
    {
      String path = wildcardPath.substring(1,wildcardPath.length()-1);
      return requestPath.indexOf(path) > -1;
    }
    else if (wildcardIndex == (wildcardPath.length() - 1)) //ends with *
    {
        //log.debug("Wildcard appears at end of match path.");
        String checkString = wildcardPath.substring(0, wildcardPath.length() - 1);

        //  /stuff/* -> /stuff     /stuff/abc* != /stuff/ab
        
        if( checkString.charAt(checkString.length()-1) == '/')
        {
          checkString = checkString.substring(0,checkString.length() - 1);
        }
        //log.debug("String after wildcard removed: " + checkString);
        boolean answer = requestPath.startsWith(checkString);

        //log.debug("Does " + requestPath + " start with " + checkString + "? " + answer);
        return answer;
    }
    else if( wildcardPath.charAt(0) == '*')
    {
      String checkString = wildcardPath.substring(1);

      //log.debug("String after wildcard removed: " + checkString);
      boolean answer = requestPath.endsWith(checkString);
      return answer;
    }
    else
    {
      //log.debug("Wildcard appears in the middle of the string");
      String preMatch = wildcardPath.substring(0, wildcardIndex);
      String postMatch = wildcardPath.substring(wildcardIndex + 1);

      return requestPath.startsWith(preMatch) && requestPath.endsWith(postMatch);
    }
  }
}