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