3
0
mirror of https://github.com/pragma-/pbot.git synced 2024-12-28 21:52:35 +01:00
pbot/PBot/ChanOpCommands.pm

455 lines
14 KiB
Perl
Raw Normal View History

# File: ChanOpCommands.pm
# Author: pragma_
#
# Purpose: Channel operator command subroutines.
License project under MPL2 This patch adds the file LICENSE which is the verbatim copy of the Mozilla Public License Version 2.0 as retreived from https://www.mozilla.org/media/MPL/2.0/index.815ca599c9df.txt on 2017-03-05. This patch also places license headers for the MPL2 type A variant of the license header in the following files: PBot/AntiFlood.pm PBot/BanTracker.pm PBot/BlackList.pm PBot/BotAdminCommands.pm PBot/BotAdmins.pm PBot/ChanOpCommands.pm PBot/ChanOps.pm PBot/Channels.pm PBot/Commands.pm PBot/DualIndexHashObject.pm PBot/EventDispatcher.pm PBot/FactoidCommands.pm PBot/FactoidModuleLauncher.pm PBot/Factoids.pm PBot/HashObject.pm PBot/IRCHandlers.pm PBot/IgnoreList.pm PBot/IgnoreListCommands.pm PBot/Interpreter.pm PBot/LagChecker.pm PBot/Logger.pm PBot/MessageHistory.pm PBot/MessageHistory_SQLite.pm PBot/NickList.pm PBot/PBot.pm PBot/Plugins.pm PBot/Plugins/AntiAway.pm PBot/Plugins/AntiKickAutoRejoin.pm PBot/Plugins/AntiRepeat.pm PBot/Plugins/AntiTwitter.pm PBot/Plugins/AutoRejoin.pm PBot/Plugins/Counter.pm PBot/Plugins/Quotegrabs.pm PBot/Plugins/Quotegrabs/Quotegrabs_Hashtable.pm PBot/Plugins/Quotegrabs/Quotegrabs_SQLite.pm PBot/Plugins/UrlTitles.pm PBot/Plugins/_Example.pm PBot/Refresher.pm PBot/Registerable.pm PBot/Registry.pm PBot/RegistryCommands.pm PBot/SQLiteLogger.pm PBot/SQLiteLoggerLayer.pm PBot/SelectHandler.pm PBot/StdinReader.pm PBot/Timer.pm PBot/Utils/ParseDate.pm PBot/VERSION.pm build/update-version.pl modules/acronym.pl modules/ago.pl modules/c11std.pl modules/c2english.pl modules/c2english/CGrammar.pm modules/c2english/c2eng.pl modules/c99std.pl modules/cdecl.pl modules/cfaq.pl modules/cjeopardy/IRCColors.pm modules/cjeopardy/QStatskeeper.pm modules/cjeopardy/Scorekeeper.pm modules/cjeopardy/cjeopardy.pl modules/cjeopardy/cjeopardy_answer.pl modules/cjeopardy/cjeopardy_filter.pl modules/cjeopardy/cjeopardy_hint.pl modules/cjeopardy/cjeopardy_qstats.pl modules/cjeopardy/cjeopardy_scores.pl modules/cjeopardy/cjeopardy_show.pl modules/codepad.pl modules/compiler_block.pl modules/compiler_client.pl modules/compiler_vm/Diff.pm modules/compiler_vm/cc modules/compiler_vm/compiler_client.pl modules/compiler_vm/compiler_server.pl modules/compiler_vm/compiler_server_vbox_win32.pl modules/compiler_vm/compiler_server_watchdog.pl modules/compiler_vm/compiler_vm_client.pl modules/compiler_vm/compiler_vm_server.pl modules/compiler_vm/compiler_watchdog.pl modules/compiler_vm/languages/_c_base.pm modules/compiler_vm/languages/_default.pm modules/compiler_vm/languages/bash.pm modules/compiler_vm/languages/bc.pm modules/compiler_vm/languages/bf.pm modules/compiler_vm/languages/c11.pm modules/compiler_vm/languages/c89.pm modules/compiler_vm/languages/c99.pm modules/compiler_vm/languages/clang.pm modules/compiler_vm/languages/clang11.pm modules/compiler_vm/languages/clang89.pm modules/compiler_vm/languages/clang99.pm modules/compiler_vm/languages/clangpp.pm modules/compiler_vm/languages/clisp.pm modules/compiler_vm/languages/cpp.pm modules/compiler_vm/languages/freebasic.pm modules/compiler_vm/languages/go.pm modules/compiler_vm/languages/haskell.pm modules/compiler_vm/languages/java.pm modules/compiler_vm/languages/javascript.pm modules/compiler_vm/languages/ksh.pm modules/compiler_vm/languages/lua.pm modules/compiler_vm/languages/perl.pm modules/compiler_vm/languages/python.pm modules/compiler_vm/languages/python3.pm modules/compiler_vm/languages/qbasic.pm modules/compiler_vm/languages/scheme.pm modules/compiler_vm/languages/server/_c_base.pm modules/compiler_vm/languages/server/_default.pm modules/compiler_vm/languages/server/c11.pm modules/compiler_vm/languages/server/c89.pm modules/compiler_vm/languages/server/c99.pm modules/compiler_vm/languages/server/clang.pm modules/compiler_vm/languages/server/clang11.pm modules/compiler_vm/languages/server/clang89.pm modules/compiler_vm/languages/server/clang99.pm modules/compiler_vm/languages/server/cpp.pm modules/compiler_vm/languages/server/freebasic.pm modules/compiler_vm/languages/server/haskell.pm modules/compiler_vm/languages/server/java.pm modules/compiler_vm/languages/server/qbasic.pm modules/compiler_vm/languages/server/tendra.pm modules/compiler_vm/languages/sh.pm modules/compiler_vm/languages/tendra.pm modules/compliment modules/cstd.pl modules/define.pl modules/dice_roll.pl modules/excuse.sh modules/expand_macros.pl modules/fnord.pl modules/funnyish_quote.pl modules/g.pl modules/gdefine.pl modules/gen_cfacts.pl modules/gencstd.pl modules/get_title.pl modules/getcfact.pl modules/google.pl modules/gspy.pl modules/gtop10.pl modules/gtop15.pl modules/headlines.pl modules/horoscope modules/horrorscope modules/ideone.pl modules/insult.pl modules/love_quote.pl modules/man.pl modules/map.pl modules/math.pl modules/prototype.pl modules/qalc.pl modules/random_quote.pl modules/seen.pl modules/urban modules/weather.pl modules/wikipedia.pl pbot.pl pbot.sh It is highly recommended that this list of files is reviewed to ensure that all files are the copyright of the sole maintainer of the repository. If any files with license headers contain the intellectual property of anyone else, it is recommended that a request is made to revise this patch or that the explicit permission of the co-author is gained to allow for the license of the work to be changed. I (Tomasz Kramkowski), the contributor, take no responsibility for any legal action taken against the maintainer of this repository for incorrectly claiming copyright to any work not owned by the maintainer of this repository.
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/.
package PBot::ChanOpCommands;
use warnings;
use strict;
2019-07-11 03:40:53 +02:00
use feature 'unicode_strings';
use Carp ();
use Time::Duration;
use Time::HiRes qw/gettimeofday/;
sub new {
if (ref($_[1]) eq 'HASH') {
Carp::croak("Options to ChanOpCommands 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) = @_;
my $pbot = delete $conf{pbot};
if (not defined $pbot) {
Carp::croak("Missing pbot reference to ChanOpCommands");
}
$self->{pbot} = $pbot;
$pbot->{commands}->register(sub { return $self->ban_user(@_) }, "ban", 10);
$pbot->{commands}->register(sub { return $self->unban_user(@_) }, "unban", 10);
2015-05-27 19:45:43 +02:00
$pbot->{commands}->register(sub { return $self->mute_user(@_) }, "mute", 10);
$pbot->{commands}->register(sub { return $self->unmute_user(@_) }, "unmute", 10);
$pbot->{commands}->register(sub { return $self->kick_user(@_) }, "kick", 10);
$pbot->{commands}->register(sub { return $self->checkban(@_) }, "checkban", 0);
$pbot->{commands}->register(sub { return $self->checkmute(@_) }, "checkmute", 0);
}
sub checkban {
my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;
my ($target, $channel) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 2);
if (not defined $target) {
return "Usage: checkban <mask> [channel]";
}
if (not defined $channel) {
$channel = $from;
}
if ($channel !~ /^#/) {
return "Please specify a channel.";
}
$channel = lc $channel;
$target = lc $target;
my $mask = $self->{pbot}->{chanops}->nick_to_banmask($target);
if (exists $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}
&& exists $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}) {
my $timeout = $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}{timeout};
my $owner = $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}{owner};
my $reason = $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}{reason};
my $duration = concise duration($timeout - gettimeofday);
my $result = "$mask banned in $channel ";
$result .= "by $owner " if defined $owner;
$result .= "for $reason " if defined $reason;
$result .= "($duration remaining)";
return $result;
} else {
return "$mask has no ban timeout";
}
}
sub checkmute {
my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;
my ($target, $channel) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 2);
if (not defined $target) {
return "Usage: checkmute <mask> [channel]";
}
if (not defined $channel) {
$channel = $from;
}
if ($channel !~ /^#/) {
return "Please specify a channel.";
}
$channel = lc $channel;
$target = lc $target;
my $mask = $self->{pbot}->{chanops}->nick_to_banmask($target);
if (exists $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}
&& exists $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}) {
my $timeout = $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}{timeout};
my $owner = $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}{owner};
my $reason = $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}{reason};
my $duration = concise duration($timeout - gettimeofday);
my $result = "$mask muted in $channel ";
$result .= "by $owner " if defined $owner;
$result .= "for $reason " if defined $reason;
$result .= "($duration remaining)";
return "$mask has $duration remaining on their $channel mute";
} else {
return "$mask has no mute timeout";
}
}
sub ban_user {
my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;
my ($target, $channel, $length) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 3);
2017-04-11 04:13:56 +02:00
$channel = '' if not defined $channel;
$length = '' if not defined $length;
if (not defined $from) {
$self->{pbot}->{logger}->log("Command missing ~from parameter!\n");
return "";
}
2015-05-27 19:45:43 +02:00
if ($channel !~ m/^#/) {
$length = "$channel $length";
$length = undef if $length eq ' ';
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from;
2015-05-27 19:45:43 +02:00
}
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from if not defined $channel or not length $channel;
if (not defined $target) {
2015-05-27 19:45:43 +02:00
return "/msg $nick Usage: ban <mask> [channel [timeout (default: 24 hours)]]";
}
my $no_length = 0;
if (not defined $length) {
$length = $self->{pbot}->{registry}->get_value($channel, 'default_ban_timeout', 0, $stuff) //
$self->{pbot}->{registry}->get_value('general', 'default_ban_timeout', 0, $stuff) // 60 * 60 * 24; # 24 hours
$no_length = 1;
} else {
my $error;
($length, $error) = $self->{pbot}->{parsedate}->parsedate($length);
return $error if defined $error;
}
$channel = lc $channel;
$target = lc $target;
my $botnick = $self->{pbot}->{registry}->get_value('irc', 'botnick');
return "I don't think so." if $target =~ /^\Q$botnick\E!/i;
if (not $stuff->{'effective-level'} and not $self->{pbot}->{admins}->loggedin($channel, "$nick!$user\@$host")) {
return "/msg $nick You are not an admin for $channel.";
}
my $result = '';
my $sep = '';
my @targets = split /,/, $target;
my $immediately = @targets > 1 ? 0 : 1;
foreach my $t (@targets) {
my $mask = $self->{pbot}->{chanops}->nick_to_banmask($t);
if ($no_length && exists $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}
&& exists $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}) {
my $timeout = $self->{pbot}->{chanops}->{unban_timeout}->hash->{$channel}->{$mask}{timeout};
my $duration = duration($timeout - gettimeofday);
$result .= "$sep$mask has $duration remaining on their $channel ban";
$sep = '; ';
} else {
$self->{pbot}->{chanops}->ban_user_timed("$nick!$user\@$host", undef, $mask, $channel, $length, $immediately);
my $duration;
if ($length > 0) {
$duration = duration($length);
} else {
$duration = 'all eternity';
}
$result .= "$sep$mask banned in $channel for $duration";
$sep = '; ';
}
}
if (not $immediately) {
$self->{pbot}->{chanops}->check_ban_queue;
}
$result = "/msg $nick $result" if $result !~ m/remaining on their/;
return $result;
}
sub unban_user {
my $self = shift;
my ($from, $nick, $user, $host, $arguments, $stuff) = @_;
if (not defined $from) {
$self->{pbot}->{logger}->log("Command missing ~from parameter!\n");
return "";
}
my ($target, $channel, $immediately) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 3);
if (defined $target and defined $channel and $channel !~ /^#/) {
my $temp = $target;
$target = $channel;
$channel = $temp;
}
if (not defined $target) {
return "/msg $nick Usage: unban <nick/mask> [[channel] [false value to use unban queue]]";
}
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from if not defined $channel;
$immediately = 1 if not defined $immediately;
return "/msg $nick Usage for /msg: unban <nick/mask> <channel> [false value to use unban queue]" if $channel !~ /^#/;
if (not $stuff->{'effective-level'} and not $self->{pbot}->{admins}->loggedin($channel, "$nick!$user\@$host")) {
return "/msg $nick You are not an admin for $channel.";
}
my @targets = split /,/, $target;
$immediately = 0 if @targets > 1;
foreach my $t (@targets) {
$self->{pbot}->{chanops}->unban_user($t, $channel, $immediately);
}
if (@targets > 1) {
$self->{pbot}->{chanops}->check_unban_queue;
}
2011-10-31 20:56:08 +01:00
return "/msg $nick $target has been unbanned from $channel.";
}
2015-05-27 19:45:43 +02:00
sub mute_user {
my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;
my ($target, $channel, $length) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 3);
2015-05-27 19:45:43 +02:00
if (not defined $from) {
2015-05-27 19:45:43 +02:00
$self->{pbot}->{logger}->log("Command missing ~from parameter!\n");
return "";
}
if (not defined $channel and $from !~ m/^#/) {
return "/msg $nick Usage from private message: mute <mask> <channel> [timeout (default: 24 hours)]";
}
2015-05-27 19:45:43 +02:00
if ($channel !~ m/^#/) {
$length = "$channel $length";
$length = undef if $length eq ' ';
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from;
2015-05-27 19:45:43 +02:00
}
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from if not defined $channel;
2015-05-27 19:45:43 +02:00
if ($channel !~ m/^#/) {
return "/msg $nick Please specify a channel.";
}
if (not defined $target) {
2015-05-27 19:45:43 +02:00
return "/msg $nick Usage: mute <mask> [channel [timeout (default: 24 hours)]]";
}
my $no_length = 0;
if (not defined $length) {
$length = $self->{pbot}->{registry}->get_value($channel, 'default_mute_timeout', 0, $stuff) //
$self->{pbot}->{registry}->get_value('general', 'default_mute_timeout', 0, $stuff) // 60 * 60 * 24; # 24 hours
$no_length = 1;
2015-05-27 19:45:43 +02:00
} else {
my $error;
($length, $error) = $self->{pbot}->{parsedate}->parsedate($length);
2015-05-27 19:45:43 +02:00
return $error if defined $error;
}
$channel = lc $channel;
$target = lc $target;
2015-05-27 19:45:43 +02:00
my $botnick = $self->{pbot}->{registry}->get_value('irc', 'botnick');
return "I don't think so." if $target =~ /^\Q$botnick\E!/i;
if (not $stuff->{'effective-level'} and not $self->{pbot}->{admins}->loggedin($channel, "$nick!$user\@$host")) {
return "/msg $nick You are not an admin for $channel.";
}
my $result = '';
my $sep = '';
my @targets = split /,/, $target;
my $immediately = @targets > 1 ? 0 : 1;
foreach my $t (@targets) {
my $mask = $self->{pbot}->{chanops}->nick_to_banmask($t);
if ($no_length && exists $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}
&& exists $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}) {
my $timeout = $self->{pbot}->{chanops}->{unmute_timeout}->hash->{$channel}->{$mask}{timeout};
my $duration = duration($timeout - gettimeofday);
$result .= "$sep$mask has $duration remaining on their $channel mute";
$sep = '; ';
} else {
$self->{pbot}->{chanops}->mute_user_timed("$nick!$user\@$host", undef, $t, $channel, $length, $immediately);
my $duration;
if ($length > 0) {
$duration = duration($length);
} else {
$duration = 'all eternity';
}
$result .= "$sep$mask muted in $channel for $duration";
$sep = '; ';
}
}
if (not $immediately) {
$self->{pbot}->{chanops}->check_ban_queue;
}
2015-05-27 19:45:43 +02:00
$result = "/msg $nick $result" if $result !~ m/remaining on their/;
return $result;
2015-05-27 19:45:43 +02:00
}
sub unmute_user {
my $self = shift;
my ($from, $nick, $user, $host, $arguments, $stuff) = @_;
2015-05-27 19:45:43 +02:00
if (not defined $from) {
2015-05-27 19:45:43 +02:00
$self->{pbot}->{logger}->log("Command missing ~from parameter!\n");
return "";
}
my ($target, $channel, $immediately) = $self->{pbot}->{interpreter}->split_args($stuff->{arglist}, 3);
2015-05-27 19:45:43 +02:00
if (defined $target and defined $channel and $channel !~ /^#/) {
my $temp = $target;
$target = $channel;
$channel = $temp;
}
if (not defined $target) {
return "/msg $nick Usage: unmute <nick/mask> [[channel] [false value to use unban queue]]";
2015-05-27 19:45:43 +02:00
}
2018-02-22 03:41:56 +01:00
$channel = exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from if not defined $channel;
$immediately = 1 if not defined $immediately;
2015-05-27 19:45:43 +02:00
return "/msg $nick Usage for /msg: unmute <nick/mask> <channel> [false value to use unban queue]" if $channel !~ /^#/;
2015-05-27 19:45:43 +02:00
if (not $stuff->{'effective-level'} and not $self->{pbot}->{admins}->loggedin($channel, "$nick!$user\@$host")) {
return "/msg $nick You are not an admin for $channel.";
}
my @targets = split /,/, $target;
$immediately = 0 if @targets > 1;
foreach my $t (@targets) {
$self->{pbot}->{chanops}->unmute_user($t, $channel, $immediately);
}
if (@targets > 1) {
$self->{pbot}->{chanops}->check_unban_queue;
}
2015-05-27 19:45:43 +02:00
return "/msg $nick $target has been unmuted in $channel.";
}
sub kick_user {
my $self = shift;
my ($from, $nick, $user, $host, $arguments, $stuff) = @_;
if (not defined $from) {
$self->{pbot}->{logger}->log("Command missing ~from parameter!\n");
return "";
}
my ($channel, $victim, $reason);
if (not $from =~ /^#/) {
# used in private message
if (not $arguments =~ s/^(^#\S+) (\S+)\s*//) {
return "/msg $nick Usage from private message: kick <channel> <nick> [reason]";
}
($channel, $victim) = ($1, $2);
} else {
# used in channel
if ($arguments =~ s/^(#\S+)\s+(\S+)\s*//) {
($channel, $victim) = ($1, $2);
} elsif ($arguments =~ s/^(\S+)\s*//) {
2018-02-22 03:41:56 +01:00
($victim, $channel) = ($1, exists $stuff->{admin_channel_override} ? $stuff->{admin_channel_override} : $from);
} else {
return "/msg $nick Usage: kick [channel] <nick> [reason]";
2014-04-19 12:35:27 +02:00
}
}
2014-04-19 12:35:27 +02:00
$reason = $arguments;
# If the user is too stupid to remember the order of the arguments,
# we can help them out by seeing if they put the channel in the reason.
if ($reason =~ s/^(#\S+)\s*//) {
$channel = $1;
}
if (not $stuff->{'effective-level'} and not $self->{pbot}->{admins}->loggedin($channel, "$nick!$user\@$host")) {
2017-11-11 21:59:27 +01:00
return "/msg $nick You are not an admin for $channel.";
}
my @insults;
if (not length $reason) {
if (open my $fh, '<', $self->{pbot}->{registry}->get_value('general', 'module_dir') . '/insults.txt') {
2017-11-11 21:59:27 +01:00
@insults = <$fh>;
close $fh;
$reason = $insults[rand @insults];
2017-11-11 21:59:27 +01:00
$reason =~ s/\s+$//;
} else {
$reason = 'Bye!';
}
}
2014-04-19 12:35:27 +02:00
2017-11-11 21:59:27 +01:00
my @nicks = split /,/, $victim;
2017-11-13 17:42:56 +01:00
my $i = 0;
2017-11-11 21:59:27 +01:00
foreach my $n (@nicks) {
$self->{pbot}->{chanops}->add_op_command($channel, "kick $channel $n $reason");
if (@insults) {
$reason = $insults[rand @insults];
$reason =~ s/\s+$//;
}
2017-11-13 17:42:56 +01:00
last if ++$i >= 5;
}
$self->{pbot}->{chanops}->gain_ops($channel);
2017-09-19 06:24:30 +02:00
return "";
}
1;