awesome-scripts 之 self-installer.sh 脚本解读

awesome-scripts 项目提供了很多有用的脚本工具，本篇通过解读工具的安装脚本熟悉一些 shell 基本用法。

安装脚本的下载和执行

awesome-scripts 提供的脚本工具可以通过下面一行命令进行安装，显然就是远程获取 self-installer.sh 脚本然后执行安装

# curl -s 表示 silence 即不输出进度和错误信息
curl -s "https://raw.githubusercontent.com/superhj1987/awesome-scripts/master/self-installer.sh" | bash -s

首先对这个命令做一下解释。这里 shell 脚本可以放在 http 页面上，不用 download，可以直接执行。通常我们可以用 curl（Linux下强大的http命令行工具，默认就是一个 get 请求）的方式执行 http 页面上的 shell 脚本如下：

curl "http://xxx.com/xx/xx.sh" | bash
# 如果需要给脚本传参
curl http://example.com/script.sh | bash -s -- arg1 arg2 
# curl 命令其它常见用法 
# -o 将文件保存到执行文件名, -O 保存成文件，并将 URL 的最后部分当作文件名。
curl  https://www.baidu.com -o 2.txt # 保存为 2.txt
curl -O https://www.example.com/foo/bar.html # 保存为 bar.html
# -d 发送 post 参数，-X 参数指定 HTTP 请求的方法
curl -d 'login=emma＆password=123' -X POST https://google.com/login
# -u参数用来设置服务器认证的用户名和密码。
curl -u 'bob:12345' https://google.com/login

安装脚本

这个脚本的大致流程就是，用户选择下载还是下载安装，然后根据环境决定是从 git 或 svn 进行下载解压并编译安装

#!/bin/bash

# 用户交互，提供几个选项，根据用户输入进行相应动作
getType(){
    echo "1 : Download and install to current folder"
    echo "2 : Download only"
    echo "q : Quit" # 输出选项内容
    while(true) ;do
        echo -n "Enter a value:"  # echo -n 不换行输出，如果没有 -n 则用户输入则会换行看着不太好
        read choice < /dev/tty  # read 指令，read -p "please input name: " name 表示将用户的输入放入 name 变量，-p 后面跟提示信息，另外 -t ：等待秒数，-n：接收字符数，-s：隐藏输入的数据
                                # /dev/tty 就是当前使用的控制台，< 是输入重定向，这句话的意思就是将控制台的标准输入重定向给 choice，和上面的 read -p ”提示信息“ param 效果一样 
        if [ "$choice" = "q" ];then exit 0;fi # exit 命令用于退出当前 shell，在 shell 脚本中可以终止当前脚本执行。一般 0 表示正常退出，大于0表示异常退出
        if [ "$choice" -gt "0" 2>/dev/null ] && [ "$choice" -lt "4" 2>/dev/null ]; then # 同理 2>/dev/null 表示不要输出错误信息
            return $choice;
        else
            echo "$choice is not valid option!"
        fi
    done 
}

do_download(){
    fetch_dir=$1;  # 传入的是调用 shell 的当前目录
    if [ ! -d $fetch_dir ]; then # -d 表示判断文件存在且为文件夹
        echo "$fetch_dir is not vaild!"
        exit 1; # 返回失败
    fi
    cd $fetch_dir
    test_exists $fetch_dir # 校验是否存在
    set +e # 异常不要中断
    type "git" >/dev/null 2>/dev/null # type 命令一般被用于判断另外一个命令是否是内置命令，这里用来判断命令是否存在
    has_git=$?
    set -e
    if [ "$has_git" -eq 0 ];then # 如果上面的命令返回 0 说明 git 命令存在
        echo "fetching source from github"
        do_fetch  $fetch_dir;
    else
        set +e
        type "svn" >/dev/null 2>/dev/null
        has_svn=$?
        set -e
        if [ "$has_svn" -eq 0 ];then
            echo "fetching source from github using svn"
            do_fetch $fetch_dir svn;
        else
            echo "can't locate svn ,using archive mode."
            do_download_archive $fetch_dir;
        fi
    fi
    echo "awesome-scripts is downloaded to $fetch_dir/awesome-scripts"
}

do_download_archive(){
    wget https://codeload.github.com/superhj1987/awesome-scripts/zip/master -O awesome-scripts.zip
    unzip awesome-scripts.zip
    rm -rf awesome-scripts.zip
    mv awesome-scripts-master awesome-scripts
    cd awesome-scripts
}

do_fetch(){
    fetch_dir=$1;
    if [ ! -d $fetch_dir ]; then
        echo "$fetch_dir is not vaild!"
        exit 1;
    fi
    cd $fetch_dir ;
    test_exists awesome-scripts;
    if [[ $# < 2 || "$2" = "git" ]]; then  # 如果参数个数小于 2 个， 第二个参数是 git
        git clone https://github.com/superhj1987/awesome-scripts.git awesome-scripts --depth=1
    else
        svn checkout https://github.com/superhj1987/awesome-scripts/trunk awesome-scripts
    fi
    cd awesome-scripts 
    return 0 
}

test_exists(){
    if [ -e awesome-scripts ]; then # -e 表示文件是否存在（可以是文件或文件夹）
        echo "$1/awesome-scripts already exist!"
        while(true);do
            echo -n "(q)uit or (r)eplace?" # 退出还是继续下载并覆盖
            read choice < /dev/tty
            if [ "$choice" = "q" ];then
                exit 0;
            elif [ "$choice" = "r" ];then
                rm -fr $1/awesome-scripts # 如果是覆盖，则将已有文件删除
                break;
            else
                echo "$choice is not valid!"
            fi  
        done
    fi
}

do_install(){
    echo '***install need sudo,please enter password***'
    sudo make install
    echo 'awesome-scripts was installed to /usr/local/bin,have fun.'
}

main(){
    getType
    type=$? # $? 最后运行的命令的结束代码（返回值）
    set -e # 当命令的返回值为非零状态（异常）则立即退出脚本的执行，同理 set +e 表示脚本出现有错的时候继续执行下面的代码
    case "$type" in 
        ("1")
            echo "Launching awesome-scripts installer..."
            do_download `pwd` # 执行下载和安装，同时将 `pwd` 命令的输出结果作为参数传给 do_download 方法。
                              # 注意反引号括起来的字符串被shell解释为命令行，在执行时，shell首先执行该命令行，并以它的标准输出结果取代整个反引号（包括两个反引号）部分，也可以使用 $() 
            do_install
            ;;
        ("2")
            echo "Start downloading awesome-scripts ..."
            do_download `pwd` # 只下载
            ;;
    esac
}

main "$@" # 所有参数列表，

关联知识点

关于 shell 脚本中的特殊变量 $0、$?、$!、$$、$*、$#、$@

• $1～$n：添加到 Shell 的各参数值。$1是第1参数、$2是第2参数…
• $0：Shell 本身的文件名
• $#：添加到 Shell 的参数个数
• $@：所有参数列表。如"$@"用「"」括起来的情况、以"$1" "$2" … "$n"的形式输出所有参数。
• $\*：所有参数列表。如"$*"用「"」括起来的情况、以"$1 $2 … $n"的形式输出所有参数。
• $!：Shell最后运行的后台 Process 的 PID
• $$：Shell 本身的 PID（ProcessID）

# shell 测试脚本
#!/bin/bash

echo "\$# = params number: $#"
echo "\$0 = script file name: $0"
echo "\$1 = first param: $1"
echo "\$2 = second param: $2"
echo "\$@ = all params: $@"
echo "\$* = all params: $*"
echo "\$$ = shell pid: $$"
echo "\$! = last bg pid: $!"

# 运行 sh test.sh a b c d 可以看到输出
$# = params number: 4
$0 = script file name: test.sh
$1 = first param: a
$2 = second param: b
$@ = all params: a b c d
$* = all params: a b c d
$$ = shell pid: 58271
$! = last bg pid:

Shell 重定向

Linux 中一切皆文件，包括标准输入设备（键盘）和标准输出设备（显示器）在内的所有计算机硬件都是文件。Linux 程序在执行任何形式的 I/O 操作时，都是在读取或者写入一个文件描述符。一个文件描述符只是一个和打开的文件相关联的整数，它的背后可能是一个硬盘上的普通文件、FIFO、管道、终端、键盘、显示器，甚至是一个网络连接。stdin、stdout、stderr 默认都是打开的，在重定向的过程中，0、1、2 这三个文件描述符可以直接使用。

Linux Shell 重定向分为两种，一种输入重定向，一种是输出重定向；从字面上理解，输入输出重定向就是「改变输入与输出的方向」的意思。

输出重定向

输出重定向是指命令的结果不再输出到显示器上，而是输出到其它地方，一般是文件中。这样做的最大好处就是把命令的结果保存起来，当我们需要的时候可以随时查询。

注意：输出重定向的完整写法其实是fd>file或者fd>>file，其中 fd 表示文件描述符，如果不写，默认为 1，也就是标准输出文件。另外 > 两边不要加空格，否则会解析失败

最常见的指令莫过于

ls -l >out.log 2>&1 # 将命令 ls -l 的正确结果和错误结果一起保存在 out.log 文件
ls -l >out.log 2>err.log # 将命令 ls -l 的正确结果保存在 out.log 文件, 错误结果保存在 err.log
ls java &>/dev/null # 如果你既不想把命令的输出结果保存到文件，也不想把命令的输出结果显示到屏幕上，干扰命令的执行，那么可以把命令的所有结果重定向到 /dev/null 文件中。注意没有 & 的话, 错误结果还是会输出

输入重定向

输入重定向就是改变输入的方向，不再使用键盘作为命令输入的来源，而是使用文件作为命令的输入。

举个栗子，Linux wc 命令可以用来对文本进行统计，包括单词个数、行数、字节数，它的用法如下，其中，-c选项统计字节数，-w选项统计单词数，-l选项统计行数。

$ cat readme.txt  #预览一下文件内容
C语言中文网
http://c.biancheng.net/
成立7年了
日IP数万
$ wc -l <readme.txt  #输入重定向
4

问号表达式

下面的命令组使用了在 Bash 里称为 list constructs 的工具。它允许你通过 &&（代表 and） 和 || (代表 or） 将命令串到一起。上面的命令将会执行 ls java 命令，如果退出码是 0 命令 echo "lala" 将被执行。但如果 ls java 的退出码为 1 ，圆括号里的命令将在之后被执行。圆括号里的命令也通过 && 、 || 被串到一起。

$ ls # 当前目录下有三个文件夹
arthas  project temp
$ ls java && echo "lala" || (ls temp && echo "blabla" || echo "fail") # java 文件夹不存在，执行会异常，temp 文件夹存在可以正常输出里面的文件
ls: java: No such file or directory
err.log                log.text               self-installer-test.sh self-installer.sh      test.sh
blabla

exit code

在 Unix 和 Linux 系统中，程序可以在执行终止后传递值给其父进程。这个值被称为退出码（exit code）或退出状态（exit status）。在 POSIX 系统中，惯例做法是当程序成功执行时传递 0 ，当程序执行失败时传递 1 或比 1 大的值。

如果你不定义状态码，它仍然存在于你的脚本中。如果你不定义恰当的退出码，执行失败的脚本可能会返回成功的状态，这样就会导致问题出现！

举个栗子，下面的脚本既会执行 touch 命令也会执行 echo 命令。当我们以非 root 用户执行这个脚本时 touch 命令将会执行失败，可以看到，当执行 ./tmp.sh 后退出码是 0 ，而 0 代表脚本执行成功，虽然 touch 命令执行失败了。因为我们没有指定退出码所以脚本以最后一个命令执行后的状态码退出。在这个例子中，最后运行的是 echo 命令，这个命令确实执行成功了。

# tmp.sh 内容
#!/bin/bash
touch /root/test
echo created file
# 执行上面脚本看下
$ ./tmp.sh 
touch: cannot touch '/root/test': Permission denied
created file
$ echo $?
0

因此我们最好在脚本中自定义退出码，类似下面这样

#!/bin/bash

touch /root/test 2> /dev/null

if [$? -eq 0 ]
then
  echo "Successfully created file"
  exit 0
else
  echo "Could not create file" >&2
  exit 1
fi