src/lib/config.cc

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