Supporters update.
[dcpomatic.git] / 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                             cinema name (when using -C) or name/email (to filter cinemas)");
74         out ("  -S, --screen                             screen name (when using -C) or screen name (to filter screens when using -c)");
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                         int const offset_hour = i->cinema ? i->cinema->utc_offset_hour() : 0;
358                         int const offset_minute = i->cinema ? i->cinema->utc_offset_minute() : 0;
359
360                         dcp::LocalTime begin(valid_from, offset_hour, offset_minute);
361                         dcp::LocalTime end(valid_to, offset_hour, offset_minute);
362
363                         auto const kdm = kdm_from_dkdm(
364                                                         dkdm,
365                                                         i->recipient.get(),
366                                                         i->trusted_device_thumbprints(),
367                                                         begin,
368                                                         end,
369                                                         formulation,
370                                                         disable_forensic_marking_picture,
371                                                         disable_forensic_marking_audio
372                                                         );
373
374                         dcp::NameFormat::Map name_values;
375                         name_values['c'] = i->cinema ? i->cinema->name : "";
376                         name_values['s'] = i->name;
377                         name_values['f'] = kdm.content_title_text();
378                         name_values['b'] = begin.date() + " " + begin.time_of_day(true, false);
379                         name_values['e'] = end.date() + " " + end.time_of_day(true, false);
380                         name_values['i'] = kdm.cpl_id();
381
382                         kdms.push_back (make_shared<KDMWithMetadata>(name_values, i->cinema.get(), i->cinema ? i->cinema->emails : list<string>(), kdm));
383                 }
384                 write_files (kdms, zip, output, container_name_format, filename_format, verbose, out);
385                 if (email) {
386                         send_emails ({kdms}, container_name_format, filename_format, dkdm.annotation_text().get_value_or(""), {});
387                 }
388         } catch (FileError& e) {
389                 throw KDMCLIError (String::compose("%1 (%2)", e.what(), e.file().string()));
390         }
391 }
392
393
394 static
395 void
396 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent, std::function<void (string)> out)
397 {
398         auto const indent_string = string(indent, ' ');
399
400         if (indent > 0) {
401                 out (indent_string + group->name());
402         }
403         for (auto i: group->children()) {
404                 auto g = dynamic_pointer_cast<DKDMGroup>(i);
405                 if (g) {
406                         dump_dkdm_group (g, indent + 2, out);
407                 } else {
408                         auto d = dynamic_pointer_cast<DKDM>(i);
409                         assert(d);
410                         out (indent_string + d->dkdm().cpl_id());
411                 }
412         }
413 }
414
415
416 optional<string>
417 kdm_cli (int argc, char* argv[], std::function<void (string)> out)
418 try
419 {
420         boost::filesystem::path output = boost::filesystem::current_path();
421         auto container_name_format = Config::instance()->kdm_container_name_format();
422         auto filename_format = Config::instance()->kdm_filename_format();
423         optional<string> cinema_name;
424         shared_ptr<Cinema> cinema;
425         optional<boost::filesystem::path> certificate;
426         optional<string> screen;
427         list<shared_ptr<Screen>> screens;
428         optional<dcp::EncryptedKDM> dkdm;
429         optional<boost::posix_time::ptime> valid_from;
430         optional<boost::posix_time::ptime> valid_to;
431         bool zip = false;
432         bool list_cinemas = false;
433         bool list_dkdm_cpls = false;
434         optional<string> duration_string;
435         bool verbose = false;
436         dcp::Formulation formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
437         bool disable_forensic_marking_picture = false;
438         optional<int> disable_forensic_marking_audio;
439         bool email = false;
440
441         program_name = argv[0];
442
443         /* Reset getopt() so we can call this method several times in one test process */
444         optind = 1;
445
446         int option_index = 0;
447         while (true) {
448                 static struct option long_options[] = {
449                         { "help", no_argument, 0, 'h'},
450                         { "output", required_argument, 0, 'o'},
451                         { "filename-format", required_argument, 0, 'K'},
452                         { "container-name-format", required_argument, 0, 'Z'},
453                         { "valid-from", required_argument, 0, 'f'},
454                         { "valid-to", required_argument, 0, 't'},
455                         { "valid-duration", required_argument, 0, 'd'},
456                         { "formulation", required_argument, 0, 'F' },
457                         { "disable-forensic-marking-picture", no_argument, 0, 'p' },
458                         { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
459                         { "email", no_argument, 0, 'e' },
460                         { "zip", no_argument, 0, 'z' },
461                         { "verbose", no_argument, 0, 'v' },
462                         { "cinema", required_argument, 0, 'c' },
463                         { "screen", required_argument, 0, 'S' },
464                         { "certificate", required_argument, 0, 'C' },
465                         { "trusted-device", required_argument, 0, 'T' },
466                         { "list-cinemas", no_argument, 0, 'B' },
467                         { "list-dkdm-cpls", no_argument, 0, 'D' },
468                         { 0, 0, 0, 0 }
469                 };
470
471                 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pae::zvc:S:C:T:BD", long_options, &option_index);
472
473                 if (c == -1) {
474                         break;
475                 }
476
477                 switch (c) {
478                 case 'h':
479                         help (out);
480                         exit (EXIT_SUCCESS);
481                 case 'o':
482                         output = optarg;
483                         break;
484                 case 'K':
485                         filename_format = dcp::NameFormat (optarg);
486                         break;
487                 case 'Z':
488                         container_name_format = dcp::NameFormat (optarg);
489                         break;
490                 case 'f':
491                         valid_from = time_from_string (optarg);
492                         break;
493                 case 't':
494                         valid_to = time_from_string (optarg);
495                         break;
496                 case 'd':
497                         duration_string = optarg;
498                         break;
499                 case 'F':
500                         if (string(optarg) == "modified-transitional-1") {
501                                 formulation = dcp::Formulation::MODIFIED_TRANSITIONAL_1;
502                         } else if (string(optarg) == "multiple-modified-transitional-1") {
503                                 formulation = dcp::Formulation::MULTIPLE_MODIFIED_TRANSITIONAL_1;
504                         } else if (string(optarg) == "dci-any") {
505                                 formulation = dcp::Formulation::DCI_ANY;
506                         } else if (string(optarg) == "dci-specific") {
507                                 formulation = dcp::Formulation::DCI_SPECIFIC;
508                         } else {
509                                 throw KDMCLIError ("unrecognised KDM formulation " + string (optarg));
510                         }
511                         break;
512                 case 'p':
513                         disable_forensic_marking_picture = true;
514                         break;
515                 case 'a':
516                         disable_forensic_marking_audio = 0;
517                         if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
518                                 disable_forensic_marking_audio = atoi (argv[optind++]);
519                         } else if (optarg) {
520                                 disable_forensic_marking_audio = atoi (optarg);
521                         }
522                         break;
523                 case 'e':
524                         email = true;
525                         break;
526                 case 'z':
527                         zip = true;
528                         break;
529                 case 'v':
530                         verbose = true;
531                         break;
532                 case 'c':
533                         /* This could be a cinema to search for in the configured list or the name of a cinema being
534                            built up on-the-fly in the option.  Cater for both possilibities here by storing the name
535                            (for lookup) and by creating a Cinema which the next Screen will be added to.
536                         */
537                         cinema_name = optarg;
538                         cinema = make_shared<Cinema>(optarg, list<string>(), "", 0, 0);
539                         break;
540                 case 'S':
541                         /* Similarly, this could be the name of a new (temporary) screen or the name of a screen
542                          * to search for.
543                          */
544                         screen = optarg;
545                         break;
546                 case 'C':
547                         certificate = optarg;
548                         break;
549                 case 'T':
550                         /* A trusted device ends up in the last screen we made */
551                         if (!screens.empty ()) {
552                                 screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
553                         }
554                         break;
555                 case 'B':
556                         list_cinemas = true;
557                         break;
558                 case 'D':
559                         list_dkdm_cpls = true;
560                         break;
561                 }
562         }
563
564         if (certificate) {
565                 /* Make a new screen and add it to the current cinema */
566                 dcp::CertificateChain chain(dcp::file_to_string(*certificate));
567                 auto screen_to_add = std::make_shared<Screen>(screen.get_value_or(""), "", chain.leaf(), boost::none, vector<TrustedDevice>());
568                 if (cinema) {
569                         cinema->add_screen(screen_to_add);
570                 }
571                 screens.push_back(screen_to_add);
572         }
573
574         if (list_cinemas) {
575                 auto cinemas = Config::instance()->cinemas ();
576                 for (auto i: cinemas) {
577                         out (String::compose("%1 (%2)", i->name, Emailer::address_list (i->emails)));
578                 }
579                 exit (EXIT_SUCCESS);
580         }
581
582         if (list_dkdm_cpls) {
583                 dump_dkdm_group (Config::instance()->dkdms(), 0, out);
584                 exit (EXIT_SUCCESS);
585         }
586
587         if (!duration_string && !valid_to) {
588                 throw KDMCLIError ("you must specify a --valid-duration or --valid-to");
589         }
590
591         if (!valid_from) {
592                 throw KDMCLIError ("you must specify --valid-from");
593         }
594
595         if (optind >= argc) {
596                 throw KDMCLIError ("no film, CPL ID or DKDM specified");
597         }
598
599         if (screens.empty()) {
600                 if (!cinema_name) {
601                         throw KDMCLIError ("you must specify either a cinema or one or more screens using certificate files");
602                 }
603
604                 screens = find_cinema (*cinema_name)->screens ();
605                 if (screen) {
606                         screens.erase(std::remove_if(screens.begin(), screens.end(), [&screen](shared_ptr<Screen> s) { return s->name != *screen; }), screens.end());
607                 }
608         }
609
610         if (duration_string) {
611                 valid_to = valid_from.get() + duration_from_string (*duration_string);
612         }
613
614         if (verbose) {
615                 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())));
616         }
617
618         string const thing = argv[optind];
619         if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
620                 from_film (
621                         screens,
622                         thing,
623                         verbose,
624                         output,
625                         container_name_format,
626                         filename_format,
627                         *valid_from,
628                         *valid_to,
629                         formulation,
630                         disable_forensic_marking_picture,
631                         disable_forensic_marking_audio,
632                         email,
633                         zip,
634                         out
635                         );
636         } else {
637                 if (boost::filesystem::is_regular_file(thing)) {
638                         dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
639                 } else {
640                         dkdm = find_dkdm (thing);
641                 }
642
643                 if (!dkdm) {
644                         throw KDMCLIError ("could not find film or CPL ID corresponding to " + thing);
645                 }
646
647                 from_dkdm (
648                         screens,
649                         dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
650                         verbose,
651                         output,
652                         container_name_format,
653                         filename_format,
654                         *valid_from,
655                         *valid_to,
656                         formulation,
657                         disable_forensic_marking_picture,
658                         disable_forensic_marking_audio,
659                         email,
660                         zip,
661                         out
662                         );
663         }
664
665         return {};
666 } catch (std::exception& e) {
667         return string(e.what());
668 }
669