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