2.4/user/src/com/google/gwt/resources/rg/ExternalTextResourceGenerator.java

/*
 * Copyright 2008 Google Inc.
 *
 * 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.google.gwt.resources.rg;

import com.google.gwt.core.ext.BadPropertyValueException;
import com.google.gwt.core.ext.ConfigurationProperty;
import com.google.gwt.core.ext.Generator;
import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.JMethod;
import com.google.gwt.core.ext.typeinfo.JType;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
import com.google.gwt.dev.util.Util;
import com.google.gwt.resources.client.TextResource;
import com.google.gwt.resources.client.impl.ExternalTextResourcePrototype;
import com.google.gwt.resources.ext.AbstractResourceGenerator;
import com.google.gwt.resources.ext.ClientBundleFields;
import com.google.gwt.resources.ext.ClientBundleRequirements;
import com.google.gwt.resources.ext.ResourceContext;
import com.google.gwt.resources.ext.ResourceGeneratorUtil;
import com.google.gwt.resources.ext.SupportsGeneratorResultCaching;
import com.google.gwt.safehtml.shared.UriUtils;
import com.google.gwt.user.rebind.SourceWriter;
import com.google.gwt.user.rebind.StringSourceWriter;

import java.net.URL;
import java.util.HashMap;
import java.util.Map;

/**
 * Adds {@link ExternalTextResourcePrototype} objects to the bundle.
 */
public final class ExternalTextResourceGenerator extends
    AbstractResourceGenerator implements SupportsGeneratorResultCaching {
  /**
   * The name of a deferred binding property that determines whether or not this
   * generator will use JSONP to fetch the files.
   */
  static final String USE_JSONP = "ExternalTextResource.useJsonp";

  // This string must stay in sync with the values in JsonpRequest.java
  static final String JSONP_CALLBACK_PREFIX = "__gwt_jsonp__.P";

  private StringBuffer data;
  private boolean first;
  private String urlExpression;
  private Map<String, Integer> hashes;
  private Map<String, Integer> offsets;
  private int currentIndex;

  private String externalTextUrlIdent;

  private String externalTextCacheIdent;

  @Override
  public String createAssignment(TreeLogger logger, ResourceContext context,
      JMethod method) throws UnableToCompleteException {
    String name = method.getName();

    SourceWriter sw = new StringSourceWriter();
    sw.println("new " + ExternalTextResourcePrototype.class.getName() + "(");
    sw.indent();
    sw.println('"' + name + "\",");
    // These are field names
    sw.println(UriUtils.class.getName() + ".fromTrustedString(" + externalTextUrlIdent + "),");
    sw.println(externalTextCacheIdent + ", ");
    sw.println(offsets.get(method.getName()).toString());
    if (shouldUseJsonp(context, logger)) {
      sw.println(", \"" + getMd5HashOfData() + "\"");
    }
    sw.outdent();
    sw.print(")");

    return sw.toString();
  }

  @Override
  public void createFields(TreeLogger logger, ResourceContext context,
      ClientBundleFields fields) throws UnableToCompleteException {
    data.append(']');
    StringBuffer wrappedData = new StringBuffer();
    if (shouldUseJsonp(context, logger)) {
      wrappedData.append(JSONP_CALLBACK_PREFIX);
      wrappedData.append(getMd5HashOfData());
      wrappedData.append(".onSuccess(\n");
      wrappedData.append(data.toString());
      wrappedData.append(")");
    } else {
      wrappedData = data;
    }

    urlExpression = context.deploy(
        context.getClientBundleType().getQualifiedSourceName().replace('.', '_')
            + "_jsonbundle.txt", "text/plain", wrappedData.toString().getBytes(), true);

    TypeOracle typeOracle = context.getGeneratorContext().getTypeOracle();
    JClassType stringType = typeOracle.findType(String.class.getName());
    assert stringType != null;

    externalTextUrlIdent = fields.define(stringType, "externalTextUrl",
        urlExpression, true, true);

    JClassType textResourceType = typeOracle.findType(TextResource.class.getName());
    assert textResourceType != null;
    JType textResourceArrayType = typeOracle.getArrayType(textResourceType);

    externalTextCacheIdent = fields.define(textResourceArrayType,
        "externalTextCache", "new " + TextResource.class.getName() + "["
            + currentIndex + "]", true, true);
  }

  @Override
  public void init(TreeLogger logger, ResourceContext context)
      throws UnableToCompleteException {
    data = new StringBuffer("[\n");
    first = true;
    urlExpression = null;
    hashes = new HashMap<String, Integer>();
    offsets = new HashMap<String, Integer>();
    currentIndex = 0;
  }

  @Override
  public void prepare(TreeLogger logger, ResourceContext context,
      ClientBundleRequirements requirements, JMethod method)
      throws UnableToCompleteException {

    URL[] urls = ResourceGeneratorUtil.findResources(logger, context, method);

    if (urls.length != 1) {
      logger.log(TreeLogger.ERROR, "Exactly one resource must be specified",
          null);
      throw new UnableToCompleteException();
    }

    URL resource = urls[0];

    String toWrite = Util.readURLAsString(resource);

    // This de-duplicates strings in the bundle.
    if (!hashes.containsKey(toWrite)) {
      hashes.put(toWrite, currentIndex++);

      if (!first) {
        data.append(",\n");
      } else {
        first = false;
      }

      data.append('"');
      data.append(Generator.escape(toWrite));
      data.append('"');
    }

    // Store the (possibly n:1) mapping of resource function to bundle index.
    offsets.put(method.getName(), hashes.get(toWrite));
  }

  private String getMd5HashOfData() {
    return Util.computeStrongName(data.toString().getBytes());
  }

  private boolean shouldUseJsonp(ResourceContext context, TreeLogger logger) {
    String useJsonpProp = null;
    try {
      ConfigurationProperty prop = context.getGeneratorContext()
        .getPropertyOracle().getConfigurationProperty(USE_JSONP);
      useJsonpProp = prop.getValues().get(0);

      // add this configuration property to our requirements
      context.getRequirements().addConfigurationProperty(USE_JSONP);
    } catch (BadPropertyValueException e) {
      logger.log(TreeLogger.ERROR, "Bad value for " + USE_JSONP, e);
      return false;
    }
    return Boolean.parseBoolean(useJsonpProp);
  }

}