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