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 "server.h"
  22 #include "filter.h"
  23 #include "ratio.h"
  24 #include "dcp_content_type.h"
  25 #include "cinema_sound_processor.h"
  26 #include "colour_conversion.h"
  27 #include "cinema.h"
  28 #include "util.h"
  29 #include "cross.h"
  30 #include "raw_convert.h"
  31 #include <dcp/colour_matrix.h>
  32 #include <dcp/signer.h>
  33 #include <dcp/certificate_chain.h>
  34 #include <libcxml/cxml.h>
  35 #include <glib.h>
  36 #include <boost/filesystem.hpp>
  37 #include <boost/algorithm/string.hpp>
  38 #include <cstdlib>
  39 #include <fstream>
  40
  41 #include "i18n.h"
  42
  43 using std::vector;
  44 using std::cout;
  45 using std::ifstream;
  46 using std::string;
  47 using std::list;
  48 using std::max;
  49 using std::remove;
  50 using std::exception;
  51 using std::cerr;
  52 using boost::shared_ptr;
  53 using boost::optional;
  54 using boost::algorithm::trim;
  55
  56 Config* Config::_instance = 0;
  57
  58 /** Construct default configuration */
  59 Config::Config ()
  60 {
  61         set_defaults ();
  62 }
  63
  64 void
  65 Config::set_defaults ()
  66 {
  67         _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  68         _server_port_base = 6192;
  69         _use_any_servers = true;
  70         _tms_path = ".";
  71         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
  72         _allow_any_dcp_frame_rate = false;
  73         _default_still_length = 10;
  74         _default_container = Ratio::from_id ("185");
  75         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
  76         _default_j2k_bandwidth = 100000000;
  77         _default_audio_delay = 0;
  78         _check_for_updates = false;
  79         _check_for_test_updates = false;
  80         _maximum_j2k_bandwidth = 250000000;
  81         _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR | Log::TYPE_DEBUG;
  82 #ifdef DCPOMATIC_WINDOWS
  83         _win32_console = false;
  84 #endif
  85
  86         _allowed_dcp_frame_rates.clear ();
  87         _allowed_dcp_frame_rates.push_back (24);
  88         _allowed_dcp_frame_rates.push_back (25);
  89         _allowed_dcp_frame_rates.push_back (30);
  90         _allowed_dcp_frame_rates.push_back (48);
  91         _allowed_dcp_frame_rates.push_back (50);
  92         _allowed_dcp_frame_rates.push_back (60);
  93
  94         _colour_conversions.clear ();
  95         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), dcp::ColourConversion::srgb_to_xyz ()));
  96         _colour_conversions.push_back (PresetColourConversion (_("Rec. 601"), dcp::ColourConversion::rec601_to_xyz ()));
  97         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), dcp::ColourConversion::rec709_to_xyz ()));
  98
  99         set_kdm_email_to_default ();
 100 }
 101
 102 void
 103 Config::restore_defaults ()
 104 {
 105         Config::instance()->set_defaults ();
 106         Config::instance()->changed ();
 107 }
 108
 109 void
 110 Config::read ()
 111 {
 112         if (!boost::filesystem::exists (file ())) {
 113                 /* Make a new set of signing certificates and key */
 114                 _signer.reset (new dcp::Signer (openssl_path ()));
 115                 /* And decryption keys */
 116                 make_decryption_keys ();
 117                 return;
 118         }
 119
 120         cxml::Document f ("Config");
 121         f.read_file (file ());
 122         optional<string> c;
 123
 124         optional<int> version = f.optional_number_child<int> ("Version");
 125
 126         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 127         _default_directory = f.string_child ("DefaultDirectory");
 128
 129         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 130         if (!b) {
 131                 b = f.optional_number_child<int> ("ServerPortBase");
 132         }
 133         _server_port_base = b.get ();
 134
 135         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 136         _use_any_servers = u.get_value_or (true);
 137
 138         list<cxml::NodePtr> servers = f.node_children ("Server");
 139         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 140                 if ((*i)->node_children("HostName").size() == 1) {
 141                         _servers.push_back ((*i)->string_child ("HostName"));
 142                 } else {
 143                         _servers.push_back ((*i)->content ());
 144                 }
 145         }
 146
 147         _tms_ip = f.string_child ("TMSIP");
 148         _tms_path = f.string_child ("TMSPath");
 149         _tms_user = f.string_child ("TMSUser");
 150         _tms_password = f.string_child ("TMSPassword");
 151
 152         c = f.optional_string_child ("SoundProcessor");
 153         if (c) {
 154                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 155         }
 156         c = f.optional_string_child ("CinemaSoundProcessor");
 157         if (c) {
 158                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 159         }
 160
 161         _language = f.optional_string_child ("Language");
 162
 163         c = f.optional_string_child ("DefaultContainer");
 164         if (c) {
 165                 _default_container = Ratio::from_id (c.get ());
 166         }
 167
 168         c = f.optional_string_child ("DefaultDCPContentType");
 169         if (c) {
 170                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 171         }
 172
 173         if (f.optional_string_child ("DCPMetadataIssuer")) {
 174                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 175         } else if (f.optional_string_child ("DCPIssuer")) {
 176                 _dcp_issuer = f.string_child ("DCPIssuer");
 177         }
 178
 179         if (version && version.get() >= 2) {
 180                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 181         } else {
 182                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 183         }
 184
 185         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 186         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 187         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 188
 189         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 190
 191         if (!cc.empty ()) {
 192                 _colour_conversions.clear ();
 193         }
 194
 195         try {
 196                 for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 197                         /* This is a bit of a hack; use 32 (the first Film state file version for the 2.x branch)
 198                            for version 2 and 10 (the current Film state version for the 1.x branch) for version 1.
 199                         */
 200                         _colour_conversions.push_back (PresetColourConversion (*i, version == 2 ? 32 : 10));
 201                 }
 202         } catch (cxml::Error) {
 203                 /* Probably failed to load an old-style ColourConversion tag; just give up */
 204                 _colour_conversions.push_back (PresetColourConversion (_("sRGB"), dcp::ColourConversion::srgb_to_xyz ()));
 205                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), dcp::ColourConversion::rec709_to_xyz ()));
 206         }
 207
 208         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 209         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 210                 /* Slightly grotty two-part construction of Cinema here so that we can use
 211                    shared_from_this.
 212                 */
 213                 shared_ptr<Cinema> cinema (new Cinema (*i));
 214                 cinema->read_screens (*i);
 215                 _cinemas.push_back (cinema);
 216         }
 217
 218         _mail_server = f.string_child ("MailServer");
 219         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 220         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 221         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 222         _kdm_from = f.string_child ("KDMFrom");
 223         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 224         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 225         _kdm_email = f.string_child ("KDMEmail");
 226
 227         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 228         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 229
 230         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 231         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 232
 233         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 234 #ifdef DCPOMATIC_WINDOWS
 235         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 236 #endif
 237
 238         list<cxml::NodePtr> his = f.node_children ("History");
 239         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 240                 _history.push_back ((*i)->content ());
 241         }
 242
 243         cxml::NodePtr signer = f.optional_node_child ("Signer");
 244         dcp::CertificateChain signer_chain;
 245         if (signer) {
 246                 /* Read the signing certificates and private key in from the config file */
 247                 list<cxml::NodePtr> certificates = signer->node_children ("Certificate");
 248                 for (list<cxml::NodePtr>::const_iterator i = certificates.begin(); i != certificates.end(); ++i) {
 249                         signer_chain.add (dcp::Certificate ((*i)->content ()));
 250                 }
 251
 252                 _signer.reset (new dcp::Signer (signer_chain, signer->string_child ("PrivateKey")));
 253         } else {
 254                 /* Make a new set of signing certificates and key */
 255                 _signer.reset (new dcp::Signer (openssl_path ()));
 256         }
 257
 258         if (f.optional_string_child ("DecryptionCertificate")) {
 259                 _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate"));
 260         }
 261
 262         if (f.optional_string_child ("DecryptionPrivateKey")) {
 263                 _decryption_private_key = f.string_child ("DecryptionPrivateKey");
 264         }
 265
 266         if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) {
 267                 /* Generate our own decryption certificate and key if either is not present in config */
 268                 make_decryption_keys ();
 269         }
 270 }
 271
 272 void
 273 Config::make_decryption_keys ()
 274 {
 275         boost::filesystem::path p = dcp::make_certificate_chain (openssl_path ());
 276         _decryption_certificate = dcp::Certificate (dcp::file_to_string (p / "leaf.signed.pem"));
 277         _decryption_private_key = dcp::file_to_string (p / "leaf.key");
 278         boost::filesystem::remove_all (p);
 279 }
 280
 281 /** @return Filename to write configuration to */
 282 boost::filesystem::path
 283 Config::file () const
 284 {
 285         boost::filesystem::path p;
 286         p /= g_get_user_config_dir ();
 287         boost::system::error_code ec;
 288         boost::filesystem::create_directory (p, ec);
 289         p /= "dcpomatic2";
 290         boost::filesystem::create_directory (p, ec);
 291         p /= "config.xml";
 292         return p;
 293 }
 294
 295 /** @return Singleton instance */
 296 Config *
 297 Config::instance ()
 298 {
 299         if (_instance == 0) {
 300                 _instance = new Config;
 301                 try {
 302                         _instance->read ();
 303                 } catch (exception& e) {
 304                         /* configuration load failed; never mind, just
 305                            stick with the default.
 306                         */
 307                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 308                 } catch (...) {
 309                         cerr << "dcpomatic: failed to load configuration\n";
 310                 }
 311         }
 312
 313         return _instance;
 314 }
 315
 316 /** Write our configuration to disk */
 317 void
 318 Config::write () const
 319 {
 320         xmlpp::Document doc;
 321         xmlpp::Element* root = doc.create_root_node ("Config");
 322
 323         root->add_child("Version")->add_child_text ("2");
 324         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 325         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 326         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 327         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 328
 329         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 330                 root->add_child("Server")->add_child_text (*i);
 331         }
 332
 333         root->add_child("TMSIP")->add_child_text (_tms_ip);
 334         root->add_child("TMSPath")->add_child_text (_tms_path);
 335         root->add_child("TMSUser")->add_child_text (_tms_user);
 336         root->add_child("TMSPassword")->add_child_text (_tms_password);
 337         if (_cinema_sound_processor) {
 338                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 339         }
 340         if (_language) {
 341                 root->add_child("Language")->add_child_text (_language.get());
 342         }
 343         if (_default_container) {
 344                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 345         }
 346         if (_default_dcp_content_type) {
 347                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 348         }
 349         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 350
 351         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 352
 353         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 354         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 355         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 356
 357         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 358                 i->as_xml (root->add_child ("ColourConversion"));
 359         }
 360
 361         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 362                 (*i)->as_xml (root->add_child ("Cinema"));
 363         }
 364
 365         root->add_child("MailServer")->add_child_text (_mail_server);
 366         root->add_child("MailUser")->add_child_text (_mail_user);
 367         root->add_child("MailPassword")->add_child_text (_mail_password);
 368         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 369         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 370         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 371         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 372         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 373
 374         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 375         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 376
 377         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 378         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 379         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 380 #ifdef DCPOMATIC_WINDOWS
 381         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 382 #endif
 383
 384         xmlpp::Element* signer = root->add_child ("Signer");
 385         dcp::CertificateChain::List certs = _signer->certificates().root_to_leaf ();
 386         for (dcp::CertificateChain::List::const_iterator i = certs.begin(); i != certs.end(); ++i) {
 387                 signer->add_child("Certificate")->add_child_text (i->certificate (true));
 388         }
 389         signer->add_child("PrivateKey")->add_child_text (_signer->key ());
 390
 391         root->add_child("DecryptionCertificate")->add_child_text (_decryption_certificate.certificate (true));
 392         root->add_child("DecryptionPrivateKey")->add_child_text (_decryption_private_key);
 393
 394         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 395                 root->add_child("History")->add_child_text (i->string ());
 396         }
 397
 398         try {
 399                 doc.write_to_file_formatted (file().string ());
 400         } catch (xmlpp::exception& e) {
 401                 string s = e.what ();
 402                 trim (s);
 403                 throw FileError (s, file ());
 404         }
 405 }
 406
 407 boost::filesystem::path
 408 Config::default_directory_or (boost::filesystem::path a) const
 409 {
 410         if (_default_directory.empty()) {
 411                 return a;
 412         }
 413
 414         boost::system::error_code ec;
 415         bool const e = boost::filesystem::exists (_default_directory, ec);
 416         if (ec || !e) {
 417                 return a;
 418         }
 419
 420         return _default_directory;
 421 }
 422
 423 void
 424 Config::drop ()
 425 {
 426         delete _instance;
 427         _instance = 0;
 428 }
 429
 430 void
 431 Config::changed ()
 432 {
 433         write ();
 434         Changed ();
 435 }
 436
 437 void
 438 Config::set_kdm_email_to_default ()
 439 {
 440         _kdm_email = _(
 441                 "Dear Projectionist\n\n"
 442                 "Please find attached KDMs for $CPL_NAME.\n\n"
 443                 "Cinema: $CINEMA_NAME\n"
 444                 "Screen(s): $SCREENS\n\n"
 445                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 446                 "Best regards,\nDCP-o-matic"
 447                 );
 448 }
 449
 450 void
 451 Config::reset_kdm_email ()
 452 {
 453         set_kdm_email_to_default ();
 454         changed ();
 455 }
 456
 457 void
 458 Config::add_to_history (boost::filesystem::path p)
 459 {
 460         /* Remove existing instances of this path in the history */
 461         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 462
 463         _history.insert (_history.begin (), p);
 464         if (_history.size() > HISTORY_SIZE) {
 465                 _history.pop_back ();
 466         }
 467
 468         changed ();
 469 }