pbot/Plugins/GoogleSearch.pm

#!/usr/bin/perl

# 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 Plugins::GoogleSearch;

use warnings;
use strict;

use feature 'unicode_strings';

use WWW::Google::CustomSearch;
use HTML::Entities;

use Carp ();

sub new {
  Carp::croak("Options to " . __FILE__ . " should be key/value pairs, not hash reference") if ref $_[1] eq 'HASH';
  my ($class, %conf) = @_;
  my $self = bless {}, $class;
  $self->initialize(%conf);
  return $self;
}

sub initialize {
  my ($self, %conf) = @_;
  $self->{pbot} = $conf{pbot} // Carp::croak("Missing pbot reference to " . __FILE__);

  $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}->register(sub { $self->googlesearch(@_) }, 'google', 0);
}

sub unload {
  my $self = shift;
  $self->{pbot}->{commands}->unregister('google');
}

sub googlesearch {
  my ($self, $from, $nick, $user, $host, $arguments, $stuff) = @_;

  if (not length $arguments) {
    return "Usage: google [number of results] query\n";
  }

  my $matches = 1;

  if ($arguments =~ s/^([0-9]+)//) {
    $matches = $1;
  }

  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 "$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 "$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 => "$nick!$user\@$host");

  if ($arguments =~ m/(.*)\svs\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 "$nick: No results for $a";
    }

    if (not defined $result2 or not defined $result2->items or not @{$result2->items}) {
      return "$nick: No results for $b";
    }

    my $title1 = $result1->items->[0]->title;
    my $title2 = $result2->items->[0]->title;

    utf8::decode $title1;
    utf8::decode $title2;

    return "$nick: $a: (" . $result1->formattedTotalResults . ") " . decode_entities($title1) . " <" . $result1->items->[0]->link . "> VS $b: (" . $result2->formattedTotalResults . ") " . decode_entities($title2) . " <" . $result2->items->[0]->link . ">";
  }

  my $result  = $engine->search($arguments);

  if (not defined $result or not defined $result->items or not @{$result->items}) {
    return "$nick: No results found";
  }

  my $output = "$nick: (" . $result->formattedTotalResults . " results) ";

  my $comma = "";
  foreach my $item (@{$result->items}) {
    my $title = $item->title;
    utf8::decode $title;
    $output .= $comma . decode_entities($title) . ': <' . $item->link . ">";
    $comma = " -- ";
    last if --$matches <= 0;
  }
  return $output;
}

1;