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