self extract 以 bash script 建立自解壓的安裝檔

本文主要譯自這兒，用 bash script 建立可以自己解壓的安裝檔(self extract installing file)。

一般利用 tar 來壓縮檔案，在安裝時並不存在像 Zip類似的「解壓後執行」功能，因此無法建立自解壓的安裝檔。Unix 其實有很好的工具可以做到這一點，原理不難，就是利用一個標籤(本文用的是 __ARCHIVE_BELOW__ 來把 shell script 與壓縮檔分開，再利用 awk 與 tail 把此壓縮檔取出來後再安裝。

本文只是簡單示範，想要更聰明的安裝，例如事先指定安裝目錄等等，請自行修改，另外本文雖然示範安裝二個純文字檔，真正在用的時候並沒有此限制，您可以安裝任何檔。為了開放彈性的安裝程序，有個 installer 是解壓後執行，用來真正安裝檔案。

先把整個目錄結構介紹一下：

$ ls -FR .
.:
build*  decompress*  payload/  selfextract.bsx*

./payload:
files.tar  installer*

整個過程其目的是將 payload/files.tar 中被壓縮的檔案安裝到其他機器的系統中，目前該檔只有二個檔如下：

$ tar tvf files.tar
-rw-r--r-- Wade/Wade 11 2008-08-11 09:13 File1.txt
-rw-r--r-- Wade/Wade 22 2008-08-11 09:13 File2.txt

build 這個檔用來將 decompress 及 payload/ 包裝成自解壓的檔，而 decompress 是整個自解壓檔的「頭部」， payload 則是尾部，中間以 __ARCHIVE_BELOW__ 連接。所以這邊有三個 script file, 一個是安裝用的 installer, 一個是解壓用的 decompress, 一個是用來建立自解壓安裝檔用的 build，這三個檔的內容如下：

build:

#!/bin/bash
# 底下三行把 payload 包裝成 payload.tar
cd payload
tar cf ../payload.tar ./*
cd ..

if [ -e "payload.tar" ]; then
  gzip payload.tar  # 用 gzip 壓縮以減小檔案大小

  # 檢查確實有壓成功的話，再將之附到 decompress 後面變成新檔 selfextract.bsx
  if [ -e "payload.tar.gz" ]; then
    cat decompress payload.tar.gz > selfextract.bsx
  else
    echo "payload.tar.gz does not exist"
    exit 1
  fi
else
  echo "payload.tar does not exist"
  exit 1
fi

echo "selfextract.bsx created"
rm -f payload.tar.gz  # 捨棄不要的檔
exit 0

decompress:

#!/bin/bash
echo ""
echo "Self Extracting Installer"
echo ""
# 用 mktemp -d 建立暫時目錄
export TMPDIR=`mktemp -d /tmp/selfextract.XXXXXX`
# 取得前面的 payload.tar.gz 這個壓縮檔內容
ARCHIVE=`awk '/^__ARCHIVE_BELOW__/ {print NR + 1; exit 0; }' $0`
# 配合 tail 及 tar 將之解壓
tail -n+$ARCHIVE $0 | tar xzv -C $TMPDIR

CDIR=$PWD
cd $TMPDIR

# 執行 installer 安裝檔案
./installer

cd $CDIR
rm -rf $TMPDIR # 刪除不必要的暫時檔

exit 0

__ARCHIVE_BELOW__

installer:

#!/bin/bash
# 取得要安裝的目錄，此時的 $PWD 是上面提到的暫時目錄
echo -n "The install directory is ($PWD)? "
read INSTALLDIR
[ "x$INSTALLDIR" = "x" ] && INSTALLDIR=$PWD
# 處理安裝目錄已存在的情況
if [ -e $INSTALLDIR ]; then
  if [ -f $INSTALLDIR ]; then
    echo -n "The $INSTALLDIR is in file type, remove it at first (Yes)? "
    read REMOVE
    [ "x$INSTALLDIR" = "x" -o "x$INSTALLDIR" = "Yes" ] && rm -rf $INSTALLDIR || exit 0
  elif [ -d $INSTALLDIR ]; then
    echo -n "The $INSTALLDIR already exist, remove it at first (No)? "
    read REMOVE
    [ "x$INSTALLDIR" = "xYes" ] && rm -rf $INSTALLDIR
  fi
fi
mkdir -p $INSTALLDIR  # 產生安裝目錄
tar xvf ./files.tar -C $INSTALLDIR

特別強調一下，這個 installer 應視需要自行修改，執行畫面如下：

包裝成自解壓檔:

$ ./build
/home/Wade/installer/payload
selfextract.bsx created

$ \ls -FR .
.:
build*  decompress*  payload/  selfextract.bsx

./payload:
files.tar  installer*

執行 selfextract.bsx:

$ bash selfextract.bsx

Self Extracting Installer

./files.tar
./installer
The install directory is (/tmp/selfextract.Wo2424)? /tmp/files
File1.txt
File2.txt

$ ls -l /tmp/files
total 2
-rw-r--r-- 1 Wade Wade 11 Aug 11 09:13 File1.txt
-rw-r--r-- 1 Wade Wade 22 Aug 11 09:13 File2.txt