Adjust how macOS drives are analysed and add a couple of tests.
[dcpomatic.git] / src / lib / cross_osx.cc
index d0cb9f216980846307f70c84745e98a38f5a18be..2dc9b2702b006044f8d384e450f6877753ccc4c3 100644 (file)
@@ -104,7 +104,7 @@ cpu_info ()
 boost::filesystem::path
 directory_containing_executable ()
 {
-       return boost::dll::program_location().parent_path();
+       return boost::filesystem::canonical(boost::dll::program_location()).parent_path();
 }
 
 
@@ -309,14 +309,7 @@ get_model (CFDictionaryRef& description)
 }
 
 
-struct MediaPath
-{
-       bool real;       ///< true for a "real" disk, false for a synthesized APFS one
-       std::string prt; ///< "PRT" entry from the media path
-};
-
-
-static optional<MediaPath>
+static optional<OSXMediaPath>
 analyse_media_path (CFDictionaryRef& description)
 {
        using namespace boost::algorithm;
@@ -335,31 +328,7 @@ analyse_media_path (CFDictionaryRef& description)
 
        string path(path_key_cstr);
        LOG_DISK("MediaPathKey is %1", path);
-
-       if (path.find("/IOHDIXController") != string::npos) {
-               /* This is a disk image, so we completely ignore it */
-               LOG_DISK_NC("Ignoring this as it seems to be a disk image");
-               return {};
-       }
-
-       MediaPath mp;
-       if (starts_with(path, "IODeviceTree:")) {
-               mp.real = true;
-       } else if (starts_with(path, "IOService:")) {
-               mp.real = false;
-       } else {
-               return {};
-       }
-
-       vector<string> bits;
-       split(bits, path, boost::is_any_of("/"));
-       for (auto i: bits) {
-               if (starts_with(i, "PRT")) {
-                       mp.prt = i;
-               }
-       }
-
-       return mp;
+       return analyse_osx_media_path (path);
 }
 
 
@@ -411,26 +380,13 @@ mount_point (CFDictionaryRef& description)
  * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
  * which are mounted.  /dev/disk2s2 is not considered to be mounted, in this case.  So we need to know that
  * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are.  In order to do
- * this I am picking out what looks like a suitable identifier prefixed with PRT from the MediaContentKey.
- * If disk2s2 and disk3 have the same PRT code I am assuming they are linked.
+ * this I am taking the first two parts of the IODeviceTree and seeing if they exist anywhere in a
+ * IOService identifier.  If they do, I am assuming the IOService device is on the matching IODeviceTree device.
  *
  * Lots of this is guesswork and may be broken.  In my defence the documentation that I have been able to
  * unearth is, to put it impolitely, crap.
  */
 
-struct Disk
-{
-       string mount_point;
-       optional<string> vendor;
-       optional<string> model;
-       bool real;
-       string prt;
-       bool whole;
-       vector<boost::filesystem::path> mount_points;
-       unsigned long size;
-};
-
-
 static void
 disk_appeared (DADiskRef disk, void* context)
 {
@@ -441,10 +397,10 @@ disk_appeared (DADiskRef disk, void* context)
        }
        LOG_DISK("%1 appeared", bsd_name);
 
-       Disk this_disk;
+       OSXDisk this_disk;
 
-       this_disk.mount_point = string("/dev/") + bsd_name;
-       LOG_DISK("Mount point is %1", this_disk.mount_point);
+       this_disk.device = string("/dev/") + bsd_name;
+       LOG_DISK("Device is %1", this_disk.device);
 
        CFDictionaryRef description = DADiskCopyDescription (disk);
 
@@ -458,8 +414,7 @@ disk_appeared (DADiskRef disk, void* context)
                return;
        }
 
-       this_disk.real = media_path->real;
-       this_disk.prt = media_path->prt;
+       this_disk.media_path = *media_path;
        this_disk.whole = is_whole_drive (disk);
        auto mp = mount_point (description);
        if (mp) {
@@ -467,11 +422,10 @@ disk_appeared (DADiskRef disk, void* context)
        }
 
        LOG_DISK(
-               "%1 prt %2 whole %3 mounted %4",
-                this_disk.real ? "Real" : "Synth",
-                this_disk.prt,
+               "%1 %2 mounted at %3",
+                this_disk.media_path.real ? "Real" : "Synth",
                 this_disk.whole ? "whole" : "part",
-                mp ? ("mounted at " + mp->string()) : "unmounted"
+                mp ? mp->string() : "[nowhere]"
                );
 
        auto media_size_cstr = CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey);
@@ -483,7 +437,7 @@ disk_appeared (DADiskRef disk, void* context)
        CFNumberGetValue ((CFNumberRef) media_size_cstr, kCFNumberLongType, &this_disk.size);
        CFRelease (description);
 
-       reinterpret_cast<vector<Disk>*>(context)->push_back(this_disk);
+       reinterpret_cast<vector<OSXDisk>*>(context)->push_back(this_disk);
 }
 
 
@@ -491,7 +445,7 @@ vector<Drive>
 Drive::get ()
 {
        using namespace boost::algorithm;
-       vector<Disk> disks;
+       vector<OSXDisk> disks;
 
        auto session = DASessionCreate(kCFAllocatorDefault);
        if (!session) {
@@ -506,53 +460,12 @@ Drive::get ()
        DAUnregisterCallback(session, (void *) disk_appeared, &disks);
        CFRelease(session);
 
-       /* Mark disks containing mounted partitions as themselves mounted */
-       for (auto& i: disks) {
-               if (!i.whole) {
-                       continue;
-               }
-               for (auto& j: disks) {
-                       if (!j.mount_points.empty() && starts_with(j.mount_point, i.mount_point)) {
-                               LOG_DISK("Marking %1 as mounted because %2 is", i.mount_point, j.mount_point);
-                               std::copy(j.mount_points.begin(), j.mount_points.end(), back_inserter(i.mount_points));
-                       }
-               }
-       }
-
-       /* Make a map of the PRT codes and mount points of mounted, synthesized disks */
-       map<string, vector<boost::filesystem::path>> mounted_synths;
-       for (auto& i: disks) {
-               if (!i.real && !i.mount_points.empty()) {
-                       LOG_DISK("Found a mounted synth %1 with %2", i.mount_point, i.prt);
-                       mounted_synths[i.prt] = i.mount_points;
-               }
-       }
-
-       /* Mark containers of those mounted synths as themselves mounted */
-       for (auto& i: disks) {
-               if (i.real) {
-                       auto j = mounted_synths.find(i.prt);
-                       if (j != mounted_synths.end()) {
-                               LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.mount_point, i.prt);
-                               std::copy(j->second.begin(), j->second.end(), back_inserter(i.mount_points));
-                       }
-               }
-       }
-
-       vector<Drive> drives;
-       for (auto& i: disks) {
-               if (i.whole) {
-                       /* A whole disk that is not a container for a mounted synth */
-                       drives.push_back(Drive(i.mount_point, i.mount_points, i.size, i.vendor, i.model));
-                       LOG_DISK_NC(drives.back().log_summary());
-               }
-       }
-       return drives;
+       return osx_disks_to_drives (disks);
 }
 
 
 boost::filesystem::path
-config_path ()
+config_path (optional<string> version)
 {
        boost::filesystem::path p;
        p /= g_get_home_dir ();
@@ -560,6 +473,9 @@ config_path ()
        p /= "Preferences";
        p /= "com.dcpomatic";
        p /= "2";
+       if (version) {
+               p /= *version;
+       }
        return p;
 }