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