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 "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 <dcp/raw_convert.h>
  36 #include <dcp/name_format.h>
  37 #include <dcp/certificate_chain.h>
  38 #include <libcxml/cxml.h>
  39 #include <glib.h>
  40 #include <libxml++/libxml++.h>
  41 #include <boost/filesystem.hpp>
  42 #include <boost/algorithm/string.hpp>
  43 #include <boost/foreach.hpp>
  44 #include <boost/thread.hpp>
  45 #include <cstdlib>
  46 #include <fstream>
  47 #include <iostream>
  48
  49 #include "i18n.h"
  50
  51 using std::vector;
  52 using std::cout;
  53 using std::ifstream;
  54 using std::string;
  55 using std::list;
  56 using std::min;
  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         _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_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         _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         } catch (...) {}
 237 }
 238
 239 void
 240 Config::read ()
 241 try
 242 {
 243 #if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX)
 244         if (geteuid() == 0) {
 245                 /* Take ownership of the config file if we're root */
 246                 chown (config_file().string().c_str(), 0, 0);
 247                 chmod (config_file().string().c_str(), 0644);
 248         }
 249 #endif
 250
 251         cxml::Document f ("Config");
 252         f.read_file (config_file ());
 253
 254         optional<int> version = f.optional_number_child<int> ("Version");
 255         if (version && *version < _current_version) {
 256                 /* Back up the old config before we re-write it in a back-incompatible way */
 257                 backup ();
 258         }
 259
 260         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 261                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 262         } else {
 263                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 264                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 265         }
 266
 267         _default_directory = f.optional_string_child ("DefaultDirectory");
 268         if (_default_directory && _default_directory->empty ()) {
 269                 /* We used to store an empty value for this to mean "none set" */
 270                 _default_directory = boost::optional<boost::filesystem::path> ();
 271         }
 272
 273         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 274         if (!b) {
 275                 b = f.optional_number_child<int> ("ServerPortBase");
 276         }
 277         _server_port_base = b.get ();
 278
 279         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 280         _use_any_servers = u.get_value_or (true);
 281
 282         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
 283                 if (i->node_children("HostName").size() == 1) {
 284                         _servers.push_back (i->string_child ("HostName"));
 285                 } else {
 286                         _servers.push_back (i->content ());
 287                 }
 288         }
 289
 290         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 291         _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
 292         _tms_ip = f.string_child ("TMSIP");
 293         _tms_path = f.string_child ("TMSPath");
 294         _tms_user = f.string_child ("TMSUser");
 295         _tms_password = f.string_child ("TMSPassword");
 296
 297         _language = f.optional_string_child ("Language");
 298
 299         optional<string> c = f.optional_string_child ("DefaultContainer");
 300         if (c) {
 301                 _default_container = Ratio::from_id (c.get ());
 302         }
 303
 304         if (_default_container && !_default_container->used_for_container()) {
 305                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 306                 _default_container = Ratio::from_id ("185");
 307         }
 308
 309         c = f.optional_string_child ("DefaultScaleTo");
 310         if (c) {
 311                 _default_scale_to = Ratio::from_id (c.get ());
 312         }
 313
 314         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 315         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 316
 317         if (f.optional_string_child ("DCPMetadataIssuer")) {
 318                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 319         } else if (f.optional_string_child ("DCPIssuer")) {
 320                 _dcp_issuer = f.string_child ("DCPIssuer");
 321         }
 322
 323         _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
 324         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 325
 326         if (version && version.get() >= 2) {
 327                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 328         } else {
 329                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 330         }
 331
 332         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 333         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 334         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 335         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 336         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 337
 338         /* Load any cinemas from config.xml */
 339         read_cinemas (f);
 340
 341         _mail_server = f.string_child ("MailServer");
 342         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 343
 344         {
 345                 /* Make sure this matches the code in write_config */
 346                 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
 347                 if (protocol == "Auto") {
 348                         _mail_protocol = EMAIL_PROTOCOL_AUTO;
 349                 } else if (protocol == "Plain") {
 350                         _mail_protocol = EMAIL_PROTOCOL_PLAIN;
 351                 } else if (protocol == "STARTTLS") {
 352                         _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
 353                 } else if (protocol == "SSL") {
 354                         _mail_protocol = EMAIL_PROTOCOL_SSL;
 355                 }
 356         }
 357
 358         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 359         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 360
 361         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 362         _kdm_from = f.string_child ("KDMFrom");
 363         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 364                 if (!i->content().empty()) {
 365                         _kdm_cc.push_back (i->content ());
 366                 }
 367         }
 368         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 369         _kdm_email = f.string_child ("KDMEmail");
 370
 371         _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
 372         _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
 373         _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
 374         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
 375                 if (!i->content().empty()) {
 376                         _notification_cc.push_back (i->content ());
 377                 }
 378         }
 379         _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
 380         if (f.optional_string_child("NotificationEmail")) {
 381                 _notification_email = f.string_child("NotificationEmail");
 382         }
 383
 384         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 385         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 386
 387         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 388         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 389         _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 390         _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
 391
 392         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 393         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 394         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 395 #ifdef DCPOMATIC_WINDOWS
 396         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 397 #endif
 398
 399         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
 400                 _history.push_back (i->content ());
 401         }
 402
 403         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
 404                 _player_history.push_back (i->content ());
 405         }
 406
 407         cxml::NodePtr signer = f.optional_node_child ("Signer");
 408 #ifdef DCPOMATIC_VARIANT_SWAROOP
 409         if (signer && signer->node_children().size() == 1) {
 410                 /* The content of <Signer> is a path to a file; if it's relative it's in the same
 411                    directory as .config. */
 412                 _signer_chain_path = signer->content();
 413                 if (_signer_chain_path.is_relative()) {
 414                         _signer_chain = read_swaroop_chain (path(_signer_chain_path.string()));
 415                 } else {
 416                         _signer_chain = read_swaroop_chain (_signer_chain_path);
 417                 }
 418         } else {
 419                 /* <Signer> is not present or has children: ignore it and remake. */
 420                 _signer_chain = create_certificate_chain ();
 421         }
 422 #else
 423         if (signer) {
 424                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 425                 /* Read the signing certificates and private key in from the config file */
 426                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 427                         c->add (dcp::Certificate (i->content ()));
 428                 }
 429                 c->set_key (signer->string_child ("PrivateKey"));
 430                 _signer_chain = c;
 431         } else {
 432                 /* Make a new set of signing certificates and key */
 433                 _signer_chain = create_certificate_chain ();
 434         }
 435 #endif
 436
 437         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 438 #ifdef DCPOMATIC_VARIANT_SWAROOP
 439         if (decryption && decryption->node_children().size() == 1) {
 440                 /* The content of <Decryption> is a path to a file; if it's relative, it's in the same
 441                    directory as .config. */
 442                 _decryption_chain_path = decryption->content();
 443                 if (_decryption_chain_path.is_relative()) {
 444                         _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string()));
 445                 } else {
 446                         _decryption_chain = read_swaroop_chain (_decryption_chain_path);
 447                 }
 448         } else {
 449                 /* <Decryption> is not present or has more children: ignore it and remake. */
 450                 _decryption_chain = create_certificate_chain ();
 451         }
 452 #else
 453         if (decryption) {
 454                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 455                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 456                         c->add (dcp::Certificate (i->content ()));
 457                 }
 458                 c->set_key (decryption->string_child ("PrivateKey"));
 459                 _decryption_chain = c;
 460         } else {
 461                 _decryption_chain = create_certificate_chain ();
 462         }
 463 #endif
 464
 465         /* These must be done before we call Bad as that might set one
 466            of the nags.
 467         */
 468         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 469                 int const id = i->number_attribute<int>("Id");
 470                 if (id >= 0 && id < NAG_COUNT) {
 471                         _nagged[id] = raw_convert<int>(i->content());
 472                 }
 473         }
 474
 475         optional<BadReason> bad;
 476
 477         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 478                 if (i.has_utf8_strings()) {
 479                         bad = BAD_SIGNER_UTF8_STRINGS;
 480                 }
 481         }
 482
 483         if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
 484                 bad = BAD_SIGNER_INCONSISTENT;
 485         }
 486
 487         if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
 488                 bad = BAD_DECRYPTION_INCONSISTENT;
 489         }
 490
 491         if (bad) {
 492                 optional<bool> const remake = Bad(*bad);
 493                 if (remake && *remake) {
 494                         switch (*bad) {
 495                         case BAD_SIGNER_UTF8_STRINGS:
 496                         case BAD_SIGNER_INCONSISTENT:
 497                                 _signer_chain = create_certificate_chain ();
 498                                 break;
 499                         case BAD_DECRYPTION_INCONSISTENT:
 500                                 _decryption_chain = create_certificate_chain ();
 501                                 break;
 502                         }
 503                 }
 504         }
 505
 506         if (f.optional_node_child("DKDMGroup")) {
 507                 /* New-style: all DKDMs in a group */
 508                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 509         } else {
 510                 /* Old-style: one or more DKDM nodes */
 511                 _dkdms.reset (new DKDMGroup ("root"));
 512                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
 513                         _dkdms->add (DKDMBase::read (i));
 514                 }
 515         }
 516         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 517         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 518         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 519         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 520         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 521         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 522         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 523         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 524         /* The variable was renamed but not the XML tag */
 525         _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
 526         _sound_output = f.optional_string_child("PreviewSoundOutput");
 527         if (f.optional_string_child("CoverSheet")) {
 528                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 529         }
 530         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
 531         if (f.optional_string_child("LastKDMWriteType")) {
 532                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
 533                         _last_kdm_write_type = KDM_WRITE_FLAT;
 534                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
 535                         _last_kdm_write_type = KDM_WRITE_FOLDER;
 536                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
 537                         _last_kdm_write_type = KDM_WRITE_ZIP;
 538                 }
 539         }
 540         if (f.optional_string_child("LastDKDMWriteType")) {
 541                 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
 542                         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 543                 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
 544                         _last_dkdm_write_type = DKDM_WRITE_FILE;
 545                 }
 546         }
 547         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
 548         _decode_reduction = f.optional_number_child<int>("DecodeReduction");
 549         _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
 550
 551         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
 552                 int const id = i->number_attribute<int>("Id");
 553                 if (id >= 0 && id < NOTIFICATION_COUNT) {
 554                         _notification[id] = raw_convert<int>(i->content());
 555                 }
 556         }
 557
 558         _barco_username = f.optional_string_child("BarcoUsername");
 559         _barco_password = f.optional_string_child("BarcoPassword");
 560         _christie_username = f.optional_string_child("ChristieUsername");
 561         _christie_password = f.optional_string_child("ChristiePassword");
 562         _gdc_username = f.optional_string_child("GDCUsername");
 563         _gdc_password = f.optional_string_child("GDCPassword");
 564
 565         optional<string> ic = f.optional_string_child("InterfaceComplexity");
 566         if (ic && *ic == "full") {
 567                 _interface_complexity = INTERFACE_FULL;
 568         }
 569         optional<string> pm = f.optional_string_child("PlayerMode");
 570         if (pm && *pm == "window") {
 571                 _player_mode = PLAYER_MODE_WINDOW;
 572         } else if (pm && *pm == "full") {
 573                 _player_mode = PLAYER_MODE_FULL;
 574         } else if (pm && *pm == "dual") {
 575                 _player_mode = PLAYER_MODE_DUAL;
 576         }
 577
 578         _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
 579         optional<string> vc = f.optional_string_child("VideoViewType");
 580         if (vc && *vc == "opengl") {
 581                 _video_view_type = VIDEO_VIEW_OPENGL;
 582         } else if (vc && *vc == "simple") {
 583                 _video_view_type = VIDEO_VIEW_SIMPLE;
 584         }
 585         _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
 586         /* PlayerLogFile is old name */
 587         _player_activity_log_file = f.optional_string_child("PlayerLogFile");
 588         if (!_player_activity_log_file) {
 589                 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
 590         }
 591         _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
 592         _player_content_directory = f.optional_string_child("PlayerContentDirectory");
 593         _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
 594         _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
 595
 596         if (f.optional_node_child("AudioMapping")) {
 597                 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
 598         }
 599
 600 #ifdef DCPOMATIC_VARIANT_SWAROOP
 601         _player_background_image = f.optional_string_child("PlayerBackgroundImage");
 602         _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
 603         _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or("");
 604         _player_watermark_period = f.optional_number_child<int>("PlayerWatermarkPeriod").get_value_or(1);
 605         _player_watermark_duration = f.optional_number_child<int>("PlayerWatermarkDuration").get_value_or(150);
 606         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) {
 607                 _required_monitors.push_back(Monitor(i));
 608         }
 609         _player_lock_file = f.optional_string_child("PlayerLockFile");
 610 #endif
 611
 612         /* Replace any cinemas from config.xml with those from the configured file */
 613         if (boost::filesystem::exists (_cinemas_file)) {
 614                 cxml::Document f ("Cinemas");
 615                 f.read_file (_cinemas_file);
 616                 read_cinemas (f);
 617         }
 618 }
 619 catch (...) {
 620         if (have_existing ("config.xml")) {
 621                 backup ();
 622                 /* We have a config file but it didn't load */
 623                 FailedToLoad ();
 624         }
 625         set_defaults ();
 626         /* Make a new set of signing certificates and key */
 627         _signer_chain = create_certificate_chain ();
 628         /* And similar for decryption of KDMs */
 629         _decryption_chain = create_certificate_chain ();
 630         write ();
 631 }
 632
 633 /** @return Singleton instance */
 634 Config *
 635 Config::instance ()
 636 {
 637         if (_instance == 0) {
 638                 _instance = new Config;
 639                 _instance->read ();
 640         }
 641
 642         return _instance;
 643 }
 644
 645 /** Write our configuration to disk */
 646 void
 647 Config::write () const
 648 {
 649         write_config ();
 650         write_cinemas ();
 651 }
 652
 653 void
 654 Config::write_config () const
 655 {
 656         xmlpp::Document doc;
 657         xmlpp::Element* root = doc.create_root_node ("Config");
 658
 659         /* [XML] Version The version number of the configuration file format. */
 660         root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
 661         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 662         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 663         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 664         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 665         if (_default_directory) {
 666                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 667                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 668         }
 669         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 670            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 671            by the batch converter to listen for job requests.
 672         */
 673         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 674         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 675         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 676
 677         BOOST_FOREACH (string i, _servers) {
 678                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 679                    as you like.
 680                 */
 681                 root->add_child("Server")->add_child_text (i);
 682         }
 683
 684         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 685            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 686         */
 687         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 688         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 689         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 690         /* [XML] TMSIP IP address of TMS. */
 691         root->add_child("TMSIP")->add_child_text (_tms_ip);
 692         /* [XML] TMSPath Path on the TMS to copy files to. */
 693         root->add_child("TMSPath")->add_child_text (_tms_path);
 694         /* [XML] TMSUser Username to log into the TMS with. */
 695         root->add_child("TMSUser")->add_child_text (_tms_user);
 696         /* [XML] TMSPassword Password to log into the TMS with. */
 697         root->add_child("TMSPassword")->add_child_text (_tms_password);
 698         if (_language) {
 699                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
 700                 root->add_child("Language")->add_child_text (_language.get());
 701         }
 702         if (_default_container) {
 703                 /* [XML:opt] DefaultContainer ID of default container
 704                    to use when creating new films (<code>185</code>,<code>239</code> or
 705                    <code>190</code>).
 706                 */
 707                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 708         }
 709         if (_default_scale_to) {
 710                 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
 711                    (see <code>DefaultContainer</code> for IDs).
 712                 */
 713                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
 714         }
 715         if (_default_dcp_content_type) {
 716                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
 717                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
 718                    <code>PSA</code> or <code>ADV</code>). */
 719                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 720         }
 721         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
 722         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 723         /* [XML] DCPIssuer Issuer text to write into CPL files. */
 724         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 725         /* [XML] DCPIssuer Creator text to write into CPL files. */
 726         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 727         /* [XML] DefaultUploadAfterMakeDCP 1 to default to uploading to a TMS after making a DCP, 0 to default to no upload. */
 728         root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
 729
 730         /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
 731            <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
 732            <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
 733            <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
 734            <code>&lt;MasteredLuminance&gt;</code>.
 735         */
 736         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 737
 738         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
 739         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 740         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
 741         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 742         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
 743         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 744         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
 745         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 746         if (_default_kdm_directory) {
 747                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 748                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 749         }
 750         /* [XML] MailServer Hostname of SMTP server to use. */
 751         root->add_child("MailServer")->add_child_text (_mail_server);
 752         /* [XML] MailPort Port number to use on SMTP server. */
 753         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 754         /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
 755         switch (_mail_protocol) {
 756         case EMAIL_PROTOCOL_AUTO:
 757                 root->add_child("MailProtocol")->add_child_text("Auto");
 758                 break;
 759         case EMAIL_PROTOCOL_PLAIN:
 760                 root->add_child("MailProtocol")->add_child_text("Plain");
 761                 break;
 762         case EMAIL_PROTOCOL_STARTTLS:
 763                 root->add_child("MailProtocol")->add_child_text("STARTTLS");
 764                 break;
 765         case EMAIL_PROTOCOL_SSL:
 766                 root->add_child("MailProtocol")->add_child_text("SSL");
 767                 break;
 768         }
 769         /* [XML] MailUser Username to use on SMTP server. */
 770         root->add_child("MailUser")->add_child_text (_mail_user);
 771         /* [XML] MailPassword Password to use on SMTP server. */
 772         root->add_child("MailPassword")->add_child_text (_mail_password);
 773
 774         /* [XML] KDMSubject Subject to use for KDM emails. */
 775         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 776         /* [XML] KDMFrom From address to use for KDM emails. */
 777         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 778         BOOST_FOREACH (string i, _kdm_cc) {
 779                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
 780                 root->add_child("KDMCC")->add_child_text (i);
 781         }
 782         /* [XML] KDMBCC BCC address to use for KDM emails. */
 783         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 784         /* [XML] KDMEmail Text of KDM email. */
 785         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 786
 787         /* [XML] NotificationSubject Subject to use for notification emails. */
 788         root->add_child("NotificationSubject")->add_child_text (_notification_subject);
 789         /* [XML] NotificationFrom From address to use for notification emails. */
 790         root->add_child("NotificationFrom")->add_child_text (_notification_from);
 791         /* [XML] NotificationFrom To address to use for notification emails. */
 792         root->add_child("NotificationTo")->add_child_text (_notification_to);
 793         BOOST_FOREACH (string i, _notification_cc) {
 794                 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
 795                 root->add_child("NotificationCC")->add_child_text (i);
 796         }
 797         /* [XML] NotificationBCC BCC address to use for notification emails. */
 798         root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
 799         /* [XML] NotificationEmail Text of notification email. */
 800         root->add_child("NotificationEmail")->add_child_text (_notification_email);
 801
 802         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
 803         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 804         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
 805         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 806
 807         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
 808         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 809         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
 810         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 811         /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers. */
 812         root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
 813         /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
 814         root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "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         switch (_video_view_type) {
1018         case VIDEO_VIEW_SIMPLE:
1019                 root->add_child("VideoViewType")->add_child_text("simple");
1020                 break;
1021         case VIDEO_VIEW_OPENGL:
1022                 root->add_child("VideoViewType")->add_child_text("opengl");
1023                 break;
1024         }
1025         /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
1026         root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
1027         if (_player_activity_log_file) {
1028                 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
1029                 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
1030         }
1031         if (_player_debug_log_file) {
1032                 /* [XML] PlayerLogFile Filename to use for player debug logs */
1033                 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1034         }
1035         if (_player_content_directory) {
1036                 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1037                 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1038         }
1039         if (_player_playlist_directory) {
1040                 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1041                 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1042         }
1043         if (_player_kdm_directory) {
1044                 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1045                 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1046         }
1047         if (_audio_mapping) {
1048                 _audio_mapping->as_xml (root->add_child("AudioMapping"));
1049         }
1050 #ifdef DCPOMATIC_VARIANT_SWAROOP
1051         if (_player_background_image) {
1052                 root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
1053         }
1054         root->add_child("KDMServerURL")->add_child_text(_kdm_server_url);
1055         root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre);
1056         root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert<string>(_player_watermark_period));
1057         root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert<string>(_player_watermark_duration));
1058         BOOST_FOREACH (Monitor i, _required_monitors) {
1059                 i.as_xml(root->add_child("RequiredMonitor"));
1060         }
1061         if (_player_lock_file) {
1062                 root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string());
1063         }
1064 #endif
1065
1066         try {
1067                 string const s = doc.write_to_string_formatted ();
1068                 boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
1069                 FILE* f = fopen_boost (tmp, "w");
1070                 if (!f) {
1071                         throw FileError (_("Could not open file for writing"), tmp);
1072                 }
1073                 checked_fwrite (s.c_str(), s.length(), f, tmp);
1074                 fclose (f);
1075                 boost::filesystem::remove (config_file());
1076                 boost::filesystem::rename (tmp, config_file());
1077         } catch (xmlpp::exception& e) {
1078                 string s = e.what ();
1079                 trim (s);
1080                 throw FileError (s, config_file());
1081         }
1082 }
1083
1084 void
1085 Config::write_cinemas () const
1086 {
1087         xmlpp::Document doc;
1088         xmlpp::Element* root = doc.create_root_node ("Cinemas");
1089         root->add_child("Version")->add_child_text ("1");
1090
1091         BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
1092                 i->as_xml (root->add_child ("Cinema"));
1093         }
1094
1095         try {
1096                 doc.write_to_file_formatted (_cinemas_file.string() + ".tmp");
1097                 boost::filesystem::remove (_cinemas_file);
1098                 boost::filesystem::rename (_cinemas_file.string() + ".tmp", _cinemas_file);
1099         } catch (xmlpp::exception& e) {
1100                 string s = e.what ();
1101                 trim (s);
1102                 throw FileError (s, _cinemas_file);
1103         }
1104 }
1105
1106 boost::filesystem::path
1107 Config::default_directory_or (boost::filesystem::path a) const
1108 {
1109         return directory_or (_default_directory, a);
1110 }
1111
1112 boost::filesystem::path
1113 Config::default_kdm_directory_or (boost::filesystem::path a) const
1114 {
1115         return directory_or (_default_kdm_directory, a);
1116 }
1117
1118 boost::filesystem::path
1119 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1120 {
1121         if (!dir) {
1122                 return a;
1123         }
1124
1125         boost::system::error_code ec;
1126         bool const e = boost::filesystem::exists (*dir, ec);
1127         if (ec || !e) {
1128                 return a;
1129         }
1130
1131         return *dir;
1132 }
1133
1134 void
1135 Config::drop ()
1136 {
1137         delete _instance;
1138         _instance = 0;
1139 }
1140
1141 void
1142 Config::changed (Property what)
1143 {
1144         Changed (what);
1145 }
1146
1147 void
1148 Config::set_kdm_email_to_default ()
1149 {
1150         _kdm_subject = _("KDM delivery: $CPL_NAME");
1151
1152         _kdm_email = _(
1153                 "Dear Projectionist\n\n"
1154                 "Please find attached KDMs for $CPL_NAME.\n\n"
1155                 "Cinema: $CINEMA_NAME\n"
1156                 "Screen(s): $SCREENS\n\n"
1157                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1158                 "Best regards,\nDCP-o-matic"
1159                 );
1160 }
1161
1162 void
1163 Config::set_notification_email_to_default ()
1164 {
1165         _notification_subject = _("DCP-o-matic notification");
1166
1167         _notification_email = _(
1168                 "$JOB_NAME: $JOB_STATUS"
1169                 );
1170 }
1171
1172 void
1173 Config::reset_kdm_email ()
1174 {
1175         set_kdm_email_to_default ();
1176         changed ();
1177 }
1178
1179 void
1180 Config::reset_notification_email ()
1181 {
1182         set_notification_email_to_default ();
1183         changed ();
1184 }
1185
1186 void
1187 Config::set_cover_sheet_to_default ()
1188 {
1189         _cover_sheet = _(
1190                 "$CPL_NAME\n\n"
1191                 "Type: $TYPE\n"
1192                 "Format: $CONTAINER\n"
1193                 "Audio: $AUDIO\n"
1194                 "Audio Language: $AUDIO_LANGUAGE\n"
1195                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1196                 "Length: $LENGTH\n"
1197                 "Size: $SIZE\n"
1198                 );
1199 }
1200
1201 void
1202 Config::add_to_history (boost::filesystem::path p)
1203 {
1204         add_to_history_internal (_history, p);
1205 }
1206
1207 /** Remove non-existant items from the history */
1208 void
1209 Config::clean_history ()
1210 {
1211         clean_history_internal (_history);
1212 }
1213
1214 void
1215 Config::add_to_player_history (boost::filesystem::path p)
1216 {
1217         add_to_history_internal (_player_history, p);
1218 }
1219
1220 /** Remove non-existant items from the player history */
1221 void
1222 Config::clean_player_history ()
1223 {
1224         clean_history_internal (_player_history);
1225 }
1226
1227 void
1228 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1229 {
1230         /* Remove existing instances of this path in the history */
1231         h.erase (remove (h.begin(), h.end(), p), h.end ());
1232
1233         h.insert (h.begin (), p);
1234         if (h.size() > HISTORY_SIZE) {
1235                 h.pop_back ();
1236         }
1237
1238         changed (HISTORY);
1239 }
1240
1241 void
1242 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1243 {
1244         vector<boost::filesystem::path> old = h;
1245         h.clear ();
1246         BOOST_FOREACH (boost::filesystem::path i, old) {
1247                 try {
1248                         if (boost::filesystem::is_directory(i)) {
1249                                 h.push_back (i);
1250                         }
1251                 } catch (...) {
1252                         /* We couldn't find out if it's a directory for some reason; just ignore it */
1253                 }
1254         }
1255 }
1256
1257 bool
1258 Config::have_existing (string file)
1259 {
1260         return boost::filesystem::exists (path (file, false));
1261 }
1262
1263 void
1264 Config::read_cinemas (cxml::Document const & f)
1265 {
1266         _cinemas.clear ();
1267         list<cxml::NodePtr> cin = f.node_children ("Cinema");
1268         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1269                 /* Slightly grotty two-part construction of Cinema here so that we can use
1270                    shared_from_this.
1271                 */
1272                 shared_ptr<Cinema> cinema (new Cinema (i));
1273                 cinema->read_screens (i);
1274                 _cinemas.push_back (cinema);
1275         }
1276 }
1277
1278 void
1279 Config::set_cinemas_file (boost::filesystem::path file)
1280 {
1281         if (file == _cinemas_file) {
1282                 return;
1283         }
1284
1285         _cinemas_file = file;
1286
1287         if (boost::filesystem::exists (_cinemas_file)) {
1288                 /* Existing file; read it in */
1289                 cxml::Document f ("Cinemas");
1290                 f.read_file (_cinemas_file);
1291                 read_cinemas (f);
1292         }
1293
1294         changed (OTHER);
1295 }
1296
1297 void
1298 Config::save_template (shared_ptr<const Film> film, string name) const
1299 {
1300         film->write_template (template_path (name));
1301 }
1302
1303 list<string>
1304 Config::templates () const
1305 {
1306         if (!boost::filesystem::exists (path ("templates"))) {
1307                 return list<string> ();
1308         }
1309
1310         list<string> n;
1311         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1312                 n.push_back (i->path().filename().string());
1313         }
1314         return n;
1315 }
1316
1317 bool
1318 Config::existing_template (string name) const
1319 {
1320         return boost::filesystem::exists (template_path (name));
1321 }
1322
1323 boost::filesystem::path
1324 Config::template_path (string name) const
1325 {
1326         return path("templates") / tidy_for_filename (name);
1327 }
1328
1329 void
1330 Config::rename_template (string old_name, string new_name) const
1331 {
1332         boost::filesystem::rename (template_path (old_name), template_path (new_name));
1333 }
1334
1335 void
1336 Config::delete_template (string name) const
1337 {
1338         boost::filesystem::remove (template_path (name));
1339 }
1340
1341 /** @return Path to the config.xml containing the actual settings, following a link if required */
1342 boost::filesystem::path
1343 Config::config_file ()
1344 {
1345         cxml::Document f ("Config");
1346         boost::filesystem::path main = path("config.xml", false);
1347         if (!boost::filesystem::exists (main)) {
1348                 /* It doesn't exist, so there can't be any links; just return it */
1349                 return main;
1350         }
1351
1352         /* See if there's a link */
1353         try {
1354                 f.read_file (main);
1355                 optional<string> link = f.optional_string_child("Link");
1356                 if (link) {
1357                         return *link;
1358                 }
1359         } catch (xmlpp::exception& e) {
1360                 /* There as a problem reading the main configuration file,
1361                    so there can't be a link.
1362                 */
1363         }
1364
1365         return main;
1366 }
1367
1368 void
1369 Config::reset_cover_sheet ()
1370 {
1371         set_cover_sheet_to_default ();
1372         changed ();
1373 }
1374
1375 void
1376 Config::link (boost::filesystem::path new_file) const
1377 {
1378         xmlpp::Document doc;
1379         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1380         try {
1381                 doc.write_to_file_formatted(path("config.xml", true).string());
1382         } catch (xmlpp::exception& e) {
1383                 string s = e.what ();
1384                 trim (s);
1385                 throw FileError (s, path("config.xml"));
1386         }
1387 }
1388
1389 void
1390 Config::copy_and_link (boost::filesystem::path new_file) const
1391 {
1392         write ();
1393         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1394         link (new_file);
1395 }
1396
1397 bool
1398 Config::have_write_permission () const
1399 {
1400         FILE* f = fopen_boost (config_file(), "r+");
1401         if (!f) {
1402                 return false;
1403         }
1404
1405         fclose (f);
1406         return true;
1407 }
1408
1409 /** @param  output_channels Number of output channels in use.
1410  *  @return Audio mapping for this output channel count (may be a default).
1411  */
1412 AudioMapping
1413 Config::audio_mapping (int output_channels)
1414 {
1415         if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1416                 /* Set up a default */
1417                 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1418                 if (output_channels == 2) {
1419                         /* Special case for stereo output.
1420                            Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1421                            Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1422                         */
1423                         _audio_mapping->set (dcp::LEFT,   0, 1 / sqrt(2));  // L   -> Lt
1424                         _audio_mapping->set (dcp::RIGHT,  1, 1 / sqrt(2));  // R   -> Rt
1425                         _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0);      // C   -> Lt
1426                         _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0);      // C   -> Rt
1427                         _audio_mapping->set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
1428                         _audio_mapping->set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
1429                         _audio_mapping->set (dcp::LS,     0, 1 / sqrt(2));  // Ls  -> Lt
1430                         _audio_mapping->set (dcp::RS,     1, 1 / sqrt(2));  // Rs  -> Rt
1431                 } else {
1432                         /* 1:1 mapping */
1433                         for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1434                                 _audio_mapping->set (i, i, 1);
1435                         }
1436                 }
1437         }
1438
1439         return *_audio_mapping;
1440 }
1441
1442 void
1443 Config::set_audio_mapping (AudioMapping m)
1444 {
1445         _audio_mapping = m;
1446         changed (AUDIO_MAPPING);
1447 }
1448
1449 void
1450 Config::set_audio_mapping_to_default ()
1451 {
1452         DCPOMATIC_ASSERT (_audio_mapping);
1453         int const ch = _audio_mapping->output_channels ();
1454         _audio_mapping = boost::none;
1455         _audio_mapping = audio_mapping (ch);
1456         changed (AUDIO_MAPPING);
1457 }