3
0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-26 22:09:26 +01:00
pbot/lib/PBot/Plugin/GoogleSearch.pm
2023-04-13 17:08:27 -07:00

106 lines
3.9 KiB
Perl

# File: GoogleSearch.pm
#
# Purpose: Google CustomSearch API. You'll need to configure an api-key and
# a custom-search context. URLs to instructions are provided by the command.
# SPDX-FileCopyrightText: 2019-2023 Pragmatic Software <pragma78@gmail.com>
# SPDX-License-Identifier: MIT
package PBot::Plugin::GoogleSearch;
use parent 'PBot::Plugin::Base';
use PBot::Imports;
use WWW::Google::CustomSearch;
use HTML::Entities;
sub initialize($self, %conf) {
$self->{pbot}->{registry}->add_default('text', 'googlesearch', 'api_key', '');
$self->{pbot}->{registry}->add_default('text', 'googlesearch', 'context', '');
$self->{pbot}->{registry}->set_default('googlesearch', 'api_key', 'private', 1);
$self->{pbot}->{registry}->set_default('googlesearch', 'context', 'private', 1);
$self->{pbot}->{commands}->add(
name => 'google',
help => 'Google search',
subref => sub { $self->cmd_googlesearch(@_) },
);
}
sub unload($self) {
$self->{pbot}->{commands}->remove('google');
}
sub cmd_googlesearch($self, $context) {
return "Usage: google [-n <number of results>] query\n" if not length $context->{arguments};
my $matches = 3;
$matches = $1 if $context->{arguments} =~ s/-n\s+([0-9]+)\s*//;
$matches = 10 if $matches > 10;
my $api_key = $self->{pbot}->{registry}->get_value('googlesearch', 'api_key'); # https://developers.google.com/custom-search/v1/overview
my $cx = $self->{pbot}->{registry}->get_value('googlesearch', 'context'); # https://cse.google.com/all
if (not length $api_key) {
return "$context->{nick}: Registry item googlesearch.api_key is not set. See https://developers.google.com/custom-search/v1/overview to get an API key.";
}
if (not length $cx) { return "$context->{nick}: Registry item googlesearch.context is not set. See https://cse.google.com/all to set up a context."; }
my $engine = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx, quotaUser => $context->{hostmask});
# versus/fight mode: !google banana vs apple -- returns number of results for both terms.
if ($context->{arguments} =~ m/(.*)\s+vs\s+(.*)/i) {
my ($a, $b) = ($1, $2);
my $result1 = $engine->search("\"$a\" -\"$b\"");
my $result2 = $engine->search("\"$b\" -\"$a\"");
if (not defined $result1 or not defined $result1->items or not @{$result1->items}) { return "$context->{nick}: No results for $a"; }
if (not defined $result2 or not defined $result2->items or not @{$result2->items}) { return "$context->{nick}: No results for $b"; }
my $title1 = $result1->items->[0]->title;
my $title2 = $result2->items->[0]->title;
utf8::decode $title1;
utf8::decode $title2;
return "$context->{nick}: "
. "$a: (" . $result1->formattedTotalResults . ') '
. decode_entities($title1) . ' <' . $result1->items->[0]->link . '> '
. 'VS '
. "$b: (" . $result2->formattedTotalResults . ') '
. decode_entities($title2) . ' <' . $result2->items->[0]->link . '>';
}
my $result = eval { $engine->search($context->{arguments}) };
if ($@) {
my $error = $@;
$error =~ s/^WWW::Google::CustomSearch::search\(\): /google: /;
$error =~ s/file .*?$//;
$error =~ s/Missing required arguments: totalResults.*/No results./;
return $error;
}
if (not defined $result or not defined $result->items or not @{$result->items}) { return "$context->{nick}: No results found"; }
my $output = "$context->{nick}: (" . $result->formattedTotalResults . " results) ";
my @results;
foreach my $item (@{$result->items}) {
my $title = $item->title;
utf8::decode $title;
push @results, decode_entities($title) . ': <' . $item->link . '>';
last if --$matches <= 0;
}
$output .= join "\n-- ", @results;
return $output;
}
1;