Image::VisualConfirmation - Add anti-spam CAPTCHA ( visual


Image-VisualConfirmation documentation Contained in the Image-VisualConfirmation distribution.

Index


Code Index:

NAME

Top

Image::VisualConfirmation - Add anti-spam CAPTCHA ( visual confirmation/challenge) to your web forms.

SYNOPSIS

Top

    use Image::VisualConfirmation;

    my $vc = Image::VisualConfirmation->new();

    # ### Get code and image ####

    print $vc->image_code;

    my $image_data = $vc->image_data(type => 'png');

    # ### Work with the Imager object directly ###

    my $image = $vc->image;
    $image->filter(type=>'turbnoise'):

    $vc->image->write(file => 'vc.jpg');




DESCRIPTION

Top

This module aims at making the creation of visual confirmation (also known as visual challenge) images simple. For those who doen't know about these, they are the funky images from which you have to copy the text when submitting a form. Their function is to avoid robots spamming web forms, and they work quite good even though spammers' OCR software is becoming increasingly good.

This module is mainly for use in a web application context, in conjuction with such modules as CGI::Session or with a web framework such as Catalyst.

When creating the random string, this module excludes the letters/digits which might be confused with each other, so that the user has a greater chance to not get angered with the challenge: 0, upper and lower-case o; lower-case l and 1; j.

This module is in many ways similar to Authen::Captcha, but is uses Imager instead of GD and it features a different interface: it's simpler, just a lightweight wrapper around Imager). And there's also GD::SecurityImage. Choose the module that better suits your needs.

An usage example is available in the examples directory.

METHODS

Top

new

Arguments: \%options

Return Value: $vc (new Image::VisualConfirmation object)

This method initializes a new object.

    # This should work everywhere
    my $vc = Image::VisualConfirmation->new();

    # Font selection on Win32
    my $vc = Image::VisualConfirmation->new({
        font_file   => './bodoni.pbf',
        font_size   => 30,
    });

    # Font selection on all other systems (should work on Win32 as well)
    my $vc = Image::VisualConfirmation->new({
        font_face   => 'Times New Roman',
        font_size   => 30,
    });

All parameters are optional:

font_face: under Win32, this is the standard method to specify the font to use to render the text. You can specify the font with or without attributes, i.e. Times New Roman or Arial Bold. If this parameter is not passed, it defaults to Arial on Win32 and is completely ignored on other systems.

font_file: the path to the font to use to render the text. By default it uses a Bitstream Vera font bundled with this module, unless you are on Win32 where your system Arial font will be used. Several font formats are accepted, depending on your platform: see Imager::Font documentation. The bundled Vera font is in /your/perllib/path/Image/VisualConfirmation/Vera.ttf or some similar location, and you should have plenty of fonts to choose from in /usr/share/fonts.

font_size: the size of the characters, it defaults to 20.

font_type: it has been reported the font-type autodetection by Imager doesn't always work, so you have the options to explicitly tell the the font type: available types depend on how Imager is compiled on your system, but they should be tt, t1, w32, ft2 or a subset of these. This parameter is only considered when font_file is specified as well. It is highly recommended that you pass this parameter if you pass a font_file (you might get font file not found from Imager errors otherwise).

code_length: the length, in chars, of the visual code to generate at random; default is 6.

code: allows to provide a code to display on the image, instead of generating one at random. You can also pass a coderef of any sub that returns a string.

width and height: if these 2 are provided, the image will be createt of that size (but rotation might then change it a bit); otherwise, the size will be calculated dinamically depending on code_length and font_size.

create_new_image

Arguments: \%options

Generates a new code and new image for the given object. Parameters are the same as new.

code

Returns: string

Returns the code which has been generated, in string format. This is needed for comparison with the user-entered one.

image

Returns: Imager object

Returns an Imager object with the created image. This allows you to get all the image properties, save it, ... It also allows to perform further obfuscation on the image, if needed.

image_data

Arguments: \%options

Returns: raw image data

This method returns the raw data of the image in a variable, which can be used for direct output, i.e.:

    my $image_data = $vc->image_data;

    print $q->header(
        type   => 'image/png',
    );

    print $image_data;

There's an optional parameter, type, which allows you to specify the format of the data you get. All formats supported by Imager are valid: png (the default if you don't pass the parameter), jpeg, gif, tiff, bmp, tga and raw. Beware that gif support is broken on some platforms (including mine): don't use it. You can pass any additional parameter that Imager's write method accepts, it will be forwarded: see Imager::Files for more information.

TODO

Top

- Make width and height actually work as expected.

- Improve the visual challenge by adding image deformations.

- Improve the synopsis with a CGI::Session and a Catalyst example.

- Improve error handling with bad parameters.

SEE ALSO

Top

Imager

AUTHOR

Top

Michele Beltrame, mb@italpro.net

LICENSE

Top

This library is free software, you can redistribute it and/or modify it under the same terms as Perl 5 itself.

The Bitstream Vera font bundled with this distribution is copyrighted by Bitstream ( http://www.bitstream.com ) and distributed under its license terms.


Image-VisualConfirmation documentation Contained in the Image-VisualConfirmation distribution.

package Image::VisualConfirmation;

BEGIN {
  $Image::VisualConfirmation::VERSION = '0.10007';
}

use strict;
use warnings;

use Carp;
use Imager();
use Path::Class();
use List::Util qw/shuffle/;

# We want to avoid all possible confusions for the user: 0, upper and
# lower-case 'o', lower-case 'l' and '1', 'j'
our @LETTERS = (
    'A'..'N', 'P'..'Z', 'a'..'i', 'k', 'm', 'n', 'p'..'z', '2'..'9'
);

our $DEFAULT_TYPE         = 'png';
our $DEFAULT_FONT_FACE    = 'Arial';        # For Win32
our $DEFAULT_FONT_FILE    = 'Vera.ttf';     # For all other platforms
our $DEFAULT_FONT_TYPE    = 'ft2';          # For Vera.ttf
our $DEFAULT_FONT_SIZE    = 20;
our $DEFAULT_CODE_LENGTH  = 6;

# Instantiate a new object, and then call create_new_image which
# does the real work
sub new {
    my ($class, $options) = @_;

    my $self = {};
    bless $self, $class;

    # Create an image from the code
    $self->create_new_image($options);
        
    return $self;
}

# Create a new codice and image
sub create_new_image {
    my ($self, $options) = @_;
        
    croak "Arguments must be an hashref"
        if ( $options ) && ( ref($options) ne 'HASH' );

    # If we're on Win32, see if the font face is passed, otherwise
    # grab the default one
    if ( $^O =~ m/Win/xms ) {
        $self->{font_face} = $options->{font_face} || $DEFAULT_FONT_FACE;
    }

    # Now see if there is a font_file parameter, which is the one
    # needed on Unix (and will override font_face on Windows)
    if ( exists $options->{font_file} )
    {
        $self->{font_file} = $options->{font_file};

        $self->{font_type} = $options->{font_type};
    }
    
    # Otherwise we search for the default, but only if we're not
    # on Windows (we'll use the font_face defined above in that case)
    elsif ( $^O !~ m/Win/xms ) {
        my $font_basedir = __FILE__;
        $font_basedir =~ s/\.pm\z//;
        
        my $font_file = Path::Class::File->new(
            $font_basedir, '/', $DEFAULT_FONT_FILE
        );

        croak 'Error getting the default font file. Please specify one'
            if !-e $font_file;
        $self->{font_file} = $font_file;

        $self->{font_type} = $DEFAULT_FONT_TYPE;
    }

    $self->{code_length} = $options->{code_length} || $DEFAULT_CODE_LENGTH;
    $self->{font_size} = $options->{font_size} || $DEFAULT_FONT_SIZE;
    
    if ( defined $options->{code} ) {
        $self->{code} = ref($options->{code}) eq 'CODE'
            ? $options->{code}->()
            : $options->{code}
            ;
    }
    else {
        $self->{code} = $self->_generate_code();
    }
    
    my ($width, $height);
    if ( (exists $options->{width}) && (exists $options->{height}) ) {
        $width  = $options->{width};
        $height = $options->{heigh};
    }

    # Auto-compute the size of the image (if it's not passed)
    else {
        $width
            = int($self->{font_size}*1.2) * $self->{code_length} + 20;
        $height = $self->{font_size}*1.3 + 10;
    }

    $self->{image} = Imager->new(
        xsize    => $width,
        ysize    => $height,
    ) or croak "Can't create image objct: $!";

    # Background color
    $self->_create_bgcolor();
    $self->{image}->box( filled => 1, color => $self->{bgcolor} );

    $self->_create_string();
    
    # Rotate the image just to confuse things a bit
    my $degrees = int(rand 10) + 10;
    $degrees = (qw/+ -/)[int(rand 2)] . $degrees;
    $self->{image}
        = $self->{image}->rotate(degrees => $degrees, back => $self->{bgcolor})
            or croak $self->{image}->errstr;

    $self->{image}->filter(type=>"gaussian", stddev=>1)
        or croak $self->{image}->errstr;
    $self->{image}->filter(type=>"noise", amount=>50, subtype=>0)
        or croak $self->{image}->errstr;
}

# Return the code in a string
sub code {
    my $self = shift;

    return $self->{code};
}

# Return the Imager object for the image
sub image {
    my $self = shift;

    return $self->{image};
}

# Return the raw data of an image, in the format specified (PNG if
# not otherwise stated)
sub image_data {
    my ($self, $options) = @_;
    
    croak "Arguments must be an hashref"
        if ( $options ) && ( ref($options) ne 'HASH' );

    # Supply a default image type if it's not already provided
    $options->{type} = $options->{type} || $DEFAULT_TYPE;
    
    my $image = $self->{image};
    my $image_data;
    
    $image->write(
        data    => \$image_data,
        %$options,
    ) or croak $image->errstr;

    return $image_data;
}

# Generate the code for the image
sub _generate_code {
    my $self = shift;

    my $code = '';
    for my $i(1 .. $self->{code_length}) {
        $code .= $LETTERS[ rand $#LETTERS ];
    }
    
    return $code;
}

# Create a random bgcolor
sub _create_bgcolor {
    my $self = shift;
   
    my @components = shuffle(
        int(rand 100)+156, int(rand 100)+156, int(rand 100)+156
    );
    
    $self->{bgcolor} = new Imager::Color(
        shuffle(int(rand 100)+156, int(rand 100)+156, int(rand 100)+156)
    );
}

# Create the funky string in the image
sub _create_string {
    my $self = shift;

    my $image = $self->{image};
    my $code  = $self->{code};
       
    # Render the font
    my $font;
    if ( exists $self->{font_file} ) {
        my %imager_params = (
            file  => $self->{font_file},
        );
        if ( defined $self->{font_type} ) {
            $imager_params{type} = $self->{font_type};
        }

        $font = Imager::Font->new(
            %imager_params
        ) or croak "Font file not found: $!";
    }
    else {
        $font = Imager::Font->new(
            face  => $self->{font_face},
        ) or croak "Font not found: $!";
    }

    my @code_chars = split //, $code;
    my $pos_x = 10;
    
    # Get background color components for comparison with letter
    # color components
    my ($bg_red, $bg_green, $bg_blue) = $self->{bgcolor}->rgba();

    my $i = 0;
    while ($i < length($code) ) {

        my $color = Imager::Color->new(
            shuffle( int(rand 10)+1, int(rand 100)+1, int(rand 100)+1 )
        );
        
        # Make sure the font size grows sometimes a bit (20%)
        my $font_growth = int( rand int($self->{font_size}*0.20) )+1;
        my $font_size = $self->{font_size} + $font_growth;

        $image->align_string(
            font    => $font,
            text    => $code_chars[$i],
            x       => $pos_x,
            y       => 10,
            valign  => 'top',
            size    => $font_size,
            color   => $color,
            aa      => 1
        ) or croak "Error inserting string: $!";
        
        $pos_x += $self->{font_size} + int(rand (int ($self->{font_size}/2)))+1;
        
        $i++;
    }
}

1;

__END__