src/lib/config.cc

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