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