2 Copyright (C) 2015-2022 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 "check_box.h"
23 #include "confirm_kdm_email_dialog.h"
24 #include "dcpomatic_button.h"
25 #include "kdm_advanced_dialog.h"
26 #include "kdm_output_panel.h"
27 #include "kdm_timing_panel.h"
28 #include "name_format_editor.h"
30 #include "lib/cinema.h"
31 #include "lib/config.h"
32 #include "lib/send_kdm_email_job.h"
33 #include "lib/warnings.h"
34 #include <dcp/exceptions.h>
35 #include <dcp/types.h>
36 #ifdef DCPOMATIC_USE_OWN_PICKER
37 #include "dir_picker_ctrl.h"
39 DCPOMATIC_DISABLE_WARNINGS
40 #include <wx/filepicker.h>
41 DCPOMATIC_ENABLE_WARNINGS
43 DCPOMATIC_DISABLE_WARNINGS
44 #include <wx/stdpaths.h>
45 DCPOMATIC_ENABLE_WARNINGS
52 using std::make_shared;
54 using std::shared_ptr;
56 #if BOOST_VERSION >= 106100
57 using namespace boost::placeholders;
61 KDMOutputPanel::KDMOutputPanel (wxWindow* parent)
62 : wxPanel (parent, wxID_ANY)
63 , _forensic_mark_video (true)
64 , _forensic_mark_audio (true)
65 , _forensic_mark_audio_up_to (12)
67 auto table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
68 table->AddGrowableCol (1);
70 add_label_to_sizer (table, this, _("KDM type"), true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTRE_VERTICAL);
72 auto type = new wxBoxSizer (wxHORIZONTAL);
73 _type = new wxChoice (this, wxID_ANY);
74 _type->Append ("Modified Transitional 1", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_1));
75 _type->Append ("DCI Any", ((void *) dcp::Formulation::DCI_ANY));
76 _type->Append ("DCI Specific", ((void *) dcp::Formulation::DCI_SPECIFIC));
77 _type->Append ("Multiple Modified Transitional 1", ((void *) dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1));
78 _type->Append ("Modified Transitional 1 (without AuthorizedDeviceInfo)", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_TEST));
79 type->Add (_type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
80 _type->SetSelection (0);
81 auto advanced = new Button (this, _("Advanced..."));
82 type->Add (advanced, 0, wxLEFT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
83 table->Add (type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
85 add_label_to_sizer (table, this, _("Folder / ZIP name format"), true, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
86 _container_name_format = new NameFormatEditor (this, Config::instance()->kdm_container_name_format(), dcp::NameFormat::Map(), dcp::NameFormat::Map(), "");
87 table->Add (_container_name_format->panel(), 1, wxEXPAND);
89 auto format = create_label (this, _("Filename format"), true);
90 auto align = new wxBoxSizer (wxHORIZONTAL);
92 align->Add (format, 0, wxTOP, 2);
93 table->Add (align, 0, wxALIGN_RIGHT | wxRIGHT, DCPOMATIC_SIZER_GAP - 2);
95 align->Add (format, 0, wxLEFT, DCPOMATIC_SIZER_GAP - 2);
96 table->Add (align, 0, wxTOP | wxRIGHT | wxALIGN_TOP, DCPOMATIC_SIZER_GAP);
98 dcp::NameFormat::Map titles;
99 titles['f'] = wx_to_std (_("film name"));
100 titles['c'] = wx_to_std (_("cinema"));
101 titles['s'] = wx_to_std (_("screen"));
102 titles['b'] = wx_to_std (_("from date/time"));
103 titles['e'] = wx_to_std (_("to date/time"));
104 dcp::NameFormat::Map ex;
106 ex['c'] = "Lumière";
107 ex['s'] = "Screen 1";
108 ex['b'] = "2012/03/15 12:30";
109 ex['e'] = "2012/03/22 02:30";
110 _filename_format = new NameFormatEditor (this, Config::instance()->kdm_filename_format(), titles, ex, ".xml");
111 table->Add (_filename_format->panel(), 1, wxEXPAND);
113 _write_to = new CheckBox (this, _("Write to"));
114 table->Add (_write_to, 1, wxEXPAND);
116 #ifdef DCPOMATIC_USE_OWN_PICKER
117 _folder = new DirPickerCtrl (this);
119 _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
122 auto path = Config::instance()->default_kdm_directory();
124 _folder->SetPath (std_to_wx (path->string ()));
126 _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
129 table->Add (_folder, 1, wxEXPAND);
131 auto write_options = new wxBoxSizer(wxVERTICAL);
132 _write_flat = new wxRadioButton (this, wxID_ANY, _("Write all KDMs to the same folder"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
133 write_options->Add (_write_flat, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
134 _write_folder = new wxRadioButton (this, wxID_ANY, _("Write a folder for each cinema's KDMs"));
135 write_options->Add (_write_folder, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
136 _write_zip = new wxRadioButton (this, wxID_ANY, _("Write a ZIP file for each cinema's KDMs"));
137 write_options->Add (_write_zip, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
138 table->AddSpacer (0);
139 table->Add (write_options);
141 _email = new CheckBox (this, _("Send by email"));
142 table->Add (_email, 1, wxEXPAND);
143 table->AddSpacer (0);
145 switch (Config::instance()->last_kdm_write_type().get_value_or(Config::KDM_WRITE_FLAT)) {
146 case Config::KDM_WRITE_FLAT:
147 _write_flat->SetValue (true);
149 case Config::KDM_WRITE_FOLDER:
150 _write_folder->SetValue (true);
152 case Config::KDM_WRITE_ZIP:
153 _write_zip->SetValue (true);
157 _write_to->SetValue (Config::instance()->write_kdms_to_disk());
158 _email->SetValue (Config::instance()->email_kdms());
160 _write_to->Bind (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::write_to_changed, this));
161 _email->Bind (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::email_changed, this));
162 _write_flat->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
163 _write_folder->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
164 _write_zip->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
165 advanced->Bind (wxEVT_BUTTON, boost::bind (&KDMOutputPanel::advanced_clicked, this));
172 KDMOutputPanel::write_to_changed ()
174 Config::instance()->set_write_kdms_to_disk(_write_to->GetValue());
175 setup_sensitivity ();
180 KDMOutputPanel::email_changed ()
182 Config::instance()->set_email_kdms(_email->GetValue());
183 setup_sensitivity ();
188 KDMOutputPanel::setup_sensitivity ()
190 bool const write = _write_to->GetValue ();
191 _folder->Enable (write);
192 _write_flat->Enable (write);
193 _write_folder->Enable (write);
194 _write_zip->Enable (write);
199 KDMOutputPanel::advanced_clicked ()
201 auto d = new KDMAdvancedDialog (this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
203 _forensic_mark_video = d->forensic_mark_video ();
204 _forensic_mark_audio = d->forensic_mark_audio ();
205 _forensic_mark_audio_up_to = d->forensic_mark_audio_up_to ();
211 KDMOutputPanel::kdm_write_type_changed ()
213 if (_write_flat->GetValue()) {
214 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FLAT);
215 } else if (_write_folder->GetValue()) {
216 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FOLDER);
217 } else if (_write_zip->GetValue()) {
218 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_ZIP);
223 pair<shared_ptr<Job>, int>
224 KDMOutputPanel::make (
225 list<KDMWithMetadataPtr> kdms, string name, function<bool (boost::filesystem::path)> confirm_overwrite
228 auto const cinema_kdms = collect (kdms);
230 /* Decide whether to proceed */
234 if (_email->GetValue ()) {
236 if (Config::instance()->mail_server().empty ()) {
238 error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
241 bool const cinemas_with_no_email = std::any_of(
242 cinema_kdms.begin(), cinema_kdms.end(),
243 [](list<KDMWithMetadataPtr> const& list) { return list.front()->emails().empty(); }
246 if (proceed && cinemas_with_no_email && !confirm_dialog (
248 _("You have selected some cinemas that have no configured email address. Do you want to continue?")
253 if (proceed && Config::instance()->confirm_kdm_email ()) {
255 for (auto const& i: cinema_kdms) {
256 for (auto j: i.front()->emails()) {
257 emails.push_back (j);
261 if (!emails.empty ()) {
262 auto d = new ConfirmKDMEmailDialog (this, emails);
263 if (d->ShowModal() == wxID_CANCEL) {
275 Config::instance()->set_kdm_filename_format (_filename_format->get ());
282 if (_write_to->GetValue()) {
283 if (_write_flat->GetValue()) {
284 written = write_files (
287 _filename_format->get(),
290 } else if (_write_folder->GetValue()) {
291 written = write_directories (
294 _container_name_format->get(),
295 _filename_format->get(),
298 } else if (_write_zip->GetValue()) {
299 written = write_zip_files (
302 _container_name_format->get(),
303 _filename_format->get(),
309 if (_email->GetValue ()) {
310 job = make_shared<SendKDMEmailJob>(
312 _container_name_format->get(),
313 _filename_format->get(),
318 } catch (dcp::NotEncryptedError& e) {
319 error_dialog (this, _("CPL's content is not encrypted."));
320 } catch (exception& e) {
321 error_dialog (this, std_to_wx(e.what()));
323 error_dialog (this, _("An unknown exception occurred."));
326 return make_pair (job, written);
331 KDMOutputPanel::formulation () const
333 return (dcp::Formulation) reinterpret_cast<intptr_t> (_type->GetClientData (_type->GetSelection()));
337 boost::filesystem::path
338 KDMOutputPanel::directory () const
340 return wx_to_std (_folder->GetPath ());