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 <notify.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                 Bind (wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
 122
 123                 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
 124
 125 #ifdef DCPOMATIC_WINDOWS
 126                 /* We must use ::shell here, it seems, to avoid error code 740 (related to privilege escalation) */
 127                 LOG_DISK("Starting writer process %1", disk_writer_path().string());
 128                 _writer = new boost::process::child (disk_writer_path(), boost::process::shell, boost::process::windows::hide);
 129 #endif
 130
 131 #ifdef DCPOMATIC_LINUX
 132                 if (getenv("DCPOMATIC_NO_START_WRITER")) {
 133                         LOG_DISK_NC("Not starting writer process as DCPOMATIC_NO_START_WRITER is set");
 134                 } else {
 135                         LOG_DISK("Starting writer process %1", disk_writer_path().string());
 136                         _writer = new boost::process::child (disk_writer_path());
 137                 }
 138 #endif
 139
 140 #ifdef DCPOMATIC_OSX
 141                 LOG_DISK_NC("Sending notification to writer daemon");
 142                 notify_post ("com.dcpomatic.disk.writer.start");
 143 #endif
 144         }
 145
 146         ~DOMFrame ()
 147         {
 148                 _nanomsg.send(DISK_WRITER_QUIT "\n", 2000);
 149         }
 150
 151 private:
 152         void sized (wxSizeEvent& ev)
 153         {
 154                 _sizer->Layout ();
 155                 ev.Skip ();
 156         }
 157
 158
 159         bool should_close ()
 160         {
 161                 if (!JobManager::instance()->work_to_do()) {
 162                         return true;
 163                 }
 164
 165                 wxMessageDialog* d = new wxMessageDialog (
 166                         0,
 167                         _("There are unfinished jobs; are you sure you want to quit?"),
 168                         _("Unfinished jobs"),
 169                         wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
 170                         );
 171
 172                 bool const r = d->ShowModal() == wxID_YES;
 173                 d->Destroy ();
 174                 return r;
 175         }
 176
 177
 178         void close (wxCloseEvent& ev)
 179         {
 180                 if (!should_close()) {
 181                         ev.Veto ();
 182                         return;
 183                 }
 184
 185                 ev.Skip ();
 186         }
 187
 188
 189         void open ()
 190         {
 191                 wxDirDialog* d = new wxDirDialog (this, _("Choose a DCP folder"), wxT(""), wxDD_DIR_MUST_EXIST);
 192                 int r = d->ShowModal ();
 193                 boost::filesystem::path const path (wx_to_std(d->GetPath()));
 194                 d->Destroy ();
 195
 196                 if (r != wxID_OK) {
 197                         return;
 198                 }
 199
 200                 _dcp_path = path;
 201                 _dcp_name->SetLabel (std_to_wx(_dcp_path->filename().string()));
 202                 setup_sensitivity ();
 203         }
 204
 205         void copy ()
 206         {
 207                 DCPOMATIC_ASSERT (_drive->GetSelection() != wxNOT_FOUND);
 208                 DCPOMATIC_ASSERT (static_cast<bool>(_dcp_path));
 209
 210                 Drive const& drive = _drives[_drive->GetSelection()];
 211                 if (drive.mounted()) {
 212                         TryUnmountDialog* d = new TryUnmountDialog(this, drive.description());
 213                         int const r = d->ShowModal ();
 214                         d->Destroy ();
 215                         if (r != wxID_OK) {
 216                                 return;
 217                         }
 218
 219                         LOG_DISK("Sending unmount request to disk writer for %1", drive.as_xml());
 220                         if (!_nanomsg.send(DISK_WRITER_UNMOUNT "\n", 2000)) {
 221                                 throw CommunicationFailedError ();
 222                         }
 223                         if (!_nanomsg.send(drive.as_xml(), 2000)) {
 224                                 throw CommunicationFailedError ();
 225                         }
 226                         optional<string> reply = _nanomsg.receive (2000);
 227                         if (!reply || *reply != DISK_WRITER_OK) {
 228                                 MessageDialog* m = new MessageDialog (
 229                                                 this,
 230                                                 _("DCP-o-matic Disk Writer"),
 231                                                 wxString::Format(_("The drive %s could not be unmounted.\nClose any application that is using it, then try again."), std_to_wx(drive.description()))
 232                                                 );
 233                                 m->ShowModal ();
 234                                 m->Destroy ();
 235                                 return;
 236                         }
 237                 }
 238
 239
 240                 DriveWipeWarningDialog* d = new DriveWipeWarningDialog (this, _drive->GetString(_drive->GetSelection()));
 241                 int const r = d->ShowModal ();
 242                 bool ok = r == wxID_OK && d->confirmed();
 243                 d->Destroy ();
 244
 245                 if (!ok) {
 246                         return;
 247                 }
 248
 249                 JobManager::instance()->add(shared_ptr<Job>(new CopyToDriveJob(*_dcp_path, _drives[_drive->GetSelection()], _nanomsg)));
 250                 setup_sensitivity ();
 251         }
 252
 253         void drive_refresh ()
 254         {
 255                 int const sel = _drive->GetSelection ();
 256                 wxString current;
 257                 if (sel != wxNOT_FOUND) {
 258                         current = _drive->GetString (sel);
 259                 }
 260                 _drive->Clear ();
 261                 int re_select = wxNOT_FOUND;
 262                 int j = 0;
 263                 _drives = Drive::get ();
 264                 BOOST_FOREACH (Drive i, _drives) {
 265                         wxString const s = std_to_wx(i.description());
 266                         if (s == current) {
 267                                 re_select = j;
 268                         }
 269                         _drive->Append(s);
 270                         ++j;
 271                 }
 272                 _drive->SetSelection (re_select);
 273                 setup_sensitivity ();
 274         }
 275
 276         void setup_sensitivity ()
 277         {
 278                 _copy->Enable (static_cast<bool>(_dcp_path) && _drive->GetSelection() != wxNOT_FOUND && !JobManager::instance()->work_to_do());
 279         }
 280
 281         wxStaticText* _dcp_name;
 282         wxButton* _dcp_open;
 283         wxChoice* _drive;
 284         wxButton* _drive_refresh;
 285         wxButton* _copy;
 286         JobManagerView* _jobs;
 287         boost::optional<boost::filesystem::path> _dcp_path;
 288         std::vector<Drive> _drives;
 289 #ifndef DCPOMATIC_OSX
 290         boost::process::child* _writer;
 291 #endif
 292         Nanomsg _nanomsg;
 293         wxSizer* _sizer;
 294 };
 295
 296 class App : public wxApp
 297 {
 298 public:
 299         App ()
 300                 : _frame (0)
 301         {}
 302
 303         bool OnInit ()
 304         {
 305                 try {
 306                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
 307                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
 308
 309                         SetAppName (_("DCP-o-matic Disk Writer"));
 310
 311                         if (!wxApp::OnInit()) {
 312                                 return false;
 313                         }
 314
 315 #ifdef DCPOMATIC_LINUX
 316                         unsetenv ("UBUNTU_MENUPROXY");
 317 #endif
 318
 319 #ifdef DCPOMATIC_OSX
 320                         make_foreground_application ();
 321 #endif
 322
 323                         dcpomatic_setup_path_encoding ();
 324
 325                         /* Enable i18n; this will create a Config object
 326                            to look for a force-configured language.  This Config
 327                            object will be wrong, however, because dcpomatic_setup
 328                            hasn't yet been called and there aren't any filters etc.
 329                            set up yet.
 330                         */
 331                         dcpomatic_setup_i18n ();
 332
 333                         /* Set things up, including filters etc.
 334                            which will now be internationalised correctly.
 335                         */
 336                         dcpomatic_setup ();
 337
 338                         /* Force the configuration to be re-loaded correctly next
 339                            time it is needed.
 340                         */
 341                         Config::drop ();
 342
 343                         DiskWarningDialog* warning = new DiskWarningDialog ();
 344                         warning->ShowModal ();
 345                         if (!warning->confirmed()) {
 346                                 return false;
 347                         }
 348                         warning->Destroy ();
 349
 350                         _frame = new DOMFrame (_("DCP-o-matic Disk Writer"));
 351                         SetTopWindow (_frame);
 352
 353                         _frame->Show ();
 354
 355                         signal_manager = new wxSignalManager (this);
 356                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
 357                 }
 358                 catch (exception& e)
 359                 {
 360                         error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
 361                         return false;
 362                 }
 363
 364                 return true;
 365         }
 366
 367         void config_failed_to_load ()
 368         {
 369                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
 370         }
 371
 372         void config_warning (string m)
 373         {
 374                 message_dialog (_frame, std_to_wx(m));
 375         }
 376
 377         void idle (wxIdleEvent& ev)
 378         {
 379                 signal_manager->ui_idle ();
 380                 ev.Skip ();
 381         }
 382
 383         void report_exception ()
 384         {
 385                 try {
 386                         throw;
 387                 } catch (FileError& e) {
 388                         error_dialog (
 389                                 0,
 390                                 wxString::Format (
 391                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
 392                                         std_to_wx (e.what()),
 393                                         std_to_wx (e.file().string().c_str ())
 394                                         )
 395                                 );
 396                 } catch (exception& e) {
 397                         error_dialog (
 398                                 0,
 399                                 wxString::Format (
 400                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
 401                                         std_to_wx (e.what ())
 402                                         )
 403                                 );
 404                 } catch (...) {
 405                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
 406                 }
 407         }
 408
 409         bool OnExceptionInMainLoop ()
 410         {
 411                 report_exception ();
 412                 /* This will terminate the program */
 413                 return false;
 414         }
 415
 416         void OnUnhandledException ()
 417         {
 418                 report_exception ();
 419         }
 420
 421         DOMFrame* _frame;
 422 };
 423
 424 IMPLEMENT_APP (App)