1#!/bin/sh 2# 3# SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4# 5# Copyright (c) September 1995 Wolfram Schneider <wosch@FreeBSD.org>. Berlin. 6# All rights reserved. 7# 8# Redistribution and use in source and binary forms, with or without 9# modification, are permitted provided that the following conditions 10# are met: 11# 1. Redistributions of source code must retain the above copyright 12# notice, this list of conditions and the following disclaimer. 13# 2. Redistributions in binary form must reproduce the above copyright 14# notice, this list of conditions and the following disclaimer in the 15# documentation and/or other materials provided with the distribution. 16# 17# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27# SUCH DAMAGE. 28# 29# updatedb - update locate database for local mounted filesystems 30# 31# $FreeBSD: head/usr.bin/locate/locate/updatedb.sh 326276 2017-11-27 15:37:16Z pfg $ 32 33if [ "$(id -u)" = "0" ]; then 34 echo ">>> WARNING" 1>&2 35 echo ">>> Executing updatedb as root. This WILL reveal all filenames" 1>&2 36 echo ">>> on your machine to all login users, which is a security risk." 1>&2 37fi 38: ${LOCATE_CONFIG="/etc/locate.rc"} 39if [ -f "$LOCATE_CONFIG" -a -r "$LOCATE_CONFIG" ]; then 40 . $LOCATE_CONFIG 41fi 42 43# The directory containing locate subprograms 44: ${LIBEXECDIR:=/usr/libexec}; export LIBEXECDIR 45: ${TMPDIR:=/tmp}; export TMPDIR 46if ! TMPDIR=`mktemp -d $TMPDIR/locateXXXXXXXXXX`; then 47 exit 1 48fi 49 50PATH=$LIBEXECDIR:/bin:/usr/bin:$PATH; export PATH 51 52 53: ${mklocatedb:=locate.mklocatedb} # make locate database program 54: ${FCODES:=/var/db/locate.database} # the database 55: ${PRUNEPATHS:="/tmp /usr/tmp /var/tmp"} # unwanted directories 56: ${PRUNEDIRS:=".git"} # unwanted directories, in any parent 57# allowed filesystems 58: ${FILESYSTEMS:="$(lsvfs | tail -n +3 | \ 59 egrep -vw 'loopback|network|synthetic|read-only|0' | \ 60 cut -d ' ' -f1)"} 61# directories to be searched to create the database 62# default to be all mount points with the above allowed filesystems, thus 63# allowing the exclusion of the root (/) filesystem while other mounted 64# and allowed filesystems can still be indexed. 65: ${SEARCHPATHS:="$(mount -t $(echo $FILESYSTEMS | tr ' ' ',') | \ 66 awk '{ print $3 }')"} 67# the find program and its options 68: ${FIND:="find -x"} 69 70if [ -z "$SEARCHPATHS" ]; then 71 echo "$0: empty variable SEARCHPATHS" >&2; exit 1 72fi 73if [ -z "$FILESYSTEMS" ]; then 74 echo "$0: empty variable FILESYSTEMS" >&2; exit 1 75fi 76ROOTFS="$(df -T / | awk '$NF=="/" { print $2 }')" 77if ! echo "$FILESYSTEMS" | grep -qw "$ROOTFS"; then 78 echo "WARNING: root filesystem '$ROOTFS' was excluded" >&2 79fi 80 81# Make a list a paths to exclude in the locate run 82excludes="! (" or="" 83for fstype in $FILESYSTEMS 84do 85 excludes="$excludes $or -fstype $fstype" 86 or="-or" 87done 88excludes="$excludes ) -prune" 89 90if [ -n "$PRUNEPATHS" ]; then 91 for path in $PRUNEPATHS; do 92 excludes="$excludes -or -path $path -prune" 93 done 94fi 95 96if [ -n "$PRUNEDIRS" ]; then 97 for dir in $PRUNEDIRS; do 98 excludes="$excludes -or -name $dir -type d -prune" 99 done 100fi 101 102tmp=$TMPDIR/_updatedb$$ 103trap 'rm -f $tmp; rmdir $TMPDIR' 0 1 2 3 5 10 15 104 105# search locally 106echo $FIND $SEARCHPATHS $excludes -or -print 107if $FIND $SEARCHPATHS $excludes -or -print 2>/dev/null | \ 108 sort | uniq | $mklocatedb -presort > $tmp 109then 110 if [ "$(stat -f '%z' $tmp)" -lt "257" ]; then 111 echo "updatedb: locate database $tmp is empty" >&2 112 exit 1 113 else 114 # Use "cat" instead of "cp", since the permission of the 115 # database is set up the by caller (i.e., peridoic task) 116 # which has privilege, while this tool should be run as 117 # a non-privilege user. 118 cat $tmp > $FCODES 119 echo "updatedb: built new locate database: $FCODES" 120 fi 121fi 122