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