Fix the build for older macOS.
[dcpomatic.git] / src / lib / config.cc
index cc9bd6ffdc177d619f810fffe61cc3ff45f0c619..419436995dc829337bf59c0cf81a604c01741603 100644 (file)
@@ -56,8 +56,6 @@ using std::list;
 using std::min;
 using std::max;
 using std::remove;
-using std::exception;
-using std::cerr;
 using std::shared_ptr;
 using std::make_shared;
 using boost::optional;
@@ -103,7 +101,8 @@ 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;
@@ -126,8 +125,8 @@ Config::set_defaults ()
 #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");
@@ -169,13 +168,13 @@ Config::set_defaults ()
        _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;
-       _minimum_frame_size = 65536;
+       _custom_languages.clear ();
+       _add_files_path = boost::none;
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -216,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 (...) {}
 }
 
@@ -231,7 +230,7 @@ Config::read ()
 try
 {
        cxml::Document f ("Config");
-       f.read_file (config_file ());
+       f.read_file (config_read_file());
 
        auto version = f.optional_number_child<int> ("Version");
        if (version && *version < _current_version) {
@@ -308,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<int>("DefaultStillLength").get_value_or (10);
        _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
        _default_audio_delay = f.optional_number_child<int>("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
@@ -468,8 +466,8 @@ try
                        _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"));
@@ -536,11 +534,6 @@ try
                _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");
@@ -550,7 +543,16 @@ try
                _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
        }
 
-       _minimum_frame_size = f.optional_number_child<int>("MinimumFrameSize").get_value_or(65536);
+       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) {}
+       }
+
+       _add_files_path = f.optional_string_child("AddFilesPath");
 
        if (boost::filesystem::exists (_cinemas_file)) {
                cxml::Document f ("Cinemas");
@@ -678,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 <code>&lt;ContentVersion&gt;</code>,
-          <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
-          <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
-          <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
-          <code>&lt;MasteredLuminance&gt;</code>.
-       */
-       _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<string> (_default_still_length));
        /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
@@ -694,6 +688,11 @@ Config::write_config () const
        root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_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 ());
@@ -774,8 +773,13 @@ 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
 
        /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
@@ -952,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) {
@@ -975,23 +975,31 @@ Config::write_config () const
        if (_audio_mapping) {
                _audio_mapping->as_xml (root->add_child("AudioMapping"));
        }
-       root->add_child("MinimumFrameSize")->add_child_text(raw_convert<string>(_minimum_frame_size));
+       for (auto const& i: _custom_languages) {
+               root->add_child("CustomLanguage")->add_child_text(i.to_string());
+       }
+       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());
+       }
+
+       auto target = config_write_file();
 
        try {
                auto const s = doc.write_to_string_formatted ();
-               boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
+               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.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);
        }
 }
 
@@ -1185,12 +1193,14 @@ Config::clean_history_internal (vector<boost::filesystem::path>& 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)
 {
@@ -1234,41 +1244,23 @@ Config::read_dkdm_recipients (cxml::Document const & f)
        }
 }
 
-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<const Film> film, string name) const
 {
-       film->write_template (template_path (name));
+       film->write_template (template_write_path(name));
 }
 
+
 list<string>
 Config::templates () const
 {
-       if (!boost::filesystem::exists (path ("templates"))) {
+       if (!boost::filesystem::exists(read_path("templates"))) {
                return {};
        }
 
        list<string> n;
-       for (auto const& i: boost::filesystem::directory_iterator(path("templates"))) {
+       for (auto const& i: boost::filesystem::directory_iterator(read_path("templates"))) {
                n.push_back (i.path().filename().string());
        }
        return n;
@@ -1277,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_read_path (string name) const
+{
+       return read_path("templates") / tidy_for_filename (name);
 }
 
+
 boost::filesystem::path
-Config::template_path (string name) const
+Config::template_write_path (string name) const
 {
-       return path("templates") / tidy_for_filename (name);
+       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");
-       auto 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;
@@ -1325,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 ()
 {
@@ -1338,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"));
        }
 }
 
@@ -1350,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
 {
-       auto f = fopen_boost (config_file(), "r+");
+       auto f = fopen_boost (config_write_file(), "r+");
        if (!f) {
                return false;
        }
@@ -1415,3 +1430,14 @@ Config::set_audio_mapping_to_default ()
        _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 ();
+       }
+}
+