File Coverage

blib/lib/Farly/Template/Cisco.pm

Criterion	Covered	Total	%
statement	121	122	99.1
branch	63	70	90.0
condition	18	24	75.0
subroutine	17	17	100.0
pod	4	4	100.0
total	223	237	94.0

package Farly::Template::Cisco;

use 5.008008;
use strict;
use warnings;
use Carp;
use File::Spec;
use Template;
use Log::Any qw($log);

our $VERSION = '0.26';
our ( $volume, $dir, $file ) = File::Spec->splitpath( $INC{'Farly/Template/Cisco.pm'} );

sub new {
    my ( $class, $file, %args ) = @_;

    my $self = {
        FILE     => $file,
        TEMPLATE => undef,
        TEXT     => undef,    #set this to use text port and protocol names
    };

    bless $self, $class;

    $self->_init(%args);

    $log->info("$self new");

    return $self;
}

sub _template { return $_[0]->{TEMPLATE}; }
sub _file     { return $_[0]->{FILE}; }
sub _text     { $_[0]->{TEXT} }

sub _init {
    my ( $self, %args ) = @_;

    my $path = "$volume$dir" . "Files/";

    $self->{TEMPLATE} = Template->new(
        {
            %args,
            INCLUDE_PATH => $path,
            TRIM         => 1,
        }
      )
      or die "$Template::ERROR\n";
}

sub use_text {
    my ( $self, $flag ) = @_;
    $self->{TEXT} = $flag;
}

# port_formatter     => Farly::ASA::PortFormatter->new(),
# protocol_formatter => Farly::ASA::ProtocolFormatter->new(),
# icmp_formatter     => Farly::ASA::ICMPFormatter->new(),

sub set_formatters {
    my ( $self, $formatter ) = @_;
    foreach my $key ( keys %$formatter ) {
        confess "invalid formatters"
          if ( $key !~ /port_formatter|protocol_formatter|icmp_formatter/ );
        $self->{$key} = $formatter->{$key};
    }
}

sub _value_format {
    my ( $self, $value ) = @_;

    my $string;

    if ( $value->isa('Farly::IPv4::Address') ) {

        $string = "host " . $value->as_string();
    }
    elsif ( $value->isa('Farly::Transport::Protocol') ) {

        if ( $self->_text ) {
            $string = defined($self->{protocol_formatter}) && defined( $self->{protocol_formatter}->as_string( $value->as_string() ) )
              ? $self->{protocol_formatter}->as_string( $value->as_string() )
              : $value->as_string();
        }
        else {
            $string = $value->as_string();
        }
    }
    elsif ( $value->isa('Farly::Transport::PortGT') ) {
        $string = "gt ";
        if ( $self->_text ) {
            $string .= defined($self->{port_formatter}) && defined( $self->{port_formatter}->as_string( $value->as_string() ) )
              ? $self->{port_formatter}->as_string( $value->as_string() )
              : $value->as_string();
        }
        else {
            $string .= $value->as_string();
        }
    }
    elsif ( $value->isa('Farly::Transport::PortLT') ) {
        $string = "lt ";
        if ( $self->_text ) {
            $string .= defined($self->{port_formatter}) && defined( $self->{port_formatter}->as_string( $value->as_string() ) )
              ? $self->{port_formatter}->as_string( $value->as_string() )
              : $value->as_string();
        }
        else {
            $string .= $value->as_string();
        }
    }
    elsif ( $value->isa('Farly::Transport::Port') ) {
        $string = "eq ";
        if ( $self->_text ) {
            $string .= defined($self->{port_formatter}) && defined( $self->{port_formatter}->as_string( $value->as_string() ) )
              ? $self->{port_formatter}->as_string( $value->as_string() )
              : $value->as_string();
        }
        else {
            $string .= $value->as_string();
        }
    }
    elsif ( $value->isa('Farly::Transport::PortRange') ) {

        $string = "range ";

        if ( $self->_text ) {

            $string .= defined($self->{port_formatter}) && defined( $self->{port_formatter}->as_string( $value->first() ) )
              ? $self->{port_formatter}->as_string( $value->first() )
              : $value->first();

            $string .= " ";

            $string .= defined($self->{port_formatter}) && defined( $self->{port_formatter}->as_string( $value->last() ) )
              ? $self->{port_formatter}->as_string( $value->last() )
              : $value->last();
        }
        else {
            $string .= $value->as_string();
        }
    }
    elsif ( $value->isa('Farly::Object::Ref') ) {

        $string = $value->get("ID")->as_string();
    }
    else {

        $string = $value->as_string();
        $string =~ s/0.0.0.0 0.0.0.0/any/g;
        $string =~ s/^\s+|\s+$//g;
    }

    return $string;
}

sub _format {
    my ( $self, $ce ) = @_;

    my $GROUP_REF = Farly::Object::Ref->new();
    $GROUP_REF->set( 'ENTRY', Farly::Value::String->new('GROUP') );

    my $OBJECT_REF = Farly::Object::Ref->new();
    $OBJECT_REF->set( 'ENTRY', Farly::Value::String->new('OBJECT') );

    my $IF_REF = Farly::Object::Ref->new();
    $IF_REF->set( 'ENTRY', Farly::Value::String->new('INTERFACE') );

    my $NAME = Farly::Object->new();
    $NAME->set( 'ENTRY', Farly::Value::String->new('NAME') );

    my $INTERFACE = Farly::Object->new();
    $INTERFACE->set( 'ENTRY', Farly::Value::String->new('INTERFACE') );

    my $ROUTE = Farly::Object->new();
    $ROUTE->set( 'ENTRY', Farly::Value::String->new('ROUTE') );

    my $RULE = Farly::Value::String->new('RULE');

    my $ALL           = Farly::Transport::PortRange->new('1 65535');
    my $ANY_ICMP_TYPE = Farly::IPv4::ICMPType->new(-1);

    my $hash;

    #names should not be prefixed with 'host'
    if ( $ce->matches($NAME) ) {
        foreach my $key ( $ce->get_keys() ) {
            $hash->{$key} = $ce->get($key)->as_string();
        }
        return $hash;
    }

    #interface ip addresses should not be prefixed with 'host'
    if ( $ce->matches($INTERFACE) ) {
        foreach my $key ( $ce->get_keys() ) {
            $hash->{$key} = $ce->get($key)->as_string();
        }
        return $hash;
    }

    # for routes, neither interface names nor ip addresses should be prefixed
    if ( $ce->matches($ROUTE) ) {
        foreach my $key ( $ce->get_keys() ) {
            if ( $key eq 'INTERFACE' ) {

                # use _value_format because $ce isa 'Farly::Object::Ref'
                $hash->{$key} = $self->_value_format( $ce->get($key) );
                next;
            }
            $hash->{$key} = $ce->get($key)->as_string();
        }
        return $hash;
    }

    foreach my $key ( $ce->get_keys() ) {

        my $value = $ce->get($key);

        my $prefix;
        my $string;

        # skip port range 1 - 65535
        if ( $value->equals($ALL) ) {
            next;
        }

        # skip default ICMP type '-1'
        if ( $value->equals($ANY_ICMP_TYPE) ) {
            next;
        }

        if ( $value->isa('Farly::Object::Ref') ) {

            if ( $value->matches($GROUP_REF) ) {
                if ( $ce->get('ENTRY')->equals($RULE) ) {
                    $prefix = 'object-group';
                }
            }
            elsif ( $value->matches($OBJECT_REF) ) {
                $prefix = 'object';
            }
            elsif ( $value->matches($IF_REF) ) {
                $prefix = 'interface';
            }
        }

        $string = defined($prefix)
          ? $prefix . ' ' . $self->_value_format($value)
          : $self->_value_format($value);

        if ( $self->_text && $key eq 'ICMP_TYPE' ) {

            $string = defined($self->{icmp_formatter}) && defined( $self->{icmp_formatter}->as_string( $value->as_string() ) )
              ? $self->{icmp_formatter}->as_string( $value->as_string() )
              : $value->as_string();
        }

        $hash->{$key} = $string;
    }

    return $hash;
}

sub as_string {
    my ( $self, $ce ) = @_;

    my $hash = $self->_format($ce);

    $self->_template()->process( $self->_file, $hash )
      or die $self->_template()->error();
}

1;
__END__