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