src/tools/dcpomatic_disk.cc

   1 /*
   2     Copyright (C) 2019-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 #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"
  38 #include "lib/util.h"
  39 #include "lib/version.h"
  40 #include "lib/warnings.h"
  41 #include <wx/cmdline.h>
  42 #include <wx/wx.h>
  43 DCPOMATIC_DISABLE_WARNINGS
  44 #include <boost/process.hpp>
  45 DCPOMATIC_ENABLE_WARNINGS
  46 #ifdef DCPOMATIC_WINDOWS
  47 #include <boost/process/windows.hpp>
  48 #endif
  49 #ifdef DCPOMATIC_OSX
  50 #include <notify.h>
  51 #endif
  52
  53
  54 using std::cerr;
  55 using std::cout;
  56 using std::exception;
  57 using std::make_shared;
  58 using std::shared_ptr;
  59 using std::string;
  60 using boost::optional;
  61 #if BOOST_VERSION >= 106100
  62 using namespace boost::placeholders;
  63 #endif
  64
  65
  66 #ifdef DCPOMATIC_OSX
  67 enum {
  68         ID_tools_uninstall = 1,
  69 };
  70 #endif
  71
  72
  73 class DOMFrame : public wxFrame
  74 {
  75 public:
  76         explicit DOMFrame (wxString const & title)
  77                 : wxFrame (nullptr, wxID_ANY, title)
  78                 , _nanomsg (true)
  79                 , _sizer (new wxBoxSizer(wxVERTICAL))
  80         {
  81 #ifdef DCPOMATIC_OSX
  82                 auto bar = new wxMenuBar;
  83                 auto tools = new wxMenu;
  84                 tools->Append(ID_tools_uninstall, _("Uninstall..."));
  85                 bar->Append(tools, _("Tools"));
  86                 SetMenuBar (bar);
  87                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::uninstall, this), ID_tools_uninstall);
  88 #endif
  89
  90                 /* Use a panel as the only child of the Frame so that we avoid
  91                    the dark-grey background on Windows.
  92                 */
  93                 auto overall_panel = new wxPanel (this);
  94                 auto s = new wxBoxSizer (wxHORIZONTAL);
  95                 s->Add (overall_panel, 1, wxEXPAND);
  96                 SetSizer (s);
  97
  98                 auto grid = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  99
 100                 int r = 0;
 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);
 108                 ++r;
 109
 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);
 117                 ++r;
 118
 119                 _jobs = new JobManagerView (overall_panel, false);
 120                 grid->Add (_jobs, wxGBPosition(r, 0), wxGBSpan(6, 2), wxEXPAND);
 121                 r += 6;
 122
 123                 _copy = new wxButton (overall_panel, wxID_ANY, _("Copy DCP"));
 124                 grid->Add (_copy, wxGBPosition(r, 0), wxGBSpan(1, 2), wxEXPAND);
 125                 ++r;
 126
 127                 grid->AddGrowableCol (1);
 128
 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));
 133
 134                 _sizer->Add (grid, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
 135                 overall_panel->SetSizer (_sizer);
 136                 Fit ();
 137                 SetSize (1024, GetSize().GetHeight() + 32);
 138
 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.
 141                  */
 142                 dcpomatic_log.reset(new FileLog(config_path() / "disk.log"));
 143                 dcpomatic_log->set_types (dcpomatic_log->types() | LogEntry::TYPE_DISK);
 144                 LOG_DISK("dcpomatic_disk %1 started", dcpomatic_git_commit);
 145
 146                 drive_refresh ();
 147
 148                 Bind (wxEVT_SIZE, boost::bind(&DOMFrame::sized, this, _1));
 149                 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
 150
 151                 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
 152
 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);
 157 #endif
 158
 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");
 162                 } else {
 163                         LOG_DISK("Starting writer process %1", disk_writer_path().string());
 164                         _writer = new boost::process::child (disk_writer_path());
 165                 }
 166 #endif
 167
 168 #ifdef DCPOMATIC_OSX
 169                 LOG_DISK_NC("Sending notification to writer daemon");
 170                 notify_post ("com.dcpomatic.disk.writer.start");
 171 #endif
 172         }
 173
 174         ~DOMFrame ()
 175         {
 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.
 179                  */
 180                 dcpomatic_sleep_seconds (1);
 181         }
 182
 183         void set_dcp (boost::filesystem::path dcp)
 184         {
 185                 _dcp_path = dcp;
 186                 _dcp_name->SetLabel (std_to_wx(dcp.filename().string()));
 187         }
 188
 189 private:
 190         void sized (wxSizeEvent& ev)
 191         {
 192                 _sizer->Layout ();
 193                 ev.Skip ();
 194         }
 195
 196
 197 #ifdef DCPOMATIC_OSX
 198         void uninstall()
 199         {
 200                 system(String::compose("osascript \"%1/uninstall_disk.applescript\"", resources_path().string()).c_str());
 201         }
 202 #endif
 203
 204
 205         bool should_close ()
 206         {
 207                 if (!JobManager::instance()->work_to_do()) {
 208                         return true;
 209                 }
 210
 211                 auto d = new wxMessageDialog (
 212                         0,
 213                         _("There are unfinished jobs; are you sure you want to quit?"),
 214                         _("Unfinished jobs"),
 215                         wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
 216                         );
 217
 218                 bool const r = d->ShowModal() == wxID_YES;
 219                 d->Destroy ();
 220                 return r;
 221         }
 222
 223
 224         void close (wxCloseEvent& ev)
 225         {
 226                 if (!should_close()) {
 227                         ev.Veto ();
 228                         return;
 229                 }
 230
 231                 ev.Skip ();
 232         }
 233
 234
 235         void open ()
 236         {
 237                 auto d = new wxDirDialog (this, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
 238                 int r = d->ShowModal ();
 239                 boost::filesystem::path const path (wx_to_std(d->GetPath()));
 240                 d->Destroy ();
 241
 242                 if (r != wxID_OK) {
 243                         return;
 244                 }
 245
 246                 set_dcp (path);
 247                 setup_sensitivity ();
 248         }
 249
 250         void copy ()
 251         {
 252                 /* Check that the selected drive still exists and update its properties if so */
 253                 drive_refresh ();
 254                 if (_drive->GetSelection() == wxNOT_FOUND) {
 255                         error_dialog (this, _("The disk you selected is no longer available.  Please choose another."));
 256                         return;
 257                 }
 258
 259                 DCPOMATIC_ASSERT (_drive->GetSelection() != wxNOT_FOUND);
 260                 DCPOMATIC_ASSERT (static_cast<bool>(_dcp_path));
 261
 262                 auto ping = [this](int attempt) {
 263                         if (_nanomsg.send(DISK_WRITER_PING "\n", 1000)) {
 264                                 auto reply = _nanomsg.receive (1000);
 265                                 if (reply && *reply == DISK_WRITER_PONG) {
 266                                         return true;
 267                                 } else if (reply) {
 268                                         LOG_DISK("Unexpected response %1 to ping received (attempt %2)", *reply, attempt);
 269                                 } else {
 270                                         LOG_DISK("No reply received from ping (attempt %1)", attempt);
 271                                 }
 272                         } else {
 273                                 LOG_DISK("Could not send ping to writer (attempt %1)", attempt);
 274                         }
 275                         dcpomatic_sleep_seconds (1);
 276                         return false;
 277                 };
 278
 279                 bool have_writer = false;
 280                 for (int i = 0; i < 8; ++i) {
 281                         if (ping(i + 1)) {
 282                                 have_writer = true;
 283                                 break;
 284                         }
 285                 }
 286
 287                 if (!have_writer) {
 288 #if defined(DCPOMATIC_WINDOWS)
 289                         auto m = new MessageDialog (
 290                                 this,
 291                                 _("DCP-o-matic Disk Writer"),
 292                                 _("Do you see a 'User Account Control' dialogue asking about dcpomatic2_disk_writer.exe?  If so, click 'Yes', then try again.")
 293                                 );
 294                         m->ShowModal ();
 295                         m->Destroy ();
 296                         return;
 297 #elif defined(DCPOMATIC_OSX)
 298                         auto m = new MessageDialog (
 299                                 this,
 300                                 _("DCP-o-matic Disk Writer"),
 301                                 _("Did you install the DCP-o-matic Disk Writer.pkg from the .dmg?  Please check and try again.")
 302                                 );
 303                         m->ShowModal ();
 304                         m->Destroy ();
 305                         return;
 306 #else
 307                         LOG_DISK_NC ("Failed to ping writer");
 308                         throw CommunicationFailedError ();
 309 #endif
 310                 }
 311
 312                 auto const& drive = _drives[_drive->GetSelection()];
 313                 if (drive.mounted()) {
 314                         auto d = new TryUnmountDialog(this, drive.description());
 315                         int const r = d->ShowModal ();
 316                         d->Destroy ();
 317                         if (r != wxID_OK) {
 318                                 return;
 319                         }
 320
 321                         LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
 322                         if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
 323                                 LOG_DISK_NC("Failed to send unmount request.");
 324                                 throw CommunicationFailedError ();
 325                         }
 326                         if (!_nanomsg.send(drive.as_xml(), 2000)) {
 327                                 LOG_DISK_NC("Failed to send drive for unmount request.");
 328                                 throw CommunicationFailedError ();
 329                         }
 330                         /* The reply may have to wait for the user to authenticate, so let's wait a while */
 331                         auto reply = _nanomsg.receive (30000);
 332                         if (!reply || *reply != DISK_WRITER_OK) {
 333                                 auto * m = new MessageDialog (
 334                                                 this,
 335                                                 _("DCP-o-matic Disk Writer"),
 336                                                 wxString::Format(_("The drive %s could not be unmounted.\nClose any application that is using it, then try again."), std_to_wx(drive.description()))
 337                                                 );
 338                                 m->ShowModal ();
 339                                 m->Destroy ();
 340                                 return;
 341                         }
 342                 }
 343
 344
 345                 auto * d = new DriveWipeWarningDialog (this, _drive->GetString(_drive->GetSelection()));
 346                 int const r = d->ShowModal ();
 347                 bool ok = r == wxID_OK && d->confirmed();
 348                 d->Destroy ();
 349
 350                 if (!ok) {
 351                         return;
 352                 }
 353
 354                 JobManager::instance()->add(make_shared<CopyToDriveJob>(*_dcp_path, _drives[_drive->GetSelection()], _nanomsg));
 355                 setup_sensitivity ();
 356         }
 357
 358         void drive_refresh ()
 359         {
 360                 int const sel = _drive->GetSelection ();
 361                 wxString current;
 362                 if (sel != wxNOT_FOUND) {
 363                         current = _drive->GetString (sel);
 364                 }
 365                 _drive->Clear ();
 366                 int re_select = wxNOT_FOUND;
 367                 int j = 0;
 368                 _drives = Drive::get ();
 369                 for (auto i: _drives) {
 370                         auto const s = std_to_wx(i.description());
 371                         if (s == current) {
 372                                 re_select = j;
 373                         }
 374                         _drive->Append(s);
 375                         ++j;
 376                 }
 377                 _drive->SetSelection (re_select);
 378                 setup_sensitivity ();
 379         }
 380
 381         void setup_sensitivity ()
 382         {
 383                 _copy->Enable (static_cast<bool>(_dcp_path) && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
 384         }
 385
 386         wxStaticText* _dcp_name;
 387         wxButton* _dcp_open;
 388         wxChoice* _drive;
 389         wxButton* _drive_refresh;
 390         wxButton* _copy;
 391         JobManagerView* _jobs;
 392         boost::optional<boost::filesystem::path> _dcp_path;
 393         std::vector<Drive> _drives;
 394 #ifndef DCPOMATIC_OSX
 395         boost::process::child* _writer;
 396 #endif
 397         Nanomsg _nanomsg;
 398         wxSizer* _sizer;
 399 };
 400
 401
 402 static const wxCmdLineEntryDesc command_line_description[] = {
 403         { wxCMD_LINE_OPTION, "d", "dcp", "DCP to write", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
 404         { wxCMD_LINE_SWITCH, "s", "sure", "skip alpha test warnings", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
 405         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
 406 };
 407
 408
 409 class App : public wxApp
 410 {
 411 public:
 412         App ()
 413                 : _frame (nullptr)
 414         {}
 415
 416         bool OnInit ()
 417         {
 418                 try {
 419                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
 420                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
 421
 422                         SetAppName (_("DCP-o-matic Disk Writer"));
 423
 424                         if (!wxApp::OnInit()) {
 425                                 return false;
 426                         }
 427
 428 #ifdef DCPOMATIC_LINUX
 429                         unsetenv ("UBUNTU_MENUPROXY");
 430 #endif
 431
 432 #ifdef DCPOMATIC_OSX
 433                         dcpomatic_sleep_seconds (1);
 434                         make_foreground_application ();
 435 #endif
 436
 437                         dcpomatic_setup_path_encoding ();
 438
 439                         /* Enable i18n; this will create a Config object
 440                            to look for a force-configured language.  This Config
 441                            object will be wrong, however, because dcpomatic_setup
 442                            hasn't yet been called and there aren't any filters etc.
 443                            set up yet.
 444                         */
 445                         dcpomatic_setup_i18n ();
 446
 447                         /* Set things up, including filters etc.
 448                            which will now be internationalised correctly.
 449                         */
 450                         dcpomatic_setup ();
 451
 452                         /* Force the configuration to be re-loaded correctly next
 453                            time it is needed.
 454                         */
 455                         Config::drop ();
 456
 457                         if (!_skip_alpha_check) {
 458                                 auto warning = new DiskWarningDialog ();
 459                                 warning->ShowModal ();
 460                                 if (!warning->confirmed()) {
 461                                         return false;
 462                                 }
 463                                 warning->Destroy ();
 464                         }
 465
 466                         _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
 467                         SetTopWindow (_frame);
 468
 469                         _frame->Show ();
 470
 471                         if (_dcp_to_write) {
 472                                 _frame->set_dcp (*_dcp_to_write);
 473                         }
 474
 475                         signal_manager = new wxSignalManager (this);
 476                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
 477                 }
 478                 catch (exception& e)
 479                 {
 480                         error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
 481                         return false;
 482                 }
 483
 484                 return true;
 485         }
 486
 487         void OnInitCmdLine (wxCmdLineParser& parser)
 488         {
 489                 parser.SetDesc (command_line_description);
 490                 parser.SetSwitchChars (wxT ("-"));
 491         }
 492
 493         bool OnCmdLineParsed (wxCmdLineParser& parser)
 494         {
 495                 _skip_alpha_check = parser.Found(wxT("sure"));
 496
 497                 wxString dcp;
 498                 if (parser.Found(wxT("dcp"), &dcp)) {
 499                         _dcp_to_write = wx_to_std (dcp);
 500                 }
 501
 502                 return true;
 503         }
 504
 505         void config_failed_to_load ()
 506         {
 507                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
 508         }
 509
 510         void config_warning (string m)
 511         {
 512                 message_dialog (_frame, std_to_wx(m));
 513         }
 514
 515         void idle (wxIdleEvent& ev)
 516         {
 517                 signal_manager->ui_idle ();
 518                 ev.Skip ();
 519         }
 520
 521         void report_exception ()
 522         {
 523                 try {
 524                         throw;
 525                 } catch (FileError& e) {
 526                         error_dialog (
 527                                 0,
 528                                 wxString::Format (
 529                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
 530                                         std_to_wx (e.what()),
 531                                         std_to_wx (e.file().string().c_str ())
 532                                         )
 533                                 );
 534                 } catch (exception& e) {
 535                         error_dialog (
 536                                 0,
 537                                 wxString::Format (
 538                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
 539                                         std_to_wx (e.what ())
 540                                         )
 541                                 );
 542                 } catch (...) {
 543                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 544                 }
 545         }
 546
 547         bool OnExceptionInMainLoop ()
 548         {
 549                 report_exception ();
 550                 /* This will terminate the program */
 551                 return false;
 552         }
 553
 554         void OnUnhandledException ()
 555         {
 556                 report_exception ();
 557         }
 558
 559         DOMFrame* _frame;
 560         bool _skip_alpha_check = false;
 561         boost::optional<boost::filesystem::path> _dcp_to_write;
 562 };
 563
 564 IMPLEMENT_APP (App)