Simple cover sheet support (#1039).
[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 <dcp/raw_convert.h>
34 #include <dcp/name_format.h>
35 #include <dcp/certificate_chain.h>
36 #include <libcxml/cxml.h>
37 #include <glib.h>
38 #include <libxml++/libxml++.h>
39 #include <boost/filesystem.hpp>
40 #include <boost/algorithm/string.hpp>
41 #include <boost/foreach.hpp>
42 #include <boost/thread.hpp>
43 #include <cstdlib>
44 #include <fstream>
45 #include <iostream>
46
47 #include "i18n.h"
48
49 using std::vector;
50 using std::cout;
51 using std::ifstream;
52 using std::string;
53 using std::list;
54 using std::max;
55 using std::remove;
56 using std::exception;
57 using std::cerr;
58 using boost::shared_ptr;
59 using boost::optional;
60 using boost::algorithm::trim;
61 using dcp::raw_convert;
62
63 Config* Config::_instance = 0;
64 boost::signals2::signal<void ()> Config::FailedToLoad;
65
66 /** Construct default configuration */
67 Config::Config ()
68 {
69         set_defaults ();
70 }
71
72 void
73 Config::set_defaults ()
74 {
75         _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
76         _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
77         _server_port_base = 6192;
78         _use_any_servers = true;
79         _servers.clear ();
80         _only_servers_encode = false;
81         _tms_protocol = PROTOCOL_SCP;
82         _tms_ip = "";
83         _tms_path = ".";
84         _tms_user = "";
85         _tms_password = "";
86         _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
87         _allow_any_dcp_frame_rate = false;
88         _language = optional<string> ();
89         _default_still_length = 10;
90         _default_container = Ratio::from_id ("185");
91         _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
92         _default_dcp_audio_channels = 6;
93         _default_j2k_bandwidth = 100000000;
94         _default_audio_delay = 0;
95         _default_interop = true;
96         _mail_server = "";
97         _mail_port = 25;
98         _mail_user = "";
99         _mail_password = "";
100         _kdm_from = "";
101         _kdm_cc.clear ();
102         _kdm_bcc = "";
103         _check_for_updates = false;
104         _check_for_test_updates = false;
105         _maximum_j2k_bandwidth = 250000000;
106         _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
107         _analyse_ebur128 = true;
108         _automatic_audio_analysis = false;
109 #ifdef DCPOMATIC_WINDOWS
110         _win32_console = false;
111 #endif
112         _cinemas_file = path ("cinemas.xml");
113         _show_hints_before_make_dcp = true;
114         _confirm_kdm_email = true;
115         _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
116         _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
117         _dcp_metadata_filename_format = dcp::NameFormat ("%t");
118         _dcp_asset_filename_format = dcp::NameFormat ("%t");
119         _jump_to_selected = true;
120         for (int i = 0; i < NAG_COUNT; ++i) {
121                 _nagged[i] = false;
122         }
123         _preview_sound = false;
124         _preview_sound_output = optional<string> ();
125
126         _allowed_dcp_frame_rates.clear ();
127         _allowed_dcp_frame_rates.push_back (24);
128         _allowed_dcp_frame_rates.push_back (25);
129         _allowed_dcp_frame_rates.push_back (30);
130         _allowed_dcp_frame_rates.push_back (48);
131         _allowed_dcp_frame_rates.push_back (50);
132         _allowed_dcp_frame_rates.push_back (60);
133
134         set_kdm_email_to_default ();
135         set_cover_sheet_to_default ();
136 }
137
138 void
139 Config::restore_defaults ()
140 {
141         Config::instance()->set_defaults ();
142         Config::instance()->changed ();
143 }
144
145 shared_ptr<dcp::CertificateChain>
146 Config::create_certificate_chain ()
147 {
148         return shared_ptr<dcp::CertificateChain> (
149                 new dcp::CertificateChain (
150                         openssl_path(),
151                         "dcpomatic.com",
152                         "dcpomatic.com",
153                         ".dcpomatic.smpte-430-2.ROOT",
154                         ".dcpomatic.smpte-430-2.INTERMEDIATE",
155                         "CS.dcpomatic.smpte-430-2.LEAF"
156                         )
157                 );
158 }
159
160 void
161 Config::read ()
162 try
163 {
164         cxml::Document f ("Config");
165         f.read_file (path ("config.xml"));
166         optional<string> c;
167
168         optional<int> version = f.optional_number_child<int> ("Version");
169
170         if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
171                 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
172         } else {
173                 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
174                 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
175         }
176
177         _default_directory = f.optional_string_child ("DefaultDirectory");
178         if (_default_directory && _default_directory->empty ()) {
179                 /* We used to store an empty value for this to mean "none set" */
180                 _default_directory = boost::optional<boost::filesystem::path> ();
181         }
182
183         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
184         if (!b) {
185                 b = f.optional_number_child<int> ("ServerPortBase");
186         }
187         _server_port_base = b.get ();
188
189         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
190         _use_any_servers = u.get_value_or (true);
191
192         list<cxml::NodePtr> servers = f.node_children ("Server");
193         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
194                 if ((*i)->node_children("HostName").size() == 1) {
195                         _servers.push_back ((*i)->string_child ("HostName"));
196                 } else {
197                         _servers.push_back ((*i)->content ());
198                 }
199         }
200
201         _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
202         _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
203         _tms_ip = f.string_child ("TMSIP");
204         _tms_path = f.string_child ("TMSPath");
205         _tms_user = f.string_child ("TMSUser");
206         _tms_password = f.string_child ("TMSPassword");
207
208         c = f.optional_string_child ("SoundProcessor");
209         if (c) {
210                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
211         }
212         c = f.optional_string_child ("CinemaSoundProcessor");
213         if (c) {
214                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
215         }
216
217         _language = f.optional_string_child ("Language");
218
219         c = f.optional_string_child ("DefaultContainer");
220         if (c) {
221                 _default_container = Ratio::from_id (c.get ());
222         }
223
224         c = f.optional_string_child ("DefaultDCPContentType");
225         if (c) {
226                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
227         }
228
229         _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
230
231         if (f.optional_string_child ("DCPMetadataIssuer")) {
232                 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
233         } else if (f.optional_string_child ("DCPIssuer")) {
234                 _dcp_issuer = f.string_child ("DCPIssuer");
235         }
236
237         _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
238
239         if (version && version.get() >= 2) {
240                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
241         } else {
242                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
243         }
244
245         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
246         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
247         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
248         _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
249         _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
250
251         /* Load any cinemas from config.xml */
252         read_cinemas (f);
253
254         _mail_server = f.string_child ("MailServer");
255         _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
256         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
257         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
258         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
259         _kdm_from = f.string_child ("KDMFrom");
260         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
261                 if (!i->content().empty()) {
262                         _kdm_cc.push_back (i->content ());
263                 }
264         }
265         _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
266         _kdm_email = f.string_child ("KDMEmail");
267
268         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
269         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
270
271         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
272         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
273
274         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
275         _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
276         _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
277 #ifdef DCPOMATIC_WINDOWS
278         _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
279 #endif
280
281         list<cxml::NodePtr> his = f.node_children ("History");
282         for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
283                 _history.push_back ((*i)->content ());
284         }
285
286         cxml::NodePtr signer = f.optional_node_child ("Signer");
287         if (signer) {
288                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
289                 /* Read the signing certificates and private key in from the config file */
290                 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
291                         c->add (dcp::Certificate (i->content ()));
292                 }
293                 c->set_key (signer->string_child ("PrivateKey"));
294                 _signer_chain = c;
295         } else {
296                 /* Make a new set of signing certificates and key */
297                 _signer_chain = create_certificate_chain ();
298         }
299
300         cxml::NodePtr decryption = f.optional_node_child ("Decryption");
301         if (decryption) {
302                 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
303                 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
304                         c->add (dcp::Certificate (i->content ()));
305                 }
306                 c->set_key (decryption->string_child ("PrivateKey"));
307                 _decryption_chain = c;
308         } else {
309                 _decryption_chain = create_certificate_chain ();
310         }
311
312         list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
313         BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
314                 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
315         }
316
317         _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
318         _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
319         _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
320         _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
321         _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
322         _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
323         _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
324         _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
325         BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
326                 int const id = i->number_attribute<int>("Id");
327                 if (id >= 0 && id < NAG_COUNT) {
328                         _nagged[id] = raw_convert<int>(i->content());
329                 }
330         }
331         _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
332         _preview_sound_output = f.optional_string_child("PreviewSoundOutput");
333         if (f.optional_string_child("CoverSheet")) {
334                 _cover_sheet = f.optional_string_child("CoverSheet").get();
335         }
336
337         /* Replace any cinemas from config.xml with those from the configured file */
338         if (boost::filesystem::exists (_cinemas_file)) {
339                 cxml::Document f ("Cinemas");
340                 f.read_file (_cinemas_file);
341                 read_cinemas (f);
342         }
343 }
344 catch (...) {
345         if (have_existing ("config.xml")) {
346
347                 /* Make a copy of the configuration */
348                 try {
349                         boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
350                         boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
351                 } catch (...) {}
352
353                 /* We have a config file but it didn't load */
354                 FailedToLoad ();
355         }
356         set_defaults ();
357         /* Make a new set of signing certificates and key */
358         _signer_chain = create_certificate_chain ();
359         /* And similar for decryption of KDMs */
360         _decryption_chain = create_certificate_chain ();
361         write ();
362 }
363
364
365 /** @return Filename to write configuration to */
366 boost::filesystem::path
367 Config::path (string file, bool create_directories)
368 {
369         boost::filesystem::path p;
370 #ifdef DCPOMATIC_OSX
371         p /= g_get_home_dir ();
372         p /= "Library";
373         p /= "Preferences";
374         p /= "com.dcpomatic";
375         p /= "2";
376 #else
377         p /= g_get_user_config_dir ();
378         p /= "dcpomatic2";
379 #endif
380         boost::system::error_code ec;
381         if (create_directories) {
382                 boost::filesystem::create_directories (p, ec);
383         }
384         p /= file;
385         return p;
386 }
387
388 /** @return Singleton instance */
389 Config *
390 Config::instance ()
391 {
392         if (_instance == 0) {
393                 _instance = new Config;
394                 _instance->read ();
395         }
396
397         return _instance;
398 }
399
400 /** Write our configuration to disk */
401 void
402 Config::write () const
403 {
404         write_config ();
405         write_cinemas ();
406 }
407
408 void
409 Config::write_config () const
410 {
411         xmlpp::Document doc;
412         xmlpp::Element* root = doc.create_root_node ("Config");
413
414         root->add_child("Version")->add_child_text ("2");
415         root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
416         root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
417         if (_default_directory) {
418                 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
419         }
420         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
421         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
422
423         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
424                 root->add_child("Server")->add_child_text (*i);
425         }
426
427         root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
428         root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
429         root->add_child("TMSIP")->add_child_text (_tms_ip);
430         root->add_child("TMSPath")->add_child_text (_tms_path);
431         root->add_child("TMSUser")->add_child_text (_tms_user);
432         root->add_child("TMSPassword")->add_child_text (_tms_password);
433         if (_cinema_sound_processor) {
434                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
435         }
436         if (_language) {
437                 root->add_child("Language")->add_child_text (_language.get());
438         }
439         if (_default_container) {
440                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
441         }
442         if (_default_dcp_content_type) {
443                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
444         }
445         root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
446         root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
447         root->add_child("DCPCreator")->add_child_text (_dcp_creator);
448
449         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
450
451         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
452         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
453         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
454         root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
455         if (_default_kdm_directory) {
456                 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
457         }
458         root->add_child("MailServer")->add_child_text (_mail_server);
459         root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
460         root->add_child("MailUser")->add_child_text (_mail_user);
461         root->add_child("MailPassword")->add_child_text (_mail_password);
462         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
463         root->add_child("KDMFrom")->add_child_text (_kdm_from);
464         BOOST_FOREACH (string i, _kdm_cc) {
465                 root->add_child("KDMCC")->add_child_text (i);
466         }
467         root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
468         root->add_child("KDMEmail")->add_child_text (_kdm_email);
469
470         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
471         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
472
473         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
474         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
475         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
476         root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
477         root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
478 #ifdef DCPOMATIC_WINDOWS
479         root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
480 #endif
481
482         xmlpp::Element* signer = root->add_child ("Signer");
483         DCPOMATIC_ASSERT (_signer_chain);
484         BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
485                 signer->add_child("Certificate")->add_child_text (i.certificate (true));
486         }
487         signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
488
489         xmlpp::Element* decryption = root->add_child ("Decryption");
490         DCPOMATIC_ASSERT (_decryption_chain);
491         BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
492                 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
493         }
494         decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
495
496         for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
497                 root->add_child("History")->add_child_text (i->string ());
498         }
499
500         BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
501                 root->add_child("DKDM")->add_child_text (i.as_xml ());
502         }
503
504         root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
505         root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
506         root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
507         root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
508         root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
509         root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
510         root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
511         root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
512         for (int i = 0; i < NAG_COUNT; ++i) {
513                 xmlpp::Element* e = root->add_child ("Nagged");
514                 e->set_attribute ("Id", raw_convert<string>(i));
515                 e->add_child_text (_nagged[i] ? "1" : "0");
516         }
517         root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
518         if (_preview_sound_output) {
519                 root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
520         }
521         root->add_child("CoverSheet")->add_child_text (_cover_sheet);
522
523         try {
524                 doc.write_to_file_formatted (path("config.xml").string ());
525         } catch (xmlpp::exception& e) {
526                 string s = e.what ();
527                 trim (s);
528                 throw FileError (s, path("config.xml"));
529         }
530 }
531
532 void
533 Config::write_cinemas () const
534 {
535         xmlpp::Document doc;
536         xmlpp::Element* root = doc.create_root_node ("Cinemas");
537         root->add_child("Version")->add_child_text ("1");
538
539         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
540                 (*i)->as_xml (root->add_child ("Cinema"));
541         }
542
543         try {
544                 doc.write_to_file_formatted (_cinemas_file.string ());
545         } catch (xmlpp::exception& e) {
546                 string s = e.what ();
547                 trim (s);
548                 throw FileError (s, _cinemas_file);
549         }
550 }
551
552 boost::filesystem::path
553 Config::default_directory_or (boost::filesystem::path a) const
554 {
555         return directory_or (_default_directory, a);
556 }
557
558 boost::filesystem::path
559 Config::default_kdm_directory_or (boost::filesystem::path a) const
560 {
561         return directory_or (_default_kdm_directory, a);
562 }
563
564 boost::filesystem::path
565 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
566 {
567         if (!dir) {
568                 return a;
569         }
570
571         boost::system::error_code ec;
572         bool const e = boost::filesystem::exists (*dir, ec);
573         if (ec || !e) {
574                 return a;
575         }
576
577         return *dir;
578 }
579
580 void
581 Config::drop ()
582 {
583         delete _instance;
584         _instance = 0;
585 }
586
587 void
588 Config::changed (Property what)
589 {
590         Changed (what);
591 }
592
593 void
594 Config::set_kdm_email_to_default ()
595 {
596         _kdm_subject = _("KDM delivery: $CPL_NAME");
597
598         _kdm_email = _(
599                 "Dear Projectionist\n\n"
600                 "Please find attached KDMs for $CPL_NAME.\n\n"
601                 "Cinema: $CINEMA_NAME\n"
602                 "Screen(s): $SCREENS\n\n"
603                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
604                 "Best regards,\nDCP-o-matic"
605                 );
606 }
607
608 void
609 Config::reset_kdm_email ()
610 {
611         set_kdm_email_to_default ();
612         changed ();
613 }
614
615 void
616 Config::set_cover_sheet_to_default ()
617 {
618         _cover_sheet = _(
619                 "$CPL_NAME\n\n"
620                 "Type: $TYPE\n"
621                 "Format: $CONTAINER\n"
622                 "Audio: $AUDIO\n"
623                 "Length: $LENGTH\n"
624                 );
625 }
626
627 void
628 Config::add_to_history (boost::filesystem::path p)
629 {
630         /* Remove existing instances of this path in the history */
631         _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
632
633         _history.insert (_history.begin (), p);
634         if (_history.size() > HISTORY_SIZE) {
635                 _history.pop_back ();
636         }
637
638         changed ();
639 }
640
641 bool
642 Config::have_existing (string file)
643 {
644         return boost::filesystem::exists (path (file, false));
645 }
646
647 void
648 Config::read_cinemas (cxml::Document const & f)
649 {
650         _cinemas.clear ();
651         list<cxml::NodePtr> cin = f.node_children ("Cinema");
652         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
653                 /* Slightly grotty two-part construction of Cinema here so that we can use
654                    shared_from_this.
655                 */
656                 shared_ptr<Cinema> cinema (new Cinema (*i));
657                 cinema->read_screens (*i);
658                 _cinemas.push_back (cinema);
659         }
660 }
661
662 void
663 Config::set_cinemas_file (boost::filesystem::path file)
664 {
665         _cinemas_file = file;
666
667         if (boost::filesystem::exists (_cinemas_file)) {
668                 /* Existing file; read it in */
669                 cxml::Document f ("Cinemas");
670                 f.read_file (_cinemas_file);
671                 read_cinemas (f);
672         }
673
674         changed (OTHER);
675 }
676
677 void
678 Config::save_template (shared_ptr<const Film> film, string name) const
679 {
680         film->write_template (template_path (name));
681 }
682
683 list<string>
684 Config::templates () const
685 {
686         if (!boost::filesystem::exists (path ("templates"))) {
687                 return list<string> ();
688         }
689
690         list<string> n;
691         for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
692                 n.push_back (i->path().filename().string());
693         }
694         return n;
695 }
696
697 bool
698 Config::existing_template (string name) const
699 {
700         return boost::filesystem::exists (template_path (name));
701 }
702
703 boost::filesystem::path
704 Config::template_path (string name) const
705 {
706         return path("templates") / tidy_for_filename (name);
707 }
708
709 void
710 Config::rename_template (string old_name, string new_name) const
711 {
712         boost::filesystem::rename (template_path (old_name), template_path (new_name));
713 }
714
715 void
716 Config::delete_template (string name) const
717 {
718         boost::filesystem::remove (template_path (name));
719 }
720
721 /** @return Path to the config.xml, for telling the user what it is */
722 boost::filesystem::path
723 Config::config_path ()
724 {
725         return path("config.xml", false);
726 }
727
728 void
729 Config::reset_cover_sheet ()
730 {
731         set_cover_sheet_to_default ();
732         changed ();
733 }