src/lib/config.cc

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