Added a Greet module.

doc/CHANGELOG

@@ -3,6 +3,7 @@ Auto IRC Bot 3.0: Change Log
 
 3.0 Indev
 ===============================================================================
+    * Added a Greet module for greeting users on join.
     * Added PostgreSQL support. Official modules do not support this yet.
     * database:format now a required configuration value.
     * Added support for MySQL. ./install --with-mysql

modules/Greet.pm

@@ -0,0 +1,159 @@
+# Module: Greet. See below for documentation.
+# Copyright (C) 2010-2011 Xelhua Development Group, et al.
+# This program is free software; rights to this code are stated in doc/LICENSE.
+package m_Greet;
+use strict;
+use warnings;
+use feature qw(switch);
+use API::Std qw(cmd_add cmd_del hook_add hook_del trans);
+use API::IRC qw(privmsg notice);
+
+# Initialization subroutine.
+sub _init
+{
+    # Not compatible with PostgreSQL.
+    if ($Auto::ENFEAT =~ /pgsql/) { err(2, 'Unable to load Greet: PostgreSQL is not supported.', 0); return; }
+
+    # Create the `greets` table.
+    $Auto::DB->do('CREATE TABLE IF NOT EXISTS greets (nick TEXT, greet TEXT)') or return;
+    # Create the GREET command.
+    cmd_add('GREET', 2, 'cmd.greet', \%m_Greet::HELP_GREET, \&m_Greet::cmd_greet) or return;
+    # Create the greet_onjoin hook.
+    hook_add('on_rcjoin', 'greet_onjoin', \&m_Greet::hook_rcjoin) or return;
+
+    # Success.
+    return 1;
+}
+
+# Void subroutine.
+sub _void
+{
+    # Delete the GREET command.
+    cmd_del('GREET') or return;
+    # Delete the greet_onjoin hook.
+    hook_del('on_rcjoin') or return;
+
+    # Success.
+    return 1;
+}
+
+# Help hash for GREET. Spanish, French and German translation needed.
+our %HELP_GREET = (
+    'en' => "This command allows management of greets. \002Syntax:\002 GREET (ADD|DEL) [nick] [greet]",
+);
+# Callback for GREET.
+sub cmd_greet
+{
+    my (%data) = @_;
+    my @argv = @{ $data{args} }; delete $data{args};
+
+    # Check for required parameters.
+    if (!defined $argv[0]) {
+        notice($data{svr}, $data{nick}, trans('Not enough parameters').q{.});
+        return;
+    }
+
+    # Check what action we're being told to take.
+    given (uc $argv[0]) {
+        when ('ADD') {
+            # GREET ADD
+            
+            # Check for needed parameters.
+            if (!defined $argv[1] or !defined $argv[2]) {
+                notice($data{svr}, $data{nick}, trans('Not enough parameters').q{.});
+                return;
+            }
+            my $nick = $argv[1]; shift @argv; shift @argv;
+            $nick = lc $nick;
+            my $greet = join(' ', @argv);
+
+            # Make sure it doesn't already exist.
+            if ($Auto::DB->selectrow_array('SELECT * FROM greets WHERE nick = "'.$nick.'"')) {
+                notice($data{svr}, $data{nick}, "A greet for \002$nick\002 already exists.");
+                return;
+            }
+
+            # Insert into database.
+            my $dbq = $Auto::DB->prepare('INSERT INTO greets (nick, greet) VALUES (?, ?)') or notice($data{svr}, $data{nick}, trans('An error occurred').q{.}) and return;
+            $dbq->execute($nick, $greet) or notice($data{svr}, $data{nick}, trans('An error occurred').q{.}) and return;
+
+            # Done.
+            notice($data{svr}, $data{nick}, "Successfully added greet for \002$nick\002.");
+        }
+        when ('DEL') {
+            # GREET DEL
+            
+            # Check for needed parameters.
+            if (!defined $argv[1]) {
+                notice($data{svr}, $data{nick}, trans('Not enough parameters').q{.});
+                return;
+            }
+            my $nick = lc $argv[1];
+
+            # Check if there is a greet for this user.
+            if (!$Auto::DB->selectrow_array('SELECT * FROM greets WHERE nick = "'.$nick.'"')) {
+                notice($data{svr}, $data{nick}, "There is no greet for \002$nick\002.");
+                return;
+            }
+
+            # Delete it.
+            $Auto::DB->do('DELETE FROM greets WHERE nick = "'.$nick.'"') or notice($data{svr}, $data{nick}, trans('An error occurred').q{.}) and return;
+            notice($data{svr}, $data{nick}, "Greet for \002$nick\002 successfully deleted.");
+        }
+        default { notice($data{svr}, $data{nick}, "Unknown action \002$argv[0]\002. \002Syntax:\002 GREET (ADD|DEL)"); return; }
+    }
+
+    return 1;
+}
+
+# Call back for on_rcjoin hook.
+sub hook_rcjoin
+{
+    my (($svr, $src, $chan)) = @_;
+    my $nick = lc $src->{nick};
+
+    # Check if there's a greet for this user.
+    if ($Auto::DB->selectrow_array('SELECT * FROM greets WHERE nick = "'.$nick.'"')) {
+        # Get data.
+        my @data = $Auto::DB->selectrow_array('SELECT * FROM greets WHERE nick = "'.$nick.'"');
+        
+        # Send the greet.
+        privmsg($svr, $chan, "[\002".$src->{nick}."\002] ".$data[1]);
+    }
+
+    return 1;
+}
+
+# Start initialization.
+API::Std::mod_init('Greet', 'Xelhua', '1.00', '3.0.0d', __PACKAGE__);
+# vim: set ai sw=4 ts=4:
+# build: perl=5.010000
+
+__END__
+
+=head1 Greet
+
+=head2 Description
+
+=over
+
+This module adds GREET ADD|DEL for greet management. Greets are sent when a
+user that has a greet in the database joins a channel the bot is in.
+
+=back
+
+=head2 To Do
+
+=over
+
+* Add Spanish, French and German translations for the help hash.
+
+=back
+
+=head2 Technical
+
+=over
+
+This module is compatible with Auto version 3.0.0a4+.
+
+=back