src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "config.h"
  22 #include "filter.h"
  23 #include "ratio.h"
  24 #include "types.h"
  25 #include "log.h"
  26 #include "dcp_content_type.h"
  27 #include "cinema_sound_processor.h"
  28 #include "colour_conversion.h"
  29 #include "cinema.h"
  30 #include "util.h"
  31 #include "cross.h"
  32 #include "film.h"
  33 #include "dkdm_wrapper.h"
  34 #include "compose.hpp"
  35 #include <dcp/raw_convert.h>
  36 #include <dcp/name_format.h>
  37 #include <dcp/certificate_chain.h>
  38 #include <libcxml/cxml.h>
  39 #include <glib.h>
  40 #include <libxml++/libxml++.h>
  41 #include <boost/filesystem.hpp>
  42 #include <boost/algorithm/string.hpp>
  43 #include <boost/foreach.hpp>
  44 #include <boost/thread.hpp>
  45 #include <cstdlib>
  46 #include <fstream>
  47 #include <iostream>
  48
  49 #include "i18n.h"
  50
  51 using std::vector;
  52 using std::cout;
  53 using std::ifstream;
  54 using std::string;
  55 using std::list;
  56 using std::max;
  57 using std::remove;
  58 using std::exception;
  59 using std::cerr;
  60 using boost::shared_ptr;
  61 using boost::optional;
  62 using boost::dynamic_pointer_cast;
  63 using boost::algorithm::trim;
  64 using dcp::raw_convert;
  65
  66 Config* Config::_instance = 0;
  67 int const Config::_current_version = 3;
  68 boost::signals2::signal<void ()> Config::FailedToLoad;
  69 boost::signals2::signal<void (string)> Config::Warning;
  70 boost::optional<boost::filesystem::path> Config::test_path;
  71
  72 /** Construct default configuration */
  73 Config::Config ()
  74         /* DKDMs are not considered a thing to reset on set_defaults() */
  75         : _dkdms (new DKDMGroup ("root"))
  76 {
  77         set_defaults ();
  78 }
  79
  80 void
  81 Config::set_defaults ()
  82 {
  83         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  84         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  85         _server_port_base = 6192;
  86         _use_any_servers = true;
  87         _servers.clear ();
  88         _only_servers_encode = false;
  89         _tms_protocol = PROTOCOL_SCP;
  90         _tms_ip = "";
  91         _tms_path = ".";
  92         _tms_user = "";
  93         _tms_password = "";
  94         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
  95         _allow_any_dcp_frame_rate = false;
  96         _language = optional<string> ();
  97         _default_still_length = 10;
  98         _default_container = Ratio::from_id ("185");
  99         _default_scale_to = 0;
 100         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
 101         _default_dcp_audio_channels = 6;
 102         _default_j2k_bandwidth = 100000000;
 103         _default_audio_delay = 0;
 104         _default_interop = true;
 105         _default_upload_after_make_dcp = false;
 106         _mail_server = "";
 107         _mail_port = 25;
 108         _mail_user = "";
 109         _mail_password = "";
 110         _kdm_from = "";
 111         _kdm_cc.clear ();
 112         _kdm_bcc = "";
 113         _check_for_updates = false;
 114         _check_for_test_updates = false;
 115         _maximum_j2k_bandwidth = 250000000;
 116         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 117         _analyse_ebur128 = true;
 118         _automatic_audio_analysis = false;
 119 #ifdef DCPOMATIC_WINDOWS
 120         _win32_console = false;
 121 #endif
 122         _cinemas_file = path ("cinemas.xml");
 123         _show_hints_before_make_dcp = true;
 124         _confirm_kdm_email = true;
 125         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
 126         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
 127         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
 128         _dcp_asset_filename_format = dcp::NameFormat ("%t");
 129         _jump_to_selected = true;
 130         for (int i = 0; i < NAG_COUNT; ++i) {
 131                 _nagged[i] = false;
 132         }
 133         _sound = true;
 134         _sound_output = optional<string> ();
 135         _last_kdm_write_type = KDM_WRITE_FLAT;
 136         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 137
 138         /* I think the scaling factor here should be the ratio of the longest frame
 139            encode time to the shortest; if the thread count is T, longest time is L
 140            and the shortest time S we could encode L/S frames per thread whilst waiting
 141            for the L frame to encode so we might have to store LT/S frames.
 142
 143            However we don't want to use too much memory, so keep it a bit lower than we'd
 144            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
 145            use about 240Mb with 72 encoding threads.
 146         */
 147         _frames_in_memory_multiplier = 3;
 148         _decode_reduction = optional<int>();
 149
 150         _allowed_dcp_frame_rates.clear ();
 151         _allowed_dcp_frame_rates.push_back (24);
 152         _allowed_dcp_frame_rates.push_back (25);
 153         _allowed_dcp_frame_rates.push_back (30);
 154         _allowed_dcp_frame_rates.push_back (48);
 155         _allowed_dcp_frame_rates.push_back (50);
 156         _allowed_dcp_frame_rates.push_back (60);
 157
 158         set_kdm_email_to_default ();
 159         set_cover_sheet_to_default ();
 160 }
 161
 162 void
 163 Config::restore_defaults ()
 164 {
 165         Config::instance()->set_defaults ();
 166         Config::instance()->changed ();
 167 }
 168
 169 shared_ptr<dcp::CertificateChain>
 170 Config::create_certificate_chain ()
 171 {
 172         return shared_ptr<dcp::CertificateChain> (
 173                 new dcp::CertificateChain (
 174                         openssl_path(),
 175                         "dcpomatic.com",
 176                         "dcpomatic.com",
 177                         ".dcpomatic.smpte-430-2.ROOT",
 178                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 179                         "CS.dcpomatic.smpte-430-2.LEAF"
 180                         )
 181                 );
 182 }
 183
 184 void
 185 Config::backup ()
 186 {
 187         /* Make a copy of the configuration */
 188         try {
 189                 int n = 1;
 190                 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
 191                         ++n;
 192                 }
 193
 194                 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
 195                 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
 196         } catch (...) {}
 197 }
 198
 199 void
 200 Config::read ()
 201 try
 202 {
 203         cxml::Document f ("Config");
 204         f.read_file (config_file ());
 205
 206         optional<int> version = f.optional_number_child<int> ("Version");
 207         if (version && *version < _current_version) {
 208                 /* Back up the old config before we re-write it in a back-incompatible way */
 209                 backup ();
 210         }
 211
 212         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 213                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 214         } else {
 215                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 216                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 217         }
 218
 219         _default_directory = f.optional_string_child ("DefaultDirectory");
 220         if (_default_directory && _default_directory->empty ()) {
 221                 /* We used to store an empty value for this to mean "none set" */
 222                 _default_directory = boost::optional<boost::filesystem::path> ();
 223         }
 224
 225         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 226         if (!b) {
 227                 b = f.optional_number_child<int> ("ServerPortBase");
 228         }
 229         _server_port_base = b.get ();
 230
 231         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 232         _use_any_servers = u.get_value_or (true);
 233
 234         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
 235                 if (i->node_children("HostName").size() == 1) {
 236                         _servers.push_back (i->string_child ("HostName"));
 237                 } else {
 238                         _servers.push_back (i->content ());
 239                 }
 240         }
 241
 242         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 243         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 244         _tms_ip = f.string_child ("TMSIP");
 245         _tms_path = f.string_child ("TMSPath");
 246         _tms_user = f.string_child ("TMSUser");
 247         _tms_password = f.string_child ("TMSPassword");
 248
 249         optional<string> c;
 250         c = f.optional_string_child ("SoundProcessor");
 251         if (c) {
 252                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 253         }
 254         c = f.optional_string_child ("CinemaSoundProcessor");
 255         if (c) {
 256                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 257         }
 258
 259         _language = f.optional_string_child ("Language");
 260
 261         c = f.optional_string_child ("DefaultContainer");
 262         if (c) {
 263                 _default_container = Ratio::from_id (c.get ());
 264         }
 265
 266         if (_default_container && !_default_container->used_for_container()) {
 267                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 268                 _default_container = Ratio::from_id ("185");
 269         }
 270
 271         c = f.optional_string_child ("DefaultScaleTo");
 272         if (c) {
 273                 _default_scale_to = Ratio::from_id (c.get ());
 274         }
 275
 276         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 277         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 278
 279         if (f.optional_string_child ("DCPMetadataIssuer")) {
 280                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 281         } else if (f.optional_string_child ("DCPIssuer")) {
 282                 _dcp_issuer = f.string_child ("DCPIssuer");
 283         }
 284
 285         _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
 286         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 287
 288         if (version && version.get() >= 2) {
 289                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 290         } else {
 291                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 292         }
 293
 294         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 295         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 296         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 297         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 298         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 299
 300         /* Load any cinemas from config.xml */
 301         read_cinemas (f);
 302
 303         _mail_server = f.string_child ("MailServer");
 304         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 305         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 306         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 307         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 308         _kdm_from = f.string_child ("KDMFrom");
 309         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 310                 if (!i->content().empty()) {
 311                         _kdm_cc.push_back (i->content ());
 312                 }
 313         }
 314         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 315         _kdm_email = f.string_child ("KDMEmail");
 316
 317         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 318         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 319
 320         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 321         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 322
 323         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 324         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 325         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 326 #ifdef DCPOMATIC_WINDOWS
 327         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 328 #endif
 329
 330         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
 331                 _history.push_back (i->content ());
 332         }
 333
 334         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
 335                 _player_history.push_back (i->content ());
 336         }
 337
 338         cxml::NodePtr signer = f.optional_node_child ("Signer");
 339         if (signer) {
 340                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 341                 /* Read the signing certificates and private key in from the config file */
 342                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 343                         c->add (dcp::Certificate (i->content ()));
 344                 }
 345                 c->set_key (signer->string_child ("PrivateKey"));
 346                 _signer_chain = c;
 347         } else {
 348                 /* Make a new set of signing certificates and key */
 349                 _signer_chain = create_certificate_chain ();
 350         }
 351
 352         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 353         if (decryption) {
 354                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 355                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 356                         c->add (dcp::Certificate (i->content ()));
 357                 }
 358                 c->set_key (decryption->string_child ("PrivateKey"));
 359                 _decryption_chain = c;
 360         } else {
 361                 _decryption_chain = create_certificate_chain ();
 362         }
 363
 364         if (f.optional_node_child("DKDMGroup")) {
 365                 /* New-style: all DKDMs in a group */
 366                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 367         } else {
 368                 /* Old-style: one or more DKDM nodes */
 369                 _dkdms.reset (new DKDMGroup ("root"));
 370                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
 371                         _dkdms->add (DKDMBase::read (i));
 372                 }
 373         }
 374         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 375         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 376         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 377         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 378         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 379         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 380         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 381         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 382         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 383                 int const id = i->number_attribute<int>("Id");
 384                 if (id >= 0 && id < NAG_COUNT) {
 385                         _nagged[id] = raw_convert<int>(i->content());
 386                 }
 387         }
 388         /* The variable was renamed but not the XML tag */
 389         _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
 390         _sound_output = f.optional_string_child("PreviewSoundOutput");
 391         if (f.optional_string_child("CoverSheet")) {
 392                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 393         }
 394         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
 395         if (f.optional_string_child("LastKDMWriteType")) {
 396                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
 397                         _last_kdm_write_type = KDM_WRITE_FLAT;
 398                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
 399                         _last_kdm_write_type = KDM_WRITE_FOLDER;
 400                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
 401                         _last_kdm_write_type = KDM_WRITE_ZIP;
 402                 }
 403         }
 404         if (f.optional_string_child("LastDKDMWriteType")) {
 405                 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
 406                         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 407                 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
 408                         _last_dkdm_write_type = DKDM_WRITE_FILE;
 409                 }
 410         }
 411         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
 412         _decode_reduction = f.optional_number_child<int>("DecodeReduction");
 413
 414         /* Replace any cinemas from config.xml with those from the configured file */
 415         if (boost::filesystem::exists (_cinemas_file)) {
 416                 cxml::Document f ("Cinemas");
 417                 f.read_file (_cinemas_file);
 418                 read_cinemas (f);
 419         }
 420 }
 421 catch (...) {
 422         if (have_existing ("config.xml")) {
 423                 backup ();
 424                 /* We have a config file but it didn't load */
 425                 FailedToLoad ();
 426         }
 427         set_defaults ();
 428         /* Make a new set of signing certificates and key */
 429         _signer_chain = create_certificate_chain ();
 430         /* And similar for decryption of KDMs */
 431         _decryption_chain = create_certificate_chain ();
 432         write ();
 433 }
 434
 435 /** @return Filename to write configuration to */
 436 boost::filesystem::path
 437 Config::path (string file, bool create_directories)
 438 {
 439         boost::filesystem::path p;
 440         if (test_path) {
 441                 p = test_path.get();
 442         } else {
 443 #ifdef DCPOMATIC_OSX
 444                 p /= g_get_home_dir ();
 445                 p /= "Library";
 446                 p /= "Preferences";
 447                 p /= "com.dcpomatic";
 448                 p /= "2";
 449 #else
 450                 p /= g_get_user_config_dir ();
 451                 p /= "dcpomatic2";
 452 #endif
 453         }
 454         boost::system::error_code ec;
 455         if (create_directories) {
 456                 boost::filesystem::create_directories (p, ec);
 457         }
 458         p /= file;
 459         return p;
 460 }
 461
 462 /** @return Singleton instance */
 463 Config *
 464 Config::instance ()
 465 {
 466         if (_instance == 0) {
 467                 _instance = new Config;
 468                 _instance->read ();
 469         }
 470
 471         return _instance;
 472 }
 473
 474 /** Write our configuration to disk */
 475 void
 476 Config::write () const
 477 {
 478         write_config ();
 479         write_cinemas ();
 480 }
 481
 482 void
 483 Config::write_config () const
 484 {
 485         xmlpp::Document doc;
 486         xmlpp::Element* root = doc.create_root_node ("Config");
 487
 488         /* [XML] Version The version number of the configuration file format */
 489         root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
 490         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 491         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 492         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 493         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 494         if (_default_directory) {
 495                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 496                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 497         }
 498         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 499            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 500            by the batch converter to listen for job requests.
 501         */
 502         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 503         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 504         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 505
 506         BOOST_FOREACH (string i, _servers) {
 507                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 508                    as you like.
 509                 */
 510                 root->add_child("Server")->add_child_text (i);
 511         }
 512
 513         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 514            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 515         */
 516         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 517         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 518         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 519         /* [XML] TMSIP IP address of TMS */
 520         root->add_child("TMSIP")->add_child_text (_tms_ip);
 521         /* [XML] TMSPath Path on the TMS to copy files to */
 522         root->add_child("TMSPath")->add_child_text (_tms_path);
 523         /* [XML] TMSUser Username to log into the TMS with */
 524         root->add_child("TMSUser")->add_child_text (_tms_user);
 525         /* [XML] TMSPassword Password to log into the TMS with */
 526         root->add_child("TMSPassword")->add_child_text (_tms_password);
 527         if (_cinema_sound_processor) {
 528                 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
 529                    gain changes from fader positions.  Currently can only be <code>dolby_cp750</code>.
 530                 */
 531                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 532         }
 533         if (_language) {
 534                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
 535                 root->add_child("Language")->add_child_text (_language.get());
 536         }
 537         if (_default_container) {
 538                 /* [XML:opt] DefaultContainer ID of default container
 539                  * to use when creating new films (<code>185</code>,<code>239</code> or
 540                  * <code>190</code>).
 541                 */
 542                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 543         }
 544         if (_default_scale_to) {
 545                 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
 546                    (see <code>DefaultContainer</code> for IDs).
 547                 */
 548                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
 549         }
 550         if (_default_dcp_content_type) {
 551                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
 552                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
 553                    <code>PSA</code> or <code>ADV</code>). */
 554                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 555         }
 556         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
 557         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 558         /* [XML] DCPIssuer Issuer text to write into CPL files. */
 559         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 560         /* [XML] DCPIssuer Creator text to write into CPL files. */
 561         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 562         root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
 563
 564         /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
 565            <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
 566            <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
 567            <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
 568            <code>&lt;MasteredLuminance&gt;</code>.
 569         */
 570         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 571
 572         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
 573         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 574         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
 575         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 576         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
 577         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 578         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
 579         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 580         if (_default_kdm_directory) {
 581                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 582                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 583         }
 584         /* [XML] MailServer Hostname of SMTP server to use. */
 585         root->add_child("MailServer")->add_child_text (_mail_server);
 586         /* [XML] MailPort Port number to use on SMTP server. */
 587         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 588         /* [XML] MailUser Username to use on SMTP server. */
 589         root->add_child("MailUser")->add_child_text (_mail_user);
 590         /* [XML] MailPassword Password to use on SMTP server. */
 591         root->add_child("MailPassword")->add_child_text (_mail_password);
 592         /* [XML] KDMSubject Subject to use for KDM emails. */
 593         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 594         /* [XML] KDMFrom From address to use for KDM emails. */
 595         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 596         BOOST_FOREACH (string i, _kdm_cc) {
 597                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
 598                 root->add_child("KDMCC")->add_child_text (i);
 599         }
 600         /* [XML] KDMBCC BCC address to use for KDM emails */
 601         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 602         /* [XML] KDMEmail Text of KDM email */
 603         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 604
 605         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
 606         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 607         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
 608         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 609
 610         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
 611         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 612         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
 613         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 614         /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
 615            to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
 616            to sending email.
 617         */
 618         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 619         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
 620         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 621         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
 622         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 623 #ifdef DCPOMATIC_WINDOWS
 624         /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
 625         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 626 #endif
 627
 628         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
 629            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
 630         */
 631         xmlpp::Element* signer = root->add_child ("Signer");
 632         DCPOMATIC_ASSERT (_signer_chain);
 633         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 634                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 635         }
 636         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 637
 638         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
 639         xmlpp::Element* decryption = root->add_child ("Decryption");
 640         DCPOMATIC_ASSERT (_decryption_chain);
 641         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
 642                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 643         }
 644         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 645
 646         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
 647            of these tags.
 648         */
 649         BOOST_FOREACH (boost::filesystem::path i, _history) {
 650                 root->add_child("History")->add_child_text (i.string ());
 651         }
 652
 653         BOOST_FOREACH (boost::filesystem::path i, _player_history) {
 654                 root->add_child("PlayerHistory")->add_child_text (i.string ());
 655         }
 656
 657         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
 658            or <code>&lt;DKDM&gt;</code> tags.
 659         */
 660         /* [XML] DKDM A DKDM as XML */
 661         _dkdms->as_xml (root);
 662
 663         /* [XML] CinemasFile Filename of cinemas list file */
 664         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 665         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
 666         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 667         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
 668         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 669         /* [XML] KDMFilenameFormat Format for KDM filenames */
 670         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 671         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
 672         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 673         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
 674         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 675         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
 676         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 677         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
 678         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 679         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
 680         for (int i = 0; i < NAG_COUNT; ++i) {
 681                 xmlpp::Element* e = root->add_child ("Nagged");
 682                 e->set_attribute ("Id", raw_convert<string>(i));
 683                 e->add_child_text (_nagged[i] ? "1" : "0");
 684         }
 685         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
 686         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
 687         if (_sound_output) {
 688                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
 689                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
 690         }
 691         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
 692         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 693         if (_last_player_load_directory) {
 694                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
 695         }
 696         if (_last_kdm_write_type) {
 697                 switch (_last_kdm_write_type.get()) {
 698                 case KDM_WRITE_FLAT:
 699                         root->add_child("LastKDMWriteType")->add_child_text("flat");
 700                         break;
 701                 case KDM_WRITE_FOLDER:
 702                         root->add_child("LastKDMWriteType")->add_child_text("folder");
 703                         break;
 704                 case KDM_WRITE_ZIP:
 705                         root->add_child("LastKDMWriteType")->add_child_text("zip");
 706                         break;
 707                 }
 708         }
 709         if (_last_dkdm_write_type) {
 710                 switch (_last_dkdm_write_type.get()) {
 711                 case DKDM_WRITE_INTERNAL:
 712                         root->add_child("LastDKDMWriteType")->add_child_text("internal");
 713                         break;
 714                 case DKDM_WRITE_FILE:
 715                         root->add_child("LastDKDMWriteType")->add_child_text("file");
 716                         break;
 717                 }
 718         }
 719         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
 720            frames to be held in memory at once.
 721         */
 722         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
 723
 724         /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
 725         if (_decode_reduction) {
 726                 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
 727         }
 728
 729         try {
 730                 doc.write_to_file_formatted(config_file().string());
 731         } catch (xmlpp::exception& e) {
 732                 string s = e.what ();
 733                 trim (s);
 734                 throw FileError (s, path("config.xml"));
 735         }
 736 }
 737
 738 void
 739 Config::write_cinemas () const
 740 {
 741         xmlpp::Document doc;
 742         xmlpp::Element* root = doc.create_root_node ("Cinemas");
 743         root->add_child("Version")->add_child_text ("1");
 744
 745         BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
 746                 i->as_xml (root->add_child ("Cinema"));
 747         }
 748
 749         try {
 750                 doc.write_to_file_formatted (_cinemas_file.string ());
 751         } catch (xmlpp::exception& e) {
 752                 string s = e.what ();
 753                 trim (s);
 754                 throw FileError (s, _cinemas_file);
 755         }
 756 }
 757
 758 boost::filesystem::path
 759 Config::default_directory_or (boost::filesystem::path a) const
 760 {
 761         return directory_or (_default_directory, a);
 762 }
 763
 764 boost::filesystem::path
 765 Config::default_kdm_directory_or (boost::filesystem::path a) const
 766 {
 767         return directory_or (_default_kdm_directory, a);
 768 }
 769
 770 boost::filesystem::path
 771 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
 772 {
 773         if (!dir) {
 774                 return a;
 775         }
 776
 777         boost::system::error_code ec;
 778         bool const e = boost::filesystem::exists (*dir, ec);
 779         if (ec || !e) {
 780                 return a;
 781         }
 782
 783         return *dir;
 784 }
 785
 786 void
 787 Config::drop ()
 788 {
 789         delete _instance;
 790         _instance = 0;
 791 }
 792
 793 void
 794 Config::changed (Property what)
 795 {
 796         Changed (what);
 797 }
 798
 799 void
 800 Config::set_kdm_email_to_default ()
 801 {
 802         _kdm_subject = _("KDM delivery: $CPL_NAME");
 803
 804         _kdm_email = _(
 805                 "Dear Projectionist\n\n"
 806                 "Please find attached KDMs for $CPL_NAME.\n\n"
 807                 "Cinema: $CINEMA_NAME\n"
 808                 "Screen(s): $SCREENS\n\n"
 809                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 810                 "Best regards,\nDCP-o-matic"
 811                 );
 812 }
 813
 814 void
 815 Config::reset_kdm_email ()
 816 {
 817         set_kdm_email_to_default ();
 818         changed ();
 819 }
 820
 821 void
 822 Config::set_cover_sheet_to_default ()
 823 {
 824         _cover_sheet = _(
 825                 "$CPL_NAME\n\n"
 826                 "Type: $TYPE\n"
 827                 "Format: $CONTAINER\n"
 828                 "Audio: $AUDIO\n"
 829                 "Audio Language: $AUDIO_LANGUAGE\n"
 830                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
 831                 "Length: $LENGTH\n"
 832                 "Size: $SIZE\n"
 833                 );
 834 }
 835
 836 void
 837 Config::add_to_history (boost::filesystem::path p)
 838 {
 839         add_to_history_internal (_history, p);
 840 }
 841
 842 void
 843 Config::add_to_player_history (boost::filesystem::path p)
 844 {
 845         add_to_history_internal (_player_history, p);
 846 }
 847
 848 void
 849 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
 850 {
 851         /* Remove existing instances of this path in the history */
 852         h.erase (remove (h.begin(), h.end(), p), h.end ());
 853
 854         h.insert (h.begin (), p);
 855         if (h.size() > HISTORY_SIZE) {
 856                 h.pop_back ();
 857         }
 858
 859         changed ();
 860 }
 861
 862 bool
 863 Config::have_existing (string file)
 864 {
 865         return boost::filesystem::exists (path (file, false));
 866 }
 867
 868 void
 869 Config::read_cinemas (cxml::Document const & f)
 870 {
 871         _cinemas.clear ();
 872         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 873         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
 874                 /* Slightly grotty two-part construction of Cinema here so that we can use
 875                    shared_from_this.
 876                 */
 877                 shared_ptr<Cinema> cinema (new Cinema (i));
 878                 cinema->read_screens (i);
 879                 _cinemas.push_back (cinema);
 880         }
 881 }
 882
 883 void
 884 Config::set_cinemas_file (boost::filesystem::path file)
 885 {
 886         _cinemas_file = file;
 887
 888         if (boost::filesystem::exists (_cinemas_file)) {
 889                 /* Existing file; read it in */
 890                 cxml::Document f ("Cinemas");
 891                 f.read_file (_cinemas_file);
 892                 read_cinemas (f);
 893         }
 894
 895         changed (OTHER);
 896 }
 897
 898 void
 899 Config::save_template (shared_ptr<const Film> film, string name) const
 900 {
 901         film->write_template (template_path (name));
 902 }
 903
 904 list<string>
 905 Config::templates () const
 906 {
 907         if (!boost::filesystem::exists (path ("templates"))) {
 908                 return list<string> ();
 909         }
 910
 911         list<string> n;
 912         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
 913                 n.push_back (i->path().filename().string());
 914         }
 915         return n;
 916 }
 917
 918 bool
 919 Config::existing_template (string name) const
 920 {
 921         return boost::filesystem::exists (template_path (name));
 922 }
 923
 924 boost::filesystem::path
 925 Config::template_path (string name) const
 926 {
 927         return path("templates") / tidy_for_filename (name);
 928 }
 929
 930 void
 931 Config::rename_template (string old_name, string new_name) const
 932 {
 933         boost::filesystem::rename (template_path (old_name), template_path (new_name));
 934 }
 935
 936 void
 937 Config::delete_template (string name) const
 938 {
 939         boost::filesystem::remove (template_path (name));
 940 }
 941
 942 /** @return Path to the config.xml containing the actual settings, following a link if required */
 943 boost::filesystem::path
 944 Config::config_file ()
 945 {
 946         cxml::Document f ("Config");
 947         boost::filesystem::path main = path("config.xml", false);
 948         if (!boost::filesystem::exists (main)) {
 949                 /* It doesn't exist, so there can't be any links; just return it */
 950                 return main;
 951         }
 952
 953         /* See if there's a link */
 954         f.read_file (main);
 955         optional<string> link = f.optional_string_child("Link");
 956         if (link) {
 957                 return *link;
 958         }
 959
 960         return main;
 961 }
 962
 963 void
 964 Config::reset_cover_sheet ()
 965 {
 966         set_cover_sheet_to_default ();
 967         changed ();
 968 }
 969
 970 void
 971 Config::link (boost::filesystem::path new_file) const
 972 {
 973         xmlpp::Document doc;
 974         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
 975         try {
 976                 doc.write_to_file_formatted(path("config.xml", true).string());
 977         } catch (xmlpp::exception& e) {
 978                 string s = e.what ();
 979                 trim (s);
 980                 throw FileError (s, path("config.xml"));
 981         }
 982 }
 983
 984 void
 985 Config::copy_and_link (boost::filesystem::path new_file) const
 986 {
 987         write ();
 988         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
 989         link (new_file);
 990 }