BOOST_FOREACH.
[dcpomatic.git] / src / lib / cross_osx.cc
index a363f0570b98af54779f5ac5d8d59823dd35733f..8b60ff492f2cc8ea4234fa5fd309ce64c852d631 100644 (file)
 #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/foreach.hpp>
 #include <boost/regex.hpp>
+#if BOOST_VERSION >= 106100
+#include <boost/dll/runtime_symbol_info.hpp>
+#endif
+#include <ApplicationServices/ApplicationServices.h>
 #include <sys/sysctl.h>
 #include <mach-o/dyld.h>
 #include <IOKit/pwr_mgt/IOPMLib.h>
@@ -58,8 +62,10 @@ using std::vector;
 using std::cerr;
 using std::cout;
 using std::runtime_error;
-using boost::shared_ptr;
+using std::map;
+using std::shared_ptr;
 using boost::optional;
+using boost::function;
 
 /** @param s Number of seconds to sleep for */
 void
@@ -89,14 +95,13 @@ cpu_info ()
        return info;
 }
 
-/** @return Path of the Contents directory in the .app */
+
 boost::filesystem::path
-app_contents ()
+directory_containing_executable ()
 {
-       /* Could use boost::dll::program_location().parent_path().parent_path() but that
-        * boost library isn't in the 10.6 environment we're currently using and I don't
-        * really want to change it right now.
-        */
+#if BOOST_VERSION >= 106100
+       return boost::dll::program_location().parent_path();
+#else
        uint32_t size = 1024;
        char buffer[size];
        if (_NSGetExecutablePath (buffer, &size)) {
@@ -105,29 +110,43 @@ app_contents ()
 
        boost::filesystem::path path (buffer);
        path = boost::filesystem::canonical (path);
-       path = path.parent_path ();
-       path = path.parent_path ();
-       return path;
+       return path.parent_path ();
+#endif
+}
+
+
+boost::filesystem::path
+resources_path ()
+{
+       return directory_containing_executable().parent_path() / "Resources";
+}
+
+
+boost::filesystem::path
+xsd_path ()
+{
+       return resources_path() / "xsd";
 }
 
+
 boost::filesystem::path
-shared_path ()
+tags_path ()
 {
-       return app_contents() / "Resources";
+       return resources_path() / "tags";
 }
 
+
 void
 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 {
-       boost::filesystem::path path = app_contents();
-       path /= "MacOS";
-       path /= "ffprobe";
+       boost::filesystem::path path = directory_containing_executable () / "ffprobe";
 
        string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
        LOG_GENERAL (N_("Probing with %1"), ffprobe);
        system (ffprobe.c_str ());
 }
 
+
 list<pair<string, string> >
 mount_info ()
 {
@@ -138,20 +157,16 @@ mount_info ()
 boost::filesystem::path
 openssl_path ()
 {
-       boost::filesystem::path path = app_contents();
-       path /= "MacOS";
-       path /= "openssl";
-       return path;
+       return directory_containing_executable() / "openssl";
 }
 
+
 #ifdef DCPOMATIC_DISK
+/* Note: this isn't actually used at the moment as the disk writer is started as a service */
 boost::filesystem::path
 disk_writer_path ()
 {
-       boost::filesystem::path path = app_contents();
-       path /= "MacOS";
-       path /= "dcpomatic2_disk_writer";
-       return path;
+       return directory_containing_executable() / "dcpomatic2_disk_writer";
 }
 #endif
 
@@ -180,10 +195,7 @@ Waker::nudge ()
 Waker::Waker ()
 {
        boost::mutex::scoped_lock lm (_mutex);
-       /* We should use this */
-        // IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
-       /* but it's not available on 10.5, so we use this */
-        IOPMAssertionCreate (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, &_assertion_id);
+       IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
 }
 
 Waker::~Waker ()
@@ -193,37 +205,42 @@ Waker::~Waker ()
 }
 
 void
-start_tool (boost::filesystem::path dcpomatic, string executable, string app)
-{
-       boost::filesystem::path batch = dcpomatic.parent_path ();
-       batch = batch.parent_path (); // MacOS
-       batch = batch.parent_path (); // Contents
-       batch = batch.parent_path (); // DCP-o-matic.app
-       batch = batch.parent_path (); // Applications
-       batch /= app;
-       batch /= "Contents";
-       batch /= "MacOS";
-       batch /= executable;
+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
+       exe_path /= app;
+       exe_path /= "Contents";
+       exe_path /= "MacOS";
+       exe_path /= executable;
 
        pid_t pid = fork ();
        if (pid == 0) {
-               int const r = system (batch.string().c_str());
+               LOG_GENERAL ("start_tool %1 %2 with path %3", executable, app, exe_path.string());
+               int const r = system (exe_path.string().c_str());
                exit (WEXITSTATUS (r));
+       } else if (pid == -1) {
+               LOG_ERROR_NC("Fork failed in start_tool");
        }
 }
 
+
 void
-start_batch_converter (boost::filesystem::path dcpomatic)
+start_batch_converter ()
 {
-       start_tool (dcpomatic, "dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
+       start_tool ("dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
 }
 
+
 void
-start_player (boost::filesystem::path dcpomatic)
+start_player ()
 {
-       start_tool (dcpomatic, "dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
+       start_tool ("dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
 }
 
+
 uint64_t
 thread_id ()
 {
@@ -242,12 +259,6 @@ home_directory ()
                return getenv("HOME");
 }
 
-string
-command_and_read (string cmd)
-{
-       return "";
-}
-
 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
 bool
 running_32_on_64 ()
@@ -295,10 +306,19 @@ analyse_media_path (CFDictionaryRef& description)
 
        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;
@@ -310,7 +330,7 @@ analyse_media_path (CFDictionaryRef& description)
 
        vector<string> bits;
        split(bits, path, boost::is_any_of("/"));
-       BOOST_FOREACH (string i, bits) {
+       for (auto i: bits) {
                if (starts_with(i, "PRT")) {
                        mp.prt = i;
                }
@@ -333,25 +353,28 @@ is_whole_drive (DADiskRef& disk)
        return whole_media;
 }
 
-static bool
-is_mounted (CFDictionaryRef& description)
+static optional<boost::filesystem::path>
+mount_point (CFDictionaryRef& description)
 {
        CFURLRef volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
        char mount_path_buffer[1024];
-       return CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer));
+       if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
+               return boost::optional<boost::filesystem::path>();
+       }
+       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.
  *
- * We use the Disk Arbitration framework to give us a series of devices (/dev/disk0, /dev/disk1,
- * /dev/disk1s1 and so on) and we use the API to gather useful information about these devices into
+ * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
+ * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
  * a vector of Disk structs.
  *
  * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
  * user, with details of whether those drives are currently mounted or not.
  *
- * At the basic level we find the "disk"-level devices, looking at whether any of their partitions are mounted.
+ * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
  *
  * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
  * reflect data in `real' partitions.  So, for example, we might have a real (physical) drive /dev/disk2 with
@@ -367,13 +390,13 @@ is_mounted (CFDictionaryRef& description)
 
 struct Disk
 {
-       string device;
+       string mount_point;
        optional<string> vendor;
        optional<string> model;
        bool real;
        string prt;
        bool whole;
-       bool mounted;
+       vector<boost::filesystem::path> mount_points;
        unsigned long size;
 };
 
@@ -388,7 +411,7 @@ disk_appeared (DADiskRef disk, void* context)
 
        Disk this_disk;
 
-       this_disk.device = string("/dev/") + bsd_name;
+       this_disk.mount_point = string("/dev/") + bsd_name;
 
        CFDictionaryRef description = DADiskCopyDescription (disk);
 
@@ -405,8 +428,18 @@ disk_appeared (DADiskRef disk, void* context)
        this_disk.real = media_path->real;
        this_disk.prt = media_path->prt;
        this_disk.whole = is_whole_drive (disk);
-       this_disk.mounted = is_mounted (description);
-       LOG_DISK("%1 prt %2 whole %3 mounted %4", this_disk.real ? "Real" : "Synth", this_disk.prt, this_disk.whole ? "whole" : "part", this_disk.mounted ? "mounted" : "unmounted");
+       optional<boost::filesystem::path> 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,
+                this_disk.whole ? "whole" : "part",
+                mp ? ("mounted at " + mp->string()) : "unmounted"
+               );
 
        CFNumberGetValue ((CFNumberRef) CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey), kCFNumberLongType, &this_disk.size);
        CFRelease (description);
@@ -415,7 +448,7 @@ disk_appeared (DADiskRef disk, void* context)
 }
 
 vector<Drive>
-get_drives ()
+Drive::get ()
 {
        using namespace boost::algorithm;
        vector<Disk> disks;
@@ -434,46 +467,50 @@ get_drives ()
        CFRelease(session);
 
        /* Mark disks containing mounted partitions as themselves mounted */
-       BOOST_FOREACH (Disk& i, disks) {
+       for (auto& i: disks) {
                if (!i.whole) {
                        continue;
                }
-               BOOST_FOREACH (Disk& j, disks) {
-                       if (j.mounted && starts_with(j.device, i.device)) {
-                               LOG_DISK("Marking %1 as mounted because %2 is", i.device, j.device);
-                               i.mounted = true;
+               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 list of the PRT codes of mounted, synthesized disks */
-       vector<string> mounted_synths;
-       BOOST_FOREACH (Disk& i, disks) {
-               if (!i.real && i.mounted) {
-                       LOG_DISK("Found a mounted synth %1 with %2", i.device, i.prt);
-                       mounted_synths.push_back (i.prt);
+       /* 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 */
-       BOOST_FOREACH (Disk& i, disks) {
-               if (i.real && find(mounted_synths.begin(), mounted_synths.end(), i.prt) != mounted_synths.end()) {
-                       LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.device, i.prt);
-                       i.mounted = true;
+       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;
-       BOOST_FOREACH (Disk& i, disks) {
+       for (auto& i: disks) {
                if (i.whole) {
                        /* A whole disk that is not a container for a mounted synth */
-                       LOG_DISK("Adding drive: %1 %2 %3 %4 %5", i.device, i.size, i.mounted ? "mounted" : "unmounted", i.vendor.get_value_or("[none]"), i.model.get_value_or("[none]"));
-                       drives.push_back(Drive(i.device, i.size, i.mounted, i.vendor, i.model));
+                       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;
 }
 
+
 boost::filesystem::path
 config_path ()
 {
@@ -486,11 +523,71 @@ config_path ()
        return p;
 }
 
+
+void done_callback(DADiskRef, DADissenterRef dissenter, void* context)
+{
+       LOG_DISK_NC("Unmount finished");
+       bool* success = reinterpret_cast<bool*> (context);
+       if (dissenter) {
+               LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
+               *success = false;
+       } else {
+               LOG_DISK_NC("Successful");
+               *success = true;
+       }
+}
+
+
 bool
-unmount_device (string device)
+Drive::unmount ()
+{
+       LOG_DISK_NC("Unmount operation started");
+
+       DASessionRef session = DASessionCreate(kCFAllocatorDefault);
+       if (!session) {
+               return false;
+       }
+
+       DADiskRef disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
+       if (!disk) {
+               return false;
+       }
+       LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
+       bool success = false;
+       DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
+       CFRelease (disk);
+
+       CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
+       DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
+       CFRunLoopStop (run_loop);
+       CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
+       CFRelease(session);
+
+       LOG_DISK_NC("End of unmount");
+       return success;
+}
+
+
+void
+disk_write_finished ()
 {
-       int const r = umount(device.c_str());
-       LOG_DISK("Tried to unmount %1 and got %2 and %3", device, r, errno);
-       return r == 0;
 
 }
+
+
+void
+make_foreground_application ()
+{
+       ProcessSerialNumber serial;
+DCPOMATIC_DISABLE_WARNINGS
+       GetCurrentProcess (&serial);
+DCPOMATIC_ENABLE_WARNINGS
+       TransformProcessType (&serial, kProcessTransformToForegroundApplication);
+}
+
+
+string
+dcpomatic::get_process_id ()
+{
+       return dcp::raw_convert<string>(getpid());
+}