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