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