package/base-files/files/sbin/sysupgrade

   1 #!/bin/sh
   2
   3 . /lib/functions.sh
   4 . /lib/functions/system.sh
   5 . /usr/share/libubox/jshn.sh
   6
   7 # initialize defaults
   8 export MTD_ARGS=""
   9 export MTD_CONFIG_ARGS=""
  10 export INTERACTIVE=0
  11 export VERBOSE=1
  12 export SAVE_CONFIG=1
  13 export SAVE_OVERLAY=0
  14 export SAVE_OVERLAY_PATH=
  15 export SAVE_PARTITIONS=1
  16 export SAVE_INSTALLED_PKGS=0
  17 export SKIP_UNCHANGED=0
  18 export CONF_IMAGE=
  19 export CONF_BACKUP_LIST=0
  20 export CONF_BACKUP=
  21 export CONF_RESTORE=
  22 export NEED_IMAGE=
  23 export HELP=0
  24 export FORCE=0
  25 export TEST=0
  26 export UMOUNT_ETCBACKUP_DIR=0
  27
  28 # parse options
  29 while [ -n "$1" ]; do
  30         case "$1" in
  31                 -i) export INTERACTIVE=1;;
  32                 -v) export VERBOSE="$(($VERBOSE + 1))";;
  33                 -q) export VERBOSE="$(($VERBOSE - 1))";;
  34                 -n) export SAVE_CONFIG=0;;
  35                 -c) export SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/etc;;
  36                 -o) export SAVE_OVERLAY=1 SAVE_OVERLAY_PATH=/;;
  37                 -p) export SAVE_PARTITIONS=0;;
  38                 -k) export SAVE_INSTALLED_PKGS=1;;
  39                 -u) export SKIP_UNCHANGED=1;;
  40                 -b|--create-backup) export CONF_BACKUP="$2" NEED_IMAGE=1; shift;;
  41                 -r|--restore-backup) export CONF_RESTORE="$2" NEED_IMAGE=1; shift;;
  42                 -l|--list-backup) export CONF_BACKUP_LIST=1;;
  43                 -f) export CONF_IMAGE="$2"; shift;;
  44                 -F|--force) export FORCE=1;;
  45                 -T|--test) export TEST=1;;
  46                 -h|--help) export HELP=1; break;;
  47                 -*)
  48                         echo "Invalid option: $1" >&2
  49                         exit 1
  50                 ;;
  51                 *) break;;
  52         esac
  53         shift;
  54 done
  55
  56 export CONFFILES=/tmp/sysupgrade.conffiles
  57 export CONF_TAR=/tmp/sysupgrade.tgz
  58 export ETCBACKUP_DIR=/etc/backup
  59 export INSTALLED_PACKAGES=${ETCBACKUP_DIR}/installed_packages.txt
  60
  61 IMAGE="$1"
  62
  63 [ -z "$IMAGE" -a -z "$NEED_IMAGE" -a $CONF_BACKUP_LIST -eq 0 -o $HELP -gt 0 ] && {
  64         cat <<EOF
  65 Usage: $0 [<upgrade-option>...] <image file or URL>
  66        $0 [-q] [-i] [-c] [-u] [-o] [-k] <backup-command> <file>
  67
  68 upgrade-option:
  69         -f <config>  restore configuration from .tar.gz (file or url)
  70         -i           interactive mode
  71         -c           attempt to preserve all changed files in /etc/
  72         -o           attempt to preserve all changed files in /, except those
  73                      from packages but including changed confs.
  74         -u           skip from backup files that are equal to those in /rom
  75         -n           do not save configuration over reflash
  76         -p           do not attempt to restore the partition table after flash.
  77         -k           include in backup a list of current installed packages at
  78                      $INSTALLED_PACKAGES
  79         -T | --test
  80                      Verify image and config .tar.gz but do not actually flash.
  81         -F | --force
  82                      Flash image even if image checks fail, this is dangerous!
  83         -q           less verbose
  84         -v           more verbose
  85         -h | --help  display this help
  86
  87 backup-command:
  88         -b | --create-backup <file>
  89                      create .tar.gz of files specified in sysupgrade.conf
  90                      then exit. Does not flash an image. If file is '-',
  91                      i.e. stdout, verbosity is set to 0 (i.e. quiet).
  92         -r | --restore-backup <file>
  93                      restore a .tar.gz created with sysupgrade -b
  94                      then exit. Does not flash an image. If file is '-',
  95                      the archive is read from stdin.
  96         -l | --list-backup
  97                      list the files that would be backed up when calling
  98                      sysupgrade -b. Does not create a backup file.
  99
 100 EOF
 101         exit 1
 102 }
 103
 104 [ -n "$IMAGE" -a -n "$NEED_IMAGE" ] && {
 105         cat <<-EOF
 106                 -b|--create-backup and -r|--restore-backup do not perform a firmware upgrade.
 107                 Do not specify both -b|-r and a firmware image.
 108         EOF
 109         exit 1
 110 }
 111
 112 # prevent messages from clobbering the tarball when using stdout
 113 [ "$CONF_BACKUP" = "-" ] && export VERBOSE=0
 114
 115
 116 list_conffiles() {
 117         awk '
 118                 BEGIN { conffiles = 0 }
 119                 /^Conffiles:/ { conffiles = 1; next }
 120                 !/^ / { conffiles = 0; next }
 121                 conffiles == 1 { print }
 122         ' /usr/lib/opkg/status
 123 }
 124
 125 list_changed_conffiles() {
 126         # Cannot handle spaces in filenames - but opkg cannot either...
 127         list_conffiles | while read file csum; do
 128                 [ -r "$file" ] || continue
 129
 130                 echo "${csum}  ${file}" | busybox sha256sum -sc - || echo "$file"
 131         done
 132 }
 133
 134 list_static_conffiles() {
 135         local filter=$1
 136
 137         find $(sed -ne '/^[[:space:]]*$/d; /^#/d; p' \
 138                 /etc/sysupgrade.conf /lib/upgrade/keep.d/* 2>/dev/null) \
 139                 \( -type f -o -type l \) $filter 2>/dev/null
 140 }
 141
 142 add_conffiles() {
 143         local file="$1"
 144
 145         ( list_static_conffiles "$find_filter"; list_changed_conffiles ) |
 146                 sort -u > "$file"
 147         return 0
 148 }
 149
 150 add_overlayfiles() {
 151         local file="$1"
 152
 153         local packagesfiles=$1.packagesfiles
 154         touch "$packagesfiles"
 155
 156         if [ "$SAVE_OVERLAY_PATH" = / ]; then
 157                 local conffiles=$1.conffiles
 158                 local keepfiles=$1.keepfiles
 159
 160                 list_conffiles | cut -f2 -d ' ' | sort -u > "$conffiles"
 161
 162                 # backup files from /etc/sysupgrade.conf and /lib/upgrade/keep.d, but
 163                 # ignore those aready controlled by opkg conffiles
 164                 list_static_conffiles | sort -u |
 165                         grep -h -v -x -F -f $conffiles > "$keepfiles"
 166
 167                 # backup conffiles, but only those changed if '-u'
 168                 [ $SKIP_UNCHANGED = 1 ] &&
 169                         list_changed_conffiles | sort -u > "$conffiles"
 170
 171                 # do not backup files from packages, except those listed
 172                 # in conffiles and keep.d
 173                 {
 174                         find /usr/lib/opkg/info -type f -name "*.list" -exec cat {} \;
 175                         find /usr/lib/opkg/info -type f -name "*.control" -exec sed \
 176                                 -ne '/^Alternatives/{s/^Alternatives: //;s/, /\n/g;p}' {} \; |
 177                                 cut -f2 -d:
 178                 } |  grep -v -x -F -f $conffiles |
 179                      grep -v -x -F -f $keepfiles | sort -u > "$packagesfiles"
 180                 rm -f "$keepfiles" "$conffiles"
 181         fi
 182
 183         # busybox grep bug when file is empty
 184         [ -s "$packagesfiles" ] || echo > $packagesfiles
 185
 186         ( cd /overlay/upper/; find .$SAVE_OVERLAY_PATH \( -type f -o -type l \) $find_filter | sed \
 187                 -e 's,^\.,,' \
 188                 -e '\,^/etc/board.json$,d' \
 189                 -e '\,/[^/]*-opkg$,d' \
 190                 -e '\,^/etc/urandom.seed$,d' \
 191                 -e "\,^$INSTALLED_PACKAGES$,d" \
 192                 -e '\,^/usr/lib/opkg/.*,d' \
 193         ) | grep -v -x -F -f $packagesfiles > "$file"
 194
 195         rm -f "$packagesfiles"
 196
 197         return 0
 198 }
 199
 200 if [ $SAVE_OVERLAY = 1 ]; then
 201         [ ! -d /overlay/upper/etc ] && {
 202                 echo "Cannot find '/overlay/upper/etc', required for '-c'" >&2
 203                 exit 1
 204         }
 205         sysupgrade_init_conffiles="add_overlayfiles"
 206 else
 207         sysupgrade_init_conffiles="add_conffiles"
 208 fi
 209
 210 find_filter=""
 211 if [ $SKIP_UNCHANGED = 1 ]; then
 212         [ ! -d /rom/ ] && {
 213                 echo "'/rom/' is required by '-u'"
 214                 exit 1
 215         }
 216         find_filter='( ( -exec test -e /rom/{} ; -exec cmp -s /{} /rom/{} ; ) -o -print )'
 217 fi
 218
 219 include /lib/upgrade
 220
 221 do_save_conffiles() {
 222         local conf_tar="$1"
 223
 224         [ "$(rootfs_type)" = "tmpfs" ] && {
 225                 echo "Cannot save config while running from ramdisk." >&2
 226                 ask_bool 0 "Abort" && exit
 227                 rm -f "$conf_tar"
 228                 return 0
 229         }
 230         run_hooks "$CONFFILES" $sysupgrade_init_conffiles
 231         ask_bool 0 "Edit config file list" && vi "$CONFFILES"
 232
 233         if [ "$SAVE_INSTALLED_PKGS" -eq 1 ]; then
 234                 echo "${INSTALLED_PACKAGES}" >> "$CONFFILES"
 235                 mkdir -p "$ETCBACKUP_DIR"
 236                 # Avoid touching filesystem on each backup
 237                 RAMFS="$(mktemp -d -t sysupgrade.XXXXXX)"
 238                 mkdir -p "$RAMFS/upper" "$RAMFS/work"
 239                 mount -t overlay overlay -o lowerdir=$ETCBACKUP_DIR,upperdir=$RAMFS/upper,workdir=$RAMFS/work $ETCBACKUP_DIR &&
 240                         UMOUNT_ETCBACKUP_DIR=1 || {
 241                                 echo "Cannot mount '$ETCBACKUP_DIR' as tmpfs to avoid touching disk while saving the list of installed packages." >&2
 242                                 ask_bool 0 "Abort" && exit
 243                         }
 244
 245                 # Format: pkg-name<TAB>{rom,overlay,unkown}
 246                 # rom is used for pkgs in /rom, even if updated later
 247                 find /usr/lib/opkg/info -name "*.control" \( \
 248                         \( -exec test -f /rom/{} \; -exec echo {} rom \; \) -o \
 249                         \( -exec test -f /overlay/upper/{} \; -exec echo {} overlay \; \) -o \
 250                         \( -exec echo {} unknown \; \) \
 251                         \) | sed -e 's,.*/,,;s/\.control /\t/' > ${INSTALLED_PACKAGES}
 252         fi
 253
 254         v "Saving config files..."
 255         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 256         tar c${TAR_V}zf "$conf_tar" -T "$CONFFILES" 2>/dev/null
 257         if [ "$?" -ne 0 ]; then
 258                 echo "Failed to create the configuration backup."
 259                 rm -f "$conf_tar"
 260                 exit 1
 261         fi
 262
 263         [ "$UMOUNT_ETCBACKUP_DIR" -eq 1 ] && {
 264                 umount "$ETCBACKUP_DIR"
 265                 rm -rf "$RAMFS"
 266         }
 267         rm -f "$CONFFILES"
 268 }
 269
 270 if [ $CONF_BACKUP_LIST -eq 1 ]; then
 271         run_hooks "$CONFFILES" $sysupgrade_init_conffiles
 272         [ "$SAVE_INSTALLED_PKGS" -eq 1 ] && echo ${INSTALLED_PACKAGES} >> "$CONFFILES"
 273         cat "$CONFFILES"
 274         rm -f "$CONFFILES"
 275         exit 0
 276 fi
 277
 278 if [ -n "$CONF_BACKUP" ]; then
 279         do_save_conffiles "$CONF_BACKUP"
 280         exit $?
 281 fi
 282
 283 if [ -n "$CONF_RESTORE" ]; then
 284         if [ "$CONF_RESTORE" != "-" ] && [ ! -f "$CONF_RESTORE" ]; then
 285                 echo "Backup archive '$CONF_RESTORE' not found." >&2
 286                 exit 1
 287         fi
 288
 289         [ "$VERBOSE" -gt 1 ] && TAR_V="v" || TAR_V=""
 290         v "Restoring config files..."
 291         tar -C / -x${TAR_V}zf "$CONF_RESTORE"
 292         exit $?
 293 fi
 294
 295 type platform_check_image >/dev/null 2>/dev/null || {
 296         echo "Firmware upgrade is not implemented for this platform." >&2
 297         exit 1
 298 }
 299
 300 case "$IMAGE" in
 301         http://*|\
 302         https://*)
 303                 wget -O/tmp/sysupgrade.img "$IMAGE" || exit 1
 304                 IMAGE=/tmp/sysupgrade.img
 305                 ;;
 306 esac
 307
 308 IMAGE="$(readlink -f "$IMAGE")"
 309
 310 case "$IMAGE" in
 311         '')
 312                 echo "Image file not found." >&2
 313                 exit 1
 314                 ;;
 315         /tmp/*) ;;
 316         *)
 317                 v "Image not in /tmp, copying..."
 318                 cp -f "$IMAGE" /tmp/sysupgrade.img
 319                 IMAGE=/tmp/sysupgrade.img
 320                 ;;
 321 esac
 322
 323 json_load "$(/usr/libexec/validate_firmware_image "$IMAGE")" || {
 324         echo "Failed to check image"
 325         exit 1
 326 }
 327 json_get_var valid "valid"
 328 [ "$valid" -eq 0 ] && {
 329         if [ $FORCE -eq 1 ]; then
 330                 echo "Image check failed but --force given - will update anyway!" >&2
 331         else
 332                 echo "Image check failed." >&2
 333                 exit 1
 334         fi
 335 }
 336
 337 if [ -n "$CONF_IMAGE" ]; then
 338         case "$(get_magic_word $CONF_IMAGE cat)" in
 339                 # .gz files
 340                 1f8b) ;;
 341                 *)
 342                         echo "Invalid config file. Please use only .tar.gz files" >&2
 343                         exit 1
 344                 ;;
 345         esac
 346         get_image "$CONF_IMAGE" "cat" > "$CONF_TAR"
 347         export SAVE_CONFIG=1
 348 elif ask_bool $SAVE_CONFIG "Keep config files over reflash"; then
 349         [ $TEST -eq 1 ] || do_save_conffiles "$CONF_TAR"
 350         export SAVE_CONFIG=1
 351 else
 352         [ $TEST -eq 1 ] || rm -f "$CONF_TAR"
 353         export SAVE_CONFIG=0
 354 fi
 355
 356 if [ $TEST -eq 1 ]; then
 357         exit 0
 358 fi
 359
 360 install_bin /sbin/upgraded
 361 v "Commencing upgrade. Closing all shell sessions."
 362
 363 COMMAND='/lib/upgrade/do_stage2'
 364
 365 if [ -n "$FAILSAFE" ]; then
 366         printf '%s\x00%s\x00%s' "$RAM_ROOT" "$IMAGE" "$COMMAND" >/tmp/sysupgrade
 367         lock -u /tmp/.failsafe
 368 else
 369         json_init
 370         json_add_string prefix "$RAM_ROOT"
 371         json_add_string path "$IMAGE"
 372         [ $FORCE -eq 1 ] && json_add_boolean force 1
 373         [ $SAVE_CONFIG -eq 1 ] && json_add_string backup "$CONF_TAR"
 374         json_add_string command "$COMMAND"
 375         json_add_object options
 376         json_add_int save_partitions "$SAVE_PARTITIONS"
 377         json_close_object
 378
 379         ubus call system sysupgrade "$(json_dump)"
 380 fi