278 lines
6.3 KiB
Bash
Executable File
278 lines
6.3 KiB
Bash
Executable File
#!/bin/sh
|
|
#
|
|
# Copyright (C) 2016 Glyptodon LLC
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
#
|
|
|
|
#
|
|
# guacctl
|
|
# -------
|
|
#
|
|
# Utility for sending Guacamole-specific console codes for controlling a
|
|
# terminal session, such as:
|
|
#
|
|
# * Downloading files (SSH only)
|
|
# * Setting the destination directory for uploads (SSH only)
|
|
# * Redirecting output to a named pipe stream (SSH or telnet)
|
|
#
|
|
# This script may also be run as "guacget", in which case the script accepts
|
|
# no options and assumes anything given on the commandline is a file to be
|
|
# downloaded.
|
|
#
|
|
|
|
##
|
|
## Given the name of a file, which may be a relative path, produce the full,
|
|
## real, non-relative path for that same file.
|
|
##
|
|
## @param FILENAME
|
|
## The name of the file to produce the full path of.
|
|
##
|
|
fullpath() {
|
|
FILENAME="$1"
|
|
DIR=`dirname "$FILENAME"`
|
|
FILE=`basename "$FILENAME"`
|
|
(cd "$DIR" && echo "$PWD/$FILE")
|
|
}
|
|
|
|
##
|
|
## Sends the Guacamole-specific console code for initiating a download.
|
|
##
|
|
## @param FILENAME
|
|
## The full path of the file to download.
|
|
##
|
|
send_download_file() {
|
|
FILENAME="$1"
|
|
printf "\033]482200;%s\007" "$FILENAME"
|
|
}
|
|
|
|
##
|
|
## Sends the Guacamole-specific console code for setting the upload directory.
|
|
##
|
|
## @param FILENAME
|
|
## The full path to the directory which should receive uploads.
|
|
##
|
|
send_set_directory() {
|
|
FILENAME="$1"
|
|
printf "\033]482201;%s\007" "$FILENAME"
|
|
}
|
|
|
|
##
|
|
## Sends the Guacamole-specific console code for redirecting output to a named
|
|
## pipe stream (instead of the terminal emulator)
|
|
##
|
|
## @param NAME
|
|
## The name of the pipe stream to open.
|
|
##
|
|
send_open_pipe_stream() {
|
|
NAME="$1"
|
|
printf "\033]482202;%s\007" "$NAME"
|
|
}
|
|
|
|
##
|
|
## Sends the Guacamole-specific console code for redirecting output back to the
|
|
## terminal emulator
|
|
##
|
|
send_close_pipe_stream() {
|
|
printf "\033]482203\007"
|
|
}
|
|
|
|
##
|
|
## Prints the given error text to STDERR.
|
|
##
|
|
## @param ...
|
|
## The text to print as an error message.
|
|
##
|
|
error() {
|
|
echo "$NAME:" "$@" >&2
|
|
}
|
|
|
|
##
|
|
## Prints usage documentation for this script.
|
|
##
|
|
usage() {
|
|
cat >&2 <<END
|
|
guacctl 0.9.9, Guacamole terminal session control utility.
|
|
Usage: guacctl [OPTION] [FILE or NAME]...
|
|
|
|
-d, --download download each of the files listed.
|
|
-s, --set-directory set the destination directory for future uploaded
|
|
files.
|
|
-o, --open-pipe redirect output to a new pipe stream with the given
|
|
name.
|
|
-c, --close-pipe close any existing pipe stream and redirect output
|
|
back to the terminal emulator.
|
|
END
|
|
}
|
|
|
|
##
|
|
## Initiates a download for each of the specified files.
|
|
##
|
|
## @param ...
|
|
## The name of each file that should be downloaded, as originally
|
|
## provided to guacctl.
|
|
##
|
|
download_files() {
|
|
|
|
#
|
|
# Validate arguments
|
|
#
|
|
|
|
if [ $# -lt 1 ]; then
|
|
error "No files specified."
|
|
return;
|
|
fi
|
|
|
|
#
|
|
# Send download code for each file given
|
|
#
|
|
|
|
for FILENAME in "$@"; do
|
|
if [ -e "$FILENAME" ]; then
|
|
send_download_file "`fullpath "$FILENAME"`"
|
|
else
|
|
error "$FILENAME: File does not exist."
|
|
fi
|
|
done
|
|
|
|
}
|
|
|
|
##
|
|
## Changes the upload path for future uploads to the given directory.
|
|
##
|
|
## @param ...
|
|
## The name of the directory to use for uploads, as provided to guacctl.
|
|
##
|
|
set_directory() {
|
|
|
|
#
|
|
# Validate arguments
|
|
#
|
|
|
|
if [ $# -lt 1 ]; then
|
|
error "No destination directory specified."
|
|
return;
|
|
fi
|
|
|
|
if [ $# -gt 1 ]; then
|
|
error "Only one destination directory may be given."
|
|
return;
|
|
fi
|
|
|
|
#
|
|
# Send code for setting the upload directory
|
|
#
|
|
|
|
FILENAME="$1"
|
|
if [ -d "$FILENAME" ]; then
|
|
send_set_directory "`fullpath "$FILENAME"`"
|
|
else
|
|
error "$FILENAME: File does not exist or is not a directory."
|
|
fi
|
|
|
|
}
|
|
|
|
##
|
|
## Opens a new pipe stream having the given name and redirects terminal output
|
|
## to that stream.
|
|
##
|
|
## @param ...
|
|
## The name of the pipe stream to open, as provided to guacctl.
|
|
##
|
|
open_pipe_stream() {
|
|
|
|
#
|
|
# Validate arguments
|
|
#
|
|
|
|
if [ $# -lt 1 ]; then
|
|
error "No pipe name specified."
|
|
return;
|
|
fi
|
|
|
|
if [ $# -gt 1 ]; then
|
|
error "Only one pipe name may be given."
|
|
return;
|
|
fi
|
|
|
|
#
|
|
# Send code for opening the named pipe stream
|
|
#
|
|
|
|
NAME="$1"
|
|
send_open_pipe_stream "$NAME"
|
|
|
|
}
|
|
|
|
##
|
|
## Closes the currently-open pipe stream and redirects terminal output back to
|
|
## the terminal emulator
|
|
##
|
|
## @param ...
|
|
## The arguments provided to guacctl, which should be empty.
|
|
##
|
|
close_pipe_stream() {
|
|
|
|
#
|
|
# Validate arguments
|
|
#
|
|
|
|
if [ $# -gt 0 ]; then
|
|
error "Closing an open pipe stream does not require any arguments."
|
|
return;
|
|
fi
|
|
|
|
#
|
|
# Send code for closing the currently-open named pipe stream
|
|
#
|
|
|
|
send_close_pipe_stream
|
|
|
|
}
|
|
|
|
#
|
|
# Get script name
|
|
#
|
|
|
|
NAME=`basename "$0"`
|
|
|
|
#
|
|
# Parse options
|
|
#
|
|
|
|
if [ "x$NAME" = "xguacget" ]; then
|
|
download_files "$@"
|
|
elif [ "x$1" = "x--download" -o "x$1" = "x-d" ]; then
|
|
shift
|
|
download_files "$@"
|
|
elif [ "x$1" = "x--set-directory" -o "x$1" = "x-s" ]; then
|
|
shift
|
|
set_directory "$@"
|
|
elif [ "x$1" = "x--open-pipe" -o "x$1" = "x-o" ]; then
|
|
shift
|
|
open_pipe_stream "$@"
|
|
elif [ "x$1" = "x--close-pipe" -o "x$1" = "x-c" ]; then
|
|
shift
|
|
close_pipe_stream "$@"
|
|
else
|
|
usage
|
|
exit 1
|
|
fi
|
|
|