2015-03-17 05:08:25 +01:00
|
|
|
# File: BlackList.pm
|
|
|
|
# Author: pragma_
|
|
|
|
#
|
|
|
|
# Purpose: Manages list of hostmasks that are not allowed to join a channel.
|
|
|
|
|
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/.
|
|
|
|
|
2015-03-17 05:08:25 +01:00
|
|
|
package PBot::BlackList;
|
|
|
|
|
|
|
|
use warnings;
|
|
|
|
use strict;
|
|
|
|
|
|
|
|
use feature 'switch';
|
|
|
|
no if $] >= 5.018, warnings => "experimental::smartmatch";
|
|
|
|
|
|
|
|
use Carp ();
|
|
|
|
use Time::HiRes qw(gettimeofday);
|
|
|
|
|
|
|
|
sub new {
|
2019-05-28 18:19:42 +02:00
|
|
|
if (ref($_[1]) eq 'HASH') {
|
2015-03-17 05:08:25 +01:00
|
|
|
Carp::croak("Options to " . __FILE__ . " should be key/value pairs, not hash reference");
|
|
|
|
}
|
|
|
|
|
|
|
|
my ($class, %conf) = @_;
|
|
|
|
|
|
|
|
my $self = bless {}, $class;
|
|
|
|
$self->initialize(%conf);
|
|
|
|
return $self;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub initialize {
|
|
|
|
my ($self, %conf) = @_;
|
|
|
|
|
|
|
|
$self->{pbot} = delete $conf{pbot} // Carp::croak("Missing pbot reference to " . __FILE__);
|
|
|
|
$self->{filename} = delete $conf{filename};
|
|
|
|
|
|
|
|
$self->{blacklist} = {};
|
|
|
|
|
|
|
|
$self->{pbot}->{commands}->register(sub { return $self->blacklist(@_) }, "blacklist", 10);
|
|
|
|
|
|
|
|
$self->load_blacklist;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub add {
|
|
|
|
my ($self, $channel, $hostmask) = @_;
|
|
|
|
|
|
|
|
$self->{blacklist}->{lc $channel}->{lc $hostmask} = 1;
|
|
|
|
$self->save_blacklist();
|
|
|
|
}
|
|
|
|
|
|
|
|
sub remove {
|
|
|
|
my $self = shift;
|
|
|
|
my ($channel, $hostmask) = @_;
|
|
|
|
|
|
|
|
$channel = lc $channel;
|
|
|
|
$hostmask = lc $hostmask;
|
|
|
|
|
2019-06-26 18:34:19 +02:00
|
|
|
if (exists $self->{blacklist}->{$channel}) {
|
2015-03-17 05:08:25 +01:00
|
|
|
delete $self->{blacklist}->{$channel}->{$hostmask};
|
|
|
|
|
2016-11-04 20:40:17 +01:00
|
|
|
if (keys %{ $self->{blacklist}->{$channel} } == 0) {
|
|
|
|
delete $self->{blacklist}->{$channel};
|
|
|
|
}
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$self->save_blacklist();
|
|
|
|
}
|
|
|
|
|
2017-08-06 06:38:46 +02:00
|
|
|
sub clear_blacklist {
|
|
|
|
my $self = shift;
|
|
|
|
$self->{blacklist} = {};
|
|
|
|
}
|
|
|
|
|
2015-03-17 05:08:25 +01:00
|
|
|
sub load_blacklist {
|
|
|
|
my $self = shift;
|
|
|
|
my $filename;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (@_) { $filename = shift; } else { $filename = $self->{filename}; }
|
2015-03-17 05:08:25 +01:00
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (not defined $filename) {
|
2015-03-17 05:08:25 +01:00
|
|
|
Carp::carp "No blacklist path specified -- skipping loading of blacklist";
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{pbot}->{logger}->log("Loading blacklist from $filename ...\n");
|
2019-06-26 18:34:19 +02:00
|
|
|
|
2015-03-17 05:08:25 +01:00
|
|
|
open(FILE, "< $filename") or Carp::croak "Couldn't open $filename: $!\n";
|
|
|
|
my @contents = <FILE>;
|
|
|
|
close(FILE);
|
|
|
|
|
|
|
|
my $i = 0;
|
|
|
|
|
|
|
|
foreach my $line (@contents) {
|
|
|
|
chomp $line;
|
|
|
|
$i++;
|
|
|
|
|
|
|
|
my ($channel, $hostmask) = split(/\s+/, $line);
|
2019-06-26 18:34:19 +02:00
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (not defined $hostmask || not defined $channel) {
|
2015-03-17 05:08:25 +01:00
|
|
|
Carp::croak "Syntax error around line $i of $filename\n";
|
|
|
|
}
|
2019-06-26 18:34:19 +02:00
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (exists $self->{blacklist}->{$channel}->{$hostmask}) {
|
2015-03-17 05:08:25 +01:00
|
|
|
Carp::croak "Duplicate blacklist entry [$hostmask][$channel] found in $filename around line $i\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{blacklist}->{$channel}->{$hostmask} = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
$self->{pbot}->{logger}->log(" $i entries in blacklist\n");
|
|
|
|
$self->{pbot}->{logger}->log("Done.\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
sub save_blacklist {
|
|
|
|
my $self = shift;
|
|
|
|
my $filename;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (@_) { $filename = shift; } else { $filename = $self->{filename}; }
|
2015-03-17 05:08:25 +01:00
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (not defined $filename) {
|
2015-03-17 05:08:25 +01:00
|
|
|
Carp::carp "No blacklist path specified -- skipping saving of blacklist\n";
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
open(FILE, "> $filename") or die "Couldn't open $filename: $!\n";
|
|
|
|
|
|
|
|
foreach my $channel (keys %{ $self->{blacklist} }) {
|
|
|
|
foreach my $hostmask (keys %{ $self->{blacklist}->{$channel} }) {
|
|
|
|
print FILE "$channel $hostmask\n";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
close(FILE);
|
|
|
|
}
|
|
|
|
|
|
|
|
sub check_blacklist {
|
|
|
|
my $self = shift;
|
2016-02-10 12:42:42 +01:00
|
|
|
my ($hostmask, $channel, $nickserv, $gecos) = @_;
|
2015-03-17 05:08:25 +01:00
|
|
|
|
|
|
|
return 0 if not defined $channel;
|
|
|
|
|
2015-03-30 05:26:08 +02:00
|
|
|
foreach my $black_channel (keys %{ $self->{blacklist} }) {
|
|
|
|
foreach my $black_hostmask (keys %{ $self->{blacklist}->{$black_channel} }) {
|
2016-02-10 12:42:42 +01:00
|
|
|
my $flag = '';
|
|
|
|
$flag = $1 if $black_hostmask =~ s/^\$(.)://;
|
|
|
|
|
2015-03-30 05:26:08 +02:00
|
|
|
my $black_channel_escaped = quotemeta $black_channel;
|
|
|
|
my $black_hostmask_escaped = quotemeta $black_hostmask;
|
2015-03-17 05:08:25 +01:00
|
|
|
|
2015-03-30 05:26:08 +02:00
|
|
|
$black_channel_escaped =~ s/\\(\.|\*)/$1/g;
|
|
|
|
$black_hostmask_escaped =~ s/\\(\.|\*)/$1/g;
|
2015-03-17 05:08:25 +01:00
|
|
|
|
2017-08-04 00:21:46 +02:00
|
|
|
next if $channel !~ /^$black_channel_escaped$/;
|
|
|
|
|
2018-05-12 11:51:23 +02:00
|
|
|
if ($flag eq 'a' && defined $nickserv && $nickserv =~ /^$black_hostmask_escaped$/i) {
|
2016-02-10 12:42:42 +01:00
|
|
|
$self->{pbot}->{logger}->log("$hostmask nickserv $nickserv blacklisted in channel $channel (matches [\$a:$black_hostmask] host and [$black_channel] channel)\n");
|
|
|
|
return 1;
|
2018-05-12 11:51:23 +02:00
|
|
|
} elsif ($flag eq 'r' && defined $gecos && $gecos =~ /^$black_hostmask_escaped$/i) {
|
2016-02-10 12:42:42 +01:00
|
|
|
$self->{pbot}->{logger}->log("$hostmask GECOS $gecos blacklisted in channel $channel (matches [\$r:$black_hostmask] host and [$black_channel] channel)\n");
|
|
|
|
return 1;
|
2018-05-12 11:51:23 +02:00
|
|
|
} elsif ($flag eq '' && $hostmask =~ /^$black_hostmask_escaped$/i) {
|
2015-03-30 05:26:08 +02:00
|
|
|
$self->{pbot}->{logger}->log("$hostmask blacklisted in channel $channel (matches [$black_hostmask] host and [$black_channel] channel)\n");
|
2015-03-17 05:08:25 +01:00
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
sub blacklist {
|
2018-08-09 02:38:57 +02:00
|
|
|
my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;
|
2015-03-17 05:08:25 +01:00
|
|
|
|
2018-08-09 02:38:57 +02:00
|
|
|
my $arglist = $stuff->{arglist};
|
|
|
|
$self->{pbot}->{interpreter}->lc_args($arglist);
|
|
|
|
|
|
|
|
my $command = $self->{pbot}->{interpreter}->shift_arg($arglist);
|
2015-03-17 05:08:25 +01:00
|
|
|
|
|
|
|
return "Usage: blacklist <command>, where commands are: list/show, add, remove" if not defined $command;
|
|
|
|
|
2018-08-09 02:38:57 +02:00
|
|
|
given ($command) {
|
|
|
|
when ($_ eq "list" or $_ eq "show") {
|
2015-03-17 05:08:25 +01:00
|
|
|
my $text = "Blacklist:\n";
|
|
|
|
my $entries = 0;
|
2015-03-21 05:14:07 +01:00
|
|
|
foreach my $channel (sort keys %{ $self->{blacklist} }) {
|
|
|
|
if ($channel eq '.*') {
|
|
|
|
$text .= " all channels:\n";
|
|
|
|
} else {
|
2015-03-17 05:08:25 +01:00
|
|
|
$text .= " $channel:\n";
|
2015-03-21 05:14:07 +01:00
|
|
|
}
|
|
|
|
foreach my $mask (sort keys %{ $self->{blacklist}->{$channel} }) {
|
|
|
|
$text .= " $mask,\n";
|
|
|
|
$entries++;
|
|
|
|
}
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
|
|
|
$text .= "none" if $entries == 0;
|
2018-05-15 04:20:55 +02:00
|
|
|
return "/msg $nick $text";
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
2018-08-09 02:38:57 +02:00
|
|
|
when ("add") {
|
|
|
|
my ($mask, $channel) = $self->{pbot}->{interpreter}->split_args($arglist, 2);
|
2015-03-17 05:08:25 +01:00
|
|
|
return "Usage: blacklist add <hostmask regex> [channel]" if not defined $mask;
|
|
|
|
|
|
|
|
$channel = '.*' if not defined $channel;
|
|
|
|
|
|
|
|
$self->{pbot}->{logger}->log("$nick!$user\@$host added [$mask] to blacklist for channel [$channel]\n");
|
|
|
|
$self->add($channel, $mask);
|
2017-09-02 09:14:13 +02:00
|
|
|
return "/say $mask blacklisted in channel $channel";
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
2018-08-09 02:38:57 +02:00
|
|
|
when ("remove") {
|
|
|
|
my ($mask, $channel) = $self->{pbot}->{interpreter}->split_args($arglist, 2);
|
2015-03-17 05:08:25 +01:00
|
|
|
return "Usage: blacklist remove <hostmask regex> [channel]" if not defined $mask;
|
|
|
|
|
|
|
|
$channel = '.*' if not defined $channel;
|
|
|
|
|
2019-05-28 18:19:42 +02:00
|
|
|
if (exists $self->{blacklist}->{$channel} and not exists $self->{blacklist}->{$channel}->{$mask}) {
|
2015-03-17 05:08:25 +01:00
|
|
|
$self->{pbot}->{logger}->log("$nick attempt to remove nonexistent [$mask][$channel] from blacklist\n");
|
2017-09-02 09:14:13 +02:00
|
|
|
return "/say $mask not found in blacklist for channel $channel (use `blacklist list` to display blacklist)";
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$self->remove($channel, $mask);
|
|
|
|
$self->{pbot}->{logger}->log("$nick!$user\@$host removed [$mask] from blacklist for channel [$channel]\n");
|
2017-09-02 09:14:13 +02:00
|
|
|
return "/say $mask removed from blacklist for channel $channel";
|
2015-03-17 05:08:25 +01:00
|
|
|
}
|
|
|
|
default {
|
|
|
|
return "Unknown command '$command'; commands are: list/show, add, remove";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
1;
|