com.pdd.pop.ext.glassfish.grizzly.http.server.StaticHttpHandler Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.pdd.pop.ext.glassfish.grizzly.http.server;
import java.io.File;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.pdd.pop.ext.glassfish.grizzly.Grizzly;
import com.pdd.pop.ext.glassfish.grizzly.http.Method;
import com.pdd.pop.ext.glassfish.grizzly.http.util.Header;
import com.pdd.pop.ext.glassfish.grizzly.http.util.HttpStatus;
import com.pdd.pop.ext.glassfish.grizzly.utils.ArraySet;
/**
* {@link HttpHandler}, which processes requests to a static resources.
*
* @author Jeanfrancois Arcand
* @author Alexey Stashok
*/
public class StaticHttpHandler extends StaticHttpHandlerBase {
private static final Logger LOGGER = Grizzly.logger(StaticHttpHandler.class);
protected final ArraySet docRoots = new ArraySet(File.class);
private boolean directorySlashOff;
/**
* Create HttpHandler, which, by default, will handle requests
* to the static resources located in the current directory.
*/
public StaticHttpHandler() {
addDocRoot(".");
}
/**
* Create a new instance which will look for static pages located
* under the docRoot. If the docRoot is null -
* static pages won't be served by this HttpHandler
*
* @param docRoots the folder(s) where the static resource are located.
* If the docRoot is null - static pages won't be served
* by this HttpHandler
*/
public StaticHttpHandler(String... docRoots) {
if (docRoots != null) {
for (String docRoot : docRoots) {
addDocRoot(docRoot);
}
}
}
/**
* Create a new instance which will look for static pages located
* under the docRoot. If the docRoot is null -
* static pages won't be served by this HttpHandler
*
* @param docRoots the folders where the static resource are located.
* If the docRoot is empty - static pages won't be served
* by this HttpHandler
*/
@SuppressWarnings("UnusedDeclaration")
public StaticHttpHandler(Set docRoots) {
if (docRoots != null) {
for (String docRoot : docRoots) {
addDocRoot(docRoot);
}
}
}
/**
* Return the default directory from where files will be serviced.
* @return the default directory from where file will be serviced.
*/
@SuppressWarnings("UnusedDeclaration")
public File getDefaultDocRoot() {
final File[] array = docRoots.getArray();
return (array != null && array.length > 0) ? array[0] : null;
}
/**
* Return the list of directories where files will be serviced from.
*
* @return the list of directories where files will be serviced from.
*/
public ArraySet getDocRoots() {
return docRoots;
}
/**
* Add the directory to the list of directories where files will be serviced from.
*
* @param docRoot the directory to be added to the list of directories
* where files will be serviced from.
*
* @return return the {@link File} representation of the passed docRoot.
*/
public final File addDocRoot(String docRoot) {
if (docRoot == null) {
throw new NullPointerException("docRoot can't be null");
}
final File file = new File(docRoot);
addDocRoot(file);
return file;
}
/**
* Add the directory to the list of directories where files will be serviced from.
*
* @param docRoot the directory to be added to the list of directories
* where files will be serviced from.
*/
public final void addDocRoot(File docRoot) {
docRoots.add(docRoot);
}
/**
* Removes the directory from the list of directories where static files will be serviced from.
*
* @param docRoot the directory to remove.
*/
@SuppressWarnings("UnusedDeclaration")
public void removeDocRoot(File docRoot) {
docRoots.remove(docRoot);
}
/**
* @return true if HTTP 301 redirect shouldn't be sent when requested
* static resource is a directory, or false otherwise
*/
public boolean isDirectorySlashOff() {
return directorySlashOff;
}
/**
* If the directorySlashOff is true HTTP 301 redirect will not be
* sent when requested static resource is a directory.
*
* @param directorySlashOff
*/
public void setDirectorySlashOff(boolean directorySlashOff) {
this.directorySlashOff = directorySlashOff;
}
// ------------------------------------------------------- Protected Methods
/**
* {@inheritDoc}
*/
@Override
protected boolean handle(final String uri,
final Request request,
final Response response) throws Exception {
boolean found = false;
final File[] fileFolders = docRoots.getArray();
if (fileFolders == null) {
return false;
}
File resource = null;
for (int i = 0; i < fileFolders.length; i++) {
final File webDir = fileFolders[i];
// local file
resource = new File(webDir, uri);
final boolean exists = resource.exists();
final boolean isDirectory = resource.isDirectory();
if (exists && isDirectory) {
if (!directorySlashOff && !uri.endsWith("/")) { // redirect to the same url, but with trailing slash
response.setStatus(HttpStatus.MOVED_PERMANENTLY_301);
response.setHeader(Header.Location,
response.encodeRedirectURL(uri + "/"));
return true;
}
final File f = new File(resource, "/index.html");
if (f.exists()) {
resource = f;
found = true;
break;
}
}
if (isDirectory || !exists) {
found = false;
} else {
found = true;
break;
}
}
if (!found) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, "File not found {0}", resource);
}
return false;
}
assert resource != null;
// If it's not HTTP GET - return method is not supported status
if (!Method.GET.equals(request.getMethod())) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE, "File found {0}, but HTTP method {1} is not allowed",
new Object[] {resource, request.getMethod()});
}
response.setStatus(HttpStatus.METHOD_NOT_ALLOWED_405);
response.setHeader(Header.Allow, "GET");
return true;
}
pickupContentType(response, resource.getPath());
addToFileCache(request, response, resource);
sendFile(response, resource);
return true;
}
}