src/tools/dcpomatic_disk.cc

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