package/base-files/files/sbin/sysupgrade

   1 #!/bin/sh
   2 . /lib/functions.sh
   3
   4 # initialize defaults
   5 RAMFS_COPY_BIN=""       # extra programs for temporary ramfs root
   6 RAMFS_COPY_DATA=""      # extra data files
   7 export INTERACTIVE=0
   8 export VERBOSE=1
   9 export SAVE_CONFIG=1
  10 export SAVE_OVERLAY=0
  11 export DELAY=
  12 export CONF_IMAGE=
  13 export CONF_BACKUP_LIST=0
  14 export CONF_BACKUP=
  15 export CONF_RESTORE=
  16 export NEED_IMAGE=
  17 export HELP=0
  18 export FORCE=0
  19 export TEST=0
  20
  21 # parse options
  22 while [ -n "$1" ]; do
  23         case "$1" in
  24                 -i) export INTERACTIVE=1;;
  25                 -d) export DELAY="$2"; shift;;
  26                 -v) export VERBOSE="$(($VERBOSE + 1))";;
  27                 -q) export VERBOSE="$(($VERBOSE - 1))";;
  28                 -n) export SAVE_CONFIG=0;;
  29                 -c) export SAVE_OVERLAY=1;;
  30                 -b|--create-backup) export CONF_BACKUP="$2" NEED_IMAGE=1; shift;;
  31                 -r|--restore-backup) export CONF_RESTORE="$2" NEED_IMAGE=1; shift;;
  32                 -l|--list-backup) export CONF_BACKUP_LIST=1; break;;
  33                 -f) export CONF_IMAGE="$2"; shift;;
  34                 -F|--force) export FORCE=1;;
  35                 -T|--test) export TEST=1;;
  36                 -h|--help) export HELP=1; break;;
  37                 -*)
  38                         echo "Invalid option: $1"
  39                         exit 1
  40                 ;;
  41                 *) break;;
  42         esac
  43         shift;
  44 done
  45
  46 export CONFFILES=/tmp/sysupgrade.conffiles
  47 export CONF_TAR=/tmp/sysupgrade.tgz
  48
  49 export ARGV="$*"
  50 export ARGC="$#"
  51
  52 [ -z "$ARGV" -a -z "$NEED_IMAGE" -o $HELP -gt 0 ] && {
  53         cat <<EOF
  54 Usage: $0 [<upgrade-option>...] <image file or URL>
  55        $0 [-q] [-i] <backup-command> <file>
  56
  57 upgrade-option:
  58         -d <delay>   add a delay before rebooting
  59         -f <config>  restore configuration from .tar.gz (file or url)
  60         -i           interactive mode
  61         -c           attempt to preserve all changed files in /etc/
  62         -n           do not save configuration over reflash
  63         -T | --test
  64                      Verify image and config .tar.gz but do not actually flash.
  65         -F | --force
  66                      Flash image even if image checks fail, this is dangerous!
  67         -q           less verbose
  68         -v           more verbose
  69         -h | --help  display this help
  70
  71 backup-command:
  72         -b | --create-backup <file>
  73                      create .tar.gz of files specified in sysupgrade.conf
  74                      then exit. Does not flash an image. If file is '-',
  75                      i.e. stdout, verbosity is set to 0 (i.e. quiet).
  76         -r | --restore-backup <file>
  77                      restore a .tar.gz created with sysupgrade -b
  78                      then exit. Does not flash an image. If file is '-',
  79                      the archive is read from stdin.
  80         -l | --list-backup
  81                      list the files that would be backed up when calling
  82                      sysupgrade -b. Does not create a backup file.
  83
  84 EOF
  85         exit 1
  86 }
  87
  88 [ -n "$ARGV" -a -n "$NEED_IMAGE" ] && {
  89         cat <<-EOF
  90                 -b|--create-backup and -r|--restore-backup do not perform a firmware upgrade.
  91                 Do not specify both -b|-r and a firmware image.
  92         EOF
  93         exit 1
  94 }
  95
  96 # prevent messages from clobbering the tarball when using stdout
  97 [ "$CONF_BACKUP" = "-" ] && export VERBOSE=0
  98
  99 add_uci_conffiles() {
 100         local file="$1"
 101         ( find $(sed -ne '/^[[:space:]]*$/d; /^#/d; p' \
 102                 /etc/sysupgrade.conf /lib/upgrade/keep.d/* 2>/dev/null) \
 103                 -type f 2>/dev/null;
 104           opkg list-changed-conffiles ) | sort -u > "$file"
 105         return 0
 106 }
 107
 108 add_overlayfiles() {
 109         local file="$1"
 110         find /overlay/etc/ -type f | sed \
 111                 -e 's,^/overlay/,/,' \
 112                 -e '\,/META_[a-zA-Z0-9]*$,d' \
 113                 -e '\,/functions.sh$,d' \
 114                 -e '\,/[^/]*-opkg$,d' \
 115         > "$file"
 116         return 0
 117 }
 118
 119 # hooks
 120 sysupgrade_image_check="platform_check_image"
 121 [ $SAVE_OVERLAY = 0 -o ! -d /overlay/etc ] && \
 122         sysupgrade_init_conffiles="add_uci_conffiles" || \
 123         sysupgrade_init_conffiles="add_overlayfiles"
 124
 125 include /lib/upgrade
 126
 127 do_save_conffiles() {
 128         local conf_tar="${1:-$CONF_TAR}"
 129
 130         [ -z "$(rootfs_type)" ] && {
 131                 echo "Cannot save config while running from ramdisk."
 132                 ask_bool 0 "Abort" && exit
 133                 return 0
 134         }
 135         run_hooks "$CONFFILES" $sysupgrade_init_conffiles
 136         ask_bool 0 "Edit config file list" && vi "$CONFFILES"
 137
 138         v "Saving config files..."
 139         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 140         tar c${TAR_V}zf "$conf_tar" -T "$CONFFILES" 2>/dev/null
 141
 142         rm -f "$CONFFILES"
 143 }
 144
 145 if [ $CONF_BACKUP_LIST -eq 1 ]; then
 146         add_uci_conffiles "$CONFFILES"
 147         cat "$CONFFILES"
 148         rm -f "$CONFFILES"
 149         exit 0
 150 fi
 151
 152 if [ -n "$CONF_BACKUP" ]; then
 153         do_save_conffiles "$CONF_BACKUP"
 154         exit $?
 155 fi
 156
 157 if [ -n "$CONF_RESTORE" ]; then
 158         if [ "$CONF_RESTORE" != "-" ] && [ ! -f "$CONF_RESTORE" ]; then
 159                 echo "Backup archive '$CONF_RESTORE' not found."
 160                 exit 1
 161         fi
 162
 163         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 164         tar -C / -x${TAR_V}zf "$CONF_RESTORE"
 165         exit $?
 166 fi
 167
 168 type platform_check_image >/dev/null 2>/dev/null || {
 169         echo "Firmware upgrade is not implemented for this platform."
 170         exit 1
 171 }
 172
 173 for check in $sysupgrade_image_check; do
 174         ( eval "$check \"\$ARGV\"" ) || {
 175                 if [ $FORCE -eq 1 ]; then
 176                         echo "Image check '$check' failed but --force given - will update anyway!"
 177                         break
 178                 else
 179                         echo "Image check '$check' failed."
 180                         exit 1
 181                 fi
 182         }
 183 done
 184
 185 if [ -n "$CONF_IMAGE" ]; then
 186         case "$(get_magic_word $CONF_IMAGE cat)" in
 187                 # .gz files
 188                 1f8b) ;;
 189                 *)
 190                         echo "Invalid config file. Please use only .tar.gz files"
 191                         exit 1
 192                 ;;
 193         esac
 194         get_image "$CONF_IMAGE" "cat" > "$CONF_TAR"
 195         export SAVE_CONFIG=1
 196 elif ask_bool $SAVE_CONFIG "Keep config files over reflash"; then
 197         [ $TEST -eq 1 ] || do_save_conffiles
 198         export SAVE_CONFIG=1
 199 else
 200         export SAVE_CONFIG=0
 201 fi
 202
 203 if [ $TEST -eq 1 ]; then
 204         exit 0
 205 fi
 206
 207 run_hooks "" $sysupgrade_pre_upgrade
 208
 209 ubus call system upgrade
 210 touch /tmp/sysupgrade
 211
 212 kill_remaining TERM
 213 sleep 3
 214 kill_remaining KILL
 215
 216 if [ -n "$(rootfs_type)" ]; then
 217         v "Switching to ramdisk..."
 218         run_ramfs '. /lib/functions.sh; include /lib/upgrade; do_upgrade'
 219 else
 220         do_upgrade
 221 fi