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