src/tools/dcpomatic_disk.cc

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