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