src/wx/kdm_output_panel.cc

   1 /*
   2     Copyright (C) 2015-2018 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 #include "kdm_output_panel.h"
  22 #include "kdm_timing_panel.h"
  23 #include "confirm_kdm_email_dialog.h"
  24 #include "wx_util.h"
  25 #include "kdm_advanced_dialog.h"
  26 #include "name_format_editor.h"
  27 #include "check_box.h"
  28 #include "dcpomatic_button.h"
  29 #include "lib/config.h"
  30 #include "lib/cinema.h"
  31 #include "lib/send_kdm_email_job.h"
  32 #include "lib/warnings.h"
  33 #include <dcp/exceptions.h>
  34 #include <dcp/types.h>
  35 #ifdef DCPOMATIC_USE_OWN_PICKER
  36 #include "dir_picker_ctrl.h"
  37 #else
  38 DCPOMATIC_DISABLE_WARNINGS
  39 #include <wx/filepicker.h>
  40 DCPOMATIC_ENABLE_WARNINGS
  41 #endif
  42 DCPOMATIC_DISABLE_WARNINGS
  43 #include <wx/stdpaths.h>
  44 DCPOMATIC_ENABLE_WARNINGS
  45
  46 using std::pair;
  47 using std::string;
  48 using std::list;
  49 using std::exception;
  50 using std::make_pair;
  51 using std::shared_ptr;
  52 using std::function;
  53 #if BOOST_VERSION >= 106100
  54 using namespace boost::placeholders;
  55 #endif
  56
  57
  58 KDMOutputPanel::KDMOutputPanel (wxWindow* parent)
  59         : wxPanel (parent, wxID_ANY)
  60         , _forensic_mark_video (true)
  61         , _forensic_mark_audio (true)
  62         , _forensic_mark_audio_up_to (12)
  63 {
  64         wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
  65         table->AddGrowableCol (1);
  66
  67         add_label_to_sizer (table, this, _("KDM type"), true, 0, wxLEFT | wxRIGHT | wxALIGN_CENTRE_VERTICAL);
  68
  69         wxBoxSizer* type = new wxBoxSizer (wxHORIZONTAL);
  70         _type = new wxChoice (this, wxID_ANY);
  71         _type->Append ("Modified Transitional 1", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_1));
  72         _type->Append ("DCI Any", ((void *) dcp::Formulation::DCI_ANY));
  73         _type->Append ("DCI Specific", ((void *) dcp::Formulation::DCI_SPECIFIC));
  74         _type->Append ("Multiple Modified Transitional 1", ((void *) dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1));
  75         _type->Append ("Modified Transitional 1 (without AuthorizedDeviceInfo)", ((void *) dcp::Formulation::MODIFIED_TRANSITIONAL_TEST));
  76         type->Add (_type, 1, wxTOP, DCPOMATIC_CHOICE_TOP_PAD);
  77         _type->SetSelection (0);
  78         wxButton* 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         boost::optional<boost::filesystem::path> 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         wxSizer* 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         table->AddSpacer (0);
 141
 142         switch (Config::instance()->last_kdm_write_type().get_value_or(Config::KDM_WRITE_FLAT)) {
 143         case Config::KDM_WRITE_FLAT:
 144                 _write_flat->SetValue (true);
 145                 break;
 146         case Config::KDM_WRITE_FOLDER:
 147                 _write_folder->SetValue (true);
 148                 break;
 149         case Config::KDM_WRITE_ZIP:
 150                 _write_zip->SetValue (true);
 151                 break;
 152         }
 153
 154         _write_to->SetValue (true);
 155
 156         _write_to->Bind     (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 157         _email->Bind        (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 158         _write_flat->Bind   (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 159         _write_folder->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 160         _write_zip->Bind    (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
 161         advanced->Bind      (wxEVT_BUTTON, boost::bind (&KDMOutputPanel::advanced_clicked, this));
 162
 163         SetSizer (table);
 164 }
 165
 166 void
 167 KDMOutputPanel::setup_sensitivity ()
 168 {
 169         bool const write = _write_to->GetValue ();
 170         _folder->Enable (write);
 171         _write_flat->Enable (write);
 172         _write_folder->Enable (write);
 173         _write_zip->Enable (write);
 174 }
 175
 176 void
 177 KDMOutputPanel::advanced_clicked ()
 178 {
 179         KDMAdvancedDialog* d = new KDMAdvancedDialog (this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
 180         d->ShowModal ();
 181         _forensic_mark_video = d->forensic_mark_video ();
 182         _forensic_mark_audio = d->forensic_mark_audio ();
 183         _forensic_mark_audio_up_to = d->forensic_mark_audio_up_to ();
 184         d->Destroy ();
 185 }
 186
 187 void
 188 KDMOutputPanel::kdm_write_type_changed ()
 189 {
 190         if (_write_flat->GetValue()) {
 191                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FLAT);
 192         } else if (_write_folder->GetValue()) {
 193                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FOLDER);
 194         } else if (_write_zip->GetValue()) {
 195                 Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_ZIP);
 196         }
 197 }
 198
 199 pair<shared_ptr<Job>, int>
 200 KDMOutputPanel::make (
 201         list<KDMWithMetadataPtr> kdms, string name, function<bool (boost::filesystem::path)> confirm_overwrite
 202         )
 203 {
 204         list<list<KDMWithMetadataPtr> > const cinema_kdms = collect (kdms);
 205
 206         /* Decide whether to proceed */
 207
 208         bool proceed = true;
 209
 210         if (_email->GetValue ()) {
 211
 212                 if (Config::instance()->mail_server().empty ()) {
 213                         proceed = false;
 214                         error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
 215                 }
 216
 217                 bool cinemas_with_no_email = false;
 218                 for (auto i: cinema_kdms) {
 219                         if (i.front()->emails().empty()) {
 220                                 cinemas_with_no_email = true;
 221                         }
 222                 }
 223
 224                 if (proceed && cinemas_with_no_email && !confirm_dialog (
 225                             this,
 226                             _("You have selected some cinemas that have no configured email address.  Do you want to continue?")
 227                             )) {
 228                         proceed = false;
 229                 }
 230
 231                 if (proceed && Config::instance()->confirm_kdm_email ()) {
 232                         list<string> emails;
 233                         for (auto const& i: cinema_kdms) {
 234                                 for (auto j: i.front()->emails()) {
 235                                         emails.push_back (j);
 236                                 }
 237                         }
 238
 239                         if (!emails.empty ()) {
 240                                 ConfirmKDMEmailDialog* d = new ConfirmKDMEmailDialog (this, emails);
 241                                 if (d->ShowModal() == wxID_CANCEL) {
 242                                         proceed = false;
 243                                 }
 244                         }
 245                 }
 246         }
 247
 248         if (!proceed) {
 249                 return make_pair (shared_ptr<Job>(), 0);
 250         }
 251
 252         Config::instance()->set_kdm_filename_format (_filename_format->get ());
 253
 254         int written = 0;
 255         shared_ptr<Job> job;
 256
 257         try {
 258
 259                 if (_write_to->GetValue()) {
 260                         if (_write_flat->GetValue()) {
 261                                 written = write_files (
 262                                         kdms,
 263                                         directory(),
 264                                         _filename_format->get(),
 265                                         confirm_overwrite
 266                                         );
 267                         } else if (_write_folder->GetValue()) {
 268                                 written = write_directories (
 269                                         collect (kdms),
 270                                         directory(),
 271                                         _container_name_format->get(),
 272                                         _filename_format->get(),
 273                                         confirm_overwrite
 274                                         );
 275                         } else if (_write_zip->GetValue()) {
 276                                 written = write_zip_files (
 277                                         collect (kdms),
 278                                         directory(),
 279                                         _container_name_format->get(),
 280                                         _filename_format->get(),
 281                                         confirm_overwrite
 282                                         );
 283                         }
 284                 }
 285
 286                 if (_email->GetValue ()) {
 287                         job.reset (
 288                                 new SendKDMEmailJob (
 289                                         cinema_kdms,
 290                                         _container_name_format->get(),
 291                                         _filename_format->get(),
 292                                         name
 293                                         )
 294                                 );
 295                 }
 296
 297         } catch (dcp::NotEncryptedError& e) {
 298                 error_dialog (this, _("CPL's content is not encrypted."));
 299         } catch (exception& e) {
 300                 error_dialog (this, std_to_wx(e.what()));
 301         } catch (...) {
 302                 error_dialog (this, _("An unknown exception occurred."));
 303         }
 304
 305         return make_pair (job, written);
 306 }
 307
 308 dcp::Formulation
 309 KDMOutputPanel::formulation () const
 310 {
 311         return (dcp::Formulation) reinterpret_cast<intptr_t> (_type->GetClientData (_type->GetSelection()));
 312 }
 313
 314 boost::filesystem::path
 315 KDMOutputPanel::directory () const
 316 {
 317         return wx_to_std (_folder->GetPath ());
 318 }