src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "config.h"
  21 #include "filter.h"
  22 #include "ratio.h"
  23 #include "types.h"
  24 #include "log.h"
  25 #include "dcp_content_type.h"
  26 #include "cinema_sound_processor.h"
  27 #include "colour_conversion.h"
  28 #include "cinema.h"
  29 #include "util.h"
  30 #include "cross.h"
  31 #include "raw_convert.h"
  32 #include <dcp/colour_matrix.h>
  33 #include <dcp/certificate_chain.h>
  34 #include <libcxml/cxml.h>
  35 #include <glib.h>
  36 #include <libxml++/libxml++.h>
  37 #include <boost/filesystem.hpp>
  38 #include <boost/algorithm/string.hpp>
  39 #include <boost/foreach.hpp>
  40 #include <boost/thread.hpp>
  41 #include <cstdlib>
  42 #include <fstream>
  43 #include <iostream>
  44
  45 #include "i18n.h"
  46
  47 using std::vector;
  48 using std::cout;
  49 using std::ifstream;
  50 using std::string;
  51 using std::list;
  52 using std::max;
  53 using std::remove;
  54 using std::exception;
  55 using std::cerr;
  56 using boost::shared_ptr;
  57 using boost::optional;
  58 using boost::algorithm::trim;
  59
  60 Config* Config::_instance = 0;
  61
  62 /** Construct default configuration */
  63 Config::Config ()
  64 {
  65         set_defaults ();
  66 }
  67
  68 void
  69 Config::set_defaults ()
  70 {
  71         _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  72         _server_port_base = 6192;
  73         _use_any_servers = true;
  74         _servers.clear ();
  75         _only_servers_encode = false;
  76         _tms_protocol = PROTOCOL_SCP;
  77         _tms_ip = "";
  78         _tms_path = ".";
  79         _tms_user = "";
  80         _tms_password = "";
  81         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
  82         _allow_any_dcp_frame_rate = false;
  83         _language = optional<string> ();
  84         _default_still_length = 10;
  85         _default_container = Ratio::from_id ("185");
  86         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
  87         _default_j2k_bandwidth = 100000000;
  88         _default_audio_delay = 0;
  89         _default_interop = false;
  90         _mail_server = "";
  91         _mail_port = 25;
  92         _mail_user = "";
  93         _mail_password = "";
  94         _kdm_from = "";
  95         _kdm_cc.clear ();
  96         _kdm_bcc = "";
  97         _check_for_updates = false;
  98         _check_for_test_updates = false;
  99         _maximum_j2k_bandwidth = 250000000;
 100         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 101         _automatic_audio_analysis = false;
 102 #ifdef DCPOMATIC_WINDOWS
 103         _win32_console = false;
 104 #endif
 105
 106         _allowed_dcp_frame_rates.clear ();
 107         _allowed_dcp_frame_rates.push_back (24);
 108         _allowed_dcp_frame_rates.push_back (25);
 109         _allowed_dcp_frame_rates.push_back (30);
 110         _allowed_dcp_frame_rates.push_back (48);
 111         _allowed_dcp_frame_rates.push_back (50);
 112         _allowed_dcp_frame_rates.push_back (60);
 113
 114         set_kdm_email_to_default ();
 115 }
 116
 117 void
 118 Config::restore_defaults ()
 119 {
 120         Config::instance()->set_defaults ();
 121         Config::instance()->changed ();
 122 }
 123
 124 shared_ptr<dcp::CertificateChain>
 125 Config::create_certificate_chain ()
 126 {
 127         return shared_ptr<dcp::CertificateChain> (
 128                 new dcp::CertificateChain (
 129                         openssl_path(),
 130                         "dcpomatic.com",
 131                         "dcpomatic.com",
 132                         ".dcpomatic.smpte-430-2.ROOT",
 133                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 134                         "CS.dcpomatic.smpte-430-2.LEAF"
 135                         )
 136                 );
 137 }
 138
 139 void
 140 Config::read ()
 141 {
 142         if (!have_existing ("config.xml")) {
 143                 /* Make a new set of signing certificates and key */
 144                 _signer_chain = create_certificate_chain ();
 145                 /* And similar for decryption of KDMs */
 146                 _decryption_chain = create_certificate_chain ();
 147                 write ();
 148                 return;
 149         }
 150
 151         cxml::Document f ("Config");
 152         f.read_file (path ("config.xml"));
 153         optional<string> c;
 154
 155         optional<int> version = f.optional_number_child<int> ("Version");
 156
 157         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 158         _default_directory = f.string_child ("DefaultDirectory");
 159
 160         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 161         if (!b) {
 162                 b = f.optional_number_child<int> ("ServerPortBase");
 163         }
 164         _server_port_base = b.get ();
 165
 166         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 167         _use_any_servers = u.get_value_or (true);
 168
 169         list<cxml::NodePtr> servers = f.node_children ("Server");
 170         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 171                 if ((*i)->node_children("HostName").size() == 1) {
 172                         _servers.push_back ((*i)->string_child ("HostName"));
 173                 } else {
 174                         _servers.push_back ((*i)->content ());
 175                 }
 176         }
 177
 178         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 179         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 180         _tms_ip = f.string_child ("TMSIP");
 181         _tms_path = f.string_child ("TMSPath");
 182         _tms_user = f.string_child ("TMSUser");
 183         _tms_password = f.string_child ("TMSPassword");
 184
 185         c = f.optional_string_child ("SoundProcessor");
 186         if (c) {
 187                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 188         }
 189         c = f.optional_string_child ("CinemaSoundProcessor");
 190         if (c) {
 191                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 192         }
 193
 194         _language = f.optional_string_child ("Language");
 195
 196         c = f.optional_string_child ("DefaultContainer");
 197         if (c) {
 198                 _default_container = Ratio::from_id (c.get ());
 199         }
 200
 201         c = f.optional_string_child ("DefaultDCPContentType");
 202         if (c) {
 203                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 204         }
 205
 206         if (f.optional_string_child ("DCPMetadataIssuer")) {
 207                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 208         } else if (f.optional_string_child ("DCPIssuer")) {
 209                 _dcp_issuer = f.string_child ("DCPIssuer");
 210         }
 211
 212         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 213
 214         if (version && version.get() >= 2) {
 215                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 216         } else {
 217                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 218         }
 219
 220         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 221         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 222         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 223         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 224
 225         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 226         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 227                 /* Slightly grotty two-part construction of Cinema here so that we can use
 228                    shared_from_this.
 229                 */
 230                 shared_ptr<Cinema> cinema (new Cinema (*i));
 231                 cinema->read_screens (*i);
 232                 _cinemas.push_back (cinema);
 233         }
 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         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 257 #ifdef DCPOMATIC_WINDOWS
 258         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 259 #endif
 260
 261         list<cxml::NodePtr> his = f.node_children ("History");
 262         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 263                 _history.push_back ((*i)->content ());
 264         }
 265
 266         cxml::NodePtr signer = f.optional_node_child ("Signer");
 267         if (signer) {
 268                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 269                 /* Read the signing certificates and private key in from the config file */
 270                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 271                         c->add (dcp::Certificate (i->content ()));
 272                 }
 273                 c->set_key (signer->string_child ("PrivateKey"));
 274                 _signer_chain = c;
 275         } else {
 276                 /* Make a new set of signing certificates and key */
 277                 _signer_chain = create_certificate_chain ();
 278         }
 279
 280         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 281         if (decryption) {
 282                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 283                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 284                         c->add (dcp::Certificate (i->content ()));
 285                 }
 286                 c->set_key (decryption->string_child ("PrivateKey"));
 287                 _decryption_chain = c;
 288         } else {
 289                 _decryption_chain = create_certificate_chain ();
 290         }
 291
 292         list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
 293         BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
 294                 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
 295         }
 296
 297 }
 298
 299 /** @return Filename to write configuration to */
 300 boost::filesystem::path
 301 Config::path (string file, bool create_directories)
 302 {
 303         boost::filesystem::path p;
 304 #ifdef DCPOMATIC_OSX
 305         p /= g_get_home_dir ();
 306         p /= "Library";
 307         p /= "Preferences";
 308         p /= "com.dcpomatic";
 309         p /= "2";
 310 #else
 311         p /= g_get_user_config_dir ();
 312         p /= "dcpomatic2";
 313 #endif
 314         boost::system::error_code ec;
 315         if (create_directories) {
 316                 boost::filesystem::create_directories (p, ec);
 317         }
 318         p /= file;
 319         return p;
 320 }
 321
 322 /** @return Singleton instance */
 323 Config *
 324 Config::instance ()
 325 {
 326         if (_instance == 0) {
 327                 _instance = new Config;
 328                 try {
 329                         _instance->read ();
 330                 } catch (exception& e) {
 331                         /* configuration load failed; never mind, just
 332                            stick with the default.
 333                         */
 334                         cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
 335                 } catch (...) {
 336                         cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
 337                 }
 338         }
 339
 340         return _instance;
 341 }
 342
 343 /** Write our configuration to disk */
 344 void
 345 Config::write () const
 346 {
 347         xmlpp::Document doc;
 348         xmlpp::Element* root = doc.create_root_node ("Config");
 349
 350         root->add_child("Version")->add_child_text ("2");
 351         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 352         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 353         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 354         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 355
 356         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 357                 root->add_child("Server")->add_child_text (*i);
 358         }
 359
 360         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 361         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
 362         root->add_child("TMSIP")->add_child_text (_tms_ip);
 363         root->add_child("TMSPath")->add_child_text (_tms_path);
 364         root->add_child("TMSUser")->add_child_text (_tms_user);
 365         root->add_child("TMSPassword")->add_child_text (_tms_password);
 366         if (_cinema_sound_processor) {
 367                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 368         }
 369         if (_language) {
 370                 root->add_child("Language")->add_child_text (_language.get());
 371         }
 372         if (_default_container) {
 373                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 374         }
 375         if (_default_dcp_content_type) {
 376                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 377         }
 378         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 379         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 380
 381         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 382
 383         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 384         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 385         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 386         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 387
 388         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 389                 (*i)->as_xml (root->add_child ("Cinema"));
 390         }
 391
 392         root->add_child("MailServer")->add_child_text (_mail_server);
 393         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 394         root->add_child("MailUser")->add_child_text (_mail_user);
 395         root->add_child("MailPassword")->add_child_text (_mail_password);
 396         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 397         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 398         BOOST_FOREACH (string i, _kdm_cc) {
 399                 root->add_child("KDMCC")->add_child_text (i);
 400         }
 401         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 402         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 403
 404         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 405         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 406
 407         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 408         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 409         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 410         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 411 #ifdef DCPOMATIC_WINDOWS
 412         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 413 #endif
 414
 415         xmlpp::Element* signer = root->add_child ("Signer");
 416         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
 417                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 418         }
 419         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 420
 421         xmlpp::Element* decryption = root->add_child ("Decryption");
 422         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
 423                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 424         }
 425         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 426
 427         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 428                 root->add_child("History")->add_child_text (i->string ());
 429         }
 430
 431         BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
 432                 root->add_child("DKDM")->add_child_text (i.as_xml ());
 433         }
 434
 435         try {
 436                 doc.write_to_file_formatted (path("config.xml").string ());
 437         } catch (xmlpp::exception& e) {
 438                 string s = e.what ();
 439                 trim (s);
 440                 throw FileError (s, path("config.xml"));
 441         }
 442 }
 443
 444 boost::filesystem::path
 445 Config::default_directory_or (boost::filesystem::path a) const
 446 {
 447         if (_default_directory.empty()) {
 448                 return a;
 449         }
 450
 451         boost::system::error_code ec;
 452         bool const e = boost::filesystem::exists (_default_directory, ec);
 453         if (ec || !e) {
 454                 return a;
 455         }
 456
 457         return _default_directory;
 458 }
 459
 460 void
 461 Config::drop ()
 462 {
 463         delete _instance;
 464         _instance = 0;
 465 }
 466
 467 void
 468 Config::changed (Property what)
 469 {
 470         Changed (what);
 471 }
 472
 473 void
 474 Config::set_kdm_email_to_default ()
 475 {
 476         _kdm_subject = _("KDM delivery: $CPL_NAME");
 477
 478         _kdm_email = _(
 479                 "Dear Projectionist\n\n"
 480                 "Please find attached KDMs for $CPL_NAME.\n\n"
 481                 "Cinema: $CINEMA_NAME\n"
 482                 "Screen(s): $SCREENS\n\n"
 483                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 484                 "Best regards,\nDCP-o-matic"
 485                 );
 486 }
 487
 488 void
 489 Config::reset_kdm_email ()
 490 {
 491         set_kdm_email_to_default ();
 492         changed ();
 493 }
 494
 495 void
 496 Config::add_to_history (boost::filesystem::path p)
 497 {
 498         /* Remove existing instances of this path in the history */
 499         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 500
 501         _history.insert (_history.begin (), p);
 502         if (_history.size() > HISTORY_SIZE) {
 503                 _history.pop_back ();
 504         }
 505
 506         changed ();
 507 }
 508
 509 bool
 510 Config::have_existing (string file)
 511 {
 512         return boost::filesystem::exists (path (file, false));
 513 }