org.owasp.validator.html.util.URIUtils Maven / Gradle / Ivy

/*
 * Copyright (c) 2007-2011, Arshan Dabirsiaghi, Jason Li
 * 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 * Neither the name of OWASP nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR
 * CONTRIBUTORS 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.
 */

package org.owasp.validator.html.util;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Stack;
import java.util.StringTokenizer;

/**
 * A utility class for URI handling
 *
 * @author Keith Visco
 **/
public class URIUtils {

	/**
	 * the File protocol
	 **/
	private static final String FILE_PROTOCOL_PREFIX = "file:///";
	/**
	 * the path separator for an URI
	 */
	private static final char HREF_PATH_SEP = '/';
	/**
	 * the path separate for a URL as a String
	 */
	private static final String URL_PATH_SEP_STR = "/";
	/**
	 * The current directory designator
	 */
	private static final String CURRENT_DIR_OP = ".";
	/**
	 * The parent directory designator
	 */
	private static final String PARENT_DIR_OP = "..";

	/**
	 *
	 **/
	public static String resolveAsString(String href, String documentBase) {

		try {
			//-- try to create a new URL and see if MalformedURLExcetion is
			//-- ever thrown
			new URL(href);
			return href;
		} catch (MalformedURLException muex) {
		}


		//-- join document base + href
		String absolute = null;
		if ((documentBase != null) && (documentBase.length() > 0)) {
			int idx = documentBase.lastIndexOf(HREF_PATH_SEP);
			if (idx == (documentBase.length() - 1)) {
				absolute = documentBase + href;
			} else {
				absolute = documentBase + HREF_PATH_SEP + href;
			}


		} else {
			absolute = href;
		}


		try {
			//-- try to create a new URL and see if MalformedURLExcetion is
			//-- ever thrown

			if (absolute.indexOf("./") >= 0) {
				//-- normalize . or .. from URL
				absolute = normalize(absolute);
			}
			new URL(absolute);
			return absolute;
		} catch (MalformedURLException muex) {
			//-- check for unrecognized protocol
			int idx = absolute.indexOf(':');
			if (idx >= 0) {
				String scheme = absolute.substring(0, idx);
				//-- a bit of a hack, but good enough for now
				String error = "unknown protocol: " + scheme;
				if (error.equals(muex.getMessage())) {
					return absolute;
				}
			}

		}


		// Try local files
		String fileURL = absolute;
		File iFile = new File(href);
		boolean exists = iFile.exists();
		fileURL = createFileURL(iFile.getAbsolutePath());
		if (!iFile.isAbsolute()) {
			iFile = new File(absolute);
			if (iFile.exists() || (!exists)) {
				fileURL = createFileURL(iFile.getAbsolutePath());
			}
		}

		//-- one last sanity check
		try {
			//-- try to create a new URL and see if MalformedURLExcetion is
			//-- ever thrown
			new URL(fileURL);
			return fileURL;
		} catch (MalformedURLException muex) {
		}

		//-- At this point we we're unsucessful at trying to resolve
		//-- the href + documentbase, this could be due to a custom
		//-- protocol or typo in the URI, just return documentBase +
		//-- href
		return absolute;
	} //-- resolveHref

	/**
	 * This method removes "." or ".." from absolute URL.
	 * I needed this method because the JDK doesn't do this
	 * automatically when creating URLs.
	 *
	 * @param absoluteURL the absolute URI to normalize
	 */
	public static String normalize(String absoluteURL)
			throws MalformedURLException {
		if (absoluteURL == null) {
			return absoluteURL;
		}
		if (absoluteURL.indexOf('.') < 0) {
			return absoluteURL;
		}

		//-- Note: using StringTokenizer and Stacks
		//-- is not very efficient, this may need
		//-- some optimizing
		Stack tokens = new Stack();
		StringTokenizer st = new StringTokenizer(absoluteURL, URL_PATH_SEP_STR, true);
		String last = null;
		while (st.hasMoreTokens()) {
			String token = st.nextToken();
			if (URL_PATH_SEP_STR.equals(token)) {
				if (URL_PATH_SEP_STR.equals(last)) {
					tokens.push("");
				}
			} else if (PARENT_DIR_OP.equals(token)) {
				if (tokens.empty()) {
					//-- this should be an error
					throw new MalformedURLException("invalid absolute URL: " + absoluteURL);
				}
				tokens.pop();
			} else {
				if (!CURRENT_DIR_OP.equals(token)) {
					tokens.push(token);
				}
			}
			last = token;
		}

		//-- rebuild URL
		StringBuffer buffer = new StringBuffer(absoluteURL.length());
		for (int i = 0; i < tokens.size(); i++) {
			if (i > 0) {
				buffer.append(HREF_PATH_SEP);
			}
			buffer.append(tokens.elementAt(i).toString());
		}
		return buffer.toString();
	} //-- normalize

	/**
	 * Creates a File URL for the given file name
	 *
	 * @param filename the name of the file
	 * @return the String representation of the File URL
	 **/
	private static String createFileURL(String filename) {

		if (filename == null) {
			return FILE_PROTOCOL_PREFIX;
		}
		int size = filename.length() + FILE_PROTOCOL_PREFIX.length();
		StringBuffer sb = new StringBuffer(size);
		sb.append(FILE_PROTOCOL_PREFIX);
		char[] chars = filename.toCharArray();
		for (int i = 0; i < chars.length; i++) {
			char ch = chars[i];
			switch (ch) {
			case '\\':
				sb.append(HREF_PATH_SEP);
				break;
			default:
				sb.append(ch);
				break;

			}
		}
		return sb.toString();
	} //-- createFileURL

}