Move some common methods out to cross_unix.cc
[dcpomatic.git] / src / lib / cross_osx.cc
index 8b60ff492f2cc8ea4234fa5fd309ce64c852d631..eb713a980eb7325dae61459b66af7769ac7c3e6c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 #include "cross.h"
 #include "compose.hpp"
 #include "log.h"
 #include "dcpomatic_log.h"
 #include "config.h"
 #include "exceptions.h"
-#include "warnings.h"
 #include <dcp/raw_convert.h>
 #include <glib.h>
-extern "C" {
-#include <libavformat/avio.h>
-}
 #include <boost/algorithm/string.hpp>
 #include <boost/regex.hpp>
 #if BOOST_VERSION >= 106100
@@ -52,11 +49,11 @@ extern "C" {
 
 #include "i18n.h"
 
+
 using std::pair;
 using std::list;
 using std::ifstream;
 using std::string;
-using std::wstring;
 using std::make_pair;
 using std::vector;
 using std::cerr;
@@ -65,20 +62,8 @@ using std::runtime_error;
 using std::map;
 using std::shared_ptr;
 using boost::optional;
-using boost::function;
+using std::function;
 
-/** @param s Number of seconds to sleep for */
-void
-dcpomatic_sleep_seconds (int s)
-{
-       sleep (s);
-}
-
-void
-dcpomatic_sleep_milliseconds (int ms)
-{
-       usleep (ms * 1000);
-}
 
 /** @return A string of CPU information (model name etc.) */
 string
@@ -88,7 +73,7 @@ cpu_info ()
 
        char buffer[64];
        size_t N = sizeof (buffer);
-       if (sysctlbyname ("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
+       if (sysctlbyname("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
                info = buffer;
        }
 
@@ -99,19 +84,7 @@ cpu_info ()
 boost::filesystem::path
 directory_containing_executable ()
 {
-#if BOOST_VERSION >= 106100
-       return boost::dll::program_location().parent_path();
-#else
-       uint32_t size = 1024;
-       char buffer[size];
-       if (_NSGetExecutablePath (buffer, &size)) {
-               throw runtime_error ("_NSGetExecutablePath failed");
-       }
-
-       boost::filesystem::path path (buffer);
-       path = boost::filesystem::canonical (path);
-       return path.parent_path ();
-#endif
+       return boost::filesystem::canonical(boost::dll::program_location()).parent_path();
 }
 
 
@@ -123,23 +96,16 @@ resources_path ()
 
 
 boost::filesystem::path
-xsd_path ()
-{
-       return resources_path() / "xsd";
-}
-
-
-boost::filesystem::path
-tags_path ()
+libdcp_resources_path ()
 {
-       return resources_path() / "tags";
+       return resources_path();
 }
 
 
 void
 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 {
-       boost::filesystem::path path = directory_containing_executable () / "ffprobe";
+       auto path = directory_containing_executable () / "ffprobe";
 
        string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
        LOG_GENERAL (N_("Probing with %1"), ffprobe);
@@ -147,13 +113,14 @@ run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 }
 
 
-list<pair<string, string> >
+
+list<pair<string, string>>
 mount_info ()
 {
-       list<pair<string, string> > m;
-       return m;
+       return {};
 }
 
+
 boost::filesystem::path
 openssl_path ()
 {
@@ -170,21 +137,6 @@ disk_writer_path ()
 }
 #endif
 
-/* Apparently there is no way to create an ofstream using a UTF-8
-   filename under Windows.  We are hence reduced to using fopen
-   with this wrapper.
-*/
-FILE *
-fopen_boost (boost::filesystem::path p, string t)
-{
-        return fopen (p.c_str(), t.c_str ());
-}
-
-int
-dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
-{
-       return fseek (stream, offset, whence);
-}
 
 void
 Waker::nudge ()
@@ -192,25 +144,28 @@ Waker::nudge ()
 
 }
 
+
 Waker::Waker ()
 {
        boost::mutex::scoped_lock lm (_mutex);
        IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
 }
 
+
 Waker::~Waker ()
 {
        boost::mutex::scoped_lock lm (_mutex);
        IOPMAssertionRelease (_assertion_id);
 }
 
+
 void
 start_tool (string executable, string app)
 {
-       boost::filesystem::path exe_path = directory_containing_executable();
-       exe_path = exe_path.parent_path (); // Contents
-       exe_path = exe_path.parent_path (); // DCP-o-matic 2.app
-       exe_path = exe_path.parent_path (); // Applications
+       auto exe_path = directory_containing_executable();
+       exe_path = exe_path.parent_path(); // Contents
+       exe_path = exe_path.parent_path(); // DCP-o-matic 2.app
+       exe_path = exe_path.parent_path(); // Applications
        exe_path /= app;
        exe_path /= "Contents";
        exe_path /= "MacOS";
@@ -241,104 +196,67 @@ start_player ()
 }
 
 
-uint64_t
-thread_id ()
-{
-       return (uint64_t) pthread_self ();
-}
-
-int
-avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
-{
-       return avio_open (s, file.c_str(), flags);
-}
-
-boost::filesystem::path
-home_directory ()
-{
-               return getenv("HOME");
-}
-
-/** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
-bool
-running_32_on_64 ()
-{
-       /* I'm assuming nobody does this on OS X */
-       return false;
-}
-
 static optional<string>
 get_vendor (CFDictionaryRef& description)
 {
        void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
        if (!str) {
-               return optional<string>();
+               return {};
+       }
+
+       auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
+       if (!c_str) {
+               return {};
        }
 
-       string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
+       string s (c_str);
        boost::algorithm::trim (s);
        return s;
 }
 
+
 static optional<string>
 get_model (CFDictionaryRef& description)
 {
        void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
        if (!str) {
-               return optional<string>();
+               return {};
+       }
+
+       auto c_str = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
+       if (!c_str) {
+               return {};
        }
 
-       string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
+       string s (c_str);
        boost::algorithm::trim (s);
        return s;
 }
 
-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;
 
        void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
        if (!str) {
-               LOG_DISK_NC("There is no MediaPathKey");
-               return optional<MediaPath>();
-       }
-
-       string path(CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8));
-       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 optional<MediaPath>();
-       }
-
-       MediaPath mp;
-       if (starts_with(path, "IODeviceTree:")) {
-               mp.real = true;
-       } else if (starts_with(path, "IOService:")) {
-               mp.real = false;
-       } else {
-               return optional<MediaPath>();
+               LOG_DISK_NC("There is no MediaPathKey (no dictionary value)");
+               return {};
        }
 
-       vector<string> bits;
-       split(bits, path, boost::is_any_of("/"));
-       for (auto i: bits) {
-               if (starts_with(i, "PRT")) {
-                       mp.prt = i;
-               }
+       auto path_key_cstr = CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8);
+       if (!path_key_cstr) {
+               LOG_DISK_NC("There is no MediaPathKey (no cstring)");
+               return {};
        }
 
-       return mp;
+       string path(path_key_cstr);
+       LOG_DISK("MediaPathKey is %1", path);
+       return analyse_osx_media_path (path);
 }
 
+
 static bool
 is_whole_drive (DADiskRef& disk)
 {
@@ -353,17 +271,23 @@ is_whole_drive (DADiskRef& disk)
        return whole_media;
 }
 
+
 static optional<boost::filesystem::path>
 mount_point (CFDictionaryRef& description)
 {
-       CFURLRef volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
+       auto volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
+       if (!volume_path_key) {
+               return {};
+       }
+
        char mount_path_buffer[1024];
        if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
-               return boost::optional<boost::filesystem::path>();
+               return {};
        }
        return boost::filesystem::path(mount_path_buffer);
 }
 
+
 /* Here follows some rather intricate and (probably) fragile code to find the list of available
  * "real" drives on macOS that we might want to write a DCP to.
  *
@@ -381,37 +305,27 @@ 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)
 {
-       const char* bsd_name = DADiskGetBSDName (disk);
+       auto bsd_name = DADiskGetBSDName (disk);
        if (!bsd_name) {
+               LOG_DISK_NC("Disk with no BSDName appeared");
                return;
        }
        LOG_DISK("%1 appeared", bsd_name);
 
-       Disk this_disk;
+       OSXDisk this_disk;
 
-       this_disk.mount_point = string("/dev/") + bsd_name;
+       this_disk.device = string("/dev/") + bsd_name;
+       LOG_DISK("Device is %1", this_disk.device);
 
        CFDictionaryRef description = DADiskCopyDescription (disk);
 
@@ -419,100 +333,64 @@ disk_appeared (DADiskRef disk, void* context)
        this_disk.model = get_model (description);
        LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
 
-       optional<MediaPath> media_path = analyse_media_path (description);
+       auto media_path = analyse_media_path (description);
        if (!media_path) {
                LOG_DISK("Finding media path for %1 failed", bsd_name);
                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);
-       optional<boost::filesystem::path> mp = mount_point (description);
+       auto mp = mount_point (description);
        if (mp) {
                this_disk.mount_points.push_back (*mp);
        }
 
        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]"
                );
 
-       CFNumberGetValue ((CFNumberRef) CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey), kCFNumberLongType, &this_disk.size);
+       auto media_size_cstr = CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey);
+       if (!media_size_cstr) {
+               LOG_DISK_NC("Could not read media size");
+               return;
+       }
+
+       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);
 }
 
+
 vector<Drive>
 Drive::get ()
 {
        using namespace boost::algorithm;
-       vector<Disk> disks;
+       vector<OSXDisk> disks;
 
-       DASessionRef session = DASessionCreate(kCFAllocatorDefault);
+       auto session = DASessionCreate(kCFAllocatorDefault);
        if (!session) {
-               return vector<Drive>();
+               return {};
        }
 
        DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
-       CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
+       auto run_loop = CFRunLoopGetCurrent ();
        DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
        CFRunLoopStop (run_loop);
        CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
        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) {
-                       map<string, vector<boost::filesystem::path> >::const_iterator 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 ();
@@ -520,6 +398,9 @@ config_path ()
        p /= "Preferences";
        p /= "com.dcpomatic";
        p /= "2";
+       if (version) {
+               p /= *version;
+       }
        return p;
 }
 
@@ -543,12 +424,12 @@ Drive::unmount ()
 {
        LOG_DISK_NC("Unmount operation started");
 
-       DASessionRef session = DASessionCreate(kCFAllocatorDefault);
+       auto session = DASessionCreate(kCFAllocatorDefault);
        if (!session) {
                return false;
        }
 
-       DADiskRef disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
+       auto disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
        if (!disk) {
                return false;
        }
@@ -579,15 +460,17 @@ void
 make_foreground_application ()
 {
        ProcessSerialNumber serial;
-DCPOMATIC_DISABLE_WARNINGS
+LIBDCP_DISABLE_WARNINGS
        GetCurrentProcess (&serial);
-DCPOMATIC_ENABLE_WARNINGS
+LIBDCP_ENABLE_WARNINGS
        TransformProcessType (&serial, kProcessTransformToForegroundApplication);
 }
 
 
-string
-dcpomatic::get_process_id ()
+bool
+show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
 {
-       return dcp::raw_convert<string>(getpid());
+       int r = system (String::compose("open -R \"%1\"", select.string()).c_str());
+       return static_cast<bool>(WEXITSTATUS(r));
 }
+