3
0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-02 18:19:33 +01:00
pbot/lib/PBot/Core/Applets.pm

125 lines
3.9 KiB
Perl
Raw Normal View History

# File: Applets.pm
2021-06-19 06:23:34 +02:00
#
# Purpose: Applets are command-line programs and scripts that can be loaded
# via PBot factoids. Command arguments are passed as command-line arguments.
# The standard output from the script is returned as the bot command result.
# The standard error output is stored in a file named <applet>-stderr in the
# applets/ directory.
2021-07-11 00:00:22 +02:00
# SPDX-FileCopyrightText: 2021 Pragmatic Software <pragma78@gmail.com>
# SPDX-License-Identifier: MIT
package PBot::Core::Applets;
2021-07-21 07:44:51 +02:00
use parent 'PBot::Core::Class';
2021-06-19 06:23:34 +02:00
use PBot::Imports;
use IPC::Run qw/run timeout/;
use Encode;
sub initialize {
# nothing to do here
}
sub execute_applet {
2020-05-02 05:59:51 +02:00
my ($self, $context) = @_;
2020-02-15 23:38:32 +01:00
if ($self->{pbot}->{registry}->get_value('general', 'debugcontext')) {
use Data::Dumper;
$Data::Dumper::Sortkeys = 1;
$self->{pbot}->{logger}->log("execute_applet\n");
2020-05-02 05:59:51 +02:00
$self->{pbot}->{logger}->log(Dumper $context);
2020-02-15 23:38:32 +01:00
}
$self->{pbot}->{process_manager}->execute_process($context, sub { $self->launch_applet(@_) });
}
sub launch_applet {
2020-05-02 05:59:51 +02:00
my ($self, $context) = @_;
$context->{arguments} //= '';
my @factoids = $self->{pbot}->{factoids}->{data}->find($context->{from}, $context->{keyword}, exact_channel => 2, exact_trigger => 2);
2020-02-15 23:38:32 +01:00
if (not @factoids or not $factoids[0]) {
2020-05-02 05:59:51 +02:00
$context->{checkflood} = 1;
$self->{pbot}->{interpreter}->handle_result($context, "/msg $context->{nick} Failed to find applet for '$context->{keyword}' in channel $context->{from}\n");
2020-02-15 23:38:32 +01:00
return;
}
2020-02-15 23:38:32 +01:00
my ($channel, $trigger) = ($factoids[0]->[0], $factoids[0]->[1]);
2020-05-02 05:59:51 +02:00
$context->{channel} = $channel;
$context->{keyword} = $trigger;
$context->{trigger} = $trigger;
2020-02-15 23:38:32 +01:00
my $applet = $self->{pbot}->{factoids}->{data}->{storage}->get_data($channel, $trigger, 'action');
$self->{pbot}->{logger}->log(
'(' . (defined $context->{from} ? $context->{from} : "(undef)") . '): '
. "$context->{hostmask}: Executing applet [$context->{command}] $applet $context->{arguments}\n"
);
$context->{arguments} = $self->{pbot}->{factoids}->{variables}->expand_factoid_vars($context, $context->{arguments});
2020-02-15 23:38:32 +01:00
my $applet_dir = $self->{pbot}->{registry}->get_value('general', 'applet_dir');
if (not chdir $applet_dir) {
$self->{pbot}->{logger}->log("Could not chdir to '$applet_dir': $!\n");
Carp::croak("Could not chdir to '$applet_dir': $!");
}
2020-02-15 23:38:32 +01:00
if ($self->{pbot}->{factoids}->{data}->{storage}->exists($channel, $trigger, 'workdir')) {
chdir $self->{pbot}->{factoids}->{data}->{storage}->get_data($channel, $trigger, 'workdir');
2020-02-15 23:38:32 +01:00
}
# FIXME -- add check to ensure $applet exists
2020-02-15 23:38:32 +01:00
my ($exitval, $stdout, $stderr) = eval {
2020-05-02 05:59:51 +02:00
my $args = $context->{arguments};
if (not $context->{args_utf8}) {
$args = encode('UTF-8', $args);
}
my @cmdline = ("./$applet", $self->{pbot}->{interpreter}->split_line($args));
my $timeout = $self->{pbot}->{registry}->get_value('general', 'applet_timeout') // 30;
2020-02-15 23:38:32 +01:00
my ($stdin, $stdout, $stderr);
2020-02-15 23:38:32 +01:00
run \@cmdline, \$stdin, \$stdout, \$stderr, timeout($timeout);
2020-02-15 23:38:32 +01:00
my $exitval = $? >> 8;
utf8::decode $stdout;
utf8::decode $stderr;
2020-02-15 23:38:32 +01:00
return ($exitval, $stdout, $stderr);
};
if ($@) {
my $error = $@;
if ($error =~ m/timeout on timer/) {
($exitval, $stdout, $stderr) = (-1, "$context->{trigger}: timed-out", '');
} else {
($exitval, $stdout, $stderr) = (-1, '', $error);
$self->{pbot}->{logger}->log("$context->{trigger}: error executing applet: $error\n");
}
2020-02-15 23:38:32 +01:00
}
if (length $stderr) {
if (open(my $fh, '>>', "$applet-stderr")) {
2020-02-15 23:38:32 +01:00
print $fh $stderr;
close $fh;
} else {
$self->{pbot}->{logger}->log("Failed to open $applet-stderr: $!\n");
2020-02-15 23:38:32 +01:00
}
}
2020-05-02 05:59:51 +02:00
$context->{result} = $stdout;
chomp $context->{result};
}
1;