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 "wx/disk_warning_dialog.h"
23 #include "wx/drive_wipe_warning_dialog.h"
24 #include "wx/job_manager_view.h"
25 #include "wx/message_dialog.h"
26 #include "wx/try_unmount_dialog.h"
27 #include "wx/wx_util.h"
28 #include "wx/wx_signal_manager.h"
29 #include "wx/wx_util.h"
30 #include "lib/config.h"
31 #include "lib/copy_to_drive_job.h"
32 #include "lib/cross.h"
33 #include "lib/dcpomatic_log.h"
34 #include "lib/disk_writer_messages.h"
35 #include "lib/file_log.h"
36 #include "lib/job_manager.h"
37 #include "lib/signal_manager.h"
39 #include "lib/version.h"
40 #include "lib/warnings.h"
41 #include <wx/cmdline.h>
43 DCPOMATIC_DISABLE_WARNINGS
44 #include <boost/process.hpp>
45 DCPOMATIC_ENABLE_WARNINGS
46 #ifdef DCPOMATIC_WINDOWS
47 #include <boost/process/windows.hpp>
57 using std::make_shared;
58 using std::shared_ptr;
60 using boost::optional;
61 #if BOOST_VERSION >= 106100
62 using namespace boost::placeholders;
68 ID_tools_uninstall = 1,
73 class DOMFrame : public wxFrame
76 explicit DOMFrame (wxString const & title)
77 : wxFrame (nullptr, wxID_ANY, title)
79 , _sizer (new wxBoxSizer(wxVERTICAL))
82 auto bar = new wxMenuBar;
83 auto tools = new wxMenu;
84 tools->Append(ID_tools_uninstall, _("Uninstall..."));
85 bar->Append(tools, _("Tools"));
87 Bind (wxEVT_MENU, boost::bind(&DOMFrame::uninstall, this), ID_tools_uninstall);
90 /* Use a panel as the only child of the Frame so that we avoid
91 the dark-grey background on Windows.
93 auto overall_panel = new wxPanel (this);
94 auto s = new wxBoxSizer (wxHORIZONTAL);
95 s->Add (overall_panel, 1, wxEXPAND);
98 auto grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
101 add_label_to_sizer (grid, overall_panel, _("DCP"), true, wxGBPosition(r, 0));
102 auto dcp_name_sizer = new wxBoxSizer (wxHORIZONTAL);
103 _dcp_name = new wxStaticText (overall_panel, wxID_ANY, wxEmptyString);
104 dcp_name_sizer->Add (_dcp_name, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_X_GAP);
105 _dcp_open = new wxButton (overall_panel, wxID_ANY, _("Open..."));
106 dcp_name_sizer->Add (_dcp_open, 0);
107 grid->Add (dcp_name_sizer, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
110 add_label_to_sizer (grid, overall_panel, _("Drive"), true, wxGBPosition(r, 0));
111 auto drive_sizer = new wxBoxSizer (wxHORIZONTAL);
112 _drive = new wxChoice (overall_panel, wxID_ANY);
113 drive_sizer->Add (_drive, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_X_GAP);
114 _drive_refresh = new wxButton (overall_panel, wxID_ANY, _("Refresh"));
115 drive_sizer->Add (_drive_refresh, 0);
116 grid->Add (drive_sizer, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
119 _jobs = new JobManagerView (overall_panel, false);
120 grid->Add (_jobs, wxGBPosition(r, 0), wxGBSpan(6, 2), wxEXPAND);
123 _copy = new wxButton (overall_panel, wxID_ANY, _("Copy DCP"));
124 grid->Add (_copy, wxGBPosition(r, 0), wxGBSpan(1, 2), wxEXPAND);
127 grid->AddGrowableCol (1);
129 _dcp_open->Bind (wxEVT_BUTTON, boost::bind(&DOMFrame::open, this));
130 _copy->Bind (wxEVT_BUTTON, boost::bind(&DOMFrame::copy, this));
131 _drive->Bind (wxEVT_CHOICE, boost::bind(&DOMFrame::setup_sensitivity, this));
132 _drive_refresh->Bind (wxEVT_BUTTON, boost::bind(&DOMFrame::drive_refresh, this));
134 _sizer->Add (grid, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
135 overall_panel->SetSizer (_sizer);
137 SetSize (1024, GetSize().GetHeight() + 32);
139 /* XXX: this is a hack, but I expect we'll need logs and I'm not sure if there's
140 * a better place to put them.
142 dcpomatic_log = make_shared<FileLog>(State::write_path("disk.log"));
143 dcpomatic_log->set_types (dcpomatic_log->types() | LogEntry::TYPE_DISK);
144 LOG_DISK("dcpomatic_disk %1 started", dcpomatic_git_commit);
148 Bind (wxEVT_SIZE, boost::bind(&DOMFrame::sized, this, _1));
149 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
151 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
153 #ifdef DCPOMATIC_WINDOWS
154 /* We must use ::shell here, it seems, to avoid error code 740 (related to privilege escalation) */
155 LOG_DISK("Starting writer process %1", disk_writer_path().string());
156 _writer = new boost::process::child (disk_writer_path(), boost::process::shell, boost::process::windows::hide);
159 #ifdef DCPOMATIC_LINUX
160 if (getenv("DCPOMATIC_NO_START_WRITER")) {
161 LOG_DISK_NC("Not starting writer process as DCPOMATIC_NO_START_WRITER is set");
163 LOG_DISK("Starting writer process %1", disk_writer_path().string());
164 _writer = new boost::process::child (disk_writer_path());
169 LOG_DISK_NC("Sending notification to writer daemon");
170 notify_post ("com.dcpomatic.disk.writer.start");
176 _nanomsg.send(DISK_WRITER_QUIT "\n", 2000);
177 /* This seems really horrible but it's suggested by the examples on nanomsg.org, so...
178 * Without this the quit is not received (at least sometimes) causing #2018.
180 dcpomatic_sleep_seconds (1);
183 void set_dcp (boost::filesystem::path dcp)
185 if (!boost::filesystem::exists(dcp / "ASSETMAP") && !boost::filesystem::exists(dcp / "ASSETMAP.xml")) {
186 error_dialog (nullptr, _("No ASSETMAP or ASSETMAP.xml found in this folder. Please choose a DCP folder."));
191 _dcp_name->SetLabel (std_to_wx(dcp.filename().string()));
195 void sized (wxSizeEvent& ev)
205 system(String::compose("osascript \"%1/uninstall_disk.applescript\"", resources_path().string()).c_str());
212 if (!JobManager::instance()->work_to_do()) {
216 auto d = new wxMessageDialog (
218 _("There are unfinished jobs; are you sure you want to quit?"),
219 _("Unfinished jobs"),
220 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
223 bool const r = d->ShowModal() == wxID_YES;
229 void close (wxCloseEvent& ev)
231 if (!should_close()) {
242 auto d = new wxDirDialog (this, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
243 int r = d->ShowModal ();
244 boost::filesystem::path const path (wx_to_std(d->GetPath()));
252 setup_sensitivity ();
257 /* Check that the selected drive still exists and update its properties if so */
259 if (_drive->GetSelection() == wxNOT_FOUND) {
260 error_dialog (this, _("The disk you selected is no longer available. Please choose another."));
264 DCPOMATIC_ASSERT (_drive->GetSelection() != wxNOT_FOUND);
265 DCPOMATIC_ASSERT (static_cast<bool>(_dcp_path));
267 auto ping = [this](int attempt) {
268 if (_nanomsg.send(DISK_WRITER_PING "\n", 1000)) {
269 auto reply = _nanomsg.receive (1000);
270 if (reply && *reply == DISK_WRITER_PONG) {
273 LOG_DISK("Unexpected response %1 to ping received (attempt %2)", *reply, attempt);
275 LOG_DISK("No reply received from ping (attempt %1)", attempt);
278 LOG_DISK("Could not send ping to writer (attempt %1)", attempt);
280 dcpomatic_sleep_seconds (1);
284 bool have_writer = false;
285 for (int i = 0; i < 8; ++i) {
293 #if defined(DCPOMATIC_WINDOWS)
294 auto m = new MessageDialog (
296 _("DCP-o-matic Disk Writer"),
297 _("Do you see a 'User Account Control' dialogue asking about dcpomatic2_disk_writer.exe? If so, click 'Yes', then try again.")
302 #elif defined(DCPOMATIC_OSX)
303 auto m = new MessageDialog (
305 _("DCP-o-matic Disk Writer"),
306 _("Did you install the DCP-o-matic Disk Writer.pkg from the .dmg? Please check and try again.")
312 LOG_DISK_NC ("Failed to ping writer");
313 throw CommunicationFailedError ();
317 auto const& drive = _drives[_drive->GetSelection()];
318 if (drive.mounted()) {
319 auto d = new TryUnmountDialog(this, drive.description());
320 int const r = d->ShowModal ();
326 LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
327 if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
328 LOG_DISK_NC("Failed to send unmount request.");
329 throw CommunicationFailedError ();
331 if (!_nanomsg.send(drive.as_xml(), 2000)) {
332 LOG_DISK_NC("Failed to send drive for unmount request.");
333 throw CommunicationFailedError ();
335 /* The reply may have to wait for the user to authenticate, so let's wait a while */
336 auto reply = _nanomsg.receive (30000);
337 if (!reply || *reply != DISK_WRITER_OK) {
338 auto * m = new MessageDialog (
340 _("DCP-o-matic Disk Writer"),
341 wxString::Format(_("The drive %s could not be unmounted.\nClose any application that is using it, then try again."), std_to_wx(drive.description()))
350 auto * d = new DriveWipeWarningDialog (this, _drive->GetString(_drive->GetSelection()));
351 int const r = d->ShowModal ();
352 bool ok = r == wxID_OK && d->confirmed();
359 JobManager::instance()->add(make_shared<CopyToDriveJob>(*_dcp_path, _drives[_drive->GetSelection()], _nanomsg));
360 setup_sensitivity ();
363 void drive_refresh ()
365 int const sel = _drive->GetSelection ();
367 if (sel != wxNOT_FOUND) {
368 current = _drive->GetString (sel);
371 int re_select = wxNOT_FOUND;
373 _drives = Drive::get ();
374 for (auto i: _drives) {
375 auto const s = std_to_wx(i.description());
382 _drive->SetSelection (re_select);
383 setup_sensitivity ();
386 void setup_sensitivity ()
388 _copy->Enable (static_cast<bool>(_dcp_path) && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
391 wxStaticText* _dcp_name;
394 wxButton* _drive_refresh;
396 JobManagerView* _jobs;
397 boost::optional<boost::filesystem::path> _dcp_path;
398 std::vector<Drive> _drives;
399 #ifndef DCPOMATIC_OSX
400 boost::process::child* _writer;
407 static const wxCmdLineEntryDesc command_line_description[] = {
408 { wxCMD_LINE_OPTION, "d", "dcp", "DCP to write", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
409 { wxCMD_LINE_SWITCH, "s", "sure", "skip alpha test warnings", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
410 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
414 class App : public wxApp
424 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
425 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
427 SetAppName (_("DCP-o-matic Disk Writer"));
429 if (!wxApp::OnInit()) {
433 #ifdef DCPOMATIC_LINUX
434 unsetenv ("UBUNTU_MENUPROXY");
438 dcpomatic_sleep_seconds (1);
439 make_foreground_application ();
442 dcpomatic_setup_path_encoding ();
444 /* Enable i18n; this will create a Config object
445 to look for a force-configured language. This Config
446 object will be wrong, however, because dcpomatic_setup
447 hasn't yet been called and there aren't any filters etc.
450 dcpomatic_setup_i18n ();
452 /* Set things up, including filters etc.
453 which will now be internationalised correctly.
457 /* Force the configuration to be re-loaded correctly next
462 if (!_skip_alpha_check) {
463 auto warning = new DiskWarningDialog ();
464 warning->ShowModal ();
465 if (!warning->confirmed()) {
471 _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
472 SetTopWindow (_frame);
477 _frame->set_dcp (*_dcp_to_write);
480 signal_manager = new wxSignalManager (this);
481 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
485 error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
492 void OnInitCmdLine (wxCmdLineParser& parser)
494 parser.SetDesc (command_line_description);
495 parser.SetSwitchChars (wxT ("-"));
498 bool OnCmdLineParsed (wxCmdLineParser& parser)
500 _skip_alpha_check = parser.Found(wxT("sure"));
503 if (parser.Found(wxT("dcp"), &dcp)) {
504 _dcp_to_write = wx_to_std (dcp);
510 void config_failed_to_load ()
512 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
515 void config_warning (string m)
517 message_dialog (_frame, std_to_wx(m));
520 void idle (wxIdleEvent& ev)
522 signal_manager->ui_idle ();
526 void report_exception ()
530 } catch (FileError& e) {
534 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
535 std_to_wx (e.what()),
536 std_to_wx (e.file().string().c_str ())
539 } catch (exception& e) {
543 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
544 std_to_wx (e.what ())
548 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
552 bool OnExceptionInMainLoop ()
555 /* This will terminate the program */
559 void OnUnhandledException ()
565 bool _skip_alpha_check = false;
566 boost::optional<boost::filesystem::path> _dcp_to_write;