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