Convert a path to a cananonical form : Path « File Input Output « Java






Convert a path to a cananonical form

  
// 
// Copyright 2004-2005 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// Licensed 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.
// 

/**
 * URI Holder. This class assists with the decoding and encoding or HTTP URI's.
 * It differs from the java.net.URL class as it does not provide communications
 * ability, but it does assist with query string formatting.
 * <P>
 * UTF-8 encoding is used by default for % encoded characters. This may be
 * overridden with the org.mortbay.util.URI.charset system property.
 * 
 * @see UrlEncoded
 * @author Greg Wilkins (gregw)
 */
public class Utils {
  /**
   * Convert a path to a cananonical form. All instances of "." and ".." are
   * factored out. Null is returned if the path tries to .. above its root.
   * 
   * @param path
   * @return path or null.
   */
  public static String canonicalPath(String path) {
    if (path == null || path.length() == 0)
      return path;

    int end = path.length();
    int queryIdx = path.indexOf('?');
    int start = path.lastIndexOf('/', (queryIdx > 0 ? queryIdx : end));

    search: while (end > 0) {
      switch (end - start) {
      case 2: // possible single dot
        if (path.charAt(start + 1) != '.')
          break;
        break search;
      case 3: // possible double dot
        if (path.charAt(start + 1) != '.' || path.charAt(start + 2) != '.')
          break;
        break search;
      }

      end = start;
      start = path.lastIndexOf('/', end - 1);
    }

    // If we have checked the entire string
    if (start >= end)
      return path;

    StringBuffer buf = new StringBuffer(path);
    int delStart = -1;
    int delEnd = -1;
    int skip = 0;

    while (end > 0) {
      switch (end - start) {
      case 2: // possible single dot
        if (buf.charAt(start + 1) != '.') {
          if (skip > 0 && --skip == 0) {
            delStart = start >= 0 ? start : 0;
            if (delStart > 0 && delEnd == buf.length() && buf.charAt(delEnd - 1) == '.')
              delStart++;
          }
          break;
        }

        if (start < 0 && buf.length() > 2 && buf.charAt(1) == '/' && buf.charAt(2) == '/')
          break;

        if (delEnd < 0)
          delEnd = end;
        delStart = start;
        if (delStart < 0 || delStart == 0 && buf.charAt(delStart) == '/') {
          delStart++;
          if (delEnd < buf.length() && buf.charAt(delEnd) == '/')
            delEnd++;
          break;
        }
        if (end == buf.length())
          delStart++;

        end = start--;
        while (start >= 0 && buf.charAt(start) != '/')
          start--;
        continue;

      case 3: // possible double dot
        if (buf.charAt(start + 1) != '.' || buf.charAt(start + 2) != '.') {
          if (skip > 0 && --skip == 0) {
            delStart = start >= 0 ? start : 0;
            if (delStart > 0 && delEnd == buf.length() && buf.charAt(delEnd - 1) == '.')
              delStart++;
          }
          break;
        }

        delStart = start;
        if (delEnd < 0)
          delEnd = end;

        skip++;
        end = start--;
        while (start >= 0 && buf.charAt(start) != '/')
          start--;
        continue;

      default:
        if (skip > 0 && --skip == 0) {
          delStart = start >= 0 ? start : 0;
          if (delEnd == buf.length() && buf.charAt(delEnd - 1) == '.')
            delStart++;
        }
      }

      // Do the delete
      if (skip <= 0 && delStart >= 0 && delStart >= 0) {
        buf.delete(delStart, delEnd);
        delStart = delEnd = -1;
        if (skip > 0)
          delEnd = end;
      }

      end = start--;
      while (start >= 0 && buf.charAt(start) != '/')
        start--;
    }

    // Too many ..
    if (skip > 0)
      return null;

    // Do the delete
    if (delEnd >= 0)
      buf.delete(delStart, delEnd);

    return buf.toString();
  }

}

   
    
  








Related examples in the same category

1.Returns the path of the given resource.
2.Remove path and file information from a filename returning only its extension component
3.Absolutize a relative resource path on the given absolute base path.
4.Remove File Name SuffixRemove File Name Suffix
5.A utility class for manipulating paths
6.Strip File Extension
7.Get relative path
8.Fixes the file sperator char for the target platform using the following replacement.
9.Concatenates an array of string using a seperator.
10.Rename To Temporary Name
11.Match a path which may contain a wildcard
12.Merges the two paths to create a valid version of the second path
13.General filename and filepath manipulation utilities
14.Extract File Extension
15.Get File Name SuffixGet File Name Suffix
16.Extract the page path from the given request path
17.File name Utils
18.Convert a list of path elements to a platform-specific path.
19.Change File Name To Class NameChange File Name To Class Name
20.strip Extension name
21.Create File Name with specified white space character
22.Build a relative path to the given base path
23.Checks, whether the child directory is a subdirectory of the base directory.
24.Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out.
25.Return the path within a base directory
26.Decode a path.
27.Extract file name (without path and suffix) from file name with path and suffix
28.Extract file name (without path but with suffix) from file name with path and suffix
29.Build a path, but do not create it
30.Build a directory path - creating directories if neccesary
31.Collection of file path related stuff
32.Path Util
33.Get the first/last token from a path
34.Calculates the relative path between a specified root directory and a target path.
35.Get relative Path