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