Simplify NameFormat stuff.
[dcpomatic.git] / src / lib / config.cc
1 /*
2     Copyright (C) 2012-2016 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 #include "config.h"
22 #include "filter.h"
23 #include "ratio.h"
24 #include "types.h"
25 #include "log.h"
26 #include "dcp_content_type.h"
27 #include "cinema_sound_processor.h"
28 #include "colour_conversion.h"
29 #include "cinema.h"
30 #include "util.h"
31 #include "cross.h"
32 #include "raw_convert.h"
33 #include <dcp/name_format.h>
34 #include <dcp/colour_matrix.h>
35 #include <dcp/certificate_chain.h>
36 #include <libcxml/cxml.h>
37 #include <glib.h>
38 #include <libxml++/libxml++.h>
39 #include <boost/filesystem.hpp>
40 #include <boost/algorithm/string.hpp>
41 #include <boost/foreach.hpp>
42 #include <boost/thread.hpp>
43 #include <cstdlib>
44 #include <fstream>
45 #include <iostream>
46
47 #include "i18n.h"
48
49 using std::vector;
50 using std::cout;
51 using std::ifstream;
52 using std::string;
53 using std::list;
54 using std::max;
55 using std::remove;
56 using std::exception;
57 using std::cerr;
58 using boost::shared_ptr;
59 using boost::optional;
60 using boost::algorithm::trim;
61
62 Config* Config::_instance = 0;
63 boost::signals2::signal<void ()> Config::FailedToLoad;
64
65 /** Construct default configuration */
66 Config::Config ()
67 {
68         set_defaults ();
69 }
70
71 void
72 Config::set_defaults ()
73 {
74         _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
75         _server_port_base = 6192;
76         _use_any_servers = true;
77         _servers.clear ();
78         _only_servers_encode = false;
79         _tms_protocol = PROTOCOL_SCP;
80         _tms_ip = "";
81         _tms_path = ".";
82         _tms_user = "";
83         _tms_password = "";
84         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
85         _allow_any_dcp_frame_rate = false;
86         _language = optional<string> ();
87         _default_still_length = 10;
88         _default_container = Ratio::from_id ("185");
89         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
90         _default_dcp_audio_channels = 6;
91         _default_j2k_bandwidth = 100000000;
92         _default_audio_delay = 0;
93         _default_interop = false;
94         _mail_server = "";
95         _mail_port = 25;
96         _mail_user = "";
97         _mail_password = "";
98         _kdm_from = "";
99         _kdm_cc.clear ();
100         _kdm_bcc = "";
101         _check_for_updates = false;
102         _check_for_test_updates = false;
103         _maximum_j2k_bandwidth = 250000000;
104         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
105         _analyse_ebur128 = true;
106         _automatic_audio_analysis = false;
107 #ifdef DCPOMATIC_WINDOWS
108         _win32_console = false;
109 #endif
110         _cinemas_file = path ("cinemas.xml");
111         _show_hints_before_make_dcp = true;
112         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
113         _dcp_filename_format = dcp::NameFormat ("%t_%i");
114
115         _allowed_dcp_frame_rates.clear ();
116         _allowed_dcp_frame_rates.push_back (24);
117         _allowed_dcp_frame_rates.push_back (25);
118         _allowed_dcp_frame_rates.push_back (30);
119         _allowed_dcp_frame_rates.push_back (48);
120         _allowed_dcp_frame_rates.push_back (50);
121         _allowed_dcp_frame_rates.push_back (60);
122
123         set_kdm_email_to_default ();
124 }
125
126 void
127 Config::restore_defaults ()
128 {
129         Config::instance()->set_defaults ();
130         Config::instance()->changed ();
131 }
132
133 shared_ptr<dcp::CertificateChain>
134 Config::create_certificate_chain ()
135 {
136         return shared_ptr<dcp::CertificateChain> (
137                 new dcp::CertificateChain (
138                         openssl_path(),
139                         "dcpomatic.com",
140                         "dcpomatic.com",
141                         ".dcpomatic.smpte-430-2.ROOT",
142                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
143                         "CS.dcpomatic.smpte-430-2.LEAF"
144                         )
145                 );
146 }
147
148 void
149 Config::read ()
150 try
151 {
152         cxml::Document f ("Config");
153         f.read_file (path ("config.xml"));
154         optional<string> c;
155
156         optional<int> version = f.optional_number_child<int> ("Version");
157
158         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
159         _default_directory = f.string_child ("DefaultDirectory");
160
161         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
162         if (!b) {
163                 b = f.optional_number_child<int> ("ServerPortBase");
164         }
165         _server_port_base = b.get ();
166
167         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
168         _use_any_servers = u.get_value_or (true);
169
170         list<cxml::NodePtr> servers = f.node_children ("Server");
171         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
172                 if ((*i)->node_children("HostName").size() == 1) {
173                         _servers.push_back ((*i)->string_child ("HostName"));
174                 } else {
175                         _servers.push_back ((*i)->content ());
176                 }
177         }
178
179         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
180         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
181         _tms_ip = f.string_child ("TMSIP");
182         _tms_path = f.string_child ("TMSPath");
183         _tms_user = f.string_child ("TMSUser");
184         _tms_password = f.string_child ("TMSPassword");
185
186         c = f.optional_string_child ("SoundProcessor");
187         if (c) {
188                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
189         }
190         c = f.optional_string_child ("CinemaSoundProcessor");
191         if (c) {
192                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
193         }
194
195         _language = f.optional_string_child ("Language");
196
197         c = f.optional_string_child ("DefaultContainer");
198         if (c) {
199                 _default_container = Ratio::from_id (c.get ());
200         }
201
202         c = f.optional_string_child ("DefaultDCPContentType");
203         if (c) {
204                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
205         }
206
207         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
208
209         if (f.optional_string_child ("DCPMetadataIssuer")) {
210                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
211         } else if (f.optional_string_child ("DCPIssuer")) {
212                 _dcp_issuer = f.string_child ("DCPIssuer");
213         }
214
215         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
216
217         if (version && version.get() >= 2) {
218                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
219         } else {
220                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
221         }
222
223         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
224         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
225         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
226         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
227
228         /* Load any cinemas from config.xml */
229         read_cinemas (f);
230
231         _mail_server = f.string_child ("MailServer");
232         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
233         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
234         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
235         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
236         _kdm_from = f.string_child ("KDMFrom");
237         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
238                 if (!i->content().empty()) {
239                         _kdm_cc.push_back (i->content ());
240                 }
241         }
242         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
243         _kdm_email = f.string_child ("KDMEmail");
244
245         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
246         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
247
248         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
249         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
250
251         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
252         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
253         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
254 #ifdef DCPOMATIC_WINDOWS
255         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
256 #endif
257
258         list<cxml::NodePtr> his = f.node_children ("History");
259         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
260                 _history.push_back ((*i)->content ());
261         }
262
263         cxml::NodePtr signer = f.optional_node_child ("Signer");
264         if (signer) {
265                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
266                 /* Read the signing certificates and private key in from the config file */
267                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
268                         c->add (dcp::Certificate (i->content ()));
269                 }
270                 c->set_key (signer->string_child ("PrivateKey"));
271                 _signer_chain = c;
272         } else {
273                 /* Make a new set of signing certificates and key */
274                 _signer_chain = create_certificate_chain ();
275         }
276
277         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
278         if (decryption) {
279                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
280                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
281                         c->add (dcp::Certificate (i->content ()));
282                 }
283                 c->set_key (decryption->string_child ("PrivateKey"));
284                 _decryption_chain = c;
285         } else {
286                 _decryption_chain = create_certificate_chain ();
287         }
288
289         list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
290         BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
291                 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
292         }
293
294         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
295         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
296         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
297         _dcp_filename_format = dcp::NameFormat (f.optional_string_child("DCPFilenameFormat").get_value_or ("%t_%i.mxf"));
298
299         /* Replace any cinemas from config.xml with those from the configured file */
300         if (boost::filesystem::exists (_cinemas_file)) {
301                 cxml::Document f ("Cinemas");
302                 f.read_file (_cinemas_file);
303                 read_cinemas (f);
304         }
305 }
306 catch (...) {
307         if (have_existing ("config.xml")) {
308                 /* We have a config file but it didn't load */
309                 FailedToLoad ();
310         }
311         set_defaults ();
312         /* Make a new set of signing certificates and key */
313         _signer_chain = create_certificate_chain ();
314         /* And similar for decryption of KDMs */
315         _decryption_chain = create_certificate_chain ();
316         write ();
317 }
318
319
320 /** @return Filename to write configuration to */
321 boost::filesystem::path
322 Config::path (string file, bool create_directories)
323 {
324         boost::filesystem::path p;
325 #ifdef DCPOMATIC_OSX
326         p /= g_get_home_dir ();
327         p /= "Library";
328         p /= "Preferences";
329         p /= "com.dcpomatic";
330         p /= "2";
331 #else
332         p /= g_get_user_config_dir ();
333         p /= "dcpomatic2";
334 #endif
335         boost::system::error_code ec;
336         if (create_directories) {
337                 boost::filesystem::create_directories (p, ec);
338         }
339         p /= file;
340         return p;
341 }
342
343 /** @return Singleton instance */
344 Config *
345 Config::instance ()
346 {
347         if (_instance == 0) {
348                 _instance = new Config;
349                 _instance->read ();
350         }
351
352         return _instance;
353 }
354
355 /** Write our configuration to disk */
356 void
357 Config::write () const
358 {
359         write_config_xml ();
360         write_cinemas_xml ();
361 }
362
363 void
364 Config::write_config_xml () const
365 {
366         xmlpp::Document doc;
367         xmlpp::Element* root = doc.create_root_node ("Config");
368
369         root->add_child("Version")->add_child_text ("2");
370         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
371         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
372         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
373         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
374
375         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
376                 root->add_child("Server")->add_child_text (*i);
377         }
378
379         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
380         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
381         root->add_child("TMSIP")->add_child_text (_tms_ip);
382         root->add_child("TMSPath")->add_child_text (_tms_path);
383         root->add_child("TMSUser")->add_child_text (_tms_user);
384         root->add_child("TMSPassword")->add_child_text (_tms_password);
385         if (_cinema_sound_processor) {
386                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
387         }
388         if (_language) {
389                 root->add_child("Language")->add_child_text (_language.get());
390         }
391         if (_default_container) {
392                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
393         }
394         if (_default_dcp_content_type) {
395                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
396         }
397         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
398         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
399         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
400
401         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
402
403         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
404         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
405         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
406         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
407         root->add_child("MailServer")->add_child_text (_mail_server);
408         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
409         root->add_child("MailUser")->add_child_text (_mail_user);
410         root->add_child("MailPassword")->add_child_text (_mail_password);
411         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
412         root->add_child("KDMFrom")->add_child_text (_kdm_from);
413         BOOST_FOREACH (string i, _kdm_cc) {
414                 root->add_child("KDMCC")->add_child_text (i);
415         }
416         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
417         root->add_child("KDMEmail")->add_child_text (_kdm_email);
418
419         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
420         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
421
422         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
423         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
424         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
425         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
426         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
427 #ifdef DCPOMATIC_WINDOWS
428         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
429 #endif
430
431         xmlpp::Element* signer = root->add_child ("Signer");
432         DCPOMATIC_ASSERT (_signer_chain);
433         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
434                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
435         }
436         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
437
438         xmlpp::Element* decryption = root->add_child ("Decryption");
439         DCPOMATIC_ASSERT (_decryption_chain);
440         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
441                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
442         }
443         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
444
445         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
446                 root->add_child("History")->add_child_text (i->string ());
447         }
448
449         BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
450                 root->add_child("DKDM")->add_child_text (i.as_xml ());
451         }
452
453         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
454         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
455         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
456         root->add_child("DCPFilenameFormat")->add_child_text (_dcp_filename_format.specification ());
457
458         try {
459                 doc.write_to_file_formatted (path("config.xml").string ());
460         } catch (xmlpp::exception& e) {
461                 string s = e.what ();
462                 trim (s);
463                 throw FileError (s, path("config.xml"));
464         }
465 }
466
467 void
468 Config::write_cinemas_xml () const
469 {
470         xmlpp::Document doc;
471         xmlpp::Element* root = doc.create_root_node ("Cinemas");
472         root->add_child("Version")->add_child_text ("1");
473
474         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
475                 (*i)->as_xml (root->add_child ("Cinema"));
476         }
477
478         try {
479                 doc.write_to_file_formatted (_cinemas_file.string ());
480         } catch (xmlpp::exception& e) {
481                 string s = e.what ();
482                 trim (s);
483                 throw FileError (s, _cinemas_file);
484         }
485 }
486
487 boost::filesystem::path
488 Config::default_directory_or (boost::filesystem::path a) const
489 {
490         if (_default_directory.empty()) {
491                 return a;
492         }
493
494         boost::system::error_code ec;
495         bool const e = boost::filesystem::exists (_default_directory, ec);
496         if (ec || !e) {
497                 return a;
498         }
499
500         return _default_directory;
501 }
502
503 void
504 Config::drop ()
505 {
506         delete _instance;
507         _instance = 0;
508 }
509
510 void
511 Config::changed (Property what)
512 {
513         Changed (what);
514 }
515
516 void
517 Config::set_kdm_email_to_default ()
518 {
519         _kdm_subject = _("KDM delivery: $CPL_NAME");
520
521         _kdm_email = _(
522                 "Dear Projectionist\n\n"
523                 "Please find attached KDMs for $CPL_NAME.\n\n"
524                 "Cinema: $CINEMA_NAME\n"
525                 "Screen(s): $SCREENS\n\n"
526                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
527                 "Best regards,\nDCP-o-matic"
528                 );
529 }
530
531 void
532 Config::reset_kdm_email ()
533 {
534         set_kdm_email_to_default ();
535         changed ();
536 }
537
538 void
539 Config::add_to_history (boost::filesystem::path p)
540 {
541         /* Remove existing instances of this path in the history */
542         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
543
544         _history.insert (_history.begin (), p);
545         if (_history.size() > HISTORY_SIZE) {
546                 _history.pop_back ();
547         }
548
549         changed ();
550 }
551
552 bool
553 Config::have_existing (string file)
554 {
555         return boost::filesystem::exists (path (file, false));
556 }
557
558 void
559 Config::read_cinemas (cxml::Document const & f)
560 {
561         _cinemas.clear ();
562         list<cxml::NodePtr> cin = f.node_children ("Cinema");
563         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
564                 /* Slightly grotty two-part construction of Cinema here so that we can use
565                    shared_from_this.
566                 */
567                 shared_ptr<Cinema> cinema (new Cinema (*i));
568                 cinema->read_screens (*i);
569                 _cinemas.push_back (cinema);
570         }
571 }
572
573 void
574 Config::set_cinemas_file (boost::filesystem::path file)
575 {
576         _cinemas_file = file;
577
578         if (boost::filesystem::exists (_cinemas_file)) {
579                 /* Existing file; read it in */
580                 cxml::Document f ("Cinemas");
581                 f.read_file (_cinemas_file);
582                 read_cinemas (f);
583         }
584
585         changed (OTHER);
586 }