src/lib/config.cc

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