File Coverage

blib/lib/CGI/ArgChecker.pm

Criterion	Covered	Total	%
statement	9	48	18.7
branch	0	12	0.0
condition			n/a
subroutine	3	8	37.5
pod	0	4	0.0
total	12	72	16.6

######################################################################
#
# Copyright 1999 Web Juice, LLC. All Rights Reserved.
#
# CGI/ArgChecker.pm
#
# An extensible CGI parameter validation module (allowing commonly used
# checks on parameters to be called more concisely and consistently).
#
# $Header: /usr/local/repository/advoco/CGI-ArgChecker/ArgChecker.pm,v 1.3 1999/08/12 00:07:22 dlowe Exp $
# $Log: ArgChecker.pm,v $
# Revision 1.3  1999/08/12 00:07:22  dlowe
# Documentation update
#
# Revision 1.2  1999/08/12 00:04:14  dlowe
# Changed the argcheck() method to always return a hashref containing values,
# even if some values failed in error checking.
#
# Revision 1.1.1.1  1999/07/09 01:24:54  dlowe
# CGI::ArgChecker
#
#
######################################################################
package CGI::ArgChecker;

use strict;
use vars qw($VERSION);

use String::Checker;

$VERSION = '0.02';

######################################################################
## NAME:          new
##
## DESCRIPTION:   Constructor for CGI::ArgChecker
##
## USAGE:         $checker = new CGI::ArgChecker;
##
## RETURN VALUES: undef if there's an error, otherwise a blessed hash ref.
##
## BUGS:          Hopefully none.
######################################################################
sub new
{
    my($class) = shift;

    ## We don't want this called as an instance method.
    if (ref($class))
    {
        return(undef);
    }

    my($self) = { };
    $self->{'errhandler'} = sub { };
    bless($self, $class);

    return $self;
}
### end new ##########################################################



######################################################################
## NAME:          register_check
##
## DESCRIPTION:   Register a new parameter checking routine
##
## USAGE:         $checker->register_check($name, \&sub);
##
## RETURN VALUES: None.
##
## BUGS:          Hopefully none.
######################################################################
sub register_check
{
    my($self) = shift;
    if (! ref($self))
    {
        return;
    }

    my($check)   = shift;
    my($coderef) = shift;
    String::Checker::register_check($check, $coderef);
}
### end register_check ###############################################



######################################################################
## NAME:          error_handler
##
## DESCRIPTION:   Register an error handling routine
##
## USAGE:         $checker->error_handler(\&errhandler);
##
## RETURN VALUES: None.
##
## BUGS:          Hopefully none.
######################################################################
sub error_handler
{
    my($self) = shift;
    if (! ref($self))
    {
        return(undef);
    }

    $self->{'errhandler'} = shift;
}
### end error_handler ################################################



######################################################################
## NAME:          argcheck
##
## DESCRIPTION:   Check that all CGI parameters match the programmer's
##                expectations.
##
## USAGE:         $href = $checker->argcheck($CGI_query_object,
##                                   'param_name' => [ 'expectation', ... ],
##                                    ... );
##
## RETURN VALUES: Returns a hash reference containing param_name =>
##                param_value pairs.  If there's an internal error,
##                returns undef.
##
## BUGS:          Hopefully none.
######################################################################
sub argcheck
{
    my($self) = shift;
    if (! ref($self))
    {
        return(undef);
    }

    my($query)        = shift;
    my(%expectations) = @_;
    my($error_flag)   = 0;
    my(%return);

    foreach my $parameter (keys(%expectations))
    {
        my($value)  = $query->param($parameter);
        my($ret) = String::Checker::checkstring($value,
                                                $expectations{$parameter});
        if (! defined($ret))
        {
            return(undef);
        }
        foreach my $error_name (@{$ret})
        {
            $error_flag = 1;
            $self->{'errhandler'}->($parameter, $error_name);
        }

        $return{$parameter} = $value;
    }
    if ($error_flag)
    {
        $return{'ERROR'} = 1;
    }
    else
    {
        $return{'ERROR'} = 0;
    }
    return(\%return);
}
### end argcheck #####################################################

1;
__END__