Version 0.9: Use a nickserv password, and some fixes for OCaml 3.11.

[xavierbot.git] / xavierbot.pl.in

diff --git a/xavierbot.pl.in b/xavierbot.pl.in
index 243dcbc..55ddae6 100755 (executable)
--- a/xavierbot.pl.in
+++ b/xavierbot.pl.in
@@ -1,14 +1,13 @@
-#!/usr/bin/perl -wT
+#!/usr/bin/perl -w
 # xavierbot : an OCaml interpreter IRC bot.
 # By Richard W.M. Jones <rich@annexia.org>.
 # This code is in the Public Domain.
-# $Id: xavierbot.pl.in,v 1.2 2007/06/28 20:49:10 rjones Exp $
+# $Id: xavierbot.pl.in,v 1.10 2010/04/04 19:38:40 rjones Exp $
 
 use strict;
-
 use POE qw(Component::IRC Wheel::Run);
-
-$ENV{PATH} = "/usr/bin:/bin";
+use Getopt::Long;
+use POE::Component::IRC::Plugin::NickServID;
 
 #----------------------------------------------------------------------
 # Start of configuration.
@@ -16,16 +15,38 @@ $ENV{PATH} = "/usr/bin:/bin";
 my $nick = "xavierbot";
 my $ircname = "Xavierbot";             # Printable name.
 my $server = "chat.freenode.net";
-#my $server = "devserv.devel.redhat.com";
 my $port = 6667;
 my $channel = "#ocaml";
 
+my $nickservpw = "123456"; # or undef
+
 # End of configuration.
 #----------------------------------------------------------------------
 
+# Command line args can override configuration.
+GetOptions ("nick=s" => \$nick,
+           "ircname=s" => \$ircname,
+           "server=s" => \$server,
+           "port=i" => \$port,
+           "channel=s" => \$channel)
+    or die "$0: GetOptions: $!";
+
+# Simple flood protection.  This counts number of lines received from
+# the toplevel, and is reset when we send a line.  If this exceeds
+# some value, then we just eat lines.
+# XXX This ought to count characters, not lines.
+my $flood_lim = 0;
+
+# Are we awake or sleeping?
+my $sleeping = 0;
+
+#----------------------------------------------------------------------
+
+$ENV{PATH} = "/usr/bin:/bin";
+
 POE::Session->create (
   package_states => [
-    main => [ qw(_default _start irc_001 irc_public got_stdout) ],
+    main => [ qw(_default _start irc_001 irc_public got_stdout got_sigchld) ],
   ],
 );
 
@@ -44,12 +65,14 @@ sub _start
         port => $port,
         ) or die "POE::Component::IRC->spawn failed: $!";
 
-    my $ocaml = POE::Wheel::Run->new
-       (
-        Program => "@WRAPPER@",
-        StdoutEvent => "got_stdout",
-        StderrEvent => "got_stdout",
-        ) or die "POE::Wheel::Run->new @WRAPPER@ failed: $!";
+    $irc->plugin_add('NickServID',
+                     POE::Component::IRC::Plugin::NickServID->new(
+                         Password => $nickservpw,
+                     ));
+
+    my $ocaml = start_toplevel ();
+
+    $kernel->sig(CHLD => qw(got_sigchld));
 
     $heap->{irc} = $irc;
     $heap->{ocaml} = $ocaml;
@@ -79,10 +102,45 @@ sub irc_public
     my $nick = (split /!/, $who)[0];
     my $channel = $where->[0];
 
+    my @usage =
+       (
+        "expr ;;  evaluate expr in toplevel and print result",
+        "help     help message",
+        "restart  restart the toplevel",
+        "sleep    go to sleep",
+        "wake     wake me up from sleep",
+        );
+
     print "got: $what\n";
-    if (my ($stmt) = $what =~ /^\s*([^#].*;;)\s*$/) {
-       print "stmt = $stmt\n";
-       $heap->{ocaml}->put ("$stmt\n");
+    # XXX How to interpolate $nick into the patterns?
+    if ($what =~ /^\s*xavierbot\b.*\bhelp\b/) {
+       my $nick = (split /!/, $who)[0];
+       $kernel->post ($sender => privmsg => $channel =>
+           "hello $nick, I am xavierbot @VERSION@, an OCaml toplevel");
+       $kernel->post ($sender => privmsg => $channel => $_)
+           foreach (@usage);
+    }
+    elsif ($what =~ /^\s*xavierbot\b.*\brestart\b/) {
+       $sleeping = 0;
+       print STDOUT "got instruction to restart ...\n";
+       restart_toplevel ($heap->{ocaml});
+    }
+    elsif (!$sleeping) {
+       if (my ($stmt) = $what =~ m/^\s*([^\#].*;;)\s*$/) {
+           $heap->{ocaml}->put ("$stmt\n");
+           $flood_lim = 0;
+       }
+       elsif ($what =~ /^\s*xavierbot\b.*\b(sleep|shut|quiet)\b/) {
+           $sleeping = 1;
+           $kernel->post ($sender => privmsg => $channel =>
+                          "xavierbot goes to sleep (do 'xavierbot wake' to wake)");
+       }
+    } else { # sleeping
+       if ($what =~ /^\s*xavierbot\b.*\bwake\b/) {
+           $sleeping = 0;
+           $kernel->post ($sender => privmsg => $channel =>
+                          "xavierbot wakes up");
+       }
     }
     undef;
 }
@@ -105,11 +163,49 @@ sub _default
 
 #----------------------------------------------------------------------
 
-# Bot wrote something.
+# Toplevel wrote something.
 
 sub got_stdout
 {
     my ($kernel,$heap, $input, $wheel_id) = @_[KERNEL,HEAP,ARG0,ARG1];
     print "Child said: $input\n";
-    $kernel->post ($heap->{irc} => privmsg => $channel => "$input");
+    if ($flood_lim < 10) {
+       $kernel->post ($heap->{irc} => privmsg => $channel => "$input");
+    }
+    $flood_lim++;
+}
+
+# Got a SIGCHLD, so start the bot up again.
+
+sub got_sigchld
+{
+    my ($kernel, $heap) = @_[KERNEL,HEAP];
+    my $ocaml = start_toplevel ();
+    $heap->{ocaml} = $ocaml;
+}
+
+# Start up the toplevel (assumes it's not running).
+
+sub start_toplevel
+{
+    return POE::Wheel::Run->new
+       (
+        Program => "@WRAPPER@",
+        StdoutEvent => "got_stdout",
+        StderrEvent => "got_stdout",
+        ) or die "POE::Wheel::Run->new @WRAPPER@ failed: $!";
+}
+
+# Restart the toplevel - kill the old one, and a new one
+# will be spawned after we get the SIGCHLD signal.
+#
+# XXX Can't send signal to setuid child, so instead just close
+# stdin.
+
+sub restart_toplevel
+{
+    my $ocaml = shift;
+
+    $ocaml->kill (9);
+    $ocaml->shutdown_stdin;
 }