[GitHub] [incubator-doris] wutiangan commented on a change in pull request #2463: Add fe plugin framework

[GitBox <gi...@apache.org>]

wutiangan commented on a change in pull request #2463: Add fe plugin framework
URL: https://github.com/apache/incubator-doris/pull/2463#discussion_r396538955
 
 

 ##########
 File path: fe/src/main/java/org/apache/doris/plugin/DynamicPluginLoader.java
 ##########
 @@ -0,0 +1,232 @@
+// 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.doris.plugin;
+
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.nio.file.DirectoryStream;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.doris.common.UserException;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+public class DynamicPluginLoader extends PluginLoader {
+    private final static Logger LOG = LogManager.getLogger(DynamicPluginLoader.class);
+
+    protected Path tempPath;
+
+    protected Path installPath;
+
+    DynamicPluginLoader(String pluginPath, String source) {
+        super(pluginPath, source);
+    }
+
+    DynamicPluginLoader(String pluginPath, PluginInfo info) {
+        super(pluginPath, info);
+        this.installPath = FileSystems.getDefault().getPath(pluginDir.toString(), pluginInfo.getName());
+        this.tempPath = installPath;
+    }
+
+    @Override
+    public boolean isDynamicPlugin() {
+        return true;
+    }
+
+    /**
+     * get Plugin .zip and read plugin.properties
+     */
+    @Override
+    public PluginInfo getPluginInfo() throws IOException, UserException {
+        // already install
+        if (pluginInfo != null) {
+            return pluginInfo;
+        }
+
+        // download plugin and extract
+        PluginZip zip = new PluginZip(source);
+        Path target = Files.createTempDirectory(pluginDir, ".install_");
+
+        tempPath = zip.extract(target);
+
+        pluginInfo = PluginInfo.readFromProperties(tempPath, source);
+
+        return pluginInfo;
+    }
+
+    /**
+     * move plugin to Doris's PLUGIN_DIR and dynamic load the plugin class
+     */
+    public void install() throws UserException, IOException {
+        if (hasInstalled()) {
+            throw new UserException("Plugin " + pluginInfo.getName() + " is already install.");
+        }
+
+        getPluginInfo();
+
+        Path realPath = movePlugin();
+
+        plugin = dynamicLoadPlugin(realPath);
+
+        pluginInstallValid();
+
+        plugin.init(pluginInfo, pluginContext);
+    }
+
+    private boolean hasInstalled() {
+        // check already install
+        if (pluginInfo != null && installPath != null && Files.exists(installPath)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * close plugin and delete Plugin
+     */
+    public void uninstall() throws IOException, UserException {
+        if (plugin != null) {
+            pluginUninstallValid();
+            plugin.close();
+        }
+
+        if (null != installPath && Files.exists(installPath)
+                && Files.isSameFile(installPath.getParent(), pluginDir)) {
+            FileUtils.deleteQuietly(installPath.toFile());
+        }
+
+        if (null != tempPath && Files.exists(tempPath)) {
+            FileUtils.deleteQuietly(tempPath.toFile());
+        }
+    }
+
+    /**
+     * reload plugin if plugin has install, else will re-install
+     *
+     */
+    public void reload() throws IOException, UserException {
+        if (hasInstalled()) {
+            plugin = dynamicLoadPlugin(installPath);
+            pluginInstallValid();
+            plugin.init(pluginInfo, pluginContext);
+
+        } else {
+            // re-install
+            this.pluginInfo = null;
+            this.installPath = null;
+            this.tempPath = null;
+
+            install();
+        }
+    }
+
+    Plugin dynamicLoadPlugin(Path path) throws IOException, UserException {
+        Set<URL> jarList = getJarUrl(path);
+
+        // create a child to load the plugin in this bundle
+        ClassLoader parentLoader = PluginClassLoader.createLoader(getClass().getClassLoader(), Collections.EMPTY_LIST);
+        ClassLoader loader = URLClassLoader.newInstance(jarList.toArray(new URL[0]), parentLoader);
+
+        Class<? extends Plugin> pluginClass;
+        try {
+             pluginClass = loader.loadClass(pluginInfo.getClassName()).asSubclass(Plugin.class);
+        } catch (ClassNotFoundException e) {
+            throw new UserException("Could not find plugin class [" + pluginInfo.getClassName() + "]", e);
+        }
+
+        return loadPluginClass(pluginClass);
+    }
+
+    private Plugin loadPluginClass(Class<? extends Plugin> pluginClass) {
+        final Constructor<?>[] constructors = pluginClass.getConstructors();
+        if (constructors.length == 0) {
+            throw new IllegalStateException("no public constructor for [" + pluginClass.getName() + "]");
+        }
+
+        if (constructors.length > 1) {
+            throw new IllegalStateException("no unique public constructor for [" + pluginClass.getName() + "]");
+        }
+
+        final Constructor<?> constructor = constructors[0];
+
+        try {
+            if (constructor.getParameterCount() == 0) {
+                return (Plugin) constructor.newInstance();
+            } else {
+                throw new IllegalStateException("failed to find correct constructor.");
+            }
+        } catch (final ReflectiveOperationException e) {
+            throw new IllegalStateException("failed to load plugin class [" + pluginClass.getName() + "]", e);
+        }
+    }
+
+    private Set<URL> getJarUrl(Path path) throws IOException {
+        Set<URL> urls = new LinkedHashSet<>();
+        // gather urls for jar files
+        try (DirectoryStream<Path> jarStream = Files.newDirectoryStream(path, "*.jar")) {
+            for (Path jar : jarStream) {
+                // normalize with toRealPath to get symlinks out of our hair
+                URL url = jar.toRealPath().toUri().toURL();
+                if (!urls.add(url)) {
+                    throw new IllegalStateException("duplicate codebase: " + url);
+                }
+            }
+        }
+
+        return urls;
+    }
+
+    /**
+     * move plugin's temp install directory to Doris's PLUGIN_DIR
+     */
+    Path movePlugin() throws UserException, IOException {
+
+        if (tempPath == null || !Files.exists(tempPath)) {
+            throw new UserException("Install plugin " + pluginInfo.getName() + " failed, cause install path isn't "
 
 Review comment:
   cause --> becasue?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org