2 Copyright (C) 2013-2022 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 /** @file src/tools/dcpomatic_kdm_cli.cc
23 * @brief Command-line program to generate KDMs.
29 #include "dkdm_wrapper.h"
31 #include "exceptions.h"
33 #include "kdm_with_metadata.h"
35 #include <dcp/certificate.h>
36 #include <dcp/decrypted_kdm.h>
37 #include <dcp/encrypted_kdm.h>
41 using std::dynamic_pointer_cast;
43 using std::make_shared;
44 using std::runtime_error;
45 using std::shared_ptr;
48 using boost::optional;
50 #if BOOST_VERSION >= 106100
51 using namespace boost::placeholders;
53 using namespace dcpomatic;
57 help (std::function<void (string)> out)
59 out (String::compose("Syntax: %1 [OPTION] <FILM|CPL-ID|DKDM>", program_name));
60 out (" -h, --help show this help");
61 out (" -o, --output <path> output file or directory");
62 out (" -K, --filename-format <format> filename format for KDMs");
63 out (" -Z, --container-name-format <format> filename format for ZIP containers");
64 out (" -f, --valid-from <time> 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 <time> valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")");
66 out (" -d, --valid-duration <duration> valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")");
67 out (" -F, --formulation <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 <name|email> cinema name (when using -C) or name/email (to filter cinemas)");
74 out (" -S, --screen <name> screen name (when using -C) or screen name (to filter screens when using -c)");
75 out (" -C, --certificate <file> file containing projector certificate");
76 out (" -T, --trusted-device <file> file containing a trusted device's certificate");
77 out (" --cinemas-file <file> use the given file as a list of cinemas instead of the current configuration");
78 out (" --list-cinemas list known cinemas from the DCP-o-matic settings");
79 out (" --list-dkdm-cpls list CPLs for which DCP-o-matic has DKDMs");
81 out ("CPL-ID must be the ID of a CPL that is mentioned in DCP-o-matic's DKDM list.");
85 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.");
86 out ("(Fred's Cinema must have been set up in DCP-o-matic's KDM window)");
88 out (String::compose("\t%1 -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie", program_name));
92 class KDMCLIError : public std::runtime_error
95 KDMCLIError (std::string message)
96 : std::runtime_error (String::compose("%1: %2", program_name, message).c_str())
101 static boost::posix_time::ptime
102 time_from_string (string t)
105 return boost::posix_time::second_clock::local_time ();
108 return boost::posix_time::time_from_string (t);
112 static boost::posix_time::time_duration
113 duration_from_string (string d)
116 char unit_buf[64] = "\0";
117 sscanf (d.c_str(), "%d %63s", &N, unit_buf);
118 string const unit (unit_buf);
121 throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
124 if (unit == "year" || unit == "years") {
125 return boost::posix_time::time_duration (N * 24 * 365, 0, 0, 0);
126 } else if (unit == "week" || unit == "weeks") {
127 return boost::posix_time::time_duration (N * 24 * 7, 0, 0, 0);
128 } else if (unit == "day" || unit == "days") {
129 return boost::posix_time::time_duration (N * 24, 0, 0, 0);
130 } else if (unit == "hour" || unit == "hours") {
131 return boost::posix_time::time_duration (N, 0, 0, 0);
134 throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
148 list<KDMWithMetadataPtr> kdms,
150 boost::filesystem::path output,
151 dcp::NameFormat container_name_format,
152 dcp::NameFormat filename_format,
154 std::function<void (string)> out
158 int const N = write_zip_files (
161 container_name_format,
163 bind (&always_overwrite)
167 out (String::compose("Wrote %1 ZIP files to %2", N, output));
170 int const N = write_files (
171 kdms, output, filename_format,
172 bind (&always_overwrite)
176 out (String::compose("Wrote %1 KDM files to %2", N, output));
184 find_cinema (string cinema_name)
186 auto cinemas = Config::instance()->cinemas ();
187 auto i = cinemas.begin();
189 i != cinemas.end() &&
190 (*i)->name != cinema_name &&
191 find ((*i)->emails.begin(), (*i)->emails.end(), cinema_name) == (*i)->emails.end()) {
196 if (i == cinemas.end ()) {
197 throw KDMCLIError (String::compose("could not find cinema \"%1\"", cinema_name));
207 vector<shared_ptr<Screen>> screens,
208 boost::filesystem::path film_dir,
210 boost::filesystem::path output,
211 dcp::NameFormat container_name_format,
212 dcp::NameFormat filename_format,
213 boost::posix_time::ptime valid_from,
214 boost::posix_time::ptime valid_to,
215 dcp::Formulation formulation,
216 bool disable_forensic_marking_picture,
217 optional<int> disable_forensic_marking_audio,
220 std::function<void (string)> out
223 shared_ptr<Film> film;
225 film = make_shared<Film>(film_dir);
226 film->read_metadata ();
228 out (String::compose("Read film %1", film->name()));
230 } catch (std::exception& e) {
231 throw KDMCLIError (String::compose("error reading film \"%1\" (%2)", film_dir.string(), e.what()));
234 /* XXX: allow specification of this */
235 vector<CPLSummary> cpls = film->cpls ();
237 throw KDMCLIError ("no CPLs found in film");
238 } else if (cpls.size() > 1) {
239 throw KDMCLIError ("more than one CPL found in film");
242 auto cpl = cpls.front().cpl_file;
244 std::vector<KDMCertificatePeriod> period_checks;
247 list<KDMWithMetadataPtr> kdms;
248 for (auto i: screens) {
249 std::function<dcp::DecryptedKDM (dcp::LocalTime, dcp::LocalTime)> make_kdm = [film, cpl](dcp::LocalTime begin, dcp::LocalTime end) {
250 return film->make_kdm(cpl, begin, end);
252 auto p = kdm_for_screen(make_kdm, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio, period_checks);
259 if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE) != period_checks.end()) {
261 "Some KDMs would have validity periods which are completely outside the recipient certificate periods. Such KDMs are very unlikely to work, so will not be created."
265 if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE) != period_checks.end()) {
266 out("For some of these KDMs the recipient certificate's validity period will not cover the whole of the KDM validity period. This might cause problems with the KDMs.");
269 write_files (kdms, zip, output, container_name_format, filename_format, verbose, out);
271 send_emails ({kdms}, container_name_format, filename_format, film->dcp_name(), {});
273 } catch (FileError& e) {
274 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
280 optional<dcp::EncryptedKDM>
281 sub_find_dkdm (shared_ptr<DKDMGroup> group, string cpl_id)
283 for (auto i: group->children()) {
284 auto g = dynamic_pointer_cast<DKDMGroup>(i);
286 auto dkdm = sub_find_dkdm (g, cpl_id);
291 auto d = dynamic_pointer_cast<DKDM>(i);
293 if (d->dkdm().cpl_id() == cpl_id) {
304 optional<dcp::EncryptedKDM>
305 find_dkdm (string cpl_id)
307 return sub_find_dkdm (Config::instance()->dkdms(), cpl_id);
314 dcp::DecryptedKDM dkdm,
315 dcp::Certificate target,
316 vector<string> trusted_devices,
317 dcp::LocalTime valid_from,
318 dcp::LocalTime valid_to,
319 dcp::Formulation formulation,
320 bool disable_forensic_marking_picture,
321 optional<int> disable_forensic_marking_audio
324 /* Signer for new KDM */
325 auto signer = Config::instance()->signer_chain ();
326 if (!signer->valid ()) {
327 throw KDMCLIError ("signing certificate chain is invalid.");
330 /* Make a new empty KDM and add the keys from the DKDM to it */
331 dcp::DecryptedKDM kdm (
334 dkdm.annotation_text().get_value_or(""),
335 dkdm.content_title_text(),
336 dcp::LocalTime().as_string()
339 for (auto const& j: dkdm.keys()) {
343 return kdm.encrypt (signer, target, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
350 vector<shared_ptr<Screen>> screens,
351 dcp::DecryptedKDM dkdm,
353 boost::filesystem::path output,
354 dcp::NameFormat container_name_format,
355 dcp::NameFormat filename_format,
356 boost::posix_time::ptime valid_from,
357 boost::posix_time::ptime valid_to,
358 dcp::Formulation formulation,
359 bool disable_forensic_marking_picture,
360 optional<int> disable_forensic_marking_audio,
363 std::function<void (string)> out
366 dcp::NameFormat::Map values;
369 list<KDMWithMetadataPtr> kdms;
370 for (auto i: screens) {
375 int const offset_hour = i->cinema ? i->cinema->utc_offset_hour() : 0;
376 int const offset_minute = i->cinema ? i->cinema->utc_offset_minute() : 0;
378 dcp::LocalTime begin(valid_from, dcp::UTCOffset(offset_hour, offset_minute));
379 dcp::LocalTime end(valid_to, dcp::UTCOffset(offset_hour, offset_minute));
381 auto const kdm = kdm_from_dkdm(
384 i->trusted_device_thumbprints(),
388 disable_forensic_marking_picture,
389 disable_forensic_marking_audio
392 dcp::NameFormat::Map name_values;
393 name_values['c'] = i->cinema ? i->cinema->name : "";
394 name_values['s'] = i->name;
395 name_values['f'] = kdm.content_title_text();
396 name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
397 name_values['e'] = end.date() + " " + end.time_of_day(true, false);
398 name_values['i'] = kdm.cpl_id();
400 kdms.push_back(make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema ? i->cinema->emails : vector<string>(), kdm));
402 write_files (kdms, zip, output, container_name_format, filename_format, verbose, out);
404 send_emails ({kdms}, container_name_format, filename_format, dkdm.annotation_text().get_value_or(""), {});
406 } catch (FileError& e) {
407 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
414 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent, std::function<void (string)> out)
416 auto const indent_string = string(indent, ' ');
419 out (indent_string + group->name());
421 for (auto i: group->children()) {
422 auto g = dynamic_pointer_cast<DKDMGroup>(i);
424 dump_dkdm_group (g, indent + 2, out);
426 auto d = dynamic_pointer_cast<DKDM>(i);
428 out (indent_string + d->dkdm().cpl_id());
435 kdm_cli (int argc, char* argv[], std::function<void (string)> out)
438 boost::filesystem::path output = boost::filesystem::current_path();
439 auto container_name_format = Config::instance()->kdm_container_name_format();
440 auto filename_format = Config::instance()->kdm_filename_format();
441 optional<string> cinema_name;
442 shared_ptr<Cinema> cinema;
443 optional<boost::filesystem::path> certificate;
444 optional<string> screen;
445 vector<shared_ptr<Screen>> screens;
446 optional<dcp::EncryptedKDM> dkdm;
447 optional<boost::posix_time::ptime> valid_from;
448 optional<boost::posix_time::ptime> valid_to;
450 bool list_cinemas = false;
451 bool list_dkdm_cpls = false;
452 optional<string> duration_string;
453 bool verbose = false;
454 dcp::Formulation formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
455 bool disable_forensic_marking_picture = false;
456 optional<int> disable_forensic_marking_audio;
458 optional<boost::filesystem::path> cinemas_file;
460 program_name = argv[0];
462 /* Reset getopt() so we can call this method several times in one test process */
465 int option_index = 0;
467 static struct option long_options[] = {
468 { "help", no_argument, 0, 'h'},
469 { "output", required_argument, 0, 'o'},
470 { "filename-format", required_argument, 0, 'K'},
471 { "container-name-format", required_argument, 0, 'Z'},
472 { "valid-from", required_argument, 0, 'f'},
473 { "valid-to", required_argument, 0, 't'},
474 { "valid-duration", required_argument, 0, 'd'},
475 { "formulation", required_argument, 0, 'F' },
476 { "disable-forensic-marking-picture", no_argument, 0, 'p' },
477 { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
478 { "email", no_argument, 0, 'e' },
479 { "zip", no_argument, 0, 'z' },
480 { "verbose", no_argument, 0, 'v' },
481 { "cinema", required_argument, 0, 'c' },
482 { "screen", required_argument, 0, 'S' },
483 { "certificate", required_argument, 0, 'C' },
484 { "trusted-device", required_argument, 0, 'T' },
485 { "list-cinemas", no_argument, 0, 'B' },
486 { "list-dkdm-cpls", no_argument, 0, 'D' },
487 { "cinemas-file", required_argument, 0, 'E' },
491 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pae::zvc:S:C:T:BDE:", long_options, &option_index);
505 filename_format = dcp::NameFormat (optarg);
508 container_name_format = dcp::NameFormat (optarg);
511 valid_from = time_from_string (optarg);
514 valid_to = time_from_string (optarg);
517 duration_string = optarg;
520 if (string(optarg) == "modified-transitional-1") {
521 formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
522 } else if (string(optarg) == "multiple-modified-transitional-1") {
523 formulation = dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1;
524 } else if (string(optarg) == "dci-any") {
525 formulation = dcp::Formulation::DCI_ANY;
526 } else if (string(optarg) == "dci-specific") {
527 formulation = dcp::Formulation::DCI_SPECIFIC;
529 throw KDMCLIError ("unrecognised KDM formulation " + string (optarg));
533 disable_forensic_marking_picture = true;
536 disable_forensic_marking_audio = 0;
537 if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
538 disable_forensic_marking_audio = atoi (argv[optind++]);
540 disable_forensic_marking_audio = atoi (optarg);
553 /* This could be a cinema to search for in the configured list or the name of a cinema being
554 built up on-the-fly in the option. Cater for both possilibities here by storing the name
555 (for lookup) and by creating a Cinema which the next Screen will be added to.
557 cinema_name = optarg;
558 cinema = make_shared<Cinema>(optarg, vector<string>(), "", 0, 0);
561 /* Similarly, this could be the name of a new (temporary) screen or the name of a screen
567 certificate = optarg;
570 /* A trusted device ends up in the last screen we made */
571 if (!screens.empty ()) {
572 screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
579 list_dkdm_cpls = true;
582 cinemas_file = optarg;
588 Config::instance()->set_cinemas_file(*cinemas_file);
592 /* Make a new screen and add it to the current cinema */
593 dcp::CertificateChain chain(dcp::file_to_string(*certificate));
594 auto screen_to_add = std::make_shared<Screen>(screen.get_value_or(""), "", chain.leaf(), boost::none, vector<TrustedDevice>());
596 cinema->add_screen(screen_to_add);
598 screens.push_back(screen_to_add);
602 auto cinemas = Config::instance()->cinemas ();
603 for (auto i: cinemas) {
604 out (String::compose("%1 (%2)", i->name, Emailer::address_list (i->emails)));
609 if (list_dkdm_cpls) {
610 dump_dkdm_group (Config::instance()->dkdms(), 0, out);
614 if (!duration_string && !valid_to) {
615 throw KDMCLIError ("you must specify a --valid-duration or --valid-to");
619 throw KDMCLIError ("you must specify --valid-from");
622 if (optind >= argc) {
623 throw KDMCLIError ("no film, CPL ID or DKDM specified");
626 if (screens.empty()) {
628 throw KDMCLIError ("you must specify either a cinema or one or more screens using certificate files");
631 screens = find_cinema (*cinema_name)->screens ();
633 screens.erase(std::remove_if(screens.begin(), screens.end(), [&screen](shared_ptr<Screen> s) { return s->name != *screen; }), screens.end());
637 if (duration_string) {
638 valid_to = valid_from.get() + duration_from_string (*duration_string);
642 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())));
645 string const thing = argv[optind];
646 if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
652 container_name_format,
657 disable_forensic_marking_picture,
658 disable_forensic_marking_audio,
664 if (boost::filesystem::is_regular_file(thing)) {
665 dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
667 dkdm = find_dkdm (thing);
671 throw KDMCLIError ("could not find film or CPL ID corresponding to " + thing);
676 dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
679 container_name_format,
684 disable_forensic_marking_picture,
685 disable_forensic_marking_audio,
693 } catch (std::exception& e) {
694 return string(e.what());