Basic and rather clumsy option to respect KDM validity windows.
[dcpomatic.git] / src / lib / config.cc
index 503ca9c5f30f14e26ad209a62151b2ff81362202..373b71df6b447685d8e96dab628b020d7ec2fb37 100644 (file)
@@ -64,9 +64,11 @@ using boost::algorithm::trim;
 using dcp::raw_convert;
 
 Config* Config::_instance = 0;
+int const Config::_current_version = 3;
 boost::signals2::signal<void ()> Config::FailedToLoad;
 boost::signals2::signal<void (string)> Config::Warning;
-boost::optional<boost::filesystem::path> Config::test_path;
+boost::signals2::signal<bool (void)> Config::BadSignerChain;
+boost::optional<boost::filesystem::path> Config::override_path;
 
 /** Construct default configuration */
 Config::Config ()
@@ -92,6 +94,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<string> ();
        _default_still_length = 10;
        _default_container = Ratio::from_id ("185");
@@ -109,6 +112,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 +152,19 @@ Config::set_defaults ()
        */
        _frames_in_memory_multiplier = 3;
        _decode_reduction = optional<int>();
+       _default_notify = false;
+       for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
+               _notification[i] = false;
+       }
+       _barco_username = optional<string>();
+       _barco_password = optional<string>();
+       _christie_username = optional<string>();
+       _christie_password = optional<string>();
+       _gdc_username = optional<string>();
+       _gdc_password = optional<string>();
+       _interface_complexity = INTERFACE_SIMPLE;
+       _player_mode = PLAYER_MODE_WINDOW;
+       _respect_kdm_validity_periods = false;
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -155,6 +175,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,6 +201,21 @@ 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
@@ -188,6 +224,10 @@ try
        f.read_file (config_file ());
 
        optional<int> version = f.optional_number_child<int> ("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<int>("NumLocalEncodingThreads")) {
                _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
@@ -284,6 +324,7 @@ try
        _mail_port = f.optional_number_child<int> ("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")) {
@@ -294,11 +335,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<int> ("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<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
        _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
@@ -329,6 +384,30 @@ 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<int>("Id");
+               if (id >= 0 && id < NAG_COUNT) {
+                       _nagged[id] = raw_convert<int>(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<bool> const remake = BadSignerChain();
+               if (remake && *remake) {
+                       _signer_chain = create_certificate_chain ();
+               }
+       }
+
        cxml::NodePtr decryption = f.optional_node_child ("Decryption");
        if (decryption) {
                shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
@@ -359,12 +438,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<int>("Id");
-               if (id >= 0 && id < NAG_COUNT) {
-                       _nagged[id] = raw_convert<int>(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");
@@ -390,6 +463,36 @@ try
        }
        _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
        _decode_reduction = f.optional_number_child<int>("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<int>("Id");
+               if (id >= 0 && id < NOTIFICATION_COUNT) {
+                       _notification[id] = raw_convert<int>(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<string> ic = f.optional_string_child("InterfaceComplexity");
+       if (ic && *ic == "full") {
+               _interface_complexity = INTERFACE_FULL;
+       }
+       optional<string> 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;
+       }
+
+       _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(false);
 
        /* Replace any cinemas from config.xml with those from the configured file */
        if (boost::filesystem::exists (_cinemas_file)) {
@@ -400,18 +503,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 ();
        }
@@ -428,8 +520,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 ();
@@ -476,8 +568,8 @@ 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<string> (_master_encoding_threads));
        /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
@@ -580,6 +672,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. */
@@ -593,6 +686,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 */
@@ -602,6 +710,8 @@ Config::write_config () const
        root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_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.
@@ -717,6 +827,60 @@ Config::write_config () const
                root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_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<string>(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("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
+
        try {
                doc.write_to_file_formatted(config_file().string());
        } catch (xmlpp::exception& e) {
@@ -802,6 +966,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 ()
 {
@@ -809,6 +983,13 @@ Config::reset_kdm_email ()
        changed ();
 }
 
+void
+Config::reset_notification_email ()
+{
+       set_notification_email_to_default ();
+       changed ();
+}
+
 void
 Config::set_cover_sheet_to_default ()
 {
@@ -874,6 +1055,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)) {