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