src/lib/kdm_cli.cc

   1 /*
   2     Copyright (C) 2013-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 /** @file  src/tools/dcpomatic_kdm_cli.cc
  23  *  @brief Command-line program to generate KDMs.
  24  */
  25
  26
  27 #include "cinema.h"
  28 #include "config.h"
  29 #include "dkdm_wrapper.h"
  30 #include "emailer.h"
  31 #include "exceptions.h"
  32 #include "film.h"
  33 #include "kdm_with_metadata.h"
  34 #include "screen.h"
  35 #include <dcp/certificate.h>
  36 #include <dcp/decrypted_kdm.h>
  37 #include <dcp/encrypted_kdm.h>
  38 #include <getopt.h>
  39
  40
  41 using std::dynamic_pointer_cast;
  42 using std::list;
  43 using std::make_shared;
  44 using std::runtime_error;
  45 using std::shared_ptr;
  46 using std::string;
  47 using std::vector;
  48 using boost::optional;
  49 using boost::bind;
  50 #if BOOST_VERSION >= 106100
  51 using namespace boost::placeholders;
  52 #endif
  53 using namespace dcpomatic;
  54
  55
  56 static void
  57 help (std::function<void (string)> out)
  58 {
  59         out (String::compose("Syntax: %1 [OPTION] <FILM|CPL-ID|DKDM>", program_name));
  60         out ("  -h, --help                               show this help");
  61         out ("  -o, --output                             output file or directory");
  62         out ("  -K, --filename-format                    filename format for KDMs");
  63         out ("  -Z, --container-name-format              filename format for ZIP containers");
  64         out ("  -f, --valid-from                         valid from time (in local time zone of the cinema) (e.g. \"2013-09-28 01:41:51\") or \"now\"");
  65         out ("  -t, --valid-to                           valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")");
  66         out ("  -d, --valid-duration                     valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")");
  67         out ("  -F, --formulation                        modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]");
  68         out ("  -p, --disable-forensic-marking-picture   disable forensic marking of pictures essences");
  69         out ("  -a, --disable-forensic-marking-audio     disable forensic marking of audio essences (optionally above a given channel, e.g 12)");
  70         out ("  -e, --email                              email KDMs to cinemas");
  71         out ("  -z, --zip                                ZIP each cinema's KDMs into its own file");
  72         out ("  -v, --verbose                            be verbose");
  73         out ("  -c, --cinema                             specify a cinema, either by name or email address");
  74         out ("  -S, --screen                             screen description");
  75         out ("  -C, --certificate                        file containing projector certificate");
  76         out ("  -T, --trusted-device                     file containing a trusted device's certificate");
  77         out ("      --list-cinemas                       list known cinemas from the DCP-o-matic settings");
  78         out ("      --list-dkdm-cpls                     list CPLs for which DCP-o-matic has DKDMs");
  79         out ("");
  80         out ("CPL-ID must be the ID of a CPL that is mentioned in DCP-o-matic's DKDM list.");
  81         out ("");
  82         out ("For example:");
  83         out ("");
  84         out ("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.");
  85         out ("(Fred's Cinema must have been set up in DCP-o-matic's KDM window)");
  86         out ("");
  87         out (String::compose("\t%1 -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie", program_name));
  88 }
  89
  90
  91 class KDMCLIError : public std::runtime_error
  92 {
  93 public:
  94         KDMCLIError (std::string message)
  95                 : std::runtime_error (String::compose("%1: %2", program_name, message).c_str())
  96         {}
  97 };
  98
  99
 100 static boost::posix_time::ptime
 101 time_from_string (string t)
 102 {
 103         if (t == "now") {
 104                 return boost::posix_time::second_clock::local_time ();
 105         }
 106
 107         return boost::posix_time::time_from_string (t);
 108 }
 109
 110
 111 static boost::posix_time::time_duration
 112 duration_from_string (string d)
 113 {
 114         int N;
 115         char unit_buf[64] = "\0";
 116         sscanf (d.c_str(), "%d %63s", &N, unit_buf);
 117         string const unit (unit_buf);
 118
 119         if (N == 0) {
 120                 throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
 121         }
 122
 123         if (unit == "year" || unit == "years") {
 124                 return boost::posix_time::time_duration (N * 24 * 365, 0, 0, 0);
 125         } else if (unit == "week" || unit == "weeks") {
 126                 return boost::posix_time::time_duration (N * 24 * 7, 0, 0, 0);
 127         } else if (unit == "day" || unit == "days") {
 128                 return boost::posix_time::time_duration (N * 24, 0, 0, 0);
 129         } else if (unit == "hour" || unit == "hours") {
 130                 return boost::posix_time::time_duration (N, 0, 0, 0);
 131         }
 132
 133         throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
 134 }
 135
 136
 137 static bool
 138 always_overwrite ()
 139 {
 140         return true;
 141 }
 142
 143
 144 static
 145 void
 146 write_files (
 147         list<KDMWithMetadataPtr> kdms,
 148         bool zip,
 149         boost::filesystem::path output,
 150         dcp::NameFormat container_name_format,
 151         dcp::NameFormat filename_format,
 152         bool verbose,
 153         std::function<void (string)> out
 154         )
 155 {
 156         if (zip) {
 157                 int const N = write_zip_files (
 158                         collect (kdms),
 159                         output,
 160                         container_name_format,
 161                         filename_format,
 162                         bind (&always_overwrite)
 163                         );
 164
 165                 if (verbose) {
 166                         out (String::compose("Wrote %1 ZIP files to %2", N, output));
 167                 }
 168         } else {
 169                 int const N = write_files (
 170                         kdms, output, filename_format,
 171                         bind (&always_overwrite)
 172                         );
 173
 174                 if (verbose) {
 175                         out (String::compose("Wrote %1 KDM files to %2", N, output));
 176                 }
 177         }
 178 }
 179
 180
 181 static
 182 shared_ptr<Cinema>
 183 find_cinema (string cinema_name)
 184 {
 185         auto cinemas = Config::instance()->cinemas ();
 186         auto i = cinemas.begin();
 187         while (
 188                 i != cinemas.end() &&
 189                 (*i)->name != cinema_name &&
 190                 find ((*i)->emails.begin(), (*i)->emails.end(), cinema_name) == (*i)->emails.end()) {
 191
 192                 ++i;
 193         }
 194
 195         if (i == cinemas.end ()) {
 196                 throw KDMCLIError (String::compose("could not find cinema \"%1\"", cinema_name));
 197         }
 198
 199         return *i;
 200 }
 201
 202
 203 static
 204 void
 205 from_film (
 206         list<shared_ptr<Screen>> screens,
 207         boost::filesystem::path film_dir,
 208         bool verbose,
 209         boost::filesystem::path output,
 210         dcp::NameFormat container_name_format,
 211         dcp::NameFormat filename_format,
 212         boost::posix_time::ptime valid_from,
 213         boost::posix_time::ptime valid_to,
 214         dcp::Formulation formulation,
 215         bool disable_forensic_marking_picture,
 216         optional<int> disable_forensic_marking_audio,
 217         bool email,
 218         bool zip,
 219         std::function<void (string)> out
 220         )
 221 {
 222         shared_ptr<Film> film;
 223         try {
 224                 film = make_shared<Film>(film_dir);
 225                 film->read_metadata ();
 226                 if (verbose) {
 227                         out (String::compose("Read film %1", film->name()));
 228                 }
 229         } catch (std::exception& e) {
 230                 throw KDMCLIError (String::compose("error reading film \"%1\" (%2)", film_dir.string(), e.what()));
 231         }
 232
 233         /* XXX: allow specification of this */
 234         vector<CPLSummary> cpls = film->cpls ();
 235         if (cpls.empty ()) {
 236                 throw KDMCLIError ("no CPLs found in film");
 237         } else if (cpls.size() > 1) {
 238                 throw KDMCLIError ("more than one CPL found in film");
 239         }
 240
 241         auto cpl = cpls.front().cpl_file;
 242
 243         try {
 244                 list<KDMWithMetadataPtr> kdms;
 245                 for (auto i: screens) {
 246                         auto p = kdm_for_screen (film, cpl, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
 247                         if (p) {
 248                                 kdms.push_back (p);
 249                         }
 250                 }
 251                 write_files (kdms, zip, output, container_name_format, filename_format, verbose, out);
 252                 if (email) {
 253                         send_emails ({kdms}, container_name_format, filename_format, film->dcp_name());
 254                 }
 255         } catch (FileError& e) {
 256                 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
 257         }
 258 }
 259
 260
 261 static
 262 optional<dcp::EncryptedKDM>
 263 sub_find_dkdm (shared_ptr<DKDMGroup> group, string cpl_id)
 264 {
 265         for (auto i: group->children()) {
 266                 auto g = dynamic_pointer_cast<DKDMGroup>(i);
 267                 if (g) {
 268                         auto dkdm = sub_find_dkdm (g, cpl_id);
 269                         if (dkdm) {
 270                                 return dkdm;
 271                         }
 272                 } else {
 273                         auto d = dynamic_pointer_cast<DKDM>(i);
 274                         assert (d);
 275                         if (d->dkdm().cpl_id() == cpl_id) {
 276                                 return d->dkdm();
 277                         }
 278                 }
 279         }
 280
 281         return {};
 282 }
 283
 284
 285 static
 286 optional<dcp::EncryptedKDM>
 287 find_dkdm (string cpl_id)
 288 {
 289         return sub_find_dkdm (Config::instance()->dkdms(), cpl_id);
 290 }
 291
 292
 293 static
 294 dcp::EncryptedKDM
 295 kdm_from_dkdm (
 296         dcp::DecryptedKDM dkdm,
 297         dcp::Certificate target,
 298         vector<string> trusted_devices,
 299         dcp::LocalTime valid_from,
 300         dcp::LocalTime valid_to,
 301         dcp::Formulation formulation,
 302         bool disable_forensic_marking_picture,
 303         optional<int> disable_forensic_marking_audio
 304         )
 305 {
 306         /* Signer for new KDM */
 307         auto signer = Config::instance()->signer_chain ();
 308         if (!signer->valid ()) {
 309                 throw KDMCLIError ("signing certificate chain is invalid.");
 310         }
 311
 312         /* Make a new empty KDM and add the keys from the DKDM to it */
 313         dcp::DecryptedKDM kdm (
 314                 valid_from,
 315                 valid_to,
 316                 dkdm.annotation_text().get_value_or(""),
 317                 dkdm.content_title_text(),
 318                 dcp::LocalTime().as_string()
 319                 );
 320
 321         for (auto const& j: dkdm.keys()) {
 322                 kdm.add_key(j);
 323         }
 324
 325         return kdm.encrypt (signer, target, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
 326 }
 327
 328
 329 static
 330 void
 331 from_dkdm (
 332         list<shared_ptr<Screen>> screens,
 333         dcp::DecryptedKDM dkdm,
 334         bool verbose,
 335         boost::filesystem::path output,
 336         dcp::NameFormat container_name_format,
 337         dcp::NameFormat filename_format,
 338         boost::posix_time::ptime valid_from,
 339         boost::posix_time::ptime valid_to,
 340         dcp::Formulation formulation,
 341         bool disable_forensic_marking_picture,
 342         optional<int> disable_forensic_marking_audio,
 343         bool email,
 344         bool zip,
 345         std::function<void (string)> out
 346         )
 347 {
 348         dcp::NameFormat::Map values;
 349
 350         try {
 351                 list<KDMWithMetadataPtr> kdms;
 352                 for (auto i: screens) {
 353                         if (!i->recipient) {
 354                                 continue;
 355                         }
 356
 357                         dcp::LocalTime begin(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
 358                         dcp::LocalTime end(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
 359
 360                         auto const kdm = kdm_from_dkdm(
 361                                                         dkdm,
 362                                                         i->recipient.get(),
 363                                                         i->trusted_device_thumbprints(),
 364                                                         begin,
 365                                                         end,
 366                                                         formulation,
 367                                                         disable_forensic_marking_picture,
 368                                                         disable_forensic_marking_audio
 369                                                         );
 370
 371                         dcp::NameFormat::Map name_values;
 372                         name_values['c'] = i->cinema->name;
 373                         name_values['s'] = i->name;
 374                         name_values['f'] = dkdm.annotation_text().get_value_or("");
 375                         name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
 376                         name_values['e'] = end.date() + " " + end.time_of_day(true, false);
 377                         name_values['i'] = kdm.cpl_id();
 378
 379                         kdms.push_back (make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema->emails, kdm));
 380                 }
 381                 write_files (kdms, zip, output, container_name_format, filename_format, verbose, out);
 382                 if (email) {
 383                         send_emails ({kdms}, container_name_format, filename_format, dkdm.annotation_text().get_value_or(""));
 384                 }
 385         } catch (FileError& e) {
 386                 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
 387         }
 388 }
 389
 390
 391 static
 392 void
 393 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent, std::function<void (string)> out)
 394 {
 395         auto const indent_string = string(indent, ' ');
 396
 397         if (indent > 0) {
 398                 out (indent_string + group->name());
 399         }
 400         for (auto i: group->children()) {
 401                 auto g = dynamic_pointer_cast<DKDMGroup>(i);
 402                 if (g) {
 403                         dump_dkdm_group (g, indent + 2, out);
 404                 } else {
 405                         auto d = dynamic_pointer_cast<DKDM>(i);
 406                         assert(d);
 407                         out (indent_string + d->dkdm().cpl_id());
 408                 }
 409         }
 410 }
 411
 412
 413 optional<string>
 414 kdm_cli (int argc, char* argv[], std::function<void (string)> out)
 415 try
 416 {
 417         boost::filesystem::path output = ".";
 418         auto container_name_format = Config::instance()->kdm_container_name_format();
 419         auto filename_format = Config::instance()->kdm_filename_format();
 420         optional<string> cinema_name;
 421         shared_ptr<Cinema> cinema;
 422         string screen_description;
 423         list<shared_ptr<Screen>> screens;
 424         optional<dcp::EncryptedKDM> dkdm;
 425         optional<boost::posix_time::ptime> valid_from;
 426         optional<boost::posix_time::ptime> valid_to;
 427         bool zip = false;
 428         bool list_cinemas = false;
 429         bool list_dkdm_cpls = false;
 430         optional<string> duration_string;
 431         bool verbose = false;
 432         dcp::Formulation formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
 433         bool disable_forensic_marking_picture = false;
 434         optional<int> disable_forensic_marking_audio;
 435         bool email = false;
 436
 437         program_name = argv[0];
 438
 439         int option_index = 0;
 440         while (true) {
 441                 static struct option long_options[] = {
 442                         { "help", no_argument, 0, 'h'},
 443                         { "output", required_argument, 0, 'o'},
 444                         { "filename-format", required_argument, 0, 'K'},
 445                         { "container-name-format", required_argument, 0, 'Z'},
 446                         { "valid-from", required_argument, 0, 'f'},
 447                         { "valid-to", required_argument, 0, 't'},
 448                         { "valid-duration", required_argument, 0, 'd'},
 449                         { "formulation", required_argument, 0, 'F' },
 450                         { "disable-forensic-marking-picture", no_argument, 0, 'p' },
 451                         { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
 452                         { "email", no_argument, 0, 'e' },
 453                         { "zip", no_argument, 0, 'z' },
 454                         { "verbose", no_argument, 0, 'v' },
 455                         { "cinema", required_argument, 0, 'c' },
 456                         { "screen", required_argument, 0, 'S' },
 457                         { "certificate", required_argument, 0, 'C' },
 458                         { "trusted-device", required_argument, 0, 'T' },
 459                         { "list-cinemas", no_argument, 0, 'B' },
 460                         { "list-dkdm-cpls", no_argument, 0, 'D' },
 461                         { 0, 0, 0, 0 }
 462                 };
 463
 464                 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pae::zvc:S:C:T:BD", long_options, &option_index);
 465
 466                 if (c == -1) {
 467                         break;
 468                 }
 469
 470                 switch (c) {
 471                 case 'h':
 472                         help (out);
 473                         exit (EXIT_SUCCESS);
 474                 case 'o':
 475                         output = optarg;
 476                         break;
 477                 case 'K':
 478                         filename_format = dcp::NameFormat (optarg);
 479                         break;
 480                 case 'Z':
 481                         container_name_format = dcp::NameFormat (optarg);
 482                         break;
 483                 case 'f':
 484                         valid_from = time_from_string (optarg);
 485                         break;
 486                 case 't':
 487                         valid_to = time_from_string (optarg);
 488                         break;
 489                 case 'd':
 490                         duration_string = optarg;
 491                         break;
 492                 case 'F':
 493                         if (string(optarg) == "modified-transitional-1") {
 494                                 formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
 495                         } else if (string(optarg) == "multiple-modified-transitional-1") {
 496                                 formulation = dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1;
 497                         } else if (string(optarg) == "dci-any") {
 498                                 formulation = dcp::Formulation::DCI_ANY;
 499                         } else if (string(optarg) == "dci-specific") {
 500                                 formulation = dcp::Formulation::DCI_SPECIFIC;
 501                         } else {
 502                                 throw KDMCLIError ("unrecognised KDM formulation " + string (optarg));
 503                         }
 504                         break;
 505                 case 'p':
 506                         disable_forensic_marking_picture = true;
 507                         break;
 508                 case 'a':
 509                         disable_forensic_marking_audio = 0;
 510                         if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
 511                                 disable_forensic_marking_audio = atoi (argv[optind++]);
 512                         } else if (optarg) {
 513                                 disable_forensic_marking_audio = atoi (optarg);
 514                         }
 515                         break;
 516                 case 'e':
 517                         email = true;
 518                         break;
 519                 case 'z':
 520                         zip = true;
 521                         break;
 522                 case 'v':
 523                         verbose = true;
 524                         break;
 525                 case 'c':
 526                         /* This could be a cinema to search for in the configured list or the name of a cinema being
 527                            built up on-the-fly in the option.  Cater for both possilibities here by storing the name
 528                            (for lookup) and by creating a Cinema which the next Screen will be added to.
 529                         */
 530                         cinema_name = optarg;
 531                         cinema = make_shared<Cinema>(optarg, list<string>(), "", 0, 0);
 532                         break;
 533                 case 'S':
 534                         screen_description = optarg;
 535                         break;
 536                 case 'C':
 537                 {
 538                         /* Make a new screen and add it to the current cinema */
 539                         dcp::CertificateChain chain (dcp::file_to_string(optarg));
 540                         auto screen = make_shared<Screen>(screen_description, "", chain.leaf(), vector<TrustedDevice>());
 541                         if (cinema) {
 542                                 cinema->add_screen (screen);
 543                         }
 544                         screens.push_back (screen);
 545                         break;
 546                 }
 547                 case 'T':
 548                         /* A trusted device ends up in the last screen we made */
 549                         if (!screens.empty ()) {
 550                                 screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
 551                         }
 552                         break;
 553                 case 'B':
 554                         list_cinemas = true;
 555                         break;
 556                 case 'D':
 557                         list_dkdm_cpls = true;
 558                         break;
 559                 }
 560         }
 561
 562         if (list_cinemas) {
 563                 auto cinemas = Config::instance()->cinemas ();
 564                 for (auto i: cinemas) {
 565                         out (String::compose("%1 (%2)", i->name, Emailer::address_list (i->emails)));
 566                 }
 567                 exit (EXIT_SUCCESS);
 568         }
 569
 570         if (list_dkdm_cpls) {
 571                 dump_dkdm_group (Config::instance()->dkdms(), 0, out);
 572                 exit (EXIT_SUCCESS);
 573         }
 574
 575         if (!duration_string && !valid_to) {
 576                 throw KDMCLIError ("you must specify a --valid-duration or --valid-to");
 577         }
 578
 579         if (!valid_from) {
 580                 throw KDMCLIError ("you must specify --valid-from");
 581         }
 582
 583         if (optind >= argc) {
 584                 throw KDMCLIError ("no film, CPL ID or DKDM specified");
 585         }
 586
 587         if (screens.empty()) {
 588                 if (!cinema_name) {
 589                         throw KDMCLIError ("you must specify either a cinema or one or more screens using certificate files");
 590                 }
 591
 592                 screens = find_cinema (*cinema_name)->screens ();
 593         }
 594
 595         if (duration_string) {
 596                 valid_to = valid_from.get() + duration_from_string (*duration_string);
 597         }
 598
 599         dcpomatic_setup_path_encoding ();
 600         dcpomatic_setup ();
 601
 602         if (verbose) {
 603                 out (String::compose("Making KDMs valid from %1 to %2", boost::posix_time::to_simple_string(valid_from.get()), boost::posix_time::to_simple_string(valid_to.get())));
 604         }
 605
 606         string const thing = argv[optind];
 607         if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
 608                 from_film (
 609                         screens,
 610                         thing,
 611                         verbose,
 612                         output,
 613                         container_name_format,
 614                         filename_format,
 615                         *valid_from,
 616                         *valid_to,
 617                         formulation,
 618                         disable_forensic_marking_picture,
 619                         disable_forensic_marking_audio,
 620                         email,
 621                         zip,
 622                         out
 623                         );
 624         } else {
 625                 if (boost::filesystem::is_regular_file(thing)) {
 626                         dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
 627                 } else {
 628                         dkdm = find_dkdm (thing);
 629                 }
 630
 631                 if (!dkdm) {
 632                         throw KDMCLIError ("could not find film or CPL ID corresponding to " + thing);
 633                 }
 634
 635                 from_dkdm (
 636                         screens,
 637                         dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
 638                         verbose,
 639                         output,
 640                         container_name_format,
 641                         filename_format,
 642                         *valid_from,
 643                         *valid_to,
 644                         formulation,
 645                         disable_forensic_marking_picture,
 646                         disable_forensic_marking_audio,
 647                         email,
 648                         zip,
 649                         out
 650                         );
 651         }
 652
 653         return {};
 654 } catch (std::exception& e) {
 655         return string(e.what());
 656 }
 657