Write config.xml with CR/LF terminators on Windows.
[dcpomatic.git] / src / lib / config.cc
index 2ae7939a9e7bcf7ad725c2ec6176d6f29ffce4cc..ddb4bf25a22346f8f3a6e5f7fd8ab742fcdfa43d 100644 (file)
@@ -68,7 +68,7 @@ int const Config::_current_version = 3;
 boost::signals2::signal<void ()> Config::FailedToLoad;
 boost::signals2::signal<void (string)> Config::Warning;
 boost::signals2::signal<bool (void)> Config::BadSignerChain;
-boost::optional<boost::filesystem::path> Config::test_path;
+boost::optional<boost::filesystem::path> Config::override_path;
 
 /** Construct default configuration */
 Config::Config ()
@@ -94,6 +94,7 @@ Config::set_defaults ()
        _tms_password = "";
        _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
        _allow_any_dcp_frame_rate = false;
+       _allow_any_container = false;
        _language = optional<string> ();
        _default_still_length = 10;
        _default_container = Ratio::from_id ("185");
@@ -111,6 +112,10 @@ Config::set_defaults ()
        _kdm_from = "";
        _kdm_cc.clear ();
        _kdm_bcc = "";
+       _notification_from = "";
+       _notification_to = "";
+       _notification_cc.clear ();
+       _notification_bcc = "";
        _check_for_updates = false;
        _check_for_test_updates = false;
        _maximum_j2k_bandwidth = 250000000;
@@ -147,6 +152,32 @@ Config::set_defaults ()
        */
        _frames_in_memory_multiplier = 3;
        _decode_reduction = optional<int>();
+       _default_notify = false;
+       for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
+               _notification[i] = false;
+       }
+       _barco_username = optional<string>();
+       _barco_password = optional<string>();
+       _christie_username = optional<string>();
+       _christie_password = optional<string>();
+       _gdc_username = optional<string>();
+       _gdc_password = optional<string>();
+       _interface_complexity = INTERFACE_SIMPLE;
+       _player_mode = PLAYER_MODE_WINDOW;
+       _image_display = 0;
+       _respect_kdm_validity_periods = true;
+       _player_log_file = boost::none;
+       _player_content_directory = boost::none;
+       _player_playlist_directory = boost::none;
+       _player_kdm_directory = boost::none;
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       _player_background_image = boost::none;
+       _kdm_server_url = "http://localhost:8000/{CPL}";
+       _player_watermark_theatre = "";
+       _player_watermark_period = 1;
+       _player_watermark_duration = 50;
+       _player_lock_file = boost::none;
+#endif
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -157,6 +188,7 @@ Config::set_defaults ()
        _allowed_dcp_frame_rates.push_back (60);
 
        set_kdm_email_to_default ();
+       set_notification_email_to_default ();
        set_cover_sheet_to_default ();
 }
 
@@ -201,6 +233,14 @@ void
 Config::read ()
 try
 {
+#if defined(DCPOMATIC_VARIANT_SWAROOP) && defined(DCPOMATIC_LINUX)
+       if (geteuid() == 0) {
+               /* Take ownership of the config file if we're root */
+               chown (config_file().string().c_str(), 0, 0);
+               chmod (config_file().string().c_str(), 0644);
+       }
+#endif
+
        cxml::Document f ("Config");
        f.read_file (config_file ());
 
@@ -305,6 +345,7 @@ try
        _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
        _mail_user = f.optional_string_child("MailUser").get_value_or ("");
        _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");
        BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
@@ -315,11 +356,25 @@ try
        _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
        _kdm_email = f.string_child ("KDMEmail");
 
+       _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
+       _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
+       _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
+       BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
+               if (!i->content().empty()) {
+                       _notification_cc.push_back (i->content ());
+               }
+       }
+       _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
+       if (f.optional_string_child("NotificationEmail")) {
+               _notification_email = f.string_child("NotificationEmail");
+       }
+
        _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
        _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").get_value_or (false);
+       _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
 
        _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);
@@ -429,6 +484,52 @@ try
        }
        _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
        _decode_reduction = f.optional_number_child<int>("DecodeReduction");
+       _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
+
+       BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
+               int const id = i->number_attribute<int>("Id");
+               if (id >= 0 && id < NOTIFICATION_COUNT) {
+                       _notification[id] = raw_convert<int>(i->content());
+               }
+       }
+
+       _barco_username = f.optional_string_child("BarcoUsername");
+       _barco_password = f.optional_string_child("BarcoPassword");
+       _christie_username = f.optional_string_child("ChristieUsername");
+       _christie_password = f.optional_string_child("ChristiePassword");
+       _gdc_username = f.optional_string_child("GDCUsername");
+       _gdc_password = f.optional_string_child("GDCPassword");
+
+       optional<string> ic = f.optional_string_child("InterfaceComplexity");
+       if (ic && *ic == "full") {
+               _interface_complexity = INTERFACE_FULL;
+       }
+       optional<string> pm = f.optional_string_child("PlayerMode");
+       if (pm && *pm == "window") {
+               _player_mode = PLAYER_MODE_WINDOW;
+       } else if (pm && *pm == "full") {
+               _player_mode = PLAYER_MODE_FULL;
+       } else if (pm && *pm == "dual") {
+               _player_mode = PLAYER_MODE_DUAL;
+       }
+
+       _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
+       _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
+       _player_log_file = f.optional_string_child("PlayerLogFile");
+       _player_content_directory = f.optional_string_child("PlayerContentDirectory");
+       _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
+       _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       _player_background_image = f.optional_string_child("PlayerBackgroundImage");
+       _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
+       _player_watermark_theatre = f.optional_string_child("PlayerWatermarkTheatre").get_value_or("");
+       _player_watermark_period = f.optional_number_child<int>("PlayerWatermarkPeriod").get_value_or(1);
+       _player_watermark_duration = f.optional_number_child<int>("PlayerWatermarkDuration").get_value_or(150);
+       BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("RequiredMonitor")) {
+               _required_monitors.push_back(Monitor(i));
+       }
+       _player_lock_file = f.optional_string_child("PlayerLockFile");
+#endif
 
        /* Replace any cinemas from config.xml with those from the configured file */
        if (boost::filesystem::exists (_cinemas_file)) {
@@ -456,8 +557,8 @@ boost::filesystem::path
 Config::path (string file, bool create_directories)
 {
        boost::filesystem::path p;
-       if (test_path) {
-               p = test_path.get();
+       if (override_path) {
+               p = *override_path;
        } else {
 #ifdef DCPOMATIC_OSX
                p /= g_get_home_dir ();
@@ -555,8 +656,8 @@ Config::write_config () const
        }
        if (_default_container) {
                /* [XML:opt] DefaultContainer ID of default container
-                * to use when creating new films (<code>185</code>,<code>239</code> or
-                * <code>190</code>).
+                  to use when creating new films (<code>185</code>,<code>239</code> or
+                  <code>190</code>).
                */
                root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
        }
@@ -608,6 +709,7 @@ Config::write_config () const
        root->add_child("MailUser")->add_child_text (_mail_user);
        /* [XML] MailPassword Password to use on SMTP server. */
        root->add_child("MailPassword")->add_child_text (_mail_password);
+
        /* [XML] KDMSubject Subject to use for KDM emails. */
        root->add_child("KDMSubject")->add_child_text (_kdm_subject);
        /* [XML] KDMFrom From address to use for KDM emails. */
@@ -621,6 +723,21 @@ Config::write_config () const
        /* [XML] KDMEmail Text of KDM email */
        root->add_child("KDMEmail")->add_child_text (_kdm_email);
 
+       /* [XML] NotificationSubject Subject to use for Notification emails. */
+       root->add_child("NotificationSubject")->add_child_text (_notification_subject);
+       /* [XML] NotificationFrom From address to use for Notification emails. */
+       root->add_child("NotificationFrom")->add_child_text (_notification_from);
+       /* [XML] NotificationFrom To address to use for Notification emails. */
+       root->add_child("NotificationTo")->add_child_text (_notification_to);
+       BOOST_FOREACH (string i, _notification_cc) {
+               /* [XML] NotificationCC CC address to use for Notification emails; you can use as many of these tags as you like. */
+               root->add_child("NotificationCC")->add_child_text (i);
+       }
+       /* [XML] NotificationBCC BCC address to use for Notification emails */
+       root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
+       /* [XML] NotificationEmail Text of Notification email */
+       root->add_child("NotificationEmail")->add_child_text (_notification_email);
+
        /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
        root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
        /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
@@ -630,6 +747,8 @@ Config::write_config () const
        root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
        /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
        root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
+       /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers */
+       root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
        /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
           to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
           to sending email.
@@ -745,12 +864,105 @@ Config::write_config () const
                root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
        }
 
+       /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0 */
+       root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
+
+       /* [XML] Notification 1 if a notification type is enabled, otherwise 0 */
+       for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
+               xmlpp::Element* e = root->add_child ("Notification");
+               e->set_attribute ("Id", raw_convert<string>(i));
+               e->add_child_text (_notification[i] ? "1" : "0");
+       }
+
+       if (_barco_username) {
+               root->add_child("BarcoUsername")->add_child_text(*_barco_username);
+       }
+       if (_barco_password) {
+               root->add_child("BarcoPassword")->add_child_text(*_barco_password);
+       }
+
+       if (_christie_username) {
+               root->add_child("ChristieUsername")->add_child_text(*_christie_username);
+       }
+       if (_christie_password) {
+               root->add_child("ChristiePassword")->add_child_text(*_christie_password);
+       }
+
+       if (_gdc_username) {
+               root->add_child("GDCUsername")->add_child_text(*_gdc_username);
+       }
+       if (_gdc_password) {
+               root->add_child("GDCPassword")->add_child_text(*_gdc_password);
+       }
+
+       switch (_interface_complexity) {
+       case INTERFACE_SIMPLE:
+               root->add_child("InterfaceComplexity")->add_child_text("simple");
+               break;
+       case INTERFACE_FULL:
+               root->add_child("InterfaceComplexity")->add_child_text("full");
+               break;
+       }
+
+       switch (_player_mode) {
+       case PLAYER_MODE_WINDOW:
+               root->add_child("PlayerMode")->add_child_text("window");
+               break;
+       case PLAYER_MODE_FULL:
+               root->add_child("PlayerMode")->add_child_text("full");
+               break;
+       case PLAYER_MODE_DUAL:
+               root->add_child("PlayerMode")->add_child_text("dual");
+               break;
+       }
+
+       root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
+       root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
+       if (_player_log_file) {
+               root->add_child("PlayerLogFile")->add_child_text(_player_log_file->string());
+       }
+       if (_player_content_directory) {
+               root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
+       }
+       if (_player_playlist_directory) {
+               root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
+       }
+       if (_player_kdm_directory) {
+               root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
+       }
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       if (_player_background_image) {
+               root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
+       }
+       root->add_child("KDMServerURL")->add_child_text(_kdm_server_url);
+       root->add_child("PlayerWatermarkTheatre")->add_child_text(_player_watermark_theatre);
+       root->add_child("PlayerWatermarkPeriod")->add_child_text(raw_convert<string>(_player_watermark_period));
+       root->add_child("PlayerWatermarkDuration")->add_child_text(raw_convert<string>(_player_watermark_duration));
+       BOOST_FOREACH (Monitor i, _required_monitors) {
+               i.as_xml(root->add_child("RequiredMonitor"));
+       }
+       if (_player_lock_file) {
+               root->add_child("PlayerLockFile")->add_child_text(_player_lock_file->string());
+       }
+#endif
+
        try {
-               doc.write_to_file_formatted(config_file().string());
+               string const s = doc.write_to_string_formatted ();
+               boost::filesystem::path const cf = config_file ();
+               FILE* f = fopen_boost (cf, "w");
+               if (!f) {
+                       throw FileError (_("Could not open file for writing"), cf);
+               }
+               size_t const w = fwrite (s.c_str(), 1, s.length(), f);
+               if (w != s.length()) {
+                       fclose (f);
+                       throw FileError (_("Could not write whole file"), cf);
+               }
+               fclose (f);
        } catch (xmlpp::exception& e) {
                string s = e.what ();
                trim (s);
-               throw FileError (s, path("config.xml"));
+               throw FileError (s, config_file());
        }
 }
 
@@ -830,6 +1042,16 @@ Config::set_kdm_email_to_default ()
                );
 }
 
+void
+Config::set_notification_email_to_default ()
+{
+       _notification_subject = _("DCP-o-matic notification");
+
+       _notification_email = _(
+               "$JOB_NAME: $JOB_STATUS"
+               );
+}
+
 void
 Config::reset_kdm_email ()
 {
@@ -837,6 +1059,13 @@ Config::reset_kdm_email ()
        changed ();
 }
 
+void
+Config::reset_notification_email ()
+{
+       set_notification_email_to_default ();
+       changed ();
+}
+
 void
 Config::set_cover_sheet_to_default ()
 {
@@ -875,7 +1104,7 @@ Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::file
                h.pop_back ();
        }
 
-       changed ();
+       changed (HISTORY);
 }
 
 bool
@@ -902,6 +1131,10 @@ Config::read_cinemas (cxml::Document const & f)
 void
 Config::set_cinemas_file (boost::filesystem::path file)
 {
+       if (file == _cinemas_file) {
+               return;
+       }
+
        _cinemas_file = file;
 
        if (boost::filesystem::exists (_cinemas_file)) {
@@ -1007,3 +1240,15 @@ Config::copy_and_link (boost::filesystem::path new_file) const
        boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
        link (new_file);
 }
+
+bool
+Config::have_write_permission () const
+{
+       FILE* f = fopen_boost (config_file(), "r+");
+       if (!f) {
+               return false;
+       }
+
+       fclose (f);
+       return true;
+}