src/lib/config.cc

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