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