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         _mail_server = "";
  90         _mail_port = 25;
  91         _mail_user = "";
  92         _mail_password = "";
  93         _kdm_subject = _("KDM delivery");
  94         _kdm_from = "";
  95         _kdm_cc = "";
  96         _kdm_bcc = "";
  97         _check_for_updates = false;
  98         _check_for_test_updates = false;
  99         _maximum_j2k_bandwidth = 250000000;
 100         _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::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 void
 125 Config::read ()
 126 {
 127         if (!have_existing ()) {
 128                 /* Make a new set of signing certificates and key */
 129                 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
 130                 /* And similar for decryption of KDMs */
 131                 _decryption_chain.reset (new dcp::CertificateChain (openssl_path ()));
 132                 write ();
 133                 return;
 134         }
 135
 136         cxml::Document f ("Config");
 137         f.read_file (file ());
 138         optional<string> c;
 139
 140         optional<int> version = f.optional_number_child<int> ("Version");
 141
 142         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 143         _default_directory = f.string_child ("DefaultDirectory");
 144
 145         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 146         if (!b) {
 147                 b = f.optional_number_child<int> ("ServerPortBase");
 148         }
 149         _server_port_base = b.get ();
 150
 151         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 152         _use_any_servers = u.get_value_or (true);
 153
 154         list<cxml::NodePtr> servers = f.node_children ("Server");
 155         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 156                 if ((*i)->node_children("HostName").size() == 1) {
 157                         _servers.push_back ((*i)->string_child ("HostName"));
 158                 } else {
 159                         _servers.push_back ((*i)->content ());
 160                 }
 161         }
 162
 163         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 164         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 165         _tms_ip = f.string_child ("TMSIP");
 166         _tms_path = f.string_child ("TMSPath");
 167         _tms_user = f.string_child ("TMSUser");
 168         _tms_password = f.string_child ("TMSPassword");
 169
 170         c = f.optional_string_child ("SoundProcessor");
 171         if (c) {
 172                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 173         }
 174         c = f.optional_string_child ("CinemaSoundProcessor");
 175         if (c) {
 176                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 177         }
 178
 179         _language = f.optional_string_child ("Language");
 180
 181         c = f.optional_string_child ("DefaultContainer");
 182         if (c) {
 183                 _default_container = Ratio::from_id (c.get ());
 184         }
 185
 186         c = f.optional_string_child ("DefaultDCPContentType");
 187         if (c) {
 188                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 189         }
 190
 191         if (f.optional_string_child ("DCPMetadataIssuer")) {
 192                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 193         } else if (f.optional_string_child ("DCPIssuer")) {
 194                 _dcp_issuer = f.string_child ("DCPIssuer");
 195         }
 196
 197         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 198
 199         if (version && version.get() >= 2) {
 200                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 201         } else {
 202                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 203         }
 204
 205         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 206         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 207         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 208
 209         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 210         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 211                 /* Slightly grotty two-part construction of Cinema here so that we can use
 212                    shared_from_this.
 213                 */
 214                 shared_ptr<Cinema> cinema (new Cinema (*i));
 215                 cinema->read_screens (*i);
 216                 _cinemas.push_back (cinema);
 217         }
 218
 219         _mail_server = f.string_child ("MailServer");
 220         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 221         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 222         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 223         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 224         _kdm_from = f.string_child ("KDMFrom");
 225         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 226         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 227         _kdm_email = f.string_child ("KDMEmail");
 228
 229         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 230         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 231
 232         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 233         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 234
 235         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 236         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 237 #ifdef DCPOMATIC_WINDOWS
 238         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 239 #endif
 240
 241         list<cxml::NodePtr> his = f.node_children ("History");
 242         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 243                 _history.push_back ((*i)->content ());
 244         }
 245
 246         cxml::NodePtr signer = f.optional_node_child ("Signer");
 247         if (signer) {
 248                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 249                 /* Read the signing certificates and private key in from the config file */
 250                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 251                         c->add (dcp::Certificate (i->content ()));
 252                 }
 253                 c->set_key (signer->string_child ("PrivateKey"));
 254                 _signer_chain = c;
 255         } else {
 256                 /* Make a new set of signing certificates and key */
 257                 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
 258         }
 259
 260         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 261         if (decryption) {
 262                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 263                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 264                         c->add (dcp::Certificate (i->content ()));
 265                 }
 266                 c->set_key (decryption->string_child ("PrivateKey"));
 267                 _decryption_chain = c;
 268         } else {
 269                 _decryption_chain.reset (new dcp::CertificateChain (openssl_path ()));
 270         }
 271 }
 272
 273 /** @return Filename to write configuration to */
 274 boost::filesystem::path
 275 Config::file (bool create_directories)
 276 {
 277         boost::filesystem::path p;
 278 #ifdef DCPOMATIC_OSX
 279         p /= g_get_home_dir ();
 280         p /= "Library";
 281         p /= "Preferences";
 282         p /= "com.dcpomatic";
 283         p /= "2";
 284 #else
 285         p /= g_get_user_config_dir ();
 286         p /= "dcpomatic2";
 287 #endif
 288         boost::system::error_code ec;
 289         if (create_directories) {
 290                 boost::filesystem::create_directories (p, ec);
 291         }
 292         p /= "config.xml";
 293         return p;
 294 }
 295
 296 /** @return Singleton instance */
 297 Config *
 298 Config::instance ()
 299 {
 300         if (_instance == 0) {
 301                 _instance = new Config;
 302                 try {
 303                         _instance->read ();
 304                 } catch (exception& e) {
 305                         /* configuration load failed; never mind, just
 306                            stick with the default.
 307                         */
 308                         cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
 309                 } catch (...) {
 310                         cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
 311                 }
 312         }
 313
 314         return _instance;
 315 }
 316
 317 /** Write our configuration to disk */
 318 void
 319 Config::write () const
 320 {
 321         xmlpp::Document doc;
 322         xmlpp::Element* root = doc.create_root_node ("Config");
 323
 324         root->add_child("Version")->add_child_text ("2");
 325         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 326         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 327         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 328         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 329
 330         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 331                 root->add_child("Server")->add_child_text (*i);
 332         }
 333
 334         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 335         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
 336         root->add_child("TMSIP")->add_child_text (_tms_ip);
 337         root->add_child("TMSPath")->add_child_text (_tms_path);
 338         root->add_child("TMSUser")->add_child_text (_tms_user);
 339         root->add_child("TMSPassword")->add_child_text (_tms_password);
 340         if (_cinema_sound_processor) {
 341                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 342         }
 343         if (_language) {
 344                 root->add_child("Language")->add_child_text (_language.get());
 345         }
 346         if (_default_container) {
 347                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 348         }
 349         if (_default_dcp_content_type) {
 350                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 351         }
 352         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 353         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 354
 355         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 356
 357         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 358         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 359         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 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("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 367         root->add_child("MailUser")->add_child_text (_mail_user);
 368         root->add_child("MailPassword")->add_child_text (_mail_password);
 369         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 370         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 371         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 372         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 373         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 374
 375         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 376         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 377
 378         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 379         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 380         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 381         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 382 #ifdef DCPOMATIC_WINDOWS
 383         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 384 #endif
 385
 386         xmlpp::Element* signer = root->add_child ("Signer");
 387         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
 388                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 389         }
 390         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 391
 392         xmlpp::Element* decryption = root->add_child ("Decryption");
 393         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
 394                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 395         }
 396         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 397
 398         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 399                 root->add_child("History")->add_child_text (i->string ());
 400         }
 401
 402         try {
 403                 doc.write_to_file_formatted (file().string ());
 404         } catch (xmlpp::exception& e) {
 405                 string s = e.what ();
 406                 trim (s);
 407                 throw FileError (s, file ());
 408         }
 409 }
 410
 411 boost::filesystem::path
 412 Config::default_directory_or (boost::filesystem::path a) const
 413 {
 414         if (_default_directory.empty()) {
 415                 return a;
 416         }
 417
 418         boost::system::error_code ec;
 419         bool const e = boost::filesystem::exists (_default_directory, ec);
 420         if (ec || !e) {
 421                 return a;
 422         }
 423
 424         return _default_directory;
 425 }
 426
 427 void
 428 Config::drop ()
 429 {
 430         delete _instance;
 431         _instance = 0;
 432 }
 433
 434 void
 435 Config::changed (Property what)
 436 {
 437         Changed (what);
 438 }
 439
 440 void
 441 Config::set_kdm_email_to_default ()
 442 {
 443         _kdm_email = _(
 444                 "Dear Projectionist\n\n"
 445                 "Please find attached KDMs for $CPL_NAME.\n\n"
 446                 "Cinema: $CINEMA_NAME\n"
 447                 "Screen(s): $SCREENS\n\n"
 448                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 449                 "Best regards,\nDCP-o-matic"
 450                 );
 451 }
 452
 453 void
 454 Config::reset_kdm_email ()
 455 {
 456         set_kdm_email_to_default ();
 457         changed ();
 458 }
 459
 460 void
 461 Config::add_to_history (boost::filesystem::path p)
 462 {
 463         /* Remove existing instances of this path in the history */
 464         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 465
 466         _history.insert (_history.begin (), p);
 467         if (_history.size() > HISTORY_SIZE) {
 468                 _history.pop_back ();
 469         }
 470
 471         changed ();
 472 }
 473
 474 bool
 475 Config::have_existing ()
 476 {
 477         return boost::filesystem::exists (file (false));
 478 }