src/lib/config.cc

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