File Coverage

lib/Wireguard/WGmeta/Wrapper/Show.pm

Criterion	Covered	Total	%
statement	23	62	37.1
branch	0	4	0.0
condition			n/a
subroutine	8	14	57.1
pod	4	6	66.6
total	35	86	40.7

=pod

=head1 NAME

WGmeta::Wrapper::Show - Class for interfacing `wg show dump` output

=head1 SYNOPSIS

 use Wireguard::WGmeta::Wrapper::Show;
 my $wg_show = Wireguard::WGmeta::Wrapper::Show->new();

=head1 DESCRIPTION

This class provides wrapper-functions around the output of L.

=head1 EXAMPLES

 use Wireguard::WGmeta::Wrapper::Show;
 use Wireguard::WGmeta::Wrapper::Bridge;

 my ($out, $err) = get_wg_show();
 my $wg_show = Wireguard::WGmeta::Wrapper::Show->new($out);

 # get a specific interface section
 wg_show->get_interface_section('wg0', '');

=head1 METHODS

=cut
use v5.20.0;
package Wireguard::WGmeta::Wrapper::Show;
use strict;
use warnings FATAL => 'all';
use experimental 'signatures';


our $VERSION = "0.3.4";

use constant FALSE => 0;
use constant TRUE => 1;
use Wireguard::WGmeta::Utils;
use Wireguard::WGmeta::Parser::Show;

=head3 new($wg_show_dump)

Creates a new instance of the show parser

B

=over 1

=item

C<$wg_show_dump> Output of the (external) command C.

=back

B

Instance

=cut
sub new($class, $wg_show_dump) {
    my $self = {
        'parsed_show' => wg_show_dump_parser($wg_show_dump)
    };

    bless $self, $class;

    return $self;
}

sub reload($self, $wg_show_dump){
    $self->{parsed_show} = wg_show_dump_parser($wg_show_dump);
}

=head3 get_interface_list()

Returns a list with all available interface names

B

B

A list with valid interface names.

=cut
sub get_interface_list($self) {
    return sort keys %{$self->{parsed_show}};
}

=head3 iface_exists($interface)

Simply checks if data is available for a specific interface. Useful to check if an interface is up.

B

=over 1

=item

C<$interface> An interface name

=back

B

If yes, returns True else False

=cut
sub iface_exists($self, $interface) {
    return exists $self->{parsed_show}{$interface};
}

=head3 get_interface_section($interface, $identifier)

Returns a specific section of an interface

B

=over 1

=item

C<$interface> A valid interface name, ideally retrieved through L.

=item

C<$identifier> A valid identifier, if the requested section is a peer this is its public-key, otherwise the interface
name again.

=back

B

A hash of the requested section. If non-existent, empty hash.

=cut
sub get_interface_section($self, $interface, $identifier) {
    if (exists($self->{parsed_show}{$interface}{$identifier})) {
        return %{$self->{parsed_show}{$interface}{$identifier}};
    }
    else {
        return ();
    }
}
=head3 get_section_list($interface)

Returns a sorted list of all peers belonging to given interface

B

=over 1

=item

C<$interface> A valid interface name, ideally retrieved through L.

=back

B

A list of peer public-keys (identifiers), if the interface does not exist -> empty list.

=cut
sub get_section_list($self, $interface) {
    if (exists($self->{parsed_show}{$interface})) {
        return sort keys %{$self->{parsed_show}{$interface}};
    }
    else {
        return {};
    }
}

1;