Automatically register plugin bindings
If a plugin has no modules declared in the manifest, automatically
generate the modules for the plugin based on the class files that
appear in the plugin and the @Export annotations that appear on these
concrete classes.
For any non-abstract command that extends SshCommand (or really the
internal MINA SSHD Command interface that Gerrit uses), plugins may
declare the command with @Export("name") to bind the implementation
as that SSH command, e.g.:
@Export("print-hello")
class Hello extend SshCommand {
Likewise HTTP servlets can also be bound to URLs, but this only works
for standard servlet mappings like "/foo" or "/foo/*". Regex style
bindings must use the Guice ServletModule declared in the manifest:
@Export("/print-hello")
class Hello extends HttpServlet {
Change-Id: Iae4cffcd62d7d2911d3f2705e226fbe21434be68
This commit is contained in:
Shawn O. Pearce
@@ -0,0 +1,254 @@
|
||||
// Copyright (C) 2012 The Android Open Source Project
|
||||
//
|
||||
// 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.gerrit.server.plugins;
|
||||
|
||||
import static com.google.gerrit.server.plugins.PluginGuiceEnvironment.is;
|
||||
|
||||
import com.google.gerrit.extensions.annotations.Export;
|
||||
import com.google.inject.Module;
|
||||
|
||||
import org.eclipse.jgit.util.IO;
|
||||
import org.objectweb.asm.AnnotationVisitor;
|
||||
import org.objectweb.asm.Attribute;
|
||||
import org.objectweb.asm.ClassReader;
|
||||
import org.objectweb.asm.ClassVisitor;
|
||||
import org.objectweb.asm.FieldVisitor;
|
||||
import org.objectweb.asm.MethodVisitor;
|
||||
import org.objectweb.asm.Opcodes;
|
||||
import org.objectweb.asm.Type;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.Enumeration;
|
||||
import java.util.jar.JarEntry;
|
||||
import java.util.jar.JarFile;
|
||||
|
||||
class AutoRegisterModules {
|
||||
private static final int SKIP_ALL = ClassReader.SKIP_CODE
|
||||
| ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES;
|
||||
private final String pluginName;
|
||||
private final JarFile jarFile;
|
||||
private final ClassLoader classLoader;
|
||||
private final ModuleGenerator sshGen;
|
||||
private final ModuleGenerator httpGen;
|
||||
|
||||
Module sysModule;
|
||||
Module sshModule;
|
||||
Module httpModule;
|
||||
|
||||
AutoRegisterModules(String pluginName,
|
||||
PluginGuiceEnvironment env,
|
||||
JarFile jarFile,
|
||||
ClassLoader classLoader) {
|
||||
this.pluginName = pluginName;
|
||||
this.jarFile = jarFile;
|
||||
this.classLoader = classLoader;
|
||||
this.sshGen = env.hasSshModule() ? env.newSshModuleGenerator() : null;
|
||||
this.httpGen = env.hasHttpModule() ? env.newHttpModuleGenerator() : null;
|
||||
}
|
||||
|
||||
AutoRegisterModules discover() throws InvalidPluginException {
|
||||
if (sshGen != null) {
|
||||
sshGen.setPluginName(pluginName);
|
||||
}
|
||||
if (httpGen != null) {
|
||||
httpGen.setPluginName(pluginName);
|
||||
}
|
||||
|
||||
scan();
|
||||
|
||||
if (sshGen != null) {
|
||||
sshModule = sshGen.create();
|
||||
}
|
||||
if (httpGen != null) {
|
||||
httpModule = httpGen.create();
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
private void scan() throws InvalidPluginException {
|
||||
Enumeration<JarEntry> e = jarFile.entries();
|
||||
while (e.hasMoreElements()) {
|
||||
JarEntry entry = e.nextElement();
|
||||
if (skip(entry)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
ClassData def = new ClassData();
|
||||
try {
|
||||
new ClassReader(read(entry)).accept(def, SKIP_ALL);
|
||||
} catch (IOException err) {
|
||||
throw new InvalidPluginException("Cannot auto-register", err);
|
||||
} catch (RuntimeException err) {
|
||||
PluginLoader.log.warn(String.format(
|
||||
"Plugin %s has invaild class file %s inside of %s",
|
||||
pluginName, entry.getName(), jarFile.getName()), err);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (def.exportedAsName != null) {
|
||||
if (def.isConcrete()) {
|
||||
export(def);
|
||||
} else {
|
||||
PluginLoader.log.warn(String.format(
|
||||
"Plugin %s tries to export abstract class %s",
|
||||
pluginName, def.className));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void export(ClassData def) throws InvalidPluginException {
|
||||
Class<?> clazz;
|
||||
try {
|
||||
clazz = Class.forName(def.className, false, classLoader);
|
||||
} catch (ClassNotFoundException err) {
|
||||
throw new InvalidPluginException(String.format(
|
||||
"Cannot load %s with @Export(\"%s\")",
|
||||
def.className, def.exportedAsName), err);
|
||||
}
|
||||
|
||||
Export export = clazz.getAnnotation(Export.class);
|
||||
if (export == null) {
|
||||
PluginLoader.log.warn(String.format(
|
||||
"In plugin %s asm incorrectly parsed %s with @Export(\"%s\")",
|
||||
pluginName, clazz.getName(), def.exportedAsName));
|
||||
return;
|
||||
}
|
||||
|
||||
if (is("org.apache.sshd.server.Command", clazz)) {
|
||||
if (sshGen != null) {
|
||||
sshGen.export(export, clazz);
|
||||
}
|
||||
} else if (is("javax.servlet.http.HttpServlet", clazz)) {
|
||||
if (httpGen != null) {
|
||||
httpGen.export(export, clazz);
|
||||
}
|
||||
} else {
|
||||
throw new InvalidPluginException(String.format(
|
||||
"Class %s with @Export(\"%s\") not supported",
|
||||
clazz.getName(), export.value()));
|
||||
}
|
||||
}
|
||||
|
||||
private static boolean skip(JarEntry entry) {
|
||||
if (!entry.getName().endsWith(".class")) {
|
||||
return true; // Avoid non-class resources.
|
||||
}
|
||||
if (entry.getSize() <= 0) {
|
||||
return true; // Directories have 0 size.
|
||||
}
|
||||
if (entry.getSize() >= 1024 * 1024) {
|
||||
return true; // Do not scan huge class files.
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
private byte[] read(JarEntry entry) throws IOException {
|
||||
byte[] data = new byte[(int) entry.getSize()];
|
||||
InputStream in = jarFile.getInputStream(entry);
|
||||
try {
|
||||
IO.readFully(in, data, 0, data.length);
|
||||
} finally {
|
||||
in.close();
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
private static class ClassData implements ClassVisitor {
|
||||
private static final String EXPORT = Type.getType(Export.class).getDescriptor();
|
||||
String className;
|
||||
int access;
|
||||
String exportedAsName;
|
||||
|
||||
boolean isConcrete() {
|
||||
return (access & Opcodes.ACC_ABSTRACT) == 0
|
||||
&& (access & Opcodes.ACC_INTERFACE) == 0;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visit(int version, int access, String name, String signature,
|
||||
String superName, String[] interfaces) {
|
||||
this.className = Type.getObjectType(name).getClassName();
|
||||
this.access = access;
|
||||
}
|
||||
|
||||
@Override
|
||||
public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
|
||||
if (visible && EXPORT.equals(desc)) {
|
||||
return new AbstractAnnotationVisitor() {
|
||||
@Override
|
||||
public void visit(String name, Object value) {
|
||||
exportedAsName = (String) value;
|
||||
}
|
||||
};
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitSource(String arg0, String arg1) {
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitOuterClass(String arg0, String arg1, String arg2) {
|
||||
}
|
||||
|
||||
@Override
|
||||
public MethodVisitor visitMethod(int arg0, String arg1, String arg2,
|
||||
String arg3, String[] arg4) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitInnerClass(String arg0, String arg1, String arg2, int arg3) {
|
||||
}
|
||||
|
||||
@Override
|
||||
public FieldVisitor visitField(int arg0, String arg1, String arg2,
|
||||
String arg3, Object arg4) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitEnd() {
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitAttribute(Attribute arg0) {
|
||||
}
|
||||
}
|
||||
|
||||
private static abstract class AbstractAnnotationVisitor implements
|
||||
AnnotationVisitor {
|
||||
@Override
|
||||
public AnnotationVisitor visitAnnotation(String arg0, String arg1) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public AnnotationVisitor visitArray(String arg0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitEnum(String arg0, String arg1, String arg2) {
|
||||
}
|
||||
|
||||
@Override
|
||||
public void visitEnd() {
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user