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

change from settings to vars for tracking param defaults

Browse Source
This commit is contained in:
Oliver Gorwits
2017-12-11 23:51:01 +00:00
parent f6c985bd60
commit 45a0a75d96
11 changed files with 84 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -11,8 +11,6 @@ use HTML::Entities (); # to ensure dependency is met
use URI::QueryParam (); # part of URI, to add helper methods
use Path::Class 'dir';
use Module::Load ();
use Storable 'dclone';
use Scope::Guard 'guard';
use App::Netdisco::Util::Web 'interval_to_daterange';
use App::Netdisco::Web::AuthN;
@@ -73,24 +71,51 @@ Dancer::Session::Cookie::init(session);
# workaround for https://github.com/PerlDancer/Dancer/issues/935
hook after_error_render => sub { setting('layout' => 'main') };
# build list of port detail 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'} };
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') };
set('port_columns' => \@port_columns);
# update sidebar_defaults so hooks scanning params see new plugin cols
setting('sidebar_defaults')->{'device_ports'}->{ $_->{name} } = $_
for @port_columns;
}
hook 'before' => sub {
my $key = request->path;
if (param('tab') and ($key !~ m/ajax/)) {
$key .= ('/' . param('tab'));
}
$key =~ s|.*/(\w+)/(\w+)$|${1}_${2}|;
vars->{'sidebar_key'} = $key;
var(sidebar_key => $key);
# search or report from navbar can ignore params
# copy sidebar defaults into vars so we can mess about with it
foreach my $sidebar (keys %{setting('sidebar_defaults')}) {
vars->{'sidebar_defaults'}->{$sidebar} = { map {
($_ => setting('sidebar_defaults')->{$sidebar}->{$_}->{'default'})
} keys %{setting('sidebar_defaults')->{$sidebar}} };
}
};
hook 'before_template' => sub {
# search or report from navbar, or reset of sidebar, can ignore params
return if param('firstsearch');
my $defaults = dclone (setting('sidebar_defaults')->{$key} or return);
push @{ vars->{'guards'} },
guard { setting('sidebar_defaults')->{$key} = $defaults };
# otherwise update defaults to contain the passed url params
setting('sidebar_defaults')->{$key}->{$_}->{'default'} = param($_)
for keys %{ $defaults };
# update defaults to contain the passed url params
# (this follows initial copy from config.yml, then cookie restore)
var('sidebar_defaults')->{var('sidebar_key')}->{$_} = param($_)
for keys %{ var('sidebar_defaults')->{var('sidebar_key')} || {} };
};
# this hook should be loaded _after_ all plugins
@@ -114,8 +139,12 @@ hook 'before_template' => sub {
$tokens->{table_showrecordsmenu} =
to_json( setting('table_showrecordsmenu') );
# linked searches will use these defaults in their sidebars
foreach my $sidebar_key (keys %{ setting('sidebar_defaults') }) {
# defaults for the current sidebar form fields
$tokens->{sidebar_defaults} =
var('sidebar_defaults')->{var('sidebar_key')};
# linked searches will use these default url path params
foreach my $sidebar_key (keys %{ var('sidebar_defaults') }) {
my ($mode, $report) = ($sidebar_key =~ m/(\w+)_(\w+)/);
if ($mode =~ m/^(?:search|device)$/) {
$tokens->{$sidebar_key} = uri_for("/$mode", {tab => $report});
@@ -124,15 +153,9 @@ hook 'before_template' => sub {
$tokens->{$sidebar_key} = uri_for("/$mode/$report");
}
if (defined setting('sidebar_defaults')->{$sidebar_key}) {
foreach my $col (keys %{ setting('sidebar_defaults')->{$sidebar_key} }) {
$tokens->{$sidebar_key}->query_param($col,
setting('sidebar_defaults')->{$sidebar_key}->{$col}->{'default'});
# used by the sidebar templates when first rendering
$tokens->{"${sidebar_key}_defaults"}->{$col}
= setting('sidebar_defaults')->{$sidebar_key}->{$col}->{'default'};
}
foreach my $col (keys %{ var('sidebar_defaults')->{$sidebar_key} }) {
$tokens->{$sidebar_key}->query_param($col,
var('sidebar_defaults')->{$sidebar_key}->{$col});
}
# fix Plugin Template Variables to be only path+query

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

@@ -6,65 +6,38 @@ use Dancer::Plugin::DBIC;
use Dancer::Plugin::Auth::Extensible;
use URI ();
use Storable 'dclone';
use Scope::Guard 'guard';
use URL::Encode 'url_params_mixed';
hook 'before' => sub {
# build list of port detail 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'} };
# this could be done at app startup?
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') };
# update sidebar_defaults so code scanning params sees new plugin cols
setting('sidebar_defaults')->{'device_ports'}->{ $_->{name} } = $_
for @port_columns;
var('port_columns' => \@port_columns);
# build view settings for port connected nodes and devices
var('connected_properties' => [
sort { $a->{idx} <=> $b->{idx} }
map {{ name => $_, %{ setting('sidebar_defaults')->{'device_ports'}->{$_} } }}
grep { $_ =~ m/^n_/ } keys %{ setting('sidebar_defaults')->{'device_ports'} }
]);
# build view settings for port connected nodes and devices
set('connected_properties' => [
sort { $a->{idx} <=> $b->{idx} }
map {{ name => $_, %{ setting('sidebar_defaults')->{'device_ports'}->{$_} } }}
grep { $_ =~ m/^n_/ } keys %{ setting('sidebar_defaults')->{'device_ports'} }
]);
hook 'before_template' => sub {
# override ports form defaults with cookie settings
# always do this so that embedded links to device ports page have user prefs
if (param('reset')) {
cookie('nd_ports-form' => '', expires => '-1 day');
}
elsif (my $cookie = cookie('nd_ports-form')) {
my $cdata = url_params_mixed($cookie);
my $defaults = eval { dclone setting('sidebar_defaults')->{'device_ports'} };
my $defaults = var('sidebar_defaults')->{'device_ports'};
if ($cdata and (ref {} eq ref $cdata) and $defaults) {
push @{ vars->{'guards'} },
guard { setting('sidebar_defaults')->{'device_ports'} = $defaults };
foreach my $key (keys %{ $defaults }) {
setting('sidebar_defaults')->{'device_ports'}->{$key}->{'default'}
= $cdata->{$key};
$defaults->{$key} = $cdata->{$key};
}
}
}
};
hook 'before_template' => sub {
return if param('reset')
or not var('sidebar_key') or (var('sidebar_key') ne 'device_ports');
# update cookie from params we just recieved in form submit
my $uri = URI->new();
foreach my $key (keys %{ setting('sidebar_defaults')->{'device_ports'} }) {
foreach my $key (keys %{ var('sidebar_defaults')->{'device_ports'} }) {
$uri->query_param($key => param($key)) if exists params->{$key};
}
cookie('nd_ports-form' => $uri->query(), expires => '365 days');

5
lib/App/Netdisco/Worker/Plugin.pm
View File

@@ -6,6 +6,7 @@ use Dancer::Plugin;
use App::Netdisco::Util::Permission qw/check_acl_no check_acl_only/;
use aliased 'App::Netdisco::Worker::Status';
use Scope::Guard 'guard';
use Storable 'dclone';
register 'register_worker' => sub {
my ($self, $first, $second) = plugin_args(@_);
@@ -47,7 +48,7 @@ register 'register_worker' => sub {
}
my @newuserconf = ();
my @userconf = @{ setting('device_auth') || [] };
my @userconf = @{ dclone (setting('device_auth') || []) };
# worker might be vendor/platform specific
if (ref $job->device) {
@@ -67,7 +68,7 @@ register 'register_worker' => sub {
next if exists $stanza->{action}
and not _find_matchaction($workerconf, lc($stanza->{action}));
push @newuserconf, $stanza;
push @newuserconf, dclone $stanza;
}
# per-device action but no device creds available

5
lib/App/Netdisco/Worker/Runner.pm
View File

@@ -8,6 +8,7 @@ use aliased 'App::Netdisco::Worker::Status';
use Try::Tiny;
use Module::Load ();
use Scope::Guard 'guard';
use Storable 'dclone';
use Moo::Role;
use namespace::clean;
@@ -31,7 +32,7 @@ sub run {
my $statusguard = guard { $job->finalise_status };
my @newuserconf = ();
my @userconf = @{ setting('device_auth') || [] };
my @userconf = @{ dclone (setting('device_auth') || []) };
# reduce device_auth by only/no
if (ref $job->device) {
@@ -42,7 +43,7 @@ sub run {
next if $no and check_acl_no($job->device, $no);
next if $only and not check_acl_only($job->device, $only);
push @newuserconf, $stanza;
push @newuserconf, dclone $stanza;
}
# per-device action but no device creds available

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

@@ -3,7 +3,7 @@
<thead>
<tr>
<th></th>
[% FOREACH item IN vars.port_columns %]
[% FOREACH item IN settings.port_columns %]
[% NEXT IF item.name == 'c_admin' %]
[% NEXT IF item.name == 'c_nodes' AND params.c_nodes AND params.c_neighbors %]
[% NEXT UNLESS params.${item.name} %]

2
share/views/ajax/device/ports_csv.tt
View File

@@ -2,7 +2,7 @@
[% SET headers = [] %]
[% SET c_nodes_pos = -1 %]
[% FOREACH item IN vars.port_columns %]
[% FOREACH item IN settings.port_columns %]
[% NEXT IF item.name == 'c_admin' %]
[% NEXT UNLESS params.${item.name} %]

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

@@ -57,7 +57,7 @@
</label></span>
<div id="nd_columns" class="collapse in">
<ul class="nd_inputs-list unstyled">
[% FOREACH item IN vars.port_columns %]
[% FOREACH item IN settings.port_columns %]
[% NEXT IF item.name == 'c_admin' AND NOT user_has_role('port_control') %]
<li>
<label class="checkbox">
@@ -85,12 +85,12 @@
<em class="muted">Mark as Free if Down for:</em><br/>
<select id="nd_days-select" name="age_num">
[% FOREACH count IN [1..32] %]
<option[% ' selected="selected"' IF device_ports_defaults.age_num == count %]>[% count %]</option>
<option[% ' selected="selected"' IF sidebar_defaults.age_num == count %]>[% count %]</option>
[% END %]
</select>
<select id="nd_age-select" name="age_unit">
[% FOREACH unit IN [ 'days', 'weeks', 'months', 'years' ] %]
<option[% ' selected="selected"' IF device_ports_defaults.age_unit == unit %]>[% unit %]</option>
<option[% ' selected="selected"' IF sidebar_defaults.age_unit == unit %]>[% unit %]</option>
[% END %]
</select>
</li>
@@ -126,11 +126,11 @@
<em class="muted">MAC address format:</em><br/>
<select id="nd_mac-format" name="mac_format">
[% FOREACH format IN [ 'IEEE', 'Cisco', 'Microsoft', 'Sun' ] %]
<option[% ' selected="selected"' IF device_ports_defaults.mac_format == format %]>[% format %]</option>
<option[% ' selected="selected"' IF sidebar_defaults.mac_format == format %]>[% format %]</option>
[% END %]
</select>
</li>
[% FOREACH item IN vars.connected_properties %]
[% FOREACH item IN settings.connected_properties %]
<li>
<label class="checkbox">
<input type="checkbox" id="[% item.name | html_entity %]"

4
share/views/sidebar/report/moduleinventory.tt
View File

@@ -58,7 +58,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="fruonly"
name="fruonly"[% ' checked="checked"' IF report_moduleinventory_defaults.fruonly %]/>
name="fruonly"[% ' checked="checked"' IF sidebar_defaults.fruonly %]/>
</label>
<label class="nd_checkboxlabel" for="fruonly">
<span class="nd_searchcheckbox uneditable-input">FRU Only</span>
@@ -67,7 +67,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="matchall"
name="matchall"[% ' checked="checked"' IF report_moduleinventory_defaults.matchall %]/>
name="matchall"[% ' checked="checked"' IF sidebar_defaults.matchall %]/>
</label>
<label class="nd_checkboxlabel" for="matchall">
<span class="nd_searchcheckbox uneditable-input">Match All Options</span>

2
share/views/sidebar/search/device.tt
View File

@@ -89,7 +89,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="matchall"
name="matchall"[% ' checked="checked"' IF search_device_defaults.matchall %]/>
name="matchall"[% ' checked="checked"' IF sidebar_defaults.matchall %]/>
</label>
<label class="nd_checkboxlabel" for="matchall">
<span class="nd_searchcheckbox uneditable-input">Match All Options</span>

16
share/views/sidebar/search/node.tt
View File

@@ -4,7 +4,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="stamps"
name="stamps"[% ' checked="checked"' IF search_node_defaults.stamps %]/>
name="stamps"[% ' checked="checked"' IF sidebar_defaults.stamps %]/>
</label>
<label class="nd_checkboxlabel" for="stamps">
<span class="nd_searchcheckbox uneditable-input">Time Stamps</span>
@@ -13,7 +13,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="deviceports"
name="deviceports"[% ' checked="checked"' IF search_node_defaults.deviceports %]/>
name="deviceports"[% ' checked="checked"' IF sidebar_defaults.deviceports %]/>
</label>
<label class="nd_checkboxlabel" for="deviceports">
<span class="nd_searchcheckbox uneditable-input">Device Ports</span>
@@ -22,7 +22,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="show_vendor"
name="show_vendor"[% ' checked="checked"' IF search_node_defaults.show_vendor %]/>
name="show_vendor"[% ' checked="checked"' IF sidebar_defaults.show_vendor %]/>
</label>
<label class="nd_checkboxlabel" for="show_vendor">
<span class="nd_searchcheckbox uneditable-input">Vendor</span>
@@ -31,7 +31,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="archived"
name="archived"[% ' checked="checked"' IF search_node_defaults.archived %]/>
name="archived"[% ' checked="checked"' IF sidebar_defaults.archived %]/>
</label>
<label class="nd_checkboxlabel" for="archived">
<span class="nd_searchcheckbox uneditable-input">
@@ -41,7 +41,7 @@
<div class="clearfix input-prepend">
<label class="add-on nd_sidebar-legend">
<input type="checkbox" id="node_partial"
name="partial"[% ' checked="checked"' IF search_node_defaults.partial %]/>
name="partial"[% ' checked="checked"' IF sidebar_defaults.partial %]/>
</label>
<label class="nd_checkboxlabel" for="node_partial">
<span class="nd_searchcheckbox uneditable-input">Partial Match</span>
@@ -52,20 +52,20 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="age_invert"
name="age_invert"[% ' checked="checked"' IF search_node_defaults.age_invert %]/>
name="age_invert"[% ' checked="checked"' IF sidebar_defaults.age_invert %]/>
</label>
<label class="nd_checkboxlabel" for="age_invert">
<span class="nd_searchcheckbox uneditable-input">Not within...</span>
</label>
</div>
<input class="nd_side-input" id="daterange"
type="text" name="daterange" value="[% search_node_defaults.daterange | html_entity %]"/>
type="text" name="daterange" value="[% sidebar_defaults.daterange | html_entity %]"/>
</div>
<div class="clearfix">
<em class="muted">MAC address format:</em><br/>
<select id="nd_node-mac-format" name="mac_format">
[% FOREACH format IN [ 'IEEE', 'Cisco', 'Microsoft', 'Sun' ] %]
<option[% ' selected="selected"' IF search_node_defaults.mac_format == format %]>[% format %]</option>
<option[% ' selected="selected"' IF sidebar_defaults.mac_format == format %]>[% format %]</option>
[% END %]
</select>
</div>

6
share/views/sidebar/search/port.tt
View File

@@ -4,7 +4,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="port_partial"
name="partial"[% ' checked="checked"' IF search_port_defaults.partial %]/>
name="partial"[% ' checked="checked"' IF sidebar_defaults.partial %]/>
</label>
<label class="nd_checkboxlabel" for="port_partial">
<span class="nd_searchcheckbox uneditable-input">Partial Match</span>
@@ -13,7 +13,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="port_uplink"
name="uplink"[% ' checked="checked"' IF search_port_defaults.uplink %]/>
name="uplink"[% ' checked="checked"' IF sidebar_defaults.uplink %]/>
</label>
<label class="nd_checkboxlabel" for="port_uplink">
<span class="nd_searchcheckbox uneditable-input">Uplinks</span>
@@ -22,7 +22,7 @@
<div class="clearfix input-prepend">
<label class="add-on">
<input type="checkbox" id="port_ethernet"
name="ethernet"[% ' checked="checked"' IF search_port_defaults.ethernet %]/>
name="ethernet"[% ' checked="checked"' IF sidebar_defaults.ethernet %]/>
</label>
<label class="nd_checkboxlabel" for="port_ethernet">
<span class="nd_searchcheckbox uneditable-input">Ethernet Only</span>