act.util.Jars Maven / Gradle / Ivy

Go to download
package act.util;

/*-
 * #%L
 * ACT Framework
 * %%
 * Copyright (C) 2014 - 2017 ActFramework
 * %%
 * 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.
 * #L%
 */

import act.conf.ConfLoader;
import org.osgl.$;
import org.osgl.exception.NotAppliedException;
import org.osgl.logging.L;
import org.osgl.logging.Logger;
import org.osgl.util.E;
import org.osgl.util.FastStr;
import org.osgl.util.IO;
import org.osgl.util.S;

import java.io.*;
import java.net.URL;
import java.util.*;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * Provides utilities manipulating jar files
 */
public enum Jars {
    ;

    private static Logger logger = L.get(Jars.class);

    public static Map buildClassNameIndex(File dir) {
        return buildClassNameIndex(dir, $.F.FALSE);
    }

    public static Map buildClassNameIndex(File dir, final $.Function ignoredClassNames) {
        final Map idx = new HashMap<>();
        F.JarEntryVisitor visitor = F.classNameIndexBuilder(idx, ignoredClassNames);
        scanDir(dir, visitor);
        return idx;
    }

    public static Map buildClassNameIndex(List jars) {
        return buildClassNameIndex(jars, $.F.FALSE);
    }

    public static Map buildClassNameIndex(List jars, final $.Func1 ignoredClassNames) {
        final Map idx = new HashMap<>();
        F.JarEntryVisitor visitor = F.classNameIndexBuilder(idx, ignoredClassNames);
        scanList(jars, visitor);
        return idx;
    }

    /**
     * If the class is loaded from a Jar file, then return that file. Otherwise
     * return {@code null}
     */
    public static File probeJarFile(Class clazz) {
        String fileName = ClassNames.classNameToClassFileName(clazz.getName());
        URL url = clazz.getClassLoader().getResource(fileName);
        if (null != url && "jar".equals(url.getProtocol())) {
            String path = url.getPath();
            String file = S.str(path).afterFirst("file:").beforeFirst(".jar!").append(".jar").toString();
            return new File(file);
        } else {
            return null;
        }
    }

    public static void scan(File file, F.JarEntryVisitor... visitors) {
        file = file.getAbsoluteFile();
        if (file.isDirectory()) {
            scanDir(file, visitors);
        } else {
            scanFile(file, visitors);
        }
    }

    private static void scanList(List jars, F.JarEntryVisitor visitor) {
        for (int i = 0, j = jars.size(); i < j; ++i) {
            File jar = jars.get(i);
            scanFile(jar, visitor);
        }
    }

    private static void scanDir(File jarDir, F.JarEntryVisitor... visitors) {
        File[] jars = jarDir.listFiles(new FilenameFilter() {
            @Override
            public boolean accept(File dir, String name) {
                return name.endsWith(".jar");
            }
        });
        int n = jars.length;
        for (int i = 0; i < n; ++i) {
            File file = jars[i];
            scanFile(file, visitors);
        }
    }

    private static void scanFile(File file, F.JarEntryVisitor... visitors) {
        try {
            JarFile jar = new JarFile(file);
            try {
                Enumeration entries = jar.entries();
                while (entries.hasMoreElements()) {
                    JarEntry entry = entries.nextElement();
                    String name = entry.getName();
                    if (entry.isDirectory()) {
                        continue;
                    }
                    for (F.JarEntryVisitor visitor : visitors) {
                        if (name.endsWith(visitor.suffixRequired())) {
                            visitor.apply(jar, entry);
                        }
                    }
                }
            } finally {
                jar.close();
            }
        } catch (IOException e) {
            logger.error(e, "error scan file: %s", file.getAbsolutePath());
        }
    }

    public static JarEntry jarEntry(URL url, $.Var jarFileBag) {
        E.illegalArgumentIfNot("jar".equals(url.getProtocol()), "jar URL expected");
        String path = url.getPath();
        E.unexpectedIfNot(path.startsWith("file:"), "Expected `file:` prefix in the path, found: " + path);
        E.unexpectedIfNot(path.contains("!"), "`!` not found in the path: " + path);

        S.Pair pair = S.binarySplit(path, '!');
        String jarFilePath = pair.left().substring(5);
        String entryPath = pair.right();
        try {
            JarFile jarFile = new JarFile(jarFilePath);
            jarFileBag.set(jarFile);
            if (entryPath.startsWith("/")) {
                entryPath = entryPath.substring(1);
            }
            return jarFile.getJarEntry(entryPath);
        } catch (IOException e) {
            throw E.ioException(e);
        }
    }

    public static byte[] getBytes(JarFile jar, JarEntry entry) {
        try {
            InputStream is = jar.getInputStream(entry);
            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            IO.copy(is, baos);
            return baos.toByteArray();
        } catch (IOException e) {
            throw E.ioException(e);
        }
    }

    public static String readContent(JarFile jar, JarEntry entry) {
        try {
            InputStream is = jar.getInputStream(entry);
            return IO.readContentAsString(is);
        } catch (IOException e) {
            throw E.ioException(e);
        }
    }

    public enum F {
        ;

        public static abstract class JarEntryVisitor extends $.F2 {
            public String suffixRequired() {
                return ".class";
            }
        }

        public static JarEntryVisitor classNameIndexBuilder(final Map map, final $.Function ignoredClassNames) {
            return new F.JarEntryVisitor() {
                @Override
                public Void apply(JarFile jarFile, JarEntry entry) throws NotAppliedException, $.Break {
                    String className = ClassNames.classFileNameToClassName(entry.getName());
                    if (!ignoredClassNames.apply(className)) {
                        map.put(className, getBytes(jarFile, entry));
                    }
                    return null;
                }
            };
        }

        /**
         * Visit properties files in Jar file and add the file content to map indexed by env tag.
         * For example, a jar entry named "conf/dev/abc.properties", the content will be loaded into a properties
         * instance and then put into an existing properties indexed by "dev" tag. If no env tag found
         * then the properties will be loaded into a properties instance indexed by "common"
         *
         * @param map the map stores the properties mapped to a configure tag (e.g. common, dev, uat etc)
         * @return the visitor
         */
        public static JarEntryVisitor appConfigFileIndexBuilder(final Map map) {
            return new F.JarEntryVisitor() {
                @Override
                public String suffixRequired() {
                    return ".properties";
                }

                @Override
                public Void apply(JarFile jarFile, JarEntry jarEntry) throws NotAppliedException, $.Break {
                    try {
                        String fileName = jarEntry.getName();
                        if (fileName.startsWith("conf/")) {
                            FastStr fs = FastStr.of(fileName).afterFirst('/');
                            String env = ConfLoader.common();
                            if (fs.contains('/')) {
                                env = fs.beforeFirst('/').intern();
                            }
                            Properties p = map.get(env);
                            if (null == p) {
                                p = new Properties();
                                map.put(env, p);
                            }
                            InputStream is = jarFile.getInputStream(jarEntry);
                            Properties p2 = new Properties();
                            p2.load(is);
                            p.putAll(p2);
                        }
                    } catch (IOException e) {
                        logger.warn(e, "Unable to load properties file from jar entry %s", jarEntry.getName());
                    }
                    return null;
                }
            };
        }
    }

}