src/lib/config.cc

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