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