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