X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.cc;h=419436995dc829337bf59c0cf81a604c01741603;hp=7b381e33bce5cfb717473cdef6eb184363e6cd40;hb=ac34066d5e448d1984d11a180be74e31b6e13b5c;hpb=54ca5a01f0648d2a5101fab0f50b41d8c90612e4 diff --git a/src/lib/config.cc b/src/lib/config.cc index 7b381e33b..419436995 100644 --- a/src/lib/config.cc +++ b/src/lib/config.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2020 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -41,7 +41,6 @@ #include #include #include -#include #include #include #include @@ -57,11 +56,10 @@ using std::list; using std::min; using std::max; using std::remove; -using std::exception; -using std::cerr; -using boost::shared_ptr; +using std::shared_ptr; +using std::make_shared; using boost::optional; -using boost::dynamic_pointer_cast; +using std::dynamic_pointer_cast; using boost::algorithm::trim; using dcp::raw_convert; @@ -88,7 +86,7 @@ Config::set_defaults () _use_any_servers = true; _servers.clear (); _only_servers_encode = false; - _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP; + _tms_protocol = FileTransferProtocol::SCP; _tms_ip = ""; _tms_path = "."; _tms_user = ""; @@ -103,11 +101,12 @@ Config::set_defaults () _default_dcp_audio_channels = 6; _default_j2k_bandwidth = 150000000; _default_audio_delay = 0; - _default_interop = true; + _default_interop = false; + _default_metadata.clear (); _upload_after_make_dcp = false; _mail_server = ""; _mail_port = 25; - _mail_protocol = EMAIL_PROTOCOL_AUTO; + _mail_protocol = EmailProtocol::AUTO; _mail_user = ""; _mail_password = ""; _kdm_from = ""; @@ -120,14 +119,14 @@ Config::set_defaults () _check_for_updates = false; _check_for_test_updates = false; _maximum_j2k_bandwidth = 250000000; - _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR; + _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK; _analyse_ebur128 = true; _automatic_audio_analysis = false; #ifdef DCPOMATIC_WINDOWS _win32_console = false; #endif - _cinemas_file = path ("cinemas.xml"); - _dkdm_recipients_file = path ("dkdm_recipients.xml"); + _cinemas_file = read_path ("cinemas.xml"); + _dkdm_recipients_file = read_path ("dkdm_recipients.xml"); _show_hints_before_make_dcp = true; _confirm_kdm_email = true; _kdm_container_name_format = dcp::NameFormat ("KDM %f %c"); @@ -165,27 +164,17 @@ Config::set_defaults () _christie_password = optional(); _gdc_username = optional(); _gdc_password = optional(); - _interface_complexity = INTERFACE_SIMPLE; _player_mode = PLAYER_MODE_WINDOW; _image_display = 0; _video_view_type = VIDEO_VIEW_SIMPLE; _respect_kdm_validity_periods = true; - _player_activity_log_file = boost::none; _player_debug_log_file = boost::none; _player_content_directory = boost::none; _player_playlist_directory = boost::none; _player_kdm_directory = boost::none; _audio_mapping = boost::none; -#ifdef DCPOMATIC_VARIANT_SWAROOP - _player_background_image = boost::none; - _kdm_server_url = "http://localhost:8000/{CPL}"; - _player_watermark_theatre = ""; - _player_watermark_period = 1; - _player_watermark_duration = 50; - _player_lock_file = boost::none; - _signer_chain_path = "signer"; - _decryption_chain_path = "decryption"; -#endif + _custom_languages.clear (); + _add_files_path = boost::none; _allowed_dcp_frame_rates.clear (); _allowed_dcp_frame_rates.push_back (24); @@ -210,15 +199,13 @@ Config::restore_defaults () shared_ptr Config::create_certificate_chain () { - return shared_ptr ( - new dcp::CertificateChain ( - openssl_path(), - "dcpomatic.com", - "dcpomatic.com", - ".dcpomatic.smpte-430-2.ROOT", - ".dcpomatic.smpte-430-2.INTERMEDIATE", - "CS.dcpomatic.smpte-430-2.LEAF" - ) + return make_shared ( + openssl_path(), + "dcpomatic.com", + "dcpomatic.com", + ".dcpomatic.smpte-430-2.ROOT", + ".dcpomatic.smpte-430-2.INTERMEDIATE", + "CS.dcpomatic.smpte-430-2.LEAF" ); } @@ -228,13 +215,13 @@ Config::backup () /* Make a copy of the configuration */ try { int n = 1; - while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) { + while (n < 100 && boost::filesystem::exists(write_path(String::compose("config.xml.%1", n)))) { ++n; } - boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false)); - boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false)); - boost::filesystem::copy_file(path("dkdm_recipients.xml", false), path(String::compose("dkdm_recipients.xml.%1", n), false)); + boost::filesystem::copy_file(read_path("config.xml"), write_path(String::compose("config.xml.%1", n))); + boost::filesystem::copy_file(read_path("cinemas.xml"), write_path(String::compose("cinemas.xml.%1", n))); + boost::filesystem::copy_file(read_path("dkdm_recipients.xml"), write_path(String::compose("dkdm_recipients.xml.%1", n))); } catch (...) {} } @@ -242,18 +229,10 @@ void Config::read () try { -#if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX) - if (geteuid() == 0) { - /* Take ownership of the config file if we're root */ - chown (config_file().string().c_str(), 0, 0); - chmod (config_file().string().c_str(), 0644); - } -#endif - cxml::Document f ("Config"); - f.read_file (config_file ()); + f.read_file (config_read_file()); - optional version = f.optional_number_child ("Version"); + auto version = f.optional_number_child ("Version"); if (version && *version < _current_version) { /* Back up the old config before we re-write it in a back-incompatible way */ backup (); @@ -272,16 +251,16 @@ try _default_directory = boost::optional (); } - boost::optional b = f.optional_number_child ("ServerPort"); + auto b = f.optional_number_child ("ServerPort"); if (!b) { b = f.optional_number_child ("ServerPortBase"); } _server_port_base = b.get (); - boost::optional u = f.optional_bool_child ("UseAnyServers"); + auto u = f.optional_bool_child ("UseAnyServers"); _use_any_servers = u.get_value_or (true); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) { + for (auto i: f.node_children("Server")) { if (i->node_children("HostName").size() == 1) { _servers.push_back (i->string_child ("HostName")); } else { @@ -290,7 +269,7 @@ try } _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false); - _tms_protocol = static_cast(f.optional_number_child("TMSProtocol").get_value_or(static_cast(FILE_TRANSFER_PROTOCOL_SCP))); + _tms_protocol = static_cast(f.optional_number_child("TMSProtocol").get_value_or(static_cast(FileTransferProtocol::SCP))); _tms_ip = f.string_child ("TMSIP"); _tms_path = f.string_child ("TMSPath"); _tms_user = f.string_child ("TMSUser"); @@ -298,7 +277,7 @@ try _language = f.optional_string_child ("Language"); - optional c = f.optional_string_child ("DefaultContainer"); + auto c = f.optional_string_child ("DefaultContainer"); if (c) { _default_container = Ratio::from_id (c.get ()); } @@ -317,7 +296,7 @@ try _dcp_issuer = f.string_child ("DCPIssuer"); } - optional up = f.optional_bool_child("UploadAfterMakeDCP"); + auto up = f.optional_bool_child("UploadAfterMakeDCP"); if (!up) { up = f.optional_bool_child("DefaultUploadAfterMakeDCP"); } @@ -328,16 +307,15 @@ try _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or(""); _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or(""); - if (version && version.get() >= 2) { - _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata")); - } else { - _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata")); - } - _default_still_length = f.optional_number_child("DefaultStillLength").get_value_or (10); _default_j2k_bandwidth = f.optional_number_child("DefaultJ2KBandwidth").get_value_or (200000000); _default_audio_delay = f.optional_number_child("DefaultAudioDelay").get_value_or (0); _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false); + + for (auto const& i: f.node_children("DefaultMetadata")) { + _default_metadata[i->string_attribute("key")] = i->content(); + } + _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory"); /* Read any cinemas that are still lying around in the config file @@ -352,13 +330,13 @@ try /* Make sure this matches the code in write_config */ string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto"); if (protocol == "Auto") { - _mail_protocol = EMAIL_PROTOCOL_AUTO; + _mail_protocol = EmailProtocol::AUTO; } else if (protocol == "Plain") { - _mail_protocol = EMAIL_PROTOCOL_PLAIN; + _mail_protocol = EmailProtocol::PLAIN; } else if (protocol == "STARTTLS") { - _mail_protocol = EMAIL_PROTOCOL_STARTTLS; + _mail_protocol = EmailProtocol::STARTTLS; } else if (protocol == "SSL") { - _mail_protocol = EMAIL_PROTOCOL_SSL; + _mail_protocol = EmailProtocol::SSL; } } @@ -367,7 +345,7 @@ try _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME")); _kdm_from = f.string_child ("KDMFrom"); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) { + for (auto i: f.node_children("KDMCC")) { if (!i->content().empty()) { _kdm_cc.push_back (i->content ()); } @@ -378,7 +356,7 @@ try _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification")); _notification_from = f.optional_string_child("NotificationFrom").get_value_or(""); _notification_to = f.optional_string_child("NotificationTo").get_value_or(""); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) { + for (auto i: f.node_children("NotificationCC")) { if (!i->content().empty()) { _notification_cc.push_back (i->content ()); } @@ -403,34 +381,19 @@ try _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false); #endif - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) { + for (auto i: f.node_children("History")) { _history.push_back (i->content ()); } - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) { + for (auto i: f.node_children("PlayerHistory")) { _player_history.push_back (i->content ()); } - cxml::NodePtr signer = f.optional_node_child ("Signer"); -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (signer && signer->node_children().size() == 1) { - /* The content of is a path to a file; if it's relative it's in the same - directory as .config. */ - _signer_chain_path = signer->content(); - if (_signer_chain_path.is_relative()) { - _signer_chain = read_swaroop_chain (path(_signer_chain_path.string())); - } else { - _signer_chain = read_swaroop_chain (_signer_chain_path); - } - } else { - /* is not present or has children: ignore it and remake. */ - _signer_chain = create_certificate_chain (); - } -#else + auto signer = f.optional_node_child ("Signer"); if (signer) { - shared_ptr c (new dcp::CertificateChain ()); + auto c = make_shared(); /* Read the signing certificates and private key in from the config file */ - BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) { + for (auto i: signer->node_children ("Certificate")) { c->add (dcp::Certificate (i->content ())); } c->set_key (signer->string_child ("PrivateKey")); @@ -439,27 +402,11 @@ try /* Make a new set of signing certificates and key */ _signer_chain = create_certificate_chain (); } -#endif - cxml::NodePtr decryption = f.optional_node_child ("Decryption"); -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (decryption && decryption->node_children().size() == 1) { - /* The content of is a path to a file; if it's relative, it's in the same - directory as .config. */ - _decryption_chain_path = decryption->content(); - if (_decryption_chain_path.is_relative()) { - _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string())); - } else { - _decryption_chain = read_swaroop_chain (_decryption_chain_path); - } - } else { - /* is not present or has more children: ignore it and remake. */ - _decryption_chain = create_certificate_chain (); - } -#else + auto decryption = f.optional_node_child ("Decryption"); if (decryption) { - shared_ptr c (new dcp::CertificateChain ()); - BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) { + auto c = make_shared(); + for (auto i: decryption->node_children ("Certificate")) { c->add (dcp::Certificate (i->content ())); } c->set_key (decryption->string_child ("PrivateKey")); @@ -467,13 +414,12 @@ try } else { _decryption_chain = create_certificate_chain (); } -#endif /* These must be done before we call Bad as that might set one of the nags. */ - BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) { - int const id = i->number_attribute("Id"); + for (auto i: f.node_children("Nagged")) { + auto const id = i->number_attribute("Id"); if (id >= 0 && id < NAG_COUNT) { _nagged[id] = raw_convert(i->content()); } @@ -481,7 +427,7 @@ try optional bad; - BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) { + for (auto const& i: _signer_chain->unordered()) { if (i.has_utf8_strings()) { bad = BAD_SIGNER_UTF8_STRINGS; } @@ -496,7 +442,7 @@ try } if (bad) { - optional const remake = Bad(*bad); + auto const remake = Bad(*bad); if (remake && *remake) { switch (*bad) { case BAD_SIGNER_UTF8_STRINGS: @@ -516,12 +462,12 @@ try } else { /* Old-style: one or more DKDM nodes */ _dkdms.reset (new DKDMGroup ("root")); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) { + for (auto i: f.node_children("DKDM")) { _dkdms->add (DKDMBase::read (i)); } } - _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ()); - _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or (path("dkdm_recipients.xml").string()); + _cinemas_file = f.optional_string_child("CinemasFile").get_value_or(read_path("cinemas.xml").string()); + _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or(read_path("dkdm_recipients.xml").string()); _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true); _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true); _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c")); @@ -557,7 +503,7 @@ try _decode_reduction = f.optional_number_child("DecodeReduction"); _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false); - BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) { + for (auto i: f.node_children("Notification")) { int const id = i->number_attribute("Id"); if (id >= 0 && id < NOTIFICATION_COUNT) { _notification[id] = raw_convert(i->content()); @@ -571,11 +517,7 @@ try _gdc_username = f.optional_string_child("GDCUsername"); _gdc_password = f.optional_string_child("GDCPassword"); - optional ic = f.optional_string_child("InterfaceComplexity"); - if (ic && *ic == "full") { - _interface_complexity = INTERFACE_FULL; - } - optional pm = f.optional_string_child("PlayerMode"); + auto pm = f.optional_string_child("PlayerMode"); if (pm && *pm == "window") { _player_mode = PLAYER_MODE_WINDOW; } else if (pm && *pm == "full") { @@ -585,18 +527,13 @@ try } _image_display = f.optional_number_child("ImageDisplay").get_value_or(0); - optional vc = f.optional_string_child("VideoViewType"); + auto vc = f.optional_string_child("VideoViewType"); if (vc && *vc == "opengl") { _video_view_type = VIDEO_VIEW_OPENGL; } else if (vc && *vc == "simple") { _video_view_type = VIDEO_VIEW_SIMPLE; } _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true); - /* PlayerLogFile is old name */ - _player_activity_log_file = f.optional_string_child("PlayerLogFile"); - if (!_player_activity_log_file) { - _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile"); - } _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile"); _player_content_directory = f.optional_string_child("PlayerContentDirectory"); _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory"); @@ -606,17 +543,16 @@ try _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version); } -#ifdef DCPOMATIC_VARIANT_SWAROOP - _player_background_image = f.optional_string_child("PlayerBackgroundImage"); - _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}"); - _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or(""); - _player_watermark_period = f.optional_number_child("PlayerWatermarkPeriod").get_value_or(1); - _player_watermark_duration = f.optional_number_child("PlayerWatermarkDuration").get_value_or(150); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) { - _required_monitors.push_back(Monitor(i)); + for (auto i: f.node_children("CustomLanguage")) { + try { + /* This will fail if it's called before dcp::init() as it won't recognise the + * tag. That's OK because the Config will be reloaded again later. + */ + _custom_languages.push_back (dcp::LanguageTag(i->content())); + } catch (std::runtime_error& e) {} } - _player_lock_file = f.optional_string_child("PlayerLockFile"); -#endif + + _add_files_path = f.optional_string_child("AddFilesPath"); if (boost::filesystem::exists (_cinemas_file)) { cxml::Document f ("Cinemas"); @@ -669,7 +605,7 @@ void Config::write_config () const { xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("Config"); + auto root = doc.create_root_node ("Config"); /* [XML] Version The version number of the configuration file format. */ root->add_child("Version")->add_child_text (raw_convert(_current_version)); @@ -689,7 +625,7 @@ Config::write_config () const /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */ root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0"); - BOOST_FOREACH (string i, _servers) { + for (auto i: _servers) { /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags as you like. */ @@ -731,7 +667,7 @@ Config::write_config () const root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert (_default_dcp_audio_channels)); /* [XML] DCPIssuer Issuer text to write into CPL files. */ root->add_child("DCPIssuer")->add_child_text (_dcp_issuer); - /* [XML] DCPIssuer Creator text to write into CPL files. */ + /* [XML] DCPCreator Creator text to write into CPL files. */ root->add_child("DCPCreator")->add_child_text (_dcp_creator); /* [XML] Company name to write into MXF files. */ root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name); @@ -744,14 +680,6 @@ Config::write_config () const /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */ root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0"); - /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <ContentVersion>, - <AudioLanguage>, <SubtitleLanguage>, <Territory>, - <Rating>, <Studio>, <Facility>, <TempVersion>, - <PreRelease>, <RedBand>, <Chain>, <TwoDVersionOFThreeD>, - <MasteredLuminance>. - */ - _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata")); - /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */ root->add_child("DefaultStillLength")->add_child_text (raw_convert (_default_still_length)); /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */ @@ -760,6 +688,11 @@ Config::write_config () const root->add_child("DefaultAudioDelay")->add_child_text (raw_convert (_default_audio_delay)); /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */ root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0"); + for (auto const& i: _default_metadata) { + auto c = root->add_child("DefaultMetadata"); + c->set_attribute("key", i.first); + c->add_child_text(i.second); + } if (_default_kdm_directory) { /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */ root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ()); @@ -770,16 +703,16 @@ Config::write_config () const root->add_child("MailPort")->add_child_text (raw_convert (_mail_port)); /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */ switch (_mail_protocol) { - case EMAIL_PROTOCOL_AUTO: + case EmailProtocol::AUTO: root->add_child("MailProtocol")->add_child_text("Auto"); break; - case EMAIL_PROTOCOL_PLAIN: + case EmailProtocol::PLAIN: root->add_child("MailProtocol")->add_child_text("Plain"); break; - case EMAIL_PROTOCOL_STARTTLS: + case EmailProtocol::STARTTLS: root->add_child("MailProtocol")->add_child_text("STARTTLS"); break; - case EMAIL_PROTOCOL_SSL: + case EmailProtocol::SSL: root->add_child("MailProtocol")->add_child_text("SSL"); break; } @@ -792,7 +725,7 @@ Config::write_config () const root->add_child("KDMSubject")->add_child_text (_kdm_subject); /* [XML] KDMFrom From address to use for KDM emails. */ root->add_child("KDMFrom")->add_child_text (_kdm_from); - BOOST_FOREACH (string i, _kdm_cc) { + for (auto i: _kdm_cc) { /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */ root->add_child("KDMCC")->add_child_text (i); } @@ -807,7 +740,7 @@ Config::write_config () const root->add_child("NotificationFrom")->add_child_text (_notification_from); /* [XML] NotificationFrom To address to use for notification emails. */ root->add_child("NotificationTo")->add_child_text (_notification_to); - BOOST_FOREACH (string i, _notification_cc) { + for (auto i: _notification_cc) { /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */ root->add_child("NotificationCC")->add_child_text (i); } @@ -830,8 +763,9 @@ Config::write_config () const /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */ root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0"); /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related - to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related - to sending email. + to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related + to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information + related to the player, 1024 debug information related to audio analyses. */ root->add_child("LogTypes")->add_child_text (raw_convert (_log_types)); /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */ @@ -839,57 +773,44 @@ Config::write_config () const /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */ root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0"); #ifdef DCPOMATIC_WINDOWS - /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */ - root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0"); + if (_win32_console) { + /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. + * We only write this if it's true, which is a bit of a hack to allow unit tests to work + * more easily on Windows (without a platform-specific reference in config_write_utf8_test) + */ + root->add_child("Win32Console")->add_child_text ("1"); + } #endif -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (_signer_chain_path.is_relative()) { - write_swaroop_chain (_signer_chain, path(_signer_chain_path.string())); - } else { - write_swaroop_chain (_signer_chain, _signer_chain_path); - } - root->add_child("Signer")->add_child_text(_signer_chain_path.string()); -#else /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <Certificate> tags in order and a <PrivateKey> tag all containing PEM-encoded certificates or private keys as appropriate. */ - xmlpp::Element* signer = root->add_child ("Signer"); + auto signer = root->add_child ("Signer"); DCPOMATIC_ASSERT (_signer_chain); - BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) { + for (auto const& i: _signer_chain->unordered()) { signer->add_child("Certificate")->add_child_text (i.certificate (true)); } signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ()); -#endif -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (_decryption_chain_path.is_relative()) { - write_swaroop_chain (_decryption_chain, path(_decryption_chain_path.string())); - } else { - write_swaroop_chain (_decryption_chain, _decryption_chain_path); - } - root->add_child("Decryption")->add_child_text(_decryption_chain_path.string()); -#else /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */ - xmlpp::Element* decryption = root->add_child ("Decryption"); + auto decryption = root->add_child ("Decryption"); DCPOMATIC_ASSERT (_decryption_chain); - BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) { + for (auto const& i: _decryption_chain->unordered()) { decryption->add_child("Certificate")->add_child_text (i.certificate (true)); } decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ()); -#endif /* [XML] History Filename of DCP to present in the File menu of the GUI; there can be more than one of these tags. */ - BOOST_FOREACH (boost::filesystem::path i, _history) { + for (auto i: _history) { root->add_child("History")->add_child_text (i.string ()); } /* [XML] History Filename of DCP to present in the File menu of the player; there can be more than one of these tags. */ - BOOST_FOREACH (boost::filesystem::path i, _player_history) { + for (auto i: _player_history) { root->add_child("PlayerHistory")->add_child_text (i.string ()); } @@ -1000,24 +921,14 @@ Config::write_config () const } if (_gdc_username) { - /* [XML] GCCUsername Username for logging into GDC's servers when downloading server certificates. */ + /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */ root->add_child("GDCUsername")->add_child_text(*_gdc_username); } if (_gdc_password) { - /* [XML] GCCPassword Password for logging into GDC's servers when downloading server certificates. */ + /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */ root->add_child("GDCPassword")->add_child_text(*_gdc_password); } - /* [XML] InterfaceComplexity simple for the reduced interface or full for the full interface. */ - switch (_interface_complexity) { - case INTERFACE_SIMPLE: - root->add_child("InterfaceComplexity")->add_child_text("simple"); - break; - case INTERFACE_FULL: - root->add_child("InterfaceComplexity")->add_child_text("full"); - break; - } - /* [XML] PlayerMode window for a single window, full for full-screen and dual for full screen playback with controls on another monitor. */ @@ -1045,12 +956,8 @@ Config::write_config () const } /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */ root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0"); - if (_player_activity_log_file) { - /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */ - root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string()); - } if (_player_debug_log_file) { - /* [XML] PlayerLogFile Filename to use for player debug logs */ + /* [XML] PlayerLogFile Filename to use for player debug logs. */ root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string()); } if (_player_content_directory) { @@ -1068,50 +975,44 @@ Config::write_config () const if (_audio_mapping) { _audio_mapping->as_xml (root->add_child("AudioMapping")); } -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (_player_background_image) { - root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string()); + for (auto const& i: _custom_languages) { + root->add_child("CustomLanguage")->add_child_text(i.to_string()); } - root->add_child("KDMServerURL")->add_child_text(_kdm_server_url); - root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre); - root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert(_player_watermark_period)); - root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert(_player_watermark_duration)); - BOOST_FOREACH (Monitor i, _required_monitors) { - i.as_xml(root->add_child("RequiredMonitor")); + if (_add_files_path) { + /* [XML] AddFilesPath The default path that will be offered in the picker when adding files to a film. */ + root->add_child("AddFilesPath")->add_child_text(_add_files_path->string()); } - if (_player_lock_file) { - root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string()); - } -#endif + + auto target = config_write_file(); try { - string const s = doc.write_to_string_formatted (); - boost::filesystem::path tmp (string(config_file().string()).append(".tmp")); - FILE* f = fopen_boost (tmp, "w"); + auto const s = doc.write_to_string_formatted (); + boost::filesystem::path tmp (string(target.string()).append(".tmp")); + auto f = fopen_boost (tmp, "w"); if (!f) { throw FileError (_("Could not open file for writing"), tmp); } - checked_fwrite (s.c_str(), s.length(), f, tmp); + checked_fwrite (s.c_str(), s.bytes(), f, tmp); fclose (f); - boost::filesystem::remove (config_file()); - boost::filesystem::rename (tmp, config_file()); + boost::filesystem::remove (target); + boost::filesystem::rename (tmp, target); } catch (xmlpp::exception& e) { string s = e.what (); trim (s); - throw FileError (s, config_file()); + throw FileError (s, target); } } template void -write_file (string root_node, string node, string version, list > things, boost::filesystem::path file) +write_file (string root_node, string node, string version, list> things, boost::filesystem::path file) { xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node (root_node); + auto root = doc.create_root_node (root_node); root->add_child("Version")->add_child_text(version); - BOOST_FOREACH (shared_ptr i, things) { + for (auto i: things) { i->as_xml (root->add_child(node)); } @@ -1161,7 +1062,7 @@ Config::directory_or (optional dir, boost::filesystem:: } boost::system::error_code ec; - bool const e = boost::filesystem::exists (*dir, ec); + auto const e = boost::filesystem::exists (*dir, ec); if (ec || !e) { return a; } @@ -1279,9 +1180,9 @@ Config::add_to_history_internal (vector& h, boost::file void Config::clean_history_internal (vector& h) { - vector old = h; + auto old = h; h.clear (); - BOOST_FOREACH (boost::filesystem::path i, old) { + for (auto i: old) { try { if (boost::filesystem::is_directory(i)) { h.push_back (i); @@ -1292,22 +1193,23 @@ Config::clean_history_internal (vector& h) } } + bool Config::have_existing (string file) { - return boost::filesystem::exists (path (file, false)); + return boost::filesystem::exists (read_path(file)); } + void Config::read_cinemas (cxml::Document const & f) { _cinemas.clear (); - list cin = f.node_children ("Cinema"); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) { + for (auto i: f.node_children("Cinema")) { /* Slightly grotty two-part construction of Cinema here so that we can use shared_from_this. */ - shared_ptr cinema (new Cinema (i)); + auto cinema = make_shared(i); cinema->read_screens (i); _cinemas.push_back (cinema); } @@ -1337,48 +1239,29 @@ void Config::read_dkdm_recipients (cxml::Document const & f) { _dkdm_recipients.clear (); - list cin = f.node_children ("DKDMRecipient"); - BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDMRecipient")) { + for (auto i: f.node_children("DKDMRecipient")) { _dkdm_recipients.push_back (shared_ptr(new DKDMRecipient(i))); } } -void -Config::set_dkdm_recipients_file (boost::filesystem::path file) -{ - if (file == _dkdm_recipients_file) { - return; - } - - _dkdm_recipients_file = file; - - if (boost::filesystem::exists (_dkdm_recipients_file)) { - /* Existing file; read it in */ - cxml::Document f ("DKDMRecipients"); - f.read_file (_dkdm_recipients_file); - read_dkdm_recipients (f); - } - - changed (OTHER); -} - void Config::save_template (shared_ptr film, string name) const { - film->write_template (template_path (name)); + film->write_template (template_write_path(name)); } + list Config::templates () const { - if (!boost::filesystem::exists (path ("templates"))) { - return list (); + if (!boost::filesystem::exists(read_path("templates"))) { + return {}; } list n; - for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) { - n.push_back (i->path().filename().string()); + for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) { + n.push_back (i.path().filename().string()); } return n; } @@ -1386,33 +1269,41 @@ Config::templates () const bool Config::existing_template (string name) const { - return boost::filesystem::exists (template_path (name)); + return boost::filesystem::exists (template_read_path(name)); } + boost::filesystem::path -Config::template_path (string name) const +Config::template_read_path (string name) const { - return path("templates") / tidy_for_filename (name); + return read_path("templates") / tidy_for_filename (name); } + +boost::filesystem::path +Config::template_write_path (string name) const +{ + return write_path("templates") / tidy_for_filename (name); +} + + void Config::rename_template (string old_name, string new_name) const { - boost::filesystem::rename (template_path (old_name), template_path (new_name)); + boost::filesystem::rename (template_read_path(old_name), template_write_path(new_name)); } void Config::delete_template (string name) const { - boost::filesystem::remove (template_path (name)); + boost::filesystem::remove (template_write_path(name)); } /** @return Path to the config.xml containing the actual settings, following a link if required */ boost::filesystem::path -Config::config_file () +config_file (boost::filesystem::path main) { cxml::Document f ("Config"); - boost::filesystem::path main = path("config.xml", false); if (!boost::filesystem::exists (main)) { /* It doesn't exist, so there can't be any links; just return it */ return main; @@ -1421,7 +1312,7 @@ Config::config_file () /* See if there's a link */ try { f.read_file (main); - optional link = f.optional_string_child("Link"); + auto link = f.optional_string_child("Link"); if (link) { return *link; } @@ -1434,6 +1325,21 @@ Config::config_file () return main; } + +boost::filesystem::path +Config::config_read_file () +{ + return config_file (read_path("config.xml")); +} + + +boost::filesystem::path +Config::config_write_file () +{ + return config_file (write_path("config.xml")); +} + + void Config::reset_cover_sheet () { @@ -1447,11 +1353,11 @@ Config::link (boost::filesystem::path new_file) const xmlpp::Document doc; doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string()); try { - doc.write_to_file_formatted(path("config.xml", true).string()); + doc.write_to_file_formatted(write_path("config.xml").string()); } catch (xmlpp::exception& e) { string s = e.what (); trim (s); - throw FileError (s, path("config.xml")); + throw FileError (s, write_path("config.xml")); } } @@ -1459,14 +1365,14 @@ void Config::copy_and_link (boost::filesystem::path new_file) const { write (); - boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists); + boost::filesystem::copy_file (config_read_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists); link (new_file); } bool Config::have_write_permission () const { - FILE* f = fopen_boost (config_file(), "r+"); + auto f = fopen_boost (config_write_file(), "r+"); if (!f) { return false; } @@ -1489,14 +1395,14 @@ Config::audio_mapping (int output_channels) Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB) Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB) */ - _audio_mapping->set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt - _audio_mapping->set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt - _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt - _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt - _audio_mapping->set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt - _audio_mapping->set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt - _audio_mapping->set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt - _audio_mapping->set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt + _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt + _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt + _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt + _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt + _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt + _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt + _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt + _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt } else { /* 1:1 mapping */ for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) { @@ -1519,8 +1425,19 @@ void Config::set_audio_mapping_to_default () { DCPOMATIC_ASSERT (_audio_mapping); - int const ch = _audio_mapping->output_channels (); + auto const ch = _audio_mapping->output_channels (); _audio_mapping = boost::none; _audio_mapping = audio_mapping (ch); changed (AUDIO_MAPPING); } + + +void +Config::add_custom_language (dcp::LanguageTag tag) +{ + if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) { + _custom_languages.push_back (tag); + changed (); + } +} +