Author: johnh
Date: Sun Jan 31 05:10:45 2010
New Revision: 904981
URL: http://svn.apache.org/viewvc?rev=904981&view=rev
Log:
Try #2, adding missing files this time around.
Take advantage of gadget rewritter and apply it on arbitrary html page.
This done using new servlet (gadgets/accel?url=...).
Which for now fage a gadget spec with content from the specified url.
This is just the first step in making this servlet usable.
Ziv Horesh provided the patch.
Added:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/servlet/HtmlAccelServletTest.java
Modified:
incubator/shindig/trunk/features/src/main/javascript/features/features.txt
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/HtmlRenderer.java
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/RewriteModule.java
incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/render/HtmlRendererTest.java
incubator/shindig/trunk/java/server/src/main/webapp/WEB-INF/web.full.xml
incubator/shindig/trunk/java/server/src/main/webapp/WEB-INF/web.xml
incubator/shindig/trunk/java/server/src/test/java/org/apache/shindig/server/JettyLauncher.java
Modified:
incubator/shindig/trunk/features/src/main/javascript/features/features.txt
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/features.txt?rev=904981&r1=904980&r2=904981&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/features.txt
(original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/features.txt
Sun Jan 31 05:10:45 2010
@@ -28,6 +28,7 @@
features/core.json/feature.xml
features/core.legacy/feature.xml
features/core.log/feature.xml
+features/core.none/feature.xml
features/core.prefs/feature.xml
features/core.util/feature.xml
features/core/feature.xml
Modified:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java?rev=904981&r1=904980&r2=904981&view=diff
==============================================================================
---
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
(original)
+++
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/DefaultGadgetSpecFactory.java
Sun Jan 31 05:10:45 2010
@@ -24,6 +24,7 @@
import org.apache.shindig.common.xml.XmlException;
import org.apache.shindig.common.xml.XmlUtil;
import org.apache.shindig.gadgets.http.RequestPipeline;
+import org.apache.shindig.gadgets.servlet.HtmlAccelServlet;
import org.apache.shindig.gadgets.spec.GadgetSpec;
import org.apache.shindig.gadgets.spec.SpecParserException;
@@ -42,7 +43,7 @@
public class DefaultGadgetSpecFactory extends AbstractSpecFactory<GadgetSpec>
implements GadgetSpecFactory {
public static final String CACHE_NAME = "gadgetSpecs";
- static final String RAW_GADGETSPEC_XML_PARAM_NAME = "rawxml";
+ public static final String RAW_GADGETSPEC_XML_PARAM_NAME = "rawxml";
static final Uri RAW_GADGET_URI = Uri.parse("http://localhost/raw.xml";);
@Inject
@@ -63,8 +64,14 @@
// Set URI to a fixed, safe value (localhost), preventing a gadget
rendered
// via raw XML (eg. via POST) to be rendered on a locked domain of any
other
// gadget whose spec is hosted non-locally.
- try {
- return new GadgetSpec(RAW_GADGET_URI, XmlUtil.parse(rawxml), rawxml);
+ try
+ {
+ Uri uri = RAW_GADGET_URI;
+ // For accelerate page, pass in page url instead of fake one:
+ if (HtmlAccelServlet.isAccel(context)) {
+ uri = context.getUrl();
+ }
+ return new GadgetSpec(uri, XmlUtil.parse(rawxml), rawxml);
} catch (XmlException e) {
throw new SpecParserException(e);
}
Added:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java?rev=904981&view=auto
==============================================================================
---
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
(added)
+++
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/GadgetRewritersProvider.java
Sun Jan 31 05:10:45 2010
@@ -0,0 +1,56 @@
+/*
+ * 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.shindig.gadgets.render;
+
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
+
+import org.apache.shindig.gadgets.GadgetContext;
+import org.apache.shindig.gadgets.rewrite.GadgetRewriter;
+import org.apache.shindig.gadgets.servlet.HtmlAccelServlet;
+
+import java.util.List;
+
+/**
+ * Class to provide list of rewriters according to gadget request.
+ * Provide different list of rewriters fro html accelerate request
+ *
+ */
+public class GadgetRewritersProvider {
+
+ private final List<GadgetRewriter> renderRewriters;
+ private final List<GadgetRewriter> accelRewriters;
+
+ @Inject
+ public GadgetRewritersProvider(
+ @Named("shindig.rewriters.gadget") List<GadgetRewriter> renderRewriters,
+ @Named("shindig.rewriters.accelerate") List<GadgetRewriter>
accelRewriters) {
+ this.renderRewriters = renderRewriters;
+ this.accelRewriters = accelRewriters;
+ }
+
+ public List<GadgetRewriter> getRewriters(GadgetContext context) {
+ if (HtmlAccelServlet.isAccel(context)) {
+ return accelRewriters;
+ }
+ return renderRewriters;
+ }
+
+}
Modified:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/HtmlRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/HtmlRenderer.java?rev=904981&r1=904980&r2=904981&view=diff
==============================================================================
---
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/HtmlRenderer.java
(original)
+++
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/render/HtmlRenderer.java
Sun Jan 31 05:10:45 2010
@@ -43,17 +43,17 @@
public static final String PATH_PARAM = "path";
private final PreloaderService preloader;
private final ProxyRenderer proxyRenderer;
- private final List<GadgetRewriter> gadgetRewriters;
+ private final GadgetRewritersProvider gadgetRewritersProvider;
private final GadgetHtmlParser htmlParser;
@Inject
public HtmlRenderer(PreloaderService preloader,
ProxyRenderer proxyRenderer,
- List<GadgetRewriter> gadgetRewriters,
+ GadgetRewritersProvider gadgetRewritersProvider,
GadgetHtmlParser htmlParser) {
this.preloader = preloader;
this.proxyRenderer = proxyRenderer;
- this.gadgetRewriters = gadgetRewriters;
+ this.gadgetRewritersProvider = gadgetRewritersProvider;
this.htmlParser = htmlParser;
}
@@ -87,7 +87,8 @@
}
MutableContent mc = new MutableContent(htmlParser, content);
- for (GadgetRewriter rewriter : gadgetRewriters) {
+ for (GadgetRewriter rewriter :
+ gadgetRewritersProvider.getRewriters(gadget.getContext())) {
rewriter.rewrite(gadget, mc);
}
Modified:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/RewriteModule.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/RewriteModule.java?rev=904981&r1=904980&r2=904981&view=diff
==============================================================================
---
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/RewriteModule.java
(original)
+++
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/RewriteModule.java
Sun Jan 31 05:10:45 2010
@@ -31,6 +31,7 @@
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.TypeLiteral;
+import com.google.inject.name.Names;
/**
* Guice bindings for the rewrite package.
@@ -39,11 +40,16 @@
@Override
protected void configure() {
- bind(new
TypeLiteral<List<GadgetRewriter>>(){}).toProvider(GadgetRewritersProvider.class);
+ bind(new TypeLiteral<List<GadgetRewriter>>(){})
+ .annotatedWith(Names.named("shindig.rewriters.gadget"))
+ .toProvider(GadgetRewritersProvider.class);
+ bind(new TypeLiteral<List<GadgetRewriter>>(){})
+ .annotatedWith(Names.named("shindig.rewriters.accelerate"))
+ .toProvider(AccelRewritersProvider.class);
bind(new
TypeLiteral<List<RequestRewriter>>(){}).toProvider(RequestRewritersProvider.class);
}
- private static class GadgetRewritersProvider implements
Provider<List<GadgetRewriter>> {
+ public static class GadgetRewritersProvider implements
Provider<List<GadgetRewriter>> {
private final List<GadgetRewriter> rewriters;
@Inject
@@ -70,7 +76,24 @@
}
}
- private static class RequestRewritersProvider implements
Provider<List<RequestRewriter>> {
+ public static class AccelRewritersProvider implements
Provider<List<GadgetRewriter>> {
+ private final List<GadgetRewriter> rewriters;
+
+ @Inject
+ public AccelRewritersProvider(
+ HTMLContentRewriter optimizingRewriter,
+ CajaContentRewriter cajaRewriter) {
+ rewriters = Lists.newArrayList();
+ rewriters.add(optimizingRewriter);
+ rewriters.add(cajaRewriter);
+ }
+
+ public List<GadgetRewriter> get() {
+ return rewriters;
+ }
+ }
+
+ public static class RequestRewritersProvider implements
Provider<List<RequestRewriter>> {
private final List<RequestRewriter> rewriters;
@Inject
Added:
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java?rev=904981&view=auto
==============================================================================
---
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
(added)
+++
incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
Sun Jan 31 05:10:45 2010
@@ -0,0 +1,203 @@
+/*
+ * 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.shindig.gadgets.servlet;
+
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.shindig.gadgets.DefaultGadgetSpecFactory;
+import org.apache.shindig.gadgets.GadgetContext;
+import org.apache.shindig.gadgets.GadgetException;
+import org.apache.shindig.gadgets.GadgetException.Code;
+import org.apache.shindig.gadgets.http.HttpRequest;
+import org.apache.shindig.gadgets.http.HttpResponse;
+import org.apache.shindig.gadgets.http.RequestPipeline;
+
+import java.io.IOException;
+import java.util.Map;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletRequestWrapper;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Html pages acceleration servlet.
+ * It uses the rewriter pipeline to improve speed of loading html.
+ * Internally it create a fake gadget spec and uses the Gadget rendering
servlet.
+ * Only html content is being rewritten, other content is passed as is.
+ * (It uses the rawxml tag to pass spec, so require DefaultGadgetSpecFactory)
+ */
+public class HtmlAccelServlet extends GadgetRenderingServlet {
+
+ public static final String URL_PARAM_NAME = "url";
+ /**
+ * Use ACCEL_GADGET parameter to check for AccelServlet during rendering.
+ */
+ public static final String ACCEL_GADGET_PARAM_NAME = "accelGadget";
+ /**
+ * Use the next value with '==' operation when checking for ACCEL_GADGET,
+ * That will prevent spoofing it using url params.
+ */
+ public static final String ACCEL_GADGET_PARAM_VALUE = "true";
+ public static final String CONTENT_TYPE = "Content-Type";
+ public static final String HTML_CONTENT = "text/html";
+ public static final String CONTENT_ENCODING = "Content-Encoding";
+ public static final String CONTENT_LENGTH = "Content-Length";
+
+ /** Fake spec to wrap the html data */
+ private static final String FAKE_SPEC_TPL =
+ "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+ + "<Module>\n"
+ + " <ModulePrefs title=\"Apache Shindig Accelerator\"\n"
+ + " author=\"Apache Shindig\"\n"
+ + " author_email=\"[email protected]\">\n"
+ + " <Require feature=\"core.none\"/>\n"
+ + " <Optional feature=\"content-rewrite\">\n"
+ + " <Param name=\"include-urls\">.*</Param>\n"
+ + " </Optional>\n"
+ + " </ModulePrefs>\n"
+ + " <Content type=\"html\">\n"
+ + " <![CDATA[%s]]>\n"
+ + " </Content>\n"
+ + "</Module>\n";
+
+ private RequestPipeline requestPipeline;
+ private Map<String, String> addedServletParams = null;
+
+ @Inject
+ public void setRequestPipeline(RequestPipeline pipeline) {
+ this.requestPipeline = pipeline;
+ }
+
+ @Inject(optional = true)
+ public void setAddedServletParams(
+ @Named("shindig.accelerate.added-params") Map<String, String> params) {
+ this.addedServletParams = params;
+ }
+
+ public static boolean isAccel(GadgetContext context) {
+ return context.getParameter(HtmlAccelServlet.ACCEL_GADGET_PARAM_NAME) ==
+ HtmlAccelServlet.ACCEL_GADGET_PARAM_VALUE;
+ }
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
+ throws IOException {
+
+ // Get data to accelerate:
+ HttpResponse data;
+ HttpGadgetContext context = new HttpGadgetContext(req);
+ try {
+ data = fetch(context);
+ } catch (GadgetException e) {
+ resp.sendError(HttpServletResponse.SC_BAD_REQUEST, e.getMessage());
+ return;
+ }
+
+ // No such page:
+ if (data == null) {
+ resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "Error fetching
data");
+ return;
+ }
+
+ // If not html, just return data
+ if (!isHtmlContent(data)) {
+ respondVerbatim(data, resp);
+ return;
+ }
+
+ // For html, use the gadgetServlet for rewrite
+ String content = data.getResponseAsString();
+
+ // Create fake spec wrapper for the html:
+ // (Note that the content can be big so don't use the limited
String.Format)
+ final String spec = createFakeSpec(content);
+
+ // wrap the request with the added params
+ HttpServletRequestWrapper reqWrapper = new HttpServletRequestWrapper(req) {
+ @Override
+ public String getParameter(String name) {
+ // Mark this as an accelerate page spec
+ // (The code that check for that field have to use the defined
constant,
+ // hence the use of == )
+ if (name == ACCEL_GADGET_PARAM_NAME) {
+ return ACCEL_GADGET_PARAM_VALUE;
+ }
+ // Pass the spec using rawxml (require DefaultGadgetSpecFactory):
+ if (name == DefaultGadgetSpecFactory.RAW_GADGETSPEC_XML_PARAM_NAME) {
+ return spec;
+ }
+ // Allow overriding extra params (i.e. container)
+ if (addedServletParams != null &&
addedServletParams.containsKey(name)) {
+ return addedServletParams.get(name);
+ }
+ return super.getParameter(name);
+ }
+ };
+
+ // Call the gadget renderer to rewrite content:
+ super.doGet(reqWrapper,resp);
+ }
+
+ @Override
+ protected void doPost(HttpServletRequest req, HttpServletResponse resp)
throws IOException {
+ doGet(req,resp);
+ }
+
+ protected boolean isHtmlContent(HttpResponse data) {
+ return data.getHeader(CONTENT_TYPE) != null &&
+ data.getHeader(CONTENT_TYPE).contains(HTML_CONTENT);
+ }
+
+ private HttpResponse fetch(HttpGadgetContext context) throws GadgetException
{
+
+ if (context.getUrl() == null) {
+ throw new GadgetException(Code.INVALID_PARAMETER, "Missing url
paramater");
+ }
+
+ HttpRequest request = new HttpRequest(context.getUrl())
+ .setIgnoreCache(context.getIgnoreCache())
+ .setContainer(context.getContainer());
+
+ HttpResponse results = requestPipeline.execute(request);
+ return results;
+ }
+
+ private void respondVerbatim(HttpResponse results, HttpServletResponse
response)
+ throws IOException {
+
+ for (Map.Entry<String, String> entry : results.getHeaders().entries()) {
+ // Encoding such as gzip was already stripped from data
+ if (!CONTENT_ENCODING.equals(entry.getKey()) &&
+ !CONTENT_LENGTH.equals(entry.getKey())) {
+ response.setHeader(entry.getKey(), entry.getValue());
+ }
+ }
+ response.setStatus(results.getHttpStatusCode());
+ IOUtils.copy(results.getResponse(), response.getOutputStream());
+ }
+
+ private String createFakeSpec(String content) {
+ // need to rescape CDATA: ( each "]]>" and "<![CDATA[" should be
"]]><![CDATA[")
+ // TODO: just xml escape this and remove the CDATA section
+ String data = content.replace("]]>", "<![CDATA[")
+ .replace("<![CDATA[", "]]><