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 = 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);
 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                 auto result = notify_post ("com.dcpomatic.disk.writer.start");
 171                 if (result != NOTIFY_STATUS_OK ) {
 172                         LOG_DISK("Notification did not return OK: %1", result);
 173                         switch (result) {
 174                         case NOTIFY_STATUS_INVALID_NAME:
 175                                 LOG_DISK_NC("i.e. INVALID_NAME");
 176                                 break;
 177                         case NOTIFY_STATUS_FAILED:
 178                                 LOG_DISK_NC("i.e. FAILED");
 179                                 break;
 180                         case NOTIFY_STATUS_NOT_AUTHORIZED:
 181                                 LOG_DISK_NC("i.e. NOT_AUTHORIZED");
 182                                 break;
 183                         }
 184                 }
 185 #endif
 186         }
 187
 188         ~DOMFrame ()
 189         {
 190                 _nanomsg.send(DISK_WRITER_QUIT "\n", 2000);
 191                 /* This seems really horrible but it's suggested by the examples on nanomsg.org, so...
 192                  * Without this the quit is not received (at least sometimes) causing #2018.
 193                  */
 194                 dcpomatic_sleep_seconds (1);
 195         }
 196
 197         void set_dcp (boost::filesystem::path dcp)
 198         {
 199                 if (!boost::filesystem::exists(dcp / "ASSETMAP") && !boost::filesystem::exists(dcp / "ASSETMAP.xml")) {
 200                         error_dialog (nullptr, _("No ASSETMAP or ASSETMAP.xml found in this folder.  Please choose a DCP folder."));
 201                         return;
 202                 }
 203
 204                 _dcp_path = dcp;
 205                 _dcp_name->SetLabel (std_to_wx(dcp.filename().string()));
 206         }
 207
 208 private:
 209         void sized (wxSizeEvent& ev)
 210         {
 211                 _sizer->Layout ();
 212                 ev.Skip ();
 213         }
 214
 215
 216 #ifdef DCPOMATIC_OSX
 217         void uninstall()
 218         {
 219                 system(String::compose("osascript \"%1/uninstall_disk.applescript\"", resources_path().string()).c_str());
 220         }
 221 #endif
 222
 223
 224         bool should_close ()
 225         {
 226                 if (!JobManager::instance()->work_to_do()) {
 227                         return true;
 228                 }
 229
 230                 auto d = new wxMessageDialog (
 231                         0,
 232                         _("There are unfinished jobs; are you sure you want to quit?"),
 233                         _("Unfinished jobs"),
 234                         wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
 235                         );
 236
 237                 bool const r = d->ShowModal() == wxID_YES;
 238                 d->Destroy ();
 239                 return r;
 240         }
 241
 242
 243         void close (wxCloseEvent& ev)
 244         {
 245                 if (!should_close()) {
 246                         ev.Veto ();
 247                         return;
 248                 }
 249
 250                 ev.Skip ();
 251         }
 252
 253
 254         void open ()
 255         {
 256                 auto d = new wxDirDialog (this, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
 257                 int r = d->ShowModal ();
 258                 boost::filesystem::path const path (wx_to_std(d->GetPath()));
 259                 d->Destroy ();
 260
 261                 if (r != wxID_OK) {
 262                         return;
 263                 }
 264
 265                 set_dcp (path);
 266                 setup_sensitivity ();
 267         }
 268
 269         void copy ()
 270         {
 271                 /* Check that the selected drive still exists and update its properties if so */
 272                 drive_refresh ();
 273                 if (_drive->GetSelection() == wxNOT_FOUND) {
 274                         error_dialog (this, _("The disk you selected is no longer available.  Please choose another."));
 275                         return;
 276                 }
 277
 278                 DCPOMATIC_ASSERT (_drive->GetSelection() != wxNOT_FOUND);
 279                 DCPOMATIC_ASSERT (static_cast<bool>(_dcp_path));
 280
 281                 auto ping = [this](int attempt) {
 282                         if (_nanomsg.send(DISK_WRITER_PING "\n", 1000)) {
 283                                 auto reply = _nanomsg.receive (1000);
 284                                 if (reply && *reply == DISK_WRITER_PONG) {
 285                                         return true;
 286                                 } else if (reply) {
 287                                         LOG_DISK("Unexpected response %1 to ping received (attempt %2)", *reply, attempt);
 288                                 } else {
 289                                         LOG_DISK("No reply received from ping (attempt %1)", attempt);
 290                                 }
 291                         } else {
 292                                 LOG_DISK("Could not send ping to writer (attempt %1)", attempt);
 293                         }
 294                         dcpomatic_sleep_seconds (1);
 295                         return false;
 296                 };
 297
 298                 bool have_writer = false;
 299                 for (int i = 0; i < 8; ++i) {
 300                         if (ping(i + 1)) {
 301                                 have_writer = true;
 302                                 break;
 303                         }
 304                 }
 305
 306                 if (!have_writer) {
 307 #if defined(DCPOMATIC_WINDOWS)
 308                         auto m = new MessageDialog (
 309                                 this,
 310                                 _("DCP-o-matic Disk Writer"),
 311                                 _("Do you see a 'User Account Control' dialogue asking about dcpomatic2_disk_writer.exe?  If so, click 'Yes', then try again.")
 312                                 );
 313                         m->ShowModal ();
 314                         m->Destroy ();
 315                         return;
 316 #elif defined(DCPOMATIC_OSX)
 317                         auto m = new MessageDialog (
 318                                 this,
 319                                 _("DCP-o-matic Disk Writer"),
 320                                 _("Did you install the DCP-o-matic Disk Writer.pkg from the .dmg?  Please check and try again.")
 321                                 );
 322                         m->ShowModal ();
 323                         m->Destroy ();
 324                         return;
 325 #else
 326                         LOG_DISK_NC ("Failed to ping writer");
 327                         throw CommunicationFailedError ();
 328 #endif
 329                 }
 330
 331                 auto const& drive = _drives[_drive->GetSelection()];
 332                 if (drive.mounted()) {
 333                         auto d = new TryUnmountDialog(this, drive.description());
 334                         int const r = d->ShowModal ();
 335                         d->Destroy ();
 336                         if (r != wxID_OK) {
 337                                 return;
 338                         }
 339
 340                         LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
 341                         if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
 342                                 LOG_DISK_NC("Failed to send unmount request.");
 343                                 throw CommunicationFailedError ();
 344                         }
 345                         if (!_nanomsg.send(drive.as_xml(), 2000)) {
 346                                 LOG_DISK_NC("Failed to send drive for unmount request.");
 347                                 throw CommunicationFailedError ();
 348                         }
 349                         /* The reply may have to wait for the user to authenticate, so let's wait a while */
 350                         auto reply = _nanomsg.receive (30000);
 351                         if (!reply || *reply != DISK_WRITER_OK) {
 352                                 auto * m = new MessageDialog (
 353                                                 this,
 354                                                 _("DCP-o-matic Disk Writer"),
 355                                                 wxString::Format(_("The drive %s could not be unmounted.\nClose any application that is using it, then try again."), std_to_wx(drive.description()))
 356                                                 );
 357                                 m->ShowModal ();
 358                                 m->Destroy ();
 359                                 return;
 360                         }
 361                 }
 362
 363
 364                 auto * d = new DriveWipeWarningDialog (this, _drive->GetString(_drive->GetSelection()));
 365                 int const r = d->ShowModal ();
 366                 bool ok = r == wxID_OK && d->confirmed();
 367                 d->Destroy ();
 368
 369                 if (!ok) {
 370                         return;
 371                 }
 372
 373                 JobManager::instance()->add(make_shared<CopyToDriveJob>(*_dcp_path, _drives[_drive->GetSelection()], _nanomsg));
 374                 setup_sensitivity ();
 375         }
 376
 377         void drive_refresh ()
 378         {
 379                 int const sel = _drive->GetSelection ();
 380                 wxString current;
 381                 if (sel != wxNOT_FOUND) {
 382                         current = _drive->GetString (sel);
 383                 }
 384                 _drive->Clear ();
 385                 int re_select = wxNOT_FOUND;
 386                 int j = 0;
 387                 _drives = Drive::get ();
 388                 for (auto i: _drives) {
 389                         auto const s = std_to_wx(i.description());
 390                         if (s == current) {
 391                                 re_select = j;
 392                         }
 393                         _drive->Append(s);
 394                         ++j;
 395                 }
 396                 _drive->SetSelection (re_select);
 397                 setup_sensitivity ();
 398         }
 399
 400         void setup_sensitivity ()
 401         {
 402                 _copy->Enable (static_cast<bool>(_dcp_path) && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
 403         }
 404
 405         wxStaticText* _dcp_name;
 406         wxButton* _dcp_open;
 407         wxChoice* _drive;
 408         wxButton* _drive_refresh;
 409         wxButton* _copy;
 410         JobManagerView* _jobs;
 411         boost::optional<boost::filesystem::path> _dcp_path;
 412         std::vector<Drive> _drives;
 413 #ifndef DCPOMATIC_OSX
 414         boost::process::child* _writer;
 415 #endif
 416         Nanomsg _nanomsg;
 417         wxSizer* _sizer;
 418 };
 419
 420
 421 static const wxCmdLineEntryDesc command_line_description[] = {
 422         { wxCMD_LINE_OPTION, "d", "dcp", "DCP to write", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
 423         { wxCMD_LINE_SWITCH, "s", "sure", "skip alpha test warnings", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
 424         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
 425 };
 426
 427
 428 class App : public wxApp
 429 {
 430 public:
 431         App ()
 432                 : _frame (nullptr)
 433         {}
 434
 435         bool OnInit ()
 436         {
 437                 try {
 438                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
 439                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
 440
 441                         SetAppName (_("DCP-o-matic Disk Writer"));
 442
 443                         if (!wxApp::OnInit()) {
 444                                 return false;
 445                         }
 446
 447 #ifdef DCPOMATIC_LINUX
 448                         unsetenv ("UBUNTU_MENUPROXY");
 449 #endif
 450
 451 #ifdef DCPOMATIC_OSX
 452                         dcpomatic_sleep_seconds (1);
 453                         make_foreground_application ();
 454 #endif
 455
 456                         dcpomatic_setup_path_encoding ();
 457
 458                         /* Enable i18n; this will create a Config object
 459                            to look for a force-configured language.  This Config
 460                            object will be wrong, however, because dcpomatic_setup
 461                            hasn't yet been called and there aren't any filters etc.
 462                            set up yet.
 463                         */
 464                         dcpomatic_setup_i18n ();
 465
 466                         /* Set things up, including filters etc.
 467                            which will now be internationalised correctly.
 468                         */
 469                         dcpomatic_setup ();
 470
 471                         /* Force the configuration to be re-loaded correctly next
 472                            time it is needed.
 473                         */
 474                         Config::drop ();
 475
 476                         if (!_skip_alpha_check) {
 477                                 auto warning = new DiskWarningDialog ();
 478                                 warning->ShowModal ();
 479                                 if (!warning->confirmed()) {
 480                                         return false;
 481                                 }
 482                                 warning->Destroy ();
 483                         }
 484
 485                         _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
 486                         SetTopWindow (_frame);
 487
 488                         _frame->Show ();
 489
 490                         if (_dcp_to_write) {
 491                                 _frame->set_dcp (*_dcp_to_write);
 492                         }
 493
 494                         signal_manager = new wxSignalManager (this);
 495                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
 496                 }
 497                 catch (exception& e)
 498                 {
 499                         error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
 500                         return false;
 501                 }
 502
 503                 return true;
 504         }
 505
 506         void OnInitCmdLine (wxCmdLineParser& parser)
 507         {
 508                 parser.SetDesc (command_line_description);
 509                 parser.SetSwitchChars (wxT ("-"));
 510         }
 511
 512         bool OnCmdLineParsed (wxCmdLineParser& parser)
 513         {
 514                 _skip_alpha_check = parser.Found(wxT("sure"));
 515
 516                 wxString dcp;
 517                 if (parser.Found(wxT("dcp"), &dcp)) {
 518                         _dcp_to_write = wx_to_std (dcp);
 519                 }
 520
 521                 return true;
 522         }
 523
 524         void config_failed_to_load ()
 525         {
 526                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
 527         }
 528
 529         void config_warning (string m)
 530         {
 531                 message_dialog (_frame, std_to_wx(m));
 532         }
 533
 534         void idle (wxIdleEvent& ev)
 535         {
 536                 signal_manager->ui_idle ();
 537                 ev.Skip ();
 538         }
 539
 540         void report_exception ()
 541         {
 542                 try {
 543                         throw;
 544                 } catch (FileError& e) {
 545                         error_dialog (
 546                                 0,
 547                                 wxString::Format (
 548                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
 549                                         std_to_wx (e.what()),
 550                                         std_to_wx (e.file().string().c_str ())
 551                                         )
 552                                 );
 553                 } catch (exception& e) {
 554                         error_dialog (
 555                                 0,
 556                                 wxString::Format (
 557                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
 558                                         std_to_wx (e.what ())
 559                                         )
 560                                 );
 561                 } catch (...) {
 562                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 563                 }
 564         }
 565
 566         bool OnExceptionInMainLoop ()
 567         {
 568                 report_exception ();
 569                 /* This will terminate the program */
 570                 return false;
 571         }
 572
 573         void OnUnhandledException ()
 574         {
 575                 report_exception ();
 576         }
 577
 578         DOMFrame* _frame;
 579         bool _skip_alpha_check = false;
 580         boost::optional<boost::filesystem::path> _dcp_to_write;
 581 };
 582
 583 IMPLEMENT_APP (App)