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