org.openqa.selenium.server.FutureFileResource Maven / Gradle / Ivy
Go to download
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
// ========================================================================
// $Id: FileResource.java,v 1.31 2006/01/04 13:55:31 gregwilkins Exp $
// Copyright 1996-2004 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.
// ========================================================================
package org.openqa.selenium.server;
import org.openqa.jetty.util.Credential;
import org.openqa.jetty.util.LogSupport;
import org.openqa.jetty.util.Resource;
import org.openqa.jetty.util.URLResource;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.net.URLConnection;
import java.security.Permission;
import java.util.logging.Level;
import java.util.logging.Logger;
/* ------------------------------------------------------------ */
/**
* Future File Resource.
*
* DGF This is as per the standard Jetty FileResource, but its constructor is private, so I've
* copied-and-pasted it rather than extending it. It's just like the regular FileResource, but it
* always claims its lastModified date is in the future, to prevent caching.
*
* Handle resources of implied or explicit file type. This class can check for aliasing in the
* filesystem (eg case insensitivity). By default this is turned on if the platform does not have
* the "/" path separator, or it can be controlled with the
* "org.openqa.jetty.util.FileResource.checkAliases" system parameter.
*
* If alias checking is turned on, then aliased resources are treated as if they do not exist, nor
* can they be created.
*
* @author Greg Wilkins (gregw)
* @version $Revision: 1.31 $
*/
public class FutureFileResource extends URLResource {
private static Logger log = Logger.getLogger(Credential.class.getName());
private static boolean __checkAliases;
static {
__checkAliases =
"true".equalsIgnoreCase
(System.getProperty("org.openqa.jetty.util.FileResource.checkAliases", "true"));
if (__checkAliases)
log.info("Checking Resource aliases");
}
/* ------------------------------------------------------------ */
private File _file;
private transient URL _alias = null;
private transient boolean _aliasChecked = false;
/* ------------------------------------------------------------------------------- */
/**
* setCheckAliases.
*
* @param checkAliases True of resource aliases are to be checked for (eg case insensitivity or
* 8.3 short names) and treated as not found.
*/
public static void setCheckAliases(boolean checkAliases) {
__checkAliases = checkAliases;
}
/* ------------------------------------------------------------------------------- */
/**
* getCheckAliases.
*
* @return True of resource aliases are to be checked for (eg case insensitivity or 8.3 short
* names) and treated as not found.
*/
public static boolean getCheckAliases() {
return __checkAliases;
}
/* -------------------------------------------------------- */
public FutureFileResource(URL url)
throws IOException {
super(url, null);
try {
// Try standard API to convert URL to file.
_file = new File(new URI(url.toString()));
} catch (Exception e) {
// TODO(simon): Why?
// LogSupport.ignore(log,e);
try {
// Assume that File.toURL produced unencoded chars. So try
// encoding them.
String urls =
"file:" + org.openqa.jetty.util.URI.encodePath(url.toString().substring(5));
_file = new File(new URI(urls));
} catch (Exception e2) {
// TODO(simon): Why?
// LogSupport.ignore(log,e2);
// Still can't get the file. Doh! try good old hack!
checkConnection();
Permission perm = _connection.getPermission();
_file = new File(perm == null ? url.getFile() : perm.getName());
}
}
if (_file.isDirectory() && !_urlString.endsWith("/"))
_urlString = _urlString + "/";
}
/* -------------------------------------------------------- */
public FutureFileResource(URL url, URLConnection connection, File file) {
super(url, connection);
_file = file;
if (_file.isDirectory() && !_urlString.endsWith("/"))
_urlString = _urlString + "/";
}
/* -------------------------------------------------------- */
@Override
public Resource addPath(String path)
throws IOException, MalformedURLException {
FutureFileResource r = null;
if (!isDirectory()) {
r = (FutureFileResource) super.addPath(path);
} else {
path = org.openqa.jetty.util.URI.canonicalPath(path);
// treat all paths being added as relative
String rel = path;
if (path.startsWith("/"))
rel = path.substring(1);
File newFile = new File(_file, rel.replace('/', File.separatorChar));
r = new FutureFileResource(newFile.toURI().toURL(), null, newFile);
}
String encoded = org.openqa.jetty.util.URI.encodePath(path);
int expected = r._urlString.length() - encoded.length();
int index = r._urlString.lastIndexOf(encoded, expected);
if (expected != index && ((expected - 1) != index || path.endsWith("/") || !r.isDirectory())) {
r._alias = r._url;
r._aliasChecked = true;
}
return r;
}
/* ------------------------------------------------------------ */
@Override
public URL getAlias() {
if (__checkAliases && !_aliasChecked) {
try {
String abs = _file.getAbsolutePath();
String can = _file.getCanonicalPath();
if (abs.length() != can.length() || !abs.equals(can))
_alias = new File(can).toURI().toURL();
_aliasChecked = true;
if (_alias != null) {
log.fine("ALIAS abs=" + abs);
log.fine("ALIAS can=" + can);
}
} catch (Exception e) {
log.log(Level.WARNING, LogSupport.EXCEPTION, e);
return getURL();
}
}
return _alias;
}
/* -------------------------------------------------------- */
/**
* Returns true if the resource exists.
*/
@Override
public boolean exists() {
return _file.exists();
}
/* -------------------------------------------------------- */
/**
* Returns the lastModified time, which is always in the distant future to prevent caching.
*/
@Override
public long lastModified() {
return System.currentTimeMillis() + (1000l * 3600l * 24l * 365l * 12l);
}
/* -------------------------------------------------------- */
/**
* Returns true if the respresenetd resource is a container/directory.
*/
@Override
public boolean isDirectory() {
return _file.isDirectory();
}
/* --------------------------------------------------------- */
/**
* Return the length of the resource
*/
@Override
public long length() {
return _file.length();
}
/* --------------------------------------------------------- */
/**
* Returns the name of the resource
*/
@Override
public String getName() {
return _file.getAbsolutePath();
}
/* ------------------------------------------------------------ */
/**
* Returns an File representing the given resource or NULL if this is not possible.
*/
@Override
public File getFile() {
return _file;
}
/* --------------------------------------------------------- */
/**
* Returns an input stream to the resource
*/
@Override
public synchronized InputStream getInputStream() throws IOException {
return new FileInputStream(_file);
}
/* --------------------------------------------------------- */
/**
* Returns an output stream to the resource
*/
@Override
public OutputStream getOutputStream()
throws java.io.IOException, SecurityException {
return new FileOutputStream(_file);
}
/* --------------------------------------------------------- */
/**
* Deletes the given resource
*/
@Override
public boolean delete()
throws SecurityException {
return _file.delete();
}
/* --------------------------------------------------------- */
/**
* Rename the given resource
*/
@Override
public boolean renameTo(Resource dest)
throws SecurityException {
if (dest instanceof FutureFileResource) {
return _file.renameTo(((FutureFileResource) dest)._file);
}
return false;
}
/* --------------------------------------------------------- */
/**
* Returns a list of resources contained in the given resource
*/
@Override
public String[] list() {
String[] list = _file.list();
if (list == null)
return null;
for (int i = list.length; i-- > 0;) {
if (new File(_file, list[i]).isDirectory() &&
!list[i].endsWith("/"))
list[i] += "/";
}
return list;
}
/* ------------------------------------------------------------ */
/**
* Encode according to this resource type. File URIs are encoded.
*
* @param uri URI to encode.
* @return The uri unchanged.
*/
@Override
public String encode(String uri) {
return uri;
}
/* ------------------------------------------------------------ */
/**
* @param o
* @return
*/
@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (null == o || !(o instanceof FutureFileResource))
return false;
FutureFileResource f = (FutureFileResource) o;
return f._file == _file || (null != _file && _file.equals(f._file));
}
/* ------------------------------------------------------------ */
/**
* @return the hashcode.
*/
@Override
public int hashCode() {
return null == _file ? super.hashCode() : _file.hashCode();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy