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