src/lib/config.cc

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