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/editable_list.h"
25 #include "wx/job_manager_view.h"
26 #include "wx/message_dialog.h"
27 #include "wx/try_unmount_dialog.h"
28 #include "wx/wx_util.h"
29 #include "wx/wx_signal_manager.h"
30 #include "wx/wx_util.h"
31 #include "lib/config.h"
32 #include "lib/constants.h"
33 #include "lib/copy_to_drive_job.h"
34 #include "lib/cross.h"
35 #include "lib/dcpomatic_log.h"
36 #include "lib/disk_writer_messages.h"
37 #include "lib/file_log.h"
38 #include "lib/job_manager.h"
39 #include "lib/signal_manager.h"
41 #include "lib/version.h"
42 #include <dcp/filesystem.h>
43 #include <dcp/warnings.h>
44 #include <wx/cmdline.h>
46 LIBDCP_DISABLE_WARNINGS
47 #include <boost/process.hpp>
48 LIBDCP_ENABLE_WARNINGS
49 #ifdef DCPOMATIC_WINDOWS
50 #include <boost/process/windows.hpp>
60 using std::make_shared;
61 using std::shared_ptr;
64 using boost::optional;
65 #if BOOST_VERSION >= 106100
66 using namespace boost::placeholders;
72 ID_tools_uninstall = 1,
77 class DirDialogWrapper : public wxDirDialog
80 DirDialogWrapper (wxWindow* parent)
81 : wxDirDialog (parent, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST)
86 boost::optional<boost::filesystem::path> get () const
88 auto const dcp = boost::filesystem::path(wx_to_std(GetPath()));
89 if (!dcp::filesystem::exists(dcp / "ASSETMAP") && !dcp::filesystem::exists(dcp / "ASSETMAP.xml")) {
90 error_dialog (nullptr, _("No ASSETMAP or ASSETMAP.xml found in this folder. Please choose a DCP folder."));
97 void set (boost::filesystem::path)
104 class DOMFrame : public wxFrame
107 explicit DOMFrame (wxString const & title)
108 : wxFrame (nullptr, wxID_ANY, title)
110 , _sizer (new wxBoxSizer(wxVERTICAL))
113 auto bar = new wxMenuBar;
114 auto tools = new wxMenu;
115 tools->Append(ID_tools_uninstall, _("Uninstall..."));
116 bar->Append(tools, _("Tools"));
118 Bind (wxEVT_MENU, boost::bind(&DOMFrame::uninstall, this), ID_tools_uninstall);
121 /* Use a panel as the only child of the Frame so that we avoid
122 the dark-grey background on Windows.
124 auto overall_panel = new wxPanel (this);
125 auto s = new wxBoxSizer (wxHORIZONTAL);
126 s->Add (overall_panel, 1, wxEXPAND);
129 auto grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
132 add_label_to_sizer (grid, overall_panel, _("DCP"), true, wxGBPosition(r, 0));
133 auto dcp_sizer = new wxBoxSizer (wxHORIZONTAL);
134 auto dcps = new EditableList<boost::filesystem::path, DirDialogWrapper>(
136 { EditableListColumn(_("DCP"), 300, true) },
137 boost::bind(&DOMFrame::dcp_paths, this),
138 boost::bind(&DOMFrame::set_dcp_paths, this, _1),
139 [](boost::filesystem::path p, int) { return p.filename().string(); },
140 EditableListTitle::INVISIBLE,
141 EditableListButton::NEW | EditableListButton::REMOVE
144 dcp_sizer->Add(dcps, 1, wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
145 grid->Add(dcp_sizer, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
148 add_label_to_sizer (grid, overall_panel, _("Drive"), true, wxGBPosition(r, 0));
149 auto drive_sizer = new wxBoxSizer (wxHORIZONTAL);
150 _drive = new wxChoice (overall_panel, wxID_ANY);
151 drive_sizer->Add (_drive, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, DCPOMATIC_SIZER_X_GAP);
152 _drive_refresh = new wxButton (overall_panel, wxID_ANY, _("Refresh"));
153 drive_sizer->Add (_drive_refresh, 0);
154 grid->Add (drive_sizer, wxGBPosition(r, 1), wxDefaultSpan, wxEXPAND);
157 _jobs = new JobManagerView (overall_panel, false);
158 grid->Add (_jobs, wxGBPosition(r, 0), wxGBSpan(6, 2), wxEXPAND);
161 _copy = new wxButton (overall_panel, wxID_ANY, _("Copy DCP"));
162 grid->Add (_copy, wxGBPosition(r, 0), wxGBSpan(1, 2), wxEXPAND);
165 grid->AddGrowableCol (1);
167 _copy->Bind (wxEVT_BUTTON, boost::bind(&DOMFrame::copy, this));
168 _drive->Bind (wxEVT_CHOICE, boost::bind(&DOMFrame::setup_sensitivity, this));
169 _drive_refresh->Bind (wxEVT_BUTTON, boost::bind(&DOMFrame::drive_refresh, this));
171 _sizer->Add (grid, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
172 overall_panel->SetSizer (_sizer);
174 SetSize (1024, GetSize().GetHeight() + 32);
176 /* XXX: this is a hack, but I expect we'll need logs and I'm not sure if there's
177 * a better place to put them.
179 dcpomatic_log = make_shared<FileLog>(State::write_path("disk.log"));
180 dcpomatic_log->set_types (dcpomatic_log->types() | LogEntry::TYPE_DISK);
181 LOG_DISK("dcpomatic_disk %1 started", dcpomatic_git_commit);
185 Bind (wxEVT_SIZE, boost::bind(&DOMFrame::sized, this, _1));
186 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
188 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
190 #ifdef DCPOMATIC_WINDOWS
191 /* We must use ::shell here, it seems, to avoid error code 740 (related to privilege escalation) */
192 LOG_DISK("Starting writer process %1", disk_writer_path().string());
193 _writer = new boost::process::child (disk_writer_path(), boost::process::shell, boost::process::windows::hide);
196 #ifdef DCPOMATIC_LINUX
197 if (getenv("DCPOMATIC_NO_START_WRITER")) {
198 LOG_DISK_NC("Not starting writer process as DCPOMATIC_NO_START_WRITER is set");
200 LOG_DISK("Starting writer process %1", disk_writer_path().string());
201 _writer = new boost::process::child (disk_writer_path());
206 LOG_DISK_NC("Sending notification to writer daemon");
207 notify_post ("com.dcpomatic.disk.writer.start");
213 _nanomsg.send(DISK_WRITER_QUIT "\n", 2000);
214 /* This seems really horrible but it's suggested by the examples on nanomsg.org, so...
215 * Without this the quit is not received (at least sometimes) causing #2018.
217 dcpomatic_sleep_seconds (1);
220 void set_dcp_paths (vector<boost::filesystem::path> dcps)
227 vector<boost::filesystem::path> dcp_paths() const
232 void sized (wxSizeEvent& ev)
242 system(String::compose("osascript \"%1/uninstall_disk.applescript\"", resources_path().string()).c_str());
249 if (!JobManager::instance()->work_to_do()) {
253 auto d = make_wx<wxMessageDialog>(
255 _("There are unfinished jobs; are you sure you want to quit?"),
256 _("Unfinished jobs"),
257 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
260 return d->ShowModal() == wxID_YES;
264 void close (wxCloseEvent& ev)
266 if (!should_close()) {
276 /* Check that the selected drive still exists and update its properties if so */
278 if (_drive->GetSelection() == wxNOT_FOUND) {
279 error_dialog (this, _("The disk you selected is no longer available. Please choose another."));
283 DCPOMATIC_ASSERT (_drive->GetSelection() != wxNOT_FOUND);
284 DCPOMATIC_ASSERT (!_dcp_paths.empty());
286 auto ping = [this](int attempt) {
287 if (_nanomsg.send(DISK_WRITER_PING "\n", 1000)) {
288 auto reply = DiskWriterBackEndResponse::read_from_nanomsg(_nanomsg, 1000);
289 if (reply && reply->type() == DiskWriterBackEndResponse::Type::PONG) {
292 LOG_DISK("Unexpected response %1 to ping received (attempt %2)", static_cast<int>(reply->type()), attempt);
294 LOG_DISK("No reply received from ping (attempt %1)", attempt);
297 LOG_DISK("Could not send ping to writer (attempt %1)", attempt);
299 dcpomatic_sleep_seconds (1);
303 bool have_writer = false;
304 for (int i = 0; i < 8; ++i) {
312 #if defined(DCPOMATIC_WINDOWS)
313 auto m = make_wx<MessageDialog>(
315 _("DCP-o-matic Disk Writer"),
316 _("Do you see a 'User Account Control' dialogue asking about dcpomatic2_disk_writer.exe? If so, click 'Yes', then try again.")
320 #elif defined(DCPOMATIC_OSX)
321 auto m = make_wx<MessageDialog>(
323 _("DCP-o-matic Disk Writer"),
324 _("Did you install the DCP-o-matic Disk Writer.pkg from the .dmg? Please check and try again.")
329 LOG_DISK_NC ("Failed to ping writer");
330 throw CommunicationFailedError ();
334 auto const& drive = _drives[_drive->GetSelection()];
335 if (drive.mounted()) {
336 auto d = make_wx<TryUnmountDialog>(this, drive.description());
337 int const r = d->ShowModal ();
342 LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
343 if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
344 LOG_DISK_NC("Failed to send unmount request.");
345 throw CommunicationFailedError ();
347 if (!_nanomsg.send(drive.as_xml(), 2000)) {
348 LOG_DISK_NC("Failed to send drive for unmount request.");
349 throw CommunicationFailedError ();
351 /* The reply may have to wait for the user to authenticate, so let's wait a while */
352 auto const reply = DiskWriterBackEndResponse::read_from_nanomsg(_nanomsg, 30000);
353 if (!reply || reply->type() != DiskWriterBackEndResponse::Type::OK) {
354 auto m = make_wx<MessageDialog>(
356 _("DCP-o-matic Disk Writer"),
358 _("The drive %s could not be unmounted.\nClose any application that is using it, then try again. (%s)"),
359 std_to_wx(drive.description()),
360 reply->error_message()
369 auto d = make_wx<DriveWipeWarningDialog>(this, _drive->GetString(_drive->GetSelection()));
370 if (d->ShowModal() != wxID_OK) {
373 if (!d->confirmed()) {
374 message_dialog(this, _("You did not correctly confirm that you read the warning that was just shown. Please try again."));
378 JobManager::instance()->add(make_shared<CopyToDriveJob>(_dcp_paths, _drives[_drive->GetSelection()], _nanomsg));
379 setup_sensitivity ();
382 void drive_refresh ()
384 int const sel = _drive->GetSelection ();
386 if (sel != wxNOT_FOUND) {
387 current = _drive->GetString (sel);
390 int re_select = wxNOT_FOUND;
392 _drives = Drive::get ();
393 for (auto i: _drives) {
394 auto const s = std_to_wx(i.description());
401 _drive->SetSelection (re_select);
402 setup_sensitivity ();
405 void setup_sensitivity ()
407 _copy->Enable (!_dcp_paths.empty() && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
411 wxButton* _drive_refresh;
413 JobManagerView* _jobs;
414 std::vector<boost::filesystem::path> _dcp_paths;
415 std::vector<Drive> _drives;
416 #ifndef DCPOMATIC_OSX
417 boost::process::child* _writer;
424 static const wxCmdLineEntryDesc command_line_description[] = {
425 { wxCMD_LINE_OPTION, "d", "dcp", "DCP to write", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
426 { wxCMD_LINE_SWITCH, "s", "sure", "skip alpha test warnings", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
427 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
431 class App : public wxApp
438 bool OnInit () override
441 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
442 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
444 SetAppName (_("DCP-o-matic Disk Writer"));
446 if (!wxApp::OnInit()) {
450 #ifdef DCPOMATIC_LINUX
451 unsetenv ("UBUNTU_MENUPROXY");
455 dcpomatic_sleep_seconds (1);
456 make_foreground_application ();
459 dcpomatic_setup_path_encoding ();
461 /* Enable i18n; this will create a Config object
462 to look for a force-configured language. This Config
463 object will be wrong, however, because dcpomatic_setup
464 hasn't yet been called and there aren't any filters etc.
467 dcpomatic_setup_i18n ();
469 /* Set things up, including filters etc.
470 which will now be internationalised correctly.
474 /* Force the configuration to be re-loaded correctly next
479 if (!_skip_alpha_check) {
480 auto warning = make_wx<DiskWarningDialog>();
481 if (warning->ShowModal() != wxID_OK) {
484 if (!warning->confirmed()) {
485 message_dialog(nullptr, _("You did not correctly confirm that you read the warning that was just shown. DCP-o-matic Disk Writer will close now. Please try again."));
490 _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
491 SetTopWindow (_frame);
496 _frame->set_dcp_paths({*_dcp_to_write});
499 signal_manager = new wxSignalManager (this);
500 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
504 error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
511 void OnInitCmdLine (wxCmdLineParser& parser) override
513 parser.SetDesc (command_line_description);
514 parser.SetSwitchChars (wxT ("-"));
517 bool OnCmdLineParsed (wxCmdLineParser& parser) override
519 _skip_alpha_check = parser.Found(wxT("sure"));
522 if (parser.Found(wxT("dcp"), &dcp)) {
523 _dcp_to_write = wx_to_std (dcp);
529 void config_failed_to_load ()
531 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
534 void config_warning (string m)
536 message_dialog (_frame, std_to_wx(m));
539 void idle (wxIdleEvent& ev)
541 signal_manager->ui_idle ();
545 void report_exception ()
549 } catch (FileError& e) {
553 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
554 std_to_wx (e.what()),
555 std_to_wx (e.file().string().c_str ())
558 } catch (exception& e) {
562 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
563 std_to_wx (e.what ())
567 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
571 bool OnExceptionInMainLoop () override
574 /* This will terminate the program */
578 void OnUnhandledException () override
584 bool _skip_alpha_check = false;
585 boost::optional<boost::filesystem::path> _dcp_to_write;