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