Fix failure to save screen notes when making a new one (github bug #6).
[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<shared_ptr<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<shared_ptr<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<shared_ptr<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                                 shared_ptr<ScreenKDM>(
341                                         new DCPScreenKDM(
342                                                 i,
343                                                 kdm_from_dkdm(
344                                                         dkdm,
345                                                         i->recipient.get(),
346                                                         i->trusted_device_thumbprints(),
347                                                         dcp::LocalTime(valid_from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
348                                                         dcp::LocalTime(valid_to, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
349                                                         formulation,
350                                                         disable_forensic_marking_picture,
351                                                         disable_forensic_marking_audio
352                                                         )
353                                                 )
354                                         )
355                                 );
356                 }
357                 write_files (screen_kdms, zip, output, container_name_format, filename_format, values, verbose);
358         } catch (FileError& e) {
359                 cerr << program_name << ": " << e.what() << " (" << e.file().string() << ")\n";
360                 exit (EXIT_FAILURE);
361         } catch (KDMError& e) {
362                 cerr << program_name << ": " << e.what() << "\n";
363                 exit (EXIT_FAILURE);
364         }
365 }
366
367 void
368 dump_dkdm_group (shared_ptr<DKDMGroup> group, int indent)
369 {
370         if (indent > 0) {
371                 for (int i = 0; i < indent; ++i) {
372                         cout << " ";
373                 }
374                 cout << group->name() << "\n";
375         }
376         BOOST_FOREACH (shared_ptr<DKDMBase> i, group->children()) {
377                 shared_ptr<DKDMGroup> g = dynamic_pointer_cast<DKDMGroup>(i);
378                 if (g) {
379                         dump_dkdm_group (g, indent + 2);
380                 } else {
381                         for (int j = 0; j < indent; ++j) {
382                                 cout << " ";
383                         }
384                         shared_ptr<DKDM> d = dynamic_pointer_cast<DKDM>(i);
385                         assert(d);
386                         cout << d->dkdm().cpl_id() << "\n";
387                 }
388         }
389 }
390
391 int main (int argc, char* argv[])
392 {
393         boost::filesystem::path output = ".";
394         dcp::NameFormat container_name_format = Config::instance()->kdm_container_name_format();
395         dcp::NameFormat filename_format = Config::instance()->kdm_filename_format();
396         optional<string> cinema_name;
397         shared_ptr<Cinema> cinema;
398         string screen_description = "";
399         list<shared_ptr<Screen> > screens;
400         optional<dcp::EncryptedKDM> dkdm;
401         optional<boost::posix_time::ptime> valid_from;
402         optional<boost::posix_time::ptime> valid_to;
403         bool zip = false;
404         bool list_cinemas = false;
405         bool list_dkdm_cpls = false;
406         optional<string> duration_string;
407         bool verbose = false;
408         dcp::Formulation formulation = dcp::MODIFIED_TRANSITIONAL_1;
409         bool disable_forensic_marking_picture = false;
410         optional<int> disable_forensic_marking_audio;
411
412         program_name = argv[0];
413
414         int option_index = 0;
415         while (true) {
416                 static struct option long_options[] = {
417                         { "help", no_argument, 0, 'h'},
418                         { "output", required_argument, 0, 'o'},
419                         { "filename-format", required_argument, 0, 'K'},
420                         { "container-name-format", required_argument, 0, 'Z'},
421                         { "valid-from", required_argument, 0, 'f'},
422                         { "valid-to", required_argument, 0, 't'},
423                         { "valid-duration", required_argument, 0, 'd'},
424                         { "formulation", required_argument, 0, 'F' },
425                         { "disable-forensic-marking-picture", no_argument, 0, 'p' },
426                         { "disable-forensic-marking-audio", optional_argument, 0, 'a' },
427                         { "zip", no_argument, 0, 'z' },
428                         { "verbose", no_argument, 0, 'v' },
429                         { "cinema", required_argument, 0, 'c' },
430                         { "screen", required_argument, 0, 'S' },
431                         { "certificate", required_argument, 0, 'C' },
432                         { "trusted-device", required_argument, 0, 'T' },
433                         { "list-cinemas", no_argument, 0, 'B' },
434                         { "list-dkdm-cpls", no_argument, 0, 'D' },
435                         { 0, 0, 0, 0 }
436                 };
437
438                 int c = getopt_long (argc, argv, "ho:K:Z:f:t:d:F:pa::zvc:S:C:T:BD", long_options, &option_index);
439
440                 if (c == -1) {
441                         break;
442                 }
443
444                 switch (c) {
445                 case 'h':
446                         help ();
447                         exit (EXIT_SUCCESS);
448                 case 'o':
449                         output = optarg;
450                         break;
451                 case 'K':
452                         filename_format = dcp::NameFormat (optarg);
453                         break;
454                 case 'Z':
455                         container_name_format = dcp::NameFormat (optarg);
456                         break;
457                 case 'f':
458                         valid_from = time_from_string (optarg);
459                         break;
460                 case 't':
461                         valid_to = time_from_string (optarg);
462                         break;
463                 case 'd':
464                         duration_string = optarg;
465                         break;
466                 case 'F':
467                         if (string (optarg) == "modified-transitional-1") {
468                                 formulation = dcp::MODIFIED_TRANSITIONAL_1;
469                         } else if (string (optarg) == "multiple-modified-transitional-1") {
470                                 formulation = dcp::MULTIPLE_MODIFIED_TRANSITIONAL_1;
471                         } else if (string (optarg) == "dci-any") {
472                                 formulation = dcp::DCI_ANY;
473                         } else if (string (optarg) == "dci-specific") {
474                                 formulation = dcp::DCI_SPECIFIC;
475                         } else {
476                                 error ("unrecognised KDM formulation " + string (optarg));
477                         }
478                         break;
479                 case 'p':
480                         disable_forensic_marking_picture = true;
481                         break;
482                 case 'a':
483                         disable_forensic_marking_audio = 0;
484                         if (optarg == 0 && argv[optind] != 0 && argv[optind][0] != '-') {
485                                 disable_forensic_marking_audio = atoi (argv[optind++]);
486                         } else if (optarg) {
487                                 disable_forensic_marking_audio = atoi (optarg);
488                         }
489                         break;
490                 case 'z':
491                         zip = true;
492                         break;
493                 case 'v':
494                         verbose = true;
495                         break;
496                 case 'c':
497                         /* This could be a cinema to search for in the configured list or the name of a cinema being
498                            built up on-the-fly in the option.  Cater for both possilibities here by storing the name
499                            (for lookup) and by creating a Cinema which the next Screen will be added to.
500                         */
501                         cinema_name = optarg;
502                         cinema = shared_ptr<Cinema> (new Cinema (optarg, list<string>(), "", 0, 0));
503                         break;
504                 case 'S':
505                         screen_description = optarg;
506                         break;
507                 case 'C':
508                 {
509                         /* Make a new screen and add it to the current cinema */
510                         dcp::CertificateChain chain (dcp::file_to_string(optarg));
511                         shared_ptr<Screen> screen (new Screen (screen_description, "", chain.leaf(), vector<TrustedDevice>()));
512                         if (cinema) {
513                                 cinema->add_screen (screen);
514                         }
515                         screens.push_back (screen);
516                         break;
517                 }
518                 case 'T':
519                         /* A trusted device ends up in the last screen we made */
520                         if (!screens.empty ()) {
521                                 screens.back()->trusted_devices.push_back(TrustedDevice(dcp::Certificate(dcp::file_to_string(optarg))));
522                         }
523                         break;
524                 case 'B':
525                         list_cinemas = true;
526                         break;
527                 case 'D':
528                         list_dkdm_cpls = true;
529                         break;
530                 }
531         }
532
533         if (list_cinemas) {
534                 list<boost::shared_ptr<Cinema> > cinemas = Config::instance()->cinemas ();
535                 for (list<boost::shared_ptr<Cinema> >::const_iterator i = cinemas.begin(); i != cinemas.end(); ++i) {
536                         cout << (*i)->name << " (" << Emailer::address_list ((*i)->emails) << ")\n";
537                 }
538                 exit (EXIT_SUCCESS);
539         }
540
541         if (list_dkdm_cpls) {
542                 dump_dkdm_group (Config::instance()->dkdms(), 0);
543                 exit (EXIT_SUCCESS);
544         }
545
546         if (!duration_string && !valid_to) {
547                 error ("you must specify a --valid-duration or --valid-to");
548         }
549
550         if (!valid_from) {
551                 error ("you must specify --valid-from");
552                 exit (EXIT_FAILURE);
553         }
554
555         if (optind >= argc) {
556                 help ();
557                 exit (EXIT_FAILURE);
558         }
559
560         if (screens.empty()) {
561                 if (!cinema_name) {
562                         error ("you must specify either a cinema or one or more screens using certificate files");
563                 }
564
565                 screens = find_cinema (*cinema_name)->screens ();
566         }
567
568         if (duration_string) {
569                 valid_to = valid_from.get() + duration_from_string (*duration_string);
570         }
571
572         dcpomatic_setup_path_encoding ();
573         dcpomatic_setup ();
574
575         if (verbose) {
576                 cout << "Making KDMs valid from " << valid_from.get() << " to " << valid_to.get() << "\n";
577         }
578
579         string const thing = argv[optind];
580         if (boost::filesystem::is_directory(thing) && boost::filesystem::is_regular_file(boost::filesystem::path(thing) / "metadata.xml")) {
581                 from_film (
582                         screens,
583                         thing,
584                         verbose,
585                         output,
586                         container_name_format,
587                         filename_format,
588                         *valid_from,
589                         *valid_to,
590                         formulation,
591                         disable_forensic_marking_picture,
592                         disable_forensic_marking_audio,
593                         zip
594                         );
595         } else {
596                 if (boost::filesystem::is_regular_file(thing)) {
597                         dkdm = dcp::EncryptedKDM (dcp::file_to_string (thing));
598                 } else {
599                         dkdm = find_dkdm (thing);
600                 }
601
602                 if (!dkdm) {
603                         error ("could not find film or CPL ID corresponding to " + thing);
604                 }
605
606                 from_dkdm (
607                         screens,
608                         dcp::DecryptedKDM (*dkdm, Config::instance()->decryption_chain()->key().get()),
609                         verbose,
610                         output,
611                         container_name_format,
612                         filename_format,
613                         *valid_from,
614                         *valid_to,
615                         formulation,
616                         disable_forensic_marking_picture,
617                         disable_forensic_marking_audio,
618                         zip
619                         );
620         }
621
622         return 0;
623 }