File Coverage

blib/lib/AxKit2/Constants.pm

Criterion	Covered	Total	%
statement	84	94	89.3
branch	0	8	0.0
condition			n/a
subroutine	28	30	93.3
pod	0	2	0.0
total	112	134	83.5

# Copyright 2001-2006 The Apache Software Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# System constants. Mostly plugin return codes and HTTP response codes

package AxKit2::Constants;

use strict;
use warnings;

use Exporter ();

# log levels
my %log_levels = (
        LOGDEBUG   => 7,
        LOGINFO    => 6,
        LOGNOTICE  => 5,
        LOGWARN    => 4,
        LOGERROR   => 3,
        LOGCRIT    => 2,
        LOGALERT   => 1,
        LOGEMERG   => 0,
        LOGRADAR   => 0,
);

# return codes
my %return_codes = (
        # HTTP Codes
        OK                     => 200,
        NO_CONTENT             => 204,
        PARTIAL_CONTENT        => 206,
        REDIRECT               => 302,
        NOT_MODIFIED           => 304,
        BAD_REQUEST            => 400,
        UNAUTHORIZED           => 401,
        FORBIDDEN              => 403,
        NOT_FOUND              => 404,
        SERVER_ERROR           => 500,
        NOT_IMPLEMENTED        => 501,
        SERVICE_UNAVAILABLE    => 503,

        # AxKit specific codes
        DECLINED               => 909,
        DONE                   => 910,
        CONTINUATION           => 911,
);

use vars qw(@ISA @EXPORT);
@ISA = qw(Exporter);
@EXPORT = (keys(%return_codes), keys(%log_levels), "return_code", "log_level");

foreach (keys %return_codes ) {
    eval "use constant $_ => ".$return_codes{$_};
}

foreach (keys %log_levels ) {
    eval "use constant $_ => ".$log_levels{$_};
}

sub return_code {
    my $test = shift;
    if ( $test =~ /^\d+$/ ) { # need to return the textural form
        foreach ( keys %return_codes ) {
            return $_ if $return_codes{$_} =~ /$test/;
        }
    }
    else { # just return the numeric value
        return $return_codes{$test};
    }
}

sub log_level {
    my $test = shift;
    if ( $test =~ /^\d+$/ ) { # need to return the textural form
        foreach ( keys %log_levels ) {
            return $_ if $log_levels{$_} =~ /$test/;
        }
    }
    else { # just return the numeric value
        return $log_levels{$test};
    }
}

1;

=head1 NAME

AxKit2::Constants - Constants for plugins to use

=head1 HOOK CONSTANTS

See L for hook specific information on applicable
constants.

Constants available:

=over 4

=item C

Returning this from a hook implies success, but tells axkit to go
on to the next plugin.

=item C

Returning this from a hook implies success, but tells axkit to skip any more
plugins for this phase.

=item C

C is generally hook specific, see L for
details.

=back

You can, in most hooks, return any of the HTTP response codes below.

=head1 HTTP RESPONSE CONSTANTS

        OK                     => 200,
        NO_CONTENT             => 204,
        PARTIAL_CONTENT        => 206,
        REDIRECT               => 302,
        NOT_MODIFIED           => 304,
        BAD_REQUEST            => 400,
        UNAUTHORIZED           => 401,
        FORBIDDEN              => 403,
        NOT_FOUND              => 404,
        SERVER_ERROR           => 500,
        NOT_IMPLEMENTED        => 501,
        SERVICE_UNAVAILABLE    => 503,

=head1 LOGGING CONSTANTS

The following log level constants are also available:

        LOGDEBUG   => 7,
        LOGINFO    => 6,
        LOGNOTICE  => 5,
        LOGWARN    => 4,
        LOGERROR   => 3,
        LOGCRIT    => 2,
        LOGALERT   => 1,
        LOGEMERG   => 0,


=cut