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>
44 using std::dynamic_pointer_cast;
46 using std::make_shared;
47 using std::runtime_error;
48 using std::shared_ptr;
51 using boost::optional;
53 #if BOOST_VERSION >= 106100
54 using namespace boost::placeholders;
56 using namespace dcpomatic;
62 cerr << "Syntax: " << program_name << " [OPTION] <FILM|CPL-ID|DKDM>\n"
63 " -h, --help show this help\n"
64 " -o, --output output file or directory\n"
65 " -K, --filename-format filename format for KDMs\n"
66 " -Z, --container-name-format filename format for ZIP containers\n"
67 " -f, --valid-from valid from time (in local time zone of the cinema) (e.g. \"2013-09-28 01:41:51\") or \"now\"\n"
68 " -t, --valid-to valid to time (in local time zone of the cinema) (e.g. \"2014-09-28 01:41:51\")\n"
69 " -d, --valid-duration valid duration (e.g. \"1 day\", \"4 hours\", \"2 weeks\")\n"
70 " -F, --formulation modified-transitional-1, multiple-modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]\n"
71 " -p, --disable-forensic-marking-picture disable forensic marking of pictures essences\n"
72 " -a, --disable-forensic-marking-audio disable forensic marking of audio essences (optionally above a given channel, e.g 12)\n"
73 " -e, --email email KDMs to cinemas\n"
74 " -z, --zip ZIP each cinema's KDMs into its own file\n"
75 " -v, --verbose be verbose\n"
76 " -c, --cinema specify a cinema, either by name or email address\n"
77 " -S, --screen screen description\n"
78 " -C, --certificate file containing projector certificate\n"
79 " -T, --trusted-device file containing a trusted device's certificate\n"
80 " --list-cinemas list known cinemas from the DCP-o-matic settings\n"
81 " --list-dkdm-cpls list CPLs for which DCP-o-matic has DKDMs\n\n"
82 "CPL-ID must be the ID of a CPL that is mentioned in DCP-o-matic's DKDM list.\n\n"
84 "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"
85 "(Fred's Cinema must have been set up in DCP-o-matic's KDM window)\n\n"
86 "\t" << program_name << " -c \"Fred's Cinema\" -f now -d \"2 weeks\" -z my_great_movie\n\n";
90 class KDMCLIError : public std::runtime_error
93 KDMCLIError (std::string message)
94 : std::runtime_error (String::compose("%1: %2", program_name, message).c_str())
99 static boost::posix_time::ptime
100 time_from_string (string t)
103 return boost::posix_time::second_clock::local_time ();
106 return boost::posix_time::time_from_string (t);
110 static boost::posix_time::time_duration
111 duration_from_string (string d)
114 char unit_buf[64] = "\0";
115 sscanf (d.c_str(), "%d %63s", &N, unit_buf);
116 string const unit (unit_buf);
119 throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
122 if (unit == "year" || unit == "years") {
123 return boost::posix_time::time_duration (N * 24 * 365, 0, 0, 0);
124 } else if (unit == "week" || unit == "weeks") {
125 return boost::posix_time::time_duration (N * 24 * 7, 0, 0, 0);
126 } else if (unit == "day" || unit == "days") {
127 return boost::posix_time::time_duration (N * 24, 0, 0, 0);
128 } else if (unit == "hour" || unit == "hours") {
129 return boost::posix_time::time_duration (N, 0, 0, 0);
132 throw KDMCLIError (String::compose("could not understand duration \"%1\"", d));
146 list<KDMWithMetadataPtr> kdms,
148 boost::filesystem::path output,
149 dcp::NameFormat container_name_format,
150 dcp::NameFormat filename_format,
155 int const N = write_zip_files (
158 container_name_format,
160 bind (&always_overwrite)
164 cout << "Wrote " << N << " ZIP files to " << output << "\n";
167 int const N = write_files (
168 kdms, output, filename_format,
169 bind (&always_overwrite)
173 cout << "Wrote " << N << " KDM files to " << output << "\n";
181 find_cinema (string cinema_name)
183 auto cinemas = Config::instance()->cinemas ();
184 auto i = cinemas.begin();
186 i != cinemas.end() &&
187 (*i)->name != cinema_name &&
188 find ((*i)->emails.begin(), (*i)->emails.end(), cinema_name) == (*i)->emails.end()) {
193 if (i == cinemas.end ()) {
194 throw KDMCLIError (String::compose("could not find cinema \"%1\"", cinema_name));
204 list<shared_ptr<Screen>> screens,
205 boost::filesystem::path film_dir,
207 boost::filesystem::path output,
208 dcp::NameFormat container_name_format,
209 dcp::NameFormat filename_format,
210 boost::posix_time::ptime valid_from,
211 boost::posix_time::ptime valid_to,
212 dcp::Formulation formulation,
213 bool disable_forensic_marking_picture,
214 optional<int> disable_forensic_marking_audio,
219 shared_ptr<Film> film;
221 film = make_shared<Film>(film_dir);
222 film->read_metadata ();
224 cout << "Read film " << film->name () << "\n";
226 } catch (std::exception& e) {
227 throw KDMCLIError (String::compose("error reading film \"%1\" (%2)", film_dir.string(), e.what()));
230 /* XXX: allow specification of this */
231 vector<CPLSummary> cpls = film->cpls ();
233 throw KDMCLIError ("no CPLs found in film");
234 } else if (cpls.size() > 1) {
235 throw KDMCLIError ("more than one CPL found in film");
238 auto cpl = cpls.front().cpl_file;
241 list<KDMWithMetadataPtr> kdms;
242 for (auto i: screens) {
243 auto p = kdm_for_screen (film, cpl, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
248 write_files (kdms, zip, output, container_name_format, filename_format, verbose);
250 send_emails ({kdms}, container_name_format, filename_format, film->dcp_name());
252 } catch (FileError& e) {
253 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
259 optional<dcp::EncryptedKDM>
260 sub_find_dkdm (shared_ptr<DKDMGroup> group, string cpl_id)
262 for (auto i: group->children()) {
263 auto g = dynamic_pointer_cast<DKDMGroup>(i);
265 auto dkdm = sub_find_dkdm (g, cpl_id);
270 auto d = dynamic_pointer_cast<DKDM>(i);
272 if (d->dkdm().cpl_id() == cpl_id) {
283 optional<dcp::EncryptedKDM>
284 find_dkdm (string cpl_id)
286 return sub_find_dkdm (Config::instance()->dkdms(), cpl_id);
293 dcp::DecryptedKDM dkdm,
294 dcp::Certificate target,
295 vector<string> trusted_devices,
296 dcp::LocalTime valid_from,
297 dcp::LocalTime valid_to,
298 dcp::Formulation formulation,
299 bool disable_forensic_marking_picture,
300 optional<int> disable_forensic_marking_audio
303 /* Signer for new KDM */
304 auto signer = Config::instance()->signer_chain ();
305 if (!signer->valid ()) {
306 throw KDMCLIError ("signing certificate chain is invalid.");
309 /* Make a new empty KDM and add the keys from the DKDM to it */
310 dcp::DecryptedKDM kdm (
313 dkdm.annotation_text().get_value_or(""),
314 dkdm.content_title_text(),
315 dcp::LocalTime().as_string()
318 for (auto const& j: dkdm.keys()) {
322 return kdm.encrypt (signer, target, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
329 list<shared_ptr<Screen>> screens,
330 dcp::DecryptedKDM dkdm,
332 boost::filesystem::path output,
333 dcp::NameFormat container_name_format,
334 dcp::NameFormat filename_format,
335 boost::posix_time::ptime valid_from,
336 boost::posix_time::ptime valid_to,
337 dcp::Formulation formulation,
338 bool disable_forensic_marking_picture,
339 optional<int> disable_forensic_marking_audio,
344 dcp::NameFormat::Map values;
347 list<KDMWithMetadataPtr> kdms;
348 for (auto i: screens) {
353 dcp::LocalTime begin(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
354 dcp::LocalTime end(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute());
356 auto const kdm = kdm_from_dkdm(
359 i->trusted_device_thumbprints(),
363 disable_forensic_marking_picture,
364 disable_forensic_marking_audio
367 dcp::NameFormat::Map name_values;
368 name_values['c'] = i->cinema->name;
369 name_values['s'] = i->name;
370 name_values['f'] = dkdm.annotation_text().get_value_or("");
371 name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
372 name_values['e'] = end.date() + " " + end.time_of_day(true, false);
373 name_values['i'] = kdm.cpl_id();
375 kdms.push_back (make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema->emails, kdm));
377 write_files (kdms, zip, output, container_name_format, filename_format, verbose);
379 send_emails ({kdms}, container_name_format, filename_format, dkdm.annotation_text().get_value_or(""));
381 } catch (FileError& e) {
382 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
389 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent)
392 for (int i = 0; i < indent; ++i) {
395 cout << group->name() << "\n";
397 for (auto i: group->children()) {
398 auto g = dynamic_pointer_cast<DKDMGroup>(i);
400 dump_dkdm_group (g, indent + 2);
402 for (int j = 0; j < indent; ++j) {
405 auto d = dynamic_pointer_cast<DKDM>(i);
407 cout << d->dkdm().cpl_id() << "\n";
414 kdm_cli (int argc, char* argv[])
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;
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;
437 program_name = argv[0];
439 int option_index = 0;
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' },
464 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pae::zvc:S:C:T:BD", long_options, &option_index);
478 filename_format = dcp::NameFormat (optarg);
481 container_name_format = dcp::NameFormat (optarg);
484 valid_from = time_from_string (optarg);
487 valid_to = time_from_string (optarg);
490 duration_string = optarg;
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;
502 throw KDMCLIError ("unrecognised KDM formulation " + string (optarg));
506 disable_forensic_marking_picture = true;
509 disable_forensic_marking_audio = 0;
510 if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
511 disable_forensic_marking_audio = atoi (argv[optind++]);
513 disable_forensic_marking_audio = atoi (optarg);
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.
530 cinema_name = optarg;
531 cinema = make_shared<Cinema>(optarg, list<string>(), "", 0, 0);
534 screen_description = optarg;
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>());
542 cinema->add_screen (screen);
544 screens.push_back (screen);
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))));
557 list_dkdm_cpls = true;
563 auto cinemas = Config::instance()->cinemas ();
564 for (auto i: cinemas) {
565 cout << i->name << " (" << Emailer::address_list (i->emails) << ")\n";
570 if (list_dkdm_cpls) {
571 dump_dkdm_group (Config::instance()->dkdms(), 0);
575 if (!duration_string && !valid_to) {
576 throw KDMCLIError ("you must specify a --valid-duration or --valid-to");
580 throw KDMCLIError ("you must specify --valid-from");
583 if (optind >= argc) {
588 if (screens.empty()) {
590 throw KDMCLIError ("you must specify either a cinema or one or more screens using certificate files");
593 screens = find_cinema (*cinema_name)->screens ();
596 if (duration_string) {
597 valid_to = valid_from.get() + duration_from_string (*duration_string);
600 dcpomatic_setup_path_encoding ();
604 cout << "Making KDMs valid from " << valid_from.get() << " to " << valid_to.get() << "\n";
607 string const thing = argv[optind];
608 if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
614 container_name_format,
619 disable_forensic_marking_picture,
620 disable_forensic_marking_audio,
625 if (boost::filesystem::is_regular_file(thing)) {
626 dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
628 dkdm = find_dkdm (thing);
632 throw KDMCLIError ("could not find film or CPL ID corresponding to " + thing);
637 dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
640 container_name_format,
645 disable_forensic_marking_picture,
646 disable_forensic_marking_audio,
653 } catch (std::exception& e) {
654 return string(e.what());