Merge pull request #33 from ktor/master

fix: allow to read configuration files from caller bundle

Author: gustavnovotny

src/main/java/com/ableneo/liferay/portal/setup/LiferaySetup.java

@@ -32,6 +32,8 @@
 import java.io.InputStream;
 import java.util.List;
 import java.util.Locale;
+
+import org.osgi.framework.Bundle;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -49,7 +51,19 @@ private LiferaySetup() {}
      */
     public static boolean setup(final File file) throws FileNotFoundException {
         Setup setup = MarshallUtil.unmarshall(file);
-        return setup(setup);
+        return setup(setup, null);
+    }
+
+    /**
+     * Helper method that unmarshalls xml configuration from data stream.
+     *
+     * @param inputStream data containing xml file that follows http://www.ableneo.com/liferay/setup schema
+     * @param callerBundle caller bundle to resolve its file resources during processing
+     * @return if setup was successfull
+     */
+    public static boolean setup(final InputStream inputStream, Bundle callerBundle) {
+        Setup setup = MarshallUtil.unmarshall(inputStream);
+        return setup(setup, callerBundle);
     }
 
     /**
@@ -60,7 +74,7 @@ public static boolean setup(final File file) throws FileNotFoundException {
      */
     public static boolean setup(final InputStream inputStream) {
         Setup setup = MarshallUtil.unmarshall(inputStream);
-        return setup(setup);
+        return setup(setup, null);
     }
 
     /**
@@ -70,6 +84,17 @@ public static boolean setup(final InputStream inputStream) {
      * @return true if all was set up fine
      */
     public static boolean setup(final Setup setup) {
+        return setup(setup, null);
+    }
+
+    /**
+     * Main setup method that sets up the data configured with xml.
+     *
+     * @param setup Setup object, parsed from xml configuration
+     * @param callerBundle caller bundle to resolve its file resources during processing
+     * @return true if all was set up fine
+     */
+    public static boolean setup(final Setup setup, Bundle callerBundle) {
         if (setup == null) {
             throw new IllegalArgumentException(
                 "Setup object cannot be null, without Setup object I cannot set up any data."
@@ -93,7 +118,7 @@ public static boolean setup(final Setup setup) {
                         LOG.error("Could not find company: {}", company);
                         continue;
                     }
-                    SetupConfigurationThreadLocal.configureThreadLocalContent(runAsUserEmail, companyId);
+                    SetupConfigurationThreadLocal.configureThreadLocalContent(runAsUserEmail, companyId, callerBundle);
                     executeSetupConfiguration(setup);
 
                     // iterate over group names or choose GUEST group for the company

src/main/java/com/ableneo/liferay/portal/setup/SetupConfigurationThreadLocal.java

@@ -21,6 +21,8 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Objects;
+
+import org.osgi.framework.Bundle;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -58,6 +60,11 @@ public final class SetupConfigurationThreadLocal {
         }
     );
 
+    private static final ThreadLocal<Bundle> _callerBundle = new CentralizedThreadLocal<>(
+        SetupConfigurationThreadLocal.class + "._callerBundle",
+        null
+    );
+
     private SetupConfigurationThreadLocal() {}
 
     public static Long getRunAsUserId() {
@@ -84,6 +91,14 @@ public static void setRunInGroupId(Long runInGroupId) {
         _runInGroupId.set(runInGroupId);
     }
 
+    public static Bundle getCallerBundle() {
+        return _callerBundle.get();
+    }
+
+    public static void setCallerBundle(Bundle callerBundle) {
+        _callerBundle.set(callerBundle);
+    }
+
     public static void cleanUp(
         String originalPrincipalName,
         PermissionChecker originalPermissionChecker,
@@ -92,6 +107,7 @@ public static void cleanUp(
         _runInCompanyId.remove();
         _runAsUserId.remove();
         _runInGroupId.remove();
+        _callerBundle.remove();
 
         PrincipalThreadLocal.setName(originalPrincipalName);
         PermissionThreadLocal.setPermissionChecker(originalPermissionChecker);
@@ -112,7 +128,7 @@ public static void cleanUp(
     static void configureThreadLocalContent(String runAsUserEmail, long companyId, Group group) throws PortalException {
         Objects.requireNonNull(group);
         configureGroupExecutionContext(group);
-        configureThreadLocalContent(runAsUserEmail, companyId);
+        configureThreadLocalContent(runAsUserEmail, companyId, (Bundle)null);
     }
 
     public static void configureGroupExecutionContext(Group group) {
@@ -131,15 +147,17 @@ public static void configureGroupExecutionContext(Group group) {
      * @throws PortalException user was not found, breaks the setup execution, we presume that if user email was
      *                         provided it is important to set up data as the user e.g. for easier cleanup
      */
-    static void configureThreadLocalContent(String runAsUserEmail, long companyId) throws PortalException {
+    static void configureThreadLocalContent(String runAsUserEmail, long companyId, Bundle callerBundle) throws PortalException {
         if (Validator.isBlank(runAsUserEmail)) {
             setRunInCompanyId(companyId);
+            setCallerBundle(callerBundle);
             SetupConfigurationThreadLocal.setRandomAdminPermissionCheckerForThread();
             LOG.info("Using default administrator.");
         } else {
             User user = UserLocalServiceUtil.getUserByEmailAddress(companyId, runAsUserEmail);
             setRunAsUserId(user.getUserId());
             setRunInCompanyId(companyId);
+            setCallerBundle(callerBundle);
             PrincipalThreadLocal.setName(user.getUserId());
             PermissionChecker permissionChecker = PermissionCheckerFactoryUtil.create(user);
             PermissionThreadLocal.setPermissionChecker(permissionChecker);

src/main/java/com/ableneo/liferay/portal/setup/core/util/ResourcesUtil.java

@@ -1,8 +1,12 @@
 package com.ableneo.liferay.portal.setup.core.util;
 
+import com.ableneo.liferay.portal.setup.SetupConfigurationThreadLocal;
 import com.liferay.portal.kernel.util.FileUtil;
+import org.osgi.framework.Bundle;
+
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 
 /**
@@ -14,11 +18,26 @@ private ResourcesUtil() {}
 
     public static InputStream getFileStream(String path) {
         ClassLoader cl = ResourcesUtil.class.getClassLoader();
-        InputStream is = cl.getResourceAsStream(path);
-        if (is == null) {
-            throw new RuntimeException("Can not load file, does it exist? path:[" + path + "]");
+        InputStream fileStream = cl.getResourceAsStream(path);
+        if (fileStream == null) {
+            // fail safe if caller bundle provided
+            Bundle callerBundle = SetupConfigurationThreadLocal.getCallerBundle();
+            if (callerBundle == null) {
+                throw new RuntimeException("Can not load file, does it exist? path:[" + path + "]");
+            } else {
+                URL url = callerBundle.getEntry(path);
+                if (url != null) {
+                    try {
+                        fileStream = url.openStream();
+                    } catch (IOException e) {
+                        throw new RuntimeException("Error loading file from bundle:" + callerBundle.getSymbolicName() + ", path:[" + path + "]", e);
+                    }
+                } else {
+                    throw new RuntimeException("Can not load file from bundle:" + callerBundle.getSymbolicName() + ", does it exist? path:[" + path + "]");
+                }
+            }
         }
-        return cl.getResourceAsStream(path);
+        return fileStream;
     }
 
     public static byte[] getFileBytes(String path) throws IOException {