2a8a3cc89c6efb1f7733b3d3cb660643d0835459
[dcpomatic.git] / src / lib / config.cc
1 /*
2     Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21 #include "config.h"
22 #include "filter.h"
23 #include "ratio.h"
24 #include "types.h"
25 #include "log.h"
26 #include "dcp_content_type.h"
27 #include "cinema_sound_processor.h"
28 #include "colour_conversion.h"
29 #include "cinema.h"
30 #include "util.h"
31 #include "cross.h"
32 #include "film.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>
38 #include <glib.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>
44 #include <cstdlib>
45 #include <fstream>
46 #include <iostream>
47
48 #include "i18n.h"
49
50 using std::vector;
51 using std::cout;
52 using std::ifstream;
53 using std::string;
54 using std::list;
55 using std::max;
56 using std::remove;
57 using std::exception;
58 using std::cerr;
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;
64
65 Config* Config::_instance = 0;
66 boost::signals2::signal<void ()> Config::FailedToLoad;
67 boost::signals2::signal<void (string)> Config::Warning;
68
69 /** Construct default configuration */
70 Config::Config ()
71         /* DKDMs are not considered a thing to reset on set_defaults() */
72         : _dkdms (new DKDMGroup ("root"))
73 {
74         set_defaults ();
75 }
76
77 void
78 Config::set_defaults ()
79 {
80         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
81         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
82         _server_port_base = 6192;
83         _use_any_servers = true;
84         _servers.clear ();
85         _only_servers_encode = false;
86         _tms_protocol = PROTOCOL_SCP;
87         _tms_ip = "";
88         _tms_path = ".";
89         _tms_user = "";
90         _tms_password = "";
91         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
92         _allow_any_dcp_frame_rate = false;
93         _language = optional<string> ();
94         _default_still_length = 10;
95         _default_container = Ratio::from_id ("185");
96         _default_scale_to = 0;
97         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
98         _default_dcp_audio_channels = 6;
99         _default_j2k_bandwidth = 100000000;
100         _default_audio_delay = 0;
101         _default_interop = true;
102         _mail_server = "";
103         _mail_port = 25;
104         _mail_user = "";
105         _mail_password = "";
106         _kdm_from = "";
107         _kdm_cc.clear ();
108         _kdm_bcc = "";
109         _check_for_updates = false;
110         _check_for_test_updates = false;
111         _maximum_j2k_bandwidth = 250000000;
112         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
113         _analyse_ebur128 = true;
114         _automatic_audio_analysis = false;
115 #ifdef DCPOMATIC_WINDOWS
116         _win32_console = false;
117 #endif
118         _cinemas_file = path ("cinemas.xml");
119         _show_hints_before_make_dcp = true;
120         _confirm_kdm_email = true;
121         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
122         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
123         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
124         _dcp_asset_filename_format = dcp::NameFormat ("%t");
125         _jump_to_selected = true;
126         for (int i = 0; i < NAG_COUNT; ++i) {
127                 _nagged[i] = false;
128         }
129         _sound = false;
130         _sound_output = optional<string> ();
131         _last_kdm_write_type = KDM_WRITE_FLAT;
132
133         /* I think the scaling factor here should be the ratio of the longest frame
134            encode time to the shortest; if the thread count is T, longest time is L
135            and the shortest time S we could encode L/S frames per thread whilst waiting
136            for the L frame to encode so we might have to store LT/S frames.
137
138            However we don't want to use too much memory, so keep it a bit lower than we'd
139            perhaps like.  A J2K frame is typically about 1Mb so 3 here will mean we could
140            use about 240Mb with 72 encoding threads.
141         */
142         _frames_in_memory_multiplier = 3;
143
144         _allowed_dcp_frame_rates.clear ();
145         _allowed_dcp_frame_rates.push_back (24);
146         _allowed_dcp_frame_rates.push_back (25);
147         _allowed_dcp_frame_rates.push_back (30);
148         _allowed_dcp_frame_rates.push_back (48);
149         _allowed_dcp_frame_rates.push_back (50);
150         _allowed_dcp_frame_rates.push_back (60);
151
152         set_kdm_email_to_default ();
153         set_cover_sheet_to_default ();
154 }
155
156 void
157 Config::restore_defaults ()
158 {
159         Config::instance()->set_defaults ();
160         Config::instance()->changed ();
161 }
162
163 shared_ptr<dcp::CertificateChain>
164 Config::create_certificate_chain ()
165 {
166         return shared_ptr<dcp::CertificateChain> (
167                 new dcp::CertificateChain (
168                         openssl_path(),
169                         "dcpomatic.com",
170                         "dcpomatic.com",
171                         ".dcpomatic.smpte-430-2.ROOT",
172                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
173                         "CS.dcpomatic.smpte-430-2.LEAF"
174                         )
175                 );
176 }
177
178 void
179 Config::read ()
180 try
181 {
182         cxml::Document f ("Config");
183         f.read_file (config_file ());
184
185         optional<int> version = f.optional_number_child<int> ("Version");
186
187         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
188                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
189         } else {
190                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
191                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
192         }
193
194         _default_directory = f.optional_string_child ("DefaultDirectory");
195         if (_default_directory && _default_directory->empty ()) {
196                 /* We used to store an empty value for this to mean "none set" */
197                 _default_directory = boost::optional<boost::filesystem::path> ();
198         }
199
200         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
201         if (!b) {
202                 b = f.optional_number_child<int> ("ServerPortBase");
203         }
204         _server_port_base = b.get ();
205
206         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
207         _use_any_servers = u.get_value_or (true);
208
209         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
210                 if (i->node_children("HostName").size() == 1) {
211                         _servers.push_back (i->string_child ("HostName"));
212                 } else {
213                         _servers.push_back (i->content ());
214                 }
215         }
216
217         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
218         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
219         _tms_ip = f.string_child ("TMSIP");
220         _tms_path = f.string_child ("TMSPath");
221         _tms_user = f.string_child ("TMSUser");
222         _tms_password = f.string_child ("TMSPassword");
223
224         optional<string> c;
225         c = f.optional_string_child ("SoundProcessor");
226         if (c) {
227                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
228         }
229         c = f.optional_string_child ("CinemaSoundProcessor");
230         if (c) {
231                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
232         }
233
234         _language = f.optional_string_child ("Language");
235
236         c = f.optional_string_child ("DefaultContainer");
237         if (c) {
238                 _default_container = Ratio::from_id (c.get ());
239         }
240
241         if (_default_container && !_default_container->used_for_container()) {
242                 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
243                 _default_container = Ratio::from_id ("185");
244         }
245
246         c = f.optional_string_child ("DefaultScaleTo");
247         if (c) {
248                 _default_scale_to = Ratio::from_id (c.get ());
249         }
250
251         c = f.optional_string_child ("DefaultDCPContentType");
252         if (c) {
253                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
254         }
255
256         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
257
258         if (f.optional_string_child ("DCPMetadataIssuer")) {
259                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
260         } else if (f.optional_string_child ("DCPIssuer")) {
261                 _dcp_issuer = f.string_child ("DCPIssuer");
262         }
263
264         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
265
266         if (version && version.get() >= 2) {
267                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
268         } else {
269                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
270         }
271
272         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
273         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
274         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
275         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
276         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
277
278         /* Load any cinemas from config.xml */
279         read_cinemas (f);
280
281         _mail_server = f.string_child ("MailServer");
282         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
283         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
284         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
285         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
286         _kdm_from = f.string_child ("KDMFrom");
287         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
288                 if (!i->content().empty()) {
289                         _kdm_cc.push_back (i->content ());
290                 }
291         }
292         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
293         _kdm_email = f.string_child ("KDMEmail");
294
295         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
296         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
297
298         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
299         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
300
301         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
302         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
303         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
304 #ifdef DCPOMATIC_WINDOWS
305         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
306 #endif
307
308         list<cxml::NodePtr> his = f.node_children ("History");
309         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
310                 _history.push_back (i->content ());
311         }
312
313         cxml::NodePtr signer = f.optional_node_child ("Signer");
314         if (signer) {
315                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
316                 /* Read the signing certificates and private key in from the config file */
317                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
318                         c->add (dcp::Certificate (i->content ()));
319                 }
320                 c->set_key (signer->string_child ("PrivateKey"));
321                 _signer_chain = c;
322         } else {
323                 /* Make a new set of signing certificates and key */
324                 _signer_chain = create_certificate_chain ();
325         }
326
327         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
328         if (decryption) {
329                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
330                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
331                         c->add (dcp::Certificate (i->content ()));
332                 }
333                 c->set_key (decryption->string_child ("PrivateKey"));
334                 _decryption_chain = c;
335         } else {
336                 _decryption_chain = create_certificate_chain ();
337         }
338
339         if (f.optional_node_child("DKDMGroup")) {
340                 /* New-style: all DKDMs in a group */
341                 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
342         } else {
343                 /* Old-style: one or more DKDM nodes */
344                 _dkdms.reset (new DKDMGroup ("root"));
345                 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
346                         _dkdms->add (DKDMBase::read (i));
347                 }
348         }
349         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
350         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
351         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
352         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
353         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
354         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
355         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
356         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
357         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
358                 int const id = i->number_attribute<int>("Id");
359                 if (id >= 0 && id < NAG_COUNT) {
360                         _nagged[id] = raw_convert<int>(i->content());
361                 }
362         }
363         /* The variable was renamed but not the XML tag */
364         _sound = f.optional_bool_child("PreviewSound").get_value_or (false);
365         _sound_output = f.optional_string_child("PreviewSoundOutput");
366         if (f.optional_string_child("CoverSheet")) {
367                 _cover_sheet = f.optional_string_child("CoverSheet").get();
368         }
369         _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
370         if (f.optional_string_child("LastKDMWriteType")) {
371                 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
372                         _last_kdm_write_type = KDM_WRITE_FLAT;
373                 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
374                         _last_kdm_write_type = KDM_WRITE_FOLDER;
375                 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
376                         _last_kdm_write_type = KDM_WRITE_ZIP;
377                 }
378         }
379         _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
380
381         /* Replace any cinemas from config.xml with those from the configured file */
382         if (boost::filesystem::exists (_cinemas_file)) {
383                 cxml::Document f ("Cinemas");
384                 f.read_file (_cinemas_file);
385                 read_cinemas (f);
386         }
387 }
388 catch (...) {
389         if (have_existing ("config.xml")) {
390
391                 /* Make a copy of the configuration */
392                 try {
393                         boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
394                         boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
395                 } catch (...) {}
396
397                 /* We have a config file but it didn't load */
398                 FailedToLoad ();
399         }
400         set_defaults ();
401         /* Make a new set of signing certificates and key */
402         _signer_chain = create_certificate_chain ();
403         /* And similar for decryption of KDMs */
404         _decryption_chain = create_certificate_chain ();
405         write ();
406 }
407
408 /** @return Filename to write configuration to */
409 boost::filesystem::path
410 Config::path (string file, bool create_directories)
411 {
412         boost::filesystem::path p;
413 #ifdef DCPOMATIC_OSX
414         p /= g_get_home_dir ();
415         p /= "Library";
416         p /= "Preferences";
417         p /= "com.dcpomatic";
418         p /= "2";
419 #else
420         p /= g_get_user_config_dir ();
421         p /= "dcpomatic2";
422 #endif
423         boost::system::error_code ec;
424         if (create_directories) {
425                 boost::filesystem::create_directories (p, ec);
426         }
427         p /= file;
428         return p;
429 }
430
431 /** @return Singleton instance */
432 Config *
433 Config::instance ()
434 {
435         if (_instance == 0) {
436                 _instance = new Config;
437                 _instance->read ();
438         }
439
440         return _instance;
441 }
442
443 /** Write our configuration to disk */
444 void
445 Config::write () const
446 {
447         write_config ();
448         write_cinemas ();
449 }
450
451 void
452 Config::write_config () const
453 {
454         xmlpp::Document doc;
455         xmlpp::Element* root = doc.create_root_node ("Config");
456
457         /* [XML] Version The version number of the configuration file format; currently 2. */
458         root->add_child("Version")->add_child_text ("2");
459         /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
460         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
461         /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
462         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
463         if (_default_directory) {
464                 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
465                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
466         }
467         /* [XML] ServerPortBase Port number to use for frame encoding requests.  <code>ServerPortBase</code> + 1 and
468            <code>ServerPortBase</code> + 2 are used for querying servers.  <code>ServerPortBase</code> + 3 is used
469            by the batch converter to listen for job requests.
470         */
471         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
472         /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
473         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
474
475         BOOST_FOREACH (string i, _servers) {
476                 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
477                    as you like.
478                 */
479                 root->add_child("Server")->add_child_text (i);
480         }
481
482         /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
483            is done by the encoding servers.  0 to set the master to do some encoding as well as coordinating the job.
484         */
485         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
486         /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
487         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
488         /* [XML] TMSIP IP address of TMS */
489         root->add_child("TMSIP")->add_child_text (_tms_ip);
490         /* [XML] TMSPath Path on the TMS to copy files to */
491         root->add_child("TMSPath")->add_child_text (_tms_path);
492         /* [XML] TMSUser Username to log into the TMS with */
493         root->add_child("TMSUser")->add_child_text (_tms_user);
494         /* [XML] TMSPassword Password to log into the TMS with */
495         root->add_child("TMSPassword")->add_child_text (_tms_password);
496         if (_cinema_sound_processor) {
497                 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
498                    gain changes from fader positions.  Currently can only be <code>dolby_cp750</code>.
499                 */
500                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
501         }
502         if (_language) {
503                 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
504                 root->add_child("Language")->add_child_text (_language.get());
505         }
506         if (_default_container) {
507                 /* [XML:opt] DefaultContainer ID of default container
508                  * to use when creating new films (<code>185</code>,<code>239</code> or
509                  * <code>190</code>).
510                 */
511                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
512         }
513         if (_default_scale_to) {
514                 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
515                    (see <code>DefaultContainer</code> for IDs).
516                 */
517                 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
518         }
519         if (_default_dcp_content_type) {
520                 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
521                    <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
522                    <code>PSA</code> or <code>ADV</code>). */
523                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
524         }
525         /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
526         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
527         /* [XML] DCPIssuer Issuer text to write into CPL files. */
528         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
529         /* [XML] DCPIssuer Creator text to write into CPL files. */
530         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
531
532         /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
533            <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
534            <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
535            <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
536            <code>&lt;MasteredLuminance&gt;</code>.
537         */
538         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
539
540         /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
541         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
542         /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
543         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
544         /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
545         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
546         /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
547         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
548         if (_default_kdm_directory) {
549                 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
550                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
551         }
552         /* [XML] MailServer Hostname of SMTP server to use. */
553         root->add_child("MailServer")->add_child_text (_mail_server);
554         /* [XML] MailPort Port number to use on SMTP server. */
555         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
556         /* [XML] MailUser Username to use on SMTP server. */
557         root->add_child("MailUser")->add_child_text (_mail_user);
558         /* [XML] MailPassword Password to use on SMTP server. */
559         root->add_child("MailPassword")->add_child_text (_mail_password);
560         /* [XML] KDMSubject Subject to use for KDM emails. */
561         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
562         /* [XML] KDMFrom From address to use for KDM emails. */
563         root->add_child("KDMFrom")->add_child_text (_kdm_from);
564         BOOST_FOREACH (string i, _kdm_cc) {
565                 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
566                 root->add_child("KDMCC")->add_child_text (i);
567         }
568         /* [XML] KDMBCC BCC address to use for KDM emails */
569         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
570         /* [XML] KDMEmail Text of KDM email */
571         root->add_child("KDMEmail")->add_child_text (_kdm_email);
572
573         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
574         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
575         /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
576         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
577
578         /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
579         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
580         /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
581         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
582         /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
583            to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
584            to sending email.
585         */
586         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
587         /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
588         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
589         /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
590         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
591 #ifdef DCPOMATIC_WINDOWS
592         /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
593         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
594 #endif
595
596         /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
597            tags in order and a <code>&lt;PrivateKey&gt;</code> tag all containing PEM-encoded certificates or private keys as appropriate.
598         */
599         xmlpp::Element* signer = root->add_child ("Signer");
600         DCPOMATIC_ASSERT (_signer_chain);
601         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
602                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
603         }
604         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
605
606         /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
607         xmlpp::Element* decryption = root->add_child ("Decryption");
608         DCPOMATIC_ASSERT (_decryption_chain);
609         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
610                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
611         }
612         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
613
614         /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
615            of these tags.
616         */
617         BOOST_FOREACH (boost::filesystem::path i, _history) {
618                 root->add_child("History")->add_child_text (i.string ());
619         }
620
621         /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code>&lt;DKDMGroup&gt;</code>
622            or <code>&lt;DKDM&gt;</code> tags.
623         */
624         /* [XML] DKDM A DKDM as XML */
625         _dkdms->as_xml (root);
626
627         /* [XML] CinemasFile Filename of cinemas list file */
628         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
629         /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
630         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
631         /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
632         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
633         /* [XML] KDMFilenameFormat Format for KDM filenames */
634         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
635         /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
636         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
637         /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
638         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
639         /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
640         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
641         /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
642         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
643         /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
644         for (int i = 0; i < NAG_COUNT; ++i) {
645                 xmlpp::Element* e = root->add_child ("Nagged");
646                 e->set_attribute ("Id", raw_convert<string>(i));
647                 e->add_child_text (_nagged[i] ? "1" : "0");
648         }
649         /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
650         root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
651         if (_sound_output) {
652                 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
653                 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
654         }
655         /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
656         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
657         if (_last_player_load_directory) {
658                 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
659         }
660         if (_last_kdm_write_type) {
661                 switch (_last_kdm_write_type.get()) {
662                 case KDM_WRITE_FLAT:
663                         root->add_child("LastKDMWriteType")->add_child_text("flat");
664                         break;
665                 case KDM_WRITE_FOLDER:
666                         root->add_child("LastKDMWriteType")->add_child_text("folder");
667                         break;
668                 case KDM_WRITE_ZIP:
669                         root->add_child("LastKDMWriteType")->add_child_text("zip");
670                         break;
671                 }
672         }
673         /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
674            frames to be held in memory at once.
675         */
676         root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
677
678         try {
679                 doc.write_to_file_formatted(config_file().string());
680         } catch (xmlpp::exception& e) {
681                 string s = e.what ();
682                 trim (s);
683                 throw FileError (s, path("config.xml"));
684         }
685 }
686
687 void
688 Config::write_cinemas () const
689 {
690         xmlpp::Document doc;
691         xmlpp::Element* root = doc.create_root_node ("Cinemas");
692         root->add_child("Version")->add_child_text ("1");
693
694         BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
695                 i->as_xml (root->add_child ("Cinema"));
696         }
697
698         try {
699                 doc.write_to_file_formatted (_cinemas_file.string ());
700         } catch (xmlpp::exception& e) {
701                 string s = e.what ();
702                 trim (s);
703                 throw FileError (s, _cinemas_file);
704         }
705 }
706
707 boost::filesystem::path
708 Config::default_directory_or (boost::filesystem::path a) const
709 {
710         return directory_or (_default_directory, a);
711 }
712
713 boost::filesystem::path
714 Config::default_kdm_directory_or (boost::filesystem::path a) const
715 {
716         return directory_or (_default_kdm_directory, a);
717 }
718
719 boost::filesystem::path
720 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
721 {
722         if (!dir) {
723                 return a;
724         }
725
726         boost::system::error_code ec;
727         bool const e = boost::filesystem::exists (*dir, ec);
728         if (ec || !e) {
729                 return a;
730         }
731
732         return *dir;
733 }
734
735 void
736 Config::drop ()
737 {
738         delete _instance;
739         _instance = 0;
740 }
741
742 void
743 Config::changed (Property what)
744 {
745         Changed (what);
746 }
747
748 void
749 Config::set_kdm_email_to_default ()
750 {
751         _kdm_subject = _("KDM delivery: $CPL_NAME");
752
753         _kdm_email = _(
754                 "Dear Projectionist\n\n"
755                 "Please find attached KDMs for $CPL_NAME.\n\n"
756                 "Cinema: $CINEMA_NAME\n"
757                 "Screen(s): $SCREENS\n\n"
758                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
759                 "Best regards,\nDCP-o-matic"
760                 );
761 }
762
763 void
764 Config::reset_kdm_email ()
765 {
766         set_kdm_email_to_default ();
767         changed ();
768 }
769
770 void
771 Config::set_cover_sheet_to_default ()
772 {
773         _cover_sheet = _(
774                 "$CPL_NAME\n\n"
775                 "Type: $TYPE\n"
776                 "Format: $CONTAINER\n"
777                 "Audio: $AUDIO\n"
778                 "Audio Language: $AUDIO_LANGUAGE\n"
779                 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
780                 "Length: $LENGTH\n"
781                 "Size: $SIZE\n"
782                 );
783 }
784
785 void
786 Config::add_to_history (boost::filesystem::path p)
787 {
788         /* Remove existing instances of this path in the history */
789         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
790
791         _history.insert (_history.begin (), p);
792         if (_history.size() > HISTORY_SIZE) {
793                 _history.pop_back ();
794         }
795
796         changed ();
797 }
798
799 bool
800 Config::have_existing (string file)
801 {
802         return boost::filesystem::exists (path (file, false));
803 }
804
805 void
806 Config::read_cinemas (cxml::Document const & f)
807 {
808         _cinemas.clear ();
809         list<cxml::NodePtr> cin = f.node_children ("Cinema");
810         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
811                 /* Slightly grotty two-part construction of Cinema here so that we can use
812                    shared_from_this.
813                 */
814                 shared_ptr<Cinema> cinema (new Cinema (i));
815                 cinema->read_screens (i);
816                 _cinemas.push_back (cinema);
817         }
818 }
819
820 void
821 Config::set_cinemas_file (boost::filesystem::path file)
822 {
823         _cinemas_file = file;
824
825         if (boost::filesystem::exists (_cinemas_file)) {
826                 /* Existing file; read it in */
827                 cxml::Document f ("Cinemas");
828                 f.read_file (_cinemas_file);
829                 read_cinemas (f);
830         }
831
832         changed (OTHER);
833 }
834
835 void
836 Config::save_template (shared_ptr<const Film> film, string name) const
837 {
838         film->write_template (template_path (name));
839 }
840
841 list<string>
842 Config::templates () const
843 {
844         if (!boost::filesystem::exists (path ("templates"))) {
845                 return list<string> ();
846         }
847
848         list<string> n;
849         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
850                 n.push_back (i->path().filename().string());
851         }
852         return n;
853 }
854
855 bool
856 Config::existing_template (string name) const
857 {
858         return boost::filesystem::exists (template_path (name));
859 }
860
861 boost::filesystem::path
862 Config::template_path (string name) const
863 {
864         return path("templates") / tidy_for_filename (name);
865 }
866
867 void
868 Config::rename_template (string old_name, string new_name) const
869 {
870         boost::filesystem::rename (template_path (old_name), template_path (new_name));
871 }
872
873 void
874 Config::delete_template (string name) const
875 {
876         boost::filesystem::remove (template_path (name));
877 }
878
879 /** @return Path to the config.xml containing the actual settings, following a link if required */
880 boost::filesystem::path
881 Config::config_file ()
882 {
883         cxml::Document f ("Config");
884         boost::filesystem::path main = path("config.xml", false);
885         if (!boost::filesystem::exists (main)) {
886                 /* It doesn't exist, so there can't be any links; just return it */
887                 return main;
888         }
889
890         /* See if there's a link */
891         f.read_file (main);
892         optional<string> link = f.optional_string_child("Link");
893         if (link) {
894                 return *link;
895         }
896
897         return main;
898 }
899
900 void
901 Config::reset_cover_sheet ()
902 {
903         set_cover_sheet_to_default ();
904         changed ();
905 }
906
907 void
908 Config::link (boost::filesystem::path new_file) const
909 {
910         xmlpp::Document doc;
911         doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
912         try {
913                 doc.write_to_file_formatted(path("config.xml", true).string());
914         } catch (xmlpp::exception& e) {
915                 string s = e.what ();
916                 trim (s);
917                 throw FileError (s, path("config.xml"));
918         }
919 }
920
921 void
922 Config::copy_and_link (boost::filesystem::path new_file) const
923 {
924         write ();
925         boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
926         link (new_file);
927 }