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