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