File Coverage

blib/lib/BigIP/LTM/ParseConfig.pm

Criterion	Covered	Total	%
statement	6	273	2.2
branch	0	144	0.0
condition	0	68	0.0
subroutine	2	43	4.6
pod	20	37	54.0
total	28	565	4.9

package BigIP::LTM::ParseConfig;

use strict;
use warnings;
#no warnings qw 'uninitialized';
our $VERSION = '0.8.4';

# CURRENTLY UNDER DEVELOMENT BY WENWU YAN
#----------------------------------------------------------------------------
# The contents of this file are subject to the iControl Public License
# Version 4.5 (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.f5.com/.
#
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
# the License for the specific language governing rights and limitations
# under the License.
#
# The Original Code is iControl Code and related documentation
# distributed by F5.
#
# The Initial Developer of the Original Code is F5 Networks,
# Inc. Seattle, WA, USA. Portions created by F5 are Copyright (C) 1996-2020 F5 Networks,
# Inc. All Rights Reserved.  iControl (TM) is a registered trademark of F5 Networks, Inc.
#
# Alternatively, the contents of this file may be used under the terms
# of the GNU General Public License (the "GPL"), in which case the
# provisions of GPL are applicable instead of those above.  If you wish
# to allow use of your version of this file only under the terms of the
# GPL and not to allow others to use your version of this file under the
# License, indicate your decision by deleting the provisions above and
# replace them with the notice and other provisions required by the GPL.
# If you do not delete the provisions above, a recipient may use your
# version of this file under either the License or the GPL.
#----------------------------------------------------------------------------

#----------------------------------------------------------------------------
# Initialize the module
#----------------------------------------------------------------------------
sub new {
    my $class = shift;

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

    $self->{'ConfigFile'} = shift;

    return $self;
}

#----------------------------------------------------------------------------
# Return a list of objects for ltm
#----------------------------------------------------------------------------
sub virtuals   { return shift->_objectlist('ltm virtual')}
sub pools      { return shift->_objectlist('ltm pool') }
sub rules      { return shift->_objectlist('ltm rule') }
sub nodes      { return shift->_objectlist('ltm node') }
sub monitors   { return shift->_objectlist('ltm monitor') }
sub profiles   { return shift->_objectlist('ltm profile') }
sub persistences   { return shift->_objectlist('ltm persistence') }

#----------------------------------------------------------------------------
# Return a list of objects for net
#----------------------------------------------------------------------------
sub selfs      { return shift->_objectlist('net self') }
sub vlans      { return shift->_objectlist('net vlan') }
sub routes     { return shift->_objectlist('net route') }
sub trunks     { return shift->_objectlist('net trunk') }
sub interfaces { return shift->_objectlist('net interface') }

#----------------------------------------------------------------------------
# Return a list of objects for others
#----------------------------------------------------------------------------
sub users      { return shift->_objectlist('auth user') }


#----------------------------------------------------------------------------
# Return an object hash for ltm
#----------------------------------------------------------------------------
sub virtual    { return shift->_object( 'ltm virtual',   shift ) }
sub pool       { return shift->_object( 'ltm pool',      shift ) }
sub rule       { return shift->_object( 'ltm rule',      shift ) }
sub node       { return shift->_object( 'ltm node',      shift ) }
sub profile    { return shift->_object( 'ltm profile',   shift ) }
sub monitor    { return shift->_object( 'ltm monitor',   shift ) }
sub persistence    { return shift->_object( 'ltm persistence',   shift ) }

# Return an object hash for net
sub self       { return shift->_object( "net self", shift ); }
sub vlan       { return shift->_object( "net vlan", shift ); }
sub trunk      { return shift->_object( "net trunk", shift ); }
sub interface  { return shift->_object( "net interface", shift ); }
sub route      { return shift->_object( "net route", shift ); }

# Return an object hash for sys
sub ntp       { return shift->_object( "sys", "ntp" );}
sub sshd      { return shift->_object( "sys", "sshd" ); }
sub snmp      { return shift->_object( "sys", "snmp" ); }
sub syslog    { return shift->_object( "sys", "syslog" ); }
sub state_mirror { return shift->_object( "sys", "state-mirroring" ); }

# Return an object hash for others
sub user      { return shift->_object( 'auth user',          shift ); }

#----------------------------------------------------------------------------
# Return a list of pool members
#----------------------------------------------------------------------------
sub members {
    my $self = shift;
    my $pool = shift;

    $self->{'Parsed'} ||= $self->_parse();

    return 0 unless $self->{'Parsed'}->{'ltm pool'}->{$pool}->{'members'};

    if ( ref $self->{'Parsed'}->{'ltm pool'}->{$pool}->{'members'} eq 'HASH' ) {
        return keys %{$self->{'Parsed'}->{'pool'}->{$pool}->{'members'}};
    }
    else {
        return $self->{'Parsed'}->{'ltm pool'}->{$pool}->{'members'};
    }
}

#----------------------------------------------------------------------------
# Return hashs of virtual servers
#----------------------------------------------------------------------------
sub virtuals_all {
    my $self = shift;
    my @virtuals = $self->virtuals();

    foreach (@virtuals) {
        my $virtual = $self->virtual($_);
        my $pool = $virtual->{pool} if exists $virtual->{pool};
        my @persist = keys %{$virtual->{persist}} if exists $virtual->{persist} ;
        $virtual->{"pool_details"} = $self->pool($pool) if $pool;
        $virtual->{"persist_mode"} = $self->persistence($persist[0])->{"mode"} if $persist[0];
    }

    return $self->{Parsed}{"ltm virtual"};
}

#----------------------------------------------------------------------------
# Return details of virtual server
#----------------------------------------------------------------------------
sub virtual_detail {
    my $self = shift;
    my $server = shift;
    my @virtuals = $self->virtuals();

    foreach (@virtuals) {
        my $virtual = $self->virtual($_);
        my $pool = $virtual->{pool} if exists $virtual->{pool};
        my @persist = keys %{$virtual->{persist}} if exists $virtual->{persist};
        $virtual->{"pool_details"} = $self->pool($pool) if $pool;
        $virtual->{"persist_mode"} = $self->persistence($persist[0])->{"mode"} if $persist[0];
    }

    return $self->{Parsed}{"ltm virtual"}{$server};
}

# Modify an object
sub modify {
    my $self = shift;
    my ($arg);
    %{$arg} = @_;

    return 0 unless $arg->{'type'} && $arg->{'key'};

    my $obj = $arg->{'type'};
    my $key = $arg->{'key'};
    delete $arg->{'type'};
    delete $arg->{'key'};

    $self->{'Parsed'} ||= $self->_parse();

    return 0 unless $self->{'Parsed'}->{$obj}->{$key};

    foreach my $attr ( keys %{$arg} ) {
        next unless $self->{'Parsed'}->{$obj}->{$key}->{$attr};
        $self->{'Modify'}->{$obj}->{$key}->{$attr} = $arg->{$attr};
    }

    return 1;
}

# Write out a new configuration file
sub write {
    my $self = shift;
    my $file = shift || $self->{'ConfigFile'};

    die "No changes found; no write necessary" unless $self->{'Modify'};

    foreach my $obj (
        qw( self partition route user monitor auth profile node pool rule virtual )
        )
    {
        foreach my $key ( sort keys %{ $self->{'Parsed'}->{$obj} } ) {
            if ( $self->{'Modify'}->{$obj}->{$key} ) {
                $self->{'Output'} .= "$obj $key {\n";
                foreach my $attr ( $self->_order($obj) ) {
                    next unless $self->{'Parsed'}->{$obj}->{$key}->{$attr};
                    $self->{'Modify'}->{$obj}->{$key}->{$attr}
                        ||= $self->{'Parsed'}->{$obj}->{$key}->{$attr};
                    if (ref $self->{'Modify'}->{$obj}->{$key}->{$attr} eq
                        'ARRAY' )
                    {
                        if ( @{ $self->{'Modify'}->{$obj}->{$key}->{$attr} }
                            > 1 )
                        {
                            $self->{'Output'} .= "   $attr\n";
                            foreach my $val (
                                @{  $self->{'Modify'}->{$obj}->{$key}->{$attr}
                                }
                                )
                            {
                                $self->{'Output'} .= "      $val\n";
                                if ( $self->{'Parsed'}->{$obj}->{$key}
                                    ->{'_xtra'}->{$val} )
                                {
                                    $self->{'Output'}
                                        .= '         '
                                        . $self->{'Parsed'}->{$obj}->{$key}
                                        ->{'_xtra'}->{$val} . "\n";
                                }
                            }
                        }
                        else {
                            $self->{'Output'}
                                .= "   $attr "
                                . $self->{'Modify'}->{$obj}->{$key}
                                ->{$attr}[0] . "\n";
                        }
                    }
                    else {
                        $self->{'Output'}
                            .= "   $attr "
                            . $self->{'Modify'}->{$obj}->{$key}->{$attr}
                            . "\n";
                    }
                }
                $self->{'Output'} .= "}\n";
            }
            else {
                $self->{'Output'} .= $self->{'Raw'}->{$obj}->{$key};
            }
        }
    }

    open FILE, ">$file" || return 0;
    print FILE $self->{'Output'};
    close FILE;

    return 1;
}

#----------------------------------------------------------------------------
# Return an object hash
#----------------------------------------------------------------------------
sub _object {
    my $self = shift;
    my $obj  = shift;
    my $var  = shift;

    $self->{'Parsed'} ||= $self->_parse();

    return $self->{'Parsed'}->{$obj}->{$var} || 0;
}

#----------------------------------------------------------------------------
# Return a list of objects
#----------------------------------------------------------------------------
sub _objectlist {
    my $self = shift;
    my $obj  = shift;

    $self->{'Parsed'} ||= $self->_parse();

    if ( $self->{'Parsed'}->{$obj} ) {
        return keys %{ $self->{'Parsed'}->{$obj} };
    }
    else {
        return 0;
    }
}

#----------------------------------------------------------------------------
# Define object attribute ordering
#----------------------------------------------------------------------------
sub _order {
    my $self = shift;

    for (shift) {
        /auth/ && return qw( bind login search servers service ssl user );
        /ltm monitor/
            && return
            qw( default base debug filter mandatoryattrs password security username interval timeout manual dest recv send );
        /ltm node/      && return qw( monitor screen );
        /partition/ && return qw( description );
        /ltm pool/      && return qw( lb nat monitor members );
        /net self/      && return qw( netmask unit floating vlan allow );
        /auth user/ && return qw( password description id group home shell role );
        /ltm virtual/
            && return
            qw( translate snat pool destination ip rules profiles persist );

        return 0;
    }
}

#----------------------------------------------------------------------------
# Parse the configuration file
#----------------------------------------------------------------------------
sub _parse {
    my $self = shift;
    my $file = shift || $self->{'ConfigFile'};

    die "File not found: $self->{'ConfigFile'}\n"
        unless -e $self->{'ConfigFile'};

    open FILE, $file || return 0;
    my @file = ;
    close FILE;

    my ( $parsed, $obj, $key, $attr1, $attr2, $attr3 );

    until ( !$file[0] ) {
        my $ln = shift @file;

        #user attribute
        if ( $ln=~ /^(auth user)\s(.*)\s\{(\s\})?$/) {
            next if $3;
            $obj = $1;
            $key = $2;
        }
        #ltm attribute
        elsif ( $ln =~ /^(ltm virtual|ltm pool|ltm node|ltm rule)\s(.*)\s\{(\s\})?$/ ) {
            next if $3;
            $obj = $1;
            $key = $2;
        }
        #net attribute
        elsif ( $ln =~ /^(net self|net route|net interface|net vlan|net trunk)\s(.*)\s\{(\s\})?$/ ) {
            next if $3;
            $obj = $1;
            $key = $2;
        }
        #sys attribute
        elsif ($ln =~ /^(sys)\s(sshd|syslog|ntp|snmp|state-mirroring)\s\{(\s\})?$/) {
            next if $3;
            $obj = $1;
            $key = $2;
        }
        #persistence attribute
        elsif ($ln =~ /^((ltm persistence)\s(cookie|source-addr|universal|destination-addr))\s(\S+)\s\{(\s\})?$/) {
            next if $5;
            $obj = $2;
            $key = $4;
            $parsed->{$obj}{$key}{"mode"} = $3;
        }
        #monitor attribute
        elsif ($ln =~ /^((ltm monitor)\s(http|tcp|udp|icmp))\s(\S+)\s\{(\s\})?$/) {
            next if $5;
            $obj = $2;
            $key = $4;
            $parsed->{$obj}{$key}{"mode"} = $3;
        }
        #profile attribute
        elsif ($ln =~ /^((ltm profile)\s(web-acceleration|tcp|udp|request-log))\s(\S+)\s\{(\s\})?$/) {
            next if $5;
            $obj = $2;
            $key = $4;
            $parsed->{$obj}{$key}{"mode"} = $3;
        }
        #end of {}
        elsif ( $ln =~ /^\}$/ ) {
            $obj = undef;
            $key = undef;
            next;
        }

        # mungle data structure
        if ( $obj && $key ) {
            $self->{'Raw'}->{$obj}{$key} .= $ln;

            #Indent=4 { not empty }
            if ( $ln =~ /^\s{4}(\S+)\s\{$/ ) {
                $attr1 = $1;
                next;
            }

            #$intdent=8 { not empty }
            if ( $ln =~ /^\s{8}(\S+)\s\{$/ ) {
                $attr2 = $1;
                next;
            }

            #$intdent=12 { not empty }
            if ( $ln =~ /^\s{8}(\S+)\s\{$/ ) {
                $attr3 = $1;
                next;
            }

            #Indent=4 with }$
            if ( $ln =~ /^\s{4}\}$/ ) {
                $attr1 = undef;
                next;
            }

            #Indent=8 with }$
            if ( $ln =~ /^\s{8}\}$/ ) {
                $attr2 = undef;
                next;
            }

            #Indent=12 with }$
            if ( $ln =~ /^\s{12}\}$/ ) {
                $attr2 = undef;
                next;
            }

            #Indent=4 {}
            if ( $ln =~ /^\s{4}(\S+)\s\{\s\}$/ ) {
                $parsed->{$obj}{$key}{$1} = undef;
                next;
            }

            #Indent=4 { scalar }
            if ( $ln =~ /^\s{4}(\S+)\s\{(.*)\}$/ ) {
                $parsed->{$obj}{$key}{$1} ||= [];
                push @{ $parsed->{$obj}{$key}{$1} },
                    grep { not /^\s*$/ } split( /\s+/, $2 );
                next;
            }

            if ( defined $attr1 && $attr1 ) {
                #Indent=8 {}
                if ( $ln =~ /^\s{8}(\S+)\s\{\s\}$/ ) {
                    $parsed->{$obj}{$key}{$attr1}{$1} = undef;
                    next;
                }

                #Indent=8 { scalar }
                if ( $ln =~ /^\s{8}(\S+)\s\{(.*)\}$/ ) {
                    $parsed->{$obj}{$key}{$1} ||= [];
                    push @{ $parsed->{$obj}{$key}{$1} },
                        grep { not /^\s*$/ } split( /\s+/, $2 );
                    next;
                }

                #Indent=8 match { key => value }
                if ( $ln =~ /^\s{8}(\S+)\s(.*)$/ ) {
                    $parsed->{$obj}{$key}{$attr1}{$1} = $2;
                    next;
                }

                #Indent=8 match scalar
                if ( $ln =~ /^\s{8}(\S.+)$/ ) {
                    if ( ref( $parsed->{$obj}{$key}{$attr1} ) eq 'HASH' ) {
                        $parsed->{$obj}{$key}{$attr1}{$1} = undef;
                    }
                    else {
                        $parsed->{$obj}{$key}{$attr1} ||= [];
                        push @{ $parsed->{$obj}{$key}{$attr1} }, $1;
                    }
                    next;
                }
            }

            if (defined $attr2 && ($attr1 && $attr2)) {
                #Indent=12 match { }
                if ( $ln =~ /^\s{12}(\S+)\s\{\s\}$/ ) {
                    $parsed->{$obj}{$key}{$attr1}{$attr2}{$1} = undef;
                    next;
                }

                #Indent=12 { scalar }
                if ( $ln =~ /^\s{12}(\S+)\s\{(.*)\}$/ ) {
                    $parsed->{$obj}{$key}{$attr1} ||= [];
                    push @{ $parsed->{$obj}{$key}{$attr1}{$attr2}{$1} },
                         grep { not /^\s*$/ } split(/\s+/, $2);
                    next;
                }

                #Indent=12 match { key => value }
                if ( $ln =~ /^\s{12}(\S+)\s(.*)\s?$/ ) {
                    $parsed->{$obj}->{$key}{$attr1}{$attr2}{$1} = $2;
                    next;
                }

                #Indent=12 match scalar
                if ( $ln =~ /^\s{12}(.*)\s?$/ ) {
                    if ( ref($parsed->{$obj}{$key}{$attr1}{$attr2}) eq 'HASH' ) {
                        $parsed->{$obj}{$key}{$attr1}{$attr2}{$1} = undef;
                    }
                    else {
                        $parsed->{$obj}{$key}{$attr1}{$attr2} ||= [];
                        push @{ $parsed->{$obj}{$key}{$attr1}{$attr2} }, $1;
                    }
                    next;
                }
            }

            if (defined $attr3 && ($attr1 && $attr2 && $attr3)) {
                #Indent=16 match { }
                if ( $ln =~ /^\s{16}(\S+)\s\{\s\}$/ ) {
                    $parsed->{$obj}{$key}{$attr1}{$attr2}{$attr3}{$1} = undef;
                    next;
                }

                #Indent=16 { scalar }
                if ( $ln =~ /^\s{16}(\S+)\s\{(.*)\}$/ ) {
                    $parsed->{$obj}{$key}{$attr1} ||= [];
                    push @{ $parsed->{$obj}{$key}{$attr1}{$attr2}{$attr3}{$1} },
                         grep { not /^\s*$/ } split(/\s+/, $2);
                    next;
                }

                #Indent=16 match { key => value }
                if ( $ln =~ /^\s{16}(\S+)\s(.*)\s?$/ ) {
                    $parsed->{$obj}->{$key}{$attr1}{$attr2}{$attr3}{$1} = $2;
                    next;
                }

                #Indent=16 match scalar
                if ( $ln =~ /^\s{16}(.*)\s?$/ ) {
                    if ( ref($parsed->{$obj}{$key}{$attr1}{$attr2}{$attr3}) eq 'HASH' ) {
                        $parsed->{$obj}{$key}{$attr1}{$attr2}{$attr3}{$1} = undef;
                    }
                    else {
                        $parsed->{$obj}{$key}{$attr1}{$attr2} ||= [];
                        push @{ $parsed->{$obj}{$key}{$attr1}{$attr2}{$attr3} }, $1;
                    }
                    next;
                }
            }

            #Indent=4 match { key => value }
            if ( $ln =~ /^\s{4}(\S+)\s(.*)$/ ) {
                $parsed->{$obj}{$key}{$1} = $2;
                next;
            }
        }
    }

    # Fill in ill-formatted objects
    foreach my $object ( keys %{ $self->{'Raw'} } ) {
        foreach my $attr ( keys %{ $self->{'Raw'}->{$object} } ) {
            $parsed->{$object}->{$attr} ||= $self->{'Raw'}->{$object}->{$attr};
        }
    }

    return $parsed;
}

1;

__END__