src/tools/dcpomatic_kdm_cli.cc

   1 /*
   2     Copyright (C) 2013-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 /** @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 shared_ptr<Cinema>
 145 find_cinema (string cinema_name)
 146 {
 147         list<shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
 148         list<shared_ptr<Cinema> >::const_iterator i = cinemas.begin();
 149         while (
 150                 i != cinemas.end() &&
 151                 (*i)->name != cinema_name &&
 152                 find ((*i)->emails.begin(), (*i)->emails.end(), cinema_name) == (*i)->emails.end()) {
 153
 154                 ++i;
 155         }
 156
 157         if (i == cinemas.end ()) {
 158                 cerr << program_name << ": could not find cinema \"" << cinema_name << "\"\n";
 159                 exit (EXIT_FAILURE);
 160         }
 161
 162         return *i;
 163 }
 164
 165 int main (int argc, char* argv[])
 166 {
 167         optional<boost::filesystem::path> output;
 168         optional<boost::posix_time::ptime> valid_from;
 169         optional<boost::posix_time::ptime> valid_to;
 170         optional<string> certificate_file;
 171         bool zip = false;
 172         optional<string> cinema_name;
 173         bool cinemas = false;
 174         optional<string> duration_string;
 175         bool verbose = false;
 176         dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
 177
 178         program_name = argv[0];
 179
 180         int option_index = 0;
 181         while (true) {
 182                 static struct option long_options[] = {
 183                         { "help", no_argument, 0, 'h'},
 184                         { "output", required_argument, 0, 'o'},
 185                         { "valid-from", required_argument, 0, 'f'},
 186                         { "valid-to", required_argument, 0, 't'},
 187                         { "certificate", required_argument, 0, 'A' },
 188                         { "cinema", required_argument, 0, 'c' },
 189                         { "cinemas", no_argument, 0, 'B' },
 190                         { "zip", no_argument, 0, 'z' },
 191                         { "duration", required_argument, 0, 'd' },
 192                         { "verbose", no_argument, 0, 'v' },
 193                         { "formulation", required_argument, 0, 'C' },
 194                         { 0, 0, 0, 0 }
 195                 };
 196
 197                 int c = getopt_long (argc, argv, "ho:f:t:c:A:Bzd:vC:", long_options, &option_index);
 198
 199                 if (c == -1) {
 200                         break;
 201                 }
 202
 203                 switch (c) {
 204                 case 'h':
 205                         help ();
 206                         exit (EXIT_SUCCESS);
 207                 case 'o':
 208                         output = optarg;
 209                         break;
 210                 case 'f':
 211                         valid_from = time_from_string (optarg);
 212                         break;
 213                 case 't':
 214                         valid_to = time_from_string (optarg);
 215                         break;
 216                 case 'A':
 217                         certificate_file = optarg;
 218                         break;
 219                 case 'c':
 220                         cinema_name = optarg;
 221                         break;
 222                 case 'B':
 223                         cinemas = true;
 224                         break;
 225                 case 'z':
 226                         zip = true;
 227                         break;
 228                 case 'd':
 229                         duration_string = optarg;
 230                         break;
 231                 case 'v':
 232                         verbose = true;
 233                         break;
 234                 case 'C':
 235                         if (string (optarg) == "modified-transitional-1") {
 236                                 formulation = dcp::MODIFIED_TRANSITIONAL_1;
 237                         } else if (string (optarg) == "dci-any") {
 238                                 formulation = dcp::DCI_ANY;
 239                         } else if (string (optarg) == "dci-specific") {
 240                                 formulation = dcp::DCI_SPECIFIC;
 241                         } else {
 242                                 error ("unrecognised KDM formulation " + string (optarg));
 243                         }
 244                 }
 245         }
 246
 247         if (cinemas) {
 248                 list<boost::shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
 249                 for (list<boost::shared_ptr<Cinema> >::const_iterator i = cinemas.begin(); i != cinemas.end(); ++i) {
 250                         cout << (*i)->name << " (" << Emailer::address_list ((*i)->emails) << ")\n";
 251                 }
 252                 exit (EXIT_SUCCESS);
 253         }
 254
 255         if (!duration_string && !valid_to) {
 256                 error ("you must specify a --valid-duration or --valid-to");
 257         }
 258
 259         if (!valid_from) {
 260                 error ("you must specify --valid-from");
 261                 exit (EXIT_FAILURE);
 262         }
 263
 264         if (optind >= argc) {
 265                 help ();
 266                 exit (EXIT_FAILURE);
 267         }
 268
 269         if (!cinema_name && !certificate_file) {
 270                 error ("you must specify either a cinema, a screen or a certificate file");
 271         }
 272
 273         if (duration_string) {
 274                 valid_to = valid_from.get() + duration_from_string (*duration_string);
 275         }
 276
 277         boost::filesystem::path const film_dir = argv[optind];
 278
 279         dcpomatic_setup_path_encoding ();
 280         dcpomatic_setup ();
 281
 282         shared_ptr<Film> film;
 283         try {
 284                 film.reset (new Film (film_dir));
 285                 film->read_metadata ();
 286                 if (verbose) {
 287                         cout << "Read film " << film->name () << "\n";
 288                 }
 289         } catch (std::exception& e) {
 290                 cerr << program_name << ": error reading film `" << film_dir.string() << "' (" << e.what() << ")\n";
 291                 exit (EXIT_FAILURE);
 292         }
 293
 294         if (verbose) {
 295                 cout << "Making KDMs valid from " << valid_from.get() << " to " << valid_to.get() << "\n";
 296         }
 297
 298         /* XXX: allow specification of this */
 299         vector<CPLSummary> cpls = film->cpls ();
 300         if (cpls.empty ()) {
 301                 error ("no CPLs found in film");
 302         } else if (cpls.size() > 1) {
 303                 error ("more than one CPL found in film");
 304         }
 305
 306         boost::filesystem::path cpl = cpls.front().cpl_file;
 307
 308         if (!cinema_name) {
 309
 310                 if (!output) {
 311                         error ("you must specify --output");
 312                 }
 313
 314                 dcp::Certificate certificate (dcp::file_to_string (*certificate_file));
 315                 dcp::EncryptedKDM kdm = film->make_kdm (
 316                         certificate, vector<dcp::Certificate>(), cpl, dcp::LocalTime (*valid_from), dcp::LocalTime (*valid_to), formulation
 317                         );
 318                 kdm.as_xml (*output);
 319                 if (verbose) {
 320                         cout << "Generated KDM " << *output << " for certificate.\n";
 321                 }
 322         } else {
 323
 324                 if (!output) {
 325                         output = ".";
 326                 }
 327
 328                 dcp::NameFormat::Map values;
 329                 values['f'] = film->name();
 330                 values['b'] = dcp::LocalTime(*valid_from).date() + " " + dcp::LocalTime(*valid_from).time_of_day(true, false);
 331                 values['e'] = dcp::LocalTime(*valid_to).date() + " " + dcp::LocalTime(*valid_to).time_of_day(true, false);
 332
 333                 try {
 334                         list<ScreenKDM> screen_kdms = film->make_kdms (
 335                                 find_cinema(*cinema_name)->screens(), cpl, valid_from.get(), valid_to.get(), formulation
 336                                 );
 337
 338                         write_files (screen_kdms, zip, *output, values, verbose);
 339                 } catch (FileError& e) {
 340                         cerr << argv[0] << ": " << e.what() << " (" << e.file().string() << ")\n";
 341                         exit (EXIT_FAILURE);
 342                 } catch (KDMError& e) {
 343                         cerr << argv[0] << ": " << e.what() << "\n";
 344                         exit (EXIT_FAILURE);
 345                 }
 346         }
 347
 348         return 0;
 349 }