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