135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor device ports sidebar params handling

Browse Source
This commit is contained in:
Oliver Gorwits
2017-12-10 11:47:51 +00:00
parent 9e91431411
commit f8cee4cff6
6 changed files with 98 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/App/Netdisco/Web.pm
View File

@@ -85,7 +85,7 @@ hook 'before' => sub {
# new searches will use these defaults in their sidebars
my %params = %{ setting('sidebar_defaults')->{$key} };
foreach my $p (keys %params) {
params->{$p} = $params{$p} if $params{$p};
params->{$p} = $params{$p}->{'default'} if $params{$p}->{'default'};
}
};
@@ -113,7 +113,7 @@ hook 'before_template' => sub {
# linked searches will use these defaults in their sidebars
foreach my $sidebar_key (keys %{ setting('sidebar_defaults') }) {
my ($mode, $report) = ($sidebar_key =~ m/(\w+)_(\w+)/);
if ($mode =~ m/^search$/) {
if ($mode =~ m/^(?:search|device)$/) {
$tokens->{$sidebar_key} = uri_for("/$mode", {tab => $report});
}
elsif ($mode =~ m/^report$/) {
@@ -128,16 +128,18 @@ hook 'before_template' => sub {
}
else {
$tokens->{$sidebar_key}->query_param($col,
setting('sidebar_defaults')->{$sidebar_key}->{$col});
setting('sidebar_defaults')->{$sidebar_key}->{$col}->{'default'});
}
}
}
# fix Plugin Template Variables to be only path+query
$tokens->{$sidebar_key} = $tokens->{$sidebar_key}->path_query;
}
# fix Plugin Template Variables to be only path+query
$tokens->{device_ports} = $tokens->{device_ports}->path_query;
# helper from NetAddr::MAC for the MAC formatting
$tokens->{mac_format_call} = 'as_'. lc(params->{'mac_format'})
if params->{'mac_format'};
# allow very long lists of ports
$Template::Directive::WHILE_MAX = 10_000;

160
lib/App/Netdisco/Web/Device.pm
View File

@@ -7,152 +7,56 @@ use Dancer::Plugin::Auth::Extensible;
use URL::Encode 'url_params_mixed';
hook 'before' => sub {
my @default_port_columns_left = (
{ name => 'c_admin', label => 'Port Controls', default => '' },
{ name => 'c_port', label => 'Port', default => 'on' },
);
my @default_port_columns_right = (
{ name => 'c_descr', label => 'Description', default => '' },
{ name => 'c_comment', label => 'Last Comment', default => '' },
{ name => 'c_type', label => 'Type', default => '' },
{ name => 'c_duplex', label => 'Duplex', default => '' },
{ name => 'c_lastchange', label => 'Last Change', default => '' },
{ name => 'c_name', label => 'Name', default => 'on' },
{ name => 'c_speed', label => 'Speed', default => '' },
{ name => 'c_mac', label => 'Port MAC', default => '' },
{ name => 'c_mtu', label => 'MTU', default => '' },
{ name => 'c_pvid', label => 'Native VLAN', default => 'on' },
{ name => 'c_vmember', label => 'VLAN Membership', default => 'on' },
{ name => 'c_power', label => 'PoE', default => '' },
{ name => 'c_ssid', label => 'SSID', default => '' },
{ name => 'c_nodes', label => 'Connected Nodes', default => '' },
{ name => 'c_neighbors', label => 'Connected Devices', default => 'on' },
{ name => 'c_stp', label => 'Spanning Tree', default => '' },
{ name => 'c_up', label => 'Status', default => '' },
);
# build list of port detail columns
my @port_columns = ();
my @port_columns =
sort { $a->{idx} <=> $b->{idx} }
map {{ name => $_, %{ setting('sidebar_defaults')->{'device_ports'}->{$_} } }}
grep { $_ =~ m/^c_/ } keys %{ setting('sidebar_defaults')->{'device_ports'} };
push @port_columns,
grep {$_->{position} eq 'left'} @{ setting('_extra_device_port_cols') };
push @port_columns, @default_port_columns_left;
push @port_columns,
grep {$_->{position} eq 'mid'} @{ setting('_extra_device_port_cols') };
push @port_columns, @default_port_columns_right;
push @port_columns,
splice @port_columns, setting('device_port_col_idx_left'), 0,
grep {$_->{position} eq 'left'} @{ setting('_extra_device_port_cols') };
splice @port_columns, setting('device_port_col_idx_mid'), 0,
grep {$_->{position} eq 'mid'} @{ setting('_extra_device_port_cols') };
splice @port_columns, setting('device_port_col_idx_right'), 0,
grep {$_->{position} eq 'right'} @{ setting('_extra_device_port_cols') };
var('port_columns' => \@port_columns);
# view settings for port connected devices
# need to update sidebar_defaults so code scanning params sees plugin cols
setting('sidebar_defaults')->{'device_ports'}->{ $_->{name} } = $_
for @port_columns;
# build view settings for port connected nodes and devices
var('connected_properties' => [
{ name => 'n_age', label => 'Age Stamp', default => '' },
{ name => 'n_ip4', label => 'IPv4 Addresses', default => 'on' },
{ name => 'n_ip6', label => 'IPv6 Addresses', default => 'on' },
{ name => 'n_netbios', label => 'NetBIOS', default => 'on' },
{ name => 'n_ssid', label => 'SSID', default => 'on' },
{ name => 'n_vendor', label => 'Vendor', default => '' },
{ name => 'n_archived', label => 'Archived Data', default => '' },
sort { $a->{idx} <=> $b->{idx} }
map {{ name => $_, %{ setting('sidebar_defaults')->{'device_ports'}->{$_} } }}
grep { $_ =~ m/^n_/ } keys %{ setting('sidebar_defaults')->{'device_ports'} }
]);
return unless (request->path eq uri_for('/device')->path
or index(request->path, uri_for('/ajax/content/device')->path) == 0);
# override ports form defaults with cookie settings
if (param('reset')) {
cookie('nd_ports-form' => '', expires => '-1 day');
}
elsif (my $cookie = cookie('nd_ports-form')) {
my $cdata = url_params_mixed($cookie);
my $cookie = (cookie('nd_ports-form') || '');
my $cdata = url_params_mixed($cookie);
if ($cdata and ref {} eq ref $cdata and not param('reset')) {
foreach my $item (@{ var('port_columns') }) {
my $key = $item->{name};
next unless defined $cdata->{$key}
and $cdata->{$key} =~ m/^[[:alnum:]_]+$/;
$item->{default} = $cdata->{$key};
}
foreach my $item (@{ var('connected_properties') }) {
my $key = $item->{name};
next unless defined $cdata->{$key}
and $cdata->{$key} =~ m/^[[:alnum:]_]+$/;
$item->{default} = $cdata->{$key};
}
foreach my $key (qw/age_num age_unit mac_format/) {
params->{$key} ||= $cdata->{$key}
if defined $cdata->{$key}
and $cdata->{$key} =~ m/^[[:alnum:]_]+$/;
if ($cdata and (ref {} eq ref $cdata)) {
foreach my $key (keys %{ setting('sidebar_defaults')->{'device_ports'} }) {
next unless defined $cdata->{$key}
and $cdata->{$key} =~ m/^[[:alnum:]_]+$/;
setting('sidebar_defaults')->{'device_ports'}->{$key}->{'default'}
= $cdata->{$key};
}
}
}
# copy ports form defaults into request query params if this is
# a redirect from within the application (tab param is not set)
if (param('reset') or not param('tab') or param('tab') ne 'ports') {
foreach my $col (@{ var('port_columns') }) {
delete params->{$col->{name}};
params->{$col->{name}} = 'checked'
if $col->{default} eq 'on';
}
foreach my $col (@{ var('connected_properties') }) {
delete params->{$col->{name}};
params->{$col->{name}} = 'checked'
if $col->{default} eq 'on';
}
# not stored in the cookie
params->{'age_num'} ||= 3;
params->{'age_unit'} ||= 'months';
params->{'mac_format'} ||= 'IEEE';
if (param('reset')) {
params->{'age_num'} = 3;
params->{'age_unit'} = 'months';
params->{'mac_format'} = 'IEEE';
# nuke the port params cookie
cookie('nd_ports-form' => '', expires => '-1 day');
}
}
};
hook 'before_template' => sub {
my $tokens = shift;
# new searches will use these defaults in their sidebars
$tokens->{device_ports} = uri_for('/device', { tab => 'ports' });
# copy ports form defaults into helper values for building template links
foreach my $key (qw/age_num age_unit mac_format/) {
$tokens->{device_ports}->query_param($key, params->{$key});
}
$tokens->{mac_format_call} = 'as_'. lc(params->{'mac_format'})
if params->{'mac_format'};
foreach my $col (@{ var('port_columns') }) {
next unless $col->{default} eq 'on';
$tokens->{device_ports}->query_param($col->{name}, 'checked');
}
foreach my $col (@{ var('connected_properties') }) {
next unless $col->{default} eq 'on';
$tokens->{device_ports}->query_param($col->{name}, 'checked');
}
return unless (request->path eq uri_for('/device')->path
or index(request->path, uri_for('/ajax/content/device')->path) == 0);
# for templates to link to same page with modified query but same options
my $self_uri = uri_for(request->path, scalar params);
$self_uri->query_param_delete('q');
$self_uri->query_param_delete('f');
$self_uri->query_param_delete('prefer');
$tokens->{self_options} = $self_uri->query_form_hash;
params->{'firstsearch'} = 'on';
# TODO set cookie
# if (param('reset') or not param('tab') or param('tab') ne 'ports') {
};
get '/device' => require_login sub {

61
share/config.yml
View File

@@ -87,23 +87,56 @@ web_plugins:
extra_web_plugins: []
sidebar_defaults:
search_node:
stamps: checked
deviceports: checked
show_vendor: null
archived: null
partial: null
age_invert: null
daterange: null
mac_format: IEEE
stamps: {default: checked }
deviceports: {default: checked }
show_vendor: {default: null }
archived: {default: null }
partial: {default: null }
age_invert: {default: null }
daterange: {default: null }
mac_format: {default: IEEE }
search_port:
partial: null
uplink: null
ethernet: checked
partial: {default: null }
uplink: {default: null }
ethernet: {default: checked }
search_device:
matchall: checked
matchall: {default: checked }
device_ports:
c_admin: { label: 'Port Controls', default: null, idx: 0 }
c_port: { label: 'Port', default: checked, idx: 1 }
c_descr: { label: 'Description', default: null, idx: 2 }
c_comment: { label: 'Last Comment', default: null, idx: 3 }
c_type: { label: 'Type', default: null, idx: 4 }
c_duplex: { label: 'Duplex', default: null, idx: 5 }
c_lastchange: { label: 'Last Change', default: null, idx: 6 }
c_name: { label: 'Name', default: checked, idx: 7 }
c_speed: { label: 'Speed', default: null, idx: 8 }
c_mac: { label: 'Port MAC', default: null, idx: 9 }
c_mtu: { label: 'MTU', default: null, idx: 10 }
c_pvid: { label: 'Native VLAN', default: checked, idx: 11 }
c_vmember: { label: 'VLAN Membership', default: checked, idx: 12 }
c_power: { label: 'PoE', default: null, idx: 13 }
c_ssid: { label: 'SSID', default: null, idx: 14 }
c_nodes: { label: 'Connected Nodes', default: null, idx: 15 }
c_neighbors: { label: 'Connected Devices', default: checked, idx: 16 }
c_stp: { label: 'Spanning Tree', default: null, idx: 17 }
c_up: { label: 'Status', default: null, idx: 18 }
n_age: { label: 'Age Stamp', default: null, idx: 0 }
n_ip4: { label: 'IPv4 Addresses', default: checked, idx: 1 }
n_ip6: { label: 'IPv6 Addresses', default: checked, idx: 2 }
n_netbios: { label: 'NetBIOS Name', default: checked, idx: 3 }
n_ssid: { label: 'SSID', default: checked, idx: 4 }
n_vendor: { label: 'Vendor', default: null, idx: 5 }
n_archived: { label: 'Archived Data', default: null, idx: 6 }
age_num: { default: 3 }
age_unit: { default: months }
mac_format: { default: IEEE }
report_moduleinventory:
fruonly: checked
matchall: checked
fruonly: {default: checked }
matchall: {default: checked }
device_port_col_idx_left: 0
device_port_col_idx_mid: 2
device_port_col_idx_right: -1
jobqueue_refresh: 10
safe_password_store: true
reports: []

10
share/views/ajax/device/ports.tt
View File

@@ -96,15 +96,13 @@
</span>
[% END %]
[% END %]
<a class="nd_this-port-only nd_port-only-first" href="[% uri_for('/device',
self_options) %]&q=[% params.q | uri %]&f=[% row.port | uri %]&prefer=port">
<a class="nd_this-port-only nd_port-only-first" href="[% device_ports %]&q=[% params.q | uri %]&f=[% row.port | uri %]&prefer=port">
[% IF row.is_master %]
<small><i class="icon-group muted"></i></small>&nbsp;
[% END %]
[% row.port | html_entity %]</a>
[% IF row.slave_of %]<br/>
<a class="nd_this-port-only" href="[% uri_for('/device',
self_options) %]&q=[% params.q | uri %]&f=[% row.slave_of | uri %]&prefer=port">
<a class="nd_this-port-only" href="[% device_ports %]&q=[% params.q | uri %]&f=[% row.slave_of | uri %]&prefer=port">
[% row.slave_of | html_entity %]</a>
[% END %]
</td>
@@ -268,11 +266,11 @@
[% ELSIF row.remote_type AND row.remote_type.match('^AP:\s') %]
<i class="icon-signal"></i>&nbsp;
[% END %]
<a href="[% uri_for('/device', self_options) %]&q=[% row.get_column('neighbor_ip') | uri %]">
<a href="[% device_ports %]&q=[% row.get_column('neighbor_ip') | uri %]">
[% row.get_column('neighbor_dns').remove(settings.domain_suffix) || row.get_column('neighbor_ip') | html_entity %]</a>
[% IF row.remote_port %]
-
<a href="[% uri_for('/device', self_options) %]&q=[% row.get_column('neighbor_ip') | uri %]&f=[% row.remote_port | uri %]&prefer=port">
<a href="[% device_ports %]&q=[% row.get_column('neighbor_ip') | uri %]&f=[% row.remote_port | uri %]&prefer=port">
[% row.remote_port | html_entity %]</a>
[% END %]
<br/>

14
share/views/js/common.js
View File

@@ -94,13 +94,13 @@
[% IF tab.tag == 'ports' %]
// to be fair I can't remember why we do this in JS and not from the app
// perhaps because selecting form fields to go in the cookie is easier?
var cookie = $('#ports_form').find('input,select')
.not('#nd_port-query,input[name="q"],input[name="tab"]')
.serializeArray();
$('#ports_form').find('input[type="checkbox"]').map(function() {
cookie.push({'name': 'columns', 'value': $(this).attr('name')});
});
$.cookie('nd_ports-form', $.param(cookie) ,{ expires: 365 });
// var cookie = $('#ports_form').find('input,select')
// .not('#nd_port-query,input[name="q"],input[name="tab"]')
// .serializeArray();
// $('#ports_form').find('input[type="checkbox"]').map(function() {
// cookie.push({'name': 'columns', 'value': $(this).attr('name')});
// });
// $.cookie('nd_ports-form', $.param(cookie) ,{ expires: 365 });
// form reset icon on ports tab
$('#nd_sidebar-reset-link').attr('href', uri_base + '/device?tab=[% tab.tag %]&reset=on&' +

2
share/views/layouts/main.tt
View File

@@ -15,7 +15,7 @@
<!-- <script type="text/javascript" src="http://code.jquery.com/jquery-migrate-1.1.1.js"></script> -->
<script type="text/javascript" src="[% uri_base %]/javascripts/jquery-ui.custom.min.js"></script>
<script type="text/javascript" src="[% uri_base %]/javascripts/jquery-history.js"></script>
<script type="text/javascript" src="[% uri_base %]/javascripts/jquery.cookie.js"></script>
<!-- <script type="text/javascript" src="[% uri_base %]/javascripts/jquery.cookie.js"></script> -->
<script type="text/javascript" src="[% uri_base %]/javascripts/jquery-deserialize.js"></script>
<script type="text/javascript" src="[% uri_base %]/javascripts/bootstrap.min.js"></script>
<script type="text/javascript" src="[% uri_base %]/javascripts/underscore.min.js"></script>