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