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