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