Player log file -> player activity log file.
authorCarl Hetherington <cth@carlh.net>
Thu, 14 Feb 2019 22:10:35 +0000 (22:10 +0000)
committerCarl Hetherington <cth@carlh.net>
Thu, 14 Feb 2019 22:10:35 +0000 (22:10 +0000)
src/lib/config.cc
src/lib/config.h
src/wx/player_config_dialog.cc
src/wx/swaroop_controls.cc

index 99ed74b..ac7cf7e 100644 (file)
@@ -168,7 +168,7 @@ 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_content_directory = boost::none;
        _player_playlist_directory = boost::none;
        _player_kdm_directory = boost::none;
@@ -550,7 +550,11 @@ 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_content_directory = f.optional_string_child("PlayerContentDirectory");
        _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
        _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
@@ -989,9 +993,9 @@ 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_content_directory) {
                /* [XML] PlayerContentDirectory Filename to use for player content in the dual-screen mode. */
index e3a34ae..5ae14eb 100644 (file)
@@ -484,8 +484,8 @@ public:
                return _respect_kdm_validity_periods;
        }
 
-       boost::optional<boost::filesystem::path> player_log_file () const {
-               return _player_log_file;
+       boost::optional<boost::filesystem::path> player_activity_log_file () const {
+               return _player_activity_log_file;
        }
 
        boost::optional<boost::filesystem::path> player_content_directory () const {
@@ -940,15 +940,15 @@ public:
                maybe_set (_respect_kdm_validity_periods, r);
        }
 
-       void set_player_log_file (boost::filesystem::path p) {
-               maybe_set (_player_log_file, p);
+       void set_player_activity_log_file (boost::filesystem::path p) {
+               maybe_set (_player_activity_log_file, p);
        }
 
-       void unset_player_log_file () {
-               if (!_player_log_file) {
+       void unset_player_activity_log_file () {
+               if (!_player_activity_log_file) {
                        return;
                }
-               _player_log_file = boost::none;
+               _player_activity_log_file = boost::none;
                changed ();
        }
 
@@ -1227,7 +1227,10 @@ private:
        PlayerMode _player_mode;
        int _image_display;
        bool _respect_kdm_validity_periods;
-       boost::optional<boost::filesystem::path> _player_log_file;
+       /** Log file containing things the player does (e.g. started, stopped, loaded
+           playlist etc.)  Does not contain debugging information.
+       */
+       boost::optional<boost::filesystem::path> _player_activity_log_file;
        /** A directory containing DCPs whose contents are presented to the user
            in the dual-screen player mode.  DCPs on the list can be loaded
            for playback.
index ab72284..b4a4ee4 100644 (file)
@@ -106,9 +106,9 @@ private:
                table->Add (_respect_kdm, wxGBPosition(r, 0), wxGBSpan(1, 2));
                ++r;
 
-               add_label_to_sizer (table, _panel, _("Log file"), true, wxGBPosition (r, 0));
-               _log_file = new FilePickerCtrl (_panel, _("Select log file"), "*", true);
-               table->Add (_log_file, wxGBPosition (r, 1));
+               add_label_to_sizer (table, _panel, _("Activity log file"), true, wxGBPosition (r, 0));
+               _activity_log_file = new FilePickerCtrl (_panel, _("Select activity log file"), "*", true);
+               table->Add (_activity_log_file, wxGBPosition(r, 1));
                ++r;
 
 #ifdef DCPOMATIC_VARIANT_SWAROOP
@@ -126,7 +126,7 @@ private:
                _player_mode->Bind (wxEVT_CHOICE, bind(&PlayerGeneralPage::player_mode_changed, this));
                _image_display->Bind (wxEVT_CHOICE, bind(&PlayerGeneralPage::image_display_changed, this));
                _respect_kdm->Bind (wxEVT_CHECKBOX, bind(&PlayerGeneralPage::respect_kdm_changed, this));
-               _log_file->Bind (wxEVT_FILEPICKER_CHANGED, bind(&PlayerGeneralPage::log_file_changed, this));
+               _activity_log_file->Bind (wxEVT_FILEPICKER_CHANGED, bind(&PlayerGeneralPage::activity_log_file_changed, this));
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                _kdm_server_url->Bind (wxEVT_TEXT, bind(&PlayerGeneralPage::kdm_server_url_changed, this));
                _lock_file->Bind (wxEVT_FILEPICKER_CHANGED, bind(&PlayerGeneralPage::lock_file_changed, this));
@@ -153,8 +153,8 @@ private:
 
                checked_set (_image_display, config->image_display());
                checked_set (_respect_kdm, config->respect_kdm_validity_periods());
-               if (config->player_log_file()) {
-                       checked_set (_log_file, *config->player_log_file());
+               if (config->player_activity_log_file()) {
+                       checked_set (_activity_log_file, *config->player_activity_log_file());
                }
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                checked_set (_kdm_server_url, config->kdm_server_url());
@@ -190,9 +190,9 @@ private:
                Config::instance()->set_respect_kdm_validity_periods(_respect_kdm->GetValue());
        }
 
-       void log_file_changed ()
+       void activity_log_file_changed ()
        {
-               Config::instance()->set_player_log_file(wx_to_std(_log_file->GetPath()));
+               Config::instance()->set_player_activity_log_file(wx_to_std(_activity_log_file->GetPath()));
        }
 
 #ifdef DCPOMATIC_VARIANT_SWAROOP
@@ -210,7 +210,7 @@ private:
        wxChoice* _player_mode;
        wxChoice* _image_display;
        wxCheckBox* _respect_kdm;
-       FilePickerCtrl* _log_file;
+       FilePickerCtrl* _activity_log_file;
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        wxTextCtrl* _kdm_server_url;
        FilePickerCtrl* _lock_file;
index 8cd3b1d..622e943 100644 (file)
@@ -274,7 +274,7 @@ SwaroopControls::log (wxString s)
        wxString ts = std_to_wx(string(buffer)) + N_(": ");
        _log->SetValue(_log->GetValue() + ts + s + "\n");
 
-       optional<boost::filesystem::path> log = Config::instance()->player_log_file();
+       optional<boost::filesystem::path> log = Config::instance()->player_activity_log_file();
        if (!log) {
                return;
        }