ResourcesPage.java

/* 
 * The MIT License
 *
 * Copyright 2013 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.mastfrog.acteur.resources;

import com.google.common.net.MediaType;
import com.google.inject.Inject;
import com.mastfrog.acteur.Acteur;
import com.mastfrog.acteur.ActeurFactory;
import com.mastfrog.acteur.HttpEvent;
import com.mastfrog.acteur.headers.Headers;
import com.mastfrog.acteur.Page;
import com.mastfrog.acteur.Response;
import com.mastfrog.acteur.headers.Method;
import com.mastfrog.acteur.preconditions.Description;
import com.mastfrog.acteur.resources.StaticResources.Resource;
import com.mastfrog.settings.Settings;
import com.mastfrog.url.Path;
import io.netty.handler.codec.http.HttpResponseStatus;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.joda.time.DateTime;

/**
 *
 * @author Tim Boudreau
 */
@Description("Serves static files")
public class ResourcesPage extends Page {

    /**
     * Settings key for the url path under which static resources live.
     * <b>Important</b>: This is a regex, and it needs to end in a capture group
     * - for example,
     * <code>static/(.*)</code>.
     */
    public static final String SETTINGS_KEY_STATIC_RESOURCES_BASE_URL_PATH = "static.base.url.path";

    @Inject
    public ResourcesPage(ActeurFactory af, StaticResources r, Settings settings) {
        add(af.matchMethods(Method.GET, Method.HEAD));
        String base = settings.getString(SETTINGS_KEY_STATIC_RESOURCES_BASE_URL_PATH);
        if (base != null) {
            add(af.matchPath(base));
        }
//        add(af.matchPath(r.getPatterns()));
        add(ResourceNameMatcher.class);
        add(af.sendNotModifiedIfIfModifiedSinceHeaderMatches());
        add(af.sendNotModifiedIfETagHeaderMatches());
        add(BytesWriter.class);
    }

    static boolean chunked = true;
    private static final class ResourceNameMatcher extends Acteur {

        @Inject
        ResourceNameMatcher(HttpEvent evt, StaticResources res, Settings settings, ExpiresPolicy policy, Page page) throws UnsupportedEncodingException {
            String base = settings.getString(SETTINGS_KEY_STATIC_RESOURCES_BASE_URL_PATH);
            String path = evt.getPath().toString();
            if (base != null && !base.isEmpty()) {
                Pattern p = Pattern.compile(base);
                Matcher m = p.matcher(path);
                if (m.find()) {
                    path = m.group(1);
                }
            }
            path = URLDecoder.decode(path, "UTF-8");
            for (String pat : res.getPatterns()) {
                if (path.equals(pat)) {
                    Resource r = res.get(path);
                    if (r == null) {
                        reject();
                        return;
                    } else {
                        r.decoratePage(page, evt, path, response(), chunked);
                        MediaType mimeType = r.getContentType();
                        if (mimeType != null) {
                            DateTime dt = policy.get(mimeType, Path.parse(path));
                            if (dt != null) {
                                add(Headers.EXPIRES, dt);
                            }
                        }
//                        setState(new ConsumedLockedState(r));
                        next(r);
                        return;
                    }
                }
            }
            reject();
        }
    }

    private static class BytesWriter extends Acteur {

        @Inject
        BytesWriter(HttpEvent evt, Resource r) {
            setState(new RespondWith(HttpResponseStatus.OK));
            setChunked(false);
            if (evt.getMethod() != Method.HEAD) {
                Response rr = response();
                r.attachBytes(evt, rr, chunked);
            }
        }
    }
}