Allow explicit specification of email protocol (plain/STARTTLS/SSL).
[dcpomatic.git] / src / lib / config.cc
index 99ed74b29bc27d53c27fb0cfcecf36dfd38e6580..c71f3acd3a561f8f728b5f6e2bf15893b2cbe6fc 100644 (file)
@@ -89,7 +89,7 @@ Config::set_defaults ()
        _use_any_servers = true;
        _servers.clear ();
        _only_servers_encode = false;
-       _tms_protocol = PROTOCOL_SCP;
+       _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP;
        _tms_ip = "";
        _tms_path = ".";
        _tms_user = "";
@@ -109,6 +109,7 @@ Config::set_defaults ()
        _default_upload_after_make_dcp = false;
        _mail_server = "";
        _mail_port = 25;
+       _mail_protocol = EMAIL_PROTOCOL_AUTO;
        _mail_user = "";
        _mail_password = "";
        _kdm_from = "";
@@ -168,7 +169,8 @@ Config::set_defaults ()
        _player_mode = PLAYER_MODE_WINDOW;
        _image_display = 0;
        _respect_kdm_validity_periods = true;
-       _player_log_file = boost::none;
+       _player_activity_log_file = boost::none;
+       _player_debug_log_file = boost::none;
        _player_content_directory = boost::none;
        _player_playlist_directory = boost::none;
        _player_kdm_directory = boost::none;
@@ -285,7 +287,7 @@ try
        }
 
        _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_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
        _tms_ip = f.string_child ("TMSIP");
        _tms_path = f.string_child ("TMSPath");
        _tms_user = f.string_child ("TMSUser");
@@ -347,6 +349,21 @@ try
 
        _mail_server = f.string_child ("MailServer");
        _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
+
+       {
+               /* Make sure this matches the code in write_config */
+               string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
+               if (protocol == "Auto") {
+                       _mail_protocol = EMAIL_PROTOCOL_AUTO;
+               } else if (protocol == "Plain") {
+                       _mail_protocol = EMAIL_PROTOCOL_PLAIN;
+               } else if (protocol == "STARTTLS") {
+                       _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
+               } else if (protocol == "SSL") {
+                       _mail_protocol = EMAIL_PROTOCOL_SSL;
+               }
+       }
+
        _mail_user = f.optional_string_child("MailUser").get_value_or ("");
        _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 
@@ -550,7 +567,12 @@ try
 
        _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");
+       /* PlayerLogFile is old name */
+       _player_activity_log_file = f.optional_string_child("PlayerLogFile");
+       if (!_player_activity_log_file) {
+               _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
+       }
+       _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
        _player_content_directory = f.optional_string_child("PlayerContentDirectory");
        _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
        _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
@@ -741,6 +763,21 @@ Config::write_config () const
        root->add_child("MailServer")->add_child_text (_mail_server);
        /* [XML] MailPort Port number to use on SMTP server. */
        root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
+       /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
+       switch (_mail_protocol) {
+       case EMAIL_PROTOCOL_AUTO:
+               root->add_child("MailProtocol")->add_child_text("Auto");
+               break;
+       case EMAIL_PROTOCOL_PLAIN:
+               root->add_child("MailProtocol")->add_child_text("Plain");
+               break;
+       case EMAIL_PROTOCOL_STARTTLS:
+               root->add_child("MailProtocol")->add_child_text("STARTTLS");
+               break;
+       case EMAIL_PROTOCOL_SSL:
+               root->add_child("MailProtocol")->add_child_text("SSL");
+               break;
+       }
        /* [XML] MailUser Username to use on SMTP server. */
        root->add_child("MailUser")->add_child_text (_mail_user);
        /* [XML] MailPassword Password to use on SMTP server. */
@@ -989,20 +1026,24 @@ Config::write_config () const
        root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
        /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
        root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
-       if (_player_log_file) {
-               /* [XML] PlayerLogFile Filename to use for player logs */
-               root->add_child("PlayerLogFile")->add_child_text(_player_log_file->string());
+       if (_player_activity_log_file) {
+               /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
+               root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
+       }
+       if (_player_debug_log_file) {
+               /* [XML] PlayerLogFile Filename to use for player debug logs */
+               root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
        }
        if (_player_content_directory) {
-               /* [XML] PlayerContentDirectory Filename to use for player content in the dual-screen mode. */
+               /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
                root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
        }
        if (_player_playlist_directory) {
-               /* [XML] PlayerPlaylistDirectory Filename to use for player playlists in the dual-screen mode. */
+               /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
                root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
        }
        if (_player_kdm_directory) {
-               /* [XML] PlayerKDMDirectory Filename to use for player KDMs in the dual-screen mode. */
+               /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
                root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
        }
 #ifdef DCPOMATIC_VARIANT_SWAROOP
@@ -1162,12 +1203,26 @@ Config::add_to_history (boost::filesystem::path p)
        add_to_history_internal (_history, p);
 }
 
+/** Remove non-existant items from the history */
+void
+Config::clean_history ()
+{
+       clean_history_internal (_history);
+}
+
 void
 Config::add_to_player_history (boost::filesystem::path p)
 {
        add_to_history_internal (_player_history, p);
 }
 
+/** Remove non-existant items from the player history */
+void
+Config::clean_player_history ()
+{
+       clean_history_internal (_player_history);
+}
+
 void
 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
 {
@@ -1182,6 +1237,18 @@ Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::file
        changed (HISTORY);
 }
 
+void
+Config::clean_history_internal (vector<boost::filesystem::path>& h)
+{
+       vector<boost::filesystem::path> old = h;
+       h.clear ();
+       BOOST_FOREACH (boost::filesystem::path i, old) {
+               if (boost::filesystem::is_directory(i)) {
+                       h.push_back (i);
+               }
+       }
+}
+
 bool
 Config::have_existing (string file)
 {