3 # SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 # Copyright (c) 2010-2013 Hudson River Trading LLC
6 # Written by: John H. Baldwin <jhb@FreeBSD.org>
9 # Redistribution and use in source and binary forms, with or without
10 # modification, are permitted provided that the following conditions
12 # 1. Redistributions of source code must retain the above copyright
13 # notice, this list of conditions and the following disclaimer.
14 # 2. Redistributions in binary form must reproduce the above copyright
15 # notice, this list of conditions and the following disclaimer in the
16 # documentation and/or other materials provided with the distribution.
18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 # This is a tool to manage updating files that are not updated as part
33 # of 'make installworld' such as files in /etc. Unlike other tools,
34 # this one is specifically tailored to assisting with mass upgrades.
35 # To that end it does not require user intervention while running.
37 # Theory of operation:
39 # The most reliable way to update changes to files that have local
40 # modifications is to perform a three-way merge between the original
41 # unmodified file, the new version of the file, and the modified file.
42 # This requires having all three versions of the file available when
43 # performing an update.
45 # To that end, etcupdate uses a strategy where the current unmodified
46 # tree is kept in WORKDIR/current and the previous unmodified tree is
47 # kept in WORKDIR/old. When performing a merge, a new tree is built
48 # if needed and then the changes are merged into DESTDIR. Any files
49 # with unresolved conflicts after the merge are left in a tree rooted
50 # at WORKDIR/conflicts.
52 # To provide extra flexibility, etcupdate can also build tarballs of
53 # root trees that can later be used. It can also use a tarball as the
54 # source of a new tree instead of building it from /usr/src.
56 # Global settings. These can be adjusted by config files and in some
57 # cases by command line options.
60 # - automatable conflict resolution
65 usage: etcupdate [-npBFN] [-d workdir] [-r | -s source | -t tarball]
66 [-A patterns] [-D destdir] [-I patterns] [-L logfile]
67 [-M options] [-m make]
68 etcupdate build [-BN] [-d workdir] [-s source] [-L logfile] [-M options]
70 etcupdate diff [-d workdir] [-D destdir] [-I patterns] [-L logfile]
71 etcupdate extract [-BN] [-d workdir] [-s source | -t tarball]
72 [-D destdir] [-L logfile] [-M options] [-m make]
73 etcupdate resolve [-p] [-d workdir] [-D destdir] [-L logfile]
74 etcupdate revert [-d workdir] [-D destdir] [-L logfile] file ...
75 etcupdate status [-d workdir] [-D destdir]
80 # Used to write a message prepended with '>>>' to the logfile.
86 # Used for assertion conditions that should never happen.
93 # Used to write a warning message. These are saved to the WARNINGS
94 # file with " " prepended.
97 echo -n " " >> $WARNINGS
98 echo "$@" >> $WARNINGS
101 # Output a horizontal rule using the passed-in character. Matches the
102 # length used for Index lines in CVS and SVN diffs.
110 # Output a text description of a specified file's type.
112 # $1 - file pathname.
115 stat -f "%HT" $1 | tr "[:upper:]" "[:lower:]"
118 # Returns true (0) if a file exists
120 # $1 - file pathname.
126 # Returns true (0) if a file should be ignored, false otherwise.
134 for pattern in $IGNORE_FILES; do
144 # Ignore /.cshrc and /.profile if they are hardlinked to the
145 # same file in /root. This ensures we only compare those
146 # files once in that case.
149 if [ ${DESTDIR}$1 -ef ${DESTDIR}/root$1 ]; then
160 # Returns true (0) if the new version of a file should always be
161 # installed rather than attempting to do a merge.
169 for pattern in $ALWAYS_INSTALL; do
182 # Build a new tree. This runs inside a subshell to trap SIGINT.
184 # $1 - directory to store new tree in
187 local destdir dir file make autogenfiles metatmp
189 make="$MAKE_CMD $MAKE_OPTIONS -DNO_FILEMON"
191 if [ -n "$noroot" ]; then
192 make="$make -DNO_ROOT"
193 metatmp=`mktemp $WORKDIR/etcupdate-XXXXXXX`
195 trap "rm -f $metatmp; trap '' EXIT; return 1" INT
196 trap "rm -f $metatmp" EXIT
202 log "Building tree at $1 with $make"
207 destdir=`realpath $1`
209 if [ -n "$preworld" ]; then
210 # Build a limited tree that only contains files that are
211 # crucial to installworld.
212 for file in $PREWORLD_FILES; do
213 name=$(basename $file)
214 mkdir -p $1/etc || return 1
215 cp -p $SRCDIR/$file $1/etc/$name || return 1
217 elif ! [ -n "$nobuild" ]; then
218 (cd $SRCDIR; $make DESTDIR=$destdir distrib-dirs &&
219 MAKEOBJDIRPREFIX=$destdir/usr/obj $make _obj SUBDIR_OVERRIDE=etc &&
220 MAKEOBJDIRPREFIX=$destdir/usr/obj $make everything SUBDIR_OVERRIDE=etc &&
221 MAKEOBJDIRPREFIX=$destdir/usr/obj $make DESTDIR=$destdir distribution) || \
224 (cd $SRCDIR; $make DESTDIR=$destdir distrib-dirs &&
225 $make DESTDIR=$destdir distribution) || return 1
227 chflags -R noschg $1 || return 1
228 rm -rf $1/usr/obj || return 1
230 # Purge auto-generated files. Only the source files need to
231 # be updated after which these files are regenerated.
232 autogenfiles="./etc/*.db ./etc/passwd ./var/db/services.db"
233 (cd $1 && printf '%s\n' $autogenfiles >> $metatmp && \
234 rm -f $autogenfiles) || return 1
236 # Remove empty files. These just clutter the output of 'diff'.
237 (cd $1 && find . -type f -size 0 -delete -print >> $metatmp) || \
240 # Trim empty directories.
241 (cd $1 && find . -depth -type d -empty -delete -print >> $metatmp) || \
244 if [ -n "$noroot" ]; then
245 # Rewrite the METALOG to exclude the files (and directories)
246 # removed above. $metatmp contains the list of files to delete,
247 # and we append #METALOG# as a delimiter followed by the
248 # original METALOG. This lets us scan through $metatmp in awk
249 # building up a table of names to delete until we reach the
250 # delimiter, then emit all the entries of the original METALOG
251 # after it that aren't in that table. We also exclude ./usr/obj
252 # and its children explicitly for simplicity rather than
253 # building up that list (and in practice only ./usr/obj itself
254 # will be in the METALOG since nothing is installed there).
255 echo '#METALOG#' >> $metatmp || return 1
256 cat $1/METALOG >> $metatmp || return 1
257 awk '/^#METALOG#$/ { metalog = 1; next }
258 { f=$1; gsub(/\/\/+/, "/", f) }
259 !metalog { rm[f] = 1; next }
260 !rm[f] && f !~ /^\.\/usr\/obj(\/|$)/ { print }' \
261 $metatmp > $1/METALOG || return 1
267 # Generate a new tree. If tarball is set, then the tree is
268 # extracted from the tarball. Otherwise the tree is built from a
271 # $1 - directory to store new tree in
276 # If we have a tarball, extract that into the new directory.
277 if [ -n "$tarball" ]; then
279 if [ -n "$preworld" ]; then
280 files="$PREWORLD_FILES"
282 if ! (mkdir -p $1 && tar xf $tarball -C $1 $files) \
284 echo "Failed to extract new tree."
289 if ! build_tree $1; then
290 echo "Failed to build new tree."
297 # Forcefully remove a tree. Returns true (0) if the operation succeeds.
305 chflags -R noschg $1 >&3 2>&1
311 # Return values for compare()
319 # Compare two files/directories/symlinks. Note that this does not
320 # recurse into subdirectories. Instead, if two nodes are both
321 # directories, they are assumed to be equivalent.
323 # Returns true (0) if the nodes are identical. If only one of the two
324 # nodes are present, return one of the COMPARE_ONLY* constants. If
325 # the nodes are different, return one of the COMPARE_DIFF* constants
326 # to indicate the type of difference.
334 # If the first node doesn't exist, then check for the second
335 # node. Note that -e will fail for a symbolic link that
336 # points to a missing target.
339 return $COMPARE_ONLYSECOND
341 return $COMPARE_EQUAL
343 elif ! exists $2; then
344 return $COMPARE_ONLYFIRST
347 # If the two nodes are different file types fail.
348 first=`stat -f "%Hp" $1`
349 second=`stat -f "%Hp" $2`
350 if [ "$first" != "$second" ]; then
351 return $COMPARE_DIFFTYPE
354 # If both are symlinks, compare the link values.
358 if [ "$first" = "$second" ]; then
359 return $COMPARE_EQUAL
361 return $COMPARE_DIFFLINKS
365 # If both are files, compare the file contents.
367 if cmp -s $1 $2; then
368 return $COMPARE_EQUAL
370 return $COMPARE_DIFFFILES
374 # As long as the two nodes are the same type of file, consider
376 return $COMPARE_EQUAL
379 # Returns true (0) if the only difference between two regular files is a
380 # change in the FreeBSD ID string.
382 # $1 - path of first file
383 # $2 - path of second file
387 diff -qI '\$FreeBSD.*\$' $1 $2 >/dev/null 2>&1
390 # This is a wrapper around compare that will return COMPARE_EQUAL if
391 # the only difference between two regular files is a change in the
392 # FreeBSD ID string. It only makes this adjustment if the -F flag has
404 if [ -n "$FREEBSD_ID" -a "$cmp" -eq $COMPARE_DIFFFILES ] && \
405 fbsdid_only $1 $2; then
406 return $COMPARE_EQUAL
412 # Returns true (0) if a directory is empty.
414 # $1 - pathname of the directory to check
423 # Returns true (0) if one directories contents are a subset of the
424 # other. This will recurse to handle subdirectories and compares
425 # individual files in the trees. Its purpose is to quiet spurious
426 # directory warnings for dryrun invocations.
428 # $1 - first directory (sub)
429 # $2 - second directory (super)
434 if ! [ -d $1 -a -d $2 ]; then
438 # Ignore files that are present in the second directory but not
441 for file in $contents; do
442 if ! compare $1/$file $2/$file; then
446 if [ -d $1/$file ]; then
447 if ! dir_subset $1/$file $2/$file; then
455 # Returns true (0) if a directory in the destination tree is empty.
456 # If this is a dryrun, then this returns true as long as the contents
457 # of the directory are a subset of the contents in the old tree
458 # (meaning that the directory would be empty in a non-dryrun when this
459 # was invoked) to quiet spurious warnings.
461 # $1 - pathname of the directory to check relative to DESTDIR.
465 if [ -n "$dryrun" ]; then
466 dir_subset $DESTDIR/$1 $OLDTREE/$1
470 empty_dir $DESTDIR/$1
473 # Output a diff of two directory entries with the same relative name
474 # in different trees. Note that as with compare(), this does not
475 # recurse into subdirectories. If the nodes are identical, nothing is
481 # $4 - label for first tree
482 # $5 - label for second tree
485 local first second file old new diffargs
487 if [ -n "$FREEBSD_ID" ]; then
488 diffargs="-I \\\$FreeBSD.*\\\$"
493 compare_fbsdid $1/$3 $2/$3
508 first=`file_type $1/$3`
509 second=`file_type $2/$3`
511 echo "Node changed from a $first to a $second: $3"
515 first=`readlink $1/$file`
516 second=`readlink $2/$file`
518 echo "Link changed: $file"
527 diff -u $diffargs -L "$3 ($4)" $1/$3 -L "$3 ($5)" $2/$3
532 # Run one-off commands after an update has completed. These commands
533 # are not tied to a specific file, so they cannot be handled by
534 # post_install_file().
539 # None of these commands should be run for a pre-world update.
540 if [ -n "$preworld" ]; then
544 # If /etc/localtime exists and is not a symlink and /var/db/zoneinfo
545 # exists, run tzsetup -r to refresh /etc/localtime.
546 if [ -f ${DESTDIR}/etc/localtime -a \
547 ! -L ${DESTDIR}/etc/localtime ]; then
548 if [ -f ${DESTDIR}/var/db/zoneinfo ]; then
549 if [ -n "${DESTDIR}" ]; then
554 log "tzsetup -r ${args}"
555 if [ -z "$dryrun" ]; then
556 tzsetup -r ${args} >&3 2>&1
559 warn "Needs update: /etc/localtime (required" \
560 "manual update via tzsetup(8))"
565 # Create missing parent directories of a node in a target tree
566 # preserving the owner, group, and permissions from a specified
571 # $3 - pathname of the node (relative to both trees)
578 # Nothing to do if the parent directory exists. This also
579 # catches the degenerate cases when the path is just a simple
581 if [ -d ${2}$dir ]; then
585 # If non-directory file exists with the desired directory
587 if exists ${2}$dir; then
588 # If this is a dryrun and we are installing the
589 # directory in the DESTDIR and the file in the DESTDIR
590 # matches the file in the old tree, then fake success
591 # to quiet spurious warnings.
592 if [ -n "$dryrun" -a "$2" = "$DESTDIR" ]; then
593 if compare $OLDTREE/$dir $DESTDIR/$dir; then
598 args=`file_type ${2}$dir`
599 warn "Directory mismatch: ${2}$dir ($args)"
603 # Ensure the parent directory of the directory is present
605 if ! install_dirs $1 "$2" $dir; then
609 # Format attributes from template directory as install(1)
611 args=`stat -f "-o %Su -g %Sg -m %0Mp%0Lp" $1/$dir`
613 log "install -d $args ${2}$dir"
614 if [ -z "$dryrun" ]; then
615 install -d $args ${2}$dir >&3 2>&1
620 # Perform post-install fixups for a file. This largely consists of
621 # regenerating any files that depend on the newly installed file.
623 # $1 - pathname of the updated file (relative to DESTDIR)
628 # Grr, newaliases only works for an empty DESTDIR.
629 if [ -z "$DESTDIR" ]; then
631 if [ -z "$dryrun" ]; then
638 /usr/share/certs/trusted/* | /usr/share/certs/untrusted/*)
640 if [ -z "$dryrun" ]; then
641 env DESTDIR=${DESTDIR} certctl rehash >&3 2>&1
645 log "cap_mkdb ${DESTDIR}$1"
646 if [ -z "$dryrun" ]; then
647 cap_mkdb ${DESTDIR}$1 >&3 2>&1
651 log "pwd_mkdb -p -d $DESTDIR/etc ${DESTDIR}$1"
652 if [ -z "$dryrun" ]; then
653 pwd_mkdb -p -d $DESTDIR/etc ${DESTDIR}$1 \
658 # /etc/rc.d/motd hardcodes the /etc/motd path.
659 # Don't warn about non-empty DESTDIR's since this
660 # change is only cosmetic anyway.
661 if [ -z "$DESTDIR" ]; then
662 log "sh /etc/rc.d/motd start"
663 if [ -z "$dryrun" ]; then
664 sh /etc/rc.d/motd start >&3 2>&1
669 log "services_mkdb -q -o $DESTDIR/var/db/services.db" \
671 if [ -z "$dryrun" ]; then
672 services_mkdb -q -o $DESTDIR/var/db/services.db \
673 ${DESTDIR}$1 >&3 2>&1
679 # Install the "new" version of a file. Returns true if it succeeds
680 # and false otherwise.
682 # $1 - pathname of the file to install (relative to DESTDIR)
686 if ! install_dirs $NEWTREE "$DESTDIR" $1; then
689 log "cp -Rp ${NEWTREE}$1 ${DESTDIR}$1"
690 if [ -z "$dryrun" ]; then
691 cp -Rp ${NEWTREE}$1 ${DESTDIR}$1 >&3 2>&1
697 # Install the "resolved" version of a file. Returns true if it succeeds
698 # and false otherwise.
700 # $1 - pathname of the file to install (relative to DESTDIR)
704 # This should always be present since the file is already
705 # there (it caused a conflict). However, it doesn't hurt to
707 if ! install_dirs $NEWTREE "$DESTDIR" $1; then
711 # Use cat rather than cp to preserve metadata
712 log "cat ${CONFLICTS}$1 > ${DESTDIR}$1"
713 cat ${CONFLICTS}$1 > ${DESTDIR}$1 2>&3
718 # Generate a conflict file when a "new" file conflicts with an
719 # existing file in DESTDIR.
721 # $1 - pathname of the file that conflicts (relative to DESTDIR)
725 if [ -n "$dryrun" ]; then
729 install_dirs $NEWTREE $CONFLICTS $1
730 diff --changed-group-format='<<<<<<< (local)
733 ' $DESTDIR/$1 $NEWTREE/$1 > $CONFLICTS/$1
736 # Remove the "old" version of a file.
738 # $1 - pathname of the old file to remove (relative to DESTDIR)
741 log "rm -f ${DESTDIR}$1"
742 if [ -z "$dryrun" ]; then
743 rm -f ${DESTDIR}$1 >&3 2>&1
748 # Update a file that has no local modifications.
750 # $1 - pathname of the file to update (relative to DESTDIR)
755 # If the old file is a directory, then remove it with rmdir
756 # (this should only happen if the file has changed its type
757 # from a directory to a non-directory). If the directory
758 # isn't empty, then fail. This will be reported as a warning
760 if [ -d $DESTDIR/$1 ]; then
761 if empty_destdir $1; then
762 log "rmdir ${DESTDIR}$1"
763 if [ -z "$dryrun" ]; then
764 rmdir ${DESTDIR}$1 >&3 2>&1
770 # If both the old and new files are regular files, leave the
771 # existing file. This avoids breaking hard links for /.cshrc
772 # and /.profile. Otherwise, explicitly remove the old file.
773 elif ! [ -f ${DESTDIR}$1 -a -f ${NEWTREE}$1 ]; then
774 log "rm -f ${DESTDIR}$1"
775 if [ -z "$dryrun" ]; then
776 rm -f ${DESTDIR}$1 >&3 2>&1
780 # If the new file is a directory, note that the old file has
781 # been removed, but don't do anything else for now. The
782 # directory will be installed if needed when new files within
783 # that directory are installed.
784 if [ -d $NEWTREE/$1 ]; then
785 if empty_dir $NEWTREE/$1; then
790 elif install_new $1; then
796 # Update the FreeBSD ID string in a locally modified file to match the
797 # FreeBSD ID string from the "new" version of the file.
799 # $1 - pathname of the file to update (relative to DESTDIR)
804 # If the FreeBSD ID string is removed from the local file,
805 # there is nothing to do. In this case, treat the file as
806 # updated. Otherwise, if either file has more than one
807 # FreeBSD ID string, just punt and let the user handle the
809 new=`grep -c '\$FreeBSD.*\$' ${NEWTREE}$1`
810 dest=`grep -c '\$FreeBSD.*\$' ${DESTDIR}$1`
811 if [ "$dest" -eq 0 ]; then
814 if [ "$dest" -ne 1 -o "$dest" -ne 1 ]; then
818 # If the FreeBSD ID string in the new file matches the FreeBSD ID
819 # string in the local file, there is nothing to do.
820 new=`grep '\$FreeBSD.*\$' ${NEWTREE}$1`
821 dest=`grep '\$FreeBSD.*\$' ${DESTDIR}$1`
822 if [ "$new" = "$dest" ]; then
826 # Build the new file in three passes. First, copy all the
827 # lines preceding the FreeBSD ID string from the local version
828 # of the file. Second, append the FreeBSD ID string line from
829 # the new version. Finally, append all the lines after the
830 # FreeBSD ID string from the local version of the file.
831 file=`mktemp $WORKDIR/etcupdate-XXXXXXX`
832 awk '/\$FreeBSD.*\$/ { exit } { print }' ${DESTDIR}$1 >> $file
833 awk '/\$FreeBSD.*\$/ { print }' ${NEWTREE}$1 >> $file
834 awk '/\$FreeBSD.*\$/ { ok = 1; next } { if (ok) print }' \
835 ${DESTDIR}$1 >> $file
837 # As an extra sanity check, fail the attempt if the updated
838 # version of the file has any differences aside from the
840 if ! fbsdid_only ${DESTDIR}$1 $file; then
845 log "cp $file ${DESTDIR}$1"
846 if [ -z "$dryrun" ]; then
847 cp $file ${DESTDIR}$1 >&3 2>&1
855 # Attempt to update a file that has local modifications. This routine
856 # only handles regular files. If the 3-way merge succeeds without
857 # conflicts, the updated file is installed. If the merge fails, the
858 # merged version with conflict markers is left in the CONFLICTS tree.
860 # $1 - pathname of the file to merge (relative to DESTDIR)
865 # Try the merge to see if there is a conflict.
866 diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > /dev/null 2>&3
870 # No conflicts, so just redo the merge to the
872 log "diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1"
873 if [ -z "$dryrun" ]; then
874 temp=$(mktemp -t etcupdate)
875 diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > ${temp}
876 # Use "cat >" to preserve metadata.
877 cat ${temp} > ${DESTDIR}$1
884 # Conflicts, save a version with conflict markers in
885 # the conflicts directory.
886 if [ -z "$dryrun" ]; then
887 install_dirs $NEWTREE $CONFLICTS $1
888 log "diff3 -m ${DESTDIR}$1 ${CONFLICTS}$1"
889 diff3 -m -L "yours" -L "original" -L "new" \
890 ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > \
896 panic "merge failed with status $res"
901 # Returns true if a file contains conflict markers from a merge conflict.
903 # $1 - pathname of the file to resolve (relative to DESTDIR)
907 egrep -q '^(<{7}|\|{7}|={7}|>{7}) ' $CONFLICTS/$1
910 # Attempt to resolve a conflict. The user is prompted to choose an
911 # action for each conflict. If the user edits the file, they are
912 # prompted again for an action. The process is very similar to
913 # resolving conflicts after an update or merge with Perforce or
914 # Subversion. The prompts are modelled on a subset of the available
915 # commands for resolving conflicts with Subversion.
917 # $1 - pathname of the file to resolve (relative to DESTDIR)
922 echo "Resolving conflict in '$1':"
925 # Only display the resolved command if the file
926 # doesn't contain any conflicts.
927 echo -n "Select: (p) postpone, (df) diff-full, (e) edit,"
928 if ! has_conflicts $1; then
929 echo -n " (r) resolved,"
932 echo -n " (h) help for more options: "
936 diff -u ${DESTDIR}$1 ${CONFLICTS}$1
939 $EDITOR ${CONFLICTS}$1
943 (p) postpone - ignore this conflict for now
944 (df) diff-full - show all changes made to merged file
945 (e) edit - change merged file in an editor
946 (r) resolved - accept merged version of file
947 (mf) mine-full - accept local version of entire file (ignore new changes)
948 (tf) theirs-full - accept new version of entire file (lose local changes)
949 (h) help - show this list
953 # For mine-full, just delete the
954 # merged file and leave the local
955 # version of the file as-is.
963 # If the merged file has conflict
964 # markers, require confirmation.
965 if has_conflicts $1; then
966 echo "File '$1' still has conflicts," \
967 "are you sure? (y/n) "
969 if [ "$junk" != "y" ]; then
974 if ! install_resolved $1; then
975 panic "Unable to install merged" \
982 # For theirs-full, install the new
983 # version of the file over top of the
985 if ! install_new $1; then
986 panic "Unable to install new" \
993 echo "Invalid command."
999 # Handle a file that has been removed from the new tree. If the file
1000 # does not exist in DESTDIR, then there is nothing to do. If the file
1001 # exists in DESTDIR and is identical to the old version, remove it
1002 # from DESTDIR. Otherwise, whine about the conflict but leave the
1003 # file in DESTDIR. To handle directories, this uses two passes. The
1004 # first pass handles all non-directory files. The second pass handles
1005 # just directories and removes them if they are empty.
1007 # If -F is specified, and the only difference in the file in DESTDIR
1008 # is a change in the FreeBSD ID string, then remove the file.
1010 # $1 - pathname of the file (relative to DESTDIR)
1011 handle_removed_file()
1016 if ignore $file; then
1017 log "IGNORE: removed file $file"
1021 compare_fbsdid $DESTDIR/$file $OLDTREE/$file
1024 if ! [ -d $DESTDIR/$file ]; then
1029 panic "Removed file now missing"
1031 $COMPARE_ONLYSECOND)
1032 # Already removed, nothing to do.
1034 $COMPARE_DIFFTYPE|$COMPARE_DIFFLINKS|$COMPARE_DIFFFILES)
1035 dest=`file_type $DESTDIR/$file`
1036 warn "Modified $dest remains: $file"
1041 # Handle a directory that has been removed from the new tree. Only
1042 # remove the directory if it is empty.
1044 # $1 - pathname of the directory (relative to DESTDIR)
1045 handle_removed_directory()
1050 if ignore $dir; then
1051 log "IGNORE: removed dir $dir"
1055 if [ -d $DESTDIR/$dir -a -d $OLDTREE/$dir ]; then
1056 if empty_destdir $dir; then
1057 log "rmdir ${DESTDIR}$dir"
1058 if [ -z "$dryrun" ]; then
1059 rmdir ${DESTDIR}$dir >/dev/null 2>&1
1063 warn "Non-empty directory remains: $dir"
1068 # Handle a file that exists in both the old and new trees. If the
1069 # file has not changed in the old and new trees, there is nothing to
1070 # do. If the file in the destination directory matches the new file,
1071 # there is nothing to do. If the file in the destination directory
1072 # matches the old file, then the new file should be installed.
1073 # Everything else becomes some sort of conflict with more detailed
1076 # $1 - pathname of the file (relative to DESTDIR)
1077 handle_modified_file()
1079 local cmp dest file new newdestcmp old
1082 if ignore $file; then
1083 log "IGNORE: modified file $file"
1087 compare $OLDTREE/$file $NEWTREE/$file
1089 if [ $cmp -eq $COMPARE_EQUAL ]; then
1093 if [ $cmp -eq $COMPARE_ONLYFIRST -o $cmp -eq $COMPARE_ONLYSECOND ]; then
1094 panic "Changed file now missing"
1097 compare $NEWTREE/$file $DESTDIR/$file
1099 if [ $newdestcmp -eq $COMPARE_EQUAL ]; then
1103 # If the only change in the new file versus the destination
1104 # file is a change in the FreeBSD ID string and -F is
1105 # specified, just install the new file.
1106 if [ -n "$FREEBSD_ID" -a $newdestcmp -eq $COMPARE_DIFFFILES ] && \
1107 fbsdid_only $NEWTREE/$file $DESTDIR/$file; then
1108 if update_unmodified $file; then
1111 panic "Updating FreeBSD ID string failed"
1115 # If the local file is the same as the old file, install the
1116 # new file. If -F is specified and the only local change is
1117 # in the FreeBSD ID string, then install the new file as well.
1118 if compare_fbsdid $OLDTREE/$file $DESTDIR/$file; then
1119 if update_unmodified $file; then
1124 # If the file was removed from the dest tree, just whine.
1125 if [ $newdestcmp -eq $COMPARE_ONLYFIRST ]; then
1126 # If the removed file matches an ALWAYS_INSTALL glob,
1127 # then just install the new version of the file.
1128 if always_install $file; then
1129 log "ALWAYS: adding $file"
1130 if ! [ -d $NEWTREE/$file ]; then
1131 if install_new $file; then
1138 # If the only change in the new file versus the old
1139 # file is a change in the FreeBSD ID string and -F is
1140 # specified, don't warn.
1141 if [ -n "$FREEBSD_ID" -a $cmp -eq $COMPARE_DIFFFILES ] && \
1142 fbsdid_only $OLDTREE/$file $NEWTREE/$file; then
1148 old=`file_type $OLDTREE/$file`
1149 new=`file_type $NEWTREE/$file`
1150 warn "Remove mismatch: $file ($old became $new)"
1153 old=`readlink $OLDTREE/$file`
1154 new=`readlink $NEWTREE/$file`
1156 "Removed link changed: $file (\"$old\" became \"$new\")"
1159 warn "Removed file changed: $file"
1165 # Treat the file as unmodified and force install of the new
1166 # file if it matches an ALWAYS_INSTALL glob. If the update
1167 # attempt fails, then fall through to the normal case so a
1168 # warning is generated.
1169 if always_install $file; then
1170 log "ALWAYS: updating $file"
1171 if update_unmodified $file; then
1176 # If the only change in the new file versus the old file is a
1177 # change in the FreeBSD ID string and -F is specified, just
1178 # update the FreeBSD ID string in the local file.
1179 if [ -n "$FREEBSD_ID" -a $cmp -eq $COMPARE_DIFFFILES ] && \
1180 fbsdid_only $OLDTREE/$file $NEWTREE/$file; then
1181 if update_freebsdid $file; then
1186 # If the file changed types between the old and new trees but
1187 # the files in the new and dest tree are both of the same
1188 # type, treat it like an added file just comparing the new and
1190 if [ $cmp -eq $COMPARE_DIFFTYPE ]; then
1193 new=`readlink $NEWTREE/$file`
1194 dest=`readlink $DESTDIR/$file`
1196 "New link conflict: $file (\"$new\" vs \"$dest\")"
1206 # If the file has not changed types between the old
1207 # and new trees, but it is a different type in
1208 # DESTDIR, then just warn.
1209 if [ $newdestcmp -eq $COMPARE_DIFFTYPE ]; then
1210 new=`file_type $NEWTREE/$file`
1211 dest=`file_type $DESTDIR/$file`
1212 warn "Modified mismatch: $file ($new vs $dest)"
1219 old=`file_type $OLDTREE/$file`
1220 new=`file_type $NEWTREE/$file`
1221 dest=`file_type $DESTDIR/$file`
1222 warn "Modified $dest changed: $file ($old became $new)"
1225 old=`readlink $OLDTREE/$file`
1226 new=`readlink $NEWTREE/$file`
1228 "Modified link changed: $file (\"$old\" became \"$new\")"
1236 # Handle a file that has been added in the new tree. If the file does
1237 # not exist in DESTDIR, simply copy the file into DESTDIR. If the
1238 # file exists in the DESTDIR and is identical to the new version, do
1239 # nothing. Otherwise, generate a diff of the two versions of the file
1240 # and mark it as a conflict.
1242 # $1 - pathname of the file (relative to DESTDIR)
1245 local cmp dest file new
1248 if ignore $file; then
1249 log "IGNORE: added file $file"
1253 compare $DESTDIR/$file $NEWTREE/$file
1260 panic "Added file now missing"
1262 $COMPARE_ONLYSECOND)
1263 # Ignore new directories. They will be
1264 # created as needed when non-directory nodes
1266 if ! [ -d $NEWTREE/$file ]; then
1267 if install_new $file; then
1276 # Treat the file as unmodified and force install of the new
1277 # file if it matches an ALWAYS_INSTALL glob. If the update
1278 # attempt fails, then fall through to the normal case so a
1279 # warning is generated.
1280 if always_install $file; then
1281 log "ALWAYS: updating $file"
1282 if update_unmodified $file; then
1289 new=`file_type $NEWTREE/$file`
1290 dest=`file_type $DESTDIR/$file`
1291 warn "New file mismatch: $file ($new vs $dest)"
1294 new=`readlink $NEWTREE/$file`
1295 dest=`readlink $DESTDIR/$file`
1296 warn "New link conflict: $file (\"$new\" vs \"$dest\")"
1299 # If the only change in the new file versus
1300 # the destination file is a change in the
1301 # FreeBSD ID string and -F is specified, just
1302 # install the new file.
1303 if [ -n "$FREEBSD_ID" ] && \
1304 fbsdid_only $NEWTREE/$file $DESTDIR/$file; then
1305 if update_unmodified $file; then
1309 "Updating FreeBSD ID string failed"
1319 # Main routines for each command
1321 # Build a new tree and save it in a tarball.
1326 if [ $# -ne 1 ]; then
1327 echo "Missing required tarball."
1332 log "build command: $1"
1334 # Create a temporary directory to hold the tree
1335 dir=`mktemp -d $WORKDIR/etcupdate-XXXXXXX`
1336 if [ $? -ne 0 ]; then
1337 echo "Unable to create temporary directory."
1340 if ! build_tree $dir; then
1341 echo "Failed to build tree."
1345 if ! tar cfj $1 -C $dir . >&3 2>&1; then
1346 echo "Failed to create tarball."
1353 # Output a diff comparing the tree at DESTDIR to the current
1354 # unmodified tree. Note that this diff does not include files that
1355 # are present in DESTDIR but not in the unmodified tree.
1360 if [ $# -ne 0 ]; then
1364 # Requires an unmodified tree to diff against.
1365 if ! [ -d $NEWTREE ]; then
1366 echo "Reference tree to diff against unavailable."
1370 # Unfortunately, diff alone does not quite provide the right
1371 # level of options that we want, so improvise.
1372 for file in `(cd $NEWTREE; find .) | sed -e 's/^\.//'`; do
1373 if ignore $file; then
1377 diffnode $NEWTREE "$DESTDIR" $file "stock" "local"
1381 # Just extract a new tree into NEWTREE either by building a tree or
1382 # extracting a tarball. This can be used to bootstrap updates by
1383 # initializing the current "stock" tree to match the currently
1386 # Unlike 'update', this command does not rotate or preserve an
1387 # existing NEWTREE, it just replaces any existing tree.
1391 if [ $# -ne 0 ]; then
1395 log "extract command: tarball=$tarball"
1397 # Create a temporary directory to hold the tree
1398 dir=`mktemp -d $WORKDIR/etcupdate-XXXXXXX`
1399 if [ $? -ne 0 ]; then
1400 echo "Unable to create temporary directory."
1406 if [ -d $NEWTREE ]; then
1407 if ! remove_tree $NEWTREE; then
1408 echo "Unable to remove current tree."
1414 if ! mv $dir $NEWTREE >&3 2>&1; then
1415 echo "Unable to rename temp tree to current tree."
1421 # Resolve conflicts left from an earlier merge.
1426 if [ $# -ne 0 ]; then
1430 if ! [ -d $CONFLICTS ]; then
1434 if ! [ -d $NEWTREE ]; then
1435 echo "The current tree is not present to resolve conflicts."
1439 conflicts=`(cd $CONFLICTS; find . ! -type d) | sed -e 's/^\.//'`
1440 for file in $conflicts; do
1441 resolve_conflict $file
1444 if [ -n "$NEWALIAS_WARN" ]; then
1445 warn "Needs update: /etc/mail/aliases.db" \
1446 "(requires manual update via newaliases(1))"
1449 echo " Needs update: /etc/mail/aliases.db" \
1450 "(requires manual update via newaliases(1))"
1454 # Restore files to the stock version. Only files with a local change
1455 # are restored from the stock version.
1460 if [ $# -eq 0 ]; then
1467 if ! [ -e $NEWTREE/$file ]; then
1468 echo "File $file does not exist in the current tree."
1471 if [ -d $NEWTREE/$file ]; then
1472 echo "File $file is a directory."
1476 compare $DESTDIR/$file $NEWTREE/$file
1478 if [ $cmp -eq $COMPARE_EQUAL ]; then
1482 if update_unmodified $file; then
1483 # If this file had a conflict, clean up the
1485 if [ -e $CONFLICTS/$file ]; then
1486 if ! rm $CONFLICTS/$file >&3 2>&1; then
1487 echo "Failed to remove conflict " \
1495 # Report a summary of the previous merge. Specifically, list any
1496 # remaining conflicts followed by any warnings from the previous
1501 if [ $# -ne 0 ]; then
1505 if [ -d $CONFLICTS ]; then
1506 (cd $CONFLICTS; find . ! -type d) | sed -e 's/^\./ C /'
1508 if [ -s $WARNINGS ]; then
1514 # Perform an actual merge. The new tree can either already exist (if
1515 # rerunning a merge), be extracted from a tarball, or generated from a
1521 if [ $# -ne 0 ]; then
1525 log "update command: rerun=$rerun tarball=$tarball preworld=$preworld"
1527 if [ `id -u` -ne 0 ]; then
1528 echo "Must be root to update a tree."
1532 # Enforce a sane umask
1535 # XXX: Should existing conflicts be ignored and removed during
1538 # Trim the conflicts tree. Whine if there is anything left.
1539 if [ -e $CONFLICTS ]; then
1540 find -d $CONFLICTS -type d -empty -delete >&3 2>&1
1541 rmdir $CONFLICTS >&3 2>&1
1543 if [ -d $CONFLICTS ]; then
1544 echo "Conflicts remain from previous update, aborting."
1548 # Save tree names to use for rotation later.
1551 if [ -z "$rerun" ]; then
1552 # Extract the new tree to a temporary directory. The
1553 # trees are only rotated after a successful update to
1554 # avoid races if an update command is interrupted
1555 # before it completes.
1556 dir=`mktemp -d $WORKDIR/etcupdate-XXXXXXX`
1557 if [ $? -ne 0 ]; then
1558 echo "Unable to create temporary directory."
1562 # Populate the new tree.
1565 # Compare the new tree against the previous tree. For
1566 # the preworld case OLDTREE already points to the
1567 # current stock tree.
1568 if [ -z "$preworld" ]; then
1574 if ! [ -d $OLDTREE ]; then
1576 No previous tree to compare against, a sane comparison is not possible.
1578 log "No previous tree to compare against."
1579 if [ -n "$dir" ]; then
1580 if [ -n "$rerun" ]; then
1581 panic "Should not have a temporary directory"
1588 # Build lists of nodes in the old and new trees.
1589 (cd $OLDTREE; find .) | sed -e 's/^\.//' | sort > $WORKDIR/old.files
1590 (cd $NEWTREE; find .) | sed -e 's/^\.//' | sort > $WORKDIR/new.files
1592 # Split the files up into three groups using comm.
1593 comm -23 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/removed.files
1594 comm -13 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/added.files
1595 comm -12 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/both.files
1597 # Initialize conflicts and warnings handling.
1601 # Ignore removed files for the pre-world case. A pre-world
1602 # update uses a stripped-down tree.
1603 if [ -n "$preworld" ]; then
1604 > $WORKDIR/removed.files
1607 # The order for the following sections is important. In the
1608 # odd case that a directory is converted into a file, the
1609 # existing subfiles need to be removed if possible before the
1610 # file is converted. Similarly, in the case that a file is
1611 # converted into a directory, the file needs to be converted
1612 # into a directory if possible before the new files are added.
1614 # First, handle removed files.
1615 for file in `cat $WORKDIR/removed.files`; do
1616 handle_removed_file $file
1619 # For the directory pass, reverse sort the list to effect a
1620 # depth-first traversal. This is needed to ensure that if a
1621 # directory with subdirectories is removed, the entire
1622 # directory is removed if there are no local modifications.
1623 for file in `sort -r $WORKDIR/removed.files`; do
1624 handle_removed_directory $file
1627 # Second, handle files that exist in both the old and new
1629 for file in `cat $WORKDIR/both.files`; do
1630 handle_modified_file $file
1633 # Finally, handle newly added files.
1634 for file in `cat $WORKDIR/added.files`; do
1635 handle_added_file $file
1638 if [ -n "$NEWALIAS_WARN" ]; then
1639 warn "Needs update: /etc/mail/aliases.db" \
1640 "(requires manual update via newaliases(1))"
1643 # Run any special one-off commands after an update has completed.
1646 if [ -s $WARNINGS ]; then
1651 # If this was a dryrun, remove the temporary tree if we built
1653 if [ -n "$dryrun" ]; then
1654 if [ -n "$dir" ]; then
1655 if [ -n "$rerun" ]; then
1656 panic "Should not have a temporary directory"
1663 # Finally, rotate any needed trees.
1664 if [ "$new" != "$NEWTREE" ]; then
1665 if [ -n "$rerun" ]; then
1666 panic "Should not have a temporary directory"
1668 if [ -z "$dir" ]; then
1669 panic "Should have a temporary directory"
1672 # Rotate the old tree if needed
1673 if [ "$old" != "$OLDTREE" ]; then
1674 if [ -n "$preworld" ]; then
1675 panic "Old tree should be unchanged"
1678 if ! remove_tree $old; then
1679 echo "Unable to remove previous old tree."
1683 if ! mv $OLDTREE $old >&3 2>&1; then
1684 echo "Unable to rename old tree."
1689 # Rotate the new tree. Remove a previous pre-world
1690 # tree if it exists.
1691 if [ -d $new ]; then
1692 if [ -z "$preworld" ]; then
1693 panic "New tree should be rotated to old"
1695 if ! remove_tree $new; then
1696 echo "Unable to remove previous pre-world tree."
1701 if ! mv $NEWTREE $new >&3 2>&1; then
1702 echo "Unable to rename current tree."
1708 # Determine which command we are executing. A command may be
1709 # specified as the first word. If one is not specified then 'update'
1710 # is assumed as the default command.
1712 if [ $# -gt 0 ]; then
1714 build|diff|extract|status|resolve|revert)
1719 # If first arg is an option, assume the
1728 # Set default variable values.
1730 # The path to the source tree used to build trees.
1733 # The destination directory where the modified files live.
1736 # Ignore changes in the FreeBSD ID string.
1739 # Files that should always have the new version of the file installed.
1742 # Files to ignore and never update during a merge.
1745 # The path to the make binary
1748 # Flags to pass to 'make' when building a tree.
1751 # Include a config file if it exists. Note that command line options
1752 # override any settings in the config file. More details are in the
1753 # manual, but in general the following variables can be set:
1764 if [ -r /etc/etcupdate.conf ]; then
1765 . /etc/etcupdate.conf
1768 # Parse command line options
1777 while getopts "d:m:nprs:t:A:BD:FI:L:M:N" option; do
1801 # To allow this option to be specified
1802 # multiple times, accumulate command-line
1803 # specified patterns in an 'always' variable
1804 # and use that to overwrite ALWAYS_INSTALL
1805 # after parsing all options. Need to be
1806 # careful here with globbing expansion.
1808 always="$always $OPTARG"
1821 # To allow this option to be specified
1822 # multiple times, accumulate command-line
1823 # specified patterns in an 'ignore' variable
1824 # and use that to overwrite IGNORE_FILES after
1825 # parsing all options. Need to be careful
1826 # here with globbing expansion.
1828 ignore="$ignore $OPTARG"
1835 MAKE_OPTIONS="$OPTARG"
1846 shift $((OPTIND - 1))
1848 # Allow -A command line options to override ALWAYS_INSTALL set from
1851 if [ -n "$always" ]; then
1852 ALWAYS_INSTALL="$always"
1855 # Allow -I command line options to override IGNORE_FILES set from the
1857 if [ -n "$ignore" ]; then
1858 IGNORE_FILES="$ignore"
1862 # Where the "old" and "new" trees are stored.
1863 WORKDIR=${WORKDIR:-$DESTDIR/var/db/etcupdate}
1865 # Log file for verbose output from program that are run. The log file
1866 # is opened on fd '3'.
1867 LOGFILE=${LOGFILE:-$WORKDIR/log}
1869 # The path of the "old" tree
1870 OLDTREE=$WORKDIR/old
1872 # The path of the "new" tree
1873 NEWTREE=$WORKDIR/current
1875 # The path of the "conflicts" tree where files with merge conflicts are saved.
1876 CONFLICTS=$WORKDIR/conflicts
1878 # The path of the "warnings" file that accumulates warning notes from an update.
1879 WARNINGS=$WORKDIR/warnings
1881 # Use $EDITOR for resolving conflicts. If it is not set, default to vi.
1882 EDITOR=${EDITOR:-/usr/bin/vi}
1884 # Files that need to be updated before installworld.
1885 PREWORLD_FILES="etc/master.passwd etc/group"
1887 # Handle command-specific argument processing such as complaining
1888 # about unsupported options. Since the configuration file is always
1889 # included, do not complain about extra command line arguments that
1890 # may have been set via the config file rather than the command line.
1893 if [ -n "$rerun" -a -n "$tarball" ]; then
1894 echo "Only one of -r or -t can be specified."
1898 if [ -n "$rerun" -a -n "$preworld" ]; then
1899 echo "Only one of -p or -r can be specified."
1904 build|diff|status|revert)
1905 if [ -n "$dryrun" -o -n "$rerun" -o -n "$tarball" -o \
1906 -n "$preworld" ]; then
1911 if [ -n "$dryrun" -o -n "$rerun" -o -n "$tarball" ]; then
1916 if [ -n "$dryrun" -o -n "$rerun" -o -n "$preworld" ]; then
1922 # Pre-world mode uses a different set of trees. It leaves the current
1923 # tree as-is so it is still present for a full etcupdate run after the
1924 # world install is complete. Instead, it installs a few critical files
1925 # into a separate tree.
1926 if [ -n "$preworld" ]; then
1928 NEWTREE=$WORKDIR/preworld
1931 # Open the log file. Don't truncate it if doing a minor operation so
1932 # that a minor operation doesn't lose log info from a major operation.
1933 if ! mkdir -p $WORKDIR 2>/dev/null; then
1934 echo "Failed to create work directory $WORKDIR"
1938 diff|resolve|revert|status)