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