GUAC-1452: Clean up comment style within guacctl.
This commit is contained in:
parent
6c0cd22b90
commit
1200a41bb6
117
bin/guacctl
117
bin/guacctl
@ -37,9 +37,13 @@
|
||||
# downloaded.
|
||||
#
|
||||
|
||||
|
||||
# Given the name of a file, which may be a relative path, produce the full,
|
||||
# real, non-relative path for that same file.
|
||||
##
|
||||
## 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"`
|
||||
@ -47,37 +51,61 @@ fullpath() {
|
||||
(cd "$DIR" && echo "$PWD/$FILE")
|
||||
}
|
||||
|
||||
# Sends the Guacamole-specific console code for initiating a download.
|
||||
##
|
||||
## 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.
|
||||
##
|
||||
## 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)
|
||||
##
|
||||
## 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
|
||||
##
|
||||
## 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.
|
||||
##
|
||||
## 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.
|
||||
##
|
||||
## Prints usage documentation for this script.
|
||||
##
|
||||
usage() {
|
||||
cat >&2 <<END
|
||||
guacctl 0.9.9, Guacamole terminal session control utility.
|
||||
@ -93,15 +121,28 @@ Usage: guacctl [OPTION] [FILE or NAME]...
|
||||
END
|
||||
}
|
||||
|
||||
# Initiates a download for each of the specified files
|
||||
##
|
||||
## 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"`"
|
||||
@ -112,10 +153,18 @@ download_files() {
|
||||
|
||||
}
|
||||
|
||||
# Changes the upload path for future uploads to the given directory
|
||||
##
|
||||
## 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;
|
||||
@ -126,6 +175,10 @@ set_directory() {
|
||||
return;
|
||||
fi
|
||||
|
||||
#
|
||||
# Send code for setting the upload directory
|
||||
#
|
||||
|
||||
FILENAME="$1"
|
||||
if [ -d "$FILENAME" ]; then
|
||||
send_set_directory "`fullpath "$FILENAME"`"
|
||||
@ -135,11 +188,19 @@ set_directory() {
|
||||
|
||||
}
|
||||
|
||||
# Opens a new pipe stream having the given name and redirects terminal output
|
||||
# to that stream
|
||||
##
|
||||
## 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;
|
||||
@ -150,29 +211,51 @@ open_pipe_stream() {
|
||||
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
|
||||
##
|
||||
## 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
|
||||
|
Loading…
Reference in New Issue
Block a user