2010-03-17 07:36:54 +01:00
|
|
|
# File: PBot.pm
|
|
|
|
# Author: pragma_
|
|
|
|
#
|
|
|
|
# Purpose: IRC Bot (3rd generation)
|
|
|
|
|
2017-03-05 22:33:31 +01:00
|
|
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
|
2010-03-17 07:36:54 +01:00
|
|
|
package PBot::PBot;
|
|
|
|
|
|
|
|
use strict;
|
|
|
|
use warnings;
|
|
|
|
|
2019-07-11 03:40:53 +02:00
|
|
|
use feature 'unicode_strings';
|
|
|
|
|
2010-03-17 07:36:54 +01:00
|
|
|
# unbuffer stdout
|
|
|
|
STDOUT->autoflush(1);
|
|
|
|
|
|
|
|
use Carp ();
|
|
|
|
use PBot::Logger;
|
2018-01-23 08:48:25 +01:00
|
|
|
use PBot::VERSION;
|
2014-05-17 22:08:19 +02:00
|
|
|
use PBot::Registry;
|
2014-03-14 06:51:15 +01:00
|
|
|
use PBot::SelectHandler;
|
2010-03-17 07:36:54 +01:00
|
|
|
use PBot::StdinReader;
|
2011-01-22 09:35:31 +01:00
|
|
|
use PBot::IRC;
|
2014-11-01 01:15:21 +01:00
|
|
|
use PBot::EventDispatcher;
|
2010-03-22 08:33:44 +01:00
|
|
|
use PBot::IRCHandlers;
|
2010-03-23 19:24:02 +01:00
|
|
|
use PBot::Channels;
|
2011-02-13 06:07:02 +01:00
|
|
|
use PBot::BanTracker;
|
2014-11-15 02:18:33 +01:00
|
|
|
use PBot::NickList;
|
2011-01-25 00:56:55 +01:00
|
|
|
use PBot::LagChecker;
|
2014-05-13 12:15:52 +02:00
|
|
|
use PBot::MessageHistory;
|
2010-03-17 07:36:54 +01:00
|
|
|
use PBot::AntiFlood;
|
2018-08-06 07:41:08 +02:00
|
|
|
use PBot::AntiSpam;
|
2010-03-22 08:33:44 +01:00
|
|
|
use PBot::Interpreter;
|
|
|
|
use PBot::Commands;
|
|
|
|
use PBot::ChanOps;
|
2019-06-26 18:34:19 +02:00
|
|
|
use PBot::Factoids;
|
2010-03-22 08:33:44 +01:00
|
|
|
use PBot::BotAdmins;
|
|
|
|
use PBot::IgnoreList;
|
2015-03-17 05:08:25 +01:00
|
|
|
use PBot::BlackList;
|
2010-03-22 08:33:44 +01:00
|
|
|
use PBot::Timer;
|
2015-06-16 04:55:46 +02:00
|
|
|
use PBot::Refresher;
|
2015-09-07 07:52:39 +02:00
|
|
|
use PBot::Plugins;
|
2017-12-06 06:05:44 +01:00
|
|
|
use PBot::WebPaste;
|
2019-06-07 06:46:00 +02:00
|
|
|
use PBot::Utils::ParseDate;
|
2019-08-25 04:03:08 +02:00
|
|
|
use PBot::FuncCommand;
|
2010-03-17 07:36:54 +01:00
|
|
|
|
|
|
|
sub new {
|
2019-05-28 18:19:42 +02:00
|
|
|
if (ref($_[1]) eq 'HASH') {
|
2014-05-06 07:15:27 +02:00
|
|
|
Carp::croak("Options to PBot should be key/value pairs, not hash reference");
|
2010-03-17 07:36:54 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
my ($class, %conf) = @_;
|
2010-03-22 08:33:44 +01:00
|
|
|
my $self = bless {}, $class;
|
|
|
|
$self->initialize(%conf);
|
2014-05-17 00:11:31 +02:00
|
|
|
$self->register_signal_handlers;
|
2010-03-22 08:33:44 +01:00
|
|
|
return $self;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub initialize {
|
|
|
|
my ($self, %conf) = @_;
|
|
|
|
|
2019-12-29 19:44:05 +01:00
|
|
|
$self->{startup_timestamp} = time;
|
2015-06-16 04:55:46 +02:00
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
my $data_dir = $conf{data_dir};
|
|
|
|
my $module_dir = $conf{module_dir};
|
|
|
|
my $plugin_dir = $conf{plugin_dir};
|
|
|
|
|
|
|
|
# check command-line arguments for directory overrides
|
|
|
|
foreach my $arg (@ARGV) {
|
|
|
|
if ($arg =~ m/^(?:general\.)?((?:data|module|plugin)_dir)=(.*)$/) {
|
|
|
|
my $override = $1;
|
|
|
|
my $value = $2;
|
|
|
|
$data_dir = $value if $override eq 'data_dir';
|
|
|
|
$module_dir = $value if $override eq 'module_dir';
|
|
|
|
$plugin_dir = $value if $override eq 'plugin_dir';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-29 19:44:05 +01:00
|
|
|
# logger created first to allow other modules to log things
|
|
|
|
$self->{logger} = PBot::Logger->new(filename => "$data_dir/log/log", %conf);
|
|
|
|
|
|
|
|
$self->{version} = PBot::VERSION->new(pbot => $self, %conf);
|
|
|
|
$self->{logger}->log($self->{version}->version . "\n");
|
|
|
|
$self->{logger}->log("Args: @ARGV\n") if @ARGV;
|
|
|
|
|
|
|
|
return if $conf{logger_only};
|
|
|
|
|
|
|
|
$self->{atexit} = PBot::Registerable->new(%conf);
|
|
|
|
$self->{timer} = PBot::Timer->new(timeout => 10, %conf);
|
|
|
|
|
|
|
|
$self->{commands} = PBot::Commands->new(pbot => $self, %conf);
|
|
|
|
$self->{func_cmd} = PBot::FuncCommand->new(pbot => $self, %conf);
|
|
|
|
|
|
|
|
$self->{refresher} = PBot::Refresher->new(pbot => $self);
|
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
# make sure the environment is sane
|
|
|
|
if (not -d $data_dir) {
|
|
|
|
$self->{logger}->log("Data directory ($data_dir) does not exist; aborting...\n");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (not -d $module_dir) {
|
|
|
|
$self->{logger}->log("Modules directory ($module_dir) does not exist; aborting...\n");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (not -d $plugin_dir) {
|
|
|
|
$self->{logger}->log("Plugins directory ($plugin_dir) does not exist; aborting...\n");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{logger}->log("data_dir: $data_dir\n");
|
|
|
|
$self->{logger}->log("module_dir: $module_dir\n");
|
|
|
|
$self->{logger}->log("plugin_dir: $plugin_dir\n");
|
2014-05-17 22:08:19 +02:00
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
# create registry and set some defaults
|
|
|
|
$self->{registry} = PBot::Registry->new(pbot => $self, filename => "$data_dir/registry", %conf);
|
2014-05-17 22:08:19 +02:00
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{registry}->add_default('text', 'general', 'data_dir', $data_dir);
|
|
|
|
$self->{registry}->add_default('text', 'general', 'module_dir', $module_dir);
|
|
|
|
$self->{registry}->add_default('text', 'general', 'plugin_dir', $plugin_dir);
|
2017-08-06 06:38:46 +02:00
|
|
|
$self->{registry}->add_default('text', 'general', 'trigger', $conf{trigger} // '!');
|
|
|
|
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'debug', $conf{irc_debug} // 0);
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'show_motd', $conf{show_motd} // 1);
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'max_msg_len', $conf{max_msg_len} // 425);
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'ircserver', $conf{ircserver} // "irc.freenode.net");
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'port', $conf{port} // 6667);
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'SSL', $conf{SSL} // 0);
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'SSL_ca_file', $conf{SSL_ca_file} // 'none');
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'SSL_ca_path', $conf{SSL_ca_path} // 'none');
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{registry}->add_default('text', 'irc', 'botnick', $conf{botnick} // "");
|
2017-08-06 06:38:46 +02:00
|
|
|
$self->{registry}->add_default('text', 'irc', 'username', $conf{username} // "pbot3");
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{registry}->add_default('text', 'irc', 'ircname', $conf{ircname} // "https://github.com/pragma-/pbot");
|
|
|
|
$self->{registry}->add_default('text', 'irc', 'identify_password', $conf{identify_password} // '');
|
2014-08-11 09:34:30 +02:00
|
|
|
$self->{registry}->add_default('text', 'irc', 'log_default_handler', 1);
|
2019-06-26 18:34:19 +02:00
|
|
|
|
2015-07-06 02:48:27 +02:00
|
|
|
$self->{registry}->set_default('irc', 'SSL_ca_file', 'private', 1);
|
|
|
|
$self->{registry}->set_default('irc', 'SSL_ca_path', 'private', 1);
|
|
|
|
$self->{registry}->set_default('irc', 'identify_password', 'private', 1);
|
2014-05-17 22:08:19 +02:00
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
# load existing registry entries from file (if exists) to overwrite defaults
|
|
|
|
if (-e $self->{registry}->{registry}->{filename}) {
|
|
|
|
$self->{registry}->load;
|
|
|
|
}
|
|
|
|
|
|
|
|
# update important paths
|
|
|
|
$self->{registry}->set('general', 'data_dir', 'value', $data_dir, 0, 1);
|
|
|
|
$self->{registry}->set('general', 'module_dir', 'value', $module_dir, 0, 1);
|
|
|
|
$self->{registry}->set('general', 'plugin_dir', 'value', $plugin_dir, 0, 1);
|
|
|
|
|
|
|
|
# override registry entries with command-line arguments, if any
|
|
|
|
foreach my $arg (@ARGV) {
|
|
|
|
next if $arg =~ m/^(?:general\.)?(?:config|data|module|plugin)_dir=.*$/; # already processed
|
|
|
|
my ($item, $value) = split /=/, $arg, 2;
|
|
|
|
|
|
|
|
if (not defined $item or not defined $value) {
|
|
|
|
$self->{logger}->log("Fatal error: unknown argument `$arg`; arguments must be in the form of `section.key=value` (e.g.: irc.botnick=newnick)\n");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
my ($section, $key) = split /\./, $item, 2;
|
|
|
|
|
|
|
|
if (not defined $section or not defined $key) {
|
|
|
|
$self->{logger}->log("Fatal error: bad argument `$arg`; registry entries must be in the form of section.key (e.g.: irc.botnick)\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{logger}->log("Overriding $section.$key to $value\n");
|
|
|
|
$self->{registry}->set($section, $key, 'value', $value, 0, 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
# registry triggers fire when value changes
|
2014-05-17 22:08:19 +02:00
|
|
|
$self->{registry}->add_trigger('irc', 'botnick', sub { $self->change_botnick_trigger(@_) });
|
2014-05-31 03:03:42 +02:00
|
|
|
$self->{registry}->add_trigger('irc', 'debug', sub { $self->irc_debug_trigger(@_) });
|
2019-06-26 18:34:19 +02:00
|
|
|
|
2019-12-22 04:04:39 +01:00
|
|
|
# ensure user has attempted to configure the bot
|
|
|
|
if (not length $self->{registry}->get_value('irc', 'botnick')) {
|
|
|
|
$self->{logger}->log("Fatal error: IRC nickname not defined; please set registry key irc.botnick in $data_dir/registry to continue.\n");
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{event_dispatcher} = PBot::EventDispatcher->new(pbot => $self, %conf);
|
2016-09-22 17:26:42 +02:00
|
|
|
$self->{irchandlers} = PBot::IRCHandlers->new(pbot => $self, %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{select_handler} = PBot::SelectHandler->new(pbot => $self, %conf);
|
|
|
|
$self->{stdin_reader} = PBot::StdinReader->new(pbot => $self, %conf);
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{admins} = PBot::BotAdmins->new(pbot => $self, filename => "$data_dir/admins", %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{bantracker} = PBot::BanTracker->new(pbot => $self, %conf);
|
|
|
|
$self->{lagchecker} = PBot::LagChecker->new(pbot => $self, %conf);
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{messagehistory} = PBot::MessageHistory->new(pbot => $self, filename => "$data_dir/message_history.sqlite3", %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{antiflood} = PBot::AntiFlood->new(pbot => $self, %conf);
|
2018-08-06 07:41:08 +02:00
|
|
|
$self->{antispam} = PBot::AntiSpam->new(pbot => $self, %conf);
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{ignorelist} = PBot::IgnoreList->new(pbot => $self, filename => "$data_dir/ignorelist", %conf);
|
|
|
|
$self->{blacklist} = PBot::BlackList->new(pbot => $self, filename => "$data_dir/blacklist", %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{irc} = PBot::IRC->new();
|
2019-12-22 04:04:39 +01:00
|
|
|
$self->{channels} = PBot::Channels->new(pbot => $self, filename => "$data_dir/channels", %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
$self->{chanops} = PBot::ChanOps->new(pbot => $self, %conf);
|
2016-09-22 17:26:42 +02:00
|
|
|
$self->{nicklist} = PBot::NickList->new(pbot => $self, %conf);
|
2017-12-06 06:05:44 +01:00
|
|
|
$self->{webpaste} = PBot::WebPaste->new(pbot => $self, %conf);
|
2019-06-07 06:46:00 +02:00
|
|
|
$self->{parsedate} = PBot::Utils::ParseDate->new(pbot => $self, %conf);
|
2014-12-28 01:44:15 +01:00
|
|
|
|
|
|
|
$self->{interpreter} = PBot::Interpreter->new(pbot => $self, %conf);
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{interpreter}->register(sub { return $self->{commands}->interpreter(@_); });
|
|
|
|
$self->{interpreter}->register(sub { return $self->{factoids}->interpreter(@_); });
|
2010-03-22 08:33:44 +01:00
|
|
|
|
2014-05-18 02:27:57 +02:00
|
|
|
$self->{factoids} = PBot::Factoids->new(
|
2014-05-19 00:51:37 +02:00
|
|
|
pbot => $self,
|
2019-12-22 04:04:39 +01:00
|
|
|
filename => "$data_dir/factoids",
|
2017-08-06 06:38:46 +02:00
|
|
|
export_path => $conf{export_factoids_path},
|
|
|
|
export_site => $conf{export_factoids_site},
|
2014-05-20 00:59:51 +02:00
|
|
|
%conf
|
2014-05-18 02:27:57 +02:00
|
|
|
);
|
2010-03-23 19:24:02 +01:00
|
|
|
|
2015-09-07 07:52:39 +02:00
|
|
|
$self->{plugins} = PBot::Plugins->new(pbot => $self, %conf);
|
2015-09-07 07:17:07 +02:00
|
|
|
|
2019-05-09 06:07:57 +02:00
|
|
|
# load available plugins
|
|
|
|
$self->{plugins}->autoload(%conf);
|
|
|
|
|
2014-05-17 22:08:19 +02:00
|
|
|
# create implicit bot-admin account for bot
|
|
|
|
my $botnick = $self->{registry}->get_value('irc', 'botnick');
|
2015-05-12 06:28:36 +02:00
|
|
|
$self->{admins}->add_admin($botnick, '.*', "$botnick!stdin\@localhost", 90, 'admin', 1);
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{admins}->login($botnick, "$botnick!stdin\@localhost", 'admin');
|
2014-05-17 22:08:19 +02:00
|
|
|
|
|
|
|
# start timer
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{timer}->start();
|
2010-03-17 07:36:54 +01:00
|
|
|
}
|
|
|
|
|
2015-01-11 00:56:43 +01:00
|
|
|
sub random_nick {
|
|
|
|
my @chars = ("A".."Z", "a".."z", "0".."9");
|
2015-02-14 13:01:09 +01:00
|
|
|
my $nick = $chars[rand @chars - 10]; # nicks cannot start with a digit
|
|
|
|
$nick .= $chars[rand @chars] for 1..9;
|
2015-01-11 00:56:43 +01:00
|
|
|
return $nick;
|
|
|
|
}
|
2010-03-17 07:36:54 +01:00
|
|
|
|
2015-01-11 00:56:43 +01:00
|
|
|
# TODO: add disconnect subroutine
|
2010-03-17 07:36:54 +01:00
|
|
|
sub connect {
|
|
|
|
my ($self, $server) = @_;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if ($self->{connected}) {
|
2010-03-22 08:33:44 +01:00
|
|
|
# TODO: disconnect, clean-up, etc
|
|
|
|
}
|
|
|
|
|
2014-05-17 22:08:19 +02:00
|
|
|
$server = $self->{registry}->get_value('irc', 'ircserver') if not defined $server;
|
|
|
|
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{logger}->log("Connecting to $server ...\n");
|
2010-03-17 07:36:54 +01:00
|
|
|
|
2019-06-26 18:34:19 +02:00
|
|
|
while (not $self->{conn} = $self->{irc}->newconn(
|
2019-12-22 04:04:39 +01:00
|
|
|
Nick => $self->{registry}->get_value('irc', 'randomize_nick') ? random_nick : $self->{registry}->get_value('irc', 'botnick'),
|
2014-11-01 01:15:21 +01:00
|
|
|
Username => $self->{registry}->get_value('irc', 'username'),
|
|
|
|
Ircname => $self->{registry}->get_value('irc', 'ircname'),
|
|
|
|
Server => $server,
|
2018-07-01 12:07:30 +02:00
|
|
|
Pacing => 1,
|
2019-07-01 00:08:18 +02:00
|
|
|
UTF8 => 1,
|
2014-11-01 01:15:21 +01:00
|
|
|
SSL => $self->{registry}->get_value('irc', 'SSL'),
|
|
|
|
SSL_ca_file => $self->{registry}->get_value('irc', 'SSL_ca_file'),
|
|
|
|
SSL_ca_path => $self->{registry}->get_value('irc', 'SSL_ca_path'),
|
|
|
|
Port => $self->{registry}->get_value('irc', 'port'))) {
|
2015-01-23 14:35:06 +01:00
|
|
|
$self->{logger}->log("$0: Can't connect to $server:" . $self->{registry}->get_value('irc', 'port') . ". Retrying in 15 seconds...\n");
|
2014-11-01 01:15:21 +01:00
|
|
|
sleep 15;
|
|
|
|
}
|
2010-03-22 08:33:44 +01:00
|
|
|
|
|
|
|
$self->{connected} = 1;
|
|
|
|
|
2014-08-11 09:34:30 +02:00
|
|
|
#set up handlers for the IRC engine
|
|
|
|
$self->{conn}->add_default_handler(sub { $self->{irchandlers}->default_handler(@_) }, 1);
|
2014-11-01 01:15:21 +01:00
|
|
|
$self->{conn}->add_handler([ 251,252,253,254,255,302 ], sub { $self->{irchandlers}->on_init(@_) });
|
2014-08-11 09:34:30 +02:00
|
|
|
|
|
|
|
# ignore these events
|
2019-06-26 18:34:19 +02:00
|
|
|
$self->{conn}->add_handler(['whoisserver',
|
|
|
|
'whoiscountry',
|
2014-08-11 09:34:30 +02:00
|
|
|
'whoischannels',
|
|
|
|
'whoisidle',
|
|
|
|
'motdstart',
|
2014-11-01 01:15:21 +01:00
|
|
|
'endofmotd',
|
2014-08-11 09:34:30 +02:00
|
|
|
'away',
|
|
|
|
'endofbanlist'], sub {});
|
2010-03-17 07:36:54 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
#main loop
|
|
|
|
sub do_one_loop {
|
2010-03-22 08:33:44 +01:00
|
|
|
my $self = shift;
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{irc}->do_one_loop();
|
2014-03-14 06:51:15 +01:00
|
|
|
$self->{select_handler}->do_select();
|
2010-03-22 08:33:44 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
sub start {
|
|
|
|
my $self = shift;
|
2019-06-26 18:34:19 +02:00
|
|
|
while (1) {
|
2014-11-01 01:15:21 +01:00
|
|
|
$self->connect() if not $self->{connected};
|
2019-06-26 18:34:19 +02:00
|
|
|
$self->do_one_loop() if $self->{connected};
|
2014-11-01 01:15:21 +01:00
|
|
|
}
|
2010-03-17 07:36:54 +01:00
|
|
|
}
|
|
|
|
|
2014-05-17 00:11:31 +02:00
|
|
|
sub register_signal_handlers {
|
|
|
|
my $self = shift;
|
|
|
|
$SIG{INT} = sub { $self->atexit; exit 0; };
|
|
|
|
}
|
|
|
|
|
|
|
|
sub atexit {
|
|
|
|
my $self = shift;
|
|
|
|
$self->{atexit}->execute_all;
|
|
|
|
}
|
|
|
|
|
2014-05-31 03:03:42 +02:00
|
|
|
sub irc_debug_trigger {
|
|
|
|
my ($self, $section, $item, $newvalue) = @_;
|
|
|
|
$self->{irc}->debug($newvalue);
|
|
|
|
$self->{conn}->debug($newvalue) if $self->{connected};
|
|
|
|
}
|
|
|
|
|
2014-05-17 22:08:19 +02:00
|
|
|
sub change_botnick_trigger {
|
|
|
|
my ($self, $section, $item, $newvalue) = @_;
|
2014-05-18 22:09:05 +02:00
|
|
|
$self->{conn}->nick($newvalue) if $self->{connected};
|
2010-03-23 19:24:02 +01:00
|
|
|
}
|
|
|
|
|
2010-03-17 07:36:54 +01:00
|
|
|
1;
|