src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2018 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 "compose.hpp"
  35 #include <dcp/raw_convert.h>
  36 #include <dcp/name_format.h>
  37 #include <dcp/certificate_chain.h>
  38 #include <libcxml/cxml.h>
  39 #include <glib.h>
  40 #include <libxml++/libxml++.h>
  41 #include <boost/filesystem.hpp>
  42 #include <boost/algorithm/string.hpp>
  43 #include <boost/foreach.hpp>
  44 #include <boost/thread.hpp>
  45 #include <cstdlib>
  46 #include <fstream>
  47 #include <iostream>
  48
  49 #include "i18n.h"
  50
  51 using std::vector;
  52 using std::cout;
  53 using std::ifstream;
  54 using std::string;
  55 using std::list;
  56 using std::max;
  57 using std::remove;
  58 using std::exception;
  59 using std::cerr;
  60 using boost::shared_ptr;
  61 using boost::optional;
  62 using boost::dynamic_pointer_cast;
  63 using boost::algorithm::trim;
  64 using dcp::raw_convert;
  65
  66 Config* Config::_instance = 0;
  67 int const Config::_current_version = 3;
  68 boost::signals2::signal<void ()> Config::FailedToLoad;
  69 boost::signals2::signal<void (string)> Config::Warning;
  70 boost::signals2::signal<bool (void)> Config::BadSignerChain;
  71 boost::optional<boost::filesystem::path> Config::override_path;
  72
  73 /** Construct default configuration */
  74 Config::Config ()
  75         /* DKDMs are not considered a thing to reset on set_defaults() */
  76         : _dkdms (new DKDMGroup ("root"))
  77 {
  78         set_defaults ();
  79 }
  80
  81 void
  82 Config::set_defaults ()
  83 {
  84         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  85         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
  86         _server_port_base = 6192;
  87         _use_any_servers = true;
  88         _servers.clear ();
  89         _only_servers_encode = false;
  90         _tms_protocol = PROTOCOL_SCP;
  91         _tms_ip = "";
  92         _tms_path = ".";
  93         _tms_user = "";
  94         _tms_password = "";
  95         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
  96         _allow_any_dcp_frame_rate = false;
  97         _allow_any_container = false;
  98         _language = optional<string> ();
  99         _default_still_length = 10;
 100         _default_container = Ratio::from_id ("185");
 101         _default_scale_to = 0;
 102         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
 103         _default_dcp_audio_channels = 6;
 104         _default_j2k_bandwidth = 100000000;
 105         _default_audio_delay = 0;
 106         _default_interop = true;
 107         _default_upload_after_make_dcp = false;
 108         _mail_server = "";
 109         _mail_port = 25;
 110         _mail_user = "";
 111         _mail_password = "";
 112         _kdm_from = "";
 113         _kdm_cc.clear ();
 114         _kdm_bcc = "";
 115         _notification_from = "";
 116         _notification_to = "";
 117         _notification_cc.clear ();
 118         _notification_bcc = "";
 119         _check_for_updates = false;
 120         _check_for_test_updates = false;
 121         _maximum_j2k_bandwidth = 250000000;
 122         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
 123         _analyse_ebur128 = true;
 124         _automatic_audio_analysis = false;
 125 #ifdef DCPOMATIC_WINDOWS
 126         _win32_console = false;
 127 #endif
 128         _cinemas_file = path ("cinemas.xml");
 129         _show_hints_before_make_dcp = true;
 130         _confirm_kdm_email = true;
 131         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
 132         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
 133         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
 134         _dcp_asset_filename_format = dcp::NameFormat ("%t");
 135         _jump_to_selected = true;
 136         for (int i = 0; i < NAG_COUNT; ++i) {
 137                 _nagged[i] = false;
 138         }
 139         _sound = true;
 140         _sound_output = optional<string> ();
 141         _last_kdm_write_type = KDM_WRITE_FLAT;
 142         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 143
 144         /* I think the scaling factor here should be the ratio of the longest frame
 145            encode time to the shortest; if the thread count is T, longest time is L
 146            and the shortest time S we could encode L/S frames per thread whilst waiting
 147            for the L frame to encode so we might have to store LT/S frames.
 148
 149            However we don't want to use too much memory, so keep it a bit lower than we'd
 150            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
 151            use about 240Mb with 72 encoding threads.
 152         */
 153         _frames_in_memory_multiplier = 3;
 154         _decode_reduction = optional<int>();
 155         _default_notify = false;
 156         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 157                 _notification[i] = false;
 158         }
 159         _barco_username = optional<string>();
 160         _barco_password = optional<string>();
 161         _christie_username = optional<string>();
 162         _christie_password = optional<string>();
 163         _gdc_username = optional<string>();
 164         _gdc_password = optional<string>();
 165         _interface_complexity = INTERFACE_SIMPLE;
 166
 167         _allowed_dcp_frame_rates.clear ();
 168         _allowed_dcp_frame_rates.push_back (24);
 169         _allowed_dcp_frame_rates.push_back (25);
 170         _allowed_dcp_frame_rates.push_back (30);
 171         _allowed_dcp_frame_rates.push_back (48);
 172         _allowed_dcp_frame_rates.push_back (50);
 173         _allowed_dcp_frame_rates.push_back (60);
 174
 175         set_kdm_email_to_default ();
 176         set_notification_email_to_default ();
 177         set_cover_sheet_to_default ();
 178 }
 179
 180 void
 181 Config::restore_defaults ()
 182 {
 183         Config::instance()->set_defaults ();
 184         Config::instance()->changed ();
 185 }
 186
 187 shared_ptr<dcp::CertificateChain>
 188 Config::create_certificate_chain ()
 189 {
 190         return shared_ptr<dcp::CertificateChain> (
 191                 new dcp::CertificateChain (
 192                         openssl_path(),
 193                         "dcpomatic.com",
 194                         "dcpomatic.com",
 195                         ".dcpomatic.smpte-430-2.ROOT",
 196                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
 197                         "CS.dcpomatic.smpte-430-2.LEAF"
 198                         )
 199                 );
 200 }
 201
 202 void
 203 Config::backup ()
 204 {
 205         /* Make a copy of the configuration */
 206         try {
 207                 int n = 1;
 208                 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
 209                         ++n;
 210                 }
 211
 212                 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
 213                 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
 214         } catch (...) {}
 215 }
 216
 217 void
 218 Config::read ()
 219 try
 220 {
 221         cxml::Document f ("Config");
 222         f.read_file (config_file ());
 223
 224         optional<int> version = f.optional_number_child<int> ("Version");
 225         if (version && *version < _current_version) {
 226                 /* Back up the old config before we re-write it in a back-incompatible way */
 227                 backup ();
 228         }
 229
 230         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
 231                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
 232         } else {
 233                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
 234                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
 235         }
 236
 237         _default_directory = f.optional_string_child ("DefaultDirectory");
 238         if (_default_directory && _default_directory->empty ()) {
 239                 /* We used to store an empty value for this to mean "none set" */
 240                 _default_directory = boost::optional<boost::filesystem::path> ();
 241         }
 242
 243         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 244         if (!b) {
 245                 b = f.optional_number_child<int> ("ServerPortBase");
 246         }
 247         _server_port_base = b.get ();
 248
 249         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 250         _use_any_servers = u.get_value_or (true);
 251
 252         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
 253                 if (i->node_children("HostName").size() == 1) {
 254                         _servers.push_back (i->string_child ("HostName"));
 255                 } else {
 256                         _servers.push_back (i->content ());
 257                 }
 258         }
 259
 260         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
 261         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
 262         _tms_ip = f.string_child ("TMSIP");
 263         _tms_path = f.string_child ("TMSPath");
 264         _tms_user = f.string_child ("TMSUser");
 265         _tms_password = f.string_child ("TMSPassword");
 266
 267         optional<string> c;
 268         c = f.optional_string_child ("SoundProcessor");
 269         if (c) {
 270                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 271         }
 272         c = f.optional_string_child ("CinemaSoundProcessor");
 273         if (c) {
 274                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 275         }
 276
 277         _language = f.optional_string_child ("Language");
 278
 279         c = f.optional_string_child ("DefaultContainer");
 280         if (c) {
 281                 _default_container = Ratio::from_id (c.get ());
 282         }
 283
 284         if (_default_container && !_default_container->used_for_container()) {
 285                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
 286                 _default_container = Ratio::from_id ("185");
 287         }
 288
 289         c = f.optional_string_child ("DefaultScaleTo");
 290         if (c) {
 291                 _default_scale_to = Ratio::from_id (c.get ());
 292         }
 293
 294         _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
 295         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
 296
 297         if (f.optional_string_child ("DCPMetadataIssuer")) {
 298                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
 299         } else if (f.optional_string_child ("DCPIssuer")) {
 300                 _dcp_issuer = f.string_child ("DCPIssuer");
 301         }
 302
 303         _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
 304         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
 305
 306         if (version && version.get() >= 2) {
 307                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 308         } else {
 309                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 310         }
 311
 312         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 313         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 314         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 315         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 316         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 317
 318         /* Load any cinemas from config.xml */
 319         read_cinemas (f);
 320
 321         _mail_server = f.string_child ("MailServer");
 322         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
 323         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 324         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 325
 326         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 327         _kdm_from = f.string_child ("KDMFrom");
 328         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
 329                 if (!i->content().empty()) {
 330                         _kdm_cc.push_back (i->content ());
 331                 }
 332         }
 333         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
 334         _kdm_email = f.string_child ("KDMEmail");
 335
 336         _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
 337         _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
 338         _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
 339         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
 340                 if (!i->content().empty()) {
 341                         _notification_cc.push_back (i->content ());
 342                 }
 343         }
 344         _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
 345         if (f.optional_string_child("NotificationEmail")) {
 346                 _notification_email = f.string_child("NotificationEmail");
 347         }
 348
 349         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 350         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 351
 352         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 353         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 354         _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 355
 356         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
 357         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
 358         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 359 #ifdef DCPOMATIC_WINDOWS
 360         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 361 #endif
 362
 363         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
 364                 _history.push_back (i->content ());
 365         }
 366
 367         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
 368                 _player_history.push_back (i->content ());
 369         }
 370
 371         cxml::NodePtr signer = f.optional_node_child ("Signer");
 372         if (signer) {
 373                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 374                 /* Read the signing certificates and private key in from the config file */
 375                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
 376                         c->add (dcp::Certificate (i->content ()));
 377                 }
 378                 c->set_key (signer->string_child ("PrivateKey"));
 379                 _signer_chain = c;
 380         } else {
 381                 /* Make a new set of signing certificates and key */
 382                 _signer_chain = create_certificate_chain ();
 383         }
 384
 385         /* These must be done before we call BadSignerChain as that might set one
 386            of the nags.
 387         */
 388         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
 389                 int const id = i->number_attribute<int>("Id");
 390                 if (id >= 0 && id < NAG_COUNT) {
 391                         _nagged[id] = raw_convert<int>(i->content());
 392                 }
 393         }
 394
 395         bool bad_signer_chain = false;
 396         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 397                 if (i.has_utf8_strings()) {
 398                         bad_signer_chain = true;
 399                 }
 400         }
 401
 402         if (bad_signer_chain) {
 403                 optional<bool> const remake = BadSignerChain();
 404                 if (remake && *remake) {
 405                         _signer_chain = create_certificate_chain ();
 406                 }
 407         }
 408
 409         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 410         if (decryption) {
 411                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
 412                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
 413                         c->add (dcp::Certificate (i->content ()));
 414                 }
 415                 c->set_key (decryption->string_child ("PrivateKey"));
 416                 _decryption_chain = c;
 417         } else {
 418                 _decryption_chain = create_certificate_chain ();
 419         }
 420
 421         if (f.optional_node_child("DKDMGroup")) {
 422                 /* New-style: all DKDMs in a group */
 423                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
 424         } else {
 425                 /* Old-style: one or more DKDM nodes */
 426                 _dkdms.reset (new DKDMGroup ("root"));
 427                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
 428                         _dkdms->add (DKDMBase::read (i));
 429                 }
 430         }
 431         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 432         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
 433         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
 434         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
 435         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
 436         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
 437         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
 438         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
 439         /* The variable was renamed but not the XML tag */
 440         _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
 441         _sound_output = f.optional_string_child("PreviewSoundOutput");
 442         if (f.optional_string_child("CoverSheet")) {
 443                 _cover_sheet = f.optional_string_child("CoverSheet").get();
 444         }
 445         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
 446         if (f.optional_string_child("LastKDMWriteType")) {
 447                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
 448                         _last_kdm_write_type = KDM_WRITE_FLAT;
 449                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
 450                         _last_kdm_write_type = KDM_WRITE_FOLDER;
 451                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
 452                         _last_kdm_write_type = KDM_WRITE_ZIP;
 453                 }
 454         }
 455         if (f.optional_string_child("LastDKDMWriteType")) {
 456                 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
 457                         _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
 458                 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
 459                         _last_dkdm_write_type = DKDM_WRITE_FILE;
 460                 }
 461         }
 462         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
 463         _decode_reduction = f.optional_number_child<int>("DecodeReduction");
 464         _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
 465
 466         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
 467                 int const id = i->number_attribute<int>("Id");
 468                 if (id >= 0 && id < NOTIFICATION_COUNT) {
 469                         _notification[id] = raw_convert<int>(i->content());
 470                 }
 471         }
 472
 473         _barco_username = f.optional_string_child("BarcoUsername");
 474         _barco_password = f.optional_string_child("BarcoPassword");
 475         _christie_username = f.optional_string_child("ChristieUsername");
 476         _christie_password = f.optional_string_child("ChristiePassword");
 477         _gdc_username = f.optional_string_child("GDCUsername");
 478         _gdc_password = f.optional_string_child("GDCPassword");
 479
 480         optional<string> ic = f.optional_string_child("InterfaceComplexity");
 481         if (ic && *ic == "full") {
 482                 _interface_complexity = INTERFACE_FULL;
 483         }
 484
 485         /* Replace any cinemas from config.xml with those from the configured file */
 486         if (boost::filesystem::exists (_cinemas_file)) {
 487                 cxml::Document f ("Cinemas");
 488                 f.read_file (_cinemas_file);
 489                 read_cinemas (f);
 490         }
 491 }
 492 catch (...) {
 493         if (have_existing ("config.xml")) {
 494                 backup ();
 495                 /* We have a config file but it didn't load */
 496                 FailedToLoad ();
 497         }
 498         set_defaults ();
 499         /* Make a new set of signing certificates and key */
 500         _signer_chain = create_certificate_chain ();
 501         /* And similar for decryption of KDMs */
 502         _decryption_chain = create_certificate_chain ();
 503         write ();
 504 }
 505
 506 /** @return Filename to write configuration to */
 507 boost::filesystem::path
 508 Config::path (string file, bool create_directories)
 509 {
 510         boost::filesystem::path p;
 511         if (override_path) {
 512                 p = *override_path;
 513         } else {
 514 #ifdef DCPOMATIC_OSX
 515                 p /= g_get_home_dir ();
 516                 p /= "Library";
 517                 p /= "Preferences";
 518                 p /= "com.dcpomatic";
 519                 p /= "2";
 520 #else
 521                 p /= g_get_user_config_dir ();
 522                 p /= "dcpomatic2";
 523 #endif
 524         }
 525         boost::system::error_code ec;
 526         if (create_directories) {
 527                 boost::filesystem::create_directories (p, ec);
 528         }
 529         p /= file;
 530         return p;
 531 }
 532
 533 /** @return Singleton instance */
 534 Config *
 535 Config::instance ()
 536 {
 537         if (_instance == 0) {
 538                 _instance = new Config;
 539                 _instance->read ();
 540         }
 541
 542         return _instance;
 543 }
 544
 545 /** Write our configuration to disk */
 546 void
 547 Config::write () const
 548 {
 549         write_config ();
 550         write_cinemas ();
 551 }
 552
 553 void
 554 Config::write_config () const
 555 {
 556         xmlpp::Document doc;
 557         xmlpp::Element* root = doc.create_root_node ("Config");
 558
 559         /* [XML] Version The version number of the configuration file format */
 560         root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
 561         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
 562         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
 563         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
 564         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
 565         if (_default_directory) {
 566                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
 567                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
 568         }
 569         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
 570            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
 571            by the batch converter to listen for job requests.
 572         */
 573         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 574         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
 575         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 576
 577         BOOST_FOREACH (string i, _servers) {
 578                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
 579                    as you like.
 580                 */
 581                 root->add_child("Server")->add_child_text (i);
 582         }
 583
 584         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
 585            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
 586         */
 587         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
 588         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
 589         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
 590         /* [XML] TMSIP IP address of TMS */
 591         root->add_child("TMSIP")->add_child_text (_tms_ip);
 592         /* [XML] TMSPath Path on the TMS to copy files to */
 593         root->add_child("TMSPath")->add_child_text (_tms_path);
 594         /* [XML] TMSUser Username to log into the TMS with */
 595         root->add_child("TMSUser")->add_child_text (_tms_user);
 596         /* [XML] TMSPassword Password to log into the TMS with */
 597         root->add_child("TMSPassword")->add_child_text (_tms_password);
 598         if (_cinema_sound_processor) {
 599                 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
 600                    gain changes from fader positions.  Currently can only be <code>dolby_cp750</code>.
 601                 */
 602                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 603         }
 604         if (_language) {
 605                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
 606                 root->add_child("Language")->add_child_text (_language.get());
 607         }
 608         if (_default_container) {
 609                 /* [XML:opt] DefaultContainer ID of default container
 610                  * to use when creating new films (<code>185</code>,<code>239</code> or
 611                  * <code>190</code>).
 612                 */
 613                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 614         }
 615         if (_default_scale_to) {
 616                 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
 617                    (see <code>DefaultContainer</code> for IDs).
 618                 */
 619                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
 620         }
 621         if (_default_dcp_content_type) {
 622                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
 623                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
 624                    <code>PSA</code> or <code>ADV</code>). */
 625                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 626         }
 627         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
 628         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
 629         /* [XML] DCPIssuer Issuer text to write into CPL files. */
 630         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
 631         /* [XML] DCPIssuer Creator text to write into CPL files. */
 632         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 633         root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
 634
 635         /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
 636            <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
 637            <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
 638            <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
 639            <code>&lt;MasteredLuminance&gt;</code>.
 640         */
 641         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 642
 643         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
 644         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 645         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
 646         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 647         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
 648         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 649         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
 650         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
 651         if (_default_kdm_directory) {
 652                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
 653                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
 654         }
 655         /* [XML] MailServer Hostname of SMTP server to use. */
 656         root->add_child("MailServer")->add_child_text (_mail_server);
 657         /* [XML] MailPort Port number to use on SMTP server. */
 658         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
 659         /* [XML] MailUser Username to use on SMTP server. */
 660         root->add_child("MailUser")->add_child_text (_mail_user);
 661         /* [XML] MailPassword Password to use on SMTP server. */
 662         root->add_child("MailPassword")->add_child_text (_mail_password);
 663
 664         /* [XML] KDMSubject Subject to use for KDM emails. */
 665         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 666         /* [XML] KDMFrom From address to use for KDM emails. */
 667         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 668         BOOST_FOREACH (string i, _kdm_cc) {
 669                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
 670                 root->add_child("KDMCC")->add_child_text (i);
 671         }
 672         /* [XML] KDMBCC BCC address to use for KDM emails */
 673         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
 674         /* [XML] KDMEmail Text of KDM email */
 675         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 676
 677         /* [XML] NotificationSubject Subject to use for Notification emails. */
 678         root->add_child("NotificationSubject")->add_child_text (_notification_subject);
 679         /* [XML] NotificationFrom From address to use for Notification emails. */
 680         root->add_child("NotificationFrom")->add_child_text (_notification_from);
 681         /* [XML] NotificationFrom To address to use for Notification emails. */
 682         root->add_child("NotificationTo")->add_child_text (_notification_to);
 683         BOOST_FOREACH (string i, _notification_cc) {
 684                 /* [XML] NotificationCC CC address to use for Notification emails; you can use as many of these tags as you like. */
 685                 root->add_child("NotificationCC")->add_child_text (i);
 686         }
 687         /* [XML] NotificationBCC BCC address to use for Notification emails */
 688         root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
 689         /* [XML] NotificationEmail Text of Notification email */
 690         root->add_child("NotificationEmail")->add_child_text (_notification_email);
 691
 692         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
 693         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 694         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
 695         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 696
 697         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
 698         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 699         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
 700         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 701         /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers */
 702         root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
 703         /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
 704            to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
 705            to sending email.
 706         */
 707         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 708         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
 709         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
 710         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
 711         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 712 #ifdef DCPOMATIC_WINDOWS
 713         /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
 714         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 715 #endif
 716
 717         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
 718            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
 719         */
 720         xmlpp::Element* signer = root->add_child ("Signer");
 721         DCPOMATIC_ASSERT (_signer_chain);
 722         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
 723                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
 724         }
 725         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 726
 727         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
 728         xmlpp::Element* decryption = root->add_child ("Decryption");
 729         DCPOMATIC_ASSERT (_decryption_chain);
 730         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
 731                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
 732         }
 733         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 734
 735         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
 736            of these tags.
 737         */
 738         BOOST_FOREACH (boost::filesystem::path i, _history) {
 739                 root->add_child("History")->add_child_text (i.string ());
 740         }
 741
 742         BOOST_FOREACH (boost::filesystem::path i, _player_history) {
 743                 root->add_child("PlayerHistory")->add_child_text (i.string ());
 744         }
 745
 746         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
 747            or <code>&lt;DKDM&gt;</code> tags.
 748         */
 749         /* [XML] DKDM A DKDM as XML */
 750         _dkdms->as_xml (root);
 751
 752         /* [XML] CinemasFile Filename of cinemas list file */
 753         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
 754         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
 755         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
 756         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
 757         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
 758         /* [XML] KDMFilenameFormat Format for KDM filenames */
 759         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
 760         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
 761         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
 762         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
 763         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
 764         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
 765         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
 766         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
 767         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
 768         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
 769         for (int i = 0; i < NAG_COUNT; ++i) {
 770                 xmlpp::Element* e = root->add_child ("Nagged");
 771                 e->set_attribute ("Id", raw_convert<string>(i));
 772                 e->add_child_text (_nagged[i] ? "1" : "0");
 773         }
 774         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
 775         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
 776         if (_sound_output) {
 777                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
 778                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
 779         }
 780         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
 781         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 782         if (_last_player_load_directory) {
 783                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
 784         }
 785         if (_last_kdm_write_type) {
 786                 switch (_last_kdm_write_type.get()) {
 787                 case KDM_WRITE_FLAT:
 788                         root->add_child("LastKDMWriteType")->add_child_text("flat");
 789                         break;
 790                 case KDM_WRITE_FOLDER:
 791                         root->add_child("LastKDMWriteType")->add_child_text("folder");
 792                         break;
 793                 case KDM_WRITE_ZIP:
 794                         root->add_child("LastKDMWriteType")->add_child_text("zip");
 795                         break;
 796                 }
 797         }
 798         if (_last_dkdm_write_type) {
 799                 switch (_last_dkdm_write_type.get()) {
 800                 case DKDM_WRITE_INTERNAL:
 801                         root->add_child("LastDKDMWriteType")->add_child_text("internal");
 802                         break;
 803                 case DKDM_WRITE_FILE:
 804                         root->add_child("LastDKDMWriteType")->add_child_text("file");
 805                         break;
 806                 }
 807         }
 808         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
 809            frames to be held in memory at once.
 810         */
 811         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
 812
 813         /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
 814         if (_decode_reduction) {
 815                 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
 816         }
 817
 818         /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0 */
 819         root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
 820
 821         /* [XML] Notification 1 if a notification type is enabled, otherwise 0 */
 822         for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
 823                 xmlpp::Element* e = root->add_child ("Notification");
 824                 e->set_attribute ("Id", raw_convert<string>(i));
 825                 e->add_child_text (_notification[i] ? "1" : "0");
 826         }
 827
 828         if (_barco_username) {
 829                 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
 830         }
 831         if (_barco_password) {
 832                 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
 833         }
 834
 835         if (_christie_username) {
 836                 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
 837         }
 838         if (_christie_password) {
 839                 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
 840         }
 841
 842         if (_gdc_username) {
 843                 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
 844         }
 845         if (_gdc_password) {
 846                 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
 847         }
 848
 849         switch (_interface_complexity) {
 850         case INTERFACE_SIMPLE:
 851                 root->add_child("InterfaceComplexity")->add_child_text("simple");
 852                 break;
 853         case INTERFACE_FULL:
 854                 root->add_child("InterfaceComplexity")->add_child_text("full");
 855                 break;
 856         }
 857
 858         try {
 859                 doc.write_to_file_formatted(config_file().string());
 860         } catch (xmlpp::exception& e) {
 861                 string s = e.what ();
 862                 trim (s);
 863                 throw FileError (s, path("config.xml"));
 864         }
 865 }
 866
 867 void
 868 Config::write_cinemas () const
 869 {
 870         xmlpp::Document doc;
 871         xmlpp::Element* root = doc.create_root_node ("Cinemas");
 872         root->add_child("Version")->add_child_text ("1");
 873
 874         BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
 875                 i->as_xml (root->add_child ("Cinema"));
 876         }
 877
 878         try {
 879                 doc.write_to_file_formatted (_cinemas_file.string ());
 880         } catch (xmlpp::exception& e) {
 881                 string s = e.what ();
 882                 trim (s);
 883                 throw FileError (s, _cinemas_file);
 884         }
 885 }
 886
 887 boost::filesystem::path
 888 Config::default_directory_or (boost::filesystem::path a) const
 889 {
 890         return directory_or (_default_directory, a);
 891 }
 892
 893 boost::filesystem::path
 894 Config::default_kdm_directory_or (boost::filesystem::path a) const
 895 {
 896         return directory_or (_default_kdm_directory, a);
 897 }
 898
 899 boost::filesystem::path
 900 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
 901 {
 902         if (!dir) {
 903                 return a;
 904         }
 905
 906         boost::system::error_code ec;
 907         bool const e = boost::filesystem::exists (*dir, ec);
 908         if (ec || !e) {
 909                 return a;
 910         }
 911
 912         return *dir;
 913 }
 914
 915 void
 916 Config::drop ()
 917 {
 918         delete _instance;
 919         _instance = 0;
 920 }
 921
 922 void
 923 Config::changed (Property what)
 924 {
 925         Changed (what);
 926 }
 927
 928 void
 929 Config::set_kdm_email_to_default ()
 930 {
 931         _kdm_subject = _("KDM delivery: $CPL_NAME");
 932
 933         _kdm_email = _(
 934                 "Dear Projectionist\n\n"
 935                 "Please find attached KDMs for $CPL_NAME.\n\n"
 936                 "Cinema: $CINEMA_NAME\n"
 937                 "Screen(s): $SCREENS\n\n"
 938                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 939                 "Best regards,\nDCP-o-matic"
 940                 );
 941 }
 942
 943 void
 944 Config::set_notification_email_to_default ()
 945 {
 946         _notification_subject = _("DCP-o-matic notification");
 947
 948         _notification_email = _(
 949                 "$JOB_NAME: $JOB_STATUS"
 950                 );
 951 }
 952
 953 void
 954 Config::reset_kdm_email ()
 955 {
 956         set_kdm_email_to_default ();
 957         changed ();
 958 }
 959
 960 void
 961 Config::reset_notification_email ()
 962 {
 963         set_notification_email_to_default ();
 964         changed ();
 965 }
 966
 967 void
 968 Config::set_cover_sheet_to_default ()
 969 {
 970         _cover_sheet = _(
 971                 "$CPL_NAME\n\n"
 972                 "Type: $TYPE\n"
 973                 "Format: $CONTAINER\n"
 974                 "Audio: $AUDIO\n"
 975                 "Audio Language: $AUDIO_LANGUAGE\n"
 976                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
 977                 "Length: $LENGTH\n"
 978                 "Size: $SIZE\n"
 979                 );
 980 }
 981
 982 void
 983 Config::add_to_history (boost::filesystem::path p)
 984 {
 985         add_to_history_internal (_history, p);
 986 }
 987
 988 void
 989 Config::add_to_player_history (boost::filesystem::path p)
 990 {
 991         add_to_history_internal (_player_history, p);
 992 }
 993
 994 void
 995 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
 996 {
 997         /* Remove existing instances of this path in the history */
 998         h.erase (remove (h.begin(), h.end(), p), h.end ());
 999
1000         h.insert (h.begin (), p);
1001         if (h.size() > HISTORY_SIZE) {
1002                 h.pop_back ();
1003         }
1004
1005         changed ();
1006 }
1007
1008 bool
1009 Config::have_existing (string file)
1010 {
1011         return boost::filesystem::exists (path (file, false));
1012 }
1013
1014 void
1015 Config::read_cinemas (cxml::Document const & f)
1016 {
1017         _cinemas.clear ();
1018         list<cxml::NodePtr> cin = f.node_children ("Cinema");
1019         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1020                 /* Slightly grotty two-part construction of Cinema here so that we can use
1021                    shared_from_this.
1022                 */
1023                 shared_ptr<Cinema> cinema (new Cinema (i));
1024                 cinema->read_screens (i);
1025                 _cinemas.push_back (cinema);
1026         }
1027 }
1028
1029 void
1030 Config::set_cinemas_file (boost::filesystem::path file)
1031 {
1032         if (file == _cinemas_file) {
1033                 return;
1034         }
1035
1036         _cinemas_file = file;
1037
1038         if (boost::filesystem::exists (_cinemas_file)) {
1039                 /* Existing file; read it in */
1040                 cxml::Document f ("Cinemas");
1041                 f.read_file (_cinemas_file);
1042                 read_cinemas (f);
1043         }
1044
1045         changed (OTHER);
1046 }
1047
1048 void
1049 Config::save_template (shared_ptr<const Film> film, string name) const
1050 {
1051         film->write_template (template_path (name));
1052 }
1053
1054 list<string>
1055 Config::templates () const
1056 {
1057         if (!boost::filesystem::exists (path ("templates"))) {
1058                 return list<string> ();
1059         }
1060
1061         list<string> n;
1062         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1063                 n.push_back (i->path().filename().string());
1064         }
1065         return n;
1066 }
1067
1068 bool
1069 Config::existing_template (string name) const
1070 {
1071         return boost::filesystem::exists (template_path (name));
1072 }
1073
1074 boost::filesystem::path
1075 Config::template_path (string name) const
1076 {
1077         return path("templates") / tidy_for_filename (name);
1078 }
1079
1080 void
1081 Config::rename_template (string old_name, string new_name) const
1082 {
1083         boost::filesystem::rename (template_path (old_name), template_path (new_name));
1084 }
1085
1086 void
1087 Config::delete_template (string name) const
1088 {
1089         boost::filesystem::remove (template_path (name));
1090 }
1091
1092 /** @return Path to the config.xml containing the actual settings, following a link if required */
1093 boost::filesystem::path
1094 Config::config_file ()
1095 {
1096         cxml::Document f ("Config");
1097         boost::filesystem::path main = path("config.xml", false);
1098         if (!boost::filesystem::exists (main)) {
1099                 /* It doesn't exist, so there can't be any links; just return it */
1100                 return main;
1101         }
1102
1103         /* See if there's a link */
1104         f.read_file (main);
1105         optional<string> link = f.optional_string_child("Link");
1106         if (link) {
1107                 return *link;
1108         }
1109
1110         return main;
1111 }
1112
1113 void
1114 Config::reset_cover_sheet ()
1115 {
1116         set_cover_sheet_to_default ();
1117         changed ();
1118 }
1119
1120 void
1121 Config::link (boost::filesystem::path new_file) const
1122 {
1123         xmlpp::Document doc;
1124         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1125         try {
1126                 doc.write_to_file_formatted(path("config.xml", true).string());
1127         } catch (xmlpp::exception& e) {
1128                 string s = e.what ();
1129                 trim (s);
1130                 throw FileError (s, path("config.xml"));
1131         }
1132 }
1133
1134 void
1135 Config::copy_and_link (boost::filesystem::path new_file) const
1136 {
1137         write ();
1138         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1139         link (new_file);
1140 }