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