# File: FuncCommand.pm # Author: pragma_ # # Purpose: Special `func` command that executes built-in functions with # optional arguments. Usage: func [arguments]. # # Intended usage is with command-substitution (&{}) or pipes (|{}). # # For example: # # factadd img /call echo https://google.com/search?q=&{func uri_encode $args}&tbm=isch # # The above would invoke the function 'urlencode' on $args and then replace # the command-substitution with the result, thus encoding $args to be safely # used in the URL of this simple Google Image Search factoid command. # 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::FuncCommand; use warnings; use strict; use feature 'unicode_strings'; use Carp (); sub new { if (ref($_[1]) eq 'HASH') { 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 FactoidCommands"); $self->{pbot}->{commands}->register(sub { return $self->do_func(@_) }, 'func', 0); $self->init_funcs; } sub init_funcs { my ($self) = @_; $self->{funcs} = { help => { desc => 'provides help about a func', usage => 'help [func]', subref => sub { $self->func_help(@_) } }, list => { desc => 'lists available funcs', usage => 'list [regex]', subref => sub { $self->func_list(@_) } }, uri_escape => { desc => 'percent-encode unsafe URI characters', usage => 'uri_escape ', subref => sub { $self->func_uri_escape(@_) } }, sed => { desc => 'a sed-like stream editor', usage => 'sed s///[Pig]; P preserve case; i ignore case; g replace all', subref => sub { $self->func_sed(@_) } }, unquote => { desc => 'removes unescaped surrounding quotes and strips escapes from escaped quotes', usage => 'unquote ', subref => sub { $self->func_unquote(@_) } }, }; } sub func_help { my ($self, $func) = @_; if (not exists $self->{funcs}->{$func}) { return "No such func '$func'."; } return "$func: $self->{funcs}->{$func}->{desc}; usage: $self->{funcs}->{$func}->{usage}"; } sub func_list { my ($self, $regex) = @_; $regex = '.*' if not defined $regex; my $result = eval { my $text = ''; foreach my $func (sort keys %{$self->{funcs}}) { if ($func =~ m/$regex/i or $self->{funcs}->{$func}->{desc} =~ m/$regex/i) { $text .= "$func: $self->{funcs}->{$func}->{desc}.\n"; } } if (not length $text) { if ($regex eq '.*') { $text = "No funcs yet."; } else { $text = "No matching func."; } } return $text; }; if ($@) { my $error = $@; $error =~ s/at PBot.FuncCommand.*$//; return "Error: $error\n"; } return $result; } sub func_unquote { my $self = shift; my $text = "@_"; $text =~ s/^"(.*?)(?{pbot}->{interpreter}->shift_arg($stuff->{arglist}); if (not defined $func) { return "Usage: func [arguments]"; } if (not exists $self->{funcs}->{$func}) { return "[No such func '$func']"; } my @params; while (my $param = $self->{pbot}->{interpreter}->shift_arg($stuff->{arglist})) { push @params, $param; } my $result = $self->{funcs}->{$func}->{subref}->(@params); $result =~ s/\x1/1/g; return $result; } 1;