X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.cc;h=bf4b495523cd10433e3b80549fd5ac7db67ff279;hp=8dd4c4e0bb984321f94a5026bb2931a2beb5a24f;hb=a5be11a965c2c38442e4e069874e7e21b5b43a5c;hpb=f679e8ab99d25bcf725732e0c79b658f38a39a27 diff --git a/src/lib/config.cc b/src/lib/config.cc index 8dd4c4e0b..bf4b49552 100644 --- a/src/lib/config.cc +++ b/src/lib/config.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2017 Carl Hetherington + Copyright (C) 2012-2019 Carl Hetherington This file is part of DCP-o-matic. @@ -31,6 +31,8 @@ #include "cross.h" #include "film.h" #include "dkdm_wrapper.h" +#include "compose.hpp" +#include "crypto.h" #include #include #include @@ -60,10 +62,15 @@ using boost::shared_ptr; using boost::optional; using boost::dynamic_pointer_cast; using boost::algorithm::trim; +using boost::shared_array; using dcp::raw_convert; Config* Config::_instance = 0; +int const Config::_current_version = 3; boost::signals2::signal Config::FailedToLoad; +boost::signals2::signal Config::Warning; +boost::signals2::signal Config::BadSignerChain; +boost::optional Config::override_path; /** Construct default configuration */ Config::Config () @@ -89,6 +96,7 @@ Config::set_defaults () _tms_password = ""; _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750")); _allow_any_dcp_frame_rate = false; + _allow_any_container = false; _language = optional (); _default_still_length = 10; _default_container = Ratio::from_id ("185"); @@ -98,6 +106,7 @@ Config::set_defaults () _default_j2k_bandwidth = 100000000; _default_audio_delay = 0; _default_interop = true; + _default_upload_after_make_dcp = false; _mail_server = ""; _mail_port = 25; _mail_user = ""; @@ -105,6 +114,10 @@ Config::set_defaults () _kdm_from = ""; _kdm_cc.clear (); _kdm_bcc = ""; + _notification_from = ""; + _notification_to = ""; + _notification_cc.clear (); + _notification_bcc = ""; _check_for_updates = false; _check_for_test_updates = false; _maximum_j2k_bandwidth = 250000000; @@ -125,8 +138,51 @@ Config::set_defaults () for (int i = 0; i < NAG_COUNT; ++i) { _nagged[i] = false; } - _preview_sound = false; - _preview_sound_output = optional (); + _sound = true; + _sound_output = optional (); + _last_kdm_write_type = KDM_WRITE_FLAT; + _last_dkdm_write_type = DKDM_WRITE_INTERNAL; + + /* I think the scaling factor here should be the ratio of the longest frame + encode time to the shortest; if the thread count is T, longest time is L + and the shortest time S we could encode L/S frames per thread whilst waiting + for the L frame to encode so we might have to store LT/S frames. + + However we don't want to use too much memory, so keep it a bit lower than we'd + perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could + use about 240Mb with 72 encoding threads. + */ + _frames_in_memory_multiplier = 3; + _decode_reduction = optional(); + _default_notify = false; + for (int i = 0; i < NOTIFICATION_COUNT; ++i) { + _notification[i] = false; + } + _barco_username = optional(); + _barco_password = optional(); + _christie_username = optional(); + _christie_password = optional(); + _gdc_username = optional(); + _gdc_password = optional(); + _interface_complexity = INTERFACE_SIMPLE; + _player_mode = PLAYER_MODE_WINDOW; + _image_display = 0; + _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; +#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 _allowed_dcp_frame_rates.clear (); _allowed_dcp_frame_rates.push_back (24); @@ -137,6 +193,7 @@ Config::set_defaults () _allowed_dcp_frame_rates.push_back (60); set_kdm_email_to_default (); + set_notification_email_to_default (); set_cover_sheet_to_default (); } @@ -162,15 +219,41 @@ Config::create_certificate_chain () ); } +void +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)))) { + ++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)); + } catch (...) {} +} + 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 (path ("config.xml")); - optional c; + f.read_file (config_file ()); optional 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 (); + } if (f.optional_number_child("NumLocalEncodingThreads")) { _master_encoding_threads = _server_encoding_threads = f.optional_number_child("NumLocalEncodingThreads").get(); @@ -209,6 +292,7 @@ try _tms_user = f.string_child ("TMSUser"); _tms_password = f.string_child ("TMSPassword"); + optional c; c = f.optional_string_child ("SoundProcessor"); if (c) { _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ()); @@ -225,16 +309,17 @@ try _default_container = Ratio::from_id (c.get ()); } - c = f.optional_string_child ("DefaultScaleTo"); - if (c) { - _default_scale_to = Ratio::from_id (c.get ()); + if (_default_container && !_default_container->used_for_container()) { + Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)")); + _default_container = Ratio::from_id ("185"); } - c = f.optional_string_child ("DefaultDCPContentType"); + c = f.optional_string_child ("DefaultScaleTo"); if (c) { - _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ()); + _default_scale_to = Ratio::from_id (c.get ()); } + _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR")); _default_dcp_audio_channels = f.optional_number_child("DefaultDCPAudioChannels").get_value_or (6); if (f.optional_string_child ("DCPMetadataIssuer")) { @@ -243,6 +328,7 @@ try _dcp_issuer = f.string_child ("DCPIssuer"); } + _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false); _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or (""); if (version && version.get() >= 2) { @@ -264,6 +350,7 @@ try _mail_port = f.optional_number_child ("MailPort").get_value_or (25); _mail_user = f.optional_string_child("MailUser").get_value_or (""); _mail_password = f.optional_string_child("MailPassword").get_value_or (""); + _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")) { @@ -274,11 +361,25 @@ try _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or (""); _kdm_email = f.string_child ("KDMEmail"); + _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")) { + if (!i->content().empty()) { + _notification_cc.push_back (i->content ()); + } + } + _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or(""); + if (f.optional_string_child("NotificationEmail")) { + _notification_email = f.string_child("NotificationEmail"); + } + _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false); _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false); _maximum_j2k_bandwidth = f.optional_number_child ("MaximumJ2KBandwidth").get_value_or (250000000); _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false); + _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false); _log_types = f.optional_number_child ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR); _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true); @@ -287,12 +388,30 @@ try _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false); #endif - list his = f.node_children ("History"); BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) { _history.push_back (i->content ()); } + BOOST_FOREACH (cxml::ConstNodePtr 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 if (signer) { shared_ptr c (new dcp::CertificateChain ()); /* Read the signing certificates and private key in from the config file */ @@ -305,8 +424,48 @@ try /* Make a new set of signing certificates and key */ _signer_chain = create_certificate_chain (); } +#endif + + /* These must be done before we call BadSignerChain as that might set one + of the nags. + */ + BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) { + int const id = i->number_attribute("Id"); + if (id >= 0 && id < NAG_COUNT) { + _nagged[id] = raw_convert(i->content()); + } + } + + bool bad_signer_chain = false; + BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) { + if (i.has_utf8_strings()) { + bad_signer_chain = true; + } + } + + if (bad_signer_chain) { + optional const remake = BadSignerChain(); + if (remake && *remake) { + _signer_chain = create_certificate_chain (); + } + } 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 if (decryption) { shared_ptr c (new dcp::CertificateChain ()); BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) { @@ -317,7 +476,7 @@ try } else { _decryption_chain = create_certificate_chain (); } - +#endif if (f.optional_node_child("DKDMGroup")) { /* New-style: all DKDMs in a group */ _dkdms = dynamic_pointer_cast (DKDMBase::read (f.node_child("DKDMGroup"))); @@ -336,17 +495,82 @@ try _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t")); _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t")); _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true); - BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) { + /* The variable was renamed but not the XML tag */ + _sound = f.optional_bool_child("PreviewSound").get_value_or (true); + _sound_output = f.optional_string_child("PreviewSoundOutput"); + if (f.optional_string_child("CoverSheet")) { + _cover_sheet = f.optional_string_child("CoverSheet").get(); + } + _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory"); + if (f.optional_string_child("LastKDMWriteType")) { + if (f.optional_string_child("LastKDMWriteType").get() == "flat") { + _last_kdm_write_type = KDM_WRITE_FLAT; + } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") { + _last_kdm_write_type = KDM_WRITE_FOLDER; + } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") { + _last_kdm_write_type = KDM_WRITE_ZIP; + } + } + if (f.optional_string_child("LastDKDMWriteType")) { + if (f.optional_string_child("LastDKDMWriteType").get() == "internal") { + _last_dkdm_write_type = DKDM_WRITE_INTERNAL; + } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") { + _last_dkdm_write_type = DKDM_WRITE_FILE; + } + } + _frames_in_memory_multiplier = f.optional_number_child("FramesInMemoryMultiplier").get_value_or(3); + _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")) { int const id = i->number_attribute("Id"); - if (id >= 0 && id < NAG_COUNT) { - _nagged[id] = raw_convert(i->content()); + if (id >= 0 && id < NOTIFICATION_COUNT) { + _notification[id] = raw_convert(i->content()); } } - _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false); - _preview_sound_output = f.optional_string_child("PreviewSoundOutput"); - if (f.optional_string_child("CoverSheet")) { - _cover_sheet = f.optional_string_child("CoverSheet").get(); + + _barco_username = f.optional_string_child("BarcoUsername"); + _barco_password = f.optional_string_child("BarcoPassword"); + _christie_username = f.optional_string_child("ChristieUsername"); + _christie_password = f.optional_string_child("ChristiePassword"); + _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"); + if (pm && *pm == "window") { + _player_mode = PLAYER_MODE_WINDOW; + } else if (pm && *pm == "full") { + _player_mode = PLAYER_MODE_FULL; + } else if (pm && *pm == "dual") { + _player_mode = PLAYER_MODE_DUAL; + } + + _image_display = f.optional_number_child("ImageDisplay").get_value_or(0); + _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"); + _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory"); +#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)); } + _player_lock_file = f.optional_string_child("PlayerLockFile"); +#endif /* Replace any cinemas from config.xml with those from the configured file */ if (boost::filesystem::exists (_cinemas_file)) { @@ -357,13 +581,7 @@ try } catch (...) { if (have_existing ("config.xml")) { - - /* Make a copy of the configuration */ - try { - boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false)); - boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false)); - } catch (...) {} - + backup (); /* We have a config file but it didn't load */ FailedToLoad (); } @@ -380,16 +598,20 @@ boost::filesystem::path Config::path (string file, bool create_directories) { boost::filesystem::path p; + if (override_path) { + p = *override_path; + } else { #ifdef DCPOMATIC_OSX - p /= g_get_home_dir (); - p /= "Library"; - p /= "Preferences"; - p /= "com.dcpomatic"; - p /= "2"; + p /= g_get_home_dir (); + p /= "Library"; + p /= "Preferences"; + p /= "com.dcpomatic"; + p /= "2"; #else - p /= g_get_user_config_dir (); - p /= "dcpomatic2"; + p /= g_get_user_config_dir (); + p /= "dcpomatic2"; #endif + } boost::system::error_code ec; if (create_directories) { boost::filesystem::create_directories (p, ec); @@ -424,122 +646,406 @@ Config::write_config () const xmlpp::Document doc; xmlpp::Element* root = doc.create_root_node ("Config"); - root->add_child("Version")->add_child_text ("2"); + /* [XML] Version The version number of the configuration file format. */ + root->add_child("Version")->add_child_text (String::compose ("%1", _current_version)); + /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */ root->add_child("MasterEncodingThreads")->add_child_text (raw_convert (_master_encoding_threads)); + /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */ root->add_child("ServerEncodingThreads")->add_child_text (raw_convert (_server_encoding_threads)); if (_default_directory) { + /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */ root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ()); } + /* [XML] ServerPortBase Port number to use for frame encoding requests. ServerPortBase + 1 and + ServerPortBase + 2 are used for querying servers. ServerPortBase + 3 is used + by the batch converter to listen for job requests. + */ root->add_child("ServerPortBase")->add_child_text (raw_convert (_server_port_base)); + /* [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) { + /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags + as you like. + */ root->add_child("Server")->add_child_text (i); } + /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding + is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job. + */ root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0"); + /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */ root->add_child("TMSProtocol")->add_child_text (raw_convert (static_cast (_tms_protocol))); + /* [XML] TMSIP IP address of TMS. */ root->add_child("TMSIP")->add_child_text (_tms_ip); + /* [XML] TMSPath Path on the TMS to copy files to. */ root->add_child("TMSPath")->add_child_text (_tms_path); + /* [XML] TMSUser Username to log into the TMS with. */ root->add_child("TMSUser")->add_child_text (_tms_user); + /* [XML] TMSPassword Password to log into the TMS with. */ root->add_child("TMSPassword")->add_child_text (_tms_password); if (_cinema_sound_processor) { + /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating + gain changes from fader positions. Currently can only be dolby_cp750. + */ root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ()); } if (_language) { + /* [XML:opt] Language Language to use in the GUI e.g. fr_FR. */ root->add_child("Language")->add_child_text (_language.get()); } if (_default_container) { + /* [XML:opt] DefaultContainer ID of default container + to use when creating new films (185,239 or + 190). + */ root->add_child("DefaultContainer")->add_child_text (_default_container->id ()); } if (_default_scale_to) { + /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films + (see DefaultContainer for IDs). + */ root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ()); } if (_default_dcp_content_type) { + /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (FTR, SHR, + TLR, TST, XSN, RTG, TSR, POL, + PSA or ADV). */ root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ()); } + /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */ 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. */ root->add_child("DCPCreator")->add_child_text (_dcp_creator); - + /* [XML] DefaultUploadAfterMakeDCP 1 to default to uploading to a TMS after making a DCP, 0 to default to no upload. */ + root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_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. */ root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert (_default_j2k_bandwidth)); + /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */ 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"); if (_default_kdm_directory) { + /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */ root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ()); } + /* [XML] MailServer Hostname of SMTP server to use. */ root->add_child("MailServer")->add_child_text (_mail_server); + /* [XML] MailPort Port number to use on SMTP server. */ root->add_child("MailPort")->add_child_text (raw_convert (_mail_port)); + /* [XML] MailUser Username to use on SMTP server. */ root->add_child("MailUser")->add_child_text (_mail_user); + /* [XML] MailPassword Password to use on SMTP server. */ root->add_child("MailPassword")->add_child_text (_mail_password); + + /* [XML] KDMSubject Subject to use for KDM emails. */ 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) { + /* [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); } + /* [XML] KDMBCC BCC address to use for KDM emails. */ root->add_child("KDMBCC")->add_child_text (_kdm_bcc); + /* [XML] KDMEmail Text of KDM email. */ root->add_child("KDMEmail")->add_child_text (_kdm_email); + /* [XML] NotificationSubject Subject to use for notification emails. */ + root->add_child("NotificationSubject")->add_child_text (_notification_subject); + /* [XML] NotificationFrom From address to use for notification emails. */ + 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) { + /* [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); + } + /* [XML] NotificationBCC BCC address to use for notification emails. */ + root->add_child("NotificationBCC")->add_child_text (_notification_bcc); + /* [XML] NotificationEmail Text of notification email. */ + root->add_child("NotificationEmail")->add_child_text (_notification_email); + + /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */ root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0"); + /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */ root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0"); + /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */ root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert (_maximum_j2k_bandwidth)); + /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */ root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0"); + /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers. */ + root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "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. + */ root->add_child("LogTypes")->add_child_text (raw_convert (_log_types)); + /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */ root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0"); + /* [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"); #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"); DCPOMATIC_ASSERT (_signer_chain); BOOST_FOREACH (dcp::Certificate 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"); DCPOMATIC_ASSERT (_decryption_chain); BOOST_FOREACH (dcp::Certificate 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) { 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) { + root->add_child("PlayerHistory")->add_child_text (i.string ()); + } + + /* [XML] DKDMGroup A group of DKDMs, each with a Name attribute, containing other <DKDMGroup> + or <DKDM> tags. + */ + /* [XML] DKDM A DKDM as XML */ _dkdms->as_xml (root); + /* [XML] CinemasFile Filename of cinemas list file. */ root->add_child("CinemasFile")->add_child_text (_cinemas_file.string()); + /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */ root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0"); + /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */ root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0"); + /* [XML] KDMFilenameFormat Format for KDM filenames. */ root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ()); + /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */ root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ()); + /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */ root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ()); + /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */ root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ()); + /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */ root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0"); + /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */ for (int i = 0; i < NAG_COUNT; ++i) { xmlpp::Element* e = root->add_child ("Nagged"); e->set_attribute ("Id", raw_convert(i)); e->add_child_text (_nagged[i] ? "1" : "0"); } - root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0"); - if (_preview_sound_output) { - root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get()); + /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */ + root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0"); + if (_sound_output) { + /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */ + root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get()); } + /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */ root->add_child("CoverSheet")->add_child_text (_cover_sheet); + if (_last_player_load_directory) { + root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string()); + } + /* [XML] LastKDMWriteType Last type of KDM-write: flat for a flat file, folder for a folder or zip for a ZIP file. */ + if (_last_kdm_write_type) { + switch (_last_kdm_write_type.get()) { + case KDM_WRITE_FLAT: + root->add_child("LastKDMWriteType")->add_child_text("flat"); + break; + case KDM_WRITE_FOLDER: + root->add_child("LastKDMWriteType")->add_child_text("folder"); + break; + case KDM_WRITE_ZIP: + root->add_child("LastKDMWriteType")->add_child_text("zip"); + break; + } + } + /* [XML] LastDKDMWriteType Last type of DKDM-write: file for a file, internal to add to DCP-o-matic's list. */ + if (_last_dkdm_write_type) { + switch (_last_dkdm_write_type.get()) { + case DKDM_WRITE_INTERNAL: + root->add_child("LastDKDMWriteType")->add_child_text("internal"); + break; + case DKDM_WRITE_FILE: + root->add_child("LastDKDMWriteType")->add_child_text("file"); + break; + } + } + /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of + frames to be held in memory at once. + */ + root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert(_frames_in_memory_multiplier)); + + /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */ + if (_decode_reduction) { + root->add_child("DecodeReduction")->add_child_text(raw_convert(_decode_reduction.get())); + } + + /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */ + root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0"); + + /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */ + for (int i = 0; i < NOTIFICATION_COUNT; ++i) { + xmlpp::Element* e = root->add_child ("Notification"); + e->set_attribute ("Id", raw_convert(i)); + e->add_child_text (_notification[i] ? "1" : "0"); + } + + if (_barco_username) { + /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */ + root->add_child("BarcoUsername")->add_child_text(*_barco_username); + } + if (_barco_password) { + /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */ + root->add_child("BarcoPassword")->add_child_text(*_barco_password); + } + + if (_christie_username) { + /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */ + root->add_child("ChristieUsername")->add_child_text(*_christie_username); + } + if (_christie_password) { + /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */ + root->add_child("ChristiePassword")->add_child_text(*_christie_password); + } + + if (_gdc_username) { + /* [XML] GCCUsername 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. */ + 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. + */ + switch (_player_mode) { + case PLAYER_MODE_WINDOW: + root->add_child("PlayerMode")->add_child_text("window"); + break; + case PLAYER_MODE_FULL: + root->add_child("PlayerMode")->add_child_text("full"); + break; + case PLAYER_MODE_DUAL: + root->add_child("PlayerMode")->add_child_text("dual"); + break; + } + + /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */ + root->add_child("ImageDisplay")->add_child_text(raw_convert(_image_display)); + /* [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 */ + root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string()); + } + if (_player_content_directory) { + /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */ + root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string()); + } + if (_player_playlist_directory) { + /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */ + root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string()); + } + if (_player_kdm_directory) { + /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */ + root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string()); + } +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (_player_background_image) { + root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->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 (_player_lock_file) { + root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string()); + } +#endif try { - doc.write_to_file_formatted (path("config.xml").string ()); + string const s = doc.write_to_string_formatted (); + boost::filesystem::path tmp (string(config_file().string()).append(".tmp")); + FILE* 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); + fclose (f); + boost::filesystem::remove (config_file()); + boost::filesystem::rename (tmp, config_file()); } catch (xmlpp::exception& e) { string s = e.what (); trim (s); - throw FileError (s, path("config.xml")); + throw FileError (s, config_file()); } } @@ -555,7 +1061,9 @@ Config::write_cinemas () const } try { - doc.write_to_file_formatted (_cinemas_file.string ()); + doc.write_to_file_formatted (_cinemas_file.string() + ".tmp"); + boost::filesystem::remove (_cinemas_file); + boost::filesystem::rename (_cinemas_file.string() + ".tmp", _cinemas_file); } catch (xmlpp::exception& e) { string s = e.what (); trim (s); @@ -619,6 +1127,16 @@ Config::set_kdm_email_to_default () ); } +void +Config::set_notification_email_to_default () +{ + _notification_subject = _("DCP-o-matic notification"); + + _notification_email = _( + "$JOB_NAME: $JOB_STATUS" + ); +} + void Config::reset_kdm_email () { @@ -626,6 +1144,13 @@ Config::reset_kdm_email () changed (); } +void +Config::reset_notification_email () +{ + set_notification_email_to_default (); + changed (); +} + void Config::set_cover_sheet_to_default () { @@ -643,16 +1168,28 @@ Config::set_cover_sheet_to_default () void Config::add_to_history (boost::filesystem::path p) +{ + add_to_history_internal (_history, p); +} + +void +Config::add_to_player_history (boost::filesystem::path p) +{ + add_to_history_internal (_player_history, p); +} + +void +Config::add_to_history_internal (vector& h, boost::filesystem::path p) { /* Remove existing instances of this path in the history */ - _history.erase (remove (_history.begin(), _history.end(), p), _history.end ()); + h.erase (remove (h.begin(), h.end(), p), h.end ()); - _history.insert (_history.begin (), p); - if (_history.size() > HISTORY_SIZE) { - _history.pop_back (); + h.insert (h.begin (), p); + if (h.size() > HISTORY_SIZE) { + h.pop_back (); } - changed (); + changed (HISTORY); } bool @@ -679,6 +1216,10 @@ Config::read_cinemas (cxml::Document const & f) void Config::set_cinemas_file (boost::filesystem::path file) { + if (file == _cinemas_file) { + return; + } + _cinemas_file = file; if (boost::filesystem::exists (_cinemas_file)) { @@ -735,11 +1276,31 @@ Config::delete_template (string name) const boost::filesystem::remove (template_path (name)); } -/** @return Path to the config.xml, for telling the user what it is */ +/** @return Path to the config.xml containing the actual settings, following a link if required */ boost::filesystem::path -Config::config_path () +Config::config_file () { - return path("config.xml", false); + 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; + } + + /* See if there's a link */ + try { + f.read_file (main); + optional link = f.optional_string_child("Link"); + if (link) { + return *link; + } + } catch (xmlpp::exception& e) { + /* There as a problem reading the main configuration file, + so there can't be a link. + */ + } + + return main; } void @@ -748,3 +1309,37 @@ Config::reset_cover_sheet () set_cover_sheet_to_default (); changed (); } + +void +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()); + } catch (xmlpp::exception& e) { + string s = e.what (); + trim (s); + throw FileError (s, path("config.xml")); + } +} + +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); + link (new_file); +} + +bool +Config::have_write_permission () const +{ + FILE* f = fopen_boost (config_file(), "r+"); + if (!f) { + return false; + } + + fclose (f); + return true; +}