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 "extra_kdm_email_dialog.h"
  26 #include "kdm_advanced_dialog.h"
  27 #include "kdm_choice.h"
  28 #include "kdm_output_panel.h"
  29 #include "kdm_timing_panel.h"
  30 #include "name_format_editor.h"
  31 #include "wx_util.h"
  32 #include "lib/cinema.h"
  33 #include "lib/config.h"
  34 #include "lib/send_kdm_email_job.h"
  35 #include <dcp/exceptions.h>
  36 #include <dcp/types.h>
  37 #include <dcp/warnings.h>
  38 #ifdef DCPOMATIC_USE_OWN_PICKER
  39 #include "dir_picker_ctrl.h"
  40 #else
  41 LIBDCP_DISABLE_WARNINGS
  42 #include <wx/filepicker.h>
  43 LIBDCP_ENABLE_WARNINGS
  44 #endif
  45 LIBDCP_DISABLE_WARNINGS
  46 #include <wx/stdpaths.h>
  47 LIBDCP_ENABLE_WARNINGS
  48
  49
  50 using std::exception;
  51 using std::function;
  52 using std::list;
  53 using std::make_pair;
  54 using std::make_shared;
  55 using std::pair;
  56 using std::shared_ptr;
  57 using std::string;
  58 #if BOOST_VERSION >= 106100
  59 using namespace boost::placeholders;
  60 #endif
  61
  62
  63 KDMOutputPanel::KDMOutputPanel (wxWindow* parent)
  64         : wxPanel (parent, wxID_ANY)
  65         , _forensic_mark_video (true)
  66         , _forensic_mark_audio (true)
  67         , _forensic_mark_audio_up_to (12)
  68 {
  69         auto table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
  70         table->AddGrowableCol (1);
  71
  72         add_label_to_sizer (table, this, _("KDM type"), true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTRE_VERTICAL);
  73
  74         auto type = new wxBoxSizer (wxHORIZONTAL);
  75         _type = new KDMChoice (this);
  76         type->Add (_type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
  77         _type->set(Config::instance()->default_kdm_type());
  78         auto advanced = new Button (this, _("Advanced..."));
  79         type->Add (advanced, 0, wxLEFT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
  80         table->Add (type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
  81
  82         add_label_to_sizer (table, this, _("Folder / ZIP name format"), true, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
  83         _container_name_format = new NameFormatEditor (this, Config::instance()->kdm_container_name_format(), dcp::NameFormat::Map(), dcp::NameFormat::Map(), "");
  84         table->Add (_container_name_format->panel(), 1, wxEXPAND);
  85
  86         auto format = create_label (this, _("Filename format"), true);
  87         auto align = new wxBoxSizer (wxHORIZONTAL);
  88 #ifdef DCPOMATIC_OSX
  89         align->Add (format, 0, wxTOP, 2);
  90         table->Add (align, 0, wxALIGN_RIGHT | wxRIGHT, DCPOMATIC_SIZER_GAP - 2);
  91 #else
  92         align->Add (format, 0, wxLEFT, DCPOMATIC_SIZER_GAP - 2);
  93         table->Add (align, 0, wxTOP | wxRIGHT | wxALIGN_TOP, DCPOMATIC_SIZER_GAP);
  94 #endif
  95         dcp::NameFormat::Map titles;
  96         titles['f'] = wx_to_std (_("film name"));
  97         titles['c'] = wx_to_std (_("cinema"));
  98         titles['s'] = wx_to_std (_("screen"));
  99         titles['b'] = wx_to_std (_("from date/time"));
 100         titles['e'] = wx_to_std (_("to date/time"));
 101         dcp::NameFormat::Map ex;
 102         ex['f'] = "Bambi";
 103         ex['c'] = "Lumière";
 104         ex['s'] = "Screen 1";
 105         ex['b'] = "2012/03/15 12:30";
 106         ex['e'] = "2012/03/22 02:30";
 107         _filename_format = new NameFormatEditor (this, Config::instance()->kdm_filename_format(), titles, ex, ".xml");
 108         table->Add (_filename_format->panel(), 1, wxEXPAND);
 109
 110         _write_to = new CheckBox (this, _("Write to"));
 111         table->Add (_write_to, 1, wxEXPAND);
 112
 113 #ifdef DCPOMATIC_USE_OWN_PICKER
 114         _folder = new DirPickerCtrl (this);
 115 #else
 116         _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
 117 #endif
 118
 119         auto path = Config::instance()->default_kdm_directory();
 120         if (path) {
 121                 _folder->SetPath (std_to_wx (path->string ()));
 122         } else {
 123                 _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
 124         }
 125
 126         table->Add (_folder, 1, wxEXPAND);
 127
 128         auto write_options = new wxBoxSizer(wxVERTICAL);
 129         _write_flat = new wxRadioButton (this, wxID_ANY, _("Write all KDMs to the same folder"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
 130         write_options->Add (_write_flat, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 131         _write_folder = new wxRadioButton (this, wxID_ANY, _("Write a folder for each cinema's KDMs"));
 132         write_options->Add (_write_folder, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 133         _write_zip = new wxRadioButton (this, wxID_ANY, _("Write a ZIP file for each cinema's KDMs"));
 134         write_options->Add (_write_zip, 1, wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
 135         table->AddSpacer (0);
 136         table->Add (write_options);
 137
 138         _email = new CheckBox (this, _("Send by email"));
 139         table->Add (_email, 1, wxEXPAND);
 140         auto add_email_addresses = new wxButton(this, wxID_ANY, _("Set additional email addresses..."));
 141         table->Add (add_email_addresses);
 142
 143         switch (Config::instance()->last_kdm_write_type().get_value_or(Config::KDM_WRITE_FLAT)) {
 144         case Config::KDM_WRITE_FLAT:
 145                 _write_flat->SetValue (true);
 146                 break;
 147         case Config::KDM_WRITE_FOLDER:
 148                 _write_folder->SetValue (true);
 149                 break;
 150         case Config::KDM_WRITE_ZIP:
 151                 _write_zip->SetValue (true);
 152                 break;
 153         }
 154
 155         _write_to->SetValue (Config::instance()->write_kdms_to_disk());
 156         _email->SetValue (Config::instance()->email_kdms());
 157
 158         _write_to->bind(&KDMOutputPanel::write_to_changed, this);
 159         _email->bind(&KDMOutputPanel::email_changed, this);
 160         add_email_addresses->Bind (wxEVT_BUTTON, boost::bind(&KDMOutputPanel::add_email_addresses_clicked, 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));
 165
 166         SetSizer (table);
 167 }
 168
 169
 170 void
 171 KDMOutputPanel::write_to_changed ()
 172 {
 173         Config::instance()->set_write_kdms_to_disk(_write_to->GetValue());
 174         setup_sensitivity ();
 175         MethodChanged();
 176 }
 177
 178
 179 void
 180 KDMOutputPanel::email_changed ()
 181 {
 182         Config::instance()->set_email_kdms(_email->GetValue());
 183         setup_sensitivity ();
 184         MethodChanged();
 185 }
 186
 187
 188 void
 189 KDMOutputPanel::setup_sensitivity ()
 190 {
 191         bool const write = _write_to->GetValue ();
 192         _folder->Enable (write);
 193         _write_flat->Enable (write);
 194         _write_folder->Enable (write);
 195         _write_zip->Enable (write);
 196 }
 197
 198
 199 void
 200 KDMOutputPanel::advanced_clicked ()
 201 {
 202         KDMAdvancedDialog dialog(this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
 203         dialog.ShowModal();
 204         _forensic_mark_video = dialog.forensic_mark_video();
 205         _forensic_mark_audio = dialog.forensic_mark_audio();
 206         _forensic_mark_audio_up_to = dialog.forensic_mark_audio_up_to();
 207 }
 208
 209
 210 void
 211 KDMOutputPanel::kdm_write_type_changed ()
 212 {
 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);
 219         }
 220 }
 221
 222
 223 pair<shared_ptr<Job>, int>
 224 KDMOutputPanel::make (
 225         list<KDMWithMetadataPtr> kdms, string name, function<bool (boost::filesystem::path)> confirm_overwrite
 226         )
 227 {
 228         auto const cinema_kdms = collect (kdms);
 229
 230         /* Decide whether to proceed */
 231
 232         bool proceed = true;
 233
 234         if (_email->GetValue ()) {
 235
 236                 if (Config::instance()->mail_server().empty ()) {
 237                         proceed = false;
 238                         error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
 239                 }
 240
 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(); }
 244                         );
 245
 246                 if (proceed && cinemas_with_no_email && !confirm_dialog (
 247                             this,
 248                             _("You have selected some cinemas that have no configured email address.  Do you want to continue?")
 249                             )) {
 250                         proceed = false;
 251                 }
 252
 253                 if (proceed && Config::instance()->confirm_kdm_email ()) {
 254                         list<string> emails;
 255                         for (auto const& i: cinema_kdms) {
 256                                 for (auto j: i.front()->emails()) {
 257                                         emails.push_back (j);
 258                                 }
 259                         }
 260
 261                         if (!emails.empty ()) {
 262                                 auto d = new ConfirmKDMEmailDialog (this, emails);
 263                                 if (d->ShowModal() == wxID_CANCEL) {
 264                                         proceed = false;
 265                                 }
 266                         }
 267                 }
 268         }
 269
 270         if (!proceed) {
 271                 return {};
 272         }
 273
 274         Config::instance()->set_kdm_filename_format (_filename_format->get ());
 275
 276         int written = 0;
 277         shared_ptr<Job> job;
 278
 279         try {
 280
 281                 if (_write_to->GetValue()) {
 282                         if (_write_flat->GetValue()) {
 283                                 written = write_files (
 284                                         kdms,
 285                                         directory(),
 286                                         _filename_format->get(),
 287                                         confirm_overwrite
 288                                         );
 289                         } else if (_write_folder->GetValue()) {
 290                                 written = write_directories (
 291                                         collect (kdms),
 292                                         directory(),
 293                                         _container_name_format->get(),
 294                                         _filename_format->get(),
 295                                         confirm_overwrite
 296                                         );
 297                         } else if (_write_zip->GetValue()) {
 298                                 written = write_zip_files (
 299                                         collect (kdms),
 300                                         directory(),
 301                                         _container_name_format->get(),
 302                                         _filename_format->get(),
 303                                         confirm_overwrite
 304                                         );
 305                         }
 306                 }
 307
 308                 if (_email->GetValue ()) {
 309                         job = make_shared<SendKDMEmailJob>(
 310                                 cinema_kdms,
 311                                 _container_name_format->get(),
 312                                 _filename_format->get(),
 313                                 name,
 314                                 _extra_addresses
 315                                 );
 316                 }
 317
 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()));
 322         } catch (...) {
 323                 error_dialog (this, _("An unknown exception occurred."));
 324         }
 325
 326         return make_pair (job, written);
 327 }
 328
 329
 330 dcp::Formulation
 331 KDMOutputPanel::formulation () const
 332 {
 333         return _type->get();
 334 }
 335
 336
 337 boost::filesystem::path
 338 KDMOutputPanel::directory () const
 339 {
 340         return wx_to_std (_folder->GetPath ());
 341 }
 342
 343
 344 void
 345 KDMOutputPanel::add_email_addresses_clicked ()
 346 {
 347         ExtraKDMEmailDialog dialog(this, _extra_addresses);
 348         if (dialog.ShowModal() == wxID_OK) {
 349                 _extra_addresses = dialog.get();
 350         }
 351 }
 352
 353
 354 bool
 355 KDMOutputPanel::method_selected() const
 356 {
 357         return _write_to->GetValue() || _email->GetValue();
 358 }
 359