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