src/tools/dcpomatic_kdm_cli.cc

   1 /*
   2     Copyright (C) 2013-2015 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 /** @file  src/tools/dcpomatic_kdm_cli.cc
  22  *  @brief Command-line program to generate KDMs.
  23  */
  24
  25 #include "lib/film.h"
  26 #include "lib/cinema.h"
  27 #include "lib/screen_kdm.h"
  28 #include "lib/cinema_kdms.h"
  29 #include "lib/config.h"
  30 #include "lib/exceptions.h"
  31 #include "lib/emailer.h"
  32 #include <dcp/certificate.h>
  33 #include <getopt.h>
  34 #include <iostream>
  35
  36 using std::string;
  37 using std::cout;
  38 using std::cerr;
  39 using std::list;
  40 using std::vector;
  41 using boost::shared_ptr;
  42 using boost::optional;
  43 using boost::bind;
  44
  45 static void
  46 help ()
  47 {
  48         cerr << "Syntax: " << program_name << " [OPTION] [<FILM>]\n"
  49                 "  -h, --help             show this help\n"
  50                 "  -o, --output           output file or directory\n"
  51                 "  -f, --valid-from       valid from time (in local time zone of the cinema) (e.g. \"2013-09-28 01:41:51\") or \"now\"\n"
  52                 "  -t, --valid-to         valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")\n"
  53                 "  -d, --valid-duration   valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")\n"
  54                 "      --formulation      modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]\n"
  55                 "  -z, --zip              ZIP each cinema's KDMs into its own file\n"
  56                 "  -v, --verbose          be verbose\n"
  57                 "  -c, --cinema           specify a cinema, either by name or email address\n"
  58                 "      --cinemas          list known cinemas from the DCP-o-matic settings\n"
  59                 "      --certificate file containing projector certificate\n\n"
  60                 "For example:\n\n"
  61                 "Create KDMs for my_great_movie to play in all of Fred's Cinema's screens for the next two weeks and zip them up.\n"
  62                 "(Fred's Cinema must have been set up in DCP-o-matic's KDM window)\n\n"
  63                 "\tdcpomatic_kdm -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie\n\n";
  64 }
  65
  66 static void
  67 error (string m)
  68 {
  69         cerr << program_name << ": " << m << "\n";
  70         exit (EXIT_FAILURE);
  71 }
  72
  73 static boost::posix_time::ptime
  74 time_from_string (string t)
  75 {
  76         if (t == "now") {
  77                 return boost::posix_time::second_clock::local_time ();
  78         }
  79
  80         return boost::posix_time::time_from_string (t);
  81 }
  82
  83 static boost::posix_time::time_duration
  84 duration_from_string (string d)
  85 {
  86         int N;
  87         char unit_buf[64] = "\0";
  88         sscanf (d.c_str(), "%d %63s", &N, unit_buf);
  89         string const unit (unit_buf);
  90
  91         if (N == 0) {
  92                 cerr << "Could not understand duration \"" << d << "\"\n";
  93                 exit (EXIT_FAILURE);
  94         }
  95
  96         if (unit == "year" || unit == "years") {
  97                 return boost::posix_time::time_duration (N * 24 * 365, 0, 0, 0);
  98         } else if (unit == "week" || unit == "weeks") {
  99                 return boost::posix_time::time_duration (N * 24 * 7, 0, 0, 0);
 100         } else if (unit == "day" || unit == "days") {
 101                 return boost::posix_time::time_duration (N * 24, 0, 0, 0);
 102         } else if (unit == "hour" || unit == "hours") {
 103                 return boost::posix_time::time_duration (N, 0, 0, 0);
 104         }
 105
 106         cerr << "Could not understand duration \"" << d << "\"\n";
 107         exit (EXIT_FAILURE);
 108 }
 109
 110 static bool
 111 always_overwrite ()
 112 {
 113         return true;
 114 }
 115
 116 void
 117 write_files (list<ScreenKDM> screen_kdms, bool zip, boost::filesystem::path output, dcp::NameFormat::Map values, bool verbose)
 118 {
 119         if (zip) {
 120                 int const N = CinemaKDMs::write_zip_files (
 121                         CinemaKDMs::collect (screen_kdms),
 122                         output,
 123                         Config::instance()->kdm_container_name_format(),
 124                         Config::instance()->kdm_filename_format(),
 125                         values,
 126                         bind (&always_overwrite)
 127                         );
 128
 129                 if (verbose) {
 130                         cout << "Wrote " << N << " ZIP files to " << output << "\n";
 131                 }
 132         } else {
 133                 int const N = ScreenKDM::write_files (
 134                         screen_kdms, output, Config::instance()->kdm_filename_format(), values,
 135                         bind (&always_overwrite)
 136                         );
 137
 138                 if (verbose) {
 139                         cout << "Wrote " << N << " KDM files to " << output << "\n";
 140                 }
 141         }
 142 }
 143
 144 int main (int argc, char* argv[])
 145 {
 146         boost::filesystem::path output;
 147         boost::optional<boost::posix_time::ptime> valid_from;
 148         boost::optional<boost::posix_time::ptime> valid_to;
 149         string certificate_file;
 150         bool zip = false;
 151         string cinema_name;
 152         bool cinemas = false;
 153         string duration_string;
 154         bool verbose = false;
 155         dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
 156
 157         program_name = argv[0];
 158
 159         int option_index = 0;
 160         while (true) {
 161                 static struct option long_options[] = {
 162                         { "help", no_argument, 0, 'h'},
 163                         { "output", required_argument, 0, 'o'},
 164                         { "valid-from", required_argument, 0, 'f'},
 165                         { "valid-to", required_argument, 0, 't'},
 166                         { "certificate", required_argument, 0, 'A' },
 167                         { "cinema", required_argument, 0, 'c' },
 168                         { "cinemas", no_argument, 0, 'B' },
 169                         { "zip", no_argument, 0, 'z' },
 170                         { "duration", required_argument, 0, 'd' },
 171                         { "verbose", no_argument, 0, 'v' },
 172                         { "formulation", required_argument, 0, 'C' },
 173                         { 0, 0, 0, 0 }
 174                 };
 175
 176                 int c = getopt_long (argc, argv, "ho:f:t:c:A:Bzd:vC:", long_options, &option_index);
 177
 178                 if (c == -1) {
 179                         break;
 180                 }
 181
 182                 switch (c) {
 183                 case 'h':
 184                         help ();
 185                         exit (EXIT_SUCCESS);
 186                 case 'o':
 187                         output = optarg;
 188                         break;
 189                 case 'f':
 190                         valid_from = time_from_string (optarg);
 191                         break;
 192                 case 't':
 193                         valid_to = time_from_string (optarg);
 194                         break;
 195                 case 'A':
 196                         certificate_file = optarg;
 197                         break;
 198                 case 'c':
 199                         cinema_name = optarg;
 200                         break;
 201                 case 'B':
 202                         cinemas = true;
 203                         break;
 204                 case 'z':
 205                         zip = true;
 206                         break;
 207                 case 'd':
 208                         duration_string = optarg;
 209                         break;
 210                 case 'v':
 211                         verbose = true;
 212                         break;
 213                 case 'C':
 214                         if (string (optarg) == "modified-transitional-1") {
 215                                 formulation = dcp::MODIFIED_TRANSITIONAL_1;
 216                         } else if (string (optarg) == "dci-any") {
 217                                 formulation = dcp::DCI_ANY;
 218                         } else if (string (optarg) == "dci-specific") {
 219                                 formulation = dcp::DCI_SPECIFIC;
 220                         } else {
 221                                 error ("unrecognised KDM formulation " + string (optarg));
 222                         }
 223                 }
 224         }
 225
 226         if (cinemas) {
 227                 list<boost::shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
 228                 for (list<boost::shared_ptr<Cinema> >::const_iterator i = cinemas.begin(); i != cinemas.end(); ++i) {
 229                         cout << (*i)->name << " (" << Emailer::address_list ((*i)->emails) << ")\n";
 230                 }
 231                 exit (EXIT_SUCCESS);
 232         }
 233
 234         if (duration_string.empty() && !valid_to) {
 235                 error ("you must specify a --valid-duration or --valid-to");
 236         }
 237
 238         if (!valid_from) {
 239                 error ("you must specify --valid-from");
 240                 exit (EXIT_FAILURE);
 241         }
 242
 243         if (optind >= argc) {
 244                 help ();
 245                 exit (EXIT_FAILURE);
 246         }
 247
 248         if (cinema_name.empty() && certificate_file.empty()) {
 249                 error ("you must specify either a cinema, a screen or a certificate file");
 250         }
 251
 252         if (!duration_string.empty ()) {
 253                 valid_to = valid_from.get() + duration_from_string (duration_string);
 254         }
 255
 256         boost::filesystem::path const film_dir = argv[optind];
 257
 258         dcpomatic_setup_path_encoding ();
 259         dcpomatic_setup ();
 260
 261         shared_ptr<Film> film;
 262         try {
 263                 film.reset (new Film (film_dir));
 264                 film->read_metadata ();
 265                 if (verbose) {
 266                         cout << "Read film " << film->name () << "\n";
 267                 }
 268         } catch (std::exception& e) {
 269                 cerr << program_name << ": error reading film `" << film_dir.string() << "' (" << e.what() << ")\n";
 270                 exit (EXIT_FAILURE);
 271         }
 272
 273         if (verbose) {
 274                 cout << "Making KDMs valid from " << valid_from.get() << " to " << valid_to.get() << "\n";
 275         }
 276
 277         /* XXX: allow specification of this */
 278         vector<CPLSummary> cpls = film->cpls ();
 279         if (cpls.empty ()) {
 280                 error ("no CPLs found in film");
 281         } else if (cpls.size() > 1) {
 282                 error ("more than one CPL found in film");
 283         }
 284
 285         boost::filesystem::path cpl = cpls.front().cpl_file;
 286
 287         if (cinema_name.empty ()) {
 288
 289                 if (output.empty ()) {
 290                         error ("you must specify --output");
 291                 }
 292
 293                 dcp::Certificate certificate (dcp::file_to_string (certificate_file));
 294                 dcp::EncryptedKDM kdm = film->make_kdm (
 295                         certificate, vector<dcp::Certificate>(), cpl, dcp::LocalTime (valid_from.get()), dcp::LocalTime (valid_to.get()), formulation
 296                         );
 297                 kdm.as_xml (output);
 298                 if (verbose) {
 299                         cout << "Generated KDM " << output << " for certificate.\n";
 300                 }
 301         } else {
 302
 303                 list<shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
 304                 list<shared_ptr<Cinema> >::const_iterator i = cinemas.begin();
 305                 while (
 306                         i != cinemas.end() &&
 307                         (*i)->name != cinema_name &&
 308                         find ((*i)->emails.begin(), (*i)->emails.end(), cinema_name) == (*i)->emails.end()) {
 309
 310                         ++i;
 311                 }
 312
 313                 if (i == cinemas.end ()) {
 314                         cerr << program_name << ": could not find cinema \"" << cinema_name << "\"\n";
 315                         exit (EXIT_FAILURE);
 316                 }
 317
 318                 if (output.empty ()) {
 319                         output = ".";
 320                 }
 321
 322                 dcp::NameFormat::Map values;
 323                 values['f'] = film->name();
 324                 values['b'] = dcp::LocalTime(valid_from.get()).date() + " " + dcp::LocalTime(valid_from.get()).time_of_day(true, false);
 325                 values['e'] = dcp::LocalTime(valid_to.get()).date() + " " + dcp::LocalTime(valid_to.get()).time_of_day(true, false);
 326
 327                 try {
 328                         list<ScreenKDM> screen_kdms = film->make_kdms (
 329                                 (*i)->screens(), cpl, valid_from.get(), valid_to.get(), formulation
 330                                 );
 331
 332                         write_files (screen_kdms, zip, output, values, verbose);
 333                 } catch (FileError& e) {
 334                         cerr << argv[0] << ": " << e.what() << " (" << e.file().string() << ")\n";
 335                         exit (EXIT_FAILURE);
 336                 } catch (KDMError& e) {
 337                         cerr << argv[0] << ": " << e.what() << "\n";
 338                         exit (EXIT_FAILURE);
 339                 }
 340         }
 341
 342         return 0;
 343 }