/*

 * Copyright (c) 2007, 2010 Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

import java.io.BufferedReader;

import java.io.ByteArrayOutputStream;

import java.io.Closeable;

import java.io.File;

import java.io.FileFilter;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.PrintStream;

import java.nio.channels.FileChannel;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.List;

import java.util.Map;

import java.util.jar.JarFile;

import java.util.jar.JarOutputStream;

import java.util.jar.Pack200;

import java.util.zip.ZipEntry;

import java.util.zip.ZipFile;

/**

 *

 * @author ksrini

 */

/*

 * This class contains all the commonly used utilities used by various tests

 * in this directory.

 */

class Utils {

    static final String JavaHome = System.getProperty("test.java",

            System.getProperty("java.home"));

    static final boolean IsWindows =

            System.getProperty("os.name").startsWith("Windows");

    static final boolean Is64Bit =

            System.getProperty("sun.arch.data.model", "32").equals("64");

    static final File   JavaSDK =  new File(JavaHome).getParentFile();

    static final String PACK_FILE_EXT   = ".pack";

    static final String JAVA_FILE_EXT   = ".java";

    static final String CLASS_FILE_EXT  = ".class";

    static final String JAR_FILE_EXT    = ".jar";

    static final File   TEST_SRC_DIR = new File(System.getProperty("test.src"));

    static final String VERIFIER_DIR_NAME = "pack200-verifier";

    static final File   VerifierJar = new File(VERIFIER_DIR_NAME + JAR_FILE_EXT);

    private Utils() {} // all static

    static {

        if (!JavaHome.endsWith("jre")) {

            throw new RuntimeException("Error: requires an SDK to run");

        }

    }

    private static void init() throws IOException {

        if (VerifierJar.exists()) {

            return;

        }

        File srcDir = new File(TEST_SRC_DIR, VERIFIER_DIR_NAME);

        List<File> javaFileList = findFiles(srcDir, createFilter(JAVA_FILE_EXT));

        File tmpFile = File.createTempFile("javac", ".tmp");

        File classesDir = new File("xclasses");

        classesDir.mkdirs();

        FileOutputStream fos = null;

        PrintStream ps = null;

        try {

            fos = new FileOutputStream(tmpFile);

            ps = new PrintStream(fos);

            for (File f : javaFileList) {

                ps.println(f.getAbsolutePath());

            }

        } finally {

            close(ps);

            close(fos);

        }

        compiler("-d",

                "xclasses",

                "@" + tmpFile.getAbsolutePath());

        jar("cvfe",

            VerifierJar.getName(),

            "sun.tools.pack.verify.Main",

            "-C",

            "xclasses",

            ".");

    }

    static void dirlist(File dir) {

        File[] files = dir.listFiles();

        System.out.println("--listing " + dir.getAbsolutePath() + "---");

        for (File f : files) {

            StringBuffer sb = new StringBuffer();

            sb.append(f.isDirectory() ? "d " : "- ");

            sb.append(f.getName());

            System.out.println(sb);

        }

    }

    static void doCompareVerify(File reference, File specimen) throws IOException {

        init();

        List<String> cmds = new ArrayList<String>();

        cmds.add(getJavaCmd());

        cmds.add("-jar");

        cmds.add(VerifierJar.getName());

        cmds.add(reference.getAbsolutePath());

        cmds.add(specimen.getAbsolutePath());

        cmds.add("-O");

        runExec(cmds);

    }

    static void doCompareBitWise(File reference, File specimen)

            throws IOException {

        init();

        List<String> cmds = new ArrayList<String>();

        cmds.add(getJavaCmd());

        cmds.add("-jar");

        cmds.add(VerifierJar.getName());

        cmds.add(reference.getName());

        cmds.add(specimen.getName());

        cmds.add("-O");

        cmds.add("-b");

        runExec(cmds);

    }

    static FileFilter createFilter(final String extension) {

        return new FileFilter() {

            @Override

            public boolean accept(File pathname) {

                String name = pathname.getName();

                if (name.endsWith(extension)) {

                    return true;

                }

                return false;

            }

        };

    }

    static final FileFilter DIR_FILTER = new FileFilter() {

        public boolean accept(File pathname) {

            if (pathname.isDirectory()) {

                return true;

            }

            return false;

        }

    };

    static final FileFilter FILE_FILTER = new FileFilter() {

        public boolean accept(File pathname) {

            if (pathname.isFile()) {

                return true;

            }

            return false;

        }

    };

    private static void setFileAttributes(File src, File dst) throws IOException {

        dst.setExecutable(src.canExecute());

        dst.setReadable(src.canRead());

        dst.setWritable(src.canWrite());

        dst.setLastModified(src.lastModified());

    }

    static void copyFile(File src, File dst) throws IOException {

        if (src.isDirectory()) {

            dst.mkdirs();

            setFileAttributes(src, dst);

            return;

        } else {

            File baseDirFile = dst.getParentFile();

            if (!baseDirFile.exists()) {

                baseDirFile.mkdirs();

            }

        }

        FileInputStream in = null;

        FileOutputStream out = null;

        FileChannel srcChannel = null;

        FileChannel dstChannel = null;

        try {

            in = new FileInputStream(src);

            out = new FileOutputStream(dst);

            srcChannel = in.getChannel();

            dstChannel = out.getChannel();

            long retval = srcChannel.transferTo(0, src.length(), dstChannel);

            if (src.length() != dst.length()) {

                throw new IOException("file copy failed for " + src);

            }

        } finally {

            close(srcChannel);

            close(dstChannel);

            close(in);

            close(out);

        }

        setFileAttributes(src, dst);

    }

    /*

     * Suppose a path is provided which consists of a full path

     * this method returns the sub path for a full path ex: /foo/bar/baz/foobar.z

     * and the base path is /foo/bar it will will return baz/foobar.z.

     */

    private static String getEntryPath(String basePath, String fullPath) {

        if (!fullPath.startsWith(basePath)) {

            return null;

        }

        return fullPath.substring(basePath.length());

    }

    static String getEntryPath(File basePathFile, File fullPathFile) {

        return getEntryPath(basePathFile.toString(), fullPathFile.toString());

    }

    public static void recursiveCopy(File src, File dest) throws IOException {

        if (!src.exists() || !src.canRead()) {

            throw new IOException("file not found or readable: " + src);

        }

        if (dest.exists() && !dest.isDirectory() && !dest.canWrite()) {

            throw new IOException("file not found or writeable: " + dest);

        }

        if (!dest.exists()) {

            dest.mkdirs();

        }

        List<File> a = directoryList(src);

        for (File f : a) {

            copyFile(f, new File(dest, getEntryPath(src, f)));

        }

    }

    static List<File> directoryList(File dirname) {

        List<File>  dirList = new ArrayList<File>();

        return directoryList(dirname, dirList, null);

    }

    private static List<File> directoryList(File dirname, List<File> dirList,

            File[] dirs) {

        dirList.addAll(Arrays.asList(dirname.listFiles(FILE_FILTER)));

        dirs = dirname.listFiles(DIR_FILTER);

        for (File f : dirs) {

            if (f.isDirectory() && !f.equals(dirname)) {

                dirList.add(f);

                directoryList(f, dirList, dirs);

            }

        }

        return dirList;

    }

    static void recursiveDelete(File dir) throws IOException {

        if (dir.isFile()) {

            dir.delete();

        } else if (dir.isDirectory()) {

            File[] entries = dir.listFiles();

            for (int i = 0; i < entries.length; i++) {

                if (entries[i].isDirectory()) {

                    recursiveDelete(entries[i]);

                }

                entries[i].delete();

            }

            dir.delete();

        }

    }

    static List<File> findFiles(File startDir, FileFilter filter)

            throws IOException {

        List<File> list = new ArrayList<File>();

        findFiles0(startDir, list, filter);

        return list;

    }

    /*

     * finds files in the start directory using the the filter, appends

     * the files to the dirList.

     */

    private static void findFiles0(File startDir, List<File> list,

                                    FileFilter filter) throws IOException {

        File[] foundFiles = startDir.listFiles(filter);

        list.addAll(Arrays.asList(foundFiles));

        File[] dirs = startDir.listFiles(DIR_FILTER);

        for (File dir : dirs) {

            findFiles0(dir, list, filter);

        }

    }

    static void close(Closeable c) {

        if (c == null) {

            return;

        }

        try {

            c.close();

        } catch (IOException ignore) {

        }

    }

    static void compiler(String... javacCmds) {

        if (com.sun.tools.javac.Main.compile(javacCmds) != 0) {

            throw new RuntimeException("compilation failed");

        }

    }

    static void jar(String... jargs) {

        sun.tools.jar.Main jarTool =

                new sun.tools.jar.Main(System.out, System.err, "jartool");

        if (!jarTool.run(jargs)) {

            throw new RuntimeException("jar command failed");

        }

    }

    // given a jar file foo.jar will write to foo.pack

    static void pack(JarFile jarFile, File packFile) throws IOException {

        Pack200.Packer packer = Pack200.newPacker();

        Map<String, String> p = packer.properties();

        // Take the time optimization vs. space

        p.put(packer.EFFORT, "1");  // CAUTION: do not use 0.

        // Make the memory consumption as effective as possible

        p.put(packer.SEGMENT_LIMIT, "10000");

        // ignore all JAR deflation requests to save time

        p.put(packer.DEFLATE_HINT, packer.FALSE);

        // save the file ordering of the original JAR

        p.put(packer.KEEP_FILE_ORDER, packer.TRUE);

        FileOutputStream fos = null;

        try {

            // Write out to a jtreg scratch area

            fos = new FileOutputStream(packFile);

            // Call the packer

            packer.pack(jarFile, fos);

        } finally {

            close(fos);

        }

    }

    // uses java unpacker, slow but useful to discover issues with the packer

    static void unpackj(File inFile, JarOutputStream jarStream)

            throws IOException {

        unpack0(inFile, jarStream, true);

    }

    // uses native unpacker using the java APIs

    static void unpackn(File inFile, JarOutputStream jarStream)

            throws IOException {

        unpack0(inFile, jarStream, false);

    }

    // given a packed file, create the jar file in the current directory.

    private static void unpack0(File inFile, JarOutputStream jarStream,

            boolean useJavaUnpack) throws IOException {

        // Unpack the files

        Pack200.Unpacker unpacker = Pack200.newUnpacker();

        Map<String, String> props = unpacker.properties();

        if (useJavaUnpack) {

            props.put("com.sun.java.util.jar.pack.disable.native", "true");

        }

        // Call the unpacker

        unpacker.unpack(inFile, jarStream);

    }

    static byte[] getBuffer(ZipFile zf, ZipEntry ze) throws IOException {

        ByteArrayOutputStream baos = new ByteArrayOutputStream();

        byte buf[] = new byte[8192];

        InputStream is = null;

        try {

            is = zf.getInputStream(ze);

            int n = is.read(buf);

            while (n > 0) {

                baos.write(buf, 0, n);

                n = is.read(buf);

            }

            return baos.toByteArray();

        } finally {

            close(is);

        }

    }

    static ArrayList<String> getZipFileEntryNames(ZipFile z) {

        ArrayList<String> out = new ArrayList<String>();

        for (ZipEntry ze : Collections.list(z.entries())) {

            out.add(ze.getName());

        }

        return out;

    }

    static List<String> runExec(List<String> cmdsList) {

        ArrayList<String> alist = new ArrayList<String>();

        ProcessBuilder pb =

                new ProcessBuilder(cmdsList);

        Map<String, String> env = pb.environment();

        pb.directory(new File("."));

        dirlist(new File("."));

        for (String x : cmdsList) {

            System.out.print(x + " ");

        }

        System.out.println("");

        int retval = 0;

        Process p = null;

        InputStreamReader ir = null;

        BufferedReader rd = null;

        InputStream is = null;

        try {

            pb.redirectErrorStream(true);

            p = pb.start();

            is = p.getInputStream();

            ir = new InputStreamReader(is);

            rd = new BufferedReader(ir, 8192);

            String in = rd.readLine();

            while (in != null) {

                alist.add(in);

                System.out.println(in);

                in = rd.readLine();

            }

            retval = p.waitFor();

            if (retval != 0) {

                throw new RuntimeException("process failed with non-zero exit");

            }

        } catch (Exception ex) {

            throw new RuntimeException(ex.getMessage());

        } finally {

            close(rd);

            close(ir);

            close(is);

            if (p != null) {

                p.destroy();

            }

        }

        return alist;

    }

    static String getUnpack200Cmd() {

        return getAjavaCmd("unpack200");

    }

    static String getPack200Cmd() {

        return getAjavaCmd("pack200");

    }

    static String getJavaCmd() {

        return getAjavaCmd("java");

    }

    static String getAjavaCmd(String cmdStr) {

        File binDir = new File(JavaHome, "bin");

        File unpack200File = IsWindows

                ? new File(binDir, cmdStr + ".exe")

                : new File(binDir, cmdStr);

        String cmd = unpack200File.getAbsolutePath();

        if (!unpack200File.canExecute()) {

            throw new RuntimeException("please check" +

                    cmd + " exists and is executable");

        }

        return cmd;

    }

    private static List<File> locaterCache = null;

    // search the source dir and jdk dir for requested file and returns

    // the first location it finds.

    static File locateJar(String name) {

        try {

            if (locaterCache == null) {

                locaterCache = new ArrayList<File>();

                locaterCache.addAll(findFiles(TEST_SRC_DIR, createFilter(JAR_FILE_EXT)));

                locaterCache.addAll(findFiles(JavaSDK, createFilter(JAR_FILE_EXT)));

            }

            for (File f : locaterCache) {

                if (f.getName().equals(name)) {

                    return f;

                }

            }

            throw new IOException("file not found: " + name);

        } catch (IOException e) {

            throw new RuntimeException(e);

        }

    }

}