File Coverage

blib/lib/Mojolicious/Plugin/ReCAPTCHAv2.pm

Criterion	Covered	Total	%
statement	74	94	78.7
branch	18	30	60.0
condition	12	23	52.1
subroutine	7	7	100.0
pod	1	1	100.0
total	112	155	72.2

package Mojolicious::Plugin::ReCAPTCHAv2;
$Mojolicious::Plugin::ReCAPTCHAv2::VERSION = '1.06';
# vim:syntax=perl:tabstop=4:number:noexpandtab:

use Mojo::Base 'Mojolicious::Plugin';

# ABSTRACT: use Googles "No CAPTCHA reCAPCTHA" (reCAPTCHA v2) service in Mojolicious apps

use Mojo::JSON qw();
use Mojo::UserAgent qw();

has conf => sub { +{} };
has ua   => sub { Mojo::UserAgent->new()->max_redirects( 0 ) };


sub register {
    my $plugin = shift;
    my $app    = shift;
    my $conf   = shift || {};

    die ref( $plugin ), ": need sitekey and secret!\n"
      unless $conf->{'sitekey'} and $conf->{'secret'};

    $conf->{'api_url'}     //= 'https://www.google.com/recaptcha/api/siteverify';
    $conf->{'api_timeout'} //= 10;

    $plugin->conf( $conf );
    $plugin->ua->request_timeout( $conf->{'api_timeout'} );

    $app->helper(
        recaptcha_get_html => sub {
            my $c        = shift;
            my $language = $_[0] ? shift : undef;

            my %data_attr = map { $_ => $plugin->conf->{$_} } grep { index( $_, 'api_' ) != 0 } keys %{ $plugin->conf };

            # Never expose this!
            delete $data_attr{'secret'};

            my $hl = '';
            if ( defined $language and $language ) {
                $hl = $language;
            }
            elsif ( exists $data_attr{'language'} ) {
                $hl = delete $data_attr{'language'};
            }

            my $output   = '';
            my $template = q|
 data-<%= $k %>="<%= $attr->{$k} %>"<% } %>>|;

            return $c->render_to_string(
                handler => 'ep',
                inline  => $template,
                hl      => $hl,
                attr    => \%data_attr,
            );
        }
    );

    $app->helper(
        recaptcha_verify => sub {
            my $c = shift;

            my $cb = shift;
            unless ( defined( $cb ) and ref( $cb ) eq 'CODE' ) {
                $cb = '';
            }

            my %verify_params = (
                remoteip => $c->tx->remote_address,
                response => ( $c->req->param( 'g-recaptcha-response' ) || '' ),
                secret   => $plugin->conf->{'secret'},
            );

            my $url = $plugin->conf->{'api_url'};

            my $response_handler = sub {
                my ( $ua, $tx ) = @_;

                my ( $verified, $err ) = ( 0, [] );
                if ( my $txerr = $tx->error ) {
                    my $txt = 'Retrieving captcha verifcation failed';
                    $txt .= ' (HTTP ' . $txerr->{'code'} . ')' if $txerr->{'code'};

                    $c->app->log->error( $txt . ': ' . $txerr->{'message'} );
                    $c->app->log->error( 'Request  was: ' . $tx->req->to_string );

                    ( $verified, $err ) = ( 0, ['x-http-communication-failed'] );
                }
                else {
                    my $json = '';
                    eval { $json = Mojo::JSON::decode_json( $tx->res->body ); };

                    if ( $@ ) {
                        $c->app->log->error( 'Decoding JSON response failed: ' . $@ );
                        $c->app->log->error( 'Request  was: ' . $tx->req->to_string );
                        $c->app->log->error( 'Response was: ' . $tx->res->to_string );

                        ( $verified, $err ) = ( 0, ['x-unparseable-data-received'] );
                    }
                    else {
                        unless ( $json->{'success'} == Mojo::JSON->true ) {
                            @{$err} = @{ $json->{'error-codes'} // [] };
                        }
                        $verified = $json->{'success'};
                    }
                }

                return $cb->( $verified, $err ) if $cb;
                return ( $verified, $err );
            };

            if ( $cb ) {
                return $plugin->ua->post( $url, form => \%verify_params, $response_handler );
            }
            else {
                my $tx = $plugin->ua->post( $url, form => \%verify_params );
                return $response_handler->( $plugin->ua, $tx );
            }
        }
    );

    $app->helper(
        recaptcha_verify_p => sub {
            my $c = shift;

            my %verify_params = (
                remoteip => $c->tx->remote_address,
                response => ( $c->req->param( 'g-recaptcha-response' ) || '' ),
                secret   => $plugin->conf->{'secret'},
            );

            my $url = $plugin->conf->{'api_url'};

            # Async request using promises
            require Mojo::Promise;
            my $p = Mojo::Promise->new();
            $plugin->ua->post(
                $url => form => \%verify_params,
                sub {
                    my ( $ua, $tx ) = @_;

                    if ( my $err = $tx->error ) {
                        my $txt = 'Retrieving captcha verification failed';
                        $txt .= ' (HTTP ' . $err->{'code'} . ')' if $err->{'code'};

                        $c->app->log->error( $txt . ': ' . $err->{'message'} );
                        $c->app->log->error( 'Request  was: ' . $tx->req->to_string );
                        return $p->reject( ['x-http-communication-failed'] );
                    }

                    my $res  = $tx->res;
                    my $json = eval { $res->json };

                    if ( not defined $json ) {
                        $c->app->log->error( 'Decoding JSON response failed: ' . $@ );
                        $c->app->log->error( 'Request  was: ' . $tx->req->to_string );
                        $c->app->log->error( 'Response was: ' . $tx->res->to_string );
                        return $p->reject( ['x-unparseable-data-received'] );
                    }

                    unless ( $json->{'success'} ) {
                        return $p->reject( $json->{'error-codes'} // [] );
                    }

                    return $p->resolve( $json->{'success'} );
                }
            );

            return $p;
        }
    );

    return;
} ## end sub register

1;

__END__