src/wx/kdm_output_panel.cc

   1 /*
   2     Copyright (C) 2015-2022 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 "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"
  29 #include "wx_util.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"
  38 #else
  39 DCPOMATIC_DISABLE_WARNINGS
  40 #include <wx/filepicker.h>
  41 DCPOMATIC_ENABLE_WARNINGS
  42 #endif
  43 DCPOMATIC_DISABLE_WARNINGS
  44 #include <wx/stdpaths.h>
  45 DCPOMATIC_ENABLE_WARNINGS
  46
  47
  48 using std::exception;
  49 using std::function;
  50 using std::list;
  51 using std::make_pair;
  52 using std::pair;
  53 using std::shared_ptr;
  54 using std::string;
  55 #if BOOST_VERSION >= 106100
  56 using namespace boost::placeholders;
  57 #endif
  58
  59
  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)
  65 {
  66         auto table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
  67         table->AddGrowableCol (1);
  68
  69         add_label_to_sizer (table, this, _("KDM type"), true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTRE_VERTICAL);
  70
  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);
  83
  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);
  87
  88         auto format = create_label (this, _("Filename format"), true);
  89         auto align = new wxBoxSizer (wxHORIZONTAL);
  90 #ifdef DCPOMATIC_OSX
  91         align->Add (format, 0, wxTOP, 2);
  92         table->Add (align, 0, wxALIGN_RIGHT | wxRIGHT, DCPOMATIC_SIZER_GAP - 2);
  93 #else
  94         align->Add (format, 0, wxLEFT, DCPOMATIC_SIZER_GAP - 2);
  95         table->Add (align, 0, wxTOP | wxRIGHT | wxALIGN_TOP, DCPOMATIC_SIZER_GAP);
  96 #endif
  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;
 104         ex['f'] = "Bambi";
 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);
 111
 112         _write_to = new CheckBox (this, _("Write to"));
 113         table->Add (_write_to, 1, wxEXPAND);
 114
 115 #ifdef DCPOMATIC_USE_OWN_PICKER
 116         _folder = new DirPickerCtrl (this);
 117 #else
 118         _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
 119 #endif
 120
 121         auto path = Config::instance()->default_kdm_directory ();
 122         if (path) {
 123                 _folder->SetPath (std_to_wx (path->string ()));
 124         } else {
 125                 _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
 126         }
 127
 128         table->Add (_folder, 1, wxEXPAND);
 129
 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);
 139
 140         _email = new CheckBox (this, _("Send by email"));
 141         table->Add (_email, 1, wxEXPAND);
 142         table->AddSpacer (0);
 143
 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);
 147                 break;
 148         case Config::KDM_WRITE_FOLDER:
 149                 _write_folder->SetValue (true);
 150                 break;
 151         case Config::KDM_WRITE_ZIP:
 152                 _write_zip->SetValue (true);
 153                 break;
 154         }
 155
 156         _write_to->SetValue (true);
 157
 158         _write_to->Bind     (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 159         _email->Bind        (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 160         _write_flat->Bind   (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 161         _write_folder->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 162         _write_zip->Bind    (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 163         advanced->Bind      (wxEVT_BUTTON, boost::bind (&KDMOutputPanel::advanced_clicked, this));
 164
 165         SetSizer (table);
 166 }
 167
 168
 169 void
 170 KDMOutputPanel::setup_sensitivity ()
 171 {
 172         bool const write = _write_to->GetValue ();
 173         _folder->Enable (write);
 174         _write_flat->Enable (write);
 175         _write_folder->Enable (write);
 176         _write_zip->Enable (write);
 177 }
 178
 179
 180 void
 181 KDMOutputPanel::advanced_clicked ()
 182 {
 183         auto d = new KDMAdvancedDialog (this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
 184         d->ShowModal ();
 185         _forensic_mark_video = d->forensic_mark_video ();
 186         _forensic_mark_audio = d->forensic_mark_audio ();
 187         _forensic_mark_audio_up_to = d->forensic_mark_audio_up_to ();
 188         d->Destroy ();
 189 }
 190
 191
 192 void
 193 KDMOutputPanel::kdm_write_type_changed ()
 194 {
 195         if (_write_flat->GetValue()) {
 196                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FLAT);
 197         } else if (_write_folder->GetValue()) {
 198                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FOLDER);
 199         } else if (_write_zip->GetValue()) {
 200                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_ZIP);
 201         }
 202 }
 203
 204
 205 pair<shared_ptr<Job>, int>
 206 KDMOutputPanel::make (
 207         list<KDMWithMetadataPtr> kdms, string name, function<bool (boost::filesystem::path)> confirm_overwrite
 208         )
 209 {
 210         auto const cinema_kdms = collect (kdms);
 211
 212         /* Decide whether to proceed */
 213
 214         bool proceed = true;
 215
 216         if (_email->GetValue ()) {
 217
 218                 if (Config::instance()->mail_server().empty ()) {
 219                         proceed = false;
 220                         error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
 221                 }
 222
 223                 bool const cinemas_with_no_email = std::any_of(
 224                         cinema_kdms.begin(), cinema_kdms.end(),
 225                         [](list<KDMWithMetadataPtr> const& list) { return list.front()->emails().empty(); }
 226                         );
 227
 228                 if (proceed && cinemas_with_no_email && !confirm_dialog (
 229                             this,
 230                             _("You have selected some cinemas that have no configured email address.  Do you want to continue?")
 231                             )) {
 232                         proceed = false;
 233                 }
 234
 235                 if (proceed && Config::instance()->confirm_kdm_email ()) {
 236                         list<string> emails;
 237                         for (auto const& i: cinema_kdms) {
 238                                 for (auto j: i.front()->emails()) {
 239                                         emails.push_back (j);
 240                                 }
 241                         }
 242
 243                         if (!emails.empty ()) {
 244                                 auto d = new ConfirmKDMEmailDialog (this, emails);
 245                                 if (d->ShowModal() == wxID_CANCEL) {
 246                                         proceed = false;
 247                                 }
 248                         }
 249                 }
 250         }
 251
 252         if (!proceed) {
 253                 return {};
 254         }
 255
 256         Config::instance()->set_kdm_filename_format (_filename_format->get ());
 257
 258         int written = 0;
 259         shared_ptr<Job> job;
 260
 261         try {
 262
 263                 if (_write_to->GetValue()) {
 264                         if (_write_flat->GetValue()) {
 265                                 written = write_files (
 266                                         kdms,
 267                                         directory(),
 268                                         _filename_format->get(),
 269                                         confirm_overwrite
 270                                         );
 271                         } else if (_write_folder->GetValue()) {
 272                                 written = write_directories (
 273                                         collect (kdms),
 274                                         directory(),
 275                                         _container_name_format->get(),
 276                                         _filename_format->get(),
 277                                         confirm_overwrite
 278                                         );
 279                         } else if (_write_zip->GetValue()) {
 280                                 written = write_zip_files (
 281                                         collect (kdms),
 282                                         directory(),
 283                                         _container_name_format->get(),
 284                                         _filename_format->get(),
 285                                         confirm_overwrite
 286                                         );
 287                         }
 288                 }
 289
 290                 if (_email->GetValue ()) {
 291                         job.reset (
 292                                 new SendKDMEmailJob (
 293                                         cinema_kdms,
 294                                         _container_name_format->get(),
 295                                         _filename_format->get(),
 296                                         name
 297                                         )
 298                                 );
 299                 }
 300
 301         } catch (dcp::NotEncryptedError& e) {
 302                 error_dialog (this, _("CPL's content is not encrypted."));
 303         } catch (exception& e) {
 304                 error_dialog (this, std_to_wx(e.what()));
 305         } catch (...) {
 306                 error_dialog (this, _("An unknown exception occurred."));
 307         }
 308
 309         return make_pair (job, written);
 310 }
 311
 312
 313 dcp::Formulation
 314 KDMOutputPanel::formulation () const
 315 {
 316         return (dcp::Formulation) reinterpret_cast<intptr_t> (_type->GetClientData (_type->GetSelection()));
 317 }
 318
 319
 320 boost::filesystem::path
 321 KDMOutputPanel::directory () const
 322 {
 323         return wx_to_std (_folder->GetPath ());
 324 }