Merge pull request #4539 from MovingBlocks/chore/modulemanager-deinte…

…rface refactor(ModuleManager): replace interface with concrete class
MovingBlocks · Feb 23, 2021 · 31b73f2 · 31b73f2
2 parents 9f19f6b + d7a9aaf
commit 31b73f2
Show file tree

Hide file tree

Showing 4 changed files with 224 additions and 271 deletions.
diff --git a/engine-tests/src/main/java/org/terasology/testUtil/ModuleManagerFactory.java b/engine-tests/src/main/java/org/terasology/testUtil/ModuleManagerFactory.java
@@ -3,12 +3,11 @@
 package org.terasology.testUtil;
 
 import org.terasology.engine.module.ModuleManager;
-import org.terasology.engine.module.ModuleManagerImpl;
 
 public final class ModuleManagerFactory {
     private ModuleManagerFactory() { }
 
     public static ModuleManager create() throws Exception {
-        return new ModuleManagerImpl("");
+        return new ModuleManager("");
     }
 }
diff --git a/engine/src/main/java/org/terasology/engine/TerasologyEngine.java b/engine/src/main/java/org/terasology/engine/TerasologyEngine.java
@@ -1,4 +1,4 @@
-// Copyright 2020 The Terasology Foundation
+// Copyright 2021 The Terasology Foundation
 // SPDX-License-Identifier: Apache-2.0
 package org.terasology.engine;
 
@@ -19,7 +19,6 @@
 import org.terasology.engine.modes.GameState;
 import org.terasology.engine.module.ExternalApiWhitelist;
 import org.terasology.engine.module.ModuleManager;
-import org.terasology.engine.module.ModuleManagerImpl;
 import org.terasology.engine.paths.PathManager;
 import org.terasology.engine.subsystem.DisplayDevice;
 import org.terasology.engine.subsystem.EngineSubsystem;
@@ -317,7 +316,7 @@ private void initManagers() {
         TypeRegistry.WHITELISTED_PACKAGES = ExternalApiWhitelist.PACKAGES;
         rootContext.put(TypeRegistry.class, typeRegistry);
 
-        ModuleManager moduleManager = new ModuleManagerImpl(rootContext.get(Config.class), classesOnClasspathsToAddToEngine);
+        ModuleManager moduleManager = new ModuleManager(rootContext.get(Config.class), classesOnClasspathsToAddToEngine);
         rootContext.put(ModuleManager.class, moduleManager);
 
         changeStatus(TerasologyEngineStatus.INITIALIZING_LOWLEVEL_OBJECT_MANIPULATION);

diff --git a/engine/src/main/java/org/terasology/engine/module/ModuleManager.java b/engine/src/main/java/org/terasology/engine/module/ModuleManager.java
@@ -1,40 +1,234 @@
-/*
- * Copyright 2015 MovingBlocks
- *
- * 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.
- */
-
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
 package org.terasology.engine.module;
 
-import java.util.Set;
-
+import com.google.common.collect.Sets;
+import org.reflections.Reflections;
+import org.reflections.serializers.Serializer;
+import org.reflections.serializers.XmlSerializer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.terasology.assets.Asset;
+import org.terasology.config.Config;
+import org.terasology.config.SystemConfig;
+import org.terasology.engine.TerasologyConstants;
+import org.terasology.engine.paths.PathManager;
+import org.terasology.input.device.KeyboardDevice;
+import org.terasology.module.ClasspathModule;
+import org.terasology.module.DependencyInfo;
 import org.terasology.module.Module;
 import org.terasology.module.ModuleEnvironment;
+import org.terasology.module.ModuleLoader;
+import org.terasology.module.ModuleMetadata;
 import org.terasology.module.ModuleMetadataJsonAdapter;
+import org.terasology.module.ModulePathScanner;
 import org.terasology.module.ModuleRegistry;
+import org.terasology.module.TableModuleRegistry;
+import org.terasology.module.sandbox.APIScanner;
+import org.terasology.module.sandbox.ModuleSecurityManager;
+import org.terasology.module.sandbox.ModuleSecurityPolicy;
+import org.terasology.module.sandbox.PermissionProviderFactory;
+import org.terasology.module.sandbox.StandardPermissionProviderFactory;
+import org.terasology.module.sandbox.WarnOnlyProviderFactory;
+import org.terasology.nui.UIWidget;
+import org.terasology.reflection.TypeRegistry;
+import org.terasology.utilities.Jvm;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.lang.reflect.ReflectPermission;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.security.Policy;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public class ModuleManager {
+    private static final Logger logger = LoggerFactory.getLogger(ModuleManager.class);
+    private final StandardPermissionProviderFactory permissionProviderFactory = new StandardPermissionProviderFactory();
+    private final PermissionProviderFactory wrappingPermissionProviderFactory = new WarnOnlyProviderFactory(permissionProviderFactory);
+
+    private final ModuleRegistry registry;
+    private ModuleEnvironment environment;
+    private final ModuleMetadataJsonAdapter metadataReader;
+    private final ModuleInstallManager installManager;
+
+    public ModuleManager(String masterServerAddress) {
+        this(masterServerAddress, Collections.emptyList());
+    }
+
+    public ModuleManager(String masterServerAddress, List<Class<?>> classesOnClasspathsToAddToEngine) {
+        PathManager pathManager = PathManager.getInstance();  // get early so if it needs to initialize, it does it now
+
+        metadataReader = new ModuleMetadataJsonAdapter();
+        for (ModuleExtension ext : StandardModuleExtension.values()) {
+            metadataReader.registerExtension(ext.getKey(), ext.getValueType());
+        }
+        for (ModuleExtension ext : ExtraDataModuleExtension.values()) {
+            metadataReader.registerExtension(ext.getKey(), ext.getValueType());
+        }
+        Module engineModule;
+        try (Reader reader = new InputStreamReader(getClass().getResourceAsStream("/engine-module.txt"), TerasologyConstants.CHARSET)) {
+            ModuleMetadata metadata = metadataReader.read(reader);
+            List<Class<?>> additionalClassesList = new ArrayList<>(classesOnClasspathsToAddToEngine.size() + 2);
+            additionalClassesList.add(Module.class); // provide access to gestalt-module.jar
+            additionalClassesList.add(Asset.class); // provide access to gestalt-asset-core.jar
+            additionalClassesList.add(UIWidget.class); // provide access to nui.jar
+            additionalClassesList.add(TypeRegistry.class); // provide access to nui-reflect.jar
+            additionalClassesList.add(KeyboardDevice.class); // provide access to nui-input.jar
+            additionalClassesList.addAll(classesOnClasspathsToAddToEngine); // provide access to any facade-provided classes
+            Class<?>[] additionalClassesArray = new Class[additionalClassesList.size()];
+            additionalClassesArray = additionalClassesList.toArray(additionalClassesArray);
+            engineModule = ClasspathModule.create(metadata, getClass(), additionalClassesArray);
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to read engine metadata", e);
+        } catch (URISyntaxException e) {
+            throw new RuntimeException("Failed to convert engine library location to path", e);
+        }
+
+        enrichReflectionsWithSubsystems(engineModule);
+
+        registry = new TableModuleRegistry();
+        registry.add(engineModule);
+
+        loadModulesFromClassPath();
+
+        ModulePathScanner scanner = new ModulePathScanner(new ModuleLoader(metadataReader));
+        scanner.getModuleLoader().setModuleInfoPath(TerasologyConstants.MODULE_INFO_FILENAME);
+        scanner.scan(registry, pathManager.getModulePaths());
+
+        DependencyInfo engineDep = new DependencyInfo();
+        engineDep.setId(engineModule.getId());
+        engineDep.setMinVersion(engineModule.getVersion());
+        engineDep.setMaxVersion(engineModule.getVersion().getNextPatchVersion());
+
+        registry.stream().filter(mod -> mod != engineModule).forEach(mod -> mod.getMetadata().getDependencies().add(engineDep));
+
+        setupSandbox();
+        loadEnvironment(Sets.newHashSet(engineModule), true);
+        installManager = new ModuleInstallManager(this, masterServerAddress);
+    }
+
+    public ModuleManager(Config config) {
+        this(config, Collections.emptyList());
+    }
+
+    public ModuleManager(Config config, List<Class<?>> classesOnClasspathsToAddToEngine) {
+        this(config.getNetwork().getMasterServer(), classesOnClasspathsToAddToEngine);
+    }
+
+    /**
+     * Overrides modules in modules/ with those specified via -classpath in the JVM
+     */
+    void loadModulesFromClassPath() {
+        logger.debug("loadModulesFromClassPath with classpath:");
+        Jvm.logClasspath(logger);
+
+        ModuleLoader loader = new ClasspathSupportingModuleLoader(metadataReader, true, true);
+        loader.setModuleInfoPath(TerasologyConstants.MODULE_INFO_FILENAME);
+
+        List<Path> classPaths = Arrays.stream(
+                System.getProperty("java.class.path").split(System.getProperty("path.separator", ":"))
+        ).map(Paths::get).collect(Collectors.toList());
+
+        for (Path path : classPaths) {
+            // I thought I'd make the ClasspathSupporting stuff in the shape of a ModuleLoader
+            // so I could use it with the existing ModulePathScanner, but no. The inputs to that
+            // are the _parent directories_ of what we have.
+            //
+            // The conditions here mirror those of org.terasology.module.ModulePathScanner.loadModule
+
+            Module module;
+            try {
+                module = loader.load(path);
+            } catch (IOException e) {
+                logger.error("Failed to load classpath module {}", path, e);
+                continue;
+            }
+
+            if (module == null) {
+                continue;
+            }
+
+            boolean isNew = registry.add(module);
+            if (isNew) {
+                logger.info("Discovered module: {}", module);
+            } else {
+                logger.warn("Discovered duplicate module: {}-{}, skipping {}",
+                        module.getId(), module.getVersion(), path);
+            }
+        }
+    }
+
+    private void setupSandbox() {
+        ExternalApiWhitelist.CLASSES.stream().forEach(clazz ->
+                permissionProviderFactory.getBasePermissionSet().addAPIClass(clazz));
+        ExternalApiWhitelist.PACKAGES.stream().forEach(packagee ->
+                permissionProviderFactory.getBasePermissionSet().addAPIPackage(packagee));
+
+        APIScanner apiScanner = new APIScannerTolerantOfAssetOnlyModules(permissionProviderFactory);
+        apiScanner.scan(registry);
+
+        permissionProviderFactory.getBasePermissionSet().grantPermission("com.google.gson", ReflectPermission.class);
+        permissionProviderFactory.getBasePermissionSet().grantPermission("com.google.gson.internal", ReflectPermission.class);
+
+        Policy.setPolicy(new ModuleSecurityPolicy());
+        System.setSecurityManager(new ModuleSecurityManager());
+    }
 
-/**
- * TODO Type description
- */
-public interface ModuleManager {
+    public ModuleRegistry getRegistry() {
+        return registry;
+    }
 
-    ModuleRegistry getRegistry();
+    public ModuleInstallManager getInstallManager() {
+        return installManager;
+    }
 
-    ModuleInstallManager getInstallManager();
+    public ModuleEnvironment getEnvironment() {
+        return environment;
+    }
 
-    ModuleEnvironment getEnvironment();
+    public ModuleEnvironment loadEnvironment(Set<Module> modules, boolean asPrimary) {
+        Set<Module> finalModules = Sets.newLinkedHashSet(modules);
+        finalModules.addAll(registry.stream().filter(Module::isOnClasspath).collect(Collectors.toList()));
+        ModuleEnvironment newEnvironment;
+        boolean permissiveSecurityEnabled = Boolean.parseBoolean(System.getProperty(SystemConfig.PERMISSIVE_SECURITY_ENABLED_PROPERTY));
+        if (permissiveSecurityEnabled) {
+            newEnvironment = new ModuleEnvironment(finalModules, wrappingPermissionProviderFactory, Collections.emptyList());
+        } else {
+            newEnvironment = new ModuleEnvironment(finalModules, permissionProviderFactory, Collections.emptyList());
+        }
+        if (asPrimary) {
+            environment = newEnvironment;
+        }
+        return newEnvironment;
+    }
 
-    ModuleEnvironment loadEnvironment(Set<Module> modules, boolean asPrimary);
+    public ModuleMetadataJsonAdapter getModuleMetadataReader() {
+        return metadataReader;
+    }
 
-    ModuleMetadataJsonAdapter getModuleMetadataReader();
+    private void enrichReflectionsWithSubsystems(Module engineModule) {
+        Serializer serializer = new XmlSerializer();
+        try {
+            Enumeration<URL> urls = ModuleManager.class.getClassLoader().getResources("reflections.cache");
+            while (urls.hasMoreElements()) {
+                URL url = urls.nextElement();
+                if (url.getPath().contains("subsystem")) {
+                    Reflections subsystemReflections = serializer.read(url.openStream());
+                    engineModule.getReflectionsFragment().merge(subsystemReflections);
+                }
+            }
+        } catch (IOException e) {
+            logger.error("Cannot enrich engine's reflections with subsystems");
+        }
+    }
 }