src/lib/config.cc

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