Version 0.9: Use a nickserv password, and some fixes for OCaml 3.11.
[xavierbot.git] / xavierbot.pl
index f79310d..d229477 100755 (executable)
@@ -1,45 +1,53 @@
-#!/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,v 1.3 2007/06/28 19:47:26 rjones Exp $
+# $Id: xavierbot.pl,v 1.14 2010/04/04 19:38:40 rjones Exp $
 
 use strict;
-
-use POE qw(Component::IRC);
+use POE qw(Component::IRC Wheel::Run);
+use Getopt::Long;
+use POE::Component::IRC::Plugin::NickServID;
 
 #----------------------------------------------------------------------
 # Start of configuration.
 
 my $nick = "xavierbot";
 my $ircname = "Xavierbot";             # Printable name.
-#my $server = "chat.freenode.net";
-my $server = "devserv.devel.redhat.com";
+my $server = "chat.freenode.net";
 my $port = 6667;
+my $channel = "#ocaml";
 
-my @channels = ("#ocaml");
+my $nickservpw = "123456"; # or undef
 
 # End of configuration.
 #----------------------------------------------------------------------
 
-my $irc = POE::Component::IRC->spawn (
-      nick => $nick,
-      ircname => $ircname,
-      server => $server,
-      port => $port,
-  ) or die "POE::Component::IRC->spawn failed: $!";
+# 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) ],
+    main => [ qw(_default _start irc_001 irc_public got_stdout got_sigchld) ],
   ],
-  heap => { irc => $irc },
-);
-
-POE::Wheel::Run->new (
-  Program => [ "/usr/local/sbin/ocamlbotwrapper" ],
-  StdoutEvent => 'stdout_event',
-  StderrEvent => 'stdout_event',
 );
 
 POE::Kernel->run ();
@@ -49,6 +57,26 @@ sub _start
 {
     my ($kernel, $heap) = @_[KERNEL,HEAP];
 
+    my $irc = POE::Component::IRC->spawn
+       (
+        nick => $nick,
+        ircname => $ircname,
+        server => $server,
+        port => $port,
+        ) or die "POE::Component::IRC->spawn 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;
+
     my $irc_session = $heap->{irc}->session_id ();
     $kernel->post ($irc_session => register => "all");
     $kernel->post ($irc_session => connect => { });
@@ -63,21 +91,56 @@ sub irc_001
     my $poco_object = $sender->get_heap ();
     print "Connected to ", $poco_object->server_name (), "\n";
 
-    $kernel->post ($sender => join => $_ ) for @channels;
+    $kernel->post ($sender => join => $channel);
     undef;
 }
 
 sub irc_public
 {
-    my ($kernel, $sender, $who, $where, $what) =
-       @_[KERNEL,SENDER,ARG0,ARG1,ARG2];
+    my ($kernel, $sender, $who, $where, $what, $heap) =
+       @_[KERNEL,SENDER,ARG0,ARG1,ARG2,HEAP];
     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 ($rot13) = $what =~ /^rot13 (.+)/) {
-       $rot13 =~ tr[a-zA-Z][n-za-mN-ZA-M];
-       $kernel->post ($sender => privmsg => $channel => "$nick: $rot13");
+    # 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 0.8, 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;
 }
@@ -100,10 +163,49 @@ sub _default
 
 #----------------------------------------------------------------------
 
-# Start the bot.
+# Toplevel wrote something.
 
-sub stdout_event
+sub got_stdout
 {
-    my ($heap, $input, $wheel_id) = @_[HEAP,ARG0,ARG1];
+    my ($kernel,$heap, $input, $wheel_id) = @_[KERNEL,HEAP,ARG0,ARG1];
     print "Child said: $input\n";
+    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 => "./ocamlbotwrapper",
+        StdoutEvent => "got_stdout",
+        StderrEvent => "got_stdout",
+        ) or die "POE::Wheel::Run->new ./ocamlbotwrapper 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;
 }