src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2020 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 "colour_conversion.h"
  28 #include "cinema.h"
  29 #include "util.h"
  30 #include "cross.h"
  31 #include "film.h"
  32 #include "dkdm_wrapper.h"
  33 #include "compose.hpp"
  34 #include "crypto.h"
  35 #include "dkdm_recipient.h"
  36 #include <dcp/raw_convert.h>
  37 #include <dcp/name_format.h>
  38 #include <dcp/certificate_chain.h>
  39 #include <libcxml/cxml.h>
  40 #include <glib.h>
  41 #include <libxml++/libxml++.h>
  42 #include <boost/filesystem.hpp>
  43 #include <boost/algorithm/string.hpp>
  44 #include <boost/foreach.hpp>
  45 #include <boost/thread.hpp>
  46 #include <cstdlib>
  47 #include <fstream>
  48 #include <iostream>
  49
  50 #include "i18n.h"
  51
  52 using std::vector;
  53 using std::cout;
  54 using std::ifstream;
  55 using std::string;
  56 using std::list;
  57 using std::min;
  58 using std::max;
  59 using std::remove;
  60 using std::exception;
  61 using std::cerr;
  62 using boost::shared_ptr;
  63 using boost::optional;
  64 using boost::dynamic_pointer_cast;
  65 using boost::algorithm::trim;
  66 using dcp::raw_convert;
  67
  68 Config* Config::_instance = 0;
  69 int const Config::_current_version = 3;
  70 boost::signals2::signal<void ()> Config::FailedToLoad;
  71 boost::signals2::signal<void (string)> Config::Warning;
  72 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
  73
  74 /** Construct default configuration */
  75 Config::Config ()
  76         /* DKDMs are not considered a thing to reset on set_defaults() */
  77         : _dkdms (new DKDMGroup ("root"))
  78 {
  79         set_defaults ();
  80 }
  81
  82 void
  83 Config::set_defaults ()
  84 {
  85         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  86         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  87         _server_port_base = 6192;
  88         _use_any_servers = true;
  89         _servers.clear ();
  90         _only_servers_encode = false;
  91         _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP;
  92         _tms_ip = "";
  93         _tms_path = ".";
  94         _tms_user = "";
  95         _tms_password = "";
  96         _allow_any_dcp_frame_rate = false;
  97         _allow_any_container = false;
  98         _show_experimental_audio_processors = false;
  99         _language = optional<string> ();
 100         _default_still_length = 10;
 101         _default_container = Ratio::from_id ("185");
 102         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
 103         _default_dcp_audio_channels = 6;
 104         _default_j2k_bandwidth = 150000000;
 105         _default_audio_delay = 0;
 106         _default_interop = true;
 107         _default_upload_after_make_dcp = false;
 108         _mail_server = "";
 109         _mail_port = 25;
 110         _mail_protocol = EMAIL_PROTOCOL_AUTO;
 111         _mail_user = "";
 112         _mail_password = "";
 113         _kdm_from = "";
 114         _kdm_cc.clear ();
 115         _kdm_bcc = "";
 116         _notification_from = "";
 117         _notification_to = "";
 118         _notification_cc.clear ();
 119         _notification_bcc = "";
 120         _check_for_updates = false;
 121         _check_for_test_updates = false;
 122         _maximum_j2k_bandwidth = 250000000;
 123         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 124         _analyse_ebur128 = true;
 125         _automatic_audio_analysis = false;
 126 #ifdef DCPOMATIC_WINDOWS
 127         _win32_console = false;
 128 #endif
 129         _cinemas_file = path ("cinemas.xml");
 130         _dkdm_recipients_file = path ("dkdm_recipients.xml");
 131         _show_hints_before_make_dcp = true;
 132         _confirm_kdm_email = true;
 133         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
 134         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
 135         _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
 136         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
 137         _dcp_asset_filename_format = dcp::NameFormat ("%t");
 138         _jump_to_selected = true;
 139         for (int i = 0; i < NAG_COUNT; ++i) {
 140                 _nagged[i] = false;
 141         }
 142         _sound = true;
 143         _sound_output = optional<string> ();
 144         _last_kdm_write_type = KDM_WRITE_FLAT;
 145         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 146
 147         /* I think the scaling factor here should be the ratio of the longest frame
 148            encode time to the shortest; if the thread count is T, longest time is L
 149            and the shortest time S we could encode L/S frames per thread whilst waiting
 150            for the L frame to encode so we might have to store LT/S frames.
 151
 152            However we don't want to use too much memory, so keep it a bit lower than we'd
 153            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
 154            use about 240Mb with 72 encoding threads.
 155         */
 156         _frames_in_memory_multiplier = 3;
 157         _decode_reduction = optional<int>();
 158         _default_notify = false;
 159         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 160                 _notification[i] = false;
 161         }
 162         _barco_username = optional<string>();
 163         _barco_password = optional<string>();
 164         _christie_username = optional<string>();
 165         _christie_password = optional<string>();
 166         _gdc_username = optional<string>();
 167         _gdc_password = optional<string>();
 168         _interface_complexity = INTERFACE_SIMPLE;
 169         _player_mode = PLAYER_MODE_WINDOW;
 170         _image_display = 0;
 171         _video_view_type = VIDEO_VIEW_SIMPLE;
 172         _respect_kdm_validity_periods = true;
 173         _player_activity_log_file = boost::none;
 174         _player_debug_log_file = boost::none;
 175         _player_content_directory = boost::none;
 176         _player_playlist_directory = boost::none;
 177         _player_kdm_directory = boost::none;
 178         _audio_mapping = boost::none;
 179 #ifdef DCPOMATIC_VARIANT_SWAROOP
 180         _player_background_image = boost::none;
 181         _kdm_server_url = "http://localhost:8000/{CPL}";
 182         _player_watermark_theatre = "";
 183         _player_watermark_period = 1;
 184         _player_watermark_duration = 50;
 185         _player_lock_file = boost::none;
 186         _signer_chain_path = "signer";
 187         _decryption_chain_path = "decryption";
 188 #endif
 189
 190         _allowed_dcp_frame_rates.clear ();
 191         _allowed_dcp_frame_rates.push_back (24);
 192         _allowed_dcp_frame_rates.push_back (25);
 193         _allowed_dcp_frame_rates.push_back (30);
 194         _allowed_dcp_frame_rates.push_back (48);
 195         _allowed_dcp_frame_rates.push_back (50);
 196         _allowed_dcp_frame_rates.push_back (60);
 197
 198         set_kdm_email_to_default ();
 199         set_notification_email_to_default ();
 200         set_cover_sheet_to_default ();
 201 }
 202
 203 void
 204 Config::restore_defaults ()
 205 {
 206         Config::instance()->set_defaults ();
 207         Config::instance()->changed ();
 208 }
 209
 210 shared_ptr<dcp::CertificateChain>
 211 Config::create_certificate_chain ()
 212 {
 213         return shared_ptr<dcp::CertificateChain> (
 214                 new dcp::CertificateChain (
 215                         openssl_path(),
 216                         "dcpomatic.com",
 217                         "dcpomatic.com",
 218                         ".dcpomatic.smpte-430-2.ROOT",
 219                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 220                         "CS.dcpomatic.smpte-430-2.LEAF"
 221                         )
 222                 );
 223 }
 224
 225 void
 226 Config::backup ()
 227 {
 228         /* Make a copy of the configuration */
 229         try {
 230                 int n = 1;
 231                 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
 232                         ++n;
 233                 }
 234
 235                 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
 236                 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
 237                 boost::filesystem::copy_file(path("dkdm_recipients.xml", false), path(String::compose("dkdm_recipients.xml.%1", n), false));
 238         } catch (...) {}
 239 }
 240
 241 void
 242 Config::read ()
 243 try
 244 {
 245 #if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX)
 246         if (geteuid() == 0) {
 247                 /* Take ownership of the config file if we're root */
 248                 chown (config_file().string().c_str(), 0, 0);
 249                 chmod (config_file().string().c_str(), 0644);
 250         }
 251 #endif
 252
 253         cxml::Document f ("Config");
 254         f.read_file (config_file ());
 255
 256         optional<int> version = f.optional_number_child<int> ("Version");
 257         if (version && *version < _current_version) {
 258                 /* Back up the old config before we re-write it in a back-incompatible way */
 259                 backup ();
 260         }
 261
 262         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 263                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 264         } else {
 265                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 266                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 267         }
 268
 269         _default_directory = f.optional_string_child ("DefaultDirectory");
 270         if (_default_directory && _default_directory->empty ()) {
 271                 /* We used to store an empty value for this to mean "none set" */
 272                 _default_directory = boost::optional<boost::filesystem::path> ();
 273         }
 274
 275         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 276         if (!b) {
 277                 b = f.optional_number_child<int> ("ServerPortBase");
 278         }
 279         _server_port_base = b.get ();
 280
 281         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 282         _use_any_servers = u.get_value_or (true);
 283
 284         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
 285                 if (i->node_children("HostName").size() == 1) {
 286                         _servers.push_back (i->string_child ("HostName"));
 287                 } else {
 288                         _servers.push_back (i->content ());
 289                 }
 290         }
 291
 292         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 293         _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
 294         _tms_ip = f.string_child ("TMSIP");
 295         _tms_path = f.string_child ("TMSPath");
 296         _tms_user = f.string_child ("TMSUser");
 297         _tms_password = f.string_child ("TMSPassword");
 298
 299         _language = f.optional_string_child ("Language");
 300
 301         optional<string> c = f.optional_string_child ("DefaultContainer");
 302         if (c) {
 303                 _default_container = Ratio::from_id (c.get ());
 304         }
 305
 306         if (_default_container && !_default_container->used_for_container()) {
 307                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 308                 _default_container = Ratio::from_id ("185");
 309         }
 310
 311         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 312         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 313
 314         if (f.optional_string_child ("DCPMetadataIssuer")) {
 315                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 316         } else if (f.optional_string_child ("DCPIssuer")) {
 317                 _dcp_issuer = f.string_child ("DCPIssuer");
 318         }
 319
 320         _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
 321         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 322
 323         if (version && version.get() >= 2) {
 324                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 325         } else {
 326                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 327         }
 328
 329         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 330         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 331         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 332         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 333         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 334
 335         /* Read any cinemas that are still lying around in the config file
 336          * from an old version.
 337          */
 338         read_cinemas (f);
 339
 340         _mail_server = f.string_child ("MailServer");
 341         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 342
 343         {
 344                 /* Make sure this matches the code in write_config */
 345                 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
 346                 if (protocol == "Auto") {
 347                         _mail_protocol = EMAIL_PROTOCOL_AUTO;
 348                 } else if (protocol == "Plain") {
 349                         _mail_protocol = EMAIL_PROTOCOL_PLAIN;
 350                 } else if (protocol == "STARTTLS") {
 351                         _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
 352                 } else if (protocol == "SSL") {
 353                         _mail_protocol = EMAIL_PROTOCOL_SSL;
 354                 }
 355         }
 356
 357         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 358         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 359
 360         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 361         _kdm_from = f.string_child ("KDMFrom");
 362         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 363                 if (!i->content().empty()) {
 364                         _kdm_cc.push_back (i->content ());
 365                 }
 366         }
 367         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 368         _kdm_email = f.string_child ("KDMEmail");
 369
 370         _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
 371         _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
 372         _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
 373         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
 374                 if (!i->content().empty()) {
 375                         _notification_cc.push_back (i->content ());
 376                 }
 377         }
 378         _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
 379         if (f.optional_string_child("NotificationEmail")) {
 380                 _notification_email = f.string_child("NotificationEmail");
 381         }
 382
 383         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 384         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 385
 386         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 387         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 388         _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 389         _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
 390
 391         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 392         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 393         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 394 #ifdef DCPOMATIC_WINDOWS
 395         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 396 #endif
 397
 398         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
 399                 _history.push_back (i->content ());
 400         }
 401
 402         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
 403                 _player_history.push_back (i->content ());
 404         }
 405
 406         cxml::NodePtr signer = f.optional_node_child ("Signer");
 407 #ifdef DCPOMATIC_VARIANT_SWAROOP
 408         if (signer && signer->node_children().size() == 1) {
 409                 /* The content of <Signer> is a path to a file; if it's relative it's in the same
 410                    directory as .config. */
 411                 _signer_chain_path = signer->content();
 412                 if (_signer_chain_path.is_relative()) {
 413                         _signer_chain = read_swaroop_chain (path(_signer_chain_path.string()));
 414                 } else {
 415                         _signer_chain = read_swaroop_chain (_signer_chain_path);
 416                 }
 417         } else {
 418                 /* <Signer> is not present or has children: ignore it and remake. */
 419                 _signer_chain = create_certificate_chain ();
 420         }
 421 #else
 422         if (signer) {
 423                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 424                 /* Read the signing certificates and private key in from the config file */
 425                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 426                         c->add (dcp::Certificate (i->content ()));
 427                 }
 428                 c->set_key (signer->string_child ("PrivateKey"));
 429                 _signer_chain = c;
 430         } else {
 431                 /* Make a new set of signing certificates and key */
 432                 _signer_chain = create_certificate_chain ();
 433         }
 434 #endif
 435
 436         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 437 #ifdef DCPOMATIC_VARIANT_SWAROOP
 438         if (decryption && decryption->node_children().size() == 1) {
 439                 /* The content of <Decryption> is a path to a file; if it's relative, it's in the same
 440                    directory as .config. */
 441                 _decryption_chain_path = decryption->content();
 442                 if (_decryption_chain_path.is_relative()) {
 443                         _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string()));
 444                 } else {
 445                         _decryption_chain = read_swaroop_chain (_decryption_chain_path);
 446                 }
 447         } else {
 448                 /* <Decryption> is not present or has more children: ignore it and remake. */
 449                 _decryption_chain = create_certificate_chain ();
 450         }
 451 #else
 452         if (decryption) {
 453                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 454                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 455                         c->add (dcp::Certificate (i->content ()));
 456                 }
 457                 c->set_key (decryption->string_child ("PrivateKey"));
 458                 _decryption_chain = c;
 459         } else {
 460                 _decryption_chain = create_certificate_chain ();
 461         }
 462 #endif
 463
 464         /* These must be done before we call Bad as that might set one
 465            of the nags.
 466         */
 467         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 468                 int const id = i->number_attribute<int>("Id");
 469                 if (id >= 0 && id < NAG_COUNT) {
 470                         _nagged[id] = raw_convert<int>(i->content());
 471                 }
 472         }
 473
 474         optional<BadReason> bad;
 475
 476         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 477                 if (i.has_utf8_strings()) {
 478                         bad = BAD_SIGNER_UTF8_STRINGS;
 479                 }
 480         }
 481
 482         if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
 483                 bad = BAD_SIGNER_INCONSISTENT;
 484         }
 485
 486         if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
 487                 bad = BAD_DECRYPTION_INCONSISTENT;
 488         }
 489
 490         if (bad) {
 491                 optional<bool> const remake = Bad(*bad);
 492                 if (remake && *remake) {
 493                         switch (*bad) {
 494                         case BAD_SIGNER_UTF8_STRINGS:
 495                         case BAD_SIGNER_INCONSISTENT:
 496                                 _signer_chain = create_certificate_chain ();
 497                                 break;
 498                         case BAD_DECRYPTION_INCONSISTENT:
 499                                 _decryption_chain = create_certificate_chain ();
 500                                 break;
 501                         }
 502                 }
 503         }
 504
 505         if (f.optional_node_child("DKDMGroup")) {
 506                 /* New-style: all DKDMs in a group */
 507                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 508         } else {
 509                 /* Old-style: one or more DKDM nodes */
 510                 _dkdms.reset (new DKDMGroup ("root"));
 511                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
 512                         _dkdms->add (DKDMBase::read (i));
 513                 }
 514         }
 515         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 516         _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or (path("dkdm_recipients.xml").string());
 517         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 518         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 519         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 520         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 521         _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
 522         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 523         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 524         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 525         /* The variable was renamed but not the XML tag */
 526         _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
 527         _sound_output = f.optional_string_child("PreviewSoundOutput");
 528         if (f.optional_string_child("CoverSheet")) {
 529                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 530         }
 531         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
 532         if (f.optional_string_child("LastKDMWriteType")) {
 533                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
 534                         _last_kdm_write_type = KDM_WRITE_FLAT;
 535                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
 536                         _last_kdm_write_type = KDM_WRITE_FOLDER;
 537                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
 538                         _last_kdm_write_type = KDM_WRITE_ZIP;
 539                 }
 540         }
 541         if (f.optional_string_child("LastDKDMWriteType")) {
 542                 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
 543                         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 544                 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
 545                         _last_dkdm_write_type = DKDM_WRITE_FILE;
 546                 }
 547         }
 548         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
 549         _decode_reduction = f.optional_number_child<int>("DecodeReduction");
 550         _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
 551
 552         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
 553                 int const id = i->number_attribute<int>("Id");
 554                 if (id >= 0 && id < NOTIFICATION_COUNT) {
 555                         _notification[id] = raw_convert<int>(i->content());
 556                 }
 557         }
 558
 559         _barco_username = f.optional_string_child("BarcoUsername");
 560         _barco_password = f.optional_string_child("BarcoPassword");
 561         _christie_username = f.optional_string_child("ChristieUsername");
 562         _christie_password = f.optional_string_child("ChristiePassword");
 563         _gdc_username = f.optional_string_child("GDCUsername");
 564         _gdc_password = f.optional_string_child("GDCPassword");
 565
 566         optional<string> ic = f.optional_string_child("InterfaceComplexity");
 567         if (ic && *ic == "full") {
 568                 _interface_complexity = INTERFACE_FULL;
 569         }
 570         optional<string> pm = f.optional_string_child("PlayerMode");
 571         if (pm && *pm == "window") {
 572                 _player_mode = PLAYER_MODE_WINDOW;
 573         } else if (pm && *pm == "full") {
 574                 _player_mode = PLAYER_MODE_FULL;
 575         } else if (pm && *pm == "dual") {
 576                 _player_mode = PLAYER_MODE_DUAL;
 577         }
 578
 579         _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
 580         optional<string> vc = f.optional_string_child("VideoViewType");
 581         if (vc && *vc == "opengl") {
 582                 _video_view_type = VIDEO_VIEW_OPENGL;
 583         } else if (vc && *vc == "simple") {
 584                 _video_view_type = VIDEO_VIEW_SIMPLE;
 585         }
 586         _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
 587         /* PlayerLogFile is old name */
 588         _player_activity_log_file = f.optional_string_child("PlayerLogFile");
 589         if (!_player_activity_log_file) {
 590                 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
 591         }
 592         _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
 593         _player_content_directory = f.optional_string_child("PlayerContentDirectory");
 594         _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
 595         _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
 596
 597         if (f.optional_node_child("AudioMapping")) {
 598                 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
 599         }
 600
 601 #ifdef DCPOMATIC_VARIANT_SWAROOP
 602         _player_background_image = f.optional_string_child("PlayerBackgroundImage");
 603         _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
 604         _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or("");
 605         _player_watermark_period = f.optional_number_child<int>("PlayerWatermarkPeriod").get_value_or(1);
 606         _player_watermark_duration = f.optional_number_child<int>("PlayerWatermarkDuration").get_value_or(150);
 607         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) {
 608                 _required_monitors.push_back(Monitor(i));
 609         }
 610         _player_lock_file = f.optional_string_child("PlayerLockFile");
 611 #endif
 612
 613         if (boost::filesystem::exists (_cinemas_file)) {
 614                 cxml::Document f ("Cinemas");
 615                 f.read_file (_cinemas_file);
 616                 read_cinemas (f);
 617         }
 618
 619         if (boost::filesystem::exists (_dkdm_recipients_file)) {
 620                 cxml::Document f ("DKDMRecipients");
 621                 f.read_file (_dkdm_recipients_file);
 622                 read_dkdm_recipients (f);
 623         }
 624 }
 625 catch (...) {
 626         if (have_existing ("config.xml")) {
 627                 backup ();
 628                 /* We have a config file but it didn't load */
 629                 FailedToLoad ();
 630         }
 631         set_defaults ();
 632         /* Make a new set of signing certificates and key */
 633         _signer_chain = create_certificate_chain ();
 634         /* And similar for decryption of KDMs */
 635         _decryption_chain = create_certificate_chain ();
 636         write ();
 637 }
 638
 639 /** @return Singleton instance */
 640 Config *
 641 Config::instance ()
 642 {
 643         if (_instance == 0) {
 644                 _instance = new Config;
 645                 _instance->read ();
 646         }
 647
 648         return _instance;
 649 }
 650
 651 /** Write our configuration to disk */
 652 void
 653 Config::write () const
 654 {
 655         write_config ();
 656         write_cinemas ();
 657         write_dkdm_recipients ();
 658 }
 659
 660 void
 661 Config::write_config () const
 662 {
 663         xmlpp::Document doc;
 664         xmlpp::Element* root = doc.create_root_node ("Config");
 665
 666         /* [XML] Version The version number of the configuration file format. */
 667         root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
 668         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 669         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 670         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 671         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 672         if (_default_directory) {
 673                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 674                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 675         }
 676         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 677            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 678            by the batch converter to listen for job requests.
 679         */
 680         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 681         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 682         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 683
 684         BOOST_FOREACH (string i, _servers) {
 685                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 686                    as you like.
 687                 */
 688                 root->add_child("Server")->add_child_text (i);
 689         }
 690
 691         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 692            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 693         */
 694         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 695         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 696         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 697         /* [XML] TMSIP IP address of TMS. */
 698         root->add_child("TMSIP")->add_child_text (_tms_ip);
 699         /* [XML] TMSPath Path on the TMS to copy files to. */
 700         root->add_child("TMSPath")->add_child_text (_tms_path);
 701         /* [XML] TMSUser Username to log into the TMS with. */
 702         root->add_child("TMSUser")->add_child_text (_tms_user);
 703         /* [XML] TMSPassword Password to log into the TMS with. */
 704         root->add_child("TMSPassword")->add_child_text (_tms_password);
 705         if (_language) {
 706                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
 707                 root->add_child("Language")->add_child_text (_language.get());
 708         }
 709         if (_default_container) {
 710                 /* [XML:opt] DefaultContainer ID of default container
 711                    to use when creating new films (<code>185</code>,<code>239</code> or
 712                    <code>190</code>).
 713                 */
 714                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 715         }
 716         if (_default_dcp_content_type) {
 717                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
 718                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
 719                    <code>PSA</code> or <code>ADV</code>). */
 720                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 721         }
 722         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
 723         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 724         /* [XML] DCPIssuer Issuer text to write into CPL files. */
 725         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 726         /* [XML] DCPIssuer Creator text to write into CPL files. */
 727         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 728         /* [XML] DefaultUploadAfterMakeDCP 1 to default to uploading to a TMS after making a DCP, 0 to default to no upload. */
 729         root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
 730
 731         /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
 732            <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
 733            <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
 734            <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
 735            <code>&lt;MasteredLuminance&gt;</code>.
 736         */
 737         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 738
 739         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
 740         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 741         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
 742         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 743         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
 744         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 745         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
 746         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 747         if (_default_kdm_directory) {
 748                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 749                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 750         }
 751         /* [XML] MailServer Hostname of SMTP server to use. */
 752         root->add_child("MailServer")->add_child_text (_mail_server);
 753         /* [XML] MailPort Port number to use on SMTP server. */
 754         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 755         /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
 756         switch (_mail_protocol) {
 757         case EMAIL_PROTOCOL_AUTO:
 758                 root->add_child("MailProtocol")->add_child_text("Auto");
 759                 break;
 760         case EMAIL_PROTOCOL_PLAIN:
 761                 root->add_child("MailProtocol")->add_child_text("Plain");
 762                 break;
 763         case EMAIL_PROTOCOL_STARTTLS:
 764                 root->add_child("MailProtocol")->add_child_text("STARTTLS");
 765                 break;
 766         case EMAIL_PROTOCOL_SSL:
 767                 root->add_child("MailProtocol")->add_child_text("SSL");
 768                 break;
 769         }
 770         /* [XML] MailUser Username to use on SMTP server. */
 771         root->add_child("MailUser")->add_child_text (_mail_user);
 772         /* [XML] MailPassword Password to use on SMTP server. */
 773         root->add_child("MailPassword")->add_child_text (_mail_password);
 774
 775         /* [XML] KDMSubject Subject to use for KDM emails. */
 776         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 777         /* [XML] KDMFrom From address to use for KDM emails. */
 778         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 779         BOOST_FOREACH (string i, _kdm_cc) {
 780                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
 781                 root->add_child("KDMCC")->add_child_text (i);
 782         }
 783         /* [XML] KDMBCC BCC address to use for KDM emails. */
 784         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 785         /* [XML] KDMEmail Text of KDM email. */
 786         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 787
 788         /* [XML] NotificationSubject Subject to use for notification emails. */
 789         root->add_child("NotificationSubject")->add_child_text (_notification_subject);
 790         /* [XML] NotificationFrom From address to use for notification emails. */
 791         root->add_child("NotificationFrom")->add_child_text (_notification_from);
 792         /* [XML] NotificationFrom To address to use for notification emails. */
 793         root->add_child("NotificationTo")->add_child_text (_notification_to);
 794         BOOST_FOREACH (string i, _notification_cc) {
 795                 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
 796                 root->add_child("NotificationCC")->add_child_text (i);
 797         }
 798         /* [XML] NotificationBCC BCC address to use for notification emails. */
 799         root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
 800         /* [XML] NotificationEmail Text of notification email. */
 801         root->add_child("NotificationEmail")->add_child_text (_notification_email);
 802
 803         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
 804         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 805         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
 806         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 807
 808         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
 809         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 810         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
 811         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 812         /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
 813         root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
 814         /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
 815         root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
 816         /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
 817            to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
 818            to sending email.
 819         */
 820         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 821         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
 822         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 823         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
 824         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 825 #ifdef DCPOMATIC_WINDOWS
 826         /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
 827         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 828 #endif
 829
 830 #ifdef DCPOMATIC_VARIANT_SWAROOP
 831         if (_signer_chain_path.is_relative()) {
 832                 write_swaroop_chain (_signer_chain, path(_signer_chain_path.string()));
 833         } else {
 834                 write_swaroop_chain (_signer_chain, _signer_chain_path);
 835         }
 836         root->add_child("Signer")->add_child_text(_signer_chain_path.string());
 837 #else
 838         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
 839            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
 840         */
 841         xmlpp::Element* signer = root->add_child ("Signer");
 842         DCPOMATIC_ASSERT (_signer_chain);
 843         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 844                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 845         }
 846         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 847 #endif
 848
 849 #ifdef DCPOMATIC_VARIANT_SWAROOP
 850         if (_decryption_chain_path.is_relative()) {
 851                 write_swaroop_chain (_decryption_chain, path(_decryption_chain_path.string()));
 852         } else {
 853                 write_swaroop_chain (_decryption_chain, _decryption_chain_path);
 854         }
 855         root->add_child("Decryption")->add_child_text(_decryption_chain_path.string());
 856 #else
 857         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
 858         xmlpp::Element* decryption = root->add_child ("Decryption");
 859         DCPOMATIC_ASSERT (_decryption_chain);
 860         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
 861                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 862         }
 863         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 864 #endif
 865
 866         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
 867            of these tags.
 868         */
 869         BOOST_FOREACH (boost::filesystem::path i, _history) {
 870                 root->add_child("History")->add_child_text (i.string ());
 871         }
 872
 873         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
 874            of these tags.
 875         */
 876         BOOST_FOREACH (boost::filesystem::path i, _player_history) {
 877                 root->add_child("PlayerHistory")->add_child_text (i.string ());
 878         }
 879
 880         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
 881            or <code>&lt;DKDM&gt;</code> tags.
 882         */
 883         /* [XML] DKDM A DKDM as XML */
 884         _dkdms->as_xml (root);
 885
 886         /* [XML] CinemasFile Filename of cinemas list file. */
 887         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 888         /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
 889         root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
 890         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
 891         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 892         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
 893         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 894         /* [XML] KDMFilenameFormat Format for KDM filenames. */
 895         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 896         /* [XML] KDMFilenameFormat Format for DKDM filenames. */
 897         root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
 898         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
 899         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 900         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
 901         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 902         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
 903         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 904         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
 905         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 906         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
 907         for (int i = 0; i < NAG_COUNT; ++i) {
 908                 xmlpp::Element* e = root->add_child ("Nagged");
 909                 e->set_attribute ("Id", raw_convert<string>(i));
 910                 e->add_child_text (_nagged[i] ? "1" : "0");
 911         }
 912         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
 913         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
 914         if (_sound_output) {
 915                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
 916                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
 917         }
 918         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
 919         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 920         if (_last_player_load_directory) {
 921                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
 922         }
 923         /* [XML] LastKDMWriteType Last type of KDM-write: <code>flat</code> for a flat file, <code>folder</code> for a folder or <code>zip</code> for a ZIP file. */
 924         if (_last_kdm_write_type) {
 925                 switch (_last_kdm_write_type.get()) {
 926                 case KDM_WRITE_FLAT:
 927                         root->add_child("LastKDMWriteType")->add_child_text("flat");
 928                         break;
 929                 case KDM_WRITE_FOLDER:
 930                         root->add_child("LastKDMWriteType")->add_child_text("folder");
 931                         break;
 932                 case KDM_WRITE_ZIP:
 933                         root->add_child("LastKDMWriteType")->add_child_text("zip");
 934                         break;
 935                 }
 936         }
 937         /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
 938         if (_last_dkdm_write_type) {
 939                 switch (_last_dkdm_write_type.get()) {
 940                 case DKDM_WRITE_INTERNAL:
 941                         root->add_child("LastDKDMWriteType")->add_child_text("internal");
 942                         break;
 943                 case DKDM_WRITE_FILE:
 944                         root->add_child("LastDKDMWriteType")->add_child_text("file");
 945                         break;
 946                 }
 947         }
 948         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
 949            frames to be held in memory at once.
 950         */
 951         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
 952
 953         /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
 954         if (_decode_reduction) {
 955                 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
 956         }
 957
 958         /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
 959         root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
 960
 961         /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
 962         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 963                 xmlpp::Element* e = root->add_child ("Notification");
 964                 e->set_attribute ("Id", raw_convert<string>(i));
 965                 e->add_child_text (_notification[i] ? "1" : "0");
 966         }
 967
 968         if (_barco_username) {
 969                 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
 970                 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
 971         }
 972         if (_barco_password) {
 973                 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
 974                 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
 975         }
 976
 977         if (_christie_username) {
 978                 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
 979                 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
 980         }
 981         if (_christie_password) {
 982                 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
 983                 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
 984         }
 985
 986         if (_gdc_username) {
 987                 /* [XML] GCCUsername Username for logging into GDC's servers when downloading server certificates. */
 988                 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
 989         }
 990         if (_gdc_password) {
 991                 /* [XML] GCCPassword Password for logging into GDC's servers when downloading server certificates. */
 992                 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
 993         }
 994
 995         /* [XML] InterfaceComplexity <code>simple</code> for the reduced interface or <code>full</code> for the full interface. */
 996         switch (_interface_complexity) {
 997         case INTERFACE_SIMPLE:
 998                 root->add_child("InterfaceComplexity")->add_child_text("simple");
 999                 break;
1000         case INTERFACE_FULL:
1001                 root->add_child("InterfaceComplexity")->add_child_text("full");
1002                 break;
1003         }
1004
1005         /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
1006            with controls on another monitor.
1007         */
1008         switch (_player_mode) {
1009         case PLAYER_MODE_WINDOW:
1010                 root->add_child("PlayerMode")->add_child_text("window");
1011                 break;
1012         case PLAYER_MODE_FULL:
1013                 root->add_child("PlayerMode")->add_child_text("full");
1014                 break;
1015         case PLAYER_MODE_DUAL:
1016                 root->add_child("PlayerMode")->add_child_text("dual");
1017                 break;
1018         }
1019
1020         /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
1021         root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
1022         switch (_video_view_type) {
1023         case VIDEO_VIEW_SIMPLE:
1024                 root->add_child("VideoViewType")->add_child_text("simple");
1025                 break;
1026         case VIDEO_VIEW_OPENGL:
1027                 root->add_child("VideoViewType")->add_child_text("opengl");
1028                 break;
1029         }
1030         /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
1031         root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
1032         if (_player_activity_log_file) {
1033                 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
1034                 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
1035         }
1036         if (_player_debug_log_file) {
1037                 /* [XML] PlayerLogFile Filename to use for player debug logs */
1038                 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1039         }
1040         if (_player_content_directory) {
1041                 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1042                 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1043         }
1044         if (_player_playlist_directory) {
1045                 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1046                 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1047         }
1048         if (_player_kdm_directory) {
1049                 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1050                 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1051         }
1052         if (_audio_mapping) {
1053                 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1054         }
1055 #ifdef DCPOMATIC_VARIANT_SWAROOP
1056         if (_player_background_image) {
1057                 root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
1058         }
1059         root->add_child("KDMServerURL")->add_child_text(_kdm_server_url);
1060         root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre);
1061         root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert<string>(_player_watermark_period));
1062         root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert<string>(_player_watermark_duration));
1063         BOOST_FOREACH (Monitor i, _required_monitors) {
1064                 i.as_xml(root->add_child("RequiredMonitor"));
1065         }
1066         if (_player_lock_file) {
1067                 root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string());
1068         }
1069 #endif
1070
1071         try {
1072                 string const s = doc.write_to_string_formatted ();
1073                 boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
1074                 FILE* f = fopen_boost (tmp, "w");
1075                 if (!f) {
1076                         throw FileError (_("Could not open file for writing"), tmp);
1077                 }
1078                 checked_fwrite (s.c_str(), s.length(), f, tmp);
1079                 fclose (f);
1080                 boost::filesystem::remove (config_file());
1081                 boost::filesystem::rename (tmp, config_file());
1082         } catch (xmlpp::exception& e) {
1083                 string s = e.what ();
1084                 trim (s);
1085                 throw FileError (s, config_file());
1086         }
1087 }
1088
1089
1090 template <class T>
1091 void
1092 write_file (string root_node, string node, string version, list<shared_ptr<T> > things, boost::filesystem::path file)
1093 {
1094         xmlpp::Document doc;
1095         xmlpp::Element* root = doc.create_root_node (root_node);
1096         root->add_child("Version")->add_child_text(version);
1097
1098         BOOST_FOREACH (shared_ptr<T> i, things) {
1099                 i->as_xml (root->add_child(node));
1100         }
1101
1102         try {
1103                 doc.write_to_file_formatted (file.string() + ".tmp");
1104                 boost::filesystem::remove (file);
1105                 boost::filesystem::rename (file.string() + ".tmp", file);
1106         } catch (xmlpp::exception& e) {
1107                 string s = e.what ();
1108                 trim (s);
1109                 throw FileError (s, file);
1110         }
1111 }
1112
1113
1114 void
1115 Config::write_cinemas () const
1116 {
1117         write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1118 }
1119
1120
1121 void
1122 Config::write_dkdm_recipients () const
1123 {
1124         write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1125 }
1126
1127
1128 boost::filesystem::path
1129 Config::default_directory_or (boost::filesystem::path a) const
1130 {
1131         return directory_or (_default_directory, a);
1132 }
1133
1134 boost::filesystem::path
1135 Config::default_kdm_directory_or (boost::filesystem::path a) const
1136 {
1137         return directory_or (_default_kdm_directory, a);
1138 }
1139
1140 boost::filesystem::path
1141 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1142 {
1143         if (!dir) {
1144                 return a;
1145         }
1146
1147         boost::system::error_code ec;
1148         bool const e = boost::filesystem::exists (*dir, ec);
1149         if (ec || !e) {
1150                 return a;
1151         }
1152
1153         return *dir;
1154 }
1155
1156 void
1157 Config::drop ()
1158 {
1159         delete _instance;
1160         _instance = 0;
1161 }
1162
1163 void
1164 Config::changed (Property what)
1165 {
1166         Changed (what);
1167 }
1168
1169 void
1170 Config::set_kdm_email_to_default ()
1171 {
1172         _kdm_subject = _("KDM delivery: $CPL_NAME");
1173
1174         _kdm_email = _(
1175                 "Dear Projectionist\n\n"
1176                 "Please find attached KDMs for $CPL_NAME.\n\n"
1177                 "Cinema: $CINEMA_NAME\n"
1178                 "Screen(s): $SCREENS\n\n"
1179                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1180                 "Best regards,\nDCP-o-matic"
1181                 );
1182 }
1183
1184 void
1185 Config::set_notification_email_to_default ()
1186 {
1187         _notification_subject = _("DCP-o-matic notification");
1188
1189         _notification_email = _(
1190                 "$JOB_NAME: $JOB_STATUS"
1191                 );
1192 }
1193
1194 void
1195 Config::reset_kdm_email ()
1196 {
1197         set_kdm_email_to_default ();
1198         changed ();
1199 }
1200
1201 void
1202 Config::reset_notification_email ()
1203 {
1204         set_notification_email_to_default ();
1205         changed ();
1206 }
1207
1208 void
1209 Config::set_cover_sheet_to_default ()
1210 {
1211         _cover_sheet = _(
1212                 "$CPL_NAME\n\n"
1213                 "Type: $TYPE\n"
1214                 "Format: $CONTAINER\n"
1215                 "Audio: $AUDIO\n"
1216                 "Audio Language: $AUDIO_LANGUAGE\n"
1217                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1218                 "Length: $LENGTH\n"
1219                 "Size: $SIZE\n"
1220                 );
1221 }
1222
1223 void
1224 Config::add_to_history (boost::filesystem::path p)
1225 {
1226         add_to_history_internal (_history, p);
1227 }
1228
1229 /** Remove non-existant items from the history */
1230 void
1231 Config::clean_history ()
1232 {
1233         clean_history_internal (_history);
1234 }
1235
1236 void
1237 Config::add_to_player_history (boost::filesystem::path p)
1238 {
1239         add_to_history_internal (_player_history, p);
1240 }
1241
1242 /** Remove non-existant items from the player history */
1243 void
1244 Config::clean_player_history ()
1245 {
1246         clean_history_internal (_player_history);
1247 }
1248
1249 void
1250 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1251 {
1252         /* Remove existing instances of this path in the history */
1253         h.erase (remove (h.begin(), h.end(), p), h.end ());
1254
1255         h.insert (h.begin (), p);
1256         if (h.size() > HISTORY_SIZE) {
1257                 h.pop_back ();
1258         }
1259
1260         changed (HISTORY);
1261 }
1262
1263 void
1264 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1265 {
1266         vector<boost::filesystem::path> old = h;
1267         h.clear ();
1268         BOOST_FOREACH (boost::filesystem::path i, old) {
1269                 try {
1270                         if (boost::filesystem::is_directory(i)) {
1271                                 h.push_back (i);
1272                         }
1273                 } catch (...) {
1274                         /* We couldn't find out if it's a directory for some reason; just ignore it */
1275                 }
1276         }
1277 }
1278
1279 bool
1280 Config::have_existing (string file)
1281 {
1282         return boost::filesystem::exists (path (file, false));
1283 }
1284
1285 void
1286 Config::read_cinemas (cxml::Document const & f)
1287 {
1288         _cinemas.clear ();
1289         list<cxml::NodePtr> cin = f.node_children ("Cinema");
1290         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1291                 /* Slightly grotty two-part construction of Cinema here so that we can use
1292                    shared_from_this.
1293                 */
1294                 shared_ptr<Cinema> cinema (new Cinema (i));
1295                 cinema->read_screens (i);
1296                 _cinemas.push_back (cinema);
1297         }
1298 }
1299
1300 void
1301 Config::set_cinemas_file (boost::filesystem::path file)
1302 {
1303         if (file == _cinemas_file) {
1304                 return;
1305         }
1306
1307         _cinemas_file = file;
1308
1309         if (boost::filesystem::exists (_cinemas_file)) {
1310                 /* Existing file; read it in */
1311                 cxml::Document f ("Cinemas");
1312                 f.read_file (_cinemas_file);
1313                 read_cinemas (f);
1314         }
1315
1316         changed (OTHER);
1317 }
1318
1319
1320 void
1321 Config::read_dkdm_recipients (cxml::Document const & f)
1322 {
1323         _dkdm_recipients.clear ();
1324         list<cxml::NodePtr> cin = f.node_children ("DKDMRecipient");
1325         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDMRecipient")) {
1326                 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1327         }
1328 }
1329
1330 void
1331 Config::set_dkdm_recipients_file (boost::filesystem::path file)
1332 {
1333         if (file == _dkdm_recipients_file) {
1334                 return;
1335         }
1336
1337         _dkdm_recipients_file = file;
1338
1339         if (boost::filesystem::exists (_dkdm_recipients_file)) {
1340                 /* Existing file; read it in */
1341                 cxml::Document f ("DKDMRecipients");
1342                 f.read_file (_dkdm_recipients_file);
1343                 read_dkdm_recipients (f);
1344         }
1345
1346         changed (OTHER);
1347 }
1348
1349
1350 void
1351 Config::save_template (shared_ptr<const Film> film, string name) const
1352 {
1353         film->write_template (template_path (name));
1354 }
1355
1356 list<string>
1357 Config::templates () const
1358 {
1359         if (!boost::filesystem::exists (path ("templates"))) {
1360                 return list<string> ();
1361         }
1362
1363         list<string> n;
1364         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1365                 n.push_back (i->path().filename().string());
1366         }
1367         return n;
1368 }
1369
1370 bool
1371 Config::existing_template (string name) const
1372 {
1373         return boost::filesystem::exists (template_path (name));
1374 }
1375
1376 boost::filesystem::path
1377 Config::template_path (string name) const
1378 {
1379         return path("templates") / tidy_for_filename (name);
1380 }
1381
1382 void
1383 Config::rename_template (string old_name, string new_name) const
1384 {
1385         boost::filesystem::rename (template_path (old_name), template_path (new_name));
1386 }
1387
1388 void
1389 Config::delete_template (string name) const
1390 {
1391         boost::filesystem::remove (template_path (name));
1392 }
1393
1394 /** @return Path to the config.xml containing the actual settings, following a link if required */
1395 boost::filesystem::path
1396 Config::config_file ()
1397 {
1398         cxml::Document f ("Config");
1399         boost::filesystem::path main = path("config.xml", false);
1400         if (!boost::filesystem::exists (main)) {
1401                 /* It doesn't exist, so there can't be any links; just return it */
1402                 return main;
1403         }
1404
1405         /* See if there's a link */
1406         try {
1407                 f.read_file (main);
1408                 optional<string> link = f.optional_string_child("Link");
1409                 if (link) {
1410                         return *link;
1411                 }
1412         } catch (xmlpp::exception& e) {
1413                 /* There as a problem reading the main configuration file,
1414                    so there can't be a link.
1415                 */
1416         }
1417
1418         return main;
1419 }
1420
1421 void
1422 Config::reset_cover_sheet ()
1423 {
1424         set_cover_sheet_to_default ();
1425         changed ();
1426 }
1427
1428 void
1429 Config::link (boost::filesystem::path new_file) const
1430 {
1431         xmlpp::Document doc;
1432         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1433         try {
1434                 doc.write_to_file_formatted(path("config.xml", true).string());
1435         } catch (xmlpp::exception& e) {
1436                 string s = e.what ();
1437                 trim (s);
1438                 throw FileError (s, path("config.xml"));
1439         }
1440 }
1441
1442 void
1443 Config::copy_and_link (boost::filesystem::path new_file) const
1444 {
1445         write ();
1446         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1447         link (new_file);
1448 }
1449
1450 bool
1451 Config::have_write_permission () const
1452 {
1453         FILE* f = fopen_boost (config_file(), "r+");
1454         if (!f) {
1455                 return false;
1456         }
1457
1458         fclose (f);
1459         return true;
1460 }
1461
1462 /** @param  output_channels Number of output channels in use.
1463  *  @return Audio mapping for this output channel count (may be a default).
1464  */
1465 AudioMapping
1466 Config::audio_mapping (int output_channels)
1467 {
1468         if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1469                 /* Set up a default */
1470                 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1471                 if (output_channels == 2) {
1472                         /* Special case for stereo output.
1473                            Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1474                            Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1475                         */
1476                         _audio_mapping->set (dcp::LEFT,   0, 1 / sqrt(2));  // L   -> Lt
1477                         _audio_mapping->set (dcp::RIGHT,  1, 1 / sqrt(2));  // R   -> Rt
1478                         _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0);      // C   -> Lt
1479                         _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0);      // C   -> Rt
1480                         _audio_mapping->set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
1481                         _audio_mapping->set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
1482                         _audio_mapping->set (dcp::LS,     0, 1 / sqrt(2));  // Ls  -> Lt
1483                         _audio_mapping->set (dcp::RS,     1, 1 / sqrt(2));  // Rs  -> Rt
1484                 } else {
1485                         /* 1:1 mapping */
1486                         for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1487                                 _audio_mapping->set (i, i, 1);
1488                         }
1489                 }
1490         }
1491
1492         return *_audio_mapping;
1493 }
1494
1495 void
1496 Config::set_audio_mapping (AudioMapping m)
1497 {
1498         _audio_mapping = m;
1499         changed (AUDIO_MAPPING);
1500 }
1501
1502 void
1503 Config::set_audio_mapping_to_default ()
1504 {
1505         DCPOMATIC_ASSERT (_audio_mapping);
1506         int const ch = _audio_mapping->output_channels ();
1507         _audio_mapping = boost::none;
1508         _audio_mapping = audio_mapping (ch);
1509         changed (AUDIO_MAPPING);
1510 }