src/lib/config.cc

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