#!/usr/bin/perl # # Manages VNC ports for server VMs that have VNC enabled. # use strict; use warnings; use Anvil::Tools; use Data::Dumper; $| = 1; my $THIS_FILE = ($0 =~ /^.*\/(.*)$/)[0]; my $running_directory = ($0 =~ /^(.*?)\/$THIS_FILE$/)[0]; if (($running_directory =~ /^\./) && ($ENV{PWD})) { $running_directory =~ s/^\./$ENV{PWD}/; } my $anvil = Anvil::Tools->new(); my $echo = $anvil->data->{path}{exe}{'echo'}; my $grep = $anvil->data->{path}{exe}{'grep'}; my $kill = $anvil->data->{path}{exe}{'kill'}; my $pgrep = $anvil->data->{path}{exe}{'pgrep'}; my $ss = $anvil->data->{path}{exe}{'ss'}; my $sed = $anvil->data->{path}{exe}{'sed'}; my $websockify = $anvil->data->{path}{exe}{'websockify'}; $anvil->Get->switches; $anvil->Database->connect; $anvil->Log->entry({ source => $THIS_FILE, line => __LINE__, level => 2, secure => 0, key => "log_0132" }); if (not $anvil->data->{sys}{database}{connections}) { # No databases, exit. $anvil->Log->entry({ source => $THIS_FILE, line => __LINE__, level => 0, 'print' => 1, priority => "err", key => "error_0003" }); $anvil->nice_exit({ exit_code => 1 }); } my $switch_debug = $anvil->data->{switches}{'debug'}; my $open = $anvil->data->{switches}{'open'}; my $server = $anvil->data->{switches}{'server'}; my $server_uuid = $anvil->data->{switches}{'server-uuid'}; my $server_vnc_port = $anvil->data->{switches}{'server-vnc-port'}; if (defined $server) { $server_uuid //= is_uuid_v4($server) ? $server : $anvil->Get->server_uuid_from_name({ server_name => $server }); } $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $switch_debug, list => { open => $open, server => $server, server_uuid => $server_uuid, server_vnc_port => $server_vnc_port } }); my $map_to_operation = { start => \&start_pipe, stop => \&stop_pipe }; if ($server_uuid) { my $operation = $open ? "start" : "stop"; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $switch_debug, list => { operation => $operation } }); my ($rcode) = $map_to_operation->{$operation}({ debug => $switch_debug, svr_uuid => $server_uuid, svr_vnc_port => $server_vnc_port, }); $anvil->nice_exit({ exit_code => $rcode }); } $anvil->nice_exit({ exit_code => 0 }); # # Functions # sub build_find_available_port_call { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $start = $parameters->{start}; my $step_operator = $parameters->{step_operator} // "+"; my $step_size = $parameters->{step_size} || 1; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "build_find_available_port_call" }); return (1) if ( (not $step_operator =~ /^[+-]$/) || (not is_int($step_size)) || ($step_size < 1) ); my $call = "ss_output=\$($ss -ant) && port=${start} && while $grep -Eq \":\${port}[[:space:]]+[^[:space:]]+\" <<<\$ss_output; do (( port ${step_operator}= $step_size )); done && $echo \$port"; return (0, $call); } sub build_vncinfo_variable_name { my ($svr_uuid) = @_; return "server::${svr_uuid}::vncport"; } sub call { my $parameters = shift; my $background = $parameters->{background} || 0; my $call = $parameters->{call}; my $debug = $parameters->{debug} || 3; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "call" }); return (1) if ( (not defined $call) || ($call eq "") ); my ($output, $rcode) = $anvil->System->call({ background => $background, shell_call => $call }); $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => { output => $output, rcode => $rcode } }); # Output order reversed keep returns consistent. return ($rcode, $output); } sub find_available_port { my $parameters = shift; my $debug = $parameters->{debug} || 3; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "find_available_port" }); my ($build_rcode, $call) = build_find_available_port_call($parameters); return (1) if ($build_rcode); return call({ call => $call, debug => $debug }); } sub find_server_vnc_port { my $parameters = shift; my $debug = $parameters->{debug}; my $svr_uuid = $parameters->{svr_uuid}; my $svr_vnc_port = $parameters->{svr_vnc_port}; return (0, $svr_vnc_port) if (is_int($svr_vnc_port)); # If we don't have the server's VNC port, find it in its qemu-kvm process. my ($rcode, $svr_processes) = $anvil->Server->find_processes({ debug => $debug }); return (1) if ($rcode); my $svr_process = $svr_processes->{uuids}{$svr_uuid}; my $svr_vnc_alive = $svr_process->{vnc_alive}; return (1) if (not $svr_vnc_alive); return (0, $svr_process->{vnc_port}); } sub find_ws_processes { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $ps_name = $parameters->{ps_name} // "websockify"; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "find_ws_processes" }); my $ps_call = "$pgrep -a '$ps_name' | $sed -En 's/^([[:digit:]]+).*${ps_name}([[:space:]]+(--?[^[:space:]]+))*[[:space:]:]+([[:digit:]]+)[[:space:]:]+([[:digit:]]+).*\$/\\1,\\4,\\5/p'"; my ($rcode, $output) = call({ call => $ps_call, debug => $debug }); return (1) if ($rcode); my $result = { pids => {}, sources => {}, targets => {} }; foreach my $line (split(/\n/, $output)) { chomp($line); $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => { ws_line => $line } }); my ($pid, $sport, $tport) = split(/,/, $line); my $process = { pid => $pid, sport => $sport, tport => $tport }; set_ws_process({ debug => $debug, entry => $process, entries => $result }); } $anvil->Log->entry({ source => $THIS_FILE, line => __LINE__, level => $debug, raw => prettify($result, "ws_processes") }); return (0, $result); } sub is_int { return defined $_[0] && $_[0] =~ /^\d+$/; } sub is_uuid_v4 { return defined $_[0] && $_[0] =~ /[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}/; } sub prettify { my $var_value = shift; my $var_name = shift; local $Data::Dumper::Indent = 1; local $Data::Dumper::Varname = $var_name; return Dumper($var_value); } sub set_entry { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $handle_delete = $parameters->{handle_delete}; my $handle_set = $parameters->{handle_set}; my $id = $parameters->{id}; my $entry = $parameters->{entry}; my $entries = $parameters->{entries}; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => { %$parameters, p_entry => prettify($entry), p_entries => prettify($entries), }, prefix => "set_entry" }); return (1) if (not defined $entries); if (defined $entry) { $handle_set->($id, $entry, $entries); } elsif (defined $id) { $handle_delete->($id, $entry, $entries); } $anvil->Log->entry({ source => $THIS_FILE, line => __LINE__, level => $debug, raw => prettify($entries, "entries") }); return (0); } sub set_vncinfo_variable { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $end_port = $parameters->{end_port}; my $svr_uuid = $parameters->{svr_uuid}; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "set_vncinfo_variable" }); my $local_host_name = $anvil->data->{sys}{host_name}; my ($variable_uuid) = $anvil->Database->insert_or_update_variables({ file => $THIS_FILE, line => __LINE__, variable_name => build_vncinfo_variable_name($svr_uuid), variable_value => "${local_host_name}:${end_port}", }); return (1) if (not is_uuid_v4($variable_uuid)); return (0); } sub set_ws_process { my $parameters = shift; $parameters->{handle_delete} = sub { my ($pid, $process, $processes) = @_; $process = $processes->{pids}{$pid}; my $sport = $process->{sport}; my $tport = $process->{tport}; delete $processes->{pids}{$pid}; delete $processes->{sources}{$sport}; delete $processes->{targets}{$tport}; }; $parameters->{handle_set} = sub { my ($pid, $process, $processes) = @_; $pid = $process->{pid}; my $sport = $process->{sport}; my $tport = $process->{tport}; $processes->{pids}{$pid} = $process; $processes->{sources}{$sport} = $pid; $processes->{targets}{$tport} = $pid; }; return set_entry($parameters); } sub start_pipe { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $svr_uuid = $parameters->{svr_uuid}; my $svr_vnc_port = $parameters->{svr_vnc_port}; return (1) if (not is_uuid_v4($svr_uuid)); my $common_params = { debug => $debug }; my $rcode; ($rcode, $svr_vnc_port) = find_server_vnc_port($parameters); return ($rcode) if ($rcode); ($rcode, my $ws_processes) = find_ws_processes($common_params); return ($rcode) if ($rcode); ($rcode, my $ws_pid) = start_ws({ svr_vnc_port => $svr_vnc_port, ws_processes => $ws_processes, %$common_params }); return ($rcode) if ($rcode); my $ws_process = $ws_processes->{pids}{$ws_pid}; set_vncinfo_variable({ end_port => $ws_process->{sport}, svr_uuid => $svr_uuid, %$common_params }); return (0); } sub start_ws { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $svr_vnc_port = $parameters->{svr_vnc_port}; my $ws_processes = $parameters->{ws_processes}; my $ws_sport_offset = $parameters->{ws_sport_offset} || 10000; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "start_ws" }); return (1) if ( (not defined $ws_processes) || (not is_int($svr_vnc_port)) || (not is_int($ws_sport_offset)) ); my $existing_ws_pid = $ws_processes->{targets}{$svr_vnc_port}; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => { existing_ws_pid => $existing_ws_pid } }); return (0, $existing_ws_pid) if (defined $existing_ws_pid); my $rcode; ($rcode, my $ws_sport) = find_available_port({ debug => $debug, start => int($svr_vnc_port) + int($ws_sport_offset) }); return ($rcode) if ($rcode); my $ws_call = "$websockify -D $ws_sport :$svr_vnc_port &>/dev/null"; ($rcode) = call({ call => $ws_call, debug => $debug }); return ($rcode) if ($rcode); # Re-find to locate the new daemon. ($rcode, my $re_ws_processes) = find_ws_processes({ debug => $debug }); return ($rcode) if ($rcode); my $ws_pid = $re_ws_processes->{targets}{$svr_vnc_port}; my $ws_process = $re_ws_processes->{pids}{$ws_pid}; # Remember the started daemon. set_ws_process({ debug => $debug, entry => $ws_process, entries => $ws_processes }); return (0, $ws_pid); } sub stop_pipe { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $svr_uuid = $parameters->{svr_uuid}; my $svr_vnc_port = $parameters->{svr_vnc_port}; return (1) if (not is_uuid_v4($svr_uuid)); my $common_params = { debug => $debug }; my $rcode; ($rcode, $svr_vnc_port) = find_server_vnc_port($parameters); return ($rcode) if ($rcode); ($rcode, my $ws_processes) = find_ws_processes($common_params); return ($rcode) if ($rcode); my $ws_pid = $ws_processes->{targets}{$svr_vnc_port}; stop_ws({ ws_pid => $ws_pid, ws_processes => $ws_processes, %$common_params }); return (0); } sub stop_ws { my $parameters = shift; my $debug = $parameters->{debug} || 3; my $ws_pid = $parameters->{ws_pid}; my $ws_processes = $parameters->{ws_processes}; $anvil->Log->variables({ source => $THIS_FILE, line => __LINE__, level => $debug, list => $parameters, prefix => "stop_ws" }); return (1) if ( (not is_int($ws_pid)) || (not defined $ws_processes) ); call({ debug => $debug, call => "$kill $ws_pid || $kill -9 $ws_pid" }); set_ws_process({ debug => $debug, id => $ws_pid, entries => $ws_processes }); return (0); }