package/base-files/files/sbin/sysupgrade

   1 #!/bin/sh
   2
   3 . /lib/functions.sh
   4 . /lib/functions/system.sh
   5
   6 # initialize defaults
   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 SAVE_PARTITIONS=1
  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                 -v) export VERBOSE="$(($VERBOSE + 1))";;
  27                 -q) export VERBOSE="$(($VERBOSE - 1))";;
  28                 -n) export SAVE_CONFIG=0;;
  29                 -c) export SAVE_OVERLAY=1;;
  30                 -p) export SAVE_PARTITIONS=0;;
  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 IMAGE="$1"
  51
  52 [ -z "$IMAGE" -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         -p           do not attempt to restore the partition table after flash.
  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 "$IMAGE" -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 -o -type l 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/upper/etc/ -type f -o -type l | sed \
 112                 -e 's,^/overlay\/upper/,/,' \
 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="fwtool_check_image platform_check_image"
 122 sysupgrade_pre_upgrade="fwtool_pre_upgrade"
 123
 124 if [ $SAVE_OVERLAY = 1 ]; then
 125         [ ! -d /overlay/upper/etc ] && {
 126                 echo "Cannot find '/overlay/upper/etc', required for '-c'"
 127                 exit 1
 128         }
 129         sysupgrade_init_conffiles="add_overlayfiles"
 130 else
 131         sysupgrade_init_conffiles="add_uci_conffiles"
 132 fi
 133
 134 include /lib/upgrade
 135
 136 do_save_conffiles() {
 137         local conf_tar="${1:-$CONF_TAR}"
 138
 139         [ -z "$(rootfs_type)" ] && {
 140                 echo "Cannot save config while running from ramdisk."
 141                 ask_bool 0 "Abort" && exit
 142                 rm -f "$conf_tar"
 143                 return 0
 144         }
 145         run_hooks "$CONFFILES" $sysupgrade_init_conffiles
 146         ask_bool 0 "Edit config file list" && vi "$CONFFILES"
 147
 148         v "Saving config files..."
 149         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 150         tar c${TAR_V}zf "$conf_tar" -T "$CONFFILES" 2>/dev/null
 151
 152         rm -f "$CONFFILES"
 153 }
 154
 155 if [ $CONF_BACKUP_LIST -eq 1 ]; then
 156         run_hooks "$CONFFILES" $sysupgrade_init_conffiles
 157         cat "$CONFFILES"
 158         rm -f "$CONFFILES"
 159         exit 0
 160 fi
 161
 162 if [ -n "$CONF_BACKUP" ]; then
 163         do_save_conffiles "$CONF_BACKUP"
 164         exit $?
 165 fi
 166
 167 if [ -n "$CONF_RESTORE" ]; then
 168         if [ "$CONF_RESTORE" != "-" ] && [ ! -f "$CONF_RESTORE" ]; then
 169                 echo "Backup archive '$CONF_RESTORE' not found."
 170                 exit 1
 171         fi
 172
 173         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 174         tar -C / -x${TAR_V}zf "$CONF_RESTORE"
 175         exit $?
 176 fi
 177
 178 type platform_check_image >/dev/null 2>/dev/null || {
 179         echo "Firmware upgrade is not implemented for this platform."
 180         exit 1
 181 }
 182
 183 case "$IMAGE" in
 184         http://*)
 185                 wget -O/tmp/sysupgrade.img "$IMAGE"
 186                 IMAGE=/tmp/sysupgrade.img
 187                 ;;
 188 esac
 189
 190 IMAGE="$(readlink -f "$IMAGE")"
 191
 192 case "$IMAGE" in
 193         '')
 194                 echo "Image file not found."
 195                 exit 1
 196                 ;;
 197         /tmp/*) ;;
 198         *)
 199                 v "Image not in /tmp, copying..."
 200                 cp -f "$IMAGE" /tmp/sysupgrade.img
 201                 IMAGE=/tmp/sysupgrade.img
 202                 ;;
 203 esac
 204
 205 export ARGV="$IMAGE"
 206 export ARGC=1
 207
 208 for check in $sysupgrade_image_check; do
 209         ( $check "$IMAGE" ) || {
 210                 if [ $FORCE -eq 1 ]; then
 211                         echo "Image check '$check' failed but --force given - will update anyway!"
 212                         break
 213                 else
 214                         echo "Image check '$check' failed."
 215                         exit 1
 216                 fi
 217         }
 218 done
 219
 220 if [ -n "$CONF_IMAGE" ]; then
 221         case "$(get_magic_word $CONF_IMAGE cat)" in
 222                 # .gz files
 223                 1f8b) ;;
 224                 *)
 225                         echo "Invalid config file. Please use only .tar.gz files"
 226                         exit 1
 227                 ;;
 228         esac
 229         get_image "$CONF_IMAGE" "cat" > "$CONF_TAR"
 230         export SAVE_CONFIG=1
 231 elif ask_bool $SAVE_CONFIG "Keep config files over reflash"; then
 232         [ $TEST -eq 1 ] || do_save_conffiles
 233         export SAVE_CONFIG=1
 234 else
 235         [ $TEST -eq 1 ] || rm -f "$CONF_TAR"
 236         export SAVE_CONFIG=0
 237 fi
 238
 239 if [ $TEST -eq 1 ]; then
 240         exit 0
 241 fi
 242
 243 if [ $SAVE_PARTITIONS -eq 0 ]; then
 244         touch /tmp/sysupgrade.always.overwrite.bootdisk.partmap
 245 else
 246         rm -f /tmp/sysupgrade.always.overwrite.bootdisk.partmap
 247 fi
 248
 249 run_hooks "" $sysupgrade_pre_upgrade
 250
 251 install_bin /sbin/upgraded
 252 v "Commencing upgrade. All shell sessions will be closed now."
 253
 254 COMMAND='. /lib/functions.sh; include /lib/upgrade; do_upgrade_stage2'
 255
 256 if [ -n "$FAILSAFE" ]; then
 257         printf '%s\x00%s\x00%s' "$RAM_ROOT" "$IMAGE" "$COMMAND" >/tmp/sysupgrade
 258         lock -u /tmp/.failsafe
 259 else
 260         ubus call system sysupgrade "{
 261                 \"prefix\": $(json_string "$RAM_ROOT"),
 262                 \"path\": $(json_string "$IMAGE"),
 263                 \"command\": $(json_string "$COMMAND")
 264         }"
 265 fi