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