From 45a0a75d969f3da7fb83476f071eb0c946a93b4b Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Mon, 11 Dec 2017 23:51:01 +0000 Subject: [PATCH 1/2] change from settings to vars for tracking param defaults --- lib/App/Netdisco/Web.pm | 67 +++++++++++++------ lib/App/Netdisco/Web/Device.pm | 51 ++++---------- lib/App/Netdisco/Worker/Plugin.pm | 5 +- lib/App/Netdisco/Worker/Runner.pm | 5 +- share/views/ajax/device/ports.tt | 2 +- share/views/ajax/device/ports_csv.tt | 2 +- share/views/sidebar/device/ports.tt | 10 +-- share/views/sidebar/report/moduleinventory.tt | 4 +- share/views/sidebar/search/device.tt | 2 +- share/views/sidebar/search/node.tt | 16 ++--- share/views/sidebar/search/port.tt | 6 +- 11 files changed, 84 insertions(+), 86 deletions(-) diff --git a/lib/App/Netdisco/Web.pm b/lib/App/Netdisco/Web.pm index 3094c377..a8d0639e 100644 --- a/lib/App/Netdisco/Web.pm +++ b/lib/App/Netdisco/Web.pm @@ -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 diff --git a/lib/App/Netdisco/Web/Device.pm b/lib/App/Netdisco/Web/Device.pm index d0280480..ee06e551 100644 --- a/lib/App/Netdisco/Web/Device.pm +++ b/lib/App/Netdisco/Web/Device.pm @@ -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'); diff --git a/lib/App/Netdisco/Worker/Plugin.pm b/lib/App/Netdisco/Worker/Plugin.pm index dbf1b75c..d4266d48 100644 --- a/lib/App/Netdisco/Worker/Plugin.pm +++ b/lib/App/Netdisco/Worker/Plugin.pm @@ -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 diff --git a/lib/App/Netdisco/Worker/Runner.pm b/lib/App/Netdisco/Worker/Runner.pm index 334e9e97..c0f1a770 100644 --- a/lib/App/Netdisco/Worker/Runner.pm +++ b/lib/App/Netdisco/Worker/Runner.pm @@ -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 diff --git a/share/views/ajax/device/ports.tt b/share/views/ajax/device/ports.tt index 29951594..e17da212 100644 --- a/share/views/ajax/device/ports.tt +++ b/share/views/ajax/device/ports.tt @@ -3,7 +3,7 @@ - [% 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} %] diff --git a/share/views/ajax/device/ports_csv.tt b/share/views/ajax/device/ports_csv.tt index 81a31fe5..7f4db98f 100644 --- a/share/views/ajax/device/ports_csv.tt +++ b/share/views/ajax/device/ports_csv.tt @@ -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} %] diff --git a/share/views/sidebar/device/ports.tt b/share/views/sidebar/device/ports.tt index 29ad34f2..9fe12a31 100644 --- a/share/views/sidebar/device/ports.tt +++ b/share/views/sidebar/device/ports.tt @@ -57,7 +57,7 @@