Get FileStore options (oshi#1100)

dbwiddis · web-flow · commit b24ae10f61e7 · 2020-02-10T21:10:02.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 4.4.0 (in progress)
 ================
 * [#1098](https://github.com/oshi/oshi/pull/1098): Option to limit FileStore list to local file systems. - [@Space2Man](https://github.com/Space2Man).
+* [#1100](https://github.com/oshi/oshi/pull/1100): Get FileStore options. - [@dbwiddis](https://github.com/dbwiddis).
 * Your contribution here.
 
 4.3.0 (1/2/2020), 4.3.1 (2/5/2020)
diff --git a/oshi-core/src/main/java/oshi/software/os/OSFileStore.java b/oshi-core/src/main/java/oshi/software/os/OSFileStore.java
@@ -48,6 +48,7 @@ public class OSFileStore {
     private String mount;
     private String description;
     private String fsType;
+    private String options;
     private String uuid;
     private long freeSpace;
     private long usableSpace;
@@ -76,6 +77,7 @@ public OSFileStore(OSFileStore fileStore) {
         setMount(fileStore.getMount());
         setDescription(fileStore.getDescription());
         setType(fileStore.getType());
+        setType(fileStore.getOptions());
         setUUID(fileStore.getUUID());
         setFreeSpace(fileStore.getFreeSpace());
         setUsableSpace(fileStore.getUsableSpace());
@@ -202,6 +204,25 @@ public void setType(String value) {
         this.fsType = value;
     }
 
+    /**
+     * Filesystem options
+     *
+     * @return A comma-deimited string of options
+     */
+    public String getOptions() {
+        return options;
+    }
+
+    /**
+     * Sets the File System options
+     *
+     * @param value
+     *            The options
+     */
+    public void setOptions(String value) {
+        this.options = value;
+    }
+
     /**
      * UUID/GUID of the File System
      *
@@ -345,12 +366,12 @@ public boolean updateAtrributes() {
         }
         return false;
     }
-    
+
     @Override
     public String toString() {
         return "OSFileStore [name=" + name + ", volume=" + volume + ", logicalVolume=" + logicalVolume + ", mount="
-                + mount + ", description=" + description + ", fsType=" + fsType + ", uuid=" + uuid + ", freeSpace="
-                + freeSpace + ", usableSpace=" + usableSpace + ", totalSpace=" + totalSpace + ", freeInodes="
-                + freeInodes + ", totalInodes=" + totalInodes + "]";
+                + mount + ", description=" + description + ", fsType=" + fsType + ", options=\"" + options + "\", uuid="
+                + uuid + ", freeSpace=" + freeSpace + ", usableSpace=" + usableSpace + ", totalSpace=" + totalSpace
+                + ", freeInodes=" + freeInodes + ", totalInodes=" + totalInodes + "]";
     }
 }
diff --git a/oshi-core/src/main/java/oshi/software/os/linux/LinuxFileSystem.java b/oshi-core/src/main/java/oshi/software/os/linux/LinuxFileSystem.java
@@ -44,6 +44,7 @@
 import oshi.software.os.OSFileStore;
 import oshi.util.FileUtil;
 import oshi.util.ParseUtil;
+import oshi.util.platform.linux.ProcUtil;
 
 /**
  * The Linux File System contains {@link oshi.software.os.OSFileStore}s which
@@ -118,15 +119,15 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, Map<St
             boolean localOnly) {
         List<OSFileStore> fsList = new ArrayList<>();
 
-        // Parse /proc/self/mounts to get fs types
-        List<String> mounts = FileUtil.readFile("/proc/self/mounts");
+        // Parse /proc/mounts to get fs types
+        List<String> mounts = FileUtil.readFile(ProcUtil.getProcPath() + "/mounts");
         for (String mount : mounts) {
             String[] split = mount.split(" ");
             // As reported in fstab(5) manpage, struct is:
             // 1st field is volume name
             // 2nd field is path with spaces escaped as \040
             // 3rd field is fs type
-            // 4th field is mount options (ignored)
+            // 4th field is mount options
             // 5th field is used by dump(8) (ignored)
             // 6th field is fsck order (ignored)
             if (split.length < 6) {
@@ -144,6 +145,7 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, Map<St
             ) {
                 continue;
             }
+            String options = split[3];
 
             String name = split[0].replaceAll("\\\\040", " ");
             if (path.equals("/")) {
@@ -218,6 +220,7 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, Map<St
             osStore.setMount(path);
             osStore.setDescription(description);
             osStore.setType(type);
+            osStore.setOptions(options);
             osStore.setUUID(uuid);
             osStore.setFreeSpace(freeSpace);
             osStore.setUsableSpace(usableSpace);
diff --git a/oshi-core/src/main/java/oshi/software/os/mac/MacFileSystem.java b/oshi-core/src/main/java/oshi/software/os/mac/MacFileSystem.java
@@ -26,8 +26,11 @@
 import java.io.File;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -64,7 +67,54 @@ public class MacFileSystem extends AbstractFileSystem {
     // Regexp matcher for /dev/disk1 etc.
     private static final Pattern LOCAL_DISK = Pattern.compile("/dev/disk\\d");
 
+    // User specifiable flags.
+    private static final int MNT_RDONLY = 0x00000001;
+    private static final int MNT_SYNCHRONOUS = 0x00000002;
+    private static final int MNT_NOEXEC = 0x00000004;
+    private static final int MNT_NOSUID = 0x00000008;
+    private static final int MNT_NODEV = 0x00000010;
+    private static final int MNT_UNION = 0x00000020;
+    private static final int MNT_ASYNC = 0x00000040;
+    private static final int MNT_CPROTECT = 0x00000080;
+    private static final int MNT_EXPORTED = 0x00000100;
+    private static final int MNT_QUARANTINE = 0x00000400;
     private static final int MNT_LOCAL = 0x00001000;
+    private static final int MNT_QUOTA = 0x00002000;
+    private static final int MNT_ROOTFS = 0x00004000;
+    private static final int MNT_DOVOLFS = 0x00008000;
+    private static final int MNT_DONTBROWSE = 0x00100000;
+    private static final int MNT_IGNORE_OWNERSHIP = 0x00200000;
+    private static final int MNT_AUTOMOUNTED = 0x00400000;
+    private static final int MNT_JOURNALED = 0x00800000;
+    private static final int MNT_NOUSERXATTR = 0x01000000;
+    private static final int MNT_DEFWRITE = 0x02000000;
+    private static final int MNT_MULTILABEL = 0x04000000;
+    private static final int MNT_NOATIME = 0x10000000;
+
+    private static final Map<Integer, String> OPTIONS_MAP = new HashMap<>();
+    static {
+        OPTIONS_MAP.put(MNT_SYNCHRONOUS, "synchronous");
+        OPTIONS_MAP.put(MNT_NOEXEC, "noexec");
+        OPTIONS_MAP.put(MNT_NOSUID, "nosuid");
+        OPTIONS_MAP.put(MNT_NODEV, "nodev");
+        OPTIONS_MAP.put(MNT_UNION, "union");
+        OPTIONS_MAP.put(MNT_ASYNC, "asynchronous");
+        OPTIONS_MAP.put(MNT_CPROTECT, "content-protection");
+        OPTIONS_MAP.put(MNT_EXPORTED, "exported");
+        OPTIONS_MAP.put(MNT_QUARANTINE, "quarantined");
+        OPTIONS_MAP.put(MNT_LOCAL, "local");
+        OPTIONS_MAP.put(MNT_QUOTA, "quotas");
+        OPTIONS_MAP.put(MNT_ROOTFS, "rootfs");
+        OPTIONS_MAP.put(MNT_DOVOLFS, "volfs");
+        OPTIONS_MAP.put(MNT_DONTBROWSE, "nobrowse");
+        OPTIONS_MAP.put(MNT_IGNORE_OWNERSHIP, "noowners");
+        OPTIONS_MAP.put(MNT_AUTOMOUNTED, "automounted");
+        OPTIONS_MAP.put(MNT_JOURNALED, "journaled");
+        OPTIONS_MAP.put(MNT_NOUSERXATTR, "nouserxattr");
+        OPTIONS_MAP.put(MNT_DEFWRITE, "defwrite");
+        OPTIONS_MAP.put(MNT_MULTILABEL, "multilabel");
+        OPTIONS_MAP.put(MNT_NOATIME, "noatime");
+    }
 
     @Override
     public OSFileStore[] getFileStores(boolean localOnly) {
@@ -104,12 +154,10 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, boolea
 
                     // Get volume name
                     String volume = new String(fs[f].f_mntfromname, StandardCharsets.UTF_8).trim();
-                    // Skip system types
-                    if (volume.equals("devfs") || volume.startsWith("map ")) {
-                        continue;
-                    }
-                    // Skip non-local drives if requested
-                    if (localOnly && (fs[f].f_flags & MNT_LOCAL) == 0) {
+                    // Skip non-local drives if requested, skip system types
+                    final int flags = fs[f].f_flags;
+                    if ((localOnly && (flags & MNT_LOCAL) == 0) || volume.equals("devfs")
+                            || volume.startsWith("map ")) {
                         continue;
                     }
 
@@ -135,6 +183,13 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, boolea
                         continue;
                     }
 
+                    StringBuilder options = new StringBuilder((MNT_RDONLY & flags) == 0 ? "rw" : "ro");
+                    String moreOptions = OPTIONS_MAP.entrySet().stream().filter(e -> (e.getKey() & flags) > 0)
+                            .map(Map.Entry::getValue).collect(Collectors.joining(","));
+                    if (!moreOptions.isEmpty()) {
+                        options.append(',').append(moreOptions);
+                    }
+
                     String uuid = "";
                     // Use volume to find DiskArbitration volume name and search for
                     // the registry entry for UUID
@@ -187,6 +242,7 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, boolea
                     osStore.setMount(path);
                     osStore.setDescription(description);
                     osStore.setType(type);
+                    osStore.setOptions(options.toString());
                     osStore.setUUID(uuid == null ? "" : uuid);
                     osStore.setFreeSpace(file.getFreeSpace());
                     osStore.setUsableSpace(file.getUsableSpace());
diff --git a/oshi-core/src/main/java/oshi/software/os/unix/freebsd/FreeBsdFileSystem.java b/oshi-core/src/main/java/oshi/software/os/unix/freebsd/FreeBsdFileSystem.java
@@ -114,13 +114,16 @@ public OSFileStore[] getFileStores(boolean localOnly) {
             // 1st field is volume name
             // 2nd field is mount point
             // 3rd field is fs type
+            // 4th field is options
             // other fields ignored
             String volume = split[0];
             String path = split[1];
             String type = split[2];
+            String options = split[3];
 
             // Skip non-local drives if requested, and exclude pseudo file systems
-            if ((localOnly && NETWORK_FS_TYPES.contains(type)) || PSEUDO_FS.contains(type) || path.equals("/dev") || ParseUtil.filePathStartsWith(TMP_FS_PATHS, path)
+            if ((localOnly && NETWORK_FS_TYPES.contains(type)) || PSEUDO_FS.contains(type) || path.equals("/dev")
+                    || ParseUtil.filePathStartsWith(TMP_FS_PATHS, path)
                     || volume.startsWith("rpool") && !path.equals("/")) {
                 continue;
             }
@@ -155,6 +158,7 @@ public OSFileStore[] getFileStores(boolean localOnly) {
             osStore.setMount(path);
             osStore.setDescription(description);
             osStore.setType(type);
+            osStore.setOptions(options);
             osStore.setUUID(uuid);
             osStore.setFreeSpace(freeSpace);
             osStore.setUsableSpace(usableSpace);
diff --git a/oshi-core/src/main/java/oshi/software/os/unix/solaris/SolarisFileSystem.java b/oshi-core/src/main/java/oshi/software/os/unix/solaris/SolarisFileSystem.java
@@ -117,10 +117,12 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, boolea
             // 1st field is volume name
             // 2nd field is mount point
             // 3rd field is fs type
+            // 4th field is options
             // other fields ignored
             String volume = split[0];
             String path = split[1];
             String type = split[2];
+            String options = split[3];
 
             // Skip non-local drives if requested, and exclude pseudo file systems
             if ((localOnly && NETWORK_FS_TYPES.contains(type)) || PSEUDO_FS.contains(type) || path.equals("/dev")
@@ -161,6 +163,7 @@ private static List<OSFileStore> getFileStoreMatching(String nameToMatch, boolea
             osStore.setMount(path);
             osStore.setDescription(description);
             osStore.setType(type);
+            osStore.setOptions(options);
             osStore.setUUID(""); // No UUID info on Solaris
             osStore.setFreeSpace(freeSpace);
             osStore.setUsableSpace(usableSpace);
diff --git a/oshi-core/src/main/java/oshi/software/os/windows/WindowsFileSystem.java b/oshi-core/src/main/java/oshi/software/os/windows/WindowsFileSystem.java
@@ -27,12 +27,14 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import com.sun.jna.platform.win32.Kernel32; //NOSONAR
 import com.sun.jna.platform.win32.WinBase;
 import com.sun.jna.platform.win32.WinNT;
 import com.sun.jna.platform.win32.COM.WbemcliUtil.WmiQuery;
 import com.sun.jna.platform.win32.COM.WbemcliUtil.WmiResult;
+import com.sun.jna.ptr.IntByReference;
 
 import oshi.software.common.AbstractFileSystem;
 import oshi.software.os.OSFileStore;
@@ -55,6 +57,44 @@ public class WindowsFileSystem extends AbstractFileSystem {
 
     private static final int SEM_FAILCRITICALERRORS = 0x0001;
 
+    private static final int FILE_CASE_SENSITIVE_SEARCH = 0x00000001;
+    private static final int FILE_CASE_PRESERVED_NAMES = 0x00000002;
+    private static final int FILE_FILE_COMPRESSION = 0x00000010;
+    private static final int FILE_DAX_VOLUME = 0x20000000;
+    private static final int FILE_NAMED_STREAMS = 0x00040000;
+    private static final int FILE_PERSISTENT_ACLS = 0x00000008;
+    private static final int FILE_READ_ONLY_VOLUME = 0x00080000;
+    private static final int FILE_SEQUENTIAL_WRITE_ONCE = 0x00100000;
+    private static final int FILE_SUPPORTS_ENCRYPTION = 0x00020000;
+    private static final int FILE_SUPPORTS_OBJECT_IDS = 0x00010000;
+    private static final int FILE_SUPPORTS_REPARSE_POINTS = 0x00000080;
+    private static final int FILE_SUPPORTS_SPARSE_FILES = 0x00000040;
+    private static final int FILE_SUPPORTS_TRANSACTIONS = 0x00200000;
+    private static final int FILE_SUPPORTS_USN_JOURNAL = 0x02000000;
+    private static final int FILE_UNICODE_ON_DISK = 0x00000004;
+    private static final int FILE_VOLUME_IS_COMPRESSED = 0x00008000;
+    private static final int FILE_VOLUME_QUOTAS = 0x00000020;
+
+    private static final Map<Integer, String> OPTIONS_MAP = new HashMap<>();
+    static {
+        OPTIONS_MAP.put(FILE_CASE_PRESERVED_NAMES, "casepn");
+        OPTIONS_MAP.put(FILE_CASE_SENSITIVE_SEARCH, "casess");
+        OPTIONS_MAP.put(FILE_FILE_COMPRESSION, "fcomp");
+        OPTIONS_MAP.put(FILE_DAX_VOLUME, "dax");
+        OPTIONS_MAP.put(FILE_NAMED_STREAMS, "streams");
+        OPTIONS_MAP.put(FILE_PERSISTENT_ACLS, "acls");
+        OPTIONS_MAP.put(FILE_SEQUENTIAL_WRITE_ONCE, "wronce");
+        OPTIONS_MAP.put(FILE_SUPPORTS_ENCRYPTION, "efs");
+        OPTIONS_MAP.put(FILE_SUPPORTS_OBJECT_IDS, "oids");
+        OPTIONS_MAP.put(FILE_SUPPORTS_REPARSE_POINTS, "reparse");
+        OPTIONS_MAP.put(FILE_SUPPORTS_SPARSE_FILES, "sparse");
+        OPTIONS_MAP.put(FILE_SUPPORTS_TRANSACTIONS, "trans");
+        OPTIONS_MAP.put(FILE_SUPPORTS_USN_JOURNAL, "journaled");
+        OPTIONS_MAP.put(FILE_UNICODE_ON_DISK, "unicode");
+        OPTIONS_MAP.put(FILE_VOLUME_IS_COMPRESSED, "vcomp");
+        OPTIONS_MAP.put(FILE_VOLUME_QUOTAS, "quota");
+    }
+
     enum LogicalDiskProperty {
         DESCRIPTION, DRIVETYPE, FILESYSTEM, FREESPACE, NAME, PROVIDERNAME, SIZE;
     }
@@ -157,6 +197,7 @@ private static ArrayList<OSFileStore> getLocalVolumes(String nameToMatch) {
         char[] fstype;
         char[] name;
         char[] mount;
+        IntByReference pFlags;
 
         fs = new ArrayList<>();
         aVolume = new char[BUFSIZE];
@@ -170,36 +211,47 @@ private static ArrayList<OSFileStore> getLocalVolumes(String nameToMatch) {
             fstype = new char[16];
             name = new char[BUFSIZE];
             mount = new char[BUFSIZE];
+            pFlags = new IntByReference();
 
             userFreeBytes = new WinNT.LARGE_INTEGER(0L);
             totalBytes = new WinNT.LARGE_INTEGER(0L);
             systemFreeBytes = new WinNT.LARGE_INTEGER(0L);
 
             volume = new String(aVolume).trim();
-            Kernel32.INSTANCE.GetVolumeInformation(volume, name, BUFSIZE, null, null, null, fstype, 16);
+            Kernel32.INSTANCE.GetVolumeInformation(volume, name, BUFSIZE, null, null, pFlags, fstype, 16);
+            final int flags = pFlags.getValue();
             Kernel32.INSTANCE.GetVolumePathNamesForVolumeName(volume, mount, BUFSIZE, null);
 
             strMount = new String(mount).trim();
-            strName = new String(name).trim();
-            strFsType = new String(fstype).trim();
-            String osName = String.format("%s (%s)", strName, strMount);
-            if (nameToMatch == null || nameToMatch.equals(osName)) {
-                Kernel32.INSTANCE.GetDiskFreeSpaceEx(volume, userFreeBytes, totalBytes, systemFreeBytes);
-                // Parse uuid from volume name
-                String uuid = ParseUtil.parseUuidOrDefault(volume, "");
-
-                if (!strMount.isEmpty()) {
+            if (!strMount.isEmpty()) {
+                strName = new String(name).trim();
+                strFsType = new String(fstype).trim();
+
+                StringBuilder options = new StringBuilder((FILE_READ_ONLY_VOLUME & flags) == 0 ? "rw" : "ro");
+                String moreOptions = OPTIONS_MAP.entrySet().stream().filter(e -> (e.getKey() & flags) > 0)
+                        .map(Map.Entry::getValue).collect(Collectors.joining(","));
+                if (!moreOptions.isEmpty()) {
+                    options.append(',').append(moreOptions);
+                }
+                String osName = String.format("%s (%s)", strName, strMount);
+                if (nameToMatch == null || nameToMatch.equals(osName)) {
+                    Kernel32.INSTANCE.GetDiskFreeSpaceEx(volume, userFreeBytes, totalBytes, systemFreeBytes);
+                    // Parse uuid from volume name
+                    String uuid = ParseUtil.parseUuidOrDefault(volume, "");
+
                     // Volume is mounted
                     OSFileStore osStore = new OSFileStore();
                     osStore.setName(osName);
                     osStore.setVolume(volume);
                     osStore.setMount(strMount);
                     osStore.setDescription(getDriveType(strMount));
                     osStore.setType(strFsType);
+                    osStore.setOptions(options.toString());
                     osStore.setUUID(uuid);
                     osStore.setFreeSpace(systemFreeBytes.getValue());
                     osStore.setUsableSpace(userFreeBytes.getValue());
                     osStore.setTotalSpace(totalBytes.getValue());
+                    System.out.println(osStore.toString());
                     fs.add(osStore);
                 }
             }
@@ -238,7 +290,8 @@ private static List<OSFileStore> getWmiVolumes(String nameToMatch, boolean local
             wmiClassName.append(where ? " WHERE" : " AND").append(" Name=\"").append(nameToMatch).append('\"');
         }
         WmiQueryHandler wmiQueryHandler = WmiQueryHandler.createInstance();
-        WmiQuery<LogicalDiskProperty> logicalDiskQuery = new WmiQuery<>(wmiClassName.toString(), LogicalDiskProperty.class);
+        WmiQuery<LogicalDiskProperty> logicalDiskQuery = new WmiQuery<>(wmiClassName.toString(),
+                LogicalDiskProperty.class);
         WmiResult<LogicalDiskProperty> drives = wmiQueryHandler.queryWMI(logicalDiskQuery);
 
         for (int i = 0; i < drives.getResultCount(); i++) {
diff --git a/oshi-core/src/test/java/oshi/software/os/FileSystemTest.java b/oshi-core/src/test/java/oshi/software/os/FileSystemTest.java
