src/lib/config.cc

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