File Coverage

blib/lib/DNS/BL/cmds.pm

Criterion	Covered	Total	%
statement	26	29	89.6
branch	2	4	50.0
condition			n/a
subroutine	6	7	85.7
pod	2	2	100.0
total	36	42	85.7

package DNS::BL::cmds;

use DNS::BL;

use 5.006001;
use strict;
use warnings;

use Carp;

our $VERSION = '0.00_01';
$VERSION = eval $VERSION;  # see L

# Preloaded methods go here.

=pod

=head1 NAME

DNS::BL::cmds - Base class for DNS::BL commands

=head1 SYNOPSIS

  use DNS::BL::cmds;

=head1 DESCRIPTION

This module provides template functions that must be overriden by the
actual C commands, as well as its documentation. This behaves
as a pure-virtual class.

The following methods are implemented by this module:

=over

=item C<-Eexecute($dns_bl, $verb, @arguments)>

This method is invoked by C whenever parsing of a command
line with a given verb is requested. The first argument, is a
reference to the invoking C object. The second argument is
the verb that caused this invocation. Any additional parameters, are
passed along as a list or arguments.

In scalar context, this method must return one of the C
constants defined in L. In list context, the first element of
the return value must be this constant. The second argument, must be
an explanation message suitable for presenting to an end user.

=cut

sub execute { croak "Must override ->execute()"; }

=pod

=item C<-Earg_check($caller, $dns_bl, $handler, $verb, \@known, \%arguments)>

This method is provided as a courtesy to subclasses. It tests
automatically wether passed arguments are understood by the
implementation. See the various subclasses for examples of its use.

=cut

sub arg_check
{
    my $caller	= shift;
    my $bl	= shift;
    my $command	= shift;
    my $handler	= shift;
    my $r_known	= shift;
    my $r_args	= shift;

    unless ($command eq $handler)
    {
	return
	    (&DNS::BL::DNSBL_ESYNTAX(),
	     "'$caller' invoked by command '$command'");
    }

    for my $k (keys %$r_args)
    {
	unless (grep { $k eq $_ } @$r_known)
	{
	    return (&DNS::BL::DNSBL_ESYNTAX(),
		    "Unknown argument '$k' to command '$command'");
	}
    }

    return (&DNS::BL::DNSBL_OK(), "OK");
}

1;
__END__