src/lib/config.cc

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