src/lib/config.cc

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