2 Copyright (C) 2015-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "wx/full_config_dialog.h"
22 #include "wx/about_dialog.h"
23 #include "wx/report_problem_dialog.h"
24 #include "wx/file_picker_ctrl.h"
25 #include "wx/wx_util.h"
26 #include "wx/wx_signal_manager.h"
27 #include "wx/screens_panel.h"
28 #include "wx/kdm_timing_panel.h"
29 #include "wx/kdm_output_panel.h"
30 #include "wx/job_view_dialog.h"
31 #include "wx/file_dialog_wrapper.h"
32 #include "wx/new_dkdm_folder_dialog.h"
33 #include "wx/editable_list.h"
34 #include "wx/static_text.h"
35 #include "wx/dcpomatic_button.h"
36 #include "wx/nag_dialog.h"
37 #include "lib/config.h"
39 #include "lib/screen.h"
40 #include "lib/job_manager.h"
41 #include "lib/screen_kdm.h"
42 #include "lib/exceptions.h"
43 #include "lib/cinema_kdms.h"
44 #include "lib/send_kdm_email_job.h"
45 #include "lib/compose.hpp"
46 #include "lib/cinema.h"
47 #include "lib/dkdm_wrapper.h"
48 #include "lib/cross.h"
49 #include <dcp/encrypted_kdm.h>
50 #include <dcp/decrypted_kdm.h>
51 #include <dcp/exceptions.h>
53 #include <wx/preferences.h>
54 #include <wx/splash.h>
55 #include <wx/filepicker.h>
57 #include <ApplicationServices/ApplicationServices.h>
59 #include <boost/bind.hpp>
60 #include <boost/foreach.hpp>
72 using boost::shared_ptr;
74 using boost::optional;
76 using boost::dynamic_pointer_cast;
77 using namespace dcpomatic;
80 ID_help_report_a_problem = 1,
83 class DOMFrame : public wxFrame
86 explicit DOMFrame (wxString const & title)
87 : wxFrame (0, -1, title)
91 #if defined(DCPOMATIC_WINDOWS)
92 if (Config::instance()->win32_console ()) {
95 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
96 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
97 FILE* hf_out = _fdopen(hCrt, "w");
98 setvbuf(hf_out, NULL, _IONBF, 1);
101 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
102 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
103 FILE* hf_in = _fdopen(hCrt, "r");
104 setvbuf(hf_in, NULL, _IONBF, 128);
107 std::cout << "DCP-o-matic KDM creator is starting." << "\n";
111 wxMenuBar* bar = new wxMenuBar;
115 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
116 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
117 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
118 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
120 /* Use a panel as the only child of the Frame so that we avoid
121 the dark-grey background on Windows.
123 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
124 wxBoxSizer* main_sizer = new wxBoxSizer (wxHORIZONTAL);
126 wxBoxSizer* horizontal = new wxBoxSizer (wxHORIZONTAL);
127 wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
128 wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
130 horizontal->Add (left, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_X_GAP * 2);
131 horizontal->Add (right, 1, wxEXPAND);
133 wxFont subheading_font (*wxNORMAL_FONT);
134 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
136 wxStaticText* h = new StaticText (overall_panel, _("Screens"));
137 h->SetFont (subheading_font);
138 left->Add (h, 0, wxALIGN_CENTER_VERTICAL | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
139 _screens = new ScreensPanel (overall_panel);
140 left->Add (_screens, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
142 /// TRANSLATORS: translate the word "Timing" here; do not include the "KDM|" prefix
143 h = new StaticText (overall_panel, S_("KDM|Timing"));
144 h->SetFont (subheading_font);
145 right->Add (h, 0, wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_Y_GAP * 2);
146 _timing = new KDMTimingPanel (overall_panel);
147 right->Add (_timing, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
149 h = new StaticText (overall_panel, _("DKDM"));
150 h->SetFont (subheading_font);
151 right->Add (h, 0, wxALIGN_CENTER_VERTICAL | wxTOP, DCPOMATIC_SIZER_Y_GAP * 2);
152 wxBoxSizer* dkdm_sizer = new wxBoxSizer (wxHORIZONTAL);
153 _dkdm = new wxTreeCtrl (
154 overall_panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTR_HIDE_ROOT | wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT
156 dkdm_sizer->Add (_dkdm, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP);
157 wxBoxSizer* dkdm_buttons = new wxBoxSizer(wxVERTICAL);
158 _add_dkdm = new Button (overall_panel, _("Add..."));
159 dkdm_buttons->Add (_add_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
160 _add_dkdm_folder = new Button (overall_panel, _("Add folder..."));
161 dkdm_buttons->Add (_add_dkdm_folder, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
162 _remove_dkdm = new Button (overall_panel, _("Remove"));
163 dkdm_buttons->Add (_remove_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
164 _export_dkdm = new Button (overall_panel, _("Export..."));
165 dkdm_buttons->Add (_export_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
166 dkdm_sizer->Add (dkdm_buttons, 0, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
167 right->Add (dkdm_sizer, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP);
169 add_dkdm_view (Config::instance()->dkdms());
171 h = new StaticText (overall_panel, _("Output"));
172 h->SetFont (subheading_font);
173 right->Add (h, 0, wxALIGN_CENTER_VERTICAL | wxTOP, DCPOMATIC_SIZER_Y_GAP * 2);
174 /* XXX: hard-coded non-interop here */
175 _output = new KDMOutputPanel (overall_panel, false);
176 right->Add (_output, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
178 _create = new Button (overall_panel, _("Create KDMs"));
179 right->Add (_create, 0, wxALL, DCPOMATIC_SIZER_GAP);
181 main_sizer->Add (horizontal, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
182 overall_panel->SetSizer (main_sizer);
184 /* Instantly save any config changes when using a DCP-o-matic GUI */
185 Config::instance()->Changed.connect (boost::bind (&Config::write, Config::instance ()));
187 _screens->ScreensChanged.connect (boost::bind (&DOMFrame::setup_sensitivity, this));
188 _create->Bind (wxEVT_BUTTON, bind (&DOMFrame::create_kdms, this));
189 _dkdm->Bind (wxEVT_TREE_SEL_CHANGED, boost::bind (&DOMFrame::setup_sensitivity, this));
190 _dkdm->Bind (wxEVT_TREE_BEGIN_DRAG, boost::bind (&DOMFrame::dkdm_begin_drag, this, _1));
191 _dkdm->Bind (wxEVT_TREE_END_DRAG, boost::bind (&DOMFrame::dkdm_end_drag, this, _1));
192 _add_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_clicked, this));
193 _add_dkdm_folder->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_folder_clicked, this));
194 _remove_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::remove_dkdm_clicked, this));
195 _export_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::export_dkdm_clicked, this));
197 setup_sensitivity ();
203 /* false here allows the close handler to veto the close request */
207 void edit_preferences ()
209 if (!_config_dialog) {
210 _config_dialog = create_full_config_dialog ();
212 _config_dialog->Show (this);
217 AboutDialog* d = new AboutDialog (this);
222 void help_report_a_problem ()
224 ReportProblemDialog* d = new ReportProblemDialog (this, shared_ptr<Film> ());
225 if (d->ShowModal () == wxID_OK) {
231 void setup_menu (wxMenuBar* m)
233 wxMenu* file = new wxMenu;
236 file->Append (wxID_EXIT, _("&Exit"));
238 file->Append (wxID_EXIT, _("&Quit"));
242 file->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
244 wxMenu* edit = new wxMenu;
245 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
248 wxMenu* help = new wxMenu;
250 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
252 help->Append (wxID_ABOUT, _("About"));
254 help->Append (ID_help_report_a_problem, _("Report a problem..."));
256 m->Append (file, _("&File"));
258 m->Append (edit, _("&Edit"));
260 m->Append (help, _("&Help"));
263 bool confirm_overwrite (boost::filesystem::path path)
265 return confirm_dialog (
267 wxString::Format (_("File %s already exists. Do you want to overwrite it?"), std_to_wx(path.string()).data())
271 /** @id if not 0 this is filled in with the wxTreeItemId of the selection */
272 shared_ptr<DKDMBase> selected_dkdm (wxTreeItemId* id = 0) const
274 wxArrayTreeItemIds selections;
275 _dkdm->GetSelections (selections);
276 if (selections.GetCount() != 1) {
280 return shared_ptr<DKDMBase> ();
287 DKDMMap::const_iterator i = _dkdm_id.find (selections[0]);
288 if (i == _dkdm_id.end()) {
289 return shared_ptr<DKDMBase> ();
298 shared_ptr<DKDMBase> dkdm_base = selected_dkdm ();
302 shared_ptr<DKDM> dkdm = boost::dynamic_pointer_cast<DKDM> (dkdm_base);
307 /* Decrypt the DKDM */
308 dcp::DecryptedKDM decrypted (dkdm->dkdm(), Config::instance()->decryption_chain()->key().get());
310 /* This is the signer for our new KDMs */
311 shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
312 if (!signer->valid ()) {
313 throw InvalidSignerError ();
316 list<ScreenKDM> screen_kdms;
317 BOOST_FOREACH (shared_ptr<Screen> i, _screens->screens()) {
323 /* Make an empty KDM */
324 dcp::DecryptedKDM kdm (
325 dcp::LocalTime (_timing->from(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
326 dcp::LocalTime (_timing->until(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
327 decrypted.annotation_text().get_value_or (""),
328 decrypted.content_title_text(),
329 dcp::LocalTime().as_string()
332 /* Add keys from the DKDM */
333 BOOST_FOREACH (dcp::DecryptedKDMKey const & j, decrypted.keys()) {
338 screen_kdms.push_back (
342 signer, i->recipient.get(), i->trusted_device_thumbprints(), _output->formulation(),
343 !_output->forensic_mark_video(), _output->forensic_mark_audio() ? boost::optional<int>() : 0
349 pair<shared_ptr<Job>, int> result = _output->make (
350 screen_kdms, decrypted.content_title_text(), _timing, bind (&DOMFrame::confirm_overwrite, this, _1)
354 JobManager::instance()->add (result.first);
356 _job_view->Destroy ();
359 _job_view = new JobViewDialog (this, _("Send KDM emails"), result.first);
360 _job_view->ShowModal ();
363 if (result.second > 0) {
364 /* XXX: proper plural form support in wxWidgets? */
365 wxString s = result.second == 1 ? _("%d KDM written to %s") : _("%d KDMs written to %s");
368 wxString::Format (s, result.second, std_to_wx(_output->directory().string()).data())
371 } catch (dcp::NotEncryptedError& e) {
372 error_dialog (this, _("CPL's content is not encrypted."));
373 } catch (exception& e) {
374 error_dialog (this, std_to_wx(e.what()));
376 error_dialog (this, _("An unknown exception occurred."));
380 void setup_sensitivity ()
382 _screens->setup_sensitivity ();
383 _output->setup_sensitivity ();
384 wxArrayTreeItemIds sel;
385 _dkdm->GetSelections (sel);
386 shared_ptr<DKDMGroup> group = dynamic_pointer_cast<DKDMGroup>(selected_dkdm());
387 shared_ptr<DKDM> dkdm = dynamic_pointer_cast<DKDM>(selected_dkdm());
388 _create->Enable (!_screens->screens().empty() && sel.GetCount() > 0);
389 _remove_dkdm->Enable (sel.GetCount() > 0 && (!group || group->name() != "root"));
390 _export_dkdm->Enable (sel.GetCount() > 0 && dkdm);
393 void dkdm_begin_drag (wxTreeEvent& ev)
398 void dkdm_end_drag (wxTreeEvent& ev)
400 DKDMMap::iterator from = _dkdm_id.find (_dkdm->GetSelection ());
401 DKDMMap::iterator to = _dkdm_id.find (ev.GetItem ());
402 if (from == _dkdm_id.end() || to == _dkdm_id.end() || from->first == to->first) {
406 shared_ptr<DKDMGroup> group = dynamic_pointer_cast<DKDMGroup> (to->second);
408 group = to->second->parent();
411 DCPOMATIC_ASSERT (group);
412 DCPOMATIC_ASSERT (from->second->parent ());
414 from->second->parent()->remove (from->second);
415 add_dkdm_model (from->second, group, dynamic_pointer_cast<DKDM>(to->second));
417 _dkdm->Delete (from->first);
418 _dkdm_id.erase (from->first);
419 add_dkdm_view (from->second, dynamic_pointer_cast<DKDM>(to->second) ? to->first : optional<wxTreeItemId>());
422 void add_dkdm_clicked ()
424 wxFileDialog* d = new wxFileDialog (this, _("Select DKDM file"));
425 if (d->ShowModal() == wxID_OK) {
426 shared_ptr<DKDMBase> new_dkdm;
428 dcp::EncryptedKDM ekdm(dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE));
430 /* Decrypt the DKDM to make sure that we can */
431 shared_ptr<const dcp::CertificateChain> chain = Config::instance()->decryption_chain();
432 DCPOMATIC_ASSERT (chain->key());
433 dcp::DecryptedKDM dkdm(ekdm, chain->key().get());
435 new_dkdm.reset(new DKDM(ekdm));
436 shared_ptr<DKDMGroup> group = dynamic_pointer_cast<DKDMGroup> (selected_dkdm ());
438 group = Config::instance()->dkdms ();
440 add_dkdm_model (new_dkdm, group);
441 add_dkdm_view (new_dkdm);
442 } catch (dcp::KDMFormatError& e) {
445 _("Could not read file as a KDM. Perhaps it is badly formatted, or not a KDM at all."),
449 } catch (dcp::KDMDecryptionError &) {
452 _("Could not decrypt the DKDM. Perhaps it was not created with the correct certificate.")
454 } catch (dcp::MiscError& e) {
457 _("Could not read file as a KDM. It is much too large. Make sure you are loading a DKDM (XML) file."),
465 void add_dkdm_folder_clicked ()
467 NewDKDMFolderDialog* d = new NewDKDMFolderDialog (this);
468 if (d->ShowModal() == wxID_OK) {
469 shared_ptr<DKDMBase> new_dkdm (new DKDMGroup (wx_to_std (d->get ())));
470 shared_ptr<DKDMGroup> parent = dynamic_pointer_cast<DKDMGroup> (selected_dkdm ());
472 parent = Config::instance()->dkdms ();
474 add_dkdm_model (new_dkdm, parent);
475 add_dkdm_view (new_dkdm);
480 /** @param dkdm Thing to add.
481 * @param parent Parent group, or 0.
483 void add_dkdm_view (shared_ptr<DKDMBase> base, optional<wxTreeItemId> previous = optional<wxTreeItemId>())
485 if (!base->parent()) {
486 /* This is the root group */
487 _dkdm_id[_dkdm->AddRoot("root")] = base;
489 /* Add base to the view */
492 added = _dkdm->InsertItem(dkdm_to_id(base->parent()), *previous, std_to_wx(base->name()));
494 added = _dkdm->AppendItem(dkdm_to_id(base->parent()), std_to_wx(base->name()));
496 _dkdm_id[added] = base;
500 shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup> (base);
502 BOOST_FOREACH (shared_ptr<DKDMBase> i, g->children()) {
508 /** @param group Group to add dkdm to */
509 void add_dkdm_model (shared_ptr<DKDMBase> dkdm, shared_ptr<DKDMGroup> group, shared_ptr<DKDM> previous = shared_ptr<DKDM> ())
511 group->add (dkdm, previous);
512 /* We're messing with a Config-owned object here, so tell it that something has changed.
515 Config::instance()->changed ();
518 wxTreeItemId dkdm_to_id (shared_ptr<DKDMBase> dkdm)
520 for (DKDMMap::iterator i = _dkdm_id.begin(); i != _dkdm_id.end(); ++i) {
521 if (i->second == dkdm) {
525 DCPOMATIC_ASSERT (false);
528 void remove_dkdm_clicked ()
530 shared_ptr<DKDMBase> removed = selected_dkdm ();
535 if (NagDialog::maybe_nag (
536 this, Config::NAG_DELETE_DKDM,
537 _("You are about to remove a DKDM. This will make it impossible to decrypt the DCP that the DKDM was made for, and it cannot be undone. "
543 _dkdm->Delete (dkdm_to_id (removed));
544 shared_ptr<DKDMGroup> dkdms = Config::instance()->dkdms ();
545 dkdms->remove (removed);
546 Config::instance()->changed ();
549 void export_dkdm_clicked ()
551 shared_ptr<DKDMBase> removed = selected_dkdm ();
556 shared_ptr<DKDM> dkdm = dynamic_pointer_cast<DKDM>(removed);
561 wxFileDialog* d = new wxFileDialog (
562 this, _("Select DKDM File"), wxEmptyString, wxEmptyString, wxT("XML files (*.xml)|*.xml"),
563 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
566 if (d->ShowModal() == wxID_OK) {
567 dkdm->dkdm().as_xml(wx_to_std(d->GetPath()));
572 wxPreferencesEditor* _config_dialog;
573 ScreensPanel* _screens;
574 KDMTimingPanel* _timing;
576 typedef std::map<wxTreeItemId, boost::shared_ptr<DKDMBase> > DKDMMap;
579 wxButton* _add_dkdm_folder;
580 wxButton* _remove_dkdm;
581 wxButton* _export_dkdm;
583 KDMOutputPanel* _output;
584 JobViewDialog* _job_view;
588 * @brief The magic App class for wxWidgets.
590 class App : public wxApp
602 wxSplashScreen* splash = 0;
605 wxInitAllImageHandlers ();
607 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
608 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
610 splash = maybe_show_splash ();
612 SetAppName (_("DCP-o-matic KDM Creator"));
614 if (!wxApp::OnInit()) {
618 #ifdef DCPOMATIC_LINUX
619 unsetenv ("UBUNTU_MENUPROXY");
623 ProcessSerialNumber serial;
624 GetCurrentProcess (&serial);
625 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
628 dcpomatic_setup_path_encoding ();
630 /* Enable i18n; this will create a Config object
631 to look for a force-configured language. This Config
632 object will be wrong, however, because dcpomatic_setup
633 hasn't yet been called and there aren't any filters etc.
636 dcpomatic_setup_i18n ();
638 /* Set things up, including filters etc.
639 which will now be internationalised correctly.
643 /* Force the configuration to be re-loaded correctly next
648 _frame = new DOMFrame (_("DCP-o-matic KDM Creator"));
649 SetTopWindow (_frame);
657 signal_manager = new wxSignalManager (this);
658 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
665 error_dialog (0, _("DCP-o-matic could not start"), std_to_wx(e.what()));
671 /* An unhandled exception has occurred inside the main event loop */
672 bool OnExceptionInMainLoop ()
676 } catch (FileError& e) {
680 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
681 std_to_wx (e.what()),
682 std_to_wx (e.file().string().c_str ())
685 } catch (exception& e) {
689 _("An exception occurred: %s.\n\n") + " " + REPORT_PROBLEM,
690 std_to_wx (e.what ())
694 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
697 /* This will terminate the program */
701 void OnUnhandledException ()
703 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
708 signal_manager->ui_idle ();
711 void config_failed_to_load ()
713 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
716 void config_warning (string m)
718 message_dialog (_frame, std_to_wx (m));