Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds support for BSD based Operating Systems #210

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adds support for BSD based Operating Systems #210

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8144d3
Why you hate me git?
miversen33 Dec 4, 2024
75813b7
Adding bsd and mac support
miversen33 Dec 5, 2024
bc050ab
Removed errant log lines
miversen33 Dec 5, 2024
f7d028c
Added more useful logs back
miversen33 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 71 additions & 23 deletions lua/netman/providers/ssh.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ local find_pattern_globs = {
'^(INODE)=(>?)([%d]+),',
'^(PERMISSIONS)=(>?)([%d]+),',
'^(SIZE)=(>?)([%d]+),',
'^(TYPE)=(>?)([%l%s]+),',
'^(TYPE)=(>?)([%u%l%s]+),',
'^(NAME)=(>?)(.*)$'
}

Expand Down Expand Up @@ -57,6 +57,14 @@ local SSH = {
NAME = 'NAME',
URI = 'URI'
},
STAT_COMMAND_FLAGS = {
FREEBSD = {'-L', '-f', 'MODE=%Xp,BLOCKS=%b,BLKSIZE=%k,MTIME_SEC=%m,USER=%Su,GROUP=%Sg,INODE=%i,PERMISSIONS=%OLp,SIZE=%z,TYPE=%HT,NAME=%N'},
LINUX = {'-L','-c','MODE=%f,BLOCKS=%b,BLKSIZE=%B,MTIME_SEC=%X,USER=%U,GROUP=%G,INODE=%i,PERMISSIONS=%a,SIZE=%s,TYPE=%F,NAME=%n'},
},
FIND_COMMAND_FLAGS = {
FREEBSD = {'-L', '-f', '\\|MODE=%Xp,BLOCKS=\\>%b,BLKSIZE=\\>%k,MTIME_SEC=\\>%m,USER=%Su,GROUP=%Sg,INODE=\\>%i,PERMISSIONS=\\>%OLp,SIZE=\\>%z,TYPE=%HT,NAME=%N\\|'},
LINUX = {'-L', '-c', '\\|MODE=%f,BLOCKS=\\>%b,BLKSIZE=\\>%B,MTIME_SEC=\\>%X,USER=%U,GROUP=%G,INODE=\\>%i,PERMISSIONS=\\>%a,SIZE=\\>%s,TYPE=%F,NAME=%n\\|'},
},
SSH_CONNECTION_TIMEOUT = 10,
SSH_SOCKET_FILE_NAME = '%C', -- Much more compressed way to represent the "same" connection details
SSH_PROTO_GLOB = '^([sfthcp]+)://',
Expand Down Expand Up @@ -148,14 +156,10 @@ function SSH:new(auth_details, provider_cache)
table.insert(_ssh.console_command, 'ControlMaster=auto')
table.insert(_ssh._put_command, '-o')
table.insert(_ssh._put_command, 'ControlMaster=auto')

table.insert(_ssh.console_command, '-o')
table.insert(_ssh.console_command,
string.format('ControlPath="%s%s"', socket_files, SSH.CONSTANTS.SSH_SOCKET_FILE_NAME))
table.insert(_ssh._put_command, '-o')
table.insert(_ssh._put_command,
string.format('ControlPath="%s%s"', socket_files, SSH.CONSTANTS.SSH_SOCKET_FILE_NAME))

table.insert(_ssh.console_command, '-o')
table.insert(_ssh.console_command, string.format('ControlPath="%s%s"', socket_files, SSH.CONSTANTS.SSH_SOCKET_FILE_NAME))
table.insert(_ssh._put_command, '-o')
table.insert(_ssh._put_command, string.format('ControlPath="%s%s"', socket_files, SSH.CONSTANTS.SSH_SOCKET_FILE_NAME))
table.insert(_ssh.console_command, '-o')
table.insert(_ssh.console_command, string.format('ControlPersist=%s', SSH.CONSTANTS.SSH_CONNECTION_TIMEOUT))
table.insert(_ssh._put_command, '-o')
Expand Down Expand Up @@ -235,17 +239,56 @@ function SSH:_set_user_password(new_password)
end

function SSH:_get_os()
local result = "Unknown"

logger.trace(string.format("Checking OS For Host %s", self.host))
local _get_os_command = 'cat /etc/*release* | grep -E "^NAME=" | cut -b 6-'
local _get_os_command = "uname" -- Portable (POSIX) way to get the OS
local output = self:run_command(_get_os_command, {
[command_flags.STDOUT_JOIN] = '',
[command_flags.STDERR_JOIN] = ''
})
if output.exit_code ~= 0 then
logger.warn(string.format("Unable to identify operating system for %s", self.host))
return "Unknown"

if output.exit_code ~= 0 or not output.stdout or output.stdout == "" then
-- Workaround to detect Windows:
-- Check if the path separator is backslash
if package.config:sub(1, 1) == "\\" then
result = "windows"
end
else
result = output.stdout:gsub('^%s+',""):gsub("%s+$", "") -- Remove surrounding whitespace
if result == "Linux" then
result = "linux"

-- Get Distribution
local cmd = 'cat /etc/*release* | grep -E "^NAME=" | cut -b 6-'
local distro_output = self:run_command(cmd, {
[command_flags.STDOUT_JOIN] = '',
[command_flags.STDERR_JOIN] = ''
})
if distro_output.exit_code == 0 and distro_output.stdout:len() > 0 then
result = distro_output.stdout:gsub('^%s+',""):gsub("%s+$", "") -- Remove surrounding whitespace
result = result:gsub('["\']', '') -- Remove extra quotes
end
elseif result == "Darwin" then
result = "macos"
elseif result:find("BSD") then
result = result:match("%w+BSD")
else
logger.warn(string.format("Unable to identify operating system for %s", self.host))
result = "Unknown"
end
end
return result
end

function SSH:_get_stat_flags()
if self.os:match('BSD') or self.os:match('macos') then
self.stat_flags = SSH.CONSTANTS.STAT_COMMAND_FLAGS.FREEBSD
self.find_flags = SSH.CONSTANTS.FIND_COMMAND_FLAGS.FREEBSD
else
self.stat_flags = SSH.CONSTANTS.STAT_COMMAND_FLAGS.LINUX
self.find_flags = SSH.CONSTANTS.FIND_COMMAND_FLAGS.LINUX
end
return output.stdout:gsub('["\']', '')
end

function SSH:_get_archive_availability_details()
Expand Down Expand Up @@ -1389,13 +1432,11 @@ function SSH:stat(locations, target_flags, opts)
}
if callback then callback(return_details) end
end
local stat_flags = {
'-L',
'-c',
'MODE=%f,BLOCKS=%b,BLKSIZE=%B,MTIME_SEC=%X,USER=%U,GROUP=%G,INODE=%i,PERMISSIONS=%a,SIZE=%s,TYPE=%F,NAME=%n'
}
local stat_command = { 'stat' }
for _, flag in ipairs(stat_flags) do
if not self.stat_flags then
self:_get_stat_flags()
end
for _, flag in ipairs(self.stat_flags) do
table.insert(stat_command, flag)
end
local __ = {}
Expand Down Expand Up @@ -1852,7 +1893,11 @@ end

function M.internal.read_directory(uri, host, callback)
logger.tracef("Reading %s as directory", uri:to_string("remote"))
local find_cmd = 'stat -L -c \\|MODE=%f,BLOCKS=\\>%b,BLKSIZE=\\>%B,MTIME_SEC=\\>%X,USER=%U,GROUP=%G,INODE=\\>%i,PERMISSIONS=\\>%a,SIZE=\\>%s,TYPE=%F,NAME=%n\\|'

if not host.find_flags then
host:_get_stat_flags()
end
local find_cmd = 'stat ' .. table.concat(host.find_flags, ' ')

local partial_output = {}
local children = {}
Expand Down Expand Up @@ -2046,7 +2091,7 @@ function M.read_a(uri, cache, callback)
}
end
-- If the container is running there is no reason we can't quickly stat the file in question...
if stat.TYPE == 'directory' then
if stat.FIELD_TYPE == metadata_options.LINK then
return {
type = api_flags.READ_TYPE.EXPLORE,
handle = M.internal.read_directory(uri, host, callback)
Expand Down Expand Up @@ -2133,7 +2178,10 @@ function M.internal.find(uri, host, opts)
opts = opts or {}
if not opts.exec then
-- TODO: Why is this the default? This should be a variable that we provide when we wish to do opts.exec...
opts.exec = 'stat -L -c \\|MODE=%f,BLOCKS=\\>%b,BLKSIZE=\\>%B,MTIME_SEC=\\>%X,USER=%U,GROUP=%G,INODE=\\>%i,PERMISSIONS=\\>%a,SIZE=\\>%s,TYPE=%F,NAME=%n\\|'
if not host.find_flags then
host:_get_stat_flags()
end
opts.exec= 'stat ' .. table.concat(host.find_flags, ' ')
end
local data_cache = nil
if opts.callback then
Expand Down