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