2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
25 #include "compose.hpp"
27 #include "dcpomatic_log.h"
29 #include "exceptions.h"
30 #include "dcpomatic_assert.h"
32 #include <dcp/raw_convert.h>
35 #include <libavformat/avio.h>
37 #include <boost/algorithm/string.hpp>
38 #include <boost/dll/runtime_symbol_info.hpp>
49 #include <knownfolders.h>
64 using std::runtime_error;
65 using std::shared_ptr;
69 using boost::optional;
72 static std::vector<pair<HANDLE, string>> locked_volumes;
75 /** @param s Number of seconds to sleep for */
77 dcpomatic_sleep_seconds (int s)
84 dcpomatic_sleep_milliseconds (int ms)
90 /** @return A string of CPU information (model name etc.) */
97 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, L"HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0", 0, KEY_READ, &key) != ERROR_SUCCESS) {
103 if (RegQueryValueEx (key, L"ProcessorNameString", 0, &type, 0, &data) != ERROR_SUCCESS) {
107 if (type != REG_SZ) {
111 wstring value (data / sizeof (wchar_t), L'\0');
112 if (RegQueryValueEx (key, L"ProcessorNameString", 0, 0, reinterpret_cast<LPBYTE> (&value[0]), &data) != ERROR_SUCCESS) {
117 info = string (value.begin(), value.end());
126 run_ffprobe (boost::filesystem::path content, boost::filesystem::path out)
128 SECURITY_ATTRIBUTES security;
129 security.nLength = sizeof (security);
130 security.bInheritHandle = TRUE;
131 security.lpSecurityDescriptor = 0;
133 HANDLE child_stderr_read;
134 HANDLE child_stderr_write;
135 if (!CreatePipe (&child_stderr_read, &child_stderr_write, &security, 0)) {
136 LOG_ERROR_NC ("ffprobe call failed (could not CreatePipe)");
141 MultiByteToWideChar (CP_UTF8, 0, directory_containing_executable().string().c_str(), -1, dir, sizeof(dir));
143 STARTUPINFO startup_info;
144 ZeroMemory (&startup_info, sizeof (startup_info));
145 startup_info.cb = sizeof (startup_info);
146 startup_info.hStdError = child_stderr_write;
147 startup_info.dwFlags |= STARTF_USESTDHANDLES;
149 wchar_t command[512];
150 wcscpy (command, L"ffprobe.exe \"");
153 MultiByteToWideChar (CP_UTF8, 0, content.string().c_str(), -1, file, sizeof(file));
154 wcscat (command, file);
156 wcscat (command, L"\"");
158 PROCESS_INFORMATION process_info;
159 ZeroMemory (&process_info, sizeof (process_info));
160 if (!CreateProcess (0, command, 0, 0, TRUE, CREATE_NO_WINDOW, 0, dir, &startup_info, &process_info)) {
161 LOG_ERROR_NC (N_("ffprobe call failed (could not CreateProcess)"));
165 auto o = fopen_boost (out, "w");
167 LOG_ERROR_NC (N_("ffprobe call failed (could not create output file)"));
171 CloseHandle (child_stderr_write);
176 if (!ReadFile(child_stderr_read, buffer, sizeof(buffer), &read, 0) || read == 0) {
179 fwrite (buffer, read, 1, o);
184 WaitForSingleObject (process_info.hProcess, INFINITE);
185 CloseHandle (process_info.hProcess);
186 CloseHandle (process_info.hThread);
187 CloseHandle (child_stderr_read);
191 list<pair<string, string>>
198 boost::filesystem::path
199 directory_containing_executable ()
201 return boost::dll::program_location().parent_path();
205 boost::filesystem::path
208 return directory_containing_executable().parent_path();
212 boost::filesystem::path
215 return directory_containing_executable().parent_path() / "xsd";
219 boost::filesystem::path
222 return directory_containing_executable().parent_path() / "tags";
226 boost::filesystem::path
229 return directory_containing_executable() / "openssl.exe";
233 #ifdef DCPOMATIC_DISK
234 boost::filesystem::path
237 return directory_containing_executable() / "dcpomatic2_disk_writer.exe";
242 /** Windows can't "by default" cope with paths longer than 260 characters, so if you pass such a path to
243 * any boost::filesystem method it will fail. There is a "fix" for this, which is to prepend
244 * the string \\?\ to the path. This will make it work, so long as:
245 * - the path is absolute.
246 * - the path only uses backslashes.
247 * - individual path components are "short enough" (probably less than 255 characters)
249 * See https://www.boost.org/doc/libs/1_57_0/libs/filesystem/doc/reference.html under
250 * "Warning: Long paths on Windows" for some details.
252 * Our fopen_boost uses this method to get this fix, but any other calls to boost::filesystem
253 * will not unless this method is explicitly called to pre-process the pathname.
255 boost::filesystem::path
256 fix_long_path (boost::filesystem::path long_path)
258 using namespace boost::filesystem;
260 if (boost::algorithm::starts_with(long_path.string(), "\\\\")) {
261 /* This could mean it starts with \\ (i.e. a SMB path) or \\?\ (a long path)
262 * or a variety of other things... anyway, we'll leave it alone.
267 /* We have to make the path canonical but we can't call canonical() on the long path
268 * as it will fail. So we'll sort of do it ourselves (possibly badly).
270 path fixed = "\\\\?\\";
271 if (long_path.is_absolute()) {
272 fixed += long_path.make_preferred();
274 fixed += boost::filesystem::current_path() / long_path.make_preferred();
280 /* Apparently there is no way to create an ofstream using a UTF-8
281 filename under Windows. We are hence reduced to using fopen
285 fopen_boost (boost::filesystem::path p, string t)
287 wstring w (t.begin(), t.end());
288 /* c_str() on fixed here should give a UTF-16 string */
289 return _wfopen (fix_long_path(p).c_str(), w.c_str());
294 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
296 return _fseeki64 (stream, offset, whence);
303 boost::mutex::scoped_lock lm (_mutex);
304 SetThreadExecutionState (ES_SYSTEM_REQUIRED);
321 start_tool (string executable)
323 auto batch = directory_containing_executable() / executable;
325 STARTUPINFO startup_info;
326 ZeroMemory (&startup_info, sizeof (startup_info));
327 startup_info.cb = sizeof (startup_info);
329 PROCESS_INFORMATION process_info;
330 ZeroMemory (&process_info, sizeof (process_info));
333 MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
334 CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
339 start_batch_converter ()
341 start_tool ("dcpomatic2_batch");
348 start_tool ("dcpomatic2_player");
355 return (uint64_t) GetCurrentThreadId ();
360 wchar_to_utf8 (wchar_t const * s)
362 int const length = (wcslen(s) + 1) * 2;
363 std::vector<char> utf8(length);
364 WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8.data(), length, 0, 0);
365 string u (utf8.data());
371 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
373 return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
378 maybe_open_console ()
380 if (Config::instance()->win32_console ()) {
383 auto handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
384 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
385 auto hf_out = _fdopen(hCrt, "w");
386 setvbuf(hf_out, NULL, _IONBF, 1);
389 auto handle_in = GetStdHandle(STD_INPUT_HANDLE);
390 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
391 auto hf_in = _fdopen(hCrt, "r");
392 setvbuf(hf_in, NULL, _IONBF, 128);
398 boost::filesystem::path
402 auto result = SHGetKnownFolderPath(FOLDERID_Documents, 0, nullptr, &wide_path);
404 if (result != S_OK) {
405 CoTaskMemFree(wide_path);
406 return boost::filesystem::path("c:\\");
409 auto path = wchar_to_utf8(wide_path);
410 CoTaskMemFree(wide_path);
415 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
420 IsWow64Process (GetCurrentProcess(), &p);
425 static optional<string>
426 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
428 wchar_t buffer[MAX_PATH];
429 ZeroMemory (&buffer, sizeof(buffer));
430 bool r = SetupDiGetDeviceRegistryPropertyW (
431 device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
434 return optional<string>();
436 return wchar_to_utf8 (buffer);
440 static const GUID GUID_DEVICE_INTERFACE_DISK = {
441 0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
446 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
448 /* Find the Windows path to the device */
450 SP_DEVICE_INTERFACE_DATA device_interface_data;
451 device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
453 auto r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
455 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
456 return optional<int>();
459 /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
461 r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
462 PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
463 if (!device_detail_data) {
464 LOG_DISK_NC("malloc failed");
465 return optional<int>();
468 device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
470 /* And get the path */
471 r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
473 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
474 free (device_detail_data);
475 return optional<int>();
478 /* Open it. We would not be allowed GENERIC_READ access here but specifying 0 for
479 dwDesiredAccess allows us to query some metadata.
481 auto device = CreateFileW (
482 device_detail_data->DevicePath, 0,
483 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
487 free (device_detail_data);
489 if (device == INVALID_HANDLE_VALUE) {
490 LOG_DISK("CreateFileW failed with %1", GetLastError());
491 return optional<int>();
494 /* Get the device number */
495 STORAGE_DEVICE_NUMBER device_number;
496 r = DeviceIoControl (
497 device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
498 &device_number, sizeof(device_number), &size, 0
501 CloseHandle (device);
507 return device_number.DeviceNumber;
511 typedef map<int, vector<boost::filesystem::path>> MountPoints;
514 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
518 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
520 LOG_DISK("Looking at %1", wchar_to_utf8(volume));
522 wchar_t volume_path_names[512];
523 vector<boost::filesystem::path> mp;
525 if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
526 wchar_t* p = volume_path_names;
527 while (*p != L'\0') {
528 mp.push_back (wchar_to_utf8(p));
529 LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
534 /* Strip trailing \ */
535 size_t const len = wcslen (volume);
536 DCPOMATIC_ASSERT (len > 0);
537 volume[len - 1] = L'\0';
539 auto handle = CreateFileW (
541 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
545 DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
547 VOLUME_DISK_EXTENTS extents;
549 BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
550 CloseHandle (handle);
554 DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
556 mount_points[extents.Extents[0].DiskNumber] = mp;
563 MountPoints mount_points;
565 wchar_t volume_name[512];
566 auto volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
567 if (volume == INVALID_HANDLE_VALUE) {
568 return MountPoints();
571 add_volume_mount_points (volume_name, mount_points);
573 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
576 add_volume_mount_points (volume_name, mount_points);
578 FindVolumeClose (volume);
587 vector<Drive> drives;
589 auto mount_points = find_mount_points ();
591 /* Get a `device information set' containing information about all disks */
592 auto device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
593 if (device_info == INVALID_HANDLE_VALUE) {
594 LOG_DISK_NC ("SetupDiClassDevsA failed");
600 /* Find out about the next disk */
601 SP_DEVINFO_DATA device_info_data;
602 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
603 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
604 DWORD e = GetLastError();
605 if (e != ERROR_NO_MORE_ITEMS) {
606 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
612 auto const friendly_name = get_friendly_name (device_info, &device_info_data);
613 auto device_number = get_device_number (device_info, &device_info_data);
614 if (!device_number) {
618 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
620 HANDLE device = CreateFileA (
621 physical_drive.c_str(), 0,
622 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
626 if (device == INVALID_HANDLE_VALUE) {
627 LOG_DISK_NC("Could not open PHYSICALDRIVE");
633 BOOL r = DeviceIoControl (
634 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
635 &geom, sizeof(geom), &returned, 0
638 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
640 for (auto const& i: locked_volumes) {
641 if (i.second == physical_drive) {
647 uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
648 drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
649 LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
652 CloseHandle (device);
662 LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
663 DCPOMATIC_ASSERT (_mount_points.size() == 1);
664 string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
665 string const truncated = device_name.substr (0, device_name.length() - 1);
666 //LOG_DISK("Actually opening %1", _device);
667 //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
668 LOG_DISK("Actually opening %1", truncated);
669 HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
670 if (device == INVALID_HANDLE_VALUE) {
671 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
675 BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
677 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
681 LOG_DISK("Unmount of %1 succeeded", _device);
682 locked_volumes.push_back (make_pair(device, _device));
688 boost::filesystem::path
689 config_path (optional<string> version)
691 boost::filesystem::path p;
692 p /= g_get_user_config_dir ();
702 disk_write_finished ()
704 for (auto const& i: locked_volumes) {
705 CloseHandle (i.first);
711 dcpomatic::get_process_id ()
713 return dcp::raw_convert<string>(GetCurrentProcessId());
718 show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
720 std::wstringstream args;
721 args << "/select," << select;
722 auto const r = ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
723 return (reinterpret_cast<int64_t>(r) <= 32);