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