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