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