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