com.predic8.membrane.core.interceptor.IndexInterceptor Maven / Gradle / Ivy
/* Copyright 2012 predic8 GmbH, www.predic8.com
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.predic8.membrane.core.interceptor;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.StringUtils;
import com.googlecode.jatl.Html;
import com.predic8.membrane.annot.MCElement;
import com.predic8.membrane.core.Constants;
import com.predic8.membrane.core.exchange.Exchange;
import com.predic8.membrane.core.http.Response;
import com.predic8.membrane.core.rules.AbstractServiceProxy;
import com.predic8.membrane.core.rules.Rule;
import com.predic8.membrane.core.rules.ServiceProxyKey;
import com.predic8.membrane.core.transport.http.HostColonPort;
import com.predic8.membrane.core.transport.http.HttpServerHandler;
/**
* @description The index feature lists available proxys at a simple Web page.
* To use this feature just add a serviceProxy containing the index
* element. Of course you can protect the service proxy by using
* SSL or Username and Password.
* @topic 8. SOAP based Web Services
*/
@MCElement(name="index", id="index-interceptor")
public class IndexInterceptor extends AbstractInterceptor {
private static class ServiceInfo {
public String name, url, host, port, path;
public boolean ssl;
public String method;
}
public List getServices(Exchange exc) {
List result = new ArrayList<>();
for (Rule r : router.getRuleManager().getRules()) {
if (r instanceof AbstractServiceProxy) {
ServiceInfo si = getServiceInfo(exc, (AbstractServiceProxy)r);
if (si != null)
result.add(si);
}
}
return result;
}
private ServiceInfo getServiceInfo(Exchange exc, AbstractServiceProxy sp) {
if (sp.getInterceptors().size() == 1 && sp.getInterceptors().get(0) instanceof IndexInterceptor)
return null;
ServiceProxyKey k = (ServiceProxyKey) sp.getKey();
ServiceInfo ri = new ServiceInfo();
ri.method = k.getMethod();
ri.ssl = sp.getSslInboundContext() != null;// NOTE: when running as servlet, we have no idea what the protocol was
String protocol = ri.ssl ? "https" : "http";
String host = k.isHostWildcard() ? new HostColonPort(ri.ssl, exc.getRequest().getHeader().getHost()).host() : fullfillRegexp(ServiceProxyKey.createHostPattern(k.getHost()));
if (host == null || host.length() == 0)
host = exc.getHandler().getLocalAddress().getHostAddress();
int port = k.getPort();
if (port == -1 || !exc.getHandler().isMatchLocalPort())
port = exc.getHandler().getLocalPort();
String path;
if (!k.isUsePathPattern()) {
path = "/";
} else if (k.isPathRegExp()) {
path = fullfillRegexp(k.getPath());
} else {
path = "/" + StringUtils.removeStart(k.getPath(), "/");
}
if (!"".equals(exc.getHandler().getContextPath(exc))) {
path = StringUtils.removeEnd(exc.getHandler().getContextPath(exc), "/") + "/" + StringUtils.removeStart(path, "/");
}
ri.name = sp.getName();
if (path != null)
ri.url = protocol + "://" + host + ":" + port + path;
ri.host = k.isHostWildcard() ? "" : StringEscapeUtils.escapeHtml4(k.getHost());
ri.port = k.getPort() == -1 ? "" : "" + k.getPort();
ri.path = k.isUsePathPattern() ? "" + StringEscapeUtils.escapeHtml4(k.getPath()) + "" + (k.isPathRegExp() ? " (regex)" : "") : "";
return ri;
}
static String fullfillRegexp(String regex) {
StringBuilder sb = new StringBuilder();
int p = 0, groupLevel = 0;
WHILE:
while (p < regex.length()) {
int c = regex.codePointAt(p++);
switch (c) {
case '\\':
if (p == regex.length())
return null; // illegal
c = regex.codePointAt(p++);
if (Character.isDigit(c))
return null; // backreferences are not supported
if (c == 'Q') {
while (true) {
if (p == regex.length())
return null; // 'end of regex' within quote
c = regex.codePointAt(p++);
if (c == '\\') {
if (p == regex.length())
return null; // 'end of regex' within quote
c = regex.codePointAt(p++);
if (c == 'E')
break;
sb.append('\\');
}
sb.appendCodePoint(c);
}
break;
}
if (c == 'E') {
return null; // 'end of quote' without begin
}
sb.appendCodePoint(c);
break;
case '[':
case '?':
case '*':
case '+':
case '{':
return null; // meaningful characters we do not unterstand
case '(':
groupLevel++;
break;
case ')':
if (groupLevel == 0)
return null; // unbalanced ')'
else
groupLevel--;
break;
case '|':
if (groupLevel == 0) {
break WHILE;
}
W2:
while (true) {
if (++p == regex.length())
return null; // unbalanced ')'
switch (regex.charAt(p)) {
case ')':
break W2;
case '[':
case '?':
case '*':
case '+':
case '{':
return null; // meaningful characters we do not unterstand
case '\\':
return null; // TODO: \) \Q..\E
}
}
groupLevel--;
p++;
break;
case '^':
if (p == 1)
break;
return null;
case '$':
if (p == regex.length() || regex.codePointAt(p) == '|')
break;
return null;
case '.':
int q;
if (p != regex.length() && isQuantifier(q = regex.codePointAt(p))) {
if (++p != regex.length() && isModifier(regex.codePointAt(p)))
p++;
if (q == '+')
sb.append('a');
} else {
sb.append('a');
}
break;
default:
sb.appendCodePoint(c);
break;
}
}
if (groupLevel > 0)
return null;
return sb.toString();
}
private static boolean isQuantifier(int c) {
return c == '?' || c == '*' || c == '+';
}
private static boolean isModifier(int c) {
return c == '?' || c == '+';
}
@Override
public Outcome handleRequest(final Exchange exc) throws Exception {
StringWriter sw = new StringWriter();
new Html(sw) {
{
html();
head();
title().text(Constants.PRODUCT_NAME + ": Service Proxies").end();
style();
raw("""
""");
end();
end();
body();
h1().text("Service Proxies").end();
List services = getServices(exc);
if (services.isEmpty())
p().text("There are no services defined.").end();
else
createIndexTable(services, exc.getHandler() instanceof HttpServerHandler);
p().classAttr("help").text("The hyperlinks might not work due to semantics which is not known to " + Constants.PRODUCT_NAME + ".").end();
p().classAttr("footer").raw(Constants.HTML_FOOTER).end();
end();
end();
}
private void createIndexTable(List services, boolean showSSL) {
table().cellspacing("0").cellpadding("0").border(""+1);
tr();
th().text("Name").end();
th().text("Virtual Host").end();
th().text("Port").end();
th().text("Path").end();
if (showSSL)
th().text("SSL").end();
end();
for (ServiceInfo ri : services) {
tr();
td();
if (ri.url != null && !"POST".equals(ri.method)) {
a().href(ri.url);
text(ri.name);
end();
} else {
text(ri.name);
}
end();
td().raw(ri.host).end();
td().raw(ri.port).end();
td().raw(ri.path).end();
if (showSSL)
td().raw(ri.ssl ? "yes" : "").end();
end();
}
end();
}
};
exc.setResponse(Response.ok(sw.toString()).build());
return Outcome.RETURN;
}
@Override
public String getShortDescription() {
return "Lists services available through the " + Constants.PRODUCT_NAME + " service proxies.";
}
}