src/lib/cross_windows.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 "dcpomatic_assert.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/dll/runtime_symbol_info.hpp>
  36 #include <windows.h>
  37 #include <winternl.h>
  38 #include <winioctl.h>
  39 #include <ntdddisk.h>
  40 #include <setupapi.h>
  41 #include <fileapi.h>
  42 #undef DATADIR
  43 #include <shlwapi.h>
  44 #include <shellapi.h>
  45 #include <fcntl.h>
  46 #include <fstream>
  47 #include <map>
  48
  49 #include "i18n.h"
  50
  51 using std::pair;
  52 using std::list;
  53 using std::ifstream;
  54 using std::string;
  55 using std::wstring;
  56 using std::make_pair;
  57 using std::vector;
  58 using std::cerr;
  59 using std::cout;
  60 using std::runtime_error;
  61 using std::map;
  62 using boost::shared_ptr;
  63 using boost::optional;
  64
  65 static std::vector<pair<HANDLE, string> > locked_volumes;
  66
  67 /** @param s Number of seconds to sleep for */
  68 void
  69 dcpomatic_sleep_seconds (int s)
  70 {
  71         Sleep (s * 1000);
  72 }
  73
  74 void
  75 dcpomatic_sleep_milliseconds (int ms)
  76 {
  77         Sleep (ms);
  78 }
  79
  80 /** @return A string of CPU information (model name etc.) */
  81 string
  82 cpu_info ()
  83 {
  84         string info;
  85
  86         HKEY key;
  87         if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
  88                 return info;
  89         }
  90
  91         DWORD type;
  92         DWORD data;
  93         if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
  94                 return info;
  95         }
  96
  97         if (type != REG_SZ) {
  98                 return info;
  99         }
 100
 101         wstring value (data / sizeof (wchar_t), L'\0');
 102         if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
 103                 RegCloseKey (key);
 104                 return info;
 105         }
 106
 107         info = string (value.begin(), value.end());
 108
 109         RegCloseKey (key);
 110
 111         return info;
 112 }
 113
 114 void
 115 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
 116 {
 117         SECURITY_ATTRIBUTES security;
 118         security.nLength = sizeof (security);
 119         security.bInheritHandle = TRUE;
 120         security.lpSecurityDescriptor = 0;
 121
 122         HANDLE child_stderr_read;
 123         HANDLE child_stderr_write;
 124         if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
 125                 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
 126                 return;
 127         }
 128
 129         wchar_t dir[512];
 130         MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
 131         SetCurrentDirectory (dir);
 132
 133         STARTUPINFO startup_info;
 134         ZeroMemory (&startup_info, sizeof (startup_info));
 135         startup_info.cb = sizeof (startup_info);
 136         startup_info.hStdError = child_stderr_write;
 137         startup_info.dwFlags |= STARTF_USESTDHANDLES;
 138
 139         wchar_t command[512];
 140         wcscpy (command, L"ffprobe.exe \"");
 141
 142         wchar_t file[512];
 143         MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
 144         wcscat (command, file);
 145
 146         wcscat (command, L"\"");
 147
 148         PROCESS_INFORMATION process_info;
 149         ZeroMemory (&process_info, sizeof (process_info));
 150         if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, 0, &startup_info, &process_info)) {
 151                 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
 152                 return;
 153         }
 154
 155         FILE* o = fopen_boost (out, "w");
 156         if (!o) {
 157                 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
 158                 return;
 159         }
 160
 161         CloseHandle (child_stderr_write);
 162
 163         while (true) {
 164                 char buffer[512];
 165                 DWORD read;
 166                 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
 167                         break;
 168                 }
 169                 fwrite (buffer, read, 1, o);
 170         }
 171
 172         fclose (o);
 173
 174         WaitForSingleObject (process_info.hProcess, INFINITE);
 175         CloseHandle (process_info.hProcess);
 176         CloseHandle (process_info.hThread);
 177         CloseHandle (child_stderr_read);
 178 }
 179
 180 list<pair<string, string> >
 181 mount_info ()
 182 {
 183         list<pair<string, string> > m;
 184         return m;
 185 }
 186
 187
 188 boost::filesystem::path
 189 directory_containing_executable ()
 190 {
 191         return boost::dll::program_location().parent_path();
 192 }
 193
 194
 195 boost::filesystem::path
 196 resources_path ()
 197 {
 198         return directory_containing_executable().parent_path();
 199 }
 200
 201
 202 boost::filesystem::path
 203 xsd_path ()
 204 {
 205         return directory_containing_executable().parent_path() / "xsd";
 206 }
 207
 208
 209 boost::filesystem::path
 210 tags_path ()
 211 {
 212         return directory_containing_executable().parent_path() / "tags";
 213 }
 214
 215
 216 boost::filesystem::path
 217 openssl_path ()
 218 {
 219         return directory_containing_executable() / "openssl.exe";
 220 }
 221
 222
 223 #ifdef DCPOMATIC_DISK
 224 boost::filesystem::path
 225 disk_writer_path ()
 226 {
 227         return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
 228 }
 229 #endif
 230
 231
 232 /* Apparently there is no way to create an ofstream using a UTF-8
 233    filename under Windows.  We are hence reduced to using fopen
 234    with this wrapper.
 235 */
 236 FILE *
 237 fopen_boost (boost::filesystem::path p, string t)
 238 {
 239         wstring w (t.begin(), t.end());
 240         /* c_str() here should give a UTF-16 string */
 241         return _wfopen (p.c_str(), w.c_str ());
 242 }
 243
 244 int
 245 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
 246 {
 247         return _fseeki64 (stream, offset, whence);
 248 }
 249
 250 void
 251 Waker::nudge ()
 252 {
 253         boost::mutex::scoped_lock lm (_mutex);
 254         SetThreadExecutionState (ES_SYSTEM_REQUIRED);
 255 }
 256
 257 Waker::Waker ()
 258 {
 259
 260 }
 261
 262 Waker::~Waker ()
 263 {
 264
 265 }
 266
 267
 268 void
 269 start_tool (string executable)
 270 {
 271         boost::filesystem::path batch = directory_containing_executable() / executable;
 272
 273         STARTUPINFO startup_info;
 274         ZeroMemory (&startup_info, sizeof (startup_info));
 275         startup_info.cb = sizeof (startup_info);
 276
 277         PROCESS_INFORMATION process_info;
 278         ZeroMemory (&process_info, sizeof (process_info));
 279
 280         wchar_t cmd[512];
 281         MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
 282         CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
 283 }
 284
 285
 286 void
 287 start_batch_converter ()
 288 {
 289         start_tool ("dcpomatic2_batch");
 290 }
 291
 292
 293 void
 294 start_player ()
 295 {
 296         start_tool ("dcpomatic2_player");
 297 }
 298
 299
 300 uint64_t
 301 thread_id ()
 302 {
 303         return (uint64_t) GetCurrentThreadId ();
 304 }
 305
 306 static string
 307 wchar_to_utf8 (wchar_t const * s)
 308 {
 309         int const length = (wcslen(s) + 1) * 2;
 310         char* utf8 = new char[length];
 311         WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8, length, 0, 0);
 312         string u (utf8);
 313         delete[] utf8;
 314         return u;
 315 }
 316
 317 int
 318 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
 319 {
 320         return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
 321 }
 322
 323 void
 324 maybe_open_console ()
 325 {
 326         if (Config::instance()->win32_console ()) {
 327                 AllocConsole();
 328
 329                 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
 330                 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
 331                 FILE* hf_out = _fdopen(hCrt, "w");
 332                 setvbuf(hf_out, NULL, _IONBF, 1);
 333                 *stdout = *hf_out;
 334
 335                 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
 336                 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
 337                 FILE* hf_in = _fdopen(hCrt, "r");
 338                 setvbuf(hf_in, NULL, _IONBF, 128);
 339                 *stdin = *hf_in;
 340         }
 341 }
 342
 343 boost::filesystem::path
 344 home_directory ()
 345 {
 346         return boost::filesystem::path(getenv("HOMEDRIVE")) / boost::filesystem::path(getenv("HOMEPATH"));
 347 }
 348
 349 string
 350 command_and_read (string)
 351 {
 352         return "";
 353 }
 354
 355 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
 356 bool
 357 running_32_on_64 ()
 358 {
 359         BOOL p;
 360         IsWow64Process (GetCurrentProcess(), &p);
 361         return p;
 362 }
 363
 364 static optional<string>
 365 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
 366 {
 367         wchar_t buffer[MAX_PATH];
 368         ZeroMemory (&buffer, sizeof(buffer));
 369         bool r = SetupDiGetDeviceRegistryPropertyW (
 370                         device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
 371                         );
 372         if (!r) {
 373                 return optional<string>();
 374         }
 375         return wchar_to_utf8 (buffer);
 376 }
 377
 378 static const GUID GUID_DEVICE_INTERFACE_DISK = {
 379         0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
 380 };
 381
 382 static optional<int>
 383 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
 384 {
 385         /* Find the Windows path to the device */
 386
 387         SP_DEVICE_INTERFACE_DATA device_interface_data;
 388         device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
 389
 390         BOOL r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
 391         if (!r) {
 392                 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
 393                 return optional<int>();
 394         }
 395
 396         /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
 397         DWORD size;
 398         r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
 399         PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
 400         if (!device_detail_data) {
 401                 LOG_DISK_NC("malloc failed");
 402                 return optional<int>();
 403         }
 404
 405         device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
 406
 407         /* And get the path */
 408         r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
 409         if (!r) {
 410                 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
 411                 free (device_detail_data);
 412                 return optional<int>();
 413         }
 414
 415         /* Open it.  We would not be allowed GENERIC_READ access here but specifying 0 for
 416            dwDesiredAccess allows us to query some metadata.
 417         */
 418         HANDLE device = CreateFileW (
 419                         device_detail_data->DevicePath, 0,
 420                         FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
 421                         OPEN_EXISTING, 0, 0
 422                         );
 423
 424         free (device_detail_data);
 425
 426         if (device == INVALID_HANDLE_VALUE) {
 427                 LOG_DISK("CreateFileW failed with %1", GetLastError());
 428                 return optional<int>();
 429         }
 430
 431         /* Get the device number */
 432         STORAGE_DEVICE_NUMBER device_number;
 433         r = DeviceIoControl (
 434                         device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
 435                         &device_number, sizeof(device_number), &size, 0
 436                         );
 437
 438         CloseHandle (device);
 439
 440         if (!r) {
 441                 return optional<int>();
 442         }
 443
 444         return device_number.DeviceNumber;
 445 }
 446
 447 typedef map<int, vector<boost::filesystem::path> > MountPoints;
 448
 449 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
 450  *  to @ref disks.
 451  */
 452 static void
 453 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
 454 {
 455         LOG_DISK("Looking at %1", wchar_to_utf8(volume));
 456
 457         wchar_t volume_path_names[512];
 458         vector<boost::filesystem::path> mp;
 459         DWORD returned;
 460         if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
 461                 wchar_t* p = volume_path_names;
 462                 while (*p != L'\0') {
 463                         mp.push_back (wchar_to_utf8(p));
 464                         LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
 465                         p += wcslen(p) + 1;
 466                 }
 467         }
 468
 469         /* Strip trailing \ */
 470         size_t const len = wcslen (volume);
 471         DCPOMATIC_ASSERT (len > 0);
 472         volume[len - 1] = L'\0';
 473
 474         HANDLE handle = CreateFileW (
 475                         volume, 0,
 476                         FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
 477                         OPEN_EXISTING, 0, 0
 478                         );
 479
 480         DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
 481
 482         VOLUME_DISK_EXTENTS extents;
 483         DWORD size;
 484         BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
 485         CloseHandle (handle);
 486         if (!r) {
 487                 return;
 488         }
 489         DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
 490
 491         mount_points[extents.Extents[0].DiskNumber] = mp;
 492 }
 493
 494 MountPoints
 495 find_mount_points ()
 496 {
 497         MountPoints mount_points;
 498
 499         wchar_t volume_name[512];
 500         HANDLE volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
 501         if (volume == INVALID_HANDLE_VALUE) {
 502                 return MountPoints();
 503         }
 504
 505         add_volume_mount_points (volume_name, mount_points);
 506         while (true) {
 507                 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
 508                         break;
 509                 }
 510                 add_volume_mount_points (volume_name, mount_points);
 511         }
 512         FindVolumeClose (volume);
 513
 514         return mount_points;
 515 }
 516
 517 vector<Drive>
 518 Drive::get ()
 519 {
 520         vector<Drive> drives;
 521
 522         MountPoints mount_points = find_mount_points ();
 523
 524         /* Get a `device information set' containing information about all disks */
 525         HDEVINFO device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
 526         if (device_info == INVALID_HANDLE_VALUE) {
 527                 LOG_DISK_NC ("SetupDiClassDevsA failed");
 528                 return drives;
 529         }
 530
 531         int i = 0;
 532         while (true) {
 533                 /* Find out about the next disk */
 534                 SP_DEVINFO_DATA device_info_data;
 535                 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
 536                 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
 537                         DWORD e = GetLastError();
 538                         if (e != ERROR_NO_MORE_ITEMS) {
 539                                 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
 540                         }
 541                         break;
 542                 }
 543                 ++i;
 544
 545                 optional<string> const friendly_name = get_friendly_name (device_info, &device_info_data);
 546                 optional<int> device_number = get_device_number (device_info, &device_info_data);
 547                 if (!device_number) {
 548                         continue;
 549                 }
 550
 551                 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
 552
 553                 HANDLE device = CreateFileA (
 554                                 physical_drive.c_str(), 0,
 555                                 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
 556                                 OPEN_EXISTING, 0, 0
 557                                 );
 558
 559                 if (device == INVALID_HANDLE_VALUE) {
 560                         LOG_DISK_NC("Could not open PHYSICALDRIVE");
 561                         continue;
 562                 }
 563
 564                 DISK_GEOMETRY geom;
 565                 DWORD returned;
 566                 BOOL r = DeviceIoControl (
 567                                 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
 568                                 &geom, sizeof(geom), &returned, 0
 569                                 );
 570
 571                 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
 572                 bool locked = false;
 573                 for (vector<pair<HANDLE, string> >::const_iterator i = locked_volumes.begin(); i != locked_volumes.end(); ++i) {
 574                         if (i->second == physical_drive) {
 575                                 locked = true;
 576                         }
 577                 }
 578
 579                 if (r) {
 580                         uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
 581                         drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
 582                         LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
 583                 }
 584
 585                 CloseHandle (device);
 586         }
 587
 588         return drives;
 589 }
 590
 591
 592 bool
 593 Drive::unmount ()
 594 {
 595         LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
 596         DCPOMATIC_ASSERT (_mount_points.size() == 1);
 597         string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
 598         string const truncated = device_name.substr (0, device_name.length() - 1);
 599         //LOG_DISK("Actually opening %1", _device);
 600         //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
 601         LOG_DISK("Actually opening %1", truncated);
 602         HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
 603         if (device == INVALID_HANDLE_VALUE) {
 604                 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
 605                 return false;
 606         }
 607         DWORD returned;
 608         BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
 609         if (!r) {
 610                 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
 611                 return false;
 612         }
 613
 614         LOG_DISK("Unmount of %1 succeeded", _device);
 615         locked_volumes.push_back (make_pair(device, _device));
 616
 617         return true;
 618 }
 619
 620
 621 boost::filesystem::path
 622 config_path ()
 623 {
 624         boost::filesystem::path p;
 625         p /= g_get_user_config_dir ();
 626         p /= "dcpomatic2";
 627         return p;
 628 }
 629
 630 void
 631 disk_write_finished ()
 632 {
 633         for (vector<pair<HANDLE, string> >::const_iterator i = locked_volumes.begin(); i != locked_volumes.end(); ++i) {
 634                 CloseHandle (i->first);
 635         }
 636 }
 637
 638