config file implemented (thanks oOo)

NickServ capability (thanks oOo)

apps/bogobot/Bogobot.java

@@ -7,8 +7,13 @@
  */
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
 
+import java.util.Timer;
+import java.util.TimerTask;
+import java.util.Properties;
+
 import org.apache.log4j.DailyRollingFileAppender;
 import org.apache.log4j.Level;
 import org.apache.log4j.Logger;
@@ -20,12 +25,10 @@ import org.jibble.pircbot.PircBot;
 import org.jibble.pircbot.User;
 
 /**
- * TODO 0.4 Implement java.util.Properties for configuration.
- * TODO 0.4 Add NickServ interface.
  * TODO 0.5 Add multi-server capability.
  * 
- * @author hypercubus
+ * @author hypercubus, oOo
- * @version 0.3.1
+ * @version 0.4
  */
 public class Bogobot extends PircBot {
 
@@ -36,32 +39,116 @@ public class Bogobot extends PircBot {
     private boolean _isIntentionalDisconnect      = false;
     private long    _lastUserlistCommandTimestamp = 0;
     private Logger  _logger                       = Logger.getLogger(Bogobot.class);
-    /*
-     * The following will soon be moved to bogo.config and loaded via
-     * java.util.Properties when I get some time.
-     */
-    private String  _botPrimaryNick           = "somebot";
-    private String  _botSecondaryNick         = "somebot_";
-    private String  _botShutdownPassword      = "take off eh";
-    private long    _commandAntiFloodInterval = 60;
-    private String  _ircChannel               = "#i2p-chat";
-    private String  _ircServer                = "irc.duck.i2p";
-    private int     _ircServerPort            = 6668;
-    private boolean _isLoggerEnabled          = true;
-    private boolean _isUserlistCommandEnabled = true;
-    private String  _logFilePrefix            = "irc.duck.i2p.i2p-chat";
-    private String  _logFileRotationInterval  = INTERVAL_DAILY;
-    private String  _ownerPrimaryNick         = "somenick";
-    private String  _ownerSecondaryNick       = "somenick_";
-    private String  _userlistCommandTrigger   = "!who";
 
-    public Bogobot() {
+    private int     _currentAutoRoundTripTag      = 0;
+    private long    _lastAutoRoundTripSentTime    = 0;
+    private Timer   _tickTimer;
+
+    private String  _configFile;
+
+    private String  _botPrimaryNick;
+    private String  _botSecondaryNick;
+    private String  _botNickservPassword;
+    private String  _botUsername;
+    private String  _ownerPrimaryNick;
+    private String  _ownerSecondaryNick;
+    private String  _botShutdownPassword;
+    private String  _ircChannel;
+    private String  _ircServer;
+    private int     _ircServerPort;
+    private boolean _isLoggerEnabled;
+    private String  _loggedHostnamePattern;
+    private boolean _isUserlistCommandEnabled;
+    private String  _logFilePrefix;
+    private String  _logFileRotationInterval;
+    private long    _commandAntiFloodInterval;
+    private String  _userlistCommandTrigger;
+    private boolean _isRoundTripDelayEnabled;
+    private int     _roundTripDelayPeriod;
+
+    class BogobotTickTask extends TimerTask {
+        private Bogobot _caller;
+
+        public BogobotTickTask(Bogobot caller) {
+            _caller = caller;
+        }
+
+        public void run() {
+          _caller.onTick();
+        }
+    }
+
+    private void loadConfigFile(String configFileName) {
+
+        _configFile = configFileName;
+
+        Properties config = new Properties();
+        FileInputStream fis = null;
+
+        try {
+            fis = new FileInputStream(configFileName);
+            config.load(fis);
+        } catch (IOException ioe) {
+            System.err.println("Error loading configuration file");
+            System.exit(2);
+
+        } finally {
+            if (fis != null) try {
+                fis.close();
+            } catch (IOException ioe) { // nop
+            }
+        }
+
+        _botPrimaryNick = config.getProperty("botPrimaryNick", "somebot");
+        _botSecondaryNick = config.getProperty("botSecondaryNick", "somebot_");
+        _botNickservPassword = config.getProperty("botNickservPassword", "");
+        _botUsername = config.getProperty("botUsername", "somebot");
+
+        _ownerPrimaryNick = config.getProperty("ownerPrimaryNick", "somenick");
+        _ownerSecondaryNick = config.getProperty("ownerSecondaryNick", "somenick_");
+
+        _botShutdownPassword = config.getProperty("botShutdownPassword", "take off eh");
+
+        _ircChannel = config.getProperty("ircChannel", "#i2p-chat");
+        _ircServer = config.getProperty("ircServer", "irc.duck.i2p");
+        _ircServerPort = Integer.parseInt(config.getProperty("ircServerPort", "6668"));
+
+        _isLoggerEnabled = Boolean.valueOf(config.getProperty("isLoggerEnabled", "true")).booleanValue();
+        _loggedHostnamePattern = config.getProperty("loggedHostnamePattern", "");
+        _logFilePrefix = config.getProperty("logFilePrefix", "irc.duck.i2p.i2p-chat");
+        _logFileRotationInterval = config.getProperty("logFileRotationInterval", INTERVAL_DAILY);
+
+        _isRoundTripDelayEnabled = Boolean.valueOf(config.getProperty("isRoundTripDelayEnabled", "false")).booleanValue();
+        _roundTripDelayPeriod = Integer.parseInt(config.getProperty("roundTripDelayPeriod", "300"));
+
+        _isUserlistCommandEnabled = Boolean.valueOf(config.getProperty("isUserlistCommandEnabled", "true")).booleanValue();
+        _userlistCommandTrigger = config.getProperty("userlistCommandTrigger", "!who");
+        _commandAntiFloodInterval = Long.parseLong(config.getProperty("commandAntiFloodInterval", "60"));
+    }
+
+    public Bogobot(String configFileName) {
+
+        loadConfigFile(configFileName);
+
         this.setName(_botPrimaryNick);
+        this.setLogin(_botUsername);
+        _tickTimer = new Timer();
+        _tickTimer.scheduleAtFixedRate(new BogobotTickTask(this), 1000, 10 * 1000);
     }
 
     public static void main(String[] args) {
 
-        Bogobot bogobot = new Bogobot();
+        Bogobot bogobot;
+
+        if (args.length > 1) {
+            System.err.println("Too many arguments, the only allowed parameter is configuration file name");
+            System.exit(3);
+        }
+        if (args.length == 1) {
+          bogobot = new Bogobot(args[0]);
+        } else {
+          bogobot = new Bogobot("bogobot.config");
+        }
 
         bogobot.setVerbose(true);
 
@@ -71,6 +158,19 @@ public class Bogobot extends PircBot {
         bogobot.connectToServer();
     }
 
+    protected void onTick() {
+        // Tick about once every ten seconds
+
+        if (this.isConnected() && _isRoundTripDelayEnabled) {
+            if( ( (System.currentTimeMillis() - _lastAutoRoundTripSentTime) >= (_roundTripDelayPeriod * 1000) ) && (this.getOutgoingQueueSize() == 0) ) {
+                // Connected, sending queue is empty and last RoundTrip is more then 5 minutes old -> Send a new one
+                _currentAutoRoundTripTag ++;
+                _lastAutoRoundTripSentTime = System.currentTimeMillis();
+                sendNotice(this.getNick(),"ROUNDTRIP " + _currentAutoRoundTripTag);
+            }
+        }
+    }
+
     protected void onDisconnect() {
 
         if (_isIntentionalDisconnect)
@@ -88,18 +188,22 @@ public class Bogobot extends PircBot {
     }
 
     protected void onJoin(String channel, String sender, String login, String hostname) {
+
+        if (_isLoggerEnabled) {
             if (sender.equals(this.getName())) {
 
-            if (_isLoggerEnabled)
                 _logger.info(System.currentTimeMillis() + " joins *** " + _botPrimaryNick + " ***");
 
             } else {
 
-            if (_isLoggerEnabled)
+                String prependedHostname = "@" + hostname;
+                if (prependedHostname.endsWith(_loggedHostnamePattern)) {
                     _logger.info(System.currentTimeMillis() + " joins " + sender);
+                }
 
             }
         }
+    }
 
     protected void onMessage(String channel, String sender, String login, String hostname, String message) {
         message = message.replaceFirst("<.+?> ", "");
@@ -121,8 +225,16 @@ public class Bogobot extends PircBot {
 
     protected void onPart(String channel, String sender, String login, String hostname) {
 
-        if (_isLoggerEnabled)
+        if (_isLoggerEnabled) {
+            if (sender.equals(this.getName())) {
+                _logger.info(System.currentTimeMillis() + " parts *** " + _botPrimaryNick + " ***");
+            } else {
+                String prependedHostname = "@" + hostname;
+                if (prependedHostname.endsWith(_loggedHostnamePattern)) {
                     _logger.info(System.currentTimeMillis() + " parts " + sender);
+                }
+            }
+        }
 
     }
 
@@ -142,9 +254,16 @@ public class Bogobot extends PircBot {
     }
 
     protected void onQuit(String sourceNick, String sourceLogin, String sourceHostname, String reason) {
+        String prependedHostname = "@" + sourceHostname;
 
-        if (_isLoggerEnabled)
+        if (sourceNick.equals(_botPrimaryNick))
+            changeNick(_botPrimaryNick);
+
+        if (_isLoggerEnabled) {
+            if (prependedHostname.endsWith(_loggedHostnamePattern)) {
                 _logger.info(System.currentTimeMillis() + " quits " + sourceNick + " " + reason);
+            }
+        }
 
     }
 
@@ -187,6 +306,20 @@ public class Bogobot extends PircBot {
         joinChannel(_ircChannel);
     }
 
+    protected void onNotice(String sourceNick, String sourceLogin, String sourceHostname, String target, String notice) {
+
+        if (sourceNick.equals("NickServ") && (notice.indexOf("/msg NickServ IDENTIFY") >= 0) && (_botNickservPassword != "")) {
+            sendRawLineViaQueue("NICKSERV IDENTIFY " + _botNickservPassword);
+        }
+
+        if (sourceNick.equals(getNick()) && notice.equals( "ROUNDTRIP " + _currentAutoRoundTripTag)) {
+            int delay = (int)((System.currentTimeMillis() - _lastAutoRoundTripSentTime) / 100);
+//            sendMessage(_ircChannel, "Round-trip delay = " + (delay / 10.0f) + " seconds");
+            if (_isLoggerEnabled)
+                _logger.info(System.currentTimeMillis() + " roundtrip " + delay);
+        }
+    }
+
     private void initLogger() {
 
         String                   logFilePath         = "logs" + File.separator + _logFilePrefix;
@@ -211,4 +344,5 @@ public class Bogobot extends PircBot {
             System.exit(1);
         }
     }
+
 }

apps/bogobot/Bogoparser.java

@@ -17,7 +17,7 @@ import java.util.regex.Pattern;
 
 /**
  * @author hypercubus
- * @version 0.3.1
+ * @version 0.4
  */
 public class Bogoparser {
 

apps/bogobot/bogobot.config

@@ -0,0 +1,101 @@
+#####
+# Bogobot user configuration
+#####
+
+###
+# The bot's nick and backup nick. You will probably want to register these with
+# the IRC server's NickServ.(a NickServ interface is forthcoming).
+#
+botPrimaryNick=somebot
+botSecondaryNick=somebot_
+
+###
+# The bot's password required by Nickserv service's identify command.
+# You have to register the nickname yourself first, the bot will not.
+#
+botNickservPassword=
+
+###
+# The bot's username. Appears in the whois replies
+#
+botUsername=somebot
+
+#####
+# The bot owner's nick and backup nick. One of these must match the owner's
+# currently-used nick or else remote shutdown will not be possible. You will
+# probably want to register these with the IRC server's NickServ.
+#
+ownerPrimaryNick=somenick
+ownerSecondaryNick=somenick_
+
+###
+# The bot will disconnect and shut down when sent this password via private
+# message (aka query) from either of the owner nicks specified above. DO NOT USE
+# THIS DEFAULT VALUE!
+#
+botShutdownPassword=take off eh
+
+###
+# The server, channel, and port the bot will connect to.
+#
+ircChannel=#i2p-chat
+ircServer=irc.duck.i2p
+ircServerPort=6668
+
+###
+# Set to "true" to enable logging, else "false" (but don't use quotation marks).
+#
+isLoggerEnabled=true
+
+###
+# Restrict logging of joins and parts on the user hostname.
+# Leave empty to log all of them
+# Prepend with a @ for a perfect match
+# Otherwise, specify the required end of the user hostname
+#
+loggedHostnamePattern=@free.duck.i2p
+
+###
+# The prefix to be used for the filenames of logs.
+#
+logFilePrefix=irc.duck.i2p.i2p-chat
+
+###
+# How often the logs should be rotated. Either "daily", "weekly", or "monthly"
+# (but don't use quotation marks).
+#
+logFileRotationInterval=daily
+
+###
+# Set to "true" to enable the regular round-trip delay computation,
+# else "false" (but don't use quotation marks).
+#
+isRoundTripDelayEnabled=false
+
+###
+# How often should the round-trip delay be recorded.
+# (in seconds)
+#
+roundTripDelayPeriod=300
+
+###
+# Set to "true" to enable the userlist command, else "false" (but don't use
+# quotation marks).
+#
+isUserlistCommandEnabled=true
+
+###
+# The userlist trigger command to listen for. It is a good idea to prefix
+# triggers with some non-alphanumeric character in order to avoid accidental
+# trigger use during normal channel conversation. In most cases you will
+# probably want to choose a unique trigger here that no other bots in the
+# channel will respond to.
+#
+userlistCommandTrigger=!who
+
+###
+# The number of seconds to rest after replying to a userlist command issued by
+# a user in the channel. The bot will ignore subsequent userlist commands during
+# this period. This helps prevent flooding.
+#
+commandAntiFloodInterval=60

apps/bogobot/build-eclipse.xml

@@ -3,12 +3,12 @@
 <!-- ********************************************************** -->
 <!-- bogobot - A simple join/part stats logger bot for I2P IRC. -->
 <!--                                                            -->
-<!-- build_eclipse.xml                                          -->
+<!-- build-eclipse.xml                                          -->
 <!-- 2004 The I2P Project                                       -->
 <!-- This code is public domain.                                -->
 <!--                                                            -->
-<!-- author hypercubus                                          -->
+<!-- author hypercubus, oOo                                     -->
-<!-- version 0.3.1                                              -->
+<!-- version 0.4                                                -->
 <!-- ********************************************************** -->
 
 <project basedir="." default="dist" name="Bogobot">
@@ -27,7 +27,7 @@
     Create the binary distribution archive -->
     <target depends="init" description="Create the binary distribution archive" name="dist.bin">
         <zip destfile="dist/Bogobot_${DSTAMP}.zip">
-            <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
+            <zipfileset dir="${basedir}" includes="bogobot.bat bogobot.config Bogobot.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
         </zip>
     </target>
 
@@ -35,7 +35,7 @@
     Create the source distribution archive -->
     <target depends="init" description="Create the source distribution archive" name="dist.source">
         <zip destfile="dist/Bogobot_source_${DSTAMP}.zip">
-            <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
+            <zipfileset dir="${basedir}" includes="bogobot.bat bogobot.config Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
         </zip>
     </target>
 

apps/bogobot/build.xml

@@ -7,8 +7,8 @@
 <!-- 2004 The I2P Project                                       -->
 <!-- This code is public domain.                                -->
 <!--                                                            -->
-<!-- author hypercubus                                          -->
+<!-- author hypercubus, oOo                                     -->
-<!-- version 0.3.1                                              -->
+<!-- version 0.4                                                -->
 <!-- ********************************************************** -->
 
 <project basedir="." default="compile" name="Bogobot">
@@ -26,14 +26,14 @@
     <!-- compile:
     Compile source code -->
     <target depends="init" description="Compile source code" name="compile">
-        <javac classpath="${basedir}" source="1.4" srcdir="." />
+        <javac classpath="${basedir};log4j-1.2.8.jar;pircbot.jar" source="1.4" srcdir="." />
     </target>
 
     <!-- dist.bin:
     Create the binary distribution archive -->
     <target depends="init,compile" description="Create the binary distribution archive" name="dist.bin">
         <zip destfile="dist/Bogobot_${DSTAMP}.zip">
-            <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
+            <zipfileset dir="${basedir}" includes="bogobot.bat bogobot.config Bogobot.class Bogobot$BogobotTickTask.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
         </zip>
     </target>
 
@@ -41,7 +41,7 @@
     Create the source distribution archive -->
     <target depends="init" description="Create the source distribution archive" name="dist.source">
         <zip destfile="dist/Bogobot_source_${DSTAMP}.zip">
-            <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
+            <zipfileset dir="${basedir}" includes="bogobot.bat bogobot.config Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" />
         </zip>
     </target>