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
53 using std::shared_ptr;
55 #if BOOST_VERSION >= 106100
56 using namespace boost::placeholders;
60 KDMOutputPanel::KDMOutputPanel (wxWindow* parent)
61 : wxPanel (parent, wxID_ANY)
62 , _forensic_mark_video (true)
63 , _forensic_mark_audio (true)
64 , _forensic_mark_audio_up_to (12)
66 auto table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
67 table->AddGrowableCol (1);
69 add_label_to_sizer (table, this, _("KDM type"), true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTRE_VERTICAL);
71 auto type = new wxBoxSizer (wxHORIZONTAL);
72 _type = new wxChoice (this, wxID_ANY);
73 _type->Append ("Modified Transitional 1", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_1));
74 _type->Append ("DCI Any", ((void *) dcp::Formulation::DCI_ANY));
75 _type->Append ("DCI Specific", ((void *) dcp::Formulation::DCI_SPECIFIC));
76 _type->Append ("Multiple Modified Transitional 1", ((void *) dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1));
77 _type->Append ("Modified Transitional 1 (without AuthorizedDeviceInfo)", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_TEST));
78 type->Add (_type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
79 _type->SetSelection (0);
80 auto advanced = new Button (this, _("Advanced..."));
81 type->Add (advanced, 0, wxLEFT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
82 table->Add (type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
84 add_label_to_sizer (table, this, _("Folder / ZIP name format"), true, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
85 _container_name_format = new NameFormatEditor (this, Config::instance()->kdm_container_name_format(), dcp::NameFormat::Map(), dcp::NameFormat::Map(), "");
86 table->Add (_container_name_format->panel(), 1, wxEXPAND);
88 auto format = create_label (this, _("Filename format"), true);
89 auto align = new wxBoxSizer (wxHORIZONTAL);
91 align->Add (format, 0, wxTOP, 2);
92 table->Add (align, 0, wxALIGN_RIGHT | wxRIGHT, DCPOMATIC_SIZER_GAP - 2);
94 align->Add (format, 0, wxLEFT, DCPOMATIC_SIZER_GAP - 2);
95 table->Add (align, 0, wxTOP | wxRIGHT | wxALIGN_TOP, DCPOMATIC_SIZER_GAP);
97 dcp::NameFormat::Map titles;
98 titles['f'] = wx_to_std (_("film name"));
99 titles['c'] = wx_to_std (_("cinema"));
100 titles['s'] = wx_to_std (_("screen"));
101 titles['b'] = wx_to_std (_("from date/time"));
102 titles['e'] = wx_to_std (_("to date/time"));
103 dcp::NameFormat::Map ex;
105 ex['c'] = "Lumière";
106 ex['s'] = "Screen 1";
107 ex['b'] = "2012/03/15 12:30";
108 ex['e'] = "2012/03/22 02:30";
109 _filename_format = new NameFormatEditor (this, Config::instance()->kdm_filename_format(), titles, ex, ".xml");
110 table->Add (_filename_format->panel(), 1, wxEXPAND);
112 _write_to = new CheckBox (this, _("Write to"));
113 table->Add (_write_to, 1, wxEXPAND);
115 #ifdef DCPOMATIC_USE_OWN_PICKER
116 _folder = new DirPickerCtrl (this);
118 _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
121 auto path = Config::instance()->default_kdm_directory ();
123 _folder->SetPath (std_to_wx (path->string ()));
125 _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
128 table->Add (_folder, 1, wxEXPAND);
130 auto write_options = new wxBoxSizer(wxVERTICAL);
131 _write_flat = new wxRadioButton (this, wxID_ANY, _("Write all KDMs to the same folder"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
132 write_options->Add (_write_flat, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
133 _write_folder = new wxRadioButton (this, wxID_ANY, _("Write a folder for each cinema's KDMs"));
134 write_options->Add (_write_folder, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
135 _write_zip = new wxRadioButton (this, wxID_ANY, _("Write a ZIP file for each cinema's KDMs"));
136 write_options->Add (_write_zip, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
137 table->AddSpacer (0);
138 table->Add (write_options);
140 _email = new CheckBox (this, _("Send by email"));
141 table->Add (_email, 1, wxEXPAND);
142 table->AddSpacer (0);
144 switch (Config::instance()->last_kdm_write_type().get_value_or(Config::KDM_WRITE_FLAT)) {
145 case Config::KDM_WRITE_FLAT:
146 _write_flat->SetValue (true);
148 case Config::KDM_WRITE_FOLDER:
149 _write_folder->SetValue (true);
151 case Config::KDM_WRITE_ZIP:
152 _write_zip->SetValue (true);
156 _write_to->SetValue (Config::instance()->write_kdms_to_disk());
157 _email->SetValue (Config::instance()->email_kdms());
159 _write_to->Bind (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::write_to_changed, this));
160 _email->Bind (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::email_changed, this));
161 _write_flat->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
162 _write_folder->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
163 _write_zip->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
164 advanced->Bind (wxEVT_BUTTON, boost::bind (&KDMOutputPanel::advanced_clicked, this));
171 KDMOutputPanel::write_to_changed ()
173 Config::instance()->set_write_kdms_to_disk(_write_to->GetValue());
174 setup_sensitivity ();
179 KDMOutputPanel::email_changed ()
181 Config::instance()->set_email_kdms(_email->GetValue());
182 setup_sensitivity ();
187 KDMOutputPanel::setup_sensitivity ()
189 bool const write = _write_to->GetValue ();
190 _folder->Enable (write);
191 _write_flat->Enable (write);
192 _write_folder->Enable (write);
193 _write_zip->Enable (write);
198 KDMOutputPanel::advanced_clicked ()
200 auto d = new KDMAdvancedDialog (this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
202 _forensic_mark_video = d->forensic_mark_video ();
203 _forensic_mark_audio = d->forensic_mark_audio ();
204 _forensic_mark_audio_up_to = d->forensic_mark_audio_up_to ();
210 KDMOutputPanel::kdm_write_type_changed ()
212 if (_write_flat->GetValue()) {
213 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FLAT);
214 } else if (_write_folder->GetValue()) {
215 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FOLDER);
216 } else if (_write_zip->GetValue()) {
217 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_ZIP);
222 pair<shared_ptr<Job>, int>
223 KDMOutputPanel::make (
224 list<KDMWithMetadataPtr> kdms, string name, function<bool (boost::filesystem::path)> confirm_overwrite
227 auto const cinema_kdms = collect (kdms);
229 /* Decide whether to proceed */
233 if (_email->GetValue ()) {
235 if (Config::instance()->mail_server().empty ()) {
237 error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
240 bool const cinemas_with_no_email = std::any_of(
241 cinema_kdms.begin(), cinema_kdms.end(),
242 [](list<KDMWithMetadataPtr> const& list) { return list.front()->emails().empty(); }
245 if (proceed && cinemas_with_no_email && !confirm_dialog (
247 _("You have selected some cinemas that have no configured email address. Do you want to continue?")
252 if (proceed && Config::instance()->confirm_kdm_email ()) {
254 for (auto const& i: cinema_kdms) {
255 for (auto j: i.front()->emails()) {
256 emails.push_back (j);
260 if (!emails.empty ()) {
261 auto d = new ConfirmKDMEmailDialog (this, emails);
262 if (d->ShowModal() == wxID_CANCEL) {
273 Config::instance()->set_kdm_filename_format (_filename_format->get ());
280 if (_write_to->GetValue()) {
281 if (_write_flat->GetValue()) {
282 written = write_files (
285 _filename_format->get(),
288 } else if (_write_folder->GetValue()) {
289 written = write_directories (
292 _container_name_format->get(),
293 _filename_format->get(),
296 } else if (_write_zip->GetValue()) {
297 written = write_zip_files (
300 _container_name_format->get(),
301 _filename_format->get(),
307 if (_email->GetValue ()) {
309 new SendKDMEmailJob (
311 _container_name_format->get(),
312 _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 ());