src/wx/kdm_output_panel.cc

   1 /*
   2     Copyright (C) 2015-2017 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 "lib/config.h"
  22 #include "lib/cinema.h"
  23 #include "lib/cinema_kdms.h"
  24 #include "lib/send_kdm_email_job.h"
  25 #include "kdm_output_panel.h"
  26 #include "kdm_timing_panel.h"
  27 #include "confirm_kdm_email_dialog.h"
  28 #include "wx_util.h"
  29 #include "name_format_editor.h"
  30 #include <dcp/exceptions.h>
  31 #include <dcp/types.h>
  32 #ifdef DCPOMATIC_USE_OWN_PICKER
  33 #include "dir_picker_ctrl.h"
  34 #else
  35 #include <wx/filepicker.h>
  36 #endif
  37 #include <wx/stdpaths.h>
  38
  39 using std::pair;
  40 using std::string;
  41 using std::list;
  42 using std::exception;
  43 using std::make_pair;
  44 using boost::shared_ptr;
  45 using boost::function;
  46
  47 KDMOutputPanel::KDMOutputPanel (wxWindow* parent, bool interop)
  48         : wxPanel (parent, wxID_ANY)
  49 {
  50         wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
  51
  52         add_label_to_sizer (table, this, _("KDM type"), true);
  53         _type = new wxChoice (this, wxID_ANY);
  54         _type->Append ("Modified Transitional 1", ((void *) dcp::MODIFIED_TRANSITIONAL_1));
  55         _type->Append ("Modified Transitional 1 (without AuthorizedDeviceInfo)", ((void *) dcp::MODIFIED_TRANSITIONAL_TEST));
  56         if (!interop) {
  57                 _type->Append ("DCI Any", ((void *) dcp::DCI_ANY));
  58                 _type->Append ("DCI Specific", ((void *) dcp::DCI_SPECIFIC));
  59         }
  60         table->Add (_type, 1, wxEXPAND);
  61         _type->SetSelection (0);
  62
  63         {
  64                 int flags = wxALIGN_TOP | wxTOP | wxLEFT | wxRIGHT;
  65                 wxString t = _("Folder / ZIP name format");
  66 #ifdef __WXOSX__
  67                 flags |= wxALIGN_RIGHT;
  68                 t += wxT (":");
  69 #endif
  70                 wxStaticText* m = new wxStaticText (this, wxID_ANY, t);
  71                 table->Add (m, 0, flags, DCPOMATIC_SIZER_Y_GAP);
  72         }
  73
  74         _container_name_format = new NameFormatEditor (this, Config::instance()->kdm_container_name_format(), dcp::NameFormat::Map(), dcp::NameFormat::Map(), "");
  75         table->Add (_container_name_format->panel(), 1, wxEXPAND);
  76
  77         {
  78                 int flags = wxALIGN_TOP | wxTOP | wxLEFT | wxRIGHT;
  79                 wxString t = _("Filename format");
  80 #ifdef __WXOSX__
  81                 flags |= wxALIGN_RIGHT;
  82                 t += wxT (":");
  83 #endif
  84                 wxStaticText* m = new wxStaticText (this, wxID_ANY, t);
  85                 table->Add (m, 0, flags, DCPOMATIC_SIZER_Y_GAP);
  86         }
  87
  88         dcp::NameFormat::Map titles;
  89         titles['f'] = "film name";
  90         titles['c'] = "cinema";
  91         titles['s'] = "screen";
  92         titles['b'] = "from date/time";
  93         titles['e'] = "to date/time";
  94         dcp::NameFormat::Map ex;
  95         ex['f'] = "Bambi";
  96         ex['c'] = "Lumière";
  97         ex['s'] = "Screen 1";
  98         ex['b'] = "2012/03/15 12:30";
  99         ex['e'] = "2012/03/22 02:30";
 100         _filename_format = new NameFormatEditor (this, Config::instance()->kdm_filename_format(), titles, ex, ".xml");
 101         table->Add (_filename_format->panel(), 1, wxEXPAND);
 102
 103         _write_to = new wxCheckBox (this, wxID_ANY, _("Write to"));
 104         table->Add (_write_to, 1, wxEXPAND);
 105
 106 #ifdef DCPOMATIC_USE_OWN_PICKER
 107         _folder = new DirPickerCtrl (this);
 108 #else
 109         _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
 110 #endif
 111
 112         boost::optional<boost::filesystem::path> path = Config::instance()->default_kdm_directory ();
 113         if (path) {
 114                 _folder->SetPath (std_to_wx (path->string ()));
 115         } else {
 116                 _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
 117         }
 118
 119         table->Add (_folder, 1, wxEXPAND);
 120
 121         wxSizer* write_options = new wxBoxSizer(wxVERTICAL);
 122         _write_flat = new wxRadioButton (this, wxID_ANY, _("Write all KDMs to the same folder"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
 123         write_options->Add (_write_flat);
 124         _write_folder = new wxRadioButton (this, wxID_ANY, _("Write a folder for each cinema's KDMs"));
 125         write_options->Add (_write_folder);
 126         _write_zip = new wxRadioButton (this, wxID_ANY, _("Write a ZIP file for each cinema's KDMs"));
 127         write_options->Add (_write_zip);
 128         table->AddSpacer (0);
 129         table->Add (write_options);
 130
 131         _email = new wxCheckBox (this, wxID_ANY, _("Send by email"));
 132         table->Add (_email, 1, wxEXPAND);
 133         table->AddSpacer (0);
 134
 135         _write_to->SetValue (true);
 136
 137         _write_to->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 138         _email->Bind    (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
 139
 140         SetSizer (table);
 141 }
 142
 143 void
 144 KDMOutputPanel::setup_sensitivity ()
 145 {
 146         bool const write = _write_to->GetValue ();
 147         _folder->Enable (write);
 148         _write_flat->Enable (write);
 149         _write_folder->Enable (write);
 150         _write_zip->Enable (write);
 151 }
 152
 153 pair<shared_ptr<Job>, int>
 154 KDMOutputPanel::make (
 155         list<ScreenKDM> screen_kdms, string name, KDMTimingPanel* timing, function<bool (boost::filesystem::path)> confirm_overwrite, shared_ptr<Log> log
 156         )
 157 {
 158         list<CinemaKDMs> const cinema_kdms = CinemaKDMs::collect (screen_kdms);
 159
 160         /* Decide whether to proceed */
 161
 162         bool proceed = true;
 163
 164         if (_email->GetValue ()) {
 165
 166                 if (Config::instance()->mail_server().empty ()) {
 167                         proceed = false;
 168                         error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
 169                 }
 170
 171                 bool cinemas_with_no_email = false;
 172                 BOOST_FOREACH (CinemaKDMs i, cinema_kdms) {
 173                         if (i.cinema->emails.empty ()) {
 174                                 cinemas_with_no_email = true;
 175                         }
 176                 }
 177
 178                 if (proceed && cinemas_with_no_email && !confirm_dialog (
 179                             this,
 180                             _("You have selected some cinemas that have no configured email address.  Do you want to continue?")
 181                             )) {
 182                         proceed = false;
 183                 }
 184
 185                 if (proceed && Config::instance()->confirm_kdm_email ()) {
 186                         list<string> emails;
 187                         BOOST_FOREACH (CinemaKDMs i, cinema_kdms) {
 188                                 BOOST_FOREACH (string j, i.cinema->emails) {
 189                                         emails.push_back (j);
 190                                 }
 191                         }
 192
 193                         if (!emails.empty ()) {
 194                                 ConfirmKDMEmailDialog* d = new ConfirmKDMEmailDialog (this, emails);
 195                                 if (d->ShowModal() == wxID_CANCEL) {
 196                                         proceed = false;
 197                                 }
 198                         }
 199                 }
 200         }
 201
 202         if (!proceed) {
 203                 return make_pair (shared_ptr<Job>(), 0);
 204         }
 205
 206         Config::instance()->set_kdm_filename_format (_filename_format->get ());
 207
 208         int written = 0;
 209         shared_ptr<Job> job;
 210
 211         try {
 212                 dcp::NameFormat::Map name_values;
 213                 name_values['f'] = name;
 214                 name_values['b'] = dcp::LocalTime(timing->from()).date() + " " + dcp::LocalTime(timing->from()).time_of_day(false, false);
 215                 name_values['e'] = dcp::LocalTime(timing->until()).date() + " " + dcp::LocalTime(timing->until()).time_of_day(false, false);
 216
 217                 if (_write_to->GetValue()) {
 218                         if (_write_flat->GetValue()) {
 219                                 written = ScreenKDM::write_files (
 220                                         screen_kdms,
 221                                         directory(),
 222                                         _filename_format->get(),
 223                                         name_values,
 224                                         confirm_overwrite
 225                                         );
 226                         } else if (_write_folder->GetValue()) {
 227                                 written = CinemaKDMs::write_directories (
 228                                         CinemaKDMs::collect (screen_kdms),
 229                                         directory(),
 230                                         _container_name_format->get(),
 231                                         _filename_format->get(),
 232                                         name_values,
 233                                         confirm_overwrite
 234                                         );
 235                         } else if (_write_zip->GetValue()) {
 236                                 written = CinemaKDMs::write_zip_files (
 237                                         CinemaKDMs::collect (screen_kdms),
 238                                         directory(),
 239                                         _container_name_format->get(),
 240                                         _filename_format->get(),
 241                                         name_values,
 242                                         confirm_overwrite
 243                                         );
 244                         }
 245                 }
 246
 247                 if (_email->GetValue ()) {
 248                         job.reset (
 249                                 new SendKDMEmailJob (
 250                                         cinema_kdms,
 251                                         _container_name_format->get(),
 252                                         _filename_format->get(),
 253                                         name_values,
 254                                         name,
 255                                         log
 256                                         )
 257                                 );
 258                 }
 259
 260         } catch (dcp::NotEncryptedError& e) {
 261                 error_dialog (this, _("CPL's content is not encrypted."));
 262         } catch (exception& e) {
 263                 error_dialog (this, e.what ());
 264         } catch (...) {
 265                 error_dialog (this, _("An unknown exception occurred."));
 266         }
 267
 268         return make_pair (job, written);
 269 }
 270
 271 dcp::Formulation
 272 KDMOutputPanel::formulation () const
 273 {
 274         return (dcp::Formulation) reinterpret_cast<intptr_t> (_type->GetClientData (_type->GetSelection()));
 275 }
 276
 277 boost::filesystem::path
 278 KDMOutputPanel::directory () const
 279 {
 280         return wx_to_std (_folder->GetPath ());
 281 }