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