src/lib/cross_osx.cc

   1 /*
   2     Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "cross.h"
  22 #include "compose.hpp"
  23 #include "log.h"
  24 #include "dcpomatic_log.h"
  25 #include "config.h"
  26 #include "exceptions.h"
  27 #include "warnings.h"
  28 #include <dcp/raw_convert.h>
  29 #include <glib.h>
  30 extern "C" {
  31 #include <libavformat/avio.h>
  32 }
  33 #include <boost/algorithm/string.hpp>
  34 #include <boost/foreach.hpp>
  35 #include <boost/regex.hpp>
  36 #if BOOST_VERSION >= 106100
  37 #include <boost/dll/runtime_symbol_info.hpp>
  38 #endif
  39 #include <ApplicationServices/ApplicationServices.h>
  40 #include <sys/sysctl.h>
  41 #include <mach-o/dyld.h>
  42 #include <IOKit/pwr_mgt/IOPMLib.h>
  43 #include <IOKit/storage/IOMedia.h>
  44 #include <DiskArbitration/DADisk.h>
  45 #include <DiskArbitration/DiskArbitration.h>
  46 #include <CoreFoundation/CFURL.h>
  47 #include <sys/types.h>
  48 #include <ifaddrs.h>
  49 #include <netinet/in.h>
  50 #include <arpa/inet.h>
  51 #include <fstream>
  52 #include <cstring>
  53
  54 #include "i18n.h"
  55
  56 using std::pair;
  57 using std::list;
  58 using std::ifstream;
  59 using std::string;
  60 using std::wstring;
  61 using std::make_pair;
  62 using std::vector;
  63 using std::cerr;
  64 using std::cout;
  65 using std::runtime_error;
  66 using std::map;
  67 using boost::shared_ptr;
  68 using boost::optional;
  69 using boost::function;
  70
  71 /** @param s Number of seconds to sleep for */
  72 void
  73 dcpomatic_sleep_seconds (int s)
  74 {
  75         sleep (s);
  76 }
  77
  78 void
  79 dcpomatic_sleep_milliseconds (int ms)
  80 {
  81         usleep (ms * 1000);
  82 }
  83
  84 /** @return A string of CPU information (model name etc.) */
  85 string
  86 cpu_info ()
  87 {
  88         string info;
  89
  90         char buffer[64];
  91         size_t N = sizeof (buffer);
  92         if (sysctlbyname ("machdep.cpu.brand_string", buffer, &N, 0, 0) == 0) {
  93                 info = buffer;
  94         }
  95
  96         return info;
  97 }
  98
  99
 100 boost::filesystem::path
 101 directory_containing_executable ()
 102 {
 103 #if BOOST_VERSION >= 106100
 104         return boost::dll::program_location().parent_path();
 105 #else
 106         uint32_t size = 1024;
 107         char buffer[size];
 108         if (_NSGetExecutablePath (buffer, &size)) {
 109                 throw runtime_error ("_NSGetExecutablePath failed");
 110         }
 111
 112         boost::filesystem::path path (buffer);
 113         path = boost::filesystem::canonical (path);
 114         return path.parent_path ();
 115 #endif
 116 }
 117
 118
 119 boost::filesystem::path
 120 resources_path ()
 121 {
 122         return directory_containing_executable().parent_path() / "Resources";
 123 }
 124
 125
 126 boost::filesystem::path
 127 xsd_path ()
 128 {
 129         return resources_path() / "xsd";
 130 }
 131
 132
 133 boost::filesystem::path
 134 tags_path ()
 135 {
 136         return resources_path() / "tags";
 137 }
 138
 139
 140 void
 141 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 142 {
 143         boost::filesystem::path path = directory_containing_executable () / "ffprobe";
 144
 145         string ffprobe = "\"" + path.string() + "\" \"" + content.string() + "\" 2> \"" + out.string() + "\"";
 146         LOG_GENERAL (N_("Probing with %1"), ffprobe);
 147         system (ffprobe.c_str ());
 148 }
 149
 150
 151 list<pair<string, string> >
 152 mount_info ()
 153 {
 154         list<pair<string, string> > m;
 155         return m;
 156 }
 157
 158 boost::filesystem::path
 159 openssl_path ()
 160 {
 161         return directory_containing_executable() / "openssl";
 162 }
 163
 164
 165 #ifdef DCPOMATIC_DISK
 166 /* Note: this isn't actually used at the moment as the disk writer is started as a service */
 167 boost::filesystem::path
 168 disk_writer_path ()
 169 {
 170         return directory_containing_executable() / "dcpomatic2_disk_writer";
 171 }
 172 #endif
 173
 174 /* Apparently there is no way to create an ofstream using a UTF-8
 175    filename under Windows.  We are hence reduced to using fopen
 176    with this wrapper.
 177 */
 178 FILE *
 179 fopen_boost (boost::filesystem::path p, string t)
 180 {
 181         return fopen (p.c_str(), t.c_str ());
 182 }
 183
 184 int
 185 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
 186 {
 187         return fseek (stream, offset, whence);
 188 }
 189
 190 void
 191 Waker::nudge ()
 192 {
 193
 194 }
 195
 196 Waker::Waker ()
 197 {
 198         boost::mutex::scoped_lock lm (_mutex);
 199         IOPMAssertionCreateWithName (kIOPMAssertionTypeNoIdleSleep, kIOPMAssertionLevelOn, CFSTR ("Encoding DCP"), &_assertion_id);
 200 }
 201
 202 Waker::~Waker ()
 203 {
 204         boost::mutex::scoped_lock lm (_mutex);
 205         IOPMAssertionRelease (_assertion_id);
 206 }
 207
 208 void
 209 start_tool (string executable, string app)
 210 {
 211         boost::filesystem::path exe_path = directory_containing_executable();
 212         exe_path = exe_path.parent_path (); // MacOS
 213         exe_path = exe_path.parent_path (); // Contents
 214         exe_path = exe_path.parent_path (); // DCP-o-matic.app
 215         exe_path = exe_path.parent_path (); // Applications
 216         exe_path /= app;
 217         exe_path /= "Contents";
 218         exe_path /= "MacOS";
 219         exe_path /= executable;
 220
 221         pid_t pid = fork ();
 222         if (pid == 0) {
 223                 LOG_GENERAL ("start_tool %1 %2 with path %3", executable, app, exe_path.string());
 224                 int const r = system (exe_path.string().c_str());
 225                 exit (WEXITSTATUS (r));
 226         } else if (pid == -1) {
 227                 LOG_ERROR_NC("Fork failed in start_tool");
 228         }
 229 }
 230
 231
 232 void
 233 start_batch_converter ()
 234 {
 235         start_tool ("dcpomatic2_batch", "DCP-o-matic\\ 2\\ Batch\\ Converter.app");
 236 }
 237
 238
 239 void
 240 start_player ()
 241 {
 242         start_tool ("dcpomatic2_player", "DCP-o-matic\\ 2\\ Player.app");
 243 }
 244
 245
 246 uint64_t
 247 thread_id ()
 248 {
 249         return (uint64_t) pthread_self ();
 250 }
 251
 252 int
 253 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
 254 {
 255         return avio_open (s, file.c_str(), flags);
 256 }
 257
 258 boost::filesystem::path
 259 home_directory ()
 260 {
 261                 return getenv("HOME");
 262 }
 263
 264 string
 265 command_and_read (string)
 266 {
 267         return "";
 268 }
 269
 270 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
 271 bool
 272 running_32_on_64 ()
 273 {
 274         /* I'm assuming nobody does this on OS X */
 275         return false;
 276 }
 277
 278 static optional<string>
 279 get_vendor (CFDictionaryRef& description)
 280 {
 281         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceVendorKey);
 282         if (!str) {
 283                 return optional<string>();
 284         }
 285
 286         string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
 287         boost::algorithm::trim (s);
 288         return s;
 289 }
 290
 291 static optional<string>
 292 get_model (CFDictionaryRef& description)
 293 {
 294         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionDeviceModelKey);
 295         if (!str) {
 296                 return optional<string>();
 297         }
 298
 299         string s = CFStringGetCStringPtr ((CFStringRef) str, kCFStringEncodingUTF8);
 300         boost::algorithm::trim (s);
 301         return s;
 302 }
 303
 304 struct MediaPath
 305 {
 306         bool real;       ///< true for a "real" disk, false for a synthesized APFS one
 307         std::string prt; ///< "PRT" entry from the media path
 308 };
 309
 310 static optional<MediaPath>
 311 analyse_media_path (CFDictionaryRef& description)
 312 {
 313         using namespace boost::algorithm;
 314
 315         void const* str = CFDictionaryGetValue (description, kDADiskDescriptionMediaPathKey);
 316         if (!str) {
 317                 LOG_DISK_NC("There is no MediaPathKey");
 318                 return optional<MediaPath>();
 319         }
 320
 321         string path(CFStringGetCStringPtr((CFStringRef) str, kCFStringEncodingUTF8));
 322         LOG_DISK("MediaPathKey is %1", path);
 323
 324         if (path.find("/IOHDIXController") != string::npos) {
 325                 /* This is a disk image, so we completely ignore it */
 326                 LOG_DISK_NC("Ignoring this as it seems to be a disk image");
 327                 return optional<MediaPath>();
 328         }
 329
 330         MediaPath mp;
 331         if (starts_with(path, "IODeviceTree:")) {
 332                 mp.real = true;
 333         } else if (starts_with(path, "IOService:")) {
 334                 mp.real = false;
 335         } else {
 336                 return optional<MediaPath>();
 337         }
 338
 339         vector<string> bits;
 340         split(bits, path, boost::is_any_of("/"));
 341         BOOST_FOREACH (string i, bits) {
 342                 if (starts_with(i, "PRT")) {
 343                         mp.prt = i;
 344                 }
 345         }
 346
 347         return mp;
 348 }
 349
 350 static bool
 351 is_whole_drive (DADiskRef& disk)
 352 {
 353         io_service_t service = DADiskCopyIOMedia (disk);
 354         CFTypeRef whole_media_ref = IORegistryEntryCreateCFProperty (service, CFSTR(kIOMediaWholeKey), kCFAllocatorDefault, 0);
 355         bool whole_media = false;
 356         if (whole_media_ref) {
 357                 whole_media = CFBooleanGetValue((CFBooleanRef) whole_media_ref);
 358                 CFRelease (whole_media_ref);
 359         }
 360         IOObjectRelease (service);
 361         return whole_media;
 362 }
 363
 364 static optional<boost::filesystem::path>
 365 mount_point (CFDictionaryRef& description)
 366 {
 367         CFURLRef volume_path_key = (CFURLRef) CFDictionaryGetValue (description, kDADiskDescriptionVolumePathKey);
 368         char mount_path_buffer[1024];
 369         if (!CFURLGetFileSystemRepresentation(volume_path_key, false, (UInt8 *) mount_path_buffer, sizeof(mount_path_buffer))) {
 370                 return boost::optional<boost::filesystem::path>();
 371         }
 372         return boost::filesystem::path(mount_path_buffer);
 373 }
 374
 375 /* Here follows some rather intricate and (probably) fragile code to find the list of available
 376  * "real" drives on macOS that we might want to write a DCP to.
 377  *
 378  * We use the Disk Arbitration framework to give us a series of mount_points (/dev/disk0, /dev/disk1,
 379  * /dev/disk1s1 and so on) and we use the API to gather useful information about these mount_points into
 380  * a vector of Disk structs.
 381  *
 382  * Then we read the Disks that we found and try to derive a list of drives that we should offer to the
 383  * user, with details of whether those drives are currently mounted or not.
 384  *
 385  * At the basic level we find the "disk"-level mount_points, looking at whether any of their partitions are mounted.
 386  *
 387  * This is complicated enormously by recent-ish macOS versions' habit of making `synthesized' volumes which
 388  * reflect data in `real' partitions.  So, for example, we might have a real (physical) drive /dev/disk2 with
 389  * a partition /dev/disk2s2 whose content is made into a synthesized /dev/disk3, itself containing some partitions
 390  * which are mounted.  /dev/disk2s2 is not considered to be mounted, in this case.  So we need to know that
 391  * disk2s2 is related to disk3 so we can consider disk2s2 as mounted if any parts of disk3 are.  In order to do
 392  * this I am picking out what looks like a suitable identifier prefixed with PRT from the MediaContentKey.
 393  * If disk2s2 and disk3 have the same PRT code I am assuming they are linked.
 394  *
 395  * Lots of this is guesswork and may be broken.  In my defence the documentation that I have been able to
 396  * unearth is, to put it impolitely, crap.
 397  */
 398
 399 struct Disk
 400 {
 401         string mount_point;
 402         optional<string> vendor;
 403         optional<string> model;
 404         bool real;
 405         string prt;
 406         bool whole;
 407         vector<boost::filesystem::path> mount_points;
 408         unsigned long size;
 409 };
 410
 411 static void
 412 disk_appeared (DADiskRef disk, void* context)
 413 {
 414         const char* bsd_name = DADiskGetBSDName (disk);
 415         if (!bsd_name) {
 416                 return;
 417         }
 418         LOG_DISK("%1 appeared", bsd_name);
 419
 420         Disk this_disk;
 421
 422         this_disk.mount_point = string("/dev/") + bsd_name;
 423
 424         CFDictionaryRef description = DADiskCopyDescription (disk);
 425
 426         this_disk.vendor = get_vendor (description);
 427         this_disk.model = get_model (description);
 428         LOG_DISK("Vendor/model: %1 %2", this_disk.vendor.get_value_or("[none]"), this_disk.model.get_value_or("[none]"));
 429
 430         optional<MediaPath> media_path = analyse_media_path (description);
 431         if (!media_path) {
 432                 LOG_DISK("Finding media path for %1 failed", bsd_name);
 433                 return;
 434         }
 435
 436         this_disk.real = media_path->real;
 437         this_disk.prt = media_path->prt;
 438         this_disk.whole = is_whole_drive (disk);
 439         optional<boost::filesystem::path> mp = mount_point (description);
 440         if (mp) {
 441                 this_disk.mount_points.push_back (*mp);
 442         }
 443
 444         LOG_DISK(
 445                 "%1 prt %2 whole %3 mounted %4",
 446                  this_disk.real ? "Real" : "Synth",
 447                  this_disk.prt,
 448                  this_disk.whole ? "whole" : "part",
 449                  mp ? ("mounted at " + mp->string()) : "unmounted"
 450                 );
 451
 452         CFNumberGetValue ((CFNumberRef) CFDictionaryGetValue (description, kDADiskDescriptionMediaSizeKey), kCFNumberLongType, &this_disk.size);
 453         CFRelease (description);
 454
 455         reinterpret_cast<vector<Disk>*>(context)->push_back(this_disk);
 456 }
 457
 458 vector<Drive>
 459 Drive::get ()
 460 {
 461         using namespace boost::algorithm;
 462         vector<Disk> disks;
 463
 464         DASessionRef session = DASessionCreate(kCFAllocatorDefault);
 465         if (!session) {
 466                 return vector<Drive>();
 467         }
 468
 469         DARegisterDiskAppearedCallback (session, NULL, disk_appeared, &disks);
 470         CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
 471         DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
 472         CFRunLoopStop (run_loop);
 473         CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.05, 0);
 474         DAUnregisterCallback(session, (void *) disk_appeared, &disks);
 475         CFRelease(session);
 476
 477         /* Mark disks containing mounted partitions as themselves mounted */
 478         BOOST_FOREACH (Disk& i, disks) {
 479                 if (!i.whole) {
 480                         continue;
 481                 }
 482                 BOOST_FOREACH (Disk& j, disks) {
 483                         if (!j.mount_points.empty() && starts_with(j.mount_point, i.mount_point)) {
 484                                 LOG_DISK("Marking %1 as mounted because %2 is", i.mount_point, j.mount_point);
 485                                 std::copy(j.mount_points.begin(), j.mount_points.end(), back_inserter(i.mount_points));
 486                         }
 487                 }
 488         }
 489
 490         /* Make a map of the PRT codes and mount points of mounted, synthesized disks */
 491         map<string, vector<boost::filesystem::path> > mounted_synths;
 492         BOOST_FOREACH (Disk& i, disks) {
 493                 if (!i.real && !i.mount_points.empty()) {
 494                         LOG_DISK("Found a mounted synth %1 with %2", i.mount_point, i.prt);
 495                         mounted_synths[i.prt] = i.mount_points;
 496                 }
 497         }
 498
 499         /* Mark containers of those mounted synths as themselves mounted */
 500         BOOST_FOREACH (Disk& i, disks) {
 501                 if (i.real) {
 502                         map<string, vector<boost::filesystem::path> >::const_iterator j = mounted_synths.find(i.prt);
 503                         if (j != mounted_synths.end()) {
 504                                 LOG_DISK("Marking %1 (%2) as mounted because it contains a mounted synth", i.mount_point, i.prt);
 505                                 std::copy(j->second.begin(), j->second.end(), back_inserter(i.mount_points));
 506                         }
 507                 }
 508         }
 509
 510         vector<Drive> drives;
 511         BOOST_FOREACH (Disk& i, disks) {
 512                 if (i.whole) {
 513                         /* A whole disk that is not a container for a mounted synth */
 514                         drives.push_back(Drive(i.mount_point, i.mount_points, i.size, i.vendor, i.model));
 515                         LOG_DISK_NC(drives.back().log_summary());
 516                 }
 517         }
 518         return drives;
 519 }
 520
 521
 522 boost::filesystem::path
 523 config_path ()
 524 {
 525         boost::filesystem::path p;
 526         p /= g_get_home_dir ();
 527         p /= "Library";
 528         p /= "Preferences";
 529         p /= "com.dcpomatic";
 530         p /= "2";
 531         return p;
 532 }
 533
 534
 535 void done_callback(DADiskRef, DADissenterRef dissenter, void* context)
 536 {
 537         LOG_DISK_NC("Unmount finished");
 538         bool* success = reinterpret_cast<bool*> (context);
 539         if (dissenter) {
 540                 LOG_DISK("Error: %1", DADissenterGetStatus(dissenter));
 541                 *success = false;
 542         } else {
 543                 LOG_DISK_NC("Successful");
 544                 *success = true;
 545         }
 546 }
 547
 548
 549 bool
 550 Drive::unmount ()
 551 {
 552         LOG_DISK_NC("Unmount operation started");
 553
 554         DASessionRef session = DASessionCreate(kCFAllocatorDefault);
 555         if (!session) {
 556                 return false;
 557         }
 558
 559         DADiskRef disk = DADiskCreateFromBSDName(kCFAllocatorDefault, session, _device.c_str());
 560         if (!disk) {
 561                 return false;
 562         }
 563         LOG_DISK("Requesting unmount of %1 from %2", _device, thread_id());
 564         bool success = false;
 565         DADiskUnmount(disk, kDADiskUnmountOptionWhole, &done_callback, &success);
 566         CFRelease (disk);
 567
 568         CFRunLoopRef run_loop = CFRunLoopGetCurrent ();
 569         DASessionScheduleWithRunLoop (session, run_loop, kCFRunLoopDefaultMode);
 570         CFRunLoopStop (run_loop);
 571         CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.5, 0);
 572         CFRelease(session);
 573
 574         LOG_DISK_NC("End of unmount");
 575         return success;
 576 }
 577
 578
 579 void
 580 disk_write_finished ()
 581 {
 582
 583 }
 584
 585
 586 void
 587 make_foreground_application ()
 588 {
 589         ProcessSerialNumber serial;
 590 DCPOMATIC_DISABLE_WARNINGS
 591         GetCurrentProcess (&serial);
 592 DCPOMATIC_ENABLE_WARNINGS
 593         TransformProcessType (&serial, kProcessTransformToForegroundApplication);
 594 }
 595