pbot/lib/PBot/ProcessManager.pm

369 lines
11 KiB
Perl
Raw Normal View History

# File: ProcessManager.pm
#
2021-06-19 06:23:34 +02:00
# Purpose: Handles forking and execution of module/subroutine processes.
# Provides commands to list running processes and to kill them.
2021-07-11 00:00:22 +02:00
# SPDX-FileCopyrightText: 2021 Pragmatic Software <pragma78@gmail.com>
# SPDX-License-Identifier: MIT
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
package PBot::ProcessManager;
use parent 'PBot::Class';
2021-06-19 06:23:34 +02:00
use PBot::Imports;
2019-07-11 03:40:53 +02:00
use Time::Duration qw/concise duration/;
use Time::HiRes qw/gettimeofday/;
use Getopt::Long qw/GetOptionsFromArray/;
use POSIX qw/WNOHANG/;
use JSON;
sub initialize {
2020-02-15 23:38:32 +01:00
my ($self, %conf) = @_;
# process manager bot commands
$self->{pbot}->{commands}->register(sub { $self->cmd_ps(@_) }, 'ps', 0);
$self->{pbot}->{commands}->register(sub { $self->cmd_kill(@_) }, 'kill', 1);
# give admin capability group the can-kill capability
$self->{pbot}->{capabilities}->add('admin', 'can-kill', 1);
# hash of currently running bot-invoked processes
2020-02-15 23:38:32 +01:00
$self->{processes} = {};
# automatically reap children processes in background
$SIG{CHLD} = sub {
my $pid; do { $pid = waitpid(-1, WNOHANG); $self->remove_process($pid) if $pid > 0; } while $pid > 0;
};
}
sub cmd_ps {
my ($self, $context) = @_;
my $usage = 'Usage: ps [-atu]; -a show all information; -t show running time; -u show user/channel';
my $getopt_error;
local $SIG{__WARN__} = sub {
$getopt_error = shift;
chomp $getopt_error;
};
Getopt::Long::Configure("bundling");
my ($show_all, $show_user, $show_running_time);
my @opt_args = $self->{pbot}->{interpreter}->split_line($context->{arguments}, strip_quotes => 1);
GetOptionsFromArray(
\@opt_args,
'all|a' => \$show_all,
'user|u' => \$show_user,
'time|t' => \$show_running_time
);
return "$getopt_error; $usage" if defined $getopt_error;
2020-02-15 23:38:32 +01:00
my @processes;
foreach my $pid (sort keys %{$self->{processes}}) {
push @processes, $self->{processes}->{$pid};
}
if (not @processes) {
return "No running processes.";
}
my $result = @processes == 1 ? 'One process: ' : @processes . ' processes: ';
my @entries;
foreach my $process (@processes) {
my $entry = "$process->{pid}: $process->{commands}->[0]";
if ($show_running_time or $show_all) {
my $duration = concise duration (gettimeofday - $process->{process_start});
$entry .= " [$duration]";
}
if ($show_user or $show_all) {
$entry .= " ($process->{nick} in $process->{from})";
}
push @entries, $entry;
}
$result .= join '; ', @entries;
return $result;
}
sub cmd_kill {
my ($self, $context) = @_;
my $usage = 'Usage: kill [-a] [-t <seconds>] [-s <signal>] [pids...]; -a kill all processes; -t <seconds> kill processes running longer than <seconds>; -s send <signal> to processes';
my $getopt_error;
local $SIG{__WARN__} = sub {
$getopt_error = shift;
chomp $getopt_error;
};
Getopt::Long::Configure("bundling");
my ($kill_all, $kill_time, $signal);
my @opt_args = $self->{pbot}->{interpreter}->split_line($context->{arguments}, preserve_escapes => 1, strip_quotes => 1);
GetOptionsFromArray(
\@opt_args,
'all|a' => \$kill_all,
'time|t=i' => \$kill_time,
'signal|s=s' => \$signal,
);
return "$getopt_error; $usage" if defined $getopt_error;
if (not $kill_all and not $kill_time and not @opt_args) {
return "Must specify PIDs to kill unless options -a or -t are provided.";
}
if (defined $signal) {
$signal = uc $signal;
} else {
$signal = 'INT';
}
2020-02-15 23:38:32 +01:00
my @pids;
if (defined $kill_all or defined $kill_time) {
my $now = time;
foreach my $pid (sort keys %{$self->{processes}}) {
my $process = $self->{processes}->{$pid};
next if defined $kill_time and $now - $process->{process_start} < $kill_time;
push @pids, $pid;
}
} else {
foreach my $pid (@opt_args) {
return "No such pid $pid." if not exists $self->{processes}->{$pid};
push @pids, $pid;
}
2020-02-15 23:38:32 +01:00
}
return "No matching process." if not @pids;
my $ret = eval { kill $signal, @pids };
if ($@) {
my $error = $@;
$error =~ s/ at PBot.*//;
return $error;
}
return "[$ret] Sent signal " . $signal . ' to ' . join ', ', @pids;
}
sub add_process {
2020-05-02 05:59:51 +02:00
my ($self, $pid, $context) = @_;
2020-05-02 05:59:51 +02:00
$context->{process_start} = gettimeofday;
2020-05-02 05:59:51 +02:00
$self->{processes}->{$pid} = $context;
2020-05-02 05:59:51 +02:00
$self->{pbot}->{logger}->log("Starting process $pid: $context->{commands}->[0]\n");
}
sub remove_process {
2020-02-15 23:38:32 +01:00
my ($self, $pid) = @_;
if (exists $self->{processes}->{$pid}) {
my $command = $self->{processes}->{$pid}->{commands}->[0];
my $duration = gettimeofday - $self->{processes}->{$pid}->{process_start};
$duration = sprintf "%0.3f", $duration;
$self->{pbot}->{logger}->log("Finished process $pid ($command): duration $duration seconds\n");
delete $self->{processes}->{$pid};
} else {
$self->{pbot}->{logger}->log("Finished process $pid\n");
}
}
sub execute_process {
2020-05-02 05:59:51 +02:00
my ($self, $context, $subref, $timeout) = @_;
2020-02-15 23:38:32 +01:00
$timeout //= 30; # default timeout 30 seconds
# ensure contextual command history list is available for add_process()
if (not exists $context->{commands}) {
$context->{commands} = [$context->{command}];
}
2020-02-15 23:38:32 +01:00
# don't fork again if we're already a forked process
if (defined $context->{pid} and $context->{pid} == 0) {
2020-05-02 05:59:51 +02:00
$subref->($context);
return $context->{result};
}
2020-02-15 23:38:32 +01:00
pipe(my $reader, my $writer);
# fork new process
2020-05-02 05:59:51 +02:00
$context->{pid} = fork;
2020-05-02 05:59:51 +02:00
if (not defined $context->{pid}) {
# fork failed
2020-02-15 23:38:32 +01:00
$self->{pbot}->{logger}->log("Could not fork process: $!\n");
2020-02-15 23:38:32 +01:00
close $reader;
close $writer;
delete $context->{pid};
# groan to let the users know something went wrong
2020-05-02 05:59:51 +02:00
$context->{checkflood} = 1;
$self->{pbot}->{interpreter}->handle_result($context, "/me groans loudly.\n");
2020-02-15 23:38:32 +01:00
return;
}
2020-05-02 05:59:51 +02:00
if ($context->{pid} == 0) {
2020-02-15 23:38:32 +01:00
# child
2020-02-15 23:38:32 +01:00
close $reader;
# flag this instance as child
2020-09-13 01:28:44 +02:00
$self->{pbot}->{child} = 1;
2020-02-15 23:38:32 +01:00
# don't quit the IRC client when the child dies
no warnings;
*PBot::IRC::Connection::DESTROY = sub { return; };
use warnings;
# remove atexit handlers
$self->{pbot}->{atexit}->unregister_all;
2020-05-02 05:59:51 +02:00
# execute the provided subroutine, results are stored in $context
2020-02-15 23:38:32 +01:00
eval {
2020-05-02 05:59:51 +02:00
local $SIG{ALRM} = sub { die "Process `$context->{commands}->[0]` timed-out" };
2020-02-15 23:38:32 +01:00
alarm $timeout;
2020-05-02 05:59:51 +02:00
$subref->($context);
alarm 0;
2020-02-15 23:38:32 +01:00
};
# check for errors
if ($@) {
2020-05-02 05:59:51 +02:00
$context->{result} = $@;
2020-05-02 05:59:51 +02:00
$context->{'timed-out'} = 1 if $context->{result} =~ /^Process .* timed-out at PBot\/ProcessManager/;
2020-05-02 05:59:51 +02:00
$self->{pbot}->{logger}->log("Error executing process: $context->{result}\n");
# strip internal PBot source data for IRC output
2020-05-02 05:59:51 +02:00
$context->{result} =~ s/ at PBot.*$//ms;
2020-09-27 01:01:52 +02:00
$context->{result} =~ s/\s+...propagated at .*$//ms;
2020-02-15 23:38:32 +01:00
}
2020-05-02 05:59:51 +02:00
# print $context to pipe
my $json = encode_json $context;
2020-02-15 23:38:32 +01:00
print $writer "$json\n";
close $writer;
2020-02-15 23:38:32 +01:00
# end child
exit 0;
} else {
# parent
# nothing to write to child
2020-02-15 23:38:32 +01:00
close $writer;
# add process
2020-05-02 05:59:51 +02:00
$self->add_process($context->{pid}, $context);
# add reader handler
2020-05-02 05:59:51 +02:00
$self->{pbot}->{select_handler}->add_reader($reader, sub { $self->process_pipe_reader($context->{pid}, @_) });
2020-02-15 23:38:32 +01:00
# return empty string since reader will handle the output when child is finished
return '';
2020-02-15 23:38:32 +01:00
}
}
sub process_pipe_reader {
2020-02-15 23:38:32 +01:00
my ($self, $pid, $buf) = @_;
# retrieve context object from child
2020-05-02 05:59:51 +02:00
my $context = decode_json $buf or do {
2020-02-15 23:38:32 +01:00
$self->{pbot}->{logger}->log("Failed to decode bad json: [$buf]\n");
return;
};
# context is no longer forked
2020-05-02 05:59:51 +02:00
delete $context->{pid};
# check for output
2020-05-02 05:59:51 +02:00
if (not defined $context->{result} or not length $context->{result}) {
2020-02-15 23:38:32 +01:00
$self->{pbot}->{logger}->log("No result from process.\n");
return if $context->{suppress_no_output};
$context->{result} = "No output.";
2020-02-15 23:38:32 +01:00
}
# don't output unnecessary result if command was referenced within a message
if ($context->{referenced}) {
return if $context->{result} =~ m/(?:no results)/i;
}
2020-02-15 23:38:32 +01:00
# handle code factoid result
2020-05-02 05:59:51 +02:00
if (exists $context->{special} and $context->{special} eq 'code-factoid') {
$context->{result} =~ s/\s+$//g;
if (not length $context->{result}) {
$self->{pbot}->{logger}->log("No text result from code-factoid.\n");
return;
}
2020-05-02 05:59:51 +02:00
$context->{original_keyword} = $context->{root_keyword};
$context->{result} = $self->{pbot}->{factoids}->handle_action($context, $context->{result});
2020-02-15 23:38:32 +01:00
}
# if nick isn't overridden yet, check for a potential nick prefix
# TODO: this stuff should be moved to Interpreter::output_result
if (not $context->{nickprefix}) {
$context->{trigger} //= '';
# if add_nick is set on the factoid, set the nick override to the caller's nick
if (exists $context->{special} and $context->{special} ne 'code-factoid'
and $self->{pbot}->{factoids}->{storage}->exists($context->{channel}, $context->{trigger}, 'add_nick')
and $self->{pbot}->{factoids}->{storage}->get_data($context->{channel}, $context->{trigger}, 'add_nick') != 0)
2020-02-15 23:38:32 +01:00
{
$context->{nickprefix} = $context->{nick};
$context->{nickprefix_disabled} = 0;
$context->{nickprefix_forced} = 1;
2017-11-26 05:00:55 +01:00
} else {
# extract nick-like thing from process result
2020-05-02 05:59:51 +02:00
if ($context->{result} =~ s/^(\S+): //) {
2020-02-15 23:38:32 +01:00
my $nick = $1;
2020-02-15 23:38:32 +01:00
if (lc $nick eq "usage") {
# put it back on result if it's a usage message
2020-05-02 05:59:51 +02:00
$context->{result} = "$nick: $context->{result}";
2020-02-15 23:38:32 +01:00
} else {
2020-05-02 05:59:51 +02:00
my $present = $self->{pbot}->{nicklist}->is_present($context->{channel}, $nick);
2020-02-15 23:38:32 +01:00
if ($present) {
# nick is present in channel
$context->{nickprefix} = $present;
2020-02-15 23:38:32 +01:00
} else {
# nick not present, put it back on result
2020-05-02 05:59:51 +02:00
$context->{result} = "$nick: $context->{result}";
2020-02-15 23:38:32 +01:00
}
}
}
2017-11-26 05:00:55 +01:00
}
}
# send the result off to the bot to be handled
$context->{checkflood} = 1;
$self->{pbot}->{interpreter}->handle_result($context);
}
1;