getopt:命令行选项、参数处理

脚本25阅读模式

在写shell脚本时经常会用到命令行选项、参数处理方式,如:

  1. ./test.sh -f config.conf -v --prefix=/home

-f 为短选项,它需要一个参数,即config.conf, -v也是一个选项,但它不需要参数
--prefix 是一个长选项,即选项本身多于一个字符,它也需要一个参数,用等号连接,当然等号不是必须的,/home可以直接写在--prefix后面,即--prefix=/home

在shell中,可以用以下三种方式来处理命令行参数,每种方式都有自己的应用场景

下面我们依次讨论这三种处理方式

1. 手工处理方式
在手工处理方式中,首先要知道几个变量,还是以上面的命令行为例:

$0 : ./test.sh,即命令本身,相当于C/C++中的argv[0]
$1 : -f,第一个参数
$2 : config.conf
$3, $4 ... :类推。
$#  : 参数的个数,不包括命令本身,上例中$#为4.
$@ : 参数本身的列表,也不包括命令本身,如上例为 -f config.conf -v --prefix=/home
$*   : 和$@相同,但"$*" 和 "$@"(加引号)并不同,"$*"将所有的参数解释成一个字符串,而"$@"是一个参数数组。如下例所示:

  1. #!/bin/bash
  2. for arg in "$*"
  3. do
  4. echo $arg
  5. done
  6.  
  7. echo
  8.  
  9. for arg in "$@"
  10. do
  11. echo $arg
  12. done
  1. $ bash test.sh -f config.conf -v --prefix=/home
  2. -f config.conf -v --prefix=/home #这是"$*"的输出
  3.  
  4. -f #以下为$@的输出
  5. config.conf
  6. -v
  7. --prefix=/home

所以,手工处理的方式即对这些变量的处理。因为手工处理高度依赖于你在命令行上所传参数的位置,所以一般都只用来处理较简单的参数。如./test.sh 10。而很少使用./test -n 10这种带选项的方式。

手工处理方式能满足大多数的简单需求,配合shift使用也能构造出强大的功能,但在要处理复杂选项的时候建议用下面的两种方法。

2. getopts/getopt
处理命令行参数是一个相似而又复杂的事情,在shell中,处理此事的是getopts和getopt

getopts和getopt功能相似但又不完全相同,其中getopt是独立的可执行文件,而getopts是由bash内置的

先来看看参数传递的典型用法:

./test.sh -a -b -c  : 短选项,各选项不需参数
./test.sh -abc   : 短选项,和上一种方法的效果一样,只是将所有的选项写在一起。
./test.sh -a args -b -c :短选项,其中-a需要参数,而-b -c不需参数。
./test.sh --a-long=args --b-long :长选项

我们先来看getopts,它不支持长选项。使用getopts非常简单:

  1. #!/bin/bash
  2. while getopts "a:bc" arg #选项后面的冒号表示该选项需要参数
  3. do
  4. case $arg in
  5. a)
  6. echo "a's arg:$OPTARG" #参数存在$OPTARG中
  7. ;;
  8. b)
  9. echo "b"
  10. ;;
  11. c)
  12. echo "c"
  13. ;;
  14. ?) #当有不认识的选项的时候arg为?
  15. echo "unkonw argument"
  16. exit 1
  17. ;;
  18. esac
  19. done
  1. $ bash test.sh -a arg -b -c
  2. a's arg:arg
  3. b
  4. c
  5. $ bash test.sh -a arg -bc
  6. a's arg:arg
  7. b
  8. c

应该说绝大多数脚本使用该函数就可以了,如果需要支持长选项以及可选参数,那么就需要使用getopt

  1. #!/bin/bash
  2.  
  3. #-o表示短选项,两个冒号表示该选项有一个可选参数,可选参数必须紧贴选项
  4. #如-carg 而不能是-c arg
  5. #--long表示长选项
  6. #"$@"在上面解释过
  7. # -n:出错时的信息
  8. # -- :举一个例子比较好理解:
  9. #我们要创建一个名字为 "-f"的目录你会怎么办?
  10. # mkdir -f #不成功,因为-f会被mkdir当作选项来解析,这时就可以使用
  11. # mkdir -- -f 这样-f就不会被作为选项。
  12.  
  13. TEMP=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
  14. -n 'example.bash' -- "$@"`
  15.  
  16. if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
  17.  
  18. # Note the quotes around `$TEMP': they are essential!
  19. #set 会重新排列参数的顺序,也就是改变$1,$2...$n的值,这些值在getopt中重新排列过了
  20. eval set -- "$TEMP"
  21.  
  22. #经过getopt的处理,下面处理具体选项。
  23.  
  24. while true ; do
  25. case "$1" in
  26. -a|--a-long) echo "Option a" ; shift ;;
  27. -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;;
  28. -c|--c-long)
  29. # c has an optional argument. As we are in quoted mode,
  30. # an empty parameter will be generated if its optional
  31. # argument is not found.
  32. case "$2" in
  33. "") echo "Option c, no argument"; shift 2 ;;
  34. *) echo "Option c, argument \`$2'" ; shift 2 ;;
  35. esac ;;
  36. --) shift ; break ;;
  37. *) echo "Internal error!" ; exit 1 ;;
  38. esac
  39. done
  40. echo "Remaining arguments:"
  41. for arg do
  42. echo '--> '"\`$arg'" ;
  43. done
  1. $ bash test.sh -a -b arg arg1 -c
  2. Option a
  3. Option b, argument `arg'
  4. Option c, no argument
  5. Remaining arguments:
  6. --> `arg1'

可以看到,命令行中多了个arg1参数,在经过getopt和set之后,命令行会变为:
-a -b arg -c -- arg1
$1指向-a,$2指向-b,$3指向arg,$4指向-c,$5指向--,而多出的arg1则被放到了最后

3. 举例
如将前面的ssh.expscp.exp封装起来,代码:

  1. #!/bin/bash
  2.  
  3. ###################### proc defination ########################
  4. # ignore rule
  5. ignore_init()
  6. {
  7. # ignore password
  8. array_ignore_pwd_length=0
  9. if [ -f ./ignore_pwd ]; then
  10. while read IGNORE_PWD
  11. do
  12. array_ignore_pwd[$array_ignore_pwd_length]=$IGNORE_PWD
  13. let array_ignore_pwd_length=$array_ignore_pwd_length+1
  14. done < ./ignore_pwd
  15. fi
  16.  
  17. # ignore ip address
  18. array_ignore_ip_length=0
  19. if [ -f ./ignore_ip ]; then
  20. while read IGNORE_IP
  21. do
  22. array_ignore_ip[$array_ignore_ip_length]=$IGNORE_IP
  23. let array_ignore_ip_length=$array_ignore_ip_length+1
  24. done < ./ignore_ip
  25. fi
  26. }
  27.  
  28. show_version()
  29. {
  30. echo "version: 1.0"
  31. echo "updated date: 2014-01-09"
  32. }
  33.  
  34. show_usage()
  35. {
  36. echo -e "`printf %-16s "Usage: $0"` [-h|--help]"
  37. echo -e "`printf %-16s ` [-v|-V|--version]"
  38. echo -e "`printf %-16s ` [-l|--iplist ... ]"
  39. echo -e "`printf %-16s ` [-c|--config ... ]"
  40. echo -e "`printf %-16s ` [-t|--sshtimeout ... ]"
  41. echo -e "`printf %-16s ` [-T|--fttimeout ... ]"
  42. echo -e "`printf %-16s ` [-L|--bwlimit ... ]"
  43. echo -e "`printf %-16s ` [-n|--ignore]"
  44. #echo "ignr_flag: 'ignr'-some ip will be ignored; otherwise-all ip will be handled"
  45. }
  46.  
  47. # Default Parameters
  48. myIFS=":::" # 配置文件中的分隔符
  49.  
  50. TOOLDIR=/root/scripts
  51. cd $TOOLDIR
  52.  
  53. IPLIST="iplist.txt" # IP列表,格式为IP 端口 用户名 密码
  54. CONFIG_FILE="config.txt" # 命令列表和文件传送配置列表,关键字为com:::和file:::
  55. IGNRFLAG="noignr" # 如果置为ignr,则脚本会进行忽略条件的判断
  56. SSHTIMEOUT=100 # 远程命令执行相关操作的超时设定,单位为秒
  57. SCPTIMEOUT=2000 # 文件传送相关操作的超时设定,单位为秒
  58. BWLIMIT=1024000 # 文件传送的带宽限速,单位为kbit/s
  59.  
  60. # 入口参数分析
  61. TEMP=`getopt -o hvVl:c:t:T:L:n --long help,version,iplist:,config:,sshtimeout:,fttimeout:,bwlimit:,ignore -- "$@" 2>/dev/null`
  62.  
  63. [ $? != 0 ] && echo -e "\033[31mERROR: unknown argument! \033[0m\n" && show_usage && exit 1
  64.  
  65. # 会将符合getopt参数规则的参数摆在前面,其他摆在后面,并在最后面添加--
  66. eval set -- "$TEMP"
  67.  
  68. while :
  69. do
  70. [ -z "$1" ] && break;
  71. case "$1" in
  72. -h|--help)
  73. show_usage; exit 0
  74. ;;
  75. -v|-V|--version)
  76. show_version; exit 0
  77. ;;
  78. -l|--iplist)
  79. IPLIST=$2; shift 2
  80. ;;
  81. -c|--config)
  82. CONFIG_FILE=$2; shift 2
  83. ;;
  84. -t|--sshtimeout)
  85. SSHTIMEOUT=$2; shift 2
  86. ;;
  87. -T|--fttimeout)
  88. SCPTIMEOUT=$2; shift 2
  89. ;;
  90. -L|--bwlimit)
  91. BWLIMIT=$2; shift 2
  92. ;;
  93. -n|--ignore)
  94. IGNRFLAG="ignr"; shift
  95. ;;
  96. --)
  97. shift
  98. ;;
  99. *)
  100. echo -e "\033[31mERROR: unknown argument! \033[0m\n" && show_usage && exit 1
  101. ;;
  102. esac
  103. done
  104.  
  105. ################ main #######################
  106. BEGINDATETIME=`date "+%F %T"`
  107. [ ! -f $IPLIST ] && echo -e "\033[31mERROR: iplist \"$IPLIST\" not exists, please check! \033[0m\n" && exit 1
  108.  
  109. [ ! -f $CONFIG_FILE ] && echo -e "\033[31mERROR: config \"$CONFIG_FILE\" not exists, please check! \033[0m\n" && exit 1
  110.  
  111. echo
  112. echo "You are using:"
  113. echo -e "`printf %-16s "\"$CONFIG_FILE\""` ---- as your config"
  114. echo -e "`printf %-16s "\"$IPLIST\""` ---- as your iplist"
  115. echo -e "`printf %-16s "\"$SSHTIMEOUT\""` ---- as your ssh timeout"
  116. echo -e "`printf %-16s "\"$SCPTIMEOUT\""` ---- as your scp timeout"
  117. echo -e "`printf %-16s "\"$BWLIMIT\""` ---- as your bwlimit"
  118. echo -e "`printf %-16s "\"$IGNRFLAG\""` ---- as your ignore flag"
  119. echo
  120.  
  121. [ -f ipnologin.txt ] && rm -f ipnologin.txt
  122. IPSEQ=0
  123. while read IP PORT USER PASSWD PASSWD_2ND PASSWD_3RD PASSWD_4TH OTHERS
  124. do
  125. [ -z "`echo $IP | grep -E '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}'`" ] && continue
  126. [ "`python $TOOLDIR/ckssh.py $IP $PORT`" == 'no' ] && echo "$IP" >> ipnologin.txt && continue
  127.  
  128. let IPSEQ=$IPSEQ+1
  129.  
  130. # 如果启用了忽略,则进入忽略流程
  131. if [ $IGNRFLAG == "ignr" ]; then
  132. ignore_init
  133. ignored_flag=0
  134.  
  135. i=0
  136. while [ $i -lt $array_ignore_pwd_length ]
  137. do
  138. [ ${PASSWD}x == ${array_ignore_pwd[$i]}x ] && ignored_flag=1 && break
  139. let i=$i+1
  140. done
  141.  
  142. [ $ignored_flag -eq 1 ] && continue
  143.  
  144. j=0
  145. while [ $j -lt $array_ignore_ip_length ]
  146. do
  147. [ ${IP}x == ${array_ignore_ip[$j]}x ] && ignored_flag=1 && break
  148. let j=$j+1
  149. done
  150.  
  151. [ $ignored_flag -eq 1 ] && continue
  152.  
  153. fi
  154.  
  155. ####### Try password from here ####
  156. for PW in $PASSWD $PASSWD_2ND $PASSWD_3RD $PASSWD_4TH
  157. do
  158. PASSWD_USE=$PW
  159. $TOOLDIR/ssh.exp $IP $USER $PW $PORT true $SSHTIMEOUT
  160. [ $? -eq 0 ] && PASSWD_USE=$PW && break
  161. done
  162.  
  163. # 针对一个$IP,执行配置文件中的一整套操作
  164. while read eachline
  165. do
  166. # 必须以com或file开头
  167. [ -z "`echo $eachline | grep -E '^com|^file'`" ] && continue
  168.  
  169. myKEYWORD=`echo $eachline | awk -F"$myIFS" '{ print $1 }'`
  170. myCONFIGLINE=`echo $eachline | awk -F"$myIFS" '{ print $2 }'`
  171.  
  172. # 对配置文件中的预定义的可扩展特殊字符串进行扩展
  173. # 关键字#IP#,用$IP进行替换
  174. if [ ! -z "`echo "$myCONFIGLINE" | grep '#IP#'`" ]; then
  175. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#IP#/$IP/g"`
  176. myCONFIGLINE=$myCONFIGLINE_temp
  177. fi
  178.  
  179. # 时间相关关键字,用当前时间进行替换
  180. if [ ! -z "`echo "$myCONFIGLINE" | grep '#YYYY#'`" ]; then
  181. myYEAR=`date +%Y`
  182. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#YYYY#/$myYEAR/g"`
  183. myCONFIGLINE=$myCONFIGLINE_temp
  184. fi
  185.  
  186. if [ ! -z "`echo "$myCONFIGLINE" | grep '#MM#'`" ]; then
  187. myMONTH=`date +%m`
  188. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#MM#/$myMONTH/g"`
  189. myCONFIGLINE=$myCONFIGLINE_temp
  190. fi
  191.  
  192. if [ ! -z "`echo "$myCONFIGLINE" | grep '#DD#'`" ]; then
  193. myDATE=`date +%d`
  194. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#DD#/$myDATE/g"`
  195. myCONFIGLINE=$myCONFIGLINE_temp
  196. fi
  197.  
  198. if [ ! -z "`echo "$myCONFIGLINE" | grep '#hh#'`" ]; then
  199. myHOUR=`date +%H`
  200. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#hh#/$myHOUR/g"`
  201. myCONFIGLINE=$myCONFIGLINE_temp
  202. fi
  203.  
  204. if [ ! -z "`echo "$myCONFIGLINE" | grep '#mm#'`" ]; then
  205. myMINUTE=`date +%M`
  206. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#mm#/$myMINUTE/g"`
  207. myCONFIGLINE=$myCONFIGLINE_temp
  208. fi
  209.  
  210. if [ ! -z "`echo "$myCONFIGLINE" | grep '#ss#'`" ]; then
  211. mySECOND=`date +%S`
  212. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#ss#/$mySECOND/g"`
  213. myCONFIGLINE=$myCONFIGLINE_temp
  214. fi
  215.  
  216. # IPSEQ关键字,用当前IP的序列号替换,从1开始
  217. if [ ! -z "`echo "$myCONFIGLINE" | grep '#IPSEQ#'`" ]; then
  218. myCONFIGLINE_temp=`echo $myCONFIGLINE | sed "s/#IPSEQ#/$IPSEQ/g"`
  219. myCONFIGLINE=$myCONFIGLINE_temp
  220. fi
  221.  
  222. # 配置文件中有关键字file:::,就调用scp.exp进行文件传送
  223. if [ "$myKEYWORD"x == "file"x ]; then
  224. SOURCEFILE=`echo $myCONFIGLINE | awk '{ print $1 }'`
  225. DESTDIR=`echo $myCONFIGLINE | awk '{ print $2 }'`
  226. DIRECTION=`echo $myCONFIGLINE | awk '{ print $3 }'`
  227. $TOOLDIR/scp.exp $IP $USER $PASSWD_USE $PORT $SOURCEFILE $DESTDIR $DIRECTION $BWLIMIT $SCPTIMEOUT
  228.  
  229. [ $? -ne 0 ] && echo -e "\033[31mSCP Try Out All Password Failed\033[0m\n"
  230.  
  231. # 配置文件中有关键字com:::,就调用ssh.exp进行远程命令执行
  232. elif [ "$myKEYWORD"x == "com"x ]; then
  233. $TOOLDIR/ssh.exp $IP $USER $PASSWD_USE $PORT "${myCONFIGLINE}" $SSHTIMEOUT
  234. [ $? -ne 0 ] && echo -e "\033[31mSSH Try Out All Password Failed\033[0m\n"
  235.  
  236. else
  237. echo "ERROR: configuration wrong! [$eachline] "
  238. echo " where KEYWORD should not be [$myKEYWORD], but 'com' or 'file'"
  239. echo " if you dont want to run it, you can comment it with '#'"
  240. echo ""
  241. exit
  242. fi
  243.  
  244. done < $CONFIG_FILE
  245.  
  246. done < $IPLIST
  247.  
  248. ENDDATETIME=`date "+%F %T"`
  249.  
  250. echo "$BEGINDATETIME -- $ENDDATETIME"
  251. echo "$0 $* --excutes over!"
  252.  
  253. exit 0

参考:http://www.cnblogs.com/FrankTan/archive/2010/03/01/1634516.html

Sat Jan 11 14:55:03 CST 2014

 
  • 本文由 yeho 发表于 2014-01-11
  • 转载请务必保留本文链接:https://linuxeye.com/389.html
  • getopt
脚本

Python脚本批量检查SSL证书过期时间

背景 云平台https的域名服务器如果超过上百条,如果都分布在不同的服务器或者负载均衡上,如果即将过期, 做完替换SSL证书动作后,如何批量检查域名的SSL证书是否替换网站,可通过如下脚本实现。 Py...
脚本

腾讯云COS上传、批量删除工具(Python)

腾讯云对象存储COS是类似于阿里云OSS,相比OSS,COS提供每月免费额度:存储空间50G、外网访问流量10G(内网免费)、免费读请求100万次、写请求10万次。对网站备份来说不错,但是,腾讯云提供...
脚本

Imagemagick升级脚本-OneinStack

5月3日,图像处理软件ImageMagick就被公布出一个严重的0day漏洞(CVE-2016-3714),攻击者通过此漏洞可执行任意命令,最终窃取重要信息取得服务器控制权。 详细信息参考:https...