src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "config.h"
  22 #include "filter.h"
  23 #include "ratio.h"
  24 #include "types.h"
  25 #include "log.h"
  26 #include "dcp_content_type.h"
  27 #include "cinema_sound_processor.h"
  28 #include "colour_conversion.h"
  29 #include "cinema.h"
  30 #include "util.h"
  31 #include "cross.h"
  32 #include "film.h"
  33 #include "dkdm_wrapper.h"
  34 #include "compose.hpp"
  35 #include "crypto.h"
  36 #include <dcp/raw_convert.h>
  37 #include <dcp/name_format.h>
  38 #include <dcp/certificate_chain.h>
  39 #include <libcxml/cxml.h>
  40 #include <glib.h>
  41 #include <libxml++/libxml++.h>
  42 #include <boost/filesystem.hpp>
  43 #include <boost/algorithm/string.hpp>
  44 #include <boost/foreach.hpp>
  45 #include <boost/thread.hpp>
  46 #include <cstdlib>
  47 #include <fstream>
  48 #include <iostream>
  49
  50 #include "i18n.h"
  51
  52 using std::vector;
  53 using std::cout;
  54 using std::ifstream;
  55 using std::string;
  56 using std::list;
  57 using std::max;
  58 using std::remove;
  59 using std::exception;
  60 using std::cerr;
  61 using boost::shared_ptr;
  62 using boost::optional;
  63 using boost::dynamic_pointer_cast;
  64 using boost::algorithm::trim;
  65 using boost::shared_array;
  66 using dcp::raw_convert;
  67
  68 Config* Config::_instance = 0;
  69 int const Config::_current_version = 3;
  70 boost::signals2::signal<void ()> Config::FailedToLoad;
  71 boost::signals2::signal<void (string)> Config::Warning;
  72 boost::signals2::signal<bool (Config::BadSignerChainReason)> 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                         CERTIFICATE_VALIDITY_PERIOD,
 214                         "dcpomatic.com",
 215                         "dcpomatic.com",
 216                         ".dcpomatic.smpte-430-2.ROOT",
 217                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 218                         "CS.dcpomatic.smpte-430-2.LEAF"
 219                         )
 220                 );
 221 }
 222
 223 void
 224 Config::backup ()
 225 {
 226         /* Make a copy of the configuration */
 227         try {
 228                 int n = 1;
 229                 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
 230                         ++n;
 231                 }
 232
 233                 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
 234                 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
 235         } catch (...) {}
 236 }
 237
 238 void
 239 Config::read ()
 240 try
 241 {
 242 #if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX)
 243         if (geteuid() == 0) {
 244                 /* Take ownership of the config file if we're root */
 245                 chown (config_file().string().c_str(), 0, 0);
 246                 chmod (config_file().string().c_str(), 0644);
 247         }
 248 #endif
 249
 250         cxml::Document f ("Config");
 251         f.read_file (config_file ());
 252
 253         optional<int> version = f.optional_number_child<int> ("Version");
 254         if (version && *version < _current_version) {
 255                 /* Back up the old config before we re-write it in a back-incompatible way */
 256                 backup ();
 257         }
 258
 259         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 260                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 261         } else {
 262                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 263                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 264         }
 265
 266         _default_directory = f.optional_string_child ("DefaultDirectory");
 267         if (_default_directory && _default_directory->empty ()) {
 268                 /* We used to store an empty value for this to mean "none set" */
 269                 _default_directory = boost::optional<boost::filesystem::path> ();
 270         }
 271
 272         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 273         if (!b) {
 274                 b = f.optional_number_child<int> ("ServerPortBase");
 275         }
 276         _server_port_base = b.get ();
 277
 278         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 279         _use_any_servers = u.get_value_or (true);
 280
 281         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
 282                 if (i->node_children("HostName").size() == 1) {
 283                         _servers.push_back (i->string_child ("HostName"));
 284                 } else {
 285                         _servers.push_back (i->content ());
 286                 }
 287         }
 288
 289         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 290         _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
 291         _tms_ip = f.string_child ("TMSIP");
 292         _tms_path = f.string_child ("TMSPath");
 293         _tms_user = f.string_child ("TMSUser");
 294         _tms_password = f.string_child ("TMSPassword");
 295
 296         optional<string> c;
 297         c = f.optional_string_child ("SoundProcessor");
 298         if (c) {
 299                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 300         }
 301         c = f.optional_string_child ("CinemaSoundProcessor");
 302         if (c) {
 303                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 304         }
 305
 306         _language = f.optional_string_child ("Language");
 307
 308         c = f.optional_string_child ("DefaultContainer");
 309         if (c) {
 310                 _default_container = Ratio::from_id (c.get ());
 311         }
 312
 313         if (_default_container && !_default_container->used_for_container()) {
 314                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 315                 _default_container = Ratio::from_id ("185");
 316         }
 317
 318         c = f.optional_string_child ("DefaultScaleTo");
 319         if (c) {
 320                 _default_scale_to = Ratio::from_id (c.get ());
 321         }
 322
 323         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 324         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 325
 326         if (f.optional_string_child ("DCPMetadataIssuer")) {
 327                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 328         } else if (f.optional_string_child ("DCPIssuer")) {
 329                 _dcp_issuer = f.string_child ("DCPIssuer");
 330         }
 331
 332         _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
 333         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 334
 335         if (version && version.get() >= 2) {
 336                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 337         } else {
 338                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 339         }
 340
 341         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 342         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 343         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 344         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 345         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 346
 347         /* Load any cinemas from config.xml */
 348         read_cinemas (f);
 349
 350         _mail_server = f.string_child ("MailServer");
 351         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 352
 353         {
 354                 /* Make sure this matches the code in write_config */
 355                 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
 356                 if (protocol == "Auto") {
 357                         _mail_protocol = EMAIL_PROTOCOL_AUTO;
 358                 } else if (protocol == "Plain") {
 359                         _mail_protocol = EMAIL_PROTOCOL_PLAIN;
 360                 } else if (protocol == "STARTTLS") {
 361                         _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
 362                 } else if (protocol == "SSL") {
 363                         _mail_protocol = EMAIL_PROTOCOL_SSL;
 364                 }
 365         }
 366
 367         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 368         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 369
 370         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 371         _kdm_from = f.string_child ("KDMFrom");
 372         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 373                 if (!i->content().empty()) {
 374                         _kdm_cc.push_back (i->content ());
 375                 }
 376         }
 377         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 378         _kdm_email = f.string_child ("KDMEmail");
 379
 380         _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
 381         _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
 382         _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
 383         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
 384                 if (!i->content().empty()) {
 385                         _notification_cc.push_back (i->content ());
 386                 }
 387         }
 388         _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
 389         if (f.optional_string_child("NotificationEmail")) {
 390                 _notification_email = f.string_child("NotificationEmail");
 391         }
 392
 393         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 394         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 395
 396         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 397         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 398         _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 399
 400         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 401         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 402         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 403 #ifdef DCPOMATIC_WINDOWS
 404         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 405 #endif
 406
 407         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
 408                 _history.push_back (i->content ());
 409         }
 410
 411         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
 412                 _player_history.push_back (i->content ());
 413         }
 414
 415         cxml::NodePtr signer = f.optional_node_child ("Signer");
 416 #ifdef DCPOMATIC_VARIANT_SWAROOP
 417         if (signer && signer->node_children().size() == 1) {
 418                 /* The content of <Signer> is a path to a file; if it's relative it's in the same
 419                    directory as .config. */
 420                 _signer_chain_path = signer->content();
 421                 if (_signer_chain_path.is_relative()) {
 422                         _signer_chain = read_swaroop_chain (path(_signer_chain_path.string()));
 423                 } else {
 424                         _signer_chain = read_swaroop_chain (_signer_chain_path);
 425                 }
 426         } else {
 427                 /* <Signer> is not present or has children: ignore it and remake. */
 428                 _signer_chain = create_certificate_chain ();
 429         }
 430 #else
 431         if (signer) {
 432                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 433                 /* Read the signing certificates and private key in from the config file */
 434                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 435                         c->add (dcp::Certificate (i->content ()));
 436                 }
 437                 c->set_key (signer->string_child ("PrivateKey"));
 438                 _signer_chain = c;
 439         } else {
 440                 /* Make a new set of signing certificates and key */
 441                 _signer_chain = create_certificate_chain ();
 442         }
 443 #endif
 444
 445         /* These must be done before we call BadSignerChain as that might set one
 446            of the nags.
 447         */
 448         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 449                 int const id = i->number_attribute<int>("Id");
 450                 if (id >= 0 && id < NAG_COUNT) {
 451                         _nagged[id] = raw_convert<int>(i->content());
 452                 }
 453         }
 454
 455         BadSignerChainReason reason = BAD_SIGNER_CHAIN_NONE;
 456         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 457                 if (i.has_utf8_strings()) {
 458                         reason = static_cast<BadSignerChainReason>(reason | BAD_SIGNER_CHAIN_HAS_UTF8_STRINGS);
 459                 }
 460                 struct tm not_before = i.not_before();
 461                 struct tm not_after = i.not_after();
 462                 if ((not_after.tm_year - not_before.tm_year) > 15) {
 463                         /* We don't know why (or precise details) but it seems like certificate validity of >10
 464                          * years causes problems with some projection systems (#2174 and others).
 465                          */
 466                         reason = static_cast<BadSignerChainReason>(reason | BAD_SIGNER_CHAIN_VALIDITY_TOO_LONG);
 467                 }
 468         }
 469
 470         if (reason) {
 471                 optional<bool> const remake = BadSignerChain(reason);
 472                 if (remake && *remake) {
 473                         _signer_chain = create_certificate_chain ();
 474                 }
 475         }
 476
 477         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 478 #ifdef DCPOMATIC_VARIANT_SWAROOP
 479         if (decryption && decryption->node_children().size() == 1) {
 480                 /* The content of <Decryption> is a path to a file; if it's relative, it's in the same
 481                    directory as .config. */
 482                 _decryption_chain_path = decryption->content();
 483                 if (_decryption_chain_path.is_relative()) {
 484                         _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string()));
 485                 } else {
 486                         _decryption_chain = read_swaroop_chain (_decryption_chain_path);
 487                 }
 488         } else {
 489                 /* <Decryption> is not present or has more children: ignore it and remake. */
 490                 _decryption_chain = create_certificate_chain ();
 491         }
 492 #else
 493         if (decryption) {
 494                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 495                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 496                         c->add (dcp::Certificate (i->content ()));
 497                 }
 498                 c->set_key (decryption->string_child ("PrivateKey"));
 499                 _decryption_chain = c;
 500         } else {
 501                 _decryption_chain = create_certificate_chain ();
 502         }
 503 #endif
 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         _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
 578         /* PlayerLogFile is old name */
 579         _player_activity_log_file = f.optional_string_child("PlayerLogFile");
 580         if (!_player_activity_log_file) {
 581                 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
 582         }
 583         _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
 584         _player_content_directory = f.optional_string_child("PlayerContentDirectory");
 585         _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
 586         _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
 587 #ifdef DCPOMATIC_VARIANT_SWAROOP
 588         _player_background_image = f.optional_string_child("PlayerBackgroundImage");
 589         _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
 590         _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or("");
 591         _player_watermark_period = f.optional_number_child<int>("PlayerWatermarkPeriod").get_value_or(1);
 592         _player_watermark_duration = f.optional_number_child<int>("PlayerWatermarkDuration").get_value_or(150);
 593         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) {
 594                 _required_monitors.push_back(Monitor(i));
 595         }
 596         _player_lock_file = f.optional_string_child("PlayerLockFile");
 597 #endif
 598
 599         /* Replace any cinemas from config.xml with those from the configured file */
 600         if (boost::filesystem::exists (_cinemas_file)) {
 601                 cxml::Document f ("Cinemas");
 602                 f.read_file (_cinemas_file);
 603                 read_cinemas (f);
 604         }
 605 }
 606 catch (...) {
 607         if (have_existing ("config.xml")) {
 608                 backup ();
 609                 /* We have a config file but it didn't load */
 610                 FailedToLoad ();
 611         }
 612         set_defaults ();
 613         /* Make a new set of signing certificates and key */
 614         _signer_chain = create_certificate_chain ();
 615         /* And similar for decryption of KDMs */
 616         _decryption_chain = create_certificate_chain ();
 617         write ();
 618 }
 619
 620 /** @return Singleton instance */
 621 Config *
 622 Config::instance ()
 623 {
 624         if (_instance == 0) {
 625                 _instance = new Config;
 626                 _instance->read ();
 627         }
 628
 629         return _instance;
 630 }
 631
 632 /** Write our configuration to disk */
 633 void
 634 Config::write () const
 635 {
 636         write_config ();
 637         write_cinemas ();
 638 }
 639
 640 void
 641 Config::write_config () const
 642 {
 643         xmlpp::Document doc;
 644         xmlpp::Element* root = doc.create_root_node ("Config");
 645
 646         /* [XML] Version The version number of the configuration file format. */
 647         root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
 648         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 649         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 650         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 651         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 652         if (_default_directory) {
 653                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 654                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 655         }
 656         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 657            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 658            by the batch converter to listen for job requests.
 659         */
 660         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 661         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 662         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 663
 664         BOOST_FOREACH (string i, _servers) {
 665                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 666                    as you like.
 667                 */
 668                 root->add_child("Server")->add_child_text (i);
 669         }
 670
 671         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 672            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 673         */
 674         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 675         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 676         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 677         /* [XML] TMSIP IP address of TMS. */
 678         root->add_child("TMSIP")->add_child_text (_tms_ip);
 679         /* [XML] TMSPath Path on the TMS to copy files to. */
 680         root->add_child("TMSPath")->add_child_text (_tms_path);
 681         /* [XML] TMSUser Username to log into the TMS with. */
 682         root->add_child("TMSUser")->add_child_text (_tms_user);
 683         /* [XML] TMSPassword Password to log into the TMS with. */
 684         root->add_child("TMSPassword")->add_child_text (_tms_password);
 685         if (_cinema_sound_processor) {
 686                 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
 687                    gain changes from fader positions.  Currently can only be <code>dolby_cp750</code>.
 688                 */
 689                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 690         }
 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] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
 807            to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
 808            to sending email.
 809         */
 810         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 811         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
 812         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 813         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
 814         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 815 #ifdef DCPOMATIC_WINDOWS
 816         /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
 817         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 818 #endif
 819
 820 #ifdef DCPOMATIC_VARIANT_SWAROOP
 821         if (_signer_chain_path.is_relative()) {
 822                 write_swaroop_chain (_signer_chain, path(_signer_chain_path.string()));
 823         } else {
 824                 write_swaroop_chain (_signer_chain, _signer_chain_path);
 825         }
 826         root->add_child("Signer")->add_child_text(_signer_chain_path.string());
 827 #else
 828         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
 829            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
 830         */
 831         xmlpp::Element* signer = root->add_child ("Signer");
 832         DCPOMATIC_ASSERT (_signer_chain);
 833         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 834                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 835         }
 836         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 837 #endif
 838
 839 #ifdef DCPOMATIC_VARIANT_SWAROOP
 840         if (_decryption_chain_path.is_relative()) {
 841                 write_swaroop_chain (_decryption_chain, path(_decryption_chain_path.string()));
 842         } else {
 843                 write_swaroop_chain (_decryption_chain, _decryption_chain_path);
 844         }
 845         root->add_child("Decryption")->add_child_text(_decryption_chain_path.string());
 846 #else
 847         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
 848         xmlpp::Element* decryption = root->add_child ("Decryption");
 849         DCPOMATIC_ASSERT (_decryption_chain);
 850         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
 851                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 852         }
 853         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 854 #endif
 855
 856         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
 857            of these tags.
 858         */
 859         BOOST_FOREACH (boost::filesystem::path i, _history) {
 860                 root->add_child("History")->add_child_text (i.string ());
 861         }
 862
 863         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
 864            of these tags.
 865         */
 866         BOOST_FOREACH (boost::filesystem::path i, _player_history) {
 867                 root->add_child("PlayerHistory")->add_child_text (i.string ());
 868         }
 869
 870         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
 871            or <code>&lt;DKDM&gt;</code> tags.
 872         */
 873         /* [XML] DKDM A DKDM as XML */
 874         _dkdms->as_xml (root);
 875
 876         /* [XML] CinemasFile Filename of cinemas list file. */
 877         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 878         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
 879         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 880         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
 881         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 882         /* [XML] KDMFilenameFormat Format for KDM filenames. */
 883         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 884         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
 885         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 886         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
 887         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 888         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
 889         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 890         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
 891         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 892         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
 893         for (int i = 0; i < NAG_COUNT; ++i) {
 894                 xmlpp::Element* e = root->add_child ("Nagged");
 895                 e->set_attribute ("Id", raw_convert<string>(i));
 896                 e->add_child_text (_nagged[i] ? "1" : "0");
 897         }
 898         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
 899         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
 900         if (_sound_output) {
 901                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
 902                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
 903         }
 904         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
 905         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 906         if (_last_player_load_directory) {
 907                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
 908         }
 909         /* [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. */
 910         if (_last_kdm_write_type) {
 911                 switch (_last_kdm_write_type.get()) {
 912                 case KDM_WRITE_FLAT:
 913                         root->add_child("LastKDMWriteType")->add_child_text("flat");
 914                         break;
 915                 case KDM_WRITE_FOLDER:
 916                         root->add_child("LastKDMWriteType")->add_child_text("folder");
 917                         break;
 918                 case KDM_WRITE_ZIP:
 919                         root->add_child("LastKDMWriteType")->add_child_text("zip");
 920                         break;
 921                 }
 922         }
 923         /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
 924         if (_last_dkdm_write_type) {
 925                 switch (_last_dkdm_write_type.get()) {
 926                 case DKDM_WRITE_INTERNAL:
 927                         root->add_child("LastDKDMWriteType")->add_child_text("internal");
 928                         break;
 929                 case DKDM_WRITE_FILE:
 930                         root->add_child("LastDKDMWriteType")->add_child_text("file");
 931                         break;
 932                 }
 933         }
 934         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
 935            frames to be held in memory at once.
 936         */
 937         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
 938
 939         /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
 940         if (_decode_reduction) {
 941                 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
 942         }
 943
 944         /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
 945         root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
 946
 947         /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
 948         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 949                 xmlpp::Element* e = root->add_child ("Notification");
 950                 e->set_attribute ("Id", raw_convert<string>(i));
 951                 e->add_child_text (_notification[i] ? "1" : "0");
 952         }
 953
 954         if (_barco_username) {
 955                 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
 956                 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
 957         }
 958         if (_barco_password) {
 959                 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
 960                 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
 961         }
 962
 963         if (_christie_username) {
 964                 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
 965                 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
 966         }
 967         if (_christie_password) {
 968                 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
 969                 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
 970         }
 971
 972         if (_gdc_username) {
 973                 /* [XML] GCCUsername Username for logging into GDC's servers when downloading server certificates. */
 974                 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
 975         }
 976         if (_gdc_password) {
 977                 /* [XML] GCCPassword Password for logging into GDC's servers when downloading server certificates. */
 978                 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
 979         }
 980
 981         /* [XML] InterfaceComplexity <code>simple</code> for the reduced interface or <code>full</code> for the full interface. */
 982         switch (_interface_complexity) {
 983         case INTERFACE_SIMPLE:
 984                 root->add_child("InterfaceComplexity")->add_child_text("simple");
 985                 break;
 986         case INTERFACE_FULL:
 987                 root->add_child("InterfaceComplexity")->add_child_text("full");
 988                 break;
 989         }
 990
 991         /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
 992            with controls on another monitor.
 993         */
 994         switch (_player_mode) {
 995         case PLAYER_MODE_WINDOW:
 996                 root->add_child("PlayerMode")->add_child_text("window");
 997                 break;
 998         case PLAYER_MODE_FULL:
 999                 root->add_child("PlayerMode")->add_child_text("full");
1000                 break;
1001         case PLAYER_MODE_DUAL:
1002                 root->add_child("PlayerMode")->add_child_text("dual");
1003                 break;
1004         }
1005
1006         /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
1007         root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
1008         /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
1009         root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
1010         if (_player_activity_log_file) {
1011                 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
1012                 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
1013         }
1014         if (_player_debug_log_file) {
1015                 /* [XML] PlayerLogFile Filename to use for player debug logs */
1016                 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
1017         }
1018         if (_player_content_directory) {
1019                 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
1020                 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
1021         }
1022         if (_player_playlist_directory) {
1023                 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
1024                 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
1025         }
1026         if (_player_kdm_directory) {
1027                 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
1028                 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
1029         }
1030 #ifdef DCPOMATIC_VARIANT_SWAROOP
1031         if (_player_background_image) {
1032                 root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
1033         }
1034         root->add_child("KDMServerURL")->add_child_text(_kdm_server_url);
1035         root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre);
1036         root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert<string>(_player_watermark_period));
1037         root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert<string>(_player_watermark_duration));
1038         BOOST_FOREACH (Monitor i, _required_monitors) {
1039                 i.as_xml(root->add_child("RequiredMonitor"));
1040         }
1041         if (_player_lock_file) {
1042                 root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string());
1043         }
1044 #endif
1045
1046         try {
1047                 string const s = doc.write_to_string_formatted ();
1048                 boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
1049                 FILE* f = fopen_boost (tmp, "w");
1050                 if (!f) {
1051                         throw FileError (_("Could not open file for writing"), tmp);
1052                 }
1053                 checked_fwrite (s.c_str(), s.length(), f, tmp);
1054                 fclose (f);
1055                 boost::filesystem::remove (config_file());
1056                 boost::filesystem::rename (tmp, config_file());
1057         } catch (xmlpp::exception& e) {
1058                 string s = e.what ();
1059                 trim (s);
1060                 throw FileError (s, config_file());
1061         }
1062 }
1063
1064 void
1065 Config::write_cinemas () const
1066 {
1067         xmlpp::Document doc;
1068         xmlpp::Element* root = doc.create_root_node ("Cinemas");
1069         root->add_child("Version")->add_child_text ("1");
1070
1071         BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
1072                 i->as_xml (root->add_child ("Cinema"));
1073         }
1074
1075         try {
1076                 doc.write_to_file_formatted (_cinemas_file.string() + ".tmp");
1077                 boost::filesystem::remove (_cinemas_file);
1078                 boost::filesystem::rename (_cinemas_file.string() + ".tmp", _cinemas_file);
1079         } catch (xmlpp::exception& e) {
1080                 string s = e.what ();
1081                 trim (s);
1082                 throw FileError (s, _cinemas_file);
1083         }
1084 }
1085
1086 boost::filesystem::path
1087 Config::default_directory_or (boost::filesystem::path a) const
1088 {
1089         return directory_or (_default_directory, a);
1090 }
1091
1092 boost::filesystem::path
1093 Config::default_kdm_directory_or (boost::filesystem::path a) const
1094 {
1095         return directory_or (_default_kdm_directory, a);
1096 }
1097
1098 boost::filesystem::path
1099 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1100 {
1101         if (!dir) {
1102                 return a;
1103         }
1104
1105         boost::system::error_code ec;
1106         bool const e = boost::filesystem::exists (*dir, ec);
1107         if (ec || !e) {
1108                 return a;
1109         }
1110
1111         return *dir;
1112 }
1113
1114 void
1115 Config::drop ()
1116 {
1117         delete _instance;
1118         _instance = 0;
1119 }
1120
1121 void
1122 Config::changed (Property what)
1123 {
1124         Changed (what);
1125 }
1126
1127 void
1128 Config::set_kdm_email_to_default ()
1129 {
1130         _kdm_subject = _("KDM delivery: $CPL_NAME");
1131
1132         _kdm_email = _(
1133                 "Dear Projectionist\n\n"
1134                 "Please find attached KDMs for $CPL_NAME.\n\n"
1135                 "Cinema: $CINEMA_NAME\n"
1136                 "Screen(s): $SCREENS\n\n"
1137                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1138                 "Best regards,\nDCP-o-matic"
1139                 );
1140 }
1141
1142 void
1143 Config::set_notification_email_to_default ()
1144 {
1145         _notification_subject = _("DCP-o-matic notification");
1146
1147         _notification_email = _(
1148                 "$JOB_NAME: $JOB_STATUS"
1149                 );
1150 }
1151
1152 void
1153 Config::reset_kdm_email ()
1154 {
1155         set_kdm_email_to_default ();
1156         changed ();
1157 }
1158
1159 void
1160 Config::reset_notification_email ()
1161 {
1162         set_notification_email_to_default ();
1163         changed ();
1164 }
1165
1166 void
1167 Config::set_cover_sheet_to_default ()
1168 {
1169         _cover_sheet = _(
1170                 "$CPL_NAME\n\n"
1171                 "Type: $TYPE\n"
1172                 "Format: $CONTAINER\n"
1173                 "Audio: $AUDIO\n"
1174                 "Audio Language: $AUDIO_LANGUAGE\n"
1175                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1176                 "Length: $LENGTH\n"
1177                 "Size: $SIZE\n"
1178                 );
1179 }
1180
1181 void
1182 Config::add_to_history (boost::filesystem::path p)
1183 {
1184         add_to_history_internal (_history, p);
1185 }
1186
1187 /** Remove non-existant items from the history */
1188 void
1189 Config::clean_history ()
1190 {
1191         clean_history_internal (_history);
1192 }
1193
1194 void
1195 Config::add_to_player_history (boost::filesystem::path p)
1196 {
1197         add_to_history_internal (_player_history, p);
1198 }
1199
1200 /** Remove non-existant items from the player history */
1201 void
1202 Config::clean_player_history ()
1203 {
1204         clean_history_internal (_player_history);
1205 }
1206
1207 void
1208 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1209 {
1210         /* Remove existing instances of this path in the history */
1211         h.erase (remove (h.begin(), h.end(), p), h.end ());
1212
1213         h.insert (h.begin (), p);
1214         if (h.size() > HISTORY_SIZE) {
1215                 h.pop_back ();
1216         }
1217
1218         changed (HISTORY);
1219 }
1220
1221 void
1222 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1223 {
1224         vector<boost::filesystem::path> old = h;
1225         h.clear ();
1226         BOOST_FOREACH (boost::filesystem::path i, old) {
1227                 try {
1228                         if (boost::filesystem::is_directory(i)) {
1229                                 h.push_back (i);
1230                         }
1231                 } catch (...) {
1232                         /* We couldn't find out if it's a directory for some reason; just ignore it */
1233                 }
1234         }
1235 }
1236
1237 bool
1238 Config::have_existing (string file)
1239 {
1240         return boost::filesystem::exists (path (file, false));
1241 }
1242
1243 void
1244 Config::read_cinemas (cxml::Document const & f)
1245 {
1246         _cinemas.clear ();
1247         list<cxml::NodePtr> cin = f.node_children ("Cinema");
1248         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1249                 /* Slightly grotty two-part construction of Cinema here so that we can use
1250                    shared_from_this.
1251                 */
1252                 shared_ptr<Cinema> cinema (new Cinema (i));
1253                 cinema->read_screens (i);
1254                 _cinemas.push_back (cinema);
1255         }
1256 }
1257
1258 void
1259 Config::set_cinemas_file (boost::filesystem::path file)
1260 {
1261         if (file == _cinemas_file) {
1262                 return;
1263         }
1264
1265         _cinemas_file = file;
1266
1267         if (boost::filesystem::exists (_cinemas_file)) {
1268                 /* Existing file; read it in */
1269                 cxml::Document f ("Cinemas");
1270                 f.read_file (_cinemas_file);
1271                 read_cinemas (f);
1272         }
1273
1274         changed (OTHER);
1275 }
1276
1277 void
1278 Config::save_template (shared_ptr<const Film> film, string name) const
1279 {
1280         film->write_template (template_path (name));
1281 }
1282
1283 list<string>
1284 Config::templates () const
1285 {
1286         if (!boost::filesystem::exists (path ("templates"))) {
1287                 return list<string> ();
1288         }
1289
1290         list<string> n;
1291         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1292                 n.push_back (i->path().filename().string());
1293         }
1294         return n;
1295 }
1296
1297 bool
1298 Config::existing_template (string name) const
1299 {
1300         return boost::filesystem::exists (template_path (name));
1301 }
1302
1303 boost::filesystem::path
1304 Config::template_path (string name) const
1305 {
1306         return path("templates") / tidy_for_filename (name);
1307 }
1308
1309 void
1310 Config::rename_template (string old_name, string new_name) const
1311 {
1312         boost::filesystem::rename (template_path (old_name), template_path (new_name));
1313 }
1314
1315 void
1316 Config::delete_template (string name) const
1317 {
1318         boost::filesystem::remove (template_path (name));
1319 }
1320
1321 /** @return Path to the config.xml containing the actual settings, following a link if required */
1322 boost::filesystem::path
1323 Config::config_file ()
1324 {
1325         cxml::Document f ("Config");
1326         boost::filesystem::path main = path("config.xml", false);
1327         if (!boost::filesystem::exists (main)) {
1328                 /* It doesn't exist, so there can't be any links; just return it */
1329                 return main;
1330         }
1331
1332         /* See if there's a link */
1333         try {
1334                 f.read_file (main);
1335                 optional<string> link = f.optional_string_child("Link");
1336                 if (link) {
1337                         return *link;
1338                 }
1339         } catch (xmlpp::exception& e) {
1340                 /* There as a problem reading the main configuration file,
1341                    so there can't be a link.
1342                 */
1343         }
1344
1345         return main;
1346 }
1347
1348 void
1349 Config::reset_cover_sheet ()
1350 {
1351         set_cover_sheet_to_default ();
1352         changed ();
1353 }
1354
1355 void
1356 Config::link (boost::filesystem::path new_file) const
1357 {
1358         xmlpp::Document doc;
1359         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1360         try {
1361                 doc.write_to_file_formatted(path("config.xml", true).string());
1362         } catch (xmlpp::exception& e) {
1363                 string s = e.what ();
1364                 trim (s);
1365                 throw FileError (s, path("config.xml"));
1366         }
1367 }
1368
1369 void
1370 Config::copy_and_link (boost::filesystem::path new_file) const
1371 {
1372         write ();
1373         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1374         link (new_file);
1375 }
1376
1377 bool
1378 Config::have_write_permission () const
1379 {
1380         FILE* f = fopen_boost (config_file(), "r+");
1381         if (!f) {
1382                 return false;
1383         }
1384
1385         fclose (f);
1386         return true;
1387 }