No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / config.cc
index b75791a45e96c52992d2bacdb39a8b6db742e045..b6c7e82935e6c756f71008b54ed14ac03729797b 100644 (file)
@@ -1,27 +1,28 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "config.h"
-#include "server.h"
 #include "filter.h"
 #include "ratio.h"
 #include "types.h"
+#include "log.h"
 #include "dcp_content_type.h"
 #include "cinema_sound_processor.h"
 #include "colour_conversion.h"
 #include <dcp/certificate_chain.h>
 #include <libcxml/cxml.h>
 #include <glib.h>
+#include <libxml++/libxml++.h>
 #include <boost/filesystem.hpp>
 #include <boost/algorithm/string.hpp>
+#include <boost/foreach.hpp>
+#include <boost/thread.hpp>
 #include <cstdlib>
 #include <fstream>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -68,6 +73,7 @@ Config::set_defaults ()
        _server_port_base = 6192;
        _use_any_servers = true;
        _servers.clear ();
+       _only_servers_encode = false;
        _tms_protocol = PROTOCOL_SCP;
        _tms_ip = "";
        _tms_path = ".";
@@ -81,21 +87,24 @@ Config::set_defaults ()
        _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
        _default_j2k_bandwidth = 100000000;
        _default_audio_delay = 0;
+       _default_interop = false;
        _mail_server = "";
        _mail_port = 25;
        _mail_user = "";
        _mail_password = "";
-       _kdm_subject = _("KDM delivery");
        _kdm_from = "";
-       _kdm_cc = "";
+       _kdm_cc.clear ();
        _kdm_bcc = "";
        _check_for_updates = false;
        _check_for_test_updates = false;
        _maximum_j2k_bandwidth = 250000000;
-       _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR;
+       _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
+       _analyse_ebur128 = true;
+       _automatic_audio_analysis = false;
 #ifdef DCPOMATIC_WINDOWS
        _win32_console = false;
 #endif
+       _cinemas_file = path ("cinemas.xml");
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -115,19 +124,37 @@ Config::restore_defaults ()
        Config::instance()->changed ();
 }
 
+shared_ptr<dcp::CertificateChain>
+Config::create_certificate_chain ()
+{
+       return shared_ptr<dcp::CertificateChain> (
+               new dcp::CertificateChain (
+                       openssl_path(),
+                       "dcpomatic.com",
+                       "dcpomatic.com",
+                       ".dcpomatic.smpte-430-2.ROOT",
+                       ".dcpomatic.smpte-430-2.INTERMEDIATE",
+                       "CS.dcpomatic.smpte-430-2.LEAF"
+                       )
+               );
+}
+
 void
 Config::read ()
 {
-       if (!boost::filesystem::exists (file ())) {
+       if (!have_existing ("config.xml")) {
+               cout << "No existing config.xml; creating chains.\n";
                /* Make a new set of signing certificates and key */
-               _signer.reset (new dcp::CertificateChain (openssl_path ()));
-               /* And decryption keys */
-               make_decryption_keys ();
+               _signer_chain = create_certificate_chain ();
+               /* And similar for decryption of KDMs */
+               _decryption_chain = create_certificate_chain ();
+               cout << "Writing config.\n";
+               write ();
                return;
        }
 
        cxml::Document f ("Config");
-       f.read_file (file ());
+       f.read_file (path ("config.xml"));
        optional<string> c;
 
        optional<int> version = f.optional_number_child<int> ("Version");
@@ -153,6 +180,7 @@ Config::read ()
                }
        }
 
+       _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
        _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
        _tms_ip = f.string_child ("TMSIP");
        _tms_path = f.string_child ("TMSPath");
@@ -186,6 +214,8 @@ Config::read ()
                _dcp_issuer = f.string_child ("DCPIssuer");
        }
 
+       _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
+
        if (version && version.get() >= 2) {
                _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
        } else {
@@ -195,16 +225,10 @@ Config::read ()
        _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
        _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
        _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
+       _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
 
-       list<cxml::NodePtr> cin = f.node_children ("Cinema");
-       for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
-               /* Slightly grotty two-part construction of Cinema here so that we can use
-                  shared_from_this.
-               */
-               shared_ptr<Cinema> cinema (new Cinema (*i));
-               cinema->read_screens (*i);
-               _cinemas.push_back (cinema);
-       }
+       /* Load any cinemas from config.xml */
+       read_cinemas (f);
 
        _mail_server = f.string_child ("MailServer");
        _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
@@ -212,7 +236,11 @@ Config::read ()
        _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
        _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
        _kdm_from = f.string_child ("KDMFrom");
-       _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
+       BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
+               if (!i->content().empty()) {
+                       _kdm_cc.push_back (i->content ());
+               }
+       }
        _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
        _kdm_email = f.string_child ("KDMEmail");
 
@@ -220,9 +248,11 @@ Config::read ()
        _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 
        _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
-       _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
+       _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
 
-       _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
+       _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
+       _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
+       _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
 #ifdef DCPOMATIC_WINDOWS
        _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
 #endif
@@ -233,46 +263,49 @@ Config::read ()
        }
 
        cxml::NodePtr signer = f.optional_node_child ("Signer");
-       dcp::CertificateChain signer_chain;
        if (signer) {
                shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
                /* Read the signing certificates and private key in from the config file */
-               list<cxml::NodePtr> certificates = signer->node_children ("Certificate");
-               for (list<cxml::NodePtr>::const_iterator i = certificates.begin(); i != certificates.end(); ++i) {
-                       c->add (dcp::Certificate ((*i)->content ()));
+               BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
+                       c->add (dcp::Certificate (i->content ()));
                }
                c->set_key (signer->string_child ("PrivateKey"));
-               _signer = c;
+               _signer_chain = c;
        } else {
                /* Make a new set of signing certificates and key */
-               _signer.reset (new dcp::CertificateChain (openssl_path ()));
+               _signer_chain = create_certificate_chain ();
        }
 
-       if (f.optional_string_child ("DecryptionCertificate")) {
-               _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate"));
+       cxml::NodePtr decryption = f.optional_node_child ("Decryption");
+       if (decryption) {
+               shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
+               BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
+                       c->add (dcp::Certificate (i->content ()));
+               }
+               c->set_key (decryption->string_child ("PrivateKey"));
+               _decryption_chain = c;
+       } else {
+               _decryption_chain = create_certificate_chain ();
        }
 
-       if (f.optional_string_child ("DecryptionPrivateKey")) {
-               _decryption_private_key = f.string_child ("DecryptionPrivateKey");
+       list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
+       BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
+               _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
        }
 
-       if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) {
-               /* Generate our own decryption certificate and key if either is not present in config */
-               make_decryption_keys ();
-       }
-}
+       _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
 
-void
-Config::make_decryption_keys ()
-{
-       dcp::CertificateChain c (openssl_path ());
-       _decryption_certificate = c.leaf ();
-       _decryption_private_key = c.key().get ();
+       /* Replace any cinemas from config.xml with those from the configured file */
+       if (boost::filesystem::exists (_cinemas_file)) {
+               cxml::Document f ("Cinemas");
+               f.read_file (_cinemas_file);
+               read_cinemas (f);
+       }
 }
 
 /** @return Filename to write configuration to */
 boost::filesystem::path
-Config::file () const
+Config::path (string file, bool create_directories)
 {
        boost::filesystem::path p;
 #ifdef DCPOMATIC_OSX
@@ -286,8 +319,10 @@ Config::file () const
        p /= "dcpomatic2";
 #endif
        boost::system::error_code ec;
-       boost::filesystem::create_directories (p, ec);
-       p /= "config.xml";
+       if (create_directories) {
+               boost::filesystem::create_directories (p, ec);
+       }
+       p /= file;
        return p;
 }
 
@@ -303,9 +338,9 @@ Config::instance ()
                        /* configuration load failed; never mind, just
                           stick with the default.
                        */
-                       cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
+                       cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
                } catch (...) {
-                       cerr << "dcpomatic: failed to load configuration\n";
+                       cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
                }
        }
 
@@ -315,6 +350,13 @@ Config::instance ()
 /** Write our configuration to disk */
 void
 Config::write () const
+{
+       write_config_xml ();
+       write_cinemas_xml ();
+}
+
+void
+Config::write_config_xml () const
 {
        xmlpp::Document doc;
        xmlpp::Element* root = doc.create_root_node ("Config");
@@ -329,6 +371,7 @@ Config::write () const
                root->add_child("Server")->add_child_text (*i);
        }
 
+       root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
        root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
        root->add_child("TMSIP")->add_child_text (_tms_ip);
        root->add_child("TMSPath")->add_child_text (_tms_path);
@@ -347,24 +390,23 @@ Config::write () const
                root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
        }
        root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
+       root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 
        _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 
        root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
        root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
        root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
-
-       for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
-               (*i)->as_xml (root->add_child ("Cinema"));
-       }
-
+       root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
        root->add_child("MailServer")->add_child_text (_mail_server);
        root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
        root->add_child("MailUser")->add_child_text (_mail_user);
        root->add_child("MailPassword")->add_child_text (_mail_password);
        root->add_child("KDMSubject")->add_child_text (_kdm_subject);
        root->add_child("KDMFrom")->add_child_text (_kdm_from);
-       root->add_child("KDMCC")->add_child_text (_kdm_cc);
+       BOOST_FOREACH (string i, _kdm_cc) {
+               root->add_child("KDMCC")->add_child_text (i);
+       }
        root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
        root->add_child("KDMEmail")->add_child_text (_kdm_email);
 
@@ -374,30 +416,62 @@ Config::write () const
        root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
        root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
        root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
+       root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
+       root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
 #ifdef DCPOMATIC_WINDOWS
        root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
 #endif
 
        xmlpp::Element* signer = root->add_child ("Signer");
-       dcp::CertificateChain::List certs = _signer->root_to_leaf ();
-       for (dcp::CertificateChain::List::const_iterator i = certs.begin(); i != certs.end(); ++i) {
-               signer->add_child("Certificate")->add_child_text (i->certificate (true));
+       DCPOMATIC_ASSERT (_signer_chain);
+       BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
+               signer->add_child("Certificate")->add_child_text (i.certificate (true));
        }
-       signer->add_child("PrivateKey")->add_child_text (_signer->key().get ());
+       signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
 
-       root->add_child("DecryptionCertificate")->add_child_text (_decryption_certificate.certificate (true));
-       root->add_child("DecryptionPrivateKey")->add_child_text (_decryption_private_key);
+       xmlpp::Element* decryption = root->add_child ("Decryption");
+       DCPOMATIC_ASSERT (_decryption_chain);
+       BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
+               decryption->add_child("Certificate")->add_child_text (i.certificate (true));
+       }
+       decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
 
        for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
                root->add_child("History")->add_child_text (i->string ());
        }
 
+       BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
+               root->add_child("DKDM")->add_child_text (i.as_xml ());
+       }
+
+       root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
+
        try {
-               doc.write_to_file_formatted (file().string ());
+               doc.write_to_file_formatted (path("config.xml").string ());
        } catch (xmlpp::exception& e) {
                string s = e.what ();
                trim (s);
-               throw FileError (s, file ());
+               throw FileError (s, path("config.xml"));
+       }
+}
+
+void
+Config::write_cinemas_xml () const
+{
+       xmlpp::Document doc;
+       xmlpp::Element* root = doc.create_root_node ("Cinemas");
+       root->add_child("Version")->add_child_text ("1");
+
+       for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
+               (*i)->as_xml (root->add_child ("Cinema"));
+       }
+
+       try {
+               doc.write_to_file_formatted (_cinemas_file.string ());
+       } catch (xmlpp::exception& e) {
+               string s = e.what ();
+               trim (s);
+               throw FileError (s, _cinemas_file);
        }
 }
 
@@ -427,12 +501,15 @@ Config::drop ()
 void
 Config::changed (Property what)
 {
+       cout << what << " changed in config.\n";
        Changed (what);
 }
 
 void
 Config::set_kdm_email_to_default ()
 {
+       _kdm_subject = _("KDM delivery: $CPL_NAME");
+
        _kdm_email = _(
                "Dear Projectionist\n\n"
                "Please find attached KDMs for $CPL_NAME.\n\n"
@@ -463,3 +540,39 @@ Config::add_to_history (boost::filesystem::path p)
 
        changed ();
 }
+
+bool
+Config::have_existing (string file)
+{
+       return boost::filesystem::exists (path (file, false));
+}
+
+void
+Config::read_cinemas (cxml::Document const & f)
+{
+       _cinemas.clear ();
+       list<cxml::NodePtr> cin = f.node_children ("Cinema");
+       for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
+               /* Slightly grotty two-part construction of Cinema here so that we can use
+                  shared_from_this.
+               */
+               shared_ptr<Cinema> cinema (new Cinema (*i));
+               cinema->read_screens (*i);
+               _cinemas.push_back (cinema);
+       }
+}
+
+void
+Config::set_cinemas_file (boost::filesystem::path file)
+{
+       _cinemas_file = file;
+
+       if (boost::filesystem::exists (_cinemas_file)) {
+               /* Existing file; read it in */
+               cxml::Document f ("Cinemas");
+               f.read_file (_cinemas_file);
+               read_cinemas (f);
+       }
+
+       changed (OTHER);
+}