/**
* 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.process;
import org.apache.shindig.common.ContainerConfig;
import org.apache.shindig.gadgets.Gadget;
import org.apache.shindig.gadgets.GadgetBlacklist;
import org.apache.shindig.gadgets.GadgetContext;
import org.apache.shindig.gadgets.GadgetException;
import org.apache.shindig.gadgets.GadgetSpecFactory;
import org.apache.shindig.gadgets.spec.GadgetSpec;
import org.apache.shindig.gadgets.spec.View;
import org.apache.shindig.gadgets.variables.VariableSubstituter;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import org.json.JSONArray;
import java.net.URI;
import java.util.logging.Logger;
/**
* Converts an input Context into an output Gadget.
*/
@Singleton
public class Processor {
private static final Logger LOG = Logger.getLogger(Processor.class.getName());
private final GadgetSpecFactory gadgetSpecFactory;
private final VariableSubstituter substituter;
private final ContainerConfig containerConfig;
private final GadgetBlacklist blacklist;
@Inject
public Processor(GadgetSpecFactory gadgetSpecFactory,
VariableSubstituter substituter,
ContainerConfig containerConfig,
GadgetBlacklist blacklist) {
this.gadgetSpecFactory = gadgetSpecFactory;
this.substituter = substituter;
this.blacklist = blacklist;
this.containerConfig = containerConfig;
}
/**
* Process a single gadget. Creates a gadget from a retrieved GadgetSpec and context object,
* automatically performing variable substitution on the spec for use elsewhere.
*
* @throws ProcessingException If there is a problem processing the gadget.
*/
public Gadget process(GadgetContext context) throws ProcessingException {
URI url = context.getUrl();
if (url == null) {
throw new ProcessingException("Missing or malformed url parameter");
}
if (!"http".equalsIgnoreCase(url.getScheme()) && !"https".equalsIgnoreCase(url.getScheme())) {
throw new ProcessingException("Unsupported scheme (must be http or https).");
}
if (blacklist.isBlacklisted(context.getUrl())) {
LOG.info("Attempted to render blacklisted gadget: " + context.getUrl());
throw new ProcessingException("The requested gadget is unavailable");
}
try {
GadgetSpec spec = gadgetSpecFactory.getGadgetSpec(context);
spec = substituter.substitute(context, spec);
return new Gadget()
.setContext(context)
.setSpec(spec)
.setCurrentView(getView(context, spec));
} catch (GadgetException e) {
throw new ProcessingException(e.getMessage(), e);
}
}
/**
* Attempts to extract the "current" view for the given gadget.
*/
private View getView(GadgetContext context, GadgetSpec spec) {
String viewName = context.getView();
View view = spec.getView(viewName);
if (view == null) {
JSONArray aliases = containerConfig.getJsonArray(context.getContainer(),
"gadgets.features/views/" + viewName + "/aliases");
if (aliases != null) {
for (int i = 0, j = aliases.length(); i < j; ++i) {
viewName = aliases.optString(i);
if (viewName != null) {
view = spec.getView(viewName);
if (view != null) {
break;
}
}
}
}
if (view == null) {
view = spec.getView(GadgetSpec.DEFAULT_VIEW);
}
}
return view;
}
}