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