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