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