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