proxmox-mirrors/pve-http-server
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-http-server synced 2025-05-03 03:26:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

pass basic server configuration to formatter functions

Browse Source
This commit is contained in:
Dietmar Maurer 2017-01-15 11:43:48 +01:00
parent dc80cea51c
commit ca304f91ce
4 changed files with 54 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
PVE/APIServer/AnyEvent.pm
View File

@ -733,9 +733,8 @@ sub handle_api2_request {
$delay = 0 if $delay < 0; $delay = 0 if $delay < 0;
} }
my $csrfgen_func = $self->can('generate_csrf_prevention_token'); my ($raw, $ct, $nocomp) = $formatter->($res, $res->{data}, $params, $path,
my ($raw, $ct, $nocomp) = &$formatter($res, $res->{data}, $params, $path, $auth, $self->{formatter_config});
$auth, $csrfgen_func, $self->{title});
my $resp; my $resp;
if (ref($raw) && (ref($raw) eq 'HTTP::Response')) { if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
@ -1187,7 +1186,8 @@ sub unshift_read_header {
# always delay unauthorized calls by 3 seconds # always delay unauthorized calls by 3 seconds
my $delay = 3; my $delay = 3;
if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) { if (my $formatter = PVE::APIServer::Formatter::get_login_formatter($format)) {
my ($raw, $ct, $nocomp) = &$formatter($path, $auth); my ($raw, $ct, $nocomp) =
$formatter->($path, $auth, $self->{formatter_config});
my $resp; my $resp;
if (ref($raw) && (ref($raw) eq 'HTTP::Response')) { if (ref($raw) && (ref($raw) eq 'HTTP::Response')) {
$resp = $raw; $resp = $raw;
@ -1568,6 +1568,15 @@ sub new {
$self->{dirs} //= {}; $self->{dirs} //= {};
$self->{title} //= 'API Inspector'; $self->{title} //= 'API Inspector';
# formatter_config: we pass some configuration values to the Formatter
$self->{formatter_config} = {};
foreach my $p (qw(cookie_name base_uri title)) {
$self->{formatter_config}->{$p} = $self->{$p};
}
$self->{formatter_config}->{csrfgen_func} =
$self->can('generate_csrf_prevention_token');
# add default dirs which includes jquery and bootstrap
my $base = '/usr/share/libpve-http-server-perl'; my $base = '/usr/share/libpve-http-server-perl';
add_dirs($self->{dirs}, '/css/' => "$base/css/"); add_dirs($self->{dirs}, '/css/' => "$base/css/");
add_dirs($self->{dirs}, '/js/' => "$base/js/"); add_dirs($self->{dirs}, '/js/' => "$base/js/");
@ -1690,7 +1699,6 @@ sub auth_handler {
# userid => $username, # userid => $username,
# age => $age, # age => $age,
# isUpload => $isUpload, # isUpload => $isUpload,
# cookie_name => $self->{cookie_name},
#}; #};
} }

8
PVE/APIServer/Formatter/Bootstrap.pm
View File

@ -59,17 +59,17 @@ PVE.open_vm_console = function(node, vmid) {
_EOJS _EOJS
sub new { sub new {
my ($class, $res, $url, $auth, $csrfgen_func, $title) = @_; my ($class, $res, $url, $auth, $config) = @_;
my $self = bless { my $self = bless {
url => $url, url => $url,
title => $title, title => $config->{title},
cookie_name => $auth->{cookie_name}, cookie_name => $config->{cookie_name},
js => '', js => '',
}; };
if (my $username = $auth->{userid}) { if (my $username = $auth->{userid}) {
$self->{csrftoken} = &$csrfgen_func($username); $self->{csrftoken} = $config->{csrfgen_func}->($username);
} }
return $self; return $self;

56
PVE/APIServer/Formatter/HTML.pm
View File

@ -14,11 +14,18 @@ use PVE::APIServer::Formatter::Standard;
my $portal_format = 'html'; my $portal_format = 'html';
my $portal_ct = 'text/html;charset=UTF-8'; my $portal_ct = 'text/html;charset=UTF-8';
my $baseurl = "/api2/$portal_format"; my $get_portal_base_url = sub {
my $login_url = "$baseurl/access/ticket"; my ($config) = @_;
return "$config->{base_uri}/$portal_format";
};
my $get_portal_login_url = sub {
my ($config) = @_;
return "$config->{base_uri}/$portal_format/access/ticket";
};
sub render_page { sub render_page {
my ($doc, $html, $title) = @_; my ($doc, $html, $config) = @_;
my $items = []; my $items = [];
@ -26,11 +33,12 @@ sub render_page {
tag => 'li', tag => 'li',
cn => { cn => {
tag => 'a', tag => 'a',
href => $login_url, href => $get_portal_login_url->($config),
onClick => "PVE.delete_auth_cookie();", onClick => "PVE.delete_auth_cookie();",
text => "Logout", text => "Logout",
}}; }};
my $base_url = $get_portal_base_url->($config);
my $nav = $doc->el( my $nav = $doc->el(
class => "navbar navbar-inverse navbar-fixed-top", class => "navbar navbar-inverse navbar-fixed-top",
@ -54,8 +62,8 @@ sub render_page {
{ {
tag => 'a', tag => 'a',
class => "navbar-brand", class => "navbar-brand",
href => $baseurl, href => $base_url,
text => $title, text => $config->{title},
}, },
], ],
}, },
@ -76,7 +84,7 @@ sub render_page {
shift @pcomp; # api2 shift @pcomp; # api2
shift @pcomp; # $format shift @pcomp; # $format
my $href = $baseurl; my $href = $base_url;
push @$items, { tag => 'li', cn => { push @$items, { tag => 'li', cn => {
tag => 'a', tag => 'a',
href => $href, href => $href,
@ -96,7 +104,7 @@ sub render_page {
} }
my $login_form = sub { my $login_form = sub {
my ($doc, $param, $errmsg) = @_; my ($config, $doc, $param, $errmsg) = @_;
$param = {} if !$param; $param = {} if !$param;
@ -139,7 +147,7 @@ my $login_form = sub {
tag => 'form', tag => 'form',
role => 'form', role => 'form',
method => 'POST', method => 'POST',
action => $login_url, action => $get_portal_login_url->($config),
cn => [ cn => [
{ {
class => 'form-group', class => 'form-group',
@ -158,21 +166,21 @@ my $login_form = sub {
}; };
PVE::APIServer::Formatter::register_login_formatter($portal_format, sub { PVE::APIServer::Formatter::register_login_formatter($portal_format, sub {
my ($path, $auth) = @_; my ($path, $auth, $config) = @_;
my $headers = HTTP::Headers->new(Location => $login_url); my $headers = HTTP::Headers->new(Location => $get_portal_login_url->($config));
return HTTP::Response->new(301, "Moved", $headers); return HTTP::Response->new(301, "Moved", $headers);
}); });
PVE::APIServer::Formatter::register_formatter($portal_format, sub { PVE::APIServer::Formatter::register_formatter($portal_format, sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func, $title) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
# fixme: clumsy! # fixme: clumsy!
PVE::APIServer::Formatter::Standard::prepare_response_data($portal_format, $res); PVE::APIServer::Formatter::Standard::prepare_response_data($portal_format, $res);
$data = $res->{data}; $data = $res->{data};
my $html = ''; my $html = '';
my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $csrfgen_func, $title); my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $config);
if (!HTTP::Status::is_success($res->{status})) { if (!HTTP::Status::is_success($res->{status})) {
$html .= $doc->alert(text => "Error $res->{status}: $res->{message}"); $html .= $doc->alert(text => "Error $res->{status}: $res->{message}");
@ -239,7 +247,7 @@ PVE::APIServer::Formatter::register_formatter($portal_format, sub {
$html = $doc->el(class => 'container', html => $html); $html = $doc->el(class => 'container', html => $html);
my $raw = render_page($doc, $html, $title); my $raw = render_page($doc, $html, $config);
return ($raw, $portal_ct); return ($raw, $portal_ct);
}); });
@ -248,13 +256,13 @@ PVE::APIServer::Formatter::register_page_formatter(
method => 'GET', method => 'GET',
path => "/access/ticket", path => "/access/ticket",
code => sub { code => sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func, $title) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $csrfgen_func, $title); my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $config);
my $html = &$login_form($doc); my $html = $login_form->($config, $doc);
my $raw = render_page($doc, $html, $title); my $raw = render_page($doc, $html, $config);
return ($raw, $portal_ct); return ($raw, $portal_ct);
}); });
@ -263,13 +271,13 @@ PVE::APIServer::Formatter::register_page_formatter(
method => 'POST', method => 'POST',
path => "/access/ticket", path => "/access/ticket",
code => sub { code => sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func, $title) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
if (HTTP::Status::is_success($res->{status})) { if (HTTP::Status::is_success($res->{status})) {
my $cookie = PVE::APIServer::Formatter::create_auth_cookie( my $cookie = PVE::APIServer::Formatter::create_auth_cookie(
$data->{ticket}, $auth->{cookie_name}); $data->{ticket}, $config->{cookie_name});
my $headers = HTTP::Headers->new(Location => $baseurl, my $headers = HTTP::Headers->new(Location => $get_portal_base_url->($config),
'Set-Cookie' => $cookie); 'Set-Cookie' => $cookie);
return HTTP::Response->new(301, "Moved", $headers); return HTTP::Response->new(301, "Moved", $headers);
} }
@ -277,11 +285,11 @@ PVE::APIServer::Formatter::register_page_formatter(
# Note: HTTP server redirects to 'GET /access/ticket', so below # Note: HTTP server redirects to 'GET /access/ticket', so below
# output is not really visible. # output is not really visible.
my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $csrfgen_func, $title); my $doc = PVE::APIServer::Formatter::Bootstrap->new($res, $path, $auth, $config);
my $html = &$login_form($doc); my $html = $login_form->($config, $doc);
my $raw = render_page($doc, $html, $title); my $raw = render_page($doc, $html, $config);
return ($raw, $portal_ct); return ($raw, $portal_ct);
}); });

10
PVE/APIServer/Formatter/Standard.pm
View File

@ -47,7 +47,7 @@ sub prepare_response_data {
} }
PVE::APIServer::Formatter::register_formatter('json', sub { PVE::APIServer::Formatter::register_formatter('json', sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $nocomp = 0; my $nocomp = 0;
@ -62,7 +62,7 @@ PVE::APIServer::Formatter::register_formatter('json', sub {
PVE::APIServer::Formatter::register_formatter('extjs', sub { PVE::APIServer::Formatter::register_formatter('extjs', sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $nocomp = 0; my $nocomp = 0;
@ -76,7 +76,7 @@ PVE::APIServer::Formatter::register_formatter('extjs', sub {
}); });
PVE::APIServer::Formatter::register_formatter('htmljs', sub { PVE::APIServer::Formatter::register_formatter('htmljs', sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $nocomp = 0; my $nocomp = 0;
@ -93,7 +93,7 @@ PVE::APIServer::Formatter::register_formatter('htmljs', sub {
PVE::APIServer::Formatter::register_formatter('spiceconfig', sub { PVE::APIServer::Formatter::register_formatter('spiceconfig', sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $nocomp = 0; my $nocomp = 0;
@ -116,7 +116,7 @@ PVE::APIServer::Formatter::register_formatter('spiceconfig', sub {
}); });
PVE::APIServer::Formatter::register_formatter('png', sub { PVE::APIServer::Formatter::register_formatter('png', sub {
my ($res, $data, $param, $path, $auth, $csrfgen_func) = @_; my ($res, $data, $param, $path, $auth, $config) = @_;
my $nocomp = 1; my $nocomp = 1;