Merge lp:~dlh/armagetronad/0.2.8-armagetronad-ladderlog_script into lp:armagetronad/0.2.8

[dlh]

• New commands LADDERLOG_SCRIPT_WRITE, and LADDERLOG_SCRIPT_WRITE_ALL that allow better control over which events are sent to spawned scripts.
• The CONSOLE_LADDER_LOG setting has been removed. Its functionality has been reimplemented in scripts/examples/echo.sh.

Useful for enabling events only for spawned scripts, so that they don't spam your ladderlog.txt. For example: I don't really need the CHAT, COMMAND, or GAME_TIME events to be written to ladderlog.txt, but I have a script that uses them. I also have a ladderlog sync program where it would be helpful to enable all the events I'm interested in sending.

Translatable strings
====================

• Removed: console_ladder_log_help, ladderlog_write_all_usage
• Added: ladderlog_script_write_all_help, ladderlog_script_write_help, ladderlog_script_write_enabled, ladderlog_script_write_disabled
• Modified: ladderlog_write_all_help, ladderlog_write_all_enabled

[dlh (dlh)]

review: Needs Resubmitting

[lp:~dlh/armagetronad/0.2.8-armagetronad-ladderlog_script]

1410. By dlh on 2013-07-24

Merge from 0.2.8

Unmerged revisions

1410. By dlh on 2013-07-24

Merge from 0.2.8

1409. By dlh on 2012-09-19

* New commands LADDERLOG_SCRIPT_WRITE, and LADDERLOG_SCRIPT_WRITE_ALL that allow better control over which events are sent to spawned scripts.
* The CONSOLE_LADDER_LOG setting has been removed. Its functionality has been reimplemented in scripts/examples/echo.sh.

=== modified file 'NEWS'
--- NEWS	2013-07-24 02:45:51 +0000
+++ NEWS	2013-07-24 20:16:23 +0000
@@ -32,6 +32,10 @@
 - Manage external scripts on Unix dedicated servers. New commands: 
   SPAWN_SCRIPT, RESPAWN_SCRIPT, FORCE_RESPAWN_SCRIPT, KILL_SCRIPT,
   LIST_SCRIPTS, SCRIPT_ENV.
+- New commands LADDERLOG_SCRIPT_WRITE, and LADDERLOG_SCRIPT_WRITE_ALL that
+  allow better control over which events are sent to spawned scripts.
+- The CONSOLE_LADDER_LOG setting has been removed. Its functionality has been
+  reimplemented in scripts/examples/echo.sh.
 - Authentication is now enabled by default.
 
 Changes since 0.2.8.3.1:

=== modified file 'config/settings_dedicated.cfg'
--- config/settings_dedicated.cfg	2013-04-12 17:34:00 +0000
+++ config/settings_dedicated.cfg	2013-07-24 20:16:23 +0000
@@ -419,7 +419,15 @@
 WAIT_FOR_EXTERNAL_SCRIPT 0          # set to 1 if you want the server to sleep between rounds until it is set back to 0 or
 WAIT_FOR_EXTERNAL_SCRIPT_TIMEOUT 3  # seconds
 
+# Configuring which ladderlog events are enabled or disabled
 
+# LADDERLOG_WRITE_*          Enable or disable an individual ladderlog writer for both file and script output. Usage: LADDERLOG_WRITE_* 0|1
+# LADDERLOG_WRITE_ALL        Enable or disable all ladderlog writers for both file and script output. Usage: LADDERLOG_WRITE_ALL 0|1
+# 
+# The following LADDERLOG_SCRIPT_* commands are only available on Unix.
+# 
+# LADDERLOG_SCRIPT_WRITE     Enable or disable ladderlog writers for script output. Usage: LADDERLOG_SCRIPT_WRITE 0|1 <event1> [<event2> ...]
+# LADDERLOG_SCRIPT_WRITE_ALL Enable or disable all ladderlog writers for script output. Usage: LADDERLOG_SCRIPT_WRITE_ALL 0|1
 
 ############################################################################################
 #

=== modified file 'language/english_base.txt'
--- language/english_base.txt	2013-04-12 17:34:00 +0000
+++ language/english_base.txt	2013-07-24 20:16:23 +0000
@@ -788,11 +788,13 @@
 console_decorate_id_help			Decorates every line of console output with the client ID
 console_decorate_ip_help			Decorates every line of console output with the client IP
 console_decorate_timestamp_help			Decorates every line of console output with the current date and time
-console_ladder_log_help			Sends ladder log output to the console
 ladderlog_decorate_timestamp_help		Decorates every line of ladderlog output with the current date and time
-ladderlog_write_all_help Set all the LADDER_LOG_WRITE_* settings to the same value
-ladderlog_write_all_usage Usage: LADDER_LOG_WRITE_ALL 1|0
-ladderlog_write_all_enabled Enabled full ladderlog output.
+ladderlog_write_all_help         Enable or disable all ladderlog writers for both file and script output. Usage: LADDERLOG_WRITE_ALL 0|1
+ladderlog_script_write_all_help  Enable or disable all ladderlog writers for script output. Usage: LADDERLOG_SCRIPT_WRITE_ALL 0|1
+ladderlog_script_write_help      Enable or disable ladderlog writers for script output. Usage: LADDERLOG_SCRIPT_WRITE 0|1 <event1> [<event2> ...]
+ladderlog_script_write_enabled   Enabled \1 ladderlog writers for script output.
+ladderlog_script_write_disabled  Disabled \1 ladderlog writers for script output.
+ladderlog_write_all_enabled Enabled ladderlog output.
 ladderlog_write_all_disabled Disabled ladderlog output.
 ladderlog_write_authority_blurb_help          Write to ladderlog: AUTHORITY_BLURB <blurb> <player> <text>
 ladderlog_write_basezone_conquered_help       Write to ladderlog: BASEZONE_CONQUERED <team> <cx> <cy>

=== added file 'scripts/examples/echo.sh'
--- scripts/examples/echo.sh	1970-01-01 00:00:00 +0000
+++ scripts/examples/echo.sh	2013-07-24 20:16:23 +0000
@@ -0,0 +1,7 @@
+#!/bin/bash
+# A script that simply echos back ladderlog lines to the server console.
+
+while read line
+do
+    echo "# $line"
+done

=== modified file 'src/engine/ePlayer.cpp'
--- src/engine/ePlayer.cpp	2013-07-24 02:45:51 +0000
+++ src/engine/ePlayer.cpp	2013-07-24 20:16:23 +0000
@@ -5999,37 +5999,24 @@
     return object;
 }
 
-static bool se_consoleLadderLog = false;
-static tSettingItem< bool > se_consoleLadderLogConf( "CONSOLE_LADDER_LOG", se_consoleLadderLog );
-
-static bool se_ladderlogDecorateTS = false;
-static tSettingItem< bool > se_ladderlogDecorateTSConf( "LADDERLOG_DECORATE_TIMESTAMP", se_ladderlogDecorateTS );
-extern bool sn_decorateTS; // from nNetwork.cpp
-
-void se_SaveToLadderLog( tOutput const & out )
+typedef std::set< tString > StringSet;
+
+// Parses a list of tokens and adds them to "set".
+// Returns the number of entries added.
+int se_ParseList( StringSet & set, std::istream & s )
 {
-    if (se_consoleLadderLog)
-    {
-        std::cout << "[L";
-        if(sn_decorateTS) {
-            std::cout << st_GetCurrentTime(" TS=%Y/%m/%d-%H:%M:%S");
-        }
-        std::cout << "] " << out << std::endl;
-    }
-    if (sn_GetNetState()!=nCLIENT && !tRecorder::IsPlayingBack())
-    {
-        std::ofstream o;
-        if ( tDirectories::Var().Open(o, "ladderlog.txt", std::ios::app) )
+    int entries_count = 0;
+    while ( s.good() )
+    {
+        tString name;
+        s >> name;
+        if ( name.Len() > 1 )
         {
-            std::stringstream s;
-            if(se_ladderlogDecorateTS) {
-                s << st_GetCurrentTime("%Y/%m/%d-%H:%M:%S ");
-            }
-            s << out << std::endl;
-            sr_InputForScripts( s.str().c_str() );
-            o << s.str();
+            std::pair< StringSet::iterator, bool > ret = set.insert( name );
+            if ( ret.second ) entries_count++;
         }
     }
+    return entries_count;
 }
 
 static bool se_chatLog = false;
@@ -6052,65 +6039,196 @@
     }
 }
 
-std::list<eLadderLogWriter *> &eLadderLogWriter::writers() {
-    static std::list<eLadderLogWriter *> list;
-    return list;
-}
-
-eLadderLogWriter::eLadderLogWriter(char const *ID, bool enabledByDefault) :
-    id(ID),
-    enabled(enabledByDefault),
-    conf(new tSettingItem<bool>(&(tString("LADDERLOG_WRITE_") + id)(0),
-    enabled)),
-    cache(id) {
-    writers().push_back(this);
-}
-
-eLadderLogWriter::~eLadderLogWriter() {
-    if(conf) {
-        delete conf;
-    }
-    // generic algorithms aren't exactly easier to understand than regular
-    // code, but anyways, let's try one...
-    std::list<eLadderLogWriter *> list = writers();
-    list.erase(std::find_if(list.begin(), list.end(), std::bind2nd(std::equal_to<eLadderLogWriter *>(), this)));
-}
-
-void eLadderLogWriter::write() {
-    if(enabled) {
-        se_SaveToLadderLog(cache);
-    }
-    cache = id;
-}
-
-void eLadderLogWriter::setAll(bool enabled) {
-    std::list<eLadderLogWriter *> list = writers();
-    std::list<eLadderLogWriter *>::iterator end = list.end();
-    for(std::list<eLadderLogWriter *>::iterator iter = list.begin(); iter != end; ++iter) {
-        (*iter)->enabled = enabled;
-    }
-}
-
-static void LadderLogWriteAll(std::istream &s) {
-    bool enabled;
-    s >> enabled;
-    if(s.fail()) {
-        if(tConfItemBase::printErrors) {
-            con << tOutput("$ladderlog_write_all_usage") << '\n';
-        }
-        return;
-    }
-    if(tConfItemBase::printChange) {
-        if(enabled) {
-            con << tOutput("$ladderlog_write_all_enabled") << '\n';
-        } else {
-            con << tOutput("$ladderlog_write_all_disabled") << '\n';
-        }
-    }
-    eLadderLogWriter::setAll(enabled);
-}
-
-static tConfItemFunc LadderLogWriteAllConf("LADDERLOG_WRITE_ALL", &LadderLogWriteAll);
+//! Handles configuring ladderlog settings
+class eLadderLogManager
+{
+    enum SetMode
+    {
+        SetMode_File   = 1 << 0,
+        SetMode_Script = 1 << 1
+    };
+    typedef std::map< tString, eLadderLogWriter * > WriterMap;
+    WriterMap writers_;
+public:
+    eLadderLogManager()
+        :writers_()
+    {
+    }
+    
+    void Add( eLadderLogWriter *writer )
+    {
+        writers_[writer->Name()] = writer;
+    }
+    
+    void Remove( eLadderLogWriter *writer )
+    {
+        writers_.erase( writer->Name() );
+    }
+    
+    void WriteAll( std::istream & s )
+    {
+        SetAll( "$ladderlog_write_all_help", s, SetMode_File | SetMode_Script );
+    }
+    
+    void ScriptWriteAll( std::istream & s )
+    {
+        SetAll( "$ladderlog_script_write_all_help", s, SetMode_Script );
+    }
+    
+    void ScriptWrite( std::istream & s )
+    {
+        bool enable;
+        s >> enable;
+        if ( s.fail() )
+        {
+            if ( tConfItemBase::printErrors )
+                con << tOutput("$ladderlog_script_write_help") << '\n';
+            return;
+        }
+
+        StringSet names;
+        se_ParseList( names, s );
+        int numberValid = 0;
+        
+        for ( StringSet::const_iterator it = names.begin(); it != names.end(); ++it )
+        {
+            WriterMap::iterator conf = writers_.find( *it );
+            if ( conf != writers_.end() )
+            {
+                numberValid++;
+                conf->second->SetForScript( enable );
+            }
+        }
+        
+        if ( tConfItemBase::printChange )
+        {
+            if ( enable )
+                con << tOutput("$ladderlog_script_write_enabled", numberValid) << '\n';
+            else
+                con << tOutput("$ladderlog_script_write_disabled", numberValid) << '\n';
+        }
+    }
+
+private:
+    void SetAll( const char *help, std::istream & s, int mode )
+    {
+        bool enable;
+        s >> enable;
+
+        if ( s.fail() )
+        {
+            if ( tConfItemBase::printErrors )
+                con << tOutput(help) << '\n';
+            return;
+        }
+        
+        for ( WriterMap::iterator it = writers_.begin(); it != writers_.end(); ++it )
+        {
+            if ( mode & SetMode_File )
+                it->second->SetForFile( enable );
+            if ( mode & SetMode_Script )
+                it->second->SetForScript( enable );
+        }
+        
+        if ( tConfItemBase::printChange )
+        {
+            if ( enable )
+                con << tOutput("$ladderlog_write_all_enabled") << '\n';
+            else
+                con << tOutput("$ladderlog_write_all_disabled") << '\n';
+        }
+    }    
+};
+
+static eLadderLogManager & se_GlobalLadderLogManager()
+{
+    static eLadderLogManager manager;
+    return manager;
+}
+
+//! A tSettingItem that operates on two boolean values.
+class eLadderLogSetting : public tSettingItem< bool >
+{
+public:
+    eLadderLogSetting( tString name, bool & fileTarget, bool & scriptTarget )
+        :tConfItemBase( name ), tSettingItem< bool >( name, fileTarget ),
+        scriptTarget_( &scriptTarget )
+    {
+    }
+    
+    virtual void WasChanged()
+    {
+        *scriptTarget_ = *target;
+    }
+private:
+    bool *scriptTarget_;
+};
+
+eLadderLogWriter::eLadderLogWriter( char const *name, bool enabledByDefault )
+    :name_( name ),
+    isEnabledForFile_( enabledByDefault ),
+    isEnabledForScript_( enabledByDefault ),
+    conf_( new eLadderLogSetting( tString( "LADDERLOG_WRITE_" ) + name, isEnabledForFile_, isEnabledForScript_ ) ),
+    cache_( name )
+{
+    se_GlobalLadderLogManager().Add( this );
+}
+
+eLadderLogWriter::~eLadderLogWriter()
+{
+    se_GlobalLadderLogManager().Remove( this );
+    if ( conf_ )
+        delete conf_;
+}
+
+static bool se_ladderlogDecorateTS = false;
+static tSettingItem< bool > se_ladderlogDecorateTSConf( "LADDERLOG_DECORATE_TIMESTAMP", se_ladderlogDecorateTS );
+
+void eLadderLogWriter::write()
+{
+    if( isEnabled() && sn_GetNetState() != nCLIENT && !tRecorder::IsPlayingBack() )
+    {
+        std::string line;
+        if ( se_ladderlogDecorateTS )
+            line += st_GetCurrentTime("%Y/%m/%d-%H:%M:%S ");
+        line += cache_;
+        line += '\n';
+        
+        if ( isEnabledForFile_ )
+        {
+            std::ofstream o;
+            if ( tDirectories::Var().Open( o, "ladderlog.txt", std::ios::app ) )
+                o << line;
+        }
+        
+        if ( isEnabledForScript_ )
+        {
+            sr_InputForScripts( line.c_str() );
+        }
+    }
+    cache_ = name_;
+}
+
+static void se_LadderLogWriteAll( std::istream & s )
+{
+    se_GlobalLadderLogManager().WriteAll( s );
+}
+static tConfItemFunc se_ladderLogWriteAllConf( "LADDERLOG_WRITE_ALL", se_LadderLogWriteAll );
+
+#if HAVE_UNISTD_H
+static void se_LadderLogScriptWriteAll( std::istream & s )
+{
+    se_GlobalLadderLogManager().ScriptWriteAll( s );
+}
+static tConfItemFunc se_ladderLogScriptWriteAllConf( "LADDERLOG_SCRIPT_WRITE_ALL", se_LadderLogScriptWriteAll );
+
+static void se_LadderLogScriptWrite( std::istream & s )
+{
+    se_GlobalLadderLogManager().ScriptWrite( s );    
+}
+static tConfItemFunc se_ladderLogScriptWriteConf( "LADDERLOG_SCRIPT_WRITE", se_LadderLogScriptWrite );
+#endif /* HAVE_UNISTD_H */
+
 
 void se_SaveToScoreFile(const tOutput &o){
     tString s(o);
@@ -8715,30 +8833,18 @@
     {
         Parse( ip_addresses_whitelist_, s );
     }
-protected:
-    typedef std::set< tString > StringSet;
+protected:    
+    bool HasEntry( const StringSet & whitelist, const tString & value ) const
+    {
+        return whitelist.find( value ) != whitelist.end();
+    }
     
     void Parse( StringSet & whitelist, std::istream & s )
     {
-        int entries_count = 0;
-        while ( s.good() )
-        {
-            tString name;
-            s >> name;
-            if ( name.Len() > 1 )
-            {
-                std::pair< StringSet::iterator, bool > ret = whitelist.insert( name );
-                if ( ret.second ) entries_count++;
-            }
-        }
+        int entries_count = se_ParseList( whitelist, s );
         con << tOutput( "$whitelist_enemies_success", entries_count ) << '\n';
     }
     
-    bool HasEntry( const StringSet & whitelist, const tString & value ) const
-    {
-        return whitelist.find( value ) != whitelist.end();
-    }
-    
     StringSet usernames_whitelist_;
     StringSet ip_addresses_whitelist_;    
 };

=== modified file 'src/engine/ePlayer.h'
--- src/engine/ePlayer.h	2013-07-24 02:45:51 +0000
+++ src/engine/ePlayer.h	2013-07-24 20:16:23 +0000
@@ -518,27 +518,37 @@
 void se_SaveToChatLog( tOutput const & out );  //!< writes something to chatlog.txt (if enabled) and/or ladderlog
 
 //! create a global instance of this to write stuff to ladderlog.txt
-class eLadderLogWriter {
-    static std::list<eLadderLogWriter *> &writers();
-    tString id;
-    bool enabled;
-    tSettingItem<bool> *conf;
-    tColoredString cache;
+class eLadderLogWriter
+{
+    tString name_;
+    bool isEnabledForFile_;
+    bool isEnabledForScript_;
+    tSettingItem<bool> *conf_;
+    tColoredString cache_;
 public:
-    eLadderLogWriter(char const *ID, bool enabledByDefault);
+    eLadderLogWriter( char const *name, bool enabledByDefault );
     ~eLadderLogWriter();
+    tString Name() const { return name_; }
+    
+    void SetForFile( bool enable ) { isEnabledForFile_ = enable; }
+    void SetForScript( bool enable ) { isEnabledForScript_ = enable; }
+    
     //! append a field to the current message. Spaces are added automatically.
-    template<typename T> eLadderLogWriter &operator<<(T const &s) {
-        if(enabled) {
-            cache << ' ' << s;
-        }
+    template<typename T> eLadderLogWriter &operator<<( T const &s )
+    {
+        if( isEnabled() )
+            cache_ << ' ' << s;
         return *this;
     }
-    void write(); //!< send to ladderlog and clear message
-
-    bool isEnabled() { return enabled; } //!< check this if you're going to make expensive calculations for ladderlog output
-
-    static void setAll(bool enabled); //!< enable or disable all writers
+    
+    //!< send to ladderlog and clear message
+    void write();
+
+    //!< check this if you're going to make expensive calculations for ladderlog output
+    bool isEnabled() const
+    {
+        return isEnabledForFile_ || isEnabledForScript_;
+    }
 };
 
 tColoredString & operator << (tColoredString &s,const ePlayer &p);