2 Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
26 #include "dcp_content_type.h"
27 #include "cinema_sound_processor.h"
28 #include "colour_conversion.h"
33 #include "dkdm_wrapper.h"
34 #include <dcp/raw_convert.h>
35 #include <dcp/name_format.h>
36 #include <dcp/certificate_chain.h>
37 #include <libcxml/cxml.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/filesystem.hpp>
41 #include <boost/algorithm/string.hpp>
42 #include <boost/foreach.hpp>
43 #include <boost/thread.hpp>
59 using boost::shared_ptr;
60 using boost::optional;
61 using boost::dynamic_pointer_cast;
62 using boost::algorithm::trim;
63 using dcp::raw_convert;
65 Config* Config::_instance = 0;
66 boost::signals2::signal<void ()> Config::FailedToLoad;
68 /** Construct default configuration */
70 /* DKDMs are not considered a thing to reset on set_defaults() */
71 : _dkdms (new DKDMGroup ("root"))
77 Config::set_defaults ()
79 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
80 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
81 _server_port_base = 6192;
82 _use_any_servers = true;
84 _only_servers_encode = false;
85 _tms_protocol = PROTOCOL_SCP;
90 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
91 _allow_any_dcp_frame_rate = false;
92 _language = optional<string> ();
93 _default_still_length = 10;
94 _default_container = Ratio::from_id ("185");
95 _default_scale_to = 0;
96 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
97 _default_dcp_audio_channels = 6;
98 _default_j2k_bandwidth = 100000000;
99 _default_audio_delay = 0;
100 _default_interop = true;
108 _check_for_updates = false;
109 _check_for_test_updates = false;
110 _maximum_j2k_bandwidth = 250000000;
111 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
112 _analyse_ebur128 = true;
113 _automatic_audio_analysis = false;
114 #ifdef DCPOMATIC_WINDOWS
115 _win32_console = false;
117 _cinemas_file = path ("cinemas.xml");
118 _show_hints_before_make_dcp = true;
119 _confirm_kdm_email = true;
120 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
121 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
122 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
123 _dcp_asset_filename_format = dcp::NameFormat ("%t");
124 _jump_to_selected = true;
125 for (int i = 0; i < NAG_COUNT; ++i) {
128 _preview_sound = false;
129 _preview_sound_output = optional<string> ();
131 _allowed_dcp_frame_rates.clear ();
132 _allowed_dcp_frame_rates.push_back (24);
133 _allowed_dcp_frame_rates.push_back (25);
134 _allowed_dcp_frame_rates.push_back (30);
135 _allowed_dcp_frame_rates.push_back (48);
136 _allowed_dcp_frame_rates.push_back (50);
137 _allowed_dcp_frame_rates.push_back (60);
139 set_kdm_email_to_default ();
140 set_cover_sheet_to_default ();
144 Config::restore_defaults ()
146 Config::instance()->set_defaults ();
147 Config::instance()->changed ();
150 shared_ptr<dcp::CertificateChain>
151 Config::create_certificate_chain ()
153 return shared_ptr<dcp::CertificateChain> (
154 new dcp::CertificateChain (
158 ".dcpomatic.smpte-430-2.ROOT",
159 ".dcpomatic.smpte-430-2.INTERMEDIATE",
160 "CS.dcpomatic.smpte-430-2.LEAF"
169 boost::filesystem::path const config_path = config_file ();
170 if (!boost::filesystem::exists (config_path)) {
174 cxml::Document f ("Config");
175 f.read_file (config_path);
177 optional<int> version = f.optional_number_child<int> ("Version");
179 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
180 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
182 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
183 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
186 _default_directory = f.optional_string_child ("DefaultDirectory");
187 if (_default_directory && _default_directory->empty ()) {
188 /* We used to store an empty value for this to mean "none set" */
189 _default_directory = boost::optional<boost::filesystem::path> ();
192 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
194 b = f.optional_number_child<int> ("ServerPortBase");
196 _server_port_base = b.get ();
198 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
199 _use_any_servers = u.get_value_or (true);
201 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
202 if (i->node_children("HostName").size() == 1) {
203 _servers.push_back (i->string_child ("HostName"));
205 _servers.push_back (i->content ());
209 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
210 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
211 _tms_ip = f.string_child ("TMSIP");
212 _tms_path = f.string_child ("TMSPath");
213 _tms_user = f.string_child ("TMSUser");
214 _tms_password = f.string_child ("TMSPassword");
217 c = f.optional_string_child ("SoundProcessor");
219 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
221 c = f.optional_string_child ("CinemaSoundProcessor");
223 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
226 _language = f.optional_string_child ("Language");
228 c = f.optional_string_child ("DefaultContainer");
230 _default_container = Ratio::from_id (c.get ());
233 c = f.optional_string_child ("DefaultScaleTo");
235 _default_scale_to = Ratio::from_id (c.get ());
238 c = f.optional_string_child ("DefaultDCPContentType");
240 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
243 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
245 if (f.optional_string_child ("DCPMetadataIssuer")) {
246 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
247 } else if (f.optional_string_child ("DCPIssuer")) {
248 _dcp_issuer = f.string_child ("DCPIssuer");
251 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
253 if (version && version.get() >= 2) {
254 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
256 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
259 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
260 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
261 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
262 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
263 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
265 /* Load any cinemas from config.xml */
268 _mail_server = f.string_child ("MailServer");
269 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
270 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
271 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
272 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
273 _kdm_from = f.string_child ("KDMFrom");
274 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
275 if (!i->content().empty()) {
276 _kdm_cc.push_back (i->content ());
279 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
280 _kdm_email = f.string_child ("KDMEmail");
282 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
283 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
285 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
286 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
288 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
289 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
290 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
291 #ifdef DCPOMATIC_WINDOWS
292 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
295 list<cxml::NodePtr> his = f.node_children ("History");
296 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
297 _history.push_back (i->content ());
300 cxml::NodePtr signer = f.optional_node_child ("Signer");
302 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
303 /* Read the signing certificates and private key in from the config file */
304 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
305 c->add (dcp::Certificate (i->content ()));
307 c->set_key (signer->string_child ("PrivateKey"));
310 /* Make a new set of signing certificates and key */
311 _signer_chain = create_certificate_chain ();
314 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
316 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
317 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
318 c->add (dcp::Certificate (i->content ()));
320 c->set_key (decryption->string_child ("PrivateKey"));
321 _decryption_chain = c;
323 _decryption_chain = create_certificate_chain ();
326 if (f.optional_node_child("DKDMGroup")) {
327 /* New-style: all DKDMs in a group */
328 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
330 /* Old-style: one or more DKDM nodes */
331 _dkdms.reset (new DKDMGroup ("root"));
332 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
333 _dkdms->add (DKDMBase::read (i));
336 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
337 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
338 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
339 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
340 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
341 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
342 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
343 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
344 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
345 int const id = i->number_attribute<int>("Id");
346 if (id >= 0 && id < NAG_COUNT) {
347 _nagged[id] = raw_convert<int>(i->content());
350 _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
351 _preview_sound_output = f.optional_string_child("PreviewSoundOutput");
352 if (f.optional_string_child("CoverSheet")) {
353 _cover_sheet = f.optional_string_child("CoverSheet").get();
356 /* Replace any cinemas from config.xml with those from the configured file */
357 if (boost::filesystem::exists (_cinemas_file)) {
358 cxml::Document f ("Cinemas");
359 f.read_file (_cinemas_file);
364 if (have_existing ("config.xml")) {
366 /* Make a copy of the configuration */
368 boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
369 boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
372 /* We have a config file but it didn't load */
376 /* Make a new set of signing certificates and key */
377 _signer_chain = create_certificate_chain ();
378 /* And similar for decryption of KDMs */
379 _decryption_chain = create_certificate_chain ();
383 /** @return Filename to write configuration to */
384 boost::filesystem::path
385 Config::path (string file, bool create_directories)
387 boost::filesystem::path p;
389 p /= g_get_home_dir ();
392 p /= "com.dcpomatic";
395 p /= g_get_user_config_dir ();
398 boost::system::error_code ec;
399 if (create_directories) {
400 boost::filesystem::create_directories (p, ec);
406 /** @return Singleton instance */
410 if (_instance == 0) {
411 _instance = new Config;
418 /** Write our configuration to disk */
420 Config::write () const
427 Config::write_config () const
430 xmlpp::Element* root = doc.create_root_node ("Config");
432 /* [XML] Version The version number of the configuration file format; currently 2. */
433 root->add_child("Version")->add_child_text ("2");
434 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
435 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
436 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
437 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
438 if (_default_directory) {
439 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
440 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
442 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
443 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
444 by the batch converter to listen for job requests.
446 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
447 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
448 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
450 BOOST_FOREACH (string i, _servers) {
451 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
454 root->add_child("Server")->add_child_text (i);
457 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
458 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
460 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
461 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
462 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
463 /* [XML] TMSIP IP address of TMS */
464 root->add_child("TMSIP")->add_child_text (_tms_ip);
465 /* [XML] TMSPath Path on the TMS to copy files to */
466 root->add_child("TMSPath")->add_child_text (_tms_path);
467 /* [XML] TMSUser Username to log into the TMS with */
468 root->add_child("TMSUser")->add_child_text (_tms_user);
469 /* [XML] TMSPassword Password to log into the TMS with */
470 root->add_child("TMSPassword")->add_child_text (_tms_password);
471 if (_cinema_sound_processor) {
472 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
473 gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
475 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
478 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
479 root->add_child("Language")->add_child_text (_language.get());
481 if (_default_container) {
482 /* [XML:opt] DefaultContainer ID of default container to use when creating new films (<code>119</code>, <code>133</code>,
483 <code>138</code>, <code>143</code>, <code>166</code>, <code>178</code>, <code>185</code>, <code>235</code>,
484 <code>239</code> or <code>full-frame</code>).
486 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
488 if (_default_scale_to) {
489 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
490 (see <code>DefaultContainer</code> for IDs).
492 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
494 if (_default_dcp_content_type) {
495 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
496 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
497 <code>PSA</code> or <code>ADV</code>). */
498 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
500 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
501 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
502 /* [XML] DCPIssuer Issuer text to write into CPL files. */
503 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
504 /* [XML] DCPIssuer Creator text to write into CPL files. */
505 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
507 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
508 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
509 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
510 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
511 <code><MasteredLuminance></code>.
513 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
515 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
516 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
517 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
518 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
519 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
520 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
521 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
522 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
523 if (_default_kdm_directory) {
524 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
525 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
527 /* [XML] MailServer Hostname of SMTP server to use. */
528 root->add_child("MailServer")->add_child_text (_mail_server);
529 /* [XML] MailPort Port number to use on SMTP server. */
530 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
531 /* [XML] MailUser Username to use on SMTP server. */
532 root->add_child("MailUser")->add_child_text (_mail_user);
533 /* [XML] MailPassword Password to use on SMTP server. */
534 root->add_child("MailPassword")->add_child_text (_mail_password);
535 /* [XML] KDMSubject Subject to use for KDM emails. */
536 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
537 /* [XML] KDMFrom From address to use for KDM emails. */
538 root->add_child("KDMFrom")->add_child_text (_kdm_from);
539 BOOST_FOREACH (string i, _kdm_cc) {
540 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
541 root->add_child("KDMCC")->add_child_text (i);
543 /* [XML] KDMBCC BCC address to use for KDM emails */
544 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
545 /* [XML] KDMEmail Text of KDM email */
546 root->add_child("KDMEmail")->add_child_text (_kdm_email);
548 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
549 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
550 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
551 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
553 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
554 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
555 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
556 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
557 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
558 to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
561 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
562 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
563 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
564 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
565 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
566 #ifdef DCPOMATIC_WINDOWS
567 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
568 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
571 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
572 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
574 xmlpp::Element* signer = root->add_child ("Signer");
575 DCPOMATIC_ASSERT (_signer_chain);
576 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
577 signer->add_child("Certificate")->add_child_text (i.certificate (true));
579 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
581 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
582 xmlpp::Element* decryption = root->add_child ("Decryption");
583 DCPOMATIC_ASSERT (_decryption_chain);
584 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
585 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
587 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
589 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
592 BOOST_FOREACH (boost::filesystem::path i, _history) {
593 root->add_child("History")->add_child_text (i.string ());
596 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
597 or <code><DKDM></code> tags.
599 /* [XML] DKDM A DKDM as XML */
600 _dkdms->as_xml (root);
602 /* [XML] CinemasFile Filename of cinemas list file */
603 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
604 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
605 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
606 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
607 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
608 /* [XML] KDMFilenameFormat Format for KDM filenames */
609 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
610 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
611 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
612 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
613 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
614 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
615 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
616 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
617 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
618 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
619 for (int i = 0; i < NAG_COUNT; ++i) {
620 xmlpp::Element* e = root->add_child ("Nagged");
621 e->set_attribute ("Id", raw_convert<string>(i));
622 e->add_child_text (_nagged[i] ? "1" : "0");
624 /* [XML] PreviewSound 1 to use sound in the GUI preview, otherwise 0 */
625 root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
626 if (_preview_sound_output) {
627 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
628 root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
630 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
631 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
634 doc.write_to_file_formatted(config_file().string());
635 } catch (xmlpp::exception& e) {
636 string s = e.what ();
638 throw FileError (s, path("config.xml"));
643 Config::write_cinemas () const
646 xmlpp::Element* root = doc.create_root_node ("Cinemas");
647 root->add_child("Version")->add_child_text ("1");
649 BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
650 i->as_xml (root->add_child ("Cinema"));
654 doc.write_to_file_formatted (_cinemas_file.string ());
655 } catch (xmlpp::exception& e) {
656 string s = e.what ();
658 throw FileError (s, _cinemas_file);
662 boost::filesystem::path
663 Config::default_directory_or (boost::filesystem::path a) const
665 return directory_or (_default_directory, a);
668 boost::filesystem::path
669 Config::default_kdm_directory_or (boost::filesystem::path a) const
671 return directory_or (_default_kdm_directory, a);
674 boost::filesystem::path
675 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
681 boost::system::error_code ec;
682 bool const e = boost::filesystem::exists (*dir, ec);
698 Config::changed (Property what)
704 Config::set_kdm_email_to_default ()
706 _kdm_subject = _("KDM delivery: $CPL_NAME");
709 "Dear Projectionist\n\n"
710 "Please find attached KDMs for $CPL_NAME.\n\n"
711 "Cinema: $CINEMA_NAME\n"
712 "Screen(s): $SCREENS\n\n"
713 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
714 "Best regards,\nDCP-o-matic"
719 Config::reset_kdm_email ()
721 set_kdm_email_to_default ();
726 Config::set_cover_sheet_to_default ()
731 "Format: $CONTAINER\n"
733 "Audio Language: $AUDIO_LANGUAGE\n"
734 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
741 Config::add_to_history (boost::filesystem::path p)
743 /* Remove existing instances of this path in the history */
744 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
746 _history.insert (_history.begin (), p);
747 if (_history.size() > HISTORY_SIZE) {
748 _history.pop_back ();
755 Config::have_existing (string file)
757 return boost::filesystem::exists (path (file, false));
761 Config::read_cinemas (cxml::Document const & f)
764 list<cxml::NodePtr> cin = f.node_children ("Cinema");
765 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
766 /* Slightly grotty two-part construction of Cinema here so that we can use
769 shared_ptr<Cinema> cinema (new Cinema (i));
770 cinema->read_screens (i);
771 _cinemas.push_back (cinema);
776 Config::set_cinemas_file (boost::filesystem::path file)
778 _cinemas_file = file;
780 if (boost::filesystem::exists (_cinemas_file)) {
781 /* Existing file; read it in */
782 cxml::Document f ("Cinemas");
783 f.read_file (_cinemas_file);
791 Config::save_template (shared_ptr<const Film> film, string name) const
793 film->write_template (template_path (name));
797 Config::templates () const
799 if (!boost::filesystem::exists (path ("templates"))) {
800 return list<string> ();
804 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
805 n.push_back (i->path().filename().string());
811 Config::existing_template (string name) const
813 return boost::filesystem::exists (template_path (name));
816 boost::filesystem::path
817 Config::template_path (string name) const
819 return path("templates") / tidy_for_filename (name);
823 Config::rename_template (string old_name, string new_name) const
825 boost::filesystem::rename (template_path (old_name), template_path (new_name));
829 Config::delete_template (string name) const
831 boost::filesystem::remove (template_path (name));
834 /** @return Path to the config.xml containing the actual settings, following a link if required */
835 boost::filesystem::path
836 Config::config_file ()
838 cxml::Document f ("Config");
839 boost::filesystem::path main = path("config.xml", false);
840 if (!boost::filesystem::exists (main)) {
841 /* It doesn't exist, so there can't be any links; just return it */
845 /* See if there's a link */
847 optional<string> link = f.optional_string_child("Link");
856 Config::reset_cover_sheet ()
858 set_cover_sheet_to_default ();
863 Config::link (boost::filesystem::path new_file) const
866 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
868 doc.write_to_file_formatted(path("config.xml", true).string());
869 } catch (xmlpp::exception& e) {
870 string s = e.what ();
872 throw FileError (s, path("config.xml"));
877 Config::copy_and_link (boost::filesystem::path new_file) const
880 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);