Rename Encoder -> FilmEncoder, and subclasses.
[dcpomatic.git] / src / tools / dcpomatic_kdm.cc
1 /*
2     Copyright (C) 2015-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/about_dialog.h"
23 #include "wx/dcpomatic_button.h"
24 #include "wx/editable_list.h"
25 #include "wx/id.h"
26 #include "wx/invalid_certificate_period_dialog.h"
27 #include "wx/file_dialog.h"
28 #include "wx/file_picker_ctrl.h"
29 #include "wx/full_config_dialog.h"
30 #include "wx/job_view_dialog.h"
31 #include "wx/kdm_output_panel.h"
32 #include "wx/kdm_timing_panel.h"
33 #include "wx/nag_dialog.h"
34 #include "wx/new_dkdm_folder_dialog.h"
35 #include "wx/report_problem_dialog.h"
36 #include "wx/screens_panel.h"
37 #include "wx/static_text.h"
38 #include "wx/wx_signal_manager.h"
39 #include "wx/wx_util.h"
40 #include "wx/wx_variant.h"
41 #include "lib/cinema.h"
42 #include "lib/collator.h"
43 #include "lib/compose.hpp"
44 #include "lib/constants.h"
45 #include "lib/config.h"
46 #include "lib/cross.h"
47 #include "lib/dcpomatic_log.h"
48 #include "lib/dkdm_wrapper.h"
49 #include "lib/exceptions.h"
50 #include "lib/file_log.h"
51 #include "lib/job_manager.h"
52 #include "lib/kdm_util.h"
53 #include "lib/kdm_with_metadata.h"
54 #include "lib/screen.h"
55 #include "lib/send_kdm_email_job.h"
56 #include "lib/util.h"
57 #include "lib/variant.h"
58 #include <dcp/encrypted_kdm.h>
59 #include <dcp/decrypted_kdm.h>
60 #include <dcp/exceptions.h>
61 #include <dcp/filesystem.h>
62 #include <dcp/warnings.h>
63 LIBDCP_DISABLE_WARNINGS
64 #include <wx/dnd.h>
65 #include <wx/filepicker.h>
66 #include <wx/preferences.h>
67 #include <wx/splash.h>
68 #include <wx/srchctrl.h>
69 #include <wx/treectrl.h>
70 #include <wx/wx.h>
71 LIBDCP_ENABLE_WARNINGS
72 #ifdef __WXOSX__
73 #include <ApplicationServices/ApplicationServices.h>
74 #endif
75 #include <boost/bind/bind.hpp>
76 #include <unordered_set>
77
78 #ifdef check
79 #undef check
80 #endif
81
82
83 using std::dynamic_pointer_cast;
84 using std::exception;
85 using std::list;
86 using std::make_shared;
87 using std::map;
88 using std::pair;
89 using std::shared_ptr;
90 using std::string;
91 using std::unordered_set;
92 using std::vector;
93 using boost::bind;
94 using boost::optional;
95 using boost::ref;
96 #if BOOST_VERSION >= 106100
97 using namespace boost::placeholders;
98 #endif
99 using namespace dcpomatic;
100
101
102 enum {
103         ID_help_report_a_problem = DCPOMATIC_MAIN_MENU,
104 };
105
106
107 class DOMFrame : public wxFrame
108 {
109 public:
110         explicit DOMFrame (wxString const & title)
111                 : wxFrame (nullptr, -1, title)
112                 , _config_dialog (nullptr)
113                 , _job_view (nullptr)
114         {
115 #if defined(DCPOMATIC_WINDOWS)
116                 if (Config::instance()->win32_console ()) {
117                         AllocConsole();
118
119                         HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
120                         int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
121                         FILE* hf_out = _fdopen(hCrt, "w");
122                         setvbuf(hf_out, NULL, _IONBF, 1);
123                         *stdout = *hf_out;
124
125                         HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
126                         hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
127                         FILE* hf_in = _fdopen(hCrt, "r");
128                         setvbuf(hf_in, NULL, _IONBF, 128);
129                         *stdin = *hf_in;
130
131                         std::cout << variant::insert_dcpomatic_kdm_creator("%1 is starting.\n");
132                 }
133 #endif
134
135                 auto bar = new wxMenuBar;
136                 setup_menu (bar);
137                 SetMenuBar (bar);
138
139                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this),             wxID_EXIT);
140                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this),      wxID_PREFERENCES);
141                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this),            wxID_ABOUT);
142                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
143
144                 /* Use a panel as the only child of the Frame so that we avoid
145                    the dark-grey background on Windows.
146                 */
147                 auto overall_panel = new wxPanel (this, wxID_ANY);
148                 auto main_sizer = new wxBoxSizer (wxHORIZONTAL);
149
150                 auto horizontal = new wxBoxSizer (wxHORIZONTAL);
151                 auto left = new wxBoxSizer (wxVERTICAL);
152                 auto right = new wxBoxSizer (wxVERTICAL);
153
154                 horizontal->Add (left, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_X_GAP * 2);
155                 horizontal->Add (right, 1, wxEXPAND);
156
157                 wxFont subheading_font (*wxNORMAL_FONT);
158                 subheading_font.SetWeight (wxFONTWEIGHT_BOLD);
159
160                 auto h = new StaticText (overall_panel, _("Screens"));
161                 h->SetFont (subheading_font);
162                 left->Add (h, 0, wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
163                 _screens = new ScreensPanel (overall_panel);
164                 left->Add (_screens, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
165
166                 /// TRANSLATORS: translate the word "Timing" here; do not include the "KDM|" prefix
167                 h = new StaticText (overall_panel, S_("KDM|Timing"));
168                 h->SetFont (subheading_font);
169                 right->Add (h);
170                 _timing = new KDMTimingPanel (overall_panel);
171                 right->Add (_timing, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
172
173                 h = new StaticText (overall_panel, _("DKDM"));
174                 h->SetFont (subheading_font);
175                 right->Add(h, 0, wxTOP, DCPOMATIC_SUBHEADING_TOP_PAD);
176
177                 _dkdm_search = new wxSearchCtrl(overall_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, search_ctrl_height()));
178 #ifndef __WXGTK3__
179                 /* The cancel button seems to be strangely broken in GTK3; clicking on it twice sometimes works */
180                 _dkdm_search->ShowCancelButton (true);
181 #endif
182
183                 right->Add(_dkdm_search, 0, wxTOP | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
184
185                 class DKDMDropTarget : public wxFileDropTarget
186                 {
187                 public:
188                         DKDMDropTarget(DOMFrame* frame)
189                                 : _frame(frame)
190                         {}
191
192                         bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
193                         {
194                                 for (size_t i = 0; i < filenames.GetCount(); ++i) {
195                                         _frame->add_dkdm(boost::filesystem::path(wx_to_std(filenames[0])));
196                                 }
197
198                                 return true;
199                         }
200
201                 private:
202                         DOMFrame* _frame;
203                 };
204
205                 auto dkdm_sizer = new wxBoxSizer (wxHORIZONTAL);
206                 _dkdm = new wxTreeCtrl (
207                         overall_panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTR_HIDE_ROOT | wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT
208                 );
209                 _dkdm->SetDropTarget(new DKDMDropTarget(this));
210                 dkdm_sizer->Add(_dkdm, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
211                 auto dkdm_buttons = new wxBoxSizer(wxVERTICAL);
212                 _add_dkdm = new Button (overall_panel, _("Add..."));
213                 dkdm_buttons->Add (_add_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
214                 _add_dkdm_folder = new Button (overall_panel, _("Add folder..."));
215                 dkdm_buttons->Add (_add_dkdm_folder, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
216                 _remove_dkdm = new Button (overall_panel, _("Remove"));
217                 dkdm_buttons->Add (_remove_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
218                 _export_dkdm = new Button (overall_panel, _("Export..."));
219                 dkdm_buttons->Add (_export_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP);
220                 dkdm_sizer->Add (dkdm_buttons, 0, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP);
221                 right->Add (dkdm_sizer, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP);
222
223                 update_dkdm_view();
224
225                 h = new StaticText (overall_panel, _("Output"));
226                 h->SetFont (subheading_font);
227                 right->Add(h, 0, wxTOP, DCPOMATIC_SUBHEADING_TOP_PAD);
228                 _output = new KDMOutputPanel (overall_panel);
229                 right->Add (_output, 0, wxALL, DCPOMATIC_SIZER_Y_GAP);
230
231                 _create = new Button (overall_panel, _("Create KDMs"));
232                 right->Add (_create, 0, wxALL, DCPOMATIC_SIZER_GAP);
233
234                 main_sizer->Add (horizontal, 1, wxALL | wxEXPAND, DCPOMATIC_DIALOG_BORDER);
235                 overall_panel->SetSizer (main_sizer);
236
237                 /* Instantly save any config changes when using a DCP-o-matic GUI */
238                 Config::instance()->Changed.connect (boost::bind (&Config::write, Config::instance ()));
239
240                 _screens->ScreensChanged.connect (boost::bind (&DOMFrame::setup_sensitivity, this));
241                 _create->Bind (wxEVT_BUTTON, bind (&DOMFrame::create_kdms, this));
242                 _dkdm->Bind(wxEVT_TREE_SEL_CHANGED, boost::bind(&DOMFrame::dkdm_selection_changed, this));
243                 _dkdm->Bind (wxEVT_TREE_BEGIN_DRAG, boost::bind (&DOMFrame::dkdm_begin_drag, this, _1));
244                 _dkdm->Bind (wxEVT_TREE_END_DRAG, boost::bind (&DOMFrame::dkdm_end_drag, this, _1));
245                 _dkdm->Bind(wxEVT_TREE_ITEM_EXPANDED, boost::bind(&DOMFrame::dkdm_expanded, this, _1));
246                 _dkdm->Bind(wxEVT_TREE_ITEM_COLLAPSED, boost::bind(&DOMFrame::dkdm_collapsed, this, _1));
247                 _add_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_clicked, this));
248                 _add_dkdm_folder->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_folder_clicked, this));
249                 _remove_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::remove_dkdm_clicked, this));
250                 _export_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::export_dkdm_clicked, this));
251                 _dkdm_search->Bind(wxEVT_TEXT, boost::bind(&DOMFrame::dkdm_search_changed, this));
252                 _timing->TimingChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
253                 _output->MethodChanged.connect(boost::bind(&DOMFrame::setup_sensitivity, this));
254
255                 setup_sensitivity ();
256
257                 dcpomatic_log = make_shared<FileLog>(State::write_path("kdm.log"));
258         }
259
260 private:
261         void file_exit ()
262         {
263                 /* false here allows the close handler to veto the close request */
264                 Close (false);
265         }
266
267         void edit_preferences ()
268         {
269                 if (!_config_dialog) {
270                         _config_dialog = create_full_config_dialog ();
271                 }
272                 _config_dialog->Show (this);
273         }
274
275         void help_about ()
276         {
277                 AboutDialog dialog(this);
278                 dialog.ShowModal();
279         }
280
281         void help_report_a_problem ()
282         {
283                 ReportProblemDialog dialog(this, shared_ptr<Film>());
284                 if (dialog.ShowModal() == wxID_OK) {
285                         dialog.report();
286                 }
287         }
288
289         void setup_menu (wxMenuBar* m)
290         {
291                 auto file = new wxMenu;
292
293 #ifdef __WXOSX__
294                 file->Append (wxID_EXIT, _("&Exit"));
295 #else
296                 file->Append (wxID_EXIT, _("&Quit"));
297 #endif
298
299 #ifdef __WXOSX__
300                 file->Append(wxID_PREFERENCES, _("&Preferences...\tCtrl-,"));
301 #else
302                 wxMenu* edit = new wxMenu;
303                 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
304 #endif
305
306                 wxMenu* help = new wxMenu;
307 #ifdef __WXOSX__
308                 help->Append(wxID_ABOUT, variant::wx::insert_dcpomatic_kdm_creator(_("About %s")));
309 #else
310                 help->Append (wxID_ABOUT, _("About"));
311 #endif
312                 help->Append (ID_help_report_a_problem, _("Report a problem..."));
313
314                 m->Append (file, _("&File"));
315 #ifndef __WXOSX__
316                 m->Append (edit, _("&Edit"));
317 #endif
318                 m->Append (help, _("&Help"));
319         }
320
321         bool confirm_overwrite (boost::filesystem::path path)
322         {
323                 if (dcp::filesystem::is_directory(path)) {
324                         return confirm_dialog (
325                                 this,
326                                 wxString::Format(_("Folder %s already exists.  Do you want to overwrite it?"), std_to_wx(path.string()).data())
327                                 );
328                 } else {
329                         return confirm_dialog (
330                                 this,
331                                 wxString::Format(_("File %s already exists.  Do you want to overwrite it?"), std_to_wx(path.string()).data())
332                                 );
333                 }
334         }
335
336         /** @id if not nullptr this is filled in with the wxTreeItemId of the selection */
337         shared_ptr<DKDMBase> selected_dkdm (wxTreeItemId* id = nullptr) const
338         {
339                 wxArrayTreeItemIds selections;
340                 _dkdm->GetSelections (selections);
341                 if (selections.GetCount() != 1) {
342                         if (id) {
343                                 *id = 0;
344                         }
345                         return {};
346                 }
347
348                 if (id) {
349                         *id = selections[0];
350                 }
351
352                 auto i = _dkdm_id.find (selections[0]);
353                 if (i == _dkdm_id.end()) {
354                         return {};
355                 }
356
357                 return i->second;
358         }
359
360         void create_kdms ()
361         {
362                 try {
363                         auto dkdm_base = selected_dkdm ();
364                         if (!dkdm_base) {
365                                 return;
366                         }
367
368                         list<KDMWithMetadataPtr> kdms;
369                         string title;
370
371                         auto dkdm = std::dynamic_pointer_cast<DKDM>(dkdm_base);
372                         if (!dkdm) {
373                                 return;
374                         }
375
376                         /* Decrypt the DKDM */
377                         dcp::DecryptedKDM decrypted (dkdm->dkdm(), Config::instance()->decryption_chain()->key().get());
378                         title = decrypted.content_title_text ();
379
380                         /* This is the signer for our new KDMs */
381                         auto signer = Config::instance()->signer_chain ();
382                         if (!signer->valid ()) {
383                                 throw InvalidSignerError ();
384                         }
385
386                         vector<KDMCertificatePeriod> period_checks;
387
388                         std::function<dcp::DecryptedKDM (dcp::LocalTime, dcp::LocalTime)> make_kdm = [this, decrypted, title](dcp::LocalTime begin, dcp::LocalTime end) {
389                                 /* Make an empty KDM */
390                                 dcp::DecryptedKDM kdm (
391                                         begin,
392                                         end,
393                                         _output->annotation_text(),
394                                         title,
395                                         dcp::LocalTime().as_string()
396                                         );
397
398                                 /* Add keys from the DKDM */
399                                 for (auto const& j: decrypted.keys()) {
400                                         kdm.add_key(j);
401                                 }
402
403                                 return kdm;
404                         };
405
406                         for (auto i: _screens->screens()) {
407
408                                 auto kdm = kdm_for_screen(
409                                         make_kdm,
410                                         i,
411                                         _timing->from(),
412                                         _timing->until(),
413                                         _output->formulation(),
414                                         !_output->forensic_mark_video(),
415                                         _output->forensic_mark_audio() ? boost::optional<int>() : 0,
416                                         period_checks
417                                         );
418
419                                 if (kdm) {
420                                         kdms.push_back(kdm);
421                                 }
422                         }
423
424                         if (kdms.empty()) {
425                                 return;
426                         }
427
428                         if (
429                                 find_if(
430                                         period_checks.begin(),
431                                         period_checks.end(),
432                                         [](KDMCertificatePeriod const& p) { return p.overlap != KDMCertificateOverlap::KDM_WITHIN_CERTIFICATE; }
433                                        ) != period_checks.end()) {
434                                 InvalidCertificatePeriodDialog dialog(this, period_checks);
435                                 if (dialog.ShowModal() == wxID_CANCEL) {
436                                         return;
437                                 }
438                         }
439
440                         auto result = _output->make (
441                                 kdms, title, bind (&DOMFrame::confirm_overwrite, this, _1)
442                                 );
443
444                         if (result.first) {
445                                 JobManager::instance()->add (result.first);
446                                 if (_job_view) {
447                                         _job_view->Destroy ();
448                                         _job_view = 0;
449                                 }
450                                 _job_view = new JobViewDialog (this, _("Send KDM emails"), result.first);
451                                 _job_view->ShowModal ();
452                         }
453
454                         if (result.second > 0) {
455                                 /* XXX: proper plural form support in wxWidgets? */
456                                 wxString s = result.second == 1 ? _("%d KDM written to %s") : _("%d KDMs written to %s");
457                                 message_dialog (
458                                         this,
459                                         wxString::Format (s, result.second, std_to_wx(_output->directory().string()).data())
460                                         );
461                         }
462                 } catch (dcp::BadKDMDateError& e) {
463                         if (e.starts_too_early()) {
464                                 error_dialog(this, _("The KDM start period is before (or close to) the start of the signing certificate's validity period.  Use a later start time for this KDM."));
465                         } else {
466                                 error_dialog(
467                                         this,
468                                         variant::wx::insert_dcpomatic_kdm_creator(
469                                                 _("The KDM end period is after (or close to) the end of the signing certificates' validity period.  "
470                                                   "Either use an earlier end time for this KDM or re-create your signing certificates in the %s preferences window.")
471                                                 )
472                                         );
473                         }
474                         return;
475                 } catch (dcp::NotEncryptedError& e) {
476                         error_dialog (this, _("CPL's content is not encrypted."));
477                 } catch (exception& e) {
478                         error_dialog (this, std_to_wx(e.what()));
479                 } catch (...) {
480                         error_dialog (this, _("An unknown exception occurred."));
481                 }
482         }
483
484         void setup_sensitivity ()
485         {
486                 _screens->setup_sensitivity ();
487                 _output->setup_sensitivity ();
488                 wxArrayTreeItemIds sel;
489                 _dkdm->GetSelections (sel);
490                 auto group = dynamic_pointer_cast<DKDMGroup>(selected_dkdm());
491                 auto dkdm = dynamic_pointer_cast<DKDM>(selected_dkdm());
492                 _create->Enable(!_screens->screens().empty() && _timing->valid() && sel.GetCount() > 0 && dkdm && _output->method_selected());
493                 _remove_dkdm->Enable (sel.GetCount() > 0 && (!group || group->name() != "root"));
494                 _export_dkdm->Enable (sel.GetCount() > 0 && dkdm);
495         }
496
497         void dkdm_selection_changed()
498         {
499                 _selected_dkdm = selected_dkdm();
500                 if (_selected_dkdm) {
501                         auto dkdm = std::dynamic_pointer_cast<DKDM>(_selected_dkdm);
502                         if (dkdm) {
503                                 try {
504                                         dcp::DecryptedKDM decrypted(dkdm->dkdm(), Config::instance()->decryption_chain()->key().get());
505                                         if (decrypted.annotation_text()) {
506                                                 _output->set_annotation_text(*decrypted.annotation_text());
507                                         }
508                                 } catch (...) {}
509                         }
510                 }
511                 setup_sensitivity();
512         }
513
514         void dkdm_expanded(wxTreeEvent& ev)
515         {
516                 if (_ignore_expand) {
517                         return;
518                 }
519
520                 auto iter = _dkdm_id.find(ev.GetItem());
521                 if (iter != _dkdm_id.end()) {
522                         _expanded_dkdm_groups.insert(iter->second);
523                 }
524         }
525
526         void dkdm_collapsed(wxTreeEvent& ev)
527         {
528                 auto iter = _dkdm_id.find(ev.GetItem());
529                 if (iter != _dkdm_id.end()) {
530                         _expanded_dkdm_groups.erase(iter->second);
531                 }
532         }
533
534         void dkdm_begin_drag (wxTreeEvent& ev)
535         {
536                 ev.Allow ();
537         }
538
539         void dkdm_end_drag (wxTreeEvent& ev)
540         {
541                 auto from = _dkdm_id.find (_dkdm->GetSelection ());
542                 auto to = _dkdm_id.find (ev.GetItem ());
543                 if (from == _dkdm_id.end() || to == _dkdm_id.end() || from->first == to->first) {
544                         return;
545                 }
546
547                 auto group = dynamic_pointer_cast<DKDMGroup> (to->second);
548                 if (!group) {
549                         group = to->second->parent();
550                 }
551
552                 /* Check we're not adding a group to one of its children */
553                 auto to_parent = group;
554                 while (to_parent) {
555                         if (from->second == to_parent) {
556                                 return;
557                         }
558                         to_parent = to_parent->parent();
559                 }
560
561                 DCPOMATIC_ASSERT (group);
562                 DCPOMATIC_ASSERT (from->second->parent ());
563
564                 from->second->parent()->remove (from->second);
565                 add_dkdm(from->second, group, dynamic_pointer_cast<DKDM>(to->second));
566
567                 update_dkdm_view();
568         }
569
570         void add_dkdm_clicked ()
571         {
572                 FileDialog dialog(this, _("Select DKDM file"), wxT("XML files|*.xml|All files|*.*"), wxFD_MULTIPLE, "AddDKDMPath");
573                 if (!dialog.show()) {
574                         return;
575                 }
576
577                 for (auto path: dialog.paths()) {
578                         add_dkdm(path);
579                 }
580         }
581
582         void add_dkdm(boost::filesystem::path path)
583         {
584                 auto chain = Config::instance()->decryption_chain();
585                 DCPOMATIC_ASSERT (chain->key());
586
587                 try {
588                         dcp::EncryptedKDM ekdm(dcp::file_to_string(path, MAX_KDM_SIZE));
589                         /* Decrypt the DKDM to make sure that we can */
590                         dcp::DecryptedKDM dkdm(ekdm, chain->key().get());
591
592                         auto new_dkdm = make_shared<DKDM>(ekdm);
593
594                         if (Config::instance()->dkdms()->contains(new_dkdm->dkdm().id())) {
595                                 error_dialog(
596                                         this,
597                                         wxString::Format(_("DKDM %s is already in the DKDM list and will not be added again."), std_to_wx(new_dkdm->dkdm().id()))
598                                         );
599                                 return;
600                         }
601
602                         auto group = dynamic_pointer_cast<DKDMGroup> (selected_dkdm());
603                         if (!group) {
604                                 group = Config::instance()->dkdms ();
605                         }
606                         add_dkdm(new_dkdm, group);
607                 } catch (dcp::KDMFormatError& e) {
608                         error_dialog (
609                                 this,
610                                 _("Could not read file as a KDM.  Perhaps it is badly formatted, or not a KDM at all."),
611                                 std_to_wx(e.what())
612                                 );
613                         return;
614                 } catch (dcp::KDMDecryptionError &) {
615                         error_dialog (
616                                 this,
617                                 _("Could not decrypt the DKDM.  Perhaps it was not created with the correct certificate.")
618                                 );
619                 } catch (dcp::MiscError& e) {
620                         error_dialog (
621                                 this,
622                                 _("Could not read file as a KDM.  It is much too large.  Make sure you are loading a DKDM (XML) file."),
623                                 std_to_wx(e.what())
624                                 );
625                 }
626
627                 update_dkdm_view();
628         }
629
630         void add_dkdm_folder_clicked ()
631         {
632                 NewDKDMFolderDialog dialog(this);
633                 if (dialog.ShowModal() != wxID_OK) {
634                         return;
635                 }
636
637                 auto new_dkdm = make_shared<DKDMGroup>(wx_to_std(dialog.get()));
638                 auto parent = dynamic_pointer_cast<DKDMGroup>(selected_dkdm());
639                 if (!parent) {
640                         parent = Config::instance()->dkdms ();
641                 }
642                 add_dkdm(new_dkdm, parent);
643                 update_dkdm_view();
644         }
645
646         void update_dkdm_view()
647         {
648                 _dkdm->DeleteAllItems();
649                 _dkdm_id.clear();
650                 add_dkdm_to_view(Config::instance()->dkdms());
651                 if (_selected_dkdm) {
652                         auto selection_in_id_map = std::find_if(_dkdm_id.begin(), _dkdm_id.end(), [this](pair<wxTreeItemId, shared_ptr<DKDMBase>> const& entry) {
653                                 return entry.second == _selected_dkdm;
654                         });
655                         if (selection_in_id_map != _dkdm_id.end()) {
656                                 _dkdm->SelectItem(selection_in_id_map->first);
657                         }
658                 }
659         }
660
661         /** @return true if this thing or any of its children match a search string */
662         bool matches(shared_ptr<DKDMBase> base, string const& search)
663         {
664                 if (search.empty()) {
665                         return true;
666                 }
667
668                 auto name = base->name();
669                 transform(name.begin(), name.end(), name.begin(), ::tolower);
670                 if (name.find(search) != string::npos) {
671                         return true;
672                 }
673
674                 auto group = dynamic_pointer_cast<DKDMGroup>(base);
675                 if (!group) {
676                         return false;
677                 }
678
679                 auto const children = group->children();
680                 return std::any_of(children.begin(), children.end(), [this, search](shared_ptr<DKDMBase> child) {
681                         return matches(child, search);
682                 });
683         }
684
685         /** Add DKDMs to the view that match the current search */
686         void add_dkdm_to_view(shared_ptr<DKDMBase> base)
687         {
688                 auto search = wx_to_std(_dkdm_search->GetValue());
689                 transform(search.begin(), search.end(), search.begin(), ::tolower);
690
691                 optional<wxTreeItemId> group_to_expand;
692
693                 if (!base->parent()) {
694                         /* This is the root group */
695                         _dkdm_id[_dkdm->AddRoot("root")] = base;
696                 } else {
697                         /* Add base to the view */
698                         wxTreeItemId added;
699                         auto parent_id = dkdm_to_id(base->parent());
700                         added = _dkdm->AppendItem(parent_id, std_to_wx(base->name()));
701                         /* Expand the group (later) if it matches the search or it was manually expanded */
702                         if (!search.empty() || _expanded_dkdm_groups.find(base) != _expanded_dkdm_groups.end()) {
703                                 group_to_expand = added;
704                         }
705                         _dkdm_id[added] = base;
706                 }
707
708                 /* Add children */
709                 auto group = dynamic_pointer_cast<DKDMGroup>(base);
710                 if (group) {
711                         auto children = group->children();
712                         children.sort(
713                                 [this](shared_ptr<DKDMBase> a, shared_ptr<DKDMBase> b) { return _collator.compare(a->name(), b->name()) < 0; }
714                         );
715
716                         for (auto i: children) {
717                                 if (matches(i, search)) {
718                                         add_dkdm_to_view(i);
719                                 }
720                         }
721                 }
722
723                 if (group_to_expand) {
724                         _ignore_expand = true;
725                         _dkdm->Expand(*group_to_expand);
726                         _ignore_expand = false;
727                 }
728         }
729
730         /** @param group Group to add dkdm to */
731         void add_dkdm(shared_ptr<DKDMBase> dkdm, shared_ptr<DKDMGroup> group, shared_ptr<DKDM> previous = shared_ptr<DKDM>())
732         {
733                 group->add (dkdm, previous);
734                 /* We're messing with a Config-owned object here, so tell it that something has changed.
735                    This isn't nice.
736                 */
737                 Config::instance()->changed ();
738         }
739
740         wxTreeItemId dkdm_to_id (shared_ptr<DKDMBase> dkdm)
741         {
742                 for (auto const& i: _dkdm_id) {
743                         if (i.second == dkdm) {
744                                 return i.first;
745                         }
746                 }
747                 DCPOMATIC_ASSERT (false);
748         }
749
750         void remove_dkdm_clicked ()
751         {
752                 auto removed = selected_dkdm ();
753                 if (!removed) {
754                         return;
755                 }
756
757                 if (removed->contains_dkdm()) {
758                         if (NagDialog::maybe_nag(
759                                     this, Config::NAG_DELETE_DKDM,
760                                     _("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.  "
761                                       "Are you sure?"),
762                                     true)) {
763                                 return;
764                         }
765                 }
766
767                 _dkdm->Delete (dkdm_to_id (removed));
768                 auto dkdms = Config::instance()->dkdms ();
769                 dkdms->remove (removed);
770                 Config::instance()->changed ();
771         }
772
773         void export_dkdm_clicked ()
774         {
775                 auto removed = selected_dkdm ();
776                 if (!removed) {
777                         return;
778                 }
779
780                 auto dkdm = dynamic_pointer_cast<DKDM>(removed);
781                 if (!dkdm) {
782                         return;
783                 }
784
785                 wxFileDialog dialog(
786                         this, _("Select DKDM File"), wxEmptyString, wxEmptyString, wxT("XML files (*.xml)|*.xml"),
787                         wxFD_SAVE | wxFD_OVERWRITE_PROMPT
788                         );
789
790                 if (dialog.ShowModal() == wxID_OK) {
791                         dkdm->dkdm().as_xml(wx_to_std(dialog.GetPath()));
792                 }
793         }
794
795         void dkdm_search_changed()
796         {
797                 update_dkdm_view();
798         }
799
800         wxPreferencesEditor* _config_dialog;
801         ScreensPanel* _screens;
802         KDMTimingPanel* _timing;
803         wxTreeCtrl* _dkdm;
804         wxSearchCtrl* _dkdm_search;
805         typedef std::map<wxTreeItemId, std::shared_ptr<DKDMBase>> DKDMMap;
806         DKDMMap _dkdm_id;
807         /* Keep a separate track of the selected DKDM so that when a search happens, and some things
808          * get removed from the view, we can restore the selection when they are re-added.
809          */
810         shared_ptr<DKDMBase> _selected_dkdm;
811         /* Keep expanded groups for the same reason */
812         unordered_set<shared_ptr<DKDMBase>> _expanded_dkdm_groups;
813         /* true if we are "artificially" expanding a group because it contains something found
814          * in a search.
815          */
816         bool _ignore_expand = false;
817         wxButton* _add_dkdm;
818         wxButton* _add_dkdm_folder;
819         wxButton* _remove_dkdm;
820         wxButton* _export_dkdm;
821         wxButton* _create;
822         KDMOutputPanel* _output;
823         JobViewDialog* _job_view;
824         Collator _collator;
825 };
826
827
828 /** @class App
829  *  @brief The magic App class for wxWidgets.
830  */
831 class App : public wxApp
832 {
833 public:
834         App ()
835                 : wxApp ()
836                 , _frame (nullptr)
837         {}
838
839 private:
840
841         bool OnInit () override
842         {
843                 wxSplashScreen* splash;
844
845                 try {
846                         wxInitAllImageHandlers ();
847
848                         Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
849                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
850
851                         splash = maybe_show_splash ();
852
853                         SetAppName(variant::wx::dcpomatic_kdm_creator());
854
855                         if (!wxApp::OnInit()) {
856                                 return false;
857                         }
858
859 #ifdef DCPOMATIC_LINUX
860                         unsetenv ("UBUNTU_MENUPROXY");
861 #endif
862
863 #ifdef DCPOMATIC_OSX
864                         make_foreground_application ();
865 #endif
866
867                         dcpomatic_setup_path_encoding ();
868
869                         /* Enable i18n; this will create a Config object
870                            to look for a force-configured language.  This Config
871                            object will be wrong, however, because dcpomatic_setup
872                            hasn't yet been called and there aren't any filters etc.
873                            set up yet.
874                         */
875                         dcpomatic_setup_i18n ();
876
877                         /* Set things up, including filters etc.
878                            which will now be internationalised correctly.
879                         */
880                         dcpomatic_setup ();
881
882                         /* Force the configuration to be re-loaded correctly next
883                            time it is needed.
884                         */
885                         Config::drop ();
886
887                         _frame = new DOMFrame(variant::wx::dcpomatic_kdm_creator());
888                         SetTopWindow (_frame);
889                         _frame->Maximize ();
890                         if (splash) {
891                                 splash->Destroy ();
892                                 splash = nullptr;
893                         }
894                         _frame->Show ();
895
896                         signal_manager = new wxSignalManager (this);
897                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
898                 }
899                 catch (exception& e)
900                 {
901                         if (splash) {
902                                 splash->Destroy ();
903                         }
904                         error_dialog(nullptr, variant::wx::insert_dcpomatic_kdm_creator(_("%s could not start")), std_to_wx(e.what()));
905                 }
906
907                 return true;
908         }
909
910         /* An unhandled exception has occurred inside the main event loop */
911         bool OnExceptionInMainLoop () override
912         {
913                 try {
914                         throw;
915                 } catch (FileError& e) {
916                         error_dialog (
917                                 0,
918                                 wxString::Format (
919                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
920                                         std_to_wx (e.what()),
921                                         std_to_wx (e.file().string().c_str ())
922                                         )
923                                 );
924                 } catch (exception& e) {
925                         error_dialog (
926                                 nullptr,
927                                 wxString::Format (
928                                         _("An exception occurred: %s.\n\n") + " " + REPORT_PROBLEM,
929                                         std_to_wx(e.what())
930                                         )
931                                 );
932                 } catch (...) {
933                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
934                 }
935
936                 /* This will terminate the program */
937                 return false;
938         }
939
940         void OnUnhandledException () override
941         {
942                 error_dialog (nullptr, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
943         }
944
945         void idle ()
946         {
947                 signal_manager->ui_idle ();
948         }
949
950         void config_failed_to_load(Config::LoadFailure what)
951         {
952                 report_config_load_failure(_frame, what);
953         }
954
955         void config_warning (string m)
956         {
957                 message_dialog (_frame, std_to_wx(m));
958         }
959
960         DOMFrame* _frame;
961 };
962
963 IMPLEMENT_APP (App)