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                 bool have_writer = true;
 253                 if (!_nanomsg.send(DISK_WRITER_PING "\n", 2000)) {
 254                         LOG_DISK_NC("Could not send ping to writer");
 255                         have_writer = false;
 256                 } else {
 257                         auto reply = _nanomsg.receive (2000);
 258                         if (!reply) {
 259                                 LOG_DISK_NC("No reply received from ping");
 260                                 have_writer = false;
 261                         } else if (*reply != DISK_WRITER_PONG) {
 262                                 LOG_DISK_NC("Unexpected response to ping received");
 263                                 have_writer = false;
 264                         }
 265                 }
 266
 267                 if (!have_writer) {
 268 #ifdef DCPOMATIC_WINDOWS
 269                         auto m = new MessageDialog (
 270                                 this,
 271                                 _("DCP-o-matic Disk Writer"),
 272                                 _("Do you see a 'User Account Control' dialogue asking about dcpomatic2_disk_writer.exe?  If so, click 'Yes', then try again.")
 273                                 );
 274                         m->ShowModal ();
 275                         m->Destroy ();
 276                         return;
 277 #else
 278                         LOG_DISK_NC ("Failed to ping writer");
 279                         throw CommunicationFailedError ();
 280 #endif
 281                 }
 282
 283                 auto const& drive = _drives[_drive->GetSelection()];
 284                 if (drive.mounted()) {
 285                         auto d = new TryUnmountDialog(this, drive.description());
 286                         int const r = d->ShowModal ();
 287                         d->Destroy ();
 288                         if (r != wxID_OK) {
 289                                 return;
 290                         }
 291
 292                         LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
 293                         if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
 294                                 LOG_DISK_NC("Failed to send unmount request.");
 295                                 throw CommunicationFailedError ();
 296                         }
 297                         if (!_nanomsg.send(drive.as_xml(), 2000)) {
 298                                 LOG_DISK_NC("Failed to send drive for unmount request.");
 299                                 throw CommunicationFailedError ();
 300                         }
 301                         /* The reply may have to wait for the user to authenticate, so let's wait a while */
 302                         auto reply = _nanomsg.receive (30000);
 303                         if (!reply || *reply != DISK_WRITER_OK) {
 304                                 auto * m = new MessageDialog (
 305                                                 this,
 306                                                 _("DCP-o-matic Disk Writer"),
 307                                                 wxString::Format(_("The drive %s could not be unmounted.\nClose any application that is using it, then try again."), std_to_wx(drive.description()))
 308                                                 );
 309                                 m->ShowModal ();
 310                                 m->Destroy ();
 311                                 return;
 312                         }
 313                 }
 314
 315
 316                 auto * d = new DriveWipeWarningDialog (this, _drive->GetString(_drive->GetSelection()));
 317                 int const r = d->ShowModal ();
 318                 bool ok = r == wxID_OK && d->confirmed();
 319                 d->Destroy ();
 320
 321                 if (!ok) {
 322                         return;
 323                 }
 324
 325                 JobManager::instance()->add(make_shared<CopyToDriveJob>(*_dcp_path, _drives[_drive->GetSelection()], _nanomsg));
 326                 setup_sensitivity ();
 327         }
 328
 329         void drive_refresh ()
 330         {
 331                 int const sel = _drive->GetSelection ();
 332                 wxString current;
 333                 if (sel != wxNOT_FOUND) {
 334                         current = _drive->GetString (sel);
 335                 }
 336                 _drive->Clear ();
 337                 int re_select = wxNOT_FOUND;
 338                 int j = 0;
 339                 _drives = Drive::get ();
 340                 for (auto i: _drives) {
 341                         auto const s = std_to_wx(i.description());
 342                         if (s == current) {
 343                                 re_select = j;
 344                         }
 345                         _drive->Append(s);
 346                         ++j;
 347                 }
 348                 _drive->SetSelection (re_select);
 349                 setup_sensitivity ();
 350         }
 351
 352         void setup_sensitivity ()
 353         {
 354                 _copy->Enable (static_cast<bool>(_dcp_path) && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
 355         }
 356
 357         wxStaticText* _dcp_name;
 358         wxButton* _dcp_open;
 359         wxChoice* _drive;
 360         wxButton* _drive_refresh;
 361         wxButton* _copy;
 362         JobManagerView* _jobs;
 363         boost::optional<boost::filesystem::path> _dcp_path;
 364         std::vector<Drive> _drives;
 365 #ifndef DCPOMATIC_OSX
 366         boost::process::child* _writer;
 367 #endif
 368         Nanomsg _nanomsg;
 369         wxSizer* _sizer;
 370 };
 371
 372
 373 class App : public wxApp
 374 {
 375 public:
 376         App ()
 377                 : _frame (0)
 378         {}
 379
 380         bool OnInit ()
 381         {
 382                 try {
 383                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
 384                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
 385
 386                         SetAppName (_("DCP-o-matic Disk Writer"));
 387
 388                         if (!wxApp::OnInit()) {
 389                                 return false;
 390                         }
 391
 392 #ifdef DCPOMATIC_LINUX
 393                         unsetenv ("UBUNTU_MENUPROXY");
 394 #endif
 395
 396 #ifdef DCPOMATIC_OSX
 397                         dcpomatic_sleep_seconds (1);
 398                         make_foreground_application ();
 399 #endif
 400
 401                         dcpomatic_setup_path_encoding ();
 402
 403                         /* Enable i18n; this will create a Config object
 404                            to look for a force-configured language.  This Config
 405                            object will be wrong, however, because dcpomatic_setup
 406                            hasn't yet been called and there aren't any filters etc.
 407                            set up yet.
 408                         */
 409                         dcpomatic_setup_i18n ();
 410
 411                         /* Set things up, including filters etc.
 412                            which will now be internationalised correctly.
 413                         */
 414                         dcpomatic_setup ();
 415
 416                         /* Force the configuration to be re-loaded correctly next
 417                            time it is needed.
 418                         */
 419                         Config::drop ();
 420
 421                         auto warning = new DiskWarningDialog ();
 422                         warning->ShowModal ();
 423                         if (!warning->confirmed()) {
 424                                 return false;
 425                         }
 426                         warning->Destroy ();
 427
 428                         _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
 429                         SetTopWindow (_frame);
 430
 431                         _frame->Show ();
 432
 433                         signal_manager = new wxSignalManager (this);
 434                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
 435                 }
 436                 catch (exception& e)
 437                 {
 438                         error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
 439                         return false;
 440                 }
 441
 442                 return true;
 443         }
 444
 445         void config_failed_to_load ()
 446         {
 447                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
 448         }
 449
 450         void config_warning (string m)
 451         {
 452                 message_dialog (_frame, std_to_wx(m));
 453         }
 454
 455         void idle (wxIdleEvent& ev)
 456         {
 457                 signal_manager->ui_idle ();
 458                 ev.Skip ();
 459         }
 460
 461         void report_exception ()
 462         {
 463                 try {
 464                         throw;
 465                 } catch (FileError& e) {
 466                         error_dialog (
 467                                 0,
 468                                 wxString::Format (
 469                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
 470                                         std_to_wx (e.what()),
 471                                         std_to_wx (e.file().string().c_str ())
 472                                         )
 473                                 );
 474                 } catch (exception& e) {
 475                         error_dialog (
 476                                 0,
 477                                 wxString::Format (
 478                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
 479                                         std_to_wx (e.what ())
 480                                         )
 481                                 );
 482                 } catch (...) {
 483                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 484                 }
 485         }
 486
 487         bool OnExceptionInMainLoop ()
 488         {
 489                 report_exception ();
 490                 /* This will terminate the program */
 491                 return false;
 492         }
 493
 494         void OnUnhandledException ()
 495         {
 496                 report_exception ();
 497         }
 498
 499         DOMFrame* _frame;
 500 };
 501
 502 IMPLEMENT_APP (App)