3 # Copyright (c) 2010-2013 Hudson River Trading LLC
4 # Written by: John H. Baldwin <jhb@FreeBSD.org>
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
10 # 1. Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # 2. Redistributions in binary form must reproduce the above copyright
13 # notice, this list of conditions and the following disclaimer in the
14 # documentation and/or other materials provided with the distribution.
16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 # This is a tool to manage updating files that are not updated as part
31 # of 'make installworld' such as files in /etc. Unlike other tools,
32 # this one is specifically tailored to assisting with mass upgrades.
33 # To that end it does not require user intervention while running.
35 # Theory of operation:
37 # The most reliable way to update changes to files that have local
38 # modifications is to perform a three-way merge between the original
39 # unmodified file, the new version of the file, and the modified file.
40 # This requires having all three versions of the file available when
41 # performing an update.
43 # To that end, etcupdate uses a strategy where the current unmodified
44 # tree is kept in WORKDIR/current and the previous unmodified tree is
45 # kept in WORKDIR/old. When performing a merge, a new tree is built
46 # if needed and then the changes are merged into DESTDIR. Any files
47 # with unresolved conflicts after the merge are left in a tree rooted
48 # at WORKDIR/conflicts.
50 # To provide extra flexibility, etcupdate can also build tarballs of
51 # root trees that can later be used. It can also use a tarball as the
52 # source of a new tree instead of building it from /usr/src.
54 # Global settings. These can be adjusted by config files and in some
55 # cases by command line options.
58 # - automatable conflict resolution
59 # - a 'revert' command to make a file "stock"
64 usage: etcupdate [-npBF] [-d workdir] [-r | -s source | -t tarball]
65 [-A patterns] [-D destdir] [-I patterns] [-L logfile]
67 etcupdate build [-B] [-d workdir] [-s source] [-L logfile] [-M options]
69 etcupdate diff [-d workdir] [-D destdir] [-I patterns] [-L logfile]
70 etcupdate extract [-B] [-d workdir] [-s source | -t tarball] [-L logfile]
72 etcupdate resolve [-p] [-d workdir] [-D destdir] [-L logfile]
73 etcupdate status [-d workdir] [-D destdir]
78 # Used to write a message prepended with '>>>' to the logfile.
84 # Used for assertion conditions that should never happen.
91 # Used to write a warning message. These are saved to the WARNINGS
92 # file with " " prepended.
95 echo -n " " >> $WARNINGS
96 echo "$@" >> $WARNINGS
99 # Output a horizontal rule using the passed-in character. Matches the
100 # length used for Index lines in CVS and SVN diffs.
108 # Output a text description of a specified file's type.
110 # $1 - file pathname.
113 stat -f "%HT" $1 | tr "[:upper:]" "[:lower:]"
116 # Returns true (0) if a file exists
118 # $1 - file pathname.
124 # Returns true (0) if a file should be ignored, false otherwise.
132 for pattern in $IGNORE_FILES; do
142 # Ignore /.cshrc and /.profile if they are hardlinked to the
143 # same file in /root. This ensures we only compare those
144 # files once in that case.
147 if [ ${DESTDIR}$1 -ef ${DESTDIR}/root$1 ]; then
158 # Returns true (0) if the new version of a file should always be
159 # installed rather than attempting to do a merge.
167 for pattern in $ALWAYS_INSTALL; do
182 # $1 - directory to store new tree in
185 local destdir dir file make
187 make="make $MAKE_OPTIONS -DNO_FILEMON"
189 log "Building tree at $1 with $make"
190 mkdir -p $1/usr/obj >&3 2>&1
191 destdir=`realpath $1`
193 if [ -n "$preworld" ]; then
194 # Build a limited tree that only contains files that are
195 # crucial to installworld.
196 for file in $PREWORLD_FILES; do
198 mkdir -p $1/$dir >&3 2>&1 || return 1
199 cp -p $SRCDIR/$file $1/$file || return 1
201 elif ! [ -n "$nobuild" ]; then
202 (cd $SRCDIR; $make DESTDIR=$destdir distrib-dirs &&
203 MAKEOBJDIRPREFIX=$destdir/usr/obj $make _obj SUBDIR_OVERRIDE=etc &&
204 MAKEOBJDIRPREFIX=$destdir/usr/obj $make everything SUBDIR_OVERRIDE=etc &&
205 MAKEOBJDIRPREFIX=$destdir/usr/obj $make DESTDIR=$destdir distribution) \
208 (cd $SRCDIR; $make DESTDIR=$destdir distrib-dirs &&
209 $make DESTDIR=$destdir distribution) >&3 2>&1 || return 1
211 chflags -R noschg $1 >&3 2>&1 || return 1
212 rm -rf $1/usr/obj >&3 2>&1 || return 1
214 # Purge auto-generated files. Only the source files need to
215 # be updated after which these files are regenerated.
216 rm -f $1/etc/*.db $1/etc/passwd $1/var/db/services.db >&3 2>&1 || \
219 # Remove empty files. These just clutter the output of 'diff'.
220 find $1 -type f -size 0 -delete >&3 2>&1 || return 1
222 # Trim empty directories.
223 find -d $1 -type d -empty -delete >&3 2>&1 || return 1
227 # Generate a new NEWTREE tree. If tarball is set, then the tree is
228 # extracted from the tarball. Otherwise the tree is built from a
234 # If we have a tarball, extract that into the new directory.
235 if [ -n "$tarball" ]; then
237 if [ -n "$preworld" ]; then
238 files="$PREWORLD_FILES"
240 if ! (mkdir -p $NEWTREE && tar xf $tarball -C $NEWTREE $files) \
242 echo "Failed to extract new tree."
247 if ! build_tree $NEWTREE; then
248 echo "Failed to build new tree."
255 # Forcefully remove a tree. Returns true (0) if the operation succeeds.
263 chflags -R noschg $1 >&3 2>&1
269 # Return values for compare()
277 # Compare two files/directories/symlinks. Note that this does not
278 # recurse into subdirectories. Instead, if two nodes are both
279 # directories, they are assumed to be equivalent.
281 # Returns true (0) if the nodes are identical. If only one of the two
282 # nodes are present, return one of the COMPARE_ONLY* constants. If
283 # the nodes are different, return one of the COMPARE_DIFF* constants
284 # to indicate the type of difference.
292 # If the first node doesn't exist, then check for the second
293 # node. Note that -e will fail for a symbolic link that
294 # points to a missing target.
297 return $COMPARE_ONLYSECOND
299 return $COMPARE_EQUAL
301 elif ! exists $2; then
302 return $COMPARE_ONLYFIRST
305 # If the two nodes are different file types fail.
306 first=`stat -f "%Hp" $1`
307 second=`stat -f "%Hp" $2`
308 if [ "$first" != "$second" ]; then
309 return $COMPARE_DIFFTYPE
312 # If both are symlinks, compare the link values.
316 if [ "$first" = "$second" ]; then
317 return $COMPARE_EQUAL
319 return $COMPARE_DIFFLINKS
323 # If both are files, compare the file contents.
325 if cmp -s $1 $2; then
326 return $COMPARE_EQUAL
328 return $COMPARE_DIFFFILES
332 # As long as the two nodes are the same type of file, consider
334 return $COMPARE_EQUAL
337 # Returns true (0) if the only difference between two regular files is a
338 # change in the FreeBSD ID string.
340 # $1 - path of first file
341 # $2 - path of second file
345 diff -qI '\$FreeBSD.*\$' $1 $2 >/dev/null 2>&1
348 # This is a wrapper around compare that will return COMPARE_EQUAL if
349 # the only difference between two regular files is a change in the
350 # FreeBSD ID string. It only makes this adjustment if the -F flag has
362 if [ -n "$FREEBSD_ID" -a "$cmp" -eq $COMPARE_DIFFFILES ] && \
363 fbsdid_only $1 $2; then
364 return $COMPARE_EQUAL
370 # Returns true (0) if a directory is empty.
372 # $1 - pathname of the directory to check
381 # Returns true (0) if one directories contents are a subset of the
382 # other. This will recurse to handle subdirectories and compares
383 # individual files in the trees. Its purpose is to quiet spurious
384 # directory warnings for dryrun invocations.
386 # $1 - first directory (sub)
387 # $2 - second directory (super)
392 if ! [ -d $1 -a -d $2 ]; then
396 # Ignore files that are present in the second directory but not
399 for file in $contents; do
400 if ! compare $1/$file $2/$file; then
404 if [ -d $1/$file ]; then
405 if ! dir_subset $1/$file $2/$file; then
413 # Returns true (0) if a directory in the destination tree is empty.
414 # If this is a dryrun, then this returns true as long as the contents
415 # of the directory are a subset of the contents in the old tree
416 # (meaning that the directory would be empty in a non-dryrun when this
417 # was invoked) to quiet spurious warnings.
419 # $1 - pathname of the directory to check relative to DESTDIR.
423 if [ -n "$dryrun" ]; then
424 dir_subset $DESTDIR/$1 $OLDTREE/$1
428 empty_dir $DESTDIR/$1
431 # Output a diff of two directory entries with the same relative name
432 # in different trees. Note that as with compare(), this does not
433 # recurse into subdirectories. If the nodes are identical, nothing is
439 # $4 - label for first tree
440 # $5 - label for second tree
443 local first second file old new diffargs
445 if [ -n "$FREEBSD_ID" ]; then
446 diffargs="-I \\\$FreeBSD.*\\\$"
451 compare_fbsdid $1/$3 $2/$3
466 first=`file_type $1/$3`
467 second=`file_type $2/$3`
469 echo "Node changed from a $first to a $second: $3"
473 first=`readlink $1/$file`
474 second=`readlink $2/$file`
476 echo "Link changed: $file"
485 diff -u $diffargs -L "$3 ($4)" $1/$3 -L "$3 ($5)" $2/$3
490 # Run one-off commands after an update has completed. These commands
491 # are not tied to a specific file, so they cannot be handled by
492 # post_install_file().
497 # None of these commands should be run for a pre-world update.
498 if [ -n "$preworld" ]; then
502 # If /etc/localtime exists and is not a symlink and /var/db/zoneinfo
503 # exists, run tzsetup -r to refresh /etc/localtime.
504 if [ -f ${DESTDIR}/etc/localtime -a \
505 ! -L ${DESTDIR}/etc/localtime ]; then
506 if [ -f ${DESTDIR}/var/db/zoneinfo ]; then
507 if [ -n "${DESTDIR}" ]; then
512 log "tzsetup -r ${args}"
513 if [ -z "$dryrun" ]; then
514 tzsetup -r ${args} >&3 2>&1
517 warn "Needs update: /etc/localtime (required" \
518 "manual update via tzsetup(8))"
523 # Create missing parent directories of a node in a target tree
524 # preserving the owner, group, and permissions from a specified
529 # $3 - pathname of the node (relative to both trees)
536 # Nothing to do if the parent directory exists. This also
537 # catches the degenerate cases when the path is just a simple
539 if [ -d ${2}$dir ]; then
543 # If non-directory file exists with the desired directory
545 if exists ${2}$dir; then
546 # If this is a dryrun and we are installing the
547 # directory in the DESTDIR and the file in the DESTDIR
548 # matches the file in the old tree, then fake success
549 # to quiet spurious warnings.
550 if [ -n "$dryrun" -a "$2" = "$DESTDIR" ]; then
551 if compare $OLDTREE/$dir $DESTDIR/$dir; then
556 args=`file_type ${2}$dir`
557 warn "Directory mismatch: ${2}$dir ($args)"
561 # Ensure the parent directory of the directory is present
563 if ! install_dirs $1 "$2" $dir; then
567 # Format attributes from template directory as install(1)
569 args=`stat -f "-o %Su -g %Sg -m %0Mp%0Lp" $1/$dir`
571 log "install -d $args ${2}$dir"
572 if [ -z "$dryrun" ]; then
573 install -d $args ${2}$dir >&3 2>&1
578 # Perform post-install fixups for a file. This largely consists of
579 # regenerating any files that depend on the newly installed file.
581 # $1 - pathname of the updated file (relative to DESTDIR)
586 # Grr, newaliases only works for an empty DESTDIR.
587 if [ -z "$DESTDIR" ]; then
589 if [ -z "$dryrun" ]; then
597 log "cap_mkdb ${DESTDIR}$1"
598 if [ -z "$dryrun" ]; then
599 cap_mkdb ${DESTDIR}$1 >&3 2>&1
603 log "pwd_mkdb -p -d $DESTDIR/etc ${DESTDIR}$1"
604 if [ -z "$dryrun" ]; then
605 pwd_mkdb -p -d $DESTDIR/etc ${DESTDIR}$1 \
610 # /etc/rc.d/motd hardcodes the /etc/motd path.
611 # Don't warn about non-empty DESTDIR's since this
612 # change is only cosmetic anyway.
613 if [ -z "$DESTDIR" ]; then
614 log "sh /etc/rc.d/motd start"
615 if [ -z "$dryrun" ]; then
616 sh /etc/rc.d/motd start >&3 2>&1
621 log "services_mkdb -q -o $DESTDIR/var/db/services.db" \
623 if [ -z "$dryrun" ]; then
624 services_mkdb -q -o $DESTDIR/var/db/services.db \
625 ${DESTDIR}$1 >&3 2>&1
631 # Install the "new" version of a file. Returns true if it succeeds
632 # and false otherwise.
634 # $1 - pathname of the file to install (relative to DESTDIR)
638 if ! install_dirs $NEWTREE "$DESTDIR" $1; then
641 log "cp -Rp ${NEWTREE}$1 ${DESTDIR}$1"
642 if [ -z "$dryrun" ]; then
643 cp -Rp ${NEWTREE}$1 ${DESTDIR}$1 >&3 2>&1
649 # Install the "resolved" version of a file. Returns true if it succeeds
650 # and false otherwise.
652 # $1 - pathname of the file to install (relative to DESTDIR)
656 # This should always be present since the file is already
657 # there (it caused a conflict). However, it doesn't hurt to
659 if ! install_dirs $NEWTREE "$DESTDIR" $1; then
663 log "cp -Rp ${CONFLICTS}$1 ${DESTDIR}$1"
664 cp -Rp ${CONFLICTS}$1 ${DESTDIR}$1 >&3 2>&1
669 # Generate a conflict file when a "new" file conflicts with an
670 # existing file in DESTDIR.
672 # $1 - pathname of the file that conflicts (relative to DESTDIR)
676 if [ -n "$dryrun" ]; then
680 install_dirs $NEWTREE $CONFLICTS $1
681 diff --changed-group-format='<<<<<<< (local)
684 ' $DESTDIR/$1 $NEWTREE/$1 > $CONFLICTS/$1
687 # Remove the "old" version of a file.
689 # $1 - pathname of the old file to remove (relative to DESTDIR)
692 log "rm -f ${DESTDIR}$1"
693 if [ -z "$dryrun" ]; then
694 rm -f ${DESTDIR}$1 >&3 2>&1
699 # Update a file that has no local modifications.
701 # $1 - pathname of the file to update (relative to DESTDIR)
706 # If the old file is a directory, then remove it with rmdir
707 # (this should only happen if the file has changed its type
708 # from a directory to a non-directory). If the directory
709 # isn't empty, then fail. This will be reported as a warning
711 if [ -d $DESTDIR/$1 ]; then
712 if empty_destdir $1; then
713 log "rmdir ${DESTDIR}$1"
714 if [ -z "$dryrun" ]; then
715 rmdir ${DESTDIR}$1 >&3 2>&1
721 # If both the old and new files are regular files, leave the
722 # existing file. This avoids breaking hard links for /.cshrc
723 # and /.profile. Otherwise, explicitly remove the old file.
724 elif ! [ -f ${DESTDIR}$1 -a -f ${NEWTREE}$1 ]; then
725 log "rm -f ${DESTDIR}$1"
726 if [ -z "$dryrun" ]; then
727 rm -f ${DESTDIR}$1 >&3 2>&1
731 # If the new file is a directory, note that the old file has
732 # been removed, but don't do anything else for now. The
733 # directory will be installed if needed when new files within
734 # that directory are installed.
735 if [ -d $NEWTREE/$1 ]; then
736 if empty_dir $NEWTREE/$1; then
741 elif install_new $1; then
747 # Update the FreeBSD ID string in a locally modified file to match the
748 # FreeBSD ID string from the "new" version of the file.
750 # $1 - pathname of the file to update (relative to DESTDIR)
755 # If the FreeBSD ID string is removed from the local file,
756 # there is nothing to do. In this case, treat the file as
757 # updated. Otherwise, if either file has more than one
758 # FreeBSD ID string, just punt and let the user handle the
760 new=`grep -c '\$FreeBSD.*\$' ${NEWTREE}$1`
761 dest=`grep -c '\$FreeBSD.*\$' ${DESTDIR}$1`
762 if [ "$dest" -eq 0 ]; then
765 if [ "$dest" -ne 1 -o "$dest" -ne 1 ]; then
769 # If the FreeBSD ID string in the new file matches the FreeBSD ID
770 # string in the local file, there is nothing to do.
771 new=`grep '\$FreeBSD.*\$' ${NEWTREE}$1`
772 dest=`grep '\$FreeBSD.*\$' ${DESTDIR}$1`
773 if [ "$new" = "$dest" ]; then
777 # Build the new file in three passes. First, copy all the
778 # lines preceding the FreeBSD ID string from the local version
779 # of the file. Second, append the FreeBSD ID string line from
780 # the new version. Finally, append all the lines after the
781 # FreeBSD ID string from the local version of the file.
782 file=`mktemp $WORKDIR/etcupdate-XXXXXXX`
783 awk '/\$FreeBSD.*\$/ { exit } { print }' ${DESTDIR}$1 >> $file
784 awk '/\$FreeBSD.*\$/ { print }' ${NEWTREE}$1 >> $file
785 awk '/\$FreeBSD.*\$/ { ok = 1; next } { if (ok) print }' \
786 ${DESTDIR}$1 >> $file
788 # As an extra sanity check, fail the attempt if the updated
789 # version of the file has any differences aside from the
791 if ! fbsdid_only ${DESTDIR}$1 $file; then
796 log "cp $file ${DESTDIR}$1"
797 if [ -z "$dryrun" ]; then
798 cp $file ${DESTDIR}$1 >&3 2>&1
806 # Attempt to update a file that has local modifications. This routine
807 # only handles regular files. If the 3-way merge succeeds without
808 # conflicts, the updated file is installed. If the merge fails, the
809 # merged version with conflict markers is left in the CONFLICTS tree.
811 # $1 - pathname of the file to merge (relative to DESTDIR)
816 # Try the merge to see if there is a conflict.
817 diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > /dev/null 2>&3
821 # No conflicts, so just redo the merge to the
823 log "diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1"
824 if [ -z "$dryrun" ]; then
825 temp=$(mktemp -t etcupdate)
826 diff3 -E -m ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > ${temp}
827 mv -f ${temp} ${DESTDIR}$1
833 # Conflicts, save a version with conflict markers in
834 # the conflicts directory.
835 if [ -z "$dryrun" ]; then
836 install_dirs $NEWTREE $CONFLICTS $1
837 log "diff3 -m -A ${DESTDIR}$1 ${CONFLICTS}$1"
838 diff3 -m -A -L "yours" -L "original" -L "new" \
839 ${DESTDIR}$1 ${OLDTREE}$1 ${NEWTREE}$1 > \
845 panic "merge failed with status $res"
850 # Returns true if a file contains conflict markers from a merge conflict.
852 # $1 - pathname of the file to resolve (relative to DESTDIR)
856 egrep -q '^(<{7}|\|{7}|={7}|>{7}) ' $CONFLICTS/$1
859 # Attempt to resolve a conflict. The user is prompted to choose an
860 # action for each conflict. If the user edits the file, they are
861 # prompted again for an action. The process is very similar to
862 # resolving conflicts after an update or merge with Perforce or
863 # Subversion. The prompts are modelled on a subset of the available
864 # commands for resolving conflicts with Subversion.
866 # $1 - pathname of the file to resolve (relative to DESTDIR)
871 echo "Resolving conflict in '$1':"
874 # Only display the resolved command if the file
875 # doesn't contain any conflicts.
876 echo -n "Select: (p) postpone, (df) diff-full, (e) edit,"
877 if ! has_conflicts $1; then
878 echo -n " (r) resolved,"
881 echo -n " (h) help for more options: "
885 diff -u ${DESTDIR}$1 ${CONFLICTS}$1
888 $EDITOR ${CONFLICTS}$1
892 (p) postpone - ignore this conflict for now
893 (df) diff-full - show all changes made to merged file
894 (e) edit - change merged file in an editor
895 (r) resolved - accept merged version of file
896 (mf) mine-full - accept local version of entire file (ignore new changes)
897 (tf) theirs-full - accept new version of entire file (lose local changes)
898 (h) help - show this list
902 # For mine-full, just delete the
903 # merged file and leave the local
904 # version of the file as-is.
912 # If the merged file has conflict
913 # markers, require confirmation.
914 if has_conflicts $1; then
915 echo "File '$1' still has conflicts," \
916 "are you sure? (y/n) "
918 if [ "$junk" != "y" ]; then
923 if ! install_resolved $1; then
924 panic "Unable to install merged" \
931 # For theirs-full, install the new
932 # version of the file over top of the
934 if ! install_new $1; then
935 panic "Unable to install new" \
942 echo "Invalid command."
948 # Handle a file that has been removed from the new tree. If the file
949 # does not exist in DESTDIR, then there is nothing to do. If the file
950 # exists in DESTDIR and is identical to the old version, remove it
951 # from DESTDIR. Otherwise, whine about the conflict but leave the
952 # file in DESTDIR. To handle directories, this uses two passes. The
953 # first pass handles all non-directory files. The second pass handles
954 # just directories and removes them if they are empty.
956 # If -F is specified, and the only difference in the file in DESTDIR
957 # is a change in the FreeBSD ID string, then remove the file.
959 # $1 - pathname of the file (relative to DESTDIR)
960 handle_removed_file()
965 if ignore $file; then
966 log "IGNORE: removed file $file"
970 compare_fbsdid $DESTDIR/$file $OLDTREE/$file
973 if ! [ -d $DESTDIR/$file ]; then
978 panic "Removed file now missing"
981 # Already removed, nothing to do.
983 $COMPARE_DIFFTYPE|$COMPARE_DIFFLINKS|$COMPARE_DIFFFILES)
984 dest=`file_type $DESTDIR/$file`
985 warn "Modified $dest remains: $file"
990 # Handle a directory that has been removed from the new tree. Only
991 # remove the directory if it is empty.
993 # $1 - pathname of the directory (relative to DESTDIR)
994 handle_removed_directory()
1000 log "IGNORE: removed dir $dir"
1004 if [ -d $DESTDIR/$dir -a -d $OLDTREE/$dir ]; then
1005 if empty_destdir $dir; then
1006 log "rmdir ${DESTDIR}$dir"
1007 if [ -z "$dryrun" ]; then
1008 rmdir ${DESTDIR}$dir >/dev/null 2>&1
1012 warn "Non-empty directory remains: $dir"
1017 # Handle a file that exists in both the old and new trees. If the
1018 # file has not changed in the old and new trees, there is nothing to
1019 # do. If the file in the destination directory matches the new file,
1020 # there is nothing to do. If the file in the destination directory
1021 # matches the old file, then the new file should be installed.
1022 # Everything else becomes some sort of conflict with more detailed
1025 # $1 - pathname of the file (relative to DESTDIR)
1026 handle_modified_file()
1028 local cmp dest file new newdestcmp old
1031 if ignore $file; then
1032 log "IGNORE: modified file $file"
1036 compare $OLDTREE/$file $NEWTREE/$file
1038 if [ $cmp -eq $COMPARE_EQUAL ]; then
1042 if [ $cmp -eq $COMPARE_ONLYFIRST -o $cmp -eq $COMPARE_ONLYSECOND ]; then
1043 panic "Changed file now missing"
1046 compare $NEWTREE/$file $DESTDIR/$file
1048 if [ $newdestcmp -eq $COMPARE_EQUAL ]; then
1052 # If the only change in the new file versus the destination
1053 # file is a change in the FreeBSD ID string and -F is
1054 # specified, just install the new file.
1055 if [ -n "$FREEBSD_ID" -a $newdestcmp -eq $COMPARE_DIFFFILES ] && \
1056 fbsdid_only $NEWTREE/$file $DESTDIR/$file; then
1057 if update_unmodified $file; then
1060 panic "Updating FreeBSD ID string failed"
1064 # If the local file is the same as the old file, install the
1065 # new file. If -F is specified and the only local change is
1066 # in the FreeBSD ID string, then install the new file as well.
1067 if compare_fbsdid $OLDTREE/$file $DESTDIR/$file; then
1068 if update_unmodified $file; then
1073 # If the file was removed from the dest tree, just whine.
1074 if [ $newdestcmp -eq $COMPARE_ONLYFIRST ]; then
1075 # If the removed file matches an ALWAYS_INSTALL glob,
1076 # then just install the new version of the file.
1077 if always_install $file; then
1078 log "ALWAYS: adding $file"
1079 if ! [ -d $NEWTREE/$file ]; then
1080 if install_new $file; then
1087 # If the only change in the new file versus the old
1088 # file is a change in the FreeBSD ID string and -F is
1089 # specified, don't warn.
1090 if [ -n "$FREEBSD_ID" -a $cmp -eq $COMPARE_DIFFFILES ] && \
1091 fbsdid_only $OLDTREE/$file $NEWTREE/$file; then
1097 old=`file_type $OLDTREE/$file`
1098 new=`file_type $NEWTREE/$file`
1099 warn "Remove mismatch: $file ($old became $new)"
1102 old=`readlink $OLDTREE/$file`
1103 new=`readlink $NEWTREE/$file`
1105 "Removed link changed: $file (\"$old\" became \"$new\")"
1108 warn "Removed file changed: $file"
1114 # Treat the file as unmodified and force install of the new
1115 # file if it matches an ALWAYS_INSTALL glob. If the update
1116 # attempt fails, then fall through to the normal case so a
1117 # warning is generated.
1118 if always_install $file; then
1119 log "ALWAYS: updating $file"
1120 if update_unmodified $file; then
1125 # If the only change in the new file versus the old file is a
1126 # change in the FreeBSD ID string and -F is specified, just
1127 # update the FreeBSD ID string in the local file.
1128 if [ -n "$FREEBSD_ID" -a $cmp -eq $COMPARE_DIFFFILES ] && \
1129 fbsdid_only $OLDTREE/$file $NEWTREE/$file; then
1130 if update_freebsdid $file; then
1135 # If the file changed types between the old and new trees but
1136 # the files in the new and dest tree are both of the same
1137 # type, treat it like an added file just comparing the new and
1139 if [ $cmp -eq $COMPARE_DIFFTYPE ]; then
1142 new=`readlink $NEWTREE/$file`
1143 dest=`readlink $DESTDIR/$file`
1145 "New link conflict: $file (\"$new\" vs \"$dest\")"
1155 # If the file has not changed types between the old
1156 # and new trees, but it is a different type in
1157 # DESTDIR, then just warn.
1158 if [ $newdestcmp -eq $COMPARE_DIFFTYPE ]; then
1159 new=`file_type $NEWTREE/$file`
1160 dest=`file_type $DESTDIR/$file`
1161 warn "Modified mismatch: $file ($new vs $dest)"
1168 old=`file_type $OLDTREE/$file`
1169 new=`file_type $NEWTREE/$file`
1170 dest=`file_type $DESTDIR/$file`
1171 warn "Modified $dest changed: $file ($old became $new)"
1174 old=`readlink $OLDTREE/$file`
1175 new=`readlink $NEWTREE/$file`
1177 "Modified link changed: $file (\"$old\" became \"$new\")"
1185 # Handle a file that has been added in the new tree. If the file does
1186 # not exist in DESTDIR, simply copy the file into DESTDIR. If the
1187 # file exists in the DESTDIR and is identical to the new version, do
1188 # nothing. Otherwise, generate a diff of the two versions of the file
1189 # and mark it as a conflict.
1191 # $1 - pathname of the file (relative to DESTDIR)
1194 local cmp dest file new
1197 if ignore $file; then
1198 log "IGNORE: added file $file"
1202 compare $DESTDIR/$file $NEWTREE/$file
1209 panic "Added file now missing"
1211 $COMPARE_ONLYSECOND)
1212 # Ignore new directories. They will be
1213 # created as needed when non-directory nodes
1215 if ! [ -d $NEWTREE/$file ]; then
1216 if install_new $file; then
1225 # Treat the file as unmodified and force install of the new
1226 # file if it matches an ALWAYS_INSTALL glob. If the update
1227 # attempt fails, then fall through to the normal case so a
1228 # warning is generated.
1229 if always_install $file; then
1230 log "ALWAYS: updating $file"
1231 if update_unmodified $file; then
1238 new=`file_type $NEWTREE/$file`
1239 dest=`file_type $DESTDIR/$file`
1240 warn "New file mismatch: $file ($new vs $dest)"
1243 new=`readlink $NEWTREE/$file`
1244 dest=`readlink $DESTDIR/$file`
1245 warn "New link conflict: $file (\"$new\" vs \"$dest\")"
1248 # If the only change in the new file versus
1249 # the destination file is a change in the
1250 # FreeBSD ID string and -F is specified, just
1251 # install the new file.
1252 if [ -n "$FREEBSD_ID" ] && \
1253 fbsdid_only $NEWTREE/$file $DESTDIR/$file; then
1254 if update_unmodified $file; then
1258 "Updating FreeBSD ID string failed"
1268 # Main routines for each command
1270 # Build a new tree and save it in a tarball.
1275 if [ $# -ne 1 ]; then
1276 echo "Missing required tarball."
1281 log "build command: $1"
1283 # Create a temporary directory to hold the tree
1284 dir=`mktemp -d $WORKDIR/etcupdate-XXXXXXX`
1285 if [ $? -ne 0 ]; then
1286 echo "Unable to create temporary directory."
1289 if ! build_tree $dir; then
1290 echo "Failed to build tree."
1294 if ! tar cfj $1 -C $dir . >&3 2>&1; then
1295 echo "Failed to create tarball."
1302 # Output a diff comparing the tree at DESTDIR to the current
1303 # unmodified tree. Note that this diff does not include files that
1304 # are present in DESTDIR but not in the unmodified tree.
1309 if [ $# -ne 0 ]; then
1313 # Requires an unmodified tree to diff against.
1314 if ! [ -d $NEWTREE ]; then
1315 echo "Reference tree to diff against unavailable."
1319 # Unfortunately, diff alone does not quite provide the right
1320 # level of options that we want, so improvise.
1321 for file in `(cd $NEWTREE; find .) | sed -e 's/^\.//'`; do
1322 if ignore $file; then
1326 diffnode $NEWTREE "$DESTDIR" $file "stock" "local"
1330 # Just extract a new tree into NEWTREE either by building a tree or
1331 # extracting a tarball. This can be used to bootstrap updates by
1332 # initializing the current "stock" tree to match the currently
1335 # Unlike 'update', this command does not rotate or preserve an
1336 # existing NEWTREE, it just replaces any existing tree.
1340 if [ $# -ne 0 ]; then
1344 log "extract command: tarball=$tarball"
1346 if [ -d $NEWTREE ]; then
1347 if ! remove_tree $NEWTREE; then
1348 echo "Unable to remove current tree."
1356 # Resolve conflicts left from an earlier merge.
1361 if [ $# -ne 0 ]; then
1365 if ! [ -d $CONFLICTS ]; then
1369 if ! [ -d $NEWTREE ]; then
1370 echo "The current tree is not present to resolve conflicts."
1374 conflicts=`(cd $CONFLICTS; find . ! -type d) | sed -e 's/^\.//'`
1375 for file in $conflicts; do
1376 resolve_conflict $file
1379 if [ -n "$NEWALIAS_WARN" ]; then
1380 warn "Needs update: /etc/mail/aliases.db" \
1381 "(requires manual update via newaliases(1))"
1384 echo " Needs update: /etc/mail/aliases.db" \
1385 "(requires manual update via newaliases(1))"
1389 # Report a summary of the previous merge. Specifically, list any
1390 # remaining conflicts followed by any warnings from the previous
1395 if [ $# -ne 0 ]; then
1399 if [ -d $CONFLICTS ]; then
1400 (cd $CONFLICTS; find . ! -type d) | sed -e 's/^\./ C /'
1402 if [ -s $WARNINGS ]; then
1408 # Perform an actual merge. The new tree can either already exist (if
1409 # rerunning a merge), be extracted from a tarball, or generated from a
1415 if [ $# -ne 0 ]; then
1419 log "update command: rerun=$rerun tarball=$tarball preworld=$preworld"
1421 if [ `id -u` -ne 0 ]; then
1422 echo "Must be root to update a tree."
1426 # Enforce a sane umask
1429 # XXX: Should existing conflicts be ignored and removed during
1432 # Trim the conflicts tree. Whine if there is anything left.
1433 if [ -e $CONFLICTS ]; then
1434 find -d $CONFLICTS -type d -empty -delete >&3 2>&1
1435 rmdir $CONFLICTS >&3 2>&1
1437 if [ -d $CONFLICTS ]; then
1438 echo "Conflicts remain from previous update, aborting."
1442 if [ -z "$rerun" ]; then
1443 # For a dryrun that is not a rerun, do not rotate the existing
1444 # stock tree. Instead, extract a tree to a temporary directory
1445 # and use that for the comparison.
1446 if [ -n "$dryrun" ]; then
1447 dir=`mktemp -d $WORKDIR/etcupdate-XXXXXXX`
1448 if [ $? -ne 0 ]; then
1449 echo "Unable to create temporary directory."
1453 # A pre-world dryrun has already set OLDTREE to
1454 # point to the current stock tree.
1455 if [ -z "$preworld" ]; then
1460 # For a pre-world update, blow away any pre-existing
1462 elif [ -n "$preworld" ]; then
1463 if ! remove_tree $NEWTREE; then
1464 echo "Unable to remove pre-world tree."
1468 # Rotate the existing stock tree to the old tree.
1469 elif [ -d $NEWTREE ]; then
1470 # First, delete the previous old tree if it exists.
1471 if ! remove_tree $OLDTREE; then
1472 echo "Unable to remove old tree."
1476 # Move the current stock tree.
1477 if ! mv $NEWTREE $OLDTREE >&3 2>&1; then
1478 echo "Unable to rename current stock tree."
1483 if ! [ -d $OLDTREE ]; then
1485 No previous tree to compare against, a sane comparison is not possible.
1487 log "No previous tree to compare against."
1488 if [ -n "$dir" ]; then
1494 # Populate the new tree.
1498 # Build lists of nodes in the old and new trees.
1499 (cd $OLDTREE; find .) | sed -e 's/^\.//' | sort > $WORKDIR/old.files
1500 (cd $NEWTREE; find .) | sed -e 's/^\.//' | sort > $WORKDIR/new.files
1502 # Split the files up into three groups using comm.
1503 comm -23 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/removed.files
1504 comm -13 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/added.files
1505 comm -12 $WORKDIR/old.files $WORKDIR/new.files > $WORKDIR/both.files
1507 # Initialize conflicts and warnings handling.
1511 # Ignore removed files for the pre-world case. A pre-world
1512 # update uses a stripped-down tree.
1513 if [ -n "$preworld" ]; then
1514 > $WORKDIR/removed.files
1517 # The order for the following sections is important. In the
1518 # odd case that a directory is converted into a file, the
1519 # existing subfiles need to be removed if possible before the
1520 # file is converted. Similarly, in the case that a file is
1521 # converted into a directory, the file needs to be converted
1522 # into a directory if possible before the new files are added.
1524 # First, handle removed files.
1525 for file in `cat $WORKDIR/removed.files`; do
1526 handle_removed_file $file
1529 # For the directory pass, reverse sort the list to effect a
1530 # depth-first traversal. This is needed to ensure that if a
1531 # directory with subdirectories is removed, the entire
1532 # directory is removed if there are no local modifications.
1533 for file in `sort -r $WORKDIR/removed.files`; do
1534 handle_removed_directory $file
1537 # Second, handle files that exist in both the old and new
1539 for file in `cat $WORKDIR/both.files`; do
1540 handle_modified_file $file
1543 # Finally, handle newly added files.
1544 for file in `cat $WORKDIR/added.files`; do
1545 handle_added_file $file
1548 if [ -n "$NEWALIAS_WARN" ]; then
1549 warn "Needs update: /etc/mail/aliases.db" \
1550 "(requires manual update via newaliases(1))"
1553 # Run any special one-off commands after an update has completed.
1556 if [ -s $WARNINGS ]; then
1561 if [ -n "$dir" ]; then
1562 if [ -z "$dryrun" -o -n "$rerun" ]; then
1563 panic "Should not have a temporary directory"
1570 # Determine which command we are executing. A command may be
1571 # specified as the first word. If one is not specified then 'update'
1572 # is assumed as the default command.
1574 if [ $# -gt 0 ]; then
1576 build|diff|extract|status|resolve)
1581 # If first arg is an option, assume the
1590 # Set default variable values.
1592 # The path to the source tree used to build trees.
1595 # The destination directory where the modified files live.
1598 # Ignore changes in the FreeBSD ID string.
1601 # Files that should always have the new version of the file installed.
1604 # Files to ignore and never update during a merge.
1607 # Flags to pass to 'make' when building a tree.
1610 # Include a config file if it exists. Note that command line options
1611 # override any settings in the config file. More details are in the
1612 # manual, but in general the following variables can be set:
1622 if [ -r /etc/etcupdate.conf ]; then
1623 . /etc/etcupdate.conf
1626 # Parse command line options
1634 while getopts "d:nprs:t:A:BD:FI:L:M:" option; do
1655 # To allow this option to be specified
1656 # multiple times, accumulate command-line
1657 # specified patterns in an 'always' variable
1658 # and use that to overwrite ALWAYS_INSTALL
1659 # after parsing all options. Need to be
1660 # careful here with globbing expansion.
1662 always="$always $OPTARG"
1675 # To allow this option to be specified
1676 # multiple times, accumulate command-line
1677 # specified patterns in an 'ignore' variable
1678 # and use that to overwrite IGNORE_FILES after
1679 # parsing all options. Need to be careful
1680 # here with globbing expansion.
1682 ignore="$ignore $OPTARG"
1689 MAKE_OPTIONS="$OPTARG"
1697 shift $((OPTIND - 1))
1699 # Allow -A command line options to override ALWAYS_INSTALL set from
1702 if [ -n "$always" ]; then
1703 ALWAYS_INSTALL="$always"
1706 # Allow -I command line options to override IGNORE_FILES set from the
1708 if [ -n "$ignore" ]; then
1709 IGNORE_FILES="$ignore"
1713 # Where the "old" and "new" trees are stored.
1714 WORKDIR=${WORKDIR:-$DESTDIR/var/db/etcupdate}
1716 # Log file for verbose output from program that are run. The log file
1717 # is opened on fd '3'.
1718 LOGFILE=${LOGFILE:-$WORKDIR/log}
1720 # The path of the "old" tree
1721 OLDTREE=$WORKDIR/old
1723 # The path of the "new" tree
1724 NEWTREE=$WORKDIR/current
1726 # The path of the "conflicts" tree where files with merge conflicts are saved.
1727 CONFLICTS=$WORKDIR/conflicts
1729 # The path of the "warnings" file that accumulates warning notes from an update.
1730 WARNINGS=$WORKDIR/warnings
1732 # Use $EDITOR for resolving conflicts. If it is not set, default to vi.
1733 EDITOR=${EDITOR:-/usr/bin/vi}
1735 # Files that need to be updated before installworld.
1736 PREWORLD_FILES="etc/master.passwd etc/group"
1738 # Handle command-specific argument processing such as complaining
1739 # about unsupported options. Since the configuration file is always
1740 # included, do not complain about extra command line arguments that
1741 # may have been set via the config file rather than the command line.
1744 if [ -n "$rerun" -a -n "$tarball" ]; then
1745 echo "Only one of -r or -t can be specified."
1749 if [ -n "$rerun" -a -n "$preworld" ]; then
1750 echo "Only one of -p or -r can be specified."
1756 if [ -n "$dryrun" -o -n "$rerun" -o -n "$tarball" -o \
1757 -n "$preworld" ]; then
1762 if [ -n "$dryrun" -o -n "$rerun" -o -n "$tarball" ]; then
1767 if [ -n "$dryrun" -o -n "$rerun" -o -n "$preworld" ]; then
1773 # Pre-world mode uses a different set of trees. It leaves the current
1774 # tree as-is so it is still present for a full etcupdate run after the
1775 # world install is complete. Instead, it installs a few critical files
1776 # into a separate tree.
1777 if [ -n "$preworld" ]; then
1779 NEWTREE=$WORKDIR/preworld
1782 # Open the log file. Don't truncate it if doing a minor operation so
1783 # that a minor operation doesn't lose log info from a major operation.
1784 if ! mkdir -p $WORKDIR 2>/dev/null; then
1785 echo "Failed to create work directory $WORKDIR"
1789 diff|resolve|status)