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 "config.h"
  21 #include "server.h"
  22 #include "scaler.h"
  23 #include "filter.h"
  24 #include "ratio.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 <dcp/colour_matrix.h>
  32 #include <dcp/raw_convert.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 using dcp::raw_convert;
  57
  58 Config* Config::_instance = 0;
  59
  60 /** Construct default configuration */
  61 Config::Config ()
  62         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  63         , _server_port_base (6192)
  64         , _use_any_servers (true)
  65         , _tms_path (".")
  66         , _cinema_sound_processor (CinemaSoundProcessor::from_id (N_("dolby_cp750")))
  67         , _allow_any_dcp_frame_rate (false)
  68         , _default_still_length (10)
  69         , _default_container (Ratio::from_id ("185"))
  70         , _default_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"))
  71         , _default_j2k_bandwidth (100000000)
  72         , _default_audio_delay (0)
  73         , _check_for_updates (false)
  74         , _check_for_test_updates (false)
  75         , _maximum_j2k_bandwidth (250000000)
  76         , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
  77 #ifdef DCPOMATIC_WINDOWS
  78         , _win32_console (false)
  79 #endif
  80 {
  81         _allowed_dcp_frame_rates.push_back (24);
  82         _allowed_dcp_frame_rates.push_back (25);
  83         _allowed_dcp_frame_rates.push_back (30);
  84         _allowed_dcp_frame_rates.push_back (48);
  85         _allowed_dcp_frame_rates.push_back (50);
  86         _allowed_dcp_frame_rates.push_back (60);
  87
  88         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), dcp::ColourConversion::srgb_to_xyz ()));
  89         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), dcp::ColourConversion::rec709_to_xyz ()));
  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 ("DefaultContainer");
 149         if (c) {
 150                 _default_container = Ratio::from_id (c.get ());
 151         }
 152
 153         c = f.optional_string_child ("DefaultDCPContentType");
 154         if (c) {
 155                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 156         }
 157
 158         if (f.optional_string_child ("DCPMetadataIssuer")) {
 159                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 160         } else if (f.optional_string_child ("DCPIssuer")) {
 161                 _dcp_issuer = f.string_child ("DCPIssuer");
 162         }
 163
 164         if (version && version.get() >= 2) {
 165                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 166         } else {
 167                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 168         }
 169
 170         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 171         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 172         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 173
 174         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 175
 176         if (!cc.empty ()) {
 177                 _colour_conversions.clear ();
 178         }
 179
 180         try {
 181                 for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 182                         _colour_conversions.push_back (PresetColourConversion (*i));
 183                 }
 184         } catch (cxml::Error) {
 185                 /* Probably failed to load an old-style ColourConversion tag; just give up */
 186                 _colour_conversions.push_back (PresetColourConversion (_("sRGB"), dcp::ColourConversion::srgb_to_xyz ()));
 187                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), dcp::ColourConversion::rec709_to_xyz ()));
 188         }
 189
 190         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 191         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 192                 /* Slightly grotty two-part construction of Cinema here so that we can use
 193                    shared_from_this.
 194                 */
 195                 shared_ptr<Cinema> cinema (new Cinema (*i));
 196                 cinema->read_screens (*i);
 197                 _cinemas.push_back (cinema);
 198         }
 199
 200         _mail_server = f.string_child ("MailServer");
 201         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 202         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 203         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 204         _kdm_from = f.string_child ("KDMFrom");
 205         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 206         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 207         _kdm_email = f.string_child ("KDMEmail");
 208
 209         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 210         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 211
 212         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 213         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 214
 215         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 216 #ifdef DCPOMATIC_WINDOWS
 217         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 218 #endif
 219
 220         list<cxml::NodePtr> his = f.node_children ("History");
 221         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 222                 _history.push_back ((*i)->content ());
 223         }
 224
 225         cxml::NodePtr signer = f.optional_node_child ("Signer");
 226         dcp::CertificateChain signer_chain;
 227         if (signer) {
 228                 /* Read the signing certificates and private key in from the config file */
 229                 list<cxml::NodePtr> certificates = signer->node_children ("Certificate");
 230                 for (list<cxml::NodePtr>::const_iterator i = certificates.begin(); i != certificates.end(); ++i) {
 231                         signer_chain.add (dcp::Certificate ((*i)->content ()));
 232                 }
 233
 234                 _signer.reset (new dcp::Signer (signer_chain, signer->string_child ("PrivateKey")));
 235         } else {
 236                 /* Make a new set of signing certificates and key */
 237                 _signer.reset (new dcp::Signer (openssl_path ()));
 238         }
 239
 240         if (f.optional_string_child ("DecryptionCertificate")) {
 241                 _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate"));
 242         }
 243
 244         if (f.optional_string_child ("DecryptionPrivateKey")) {
 245                 _decryption_private_key = f.string_child ("DecryptionPrivateKey");
 246         }
 247
 248         if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) {
 249                 /* Generate our own decryption certificate and key if either is not present in config */
 250                 make_decryption_keys ();
 251         }
 252 }
 253
 254 void
 255 Config::make_decryption_keys ()
 256 {
 257         boost::filesystem::path p = dcp::make_certificate_chain (openssl_path ());
 258         _decryption_certificate = dcp::Certificate (dcp::file_to_string (p / "leaf.signed.pem"));
 259         _decryption_private_key = dcp::file_to_string (p / "leaf.key");
 260         boost::filesystem::remove_all (p);
 261 }
 262
 263 /** @return Filename to write configuration to */
 264 boost::filesystem::path
 265 Config::file () const
 266 {
 267         boost::filesystem::path p;
 268         p /= g_get_user_config_dir ();
 269         boost::system::error_code ec;
 270         boost::filesystem::create_directory (p, ec);
 271         p /= "dcpomatic2";
 272         boost::filesystem::create_directory (p, ec);
 273         p /= "config.xml";
 274         return p;
 275 }
 276
 277 /** @return Singleton instance */
 278 Config *
 279 Config::instance ()
 280 {
 281         if (_instance == 0) {
 282                 _instance = new Config;
 283                 try {
 284                         _instance->read ();
 285                 } catch (exception& e) {
 286                         /* configuration load failed; never mind, just
 287                            stick with the default.
 288                         */
 289                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 290                 } catch (...) {
 291                         cerr << "dcpomatic: failed to load configuration\n";
 292                 }
 293         }
 294
 295         return _instance;
 296 }
 297
 298 /** Write our configuration to disk */
 299 void
 300 Config::write () const
 301 {
 302         xmlpp::Document doc;
 303         xmlpp::Element* root = doc.create_root_node ("Config");
 304
 305         root->add_child("Version")->add_child_text ("2");
 306         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 307         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 308         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 309         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 310
 311         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 312                 root->add_child("Server")->add_child_text (*i);
 313         }
 314
 315         root->add_child("TMSIP")->add_child_text (_tms_ip);
 316         root->add_child("TMSPath")->add_child_text (_tms_path);
 317         root->add_child("TMSUser")->add_child_text (_tms_user);
 318         root->add_child("TMSPassword")->add_child_text (_tms_password);
 319         if (_cinema_sound_processor) {
 320                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 321         }
 322         if (_language) {
 323                 root->add_child("Language")->add_child_text (_language.get());
 324         }
 325         if (_default_container) {
 326                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 327         }
 328         if (_default_dcp_content_type) {
 329                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 330         }
 331         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 332
 333         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 334
 335         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 336         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 337         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 338
 339         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 340                 i->as_xml (root->add_child ("ColourConversion"));
 341         }
 342
 343         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 344                 (*i)->as_xml (root->add_child ("Cinema"));
 345         }
 346
 347         root->add_child("MailServer")->add_child_text (_mail_server);
 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 ()
 414 {
 415         write ();
 416         Changed ();
 417 }
 418
 419 void
 420 Config::reset_kdm_email ()
 421 {
 422         _kdm_email = _(
 423                 "Dear Projectionist\n\n"
 424                 "Please find attached KDMs for $CPL_NAME.\n\n"
 425                 "Cinema: $CINEMA_NAME\n"
 426                 "Screen(s): $SCREENS\n\n"
 427                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 428                 "Best regards,\nDCP-o-matic"
 429                 );
 430 }
 431
 432 void
 433 Config::add_to_history (boost::filesystem::path p)
 434 {
 435         /* Remove existing instances of this path in the history */
 436         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 437
 438         _history.insert (_history.begin (), p);
 439         if (_history.size() > HISTORY_SIZE) {
 440                 _history.pop_back ();
 441         }
 442
 443         changed ();
 444 }