PlatformUtil.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2012-2019 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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.
 */
package org.sleuthkit.autopsy.coreutils;
 
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.lang.management.ManagementFactory;
import java.lang.management.MemoryMXBean;
import java.lang.management.MemoryUsage;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import javax.swing.filechooser.FileSystemView;
import org.apache.commons.io.FilenameUtils;
import org.openide.modules.InstalledFileLocator;
import org.openide.modules.Places;
import org.openide.util.NbBundle;
import org.sleuthkit.datamodel.SleuthkitJNI;
import org.sleuthkit.datamodel.TskCoreException;

public class PlatformUtil {
 
    private static final String PYTHON_MODULES_SUBDIRECTORY = "python_modules"; //NON-NLS
    private static final String CLASSIFIERS_SUBDIRECTORY = "object_detection_classifiers"; //NON-NLS
    private static final String OCR_LANGUAGE_SUBDIRECTORY = "ocr_language_packs"; //NON-NLS
    private static final String OCR_LANGUAGE_PACK_EXT = "traineddata";
    private static String javaPath = null;
    public static final String OS_NAME_UNKNOWN = NbBundle.getMessage(PlatformUtil.class, "PlatformUtil.nameUnknown");
    public static final String OS_VERSION_UNKNOWN = NbBundle.getMessage(PlatformUtil.class, "PlatformUtil.verUnknown");
    public static final String OS_ARCH_UNKNOWN = NbBundle.getMessage(PlatformUtil.class, "PlatformUtil.archUnknown");
    private static volatile long pid = -1;
    private static volatile MemoryMXBean memoryManager = null;

    public static String getInstallPath() {
        File coreFolder = InstalledFileLocator.getDefault().locate("core", PlatformUtil.class.getPackage().getName(), false); //NON-NLS
        File rootPath = coreFolder.getParentFile().getParentFile();
        return rootPath.getAbsolutePath();
    }

    public static String getInstallModulesPath() {
        File coreFolder = InstalledFileLocator.getDefault().locate("core", PlatformUtil.class.getPackage().getName(), false); //NON-NLS
 
        File rootPath = coreFolder.getParentFile();
        String modulesPath = rootPath.getAbsolutePath() + File.separator + "modules"; //NON-NLS
        File modulesPathF = new File(modulesPath);
        if (modulesPathF.exists() && modulesPathF.isDirectory()) {
            return modulesPath;
        } else {
            rootPath = rootPath.getParentFile();
            modulesPath = rootPath.getAbsolutePath() + File.separator + "modules"; //NON-NLS
            modulesPathF = new File(modulesPath);
            if (modulesPathF.exists() && modulesPathF.isDirectory()) {
                return modulesPath;
            } else {
                return null;
            }
        }
 
    }

    public static String getUserModulesPath() {
        return getUserDirectory().getAbsolutePath() + File.separator + "modules"; //NON-NLS
    }

    public static String getUserPythonModulesPath() {
        return getUserDirectory().getAbsolutePath() + File.separator + PYTHON_MODULES_SUBDIRECTORY;
    }

    public static String getOcrLanguagePacksPath() {
        return getUserDirectory().getAbsolutePath() + File.separator + OCR_LANGUAGE_SUBDIRECTORY;
    }

    public static List<String> getOcrLanguagePacks() {
        File languagePackRootDir = new File(getOcrLanguagePacksPath());
 
        List<String> languagePacks = new ArrayList<>();
        for (File languagePack : languagePackRootDir.listFiles()) {
            String fileExt = FilenameUtils.getExtension(languagePack.getName());
            if (!languagePack.isDirectory() && OCR_LANGUAGE_PACK_EXT.equals(fileExt)) {
                String packageName = FilenameUtils.getBaseName(languagePack.getName());
                languagePacks.add(packageName);
            }
        }
 
        return languagePacks;
    }

    public static String getObjectDetectionClassifierPath() {
        return getUserDirectory().getAbsolutePath() + File.separator + CLASSIFIERS_SUBDIRECTORY;
    }

    public synchronized static String getJavaPath() {
        if (javaPath != null) {
            return javaPath;
        }
 
        // by default, use Java that came with Autopsy
        File jrePath = new File(getInstallPath() + File.separator + "jre");
        if (jrePath.exists() && jrePath.isDirectory()) {
            System.out.println(
                    NbBundle.getMessage(PlatformUtil.class,
                            "PlatformUtil.jrePath.jreDir.msg",
                            jrePath.getAbsolutePath()));
            javaPath = jrePath.getAbsolutePath() + File.separator + "bin" + File.separator + "java"; //NON-NLS
        } else if (System.getProperty("java.home") != null && !(System.getProperty("java.home").isEmpty())) {
            // if OS knows where Java is located
            return System.getProperty("java.home") + File.separator + "bin" + File.separator + "java"; //NON-NLS
        } else {
            //else use system installed java in PATH env variable
            javaPath = "java"; //NON-NLS
        }
 
        System.out.println(NbBundle.getMessage(PlatformUtil.class, "PlatformUtil.jrePath.usingJavaPath.msg", javaPath));
 
        return javaPath;
    }

    public static File getUserDirectory() {
        return Places.getUserDirectory();
    }

    public static List<String> getProjectsDirs() {
        List<String> ret = new ArrayList<>();
        String projectDir = System.getProperty("netbeans.dirs");
        if (projectDir == null) {
            return ret;
        }
        String[] split = projectDir.split(";");
        if (split == null || split.length == 0) {
            return ret;
        }
        ret.addAll(Arrays.asList(split));
 
        return ret;
    }

    public static String getUserConfigDirectory() {
        return Places.getUserDirectory() + File.separator + "config"; //NON-NLS
    }

    public static String getModuleConfigDirectory() {
        return Paths.get(getUserConfigDirectory(), "ModuleConfig").toString();
    }

    public static String getLogDirectory() {
        return Places.getUserDirectory().getAbsolutePath() + File.separator
                + "var" + File.separator + "log" + File.separator; //NON-NLS
    }
 
    public static String getDefaultPlatformFileEncoding() {
        return System.getProperty("file.encoding");
    }
 
    public static String getDefaultPlatformCharset() {
        return Charset.defaultCharset().name();
    }
 
    public static String getLogFileEncoding() {
        return Charset.forName("UTF-8").name();
    }

    public static <T> boolean extractResourceToUserConfigDir(final Class<T> resourceClass, final String resourceFileName, boolean overWrite) throws IOException {
        Path resourceFilePath = Paths.get(getUserConfigDirectory(), resourceFileName);
        final File resourceFile = resourceFilePath.toFile();
        if (resourceFile.exists() && !overWrite) {
            return false;
        }
 
        InputStream inputStream = resourceClass.getResourceAsStream(resourceFileName);
        if (null == inputStream) {
            return false;
        }
 
        resourceFile.getParentFile().mkdirs();
        try (InputStream in = new BufferedInputStream(inputStream)) {
            try (OutputStream out = new BufferedOutputStream(new FileOutputStream(resourceFile))) {
                int readBytes;
                while ((readBytes = in.read()) != -1) {
                    out.write(readBytes);
                }
            }
        }
        return true;
    }

    public static String getOSName() {
        return System.getProperty("os.name", OS_NAME_UNKNOWN); //NON-NLS
    }

    public static String getOSVersion() {
        return System.getProperty("os.version", OS_VERSION_UNKNOWN); //NON-NLS
    }

    public static String getOSArch() {
        return System.getProperty("os.arch", OS_ARCH_UNKNOWN); //NON-NLS
    }

    public static boolean isWindowsOS() {
        return PlatformUtil.getOSName().toLowerCase().contains("windows"); //NON-NLS
    }

    public static boolean isLinuxOS() {
        return PlatformUtil.getOSName().toLowerCase().contains("linux"); //NON-NLS
    }

    public static boolean isMacOS() {
        return PlatformUtil.getOSName().toLowerCase().contains("mac"); //NON-NLS
    }

    public static String getOSFilePath(String origFilePath) {
        if (isWindowsOS()) {
            return "\"" + origFilePath + "\"";
        } else {
            return origFilePath;
        }
    }

    public static boolean is64BitOS() {
        if (System.getProperty("os.name").contains("Windows")) { //NON-NLS
            return (System.getenv("ProgramFiles(x86)") != null); //NON-NLS
        } else {
            return (System.getProperty("os.arch").contains("64")); //NON-NLS
        }
    }

    public static boolean is64BitJVM() {
        return (System.getProperty("sun.arch.data.model").equals("64"));
    }

    public static List<LocalDisk> getPhysicalDrives() {
        List<LocalDisk> drives = new ArrayList<>();
        // Windows drives
        if (PlatformUtil.isWindowsOS()) {
            int n = 0;
            int breakCount = 0;
            while (true) {
                String path = "\\\\.\\PhysicalDrive" + n; //NON-NLS
                if (canReadDrive(path)) {
                    try {
                        drives.add(new LocalDisk("Drive " + n, path, SleuthkitJNI.findDeviceSize(path))); //NON-NLS
                    } catch (TskCoreException ex) {
                        // Don't add the drive because we can't read the size
                    }
                    n++;
                } else {
                    if (breakCount > 4) { // Give up after 4 non-existent drives
                        break;
                    }
                    breakCount++;
                    n++;
                }
            }
            // Linux drives
        } else {
            File dev = new File("/dev/");
            File[] files = dev.listFiles();
            for (File f : files) {
                String name = f.getName();
                if ((name.contains("hd") || name.contains("sd") || name.contains("disk")) && f.canRead() && name.length() <= 5) { //NON-NLS
                    String path = "/dev/" + name; //NON-NLS
                    if (canReadDrive(path)) {
                        try {
                            drives.add(new LocalDisk(path, path, SleuthkitJNI.findDeviceSize(path)));
                        } catch (TskCoreException ex) {
                            // Don't add the drive because we can't read the size
                        }
                    }
                }
            }
 
        }
        return drives;
    }

    public static List<LocalDisk> getPartitions() {
        List<LocalDisk> drives = new ArrayList<>();
        FileSystemView fsv = FileSystemView.getFileSystemView();
        if (PlatformUtil.isWindowsOS()) {
            File[] f = File.listRoots();
            for (File f1 : f) {
                String name = fsv.getSystemDisplayName(f1);
                // Check if it is a drive, readable, and not mapped to the network
                if (f1.canRead() && !name.contains("\\\\") && (fsv.isDrive(f1) || fsv.isFloppyDrive(f1))) {
                    String path = f1.getPath();
                    String diskPath = "\\\\.\\" + path.substring(0, path.length() - 1);
                    if (canReadDrive(diskPath)) {
                        drives.add(new LocalDisk(fsv.getSystemDisplayName(f1), diskPath, f1.getTotalSpace()));
                    }
                }
            }
        } else {
            File dev = new File("/dev/");
            File[] files = dev.listFiles();
            for (File f : files) {
                String name = f.getName();
                if ((name.contains("hd") || name.contains("sd") || name.contains("disk")) && f.canRead() && name.length() <= 7) { //NON-NLS
                    String path = "/dev/" + name; //NON-NLS
                    if (canReadDrive(path)) {
                        drives.add(new LocalDisk(path, path, f.getTotalSpace()));
                    }
                }
            }
        }
        return drives;
    }

    private static boolean canReadDrive(String diskPath) {
        BufferedInputStream br = null;
        try {
            File tmp = new File(diskPath);
            br = new BufferedInputStream(new FileInputStream(tmp));
            int b = br.read();
            return b != -1;
        } catch (IOException ex) {
            return false;
        } finally {
            try {
                if (br != null) {
                    br.close();
                }
            } catch (IOException ex) {
            }
        }
    }

    public static synchronized long getPID() {
        // taken from https://stackoverflow.com/a/7303433/2375948
        return ProcessHandle.current().pid();
    }

    public static synchronized long getJavaPID(String sigarSubQuery) {
        long[] pids = getJavaPIDs(sigarSubQuery);
        return pids == null || pids.length < 1
                ? -1
                : pids[0];
    }
    
    private static String convertSqlLikeToRegex(String originalLikeStatement) {
        if (originalLikeStatement == null) {
            return "";
        }
 
        // Build the regex by quoting each literal segment and replacing wildcards.
        // The original implementation incorrectly called Pattern.quote() on the
        // entire string before substituting wildcards, which placed the substituted
        // ".*" and "." inside the \Q...\E literal region where they are not treated
        // as regex metacharacters.
        StringBuilder regex = new StringBuilder();
        StringBuilder literal = new StringBuilder();
 
        char[] chars = originalLikeStatement.toCharArray();
        for (int i = 0; i < chars.length; i++) {
            char cur = chars[i];
            if (cur == '%' || cur == '_') {
                // Doubled wildcard (e.g. %% or __) is treated as an escaped literal.
                if (i + 1 < chars.length && chars[i + 1] == cur) {
                    literal.append(cur);
                    i++;
                } else {
                    if (literal.length() > 0) {
                        regex.append(Pattern.quote(literal.toString()));
                        literal.setLength(0);
                    }
                    regex.append(cur == '%' ? ".*" : "."); //NON-NLS
                }
            } else {
                literal.append(cur);
            }
        }
 
        if (literal.length() > 0) {
            regex.append(Pattern.quote(literal.toString()));
        }
 
        return regex.toString();
    }

    public static synchronized long[] getJavaPIDs(String argsSubQuery) {
        // Previously this method used WMIC on Windows and "ps -ef | grep" on
        // Linux/Mac by constructing shell commands with Runtime.getRuntime().exec().
        // Those approaches had a shell injection vulnerability (argsSubQuery was
        // interpolated directly into the WMIC query string), and the Linux pipe
        // was likely broken because exec(String) does not invoke a shell.
        // Both were replaced with ProcessHandle (requires Java 9+, fine since
        // Autopsy now requires Java 21).
        //
        // Known limitation: on Windows, ProcessHandle.Info.commandLine() returns
        // Optional.empty() for processes owned by other users or running as a
        // service. The old WMIC approach did not have this restriction. In
        // practice this should not matter because Autopsy starts Solr under the
        // same user account, but if getJavaPIDs() ever starts returning empty
        // results when a matching process is known to exist, cross-user
        // visibility is the first thing to investigate.
        String regexStr = ".*java.*" + convertSqlLikeToRegex(argsSubQuery) + ".*"; //NON-NLS
        try {
            Pattern pattern = Pattern.compile(regexStr, Pattern.CASE_INSENSITIVE | Pattern.DOTALL);
            return ProcessHandle.allProcesses()
                    .filter(ph -> ph.info().commandLine()
                            .map(cmd -> pattern.matcher(cmd).matches())
                            .orElse(false))
                    .mapToLong(ProcessHandle::pid)
                    .toArray();
        } catch (Exception ex) {
            System.out.println("An exception occurred while fetching java pids with query: " + argsSubQuery + " : " + ex.getMessage());
            return null;
        }
    }

    public static synchronized void killProcess(long pid) {
        String cmd = isWindowsOS()
                ? "taskkill /F /PID " + pid
                : "kill " + pid;
 
        try {
            Runtime.getRuntime().exec(cmd);
        } catch (IOException ex) {
            System.out.println("An exception occurred while killing process pid: " + pid);
            ex.printStackTrace();
        }
    }

    public static synchronized long getProcessVirtualMemoryUsed() {
        // taken from https://stackoverflow.com/a/17376879/2375948
        return Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory();
    }

    public static String getJvmMemInfo() {
        synchronized (PlatformUtil.class) {
            if (memoryManager == null) {
                memoryManager = ManagementFactory.getMemoryMXBean();
            }
        }
        final MemoryUsage heap = memoryManager.getHeapMemoryUsage();
        final MemoryUsage nonHeap = memoryManager.getNonHeapMemoryUsage();
 
        return NbBundle.getMessage(PlatformUtil.class,
                "PlatformUtil.getJvmMemInfo.usageText",
                heap.toString(), nonHeap.toString());
    }

    public static String getPhysicalMemInfo() {
        final Runtime runTime = Runtime.getRuntime();
        final long maxMemory = runTime.maxMemory();
        final long totalMemory = runTime.totalMemory();
        final long freeMemory = runTime.freeMemory();
        return NbBundle.getMessage(PlatformUtil.class,
                "PlatformUtil.getPhysicalMemInfo.usageText",
                Long.toString(maxMemory), Long.toString(totalMemory), Long.toString(freeMemory));
    }

    public static String getAllMemUsageInfo() {
        return NbBundle.getMessage(PlatformUtil.class,
                "PlatformUtil.getAllMemUsageInfo.usageText",
                PlatformUtil.getPhysicalMemInfo(), PlatformUtil.getJvmMemInfo(),
                PlatformUtil.getProcessVirtualMemoryUsed());
    }
}