src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2014 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 <cstdlib>
  21 #include <fstream>
  22 #include <glib.h>
  23 #include <boost/filesystem.hpp>
  24 #include <boost/algorithm/string.hpp>
  25 #include <dcp/colour_matrix.h>
  26 #include <dcp/raw_convert.h>
  27 #include <dcp/signer.h>
  28 #include <dcp/certificate_chain.h>
  29 #include <libcxml/cxml.h>
  30 #include "config.h"
  31 #include "server.h"
  32 #include "scaler.h"
  33 #include "filter.h"
  34 #include "ratio.h"
  35 #include "dcp_content_type.h"
  36 #include "cinema_sound_processor.h"
  37 #include "colour_conversion.h"
  38 #include "cinema.h"
  39 #include "util.h"
  40 #include "cross.h"
  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::is_any_of;
  56 using boost::algorithm::split;
  57 using dcp::raw_convert;
  58
  59 Config* Config::_instance = 0;
  60
  61 /** Construct default configuration */
  62 Config::Config ()
  63         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  64         , _server_port_base (6192)
  65         , _use_any_servers (true)
  66         , _tms_path (".")
  67         , _cinema_sound_processor (CinemaSoundProcessor::from_id (N_("dolby_cp750")))
  68         , _allow_any_dcp_frame_rate (false)
  69         , _default_still_length (10)
  70         , _default_scale (VideoContentScale (Ratio::from_id ("185")))
  71         , _default_container (Ratio::from_id ("185"))
  72         , _default_dcp_content_type (DCPContentType::from_isdcf_name ("TST"))
  73         , _default_j2k_bandwidth (100000000)
  74         , _default_audio_delay (0)
  75         , _check_for_updates (false)
  76         , _check_for_test_updates (false)
  77         , _maximum_j2k_bandwidth (250000000)
  78         , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
  79 {
  80         _allowed_dcp_frame_rates.push_back (24);
  81         _allowed_dcp_frame_rates.push_back (25);
  82         _allowed_dcp_frame_rates.push_back (30);
  83         _allowed_dcp_frame_rates.push_back (48);
  84         _allowed_dcp_frame_rates.push_back (50);
  85         _allowed_dcp_frame_rates.push_back (60);
  86
  87         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6));
  88         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, dcp::colour_matrix::srgb_to_xyz, 2.6));
  89         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
  90
  91         reset_kdm_email ();
  92 }
  93
  94 void
  95 Config::read ()
  96 {
  97         if (!boost::filesystem::exists (file ())) {
  98                 /* Make a new set of signing certificates and key */
  99                 _signer.reset (new dcp::Signer (openssl_path ()));
 100                 /* And decryption keys */
 101                 make_decryption_keys ();
 102                 return;
 103         }
 104
 105         cxml::Document f ("Config");
 106         f.read_file (file ());
 107         optional<string> c;
 108
 109         optional<int> version = f.optional_number_child<int> ("Version");
 110
 111         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 112         _default_directory = f.string_child ("DefaultDirectory");
 113
 114         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 115         if (!b) {
 116                 b = f.optional_number_child<int> ("ServerPortBase");
 117         }
 118         _server_port_base = b.get ();
 119
 120         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 121         _use_any_servers = u.get_value_or (true);
 122
 123         list<cxml::NodePtr> servers = f.node_children ("Server");
 124         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 125                 if ((*i)->node_children("HostName").size() == 1) {
 126                         _servers.push_back ((*i)->string_child ("HostName"));
 127                 } else {
 128                         _servers.push_back ((*i)->content ());
 129                 }
 130         }
 131
 132         _tms_ip = f.string_child ("TMSIP");
 133         _tms_path = f.string_child ("TMSPath");
 134         _tms_user = f.string_child ("TMSUser");
 135         _tms_password = f.string_child ("TMSPassword");
 136
 137         c = f.optional_string_child ("SoundProcessor");
 138         if (c) {
 139                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 140         }
 141         c = f.optional_string_child ("CinemaSoundProcessor");
 142         if (c) {
 143                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 144         }
 145
 146         _language = f.optional_string_child ("Language");
 147
 148         c = f.optional_string_child ("DefaultScale");
 149         if (c) {
 150                 _default_scale = VideoContentScale::from_id (c.get ());
 151         }
 152
 153         c = f.optional_string_child ("DefaultContainer");
 154         if (c) {
 155                 _default_container = Ratio::from_id (c.get ());
 156         }
 157
 158         c = f.optional_string_child ("DefaultDCPContentType");
 159         if (c) {
 160                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 161         }
 162
 163         if (f.optional_string_child ("DCPMetadataIssuer")) {
 164                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 165         } else if (f.optional_string_child ("DCPIssuer")) {
 166                 _dcp_issuer = f.string_child ("DCPIssuer");
 167         }
 168
 169         if (version && version.get() >= 2) {
 170                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 171         } else {
 172                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 173         }
 174
 175         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 176         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 177         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 178
 179         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 180
 181         if (!cc.empty ()) {
 182                 _colour_conversions.clear ();
 183         }
 184
 185         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 186                 _colour_conversions.push_back (PresetColourConversion (*i));
 187         }
 188
 189         if (!version) {
 190                 /* Loading version 0 (before Rec. 709 was added as a preset).
 191                    Add it in.
 192                 */
 193                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
 194         }
 195
 196         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 197         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 198                 /* Slightly grotty two-part construction of Cinema here so that we can use
 199                    shared_from_this.
 200                 */
 201                 shared_ptr<Cinema> cinema (new Cinema (*i));
 202                 cinema->read_screens (*i);
 203                 _cinemas.push_back (cinema);
 204         }
 205
 206         _mail_server = f.string_child ("MailServer");
 207         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 208         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 209         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 210         _kdm_from = f.string_child ("KDMFrom");
 211         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 212         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 213         _kdm_email = f.string_child ("KDMEmail");
 214
 215         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 216         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 217
 218         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 219         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 220
 221         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 222
 223         list<cxml::NodePtr> his = f.node_children ("History");
 224         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 225                 _history.push_back ((*i)->content ());
 226         }
 227
 228         cxml::NodePtr signer = f.optional_node_child ("Signer");
 229         dcp::CertificateChain signer_chain;
 230         if (signer) {
 231                 /* Read the signing certificates and private key in from the config file */
 232                 list<cxml::NodePtr> certificates = signer->node_children ("Certificate");
 233                 for (list<cxml::NodePtr>::const_iterator i = certificates.begin(); i != certificates.end(); ++i) {
 234                         signer_chain.add (dcp::Certificate ((*i)->content ()));
 235                 }
 236
 237                 _signer.reset (new dcp::Signer (signer_chain, signer->string_child ("PrivateKey")));
 238         } else {
 239                 /* Make a new set of signing certificates and key */
 240                 _signer.reset (new dcp::Signer (openssl_path ()));
 241         }
 242
 243         if (f.optional_string_child ("DecryptionCertificate")) {
 244                 _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate"));
 245         }
 246
 247         if (f.optional_string_child ("DecryptionPrivateKey")) {
 248                 _decryption_private_key = f.string_child ("DecryptionPrivateKey");
 249         }
 250
 251         if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) {
 252                 /* Generate our own decryption certificate and key if either is not present in config */
 253                 make_decryption_keys ();
 254         }
 255 }
 256
 257 void
 258 Config::make_decryption_keys ()
 259 {
 260         boost::filesystem::path p = dcp::make_certificate_chain (openssl_path ());
 261         _decryption_certificate = dcp::Certificate (dcp::file_to_string (p / "leaf.signed.pem"));
 262         _decryption_private_key = dcp::file_to_string (p / "leaf.key");
 263         boost::filesystem::remove_all (p);
 264 }
 265
 266 /** @return Filename to write configuration to */
 267 boost::filesystem::path
 268 Config::file () const
 269 {
 270         boost::filesystem::path p;
 271         p /= g_get_user_config_dir ();
 272         boost::system::error_code ec;
 273         boost::filesystem::create_directory (p, ec);
 274         p /= "dcpomatic2";
 275         boost::filesystem::create_directory (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         root->add_child("DefaultScale")->add_child_text (_default_scale.id ());
 329         if (_default_container) {
 330                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 331         }
 332         if (_default_dcp_content_type) {
 333                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 334         }
 335         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 336
 337         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 338
 339         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 340         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 341         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 342
 343         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 344                 i->as_xml (root->add_child ("ColourConversion"));
 345         }
 346
 347         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 348                 (*i)->as_xml (root->add_child ("Cinema"));
 349         }
 350
 351         root->add_child("MailServer")->add_child_text (_mail_server);
 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
 367         xmlpp::Element* signer = root->add_child ("Signer");
 368         dcp::CertificateChain::List certs = _signer->certificates().root_to_leaf ();
 369         for (dcp::CertificateChain::List::const_iterator i = certs.begin(); i != certs.end(); ++i) {
 370                 signer->add_child("Certificate")->add_child_text (i->certificate (true));
 371         }
 372         signer->add_child("PrivateKey")->add_child_text (_signer->key ());
 373
 374         root->add_child("DecryptionCertificate")->add_child_text (_decryption_certificate.certificate (true));
 375         root->add_child("DecryptionPrivateKey")->add_child_text (_decryption_private_key);
 376
 377         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 378                 root->add_child("History")->add_child_text (i->string ());
 379         }
 380
 381         doc.write_to_file_formatted (file().string ());
 382 }
 383
 384 boost::filesystem::path
 385 Config::default_directory_or (boost::filesystem::path a) const
 386 {
 387         if (_default_directory.empty()) {
 388                 return a;
 389         }
 390
 391         boost::system::error_code ec;
 392         bool const e = boost::filesystem::exists (_default_directory, ec);
 393         if (ec || !e) {
 394                 return a;
 395         }
 396
 397         return _default_directory;
 398 }
 399
 400 void
 401 Config::drop ()
 402 {
 403         delete _instance;
 404         _instance = 0;
 405 }
 406
 407 void
 408 Config::changed ()
 409 {
 410         write ();
 411         Changed ();
 412 }
 413
 414 void
 415 Config::reset_kdm_email ()
 416 {
 417         _kdm_email = _(
 418                 "Dear Projectionist\n\n"
 419                 "Please find attached KDMs for $CPL_NAME.\n\n"
 420                 "Cinema: $CINEMA_NAME\n"
 421                 "Screen(s): $SCREENS\n\n"
 422                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 423                 "Best regards,\nDCP-o-matic"
 424                 );
 425 }
 426
 427 void
 428 Config::add_to_history (boost::filesystem::path p)
 429 {
 430         /* Remove existing instances of this path in the history */
 431         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 432
 433         _history.insert (_history.begin (), p);
 434         if (_history.size() > HISTORY_SIZE) {
 435                 _history.pop_back ();
 436         }
 437
 438         changed ();
 439 }