base-files: sysupgrade: exit with no error for --help
[openwrt/openwrt.git] / package / base-files / files / sbin / sysupgrade
index 66bdf95de01735c16256ce0ff71ac49140e5bb84..592b1f378165a078d1a0ac13d4fd39780ac3aaca 100755 (executable)
@@ -4,26 +4,35 @@
 . /lib/functions/system.sh
 . /usr/share/libubox/jshn.sh
 
-# initialize defaults
+# File-local constants
+CONF_TAR=/tmp/sysupgrade.tgz
+ETCBACKUP_DIR=/etc/backup
+INSTALLED_PACKAGES=${ETCBACKUP_DIR}/installed_packages.txt
+COMMAND=/lib/upgrade/do_stage2
+
+# File-local globals
+SAVE_OVERLAY=0
+SAVE_OVERLAY_PATH=
+SAVE_PARTITIONS=1
+SAVE_INSTALLED_PKGS=0
+SKIP_UNCHANGED=0
+CONF_IMAGE=
+CONF_BACKUP_LIST=0
+CONF_BACKUP=
+CONF_RESTORE=
+NEED_IMAGE=
+HELP=0
+TEST=0
+
+# Globals accessed in other files
 export MTD_ARGS=""
 export MTD_CONFIG_ARGS=""
 export INTERACTIVE=0
 export VERBOSE=1
 export SAVE_CONFIG=1
-export SAVE_OVERLAY=0
-export SAVE_OVERLAY_PATH=
-export SAVE_PARTITIONS=1
-export SAVE_INSTALLED_PKGS=0
-export SKIP_UNCHANGED=0
-export CONF_IMAGE=
-export CONF_BACKUP_LIST=0
-export CONF_BACKUP=
-export CONF_RESTORE=
 export IGNORE_MINOR_COMPAT=0
-export NEED_IMAGE=
-export HELP=0
 export FORCE=0
-export TEST=0
+export CONFFILES=/tmp/sysupgrade.conffiles
 
 # parse options
 while [ -n "$1" ]; do
@@ -32,18 +41,18 @@ while [ -n "$1" ]; do
                -v) export VERBOSE="$(($VERBOSE + 1))";;
                -q) export VERBOSE="$(($VERBOSE - 1))";;
                -n) export SAVE_CONFIG=0;;
-               -c) export SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/etc;;
-               -o) export SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/;;
-               -p) export SAVE_PARTITIONS=0;;
-               -k) export SAVE_INSTALLED_PKGS=1;;
-               -u) export SKIP_UNCHANGED=1;;
-               -b|--create-backup) export CONF_BACKUP="$2" NEED_IMAGE=1; shift;;
-               -r|--restore-backup) export CONF_RESTORE="$2" NEED_IMAGE=1; shift;;
-               -l|--list-backup) export CONF_BACKUP_LIST=1;;
-               -f) export CONF_IMAGE="$2"; shift;;
+               -c) SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/etc;;
+               -o) SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/;;
+               -p) SAVE_PARTITIONS=0;;
+               -k) SAVE_INSTALLED_PKGS=1;;
+               -u) SKIP_UNCHANGED=1;;
+               -b|--create-backup) CONF_BACKUP="$2" NEED_IMAGE=1; shift;;
+               -r|--restore-backup) CONF_RESTORE="$2" NEED_IMAGE=1; shift;;
+               -l|--list-backup) CONF_BACKUP_LIST=1;;
+               -f) CONF_IMAGE="$2"; shift;;
                -F|--force) export FORCE=1;;
-               -T|--test) export TEST=1;;
-               -h|--help) export HELP=1; break;;
+               -T|--test) TEST=1;;
+               -h|--help) HELP=1; break;;
                --ignore-minor-compat-version) export IGNORE_MINOR_COMPAT=1;;
                -*)
                        echo "Invalid option: $1" >&2
@@ -54,14 +63,7 @@ while [ -n "$1" ]; do
        shift;
 done
 
-export CONFFILES=/tmp/sysupgrade.conffiles
-export CONF_TAR=/tmp/sysupgrade.tgz
-export ETCBACKUP_DIR=/etc/backup
-export INSTALLED_PACKAGES=${ETCBACKUP_DIR}/installed_packages.txt
-
-IMAGE="$1"
-
-[ -z "$IMAGE" -a -z "$NEED_IMAGE" -a $CONF_BACKUP_LIST -eq 0 -o $HELP -gt 0 ] && {
+print_help() {
        cat <<EOF
 Usage: $0 [<upgrade-option>...] <image file or URL>
        $0 [-q] [-i] [-c] [-u] [-o] [-k] <backup-command> <file>
@@ -101,9 +103,20 @@ backup-command:
                     sysupgrade -b. Does not create a backup file.
 
 EOF
-       exit 1
 }
 
+IMAGE="$1"
+
+if [ $HELP -gt 0 ]; then
+       print_help
+       exit 0
+fi
+
+if [ -z "$IMAGE" -a -z "$NEED_IMAGE" -a $CONF_BACKUP_LIST -eq 0 ]; then
+       print_help
+       exit 1
+fi
+
 [ -n "$IMAGE" -a -n "$NEED_IMAGE" ] && {
        cat <<-EOF
                -b|--create-backup and -r|--restore-backup do not perform a firmware upgrade.
@@ -202,7 +215,7 @@ add_overlayfiles() {
 
 if [ $SAVE_OVERLAY = 1 ]; then
        [ ! -d /overlay/upper/etc ] && {
-               echo "Cannot find '/overlay/upper/etc', required for '-c'" >&2
+               echo "Cannot find '/overlay/upper/etc', required for '-c' or '-o'" >&2
                exit 1
        }
        sysupgrade_init_conffiles="add_overlayfiles"
@@ -223,8 +236,8 @@ include /lib/upgrade
 
 do_save_conffiles() {
        local conf_tar="$1"
-       local tmp
-       local dir
+
+       local umount_etcbackup_dir=0
 
        [ "$(rootfs_type)" = "tmpfs" ] && {
                echo "Cannot save config while running from ramdisk." >&2
@@ -235,44 +248,41 @@ do_save_conffiles() {
        run_hooks "$CONFFILES" $sysupgrade_init_conffiles
        ask_bool 0 "Edit config file list" && vi "$CONFFILES"
 
-       # Mount root directory with temporary overlay on top of it.
-       # This allows including extra (temporary) files in backup archive
-       # without messing actual rootfs.
-       tmp="$(mktemp -d -t overlay.XXXXXX)"
-       mkdir -p "$tmp/upper" "$tmp/work" "$tmp/backup"
-       dir="$tmp/backup"
-       if ! mount -t overlay overlay -o lowerdir=/,upperdir="$tmp/upper",workdir="$tmp/work" "$dir"; then
-               echo "Cannot mount backup overlay to $dir." >&2
-               ask_bool 0 "Abort" && exit
-               dir=""
-       fi
-
        if [ "$SAVE_INSTALLED_PKGS" -eq 1 ]; then
                echo "${INSTALLED_PACKAGES}" >> "$CONFFILES"
-               mkdir -p "$dir/$ETCBACKUP_DIR"
-
-               # Format: pkg-name<TAB>{rom,overlay,unkown}
+               mkdir -p "$ETCBACKUP_DIR"
+               # Avoid touching filesystem on each backup
+               RAMFS="$(mktemp -d -t sysupgrade.XXXXXX)"
+               mkdir -p "$RAMFS/upper" "$RAMFS/work"
+               mount -t overlay overlay -o lowerdir=$ETCBACKUP_DIR,upperdir=$RAMFS/upper,workdir=$RAMFS/work $ETCBACKUP_DIR &&
+                       umount_etcbackup_dir=1 || {
+                               echo "Cannot mount '$ETCBACKUP_DIR' as tmpfs to avoid touching disk while saving the list of installed packages." >&2
+                               ask_bool 0 "Abort" && exit
+                       }
+
+               # Format: pkg-name<TAB>{rom,overlay,unknown}
                # rom is used for pkgs in /rom, even if updated later
                find /usr/lib/opkg/info -name "*.control" \( \
                        \( -exec test -f /rom/{} \; -exec echo {} rom \; \) -o \
                        \( -exec test -f /overlay/upper/{} \; -exec echo {} overlay \; \) -o \
                        \( -exec echo {} unknown \; \) \
-                       \) | sed -e 's,.*/,,;s/\.control /\t/' > "$dir/${INSTALLED_PACKAGES}"
+                       \) | sed -e 's,.*/,,;s/\.control /\t/' > ${INSTALLED_PACKAGES}
        fi
 
        v "Saving config files..."
        [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
        sed -i -e 's,^/,,' "$CONFFILES"
-       tar c${TAR_V}zf "$conf_tar" -C "${dir:-/}" -T "$CONFFILES"
+       tar c${TAR_V}zf "$conf_tar" -C / -T "$CONFFILES"
        local err=$?
        if [ "$err" -ne 0 ]; then
                echo "Failed to create the configuration backup."
                rm -f "$conf_tar"
        fi
 
-       umount "$dir"
-       rm -rf "$tmp"
-
+       [ "$umount_etcbackup_dir" -eq 1 ] && {
+               umount "$ETCBACKUP_DIR"
+               rm -rf "$RAMFS"
+       }
        rm -f "$CONFFILES"
 
        return "$err"
@@ -371,8 +381,6 @@ fi
 install_bin /sbin/upgraded
 v "Commencing upgrade. Closing all shell sessions."
 
-COMMAND='/lib/upgrade/do_stage2'
-
 if [ -n "$FAILSAFE" ]; then
        printf '%s\x00%s\x00%s' "$RAM_ROOT" "$IMAGE" "$COMMAND" >/tmp/sysupgrade
        lock -u /tmp/.failsafe