src/lib/config.cc

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