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