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