2 Copyright (C) 2019-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/>.
22 #include "lib/compose.hpp"
23 #include "lib/cross.h"
24 #include "lib/dcpomatic_log.h"
25 #include "lib/digester.h"
26 #include "lib/disk_writer_messages.h"
27 #include "lib/exceptions.h"
29 #include "lib/file_log.h"
30 #include "lib/nanomsg.h"
31 #include "lib/version.h"
32 #include "lib/warnings.h"
34 #ifdef DCPOMATIC_POSIX
35 #include <sys/ioctl.h>
36 #include <sys/types.h>
41 #include "lib/stdout_log.h"
44 #include <lwext4/file_dev.h>
49 #ifdef DCPOMATIC_LINUX
50 #include <polkit/polkit.h>
54 #ifdef DCPOMATIC_WINDOWS
56 #include <lwext4/file_windows.h>
60 DCPOMATIC_DISABLE_WARNINGS
62 DCPOMATIC_ENABLE_WARNINGS
65 #include <sys/types.h>
66 #include <boost/filesystem.hpp>
67 #include <boost/algorithm/string.hpp>
74 using std::runtime_error;
77 using boost::optional;
80 #define SHORT_TIMEOUT 100
81 #define LONG_TIMEOUT 2000
84 #ifdef DCPOMATIC_LINUX
85 static PolkitAuthority* polkit_authority = nullptr;
87 static Nanomsg* nanomsg = nullptr;
90 #ifdef DCPOMATIC_LINUX
92 polkit_callback (GObject *, GAsyncResult* res, gpointer data)
94 auto parameters = reinterpret_cast<std::pair<std::function<void ()>, std::function<void ()>>*> (data);
95 GError* error = nullptr;
96 auto result = polkit_authority_check_authorization_finish (polkit_authority, res, &error);
100 LOG_DISK("polkit authority check failed (check_authorization_finish failed with %1)", error->message);
103 if (polkit_authorization_result_get_is_authorized(result)) {
107 if (polkit_authorization_result_get_is_challenge(result)) {
108 LOG_DISK_NC("polkit authority check failed (challenge)");
110 LOG_DISK_NC("polkit authority check failed (not authorized)");
116 parameters->second();
122 g_object_unref (result);
128 #ifdef DCPOMATIC_LINUX
129 void request_privileges (string action, std::function<void ()> granted, std::function<void ()> denied)
131 void request_privileges (string, std::function<void ()> granted, std::function<void ()>)
134 #ifdef DCPOMATIC_LINUX
135 polkit_authority = polkit_authority_get_sync (0, 0);
136 auto subject = polkit_unix_process_new_for_owner (getppid(), 0, -1);
138 auto parameters = new std::pair<std::function<void ()>, std::function<void ()>>(granted, denied);
139 polkit_authority_check_authorization (
140 polkit_authority, subject, action.c_str(), 0, POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION, 0, polkit_callback, parameters
152 using namespace boost::algorithm;
154 auto s = nanomsg->receive (0);
159 LOG_DISK("Writer receives command: %1", *s);
161 if (*s == DISK_WRITER_QUIT) {
163 } else if (*s == DISK_WRITER_PING) {
164 nanomsg->send(DISK_WRITER_PONG "\n", LONG_TIMEOUT);
165 } else if (*s == DISK_WRITER_UNMOUNT) {
166 auto xml_head = nanomsg->receive (LONG_TIMEOUT);
167 auto xml_body = nanomsg->receive (LONG_TIMEOUT);
168 if (!xml_head || !xml_body) {
169 LOG_DISK_NC("Failed to receive unmount request");
170 throw CommunicationFailedError ();
172 auto xml = *xml_head + *xml_body;
174 "com.dcpomatic.write-drive",
176 bool const success = Drive(xml).unmount();
177 if (!nanomsg->send(success ? (DISK_WRITER_OK "\n") : (DISK_WRITER_ERROR "\n"), LONG_TIMEOUT)) {
178 LOG_DISK_NC("CommunicationFailedError in unmount_finished");
179 throw CommunicationFailedError ();
183 if (!nanomsg->send(DISK_WRITER_ERROR "\n", LONG_TIMEOUT)) {
184 LOG_DISK_NC("CommunicationFailedError in unmount_finished");
185 throw CommunicationFailedError ();
188 } else if (*s == DISK_WRITER_WRITE) {
189 auto dcp_path_opt = nanomsg->receive (LONG_TIMEOUT);
190 auto device_opt = nanomsg->receive (LONG_TIMEOUT);
191 if (!dcp_path_opt || !device_opt) {
192 LOG_DISK_NC("Failed to receive write request");
193 throw CommunicationFailedError();
196 auto dcp_path = *dcp_path_opt;
197 auto device = *device_opt;
199 /* Do some basic sanity checks; this is a bit belt-and-braces but it can't hurt... */
202 if (!starts_with(device, "/dev/disk")) {
203 LOG_DISK ("Will not write to %1", device);
204 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
208 #ifdef DCPOMATIC_LINUX
209 if (!starts_with(device, "/dev/sd") && !starts_with(device, "/dev/hd")) {
210 LOG_DISK ("Will not write to %1", device);
211 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
215 #ifdef DCPOMATIC_WINDOWS
216 if (!starts_with(device, "\\\\.\\PHYSICALDRIVE")) {
217 LOG_DISK ("Will not write to %1", device);
218 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
223 bool on_drive_list = false;
224 bool mounted = false;
225 for (auto const& i: Drive::get()) {
226 if (i.device() == device) {
227 on_drive_list = true;
228 mounted = i.mounted();
232 if (!on_drive_list) {
233 LOG_DISK ("Will not write to %1 as it's not recognised as a drive", device);
234 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
238 LOG_DISK ("Will not write to %1 as it's mounted", device);
239 nanomsg->send(DISK_WRITER_ERROR "\nRefusing to write to this drive\n1\n", LONG_TIMEOUT);
243 LOG_DISK ("Here we go writing %1 to %2", dcp_path, device);
246 "com.dcpomatic.write-drive",
247 [dcp_path, device]() {
248 #if defined(DCPOMATIC_LINUX)
249 auto posix_partition = device;
250 /* XXX: don't know if this logic is sensible */
251 if (posix_partition.size() > 0 && isdigit(posix_partition[posix_partition.length() - 1])) {
252 posix_partition += "p1";
254 posix_partition += "1";
256 dcpomatic::write (dcp_path, device, posix_partition, nanomsg);
257 #elif defined(DCPOMATIC_OSX)
258 auto fast_device = boost::algorithm::replace_first_copy (device, "/dev/disk", "/dev/rdisk");
259 dcpomatic::write (dcp_path, fast_device, fast_device + "s1", nanomsg);
260 #elif defined(DCPOMATIC_WINDOWS)
261 dcpomatic::write (dcp_path, device, "", nanomsg);
266 nanomsg->send(DISK_WRITER_ERROR "\nCould not obtain authorization to write to the drive\n", LONG_TIMEOUT);
272 } catch (exception& e) {
273 LOG_DISK("Exception (from idle): %1", e.what());
281 /* On macOS this is running as root, so config_path() will be somewhere in root's
282 * home. Instead, just write to stdout as the macOS process control stuff will
283 * redirect this to a file in /var/log
285 dcpomatic_log.reset(new StdoutLog(LogEntry::TYPE_DISK));
286 LOG_DISK("dcpomatic_disk_writer %1 started", dcpomatic_git_commit);
288 /* XXX: this is a hack, but I expect we'll need logs and I'm not sure if there's
289 * a better place to put them.
291 dcpomatic_log.reset(new FileLog(config_path() / "disk_writer.log", LogEntry::TYPE_DISK));
292 LOG_DISK_NC("dcpomatic_disk_writer started");
296 /* I *think* this consumes the notifyd event that we used to start the process, so we only
297 * get started once per notification.
299 xpc_set_event_stream_handler("com.apple.notifyd.matching", DISPATCH_TARGET_QUEUE_DEFAULT, ^(xpc_object_t) {});
303 nanomsg = new Nanomsg (false);
304 } catch (runtime_error& e) {
305 LOG_DISK_NC("Could not set up nanomsg socket");
309 LOG_DISK_NC("Entering main loop");
310 auto ml = Glib::MainLoop::create ();
311 Glib::signal_timeout().connect(sigc::ptr_fun(&idle), 500);