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 <dcp/raw_convert.h>
  34 #include <dcp/name_format.h>
  35 #include <dcp/certificate_chain.h>
  36 #include <libcxml/cxml.h>
  37 #include <glib.h>
  38 #include <libxml++/libxml++.h>
  39 #include <boost/filesystem.hpp>
  40 #include <boost/algorithm/string.hpp>
  41 #include <boost/foreach.hpp>
  42 #include <boost/thread.hpp>
  43 #include <cstdlib>
  44 #include <fstream>
  45 #include <iostream>
  46
  47 #include "i18n.h"
  48
  49 using std::vector;
  50 using std::cout;
  51 using std::ifstream;
  52 using std::string;
  53 using std::list;
  54 using std::max;
  55 using std::remove;
  56 using std::exception;
  57 using std::cerr;
  58 using boost::shared_ptr;
  59 using boost::optional;
  60 using boost::algorithm::trim;
  61 using dcp::raw_convert;
  62
  63 Config* Config::_instance = 0;
  64 boost::signals2::signal<void ()> Config::FailedToLoad;
  65
  66 /** Construct default configuration */
  67 Config::Config ()
  68 {
  69         set_defaults ();
  70 }
  71
  72 void
  73 Config::set_defaults ()
  74 {
  75         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  76         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  77         _server_port_base = 6192;
  78         _use_any_servers = true;
  79         _servers.clear ();
  80         _only_servers_encode = false;
  81         _tms_protocol = PROTOCOL_SCP;
  82         _tms_ip = "";
  83         _tms_path = ".";
  84         _tms_user = "";
  85         _tms_password = "";
  86         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
  87         _allow_any_dcp_frame_rate = false;
  88         _language = optional<string> ();
  89         _default_still_length = 10;
  90         _default_container = Ratio::from_id ("185");
  91         _default_scale_to = 0;
  92         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
  93         _default_dcp_audio_channels = 6;
  94         _default_j2k_bandwidth = 100000000;
  95         _default_audio_delay = 0;
  96         _default_interop = true;
  97         _mail_server = "";
  98         _mail_port = 25;
  99         _mail_user = "";
 100         _mail_password = "";
 101         _kdm_from = "";
 102         _kdm_cc.clear ();
 103         _kdm_bcc = "";
 104         _check_for_updates = false;
 105         _check_for_test_updates = false;
 106         _maximum_j2k_bandwidth = 250000000;
 107         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 108         _analyse_ebur128 = true;
 109         _automatic_audio_analysis = false;
 110 #ifdef DCPOMATIC_WINDOWS
 111         _win32_console = false;
 112 #endif
 113         _cinemas_file = path ("cinemas.xml");
 114         _show_hints_before_make_dcp = true;
 115         _confirm_kdm_email = true;
 116         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
 117         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
 118         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
 119         _dcp_asset_filename_format = dcp::NameFormat ("%t");
 120         _jump_to_selected = true;
 121         for (int i = 0; i < NAG_COUNT; ++i) {
 122                 _nagged[i] = false;
 123         }
 124         _preview_sound = false;
 125         _preview_sound_output = optional<string> ();
 126
 127         _allowed_dcp_frame_rates.clear ();
 128         _allowed_dcp_frame_rates.push_back (24);
 129         _allowed_dcp_frame_rates.push_back (25);
 130         _allowed_dcp_frame_rates.push_back (30);
 131         _allowed_dcp_frame_rates.push_back (48);
 132         _allowed_dcp_frame_rates.push_back (50);
 133         _allowed_dcp_frame_rates.push_back (60);
 134
 135         set_kdm_email_to_default ();
 136         set_cover_sheet_to_default ();
 137 }
 138
 139 void
 140 Config::restore_defaults ()
 141 {
 142         Config::instance()->set_defaults ();
 143         Config::instance()->changed ();
 144 }
 145
 146 shared_ptr<dcp::CertificateChain>
 147 Config::create_certificate_chain ()
 148 {
 149         return shared_ptr<dcp::CertificateChain> (
 150                 new dcp::CertificateChain (
 151                         openssl_path(),
 152                         "dcpomatic.com",
 153                         "dcpomatic.com",
 154                         ".dcpomatic.smpte-430-2.ROOT",
 155                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 156                         "CS.dcpomatic.smpte-430-2.LEAF"
 157                         )
 158                 );
 159 }
 160
 161 void
 162 Config::read ()
 163 try
 164 {
 165         cxml::Document f ("Config");
 166         f.read_file (path ("config.xml"));
 167         optional<string> c;
 168
 169         optional<int> version = f.optional_number_child<int> ("Version");
 170
 171         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 172                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 173         } else {
 174                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 175                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 176         }
 177
 178         _default_directory = f.optional_string_child ("DefaultDirectory");
 179         if (_default_directory && _default_directory->empty ()) {
 180                 /* We used to store an empty value for this to mean "none set" */
 181                 _default_directory = boost::optional<boost::filesystem::path> ();
 182         }
 183
 184         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 185         if (!b) {
 186                 b = f.optional_number_child<int> ("ServerPortBase");
 187         }
 188         _server_port_base = b.get ();
 189
 190         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 191         _use_any_servers = u.get_value_or (true);
 192
 193         list<cxml::NodePtr> servers = f.node_children ("Server");
 194         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 195                 if ((*i)->node_children("HostName").size() == 1) {
 196                         _servers.push_back ((*i)->string_child ("HostName"));
 197                 } else {
 198                         _servers.push_back ((*i)->content ());
 199                 }
 200         }
 201
 202         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 203         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 204         _tms_ip = f.string_child ("TMSIP");
 205         _tms_path = f.string_child ("TMSPath");
 206         _tms_user = f.string_child ("TMSUser");
 207         _tms_password = f.string_child ("TMSPassword");
 208
 209         c = f.optional_string_child ("SoundProcessor");
 210         if (c) {
 211                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 212         }
 213         c = f.optional_string_child ("CinemaSoundProcessor");
 214         if (c) {
 215                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 216         }
 217
 218         _language = f.optional_string_child ("Language");
 219
 220         c = f.optional_string_child ("DefaultContainer");
 221         if (c) {
 222                 _default_container = Ratio::from_id (c.get ());
 223         }
 224
 225         c = f.optional_string_child ("DefaultScaleTo");
 226         if (c) {
 227                 _default_scale_to = Ratio::from_id (c.get ());
 228         }
 229
 230         c = f.optional_string_child ("DefaultDCPContentType");
 231         if (c) {
 232                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 233         }
 234
 235         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 236
 237         if (f.optional_string_child ("DCPMetadataIssuer")) {
 238                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 239         } else if (f.optional_string_child ("DCPIssuer")) {
 240                 _dcp_issuer = f.string_child ("DCPIssuer");
 241         }
 242
 243         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 244
 245         if (version && version.get() >= 2) {
 246                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 247         } else {
 248                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 249         }
 250
 251         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 252         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 253         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 254         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 255         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 256
 257         /* Load any cinemas from config.xml */
 258         read_cinemas (f);
 259
 260         _mail_server = f.string_child ("MailServer");
 261         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 262         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 263         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 264         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 265         _kdm_from = f.string_child ("KDMFrom");
 266         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 267                 if (!i->content().empty()) {
 268                         _kdm_cc.push_back (i->content ());
 269                 }
 270         }
 271         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 272         _kdm_email = f.string_child ("KDMEmail");
 273
 274         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 275         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 276
 277         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 278         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 279
 280         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 281         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 282         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 283 #ifdef DCPOMATIC_WINDOWS
 284         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 285 #endif
 286
 287         list<cxml::NodePtr> his = f.node_children ("History");
 288         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 289                 _history.push_back ((*i)->content ());
 290         }
 291
 292         cxml::NodePtr signer = f.optional_node_child ("Signer");
 293         if (signer) {
 294                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 295                 /* Read the signing certificates and private key in from the config file */
 296                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 297                         c->add (dcp::Certificate (i->content ()));
 298                 }
 299                 c->set_key (signer->string_child ("PrivateKey"));
 300                 _signer_chain = c;
 301         } else {
 302                 /* Make a new set of signing certificates and key */
 303                 _signer_chain = create_certificate_chain ();
 304         }
 305
 306         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 307         if (decryption) {
 308                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 309                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 310                         c->add (dcp::Certificate (i->content ()));
 311                 }
 312                 c->set_key (decryption->string_child ("PrivateKey"));
 313                 _decryption_chain = c;
 314         } else {
 315                 _decryption_chain = create_certificate_chain ();
 316         }
 317
 318         list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
 319         BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
 320                 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
 321         }
 322
 323         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 324         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 325         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 326         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 327         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 328         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 329         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 330         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 331         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 332                 int const id = i->number_attribute<int>("Id");
 333                 if (id >= 0 && id < NAG_COUNT) {
 334                         _nagged[id] = raw_convert<int>(i->content());
 335                 }
 336         }
 337         _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
 338         _preview_sound_output = f.optional_string_child("PreviewSoundOutput");
 339         if (f.optional_string_child("CoverSheet")) {
 340                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 341         }
 342
 343         /* Replace any cinemas from config.xml with those from the configured file */
 344         if (boost::filesystem::exists (_cinemas_file)) {
 345                 cxml::Document f ("Cinemas");
 346                 f.read_file (_cinemas_file);
 347                 read_cinemas (f);
 348         }
 349 }
 350 catch (...) {
 351         if (have_existing ("config.xml")) {
 352
 353                 /* Make a copy of the configuration */
 354                 try {
 355                         boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
 356                         boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
 357                 } catch (...) {}
 358
 359                 /* We have a config file but it didn't load */
 360                 FailedToLoad ();
 361         }
 362         set_defaults ();
 363         /* Make a new set of signing certificates and key */
 364         _signer_chain = create_certificate_chain ();
 365         /* And similar for decryption of KDMs */
 366         _decryption_chain = create_certificate_chain ();
 367         write ();
 368 }
 369
 370
 371 /** @return Filename to write configuration to */
 372 boost::filesystem::path
 373 Config::path (string file, bool create_directories)
 374 {
 375         boost::filesystem::path p;
 376 #ifdef DCPOMATIC_OSX
 377         p /= g_get_home_dir ();
 378         p /= "Library";
 379         p /= "Preferences";
 380         p /= "com.dcpomatic";
 381         p /= "2";
 382 #else
 383         p /= g_get_user_config_dir ();
 384         p /= "dcpomatic2";
 385 #endif
 386         boost::system::error_code ec;
 387         if (create_directories) {
 388                 boost::filesystem::create_directories (p, ec);
 389         }
 390         p /= file;
 391         return p;
 392 }
 393
 394 /** @return Singleton instance */
 395 Config *
 396 Config::instance ()
 397 {
 398         if (_instance == 0) {
 399                 _instance = new Config;
 400                 _instance->read ();
 401         }
 402
 403         return _instance;
 404 }
 405
 406 /** Write our configuration to disk */
 407 void
 408 Config::write () const
 409 {
 410         write_config ();
 411         write_cinemas ();
 412 }
 413
 414 void
 415 Config::write_config () const
 416 {
 417         xmlpp::Document doc;
 418         xmlpp::Element* root = doc.create_root_node ("Config");
 419
 420         root->add_child("Version")->add_child_text ("2");
 421         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 422         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 423         if (_default_directory) {
 424                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 425         }
 426         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 427         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 428
 429         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 430                 root->add_child("Server")->add_child_text (*i);
 431         }
 432
 433         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 434         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 435         root->add_child("TMSIP")->add_child_text (_tms_ip);
 436         root->add_child("TMSPath")->add_child_text (_tms_path);
 437         root->add_child("TMSUser")->add_child_text (_tms_user);
 438         root->add_child("TMSPassword")->add_child_text (_tms_password);
 439         if (_cinema_sound_processor) {
 440                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 441         }
 442         if (_language) {
 443                 root->add_child("Language")->add_child_text (_language.get());
 444         }
 445         if (_default_container) {
 446                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 447         }
 448         if (_default_scale_to) {
 449                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
 450         }
 451         if (_default_dcp_content_type) {
 452                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 453         }
 454         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 455         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 456         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 457
 458         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 459
 460         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 461         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 462         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 463         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 464         if (_default_kdm_directory) {
 465                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 466         }
 467         root->add_child("MailServer")->add_child_text (_mail_server);
 468         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 469         root->add_child("MailUser")->add_child_text (_mail_user);
 470         root->add_child("MailPassword")->add_child_text (_mail_password);
 471         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 472         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 473         BOOST_FOREACH (string i, _kdm_cc) {
 474                 root->add_child("KDMCC")->add_child_text (i);
 475         }
 476         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 477         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 478
 479         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 480         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 481
 482         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 483         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 484         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 485         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 486         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 487 #ifdef DCPOMATIC_WINDOWS
 488         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 489 #endif
 490
 491         xmlpp::Element* signer = root->add_child ("Signer");
 492         DCPOMATIC_ASSERT (_signer_chain);
 493         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
 494                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 495         }
 496         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 497
 498         xmlpp::Element* decryption = root->add_child ("Decryption");
 499         DCPOMATIC_ASSERT (_decryption_chain);
 500         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
 501                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 502         }
 503         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 504
 505         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 506                 root->add_child("History")->add_child_text (i->string ());
 507         }
 508
 509         BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
 510                 root->add_child("DKDM")->add_child_text (i.as_xml ());
 511         }
 512
 513         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 514         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 515         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 516         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 517         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 518         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 519         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 520         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 521         for (int i = 0; i < NAG_COUNT; ++i) {
 522                 xmlpp::Element* e = root->add_child ("Nagged");
 523                 e->set_attribute ("Id", raw_convert<string>(i));
 524                 e->add_child_text (_nagged[i] ? "1" : "0");
 525         }
 526         root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
 527         if (_preview_sound_output) {
 528                 root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
 529         }
 530         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 531
 532         try {
 533                 doc.write_to_file_formatted (path("config.xml").string ());
 534         } catch (xmlpp::exception& e) {
 535                 string s = e.what ();
 536                 trim (s);
 537                 throw FileError (s, path("config.xml"));
 538         }
 539 }
 540
 541 void
 542 Config::write_cinemas () const
 543 {
 544         xmlpp::Document doc;
 545         xmlpp::Element* root = doc.create_root_node ("Cinemas");
 546         root->add_child("Version")->add_child_text ("1");
 547
 548         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 549                 (*i)->as_xml (root->add_child ("Cinema"));
 550         }
 551
 552         try {
 553                 doc.write_to_file_formatted (_cinemas_file.string ());
 554         } catch (xmlpp::exception& e) {
 555                 string s = e.what ();
 556                 trim (s);
 557                 throw FileError (s, _cinemas_file);
 558         }
 559 }
 560
 561 boost::filesystem::path
 562 Config::default_directory_or (boost::filesystem::path a) const
 563 {
 564         return directory_or (_default_directory, a);
 565 }
 566
 567 boost::filesystem::path
 568 Config::default_kdm_directory_or (boost::filesystem::path a) const
 569 {
 570         return directory_or (_default_kdm_directory, a);
 571 }
 572
 573 boost::filesystem::path
 574 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
 575 {
 576         if (!dir) {
 577                 return a;
 578         }
 579
 580         boost::system::error_code ec;
 581         bool const e = boost::filesystem::exists (*dir, ec);
 582         if (ec || !e) {
 583                 return a;
 584         }
 585
 586         return *dir;
 587 }
 588
 589 void
 590 Config::drop ()
 591 {
 592         delete _instance;
 593         _instance = 0;
 594 }
 595
 596 void
 597 Config::changed (Property what)
 598 {
 599         Changed (what);
 600 }
 601
 602 void
 603 Config::set_kdm_email_to_default ()
 604 {
 605         _kdm_subject = _("KDM delivery: $CPL_NAME");
 606
 607         _kdm_email = _(
 608                 "Dear Projectionist\n\n"
 609                 "Please find attached KDMs for $CPL_NAME.\n\n"
 610                 "Cinema: $CINEMA_NAME\n"
 611                 "Screen(s): $SCREENS\n\n"
 612                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 613                 "Best regards,\nDCP-o-matic"
 614                 );
 615 }
 616
 617 void
 618 Config::reset_kdm_email ()
 619 {
 620         set_kdm_email_to_default ();
 621         changed ();
 622 }
 623
 624 void
 625 Config::set_cover_sheet_to_default ()
 626 {
 627         _cover_sheet = _(
 628                 "$CPL_NAME\n\n"
 629                 "Type: $TYPE\n"
 630                 "Format: $CONTAINER\n"
 631                 "Audio: $AUDIO\n"
 632                 "Length: $LENGTH\n"
 633                 );
 634 }
 635
 636 void
 637 Config::add_to_history (boost::filesystem::path p)
 638 {
 639         /* Remove existing instances of this path in the history */
 640         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 641
 642         _history.insert (_history.begin (), p);
 643         if (_history.size() > HISTORY_SIZE) {
 644                 _history.pop_back ();
 645         }
 646
 647         changed ();
 648 }
 649
 650 bool
 651 Config::have_existing (string file)
 652 {
 653         return boost::filesystem::exists (path (file, false));
 654 }
 655
 656 void
 657 Config::read_cinemas (cxml::Document const & f)
 658 {
 659         _cinemas.clear ();
 660         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 661         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 662                 /* Slightly grotty two-part construction of Cinema here so that we can use
 663                    shared_from_this.
 664                 */
 665                 shared_ptr<Cinema> cinema (new Cinema (*i));
 666                 cinema->read_screens (*i);
 667                 _cinemas.push_back (cinema);
 668         }
 669 }
 670
 671 void
 672 Config::set_cinemas_file (boost::filesystem::path file)
 673 {
 674         _cinemas_file = file;
 675
 676         if (boost::filesystem::exists (_cinemas_file)) {
 677                 /* Existing file; read it in */
 678                 cxml::Document f ("Cinemas");
 679                 f.read_file (_cinemas_file);
 680                 read_cinemas (f);
 681         }
 682
 683         changed (OTHER);
 684 }
 685
 686 void
 687 Config::save_template (shared_ptr<const Film> film, string name) const
 688 {
 689         film->write_template (template_path (name));
 690 }
 691
 692 list<string>
 693 Config::templates () const
 694 {
 695         if (!boost::filesystem::exists (path ("templates"))) {
 696                 return list<string> ();
 697         }
 698
 699         list<string> n;
 700         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
 701                 n.push_back (i->path().filename().string());
 702         }
 703         return n;
 704 }
 705
 706 bool
 707 Config::existing_template (string name) const
 708 {
 709         return boost::filesystem::exists (template_path (name));
 710 }
 711
 712 boost::filesystem::path
 713 Config::template_path (string name) const
 714 {
 715         return path("templates") / tidy_for_filename (name);
 716 }
 717
 718 void
 719 Config::rename_template (string old_name, string new_name) const
 720 {
 721         boost::filesystem::rename (template_path (old_name), template_path (new_name));
 722 }
 723
 724 void
 725 Config::delete_template (string name) const
 726 {
 727         boost::filesystem::remove (template_path (name));
 728 }
 729
 730 /** @return Path to the config.xml, for telling the user what it is */
 731 boost::filesystem::path
 732 Config::config_path ()
 733 {
 734         return path("config.xml", false);
 735 }
 736
 737 void
 738 Config::reset_cover_sheet ()
 739 {
 740         set_cover_sheet_to_default ();
 741         changed ();
 742 }