Rename some variables and re-implement collect().
[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         values['f'] = film->name();
227         values['b'] = dcp::LocalTime(valid_from).date() + " " + dcp::LocalTime(valid_from).time_of_day(true, false);
228         values['e'] = dcp::LocalTime(valid_to).date() + " " + dcp::LocalTime(valid_to).time_of_day(true, false);
229
230         try {
231                 list<KDMWithMetadataPtr> kdms;
232
233                 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
234                         if (i->recipient) {
235                                 dcp::EncryptedKDM const kdm = film->make_kdm (
236                                                 i->recipient.get(),
237                                                 i->trusted_device_thumbprints(),
238                                                 cpl,
239                                                 dcp::LocalTime(valid_from, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
240                                                 dcp::LocalTime(valid_to,   i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
241                                                 formulation,
242                                                 disable_forensic_marking_picture,
243                                                 disable_forensic_marking_audio
244                                                 );
245
246                                 dcp::NameFormat::Map name_values;
247                                 name_values['c'] = i->cinema->name;
248                                 name_values['s'] = i->name;
249
250                                 kdms.push_back (KDMWithMetadataPtr(new DCPKDMWithMetadata(name_values, i->cinema, kdm)));
251                         }
252                 }
253
254                 write_files (kdms, zip, output, container_name_format, filename_format, values, verbose);
255         } catch (FileError& e) {
256                 cerr << program_name << ": " << e.what() << " (" << e.file().string() << ")\n";
257                 exit (EXIT_FAILURE);
258         } catch (KDMError& e) {
259                 cerr << program_name << ": " << e.what() << "\n";
260                 exit (EXIT_FAILURE);
261         } catch (runtime_error& e) {
262                 cerr << program_name << ": " << e.what() << "\n";
263                 exit (EXIT_FAILURE);
264         }
265 }
266
267 optional<dcp::EncryptedKDM>
268 sub_find_dkdm (shared_ptr<DKDMGroup> group, string cpl_id)
269 {
270         BOOST_FOREACH (shared_ptr<DKDMBase> i, group->children()) {
271                 shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup>(i);
272                 if (g) {
273                         optional<dcp::EncryptedKDM> dkdm = sub_find_dkdm (g, cpl_id);
274                         if (dkdm) {
275                                 return dkdm;
276                         }
277                 } else {
278                         shared_ptr<DKDM> d = dynamic_pointer_cast<DKDM>(i);
279                         assert (d);
280                         if (d->dkdm().cpl_id() == cpl_id) {
281                                 return d->dkdm();
282                         }
283                 }
284         }
285
286         return optional<dcp::EncryptedKDM>();
287 }
288
289 optional<dcp::EncryptedKDM>
290 find_dkdm (string cpl_id)
291 {
292         return sub_find_dkdm (Config::instance()->dkdms(), cpl_id);
293 }
294
295 dcp::EncryptedKDM
296 kdm_from_dkdm (
297         dcp::DecryptedKDM dkdm,
298         dcp::Certificate target,
299         vector<string> trusted_devices,
300         dcp::LocalTime valid_from,
301         dcp::LocalTime valid_to,
302         dcp::Formulation formulation,
303         bool disable_forensic_marking_picture,
304         optional<int> disable_forensic_marking_audio
305         )
306 {
307         /* Signer for new KDM */
308         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
309         if (!signer->valid ()) {
310                 error ("signing certificate chain is invalid.");
311         }
312
313         /* Make a new empty KDM and add the keys from the DKDM to it */
314         dcp::DecryptedKDM kdm (
315                 valid_from,
316                 valid_to,
317                 dkdm.annotation_text().get_value_or(""),
318                 dkdm.content_title_text(),
319                 dcp::LocalTime().as_string()
320                 );
321
322         BOOST_FOREACH (dcp::DecryptedKDMKey const & j, dkdm.keys()) {
323                 kdm.add_key(j);
324         }
325
326         return kdm.encrypt (signer, target, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
327 }
328
329 void
330 from_dkdm (
331         list<shared_ptr<Screen> > screens,
332         dcp::DecryptedKDM dkdm,
333         bool verbose,
334         boost::filesystem::path output,
335         dcp::NameFormat container_name_format,
336         dcp::NameFormat filename_format,
337         boost::posix_time::ptime valid_from,
338         boost::posix_time::ptime valid_to,
339         dcp::Formulation formulation,
340         bool disable_forensic_marking_picture,
341         optional<int> disable_forensic_marking_audio,
342         bool zip
343         )
344 {
345         dcp::NameFormat::Map values;
346         values['f'] = dkdm.annotation_text().get_value_or("");
347         values['b'] = dcp::LocalTime(valid_from).date() + " " + dcp::LocalTime(valid_from).time_of_day(true, false);
348         values['e'] = dcp::LocalTime(valid_to).date() + " " + dcp::LocalTime(valid_to).time_of_day(true, false);
349
350         try {
351                 list<KDMWithMetadataPtr> kdms;
352                 BOOST_FOREACH (shared_ptr<Screen> i, screens) {
353                         if (!i->recipient) {
354                                 continue;
355                         }
356
357                         dcp::NameFormat::Map name_values;
358                         name_values['c'] = i->cinema->name;
359                         name_values['s'] = i->name;
360
361                         kdms.push_back (
362                                 KDMWithMetadataPtr(
363                                         new DCPKDMWithMetadata(
364                                                 name_values,
365                                                 i->cinema,
366                                                 kdm_from_dkdm(
367                                                         dkdm,
368                                                         i->recipient.get(),
369                                                         i->trusted_device_thumbprints(),
370                                                         dcp::LocalTime(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
371                                                         dcp::LocalTime(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
372                                                         formulation,
373                                                         disable_forensic_marking_picture,
374                                                         disable_forensic_marking_audio
375                                                         )
376                                                 )
377                                         )
378                                 );
379                 }
380                 write_files (kdms, zip, output, container_name_format, filename_format, values, verbose);
381         } catch (FileError& e) {
382                 cerr << program_name << ": " << e.what() << " (" << e.file().string() << ")\n";
383                 exit (EXIT_FAILURE);
384         } catch (KDMError& e) {
385                 cerr << program_name << ": " << e.what() << "\n";
386                 exit (EXIT_FAILURE);
387         }
388 }
389
390 void
391 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent)
392 {
393         if (indent > 0) {
394                 for (int i = 0; i < indent; ++i) {
395                         cout << " ";
396                 }
397                 cout << group->name() << "\n";
398         }
399         BOOST_FOREACH (shared_ptr<DKDMBase> i, group->children()) {
400                 shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup>(i);
401                 if (g) {
402                         dump_dkdm_group (g, indent + 2);
403                 } else {
404                         for (int j = 0; j < indent; ++j) {
405                                 cout << " ";
406                         }
407                         shared_ptr<DKDM> d = dynamic_pointer_cast<DKDM>(i);
408                         assert(d);
409                         cout << d->dkdm().cpl_id() << "\n";
410                 }
411         }
412 }
413
414 int main (int argc, char* argv[])
415 {
416         boost::filesystem::path output = ".";
417         dcp::NameFormat container_name_format = Config::instance()->kdm_container_name_format();
418         dcp::NameFormat filename_format = Config::instance()->kdm_filename_format();
419         optional<string> cinema_name;
420         shared_ptr<Cinema> cinema;
421         string screen_description = "";
422         list<shared_ptr<Screen> > screens;
423         optional<dcp::EncryptedKDM> dkdm;
424         optional<boost::posix_time::ptime> valid_from;
425         optional<boost::posix_time::ptime> valid_to;
426         bool zip = false;
427         bool list_cinemas = false;
428         bool list_dkdm_cpls = false;
429         optional<string> duration_string;
430         bool verbose = false;
431         dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
432         bool disable_forensic_marking_picture = false;
433         optional<int> disable_forensic_marking_audio;
434
435         program_name = argv[0];
436
437         int option_index = 0;
438         while (true) {
439                 static struct option long_options[] = {
440                         { "help", no_argument, 0, 'h'},
441                         { "output", required_argument, 0, 'o'},
442                         { "filename-format", required_argument, 0, 'K'},
443                         { "container-name-format", required_argument, 0, 'Z'},
444                         { "valid-from", required_argument, 0, 'f'},
445                         { "valid-to", required_argument, 0, 't'},
446                         { "valid-duration", required_argument, 0, 'd'},
447                         { "formulation", required_argument, 0, 'F' },
448                         { "disable-forensic-marking-picture", no_argument, 0, 'p' },
449                         { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
450                         { "zip", no_argument, 0, 'z' },
451                         { "verbose", no_argument, 0, 'v' },
452                         { "cinema", required_argument, 0, 'c' },
453                         { "screen", required_argument, 0, 'S' },
454                         { "certificate", required_argument, 0, 'C' },
455                         { "trusted-device", required_argument, 0, 'T' },
456                         { "list-cinemas", no_argument, 0, 'B' },
457                         { "list-dkdm-cpls", no_argument, 0, 'D' },
458                         { 0, 0, 0, 0 }
459                 };
460
461                 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pa::zvc:S:C:T:BD", long_options, &option_index);
462
463                 if (c == -1) {
464                         break;
465                 }
466
467                 switch (c) {
468                 case 'h':
469                         help ();
470                         exit (EXIT_SUCCESS);
471                 case 'o':
472                         output = optarg;
473                         break;
474                 case 'K':
475                         filename_format = dcp::NameFormat (optarg);
476                         break;
477                 case 'Z':
478                         container_name_format = dcp::NameFormat (optarg);
479                         break;
480                 case 'f':
481                         valid_from = time_from_string (optarg);
482                         break;
483                 case 't':
484                         valid_to = time_from_string (optarg);
485                         break;
486                 case 'd':
487                         duration_string = optarg;
488                         break;
489                 case 'F':
490                         if (string (optarg) == "modified-transitional-1") {
491                                 formulation = dcp::MODIFIED_TRANSITIONAL_1;
492                         } else if (string (optarg) == "multiple-modified-transitional-1") {
493                                 formulation = dcp::MULTIPLE_MODIFIED_TRANSITIONAL_1;
494                         } else if (string (optarg) == "dci-any") {
495                                 formulation = dcp::DCI_ANY;
496                         } else if (string (optarg) == "dci-specific") {
497                                 formulation = dcp::DCI_SPECIFIC;
498                         } else {
499                                 error ("unrecognised KDM formulation " + string (optarg));
500                         }
501                         break;
502                 case 'p':
503                         disable_forensic_marking_picture = true;
504                         break;
505                 case 'a':
506                         disable_forensic_marking_audio = 0;
507                         if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
508                                 disable_forensic_marking_audio = atoi (argv[optind++]);
509                         } else if (optarg) {
510                                 disable_forensic_marking_audio = atoi (optarg);
511                         }
512                         break;
513                 case 'z':
514                         zip = true;
515                         break;
516                 case 'v':
517                         verbose = true;
518                         break;
519                 case 'c':
520                         /* This could be a cinema to search for in the configured list or the name of a cinema being
521                            built up on-the-fly in the option.  Cater for both possilibities here by storing the name
522                            (for lookup) and by creating a Cinema which the next Screen will be added to.
523                         */
524                         cinema_name = optarg;
525                         cinema = shared_ptr<Cinema> (new Cinema (optarg, list<string>(), "", 0, 0));
526                         break;
527                 case 'S':
528                         screen_description = optarg;
529                         break;
530                 case 'C':
531                 {
532                         /* Make a new screen and add it to the current cinema */
533                         dcp::CertificateChain chain (dcp::file_to_string(optarg));
534                         shared_ptr<Screen> screen (new Screen (screen_description, "", chain.leaf(), vector<TrustedDevice>()));
535                         if (cinema) {
536                                 cinema->add_screen (screen);
537                         }
538                         screens.push_back (screen);
539                         break;
540                 }
541                 case 'T':
542                         /* A trusted device ends up in the last screen we made */
543                         if (!screens.empty ()) {
544                                 screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
545                         }
546                         break;
547                 case 'B':
548                         list_cinemas = true;
549                         break;
550                 case 'D':
551                         list_dkdm_cpls = true;
552                         break;
553                 }
554         }
555
556         if (list_cinemas) {
557                 list<boost::shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
558                 for (list<boost::shared_ptr<Cinema> >::const_iterator i = cinemas.begin(); i != cinemas.end(); ++i) {
559                         cout << (*i)->name << " (" << Emailer::address_list ((*i)->emails) << ")\n";
560                 }
561                 exit (EXIT_SUCCESS);
562         }
563
564         if (list_dkdm_cpls) {
565                 dump_dkdm_group (Config::instance()->dkdms(), 0);
566                 exit (EXIT_SUCCESS);
567         }
568
569         if (!duration_string && !valid_to) {
570                 error ("you must specify a --valid-duration or --valid-to");
571         }
572
573         if (!valid_from) {
574                 error ("you must specify --valid-from");
575                 exit (EXIT_FAILURE);
576         }
577
578         if (optind >= argc) {
579                 help ();
580                 exit (EXIT_FAILURE);
581         }
582
583         if (screens.empty()) {
584                 if (!cinema_name) {
585                         error ("you must specify either a cinema or one or more screens using certificate files");
586                 }
587
588                 screens = find_cinema (*cinema_name)->screens ();
589         }
590
591         if (duration_string) {
592                 valid_to = valid_from.get() + duration_from_string (*duration_string);
593         }
594
595         dcpomatic_setup_path_encoding ();
596         dcpomatic_setup ();
597
598         if (verbose) {
599                 cout << "Making KDMs valid from " << valid_from.get() << " to " << valid_to.get() << "\n";
600         }
601
602         string const thing = argv[optind];
603         if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
604                 from_film (
605                         screens,
606                         thing,
607                         verbose,
608                         output,
609                         container_name_format,
610                         filename_format,
611                         *valid_from,
612                         *valid_to,
613                         formulation,
614                         disable_forensic_marking_picture,
615                         disable_forensic_marking_audio,
616                         zip
617                         );
618         } else {
619                 if (boost::filesystem::is_regular_file(thing)) {
620                         dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
621                 } else {
622                         dkdm = find_dkdm (thing);
623                 }
624
625                 if (!dkdm) {
626                         error ("could not find film or CPL ID corresponding to " + thing);
627                 }
628
629                 from_dkdm (
630                         screens,
631                         dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
632                         verbose,
633                         output,
634                         container_name_format,
635                         filename_format,
636                         *valid_from,
637                         *valid_to,
638                         formulation,
639                         disable_forensic_marking_picture,
640                         disable_forensic_marking_audio,
641                         zip
642                         );
643         }
644
645         return 0;
646 }