client: add lib_plugins

- Allows client-side execution of repo/custom client plugins - A client-side equivalent of container's lib_plugins
2024-08-10 01:45:51 -07:00
parent bbb5d7c238
commit 720eec8a14
1 changed files with 120 additions and 0 deletions
--- a/client/src/docker/lib/internal/lib_plugins.bash
+++ b/client/src/docker/lib/internal/lib_plugins.bash
@@ -0,0 +1,120 @@
+#!/usr/bin/env bash
+
+# docker-finance | modern accounting for the power-user
+#
+# Copyright (C) 2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation  either version 3 of the License  or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not  see <https://www.gnu.org/licenses/>.
+
+[ -z "$DOCKER_FINANCE_CLIENT_REPO" ] && exit 1
+
+#
+# "Libraries"
+#
+
+# Utilities (a container library (but container is never exposed to client code))
+source "${DOCKER_FINANCE_CLIENT_REPO}/container/src/finance/lib/internal/lib_utils.bash" || exit 1
+
+#
+# Facade
+#
+
+function lib_plugins::plugins()
+{
+  lib_plugins::__parse_args "$@"
+  lib_plugins::__plugins "$@"
+  lib_utils::catch $?
+}
+
+#
+# Implementation
+#
+
+function lib_plugins::__parse_args()
+{
+  #
+  # Expected format:
+  #
+  #   $global_usage repo${global_arg_delim_1}file [args]
+  #     - Executes plugin in repository
+  #
+  #   $global_usage custom${global_arg_delim_1}file [args]
+  #     - Executes plugin outside of repository
+  #
+
+  [ -z "$global_usage" ] && lib_utils::die_fatal
+  [ -z "$global_arg_delim_1" ] && lib_utils::die_fatal
+
+  [ -z "$DOCKER_FINANCE_CLIENT_REPO" ] && lib_utils::die_fatal
+  local -r _repo="${DOCKER_FINANCE_CLIENT_REPO}/client/plugins/docker"
+  [ ! -d "$_repo" ] && lib_utils::die_fatal
+
+  [ -z "$DOCKER_FINANCE_CLIENT_PLUGINS" ] && lib_utils::die_fatal
+  local -r _custom="${DOCKER_FINANCE_CLIENT_PLUGINS}/client/docker"
+  [ ! -d "$_custom" ] && lib_utils::die_fatal
+
+  local -r _usage="
+\e[32mDescription:\e[0m
+
+  Execute a categorical plugin
+
+\e[32mUsage:\e[0m
+
+  $ $global_usage <repo${global_arg_delim_1}plugin | custom${global_arg_delim_1}plugin> [args]
+
+\e[32mExamples:\e[0m
+
+  \e[37;2m# Execute a repository plugin in '${_repo}'\e[0m
+  $ $global_usage repo${global_arg_delim_1}example.bash \"I'm in repo\"
+
+  \e[37;2m# Execute a custom plugin in '${_custom}'\e[0m
+  $ $global_usage custom${global_arg_delim_1}example.bash \"I'm in custom\"
+"
+
+  [ $# -eq 0 ] && lib_utils::die_usage "$_usage"
+
+  local -r _arg="$1"
+
+  [[ ! "$_arg" =~ (^repo${global_arg_delim_1}|^custom${global_arg_delim_1}) ]] && lib_utils::die_usage "$_usage"
+
+  local -r _key="${_arg%${global_arg_delim_1}*}"
+  local -r _len="$((${#_key} + 1))"
+
+  if [[ "$_key" =~ ^repo$|^custom$ ]]; then
+    local -r _arg_type="${_arg:${_len}}"
+    [ -z "$_arg_type" ] && lib_utils::die_usage "$_usage"
+  fi
+
+  local _path
+  case "$_key" in
+    repo)
+      _path="${_repo}/${_arg_type}"
+      ;;
+    custom)
+      _path="${_custom}/${_arg_type}"
+      ;;
+    *)
+      lib_utils::die_usage "$_usage"
+      ;;
+  esac
+  declare -gr global_arg_path="$_path"
+}
+
+function lib_plugins::__plugins()
+{
+  exec $global_arg_path "${@:2}"
+  return $?
+}
+
+# vim: sw=2 sts=2 si ai et