Refactoring logging script

Author: Bruno Sutic

logging.tmux

@@ -6,29 +6,29 @@ source "$CURRENT_DIR/scripts/variables.sh"
 source "$CURRENT_DIR/scripts/shared.sh"
 
 setup_logging_key_binding() {
-	local key=$(get_tmux_option "$logging_key_option" "$default_logging_key")
+	local key="$(get_tmux_option "$logging_key_option" "$default_logging_key")"
 	tmux bind-key "$key" run-shell "$CURRENT_DIR/scripts/toggle_logging.sh"
 }
 
-setup_pane_screenshot_key_binding() {
-	local key=$(get_tmux_option "$pane_screen_capture_key_option" "$default_pane_screen_capture_key")
+setup_screen_capture_key_binding() {
+	local key="$(get_tmux_option "$pane_screen_capture_key_option" "$default_pane_screen_capture_key")"
 	tmux bind-key "$key" run-shell "$CURRENT_DIR/scripts/screen_capture.sh"
 }
 
-setup_scrollback_dump_key_binding() {
-	local key=$(get_tmux_option "$save_complete_history_key_option" "$default_save_complete_history_key")
+setup_save_complete_history_key_binding() {
+	local key="$(get_tmux_option "$save_complete_history_key_option" "$default_save_complete_history_key")"
 	tmux bind-key "$key" run-shell "$CURRENT_DIR/scripts/save_complete_history.sh"
 }
 
-setup_clear_scrollback_key_binding() {
-	local key=$(get_tmux_option "$clear_history_key_option" "$default_clear_history_key")
+setup_clear_history_key_binding() {
+	local key="$(get_tmux_option "$clear_history_key_option" "$default_clear_history_key")"
 	tmux bind-key "$key" run-shell "$CURRENT_DIR/scripts/clear_history.sh"
 }
 
 main() {
 	setup_logging_key_binding
-	setup_pane_screenshot_key_binding
-	setup_scrollback_dump_key_binding
-	setup_clear_scrollback_key_binding
+	setup_screen_capture_key_binding
+	setup_save_complete_history_key_binding
+	setup_clear_history_key_binding
 }
 main

scripts/toggle_logging.sh

@@ -2,33 +2,24 @@
 
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-default_log_path="$HOME"
-default_log_name="tmux-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log"
-
-log_path_option="@logging-path"
-log_name_option="@logging-filename"
-
 source "$CURRENT_DIR/variables.sh"
 source "$CURRENT_DIR/shared.sh"
 
-get_log_path() {
-	get_tmux_option "$log_path_option" "$default_log_path"
-}
-
-get_log_name() {
-	get_tmux_option "$log_name_option" "$default_log_name"
+get_filename() {
+	local logging_path="$(get_tmux_option "$logging_path_option" "$default_logging_path")"
+	local logging_filename="$(get_tmux_option "$logging_filename_option" "$default_logging_filename")"
+	echo "${logging_path}/${logging_filename}"
 }
 
 start_pipe_pane() {
-	local file="$(get_log_path)/$(get_log_name)"
-	"$CURRENT_DIR/start_logging.sh" "$file"
-	display_message "Started logging to $file"
+	local filename="$(get_filename)"
+	"$CURRENT_DIR/start_logging.sh" "$filename"
+	display_message "Started logging to $filename"
 }
 
 stop_pipe_pane() {
-	local file="$(get_log_path)/$(get_log_name)"
 	tmux pipe-pane
-	display_message "Ended logging to $file"
+	display_message "Ended logging to $(get_filename)"
 }
 
 # returns a string unique to current pane
@@ -38,16 +29,16 @@ pane_unique_id() {
 
 # saving 'logging' 'not logging' status in a variable unique to pane
 set_logging_variable() {
-	local value=$1
+	local value="$1"
 	local pane_unique_id="$(pane_unique_id)"
-	tmux set-option -gq "@$pane_unique_id" "$value"
+	tmux set-option -gq "@${pane_unique_id}" "$value"
 }
 
 # this function checks if logging is happening for the current pane
 is_logging() {
 	local pane_unique_id="$(pane_unique_id)"
-	local current_pane_logging=$(get_tmux_option "@$pane_unique_id" "not logging")
-	if [ $current_pane_logging == "logging" ]; then
+	local current_pane_logging="$(get_tmux_option "@${pane_unique_id}" "not logging")"
+	if [ "$current_pane_logging" == "logging" ]; then
 		return 0
 	else
 		return 1

scripts/variables.sh

@@ -5,11 +5,19 @@ SUPPORTED_VERSION="1.9"
 logging_key_option="@logging-key"
 default_logging_key="P" # Shift-p
 
-pane_screen_capture_key_option="@pane-screen-capture-key"
+pane_screen_capture_key_option="@screen-capture-key"
 default_pane_screen_capture_key="M-p" # Alt-p
 
 save_complete_history_key_option="@save-complete-history-key"
 default_save_complete_history_key="M-P" # Alt-Shift-p
 
-clear_history_key_option="@pane-clear-history-key"
+clear_history_key_option="@clear-history-key"
 default_clear_history_key="M-c" # Alt-c
+
+# Logging options
+
+logging_path_option="@logging-path"
+default_logging_path="$HOME"
+
+logging_filename_option="@logging-filename"
+default_logging_filename="tmux-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log"