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