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