# **** License **** # Version: VPL 1.0 # # The contents of this file are subject to the Vyatta Public License # Version 1.0 ("License"); you may not use this file except in # compliance with the License. You may obtain a copy of the License at # http://www.vyatta.com/vpl # # Software distributed under the License is distributed on an "AS IS" # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See # the License for the specific language governing rights and limitations # under the License. # # This code was originally developed by Vyatta, Inc. # Portions created by Vyatta are Copyright (C) 2006, 2007 Vyatta, Inc. # All Rights Reserved. # # Author: Tom Grennan # Date: 2007 # Description: setup bash completion for Vyatta operational commands # # **** End License **** # don't do this if we are going into configure mode if [ "$_OFR_CONFIGURE" == "ok" ]; then return 0 fi # first set vars per args of the "source ...vyatta-op VAR=FOO" _vyatta_extglob=$(shopt -p extglob) shopt -s extglob for e ; do if [[ $e == *=* ]] ; then eval $e fi done test -f /etc/default/vyatta && source /etc/default/vyatta : ${vyatta_op_templates:=/opt/vyatta/share/vyatta-op/templates} declare -a _vyatta_op_comp_words declare -a _vyatta_op_allowed declare _vyatta_op_node_def declare _vyatta_op_node_path declare -x OFR_PAGER declare -x OFR_DEFAULT_PAGER _vyatta_op_get_node_def_field () { local file=$1 field=$2 sed -n '/^'"$field"':/,$ { # strip field name and hold rest of line s/[a-z]*: *// h :b # at EOF, print hold buffer and quit $ { x; p; q } # input next line n # if start of another field def, print hold buf and quit /^[a-z]*:/ { x; p; q } # add to hold buf and branch to input next line H bb }' $file } _vyatta_op_set_allowed_subdirs () { local dir=$1 local -a sdir_ndefs sdirs local tag_ndef local restore_shopts=$( shopt -p extglob nullglob | tr \\n \; ) shopt -s extglob nullglob sdir_ndefs=( ${vyatta_op_templates}/${dir}/!(node.tag)/node.def ) sdirs=( ${sdir_ndefs[@]%/*} ) _vyatta_op_allowed=( ${sdirs[@]##*/} ) tag_ndef=${vyatta_op_templates}/${dir}/node.tag/node.def if [ -f $tag_ndef ] ; then local acmd=$( _vyatta_op_get_node_def_field $tag_ndef allowed ) _vyatta_op_allowed+=($( eval "$acmd" )) fi eval $restore_shopts } _vyatta_op_set_allowed () { local nullglob=$( shopt -p nullglob ) shopt -s nullglob _vyatta_op_allowed=($( eval "$( _vyatta_op_get_node_def_field $_vyatta_op_node_def allowed )" )) eval $nullglob } _vyatta_op_is_allowed () { local arg=$1 allowed # return immediately if nothing allowed [ ${#_vyatta_op_allowed[@]} -ne 0 ] || return for allowed in ${_vyatta_op_allowed[@]} ; do # -- is wildcard that allows anything [ $allowed == -- ] && return [ "$arg" == $allowed ] && return done false } _vyatta_op_scan () { local -a argv=( $@ ) local -i i=0 argc=$# local arg dir node_def local -a allowed local is_run=${argv[0]} argv=( "${argv[@]:1}" ) (( argc-- )) local last_tag=0 local tpath=${vyatta_op_templates} local end_space=0 if [ "${argv[argc-1]}" == "" ]; then end_space=1 argv=( "${argv[@]:0:((argc-1))}" ) (( argc-- )) fi local last_idx (( last_idx = argc - 1 )) for (( i = 0; i < argc; i++ )); do last_tag=0 arg=${argv[i]} local _tpath=$tpath/$arg if [ -d $_tpath ]; then tpath=$_tpath continue fi _tpath=$tpath/node.tag if [ -d $_tpath ]; then if (( i != last_idx || is_run )); then # validate value if (not last component) OR (called from "run") local ndef=$_tpath/node.def if [ ! -f $ndef ]; then # no template break fi _vyatta_op_node_def=$ndef _vyatta_op_set_allowed if ! _vyatta_op_is_allowed $arg ; then # invalid tag value. # XXX probably display "allowed:"-specific help string when # that is supported? break fi fi last_tag=1 tpath=$_tpath continue fi break done if (( i < last_idx )); then # some component before the last is invalid. return failure. return 1 fi if (( i == last_idx && end_space )); then # last component is a complete word and does not match template. # return failure. return 1 fi if (( is_run )); then # called from "run" if (( i == last_idx )); then # whole line must match return 1 fi # return the path _vyatta_op_node_path=$tpath return 0 fi if (( i == last_idx )); then # last component is an incomplete word. # this could be an incomplete "non-tag" node. _vyatta_op_node_path=$tpath _vyatta_op_set_allowed_subdirs ${tpath:${#vyatta_op_templates}} return 0 fi if (( !end_space )); then # if !last_tag: a complete non-tag node (without space at the end). # if last_tag: an incomplete tag node. # in either case, the possible completions include any subdirs plus # any allowed tag values _vyatta_op_node_path=${tpath%/*} _vyatta_op_set_allowed_subdirs \ ${_vyatta_op_node_path:${#vyatta_op_templates}} return 0 else # last component is a complete node. _vyatta_op_node_path=$tpath _vyatta_op_set_allowed_subdirs ${tpath:${#vyatta_op_templates}} return 0 fi } # $1: \@completions # $2: \@help_strs # assume the arrays are not empty _vyatta_op_print_help () { local -a comps=() local -a helps=() local -i taglen=12 eval "comps=( \"\${$1[@]}\" )" eval "helps=( \"\${$2[@]}\" )" echo -en "\nPossible completions:" for (( idx = 0 ; idx < ${#comps[@]} ; idx++ )) ; do if [ ${#comps[idx]} -lt $taglen ] ; then printf "\n %-${taglen}s\t%s" "${comps[idx]}" "${helps[idx]}" else printf "\n %s\n\t\t%s" "${comps[idx]}" "${helps[idx]}" fi done } _vyatta_op_help () { local help local -a subnodes local -a allowed local subdir local subtag local -a hcomps local -a hstrs if [ -d $_vyatta_op_node_path ]; then local restore_shopts=$( shopt -p extglob nullglob | tr \\n \; ) shopt -s extglob nullglob subnodes=( $_vyatta_op_node_path/!(node.tag)/node.def ) subtag=$_vyatta_op_node_path/node.tag/node.def eval $restore_shopts if [ -f $subtag ]; then allowed=($( eval "$( _vyatta_op_get_node_def_field $subtag allowed )" )) eval help="$( _vyatta_op_get_node_def_field $subtag help )" if [ ${#allowed[@]} -ne 0 ] ; then for a in "${allowed[@]}"; do hcomps+=( "$a" ) hstrs+=( "$help" ) done fi fi if [ ${#subnodes[@]} -ne 0 ] ; then for n in ${subnodes[@]} ; do eval help="$( _vyatta_op_get_node_def_field $n help )" subdir=${n%/node.def} hcomps+=( "${subdir##*/}" ) hstrs+=( "$help" ) done fi if [ ${#hcomps[@]} -eq 0 ]; then # no completions available return 1 fi _vyatta_op_print_help hcomps hstrs return 0 else return 1 fi } _vyatta_op_expand () { local cur=${COMP_WORDS[COMP_CWORD]} local a w if _vyatta_op_scan 0 "${COMP_WORDS[@]}" ; then a="${_vyatta_op_allowed[*]}" if [ "$a" != '--' ] ; then w=$a else w="" # donot expand wildcard fi COMPREPLY=($( compgen -W "$w" -- $cur )) if [[ ${#COMPREPLY[@]} -ne 0 || "$a" == '--' ]] && [[ "${COMP_WORDS[*]}" == "${_vyatta_op_comp_words[*]}" ]] then _vyatta_op_help COMPREPLY=($( compgen -o nospace -W "______________ ..." )) _vyatta_op_comp_words=( ) else _vyatta_op_comp_words=( "${COMP_WORDS[@]}" ) fi fi } _vyatta_op_run () { if _vyatta_op_scan 1 $@ ; then local ndef=$_vyatta_op_node_path/node.def if [ -f "$ndef" ]; then eval "$( _vyatta_op_get_node_def_field $ndef run )" return 0 fi fi echo "Invalid command" } for p in $PAGER pager most less more cat ; do if type -t $p &>/dev/null ; then OFR_DEFAULT_PAGER=$p break fi done : ${OFR_PAGER:=${OFR_DEFAULT_PAGER}} if [[ -d $vyatta_op_templates ]] then for xd in $vyatta_op_templates/* ; do if [ -d $xd ] ; then cmd=${xd##*/} complete -F _vyatta_op_expand $cmd eval alias $cmd=\'_vyatta_op_run $cmd\' fi done fi shopt -s histverify eval $_vyatta_extglob unset _vyatta_extglob bind 'set show-all-if-ambiguous on' ### Local Variables: ### mode: shell-script ### End: