GearsLocalServerManifestController.java

/*
 * Copyright 2008 Jeff Dwyer
 * 
 * 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 com.apress.progwt.server.web.controllers;

import java.io.File;
import java.io.IOException;
import java.io.Writer;

import org.apache.log4j.Logger;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.apress.progwt.server.util.HostPrecedingPropertyPlaceholderConfigurer;
import com.apress.progwt.server.util.RandomUtils;

/**
 * Displays the ENTIRE directory. Which isn't so good. Could filter on
 * user-agent...
 * 
 * @author Jeff Dwyer
 * 
 */
@Controller
@RequestMapping("/manifest.json")
public class GearsLocalServerManifestController {
    private static final Logger log = Logger
            .getLogger(GearsLocalServerManifestController.class);


    @Autowired
    @Qualifier(value = "propertyConfigurer")
    private HostPrecedingPropertyPlaceholderConfigurer hostConfigurer;

    

    public void setHostConfigurer(
            HostPrecedingPropertyPlaceholderConfigurer hostConfigurer) {
        this.hostConfigurer = hostConfigurer;
    }

    
    protected String getProperty(String name){
        return hostConfigurer.resolvePlaceholder(name);
    }
    

    private static String manifest;

    /**
     * { "betaManifestVersion": 1, "version": "my_version_string",
     * "entries": [ { "url": "go_offline.html"}, { "url":
     * "go_offline.js"}, { "url": "gears_init.js"} ] }
     * 
     * @param output
     * @throws IOException
     * @throws JSONException
     */
    @RequestMapping(method = RequestMethod.GET)
    public void forumsHandler(Writer output) throws IOException,
            JSONException {

        if (manifest == null) {
            manifest = createManifest();
        }
        output.append(manifest);
        output.close();
    }

    private String createManifest() throws JSONException {

        String gwtROOT = hostConfigurer.resolvePlaceholder(
                "HOST.gears.localserver.dir");
        String localServerURL = hostConfigurer.resolvePlaceholder(
                "HOST.gears.localserver.url");

        File contextF = new File(gwtROOT);

        JSONObject json = new JSONObject();
        json.put("betaManifestVersion", Integer.parseInt(getProperty("gears.betaManifestVersion")));
        json.put("version", "0.0.1." + RandomUtils.rand(0, 2048));
        json.put("entries", getEntries(contextF, localServerURL));

        return json.toString();
    }

    private JSONArray getEntries(File dir, String localServerURL)
            throws JSONException {
        JSONArray fileArray = new JSONArray();
        return getEntries(dir, localServerURL, "", fileArray);
    }

    /**
     * 
     * @param dir
     * @param localServerURL
     * @param dirString
     * @param fileArray
     * @return
     * @throws JSONException
     */
    private JSONArray getEntries(File dir, String localServerURL,
            String dirString, JSONArray fileArray) throws JSONException {

        log.info("context: |" + dir + "|" + dirString);

        for (File f : dir.listFiles()) {

            if (shouldSkip(f.getName())) {
                continue;
            }

            // descend into directory
            if (f.isDirectory()) {
                log.info("found dir " + f);
                getEntries(f, localServerURL, f.getName() + "/",
                        fileArray);
                continue;
            }

            JSONObject oo = new JSONObject();
            oo.put("url", localServerURL + dirString + f.getName());
            fileArray.put(oo);
        }
        return fileArray;
    }

    /**
     * Skip .xml - Compile artifact
     * 
     * Skip .rpc - Server Side only
     * 
     * Skip .nocache. - If we don't skip this, we'll end up running old
     * copies while new version download. While ok for some apps, this
     * causes us IncompatibleServiceExceptions
     * 
     * Skip .cache. - No real reason to include .cache. since the
     * cache-control header is set to forever anyway. This is a judgment
     * call I suppose. Shouldn't matter either way.
     * 
     * @param name
     * @return
     */
    private boolean shouldSkip(String name) {
        if (name.endsWith(".xml") || name.endsWith(".rpc")
                || name.contains(".nocache.") || name.contains(".cache.")) {
            return true;
        }
        return false;
    }

}