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