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 "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 <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_subject = _("KDM delivery");
  95         _kdm_from = "";
  96         _kdm_cc = "";
  97         _kdm_bcc = "";
  98         _check_for_updates = false;
  99         _check_for_test_updates = false;
 100         _maximum_j2k_bandwidth = 250000000;
 101         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 102         _automatic_audio_analysis = false;
 103 #ifdef DCPOMATIC_WINDOWS
 104         _win32_console = false;
 105 #endif
 106
 107         _allowed_dcp_frame_rates.clear ();
 108         _allowed_dcp_frame_rates.push_back (24);
 109         _allowed_dcp_frame_rates.push_back (25);
 110         _allowed_dcp_frame_rates.push_back (30);
 111         _allowed_dcp_frame_rates.push_back (48);
 112         _allowed_dcp_frame_rates.push_back (50);
 113         _allowed_dcp_frame_rates.push_back (60);
 114
 115         set_kdm_email_to_default ();
 116 }
 117
 118 void
 119 Config::restore_defaults ()
 120 {
 121         Config::instance()->set_defaults ();
 122         Config::instance()->changed ();
 123 }
 124
 125 shared_ptr<dcp::CertificateChain>
 126 Config::create_certificate_chain ()
 127 {
 128         return shared_ptr<dcp::CertificateChain> (
 129                 new dcp::CertificateChain (
 130                         openssl_path(),
 131                         "dcpomatic.com",
 132                         "dcpomatic.com",
 133                         ".dcpomatic.smpte-430-2.ROOT",
 134                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 135                         "CS.dcpomatic.smpte-430-2.LEAF"
 136                         )
 137                 );
 138 }
 139
 140 void
 141 Config::read ()
 142 {
 143         if (!have_existing ()) {
 144                 /* Make a new set of signing certificates and key */
 145                 _signer_chain = create_certificate_chain ();
 146                 /* And similar for decryption of KDMs */
 147                 _decryption_chain = create_certificate_chain ();
 148                 write ();
 149                 return;
 150         }
 151
 152         cxml::Document f ("Config");
 153         f.read_file (file ());
 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         if (f.optional_string_child ("DCPMetadataIssuer")) {
 208                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 209         } else if (f.optional_string_child ("DCPIssuer")) {
 210                 _dcp_issuer = f.string_child ("DCPIssuer");
 211         }
 212
 213         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 214
 215         if (version && version.get() >= 2) {
 216                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 217         } else {
 218                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 219         }
 220
 221         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 222         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 223         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 224         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 225
 226         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 227         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 228                 /* Slightly grotty two-part construction of Cinema here so that we can use
 229                    shared_from_this.
 230                 */
 231                 shared_ptr<Cinema> cinema (new Cinema (*i));
 232                 cinema->read_screens (*i);
 233                 _cinemas.push_back (cinema);
 234         }
 235
 236         _mail_server = f.string_child ("MailServer");
 237         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 238         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 239         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 240         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 241         _kdm_from = f.string_child ("KDMFrom");
 242         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 243         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 244         _kdm_email = f.string_child ("KDMEmail");
 245
 246         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 247         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 248
 249         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 250         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 251
 252         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 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
 290 /** @return Filename to write configuration to */
 291 boost::filesystem::path
 292 Config::file (bool create_directories)
 293 {
 294         boost::filesystem::path p;
 295 #ifdef DCPOMATIC_OSX
 296         p /= g_get_home_dir ();
 297         p /= "Library";
 298         p /= "Preferences";
 299         p /= "com.dcpomatic";
 300         p /= "2";
 301 #else
 302         p /= g_get_user_config_dir ();
 303         p /= "dcpomatic2";
 304 #endif
 305         boost::system::error_code ec;
 306         if (create_directories) {
 307                 boost::filesystem::create_directories (p, ec);
 308         }
 309         p /= "config.xml";
 310         return p;
 311 }
 312
 313 /** @return Singleton instance */
 314 Config *
 315 Config::instance ()
 316 {
 317         if (_instance == 0) {
 318                 _instance = new Config;
 319                 try {
 320                         _instance->read ();
 321                 } catch (exception& e) {
 322                         /* configuration load failed; never mind, just
 323                            stick with the default.
 324                         */
 325                         cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
 326                 } catch (...) {
 327                         cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
 328                 }
 329         }
 330
 331         return _instance;
 332 }
 333
 334 /** Write our configuration to disk */
 335 void
 336 Config::write () const
 337 {
 338         xmlpp::Document doc;
 339         xmlpp::Element* root = doc.create_root_node ("Config");
 340
 341         root->add_child("Version")->add_child_text ("2");
 342         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 343         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 344         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 345         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 346
 347         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 348                 root->add_child("Server")->add_child_text (*i);
 349         }
 350
 351         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 352         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
 353         root->add_child("TMSIP")->add_child_text (_tms_ip);
 354         root->add_child("TMSPath")->add_child_text (_tms_path);
 355         root->add_child("TMSUser")->add_child_text (_tms_user);
 356         root->add_child("TMSPassword")->add_child_text (_tms_password);
 357         if (_cinema_sound_processor) {
 358                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 359         }
 360         if (_language) {
 361                 root->add_child("Language")->add_child_text (_language.get());
 362         }
 363         if (_default_container) {
 364                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 365         }
 366         if (_default_dcp_content_type) {
 367                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 368         }
 369         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 370         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 371
 372         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 373
 374         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 375         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 376         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 377         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 378
 379         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 380                 (*i)->as_xml (root->add_child ("Cinema"));
 381         }
 382
 383         root->add_child("MailServer")->add_child_text (_mail_server);
 384         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 385         root->add_child("MailUser")->add_child_text (_mail_user);
 386         root->add_child("MailPassword")->add_child_text (_mail_password);
 387         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 388         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 389         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 390         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 391         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 392
 393         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 394         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 395
 396         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 397         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 398         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 399         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 400 #ifdef DCPOMATIC_WINDOWS
 401         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 402 #endif
 403
 404         xmlpp::Element* signer = root->add_child ("Signer");
 405         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
 406                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 407         }
 408         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 409
 410         xmlpp::Element* decryption = root->add_child ("Decryption");
 411         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
 412                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 413         }
 414         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 415
 416         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 417                 root->add_child("History")->add_child_text (i->string ());
 418         }
 419
 420         try {
 421                 doc.write_to_file_formatted (file().string ());
 422         } catch (xmlpp::exception& e) {
 423                 string s = e.what ();
 424                 trim (s);
 425                 throw FileError (s, file ());
 426         }
 427 }
 428
 429 boost::filesystem::path
 430 Config::default_directory_or (boost::filesystem::path a) const
 431 {
 432         if (_default_directory.empty()) {
 433                 return a;
 434         }
 435
 436         boost::system::error_code ec;
 437         bool const e = boost::filesystem::exists (_default_directory, ec);
 438         if (ec || !e) {
 439                 return a;
 440         }
 441
 442         return _default_directory;
 443 }
 444
 445 void
 446 Config::drop ()
 447 {
 448         delete _instance;
 449         _instance = 0;
 450 }
 451
 452 void
 453 Config::changed (Property what)
 454 {
 455         Changed (what);
 456 }
 457
 458 void
 459 Config::set_kdm_email_to_default ()
 460 {
 461         _kdm_email = _(
 462                 "Dear Projectionist\n\n"
 463                 "Please find attached KDMs for $CPL_NAME.\n\n"
 464                 "Cinema: $CINEMA_NAME\n"
 465                 "Screen(s): $SCREENS\n\n"
 466                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 467                 "Best regards,\nDCP-o-matic"
 468                 );
 469 }
 470
 471 void
 472 Config::reset_kdm_email ()
 473 {
 474         set_kdm_email_to_default ();
 475         changed ();
 476 }
 477
 478 void
 479 Config::add_to_history (boost::filesystem::path p)
 480 {
 481         /* Remove existing instances of this path in the history */
 482         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 483
 484         _history.insert (_history.begin (), p);
 485         if (_history.size() > HISTORY_SIZE) {
 486                 _history.pop_back ();
 487         }
 488
 489         changed ();
 490 }
 491
 492 bool
 493 Config::have_existing ()
 494 {
 495         return boost::filesystem::exists (file (false));
 496 }