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         _preview_sound = false;
 129         _preview_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 (path ("config.xml"));
 171         optional<string> c;
 172
 173         optional<int> version = f.optional_number_child<int> ("Version");
 174
 175         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 176                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 177         } else {
 178                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 179                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 180         }
 181
 182         _default_directory = f.optional_string_child ("DefaultDirectory");
 183         if (_default_directory && _default_directory->empty ()) {
 184                 /* We used to store an empty value for this to mean "none set" */
 185                 _default_directory = boost::optional<boost::filesystem::path> ();
 186         }
 187
 188         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 189         if (!b) {
 190                 b = f.optional_number_child<int> ("ServerPortBase");
 191         }
 192         _server_port_base = b.get ();
 193
 194         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 195         _use_any_servers = u.get_value_or (true);
 196
 197         list<cxml::NodePtr> servers = f.node_children ("Server");
 198         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 199                 if ((*i)->node_children("HostName").size() == 1) {
 200                         _servers.push_back ((*i)->string_child ("HostName"));
 201                 } else {
 202                         _servers.push_back ((*i)->content ());
 203                 }
 204         }
 205
 206         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 207         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 208         _tms_ip = f.string_child ("TMSIP");
 209         _tms_path = f.string_child ("TMSPath");
 210         _tms_user = f.string_child ("TMSUser");
 211         _tms_password = f.string_child ("TMSPassword");
 212
 213         c = f.optional_string_child ("SoundProcessor");
 214         if (c) {
 215                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 216         }
 217         c = f.optional_string_child ("CinemaSoundProcessor");
 218         if (c) {
 219                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 220         }
 221
 222         _language = f.optional_string_child ("Language");
 223
 224         c = f.optional_string_child ("DefaultContainer");
 225         if (c) {
 226                 _default_container = Ratio::from_id (c.get ());
 227         }
 228
 229         c = f.optional_string_child ("DefaultScaleTo");
 230         if (c) {
 231                 _default_scale_to = Ratio::from_id (c.get ());
 232         }
 233
 234         c = f.optional_string_child ("DefaultDCPContentType");
 235         if (c) {
 236                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 237         }
 238
 239         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 240
 241         if (f.optional_string_child ("DCPMetadataIssuer")) {
 242                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 243         } else if (f.optional_string_child ("DCPIssuer")) {
 244                 _dcp_issuer = f.string_child ("DCPIssuer");
 245         }
 246
 247         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 248
 249         if (version && version.get() >= 2) {
 250                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 251         } else {
 252                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 253         }
 254
 255         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 256         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 257         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 258         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 259         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 260
 261         /* Load any cinemas from config.xml */
 262         read_cinemas (f);
 263
 264         _mail_server = f.string_child ("MailServer");
 265         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 266         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 267         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 268         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 269         _kdm_from = f.string_child ("KDMFrom");
 270         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 271                 if (!i->content().empty()) {
 272                         _kdm_cc.push_back (i->content ());
 273                 }
 274         }
 275         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 276         _kdm_email = f.string_child ("KDMEmail");
 277
 278         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 279         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 280
 281         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 282         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 283
 284         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 285         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 286         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 287 #ifdef DCPOMATIC_WINDOWS
 288         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 289 #endif
 290
 291         list<cxml::NodePtr> his = f.node_children ("History");
 292         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
 293                 _history.push_back ((*i)->content ());
 294         }
 295
 296         cxml::NodePtr signer = f.optional_node_child ("Signer");
 297         if (signer) {
 298                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 299                 /* Read the signing certificates and private key in from the config file */
 300                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 301                         c->add (dcp::Certificate (i->content ()));
 302                 }
 303                 c->set_key (signer->string_child ("PrivateKey"));
 304                 _signer_chain = c;
 305         } else {
 306                 /* Make a new set of signing certificates and key */
 307                 _signer_chain = create_certificate_chain ();
 308         }
 309
 310         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 311         if (decryption) {
 312                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 313                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 314                         c->add (dcp::Certificate (i->content ()));
 315                 }
 316                 c->set_key (decryption->string_child ("PrivateKey"));
 317                 _decryption_chain = c;
 318         } else {
 319                 _decryption_chain = create_certificate_chain ();
 320         }
 321
 322         if (f.optional_node_child("DKDMGroup")) {
 323                 /* New-style: all DKDMs in a group */
 324                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 325         } else {
 326                 /* Old-style: one or more DKDM nodes */
 327                 _dkdms.reset (new DKDMGroup ("root"));
 328                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
 329                         _dkdms->add (DKDMBase::read (i));
 330                 }
 331         }
 332         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 333         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 334         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 335         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 336         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 337         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 338         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 339         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 340         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 341                 int const id = i->number_attribute<int>("Id");
 342                 if (id >= 0 && id < NAG_COUNT) {
 343                         _nagged[id] = raw_convert<int>(i->content());
 344                 }
 345         }
 346         _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
 347         _preview_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         root->add_child("Version")->add_child_text ("2");
 429         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 430         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 431         if (_default_directory) {
 432                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 433         }
 434         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 435         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 436
 437         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 438                 root->add_child("Server")->add_child_text (*i);
 439         }
 440
 441         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 442         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 443         root->add_child("TMSIP")->add_child_text (_tms_ip);
 444         root->add_child("TMSPath")->add_child_text (_tms_path);
 445         root->add_child("TMSUser")->add_child_text (_tms_user);
 446         root->add_child("TMSPassword")->add_child_text (_tms_password);
 447         if (_cinema_sound_processor) {
 448                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 449         }
 450         if (_language) {
 451                 root->add_child("Language")->add_child_text (_language.get());
 452         }
 453         if (_default_container) {
 454                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 455         }
 456         if (_default_scale_to) {
 457                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
 458         }
 459         if (_default_dcp_content_type) {
 460                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 461         }
 462         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 463         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 464         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 465
 466         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 467
 468         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 469         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 470         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 471         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 472         if (_default_kdm_directory) {
 473                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 474         }
 475         root->add_child("MailServer")->add_child_text (_mail_server);
 476         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 477         root->add_child("MailUser")->add_child_text (_mail_user);
 478         root->add_child("MailPassword")->add_child_text (_mail_password);
 479         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 480         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 481         BOOST_FOREACH (string i, _kdm_cc) {
 482                 root->add_child("KDMCC")->add_child_text (i);
 483         }
 484         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 485         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 486
 487         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 488         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 489
 490         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 491         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 492         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 493         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 494         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 495 #ifdef DCPOMATIC_WINDOWS
 496         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 497 #endif
 498
 499         xmlpp::Element* signer = root->add_child ("Signer");
 500         DCPOMATIC_ASSERT (_signer_chain);
 501         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
 502                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 503         }
 504         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 505
 506         xmlpp::Element* decryption = root->add_child ("Decryption");
 507         DCPOMATIC_ASSERT (_decryption_chain);
 508         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
 509                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 510         }
 511         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 512
 513         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
 514                 root->add_child("History")->add_child_text (i->string ());
 515         }
 516
 517         _dkdms->as_xml (root);
 518
 519         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 520         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 521         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 522         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 523         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 524         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 525         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 526         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 527         for (int i = 0; i < NAG_COUNT; ++i) {
 528                 xmlpp::Element* e = root->add_child ("Nagged");
 529                 e->set_attribute ("Id", raw_convert<string>(i));
 530                 e->add_child_text (_nagged[i] ? "1" : "0");
 531         }
 532         root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
 533         if (_preview_sound_output) {
 534                 root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
 535         }
 536         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 537
 538         try {
 539                 doc.write_to_file_formatted (path("config.xml").string ());
 540         } catch (xmlpp::exception& e) {
 541                 string s = e.what ();
 542                 trim (s);
 543                 throw FileError (s, path("config.xml"));
 544         }
 545 }
 546
 547 void
 548 Config::write_cinemas () const
 549 {
 550         xmlpp::Document doc;
 551         xmlpp::Element* root = doc.create_root_node ("Cinemas");
 552         root->add_child("Version")->add_child_text ("1");
 553
 554         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 555                 (*i)->as_xml (root->add_child ("Cinema"));
 556         }
 557
 558         try {
 559                 doc.write_to_file_formatted (_cinemas_file.string ());
 560         } catch (xmlpp::exception& e) {
 561                 string s = e.what ();
 562                 trim (s);
 563                 throw FileError (s, _cinemas_file);
 564         }
 565 }
 566
 567 boost::filesystem::path
 568 Config::default_directory_or (boost::filesystem::path a) const
 569 {
 570         return directory_or (_default_directory, a);
 571 }
 572
 573 boost::filesystem::path
 574 Config::default_kdm_directory_or (boost::filesystem::path a) const
 575 {
 576         return directory_or (_default_kdm_directory, a);
 577 }
 578
 579 boost::filesystem::path
 580 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
 581 {
 582         if (!dir) {
 583                 return a;
 584         }
 585
 586         boost::system::error_code ec;
 587         bool const e = boost::filesystem::exists (*dir, ec);
 588         if (ec || !e) {
 589                 return a;
 590         }
 591
 592         return *dir;
 593 }
 594
 595 void
 596 Config::drop ()
 597 {
 598         delete _instance;
 599         _instance = 0;
 600 }
 601
 602 void
 603 Config::changed (Property what)
 604 {
 605         Changed (what);
 606 }
 607
 608 void
 609 Config::set_kdm_email_to_default ()
 610 {
 611         _kdm_subject = _("KDM delivery: $CPL_NAME");
 612
 613         _kdm_email = _(
 614                 "Dear Projectionist\n\n"
 615                 "Please find attached KDMs for $CPL_NAME.\n\n"
 616                 "Cinema: $CINEMA_NAME\n"
 617                 "Screen(s): $SCREENS\n\n"
 618                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 619                 "Best regards,\nDCP-o-matic"
 620                 );
 621 }
 622
 623 void
 624 Config::reset_kdm_email ()
 625 {
 626         set_kdm_email_to_default ();
 627         changed ();
 628 }
 629
 630 void
 631 Config::set_cover_sheet_to_default ()
 632 {
 633         _cover_sheet = _(
 634                 "$CPL_NAME\n\n"
 635                 "Type: $TYPE\n"
 636                 "Format: $CONTAINER\n"
 637                 "Audio: $AUDIO\n"
 638                 "Length: $LENGTH\n"
 639                 );
 640 }
 641
 642 void
 643 Config::add_to_history (boost::filesystem::path p)
 644 {
 645         /* Remove existing instances of this path in the history */
 646         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
 647
 648         _history.insert (_history.begin (), p);
 649         if (_history.size() > HISTORY_SIZE) {
 650                 _history.pop_back ();
 651         }
 652
 653         changed ();
 654 }
 655
 656 bool
 657 Config::have_existing (string file)
 658 {
 659         return boost::filesystem::exists (path (file, false));
 660 }
 661
 662 void
 663 Config::read_cinemas (cxml::Document const & f)
 664 {
 665         _cinemas.clear ();
 666         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 667         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 668                 /* Slightly grotty two-part construction of Cinema here so that we can use
 669                    shared_from_this.
 670                 */
 671                 shared_ptr<Cinema> cinema (new Cinema (*i));
 672                 cinema->read_screens (*i);
 673                 _cinemas.push_back (cinema);
 674         }
 675 }
 676
 677 void
 678 Config::set_cinemas_file (boost::filesystem::path file)
 679 {
 680         _cinemas_file = file;
 681
 682         if (boost::filesystem::exists (_cinemas_file)) {
 683                 /* Existing file; read it in */
 684                 cxml::Document f ("Cinemas");
 685                 f.read_file (_cinemas_file);
 686                 read_cinemas (f);
 687         }
 688
 689         changed (OTHER);
 690 }
 691
 692 void
 693 Config::save_template (shared_ptr<const Film> film, string name) const
 694 {
 695         film->write_template (template_path (name));
 696 }
 697
 698 list<string>
 699 Config::templates () const
 700 {
 701         if (!boost::filesystem::exists (path ("templates"))) {
 702                 return list<string> ();
 703         }
 704
 705         list<string> n;
 706         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
 707                 n.push_back (i->path().filename().string());
 708         }
 709         return n;
 710 }
 711
 712 bool
 713 Config::existing_template (string name) const
 714 {
 715         return boost::filesystem::exists (template_path (name));
 716 }
 717
 718 boost::filesystem::path
 719 Config::template_path (string name) const
 720 {
 721         return path("templates") / tidy_for_filename (name);
 722 }
 723
 724 void
 725 Config::rename_template (string old_name, string new_name) const
 726 {
 727         boost::filesystem::rename (template_path (old_name), template_path (new_name));
 728 }
 729
 730 void
 731 Config::delete_template (string name) const
 732 {
 733         boost::filesystem::remove (template_path (name));
 734 }
 735
 736 /** @return Path to the config.xml, for telling the user what it is */
 737 boost::filesystem::path
 738 Config::config_path ()
 739 {
 740         return path("config.xml", false);
 741 }
 742
 743 void
 744 Config::reset_cover_sheet ()
 745 {
 746         set_cover_sheet_to_default ();
 747         changed ();
 748 }