X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fconfig.cc;h=9dd6f638e7c6e16ba29545f942dc1388ed887378;hb=e6c52dcb012b441f2b0d3ba2345d91f2658644d2;hp=16df3779f1f11b36fd11b0af4ec5ba2dbe2fef73;hpb=0af38a850f967fd1848850a18432abc6314e9cc4;p=dcpomatic.git diff --git a/src/lib/config.cc b/src/lib/config.cc index 16df3779f..9dd6f638e 100644 --- a/src/lib/config.cc +++ b/src/lib/config.cc @@ -32,6 +32,7 @@ #include "film.h" #include "dkdm_wrapper.h" #include "compose.hpp" +#include "crypto.h" #include #include #include @@ -61,12 +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::optional Config::test_path; +boost::signals2::signal Config::BadSignerChain; +boost::optional Config::override_path; /** Construct default configuration */ Config::Config () @@ -92,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"); @@ -109,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; @@ -145,6 +154,32 @@ Config::set_defaults () */ _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_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; +#endif _allowed_dcp_frame_rates.clear (); _allowed_dcp_frame_rates.push_back (24); @@ -155,6 +190,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 (); } @@ -180,14 +216,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 (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(); @@ -253,11 +316,7 @@ try _default_scale_to = Ratio::from_id (c.get ()); } - c = f.optional_string_child ("DefaultDCPContentType"); - if (c) { - _default_dcp_content_type = DCPContentType::from_isdcf_name (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")) { @@ -288,6 +347,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")) { @@ -298,11 +358,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); @@ -333,13 +407,49 @@ try _signer_chain = create_certificate_chain (); } + /* 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"); if (decryption) { shared_ptr c (new dcp::CertificateChain ()); BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) { c->add (dcp::Certificate (i->content ())); } - c->set_key (decryption->string_child ("PrivateKey")); + optional key = decryption->optional_string_child ("PrivateKey"); +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (key) { + c->set_key (*key); + } else { + dcp::Data encrypted_key (path("private")); + dcp::Data iv (path("iv")); + c->set_key (dcpomatic::decrypt (encrypted_key, key_from_uuid(), iv)); + } +#else + DCPOMATIC_ASSERT (key); + c->set_key (*key); +#endif _decryption_chain = c; } else { _decryption_chain = create_certificate_chain (); @@ -363,12 +473,6 @@ 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")) { - int const id = i->number_attribute("Id"); - if (id >= 0 && id < NAG_COUNT) { - _nagged[id] = raw_convert(i->content()); - } - } /* 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"); @@ -394,6 +498,52 @@ try } _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 < NOTIFICATION_COUNT) { + _notification[id] = raw_convert(i->content()); + } + } + + _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); + _player_log_file = f.optional_string_child("PlayerLogFile"); + _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)) { @@ -404,18 +554,7 @@ try } catch (...) { if (have_existing ("config.xml")) { - - /* 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 (...) {} - + backup (); /* We have a config file but it didn't load */ FailedToLoad (); } @@ -432,8 +571,8 @@ boost::filesystem::path Config::path (string file, bool create_directories) { boost::filesystem::path p; - if (test_path) { - p = test_path.get(); + if (override_path) { + p = *override_path; } else { #ifdef DCPOMATIC_OSX p /= g_get_home_dir (); @@ -474,14 +613,27 @@ Config::write () const write_cinemas (); } +#ifdef DCPOMATIC_VARIANT_SWAROOP +/* Make up a key from the machine UUID */ +dcp::Data +Config::key_from_uuid () const +{ + dcp::Data key (dcpomatic::crypto_key_length()); + memset (key.data().get(), 0, key.size()); + string const magic = command_and_read ("dcpomatic2_uuid"); + strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length()); + return key; +} +#endif + void Config::write_config () const { xmlpp::Document doc; xmlpp::Element* root = doc.create_root_node ("Config"); - /* [XML] Version The version number of the configuration file format; currently 2. */ - 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. */ @@ -531,8 +683,8 @@ Config::write_config () const } if (_default_container) { /* [XML:opt] DefaultContainer ID of default container - * to use when creating new films (185,239 or - * 190). + to use when creating new films (185,239 or + 190). */ root->add_child("DefaultContainer")->add_child_text (_default_container->id ()); } @@ -584,6 +736,7 @@ Config::write_config () const 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. */ @@ -597,6 +750,21 @@ Config::write_config () const /* [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 */ @@ -606,6 +774,8 @@ Config::write_config () const 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. @@ -636,7 +806,14 @@ Config::write_config () const BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) { decryption->add_child("Certificate")->add_child_text (i.certificate (true)); } +#ifdef DCPOMATIC_VARIANT_SWAROOP + dcp::Data iv = dcpomatic::random_iv (); + dcp::Data encrypted_key = dcpomatic::encrypt (_decryption_chain->key().get(), key_from_uuid(), iv); + encrypted_key.write (path("private")); + iv.write (path("iv")); +#else 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. @@ -721,12 +898,103 @@ Config::write_config () const 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) { + root->add_child("BarcoUsername")->add_child_text(*_barco_username); + } + if (_barco_password) { + root->add_child("BarcoPassword")->add_child_text(*_barco_password); + } + + if (_christie_username) { + root->add_child("ChristieUsername")->add_child_text(*_christie_username); + } + if (_christie_password) { + root->add_child("ChristiePassword")->add_child_text(*_christie_password); + } + + if (_gdc_username) { + root->add_child("GDCUsername")->add_child_text(*_gdc_username); + } + if (_gdc_password) { + root->add_child("GDCPassword")->add_child_text(*_gdc_password); + } + + 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; + } + + 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; + } + + root->add_child("ImageDisplay")->add_child_text(raw_convert(_image_display)); + root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0"); + if (_player_log_file) { + root->add_child("PlayerLogFile")->add_child_text(_player_log_file->string()); + } + if (_player_content_directory) { + root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string()); + } + if (_player_playlist_directory) { + root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string()); + } + if (_player_kdm_directory) { + 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(config_file().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()); } } @@ -742,7 +1010,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); @@ -806,6 +1076,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 () { @@ -813,6 +1093,13 @@ Config::reset_kdm_email () changed (); } +void +Config::reset_notification_email () +{ + set_notification_email_to_default (); + changed (); +} + void Config::set_cover_sheet_to_default () { @@ -851,7 +1138,7 @@ Config::add_to_history_internal (vector& h, boost::file h.pop_back (); } - changed (); + changed (HISTORY); } bool @@ -878,6 +1165,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)) { @@ -946,10 +1237,16 @@ Config::config_file () } /* See if there's a link */ - f.read_file (main); - optional link = f.optional_string_child("Link"); - if (link) { - return *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; @@ -983,3 +1280,15 @@ Config::copy_and_link (boost::filesystem::path new_file) const 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; +}