fileservice/src/main/java/org/apache/asyncweb/fileservice/FileHttpService.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.apache.asyncweb.fileservice;

import java.io.File;
import java.io.FilenameFilter;
import java.net.URI;
import java.security.InvalidParameterException;
import java.util.regex.Pattern;

import org.apache.asyncweb.common.DefaultHttpResponse;
import org.apache.asyncweb.common.HttpResponseStatus;
import org.apache.asyncweb.common.MutableHttpResponse;
import org.apache.asyncweb.examples.file.cache.CachingPolicy;
import org.apache.asyncweb.examples.file.cache.SimpleCachingPolicy;
import org.apache.asyncweb.examples.file.fileloader.FileLoader;
import org.apache.asyncweb.examples.file.fileloader.SimpleFileLoader;
import org.apache.asyncweb.examples.file.index.DefaultDirectoryIndexGenerator;
import org.apache.asyncweb.examples.file.index.DirectoryIndexGenerator;
import org.apache.asyncweb.examples.file.mimetype.MimeMap;
import org.apache.asyncweb.server.HttpService;
import org.apache.asyncweb.server.HttpServiceContext;
import org.apache.mina.common.IoBuffer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * An HTTP service, serving files from the filesystem.
 *
 * @author The Apache MINA Project (dev@mina.apache.org)
 */
public class FileHttpService implements HttpService {
    private static final Logger LOG = LoggerFactory
            .getLogger(FileHttpService.class);

    private String baseUrl;

    private String basePath;

    private CachingPolicy cachingPolicy = new SimpleCachingPolicy();

    private MimeMap mimeMap = new MimeMap();

    private FilenameFilter indexFileFilter;

    private DirectoryIndexGenerator indexGenerator = new DefaultDirectoryIndexGenerator();
    
    private FileLoader fileLoader = new SimpleFileLoader();

    public FileHttpService(String baseUrl, String basePath,
            String directoryIndexPattern) {
        this.baseUrl = baseUrl;
        this.basePath = basePath;
        this.indexFileFilter = new RegExpFilenameFilter(Pattern
                .compile(directoryIndexPattern));

        if (baseUrl == null || basePath == null) {
            throw new InvalidParameterException("Null parameters");
        }

        File f = new File(basePath);

        if (!(f.isDirectory() && f.exists())) {
            
            throw new InvalidParameterException("The base path [ " + basePath
                    + " ] is not a valid path.");
        }
    }

    public FileHttpService(String baseUrl, String basePath) {
        this(baseUrl, basePath, "index.html");
    }

    public void handleRequest(HttpServiceContext context) throws Exception {
        URI uri = context.getRequest().getRequestUri();
        String path = uri.getPath();
        
        LOG.info("Handling file request : {} from {}",uri,context.getRemoteAddress());

        if (!path.startsWith(baseUrl)) {
            // error the requested URL is not in the base URL
            //TODO : find the good exception to throw
            throw new InvalidParameterException("Wrong URL");
        }

        MutableHttpResponse response = new DefaultHttpResponse();

        path = path.substring(baseUrl.length());
        File f = new File(basePath + File.separator + path);

        if (f.isDirectory()) {

            // is the request finishing by the '/' character ?
            String urlStr = uri.toString();

            if (urlStr.charAt(urlStr.length() - 1) != '/') {

                LOG.debug("Redirecting {} to {}/", urlStr, urlStr);

                // send back the good URI
                response.setStatus(HttpResponseStatus.MOVED_PERMANENTLY);
                response.setHeader("Location", urlStr + "/");
                context.commitResponse(response);
                return;
            }

            // search for index file
            String[] indexes = f.list(indexFileFilter);
            if (indexes.length == 0) {

                LOG.info("Serving directory index for {}", f.getAbsolutePath());

                if (indexGenerator != null) {
                    // create a directory index page
                    IoBuffer indexResponse = indexGenerator.generateIndex(f);
                    indexResponse.flip();
                    response.setContent(indexResponse);
                    response.setHeader("Content-Type", "text/html");
                    response.setStatus(HttpResponseStatus.OK);
                    context.commitResponse(response);
                    return;
                }
            } else {
                // just serve the index file (ex:index.html) 
                f = new File(f.getAbsolutePath() + File.separator + indexes[0]);
            }

        }
        if (f.exists() && !f.isDirectory()) {

            LOG.info("Serving file {}",f.getAbsolutePath());

            // caching processing
            if (cachingPolicy == null
                    || !cachingPolicy.isCacheable(f, context.getRequest())) {
                response.setHeader("Pragma", "no-cache");
                response.setHeader("Cache-Control", "no-cache");
            } else {
                cachingPolicy.testAndSetCacheHit(f, context.getRequest(),
                        response);
            }

            // setting mime-type based on the mime-map

            String contentType = mimeMap.getContentType(MimeMap.getExtension(f
                    .getName()));

            if (contentType != null)
                response.setHeader("Content-Type", contentType);

            response.setStatus(HttpResponseStatus.OK);

            IoBuffer buffer=fileLoader.loadFile(f);
            
            response.setContent(buffer);
            
        } else {
            // the file is not found, we send the famous 404 error
            response.setStatus(HttpResponseStatus.NOT_FOUND);
            response.setStatusReasonPhrase("File \"" + path + "\"");
            LOG.warn("The file {} is not found",f.getAbsolutePath());
        }
        context.commitResponse(response);

    }

    public CachingPolicy getCachingPolicy() {
        return cachingPolicy;
    }

    public void setCachingPolicy(CachingPolicy cachingPolicy) {
        this.cachingPolicy = cachingPolicy;
    }

    public void start() {
        // nothing to do there
    }

    public void stop() {
        // nothing to do there
    }

    private class RegExpFilenameFilter implements FilenameFilter {
        private Pattern pattern;

        public RegExpFilenameFilter(Pattern pattern) {
            this.pattern = pattern;
        }

        public boolean accept(File dir, String name) {
            return pattern.matcher(name).matches();
        }

    }

	public FileLoader getFileLoader() {
		return fileLoader;
	}

	public void setFileLoader(FileLoader fileLoader) {
		this.fileLoader = fileLoader;
	}
}