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