src/lib/config.cc

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