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