X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Ftools%2Fdcpomatic_kdm.cc;h=b9d71d27338ddf6ee8cd39c93b5d01c1f36768b0;hp=d60a5e190c2d3dbce7b6fd7ec7fce1148c5a0223;hb=6ebec6b3ca11a7062ae19176096b1b157275d015;hpb=a25c933a560797627ac891d95fbd80b747835ac2 diff --git a/src/tools/dcpomatic_kdm.cc b/src/tools/dcpomatic_kdm.cc index d60a5e190..b9d71d273 100644 --- a/src/tools/dcpomatic_kdm.cc +++ b/src/tools/dcpomatic_kdm.cc @@ -22,6 +22,7 @@ #include "wx/about_dialog.h" #include "wx/dcpomatic_button.h" #include "wx/editable_list.h" +#include "wx/file_dialog.h" #include "wx/file_picker_ctrl.h" #include "wx/full_config_dialog.h" #include "wx/job_view_dialog.h" @@ -35,7 +36,9 @@ #include "wx/wx_signal_manager.h" #include "wx/wx_util.h" #include "lib/cinema.h" +#include "lib/collator.h" #include "lib/compose.hpp" +#include "lib/constants.h" #include "lib/config.h" #include "lib/cross.h" #include "lib/dcpomatic_log.h" @@ -43,18 +46,20 @@ #include "lib/exceptions.h" #include "lib/file_log.h" #include "lib/job_manager.h" +#include "lib/kdm_util.h" #include "lib/kdm_with_metadata.h" #include "lib/screen.h" #include "lib/send_kdm_email_job.h" -#include "lib/util.h" #include #include #include #include LIBDCP_DISABLE_WARNINGS +#include #include #include #include +#include #include #include LIBDCP_ENABLE_WARNINGS @@ -62,6 +67,7 @@ LIBDCP_ENABLE_WARNINGS #include #endif #include +#include #ifdef check #undef check @@ -75,6 +81,7 @@ using std::map; using std::pair; using std::shared_ptr; using std::string; +using std::unordered_set; using std::vector; using boost::bind; using boost::optional; @@ -159,13 +166,43 @@ public: h = new StaticText (overall_panel, _("DKDM")); h->SetFont (subheading_font); - right->Add (h, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP * 2); + right->Add(h, 0, wxTOP, DCPOMATIC_SUBHEADING_TOP_PAD); + + _dkdm_search = new wxSearchCtrl(overall_panel, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(200, search_ctrl_height())); +#ifndef __WXGTK3__ + /* The cancel button seems to be strangely broken in GTK3; clicking on it twice sometimes works */ + _dkdm_search->ShowCancelButton (true); +#endif + + right->Add(_dkdm_search, 0, wxTOP | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP); + + class DKDMDropTarget : public wxFileDropTarget + { + public: + DKDMDropTarget(DOMFrame* frame) + : _frame(frame) + {} + + bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override + { + for (size_t i = 0; i < filenames.GetCount(); ++i) { + _frame->add_dkdm(boost::filesystem::path(wx_to_std(filenames[0]))); + } + + return true; + } + + private: + DOMFrame* _frame; + }; + auto dkdm_sizer = new wxBoxSizer (wxHORIZONTAL); _dkdm = new wxTreeCtrl ( overall_panel, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTR_HIDE_ROOT | wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT ); - dkdm_sizer->Add (_dkdm, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP); - wxBoxSizer* dkdm_buttons = new wxBoxSizer(wxVERTICAL); + _dkdm->SetDropTarget(new DKDMDropTarget(this)); + dkdm_sizer->Add(_dkdm, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP); + auto dkdm_buttons = new wxBoxSizer(wxVERTICAL); _add_dkdm = new Button (overall_panel, _("Add...")); dkdm_buttons->Add (_add_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP); _add_dkdm_folder = new Button (overall_panel, _("Add folder...")); @@ -175,13 +212,13 @@ public: _export_dkdm = new Button (overall_panel, _("Export...")); dkdm_buttons->Add (_export_dkdm, 0, wxALL | wxEXPAND, DCPOMATIC_BUTTON_STACK_GAP); dkdm_sizer->Add (dkdm_buttons, 0, wxEXPAND | wxALL, DCPOMATIC_SIZER_GAP); - right->Add (dkdm_sizer, 1, wxEXPAND | wxALL, DCPOMATIC_SIZER_Y_GAP); + right->Add (dkdm_sizer, 1, wxEXPAND | wxBOTTOM, DCPOMATIC_SIZER_Y_GAP); - add_dkdm_view (Config::instance()->dkdms()); + update_dkdm_view(); h = new StaticText (overall_panel, _("Output")); h->SetFont (subheading_font); - right->Add (h, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP * 2); + right->Add(h, 0, wxTOP, DCPOMATIC_SUBHEADING_TOP_PAD); _output = new KDMOutputPanel (overall_panel); right->Add (_output, 0, wxALL, DCPOMATIC_SIZER_Y_GAP); @@ -196,13 +233,16 @@ public: _screens->ScreensChanged.connect (boost::bind (&DOMFrame::setup_sensitivity, this)); _create->Bind (wxEVT_BUTTON, bind (&DOMFrame::create_kdms, this)); - _dkdm->Bind (wxEVT_TREE_SEL_CHANGED, boost::bind (&DOMFrame::setup_sensitivity, this)); + _dkdm->Bind(wxEVT_TREE_SEL_CHANGED, boost::bind(&DOMFrame::dkdm_selection_changed, this)); _dkdm->Bind (wxEVT_TREE_BEGIN_DRAG, boost::bind (&DOMFrame::dkdm_begin_drag, this, _1)); _dkdm->Bind (wxEVT_TREE_END_DRAG, boost::bind (&DOMFrame::dkdm_end_drag, this, _1)); + _dkdm->Bind(wxEVT_TREE_ITEM_EXPANDED, boost::bind(&DOMFrame::dkdm_expanded, this, _1)); + _dkdm->Bind(wxEVT_TREE_ITEM_COLLAPSED, boost::bind(&DOMFrame::dkdm_collapsed, this, _1)); _add_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_clicked, this)); _add_dkdm_folder->Bind (wxEVT_BUTTON, bind (&DOMFrame::add_dkdm_folder_clicked, this)); _remove_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::remove_dkdm_clicked, this)); _export_dkdm->Bind (wxEVT_BUTTON, bind (&DOMFrame::export_dkdm_clicked, this)); + _dkdm_search->Bind(wxEVT_TEXT, boost::bind(&DOMFrame::dkdm_search_changed, this)); setup_sensitivity (); @@ -226,18 +266,16 @@ private: void help_about () { - auto d = new AboutDialog (this); - d->ShowModal (); - d->Destroy (); + AboutDialog dialog(this); + dialog.ShowModal(); } void help_report_a_problem () { - auto d = new ReportProblemDialog (this, shared_ptr()); - if (d->ShowModal () == wxID_OK) { - d->report (); + ReportProblemDialog dialog(this, shared_ptr()); + if (dialog.ShowModal() == wxID_OK) { + dialog.report(); } - d->Destroy (); } void setup_menu (wxMenuBar* m) @@ -274,10 +312,17 @@ private: bool confirm_overwrite (boost::filesystem::path path) { - return confirm_dialog ( - this, - wxString::Format (_("File %s already exists. Do you want to overwrite it?"), std_to_wx(path.string()).data()) - ); + if (boost::filesystem::is_directory(path)) { + return confirm_dialog ( + this, + wxString::Format(_("Folder %s already exists. Do you want to overwrite it?"), std_to_wx(path.string()).data()) + ); + } else { + return confirm_dialog ( + this, + wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(path.string()).data()) + ); + } } /** @id if not nullptr this is filled in with the wxTreeItemId of the selection */ @@ -316,56 +361,55 @@ private: string title; auto dkdm = std::dynamic_pointer_cast(dkdm_base); - if (dkdm) { + if (!dkdm) { + return; + } + + /* Decrypt the DKDM */ + dcp::DecryptedKDM decrypted (dkdm->dkdm(), Config::instance()->decryption_chain()->key().get()); + title = decrypted.content_title_text (); + + /* This is the signer for our new KDMs */ + auto signer = Config::instance()->signer_chain (); + if (!signer->valid ()) { + throw InvalidSignerError (); + } - /* Decrypt the DKDM */ - dcp::DecryptedKDM decrypted (dkdm->dkdm(), Config::instance()->decryption_chain()->key().get()); - title = decrypted.content_title_text (); + vector period_checks; - /* This is the signer for our new KDMs */ - auto signer = Config::instance()->signer_chain (); - if (!signer->valid ()) { - throw InvalidSignerError (); + std::function make_kdm = [decrypted, title](dcp::LocalTime begin, dcp::LocalTime end) { + /* Make an empty KDM */ + dcp::DecryptedKDM kdm ( + begin, + end, + decrypted.annotation_text().get_value_or(""), + title, + dcp::LocalTime().as_string() + ); + + /* Add keys from the DKDM */ + for (auto const& j: decrypted.keys()) { + kdm.add_key(j); } - for (auto i: _screens->screens()) { - - if (!i->recipient) { - continue; - } - - dcp::LocalTime begin(_timing->from(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()); - dcp::LocalTime end(_timing->until(), i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()); - - /* Make an empty KDM */ - dcp::DecryptedKDM kdm ( - begin, - end, - decrypted.annotation_text().get_value_or (""), - title, - dcp::LocalTime().as_string() - ); - - /* Add keys from the DKDM */ - for (auto const& j: decrypted.keys()) { - kdm.add_key (j); - } - - auto const encrypted = kdm.encrypt( - signer, i->recipient.get(), i->trusted_device_thumbprints(), _output->formulation(), - !_output->forensic_mark_video(), _output->forensic_mark_audio() ? boost::optional() : 0 - ); - - dcp::NameFormat::Map name_values; - name_values['c'] = i->cinema->name; - name_values['s'] = i->name; - name_values['f'] = title; - name_values['b'] = begin.date() + " " + begin.time_of_day(true, false); - name_values['e'] = end.date() + " " + end.time_of_day(true, false); - name_values['i'] = encrypted.cpl_id (); - - /* Encrypt */ - kdms.push_back (make_shared(name_values, i->cinema.get(), i->cinema->emails, encrypted)); + return kdm; + }; + + for (auto i: _screens->screens()) { + + auto kdm = kdm_for_screen( + make_kdm, + i, + _timing->from(), + _timing->until(), + _output->formulation(), + !_output->forensic_mark_video(), + _output->forensic_mark_audio() ? boost::optional() : 0, + period_checks + ); + + if (kdm) { + kdms.push_back(kdm); } } @@ -373,6 +417,21 @@ private: return; } + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE) != period_checks.end()) { + error_dialog( + this, + _("Some KDMs would have validity periods which are completely outside the recipient certificate periods. Such KDMs are very unlikely to work, so will not be created.") + ); + return; + } + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE) != period_checks.end()) { + message_dialog( + this, + _("For some of these KDMs the recipient certificate's validity period will not cover the whole of the KDM validity period. This might cause problems with the KDMs.") + ); + } + auto result = _output->make ( kdms, title, bind (&DOMFrame::confirm_overwrite, this, _1) ); @@ -395,6 +454,13 @@ private: wxString::Format (s, result.second, std_to_wx(_output->directory().string()).data()) ); } + } catch (dcp::BadKDMDateError& e) { + if (e.starts_too_early()) { + 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.")); + } else { + error_dialog(this, _("The KDM end period is after (or close to) the end of the signing certificates' validity period. Either use an earlier end time for this KDM or re-create your signing certificates in the DCP-o-matic preferences window.")); + } + return; } catch (dcp::NotEncryptedError& e) { error_dialog (this, _("CPL's content is not encrypted.")); } catch (exception& e) { @@ -417,6 +483,32 @@ private: _export_dkdm->Enable (sel.GetCount() > 0 && dkdm); } + void dkdm_selection_changed() + { + _selected_dkdm = selected_dkdm(); + setup_sensitivity(); + } + + void dkdm_expanded(wxTreeEvent& ev) + { + if (_ignore_expand) { + return; + } + + auto iter = _dkdm_id.find(ev.GetItem()); + if (iter != _dkdm_id.end()) { + _expanded_dkdm_groups.insert(iter->second); + } + } + + void dkdm_collapsed(wxTreeEvent& ev) + { + auto iter = _dkdm_id.find(ev.GetItem()); + if (iter != _dkdm_id.end()) { + _expanded_dkdm_groups.erase(iter->second); + } + } + void dkdm_begin_drag (wxTreeEvent& ev) { ev.Allow (); @@ -439,87 +531,125 @@ private: DCPOMATIC_ASSERT (from->second->parent ()); from->second->parent()->remove (from->second); - add_dkdm_model (from->second, group, dynamic_pointer_cast(to->second)); + add_dkdm(from->second, group, dynamic_pointer_cast(to->second)); - _dkdm->Delete (from->first); - _dkdm_id.erase (from->first); - add_dkdm_view (from->second, dynamic_pointer_cast(to->second) ? to->first : optional()); + update_dkdm_view(); } void add_dkdm_clicked () { - auto d = new wxFileDialog( - this, - _("Select DKDM file"), - wxEmptyString, - wxEmptyString, - wxT("XML files|*.xml|All files|*.*"), - wxFD_MULTIPLE - ); + FileDialog dialog(this, _("Select DKDM file"), wxT("XML files|*.xml|All files|*.*"), wxFD_MULTIPLE, "AddDKDMPath"); + if (!dialog.show()) { + return; + } - if (d->ShowModal() == wxID_OK) { - auto chain = Config::instance()->decryption_chain(); - DCPOMATIC_ASSERT (chain->key()); - - wxArrayString paths; - d->GetPaths(paths); - for (unsigned int i = 0; i < paths.GetCount(); ++i) { - try { - dcp::EncryptedKDM ekdm(dcp::file_to_string(wx_to_std(paths[i]), MAX_KDM_SIZE)); - /* Decrypt the DKDM to make sure that we can */ - dcp::DecryptedKDM dkdm(ekdm, chain->key().get()); - - auto new_dkdm = make_shared(ekdm); - auto group = dynamic_pointer_cast (selected_dkdm()); - if (!group) { - group = Config::instance()->dkdms (); - } - add_dkdm_model (new_dkdm, group); - add_dkdm_view (new_dkdm); - } catch (dcp::KDMFormatError& e) { - error_dialog ( - this, - _("Could not read file as a KDM. Perhaps it is badly formatted, or not a KDM at all."), - std_to_wx(e.what()) - ); - return; - } catch (dcp::KDMDecryptionError &) { - error_dialog ( - this, - _("Could not decrypt the DKDM. Perhaps it was not created with the correct certificate.") - ); - } catch (dcp::MiscError& e) { - error_dialog ( - this, - _("Could not read file as a KDM. It is much too large. Make sure you are loading a DKDM (XML) file."), - std_to_wx(e.what()) - ); - } + for (auto path: dialog.paths()) { + add_dkdm(path); + } + } + + void add_dkdm(boost::filesystem::path path) + { + auto chain = Config::instance()->decryption_chain(); + DCPOMATIC_ASSERT (chain->key()); + + try { + dcp::EncryptedKDM ekdm(dcp::file_to_string(path, MAX_KDM_SIZE)); + /* Decrypt the DKDM to make sure that we can */ + dcp::DecryptedKDM dkdm(ekdm, chain->key().get()); + + auto new_dkdm = make_shared(ekdm); + auto group = dynamic_pointer_cast (selected_dkdm()); + if (!group) { + group = Config::instance()->dkdms (); } + add_dkdm(new_dkdm, group); + } catch (dcp::KDMFormatError& e) { + error_dialog ( + this, + _("Could not read file as a KDM. Perhaps it is badly formatted, or not a KDM at all."), + std_to_wx(e.what()) + ); + return; + } catch (dcp::KDMDecryptionError &) { + error_dialog ( + this, + _("Could not decrypt the DKDM. Perhaps it was not created with the correct certificate.") + ); + } catch (dcp::MiscError& e) { + error_dialog ( + this, + _("Could not read file as a KDM. It is much too large. Make sure you are loading a DKDM (XML) file."), + std_to_wx(e.what()) + ); } - d->Destroy (); + + update_dkdm_view(); } void add_dkdm_folder_clicked () { - auto d = new NewDKDMFolderDialog (this); - if (d->ShowModal() == wxID_OK) { - auto new_dkdm = make_shared(wx_to_std(d->get())); - auto parent = dynamic_pointer_cast(selected_dkdm()); - if (!parent) { - parent = Config::instance()->dkdms (); + NewDKDMFolderDialog dialog(this); + if (dialog.ShowModal() != wxID_OK) { + return; + } + + auto new_dkdm = make_shared(wx_to_std(dialog.get())); + auto parent = dynamic_pointer_cast(selected_dkdm()); + if (!parent) { + parent = Config::instance()->dkdms (); + } + add_dkdm(new_dkdm, parent); + update_dkdm_view(); + } + + void update_dkdm_view() + { + _dkdm->DeleteAllItems(); + _dkdm_id.clear(); + add_dkdm_to_view(Config::instance()->dkdms()); + if (_selected_dkdm) { + auto selection_in_id_map = std::find_if(_dkdm_id.begin(), _dkdm_id.end(), [this](pair> const& entry) { + return entry.second == _selected_dkdm; + }); + if (selection_in_id_map != _dkdm_id.end()) { + _dkdm->SelectItem(selection_in_id_map->first); } - add_dkdm_model (new_dkdm, parent); - add_dkdm_view (new_dkdm); } - d->Destroy (); } - /** @param dkdm Thing to add. - * @param parent Parent group, or 0. - */ - void add_dkdm_view (shared_ptr base, optional previous = optional()) + /** @return true if this thing or any of its children match a search string */ + bool matches(shared_ptr base, string const& search) { + if (search.empty()) { + return true; + } + + auto name = base->name(); + transform(name.begin(), name.end(), name.begin(), ::tolower); + if (name.find(search) != string::npos) { + return true; + } + + auto group = dynamic_pointer_cast(base); + if (!group) { + return false; + } + + auto const children = group->children(); + return std::any_of(children.begin(), children.end(), [this, search](shared_ptr child) { + return matches(child, search); + }); + } + + /** Add DKDMs to the view that match the current search */ + void add_dkdm_to_view(shared_ptr base) + { + auto search = wx_to_std(_dkdm_search->GetValue()); + transform(search.begin(), search.end(), search.begin(), ::tolower); + + optional group_to_expand; + if (!base->parent()) { /* This is the root group */ _dkdm_id[_dkdm->AddRoot("root")] = base; @@ -527,26 +657,38 @@ private: /* Add base to the view */ wxTreeItemId added; auto parent_id = dkdm_to_id(base->parent()); - if (previous) { - added = _dkdm->InsertItem(parent_id, *previous, std_to_wx(base->name())); - } else { - added = _dkdm->AppendItem(parent_id, std_to_wx(base->name())); + added = _dkdm->AppendItem(parent_id, std_to_wx(base->name())); + /* Expand the group (later) if it matches the search or it was manually expanded */ + if (!search.empty() || _expanded_dkdm_groups.find(base) != _expanded_dkdm_groups.end()) { + group_to_expand = added; } - _dkdm->SortChildren(parent_id); _dkdm_id[added] = base; } /* Add children */ - auto g = dynamic_pointer_cast(base); - if (g) { - for (auto i: g->children()) { - add_dkdm_view (i); + auto group = dynamic_pointer_cast(base); + if (group) { + auto children = group->children(); + children.sort( + [this](shared_ptr a, shared_ptr b) { return _collator.compare(a->name(), b->name()) < 0; } + ); + + for (auto i: children) { + if (matches(i, search)) { + add_dkdm_to_view(i); + } } } + + if (group_to_expand) { + _ignore_expand = true; + _dkdm->Expand(*group_to_expand); + _ignore_expand = false; + } } /** @param group Group to add dkdm to */ - void add_dkdm_model (shared_ptr dkdm, shared_ptr group, shared_ptr previous = shared_ptr ()) + void add_dkdm(shared_ptr dkdm, shared_ptr group, shared_ptr previous = shared_ptr()) { group->add (dkdm, previous); /* We're messing with a Config-owned object here, so tell it that something has changed. @@ -598,23 +740,38 @@ private: return; } - auto d = new wxFileDialog ( + wxFileDialog dialog( this, _("Select DKDM File"), wxEmptyString, wxEmptyString, wxT("XML files (*.xml)|*.xml"), wxFD_SAVE | wxFD_OVERWRITE_PROMPT ); - if (d->ShowModal() == wxID_OK) { - dkdm->dkdm().as_xml(wx_to_std(d->GetPath())); + if (dialog.ShowModal() == wxID_OK) { + dkdm->dkdm().as_xml(wx_to_std(dialog.GetPath())); } - d->Destroy (); + } + + void dkdm_search_changed() + { + update_dkdm_view(); } wxPreferencesEditor* _config_dialog; ScreensPanel* _screens; KDMTimingPanel* _timing; wxTreeCtrl* _dkdm; + wxSearchCtrl* _dkdm_search; typedef std::map> DKDMMap; DKDMMap _dkdm_id; + /* Keep a separate track of the selected DKDM so that when a search happens, and some things + * get removed from the view, we can restore the selection when they are re-added. + */ + shared_ptr _selected_dkdm; + /* Keep expanded groups for the same reason */ + unordered_set> _expanded_dkdm_groups; + /* true if we are "artificially" expanding a group because it contains something found + * in a search. + */ + bool _ignore_expand = false; wxButton* _add_dkdm; wxButton* _add_dkdm_folder; wxButton* _remove_dkdm; @@ -622,6 +779,7 @@ private: wxButton* _create; KDMOutputPanel* _output; JobViewDialog* _job_view; + Collator _collator; }; @@ -640,7 +798,7 @@ private: bool OnInit () override { - wxSplashScreen* splash = nullptr; + wxSplashScreen* splash; try { wxInitAllImageHandlers ();