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