2 Copyright (C) 2015-2021 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/>.
22 #include "wx/about_dialog.h"
23 #include "wx/dcpomatic_button.h"
24 #include "wx/editable_list.h"
25 #include "wx/file_picker_ctrl.h"
26 #include "wx/full_config_dialog.h"
27 #include "wx/job_view_dialog.h"
28 #include "wx/kdm_output_panel.h"
29 #include "wx/kdm_timing_panel.h"
30 #include "wx/nag_dialog.h"
31 #include "wx/new_dkdm_folder_dialog.h"
32 #include "wx/report_problem_dialog.h"
33 #include "wx/screens_panel.h"
34 #include "wx/static_text.h"
35 #include "wx/wx_signal_manager.h"
36 #include "wx/wx_util.h"
37 #include "lib/cinema.h"
38 #include "lib/compose.hpp"
39 #include "lib/config.h"
40 #include "lib/cross.h"
41 #include "lib/dcpomatic_log.h"
42 #include "lib/dkdm_wrapper.h"
43 #include "lib/exceptions.h"
44 #include "lib/file_log.h"
45 #include "lib/job_manager.h"
46 #include "lib/kdm_with_metadata.h"
47 #include "lib/screen.h"
48 #include "lib/send_kdm_email_job.h"
50 #include <dcp/encrypted_kdm.h>
51 #include <dcp/decrypted_kdm.h>
52 #include <dcp/exceptions.h>
53 #include <dcp/warnings.h>
54 LIBDCP_DISABLE_WARNINGS
55 #include <wx/filepicker.h>
56 #include <wx/preferences.h>
57 #include <wx/splash.h>
58 #include <wx/treectrl.h>
60 LIBDCP_ENABLE_WARNINGS
62 #include <ApplicationServices/ApplicationServices.h>
64 #include <boost/bind/bind.hpp>
73 using std::make_shared;
76 using std::shared_ptr;
80 using boost::optional;
82 using std::dynamic_pointer_cast;
83 #if BOOST_VERSION >= 106100
84 using namespace boost::placeholders;
86 using namespace dcpomatic;
90 ID_help_report_a_problem = 1,
94 class DOMFrame : public wxFrame
97 explicit DOMFrame (wxString const & title)
98 : wxFrame (nullptr, -1, title)
99 , _config_dialog (nullptr)
100 , _job_view (nullptr)
102 #if defined(DCPOMATIC_WINDOWS)
103 if (Config::instance()->win32_console ()) {
106 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
107 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
108 FILE* hf_out = _fdopen(hCrt, "w");
109 setvbuf(hf_out, NULL, _IONBF, 1);
112 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
113 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
114 FILE* hf_in = _fdopen(hCrt, "r");
115 setvbuf(hf_in, NULL, _IONBF, 128);
118 std::cout << "DCP-o-matic KDM creator is starting." << "\n";
122 auto bar = new wxMenuBar;
126 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
127 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
128 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
129 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
131 /* Use a panel as the only child of the Frame so that we avoid
132 the dark-grey background on Windows.
134 auto overall_panel = new wxPanel (this, wxID_ANY);
135 auto main_sizer = new wxBoxSizer (wxHORIZONTAL);
137 auto horizontal = new wxBoxSizer (wxHORIZONTAL);
138 auto left = new wxBoxSizer (wxVERTICAL);
139 auto right = new wxBoxSizer (wxVERTICAL);
141 horizontal->Add (left, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_X_GAP * 2);
142 horizontal->Add (right, 1, wxEXPAND);
144 wxFont subheading_font (*wxNORMAL_FONT);
145 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
147 auto h = new StaticText (overall_panel, _("Screens"));
148 h->SetFont (subheading_font);
149 left->Add (h, 0, wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
150 _screens = new ScreensPanel (overall_panel);
151 left->Add (_screens, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
153 /// TRANSLATORS: translate the word "Timing" here; do not include the "KDM|" prefix
154 h = new StaticText (overall_panel, S_("KDM|Timing"));
155 h->SetFont (subheading_font);
157 _timing = new KDMTimingPanel (overall_panel);
158 right->Add (_timing, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
160 h = new StaticText (overall_panel, _("DKDM"));
161 h->SetFont (subheading_font);
162 right->Add (h, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP * 2);
163 auto dkdm_sizer = new wxBoxSizer (wxHORIZONTAL);
164 _dkdm = new wxTreeCtrl (
165 overall_panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTR_HIDE_ROOT | wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT
167 dkdm_sizer->Add (_dkdm, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP);
168 wxBoxSizer* dkdm_buttons = new wxBoxSizer(wxVERTICAL);
169 _add_dkdm = new Button (overall_panel, _("Add..."));
170 dkdm_buttons->Add (_add_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
171 _add_dkdm_folder = new Button (overall_panel, _("Add folder..."));
172 dkdm_buttons->Add (_add_dkdm_folder, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
173 _remove_dkdm = new Button (overall_panel, _("Remove"));
174 dkdm_buttons->Add (_remove_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
175 _export_dkdm = new Button (overall_panel, _("Export..."));
176 dkdm_buttons->Add (_export_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
177 dkdm_sizer->Add (dkdm_buttons, 0, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
178 right->Add (dkdm_sizer, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP);
180 add_dkdm_view (Config::instance()->dkdms());
182 h = new StaticText (overall_panel, _("Output"));
183 h->SetFont (subheading_font);
184 right->Add (h, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP * 2);
185 _output = new KDMOutputPanel (overall_panel);
186 right->Add (_output, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
188 _create = new Button (overall_panel, _("Create KDMs"));
189 right->Add (_create, 0, wxALL, DCPOMATIC_SIZER_GAP);
191 main_sizer->Add (horizontal, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
192 overall_panel->SetSizer (main_sizer);
194 /* Instantly save any config changes when using a DCP-o-matic GUI */
195 Config::instance()->Changed.connect (boost::bind (&Config::write, Config::instance ()));
197 _screens->ScreensChanged.connect (boost::bind (&DOMFrame::setup_sensitivity, this));
198 _create->Bind (wxEVT_BUTTON, bind (&DOMFrame::create_kdms, this));
199 _dkdm->Bind (wxEVT_TREE_SEL_CHANGED, boost::bind (&DOMFrame::setup_sensitivity, this));
200 _dkdm->Bind (wxEVT_TREE_BEGIN_DRAG, boost::bind (&DOMFrame::dkdm_begin_drag, this, _1));
201 _dkdm->Bind (wxEVT_TREE_END_DRAG, boost::bind (&DOMFrame::dkdm_end_drag, this, _1));
202 _add_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_clicked, this));
203 _add_dkdm_folder->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_folder_clicked, this));
204 _remove_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::remove_dkdm_clicked, this));
205 _export_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::export_dkdm_clicked, this));
207 setup_sensitivity ();
209 dcpomatic_log = make_shared<FileLog>(State::write_path("kdm.log"));
215 /* false here allows the close handler to veto the close request */
219 void edit_preferences ()
221 if (!_config_dialog) {
222 _config_dialog = create_full_config_dialog ();
224 _config_dialog->Show (this);
229 auto d = new AboutDialog (this);
234 void help_report_a_problem ()
236 auto d = new ReportProblemDialog (this, shared_ptr<Film>());
237 if (d->ShowModal () == wxID_OK) {
243 void setup_menu (wxMenuBar* m)
245 auto file = new wxMenu;
248 file->Append (wxID_EXIT, _("&Exit"));
250 file->Append (wxID_EXIT, _("&Quit"));
254 file->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
256 wxMenu* edit = new wxMenu;
257 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
260 wxMenu* help = new wxMenu;
262 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
264 help->Append (wxID_ABOUT, _("About"));
266 help->Append (ID_help_report_a_problem, _("Report a problem..."));
268 m->Append (file, _("&File"));
270 m->Append (edit, _("&Edit"));
272 m->Append (help, _("&Help"));
275 bool confirm_overwrite (boost::filesystem::path path)
277 return confirm_dialog (
279 wxString::Format (_("File %s already exists. Do you want to overwrite it?"), std_to_wx(path.string()).data())
283 /** @id if not 0 this is filled in with the wxTreeItemId of the selection */
284 shared_ptr<DKDMBase> selected_dkdm (wxTreeItemId* id = 0) const
286 wxArrayTreeItemIds selections;
287 _dkdm->GetSelections (selections);
288 if (selections.GetCount() != 1) {
299 auto i = _dkdm_id.find (selections[0]);
300 if (i == _dkdm_id.end()) {
310 auto dkdm_base = selected_dkdm ();
315 list<KDMWithMetadataPtr> kdms;
318 auto dkdm = std::dynamic_pointer_cast<DKDM>(dkdm_base);
321 /* Decrypt the DKDM */
322 dcp::DecryptedKDM decrypted (dkdm->dkdm(), Config::instance()->decryption_chain()->key().get());
323 title = decrypted.content_title_text ();
325 /* This is the signer for our new KDMs */
326 auto signer = Config::instance()->signer_chain ();
327 if (!signer->valid ()) {
328 throw InvalidSignerError ();
331 for (auto i: _screens->screens()) {
337 dcp::LocalTime begin(_timing->from(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
338 dcp::LocalTime end(_timing->until(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
340 /* Make an empty KDM */
341 dcp::DecryptedKDM kdm (
344 decrypted.annotation_text().get_value_or (""),
346 dcp::LocalTime().as_string()
349 /* Add keys from the DKDM */
350 for (auto const& j: decrypted.keys()) {
354 auto const encrypted = kdm.encrypt(
355 signer, i->recipient.get(), i->trusted_device_thumbprints(), _output->formulation(),
356 !_output->forensic_mark_video(), _output->forensic_mark_audio() ? boost::optional<int>() : 0
359 dcp::NameFormat::Map name_values;
360 name_values['c'] = i->cinema->name;
361 name_values['s'] = i->name;
362 name_values['f'] = title;
363 name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
364 name_values['e'] = end.date() + " " + end.time_of_day(true, false);
365 name_values['i'] = encrypted.cpl_id ();
368 kdms.push_back (make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema->emails, encrypted));
376 auto result = _output->make (
377 kdms, title, bind (&DOMFrame::confirm_overwrite, this, _1)
381 JobManager::instance()->add (result.first);
383 _job_view->Destroy ();
386 _job_view = new JobViewDialog (this, _("Send KDM emails"), result.first);
387 _job_view->ShowModal ();
390 if (result.second > 0) {
391 /* XXX: proper plural form support in wxWidgets? */
392 wxString s = result.second == 1 ? _("%d KDM written to %s") : _("%d KDMs written to %s");
395 wxString::Format (s, result.second, std_to_wx(_output->directory().string()).data())
398 } catch (dcp::NotEncryptedError& e) {
399 error_dialog (this, _("CPL's content is not encrypted."));
400 } catch (exception& e) {
401 error_dialog (this, std_to_wx(e.what()));
403 error_dialog (this, _("An unknown exception occurred."));
407 void setup_sensitivity ()
409 _screens->setup_sensitivity ();
410 _output->setup_sensitivity ();
411 wxArrayTreeItemIds sel;
412 _dkdm->GetSelections (sel);
413 auto group = dynamic_pointer_cast<DKDMGroup>(selected_dkdm());
414 auto dkdm = dynamic_pointer_cast<DKDM>(selected_dkdm());
415 _create->Enable (!_screens->screens().empty() && sel.GetCount() > 0 && dkdm);
416 _remove_dkdm->Enable (sel.GetCount() > 0 && (!group || group->name() != "root"));
417 _export_dkdm->Enable (sel.GetCount() > 0 && dkdm);
420 void dkdm_begin_drag (wxTreeEvent& ev)
425 void dkdm_end_drag (wxTreeEvent& ev)
427 auto from = _dkdm_id.find (_dkdm->GetSelection ());
428 auto to = _dkdm_id.find (ev.GetItem ());
429 if (from == _dkdm_id.end() || to == _dkdm_id.end() || from->first == to->first) {
433 auto group = dynamic_pointer_cast<DKDMGroup> (to->second);
435 group = to->second->parent();
438 DCPOMATIC_ASSERT (group);
439 DCPOMATIC_ASSERT (from->second->parent ());
441 from->second->parent()->remove (from->second);
442 add_dkdm_model (from->second, group, dynamic_pointer_cast<DKDM>(to->second));
444 _dkdm->Delete (from->first);
445 _dkdm_id.erase (from->first);
446 add_dkdm_view (from->second, dynamic_pointer_cast<DKDM>(to->second) ? to->first : optional<wxTreeItemId>());
449 void add_dkdm_clicked ()
451 auto d = new wxFileDialog(
453 _("Select DKDM file"),
456 wxT("XML files|*.xml|All files|*.*"),
460 if (d->ShowModal() == wxID_OK) {
461 auto chain = Config::instance()->decryption_chain();
462 DCPOMATIC_ASSERT (chain->key());
466 for (unsigned int i = 0; i < paths.GetCount(); ++i) {
468 dcp::EncryptedKDM ekdm(dcp::file_to_string(wx_to_std(paths[i]), MAX_KDM_SIZE));
469 /* Decrypt the DKDM to make sure that we can */
470 dcp::DecryptedKDM dkdm(ekdm, chain->key().get());
472 auto new_dkdm = make_shared<DKDM>(ekdm);
473 auto group = dynamic_pointer_cast<DKDMGroup> (selected_dkdm());
475 group = Config::instance()->dkdms ();
477 add_dkdm_model (new_dkdm, group);
478 add_dkdm_view (new_dkdm);
479 } catch (dcp::KDMFormatError& e) {
482 _("Could not read file as a KDM. Perhaps it is badly formatted, or not a KDM at all."),
486 } catch (dcp::KDMDecryptionError &) {
489 _("Could not decrypt the DKDM. Perhaps it was not created with the correct certificate.")
491 } catch (dcp::MiscError& e) {
494 _("Could not read file as a KDM. It is much too large. Make sure you are loading a DKDM (XML) file."),
503 void add_dkdm_folder_clicked ()
505 auto d = new NewDKDMFolderDialog (this);
506 if (d->ShowModal() == wxID_OK) {
507 auto new_dkdm = make_shared<DKDMGroup>(wx_to_std(d->get()));
508 auto parent = dynamic_pointer_cast<DKDMGroup>(selected_dkdm());
510 parent = Config::instance()->dkdms ();
512 add_dkdm_model (new_dkdm, parent);
513 add_dkdm_view (new_dkdm);
518 /** @param dkdm Thing to add.
519 * @param parent Parent group, or 0.
521 void add_dkdm_view (shared_ptr<DKDMBase> base, optional<wxTreeItemId> previous = optional<wxTreeItemId>())
523 if (!base->parent()) {
524 /* This is the root group */
525 _dkdm_id[_dkdm->AddRoot("root")] = base;
527 /* Add base to the view */
529 auto parent_id = dkdm_to_id(base->parent());
531 added = _dkdm->InsertItem(parent_id, *previous, std_to_wx(base->name()));
533 added = _dkdm->AppendItem(parent_id, std_to_wx(base->name()));
535 _dkdm->SortChildren(parent_id);
536 _dkdm_id[added] = base;
540 auto g = dynamic_pointer_cast<DKDMGroup>(base);
542 for (auto i: g->children()) {
548 /** @param group Group to add dkdm to */
549 void add_dkdm_model (shared_ptr<DKDMBase> dkdm, shared_ptr<DKDMGroup> group, shared_ptr<DKDM> previous = shared_ptr<DKDM> ())
551 group->add (dkdm, previous);
552 /* We're messing with a Config-owned object here, so tell it that something has changed.
555 Config::instance()->changed ();
558 wxTreeItemId dkdm_to_id (shared_ptr<DKDMBase> dkdm)
560 for (auto const& i: _dkdm_id) {
561 if (i.second == dkdm) {
565 DCPOMATIC_ASSERT (false);
568 void remove_dkdm_clicked ()
570 auto removed = selected_dkdm ();
575 if (NagDialog::maybe_nag (
576 this, Config::NAG_DELETE_DKDM,
577 _("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. "
583 _dkdm->Delete (dkdm_to_id (removed));
584 auto dkdms = Config::instance()->dkdms ();
585 dkdms->remove (removed);
586 Config::instance()->changed ();
589 void export_dkdm_clicked ()
591 auto removed = selected_dkdm ();
596 auto dkdm = dynamic_pointer_cast<DKDM>(removed);
601 auto d = new wxFileDialog (
602 this, _("Select DKDM File"), wxEmptyString, wxEmptyString, wxT("XML files (*.xml)|*.xml"),
603 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
606 if (d->ShowModal() == wxID_OK) {
607 dkdm->dkdm().as_xml(wx_to_std(d->GetPath()));
612 wxPreferencesEditor* _config_dialog;
613 ScreensPanel* _screens;
614 KDMTimingPanel* _timing;
616 typedef std::map<wxTreeItemId, std::shared_ptr<DKDMBase>> DKDMMap;
619 wxButton* _add_dkdm_folder;
620 wxButton* _remove_dkdm;
621 wxButton* _export_dkdm;
623 KDMOutputPanel* _output;
624 JobViewDialog* _job_view;
629 * @brief The magic App class for wxWidgets.
631 class App : public wxApp
641 bool OnInit () override
643 wxSplashScreen* splash = nullptr;
646 wxInitAllImageHandlers ();
648 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
649 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
651 splash = maybe_show_splash ();
653 SetAppName (_("DCP-o-matic KDM Creator"));
655 if (!wxApp::OnInit()) {
659 #ifdef DCPOMATIC_LINUX
660 unsetenv ("UBUNTU_MENUPROXY");
664 make_foreground_application ();
667 dcpomatic_setup_path_encoding ();
669 /* Enable i18n; this will create a Config object
670 to look for a force-configured language. This Config
671 object will be wrong, however, because dcpomatic_setup
672 hasn't yet been called and there aren't any filters etc.
675 dcpomatic_setup_i18n ();
677 /* Set things up, including filters etc.
678 which will now be internationalised correctly.
682 /* Force the configuration to be re-loaded correctly next
687 _frame = new DOMFrame (_("DCP-o-matic KDM Creator"));
688 SetTopWindow (_frame);
696 signal_manager = new wxSignalManager (this);
697 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
704 error_dialog (0, _("DCP-o-matic could not start"), std_to_wx(e.what()));
710 /* An unhandled exception has occurred inside the main event loop */
711 bool OnExceptionInMainLoop () override
715 } catch (FileError& e) {
719 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
720 std_to_wx (e.what()),
721 std_to_wx (e.file().string().c_str ())
724 } catch (exception& e) {
728 _("An exception occurred: %s.\n\n") + " " + REPORT_PROBLEM,
733 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
736 /* This will terminate the program */
740 void OnUnhandledException () override
742 error_dialog (nullptr, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
747 signal_manager->ui_idle ();
750 void config_failed_to_load ()
752 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
755 void config_warning (string m)
757 message_dialog (_frame, std_to_wx(m));