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