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