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