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