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