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