Only define UNICODE in src/lib/{cross_windows,util}.cc.
[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         path fixed = "\\\\?\\";
259         if (boost::algorithm::starts_with(long_path.string(), fixed.string())) {
260                 return long_path;
261         }
262
263         /* We have to make the path canonical but we can't call canonical() on the long path
264          * as it will fail.  So we'll sort of do it ourselves (possibly badly).
265          */
266         if (long_path.is_absolute()) {
267                 fixed += long_path.make_preferred();
268         } else {
269                 fixed += boost::filesystem::current_path() / long_path.make_preferred();
270         }
271         return fixed;
272 }
273
274
275 /* Apparently there is no way to create an ofstream using a UTF-8
276    filename under Windows.  We are hence reduced to using fopen
277    with this wrapper.
278 */
279 FILE *
280 fopen_boost (boost::filesystem::path p, string t)
281 {
282         wstring w (t.begin(), t.end());
283         /* c_str() on fixed here should give a UTF-16 string */
284         return _wfopen (fix_long_path(p).c_str(), w.c_str());
285 }
286
287
288 int
289 dcpomatic_fseek (FILE* stream, int64_t offset, int whence)
290 {
291         return _fseeki64 (stream, offset, whence);
292 }
293
294
295 void
296 Waker::nudge ()
297 {
298         boost::mutex::scoped_lock lm (_mutex);
299         SetThreadExecutionState (ES_SYSTEM_REQUIRED);
300 }
301
302
303 Waker::Waker ()
304 {
305
306 }
307
308
309 Waker::~Waker ()
310 {
311
312 }
313
314
315 void
316 start_tool (string executable)
317 {
318         auto batch = directory_containing_executable() / executable;
319
320         STARTUPINFO startup_info;
321         ZeroMemory (&startup_info, sizeof (startup_info));
322         startup_info.cb = sizeof (startup_info);
323
324         PROCESS_INFORMATION process_info;
325         ZeroMemory (&process_info, sizeof (process_info));
326
327         wchar_t cmd[512];
328         MultiByteToWideChar (CP_UTF8, 0, batch.string().c_str(), -1, cmd, sizeof(cmd));
329         CreateProcess (0, cmd, 0, 0, FALSE, 0, 0, 0, &startup_info, &process_info);
330 }
331
332
333 void
334 start_batch_converter ()
335 {
336         start_tool ("dcpomatic2_batch");
337 }
338
339
340 void
341 start_player ()
342 {
343         start_tool ("dcpomatic2_player");
344 }
345
346
347 uint64_t
348 thread_id ()
349 {
350         return (uint64_t) GetCurrentThreadId ();
351 }
352
353
354 static string
355 wchar_to_utf8 (wchar_t const * s)
356 {
357         int const length = (wcslen(s) + 1) * 2;
358         char* utf8 = new char[length];
359         WideCharToMultiByte (CP_UTF8, 0, s, -1, utf8, length, 0, 0);
360         string u (utf8);
361         delete[] utf8;
362         return u;
363 }
364
365
366 int
367 avio_open_boost (AVIOContext** s, boost::filesystem::path file, int flags)
368 {
369         return avio_open (s, wchar_to_utf8(file.c_str()).c_str(), flags);
370 }
371
372
373 void
374 maybe_open_console ()
375 {
376         if (Config::instance()->win32_console ()) {
377                 AllocConsole();
378
379                 auto handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
380                 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
381                 auto hf_out = _fdopen(hCrt, "w");
382                 setvbuf(hf_out, NULL, _IONBF, 1);
383                 *stdout = *hf_out;
384
385                 auto handle_in = GetStdHandle(STD_INPUT_HANDLE);
386                 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
387                 auto hf_in = _fdopen(hCrt, "r");
388                 setvbuf(hf_in, NULL, _IONBF, 128);
389                 *stdin = *hf_in;
390         }
391 }
392
393
394 boost::filesystem::path
395 home_directory ()
396 {
397         return boost::filesystem::path(getenv("HOMEDRIVE")) / boost::filesystem::path(getenv("HOMEPATH"));
398 }
399
400
401 /** @return true if this process is a 32-bit one running on a 64-bit-capable OS */
402 bool
403 running_32_on_64 ()
404 {
405         BOOL p;
406         IsWow64Process (GetCurrentProcess(), &p);
407         return p;
408 }
409
410
411 static optional<string>
412 get_friendly_name (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
413 {
414         wchar_t buffer[MAX_PATH];
415         ZeroMemory (&buffer, sizeof(buffer));
416         bool r = SetupDiGetDeviceRegistryPropertyW (
417                         device_info, device_info_data, SPDRP_FRIENDLYNAME, 0, reinterpret_cast<PBYTE>(buffer), sizeof(buffer), 0
418                         );
419         if (!r) {
420                 return optional<string>();
421         }
422         return wchar_to_utf8 (buffer);
423 }
424
425
426 static const GUID GUID_DEVICE_INTERFACE_DISK = {
427         0x53F56307L, 0xB6BF, 0x11D0, { 0x94, 0xF2, 0x00, 0xA0, 0xC9, 0x1E, 0xFB, 0x8B }
428 };
429
430
431 static optional<int>
432 get_device_number (HDEVINFO device_info, SP_DEVINFO_DATA* device_info_data)
433 {
434         /* Find the Windows path to the device */
435
436         SP_DEVICE_INTERFACE_DATA device_interface_data;
437         device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
438
439         auto r = SetupDiEnumDeviceInterfaces (device_info, device_info_data, &GUID_DEVICE_INTERFACE_DISK, 0, &device_interface_data);
440         if (!r) {
441                 LOG_DISK("SetupDiEnumDeviceInterfaces failed (%1)", GetLastError());
442                 return optional<int>();
443         }
444
445         /* Find out how much space we need for our SP_DEVICE_INTERFACE_DETAIL_DATA_W */
446         DWORD size;
447         r = SetupDiGetDeviceInterfaceDetailW(device_info, &device_interface_data, 0, 0, &size, 0);
448         PSP_DEVICE_INTERFACE_DETAIL_DATA_W device_detail_data = static_cast<PSP_DEVICE_INTERFACE_DETAIL_DATA_W> (malloc(size));
449         if (!device_detail_data) {
450                 LOG_DISK_NC("malloc failed");
451                 return optional<int>();
452         }
453
454         device_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_W);
455
456         /* And get the path */
457         r = SetupDiGetDeviceInterfaceDetailW (device_info, &device_interface_data, device_detail_data, size, &size, 0);
458         if (!r) {
459                 LOG_DISK_NC("SetupDiGetDeviceInterfaceDetailW failed");
460                 free (device_detail_data);
461                 return optional<int>();
462         }
463
464         /* Open it.  We would not be allowed GENERIC_READ access here but specifying 0 for
465            dwDesiredAccess allows us to query some metadata.
466         */
467         auto device = CreateFileW (
468                         device_detail_data->DevicePath, 0,
469                         FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
470                         OPEN_EXISTING, 0, 0
471                         );
472
473         free (device_detail_data);
474
475         if (device == INVALID_HANDLE_VALUE) {
476                 LOG_DISK("CreateFileW failed with %1", GetLastError());
477                 return optional<int>();
478         }
479
480         /* Get the device number */
481         STORAGE_DEVICE_NUMBER device_number;
482         r = DeviceIoControl (
483                         device, IOCTL_STORAGE_GET_DEVICE_NUMBER, 0, 0,
484                         &device_number, sizeof(device_number), &size, 0
485                         );
486
487         CloseHandle (device);
488
489         if (!r) {
490                 return {};
491         }
492
493         return device_number.DeviceNumber;
494 }
495
496
497 typedef map<int, vector<boost::filesystem::path>> MountPoints;
498
499
500 /** Take a volume path (with a trailing \) and add any disk numbers related to that volume
501  *  to @ref disks.
502  */
503 static void
504 add_volume_mount_points (wchar_t* volume, MountPoints& mount_points)
505 {
506         LOG_DISK("Looking at %1", wchar_to_utf8(volume));
507
508         wchar_t volume_path_names[512];
509         vector<boost::filesystem::path> mp;
510         DWORD returned;
511         if (GetVolumePathNamesForVolumeNameW(volume, volume_path_names, sizeof(volume_path_names) / sizeof(wchar_t), &returned)) {
512                 wchar_t* p = volume_path_names;
513                 while (*p != L'\0') {
514                         mp.push_back (wchar_to_utf8(p));
515                         LOG_DISK ("Found mount point %1", wchar_to_utf8(p));
516                         p += wcslen(p) + 1;
517                 }
518         }
519
520         /* Strip trailing \ */
521         size_t const len = wcslen (volume);
522         DCPOMATIC_ASSERT (len > 0);
523         volume[len - 1] = L'\0';
524
525         auto handle = CreateFileW (
526                         volume, 0,
527                         FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
528                         OPEN_EXISTING, 0, 0
529                         );
530
531         DCPOMATIC_ASSERT (handle != INVALID_HANDLE_VALUE);
532
533         VOLUME_DISK_EXTENTS extents;
534         DWORD size;
535         BOOL r = DeviceIoControl (handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, 0, 0, &extents, sizeof(extents), &size, 0);
536         CloseHandle (handle);
537         if (!r) {
538                 return;
539         }
540         DCPOMATIC_ASSERT (extents.NumberOfDiskExtents == 1);
541
542         mount_points[extents.Extents[0].DiskNumber] = mp;
543 }
544
545
546 MountPoints
547 find_mount_points ()
548 {
549         MountPoints mount_points;
550
551         wchar_t volume_name[512];
552         auto volume = FindFirstVolumeW (volume_name, sizeof(volume_name) / sizeof(wchar_t));
553         if (volume == INVALID_HANDLE_VALUE) {
554                 return MountPoints();
555         }
556
557         add_volume_mount_points (volume_name, mount_points);
558         while (true) {
559                 if (!FindNextVolumeW(volume, volume_name, sizeof(volume_name) / sizeof(wchar_t))) {
560                         break;
561                 }
562                 add_volume_mount_points (volume_name, mount_points);
563         }
564         FindVolumeClose (volume);
565
566         return mount_points;
567 }
568
569
570 vector<Drive>
571 Drive::get ()
572 {
573         vector<Drive> drives;
574
575         auto mount_points = find_mount_points ();
576
577         /* Get a `device information set' containing information about all disks */
578         auto device_info = SetupDiGetClassDevsA (&GUID_DEVICE_INTERFACE_DISK, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
579         if (device_info == INVALID_HANDLE_VALUE) {
580                 LOG_DISK_NC ("SetupDiClassDevsA failed");
581                 return drives;
582         }
583
584         int i = 0;
585         while (true) {
586                 /* Find out about the next disk */
587                 SP_DEVINFO_DATA device_info_data;
588                 device_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
589                 if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data)) {
590                         DWORD e = GetLastError();
591                         if (e != ERROR_NO_MORE_ITEMS) {
592                                 LOG_DISK ("SetupDiEnumDeviceInfo failed (%1)", GetLastError());
593                         }
594                         break;
595                 }
596                 ++i;
597
598                 auto const friendly_name = get_friendly_name (device_info, &device_info_data);
599                 auto device_number = get_device_number (device_info, &device_info_data);
600                 if (!device_number) {
601                         continue;
602                 }
603
604                 string const physical_drive = String::compose("\\\\.\\PHYSICALDRIVE%1", *device_number);
605
606                 HANDLE device = CreateFileA (
607                                 physical_drive.c_str(), 0,
608                                 FILE_SHARE_READ | FILE_SHARE_WRITE, 0,
609                                 OPEN_EXISTING, 0, 0
610                                 );
611
612                 if (device == INVALID_HANDLE_VALUE) {
613                         LOG_DISK_NC("Could not open PHYSICALDRIVE");
614                         continue;
615                 }
616
617                 DISK_GEOMETRY geom;
618                 DWORD returned;
619                 BOOL r = DeviceIoControl (
620                                 device, IOCTL_DISK_GET_DRIVE_GEOMETRY, 0, 0,
621                                 &geom, sizeof(geom), &returned, 0
622                                 );
623
624                 LOG_DISK("Having a look through %1 locked volumes", locked_volumes.size());
625                 bool locked = false;
626                 for (auto const& i: locked_volumes) {
627                         if (i.second == physical_drive) {
628                                 locked = true;
629                         }
630                 }
631
632                 if (r) {
633                         uint64_t const disk_size = geom.Cylinders.QuadPart * geom.TracksPerCylinder * geom.SectorsPerTrack * geom.BytesPerSector;
634                         drives.push_back (Drive(physical_drive, locked ? vector<boost::filesystem::path>() : mount_points[*device_number], disk_size, friendly_name, optional<string>()));
635                         LOG_DISK("Added drive %1%2", drives.back().log_summary(), locked ? "(locked by us)" : "");
636                 }
637
638                 CloseHandle (device);
639         }
640
641         return drives;
642 }
643
644
645 bool
646 Drive::unmount ()
647 {
648         LOG_DISK("Unmounting %1 with %2 mount points", _device, _mount_points.size());
649         DCPOMATIC_ASSERT (_mount_points.size() == 1);
650         string const device_name = String::compose ("\\\\.\\%1", _mount_points.front());
651         string const truncated = device_name.substr (0, device_name.length() - 1);
652         //LOG_DISK("Actually opening %1", _device);
653         //HANDLE device = CreateFileA (_device.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
654         LOG_DISK("Actually opening %1", truncated);
655         HANDLE device = CreateFileA (truncated.c_str(), (GENERIC_READ | GENERIC_WRITE), FILE_SHARE_READ | FILE_SHARE_WRITE, 0, OPEN_EXISTING, 0, 0);
656         if (device == INVALID_HANDLE_VALUE) {
657                 LOG_DISK("Could not open %1 for unmount (%2)", truncated, GetLastError());
658                 return false;
659         }
660         DWORD returned;
661         BOOL r = DeviceIoControl (device, FSCTL_LOCK_VOLUME, 0, 0, 0, 0, &returned, 0);
662         if (!r) {
663                 LOG_DISK("Unmount of %1 failed (%2)", truncated, GetLastError());
664                 return false;
665         }
666
667         LOG_DISK("Unmount of %1 succeeded", _device);
668         locked_volumes.push_back (make_pair(device, _device));
669
670         return true;
671 }
672
673
674 boost::filesystem::path
675 config_path ()
676 {
677         boost::filesystem::path p;
678         p /= g_get_user_config_dir ();
679         p /= "dcpomatic2";
680         return p;
681 }
682
683
684 void
685 disk_write_finished ()
686 {
687         for (auto const& i: locked_volumes) {
688                 CloseHandle (i.first);
689         }
690 }
691
692
693 string
694 dcpomatic::get_process_id ()
695 {
696         return dcp::raw_convert<string>(GetCurrentProcessId());
697 }
698
699
700 bool
701 show_in_file_manager (boost::filesystem::path, boost::filesystem::path select)
702 {
703         std::wstringstream args;
704         args << "/select," << select;
705         auto const r = ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
706         return (reinterpret_cast<int64_t>(r) <= 32);
707 }
708