bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java - equinox/rt.equinox.bundles - Git at Google

 /*******************************************************************************
  * Copyright (c) 2008 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package org.eclipse.core.runtime;

 import java.io.File;
 import java.net.*;

 /**
  * A utility class for manipulating URIs. This class works around some of the
  * broken behavior of the java.net.URI class.
  *
  * @noinstantiate This class is not intended to be instantiated by clients.
  * @since org.eclipse.equinox.common 3.5
  */
 public final class URIUtil {

 	private static final String SCHEME_FILE = "file"; //$NON-NLS-1$

 	private URIUtil() {
 		// prevent instantiation
 	}

 	/**
 	 * Appends the given extension to the path of the give base URI and returns
 	 * the corresponding new path.
 	 * @param base The base URI to append to
 	 * @param extension The path extension to be added
 	 * @return The appended URI
 	 */
 	public static URI append(URI base, String extension) {
 		try {
 			String path = base.getPath();
 			if (path == null)
 				return appendOpaque(base, extension);
 			//if the base is already a directory then resolve will just do the right thing
 			if (path.endsWith("/")) //$NON-NLS-1$
 				return base.resolve(extension);
 			path = path + "/" + extension; //$NON-NLS-1$
 			return new URI(base.getScheme(), base.getUserInfo(), base.getHost(), base.getPort(), path, base.getQuery(), base.getFragment());
 		} catch (URISyntaxException e) {
 			//shouldn't happen because we started from a valid URI
 			throw new RuntimeException(e);
 		}
 	}

 	/**
 	 * Special case of appending to an opaque URI. Since opaque URIs
 	 * have no path segment the best we can do is append to the scheme-specific part
 	 */
 	private static URI appendOpaque(URI base, String extension) throws URISyntaxException {
 		String ssp = base.getSchemeSpecificPart();
 		if (ssp.endsWith("/")) //$NON-NLS-1$
 			ssp += extension;
 		else
 			ssp = ssp + "/" + extension; //$NON-NLS-1$
 		return new URI(base.getScheme(), ssp, base.getFragment());
 	}

 	/**
 	 * Returns a URI corresponding to the given unencoded string.
 	 * @throws URISyntaxException If the string cannot be formed into a valid URI
 	 */
 	public static URI fromString(String uriString) throws URISyntaxException {
 		int colon = uriString.indexOf(':');
 		int hash = uriString.lastIndexOf('#');
 		boolean noHash = hash < 0;
 		if (noHash)
 			hash = uriString.length();
 		String scheme = colon < 0 ? null : uriString.substring(0, colon);
 		String ssp = uriString.substring(colon + 1, hash);
 		String fragment = noHash ? null : uriString.substring(hash + 1);
 		//use java.io.File for constructing file: URIs
 		if (scheme != null && scheme.equals(SCHEME_FILE)) {
 			//handle relative URI string with scheme (produced by java.net.URL)
 			File file = new File(ssp);
 			if (file.isAbsolute())
 				return file.toURI();
 			scheme = null;
 			if (File.separatorChar != '/')
 				ssp = ssp.replace(File.separatorChar, '/');
 		}
 		return new URI(scheme, ssp, fragment);
 	}

 	/**
 	 * Returns whether the given URI refers to a local file system URI.
 	 * @param uri The URI to check
 	 * @return <code>true</code> if the URI is a local file system location, and <code>false</code> otherwise
 	 */
 	public static boolean isFileURI(URI uri) {
 		return SCHEME_FILE.equalsIgnoreCase(uri.getScheme());
 	}

 	/**
 	 * Returns the last segment of the given URI. For a hierarchical URL this returns
 	 * the last segment of the path. For opaque URIs this treats the scheme-specific
 	 * part as a path and returns the last segment. Returns null if the URI has no
 	 * path or the path is empty.
 	 */
 	public static String lastSegment(URI location) {
 		String path = location.getPath();
 		if (path == null)
 			return new Path(location.getSchemeSpecificPart()).lastSegment();
 		return new Path(path).lastSegment();
 	}

 	/**
 	 * Returns a new URI which is the same as this URI but with
 	 * the file extension removed from the path part.  If this URI does not have an
 	 * extension, this path is returned.
 	 * <p>
 	 * The file extension portion is defined as the string
 	 * following the last period (".") character in the last segment.
 	 * If there is no period in the last segment, the path has no
 	 * file extension portion. If the last segment ends in a period,
 	 * the file extension portion is the empty string.
 	 * </p>
 	 *
 	 * @return the new URI
 	 */
 	public static URI removeFileExtension(URI uri) {
 		String lastSegment = lastSegment(uri);
 		if (lastSegment == null)
 			return uri;
 		int lastIndex = lastSegment.lastIndexOf('.');
 		if (lastIndex == -1)
 			return uri;
 		String uriString = uri.toString();
 		lastIndex = uriString.lastIndexOf('.');
 		uriString = uriString.substring(0, lastIndex);
 		return URI.create(uriString);
 	}

 	/*
 	 * Compares two URI for equality.
 	 * Return false if one of them is null
 	 */
 	public static boolean sameURI(URI url1, URI url2) {
 		if (url1 == url2)
 			return true;
 		if (url1 == null || url2 == null)
 			return false;

 		if (url1.equals(url2))
 			return true;

 		if (sameString(url1.getScheme(), url2.getScheme()) && sameString(url1.getSchemeSpecificPart(), url2.getSchemeSpecificPart()) && sameString(url1.getFragment(), url2.getFragment()))
 			return true;

 		if (url1.isAbsolute() != url2.isAbsolute())
 			return false;

 		// check if we have two local file references that are case variants
 		File file1 = toFile(url1);
 		return file1 == null ? false : file1.equals(toFile(url2));
 	}

 	private static boolean sameString(String s1, String s2) {
 		return (s1 == s2) || s1 != null && s1.equals(s2);
 	}

 	/**
 	 * Returns the URI as a local file, or <code>null</code> if the given
 	 * URI does not represent a local file.
 	 * @param uri The URI to return the file for
 	 * @return The local file corresponding to the given URI, or <code>null</code>
 	 */
 	public static File toFile(URI uri) {
 		try {
 			if (!SCHEME_FILE.equalsIgnoreCase(uri.getScheme()))
 				return null;
 			//assume all illegal characters have been properly encoded, so use URI class to unencode
 			return new File(uri);
 		} catch (IllegalArgumentException e) {
 			//File constructor does not support non-hierarchical URI
 			String path = uri.getPath();
 			//path is null for non-hierarchical URI such as file:c:/tmp
 			if (path == null)
 				path = uri.getSchemeSpecificPart();
 			return new File(path);
 		}
 	}

 	/**
 	 * Returns the URL as a URI. This method will handle broken URLs that are
 	 * not properly encoded (for example they contain unencoded space characters).
 	 */
 	public static URI toURI(URL url) throws URISyntaxException {
 		//URL behaves differently across platforms so for file: URLs we parse from string form
 		if (SCHEME_FILE.equals(url.getProtocol())) {
 			String pathString = url.toExternalForm().substring(5);
 			//ensure there is a leading slash to handle common malformed URLs such as file:c:/tmp
 			if (pathString.indexOf('/') != 0)
 				pathString = '/' + pathString;
 			return new URI(SCHEME_FILE, pathString, null);
 		}
 		try {
 			return new URI(url.toExternalForm());
 		} catch (URISyntaxException e) {
 			//try multi-argument URI constructor to perform encoding
 			return new URI(url.getProtocol(), url.getUserInfo(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef());
 		}
 	}

 	/**
 	 * Returns a URI as a URL.
 	 *
 	 * @throws MalformedURLException
 	 */
 	public static URL toURL(URI uri) throws MalformedURLException {
 		return new URL(uri.toString());
 	}

 	/**
 	 * Returns a string representation of the given URI that doesn't have illegal
 	 * characters encoded. This string is suitable for later passing to {@link #fromString(String)}.
 	 * @param uri The URI to convert to string format
 	 * @return An unencoded string representation of the URI
 	 */
 	public static String toUnencodedString(URI uri) {
 		StringBuffer result = new StringBuffer();
 		String scheme = uri.getScheme();
 		if (scheme != null)
 			result.append(scheme).append(':');
 		//there is always a ssp
 		result.append(uri.getSchemeSpecificPart());
 		String fragment = uri.getFragment();
 		if (fragment != null)
 			result.append('#').append(fragment);
 		return result.toString();
 	}

 	/**
 	 * Returns an absolute URI that is created by appending the given relative URI to
 	 * the given base.  If the <tt>relative</tt> URI is already absolute it is simply returned.
 	 * <p>
 	 * This method is guaranteed to be the inverse of {@link #makeRelative(URI, URI)}.
 	 * That is, if R = makeRelative(O, B), then makeAbsolute(R, B), will return the original
 	 * URI O.
 	 *
 	 * @param relative the relative URI
 	 * @param baseURI the base URI
 	 * @return an absolute URI
 	 */
 	public static URI makeAbsolute(URI relative, URI baseURI) {
 		if (relative.isAbsolute())
 			return relative;
 		return append(baseURI, relative.toString()).normalize();
 	}

 	/**
 	 * Returns a URI equivalent to the given original URI, but relative to the given base
 	 * URI if possible.
 	 * <p>
 	 * This method is equivalent to {@link java.net.URI#relativize}, except for its
 	 * handling of file URIs. For file URIs, this method handles file system path devices.
 	 * If the URIs are not on the same device, then the original URI is returned.
 	 *
 	 * @param original the original URI
 	 * @param baseURI the base URI
 	 * @return a relative URI
 	 */
 	public static URI makeRelative(URI original, URI baseURI) {
 		// for non-local URIs just use the built in relativize method
 		if (!SCHEME_FILE.equals(original.getScheme()) || !SCHEME_FILE.equals(baseURI.getScheme()))
 			return baseURI.relativize(original);

 		IPath originalPath = new Path(original.getSchemeSpecificPart());
 		IPath basePath = new Path(baseURI.getSchemeSpecificPart());

 		// make sure we have an absolute path to start
 		if (!basePath.isAbsolute())
 			return original;
 		IPath relativePath = originalPath.makeRelativeTo(basePath);
 		//if we could not make it relative, just return the original URI
 		if (relativePath == originalPath)
 			return original;
 		try {
 			return new URI(null, relativePath.toString(), null);
 		} catch (URISyntaxException e) {
 			//cannot make a relative path, just return the original
 			return original;
 		}
 	}

 }
	/*******************************************************************************
	* Copyright (c) 2008 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/
	package org.eclipse.core.runtime;

	import java.io.File;
	import java.net.*;

	/**
	* A utility class for manipulating URIs. This class works around some of the
	* broken behavior of the java.net.URI class.
	*
	* @noinstantiate This class is not intended to be instantiated by clients.
	* @since org.eclipse.equinox.common 3.5
	*/
	public final class URIUtil {

	private static final String SCHEME_FILE = "file"; //$NON-NLS-1$

	private URIUtil() {
	// prevent instantiation
	}

	/**
	* Appends the given extension to the path of the give base URI and returns
	* the corresponding new path.
	* @param base The base URI to append to
	* @param extension The path extension to be added
	* @return The appended URI
	*/
	public static URI append(URI base, String extension) {
	try {
	String path = base.getPath();
	if (path == null)
	return appendOpaque(base, extension);
	//if the base is already a directory then resolve will just do the right thing
	if (path.endsWith("/")) //$NON-NLS-1$
	return base.resolve(extension);
	path = path + "/" + extension; //$NON-NLS-1$
	return new URI(base.getScheme(), base.getUserInfo(), base.getHost(), base.getPort(), path, base.getQuery(), base.getFragment());
	} catch (URISyntaxException e) {
	//shouldn't happen because we started from a valid URI
	throw new RuntimeException(e);
	}
	}

	/**
	* Special case of appending to an opaque URI. Since opaque URIs
	* have no path segment the best we can do is append to the scheme-specific part
	*/
	private static URI appendOpaque(URI base, String extension) throws URISyntaxException {
	String ssp = base.getSchemeSpecificPart();
	if (ssp.endsWith("/")) //$NON-NLS-1$
	ssp += extension;
	else
	ssp = ssp + "/" + extension; //$NON-NLS-1$
	return new URI(base.getScheme(), ssp, base.getFragment());
	}

	/**
	* Returns a URI corresponding to the given unencoded string.
	* @throws URISyntaxException If the string cannot be formed into a valid URI
	*/
	public static URI fromString(String uriString) throws URISyntaxException {
	int colon = uriString.indexOf(':');
	int hash = uriString.lastIndexOf('#');
	boolean noHash = hash < 0;
	if (noHash)
	hash = uriString.length();
	String scheme = colon < 0 ? null : uriString.substring(0, colon);
	String ssp = uriString.substring(colon + 1, hash);
	String fragment = noHash ? null : uriString.substring(hash + 1);
	//use java.io.File for constructing file: URIs
	if (scheme != null && scheme.equals(SCHEME_FILE)) {
	//handle relative URI string with scheme (produced by java.net.URL)
	File file = new File(ssp);
	if (file.isAbsolute())
	return file.toURI();
	scheme = null;
	if (File.separatorChar != '/')
	ssp = ssp.replace(File.separatorChar, '/');
	}
	return new URI(scheme, ssp, fragment);
	}

	/**
	* Returns whether the given URI refers to a local file system URI.
	* @param uri The URI to check
	* @return <code>true</code> if the URI is a local file system location, and <code>false</code> otherwise
	*/
	public static boolean isFileURI(URI uri) {
	return SCHEME_FILE.equalsIgnoreCase(uri.getScheme());
	}

	/**
	* Returns the last segment of the given URI. For a hierarchical URL this returns
	* the last segment of the path. For opaque URIs this treats the scheme-specific
	* part as a path and returns the last segment. Returns null if the URI has no
	* path or the path is empty.
	*/
	public static String lastSegment(URI location) {
	String path = location.getPath();
	if (path == null)
	return new Path(location.getSchemeSpecificPart()).lastSegment();
	return new Path(path).lastSegment();
	}

	/**
	* Returns a new URI which is the same as this URI but with
	* the file extension removed from the path part. If this URI does not have an
	* extension, this path is returned.
	* <p>
	* The file extension portion is defined as the string
	* following the last period (".") character in the last segment.
	* If there is no period in the last segment, the path has no
	* file extension portion. If the last segment ends in a period,
	* the file extension portion is the empty string.
	* </p>
	*
	* @return the new URI
	*/
	public static URI removeFileExtension(URI uri) {
	String lastSegment = lastSegment(uri);
	if (lastSegment == null)
	return uri;
	int lastIndex = lastSegment.lastIndexOf('.');
	if (lastIndex == -1)
	return uri;
	String uriString = uri.toString();
	lastIndex = uriString.lastIndexOf('.');
	uriString = uriString.substring(0, lastIndex);
	return URI.create(uriString);
	}

	/*
	* Compares two URI for equality.
	* Return false if one of them is null
	*/
	public static boolean sameURI(URI url1, URI url2) {
	if (url1 == url2)
	return true;
	if (url1 == null \|\| url2 == null)
	return false;

	if (url1.equals(url2))
	return true;

	if (sameString(url1.getScheme(), url2.getScheme()) && sameString(url1.getSchemeSpecificPart(), url2.getSchemeSpecificPart()) && sameString(url1.getFragment(), url2.getFragment()))
	return true;

	if (url1.isAbsolute() != url2.isAbsolute())
	return false;

	// check if we have two local file references that are case variants
	File file1 = toFile(url1);
	return file1 == null ? false : file1.equals(toFile(url2));
	}

	private static boolean sameString(String s1, String s2) {
	return (s1 == s2) \|\| s1 != null && s1.equals(s2);
	}

	/**
	* Returns the URI as a local file, or <code>null</code> if the given
	* URI does not represent a local file.
	* @param uri The URI to return the file for
	* @return The local file corresponding to the given URI, or <code>null</code>
	*/
	public static File toFile(URI uri) {
	try {
	if (!SCHEME_FILE.equalsIgnoreCase(uri.getScheme()))
	return null;
	//assume all illegal characters have been properly encoded, so use URI class to unencode
	return new File(uri);
	} catch (IllegalArgumentException e) {
	//File constructor does not support non-hierarchical URI
	String path = uri.getPath();
	//path is null for non-hierarchical URI such as file:c:/tmp
	if (path == null)
	path = uri.getSchemeSpecificPart();
	return new File(path);
	}
	}

	/**
	* Returns the URL as a URI. This method will handle broken URLs that are
	* not properly encoded (for example they contain unencoded space characters).
	*/
	public static URI toURI(URL url) throws URISyntaxException {
	//URL behaves differently across platforms so for file: URLs we parse from string form
	if (SCHEME_FILE.equals(url.getProtocol())) {
	String pathString = url.toExternalForm().substring(5);
	//ensure there is a leading slash to handle common malformed URLs such as file:c:/tmp
	if (pathString.indexOf('/') != 0)
	pathString = '/' + pathString;
	return new URI(SCHEME_FILE, pathString, null);
	}
	try {
	return new URI(url.toExternalForm());
	} catch (URISyntaxException e) {
	//try multi-argument URI constructor to perform encoding
	return new URI(url.getProtocol(), url.getUserInfo(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef());
	}
	}

	/**
	* Returns a URI as a URL.
	*
	* @throws MalformedURLException
	*/
	public static URL toURL(URI uri) throws MalformedURLException {
	return new URL(uri.toString());
	}

	/**
	* Returns a string representation of the given URI that doesn't have illegal
	* characters encoded. This string is suitable for later passing to {@link #fromString(String)}.
	* @param uri The URI to convert to string format
	* @return An unencoded string representation of the URI
	*/
	public static String toUnencodedString(URI uri) {
	StringBuffer result = new StringBuffer();
	String scheme = uri.getScheme();
	if (scheme != null)
	result.append(scheme).append(':');
	//there is always a ssp
	result.append(uri.getSchemeSpecificPart());
	String fragment = uri.getFragment();
	if (fragment != null)
	result.append('#').append(fragment);
	return result.toString();
	}

	/**
	* Returns an absolute URI that is created by appending the given relative URI to
	* the given base. If the <tt>relative</tt> URI is already absolute it is simply returned.
	* <p>
	* This method is guaranteed to be the inverse of {@link #makeRelative(URI, URI)}.
	* That is, if R = makeRelative(O, B), then makeAbsolute(R, B), will return the original
	* URI O.
	*
	* @param relative the relative URI
	* @param baseURI the base URI
	* @return an absolute URI
	*/
	public static URI makeAbsolute(URI relative, URI baseURI) {
	if (relative.isAbsolute())
	return relative;
	return append(baseURI, relative.toString()).normalize();
	}

	/**
	* Returns a URI equivalent to the given original URI, but relative to the given base
	* URI if possible.
	* <p>
	* This method is equivalent to {@link java.net.URI#relativize}, except for its
	* handling of file URIs. For file URIs, this method handles file system path devices.
	* If the URIs are not on the same device, then the original URI is returned.
	*
	* @param original the original URI
	* @param baseURI the base URI
	* @return a relative URI
	*/
	public static URI makeRelative(URI original, URI baseURI) {
	// for non-local URIs just use the built in relativize method
	if (!SCHEME_FILE.equals(original.getScheme()) \|\| !SCHEME_FILE.equals(baseURI.getScheme()))
	return baseURI.relativize(original);

	IPath originalPath = new Path(original.getSchemeSpecificPart());
	IPath basePath = new Path(baseURI.getSchemeSpecificPart());

	// make sure we have an absolute path to start
	if (!basePath.isAbsolute())
	return original;
	IPath relativePath = originalPath.makeRelativeTo(basePath);
	//if we could not make it relative, just return the original URI
	if (relativePath == originalPath)
	return original;
	try {
	return new URI(null, relativePath.toString(), null);
	} catch (URISyntaxException e) {
	//cannot make a relative path, just return the original
	return original;
	}
	}

	}