src/lib/config.cc

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