src/lib/config.cc

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